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