1 /* SPDX-License-Identifier: GPL-2.0-only */
2 #ifndef __LINUX_REGMAP_H
3 #define __LINUX_REGMAP_H
4 
5 /*
6  * Register map access API
7  *
8  * Copyright 2011 Wolfson Microelectronics plc
9  *
10  * Author: Mark Brown <[email protected]>
11  */
12 
13 #include <linux/list.h>
14 #include <linux/rbtree.h>
15 #include <linux/ktime.h>
16 #include <linux/delay.h>
17 #include <linux/err.h>
18 #include <linux/bug.h>
19 #include <linux/lockdep.h>
20 #include <linux/iopoll.h>
21 #include <linux/fwnode.h>
22 
23 struct module;
24 struct clk;
25 struct device;
26 struct device_node;
27 struct fsi_device;
28 struct i2c_client;
29 struct i3c_device;
30 struct irq_domain;
31 struct mdio_device;
32 struct slim_device;
33 struct spi_device;
34 struct spmi_device;
35 struct regmap;
36 struct regmap_range_cfg;
37 struct regmap_field;
38 struct snd_ac97;
39 struct sdw_slave;
40 
41 /*
42  * regmap_mdio address encoding. IEEE 802.3ae clause 45 addresses consist of a
43  * device address and a register address.
44  */
45 #define REGMAP_MDIO_C45_DEVAD_SHIFT	16
46 #define REGMAP_MDIO_C45_DEVAD_MASK	GENMASK(20, 16)
47 #define REGMAP_MDIO_C45_REGNUM_MASK	GENMASK(15, 0)
48 
49 /*
50  * regmap.reg_shift indicates by how much we must shift registers prior to
51  * performing any operation. It's a signed value, positive numbers means
52  * downshifting the register's address, while negative numbers means upshifting.
53  */
54 #define REGMAP_UPSHIFT(s)	(-(s))
55 #define REGMAP_DOWNSHIFT(s)	(s)
56 
57 /*
58  * The supported cache types, the default is no cache.  Any new caches
59  * should usually use the maple tree cache unless they specifically
60  * require that there are never any allocations at runtime and can't
61  * provide defaults in which case they should use the flat cache.  The
62  * rbtree cache *may* have some performance advantage for very low end
63  * systems that make heavy use of cache syncs but is mainly legacy.
64  */
65 enum regcache_type {
66 	REGCACHE_NONE,
67 	REGCACHE_RBTREE,
68 	REGCACHE_FLAT,
69 	REGCACHE_MAPLE,
70 };
71 
72 /**
73  * struct reg_default - Default value for a register.
74  *
75  * @reg: Register address.
76  * @def: Register default value.
77  *
78  * We use an array of structs rather than a simple array as many modern devices
79  * have very sparse register maps.
80  */
81 struct reg_default {
82 	unsigned int reg;
83 	unsigned int def;
84 };
85 
86 /**
87  * struct reg_sequence - An individual write from a sequence of writes.
88  *
89  * @reg: Register address.
90  * @def: Register value.
91  * @delay_us: Delay to be applied after the register write in microseconds
92  *
93  * Register/value pairs for sequences of writes with an optional delay in
94  * microseconds to be applied after each write.
95  */
96 struct reg_sequence {
97 	unsigned int reg;
98 	unsigned int def;
99 	unsigned int delay_us;
100 };
101 
102 #define REG_SEQ(_reg, _def, _delay_us) {		\
103 				.reg = _reg,		\
104 				.def = _def,		\
105 				.delay_us = _delay_us,	\
106 				}
107 #define REG_SEQ0(_reg, _def)	REG_SEQ(_reg, _def, 0)
108 
109 /**
110  * regmap_read_poll_timeout - Poll until a condition is met or a timeout occurs
111  *
112  * @map: Regmap to read from
113  * @addr: Address to poll
114  * @val: Unsigned integer variable to read the value into
115  * @cond: Break condition (usually involving @val)
116  * @sleep_us: Maximum time to sleep between reads in us (0 tight-loops). Please
117  *            read usleep_range() function description for details and
118  *            limitations.
119  * @timeout_us: Timeout in us, 0 means never timeout
120  *
121  * This is modelled after the readx_poll_timeout macros in linux/iopoll.h.
122  *
123  * Returns: 0 on success and -ETIMEDOUT upon a timeout or the regmap_read
124  * error return value in case of a error read. In the two former cases,
125  * the last read value at @addr is stored in @val. Must not be called
126  * from atomic context if sleep_us or timeout_us are used.
127  */
128 #define regmap_read_poll_timeout(map, addr, val, cond, sleep_us, timeout_us) \
129 ({ \
130 	int __ret, __tmp; \
131 	__tmp = read_poll_timeout(regmap_read, __ret, __ret || (cond), \
132 			sleep_us, timeout_us, false, (map), (addr), &(val)); \
133 	__ret ?: __tmp; \
134 })
135 
136 /**
137  * regmap_read_poll_timeout_atomic - Poll until a condition is met or a timeout occurs
138  *
139  * @map: Regmap to read from
140  * @addr: Address to poll
141  * @val: Unsigned integer variable to read the value into
142  * @cond: Break condition (usually involving @val)
143  * @delay_us: Time to udelay between reads in us (0 tight-loops). Please
144  *            read udelay() function description for details and
145  *            limitations.
146  * @timeout_us: Timeout in us, 0 means never timeout
147  *
148  * This is modelled after the readx_poll_timeout_atomic macros in linux/iopoll.h.
149  *
150  * Note: In general regmap cannot be used in atomic context. If you want to use
151  * this macro then first setup your regmap for atomic use (flat or no cache
152  * and MMIO regmap).
153  *
154  * Returns: 0 on success and -ETIMEDOUT upon a timeout or the regmap_read
155  * error return value in case of a error read. In the two former cases,
156  * the last read value at @addr is stored in @val.
157  */
158 #define regmap_read_poll_timeout_atomic(map, addr, val, cond, delay_us, timeout_us) \
159 ({ \
160 	u64 __timeout_us = (timeout_us); \
161 	unsigned long __delay_us = (delay_us); \
162 	ktime_t __timeout = ktime_add_us(ktime_get(), __timeout_us); \
163 	int __ret; \
164 	for (;;) { \
165 		__ret = regmap_read((map), (addr), &(val)); \
166 		if (__ret) \
167 			break; \
168 		if (cond) \
169 			break; \
170 		if ((__timeout_us) && \
171 		    ktime_compare(ktime_get(), __timeout) > 0) { \
172 			__ret = regmap_read((map), (addr), &(val)); \
173 			break; \
174 		} \
175 		if (__delay_us) \
176 			udelay(__delay_us); \
177 	} \
178 	__ret ?: ((cond) ? 0 : -ETIMEDOUT); \
179 })
180 
181 /**
182  * regmap_field_read_poll_timeout - Poll until a condition is met or timeout
183  *
184  * @field: Regmap field to read from
185  * @val: Unsigned integer variable to read the value into
186  * @cond: Break condition (usually involving @val)
187  * @sleep_us: Maximum time to sleep between reads in us (0 tight-loops). Please
188  *            read usleep_range() function description for details and
189  *            limitations.
190  * @timeout_us: Timeout in us, 0 means never timeout
191  *
192  * This is modelled after the readx_poll_timeout macros in linux/iopoll.h.
193  *
194  * Returns: 0 on success and -ETIMEDOUT upon a timeout or the regmap_field_read
195  * error return value in case of a error read. In the two former cases,
196  * the last read value at @addr is stored in @val. Must not be called
197  * from atomic context if sleep_us or timeout_us are used.
198  */
199 #define regmap_field_read_poll_timeout(field, val, cond, sleep_us, timeout_us) \
200 ({ \
201 	int __ret, __tmp; \
202 	__tmp = read_poll_timeout(regmap_field_read, __ret, __ret || (cond), \
203 			sleep_us, timeout_us, false, (field), &(val)); \
204 	__ret ?: __tmp; \
205 })
206 
207 #ifdef CONFIG_REGMAP
208 
209 enum regmap_endian {
210 	/* Unspecified -> 0 -> Backwards compatible default */
211 	REGMAP_ENDIAN_DEFAULT = 0,
212 	REGMAP_ENDIAN_BIG,
213 	REGMAP_ENDIAN_LITTLE,
214 	REGMAP_ENDIAN_NATIVE,
215 };
216 
217 /**
218  * struct regmap_range - A register range, used for access related checks
219  *                       (readable/writeable/volatile/precious checks)
220  *
221  * @range_min: address of first register
222  * @range_max: address of last register
223  */
224 struct regmap_range {
225 	unsigned int range_min;
226 	unsigned int range_max;
227 };
228 
229 #define regmap_reg_range(low, high) { .range_min = low, .range_max = high, }
230 
231 /**
232  * struct regmap_access_table - A table of register ranges for access checks
233  *
234  * @yes_ranges : pointer to an array of regmap ranges used as "yes ranges"
235  * @n_yes_ranges: size of the above array
236  * @no_ranges: pointer to an array of regmap ranges used as "no ranges"
237  * @n_no_ranges: size of the above array
238  *
239  * A table of ranges including some yes ranges and some no ranges.
240  * If a register belongs to a no_range, the corresponding check function
241  * will return false. If a register belongs to a yes range, the corresponding
242  * check function will return true. "no_ranges" are searched first.
243  */
244 struct regmap_access_table {
245 	const struct regmap_range *yes_ranges;
246 	unsigned int n_yes_ranges;
247 	const struct regmap_range *no_ranges;
248 	unsigned int n_no_ranges;
249 };
250 
251 typedef void (*regmap_lock)(void *);
252 typedef void (*regmap_unlock)(void *);
253 
254 /**
255  * struct regmap_config - Configuration for the register map of a device.
256  *
257  * @name: Optional name of the regmap. Useful when a device has multiple
258  *        register regions.
259  *
260  * @reg_bits: Number of bits in a register address, mandatory.
261  * @reg_stride: The register address stride. Valid register addresses are a
262  *              multiple of this value. If set to 0, a value of 1 will be
263  *              used.
264  * @reg_shift: The number of bits to shift the register before performing any
265  *	       operations. Any positive number will be downshifted, and negative
266  *	       values will be upshifted
267  * @reg_base: Value to be added to every register address before performing any
268  *	      operation.
269  * @pad_bits: Number of bits of padding between register and value.
270  * @val_bits: Number of bits in a register value, mandatory.
271  *
272  * @writeable_reg: Optional callback returning true if the register
273  *		   can be written to. If this field is NULL but wr_table
274  *		   (see below) is not, the check is performed on such table
275  *                 (a register is writeable if it belongs to one of the ranges
276  *                  specified by wr_table).
277  * @readable_reg: Optional callback returning true if the register
278  *		  can be read from. If this field is NULL but rd_table
279  *		   (see below) is not, the check is performed on such table
280  *                 (a register is readable if it belongs to one of the ranges
281  *                  specified by rd_table).
282  * @volatile_reg: Optional callback returning true if the register
283  *		  value can't be cached. If this field is NULL but
284  *		  volatile_table (see below) is not, the check is performed on
285  *                such table (a register is volatile if it belongs to one of
286  *                the ranges specified by volatile_table).
287  * @precious_reg: Optional callback returning true if the register
288  *		  should not be read outside of a call from the driver
289  *		  (e.g., a clear on read interrupt status register). If this
290  *                field is NULL but precious_table (see below) is not, the
291  *                check is performed on such table (a register is precious if
292  *                it belongs to one of the ranges specified by precious_table).
293  * @writeable_noinc_reg: Optional callback returning true if the register
294  *			supports multiple write operations without incrementing
295  *			the register number. If this field is NULL but
296  *			wr_noinc_table (see below) is not, the check is
297  *			performed on such table (a register is no increment
298  *			writeable if it belongs to one of the ranges specified
299  *			by wr_noinc_table).
300  * @readable_noinc_reg: Optional callback returning true if the register
301  *			supports multiple read operations without incrementing
302  *			the register number. If this field is NULL but
303  *			rd_noinc_table (see below) is not, the check is
304  *			performed on such table (a register is no increment
305  *			readable if it belongs to one of the ranges specified
306  *			by rd_noinc_table).
307  * @reg_read:	  Optional callback that if filled will be used to perform
308  *           	  all the reads from the registers. Should only be provided for
309  *		  devices whose read operation cannot be represented as a simple
310  *		  read operation on a bus such as SPI, I2C, etc. Most of the
311  *		  devices do not need this.
312  * @reg_write:	  Same as above for writing.
313  * @reg_update_bits: Optional callback that if filled will be used to perform
314  *		     all the update_bits(rmw) operation. Should only be provided
315  *		     if the function require special handling with lock and reg
316  *		     handling and the operation cannot be represented as a simple
317  *		     update_bits operation on a bus such as SPI, I2C, etc.
318  * @read: Optional callback that if filled will be used to perform all the
319  *        bulk reads from the registers. Data is returned in the buffer used
320  *        to transmit data.
321  * @write: Same as above for writing.
322  * @max_raw_read: Max raw read size that can be used on the device.
323  * @max_raw_write: Max raw write size that can be used on the device.
324  * @can_sleep:	  Optional, specifies whether regmap operations can sleep.
325  * @fast_io:	  Register IO is fast. Use a spinlock instead of a mutex
326  *	     	  to perform locking. This field is ignored if custom lock/unlock
327  *	     	  functions are used (see fields lock/unlock of struct regmap_config).
328  *		  This field is a duplicate of a similar file in
329  *		  'struct regmap_bus' and serves exact same purpose.
330  *		   Use it only for "no-bus" cases.
331  * @io_port:	  Support IO port accessors. Makes sense only when MMIO vs. IO port
332  *		  access can be distinguished.
333  * @disable_locking: This regmap is either protected by external means or
334  *		     is guaranteed not to be accessed from multiple threads.
335  *		     Don't use any locking mechanisms.
336  * @lock:	  Optional lock callback (overrides regmap's default lock
337  *		  function, based on spinlock or mutex).
338  * @unlock:	  As above for unlocking.
339  * @lock_arg:	  This field is passed as the only argument of lock/unlock
340  *		  functions (ignored in case regular lock/unlock functions
341  *		  are not overridden).
342  * @max_register: Optional, specifies the maximum valid register address.
343  * @max_register_is_0: Optional, specifies that zero value in @max_register
344  *                     should be taken into account. This is a workaround to
345  *                     apply handling of @max_register for regmap that contains
346  *                     only one register.
347  * @wr_table:     Optional, points to a struct regmap_access_table specifying
348  *                valid ranges for write access.
349  * @rd_table:     As above, for read access.
350  * @volatile_table: As above, for volatile registers.
351  * @precious_table: As above, for precious registers.
352  * @wr_noinc_table: As above, for no increment writeable registers.
353  * @rd_noinc_table: As above, for no increment readable registers.
354  * @reg_defaults: Power on reset values for registers (for use with
355  *                register cache support).
356  * @num_reg_defaults: Number of elements in reg_defaults.
357  *
358  * @read_flag_mask: Mask to be set in the top bytes of the register when doing
359  *                  a read.
360  * @write_flag_mask: Mask to be set in the top bytes of the register when doing
361  *                   a write. If both read_flag_mask and write_flag_mask are
362  *                   empty and zero_flag_mask is not set the regmap_bus default
363  *                   masks are used.
364  * @zero_flag_mask: If set, read_flag_mask and write_flag_mask are used even
365  *                   if they are both empty.
366  * @use_relaxed_mmio: If set, MMIO R/W operations will not use memory barriers.
367  *                    This can avoid load on devices which don't require strict
368  *                    orderings, but drivers should carefully add any explicit
369  *                    memory barriers when they may require them.
370  * @use_single_read: If set, converts the bulk read operation into a series of
371  *                   single read operations. This is useful for a device that
372  *                   does not support  bulk read.
373  * @use_single_write: If set, converts the bulk write operation into a series of
374  *                    single write operations. This is useful for a device that
375  *                    does not support bulk write.
376  * @can_multi_write: If set, the device supports the multi write mode of bulk
377  *                   write operations, if clear multi write requests will be
378  *                   split into individual write operations
379  *
380  * @cache_type: The actual cache type.
381  * @reg_defaults_raw: Power on reset values for registers (for use with
382  *                    register cache support).
383  * @num_reg_defaults_raw: Number of elements in reg_defaults_raw.
384  * @use_hwlock: Indicate if a hardware spinlock should be used.
385  * @use_raw_spinlock: Indicate if a raw spinlock should be used.
386  * @hwlock_id: Specify the hardware spinlock id.
387  * @hwlock_mode: The hardware spinlock mode, should be HWLOCK_IRQSTATE,
388  *		 HWLOCK_IRQ or 0.
389  * @reg_format_endian: Endianness for formatted register addresses. If this is
390  *		       DEFAULT, the @reg_format_endian_default value from the
391  *		       regmap bus is used.
392  * @val_format_endian: Endianness for formatted register values. If this is
393  *		       DEFAULT, the @reg_format_endian_default value from the
394  *		       regmap bus is used.
395  *
396  * @ranges: Array of configuration entries for virtual address ranges.
397  * @num_ranges: Number of range configuration entries.
398  */
399 struct regmap_config {
400 	const char *name;
401 
402 	int reg_bits;
403 	int reg_stride;
404 	int reg_shift;
405 	unsigned int reg_base;
406 	int pad_bits;
407 	int val_bits;
408 
409 	bool (*writeable_reg)(struct device *dev, unsigned int reg);
410 	bool (*readable_reg)(struct device *dev, unsigned int reg);
411 	bool (*volatile_reg)(struct device *dev, unsigned int reg);
412 	bool (*precious_reg)(struct device *dev, unsigned int reg);
413 	bool (*writeable_noinc_reg)(struct device *dev, unsigned int reg);
414 	bool (*readable_noinc_reg)(struct device *dev, unsigned int reg);
415 
416 	int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
417 	int (*reg_write)(void *context, unsigned int reg, unsigned int val);
418 	int (*reg_update_bits)(void *context, unsigned int reg,
419 			       unsigned int mask, unsigned int val);
420 	/* Bulk read/write */
421 	int (*read)(void *context, const void *reg_buf, size_t reg_size,
422 		    void *val_buf, size_t val_size);
423 	int (*write)(void *context, const void *data, size_t count);
424 	size_t max_raw_read;
425 	size_t max_raw_write;
426 
427 	bool can_sleep;
428 
429 	bool fast_io;
430 	bool io_port;
431 
432 	bool disable_locking;
433 	regmap_lock lock;
434 	regmap_unlock unlock;
435 	void *lock_arg;
436 
437 	unsigned int max_register;
438 	bool max_register_is_0;
439 	const struct regmap_access_table *wr_table;
440 	const struct regmap_access_table *rd_table;
441 	const struct regmap_access_table *volatile_table;
442 	const struct regmap_access_table *precious_table;
443 	const struct regmap_access_table *wr_noinc_table;
444 	const struct regmap_access_table *rd_noinc_table;
445 	const struct reg_default *reg_defaults;
446 	unsigned int num_reg_defaults;
447 	enum regcache_type cache_type;
448 	const void *reg_defaults_raw;
449 	unsigned int num_reg_defaults_raw;
450 
451 	unsigned long read_flag_mask;
452 	unsigned long write_flag_mask;
453 	bool zero_flag_mask;
454 
455 	bool use_single_read;
456 	bool use_single_write;
457 	bool use_relaxed_mmio;
458 	bool can_multi_write;
459 
460 	bool use_hwlock;
461 	bool use_raw_spinlock;
462 	unsigned int hwlock_id;
463 	unsigned int hwlock_mode;
464 
465 	enum regmap_endian reg_format_endian;
466 	enum regmap_endian val_format_endian;
467 
468 	const struct regmap_range_cfg *ranges;
469 	unsigned int num_ranges;
470 };
471 
472 /**
473  * struct regmap_range_cfg - Configuration for indirectly accessed or paged
474  *                           registers.
475  *
476  * @name: Descriptive name for diagnostics
477  *
478  * @range_min: Address of the lowest register address in virtual range.
479  * @range_max: Address of the highest register in virtual range.
480  *
481  * @selector_reg: Register with selector field.
482  * @selector_mask: Bit mask for selector value.
483  * @selector_shift: Bit shift for selector value.
484  *
485  * @window_start: Address of first (lowest) register in data window.
486  * @window_len: Number of registers in data window.
487  *
488  * Registers, mapped to this virtual range, are accessed in two steps:
489  *     1. page selector register update;
490  *     2. access through data window registers.
491  */
492 struct regmap_range_cfg {
493 	const char *name;
494 
495 	/* Registers of virtual address range */
496 	unsigned int range_min;
497 	unsigned int range_max;
498 
499 	/* Page selector for indirect addressing */
500 	unsigned int selector_reg;
501 	unsigned int selector_mask;
502 	int selector_shift;
503 
504 	/* Data window (per each page) */
505 	unsigned int window_start;
506 	unsigned int window_len;
507 };
508 
509 /**
510  * struct regmap_sdw_mbq_cfg - Configuration for Multi-Byte Quantities
511  *
512  * @mbq_size: Callback returning the actual size of the given register.
513  * @deferrable: Callback returning true if the hardware can defer
514  *              transactions to the given register. Deferral should
515  *              only be used by SDCA parts and typically which controls
516  *              are deferrable will be specified in either as a hard
517  *              coded list or from the DisCo tables in the platform
518  *              firmware.
519  *
520  * @timeout_us: The time in microseconds after which waiting for a deferred
521  *              transaction should time out.
522  * @retry_us: The time in microseconds between polls of the function busy
523  *            status whilst waiting for an opportunity to retry a deferred
524  *            transaction.
525  *
526  * Provides additional configuration required for SoundWire MBQ register maps.
527  */
528 struct regmap_sdw_mbq_cfg {
529 	int (*mbq_size)(struct device *dev, unsigned int reg);
530 	bool (*deferrable)(struct device *dev, unsigned int reg);
531 	unsigned long timeout_us;
532 	unsigned long retry_us;
533 };
534 
535 struct regmap_async;
536 
537 typedef int (*regmap_hw_write)(void *context, const void *data,
538 			       size_t count);
539 typedef int (*regmap_hw_gather_write)(void *context,
540 				      const void *reg, size_t reg_len,
541 				      const void *val, size_t val_len);
542 typedef int (*regmap_hw_async_write)(void *context,
543 				     const void *reg, size_t reg_len,
544 				     const void *val, size_t val_len,
545 				     struct regmap_async *async);
546 typedef int (*regmap_hw_read)(void *context,
547 			      const void *reg_buf, size_t reg_size,
548 			      void *val_buf, size_t val_size);
549 typedef int (*regmap_hw_reg_read)(void *context, unsigned int reg,
550 				  unsigned int *val);
551 typedef int (*regmap_hw_reg_noinc_read)(void *context, unsigned int reg,
552 					void *val, size_t val_count);
553 typedef int (*regmap_hw_reg_write)(void *context, unsigned int reg,
554 				   unsigned int val);
555 typedef int (*regmap_hw_reg_noinc_write)(void *context, unsigned int reg,
556 					 const void *val, size_t val_count);
557 typedef int (*regmap_hw_reg_update_bits)(void *context, unsigned int reg,
558 					 unsigned int mask, unsigned int val);
559 typedef struct regmap_async *(*regmap_hw_async_alloc)(void);
560 typedef void (*regmap_hw_free_context)(void *context);
561 
562 /**
563  * struct regmap_bus - Description of a hardware bus for the register map
564  *                     infrastructure.
565  *
566  * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
567  *	     to perform locking. This field is ignored if custom lock/unlock
568  *	     functions are used (see fields lock/unlock of
569  *	     struct regmap_config).
570  * @free_on_exit: kfree this on exit of regmap
571  * @write: Write operation.
572  * @gather_write: Write operation with split register/value, return -ENOTSUPP
573  *                if not implemented  on a given device.
574  * @async_write: Write operation which completes asynchronously, optional and
575  *               must serialise with respect to non-async I/O.
576  * @reg_write: Write a single register value to the given register address. This
577  *             write operation has to complete when returning from the function.
578  * @reg_write_noinc: Write multiple register value to the same register. This
579  *             write operation has to complete when returning from the function.
580  * @reg_update_bits: Update bits operation to be used against volatile
581  *                   registers, intended for devices supporting some mechanism
582  *                   for setting clearing bits without having to
583  *                   read/modify/write.
584  * @read: Read operation.  Data is returned in the buffer used to transmit
585  *         data.
586  * @reg_read: Read a single register value from a given register address.
587  * @free_context: Free context.
588  * @async_alloc: Allocate a regmap_async() structure.
589  * @read_flag_mask: Mask to be set in the top byte of the register when doing
590  *                  a read.
591  * @reg_format_endian_default: Default endianness for formatted register
592  *     addresses. Used when the regmap_config specifies DEFAULT. If this is
593  *     DEFAULT, BIG is assumed.
594  * @val_format_endian_default: Default endianness for formatted register
595  *     values. Used when the regmap_config specifies DEFAULT. If this is
596  *     DEFAULT, BIG is assumed.
597  * @max_raw_read: Max raw read size that can be used on the bus.
598  * @max_raw_write: Max raw write size that can be used on the bus.
599  */
600 struct regmap_bus {
601 	bool fast_io;
602 	bool free_on_exit;
603 	regmap_hw_write write;
604 	regmap_hw_gather_write gather_write;
605 	regmap_hw_async_write async_write;
606 	regmap_hw_reg_write reg_write;
607 	regmap_hw_reg_noinc_write reg_noinc_write;
608 	regmap_hw_reg_update_bits reg_update_bits;
609 	regmap_hw_read read;
610 	regmap_hw_reg_read reg_read;
611 	regmap_hw_reg_noinc_read reg_noinc_read;
612 	regmap_hw_free_context free_context;
613 	regmap_hw_async_alloc async_alloc;
614 	u8 read_flag_mask;
615 	enum regmap_endian reg_format_endian_default;
616 	enum regmap_endian val_format_endian_default;
617 	size_t max_raw_read;
618 	size_t max_raw_write;
619 };
620 
621 /*
622  * __regmap_init functions.
623  *
624  * These functions take a lock key and name parameter, and should not be called
625  * directly. Instead, use the regmap_init macros that generate a key and name
626  * for each call.
627  */
628 struct regmap *__regmap_init(struct device *dev,
629 			     const struct regmap_bus *bus,
630 			     void *bus_context,
631 			     const struct regmap_config *config,
632 			     struct lock_class_key *lock_key,
633 			     const char *lock_name);
634 struct regmap *__regmap_init_i2c(struct i2c_client *i2c,
635 				 const struct regmap_config *config,
636 				 struct lock_class_key *lock_key,
637 				 const char *lock_name);
638 struct regmap *__regmap_init_mdio(struct mdio_device *mdio_dev,
639 				 const struct regmap_config *config,
640 				 struct lock_class_key *lock_key,
641 				 const char *lock_name);
642 struct regmap *__regmap_init_sccb(struct i2c_client *i2c,
643 				  const struct regmap_config *config,
644 				  struct lock_class_key *lock_key,
645 				  const char *lock_name);
646 struct regmap *__regmap_init_slimbus(struct slim_device *slimbus,
647 				 const struct regmap_config *config,
648 				 struct lock_class_key *lock_key,
649 				 const char *lock_name);
650 struct regmap *__regmap_init_spi(struct spi_device *dev,
651 				 const struct regmap_config *config,
652 				 struct lock_class_key *lock_key,
653 				 const char *lock_name);
654 struct regmap *__regmap_init_spmi_base(struct spmi_device *dev,
655 				       const struct regmap_config *config,
656 				       struct lock_class_key *lock_key,
657 				       const char *lock_name);
658 struct regmap *__regmap_init_spmi_ext(struct spmi_device *dev,
659 				      const struct regmap_config *config,
660 				      struct lock_class_key *lock_key,
661 				      const char *lock_name);
662 struct regmap *__regmap_init_w1(struct device *w1_dev,
663 				 const struct regmap_config *config,
664 				 struct lock_class_key *lock_key,
665 				 const char *lock_name);
666 struct regmap *__regmap_init_mmio_clk(struct device *dev, const char *clk_id,
667 				      void __iomem *regs,
668 				      const struct regmap_config *config,
669 				      struct lock_class_key *lock_key,
670 				      const char *lock_name);
671 struct regmap *__regmap_init_ac97(struct snd_ac97 *ac97,
672 				  const struct regmap_config *config,
673 				  struct lock_class_key *lock_key,
674 				  const char *lock_name);
675 struct regmap *__regmap_init_sdw(struct sdw_slave *sdw,
676 				 const struct regmap_config *config,
677 				 struct lock_class_key *lock_key,
678 				 const char *lock_name);
679 struct regmap *__regmap_init_sdw_mbq(struct sdw_slave *sdw,
680 				     const struct regmap_config *config,
681 				     const struct regmap_sdw_mbq_cfg *mbq_config,
682 				     struct lock_class_key *lock_key,
683 				     const char *lock_name);
684 struct regmap *__regmap_init_spi_avmm(struct spi_device *spi,
685 				      const struct regmap_config *config,
686 				      struct lock_class_key *lock_key,
687 				      const char *lock_name);
688 struct regmap *__regmap_init_fsi(struct fsi_device *fsi_dev,
689 				 const struct regmap_config *config,
690 				 struct lock_class_key *lock_key,
691 				 const char *lock_name);
692 
693 struct regmap *__devm_regmap_init(struct device *dev,
694 				  const struct regmap_bus *bus,
695 				  void *bus_context,
696 				  const struct regmap_config *config,
697 				  struct lock_class_key *lock_key,
698 				  const char *lock_name);
699 struct regmap *__devm_regmap_init_i2c(struct i2c_client *i2c,
700 				      const struct regmap_config *config,
701 				      struct lock_class_key *lock_key,
702 				      const char *lock_name);
703 struct regmap *__devm_regmap_init_mdio(struct mdio_device *mdio_dev,
704 				      const struct regmap_config *config,
705 				      struct lock_class_key *lock_key,
706 				      const char *lock_name);
707 struct regmap *__devm_regmap_init_sccb(struct i2c_client *i2c,
708 				       const struct regmap_config *config,
709 				       struct lock_class_key *lock_key,
710 				       const char *lock_name);
711 struct regmap *__devm_regmap_init_spi(struct spi_device *dev,
712 				      const struct regmap_config *config,
713 				      struct lock_class_key *lock_key,
714 				      const char *lock_name);
715 struct regmap *__devm_regmap_init_spmi_base(struct spmi_device *dev,
716 					    const struct regmap_config *config,
717 					    struct lock_class_key *lock_key,
718 					    const char *lock_name);
719 struct regmap *__devm_regmap_init_spmi_ext(struct spmi_device *dev,
720 					   const struct regmap_config *config,
721 					   struct lock_class_key *lock_key,
722 					   const char *lock_name);
723 struct regmap *__devm_regmap_init_w1(struct device *w1_dev,
724 				      const struct regmap_config *config,
725 				      struct lock_class_key *lock_key,
726 				      const char *lock_name);
727 struct regmap *__devm_regmap_init_mmio_clk(struct device *dev,
728 					   const char *clk_id,
729 					   void __iomem *regs,
730 					   const struct regmap_config *config,
731 					   struct lock_class_key *lock_key,
732 					   const char *lock_name);
733 struct regmap *__devm_regmap_init_ac97(struct snd_ac97 *ac97,
734 				       const struct regmap_config *config,
735 				       struct lock_class_key *lock_key,
736 				       const char *lock_name);
737 struct regmap *__devm_regmap_init_sdw(struct sdw_slave *sdw,
738 				 const struct regmap_config *config,
739 				 struct lock_class_key *lock_key,
740 				 const char *lock_name);
741 struct regmap *__devm_regmap_init_sdw_mbq(struct sdw_slave *sdw,
742 					  const struct regmap_config *config,
743 					  const struct regmap_sdw_mbq_cfg *mbq_config,
744 					  struct lock_class_key *lock_key,
745 					  const char *lock_name);
746 struct regmap *__devm_regmap_init_slimbus(struct slim_device *slimbus,
747 				 const struct regmap_config *config,
748 				 struct lock_class_key *lock_key,
749 				 const char *lock_name);
750 struct regmap *__devm_regmap_init_i3c(struct i3c_device *i3c,
751 				 const struct regmap_config *config,
752 				 struct lock_class_key *lock_key,
753 				 const char *lock_name);
754 struct regmap *__devm_regmap_init_spi_avmm(struct spi_device *spi,
755 					   const struct regmap_config *config,
756 					   struct lock_class_key *lock_key,
757 					   const char *lock_name);
758 struct regmap *__devm_regmap_init_fsi(struct fsi_device *fsi_dev,
759 				      const struct regmap_config *config,
760 				      struct lock_class_key *lock_key,
761 				      const char *lock_name);
762 
763 /*
764  * Wrapper for regmap_init macros to include a unique lockdep key and name
765  * for each call. No-op if CONFIG_LOCKDEP is not set.
766  *
767  * @fn: Real function to call (in the form __[*_]regmap_init[_*])
768  * @name: Config variable name (#config in the calling macro)
769  **/
770 #ifdef CONFIG_LOCKDEP
771 #define __regmap_lockdep_wrapper(fn, name, ...)				\
772 (									\
773 	({								\
774 		static struct lock_class_key _key;			\
775 		fn(__VA_ARGS__, &_key,					\
776 			KBUILD_BASENAME ":"				\
777 			__stringify(__LINE__) ":"			\
778 			"(" name ")->lock");				\
779 	})								\
780 )
781 #else
782 #define __regmap_lockdep_wrapper(fn, name, ...) fn(__VA_ARGS__, NULL, NULL)
783 #endif
784 
785 /**
786  * regmap_init() - Initialise register map
787  *
788  * @dev: Device that will be interacted with
789  * @bus: Bus-specific callbacks to use with device
790  * @bus_context: Data passed to bus-specific callbacks
791  * @config: Configuration for register map
792  *
793  * The return value will be an ERR_PTR() on error or a valid pointer to
794  * a struct regmap.  This function should generally not be called
795  * directly, it should be called by bus-specific init functions.
796  */
797 #define regmap_init(dev, bus, bus_context, config)			\
798 	__regmap_lockdep_wrapper(__regmap_init, #config,		\
799 				dev, bus, bus_context, config)
800 int regmap_attach_dev(struct device *dev, struct regmap *map,
801 		      const struct regmap_config *config);
802 
803 /**
804  * regmap_init_i2c() - Initialise register map
805  *
806  * @i2c: Device that will be interacted with
807  * @config: Configuration for register map
808  *
809  * The return value will be an ERR_PTR() on error or a valid pointer to
810  * a struct regmap.
811  */
812 #define regmap_init_i2c(i2c, config)					\
813 	__regmap_lockdep_wrapper(__regmap_init_i2c, #config,		\
814 				i2c, config)
815 
816 /**
817  * regmap_init_mdio() - Initialise register map
818  *
819  * @mdio_dev: Device that will be interacted with
820  * @config: Configuration for register map
821  *
822  * The return value will be an ERR_PTR() on error or a valid pointer to
823  * a struct regmap.
824  */
825 #define regmap_init_mdio(mdio_dev, config)				\
826 	__regmap_lockdep_wrapper(__regmap_init_mdio, #config,		\
827 				mdio_dev, config)
828 
829 /**
830  * regmap_init_sccb() - Initialise register map
831  *
832  * @i2c: Device that will be interacted with
833  * @config: Configuration for register map
834  *
835  * The return value will be an ERR_PTR() on error or a valid pointer to
836  * a struct regmap.
837  */
838 #define regmap_init_sccb(i2c, config)					\
839 	__regmap_lockdep_wrapper(__regmap_init_sccb, #config,		\
840 				i2c, config)
841 
842 /**
843  * regmap_init_slimbus() - Initialise register map
844  *
845  * @slimbus: Device that will be interacted with
846  * @config: Configuration for register map
847  *
848  * The return value will be an ERR_PTR() on error or a valid pointer to
849  * a struct regmap.
850  */
851 #define regmap_init_slimbus(slimbus, config)				\
852 	__regmap_lockdep_wrapper(__regmap_init_slimbus, #config,	\
853 				slimbus, config)
854 
855 /**
856  * regmap_init_spi() - Initialise register map
857  *
858  * @dev: Device that will be interacted with
859  * @config: Configuration for register map
860  *
861  * The return value will be an ERR_PTR() on error or a valid pointer to
862  * a struct regmap.
863  */
864 #define regmap_init_spi(dev, config)					\
865 	__regmap_lockdep_wrapper(__regmap_init_spi, #config,		\
866 				dev, config)
867 
868 /**
869  * regmap_init_spmi_base() - Create regmap for the Base register space
870  *
871  * @dev:	SPMI device that will be interacted with
872  * @config:	Configuration for register map
873  *
874  * The return value will be an ERR_PTR() on error or a valid pointer to
875  * a struct regmap.
876  */
877 #define regmap_init_spmi_base(dev, config)				\
878 	__regmap_lockdep_wrapper(__regmap_init_spmi_base, #config,	\
879 				dev, config)
880 
881 /**
882  * regmap_init_spmi_ext() - Create regmap for Ext register space
883  *
884  * @dev:	Device that will be interacted with
885  * @config:	Configuration for register map
886  *
887  * The return value will be an ERR_PTR() on error or a valid pointer to
888  * a struct regmap.
889  */
890 #define regmap_init_spmi_ext(dev, config)				\
891 	__regmap_lockdep_wrapper(__regmap_init_spmi_ext, #config,	\
892 				dev, config)
893 
894 /**
895  * regmap_init_w1() - Initialise register map
896  *
897  * @w1_dev: Device that will be interacted with
898  * @config: Configuration for register map
899  *
900  * The return value will be an ERR_PTR() on error or a valid pointer to
901  * a struct regmap.
902  */
903 #define regmap_init_w1(w1_dev, config)					\
904 	__regmap_lockdep_wrapper(__regmap_init_w1, #config,		\
905 				w1_dev, config)
906 
907 /**
908  * regmap_init_mmio_clk() - Initialise register map with register clock
909  *
910  * @dev: Device that will be interacted with
911  * @clk_id: register clock consumer ID
912  * @regs: Pointer to memory-mapped IO region
913  * @config: Configuration for register map
914  *
915  * The return value will be an ERR_PTR() on error or a valid pointer to
916  * a struct regmap.
917  */
918 #define regmap_init_mmio_clk(dev, clk_id, regs, config)			\
919 	__regmap_lockdep_wrapper(__regmap_init_mmio_clk, #config,	\
920 				dev, clk_id, regs, config)
921 
922 /**
923  * regmap_init_mmio() - Initialise register map
924  *
925  * @dev: Device that will be interacted with
926  * @regs: Pointer to memory-mapped IO region
927  * @config: Configuration for register map
928  *
929  * The return value will be an ERR_PTR() on error or a valid pointer to
930  * a struct regmap.
931  */
932 #define regmap_init_mmio(dev, regs, config)		\
933 	regmap_init_mmio_clk(dev, NULL, regs, config)
934 
935 /**
936  * regmap_init_ac97() - Initialise AC'97 register map
937  *
938  * @ac97: Device that will be interacted with
939  * @config: Configuration for register map
940  *
941  * The return value will be an ERR_PTR() on error or a valid pointer to
942  * a struct regmap.
943  */
944 #define regmap_init_ac97(ac97, config)					\
945 	__regmap_lockdep_wrapper(__regmap_init_ac97, #config,		\
946 				ac97, config)
947 bool regmap_ac97_default_volatile(struct device *dev, unsigned int reg);
948 
949 /**
950  * regmap_init_sdw() - Initialise register map
951  *
952  * @sdw: Device that will be interacted with
953  * @config: Configuration for register map
954  *
955  * The return value will be an ERR_PTR() on error or a valid pointer to
956  * a struct regmap.
957  */
958 #define regmap_init_sdw(sdw, config)					\
959 	__regmap_lockdep_wrapper(__regmap_init_sdw, #config,		\
960 				sdw, config)
961 
962 /**
963  * regmap_init_sdw_mbq() - Initialise register map
964  *
965  * @sdw: Device that will be interacted with
966  * @config: Configuration for register map
967  *
968  * The return value will be an ERR_PTR() on error or a valid pointer to
969  * a struct regmap.
970  */
971 #define regmap_init_sdw_mbq(sdw, config)					\
972 	__regmap_lockdep_wrapper(__regmap_init_sdw_mbq, #config,		\
973 				sdw, config, NULL)
974 
975 /**
976  * regmap_init_sdw_mbq_cfg() - Initialise MBQ SDW register map with config
977  *
978  * @sdw: Device that will be interacted with
979  * @config: Configuration for register map
980  * @mbq_config: Properties for the MBQ registers
981  *
982  * The return value will be an ERR_PTR() on error or a valid pointer
983  * to a struct regmap. The regmap will be automatically freed by the
984  * device management code.
985  */
986 #define regmap_init_sdw_mbq_cfg(sdw, config, mbq_config)		\
987 	__regmap_lockdep_wrapper(__regmap_init_sdw_mbq, #config,	\
988 				sdw, config, mbq_config)
989 
990 /**
991  * regmap_init_spi_avmm() - Initialize register map for Intel SPI Slave
992  * to AVMM Bus Bridge
993  *
994  * @spi: Device that will be interacted with
995  * @config: Configuration for register map
996  *
997  * The return value will be an ERR_PTR() on error or a valid pointer
998  * to a struct regmap.
999  */
1000 #define regmap_init_spi_avmm(spi, config)					\
1001 	__regmap_lockdep_wrapper(__regmap_init_spi_avmm, #config,		\
1002 				 spi, config)
1003 
1004 /**
1005  * regmap_init_fsi() - Initialise register map
1006  *
1007  * @fsi_dev: Device that will be interacted with
1008  * @config: Configuration for register map
1009  *
1010  * The return value will be an ERR_PTR() on error or a valid pointer to
1011  * a struct regmap.
1012  */
1013 #define regmap_init_fsi(fsi_dev, config)				\
1014 	__regmap_lockdep_wrapper(__regmap_init_fsi, #config, fsi_dev,	\
1015 				 config)
1016 
1017 /**
1018  * devm_regmap_init() - Initialise managed register map
1019  *
1020  * @dev: Device that will be interacted with
1021  * @bus: Bus-specific callbacks to use with device
1022  * @bus_context: Data passed to bus-specific callbacks
1023  * @config: Configuration for register map
1024  *
1025  * The return value will be an ERR_PTR() on error or a valid pointer
1026  * to a struct regmap.  This function should generally not be called
1027  * directly, it should be called by bus-specific init functions.  The
1028  * map will be automatically freed by the device management code.
1029  */
1030 #define devm_regmap_init(dev, bus, bus_context, config)			\
1031 	__regmap_lockdep_wrapper(__devm_regmap_init, #config,		\
1032 				dev, bus, bus_context, config)
1033 
1034 /**
1035  * devm_regmap_init_i2c() - Initialise managed register map
1036  *
1037  * @i2c: Device that will be interacted with
1038  * @config: Configuration for register map
1039  *
1040  * The return value will be an ERR_PTR() on error or a valid pointer
1041  * to a struct regmap.  The regmap will be automatically freed by the
1042  * device management code.
1043  */
1044 #define devm_regmap_init_i2c(i2c, config)				\
1045 	__regmap_lockdep_wrapper(__devm_regmap_init_i2c, #config,	\
1046 				i2c, config)
1047 
1048 /**
1049  * devm_regmap_init_mdio() - Initialise managed register map
1050  *
1051  * @mdio_dev: Device that will be interacted with
1052  * @config: Configuration for register map
1053  *
1054  * The return value will be an ERR_PTR() on error or a valid pointer
1055  * to a struct regmap.  The regmap will be automatically freed by the
1056  * device management code.
1057  */
1058 #define devm_regmap_init_mdio(mdio_dev, config)				\
1059 	__regmap_lockdep_wrapper(__devm_regmap_init_mdio, #config,	\
1060 				mdio_dev, config)
1061 
1062 /**
1063  * devm_regmap_init_sccb() - Initialise managed register map
1064  *
1065  * @i2c: Device that will be interacted with
1066  * @config: Configuration for register map
1067  *
1068  * The return value will be an ERR_PTR() on error or a valid pointer
1069  * to a struct regmap.  The regmap will be automatically freed by the
1070  * device management code.
1071  */
1072 #define devm_regmap_init_sccb(i2c, config)				\
1073 	__regmap_lockdep_wrapper(__devm_regmap_init_sccb, #config,	\
1074 				i2c, config)
1075 
1076 /**
1077  * devm_regmap_init_spi() - Initialise register map
1078  *
1079  * @dev: Device that will be interacted with
1080  * @config: Configuration for register map
1081  *
1082  * The return value will be an ERR_PTR() on error or a valid pointer
1083  * to a struct regmap.  The map will be automatically freed by the
1084  * device management code.
1085  */
1086 #define devm_regmap_init_spi(dev, config)				\
1087 	__regmap_lockdep_wrapper(__devm_regmap_init_spi, #config,	\
1088 				dev, config)
1089 
1090 /**
1091  * devm_regmap_init_spmi_base() - Create managed regmap for Base register space
1092  *
1093  * @dev:	SPMI device that will be interacted with
1094  * @config:	Configuration for register map
1095  *
1096  * The return value will be an ERR_PTR() on error or a valid pointer
1097  * to a struct regmap.  The regmap will be automatically freed by the
1098  * device management code.
1099  */
1100 #define devm_regmap_init_spmi_base(dev, config)				\
1101 	__regmap_lockdep_wrapper(__devm_regmap_init_spmi_base, #config,	\
1102 				dev, config)
1103 
1104 /**
1105  * devm_regmap_init_spmi_ext() - Create managed regmap for Ext register space
1106  *
1107  * @dev:	SPMI device that will be interacted with
1108  * @config:	Configuration for register map
1109  *
1110  * The return value will be an ERR_PTR() on error or a valid pointer
1111  * to a struct regmap.  The regmap will be automatically freed by the
1112  * device management code.
1113  */
1114 #define devm_regmap_init_spmi_ext(dev, config)				\
1115 	__regmap_lockdep_wrapper(__devm_regmap_init_spmi_ext, #config,	\
1116 				dev, config)
1117 
1118 /**
1119  * devm_regmap_init_w1() - Initialise managed register map
1120  *
1121  * @w1_dev: Device that will be interacted with
1122  * @config: Configuration for register map
1123  *
1124  * The return value will be an ERR_PTR() on error or a valid pointer
1125  * to a struct regmap.  The regmap will be automatically freed by the
1126  * device management code.
1127  */
1128 #define devm_regmap_init_w1(w1_dev, config)				\
1129 	__regmap_lockdep_wrapper(__devm_regmap_init_w1, #config,	\
1130 				w1_dev, config)
1131 /**
1132  * devm_regmap_init_mmio_clk() - Initialise managed register map with clock
1133  *
1134  * @dev: Device that will be interacted with
1135  * @clk_id: register clock consumer ID
1136  * @regs: Pointer to memory-mapped IO region
1137  * @config: Configuration for register map
1138  *
1139  * The return value will be an ERR_PTR() on error or a valid pointer
1140  * to a struct regmap.  The regmap will be automatically freed by the
1141  * device management code.
1142  */
1143 #define devm_regmap_init_mmio_clk(dev, clk_id, regs, config)		\
1144 	__regmap_lockdep_wrapper(__devm_regmap_init_mmio_clk, #config,	\
1145 				dev, clk_id, regs, config)
1146 
1147 /**
1148  * devm_regmap_init_mmio() - Initialise managed register map
1149  *
1150  * @dev: Device that will be interacted with
1151  * @regs: Pointer to memory-mapped IO region
1152  * @config: Configuration for register map
1153  *
1154  * The return value will be an ERR_PTR() on error or a valid pointer
1155  * to a struct regmap.  The regmap will be automatically freed by the
1156  * device management code.
1157  */
1158 #define devm_regmap_init_mmio(dev, regs, config)		\
1159 	devm_regmap_init_mmio_clk(dev, NULL, regs, config)
1160 
1161 /**
1162  * devm_regmap_init_ac97() - Initialise AC'97 register map
1163  *
1164  * @ac97: Device that will be interacted with
1165  * @config: Configuration for register map
1166  *
1167  * The return value will be an ERR_PTR() on error or a valid pointer
1168  * to a struct regmap.  The regmap will be automatically freed by the
1169  * device management code.
1170  */
1171 #define devm_regmap_init_ac97(ac97, config)				\
1172 	__regmap_lockdep_wrapper(__devm_regmap_init_ac97, #config,	\
1173 				ac97, config)
1174 
1175 /**
1176  * devm_regmap_init_sdw() - Initialise managed register map
1177  *
1178  * @sdw: Device that will be interacted with
1179  * @config: Configuration for register map
1180  *
1181  * The return value will be an ERR_PTR() on error or a valid pointer
1182  * to a struct regmap. The regmap will be automatically freed by the
1183  * device management code.
1184  */
1185 #define devm_regmap_init_sdw(sdw, config)				\
1186 	__regmap_lockdep_wrapper(__devm_regmap_init_sdw, #config,	\
1187 				sdw, config)
1188 
1189 /**
1190  * devm_regmap_init_sdw_mbq() - Initialise managed register map
1191  *
1192  * @sdw: Device that will be interacted with
1193  * @config: Configuration for register map
1194  *
1195  * The return value will be an ERR_PTR() on error or a valid pointer
1196  * to a struct regmap. The regmap will be automatically freed by the
1197  * device management code.
1198  */
1199 #define devm_regmap_init_sdw_mbq(sdw, config)			\
1200 	__regmap_lockdep_wrapper(__devm_regmap_init_sdw_mbq, #config,   \
1201 				sdw, config, NULL)
1202 
1203 /**
1204  * devm_regmap_init_sdw_mbq_cfg() - Initialise managed MBQ SDW register map with config
1205  *
1206  * @sdw: Device that will be interacted with
1207  * @config: Configuration for register map
1208  * @mbq_config: Properties for the MBQ registers
1209  *
1210  * The return value will be an ERR_PTR() on error or a valid pointer
1211  * to a struct regmap. The regmap will be automatically freed by the
1212  * device management code.
1213  */
1214 #define devm_regmap_init_sdw_mbq_cfg(sdw, config, mbq_config)	\
1215 	__regmap_lockdep_wrapper(__devm_regmap_init_sdw_mbq,	\
1216 				#config, sdw, config, mbq_config)
1217 
1218 /**
1219  * devm_regmap_init_slimbus() - Initialise managed register map
1220  *
1221  * @slimbus: Device that will be interacted with
1222  * @config: Configuration for register map
1223  *
1224  * The return value will be an ERR_PTR() on error or a valid pointer
1225  * to a struct regmap. The regmap will be automatically freed by the
1226  * device management code.
1227  */
1228 #define devm_regmap_init_slimbus(slimbus, config)			\
1229 	__regmap_lockdep_wrapper(__devm_regmap_init_slimbus, #config,	\
1230 				slimbus, config)
1231 
1232 /**
1233  * devm_regmap_init_i3c() - Initialise managed register map
1234  *
1235  * @i3c: Device that will be interacted with
1236  * @config: Configuration for register map
1237  *
1238  * The return value will be an ERR_PTR() on error or a valid pointer
1239  * to a struct regmap.  The regmap will be automatically freed by the
1240  * device management code.
1241  */
1242 #define devm_regmap_init_i3c(i3c, config)				\
1243 	__regmap_lockdep_wrapper(__devm_regmap_init_i3c, #config,	\
1244 				i3c, config)
1245 
1246 /**
1247  * devm_regmap_init_spi_avmm() - Initialize register map for Intel SPI Slave
1248  * to AVMM Bus Bridge
1249  *
1250  * @spi: Device that will be interacted with
1251  * @config: Configuration for register map
1252  *
1253  * The return value will be an ERR_PTR() on error or a valid pointer
1254  * to a struct regmap.  The map will be automatically freed by the
1255  * device management code.
1256  */
1257 #define devm_regmap_init_spi_avmm(spi, config)				\
1258 	__regmap_lockdep_wrapper(__devm_regmap_init_spi_avmm, #config,	\
1259 				 spi, config)
1260 
1261 /**
1262  * devm_regmap_init_fsi() - Initialise managed register map
1263  *
1264  * @fsi_dev: Device that will be interacted with
1265  * @config: Configuration for register map
1266  *
1267  * The return value will be an ERR_PTR() on error or a valid pointer
1268  * to a struct regmap.  The regmap will be automatically freed by the
1269  * device management code.
1270  */
1271 #define devm_regmap_init_fsi(fsi_dev, config)				\
1272 	__regmap_lockdep_wrapper(__devm_regmap_init_fsi, #config,	\
1273 				 fsi_dev, config)
1274 
1275 int regmap_mmio_attach_clk(struct regmap *map, struct clk *clk);
1276 void regmap_mmio_detach_clk(struct regmap *map);
1277 void regmap_exit(struct regmap *map);
1278 int regmap_reinit_cache(struct regmap *map,
1279 			const struct regmap_config *config);
1280 struct regmap *dev_get_regmap(struct device *dev, const char *name);
1281 struct device *regmap_get_device(struct regmap *map);
1282 int regmap_write(struct regmap *map, unsigned int reg, unsigned int val);
1283 int regmap_write_async(struct regmap *map, unsigned int reg, unsigned int val);
1284 int regmap_raw_write(struct regmap *map, unsigned int reg,
1285 		     const void *val, size_t val_len);
1286 int regmap_noinc_write(struct regmap *map, unsigned int reg,
1287 		     const void *val, size_t val_len);
1288 int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
1289 			size_t val_count);
1290 int regmap_multi_reg_write(struct regmap *map, const struct reg_sequence *regs,
1291 			int num_regs);
1292 int regmap_multi_reg_write_bypassed(struct regmap *map,
1293 				    const struct reg_sequence *regs,
1294 				    int num_regs);
1295 int regmap_raw_write_async(struct regmap *map, unsigned int reg,
1296 			   const void *val, size_t val_len);
1297 int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val);
1298 int regmap_read_bypassed(struct regmap *map, unsigned int reg, unsigned int *val);
1299 int regmap_raw_read(struct regmap *map, unsigned int reg,
1300 		    void *val, size_t val_len);
1301 int regmap_noinc_read(struct regmap *map, unsigned int reg,
1302 		      void *val, size_t val_len);
1303 int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
1304 		     size_t val_count);
1305 int regmap_multi_reg_read(struct regmap *map, const unsigned int *reg, void *val,
1306 			  size_t val_count);
1307 int regmap_update_bits_base(struct regmap *map, unsigned int reg,
1308 			    unsigned int mask, unsigned int val,
1309 			    bool *change, bool async, bool force);
1310 
regmap_update_bits(struct regmap * map,unsigned int reg,unsigned int mask,unsigned int val)1311 static inline int regmap_update_bits(struct regmap *map, unsigned int reg,
1312 				     unsigned int mask, unsigned int val)
1313 {
1314 	return regmap_update_bits_base(map, reg, mask, val, NULL, false, false);
1315 }
1316 
regmap_update_bits_async(struct regmap * map,unsigned int reg,unsigned int mask,unsigned int val)1317 static inline int regmap_update_bits_async(struct regmap *map, unsigned int reg,
1318 					   unsigned int mask, unsigned int val)
1319 {
1320 	return regmap_update_bits_base(map, reg, mask, val, NULL, true, false);
1321 }
1322 
regmap_update_bits_check(struct regmap * map,unsigned int reg,unsigned int mask,unsigned int val,bool * change)1323 static inline int regmap_update_bits_check(struct regmap *map, unsigned int reg,
1324 					   unsigned int mask, unsigned int val,
1325 					   bool *change)
1326 {
1327 	return regmap_update_bits_base(map, reg, mask, val,
1328 				       change, false, false);
1329 }
1330 
1331 static inline int
regmap_update_bits_check_async(struct regmap * map,unsigned int reg,unsigned int mask,unsigned int val,bool * change)1332 regmap_update_bits_check_async(struct regmap *map, unsigned int reg,
1333 			       unsigned int mask, unsigned int val,
1334 			       bool *change)
1335 {
1336 	return regmap_update_bits_base(map, reg, mask, val,
1337 				       change, true, false);
1338 }
1339 
regmap_write_bits(struct regmap * map,unsigned int reg,unsigned int mask,unsigned int val)1340 static inline int regmap_write_bits(struct regmap *map, unsigned int reg,
1341 				    unsigned int mask, unsigned int val)
1342 {
1343 	return regmap_update_bits_base(map, reg, mask, val, NULL, false, true);
1344 }
1345 
1346 int regmap_get_val_bytes(struct regmap *map);
1347 int regmap_get_max_register(struct regmap *map);
1348 int regmap_get_reg_stride(struct regmap *map);
1349 bool regmap_might_sleep(struct regmap *map);
1350 int regmap_async_complete(struct regmap *map);
1351 bool regmap_can_raw_write(struct regmap *map);
1352 size_t regmap_get_raw_read_max(struct regmap *map);
1353 size_t regmap_get_raw_write_max(struct regmap *map);
1354 
1355 int regcache_sync(struct regmap *map);
1356 int regcache_sync_region(struct regmap *map, unsigned int min,
1357 			 unsigned int max);
1358 int regcache_drop_region(struct regmap *map, unsigned int min,
1359 			 unsigned int max);
1360 void regcache_cache_only(struct regmap *map, bool enable);
1361 void regcache_cache_bypass(struct regmap *map, bool enable);
1362 void regcache_mark_dirty(struct regmap *map);
1363 bool regcache_reg_cached(struct regmap *map, unsigned int reg);
1364 
1365 bool regmap_check_range_table(struct regmap *map, unsigned int reg,
1366 			      const struct regmap_access_table *table);
1367 
1368 int regmap_register_patch(struct regmap *map, const struct reg_sequence *regs,
1369 			  int num_regs);
1370 int regmap_parse_val(struct regmap *map, const void *buf,
1371 				unsigned int *val);
1372 
regmap_reg_in_range(unsigned int reg,const struct regmap_range * range)1373 static inline bool regmap_reg_in_range(unsigned int reg,
1374 				       const struct regmap_range *range)
1375 {
1376 	return reg >= range->range_min && reg <= range->range_max;
1377 }
1378 
1379 bool regmap_reg_in_ranges(unsigned int reg,
1380 			  const struct regmap_range *ranges,
1381 			  unsigned int nranges);
1382 
regmap_set_bits(struct regmap * map,unsigned int reg,unsigned int bits)1383 static inline int regmap_set_bits(struct regmap *map,
1384 				  unsigned int reg, unsigned int bits)
1385 {
1386 	return regmap_update_bits_base(map, reg, bits, bits,
1387 				       NULL, false, false);
1388 }
1389 
regmap_clear_bits(struct regmap * map,unsigned int reg,unsigned int bits)1390 static inline int regmap_clear_bits(struct regmap *map,
1391 				    unsigned int reg, unsigned int bits)
1392 {
1393 	return regmap_update_bits_base(map, reg, bits, 0, NULL, false, false);
1394 }
1395 
regmap_assign_bits(struct regmap * map,unsigned int reg,unsigned int bits,bool value)1396 static inline int regmap_assign_bits(struct regmap *map, unsigned int reg,
1397 				     unsigned int bits, bool value)
1398 {
1399 	if (value)
1400 		return regmap_set_bits(map, reg, bits);
1401 	else
1402 		return regmap_clear_bits(map, reg, bits);
1403 }
1404 
1405 int regmap_test_bits(struct regmap *map, unsigned int reg, unsigned int bits);
1406 
1407 /**
1408  * struct reg_field - Description of an register field
1409  *
1410  * @reg: Offset of the register within the regmap bank
1411  * @lsb: lsb of the register field.
1412  * @msb: msb of the register field.
1413  * @id_size: port size if it has some ports
1414  * @id_offset: address offset for each ports
1415  */
1416 struct reg_field {
1417 	unsigned int reg;
1418 	unsigned int lsb;
1419 	unsigned int msb;
1420 	unsigned int id_size;
1421 	unsigned int id_offset;
1422 };
1423 
1424 #define REG_FIELD(_reg, _lsb, _msb) {		\
1425 				.reg = _reg,	\
1426 				.lsb = _lsb,	\
1427 				.msb = _msb,	\
1428 				}
1429 
1430 #define REG_FIELD_ID(_reg, _lsb, _msb, _size, _offset) {	\
1431 				.reg = _reg,			\
1432 				.lsb = _lsb,			\
1433 				.msb = _msb,			\
1434 				.id_size = _size,		\
1435 				.id_offset = _offset,		\
1436 				}
1437 
1438 struct regmap_field *regmap_field_alloc(struct regmap *regmap,
1439 		struct reg_field reg_field);
1440 void regmap_field_free(struct regmap_field *field);
1441 
1442 struct regmap_field *devm_regmap_field_alloc(struct device *dev,
1443 		struct regmap *regmap, struct reg_field reg_field);
1444 void devm_regmap_field_free(struct device *dev,	struct regmap_field *field);
1445 
1446 int regmap_field_bulk_alloc(struct regmap *regmap,
1447 			     struct regmap_field **rm_field,
1448 			     const struct reg_field *reg_field,
1449 			     int num_fields);
1450 void regmap_field_bulk_free(struct regmap_field *field);
1451 int devm_regmap_field_bulk_alloc(struct device *dev, struct regmap *regmap,
1452 				 struct regmap_field **field,
1453 				 const struct reg_field *reg_field,
1454 				 int num_fields);
1455 void devm_regmap_field_bulk_free(struct device *dev,
1456 				 struct regmap_field *field);
1457 
1458 int regmap_field_read(struct regmap_field *field, unsigned int *val);
1459 int regmap_field_update_bits_base(struct regmap_field *field,
1460 				  unsigned int mask, unsigned int val,
1461 				  bool *change, bool async, bool force);
1462 int regmap_fields_read(struct regmap_field *field, unsigned int id,
1463 		       unsigned int *val);
1464 int regmap_fields_update_bits_base(struct regmap_field *field,  unsigned int id,
1465 				   unsigned int mask, unsigned int val,
1466 				   bool *change, bool async, bool force);
1467 
regmap_field_write(struct regmap_field * field,unsigned int val)1468 static inline int regmap_field_write(struct regmap_field *field,
1469 				     unsigned int val)
1470 {
1471 	return regmap_field_update_bits_base(field, ~0, val,
1472 					     NULL, false, false);
1473 }
1474 
regmap_field_force_write(struct regmap_field * field,unsigned int val)1475 static inline int regmap_field_force_write(struct regmap_field *field,
1476 					   unsigned int val)
1477 {
1478 	return regmap_field_update_bits_base(field, ~0, val, NULL, false, true);
1479 }
1480 
regmap_field_update_bits(struct regmap_field * field,unsigned int mask,unsigned int val)1481 static inline int regmap_field_update_bits(struct regmap_field *field,
1482 					   unsigned int mask, unsigned int val)
1483 {
1484 	return regmap_field_update_bits_base(field, mask, val,
1485 					     NULL, false, false);
1486 }
1487 
regmap_field_set_bits(struct regmap_field * field,unsigned int bits)1488 static inline int regmap_field_set_bits(struct regmap_field *field,
1489 					unsigned int bits)
1490 {
1491 	return regmap_field_update_bits_base(field, bits, bits, NULL, false,
1492 					     false);
1493 }
1494 
regmap_field_clear_bits(struct regmap_field * field,unsigned int bits)1495 static inline int regmap_field_clear_bits(struct regmap_field *field,
1496 					  unsigned int bits)
1497 {
1498 	return regmap_field_update_bits_base(field, bits, 0, NULL, false,
1499 					     false);
1500 }
1501 
1502 int regmap_field_test_bits(struct regmap_field *field, unsigned int bits);
1503 
1504 static inline int
regmap_field_force_update_bits(struct regmap_field * field,unsigned int mask,unsigned int val)1505 regmap_field_force_update_bits(struct regmap_field *field,
1506 			       unsigned int mask, unsigned int val)
1507 {
1508 	return regmap_field_update_bits_base(field, mask, val,
1509 					     NULL, false, true);
1510 }
1511 
regmap_fields_write(struct regmap_field * field,unsigned int id,unsigned int val)1512 static inline int regmap_fields_write(struct regmap_field *field,
1513 				      unsigned int id, unsigned int val)
1514 {
1515 	return regmap_fields_update_bits_base(field, id, ~0, val,
1516 					      NULL, false, false);
1517 }
1518 
regmap_fields_force_write(struct regmap_field * field,unsigned int id,unsigned int val)1519 static inline int regmap_fields_force_write(struct regmap_field *field,
1520 					    unsigned int id, unsigned int val)
1521 {
1522 	return regmap_fields_update_bits_base(field, id, ~0, val,
1523 					      NULL, false, true);
1524 }
1525 
1526 static inline int
regmap_fields_update_bits(struct regmap_field * field,unsigned int id,unsigned int mask,unsigned int val)1527 regmap_fields_update_bits(struct regmap_field *field, unsigned int id,
1528 			  unsigned int mask, unsigned int val)
1529 {
1530 	return regmap_fields_update_bits_base(field, id, mask, val,
1531 					      NULL, false, false);
1532 }
1533 
1534 static inline int
regmap_fields_force_update_bits(struct regmap_field * field,unsigned int id,unsigned int mask,unsigned int val)1535 regmap_fields_force_update_bits(struct regmap_field *field, unsigned int id,
1536 				unsigned int mask, unsigned int val)
1537 {
1538 	return regmap_fields_update_bits_base(field, id, mask, val,
1539 					      NULL, false, true);
1540 }
1541 
1542 /**
1543  * struct regmap_irq_type - IRQ type definitions.
1544  *
1545  * @type_reg_offset: Offset register for the irq type setting.
1546  * @type_rising_val: Register value to configure RISING type irq.
1547  * @type_falling_val: Register value to configure FALLING type irq.
1548  * @type_level_low_val: Register value to configure LEVEL_LOW type irq.
1549  * @type_level_high_val: Register value to configure LEVEL_HIGH type irq.
1550  * @types_supported: logical OR of IRQ_TYPE_* flags indicating supported types.
1551  */
1552 struct regmap_irq_type {
1553 	unsigned int type_reg_offset;
1554 	unsigned int type_reg_mask;
1555 	unsigned int type_rising_val;
1556 	unsigned int type_falling_val;
1557 	unsigned int type_level_low_val;
1558 	unsigned int type_level_high_val;
1559 	unsigned int types_supported;
1560 };
1561 
1562 /**
1563  * struct regmap_irq - Description of an IRQ for the generic regmap irq_chip.
1564  *
1565  * @reg_offset: Offset of the status/mask register within the bank
1566  * @mask:       Mask used to flag/control the register.
1567  * @type:	IRQ trigger type setting details if supported.
1568  */
1569 struct regmap_irq {
1570 	unsigned int reg_offset;
1571 	unsigned int mask;
1572 	struct regmap_irq_type type;
1573 };
1574 
1575 #define REGMAP_IRQ_REG(_irq, _off, _mask)		\
1576 	[_irq] = { .reg_offset = (_off), .mask = (_mask) }
1577 
1578 #define REGMAP_IRQ_REG_LINE(_id, _reg_bits) \
1579 	[_id] = {				\
1580 		.mask = BIT((_id) % (_reg_bits)),	\
1581 		.reg_offset = (_id) / (_reg_bits),	\
1582 	}
1583 
1584 #define REGMAP_IRQ_MAIN_REG_OFFSET(arr)				\
1585 	{ .num_regs = ARRAY_SIZE((arr)), .offset = &(arr)[0] }
1586 
1587 struct regmap_irq_sub_irq_map {
1588 	unsigned int num_regs;
1589 	unsigned int *offset;
1590 };
1591 
1592 struct regmap_irq_chip_data;
1593 
1594 /**
1595  * struct regmap_irq_chip - Description of a generic regmap irq_chip.
1596  *
1597  * @name:        Descriptive name for IRQ controller.
1598  * @domain_suffix: Name suffix to be appended to end of IRQ domain name. Needed
1599  *		   when multiple regmap-IRQ controllers are created from same
1600  *		   device.
1601  *
1602  * @main_status: Base main status register address. For chips which have
1603  *		 interrupts arranged in separate sub-irq blocks with own IRQ
1604  *		 registers and which have a main IRQ registers indicating
1605  *		 sub-irq blocks with unhandled interrupts. For such chips fill
1606  *		 sub-irq register information in status_base, mask_base and
1607  *		 ack_base.
1608  * @num_main_status_bits: Should be given to chips where number of meaningfull
1609  *			  main status bits differs from num_regs.
1610  * @sub_reg_offsets: arrays of mappings from main register bits to sub irq
1611  *		     registers. First item in array describes the registers
1612  *		     for first main status bit. Second array for second bit etc.
1613  *		     Offset is given as sub register status offset to
1614  *		     status_base. Should contain num_regs arrays.
1615  *		     Can be provided for chips with more complex mapping than
1616  *		     1.st bit to 1.st sub-reg, 2.nd bit to 2.nd sub-reg, ...
1617  * @num_main_regs: Number of 'main status' irq registers for chips which have
1618  *		   main_status set.
1619  *
1620  * @status_base: Base status register address.
1621  * @mask_base:   Base mask register address. Mask bits are set to 1 when an
1622  *               interrupt is masked, 0 when unmasked.
1623  * @unmask_base:  Base unmask register address. Unmask bits are set to 1 when
1624  *                an interrupt is unmasked and 0 when masked.
1625  * @ack_base:    Base ack address. If zero then the chip is clear on read.
1626  *               Using zero value is possible with @use_ack bit.
1627  * @wake_base:   Base address for wake enables.  If zero unsupported.
1628  * @config_base: Base address for IRQ type config regs. If null unsupported.
1629  * @irq_reg_stride:  Stride to use for chips where registers are not contiguous.
1630  * @init_ack_masked: Ack all masked interrupts once during initalization.
1631  * @mask_unmask_non_inverted: Controls mask bit inversion for chips that set
1632  *	both @mask_base and @unmask_base. If false, mask and unmask bits are
1633  *	inverted (which is deprecated behavior); if true, bits will not be
1634  *	inverted and the registers keep their normal behavior. Note that if
1635  *	you use only one of @mask_base or @unmask_base, this flag has no
1636  *	effect and is unnecessary. Any new drivers that set both @mask_base
1637  *	and @unmask_base should set this to true to avoid relying on the
1638  *	deprecated behavior.
1639  * @use_ack:     Use @ack register even if it is zero.
1640  * @ack_invert:  Inverted ack register: cleared bits for ack.
1641  * @clear_ack:  Use this to set 1 and 0 or vice-versa to clear interrupts.
1642  * @status_invert: Inverted status register: cleared bits are active interrupts.
1643  * @wake_invert: Inverted wake register: cleared bits are wake enabled.
1644  * @type_in_mask: Use the mask registers for controlling irq type. Use this if
1645  *		  the hardware provides separate bits for rising/falling edge
1646  *		  or low/high level interrupts and they should be combined into
1647  *		  a single logical interrupt. Use &struct regmap_irq_type data
1648  *		  to define the mask bit for each irq type.
1649  * @clear_on_unmask: For chips with interrupts cleared on read: read the status
1650  *                   registers before unmasking interrupts to clear any bits
1651  *                   set when they were masked.
1652  * @runtime_pm:  Hold a runtime PM lock on the device when accessing it.
1653  * @no_status: No status register: all interrupts assumed generated by device.
1654  *
1655  * @num_regs:    Number of registers in each control bank.
1656  *
1657  * @irqs:        Descriptors for individual IRQs.  Interrupt numbers are
1658  *               assigned based on the index in the array of the interrupt.
1659  * @num_irqs:    Number of descriptors.
1660  * @num_config_bases:	Number of config base registers.
1661  * @num_config_regs:	Number of config registers for each config base register.
1662  *
1663  * @handle_pre_irq:  Driver specific callback to handle interrupt from device
1664  *		     before regmap_irq_handler process the interrupts.
1665  * @handle_post_irq: Driver specific callback to handle interrupt from device
1666  *		     after handling the interrupts in regmap_irq_handler().
1667  * @handle_mask_sync: Callback used to handle IRQ mask syncs. The index will be
1668  *		      in the range [0, num_regs)
1669  * @set_type_config: Callback used for configuring irq types.
1670  * @get_irq_reg: Callback for mapping (base register, index) pairs to register
1671  *		 addresses. The base register will be one of @status_base,
1672  *		 @mask_base, etc., @main_status, or any of @config_base.
1673  *		 The index will be in the range [0, num_main_regs[ for the
1674  *		 main status base, [0, num_config_regs[ for any config
1675  *		 register base, and [0, num_regs[ for any other base.
1676  *		 If unspecified then regmap_irq_get_irq_reg_linear() is used.
1677  * @irq_drv_data:    Driver specific IRQ data which is passed as parameter when
1678  *		     driver specific pre/post interrupt handler is called.
1679  *
1680  * This is not intended to handle every possible interrupt controller, but
1681  * it should handle a substantial proportion of those that are found in the
1682  * wild.
1683  */
1684 struct regmap_irq_chip {
1685 	const char *name;
1686 	const char *domain_suffix;
1687 
1688 	unsigned int main_status;
1689 	unsigned int num_main_status_bits;
1690 	const struct regmap_irq_sub_irq_map *sub_reg_offsets;
1691 	int num_main_regs;
1692 
1693 	unsigned int status_base;
1694 	unsigned int mask_base;
1695 	unsigned int unmask_base;
1696 	unsigned int ack_base;
1697 	unsigned int wake_base;
1698 	const unsigned int *config_base;
1699 	unsigned int irq_reg_stride;
1700 	unsigned int init_ack_masked:1;
1701 	unsigned int mask_unmask_non_inverted:1;
1702 	unsigned int use_ack:1;
1703 	unsigned int ack_invert:1;
1704 	unsigned int clear_ack:1;
1705 	unsigned int status_invert:1;
1706 	unsigned int wake_invert:1;
1707 	unsigned int type_in_mask:1;
1708 	unsigned int clear_on_unmask:1;
1709 	unsigned int runtime_pm:1;
1710 	unsigned int no_status:1;
1711 
1712 	int num_regs;
1713 
1714 	const struct regmap_irq *irqs;
1715 	int num_irqs;
1716 
1717 	int num_config_bases;
1718 	int num_config_regs;
1719 
1720 	int (*handle_pre_irq)(void *irq_drv_data);
1721 	int (*handle_post_irq)(void *irq_drv_data);
1722 	int (*handle_mask_sync)(int index, unsigned int mask_buf_def,
1723 				unsigned int mask_buf, void *irq_drv_data);
1724 	int (*set_type_config)(unsigned int **buf, unsigned int type,
1725 			       const struct regmap_irq *irq_data, int idx,
1726 			       void *irq_drv_data);
1727 	unsigned int (*get_irq_reg)(struct regmap_irq_chip_data *data,
1728 				    unsigned int base, int index);
1729 	void *irq_drv_data;
1730 };
1731 
1732 unsigned int regmap_irq_get_irq_reg_linear(struct regmap_irq_chip_data *data,
1733 					   unsigned int base, int index);
1734 int regmap_irq_set_type_config_simple(unsigned int **buf, unsigned int type,
1735 				      const struct regmap_irq *irq_data,
1736 				      int idx, void *irq_drv_data);
1737 
1738 int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags,
1739 			int irq_base, const struct regmap_irq_chip *chip,
1740 			struct regmap_irq_chip_data **data);
1741 int regmap_add_irq_chip_fwnode(struct fwnode_handle *fwnode,
1742 			       struct regmap *map, int irq,
1743 			       int irq_flags, int irq_base,
1744 			       const struct regmap_irq_chip *chip,
1745 			       struct regmap_irq_chip_data **data);
1746 void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data);
1747 
1748 int devm_regmap_add_irq_chip(struct device *dev, struct regmap *map, int irq,
1749 			     int irq_flags, int irq_base,
1750 			     const struct regmap_irq_chip *chip,
1751 			     struct regmap_irq_chip_data **data);
1752 int devm_regmap_add_irq_chip_fwnode(struct device *dev,
1753 				    struct fwnode_handle *fwnode,
1754 				    struct regmap *map, int irq,
1755 				    int irq_flags, int irq_base,
1756 				    const struct regmap_irq_chip *chip,
1757 				    struct regmap_irq_chip_data **data);
1758 void devm_regmap_del_irq_chip(struct device *dev, int irq,
1759 			      struct regmap_irq_chip_data *data);
1760 
1761 int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data);
1762 int regmap_irq_get_virq(struct regmap_irq_chip_data *data, int irq);
1763 struct irq_domain *regmap_irq_get_domain(struct regmap_irq_chip_data *data);
1764 
1765 #else
1766 
1767 /*
1768  * These stubs should only ever be called by generic code which has
1769  * regmap based facilities, if they ever get called at runtime
1770  * something is going wrong and something probably needs to select
1771  * REGMAP.
1772  */
1773 
regmap_write(struct regmap * map,unsigned int reg,unsigned int val)1774 static inline int regmap_write(struct regmap *map, unsigned int reg,
1775 			       unsigned int val)
1776 {
1777 	WARN_ONCE(1, "regmap API is disabled");
1778 	return -EINVAL;
1779 }
1780 
regmap_write_async(struct regmap * map,unsigned int reg,unsigned int val)1781 static inline int regmap_write_async(struct regmap *map, unsigned int reg,
1782 				     unsigned int val)
1783 {
1784 	WARN_ONCE(1, "regmap API is disabled");
1785 	return -EINVAL;
1786 }
1787 
regmap_raw_write(struct regmap * map,unsigned int reg,const void * val,size_t val_len)1788 static inline int regmap_raw_write(struct regmap *map, unsigned int reg,
1789 				   const void *val, size_t val_len)
1790 {
1791 	WARN_ONCE(1, "regmap API is disabled");
1792 	return -EINVAL;
1793 }
1794 
regmap_raw_write_async(struct regmap * map,unsigned int reg,const void * val,size_t val_len)1795 static inline int regmap_raw_write_async(struct regmap *map, unsigned int reg,
1796 					 const void *val, size_t val_len)
1797 {
1798 	WARN_ONCE(1, "regmap API is disabled");
1799 	return -EINVAL;
1800 }
1801 
regmap_noinc_write(struct regmap * map,unsigned int reg,const void * val,size_t val_len)1802 static inline int regmap_noinc_write(struct regmap *map, unsigned int reg,
1803 				    const void *val, size_t val_len)
1804 {
1805 	WARN_ONCE(1, "regmap API is disabled");
1806 	return -EINVAL;
1807 }
1808 
regmap_bulk_write(struct regmap * map,unsigned int reg,const void * val,size_t val_count)1809 static inline int regmap_bulk_write(struct regmap *map, unsigned int reg,
1810 				    const void *val, size_t val_count)
1811 {
1812 	WARN_ONCE(1, "regmap API is disabled");
1813 	return -EINVAL;
1814 }
1815 
regmap_read(struct regmap * map,unsigned int reg,unsigned int * val)1816 static inline int regmap_read(struct regmap *map, unsigned int reg,
1817 			      unsigned int *val)
1818 {
1819 	WARN_ONCE(1, "regmap API is disabled");
1820 	return -EINVAL;
1821 }
1822 
regmap_read_bypassed(struct regmap * map,unsigned int reg,unsigned int * val)1823 static inline int regmap_read_bypassed(struct regmap *map, unsigned int reg,
1824 				       unsigned int *val)
1825 {
1826 	WARN_ONCE(1, "regmap API is disabled");
1827 	return -EINVAL;
1828 }
1829 
regmap_raw_read(struct regmap * map,unsigned int reg,void * val,size_t val_len)1830 static inline int regmap_raw_read(struct regmap *map, unsigned int reg,
1831 				  void *val, size_t val_len)
1832 {
1833 	WARN_ONCE(1, "regmap API is disabled");
1834 	return -EINVAL;
1835 }
1836 
regmap_noinc_read(struct regmap * map,unsigned int reg,void * val,size_t val_len)1837 static inline int regmap_noinc_read(struct regmap *map, unsigned int reg,
1838 				    void *val, size_t val_len)
1839 {
1840 	WARN_ONCE(1, "regmap API is disabled");
1841 	return -EINVAL;
1842 }
1843 
regmap_bulk_read(struct regmap * map,unsigned int reg,void * val,size_t val_count)1844 static inline int regmap_bulk_read(struct regmap *map, unsigned int reg,
1845 				   void *val, size_t val_count)
1846 {
1847 	WARN_ONCE(1, "regmap API is disabled");
1848 	return -EINVAL;
1849 }
1850 
regmap_update_bits_base(struct regmap * map,unsigned int reg,unsigned int mask,unsigned int val,bool * change,bool async,bool force)1851 static inline int regmap_update_bits_base(struct regmap *map, unsigned int reg,
1852 					  unsigned int mask, unsigned int val,
1853 					  bool *change, bool async, bool force)
1854 {
1855 	WARN_ONCE(1, "regmap API is disabled");
1856 	return -EINVAL;
1857 }
1858 
regmap_set_bits(struct regmap * map,unsigned int reg,unsigned int bits)1859 static inline int regmap_set_bits(struct regmap *map,
1860 				  unsigned int reg, unsigned int bits)
1861 {
1862 	WARN_ONCE(1, "regmap API is disabled");
1863 	return -EINVAL;
1864 }
1865 
regmap_clear_bits(struct regmap * map,unsigned int reg,unsigned int bits)1866 static inline int regmap_clear_bits(struct regmap *map,
1867 				    unsigned int reg, unsigned int bits)
1868 {
1869 	WARN_ONCE(1, "regmap API is disabled");
1870 	return -EINVAL;
1871 }
1872 
regmap_assign_bits(struct regmap * map,unsigned int reg,unsigned int bits,bool value)1873 static inline int regmap_assign_bits(struct regmap *map, unsigned int reg,
1874 				     unsigned int bits, bool value)
1875 {
1876 	WARN_ONCE(1, "regmap API is disabled");
1877 	return -EINVAL;
1878 }
1879 
regmap_test_bits(struct regmap * map,unsigned int reg,unsigned int bits)1880 static inline int regmap_test_bits(struct regmap *map,
1881 				   unsigned int reg, unsigned int bits)
1882 {
1883 	WARN_ONCE(1, "regmap API is disabled");
1884 	return -EINVAL;
1885 }
1886 
regmap_field_update_bits_base(struct regmap_field * field,unsigned int mask,unsigned int val,bool * change,bool async,bool force)1887 static inline int regmap_field_update_bits_base(struct regmap_field *field,
1888 					unsigned int mask, unsigned int val,
1889 					bool *change, bool async, bool force)
1890 {
1891 	WARN_ONCE(1, "regmap API is disabled");
1892 	return -EINVAL;
1893 }
1894 
regmap_fields_update_bits_base(struct regmap_field * field,unsigned int id,unsigned int mask,unsigned int val,bool * change,bool async,bool force)1895 static inline int regmap_fields_update_bits_base(struct regmap_field *field,
1896 				   unsigned int id,
1897 				   unsigned int mask, unsigned int val,
1898 				   bool *change, bool async, bool force)
1899 {
1900 	WARN_ONCE(1, "regmap API is disabled");
1901 	return -EINVAL;
1902 }
1903 
regmap_update_bits(struct regmap * map,unsigned int reg,unsigned int mask,unsigned int val)1904 static inline int regmap_update_bits(struct regmap *map, unsigned int reg,
1905 				     unsigned int mask, unsigned int val)
1906 {
1907 	WARN_ONCE(1, "regmap API is disabled");
1908 	return -EINVAL;
1909 }
1910 
regmap_update_bits_async(struct regmap * map,unsigned int reg,unsigned int mask,unsigned int val)1911 static inline int regmap_update_bits_async(struct regmap *map, unsigned int reg,
1912 					   unsigned int mask, unsigned int val)
1913 {
1914 	WARN_ONCE(1, "regmap API is disabled");
1915 	return -EINVAL;
1916 }
1917 
regmap_update_bits_check(struct regmap * map,unsigned int reg,unsigned int mask,unsigned int val,bool * change)1918 static inline int regmap_update_bits_check(struct regmap *map, unsigned int reg,
1919 					   unsigned int mask, unsigned int val,
1920 					   bool *change)
1921 {
1922 	WARN_ONCE(1, "regmap API is disabled");
1923 	return -EINVAL;
1924 }
1925 
1926 static inline int
regmap_update_bits_check_async(struct regmap * map,unsigned int reg,unsigned int mask,unsigned int val,bool * change)1927 regmap_update_bits_check_async(struct regmap *map, unsigned int reg,
1928 			       unsigned int mask, unsigned int val,
1929 			       bool *change)
1930 {
1931 	WARN_ONCE(1, "regmap API is disabled");
1932 	return -EINVAL;
1933 }
1934 
regmap_write_bits(struct regmap * map,unsigned int reg,unsigned int mask,unsigned int val)1935 static inline int regmap_write_bits(struct regmap *map, unsigned int reg,
1936 				    unsigned int mask, unsigned int val)
1937 {
1938 	WARN_ONCE(1, "regmap API is disabled");
1939 	return -EINVAL;
1940 }
1941 
regmap_field_write(struct regmap_field * field,unsigned int val)1942 static inline int regmap_field_write(struct regmap_field *field,
1943 				     unsigned int val)
1944 {
1945 	WARN_ONCE(1, "regmap API is disabled");
1946 	return -EINVAL;
1947 }
1948 
regmap_field_force_write(struct regmap_field * field,unsigned int val)1949 static inline int regmap_field_force_write(struct regmap_field *field,
1950 					   unsigned int val)
1951 {
1952 	WARN_ONCE(1, "regmap API is disabled");
1953 	return -EINVAL;
1954 }
1955 
regmap_field_update_bits(struct regmap_field * field,unsigned int mask,unsigned int val)1956 static inline int regmap_field_update_bits(struct regmap_field *field,
1957 					   unsigned int mask, unsigned int val)
1958 {
1959 	WARN_ONCE(1, "regmap API is disabled");
1960 	return -EINVAL;
1961 }
1962 
1963 static inline int
regmap_field_force_update_bits(struct regmap_field * field,unsigned int mask,unsigned int val)1964 regmap_field_force_update_bits(struct regmap_field *field,
1965 			       unsigned int mask, unsigned int val)
1966 {
1967 	WARN_ONCE(1, "regmap API is disabled");
1968 	return -EINVAL;
1969 }
1970 
regmap_field_set_bits(struct regmap_field * field,unsigned int bits)1971 static inline int regmap_field_set_bits(struct regmap_field *field,
1972 					unsigned int bits)
1973 {
1974 	WARN_ONCE(1, "regmap API is disabled");
1975 	return -EINVAL;
1976 }
1977 
regmap_field_clear_bits(struct regmap_field * field,unsigned int bits)1978 static inline int regmap_field_clear_bits(struct regmap_field *field,
1979 					  unsigned int bits)
1980 {
1981 	WARN_ONCE(1, "regmap API is disabled");
1982 	return -EINVAL;
1983 }
1984 
regmap_field_test_bits(struct regmap_field * field,unsigned int bits)1985 static inline int regmap_field_test_bits(struct regmap_field *field,
1986 					 unsigned int bits)
1987 {
1988 	WARN_ONCE(1, "regmap API is disabled");
1989 	return -EINVAL;
1990 }
1991 
regmap_fields_write(struct regmap_field * field,unsigned int id,unsigned int val)1992 static inline int regmap_fields_write(struct regmap_field *field,
1993 				      unsigned int id, unsigned int val)
1994 {
1995 	WARN_ONCE(1, "regmap API is disabled");
1996 	return -EINVAL;
1997 }
1998 
regmap_fields_force_write(struct regmap_field * field,unsigned int id,unsigned int val)1999 static inline int regmap_fields_force_write(struct regmap_field *field,
2000 					    unsigned int id, unsigned int val)
2001 {
2002 	WARN_ONCE(1, "regmap API is disabled");
2003 	return -EINVAL;
2004 }
2005 
2006 static inline int
regmap_fields_update_bits(struct regmap_field * field,unsigned int id,unsigned int mask,unsigned int val)2007 regmap_fields_update_bits(struct regmap_field *field, unsigned int id,
2008 			  unsigned int mask, unsigned int val)
2009 {
2010 	WARN_ONCE(1, "regmap API is disabled");
2011 	return -EINVAL;
2012 }
2013 
2014 static inline int
regmap_fields_force_update_bits(struct regmap_field * field,unsigned int id,unsigned int mask,unsigned int val)2015 regmap_fields_force_update_bits(struct regmap_field *field, unsigned int id,
2016 				unsigned int mask, unsigned int val)
2017 {
2018 	WARN_ONCE(1, "regmap API is disabled");
2019 	return -EINVAL;
2020 }
2021 
regmap_get_val_bytes(struct regmap * map)2022 static inline int regmap_get_val_bytes(struct regmap *map)
2023 {
2024 	WARN_ONCE(1, "regmap API is disabled");
2025 	return -EINVAL;
2026 }
2027 
regmap_get_max_register(struct regmap * map)2028 static inline int regmap_get_max_register(struct regmap *map)
2029 {
2030 	WARN_ONCE(1, "regmap API is disabled");
2031 	return -EINVAL;
2032 }
2033 
regmap_get_reg_stride(struct regmap * map)2034 static inline int regmap_get_reg_stride(struct regmap *map)
2035 {
2036 	WARN_ONCE(1, "regmap API is disabled");
2037 	return -EINVAL;
2038 }
2039 
regmap_might_sleep(struct regmap * map)2040 static inline bool regmap_might_sleep(struct regmap *map)
2041 {
2042 	WARN_ONCE(1, "regmap API is disabled");
2043 	return true;
2044 }
2045 
regcache_sync(struct regmap * map)2046 static inline int regcache_sync(struct regmap *map)
2047 {
2048 	WARN_ONCE(1, "regmap API is disabled");
2049 	return -EINVAL;
2050 }
2051 
regcache_sync_region(struct regmap * map,unsigned int min,unsigned int max)2052 static inline int regcache_sync_region(struct regmap *map, unsigned int min,
2053 				       unsigned int max)
2054 {
2055 	WARN_ONCE(1, "regmap API is disabled");
2056 	return -EINVAL;
2057 }
2058 
regcache_drop_region(struct regmap * map,unsigned int min,unsigned int max)2059 static inline int regcache_drop_region(struct regmap *map, unsigned int min,
2060 				       unsigned int max)
2061 {
2062 	WARN_ONCE(1, "regmap API is disabled");
2063 	return -EINVAL;
2064 }
2065 
regcache_cache_only(struct regmap * map,bool enable)2066 static inline void regcache_cache_only(struct regmap *map, bool enable)
2067 {
2068 	WARN_ONCE(1, "regmap API is disabled");
2069 }
2070 
regcache_cache_bypass(struct regmap * map,bool enable)2071 static inline void regcache_cache_bypass(struct regmap *map, bool enable)
2072 {
2073 	WARN_ONCE(1, "regmap API is disabled");
2074 }
2075 
regcache_mark_dirty(struct regmap * map)2076 static inline void regcache_mark_dirty(struct regmap *map)
2077 {
2078 	WARN_ONCE(1, "regmap API is disabled");
2079 }
2080 
regmap_async_complete(struct regmap * map)2081 static inline void regmap_async_complete(struct regmap *map)
2082 {
2083 	WARN_ONCE(1, "regmap API is disabled");
2084 }
2085 
regmap_register_patch(struct regmap * map,const struct reg_sequence * regs,int num_regs)2086 static inline int regmap_register_patch(struct regmap *map,
2087 					const struct reg_sequence *regs,
2088 					int num_regs)
2089 {
2090 	WARN_ONCE(1, "regmap API is disabled");
2091 	return -EINVAL;
2092 }
2093 
regmap_parse_val(struct regmap * map,const void * buf,unsigned int * val)2094 static inline int regmap_parse_val(struct regmap *map, const void *buf,
2095 				unsigned int *val)
2096 {
2097 	WARN_ONCE(1, "regmap API is disabled");
2098 	return -EINVAL;
2099 }
2100 
dev_get_regmap(struct device * dev,const char * name)2101 static inline struct regmap *dev_get_regmap(struct device *dev,
2102 					    const char *name)
2103 {
2104 	return NULL;
2105 }
2106 
regmap_get_device(struct regmap * map)2107 static inline struct device *regmap_get_device(struct regmap *map)
2108 {
2109 	WARN_ONCE(1, "regmap API is disabled");
2110 	return NULL;
2111 }
2112 
2113 #endif
2114 
2115 #endif
2116