1 /* SPDX-License-Identifier: GPL-2.0-only */
2 #ifndef __LINUX_REGMAP_H
3 #define __LINUX_REGMAP_H
6 * Register map access API
8 * Copyright 2011 Wolfson Microelectronics plc
10 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
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>
35 struct regmap_range_cfg;
40 /* An enum of all the supported cache types */
49 * struct reg_default - Default value for a register.
51 * @reg: Register address.
52 * @def: Register default value.
54 * We use an array of structs rather than a simple array as many modern devices
55 * have very sparse register maps.
63 * struct reg_sequence - An individual write from a sequence of writes.
65 * @reg: Register address.
66 * @def: Register value.
67 * @delay_us: Delay to be applied after the register write in microseconds
69 * Register/value pairs for sequences of writes with an optional delay in
70 * microseconds to be applied after each write.
75 unsigned int delay_us;
78 #define REG_SEQ(_reg, _def, _delay_us) { \
81 .delay_us = _delay_us, \
83 #define REG_SEQ0(_reg, _def) REG_SEQ(_reg, _def, 0)
86 * regmap_read_poll_timeout - Poll until a condition is met or a timeout occurs
88 * @map: Regmap to read from
89 * @addr: Address to poll
90 * @val: Unsigned integer variable to read the value into
91 * @cond: Break condition (usually involving @val)
92 * @sleep_us: Maximum time to sleep between reads in us (0
93 * tight-loops). Should be less than ~20ms since usleep_range
94 * is used (see Documentation/timers/timers-howto.rst).
95 * @timeout_us: Timeout in us, 0 means never timeout
97 * Returns 0 on success and -ETIMEDOUT upon a timeout or the regmap_read
98 * error return value in case of a error read. In the two former cases,
99 * the last read value at @addr is stored in @val. Must not be called
100 * from atomic context if sleep_us or timeout_us are used.
102 * This is modelled after the readx_poll_timeout macros in linux/iopoll.h.
104 #define regmap_read_poll_timeout(map, addr, val, cond, sleep_us, timeout_us) \
107 __tmp = read_poll_timeout(regmap_read, __ret, __ret || (cond), \
108 sleep_us, timeout_us, false, (map), (addr), &(val)); \
113 * regmap_read_poll_timeout_atomic - Poll until a condition is met or a timeout occurs
115 * @map: Regmap to read from
116 * @addr: Address to poll
117 * @val: Unsigned integer variable to read the value into
118 * @cond: Break condition (usually involving @val)
119 * @delay_us: Time to udelay between reads in us (0 tight-loops).
120 * Should be less than ~10us since udelay is used
121 * (see Documentation/timers/timers-howto.rst).
122 * @timeout_us: Timeout in us, 0 means never timeout
124 * Returns 0 on success and -ETIMEDOUT upon a timeout or the regmap_read
125 * error return value in case of a error read. In the two former cases,
126 * the last read value at @addr is stored in @val.
128 * This is modelled after the readx_poll_timeout_atomic macros in linux/iopoll.h.
130 * Note: In general regmap cannot be used in atomic context. If you want to use
131 * this macro then first setup your regmap for atomic use (flat or no cache
134 #define regmap_read_poll_timeout_atomic(map, addr, val, cond, delay_us, timeout_us) \
136 u64 __timeout_us = (timeout_us); \
137 unsigned long __delay_us = (delay_us); \
138 ktime_t __timeout = ktime_add_us(ktime_get(), __timeout_us); \
141 __ret = regmap_read((map), (addr), &(val)); \
146 if ((__timeout_us) && \
147 ktime_compare(ktime_get(), __timeout) > 0) { \
148 __ret = regmap_read((map), (addr), &(val)); \
152 udelay(__delay_us); \
154 __ret ?: ((cond) ? 0 : -ETIMEDOUT); \
158 * regmap_field_read_poll_timeout - Poll until a condition is met or timeout
160 * @field: Regmap field to read from
161 * @val: Unsigned integer variable to read the value into
162 * @cond: Break condition (usually involving @val)
163 * @sleep_us: Maximum time to sleep between reads in us (0
164 * tight-loops). Should be less than ~20ms since usleep_range
165 * is used (see Documentation/timers/timers-howto.rst).
166 * @timeout_us: Timeout in us, 0 means never timeout
168 * Returns 0 on success and -ETIMEDOUT upon a timeout or the regmap_field_read
169 * error return value in case of a error read. In the two former cases,
170 * the last read value at @addr is stored in @val. Must not be called
171 * from atomic context if sleep_us or timeout_us are used.
173 * This is modelled after the readx_poll_timeout macros in linux/iopoll.h.
175 #define regmap_field_read_poll_timeout(field, val, cond, sleep_us, timeout_us) \
178 __tmp = read_poll_timeout(regmap_field_read, __ret, __ret || (cond), \
179 sleep_us, timeout_us, false, (field), &(val)); \
186 /* Unspecified -> 0 -> Backwards compatible default */
187 REGMAP_ENDIAN_DEFAULT = 0,
189 REGMAP_ENDIAN_LITTLE,
190 REGMAP_ENDIAN_NATIVE,
194 * struct regmap_range - A register range, used for access related checks
195 * (readable/writeable/volatile/precious checks)
197 * @range_min: address of first register
198 * @range_max: address of last register
200 struct regmap_range {
201 unsigned int range_min;
202 unsigned int range_max;
205 #define regmap_reg_range(low, high) { .range_min = low, .range_max = high, }
208 * struct regmap_access_table - A table of register ranges for access checks
210 * @yes_ranges : pointer to an array of regmap ranges used as "yes ranges"
211 * @n_yes_ranges: size of the above array
212 * @no_ranges: pointer to an array of regmap ranges used as "no ranges"
213 * @n_no_ranges: size of the above array
215 * A table of ranges including some yes ranges and some no ranges.
216 * If a register belongs to a no_range, the corresponding check function
217 * will return false. If a register belongs to a yes range, the corresponding
218 * check function will return true. "no_ranges" are searched first.
220 struct regmap_access_table {
221 const struct regmap_range *yes_ranges;
222 unsigned int n_yes_ranges;
223 const struct regmap_range *no_ranges;
224 unsigned int n_no_ranges;
227 typedef void (*regmap_lock)(void *);
228 typedef void (*regmap_unlock)(void *);
231 * struct regmap_config - Configuration for the register map of a device.
233 * @name: Optional name of the regmap. Useful when a device has multiple
236 * @reg_bits: Number of bits in a register address, mandatory.
237 * @reg_stride: The register address stride. Valid register addresses are a
238 * multiple of this value. If set to 0, a value of 1 will be
240 * @pad_bits: Number of bits of padding between register and value.
241 * @val_bits: Number of bits in a register value, mandatory.
243 * @writeable_reg: Optional callback returning true if the register
244 * can be written to. If this field is NULL but wr_table
245 * (see below) is not, the check is performed on such table
246 * (a register is writeable if it belongs to one of the ranges
247 * specified by wr_table).
248 * @readable_reg: Optional callback returning true if the register
249 * can be read from. If this field is NULL but rd_table
250 * (see below) is not, the check is performed on such table
251 * (a register is readable if it belongs to one of the ranges
252 * specified by rd_table).
253 * @volatile_reg: Optional callback returning true if the register
254 * value can't be cached. If this field is NULL but
255 * volatile_table (see below) is not, the check is performed on
256 * such table (a register is volatile if it belongs to one of
257 * the ranges specified by volatile_table).
258 * @precious_reg: Optional callback returning true if the register
259 * should not be read outside of a call from the driver
260 * (e.g., a clear on read interrupt status register). If this
261 * field is NULL but precious_table (see below) is not, the
262 * check is performed on such table (a register is precious if
263 * it belongs to one of the ranges specified by precious_table).
264 * @writeable_noinc_reg: Optional callback returning true if the register
265 * supports multiple write operations without incrementing
266 * the register number. If this field is NULL but
267 * wr_noinc_table (see below) is not, the check is
268 * performed on such table (a register is no increment
269 * writeable if it belongs to one of the ranges specified
270 * by wr_noinc_table).
271 * @readable_noinc_reg: Optional callback returning true if the register
272 * supports multiple read operations without incrementing
273 * the register number. If this field is NULL but
274 * rd_noinc_table (see below) is not, the check is
275 * performed on such table (a register is no increment
276 * readable if it belongs to one of the ranges specified
277 * by rd_noinc_table).
278 * @disable_locking: This regmap is either protected by external means or
279 * is guaranteed not to be accessed from multiple threads.
280 * Don't use any locking mechanisms.
281 * @lock: Optional lock callback (overrides regmap's default lock
282 * function, based on spinlock or mutex).
283 * @unlock: As above for unlocking.
284 * @lock_arg: this field is passed as the only argument of lock/unlock
285 * functions (ignored in case regular lock/unlock functions
286 * are not overridden).
287 * @reg_read: Optional callback that if filled will be used to perform
288 * all the reads from the registers. Should only be provided for
289 * devices whose read operation cannot be represented as a simple
290 * read operation on a bus such as SPI, I2C, etc. Most of the
291 * devices do not need this.
292 * @reg_write: Same as above for writing.
293 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
294 * to perform locking. This field is ignored if custom lock/unlock
295 * functions are used (see fields lock/unlock of struct regmap_config).
296 * This field is a duplicate of a similar file in
297 * 'struct regmap_bus' and serves exact same purpose.
298 * Use it only for "no-bus" cases.
299 * @max_register: Optional, specifies the maximum valid register address.
300 * @wr_table: Optional, points to a struct regmap_access_table specifying
301 * valid ranges for write access.
302 * @rd_table: As above, for read access.
303 * @volatile_table: As above, for volatile registers.
304 * @precious_table: As above, for precious registers.
305 * @wr_noinc_table: As above, for no increment writeable registers.
306 * @rd_noinc_table: As above, for no increment readable registers.
307 * @reg_defaults: Power on reset values for registers (for use with
308 * register cache support).
309 * @num_reg_defaults: Number of elements in reg_defaults.
311 * @read_flag_mask: Mask to be set in the top bytes of the register when doing
313 * @write_flag_mask: Mask to be set in the top bytes of the register when doing
314 * a write. If both read_flag_mask and write_flag_mask are
315 * empty and zero_flag_mask is not set the regmap_bus default
317 * @zero_flag_mask: If set, read_flag_mask and write_flag_mask are used even
318 * if they are both empty.
319 * @use_relaxed_mmio: If set, MMIO R/W operations will not use memory barriers.
320 * This can avoid load on devices which don't require strict
321 * orderings, but drivers should carefully add any explicit
322 * memory barriers when they may require them.
323 * @use_single_read: If set, converts the bulk read operation into a series of
324 * single read operations. This is useful for a device that
325 * does not support bulk read.
326 * @use_single_write: If set, converts the bulk write operation into a series of
327 * single write operations. This is useful for a device that
328 * does not support bulk write.
329 * @can_multi_write: If set, the device supports the multi write mode of bulk
330 * write operations, if clear multi write requests will be
331 * split into individual write operations
333 * @cache_type: The actual cache type.
334 * @reg_defaults_raw: Power on reset values for registers (for use with
335 * register cache support).
336 * @num_reg_defaults_raw: Number of elements in reg_defaults_raw.
337 * @reg_format_endian: Endianness for formatted register addresses. If this is
338 * DEFAULT, the @reg_format_endian_default value from the
339 * regmap bus is used.
340 * @val_format_endian: Endianness for formatted register values. If this is
341 * DEFAULT, the @reg_format_endian_default value from the
342 * regmap bus is used.
344 * @ranges: Array of configuration entries for virtual address ranges.
345 * @num_ranges: Number of range configuration entries.
346 * @use_hwlock: Indicate if a hardware spinlock should be used.
347 * @use_raw_spinlock: Indicate if a raw spinlock should be used.
348 * @hwlock_id: Specify the hardware spinlock id.
349 * @hwlock_mode: The hardware spinlock mode, should be HWLOCK_IRQSTATE,
351 * @can_sleep: Optional, specifies whether regmap operations can sleep.
353 struct regmap_config {
361 bool (*writeable_reg)(struct device *dev, unsigned int reg);
362 bool (*readable_reg)(struct device *dev, unsigned int reg);
363 bool (*volatile_reg)(struct device *dev, unsigned int reg);
364 bool (*precious_reg)(struct device *dev, unsigned int reg);
365 bool (*writeable_noinc_reg)(struct device *dev, unsigned int reg);
366 bool (*readable_noinc_reg)(struct device *dev, unsigned int reg);
368 bool disable_locking;
370 regmap_unlock unlock;
373 int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
374 int (*reg_write)(void *context, unsigned int reg, unsigned int val);
378 unsigned int max_register;
379 const struct regmap_access_table *wr_table;
380 const struct regmap_access_table *rd_table;
381 const struct regmap_access_table *volatile_table;
382 const struct regmap_access_table *precious_table;
383 const struct regmap_access_table *wr_noinc_table;
384 const struct regmap_access_table *rd_noinc_table;
385 const struct reg_default *reg_defaults;
386 unsigned int num_reg_defaults;
387 enum regcache_type cache_type;
388 const void *reg_defaults_raw;
389 unsigned int num_reg_defaults_raw;
391 unsigned long read_flag_mask;
392 unsigned long write_flag_mask;
395 bool use_single_read;
396 bool use_single_write;
397 bool use_relaxed_mmio;
398 bool can_multi_write;
400 enum regmap_endian reg_format_endian;
401 enum regmap_endian val_format_endian;
403 const struct regmap_range_cfg *ranges;
404 unsigned int num_ranges;
407 bool use_raw_spinlock;
408 unsigned int hwlock_id;
409 unsigned int hwlock_mode;
415 * struct regmap_range_cfg - Configuration for indirectly accessed or paged
418 * @name: Descriptive name for diagnostics
420 * @range_min: Address of the lowest register address in virtual range.
421 * @range_max: Address of the highest register in virtual range.
423 * @selector_reg: Register with selector field.
424 * @selector_mask: Bit mask for selector value.
425 * @selector_shift: Bit shift for selector value.
427 * @window_start: Address of first (lowest) register in data window.
428 * @window_len: Number of registers in data window.
430 * Registers, mapped to this virtual range, are accessed in two steps:
431 * 1. page selector register update;
432 * 2. access through data window registers.
434 struct regmap_range_cfg {
437 /* Registers of virtual address range */
438 unsigned int range_min;
439 unsigned int range_max;
441 /* Page selector for indirect addressing */
442 unsigned int selector_reg;
443 unsigned int selector_mask;
446 /* Data window (per each page) */
447 unsigned int window_start;
448 unsigned int window_len;
453 typedef int (*regmap_hw_write)(void *context, const void *data,
455 typedef int (*regmap_hw_gather_write)(void *context,
456 const void *reg, size_t reg_len,
457 const void *val, size_t val_len);
458 typedef int (*regmap_hw_async_write)(void *context,
459 const void *reg, size_t reg_len,
460 const void *val, size_t val_len,
461 struct regmap_async *async);
462 typedef int (*regmap_hw_read)(void *context,
463 const void *reg_buf, size_t reg_size,
464 void *val_buf, size_t val_size);
465 typedef int (*regmap_hw_reg_read)(void *context, unsigned int reg,
467 typedef int (*regmap_hw_reg_write)(void *context, unsigned int reg,
469 typedef int (*regmap_hw_reg_update_bits)(void *context, unsigned int reg,
470 unsigned int mask, unsigned int val);
471 typedef struct regmap_async *(*regmap_hw_async_alloc)(void);
472 typedef void (*regmap_hw_free_context)(void *context);
475 * struct regmap_bus - Description of a hardware bus for the register map
478 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
479 * to perform locking. This field is ignored if custom lock/unlock
480 * functions are used (see fields lock/unlock of
481 * struct regmap_config).
482 * @write: Write operation.
483 * @gather_write: Write operation with split register/value, return -ENOTSUPP
484 * if not implemented on a given device.
485 * @async_write: Write operation which completes asynchronously, optional and
486 * must serialise with respect to non-async I/O.
487 * @reg_write: Write a single register value to the given register address. This
488 * write operation has to complete when returning from the function.
489 * @reg_update_bits: Update bits operation to be used against volatile
490 * registers, intended for devices supporting some mechanism
491 * for setting clearing bits without having to
493 * @read: Read operation. Data is returned in the buffer used to transmit
495 * @reg_read: Read a single register value from a given register address.
496 * @free_context: Free context.
497 * @async_alloc: Allocate a regmap_async() structure.
498 * @read_flag_mask: Mask to be set in the top byte of the register when doing
500 * @reg_format_endian_default: Default endianness for formatted register
501 * addresses. Used when the regmap_config specifies DEFAULT. If this is
502 * DEFAULT, BIG is assumed.
503 * @val_format_endian_default: Default endianness for formatted register
504 * values. Used when the regmap_config specifies DEFAULT. If this is
505 * DEFAULT, BIG is assumed.
506 * @max_raw_read: Max raw read size that can be used on the bus.
507 * @max_raw_write: Max raw write size that can be used on the bus.
508 * @free_on_exit: kfree this on exit of regmap
512 regmap_hw_write write;
513 regmap_hw_gather_write gather_write;
514 regmap_hw_async_write async_write;
515 regmap_hw_reg_write reg_write;
516 regmap_hw_reg_update_bits reg_update_bits;
518 regmap_hw_reg_read reg_read;
519 regmap_hw_free_context free_context;
520 regmap_hw_async_alloc async_alloc;
522 enum regmap_endian reg_format_endian_default;
523 enum regmap_endian val_format_endian_default;
525 size_t max_raw_write;
530 * __regmap_init functions.
532 * These functions take a lock key and name parameter, and should not be called
533 * directly. Instead, use the regmap_init macros that generate a key and name
536 struct regmap *__regmap_init(struct device *dev,
537 const struct regmap_bus *bus,
539 const struct regmap_config *config,
540 struct lock_class_key *lock_key,
541 const char *lock_name);
542 struct regmap *__regmap_init_i2c(struct i2c_client *i2c,
543 const struct regmap_config *config,
544 struct lock_class_key *lock_key,
545 const char *lock_name);
546 struct regmap *__regmap_init_mdio(struct mdio_device *mdio_dev,
547 const struct regmap_config *config,
548 struct lock_class_key *lock_key,
549 const char *lock_name);
550 struct regmap *__regmap_init_sccb(struct i2c_client *i2c,
551 const struct regmap_config *config,
552 struct lock_class_key *lock_key,
553 const char *lock_name);
554 struct regmap *__regmap_init_slimbus(struct slim_device *slimbus,
555 const struct regmap_config *config,
556 struct lock_class_key *lock_key,
557 const char *lock_name);
558 struct regmap *__regmap_init_spi(struct spi_device *dev,
559 const struct regmap_config *config,
560 struct lock_class_key *lock_key,
561 const char *lock_name);
562 struct regmap *__regmap_init_spmi_base(struct spmi_device *dev,
563 const struct regmap_config *config,
564 struct lock_class_key *lock_key,
565 const char *lock_name);
566 struct regmap *__regmap_init_spmi_ext(struct spmi_device *dev,
567 const struct regmap_config *config,
568 struct lock_class_key *lock_key,
569 const char *lock_name);
570 struct regmap *__regmap_init_w1(struct device *w1_dev,
571 const struct regmap_config *config,
572 struct lock_class_key *lock_key,
573 const char *lock_name);
574 struct regmap *__regmap_init_mmio_clk(struct device *dev, const char *clk_id,
576 const struct regmap_config *config,
577 struct lock_class_key *lock_key,
578 const char *lock_name);
579 struct regmap *__regmap_init_ac97(struct snd_ac97 *ac97,
580 const struct regmap_config *config,
581 struct lock_class_key *lock_key,
582 const char *lock_name);
583 struct regmap *__regmap_init_sdw(struct sdw_slave *sdw,
584 const struct regmap_config *config,
585 struct lock_class_key *lock_key,
586 const char *lock_name);
587 struct regmap *__regmap_init_sdw_mbq(struct sdw_slave *sdw,
588 const struct regmap_config *config,
589 struct lock_class_key *lock_key,
590 const char *lock_name);
591 struct regmap *__regmap_init_spi_avmm(struct spi_device *spi,
592 const struct regmap_config *config,
593 struct lock_class_key *lock_key,
594 const char *lock_name);
596 struct regmap *__devm_regmap_init(struct device *dev,
597 const struct regmap_bus *bus,
599 const struct regmap_config *config,
600 struct lock_class_key *lock_key,
601 const char *lock_name);
602 struct regmap *__devm_regmap_init_i2c(struct i2c_client *i2c,
603 const struct regmap_config *config,
604 struct lock_class_key *lock_key,
605 const char *lock_name);
606 struct regmap *__devm_regmap_init_mdio(struct mdio_device *mdio_dev,
607 const struct regmap_config *config,
608 struct lock_class_key *lock_key,
609 const char *lock_name);
610 struct regmap *__devm_regmap_init_sccb(struct i2c_client *i2c,
611 const struct regmap_config *config,
612 struct lock_class_key *lock_key,
613 const char *lock_name);
614 struct regmap *__devm_regmap_init_spi(struct spi_device *dev,
615 const struct regmap_config *config,
616 struct lock_class_key *lock_key,
617 const char *lock_name);
618 struct regmap *__devm_regmap_init_spmi_base(struct spmi_device *dev,
619 const struct regmap_config *config,
620 struct lock_class_key *lock_key,
621 const char *lock_name);
622 struct regmap *__devm_regmap_init_spmi_ext(struct spmi_device *dev,
623 const struct regmap_config *config,
624 struct lock_class_key *lock_key,
625 const char *lock_name);
626 struct regmap *__devm_regmap_init_w1(struct device *w1_dev,
627 const struct regmap_config *config,
628 struct lock_class_key *lock_key,
629 const char *lock_name);
630 struct regmap *__devm_regmap_init_mmio_clk(struct device *dev,
633 const struct regmap_config *config,
634 struct lock_class_key *lock_key,
635 const char *lock_name);
636 struct regmap *__devm_regmap_init_ac97(struct snd_ac97 *ac97,
637 const struct regmap_config *config,
638 struct lock_class_key *lock_key,
639 const char *lock_name);
640 struct regmap *__devm_regmap_init_sdw(struct sdw_slave *sdw,
641 const struct regmap_config *config,
642 struct lock_class_key *lock_key,
643 const char *lock_name);
644 struct regmap *__devm_regmap_init_sdw_mbq(struct sdw_slave *sdw,
645 const struct regmap_config *config,
646 struct lock_class_key *lock_key,
647 const char *lock_name);
648 struct regmap *__devm_regmap_init_slimbus(struct slim_device *slimbus,
649 const struct regmap_config *config,
650 struct lock_class_key *lock_key,
651 const char *lock_name);
652 struct regmap *__devm_regmap_init_i3c(struct i3c_device *i3c,
653 const struct regmap_config *config,
654 struct lock_class_key *lock_key,
655 const char *lock_name);
656 struct regmap *__devm_regmap_init_spi_avmm(struct spi_device *spi,
657 const struct regmap_config *config,
658 struct lock_class_key *lock_key,
659 const char *lock_name);
661 * Wrapper for regmap_init macros to include a unique lockdep key and name
662 * for each call. No-op if CONFIG_LOCKDEP is not set.
664 * @fn: Real function to call (in the form __[*_]regmap_init[_*])
665 * @name: Config variable name (#config in the calling macro)
667 #ifdef CONFIG_LOCKDEP
668 #define __regmap_lockdep_wrapper(fn, name, ...) \
671 static struct lock_class_key _key; \
672 fn(__VA_ARGS__, &_key, \
673 KBUILD_BASENAME ":" \
674 __stringify(__LINE__) ":" \
675 "(" name ")->lock"); \
679 #define __regmap_lockdep_wrapper(fn, name, ...) fn(__VA_ARGS__, NULL, NULL)
683 * regmap_init() - Initialise register map
685 * @dev: Device that will be interacted with
686 * @bus: Bus-specific callbacks to use with device
687 * @bus_context: Data passed to bus-specific callbacks
688 * @config: Configuration for register map
690 * The return value will be an ERR_PTR() on error or a valid pointer to
691 * a struct regmap. This function should generally not be called
692 * directly, it should be called by bus-specific init functions.
694 #define regmap_init(dev, bus, bus_context, config) \
695 __regmap_lockdep_wrapper(__regmap_init, #config, \
696 dev, bus, bus_context, config)
697 int regmap_attach_dev(struct device *dev, struct regmap *map,
698 const struct regmap_config *config);
701 * regmap_init_i2c() - Initialise register map
703 * @i2c: Device that will be interacted with
704 * @config: Configuration for register map
706 * The return value will be an ERR_PTR() on error or a valid pointer to
709 #define regmap_init_i2c(i2c, config) \
710 __regmap_lockdep_wrapper(__regmap_init_i2c, #config, \
714 * regmap_init_mdio() - Initialise register map
716 * @mdio_dev: Device that will be interacted with
717 * @config: Configuration for register map
719 * The return value will be an ERR_PTR() on error or a valid pointer to
722 #define regmap_init_mdio(mdio_dev, config) \
723 __regmap_lockdep_wrapper(__regmap_init_mdio, #config, \
727 * regmap_init_sccb() - Initialise register map
729 * @i2c: Device that will be interacted with
730 * @config: Configuration for register map
732 * The return value will be an ERR_PTR() on error or a valid pointer to
735 #define regmap_init_sccb(i2c, config) \
736 __regmap_lockdep_wrapper(__regmap_init_sccb, #config, \
740 * regmap_init_slimbus() - Initialise register map
742 * @slimbus: Device that will be interacted with
743 * @config: Configuration for register map
745 * The return value will be an ERR_PTR() on error or a valid pointer to
748 #define regmap_init_slimbus(slimbus, config) \
749 __regmap_lockdep_wrapper(__regmap_init_slimbus, #config, \
753 * regmap_init_spi() - Initialise register map
755 * @dev: Device that will be interacted with
756 * @config: Configuration for register map
758 * The return value will be an ERR_PTR() on error or a valid pointer to
761 #define regmap_init_spi(dev, config) \
762 __regmap_lockdep_wrapper(__regmap_init_spi, #config, \
766 * regmap_init_spmi_base() - Create regmap for the Base register space
768 * @dev: SPMI device that will be interacted with
769 * @config: Configuration for register map
771 * The return value will be an ERR_PTR() on error or a valid pointer to
774 #define regmap_init_spmi_base(dev, config) \
775 __regmap_lockdep_wrapper(__regmap_init_spmi_base, #config, \
779 * regmap_init_spmi_ext() - Create regmap for Ext register space
781 * @dev: Device that will be interacted with
782 * @config: Configuration for register map
784 * The return value will be an ERR_PTR() on error or a valid pointer to
787 #define regmap_init_spmi_ext(dev, config) \
788 __regmap_lockdep_wrapper(__regmap_init_spmi_ext, #config, \
792 * regmap_init_w1() - Initialise register map
794 * @w1_dev: Device that will be interacted with
795 * @config: Configuration for register map
797 * The return value will be an ERR_PTR() on error or a valid pointer to
800 #define regmap_init_w1(w1_dev, config) \
801 __regmap_lockdep_wrapper(__regmap_init_w1, #config, \
805 * regmap_init_mmio_clk() - Initialise register map with register clock
807 * @dev: Device that will be interacted with
808 * @clk_id: register clock consumer ID
809 * @regs: Pointer to memory-mapped IO region
810 * @config: Configuration for register map
812 * The return value will be an ERR_PTR() on error or a valid pointer to
815 #define regmap_init_mmio_clk(dev, clk_id, regs, config) \
816 __regmap_lockdep_wrapper(__regmap_init_mmio_clk, #config, \
817 dev, clk_id, regs, config)
820 * regmap_init_mmio() - Initialise register map
822 * @dev: Device that will be interacted with
823 * @regs: Pointer to memory-mapped IO region
824 * @config: Configuration for register map
826 * The return value will be an ERR_PTR() on error or a valid pointer to
829 #define regmap_init_mmio(dev, regs, config) \
830 regmap_init_mmio_clk(dev, NULL, regs, config)
833 * regmap_init_ac97() - Initialise AC'97 register map
835 * @ac97: Device that will be interacted with
836 * @config: Configuration for register map
838 * The return value will be an ERR_PTR() on error or a valid pointer to
841 #define regmap_init_ac97(ac97, config) \
842 __regmap_lockdep_wrapper(__regmap_init_ac97, #config, \
844 bool regmap_ac97_default_volatile(struct device *dev, unsigned int reg);
847 * regmap_init_sdw() - Initialise register map
849 * @sdw: Device that will be interacted with
850 * @config: Configuration for register map
852 * The return value will be an ERR_PTR() on error or a valid pointer to
855 #define regmap_init_sdw(sdw, config) \
856 __regmap_lockdep_wrapper(__regmap_init_sdw, #config, \
860 * regmap_init_sdw_mbq() - Initialise register map
862 * @sdw: Device that will be interacted with
863 * @config: Configuration for register map
865 * The return value will be an ERR_PTR() on error or a valid pointer to
868 #define regmap_init_sdw_mbq(sdw, config) \
869 __regmap_lockdep_wrapper(__regmap_init_sdw_mbq, #config, \
873 * regmap_init_spi_avmm() - Initialize register map for Intel SPI Slave
876 * @spi: Device that will be interacted with
877 * @config: Configuration for register map
879 * The return value will be an ERR_PTR() on error or a valid pointer
880 * to a struct regmap.
882 #define regmap_init_spi_avmm(spi, config) \
883 __regmap_lockdep_wrapper(__regmap_init_spi_avmm, #config, \
887 * devm_regmap_init() - Initialise managed register map
889 * @dev: Device that will be interacted with
890 * @bus: Bus-specific callbacks to use with device
891 * @bus_context: Data passed to bus-specific callbacks
892 * @config: Configuration for register map
894 * The return value will be an ERR_PTR() on error or a valid pointer
895 * to a struct regmap. This function should generally not be called
896 * directly, it should be called by bus-specific init functions. The
897 * map will be automatically freed by the device management code.
899 #define devm_regmap_init(dev, bus, bus_context, config) \
900 __regmap_lockdep_wrapper(__devm_regmap_init, #config, \
901 dev, bus, bus_context, config)
904 * devm_regmap_init_i2c() - Initialise managed register map
906 * @i2c: Device that will be interacted with
907 * @config: Configuration for register map
909 * The return value will be an ERR_PTR() on error or a valid pointer
910 * to a struct regmap. The regmap will be automatically freed by the
911 * device management code.
913 #define devm_regmap_init_i2c(i2c, config) \
914 __regmap_lockdep_wrapper(__devm_regmap_init_i2c, #config, \
918 * devm_regmap_init_mdio() - Initialise managed register map
920 * @mdio_dev: Device that will be interacted with
921 * @config: Configuration for register map
923 * The return value will be an ERR_PTR() on error or a valid pointer
924 * to a struct regmap. The regmap will be automatically freed by the
925 * device management code.
927 #define devm_regmap_init_mdio(mdio_dev, config) \
928 __regmap_lockdep_wrapper(__devm_regmap_init_mdio, #config, \
932 * devm_regmap_init_sccb() - Initialise managed register map
934 * @i2c: Device that will be interacted with
935 * @config: Configuration for register map
937 * The return value will be an ERR_PTR() on error or a valid pointer
938 * to a struct regmap. The regmap will be automatically freed by the
939 * device management code.
941 #define devm_regmap_init_sccb(i2c, config) \
942 __regmap_lockdep_wrapper(__devm_regmap_init_sccb, #config, \
946 * devm_regmap_init_spi() - Initialise register map
948 * @dev: Device that will be interacted with
949 * @config: Configuration for register map
951 * The return value will be an ERR_PTR() on error or a valid pointer
952 * to a struct regmap. The map will be automatically freed by the
953 * device management code.
955 #define devm_regmap_init_spi(dev, config) \
956 __regmap_lockdep_wrapper(__devm_regmap_init_spi, #config, \
960 * devm_regmap_init_spmi_base() - Create managed regmap for Base register space
962 * @dev: SPMI device that will be interacted with
963 * @config: Configuration for register map
965 * The return value will be an ERR_PTR() on error or a valid pointer
966 * to a struct regmap. The regmap will be automatically freed by the
967 * device management code.
969 #define devm_regmap_init_spmi_base(dev, config) \
970 __regmap_lockdep_wrapper(__devm_regmap_init_spmi_base, #config, \
974 * devm_regmap_init_spmi_ext() - Create managed regmap for Ext register space
976 * @dev: SPMI device that will be interacted with
977 * @config: Configuration for register map
979 * The return value will be an ERR_PTR() on error or a valid pointer
980 * to a struct regmap. The regmap will be automatically freed by the
981 * device management code.
983 #define devm_regmap_init_spmi_ext(dev, config) \
984 __regmap_lockdep_wrapper(__devm_regmap_init_spmi_ext, #config, \
988 * devm_regmap_init_w1() - Initialise managed register map
990 * @w1_dev: Device that will be interacted with
991 * @config: Configuration for register map
993 * The return value will be an ERR_PTR() on error or a valid pointer
994 * to a struct regmap. The regmap will be automatically freed by the
995 * device management code.
997 #define devm_regmap_init_w1(w1_dev, config) \
998 __regmap_lockdep_wrapper(__devm_regmap_init_w1, #config, \
1001 * devm_regmap_init_mmio_clk() - Initialise managed register map with clock
1003 * @dev: Device that will be interacted with
1004 * @clk_id: register clock consumer ID
1005 * @regs: Pointer to memory-mapped IO region
1006 * @config: Configuration for register map
1008 * The return value will be an ERR_PTR() on error or a valid pointer
1009 * to a struct regmap. The regmap will be automatically freed by the
1010 * device management code.
1012 #define devm_regmap_init_mmio_clk(dev, clk_id, regs, config) \
1013 __regmap_lockdep_wrapper(__devm_regmap_init_mmio_clk, #config, \
1014 dev, clk_id, regs, config)
1017 * devm_regmap_init_mmio() - Initialise managed register map
1019 * @dev: Device that will be interacted with
1020 * @regs: Pointer to memory-mapped IO region
1021 * @config: Configuration for register map
1023 * The return value will be an ERR_PTR() on error or a valid pointer
1024 * to a struct regmap. The regmap will be automatically freed by the
1025 * device management code.
1027 #define devm_regmap_init_mmio(dev, regs, config) \
1028 devm_regmap_init_mmio_clk(dev, NULL, regs, config)
1031 * devm_regmap_init_ac97() - Initialise AC'97 register map
1033 * @ac97: Device that will be interacted with
1034 * @config: Configuration for register map
1036 * The return value will be an ERR_PTR() on error or a valid pointer
1037 * to a struct regmap. The regmap will be automatically freed by the
1038 * device management code.
1040 #define devm_regmap_init_ac97(ac97, config) \
1041 __regmap_lockdep_wrapper(__devm_regmap_init_ac97, #config, \
1045 * devm_regmap_init_sdw() - Initialise managed register map
1047 * @sdw: Device that will be interacted with
1048 * @config: Configuration for register map
1050 * The return value will be an ERR_PTR() on error or a valid pointer
1051 * to a struct regmap. The regmap will be automatically freed by the
1052 * device management code.
1054 #define devm_regmap_init_sdw(sdw, config) \
1055 __regmap_lockdep_wrapper(__devm_regmap_init_sdw, #config, \
1059 * devm_regmap_init_sdw_mbq() - Initialise managed register map
1061 * @sdw: Device that will be interacted with
1062 * @config: Configuration for register map
1064 * The return value will be an ERR_PTR() on error or a valid pointer
1065 * to a struct regmap. The regmap will be automatically freed by the
1066 * device management code.
1068 #define devm_regmap_init_sdw_mbq(sdw, config) \
1069 __regmap_lockdep_wrapper(__devm_regmap_init_sdw_mbq, #config, \
1073 * devm_regmap_init_slimbus() - Initialise managed register map
1075 * @slimbus: Device that will be interacted with
1076 * @config: Configuration for register map
1078 * The return value will be an ERR_PTR() on error or a valid pointer
1079 * to a struct regmap. The regmap will be automatically freed by the
1080 * device management code.
1082 #define devm_regmap_init_slimbus(slimbus, config) \
1083 __regmap_lockdep_wrapper(__devm_regmap_init_slimbus, #config, \
1087 * devm_regmap_init_i3c() - Initialise managed register map
1089 * @i3c: Device that will be interacted with
1090 * @config: Configuration for register map
1092 * The return value will be an ERR_PTR() on error or a valid pointer
1093 * to a struct regmap. The regmap will be automatically freed by the
1094 * device management code.
1096 #define devm_regmap_init_i3c(i3c, config) \
1097 __regmap_lockdep_wrapper(__devm_regmap_init_i3c, #config, \
1101 * devm_regmap_init_spi_avmm() - Initialize register map for Intel SPI Slave
1102 * to AVMM Bus Bridge
1104 * @spi: Device that will be interacted with
1105 * @config: Configuration for register map
1107 * The return value will be an ERR_PTR() on error or a valid pointer
1108 * to a struct regmap. The map will be automatically freed by the
1109 * device management code.
1111 #define devm_regmap_init_spi_avmm(spi, config) \
1112 __regmap_lockdep_wrapper(__devm_regmap_init_spi_avmm, #config, \
1115 int regmap_mmio_attach_clk(struct regmap *map, struct clk *clk);
1116 void regmap_mmio_detach_clk(struct regmap *map);
1117 void regmap_exit(struct regmap *map);
1118 int regmap_reinit_cache(struct regmap *map,
1119 const struct regmap_config *config);
1120 struct regmap *dev_get_regmap(struct device *dev, const char *name);
1121 struct device *regmap_get_device(struct regmap *map);
1122 int regmap_write(struct regmap *map, unsigned int reg, unsigned int val);
1123 int regmap_write_async(struct regmap *map, unsigned int reg, unsigned int val);
1124 int regmap_raw_write(struct regmap *map, unsigned int reg,
1125 const void *val, size_t val_len);
1126 int regmap_noinc_write(struct regmap *map, unsigned int reg,
1127 const void *val, size_t val_len);
1128 int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
1130 int regmap_multi_reg_write(struct regmap *map, const struct reg_sequence *regs,
1132 int regmap_multi_reg_write_bypassed(struct regmap *map,
1133 const struct reg_sequence *regs,
1135 int regmap_raw_write_async(struct regmap *map, unsigned int reg,
1136 const void *val, size_t val_len);
1137 int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val);
1138 int regmap_raw_read(struct regmap *map, unsigned int reg,
1139 void *val, size_t val_len);
1140 int regmap_noinc_read(struct regmap *map, unsigned int reg,
1141 void *val, size_t val_len);
1142 int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
1144 int regmap_update_bits_base(struct regmap *map, unsigned int reg,
1145 unsigned int mask, unsigned int val,
1146 bool *change, bool async, bool force);
1148 static inline int regmap_update_bits(struct regmap *map, unsigned int reg,
1149 unsigned int mask, unsigned int val)
1151 return regmap_update_bits_base(map, reg, mask, val, NULL, false, false);
1154 static inline int regmap_update_bits_async(struct regmap *map, unsigned int reg,
1155 unsigned int mask, unsigned int val)
1157 return regmap_update_bits_base(map, reg, mask, val, NULL, true, false);
1160 static inline int regmap_update_bits_check(struct regmap *map, unsigned int reg,
1161 unsigned int mask, unsigned int val,
1164 return regmap_update_bits_base(map, reg, mask, val,
1165 change, false, false);
1169 regmap_update_bits_check_async(struct regmap *map, unsigned int reg,
1170 unsigned int mask, unsigned int val,
1173 return regmap_update_bits_base(map, reg, mask, val,
1174 change, true, false);
1177 static inline int regmap_write_bits(struct regmap *map, unsigned int reg,
1178 unsigned int mask, unsigned int val)
1180 return regmap_update_bits_base(map, reg, mask, val, NULL, false, true);
1183 int regmap_get_val_bytes(struct regmap *map);
1184 int regmap_get_max_register(struct regmap *map);
1185 int regmap_get_reg_stride(struct regmap *map);
1186 int regmap_async_complete(struct regmap *map);
1187 bool regmap_can_raw_write(struct regmap *map);
1188 size_t regmap_get_raw_read_max(struct regmap *map);
1189 size_t regmap_get_raw_write_max(struct regmap *map);
1191 int regcache_sync(struct regmap *map);
1192 int regcache_sync_region(struct regmap *map, unsigned int min,
1194 int regcache_drop_region(struct regmap *map, unsigned int min,
1196 void regcache_cache_only(struct regmap *map, bool enable);
1197 void regcache_cache_bypass(struct regmap *map, bool enable);
1198 void regcache_mark_dirty(struct regmap *map);
1200 bool regmap_check_range_table(struct regmap *map, unsigned int reg,
1201 const struct regmap_access_table *table);
1203 int regmap_register_patch(struct regmap *map, const struct reg_sequence *regs,
1205 int regmap_parse_val(struct regmap *map, const void *buf,
1208 static inline bool regmap_reg_in_range(unsigned int reg,
1209 const struct regmap_range *range)
1211 return reg >= range->range_min && reg <= range->range_max;
1214 bool regmap_reg_in_ranges(unsigned int reg,
1215 const struct regmap_range *ranges,
1216 unsigned int nranges);
1218 static inline int regmap_set_bits(struct regmap *map,
1219 unsigned int reg, unsigned int bits)
1221 return regmap_update_bits_base(map, reg, bits, bits,
1222 NULL, false, false);
1225 static inline int regmap_clear_bits(struct regmap *map,
1226 unsigned int reg, unsigned int bits)
1228 return regmap_update_bits_base(map, reg, bits, 0, NULL, false, false);
1231 int regmap_test_bits(struct regmap *map, unsigned int reg, unsigned int bits);
1234 * struct reg_field - Description of an register field
1236 * @reg: Offset of the register within the regmap bank
1237 * @lsb: lsb of the register field.
1238 * @msb: msb of the register field.
1239 * @id_size: port size if it has some ports
1240 * @id_offset: address offset for each ports
1246 unsigned int id_size;
1247 unsigned int id_offset;
1250 #define REG_FIELD(_reg, _lsb, _msb) { \
1256 #define REG_FIELD_ID(_reg, _lsb, _msb, _size, _offset) { \
1261 .id_offset = _offset, \
1264 struct regmap_field *regmap_field_alloc(struct regmap *regmap,
1265 struct reg_field reg_field);
1266 void regmap_field_free(struct regmap_field *field);
1268 struct regmap_field *devm_regmap_field_alloc(struct device *dev,
1269 struct regmap *regmap, struct reg_field reg_field);
1270 void devm_regmap_field_free(struct device *dev, struct regmap_field *field);
1272 int regmap_field_bulk_alloc(struct regmap *regmap,
1273 struct regmap_field **rm_field,
1274 const struct reg_field *reg_field,
1276 void regmap_field_bulk_free(struct regmap_field *field);
1277 int devm_regmap_field_bulk_alloc(struct device *dev, struct regmap *regmap,
1278 struct regmap_field **field,
1279 const struct reg_field *reg_field,
1281 void devm_regmap_field_bulk_free(struct device *dev,
1282 struct regmap_field *field);
1284 int regmap_field_read(struct regmap_field *field, unsigned int *val);
1285 int regmap_field_update_bits_base(struct regmap_field *field,
1286 unsigned int mask, unsigned int val,
1287 bool *change, bool async, bool force);
1288 int regmap_fields_read(struct regmap_field *field, unsigned int id,
1290 int regmap_fields_update_bits_base(struct regmap_field *field, unsigned int id,
1291 unsigned int mask, unsigned int val,
1292 bool *change, bool async, bool force);
1294 static inline int regmap_field_write(struct regmap_field *field,
1297 return regmap_field_update_bits_base(field, ~0, val,
1298 NULL, false, false);
1301 static inline int regmap_field_force_write(struct regmap_field *field,
1304 return regmap_field_update_bits_base(field, ~0, val, NULL, false, true);
1307 static inline int regmap_field_update_bits(struct regmap_field *field,
1308 unsigned int mask, unsigned int val)
1310 return regmap_field_update_bits_base(field, mask, val,
1311 NULL, false, false);
1315 regmap_field_force_update_bits(struct regmap_field *field,
1316 unsigned int mask, unsigned int val)
1318 return regmap_field_update_bits_base(field, mask, val,
1322 static inline int regmap_fields_write(struct regmap_field *field,
1323 unsigned int id, unsigned int val)
1325 return regmap_fields_update_bits_base(field, id, ~0, val,
1326 NULL, false, false);
1329 static inline int regmap_fields_force_write(struct regmap_field *field,
1330 unsigned int id, unsigned int val)
1332 return regmap_fields_update_bits_base(field, id, ~0, val,
1337 regmap_fields_update_bits(struct regmap_field *field, unsigned int id,
1338 unsigned int mask, unsigned int val)
1340 return regmap_fields_update_bits_base(field, id, mask, val,
1341 NULL, false, false);
1345 regmap_fields_force_update_bits(struct regmap_field *field, unsigned int id,
1346 unsigned int mask, unsigned int val)
1348 return regmap_fields_update_bits_base(field, id, mask, val,
1353 * struct regmap_irq_type - IRQ type definitions.
1355 * @type_reg_offset: Offset register for the irq type setting.
1356 * @type_rising_val: Register value to configure RISING type irq.
1357 * @type_falling_val: Register value to configure FALLING type irq.
1358 * @type_level_low_val: Register value to configure LEVEL_LOW type irq.
1359 * @type_level_high_val: Register value to configure LEVEL_HIGH type irq.
1360 * @types_supported: logical OR of IRQ_TYPE_* flags indicating supported types.
1362 struct regmap_irq_type {
1363 unsigned int type_reg_offset;
1364 unsigned int type_reg_mask;
1365 unsigned int type_rising_val;
1366 unsigned int type_falling_val;
1367 unsigned int type_level_low_val;
1368 unsigned int type_level_high_val;
1369 unsigned int types_supported;
1373 * struct regmap_irq - Description of an IRQ for the generic regmap irq_chip.
1375 * @reg_offset: Offset of the status/mask register within the bank
1376 * @mask: Mask used to flag/control the register.
1377 * @type: IRQ trigger type setting details if supported.
1380 unsigned int reg_offset;
1382 struct regmap_irq_type type;
1385 #define REGMAP_IRQ_REG(_irq, _off, _mask) \
1386 [_irq] = { .reg_offset = (_off), .mask = (_mask) }
1388 #define REGMAP_IRQ_REG_LINE(_id, _reg_bits) \
1390 .mask = BIT((_id) % (_reg_bits)), \
1391 .reg_offset = (_id) / (_reg_bits), \
1394 #define REGMAP_IRQ_MAIN_REG_OFFSET(arr) \
1395 { .num_regs = ARRAY_SIZE((arr)), .offset = &(arr)[0] }
1397 struct regmap_irq_sub_irq_map {
1398 unsigned int num_regs;
1399 unsigned int *offset;
1403 * struct regmap_irq_chip - Description of a generic regmap irq_chip.
1405 * @name: Descriptive name for IRQ controller.
1407 * @main_status: Base main status register address. For chips which have
1408 * interrupts arranged in separate sub-irq blocks with own IRQ
1409 * registers and which have a main IRQ registers indicating
1410 * sub-irq blocks with unhandled interrupts. For such chips fill
1411 * sub-irq register information in status_base, mask_base and
1413 * @num_main_status_bits: Should be given to chips where number of meaningfull
1414 * main status bits differs from num_regs.
1415 * @sub_reg_offsets: arrays of mappings from main register bits to sub irq
1416 * registers. First item in array describes the registers
1417 * for first main status bit. Second array for second bit etc.
1418 * Offset is given as sub register status offset to
1419 * status_base. Should contain num_regs arrays.
1420 * Can be provided for chips with more complex mapping than
1421 * 1.st bit to 1.st sub-reg, 2.nd bit to 2.nd sub-reg, ...
1422 * When used with not_fixed_stride, each one-element array
1423 * member contains offset calculated as address from each
1424 * peripheral to first peripheral.
1425 * @num_main_regs: Number of 'main status' irq registers for chips which have
1428 * @status_base: Base status register address.
1429 * @mask_base: Base mask register address.
1430 * @mask_writeonly: Base mask register is write only.
1431 * @unmask_base: Base unmask register address. for chips who have
1432 * separate mask and unmask registers
1433 * @ack_base: Base ack address. If zero then the chip is clear on read.
1434 * Using zero value is possible with @use_ack bit.
1435 * @wake_base: Base address for wake enables. If zero unsupported.
1436 * @type_base: Base address for irq type. If zero unsupported.
1437 * @virt_reg_base: Base addresses for extra config regs.
1438 * @irq_reg_stride: Stride to use for chips where registers are not contiguous.
1439 * @init_ack_masked: Ack all masked interrupts once during initalization.
1440 * @mask_invert: Inverted mask register: cleared bits are masked out.
1441 * @use_ack: Use @ack register even if it is zero.
1442 * @ack_invert: Inverted ack register: cleared bits for ack.
1443 * @clear_ack: Use this to set 1 and 0 or vice-versa to clear interrupts.
1444 * @wake_invert: Inverted wake register: cleared bits are wake enabled.
1445 * @type_invert: Invert the type flags.
1446 * @type_in_mask: Use the mask registers for controlling irq type. For
1447 * interrupts defining type_rising/falling_mask use mask_base
1448 * for edge configuration and never update bits in type_base.
1449 * @clear_on_unmask: For chips with interrupts cleared on read: read the status
1450 * registers before unmasking interrupts to clear any bits
1451 * set when they were masked.
1452 * @not_fixed_stride: Used when chip peripherals are not laid out with fixed
1453 * stride. Must be used with sub_reg_offsets containing the
1454 * offsets to each peripheral.
1455 * @status_invert: Inverted status register: cleared bits are active interrupts.
1456 * @runtime_pm: Hold a runtime PM lock on the device when accessing it.
1458 * @num_regs: Number of registers in each control bank.
1459 * @irqs: Descriptors for individual IRQs. Interrupt numbers are
1460 * assigned based on the index in the array of the interrupt.
1461 * @num_irqs: Number of descriptors.
1462 * @num_type_reg: Number of type registers.
1463 * @num_virt_regs: Number of non-standard irq configuration registers.
1464 * If zero unsupported.
1465 * @type_reg_stride: Stride to use for chips where type registers are not
1467 * @handle_pre_irq: Driver specific callback to handle interrupt from device
1468 * before regmap_irq_handler process the interrupts.
1469 * @handle_post_irq: Driver specific callback to handle interrupt from device
1470 * after handling the interrupts in regmap_irq_handler().
1471 * @set_type_virt: Driver specific callback to extend regmap_irq_set_type()
1472 * and configure virt regs.
1473 * @irq_drv_data: Driver specific IRQ data which is passed as parameter when
1474 * driver specific pre/post interrupt handler is called.
1476 * This is not intended to handle every possible interrupt controller, but
1477 * it should handle a substantial proportion of those that are found in the
1480 struct regmap_irq_chip {
1483 unsigned int main_status;
1484 unsigned int num_main_status_bits;
1485 struct regmap_irq_sub_irq_map *sub_reg_offsets;
1488 unsigned int status_base;
1489 unsigned int mask_base;
1490 unsigned int unmask_base;
1491 unsigned int ack_base;
1492 unsigned int wake_base;
1493 unsigned int type_base;
1494 unsigned int *virt_reg_base;
1495 unsigned int irq_reg_stride;
1496 bool mask_writeonly:1;
1497 bool init_ack_masked:1;
1505 bool type_in_mask:1;
1506 bool clear_on_unmask:1;
1507 bool not_fixed_stride:1;
1508 bool status_invert:1;
1512 const struct regmap_irq *irqs;
1517 unsigned int type_reg_stride;
1519 int (*handle_pre_irq)(void *irq_drv_data);
1520 int (*handle_post_irq)(void *irq_drv_data);
1521 int (*set_type_virt)(unsigned int **buf, unsigned int type,
1522 unsigned long hwirq, int reg);
1526 struct regmap_irq_chip_data;
1528 int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags,
1529 int irq_base, const struct regmap_irq_chip *chip,
1530 struct regmap_irq_chip_data **data);
1531 int regmap_add_irq_chip_fwnode(struct fwnode_handle *fwnode,
1532 struct regmap *map, int irq,
1533 int irq_flags, int irq_base,
1534 const struct regmap_irq_chip *chip,
1535 struct regmap_irq_chip_data **data);
1536 void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data);
1538 int devm_regmap_add_irq_chip(struct device *dev, struct regmap *map, int irq,
1539 int irq_flags, int irq_base,
1540 const struct regmap_irq_chip *chip,
1541 struct regmap_irq_chip_data **data);
1542 int devm_regmap_add_irq_chip_fwnode(struct device *dev,
1543 struct fwnode_handle *fwnode,
1544 struct regmap *map, int irq,
1545 int irq_flags, int irq_base,
1546 const struct regmap_irq_chip *chip,
1547 struct regmap_irq_chip_data **data);
1548 void devm_regmap_del_irq_chip(struct device *dev, int irq,
1549 struct regmap_irq_chip_data *data);
1551 int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data);
1552 int regmap_irq_get_virq(struct regmap_irq_chip_data *data, int irq);
1553 struct irq_domain *regmap_irq_get_domain(struct regmap_irq_chip_data *data);
1558 * These stubs should only ever be called by generic code which has
1559 * regmap based facilities, if they ever get called at runtime
1560 * something is going wrong and something probably needs to select
1564 static inline int regmap_write(struct regmap *map, unsigned int reg,
1567 WARN_ONCE(1, "regmap API is disabled");
1571 static inline int regmap_write_async(struct regmap *map, unsigned int reg,
1574 WARN_ONCE(1, "regmap API is disabled");
1578 static inline int regmap_raw_write(struct regmap *map, unsigned int reg,
1579 const void *val, size_t val_len)
1581 WARN_ONCE(1, "regmap API is disabled");
1585 static inline int regmap_raw_write_async(struct regmap *map, unsigned int reg,
1586 const void *val, size_t val_len)
1588 WARN_ONCE(1, "regmap API is disabled");
1592 static inline int regmap_noinc_write(struct regmap *map, unsigned int reg,
1593 const void *val, size_t val_len)
1595 WARN_ONCE(1, "regmap API is disabled");
1599 static inline int regmap_bulk_write(struct regmap *map, unsigned int reg,
1600 const void *val, size_t val_count)
1602 WARN_ONCE(1, "regmap API is disabled");
1606 static inline int regmap_read(struct regmap *map, unsigned int reg,
1609 WARN_ONCE(1, "regmap API is disabled");
1613 static inline int regmap_raw_read(struct regmap *map, unsigned int reg,
1614 void *val, size_t val_len)
1616 WARN_ONCE(1, "regmap API is disabled");
1620 static inline int regmap_noinc_read(struct regmap *map, unsigned int reg,
1621 void *val, size_t val_len)
1623 WARN_ONCE(1, "regmap API is disabled");
1627 static inline int regmap_bulk_read(struct regmap *map, unsigned int reg,
1628 void *val, size_t val_count)
1630 WARN_ONCE(1, "regmap API is disabled");
1634 static inline int regmap_update_bits_base(struct regmap *map, unsigned int reg,
1635 unsigned int mask, unsigned int val,
1636 bool *change, bool async, bool force)
1638 WARN_ONCE(1, "regmap API is disabled");
1642 static inline int regmap_set_bits(struct regmap *map,
1643 unsigned int reg, unsigned int bits)
1645 WARN_ONCE(1, "regmap API is disabled");
1649 static inline int regmap_clear_bits(struct regmap *map,
1650 unsigned int reg, unsigned int bits)
1652 WARN_ONCE(1, "regmap API is disabled");
1656 static inline int regmap_test_bits(struct regmap *map,
1657 unsigned int reg, unsigned int bits)
1659 WARN_ONCE(1, "regmap API is disabled");
1663 static inline int regmap_field_update_bits_base(struct regmap_field *field,
1664 unsigned int mask, unsigned int val,
1665 bool *change, bool async, bool force)
1667 WARN_ONCE(1, "regmap API is disabled");
1671 static inline int regmap_fields_update_bits_base(struct regmap_field *field,
1673 unsigned int mask, unsigned int val,
1674 bool *change, bool async, bool force)
1676 WARN_ONCE(1, "regmap API is disabled");
1680 static inline int regmap_update_bits(struct regmap *map, unsigned int reg,
1681 unsigned int mask, unsigned int val)
1683 WARN_ONCE(1, "regmap API is disabled");
1687 static inline int regmap_update_bits_async(struct regmap *map, unsigned int reg,
1688 unsigned int mask, unsigned int val)
1690 WARN_ONCE(1, "regmap API is disabled");
1694 static inline int regmap_update_bits_check(struct regmap *map, unsigned int reg,
1695 unsigned int mask, unsigned int val,
1698 WARN_ONCE(1, "regmap API is disabled");
1703 regmap_update_bits_check_async(struct regmap *map, unsigned int reg,
1704 unsigned int mask, unsigned int val,
1707 WARN_ONCE(1, "regmap API is disabled");
1711 static inline int regmap_write_bits(struct regmap *map, unsigned int reg,
1712 unsigned int mask, unsigned int val)
1714 WARN_ONCE(1, "regmap API is disabled");
1718 static inline int regmap_field_write(struct regmap_field *field,
1721 WARN_ONCE(1, "regmap API is disabled");
1725 static inline int regmap_field_force_write(struct regmap_field *field,
1728 WARN_ONCE(1, "regmap API is disabled");
1732 static inline int regmap_field_update_bits(struct regmap_field *field,
1733 unsigned int mask, unsigned int val)
1735 WARN_ONCE(1, "regmap API is disabled");
1740 regmap_field_force_update_bits(struct regmap_field *field,
1741 unsigned int mask, unsigned int val)
1743 WARN_ONCE(1, "regmap API is disabled");
1747 static inline int regmap_fields_write(struct regmap_field *field,
1748 unsigned int id, unsigned int val)
1750 WARN_ONCE(1, "regmap API is disabled");
1754 static inline int regmap_fields_force_write(struct regmap_field *field,
1755 unsigned int id, unsigned int val)
1757 WARN_ONCE(1, "regmap API is disabled");
1762 regmap_fields_update_bits(struct regmap_field *field, unsigned int id,
1763 unsigned int mask, unsigned int val)
1765 WARN_ONCE(1, "regmap API is disabled");
1770 regmap_fields_force_update_bits(struct regmap_field *field, unsigned int id,
1771 unsigned int mask, unsigned int val)
1773 WARN_ONCE(1, "regmap API is disabled");
1777 static inline int regmap_get_val_bytes(struct regmap *map)
1779 WARN_ONCE(1, "regmap API is disabled");
1783 static inline int regmap_get_max_register(struct regmap *map)
1785 WARN_ONCE(1, "regmap API is disabled");
1789 static inline int regmap_get_reg_stride(struct regmap *map)
1791 WARN_ONCE(1, "regmap API is disabled");
1795 static inline int regcache_sync(struct regmap *map)
1797 WARN_ONCE(1, "regmap API is disabled");
1801 static inline int regcache_sync_region(struct regmap *map, unsigned int min,
1804 WARN_ONCE(1, "regmap API is disabled");
1808 static inline int regcache_drop_region(struct regmap *map, unsigned int min,
1811 WARN_ONCE(1, "regmap API is disabled");
1815 static inline void regcache_cache_only(struct regmap *map, bool enable)
1817 WARN_ONCE(1, "regmap API is disabled");
1820 static inline void regcache_cache_bypass(struct regmap *map, bool enable)
1822 WARN_ONCE(1, "regmap API is disabled");
1825 static inline void regcache_mark_dirty(struct regmap *map)
1827 WARN_ONCE(1, "regmap API is disabled");
1830 static inline void regmap_async_complete(struct regmap *map)
1832 WARN_ONCE(1, "regmap API is disabled");
1835 static inline int regmap_register_patch(struct regmap *map,
1836 const struct reg_sequence *regs,
1839 WARN_ONCE(1, "regmap API is disabled");
1843 static inline int regmap_parse_val(struct regmap *map, const void *buf,
1846 WARN_ONCE(1, "regmap API is disabled");
1850 static inline struct regmap *dev_get_regmap(struct device *dev,
1856 static inline struct device *regmap_get_device(struct regmap *map)
1858 WARN_ONCE(1, "regmap API is disabled");