b9e99799965d1e3858e6efbe41b5e436ad08c9c0
[~shefty/rdma-dev.git] / include / linux / regmap.h
1 #ifndef __LINUX_REGMAP_H
2 #define __LINUX_REGMAP_H
3
4 /*
5  * Register map access API
6  *
7  * Copyright 2011 Wolfson Microelectronics plc
8  *
9  * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License version 2 as
13  * published by the Free Software Foundation.
14  */
15
16 #include <linux/list.h>
17 #include <linux/rbtree.h>
18
19 struct module;
20 struct device;
21 struct i2c_client;
22 struct irq_domain;
23 struct spi_device;
24 struct regmap;
25 struct regmap_range_cfg;
26
27 /* An enum of all the supported cache types */
28 enum regcache_type {
29         REGCACHE_NONE,
30         REGCACHE_RBTREE,
31         REGCACHE_COMPRESSED
32 };
33
34 /**
35  * Default value for a register.  We use an array of structs rather
36  * than a simple array as many modern devices have very sparse
37  * register maps.
38  *
39  * @reg: Register address.
40  * @def: Register default value.
41  */
42 struct reg_default {
43         unsigned int reg;
44         unsigned int def;
45 };
46
47 #ifdef CONFIG_REGMAP
48
49 enum regmap_endian {
50         /* Unspecified -> 0 -> Backwards compatible default */
51         REGMAP_ENDIAN_DEFAULT = 0,
52         REGMAP_ENDIAN_BIG,
53         REGMAP_ENDIAN_LITTLE,
54         REGMAP_ENDIAN_NATIVE,
55 };
56
57 /**
58  * Configuration for the register map of a device.
59  *
60  * @name: Optional name of the regmap. Useful when a device has multiple
61  *        register regions.
62  *
63  * @reg_bits: Number of bits in a register address, mandatory.
64  * @reg_stride: The register address stride. Valid register addresses are a
65  *              multiple of this value. If set to 0, a value of 1 will be
66  *              used.
67  * @pad_bits: Number of bits of padding between register and value.
68  * @val_bits: Number of bits in a register value, mandatory.
69  *
70  * @writeable_reg: Optional callback returning true if the register
71  *                 can be written to.
72  * @readable_reg: Optional callback returning true if the register
73  *                can be read from.
74  * @volatile_reg: Optional callback returning true if the register
75  *                value can't be cached.
76  * @precious_reg: Optional callback returning true if the rgister
77  *                should not be read outside of a call from the driver
78  *                (eg, a clear on read interrupt status register).
79  *
80  * @max_register: Optional, specifies the maximum valid register index.
81  * @reg_defaults: Power on reset values for registers (for use with
82  *                register cache support).
83  * @num_reg_defaults: Number of elements in reg_defaults.
84  *
85  * @read_flag_mask: Mask to be set in the top byte of the register when doing
86  *                  a read.
87  * @write_flag_mask: Mask to be set in the top byte of the register when doing
88  *                   a write. If both read_flag_mask and write_flag_mask are
89  *                   empty the regmap_bus default masks are used.
90  * @use_single_rw: If set, converts the bulk read and write operations into
91  *                  a series of single read and write operations. This is useful
92  *                  for device that does not support bulk read and write.
93  *
94  * @cache_type: The actual cache type.
95  * @reg_defaults_raw: Power on reset values for registers (for use with
96  *                    register cache support).
97  * @num_reg_defaults_raw: Number of elements in reg_defaults_raw.
98  * @reg_format_endian: Endianness for formatted register addresses. If this is
99  *                     DEFAULT, the @reg_format_endian_default value from the
100  *                     regmap bus is used.
101  * @val_format_endian: Endianness for formatted register values. If this is
102  *                     DEFAULT, the @reg_format_endian_default value from the
103  *                     regmap bus is used.
104  *
105  * @ranges: Array of configuration entries for virtual address ranges.
106  * @num_ranges: Number of range configuration entries.
107  */
108 struct regmap_config {
109         const char *name;
110
111         int reg_bits;
112         int reg_stride;
113         int pad_bits;
114         int val_bits;
115
116         bool (*writeable_reg)(struct device *dev, unsigned int reg);
117         bool (*readable_reg)(struct device *dev, unsigned int reg);
118         bool (*volatile_reg)(struct device *dev, unsigned int reg);
119         bool (*precious_reg)(struct device *dev, unsigned int reg);
120
121         unsigned int max_register;
122         const struct reg_default *reg_defaults;
123         unsigned int num_reg_defaults;
124         enum regcache_type cache_type;
125         const void *reg_defaults_raw;
126         unsigned int num_reg_defaults_raw;
127
128         u8 read_flag_mask;
129         u8 write_flag_mask;
130
131         bool use_single_rw;
132
133         enum regmap_endian reg_format_endian;
134         enum regmap_endian val_format_endian;
135
136         const struct regmap_range_cfg *ranges;
137         unsigned int n_ranges;
138 };
139
140 /**
141  * Configuration for indirectly accessed or paged registers.
142  * Registers, mapped to this virtual range, are accessed in two steps:
143  *     1. page selector register update;
144  *     2. access through data window registers.
145  *
146  * @range_min: Address of the lowest register address in virtual range.
147  * @range_max: Address of the highest register in virtual range.
148  *
149  * @page_sel_reg: Register with selector field.
150  * @page_sel_mask: Bit shift for selector value.
151  * @page_sel_shift: Bit mask for selector value.
152  *
153  * @window_start: Address of first (lowest) register in data window.
154  * @window_len: Number of registers in data window.
155  */
156 struct regmap_range_cfg {
157         /* Registers of virtual address range */
158         unsigned int range_min;
159         unsigned int range_max;
160
161         /* Page selector for indirect addressing */
162         unsigned int selector_reg;
163         unsigned int selector_mask;
164         int selector_shift;
165
166         /* Data window (per each page) */
167         unsigned int window_start;
168         unsigned int window_len;
169 };
170
171 typedef int (*regmap_hw_write)(void *context, const void *data,
172                                size_t count);
173 typedef int (*regmap_hw_gather_write)(void *context,
174                                       const void *reg, size_t reg_len,
175                                       const void *val, size_t val_len);
176 typedef int (*regmap_hw_read)(void *context,
177                               const void *reg_buf, size_t reg_size,
178                               void *val_buf, size_t val_size);
179 typedef void (*regmap_hw_free_context)(void *context);
180
181 /**
182  * Description of a hardware bus for the register map infrastructure.
183  *
184  * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
185  *           to perform locking.
186  * @write: Write operation.
187  * @gather_write: Write operation with split register/value, return -ENOTSUPP
188  *                if not implemented  on a given device.
189  * @read: Read operation.  Data is returned in the buffer used to transmit
190  *         data.
191  * @read_flag_mask: Mask to be set in the top byte of the register when doing
192  *                  a read.
193  * @reg_format_endian_default: Default endianness for formatted register
194  *     addresses. Used when the regmap_config specifies DEFAULT. If this is
195  *     DEFAULT, BIG is assumed.
196  * @val_format_endian_default: Default endianness for formatted register
197  *     values. Used when the regmap_config specifies DEFAULT. If this is
198  *     DEFAULT, BIG is assumed.
199  */
200 struct regmap_bus {
201         bool fast_io;
202         regmap_hw_write write;
203         regmap_hw_gather_write gather_write;
204         regmap_hw_read read;
205         regmap_hw_free_context free_context;
206         u8 read_flag_mask;
207         enum regmap_endian reg_format_endian_default;
208         enum regmap_endian val_format_endian_default;
209 };
210
211 struct regmap *regmap_init(struct device *dev,
212                            const struct regmap_bus *bus,
213                            void *bus_context,
214                            const struct regmap_config *config);
215 struct regmap *regmap_init_i2c(struct i2c_client *i2c,
216                                const struct regmap_config *config);
217 struct regmap *regmap_init_spi(struct spi_device *dev,
218                                const struct regmap_config *config);
219 struct regmap *regmap_init_mmio(struct device *dev,
220                                 void __iomem *regs,
221                                 const struct regmap_config *config);
222
223 struct regmap *devm_regmap_init(struct device *dev,
224                                 const struct regmap_bus *bus,
225                                 void *bus_context,
226                                 const struct regmap_config *config);
227 struct regmap *devm_regmap_init_i2c(struct i2c_client *i2c,
228                                     const struct regmap_config *config);
229 struct regmap *devm_regmap_init_spi(struct spi_device *dev,
230                                     const struct regmap_config *config);
231 struct regmap *devm_regmap_init_mmio(struct device *dev,
232                                      void __iomem *regs,
233                                      const struct regmap_config *config);
234
235 void regmap_exit(struct regmap *map);
236 int regmap_reinit_cache(struct regmap *map,
237                         const struct regmap_config *config);
238 struct regmap *dev_get_regmap(struct device *dev, const char *name);
239 int regmap_write(struct regmap *map, unsigned int reg, unsigned int val);
240 int regmap_raw_write(struct regmap *map, unsigned int reg,
241                      const void *val, size_t val_len);
242 int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
243                         size_t val_count);
244 int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val);
245 int regmap_raw_read(struct regmap *map, unsigned int reg,
246                     void *val, size_t val_len);
247 int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
248                      size_t val_count);
249 int regmap_update_bits(struct regmap *map, unsigned int reg,
250                        unsigned int mask, unsigned int val);
251 int regmap_update_bits_check(struct regmap *map, unsigned int reg,
252                              unsigned int mask, unsigned int val,
253                              bool *change);
254 int regmap_get_val_bytes(struct regmap *map);
255
256 int regcache_sync(struct regmap *map);
257 int regcache_sync_region(struct regmap *map, unsigned int min,
258                          unsigned int max);
259 void regcache_cache_only(struct regmap *map, bool enable);
260 void regcache_cache_bypass(struct regmap *map, bool enable);
261 void regcache_mark_dirty(struct regmap *map);
262
263 int regmap_register_patch(struct regmap *map, const struct reg_default *regs,
264                           int num_regs);
265
266 /**
267  * Description of an IRQ for the generic regmap irq_chip.
268  *
269  * @reg_offset: Offset of the status/mask register within the bank
270  * @mask:       Mask used to flag/control the register.
271  */
272 struct regmap_irq {
273         unsigned int reg_offset;
274         unsigned int mask;
275 };
276
277 /**
278  * Description of a generic regmap irq_chip.  This is not intended to
279  * handle every possible interrupt controller, but it should handle a
280  * substantial proportion of those that are found in the wild.
281  *
282  * @name:        Descriptive name for IRQ controller.
283  *
284  * @status_base: Base status register address.
285  * @mask_base:   Base mask register address.
286  * @ack_base:    Base ack address.  If zero then the chip is clear on read.
287  * @wake_base:   Base address for wake enables.  If zero unsupported.
288  * @irq_reg_stride:  Stride to use for chips where registers are not contiguous.
289  * @runtime_pm:  Hold a runtime PM lock on the device when accessing it.
290  *
291  * @num_regs:    Number of registers in each control bank.
292  * @irqs:        Descriptors for individual IRQs.  Interrupt numbers are
293  *               assigned based on the index in the array of the interrupt.
294  * @num_irqs:    Number of descriptors.
295  */
296 struct regmap_irq_chip {
297         const char *name;
298
299         unsigned int status_base;
300         unsigned int mask_base;
301         unsigned int ack_base;
302         unsigned int wake_base;
303         unsigned int irq_reg_stride;
304         unsigned int mask_invert;
305         bool runtime_pm;
306
307         int num_regs;
308
309         const struct regmap_irq *irqs;
310         int num_irqs;
311 };
312
313 struct regmap_irq_chip_data;
314
315 int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags,
316                         int irq_base, const struct regmap_irq_chip *chip,
317                         struct regmap_irq_chip_data **data);
318 void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data);
319 int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data);
320 int regmap_irq_get_virq(struct regmap_irq_chip_data *data, int irq);
321 struct irq_domain *regmap_irq_get_domain(struct regmap_irq_chip_data *data);
322
323 #else
324
325 /*
326  * These stubs should only ever be called by generic code which has
327  * regmap based facilities, if they ever get called at runtime
328  * something is going wrong and something probably needs to select
329  * REGMAP.
330  */
331
332 static inline int regmap_write(struct regmap *map, unsigned int reg,
333                                unsigned int val)
334 {
335         WARN_ONCE(1, "regmap API is disabled");
336         return -EINVAL;
337 }
338
339 static inline int regmap_raw_write(struct regmap *map, unsigned int reg,
340                                    const void *val, size_t val_len)
341 {
342         WARN_ONCE(1, "regmap API is disabled");
343         return -EINVAL;
344 }
345
346 static inline int regmap_bulk_write(struct regmap *map, unsigned int reg,
347                                     const void *val, size_t val_count)
348 {
349         WARN_ONCE(1, "regmap API is disabled");
350         return -EINVAL;
351 }
352
353 static inline int regmap_read(struct regmap *map, unsigned int reg,
354                               unsigned int *val)
355 {
356         WARN_ONCE(1, "regmap API is disabled");
357         return -EINVAL;
358 }
359
360 static inline int regmap_raw_read(struct regmap *map, unsigned int reg,
361                                   void *val, size_t val_len)
362 {
363         WARN_ONCE(1, "regmap API is disabled");
364         return -EINVAL;
365 }
366
367 static inline int regmap_bulk_read(struct regmap *map, unsigned int reg,
368                                    void *val, size_t val_count)
369 {
370         WARN_ONCE(1, "regmap API is disabled");
371         return -EINVAL;
372 }
373
374 static inline int regmap_update_bits(struct regmap *map, unsigned int reg,
375                                      unsigned int mask, unsigned int val)
376 {
377         WARN_ONCE(1, "regmap API is disabled");
378         return -EINVAL;
379 }
380
381 static inline int regmap_update_bits_check(struct regmap *map,
382                                            unsigned int reg,
383                                            unsigned int mask, unsigned int val,
384                                            bool *change)
385 {
386         WARN_ONCE(1, "regmap API is disabled");
387         return -EINVAL;
388 }
389
390 static inline int regmap_get_val_bytes(struct regmap *map)
391 {
392         WARN_ONCE(1, "regmap API is disabled");
393         return -EINVAL;
394 }
395
396 static inline int regcache_sync(struct regmap *map)
397 {
398         WARN_ONCE(1, "regmap API is disabled");
399         return -EINVAL;
400 }
401
402 static inline int regcache_sync_region(struct regmap *map, unsigned int min,
403                                        unsigned int max)
404 {
405         WARN_ONCE(1, "regmap API is disabled");
406         return -EINVAL;
407 }
408
409 static inline void regcache_cache_only(struct regmap *map, bool enable)
410 {
411         WARN_ONCE(1, "regmap API is disabled");
412 }
413
414 static inline void regcache_cache_bypass(struct regmap *map, bool enable)
415 {
416         WARN_ONCE(1, "regmap API is disabled");
417 }
418
419 static inline void regcache_mark_dirty(struct regmap *map)
420 {
421         WARN_ONCE(1, "regmap API is disabled");
422 }
423
424 static inline int regmap_register_patch(struct regmap *map,
425                                         const struct reg_default *regs,
426                                         int num_regs)
427 {
428         WARN_ONCE(1, "regmap API is disabled");
429         return -EINVAL;
430 }
431
432 static inline struct regmap *dev_get_regmap(struct device *dev,
433                                             const char *name)
434 {
435         return NULL;
436 }
437
438 #endif
439
440 #endif