fc9e3c576f9cce3f912b3d83b9fc662977121b15
[muen/linux.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 #include <linux/err.h>
19 #include <linux/bug.h>
20 #include <linux/lockdep.h>
21
22 struct module;
23 struct device;
24 struct i2c_client;
25 struct irq_domain;
26 struct spi_device;
27 struct spmi_device;
28 struct regmap;
29 struct regmap_range_cfg;
30 struct regmap_field;
31 struct snd_ac97;
32
33 /* An enum of all the supported cache types */
34 enum regcache_type {
35         REGCACHE_NONE,
36         REGCACHE_RBTREE,
37         REGCACHE_COMPRESSED,
38         REGCACHE_FLAT,
39 };
40
41 /**
42  * Default value for a register.  We use an array of structs rather
43  * than a simple array as many modern devices have very sparse
44  * register maps.
45  *
46  * @reg: Register address.
47  * @def: Register default value.
48  */
49 struct reg_default {
50         unsigned int reg;
51         unsigned int def;
52 };
53
54 /**
55  * Register/value pairs for sequences of writes with an optional delay in
56  * microseconds to be applied after each write.
57  *
58  * @reg: Register address.
59  * @def: Register value.
60  * @delay_us: Delay to be applied after the register write in microseconds
61  */
62 struct reg_sequence {
63         unsigned int reg;
64         unsigned int def;
65         unsigned int delay_us;
66 };
67
68 #define regmap_update_bits(map, reg, mask, val) \
69         regmap_update_bits_base(map, reg, mask, val, NULL, false, false)
70 #define regmap_update_bits_async(map, reg, mask, val)\
71         regmap_update_bits_base(map, reg, mask, val, NULL, true, false)
72 #define regmap_update_bits_check(map, reg, mask, val, change)\
73         regmap_update_bits_base(map, reg, mask, val, change, false, false)
74 #define regmap_update_bits_check_async(map, reg, mask, val, change)\
75         regmap_update_bits_base(map, reg, mask, val, change, true, false)
76
77 #define regmap_write_bits(map, reg, mask, val) \
78         regmap_update_bits_base(map, reg, mask, val, NULL, false, true)
79
80 #define regmap_field_write(field, val) \
81         regmap_field_update_bits_base(field, ~0, val, NULL, false, false)
82 #define regmap_field_force_write(field, val) \
83         regmap_field_update_bits_base(field, ~0, val, NULL, false, true)
84 #define regmap_field_update_bits(field, mask, val)\
85         regmap_field_update_bits_base(field, mask, val, NULL, false, false)
86 #define regmap_field_force_update_bits(field, mask, val) \
87         regmap_field_update_bits_base(field, mask, val, NULL, false, true)
88
89 #define regmap_fields_write(field, id, val) \
90         regmap_fields_update_bits_base(field, id, ~0, val, NULL, false, false)
91 #define regmap_fields_force_write(field, id, val) \
92         regmap_fields_update_bits_base(field, id, ~0, val, NULL, false, true)
93 #define regmap_fields_update_bits(field, id, mask, val)\
94         regmap_fields_update_bits_base(field, id, mask, val, NULL, false, false)
95 #define regmap_fields_force_update_bits(field, id, mask, val) \
96         regmap_fields_update_bits_base(field, id, mask, val, NULL, false, true)
97
98 /**
99  * regmap_read_poll_timeout - Poll until a condition is met or a timeout occurs
100  * @map: Regmap to read from
101  * @addr: Address to poll
102  * @val: Unsigned integer variable to read the value into
103  * @cond: Break condition (usually involving @val)
104  * @sleep_us: Maximum time to sleep between reads in us (0
105  *            tight-loops).  Should be less than ~20ms since usleep_range
106  *            is used (see Documentation/timers/timers-howto.txt).
107  * @timeout_us: Timeout in us, 0 means never timeout
108  *
109  * Returns 0 on success and -ETIMEDOUT upon a timeout or the regmap_read
110  * error return value in case of a error read. In the two former cases,
111  * the last read value at @addr is stored in @val. Must not be called
112  * from atomic context if sleep_us or timeout_us are used.
113  *
114  * This is modelled after the readx_poll_timeout macros in linux/iopoll.h.
115  */
116 #define regmap_read_poll_timeout(map, addr, val, cond, sleep_us, timeout_us) \
117 ({ \
118         ktime_t timeout = ktime_add_us(ktime_get(), timeout_us); \
119         int pollret; \
120         might_sleep_if(sleep_us); \
121         for (;;) { \
122                 pollret = regmap_read((map), (addr), &(val)); \
123                 if (pollret) \
124                         break; \
125                 if (cond) \
126                         break; \
127                 if (timeout_us && ktime_compare(ktime_get(), timeout) > 0) { \
128                         pollret = regmap_read((map), (addr), &(val)); \
129                         break; \
130                 } \
131                 if (sleep_us) \
132                         usleep_range((sleep_us >> 2) + 1, sleep_us); \
133         } \
134         pollret ?: ((cond) ? 0 : -ETIMEDOUT); \
135 })
136
137 #ifdef CONFIG_REGMAP
138
139 enum regmap_endian {
140         /* Unspecified -> 0 -> Backwards compatible default */
141         REGMAP_ENDIAN_DEFAULT = 0,
142         REGMAP_ENDIAN_BIG,
143         REGMAP_ENDIAN_LITTLE,
144         REGMAP_ENDIAN_NATIVE,
145 };
146
147 /**
148  * A register range, used for access related checks
149  * (readable/writeable/volatile/precious checks)
150  *
151  * @range_min: address of first register
152  * @range_max: address of last register
153  */
154 struct regmap_range {
155         unsigned int range_min;
156         unsigned int range_max;
157 };
158
159 #define regmap_reg_range(low, high) { .range_min = low, .range_max = high, }
160
161 /*
162  * A table of ranges including some yes ranges and some no ranges.
163  * If a register belongs to a no_range, the corresponding check function
164  * will return false. If a register belongs to a yes range, the corresponding
165  * check function will return true. "no_ranges" are searched first.
166  *
167  * @yes_ranges : pointer to an array of regmap ranges used as "yes ranges"
168  * @n_yes_ranges: size of the above array
169  * @no_ranges: pointer to an array of regmap ranges used as "no ranges"
170  * @n_no_ranges: size of the above array
171  */
172 struct regmap_access_table {
173         const struct regmap_range *yes_ranges;
174         unsigned int n_yes_ranges;
175         const struct regmap_range *no_ranges;
176         unsigned int n_no_ranges;
177 };
178
179 typedef void (*regmap_lock)(void *);
180 typedef void (*regmap_unlock)(void *);
181
182 /**
183  * Configuration for the register map of a device.
184  *
185  * @name: Optional name of the regmap. Useful when a device has multiple
186  *        register regions.
187  *
188  * @reg_bits: Number of bits in a register address, mandatory.
189  * @reg_stride: The register address stride. Valid register addresses are a
190  *              multiple of this value. If set to 0, a value of 1 will be
191  *              used.
192  * @pad_bits: Number of bits of padding between register and value.
193  * @val_bits: Number of bits in a register value, mandatory.
194  *
195  * @writeable_reg: Optional callback returning true if the register
196  *                 can be written to. If this field is NULL but wr_table
197  *                 (see below) is not, the check is performed on such table
198  *                 (a register is writeable if it belongs to one of the ranges
199  *                  specified by wr_table).
200  * @readable_reg: Optional callback returning true if the register
201  *                can be read from. If this field is NULL but rd_table
202  *                 (see below) is not, the check is performed on such table
203  *                 (a register is readable if it belongs to one of the ranges
204  *                  specified by rd_table).
205  * @volatile_reg: Optional callback returning true if the register
206  *                value can't be cached. If this field is NULL but
207  *                volatile_table (see below) is not, the check is performed on
208  *                such table (a register is volatile if it belongs to one of
209  *                the ranges specified by volatile_table).
210  * @precious_reg: Optional callback returning true if the register
211  *                should not be read outside of a call from the driver
212  *                (e.g., a clear on read interrupt status register). If this
213  *                field is NULL but precious_table (see below) is not, the
214  *                check is performed on such table (a register is precious if
215  *                it belongs to one of the ranges specified by precious_table).
216  * @lock:         Optional lock callback (overrides regmap's default lock
217  *                function, based on spinlock or mutex).
218  * @unlock:       As above for unlocking.
219  * @lock_arg:     this field is passed as the only argument of lock/unlock
220  *                functions (ignored in case regular lock/unlock functions
221  *                are not overridden).
222  * @reg_read:     Optional callback that if filled will be used to perform
223  *                all the reads from the registers. Should only be provided for
224  *                devices whose read operation cannot be represented as a simple
225  *                read operation on a bus such as SPI, I2C, etc. Most of the
226  *                devices do not need this.
227  * @reg_write:    Same as above for writing.
228  * @fast_io:      Register IO is fast. Use a spinlock instead of a mutex
229  *                to perform locking. This field is ignored if custom lock/unlock
230  *                functions are used (see fields lock/unlock of struct regmap_config).
231  *                This field is a duplicate of a similar file in
232  *                'struct regmap_bus' and serves exact same purpose.
233  *                 Use it only for "no-bus" cases.
234  * @max_register: Optional, specifies the maximum valid register address.
235  * @wr_table:     Optional, points to a struct regmap_access_table specifying
236  *                valid ranges for write access.
237  * @rd_table:     As above, for read access.
238  * @volatile_table: As above, for volatile registers.
239  * @precious_table: As above, for precious registers.
240  * @reg_defaults: Power on reset values for registers (for use with
241  *                register cache support).
242  * @num_reg_defaults: Number of elements in reg_defaults.
243  *
244  * @read_flag_mask: Mask to be set in the top bytes of the register when doing
245  *                  a read.
246  * @write_flag_mask: Mask to be set in the top bytes of the register when doing
247  *                   a write. If both read_flag_mask and write_flag_mask are
248  *                   empty the regmap_bus default masks are used.
249  * @use_single_rw: If set, converts the bulk read and write operations into
250  *                  a series of single read and write operations. This is useful
251  *                  for device that does not support bulk read and write.
252  * @can_multi_write: If set, the device supports the multi write mode of bulk
253  *                   write operations, if clear multi write requests will be
254  *                   split into individual write operations
255  *
256  * @cache_type: The actual cache type.
257  * @reg_defaults_raw: Power on reset values for registers (for use with
258  *                    register cache support).
259  * @num_reg_defaults_raw: Number of elements in reg_defaults_raw.
260  * @reg_format_endian: Endianness for formatted register addresses. If this is
261  *                     DEFAULT, the @reg_format_endian_default value from the
262  *                     regmap bus is used.
263  * @val_format_endian: Endianness for formatted register values. If this is
264  *                     DEFAULT, the @reg_format_endian_default value from the
265  *                     regmap bus is used.
266  *
267  * @ranges: Array of configuration entries for virtual address ranges.
268  * @num_ranges: Number of range configuration entries.
269  */
270 struct regmap_config {
271         const char *name;
272
273         int reg_bits;
274         int reg_stride;
275         int pad_bits;
276         int val_bits;
277
278         bool (*writeable_reg)(struct device *dev, unsigned int reg);
279         bool (*readable_reg)(struct device *dev, unsigned int reg);
280         bool (*volatile_reg)(struct device *dev, unsigned int reg);
281         bool (*precious_reg)(struct device *dev, unsigned int reg);
282         regmap_lock lock;
283         regmap_unlock unlock;
284         void *lock_arg;
285
286         int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
287         int (*reg_write)(void *context, unsigned int reg, unsigned int val);
288
289         bool fast_io;
290
291         unsigned int max_register;
292         const struct regmap_access_table *wr_table;
293         const struct regmap_access_table *rd_table;
294         const struct regmap_access_table *volatile_table;
295         const struct regmap_access_table *precious_table;
296         const struct reg_default *reg_defaults;
297         unsigned int num_reg_defaults;
298         enum regcache_type cache_type;
299         const void *reg_defaults_raw;
300         unsigned int num_reg_defaults_raw;
301
302         unsigned long read_flag_mask;
303         unsigned long write_flag_mask;
304
305         bool use_single_rw;
306         bool can_multi_write;
307
308         enum regmap_endian reg_format_endian;
309         enum regmap_endian val_format_endian;
310
311         const struct regmap_range_cfg *ranges;
312         unsigned int num_ranges;
313 };
314
315 /**
316  * Configuration for indirectly accessed or paged registers.
317  * Registers, mapped to this virtual range, are accessed in two steps:
318  *     1. page selector register update;
319  *     2. access through data window registers.
320  *
321  * @name: Descriptive name for diagnostics
322  *
323  * @range_min: Address of the lowest register address in virtual range.
324  * @range_max: Address of the highest register in virtual range.
325  *
326  * @page_sel_reg: Register with selector field.
327  * @page_sel_mask: Bit shift for selector value.
328  * @page_sel_shift: Bit mask for selector value.
329  *
330  * @window_start: Address of first (lowest) register in data window.
331  * @window_len: Number of registers in data window.
332  */
333 struct regmap_range_cfg {
334         const char *name;
335
336         /* Registers of virtual address range */
337         unsigned int range_min;
338         unsigned int range_max;
339
340         /* Page selector for indirect addressing */
341         unsigned int selector_reg;
342         unsigned int selector_mask;
343         int selector_shift;
344
345         /* Data window (per each page) */
346         unsigned int window_start;
347         unsigned int window_len;
348 };
349
350 struct regmap_async;
351
352 typedef int (*regmap_hw_write)(void *context, const void *data,
353                                size_t count);
354 typedef int (*regmap_hw_gather_write)(void *context,
355                                       const void *reg, size_t reg_len,
356                                       const void *val, size_t val_len);
357 typedef int (*regmap_hw_async_write)(void *context,
358                                      const void *reg, size_t reg_len,
359                                      const void *val, size_t val_len,
360                                      struct regmap_async *async);
361 typedef int (*regmap_hw_read)(void *context,
362                               const void *reg_buf, size_t reg_size,
363                               void *val_buf, size_t val_size);
364 typedef int (*regmap_hw_reg_read)(void *context, unsigned int reg,
365                                   unsigned int *val);
366 typedef int (*regmap_hw_reg_write)(void *context, unsigned int reg,
367                                    unsigned int val);
368 typedef int (*regmap_hw_reg_update_bits)(void *context, unsigned int reg,
369                                          unsigned int mask, unsigned int val);
370 typedef struct regmap_async *(*regmap_hw_async_alloc)(void);
371 typedef void (*regmap_hw_free_context)(void *context);
372
373 /**
374  * Description of a hardware bus for the register map infrastructure.
375  *
376  * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
377  *           to perform locking. This field is ignored if custom lock/unlock
378  *           functions are used (see fields lock/unlock of
379  *           struct regmap_config).
380  * @write: Write operation.
381  * @gather_write: Write operation with split register/value, return -ENOTSUPP
382  *                if not implemented  on a given device.
383  * @async_write: Write operation which completes asynchronously, optional and
384  *               must serialise with respect to non-async I/O.
385  * @reg_write: Write a single register value to the given register address. This
386  *             write operation has to complete when returning from the function.
387  * @read: Read operation.  Data is returned in the buffer used to transmit
388  *         data.
389  * @reg_read: Read a single register value from a given register address.
390  * @free_context: Free context.
391  * @async_alloc: Allocate a regmap_async() structure.
392  * @read_flag_mask: Mask to be set in the top byte of the register when doing
393  *                  a read.
394  * @reg_format_endian_default: Default endianness for formatted register
395  *     addresses. Used when the regmap_config specifies DEFAULT. If this is
396  *     DEFAULT, BIG is assumed.
397  * @val_format_endian_default: Default endianness for formatted register
398  *     values. Used when the regmap_config specifies DEFAULT. If this is
399  *     DEFAULT, BIG is assumed.
400  * @max_raw_read: Max raw read size that can be used on the bus.
401  * @max_raw_write: Max raw write size that can be used on the bus.
402  */
403 struct regmap_bus {
404         bool fast_io;
405         regmap_hw_write write;
406         regmap_hw_gather_write gather_write;
407         regmap_hw_async_write async_write;
408         regmap_hw_reg_write reg_write;
409         regmap_hw_reg_update_bits reg_update_bits;
410         regmap_hw_read read;
411         regmap_hw_reg_read reg_read;
412         regmap_hw_free_context free_context;
413         regmap_hw_async_alloc async_alloc;
414         u8 read_flag_mask;
415         enum regmap_endian reg_format_endian_default;
416         enum regmap_endian val_format_endian_default;
417         size_t max_raw_read;
418         size_t max_raw_write;
419 };
420
421 /*
422  * __regmap_init functions.
423  *
424  * These functions take a lock key and name parameter, and should not be called
425  * directly. Instead, use the regmap_init macros that generate a key and name
426  * for each call.
427  */
428 struct regmap *__regmap_init(struct device *dev,
429                              const struct regmap_bus *bus,
430                              void *bus_context,
431                              const struct regmap_config *config,
432                              struct lock_class_key *lock_key,
433                              const char *lock_name);
434 struct regmap *__regmap_init_i2c(struct i2c_client *i2c,
435                                  const struct regmap_config *config,
436                                  struct lock_class_key *lock_key,
437                                  const char *lock_name);
438 struct regmap *__regmap_init_spi(struct spi_device *dev,
439                                  const struct regmap_config *config,
440                                  struct lock_class_key *lock_key,
441                                  const char *lock_name);
442 struct regmap *__regmap_init_spmi_base(struct spmi_device *dev,
443                                        const struct regmap_config *config,
444                                        struct lock_class_key *lock_key,
445                                        const char *lock_name);
446 struct regmap *__regmap_init_spmi_ext(struct spmi_device *dev,
447                                       const struct regmap_config *config,
448                                       struct lock_class_key *lock_key,
449                                       const char *lock_name);
450 struct regmap *__regmap_init_mmio_clk(struct device *dev, const char *clk_id,
451                                       void __iomem *regs,
452                                       const struct regmap_config *config,
453                                       struct lock_class_key *lock_key,
454                                       const char *lock_name);
455 struct regmap *__regmap_init_ac97(struct snd_ac97 *ac97,
456                                   const struct regmap_config *config,
457                                   struct lock_class_key *lock_key,
458                                   const char *lock_name);
459
460 struct regmap *__devm_regmap_init(struct device *dev,
461                                   const struct regmap_bus *bus,
462                                   void *bus_context,
463                                   const struct regmap_config *config,
464                                   struct lock_class_key *lock_key,
465                                   const char *lock_name);
466 struct regmap *__devm_regmap_init_i2c(struct i2c_client *i2c,
467                                       const struct regmap_config *config,
468                                       struct lock_class_key *lock_key,
469                                       const char *lock_name);
470 struct regmap *__devm_regmap_init_spi(struct spi_device *dev,
471                                       const struct regmap_config *config,
472                                       struct lock_class_key *lock_key,
473                                       const char *lock_name);
474 struct regmap *__devm_regmap_init_spmi_base(struct spmi_device *dev,
475                                             const struct regmap_config *config,
476                                             struct lock_class_key *lock_key,
477                                             const char *lock_name);
478 struct regmap *__devm_regmap_init_spmi_ext(struct spmi_device *dev,
479                                            const struct regmap_config *config,
480                                            struct lock_class_key *lock_key,
481                                            const char *lock_name);
482 struct regmap *__devm_regmap_init_mmio_clk(struct device *dev,
483                                            const char *clk_id,
484                                            void __iomem *regs,
485                                            const struct regmap_config *config,
486                                            struct lock_class_key *lock_key,
487                                            const char *lock_name);
488 struct regmap *__devm_regmap_init_ac97(struct snd_ac97 *ac97,
489                                        const struct regmap_config *config,
490                                        struct lock_class_key *lock_key,
491                                        const char *lock_name);
492
493 /*
494  * Wrapper for regmap_init macros to include a unique lockdep key and name
495  * for each call. No-op if CONFIG_LOCKDEP is not set.
496  *
497  * @fn: Real function to call (in the form __[*_]regmap_init[_*])
498  * @name: Config variable name (#config in the calling macro)
499  **/
500 #ifdef CONFIG_LOCKDEP
501 #define __regmap_lockdep_wrapper(fn, name, ...)                         \
502 (                                                                       \
503         ({                                                              \
504                 static struct lock_class_key _key;                      \
505                 fn(__VA_ARGS__, &_key,                                  \
506                         KBUILD_BASENAME ":"                             \
507                         __stringify(__LINE__) ":"                       \
508                         "(" name ")->lock");                            \
509         })                                                              \
510 )
511 #else
512 #define __regmap_lockdep_wrapper(fn, name, ...) fn(__VA_ARGS__, NULL, NULL)
513 #endif
514
515 /**
516  * regmap_init(): Initialise register map
517  *
518  * @dev: Device that will be interacted with
519  * @bus: Bus-specific callbacks to use with device
520  * @bus_context: Data passed to bus-specific callbacks
521  * @config: Configuration for register map
522  *
523  * The return value will be an ERR_PTR() on error or a valid pointer to
524  * a struct regmap.  This function should generally not be called
525  * directly, it should be called by bus-specific init functions.
526  */
527 #define regmap_init(dev, bus, bus_context, config)                      \
528         __regmap_lockdep_wrapper(__regmap_init, #config,                \
529                                 dev, bus, bus_context, config)
530 int regmap_attach_dev(struct device *dev, struct regmap *map,
531                       const struct regmap_config *config);
532
533 /**
534  * regmap_init_i2c(): Initialise register map
535  *
536  * @i2c: Device that will be interacted with
537  * @config: Configuration for register map
538  *
539  * The return value will be an ERR_PTR() on error or a valid pointer to
540  * a struct regmap.
541  */
542 #define regmap_init_i2c(i2c, config)                                    \
543         __regmap_lockdep_wrapper(__regmap_init_i2c, #config,            \
544                                 i2c, config)
545
546 /**
547  * regmap_init_spi(): Initialise register map
548  *
549  * @spi: Device that will be interacted with
550  * @config: Configuration for register map
551  *
552  * The return value will be an ERR_PTR() on error or a valid pointer to
553  * a struct regmap.
554  */
555 #define regmap_init_spi(dev, config)                                    \
556         __regmap_lockdep_wrapper(__regmap_init_spi, #config,            \
557                                 dev, config)
558
559 /**
560  * regmap_init_spmi_base(): Create regmap for the Base register space
561  * @sdev:       SPMI device that will be interacted with
562  * @config:     Configuration for register map
563  *
564  * The return value will be an ERR_PTR() on error or a valid pointer to
565  * a struct regmap.
566  */
567 #define regmap_init_spmi_base(dev, config)                              \
568         __regmap_lockdep_wrapper(__regmap_init_spmi_base, #config,      \
569                                 dev, config)
570
571 /**
572  * regmap_init_spmi_ext(): Create regmap for Ext register space
573  * @sdev:       Device that will be interacted with
574  * @config:     Configuration for register map
575  *
576  * The return value will be an ERR_PTR() on error or a valid pointer to
577  * a struct regmap.
578  */
579 #define regmap_init_spmi_ext(dev, config)                               \
580         __regmap_lockdep_wrapper(__regmap_init_spmi_ext, #config,       \
581                                 dev, config)
582
583 /**
584  * regmap_init_mmio_clk(): Initialise register map with register clock
585  *
586  * @dev: Device that will be interacted with
587  * @clk_id: register clock consumer ID
588  * @regs: Pointer to memory-mapped IO region
589  * @config: Configuration for register map
590  *
591  * The return value will be an ERR_PTR() on error or a valid pointer to
592  * a struct regmap.
593  */
594 #define regmap_init_mmio_clk(dev, clk_id, regs, config)                 \
595         __regmap_lockdep_wrapper(__regmap_init_mmio_clk, #config,       \
596                                 dev, clk_id, regs, config)
597
598 /**
599  * regmap_init_mmio(): Initialise register map
600  *
601  * @dev: Device that will be interacted with
602  * @regs: Pointer to memory-mapped IO region
603  * @config: Configuration for register map
604  *
605  * The return value will be an ERR_PTR() on error or a valid pointer to
606  * a struct regmap.
607  */
608 #define regmap_init_mmio(dev, regs, config)             \
609         regmap_init_mmio_clk(dev, NULL, regs, config)
610
611 /**
612  * regmap_init_ac97(): Initialise AC'97 register map
613  *
614  * @ac97: Device that will be interacted with
615  * @config: Configuration for register map
616  *
617  * The return value will be an ERR_PTR() on error or a valid pointer to
618  * a struct regmap.
619  */
620 #define regmap_init_ac97(ac97, config)                                  \
621         __regmap_lockdep_wrapper(__regmap_init_ac97, #config,           \
622                                 ac97, config)
623 bool regmap_ac97_default_volatile(struct device *dev, unsigned int reg);
624
625 /**
626  * devm_regmap_init(): Initialise managed register map
627  *
628  * @dev: Device that will be interacted with
629  * @bus: Bus-specific callbacks to use with device
630  * @bus_context: Data passed to bus-specific callbacks
631  * @config: Configuration for register map
632  *
633  * The return value will be an ERR_PTR() on error or a valid pointer
634  * to a struct regmap.  This function should generally not be called
635  * directly, it should be called by bus-specific init functions.  The
636  * map will be automatically freed by the device management code.
637  */
638 #define devm_regmap_init(dev, bus, bus_context, config)                 \
639         __regmap_lockdep_wrapper(__devm_regmap_init, #config,           \
640                                 dev, bus, bus_context, config)
641
642 /**
643  * devm_regmap_init_i2c(): Initialise managed register map
644  *
645  * @i2c: Device that will be interacted with
646  * @config: Configuration for register map
647  *
648  * The return value will be an ERR_PTR() on error or a valid pointer
649  * to a struct regmap.  The regmap will be automatically freed by the
650  * device management code.
651  */
652 #define devm_regmap_init_i2c(i2c, config)                               \
653         __regmap_lockdep_wrapper(__devm_regmap_init_i2c, #config,       \
654                                 i2c, config)
655
656 /**
657  * devm_regmap_init_spi(): Initialise register map
658  *
659  * @spi: Device that will be interacted with
660  * @config: Configuration for register map
661  *
662  * The return value will be an ERR_PTR() on error or a valid pointer
663  * to a struct regmap.  The map will be automatically freed by the
664  * device management code.
665  */
666 #define devm_regmap_init_spi(dev, config)                               \
667         __regmap_lockdep_wrapper(__devm_regmap_init_spi, #config,       \
668                                 dev, config)
669
670 /**
671  * devm_regmap_init_spmi_base(): Create managed regmap for Base register space
672  * @sdev:       SPMI device that will be interacted with
673  * @config:     Configuration for register map
674  *
675  * The return value will be an ERR_PTR() on error or a valid pointer
676  * to a struct regmap.  The regmap will be automatically freed by the
677  * device management code.
678  */
679 #define devm_regmap_init_spmi_base(dev, config)                         \
680         __regmap_lockdep_wrapper(__devm_regmap_init_spmi_base, #config, \
681                                 dev, config)
682
683 /**
684  * devm_regmap_init_spmi_ext(): Create managed regmap for Ext register space
685  * @sdev:       SPMI device that will be interacted with
686  * @config:     Configuration for register map
687  *
688  * The return value will be an ERR_PTR() on error or a valid pointer
689  * to a struct regmap.  The regmap will be automatically freed by the
690  * device management code.
691  */
692 #define devm_regmap_init_spmi_ext(dev, config)                          \
693         __regmap_lockdep_wrapper(__devm_regmap_init_spmi_ext, #config,  \
694                                 dev, config)
695
696 /**
697  * devm_regmap_init_mmio_clk(): Initialise managed register map with clock
698  *
699  * @dev: Device that will be interacted with
700  * @clk_id: register clock consumer ID
701  * @regs: Pointer to memory-mapped IO region
702  * @config: Configuration for register map
703  *
704  * The return value will be an ERR_PTR() on error or a valid pointer
705  * to a struct regmap.  The regmap will be automatically freed by the
706  * device management code.
707  */
708 #define devm_regmap_init_mmio_clk(dev, clk_id, regs, config)            \
709         __regmap_lockdep_wrapper(__devm_regmap_init_mmio_clk, #config,  \
710                                 dev, clk_id, regs, config)
711
712 /**
713  * devm_regmap_init_mmio(): Initialise managed register map
714  *
715  * @dev: Device that will be interacted with
716  * @regs: Pointer to memory-mapped IO region
717  * @config: Configuration for register map
718  *
719  * The return value will be an ERR_PTR() on error or a valid pointer
720  * to a struct regmap.  The regmap will be automatically freed by the
721  * device management code.
722  */
723 #define devm_regmap_init_mmio(dev, regs, config)                \
724         devm_regmap_init_mmio_clk(dev, NULL, regs, config)
725
726 /**
727  * devm_regmap_init_ac97(): Initialise AC'97 register map
728  *
729  * @ac97: Device that will be interacted with
730  * @config: Configuration for register map
731  *
732  * The return value will be an ERR_PTR() on error or a valid pointer
733  * to a struct regmap.  The regmap will be automatically freed by the
734  * device management code.
735  */
736 #define devm_regmap_init_ac97(ac97, config)                             \
737         __regmap_lockdep_wrapper(__devm_regmap_init_ac97, #config,      \
738                                 ac97, config)
739
740 void regmap_exit(struct regmap *map);
741 int regmap_reinit_cache(struct regmap *map,
742                         const struct regmap_config *config);
743 struct regmap *dev_get_regmap(struct device *dev, const char *name);
744 struct device *regmap_get_device(struct regmap *map);
745 int regmap_write(struct regmap *map, unsigned int reg, unsigned int val);
746 int regmap_write_async(struct regmap *map, unsigned int reg, unsigned int val);
747 int regmap_raw_write(struct regmap *map, unsigned int reg,
748                      const void *val, size_t val_len);
749 int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
750                         size_t val_count);
751 int regmap_multi_reg_write(struct regmap *map, const struct reg_sequence *regs,
752                         int num_regs);
753 int regmap_multi_reg_write_bypassed(struct regmap *map,
754                                     const struct reg_sequence *regs,
755                                     int num_regs);
756 int regmap_raw_write_async(struct regmap *map, unsigned int reg,
757                            const void *val, size_t val_len);
758 int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val);
759 int regmap_raw_read(struct regmap *map, unsigned int reg,
760                     void *val, size_t val_len);
761 int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
762                      size_t val_count);
763 int regmap_update_bits_base(struct regmap *map, unsigned int reg,
764                             unsigned int mask, unsigned int val,
765                             bool *change, bool async, bool force);
766 int regmap_get_val_bytes(struct regmap *map);
767 int regmap_get_max_register(struct regmap *map);
768 int regmap_get_reg_stride(struct regmap *map);
769 int regmap_async_complete(struct regmap *map);
770 bool regmap_can_raw_write(struct regmap *map);
771 size_t regmap_get_raw_read_max(struct regmap *map);
772 size_t regmap_get_raw_write_max(struct regmap *map);
773
774 int regcache_sync(struct regmap *map);
775 int regcache_sync_region(struct regmap *map, unsigned int min,
776                          unsigned int max);
777 int regcache_drop_region(struct regmap *map, unsigned int min,
778                          unsigned int max);
779 void regcache_cache_only(struct regmap *map, bool enable);
780 void regcache_cache_bypass(struct regmap *map, bool enable);
781 void regcache_mark_dirty(struct regmap *map);
782
783 bool regmap_check_range_table(struct regmap *map, unsigned int reg,
784                               const struct regmap_access_table *table);
785
786 int regmap_register_patch(struct regmap *map, const struct reg_sequence *regs,
787                           int num_regs);
788 int regmap_parse_val(struct regmap *map, const void *buf,
789                                 unsigned int *val);
790
791 static inline bool regmap_reg_in_range(unsigned int reg,
792                                        const struct regmap_range *range)
793 {
794         return reg >= range->range_min && reg <= range->range_max;
795 }
796
797 bool regmap_reg_in_ranges(unsigned int reg,
798                           const struct regmap_range *ranges,
799                           unsigned int nranges);
800
801 /**
802  * Description of an register field
803  *
804  * @reg: Offset of the register within the regmap bank
805  * @lsb: lsb of the register field.
806  * @msb: msb of the register field.
807  * @id_size: port size if it has some ports
808  * @id_offset: address offset for each ports
809  */
810 struct reg_field {
811         unsigned int reg;
812         unsigned int lsb;
813         unsigned int msb;
814         unsigned int id_size;
815         unsigned int id_offset;
816 };
817
818 #define REG_FIELD(_reg, _lsb, _msb) {           \
819                                 .reg = _reg,    \
820                                 .lsb = _lsb,    \
821                                 .msb = _msb,    \
822                                 }
823
824 struct regmap_field *regmap_field_alloc(struct regmap *regmap,
825                 struct reg_field reg_field);
826 void regmap_field_free(struct regmap_field *field);
827
828 struct regmap_field *devm_regmap_field_alloc(struct device *dev,
829                 struct regmap *regmap, struct reg_field reg_field);
830 void devm_regmap_field_free(struct device *dev, struct regmap_field *field);
831
832 int regmap_field_read(struct regmap_field *field, unsigned int *val);
833 int regmap_field_update_bits_base(struct regmap_field *field,
834                                   unsigned int mask, unsigned int val,
835                                   bool *change, bool async, bool force);
836 int regmap_fields_read(struct regmap_field *field, unsigned int id,
837                        unsigned int *val);
838 int regmap_fields_update_bits_base(struct regmap_field *field,  unsigned int id,
839                                    unsigned int mask, unsigned int val,
840                                    bool *change, bool async, bool force);
841
842 /**
843  * Description of an IRQ for the generic regmap irq_chip.
844  *
845  * @reg_offset: Offset of the status/mask register within the bank
846  * @mask:       Mask used to flag/control the register.
847  * @type_reg_offset: Offset register for the irq type setting.
848  * @type_rising_mask: Mask bit to configure RISING type irq.
849  * @type_falling_mask: Mask bit to configure FALLING type irq.
850  */
851 struct regmap_irq {
852         unsigned int reg_offset;
853         unsigned int mask;
854         unsigned int type_reg_offset;
855         unsigned int type_rising_mask;
856         unsigned int type_falling_mask;
857 };
858
859 #define REGMAP_IRQ_REG(_irq, _off, _mask)               \
860         [_irq] = { .reg_offset = (_off), .mask = (_mask) }
861
862 /**
863  * Description of a generic regmap irq_chip.  This is not intended to
864  * handle every possible interrupt controller, but it should handle a
865  * substantial proportion of those that are found in the wild.
866  *
867  * @name:        Descriptive name for IRQ controller.
868  *
869  * @status_base: Base status register address.
870  * @mask_base:   Base mask register address.
871  * @unmask_base:  Base unmask register address. for chips who have
872  *                separate mask and unmask registers
873  * @ack_base:    Base ack address. If zero then the chip is clear on read.
874  *               Using zero value is possible with @use_ack bit.
875  * @wake_base:   Base address for wake enables.  If zero unsupported.
876  * @type_base:   Base address for irq type.  If zero unsupported.
877  * @irq_reg_stride:  Stride to use for chips where registers are not contiguous.
878  * @init_ack_masked: Ack all masked interrupts once during initalization.
879  * @mask_invert: Inverted mask register: cleared bits are masked out.
880  * @use_ack:     Use @ack register even if it is zero.
881  * @ack_invert:  Inverted ack register: cleared bits for ack.
882  * @wake_invert: Inverted wake register: cleared bits are wake enabled.
883  * @type_invert: Invert the type flags.
884  * @runtime_pm:  Hold a runtime PM lock on the device when accessing it.
885  *
886  * @num_regs:    Number of registers in each control bank.
887  * @irqs:        Descriptors for individual IRQs.  Interrupt numbers are
888  *               assigned based on the index in the array of the interrupt.
889  * @num_irqs:    Number of descriptors.
890  * @num_type_reg:    Number of type registers.
891  * @type_reg_stride: Stride to use for chips where type registers are not
892  *                      contiguous.
893  * @handle_pre_irq:  Driver specific callback to handle interrupt from device
894  *                   before regmap_irq_handler process the interrupts.
895  * @handle_post_irq: Driver specific callback to handle interrupt from device
896  *                   after handling the interrupts in regmap_irq_handler().
897  * @irq_drv_data:    Driver specific IRQ data which is passed as parameter when
898  *                   driver specific pre/post interrupt handler is called.
899  */
900 struct regmap_irq_chip {
901         const char *name;
902
903         unsigned int status_base;
904         unsigned int mask_base;
905         unsigned int unmask_base;
906         unsigned int ack_base;
907         unsigned int wake_base;
908         unsigned int type_base;
909         unsigned int irq_reg_stride;
910         bool init_ack_masked:1;
911         bool mask_invert:1;
912         bool use_ack:1;
913         bool ack_invert:1;
914         bool wake_invert:1;
915         bool runtime_pm:1;
916         bool type_invert:1;
917
918         int num_regs;
919
920         const struct regmap_irq *irqs;
921         int num_irqs;
922
923         int num_type_reg;
924         unsigned int type_reg_stride;
925
926         int (*handle_pre_irq)(void *irq_drv_data);
927         int (*handle_post_irq)(void *irq_drv_data);
928         void *irq_drv_data;
929 };
930
931 struct regmap_irq_chip_data;
932
933 int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags,
934                         int irq_base, const struct regmap_irq_chip *chip,
935                         struct regmap_irq_chip_data **data);
936 void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data);
937
938 int devm_regmap_add_irq_chip(struct device *dev, struct regmap *map, int irq,
939                              int irq_flags, int irq_base,
940                              const struct regmap_irq_chip *chip,
941                              struct regmap_irq_chip_data **data);
942 void devm_regmap_del_irq_chip(struct device *dev, int irq,
943                               struct regmap_irq_chip_data *data);
944
945 int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data);
946 int regmap_irq_get_virq(struct regmap_irq_chip_data *data, int irq);
947 struct irq_domain *regmap_irq_get_domain(struct regmap_irq_chip_data *data);
948
949 #else
950
951 /*
952  * These stubs should only ever be called by generic code which has
953  * regmap based facilities, if they ever get called at runtime
954  * something is going wrong and something probably needs to select
955  * REGMAP.
956  */
957
958 static inline int regmap_write(struct regmap *map, unsigned int reg,
959                                unsigned int val)
960 {
961         WARN_ONCE(1, "regmap API is disabled");
962         return -EINVAL;
963 }
964
965 static inline int regmap_write_async(struct regmap *map, unsigned int reg,
966                                      unsigned int val)
967 {
968         WARN_ONCE(1, "regmap API is disabled");
969         return -EINVAL;
970 }
971
972 static inline int regmap_raw_write(struct regmap *map, unsigned int reg,
973                                    const void *val, size_t val_len)
974 {
975         WARN_ONCE(1, "regmap API is disabled");
976         return -EINVAL;
977 }
978
979 static inline int regmap_raw_write_async(struct regmap *map, unsigned int reg,
980                                          const void *val, size_t val_len)
981 {
982         WARN_ONCE(1, "regmap API is disabled");
983         return -EINVAL;
984 }
985
986 static inline int regmap_bulk_write(struct regmap *map, unsigned int reg,
987                                     const void *val, size_t val_count)
988 {
989         WARN_ONCE(1, "regmap API is disabled");
990         return -EINVAL;
991 }
992
993 static inline int regmap_read(struct regmap *map, unsigned int reg,
994                               unsigned int *val)
995 {
996         WARN_ONCE(1, "regmap API is disabled");
997         return -EINVAL;
998 }
999
1000 static inline int regmap_raw_read(struct regmap *map, unsigned int reg,
1001                                   void *val, size_t val_len)
1002 {
1003         WARN_ONCE(1, "regmap API is disabled");
1004         return -EINVAL;
1005 }
1006
1007 static inline int regmap_bulk_read(struct regmap *map, unsigned int reg,
1008                                    void *val, size_t val_count)
1009 {
1010         WARN_ONCE(1, "regmap API is disabled");
1011         return -EINVAL;
1012 }
1013
1014 static inline int regmap_update_bits_base(struct regmap *map, unsigned int reg,
1015                                           unsigned int mask, unsigned int val,
1016                                           bool *change, bool async, bool force)
1017 {
1018         WARN_ONCE(1, "regmap API is disabled");
1019         return -EINVAL;
1020 }
1021
1022 static inline int regmap_field_update_bits_base(struct regmap_field *field,
1023                                         unsigned int mask, unsigned int val,
1024                                         bool *change, bool async, bool force)
1025 {
1026         WARN_ONCE(1, "regmap API is disabled");
1027         return -EINVAL;
1028 }
1029
1030 static inline int regmap_fields_update_bits_base(struct regmap_field *field,
1031                                    unsigned int id,
1032                                    unsigned int mask, unsigned int val,
1033                                    bool *change, bool async, bool force)
1034 {
1035         WARN_ONCE(1, "regmap API is disabled");
1036         return -EINVAL;
1037 }
1038
1039 static inline int regmap_get_val_bytes(struct regmap *map)
1040 {
1041         WARN_ONCE(1, "regmap API is disabled");
1042         return -EINVAL;
1043 }
1044
1045 static inline int regmap_get_max_register(struct regmap *map)
1046 {
1047         WARN_ONCE(1, "regmap API is disabled");
1048         return -EINVAL;
1049 }
1050
1051 static inline int regmap_get_reg_stride(struct regmap *map)
1052 {
1053         WARN_ONCE(1, "regmap API is disabled");
1054         return -EINVAL;
1055 }
1056
1057 static inline int regcache_sync(struct regmap *map)
1058 {
1059         WARN_ONCE(1, "regmap API is disabled");
1060         return -EINVAL;
1061 }
1062
1063 static inline int regcache_sync_region(struct regmap *map, unsigned int min,
1064                                        unsigned int max)
1065 {
1066         WARN_ONCE(1, "regmap API is disabled");
1067         return -EINVAL;
1068 }
1069
1070 static inline int regcache_drop_region(struct regmap *map, unsigned int min,
1071                                        unsigned int max)
1072 {
1073         WARN_ONCE(1, "regmap API is disabled");
1074         return -EINVAL;
1075 }
1076
1077 static inline void regcache_cache_only(struct regmap *map, bool enable)
1078 {
1079         WARN_ONCE(1, "regmap API is disabled");
1080 }
1081
1082 static inline void regcache_cache_bypass(struct regmap *map, bool enable)
1083 {
1084         WARN_ONCE(1, "regmap API is disabled");
1085 }
1086
1087 static inline void regcache_mark_dirty(struct regmap *map)
1088 {
1089         WARN_ONCE(1, "regmap API is disabled");
1090 }
1091
1092 static inline void regmap_async_complete(struct regmap *map)
1093 {
1094         WARN_ONCE(1, "regmap API is disabled");
1095 }
1096
1097 static inline int regmap_register_patch(struct regmap *map,
1098                                         const struct reg_sequence *regs,
1099                                         int num_regs)
1100 {
1101         WARN_ONCE(1, "regmap API is disabled");
1102         return -EINVAL;
1103 }
1104
1105 static inline int regmap_parse_val(struct regmap *map, const void *buf,
1106                                 unsigned int *val)
1107 {
1108         WARN_ONCE(1, "regmap API is disabled");
1109         return -EINVAL;
1110 }
1111
1112 static inline struct regmap *dev_get_regmap(struct device *dev,
1113                                             const char *name)
1114 {
1115         return NULL;
1116 }
1117
1118 static inline struct device *regmap_get_device(struct regmap *map)
1119 {
1120         WARN_ONCE(1, "regmap API is disabled");
1121         return NULL;
1122 }
1123
1124 #endif
1125
1126 #endif