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