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 * @reg_update_bits: Optional callback that if filled will be used to perform
294 * all the update_bits(rmw) operation. Should only be provided
295 * if the function require special handling with lock and reg
296 * handling and the operation cannot be represented as a simple
297 * update_bits operation on a bus such as SPI, I2C, etc.
298 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
299 * to perform locking. This field is ignored if custom lock/unlock
300 * functions are used (see fields lock/unlock of struct regmap_config).
301 * This field is a duplicate of a similar file in
302 * 'struct regmap_bus' and serves exact same purpose.
303 * Use it only for "no-bus" cases.
304 * @max_register: Optional, specifies the maximum valid register address.
305 * @wr_table: Optional, points to a struct regmap_access_table specifying
306 * valid ranges for write access.
307 * @rd_table: As above, for read access.
308 * @volatile_table: As above, for volatile registers.
309 * @precious_table: As above, for precious registers.
310 * @wr_noinc_table: As above, for no increment writeable registers.
311 * @rd_noinc_table: As above, for no increment readable registers.
312 * @reg_defaults: Power on reset values for registers (for use with
313 * register cache support).
314 * @num_reg_defaults: Number of elements in reg_defaults.
316 * @read_flag_mask: Mask to be set in the top bytes of the register when doing
318 * @write_flag_mask: Mask to be set in the top bytes of the register when doing
319 * a write. If both read_flag_mask and write_flag_mask are
320 * empty and zero_flag_mask is not set the regmap_bus default
322 * @zero_flag_mask: If set, read_flag_mask and write_flag_mask are used even
323 * if they are both empty.
324 * @use_relaxed_mmio: If set, MMIO R/W operations will not use memory barriers.
325 * This can avoid load on devices which don't require strict
326 * orderings, but drivers should carefully add any explicit
327 * memory barriers when they may require them.
328 * @use_single_read: If set, converts the bulk read operation into a series of
329 * single read operations. This is useful for a device that
330 * does not support bulk read.
331 * @use_single_write: If set, converts the bulk write operation into a series of
332 * single write operations. This is useful for a device that
333 * does not support bulk write.
334 * @can_multi_write: If set, the device supports the multi write mode of bulk
335 * write operations, if clear multi write requests will be
336 * split into individual write operations
338 * @cache_type: The actual cache type.
339 * @reg_defaults_raw: Power on reset values for registers (for use with
340 * register cache support).
341 * @num_reg_defaults_raw: Number of elements in reg_defaults_raw.
342 * @reg_format_endian: Endianness for formatted register addresses. If this is
343 * DEFAULT, the @reg_format_endian_default value from the
344 * regmap bus is used.
345 * @val_format_endian: Endianness for formatted register values. If this is
346 * DEFAULT, the @reg_format_endian_default value from the
347 * regmap bus is used.
349 * @ranges: Array of configuration entries for virtual address ranges.
350 * @num_ranges: Number of range configuration entries.
351 * @use_hwlock: Indicate if a hardware spinlock should be used.
352 * @use_raw_spinlock: Indicate if a raw spinlock should be used.
353 * @hwlock_id: Specify the hardware spinlock id.
354 * @hwlock_mode: The hardware spinlock mode, should be HWLOCK_IRQSTATE,
356 * @can_sleep: Optional, specifies whether regmap operations can sleep.
358 struct regmap_config {
366 bool (*writeable_reg)(struct device *dev, unsigned int reg);
367 bool (*readable_reg)(struct device *dev, unsigned int reg);
368 bool (*volatile_reg)(struct device *dev, unsigned int reg);
369 bool (*precious_reg)(struct device *dev, unsigned int reg);
370 bool (*writeable_noinc_reg)(struct device *dev, unsigned int reg);
371 bool (*readable_noinc_reg)(struct device *dev, unsigned int reg);
373 bool disable_locking;
375 regmap_unlock unlock;
378 int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
379 int (*reg_write)(void *context, unsigned int reg, unsigned int val);
380 int (*reg_update_bits)(void *context, unsigned int reg,
381 unsigned int mask, unsigned int val);
385 unsigned int max_register;
386 const struct regmap_access_table *wr_table;
387 const struct regmap_access_table *rd_table;
388 const struct regmap_access_table *volatile_table;
389 const struct regmap_access_table *precious_table;
390 const struct regmap_access_table *wr_noinc_table;
391 const struct regmap_access_table *rd_noinc_table;
392 const struct reg_default *reg_defaults;
393 unsigned int num_reg_defaults;
394 enum regcache_type cache_type;
395 const void *reg_defaults_raw;
396 unsigned int num_reg_defaults_raw;
398 unsigned long read_flag_mask;
399 unsigned long write_flag_mask;
402 bool use_single_read;
403 bool use_single_write;
404 bool use_relaxed_mmio;
405 bool can_multi_write;
407 enum regmap_endian reg_format_endian;
408 enum regmap_endian val_format_endian;
410 const struct regmap_range_cfg *ranges;
411 unsigned int num_ranges;
414 bool use_raw_spinlock;
415 unsigned int hwlock_id;
416 unsigned int hwlock_mode;
422 * struct regmap_range_cfg - Configuration for indirectly accessed or paged
425 * @name: Descriptive name for diagnostics
427 * @range_min: Address of the lowest register address in virtual range.
428 * @range_max: Address of the highest register in virtual range.
430 * @selector_reg: Register with selector field.
431 * @selector_mask: Bit mask for selector value.
432 * @selector_shift: Bit shift for selector value.
434 * @window_start: Address of first (lowest) register in data window.
435 * @window_len: Number of registers in data window.
437 * Registers, mapped to this virtual range, are accessed in two steps:
438 * 1. page selector register update;
439 * 2. access through data window registers.
441 struct regmap_range_cfg {
444 /* Registers of virtual address range */
445 unsigned int range_min;
446 unsigned int range_max;
448 /* Page selector for indirect addressing */
449 unsigned int selector_reg;
450 unsigned int selector_mask;
453 /* Data window (per each page) */
454 unsigned int window_start;
455 unsigned int window_len;
460 typedef int (*regmap_hw_write)(void *context, const void *data,
462 typedef int (*regmap_hw_gather_write)(void *context,
463 const void *reg, size_t reg_len,
464 const void *val, size_t val_len);
465 typedef int (*regmap_hw_async_write)(void *context,
466 const void *reg, size_t reg_len,
467 const void *val, size_t val_len,
468 struct regmap_async *async);
469 typedef int (*regmap_hw_read)(void *context,
470 const void *reg_buf, size_t reg_size,
471 void *val_buf, size_t val_size);
472 typedef int (*regmap_hw_reg_read)(void *context, unsigned int reg,
474 typedef int (*regmap_hw_reg_write)(void *context, unsigned int reg,
476 typedef int (*regmap_hw_reg_update_bits)(void *context, unsigned int reg,
477 unsigned int mask, unsigned int val);
478 typedef struct regmap_async *(*regmap_hw_async_alloc)(void);
479 typedef void (*regmap_hw_free_context)(void *context);
482 * struct regmap_bus - Description of a hardware bus for the register map
485 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
486 * to perform locking. This field is ignored if custom lock/unlock
487 * functions are used (see fields lock/unlock of
488 * struct regmap_config).
489 * @write: Write operation.
490 * @gather_write: Write operation with split register/value, return -ENOTSUPP
491 * if not implemented on a given device.
492 * @async_write: Write operation which completes asynchronously, optional and
493 * must serialise with respect to non-async I/O.
494 * @reg_write: Write a single register value to the given register address. This
495 * write operation has to complete when returning from the function.
496 * @reg_update_bits: Update bits operation to be used against volatile
497 * registers, intended for devices supporting some mechanism
498 * for setting clearing bits without having to
500 * @read: Read operation. Data is returned in the buffer used to transmit
502 * @reg_read: Read a single register value from a given register address.
503 * @free_context: Free context.
504 * @async_alloc: Allocate a regmap_async() structure.
505 * @read_flag_mask: Mask to be set in the top byte of the register when doing
507 * @reg_format_endian_default: Default endianness for formatted register
508 * addresses. Used when the regmap_config specifies DEFAULT. If this is
509 * DEFAULT, BIG is assumed.
510 * @val_format_endian_default: Default endianness for formatted register
511 * values. Used when the regmap_config specifies DEFAULT. If this is
512 * DEFAULT, BIG is assumed.
513 * @max_raw_read: Max raw read size that can be used on the bus.
514 * @max_raw_write: Max raw write size that can be used on the bus.
515 * @free_on_exit: kfree this on exit of regmap
519 regmap_hw_write write;
520 regmap_hw_gather_write gather_write;
521 regmap_hw_async_write async_write;
522 regmap_hw_reg_write reg_write;
523 regmap_hw_reg_update_bits reg_update_bits;
525 regmap_hw_reg_read reg_read;
526 regmap_hw_free_context free_context;
527 regmap_hw_async_alloc async_alloc;
529 enum regmap_endian reg_format_endian_default;
530 enum regmap_endian val_format_endian_default;
532 size_t max_raw_write;
537 * __regmap_init functions.
539 * These functions take a lock key and name parameter, and should not be called
540 * directly. Instead, use the regmap_init macros that generate a key and name
543 struct regmap *__regmap_init(struct device *dev,
544 const struct regmap_bus *bus,
546 const struct regmap_config *config,
547 struct lock_class_key *lock_key,
548 const char *lock_name);
549 struct regmap *__regmap_init_i2c(struct i2c_client *i2c,
550 const struct regmap_config *config,
551 struct lock_class_key *lock_key,
552 const char *lock_name);
553 struct regmap *__regmap_init_mdio(struct mdio_device *mdio_dev,
554 const struct regmap_config *config,
555 struct lock_class_key *lock_key,
556 const char *lock_name);
557 struct regmap *__regmap_init_sccb(struct i2c_client *i2c,
558 const struct regmap_config *config,
559 struct lock_class_key *lock_key,
560 const char *lock_name);
561 struct regmap *__regmap_init_slimbus(struct slim_device *slimbus,
562 const struct regmap_config *config,
563 struct lock_class_key *lock_key,
564 const char *lock_name);
565 struct regmap *__regmap_init_spi(struct spi_device *dev,
566 const struct regmap_config *config,
567 struct lock_class_key *lock_key,
568 const char *lock_name);
569 struct regmap *__regmap_init_spmi_base(struct spmi_device *dev,
570 const struct regmap_config *config,
571 struct lock_class_key *lock_key,
572 const char *lock_name);
573 struct regmap *__regmap_init_spmi_ext(struct spmi_device *dev,
574 const struct regmap_config *config,
575 struct lock_class_key *lock_key,
576 const char *lock_name);
577 struct regmap *__regmap_init_w1(struct device *w1_dev,
578 const struct regmap_config *config,
579 struct lock_class_key *lock_key,
580 const char *lock_name);
581 struct regmap *__regmap_init_mmio_clk(struct device *dev, const char *clk_id,
583 const struct regmap_config *config,
584 struct lock_class_key *lock_key,
585 const char *lock_name);
586 struct regmap *__regmap_init_ac97(struct snd_ac97 *ac97,
587 const struct regmap_config *config,
588 struct lock_class_key *lock_key,
589 const char *lock_name);
590 struct regmap *__regmap_init_sdw(struct sdw_slave *sdw,
591 const struct regmap_config *config,
592 struct lock_class_key *lock_key,
593 const char *lock_name);
594 struct regmap *__regmap_init_sdw_mbq(struct sdw_slave *sdw,
595 const struct regmap_config *config,
596 struct lock_class_key *lock_key,
597 const char *lock_name);
598 struct regmap *__regmap_init_spi_avmm(struct spi_device *spi,
599 const struct regmap_config *config,
600 struct lock_class_key *lock_key,
601 const char *lock_name);
603 struct regmap *__devm_regmap_init(struct device *dev,
604 const struct regmap_bus *bus,
606 const struct regmap_config *config,
607 struct lock_class_key *lock_key,
608 const char *lock_name);
609 struct regmap *__devm_regmap_init_i2c(struct i2c_client *i2c,
610 const struct regmap_config *config,
611 struct lock_class_key *lock_key,
612 const char *lock_name);
613 struct regmap *__devm_regmap_init_mdio(struct mdio_device *mdio_dev,
614 const struct regmap_config *config,
615 struct lock_class_key *lock_key,
616 const char *lock_name);
617 struct regmap *__devm_regmap_init_sccb(struct i2c_client *i2c,
618 const struct regmap_config *config,
619 struct lock_class_key *lock_key,
620 const char *lock_name);
621 struct regmap *__devm_regmap_init_spi(struct spi_device *dev,
622 const struct regmap_config *config,
623 struct lock_class_key *lock_key,
624 const char *lock_name);
625 struct regmap *__devm_regmap_init_spmi_base(struct spmi_device *dev,
626 const struct regmap_config *config,
627 struct lock_class_key *lock_key,
628 const char *lock_name);
629 struct regmap *__devm_regmap_init_spmi_ext(struct spmi_device *dev,
630 const struct regmap_config *config,
631 struct lock_class_key *lock_key,
632 const char *lock_name);
633 struct regmap *__devm_regmap_init_w1(struct device *w1_dev,
634 const struct regmap_config *config,
635 struct lock_class_key *lock_key,
636 const char *lock_name);
637 struct regmap *__devm_regmap_init_mmio_clk(struct device *dev,
640 const struct regmap_config *config,
641 struct lock_class_key *lock_key,
642 const char *lock_name);
643 struct regmap *__devm_regmap_init_ac97(struct snd_ac97 *ac97,
644 const struct regmap_config *config,
645 struct lock_class_key *lock_key,
646 const char *lock_name);
647 struct regmap *__devm_regmap_init_sdw(struct sdw_slave *sdw,
648 const struct regmap_config *config,
649 struct lock_class_key *lock_key,
650 const char *lock_name);
651 struct regmap *__devm_regmap_init_sdw_mbq(struct sdw_slave *sdw,
652 const struct regmap_config *config,
653 struct lock_class_key *lock_key,
654 const char *lock_name);
655 struct regmap *__devm_regmap_init_slimbus(struct slim_device *slimbus,
656 const struct regmap_config *config,
657 struct lock_class_key *lock_key,
658 const char *lock_name);
659 struct regmap *__devm_regmap_init_i3c(struct i3c_device *i3c,
660 const struct regmap_config *config,
661 struct lock_class_key *lock_key,
662 const char *lock_name);
663 struct regmap *__devm_regmap_init_spi_avmm(struct spi_device *spi,
664 const struct regmap_config *config,
665 struct lock_class_key *lock_key,
666 const char *lock_name);
668 * Wrapper for regmap_init macros to include a unique lockdep key and name
669 * for each call. No-op if CONFIG_LOCKDEP is not set.
671 * @fn: Real function to call (in the form __[*_]regmap_init[_*])
672 * @name: Config variable name (#config in the calling macro)
674 #ifdef CONFIG_LOCKDEP
675 #define __regmap_lockdep_wrapper(fn, name, ...) \
678 static struct lock_class_key _key; \
679 fn(__VA_ARGS__, &_key, \
680 KBUILD_BASENAME ":" \
681 __stringify(__LINE__) ":" \
682 "(" name ")->lock"); \
686 #define __regmap_lockdep_wrapper(fn, name, ...) fn(__VA_ARGS__, NULL, NULL)
690 * regmap_init() - Initialise register map
692 * @dev: Device that will be interacted with
693 * @bus: Bus-specific callbacks to use with device
694 * @bus_context: Data passed to bus-specific callbacks
695 * @config: Configuration for register map
697 * The return value will be an ERR_PTR() on error or a valid pointer to
698 * a struct regmap. This function should generally not be called
699 * directly, it should be called by bus-specific init functions.
701 #define regmap_init(dev, bus, bus_context, config) \
702 __regmap_lockdep_wrapper(__regmap_init, #config, \
703 dev, bus, bus_context, config)
704 int regmap_attach_dev(struct device *dev, struct regmap *map,
705 const struct regmap_config *config);
708 * regmap_init_i2c() - Initialise register map
710 * @i2c: Device that will be interacted with
711 * @config: Configuration for register map
713 * The return value will be an ERR_PTR() on error or a valid pointer to
716 #define regmap_init_i2c(i2c, config) \
717 __regmap_lockdep_wrapper(__regmap_init_i2c, #config, \
721 * regmap_init_mdio() - Initialise register map
723 * @mdio_dev: Device that will be interacted with
724 * @config: Configuration for register map
726 * The return value will be an ERR_PTR() on error or a valid pointer to
729 #define regmap_init_mdio(mdio_dev, config) \
730 __regmap_lockdep_wrapper(__regmap_init_mdio, #config, \
734 * regmap_init_sccb() - Initialise register map
736 * @i2c: Device that will be interacted with
737 * @config: Configuration for register map
739 * The return value will be an ERR_PTR() on error or a valid pointer to
742 #define regmap_init_sccb(i2c, config) \
743 __regmap_lockdep_wrapper(__regmap_init_sccb, #config, \
747 * regmap_init_slimbus() - Initialise register map
749 * @slimbus: Device that will be interacted with
750 * @config: Configuration for register map
752 * The return value will be an ERR_PTR() on error or a valid pointer to
755 #define regmap_init_slimbus(slimbus, config) \
756 __regmap_lockdep_wrapper(__regmap_init_slimbus, #config, \
760 * regmap_init_spi() - Initialise register map
762 * @dev: Device that will be interacted with
763 * @config: Configuration for register map
765 * The return value will be an ERR_PTR() on error or a valid pointer to
768 #define regmap_init_spi(dev, config) \
769 __regmap_lockdep_wrapper(__regmap_init_spi, #config, \
773 * regmap_init_spmi_base() - Create regmap for the Base register space
775 * @dev: SPMI device that will be interacted with
776 * @config: Configuration for register map
778 * The return value will be an ERR_PTR() on error or a valid pointer to
781 #define regmap_init_spmi_base(dev, config) \
782 __regmap_lockdep_wrapper(__regmap_init_spmi_base, #config, \
786 * regmap_init_spmi_ext() - Create regmap for Ext register space
788 * @dev: Device that will be interacted with
789 * @config: Configuration for register map
791 * The return value will be an ERR_PTR() on error or a valid pointer to
794 #define regmap_init_spmi_ext(dev, config) \
795 __regmap_lockdep_wrapper(__regmap_init_spmi_ext, #config, \
799 * regmap_init_w1() - Initialise register map
801 * @w1_dev: Device that will be interacted with
802 * @config: Configuration for register map
804 * The return value will be an ERR_PTR() on error or a valid pointer to
807 #define regmap_init_w1(w1_dev, config) \
808 __regmap_lockdep_wrapper(__regmap_init_w1, #config, \
812 * regmap_init_mmio_clk() - Initialise register map with register clock
814 * @dev: Device that will be interacted with
815 * @clk_id: register clock consumer ID
816 * @regs: Pointer to memory-mapped IO region
817 * @config: Configuration for register map
819 * The return value will be an ERR_PTR() on error or a valid pointer to
822 #define regmap_init_mmio_clk(dev, clk_id, regs, config) \
823 __regmap_lockdep_wrapper(__regmap_init_mmio_clk, #config, \
824 dev, clk_id, regs, config)
827 * regmap_init_mmio() - Initialise register map
829 * @dev: Device that will be interacted with
830 * @regs: Pointer to memory-mapped IO region
831 * @config: Configuration for register map
833 * The return value will be an ERR_PTR() on error or a valid pointer to
836 #define regmap_init_mmio(dev, regs, config) \
837 regmap_init_mmio_clk(dev, NULL, regs, config)
840 * regmap_init_ac97() - Initialise AC'97 register map
842 * @ac97: Device that will be interacted with
843 * @config: Configuration for register map
845 * The return value will be an ERR_PTR() on error or a valid pointer to
848 #define regmap_init_ac97(ac97, config) \
849 __regmap_lockdep_wrapper(__regmap_init_ac97, #config, \
851 bool regmap_ac97_default_volatile(struct device *dev, unsigned int reg);
854 * regmap_init_sdw() - Initialise register map
856 * @sdw: Device that will be interacted with
857 * @config: Configuration for register map
859 * The return value will be an ERR_PTR() on error or a valid pointer to
862 #define regmap_init_sdw(sdw, config) \
863 __regmap_lockdep_wrapper(__regmap_init_sdw, #config, \
867 * regmap_init_sdw_mbq() - Initialise register map
869 * @sdw: Device that will be interacted with
870 * @config: Configuration for register map
872 * The return value will be an ERR_PTR() on error or a valid pointer to
875 #define regmap_init_sdw_mbq(sdw, config) \
876 __regmap_lockdep_wrapper(__regmap_init_sdw_mbq, #config, \
880 * regmap_init_spi_avmm() - Initialize register map for Intel SPI Slave
883 * @spi: Device that will be interacted with
884 * @config: Configuration for register map
886 * The return value will be an ERR_PTR() on error or a valid pointer
887 * to a struct regmap.
889 #define regmap_init_spi_avmm(spi, config) \
890 __regmap_lockdep_wrapper(__regmap_init_spi_avmm, #config, \
894 * devm_regmap_init() - Initialise managed register map
896 * @dev: Device that will be interacted with
897 * @bus: Bus-specific callbacks to use with device
898 * @bus_context: Data passed to bus-specific callbacks
899 * @config: Configuration for register map
901 * The return value will be an ERR_PTR() on error or a valid pointer
902 * to a struct regmap. This function should generally not be called
903 * directly, it should be called by bus-specific init functions. The
904 * map will be automatically freed by the device management code.
906 #define devm_regmap_init(dev, bus, bus_context, config) \
907 __regmap_lockdep_wrapper(__devm_regmap_init, #config, \
908 dev, bus, bus_context, config)
911 * devm_regmap_init_i2c() - Initialise managed register map
913 * @i2c: Device that will be interacted with
914 * @config: Configuration for register map
916 * The return value will be an ERR_PTR() on error or a valid pointer
917 * to a struct regmap. The regmap will be automatically freed by the
918 * device management code.
920 #define devm_regmap_init_i2c(i2c, config) \
921 __regmap_lockdep_wrapper(__devm_regmap_init_i2c, #config, \
925 * devm_regmap_init_mdio() - Initialise managed register map
927 * @mdio_dev: Device that will be interacted with
928 * @config: Configuration for register map
930 * The return value will be an ERR_PTR() on error or a valid pointer
931 * to a struct regmap. The regmap will be automatically freed by the
932 * device management code.
934 #define devm_regmap_init_mdio(mdio_dev, config) \
935 __regmap_lockdep_wrapper(__devm_regmap_init_mdio, #config, \
939 * devm_regmap_init_sccb() - Initialise managed register map
941 * @i2c: Device that will be interacted with
942 * @config: Configuration for register map
944 * The return value will be an ERR_PTR() on error or a valid pointer
945 * to a struct regmap. The regmap will be automatically freed by the
946 * device management code.
948 #define devm_regmap_init_sccb(i2c, config) \
949 __regmap_lockdep_wrapper(__devm_regmap_init_sccb, #config, \
953 * devm_regmap_init_spi() - Initialise register map
955 * @dev: Device that will be interacted with
956 * @config: Configuration for register map
958 * The return value will be an ERR_PTR() on error or a valid pointer
959 * to a struct regmap. The map will be automatically freed by the
960 * device management code.
962 #define devm_regmap_init_spi(dev, config) \
963 __regmap_lockdep_wrapper(__devm_regmap_init_spi, #config, \
967 * devm_regmap_init_spmi_base() - Create managed regmap for Base register space
969 * @dev: SPMI device that will be interacted with
970 * @config: Configuration for register map
972 * The return value will be an ERR_PTR() on error or a valid pointer
973 * to a struct regmap. The regmap will be automatically freed by the
974 * device management code.
976 #define devm_regmap_init_spmi_base(dev, config) \
977 __regmap_lockdep_wrapper(__devm_regmap_init_spmi_base, #config, \
981 * devm_regmap_init_spmi_ext() - Create managed regmap for Ext register space
983 * @dev: SPMI device that will be interacted with
984 * @config: Configuration for register map
986 * The return value will be an ERR_PTR() on error or a valid pointer
987 * to a struct regmap. The regmap will be automatically freed by the
988 * device management code.
990 #define devm_regmap_init_spmi_ext(dev, config) \
991 __regmap_lockdep_wrapper(__devm_regmap_init_spmi_ext, #config, \
995 * devm_regmap_init_w1() - Initialise managed register map
997 * @w1_dev: Device that will be interacted with
998 * @config: Configuration for register map
1000 * The return value will be an ERR_PTR() on error or a valid pointer
1001 * to a struct regmap. The regmap will be automatically freed by the
1002 * device management code.
1004 #define devm_regmap_init_w1(w1_dev, config) \
1005 __regmap_lockdep_wrapper(__devm_regmap_init_w1, #config, \
1008 * devm_regmap_init_mmio_clk() - Initialise managed register map with clock
1010 * @dev: Device that will be interacted with
1011 * @clk_id: register clock consumer ID
1012 * @regs: Pointer to memory-mapped IO region
1013 * @config: Configuration for register map
1015 * The return value will be an ERR_PTR() on error or a valid pointer
1016 * to a struct regmap. The regmap will be automatically freed by the
1017 * device management code.
1019 #define devm_regmap_init_mmio_clk(dev, clk_id, regs, config) \
1020 __regmap_lockdep_wrapper(__devm_regmap_init_mmio_clk, #config, \
1021 dev, clk_id, regs, config)
1024 * devm_regmap_init_mmio() - Initialise managed register map
1026 * @dev: Device that will be interacted with
1027 * @regs: Pointer to memory-mapped IO region
1028 * @config: Configuration for register map
1030 * The return value will be an ERR_PTR() on error or a valid pointer
1031 * to a struct regmap. The regmap will be automatically freed by the
1032 * device management code.
1034 #define devm_regmap_init_mmio(dev, regs, config) \
1035 devm_regmap_init_mmio_clk(dev, NULL, regs, config)
1038 * devm_regmap_init_ac97() - Initialise AC'97 register map
1040 * @ac97: Device that will be interacted with
1041 * @config: Configuration for register map
1043 * The return value will be an ERR_PTR() on error or a valid pointer
1044 * to a struct regmap. The regmap will be automatically freed by the
1045 * device management code.
1047 #define devm_regmap_init_ac97(ac97, config) \
1048 __regmap_lockdep_wrapper(__devm_regmap_init_ac97, #config, \
1052 * devm_regmap_init_sdw() - Initialise managed register map
1054 * @sdw: Device that will be interacted with
1055 * @config: Configuration for register map
1057 * The return value will be an ERR_PTR() on error or a valid pointer
1058 * to a struct regmap. The regmap will be automatically freed by the
1059 * device management code.
1061 #define devm_regmap_init_sdw(sdw, config) \
1062 __regmap_lockdep_wrapper(__devm_regmap_init_sdw, #config, \
1066 * devm_regmap_init_sdw_mbq() - Initialise managed register map
1068 * @sdw: Device that will be interacted with
1069 * @config: Configuration for register map
1071 * The return value will be an ERR_PTR() on error or a valid pointer
1072 * to a struct regmap. The regmap will be automatically freed by the
1073 * device management code.
1075 #define devm_regmap_init_sdw_mbq(sdw, config) \
1076 __regmap_lockdep_wrapper(__devm_regmap_init_sdw_mbq, #config, \
1080 * devm_regmap_init_slimbus() - Initialise managed register map
1082 * @slimbus: Device that will be interacted with
1083 * @config: Configuration for register map
1085 * The return value will be an ERR_PTR() on error or a valid pointer
1086 * to a struct regmap. The regmap will be automatically freed by the
1087 * device management code.
1089 #define devm_regmap_init_slimbus(slimbus, config) \
1090 __regmap_lockdep_wrapper(__devm_regmap_init_slimbus, #config, \
1094 * devm_regmap_init_i3c() - Initialise managed register map
1096 * @i3c: Device that will be interacted with
1097 * @config: Configuration for register map
1099 * The return value will be an ERR_PTR() on error or a valid pointer
1100 * to a struct regmap. The regmap will be automatically freed by the
1101 * device management code.
1103 #define devm_regmap_init_i3c(i3c, config) \
1104 __regmap_lockdep_wrapper(__devm_regmap_init_i3c, #config, \
1108 * devm_regmap_init_spi_avmm() - Initialize register map for Intel SPI Slave
1109 * to AVMM Bus Bridge
1111 * @spi: Device that will be interacted with
1112 * @config: Configuration for register map
1114 * The return value will be an ERR_PTR() on error or a valid pointer
1115 * to a struct regmap. The map will be automatically freed by the
1116 * device management code.
1118 #define devm_regmap_init_spi_avmm(spi, config) \
1119 __regmap_lockdep_wrapper(__devm_regmap_init_spi_avmm, #config, \
1122 int regmap_mmio_attach_clk(struct regmap *map, struct clk *clk);
1123 void regmap_mmio_detach_clk(struct regmap *map);
1124 void regmap_exit(struct regmap *map);
1125 int regmap_reinit_cache(struct regmap *map,
1126 const struct regmap_config *config);
1127 struct regmap *dev_get_regmap(struct device *dev, const char *name);
1128 struct device *regmap_get_device(struct regmap *map);
1129 int regmap_write(struct regmap *map, unsigned int reg, unsigned int val);
1130 int regmap_write_async(struct regmap *map, unsigned int reg, unsigned int val);
1131 int regmap_raw_write(struct regmap *map, unsigned int reg,
1132 const void *val, size_t val_len);
1133 int regmap_noinc_write(struct regmap *map, unsigned int reg,
1134 const void *val, size_t val_len);
1135 int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
1137 int regmap_multi_reg_write(struct regmap *map, const struct reg_sequence *regs,
1139 int regmap_multi_reg_write_bypassed(struct regmap *map,
1140 const struct reg_sequence *regs,
1142 int regmap_raw_write_async(struct regmap *map, unsigned int reg,
1143 const void *val, size_t val_len);
1144 int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val);
1145 int regmap_raw_read(struct regmap *map, unsigned int reg,
1146 void *val, size_t val_len);
1147 int regmap_noinc_read(struct regmap *map, unsigned int reg,
1148 void *val, size_t val_len);
1149 int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
1151 int regmap_update_bits_base(struct regmap *map, unsigned int reg,
1152 unsigned int mask, unsigned int val,
1153 bool *change, bool async, bool force);
1155 static inline int regmap_update_bits(struct regmap *map, unsigned int reg,
1156 unsigned int mask, unsigned int val)
1158 return regmap_update_bits_base(map, reg, mask, val, NULL, false, false);
1161 static inline int regmap_update_bits_async(struct regmap *map, unsigned int reg,
1162 unsigned int mask, unsigned int val)
1164 return regmap_update_bits_base(map, reg, mask, val, NULL, true, false);
1167 static inline int regmap_update_bits_check(struct regmap *map, unsigned int reg,
1168 unsigned int mask, unsigned int val,
1171 return regmap_update_bits_base(map, reg, mask, val,
1172 change, false, false);
1176 regmap_update_bits_check_async(struct regmap *map, unsigned int reg,
1177 unsigned int mask, unsigned int val,
1180 return regmap_update_bits_base(map, reg, mask, val,
1181 change, true, false);
1184 static inline int regmap_write_bits(struct regmap *map, unsigned int reg,
1185 unsigned int mask, unsigned int val)
1187 return regmap_update_bits_base(map, reg, mask, val, NULL, false, true);
1190 int regmap_get_val_bytes(struct regmap *map);
1191 int regmap_get_max_register(struct regmap *map);
1192 int regmap_get_reg_stride(struct regmap *map);
1193 int regmap_async_complete(struct regmap *map);
1194 bool regmap_can_raw_write(struct regmap *map);
1195 size_t regmap_get_raw_read_max(struct regmap *map);
1196 size_t regmap_get_raw_write_max(struct regmap *map);
1198 int regcache_sync(struct regmap *map);
1199 int regcache_sync_region(struct regmap *map, unsigned int min,
1201 int regcache_drop_region(struct regmap *map, unsigned int min,
1203 void regcache_cache_only(struct regmap *map, bool enable);
1204 void regcache_cache_bypass(struct regmap *map, bool enable);
1205 void regcache_mark_dirty(struct regmap *map);
1207 bool regmap_check_range_table(struct regmap *map, unsigned int reg,
1208 const struct regmap_access_table *table);
1210 int regmap_register_patch(struct regmap *map, const struct reg_sequence *regs,
1212 int regmap_parse_val(struct regmap *map, const void *buf,
1215 static inline bool regmap_reg_in_range(unsigned int reg,
1216 const struct regmap_range *range)
1218 return reg >= range->range_min && reg <= range->range_max;
1221 bool regmap_reg_in_ranges(unsigned int reg,
1222 const struct regmap_range *ranges,
1223 unsigned int nranges);
1225 static inline int regmap_set_bits(struct regmap *map,
1226 unsigned int reg, unsigned int bits)
1228 return regmap_update_bits_base(map, reg, bits, bits,
1229 NULL, false, false);
1232 static inline int regmap_clear_bits(struct regmap *map,
1233 unsigned int reg, unsigned int bits)
1235 return regmap_update_bits_base(map, reg, bits, 0, NULL, false, false);
1238 int regmap_test_bits(struct regmap *map, unsigned int reg, unsigned int bits);
1241 * struct reg_field - Description of an register field
1243 * @reg: Offset of the register within the regmap bank
1244 * @lsb: lsb of the register field.
1245 * @msb: msb of the register field.
1246 * @id_size: port size if it has some ports
1247 * @id_offset: address offset for each ports
1253 unsigned int id_size;
1254 unsigned int id_offset;
1257 #define REG_FIELD(_reg, _lsb, _msb) { \
1263 #define REG_FIELD_ID(_reg, _lsb, _msb, _size, _offset) { \
1268 .id_offset = _offset, \
1271 struct regmap_field *regmap_field_alloc(struct regmap *regmap,
1272 struct reg_field reg_field);
1273 void regmap_field_free(struct regmap_field *field);
1275 struct regmap_field *devm_regmap_field_alloc(struct device *dev,
1276 struct regmap *regmap, struct reg_field reg_field);
1277 void devm_regmap_field_free(struct device *dev, struct regmap_field *field);
1279 int regmap_field_bulk_alloc(struct regmap *regmap,
1280 struct regmap_field **rm_field,
1281 const struct reg_field *reg_field,
1283 void regmap_field_bulk_free(struct regmap_field *field);
1284 int devm_regmap_field_bulk_alloc(struct device *dev, struct regmap *regmap,
1285 struct regmap_field **field,
1286 const struct reg_field *reg_field,
1288 void devm_regmap_field_bulk_free(struct device *dev,
1289 struct regmap_field *field);
1291 int regmap_field_read(struct regmap_field *field, unsigned int *val);
1292 int regmap_field_update_bits_base(struct regmap_field *field,
1293 unsigned int mask, unsigned int val,
1294 bool *change, bool async, bool force);
1295 int regmap_fields_read(struct regmap_field *field, unsigned int id,
1297 int regmap_fields_update_bits_base(struct regmap_field *field, unsigned int id,
1298 unsigned int mask, unsigned int val,
1299 bool *change, bool async, bool force);
1301 static inline int regmap_field_write(struct regmap_field *field,
1304 return regmap_field_update_bits_base(field, ~0, val,
1305 NULL, false, false);
1308 static inline int regmap_field_force_write(struct regmap_field *field,
1311 return regmap_field_update_bits_base(field, ~0, val, NULL, false, true);
1314 static inline int regmap_field_update_bits(struct regmap_field *field,
1315 unsigned int mask, unsigned int val)
1317 return regmap_field_update_bits_base(field, mask, val,
1318 NULL, false, false);
1322 regmap_field_force_update_bits(struct regmap_field *field,
1323 unsigned int mask, unsigned int val)
1325 return regmap_field_update_bits_base(field, mask, val,
1329 static inline int regmap_fields_write(struct regmap_field *field,
1330 unsigned int id, unsigned int val)
1332 return regmap_fields_update_bits_base(field, id, ~0, val,
1333 NULL, false, false);
1336 static inline int regmap_fields_force_write(struct regmap_field *field,
1337 unsigned int id, unsigned int val)
1339 return regmap_fields_update_bits_base(field, id, ~0, val,
1344 regmap_fields_update_bits(struct regmap_field *field, unsigned int id,
1345 unsigned int mask, unsigned int val)
1347 return regmap_fields_update_bits_base(field, id, mask, val,
1348 NULL, false, false);
1352 regmap_fields_force_update_bits(struct regmap_field *field, unsigned int id,
1353 unsigned int mask, unsigned int val)
1355 return regmap_fields_update_bits_base(field, id, mask, val,
1360 * struct regmap_irq_type - IRQ type definitions.
1362 * @type_reg_offset: Offset register for the irq type setting.
1363 * @type_rising_val: Register value to configure RISING type irq.
1364 * @type_falling_val: Register value to configure FALLING type irq.
1365 * @type_level_low_val: Register value to configure LEVEL_LOW type irq.
1366 * @type_level_high_val: Register value to configure LEVEL_HIGH type irq.
1367 * @types_supported: logical OR of IRQ_TYPE_* flags indicating supported types.
1369 struct regmap_irq_type {
1370 unsigned int type_reg_offset;
1371 unsigned int type_reg_mask;
1372 unsigned int type_rising_val;
1373 unsigned int type_falling_val;
1374 unsigned int type_level_low_val;
1375 unsigned int type_level_high_val;
1376 unsigned int types_supported;
1380 * struct regmap_irq - Description of an IRQ for the generic regmap irq_chip.
1382 * @reg_offset: Offset of the status/mask register within the bank
1383 * @mask: Mask used to flag/control the register.
1384 * @type: IRQ trigger type setting details if supported.
1387 unsigned int reg_offset;
1389 struct regmap_irq_type type;
1392 #define REGMAP_IRQ_REG(_irq, _off, _mask) \
1393 [_irq] = { .reg_offset = (_off), .mask = (_mask) }
1395 #define REGMAP_IRQ_REG_LINE(_id, _reg_bits) \
1397 .mask = BIT((_id) % (_reg_bits)), \
1398 .reg_offset = (_id) / (_reg_bits), \
1401 #define REGMAP_IRQ_MAIN_REG_OFFSET(arr) \
1402 { .num_regs = ARRAY_SIZE((arr)), .offset = &(arr)[0] }
1404 struct regmap_irq_sub_irq_map {
1405 unsigned int num_regs;
1406 unsigned int *offset;
1410 * struct regmap_irq_chip - Description of a generic regmap irq_chip.
1412 * @name: Descriptive name for IRQ controller.
1414 * @main_status: Base main status register address. For chips which have
1415 * interrupts arranged in separate sub-irq blocks with own IRQ
1416 * registers and which have a main IRQ registers indicating
1417 * sub-irq blocks with unhandled interrupts. For such chips fill
1418 * sub-irq register information in status_base, mask_base and
1420 * @num_main_status_bits: Should be given to chips where number of meaningfull
1421 * main status bits differs from num_regs.
1422 * @sub_reg_offsets: arrays of mappings from main register bits to sub irq
1423 * registers. First item in array describes the registers
1424 * for first main status bit. Second array for second bit etc.
1425 * Offset is given as sub register status offset to
1426 * status_base. Should contain num_regs arrays.
1427 * Can be provided for chips with more complex mapping than
1428 * 1.st bit to 1.st sub-reg, 2.nd bit to 2.nd sub-reg, ...
1429 * When used with not_fixed_stride, each one-element array
1430 * member contains offset calculated as address from each
1431 * peripheral to first peripheral.
1432 * @num_main_regs: Number of 'main status' irq registers for chips which have
1435 * @status_base: Base status register address.
1436 * @mask_base: Base mask register address.
1437 * @mask_writeonly: Base mask register is write only.
1438 * @unmask_base: Base unmask register address. for chips who have
1439 * separate mask and unmask registers
1440 * @ack_base: Base ack address. If zero then the chip is clear on read.
1441 * Using zero value is possible with @use_ack bit.
1442 * @wake_base: Base address for wake enables. If zero unsupported.
1443 * @type_base: Base address for irq type. If zero unsupported.
1444 * @virt_reg_base: Base addresses for extra config regs.
1445 * @irq_reg_stride: Stride to use for chips where registers are not contiguous.
1446 * @init_ack_masked: Ack all masked interrupts once during initalization.
1447 * @mask_invert: Inverted mask register: cleared bits are masked out.
1448 * @use_ack: Use @ack register even if it is zero.
1449 * @ack_invert: Inverted ack register: cleared bits for ack.
1450 * @clear_ack: Use this to set 1 and 0 or vice-versa to clear interrupts.
1451 * @wake_invert: Inverted wake register: cleared bits are wake enabled.
1452 * @type_invert: Invert the type flags.
1453 * @type_in_mask: Use the mask registers for controlling irq type. For
1454 * interrupts defining type_rising/falling_mask use mask_base
1455 * for edge configuration and never update bits in type_base.
1456 * @clear_on_unmask: For chips with interrupts cleared on read: read the status
1457 * registers before unmasking interrupts to clear any bits
1458 * set when they were masked.
1459 * @not_fixed_stride: Used when chip peripherals are not laid out with fixed
1460 * stride. Must be used with sub_reg_offsets containing the
1461 * offsets to each peripheral.
1462 * @status_invert: Inverted status register: cleared bits are active interrupts.
1463 * @runtime_pm: Hold a runtime PM lock on the device when accessing it.
1465 * @num_regs: Number of registers in each control bank.
1466 * @irqs: Descriptors for individual IRQs. Interrupt numbers are
1467 * assigned based on the index in the array of the interrupt.
1468 * @num_irqs: Number of descriptors.
1469 * @num_type_reg: Number of type registers.
1470 * @num_virt_regs: Number of non-standard irq configuration registers.
1471 * If zero unsupported.
1472 * @type_reg_stride: Stride to use for chips where type registers are not
1474 * @handle_pre_irq: Driver specific callback to handle interrupt from device
1475 * before regmap_irq_handler process the interrupts.
1476 * @handle_post_irq: Driver specific callback to handle interrupt from device
1477 * after handling the interrupts in regmap_irq_handler().
1478 * @set_type_virt: Driver specific callback to extend regmap_irq_set_type()
1479 * and configure virt regs.
1480 * @irq_drv_data: Driver specific IRQ data which is passed as parameter when
1481 * driver specific pre/post interrupt handler is called.
1483 * This is not intended to handle every possible interrupt controller, but
1484 * it should handle a substantial proportion of those that are found in the
1487 struct regmap_irq_chip {
1490 unsigned int main_status;
1491 unsigned int num_main_status_bits;
1492 struct regmap_irq_sub_irq_map *sub_reg_offsets;
1495 unsigned int status_base;
1496 unsigned int mask_base;
1497 unsigned int unmask_base;
1498 unsigned int ack_base;
1499 unsigned int wake_base;
1500 unsigned int type_base;
1501 unsigned int *virt_reg_base;
1502 unsigned int irq_reg_stride;
1503 bool mask_writeonly:1;
1504 bool init_ack_masked:1;
1512 bool type_in_mask:1;
1513 bool clear_on_unmask:1;
1514 bool not_fixed_stride:1;
1515 bool status_invert:1;
1519 const struct regmap_irq *irqs;
1524 unsigned int type_reg_stride;
1526 int (*handle_pre_irq)(void *irq_drv_data);
1527 int (*handle_post_irq)(void *irq_drv_data);
1528 int (*set_type_virt)(unsigned int **buf, unsigned int type,
1529 unsigned long hwirq, int reg);
1533 struct regmap_irq_chip_data;
1535 int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags,
1536 int irq_base, const struct regmap_irq_chip *chip,
1537 struct regmap_irq_chip_data **data);
1538 int regmap_add_irq_chip_fwnode(struct fwnode_handle *fwnode,
1539 struct regmap *map, int irq,
1540 int irq_flags, int irq_base,
1541 const struct regmap_irq_chip *chip,
1542 struct regmap_irq_chip_data **data);
1543 void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data);
1545 int devm_regmap_add_irq_chip(struct device *dev, struct regmap *map, int irq,
1546 int irq_flags, int irq_base,
1547 const struct regmap_irq_chip *chip,
1548 struct regmap_irq_chip_data **data);
1549 int devm_regmap_add_irq_chip_fwnode(struct device *dev,
1550 struct fwnode_handle *fwnode,
1551 struct regmap *map, int irq,
1552 int irq_flags, int irq_base,
1553 const struct regmap_irq_chip *chip,
1554 struct regmap_irq_chip_data **data);
1555 void devm_regmap_del_irq_chip(struct device *dev, int irq,
1556 struct regmap_irq_chip_data *data);
1558 int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data);
1559 int regmap_irq_get_virq(struct regmap_irq_chip_data *data, int irq);
1560 struct irq_domain *regmap_irq_get_domain(struct regmap_irq_chip_data *data);
1565 * These stubs should only ever be called by generic code which has
1566 * regmap based facilities, if they ever get called at runtime
1567 * something is going wrong and something probably needs to select
1571 static inline int regmap_write(struct regmap *map, unsigned int reg,
1574 WARN_ONCE(1, "regmap API is disabled");
1578 static inline int regmap_write_async(struct regmap *map, unsigned int reg,
1581 WARN_ONCE(1, "regmap API is disabled");
1585 static inline int regmap_raw_write(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_raw_write_async(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_noinc_write(struct regmap *map, unsigned int reg,
1600 const void *val, size_t val_len)
1602 WARN_ONCE(1, "regmap API is disabled");
1606 static inline int regmap_bulk_write(struct regmap *map, unsigned int reg,
1607 const void *val, size_t val_count)
1609 WARN_ONCE(1, "regmap API is disabled");
1613 static inline int regmap_read(struct regmap *map, unsigned int reg,
1616 WARN_ONCE(1, "regmap API is disabled");
1620 static inline int regmap_raw_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_noinc_read(struct regmap *map, unsigned int reg,
1628 void *val, size_t val_len)
1630 WARN_ONCE(1, "regmap API is disabled");
1634 static inline int regmap_bulk_read(struct regmap *map, unsigned int reg,
1635 void *val, size_t val_count)
1637 WARN_ONCE(1, "regmap API is disabled");
1641 static inline int regmap_update_bits_base(struct regmap *map, unsigned int reg,
1642 unsigned int mask, unsigned int val,
1643 bool *change, bool async, bool force)
1645 WARN_ONCE(1, "regmap API is disabled");
1649 static inline int regmap_set_bits(struct regmap *map,
1650 unsigned int reg, unsigned int bits)
1652 WARN_ONCE(1, "regmap API is disabled");
1656 static inline int regmap_clear_bits(struct regmap *map,
1657 unsigned int reg, unsigned int bits)
1659 WARN_ONCE(1, "regmap API is disabled");
1663 static inline int regmap_test_bits(struct regmap *map,
1664 unsigned int reg, unsigned int bits)
1666 WARN_ONCE(1, "regmap API is disabled");
1670 static inline int regmap_field_update_bits_base(struct regmap_field *field,
1671 unsigned int mask, unsigned int val,
1672 bool *change, bool async, bool force)
1674 WARN_ONCE(1, "regmap API is disabled");
1678 static inline int regmap_fields_update_bits_base(struct regmap_field *field,
1680 unsigned int mask, unsigned int val,
1681 bool *change, bool async, bool force)
1683 WARN_ONCE(1, "regmap API is disabled");
1687 static inline int regmap_update_bits(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_async(struct regmap *map, unsigned int reg,
1695 unsigned int mask, unsigned int val)
1697 WARN_ONCE(1, "regmap API is disabled");
1701 static inline int regmap_update_bits_check(struct regmap *map, unsigned int reg,
1702 unsigned int mask, unsigned int val,
1705 WARN_ONCE(1, "regmap API is disabled");
1710 regmap_update_bits_check_async(struct regmap *map, unsigned int reg,
1711 unsigned int mask, unsigned int val,
1714 WARN_ONCE(1, "regmap API is disabled");
1718 static inline int regmap_write_bits(struct regmap *map, unsigned int reg,
1719 unsigned int mask, unsigned int val)
1721 WARN_ONCE(1, "regmap API is disabled");
1725 static inline int regmap_field_write(struct regmap_field *field,
1728 WARN_ONCE(1, "regmap API is disabled");
1732 static inline int regmap_field_force_write(struct regmap_field *field,
1735 WARN_ONCE(1, "regmap API is disabled");
1739 static inline int regmap_field_update_bits(struct regmap_field *field,
1740 unsigned int mask, unsigned int val)
1742 WARN_ONCE(1, "regmap API is disabled");
1747 regmap_field_force_update_bits(struct regmap_field *field,
1748 unsigned int mask, unsigned int val)
1750 WARN_ONCE(1, "regmap API is disabled");
1754 static inline int regmap_fields_write(struct regmap_field *field,
1755 unsigned int id, unsigned int val)
1757 WARN_ONCE(1, "regmap API is disabled");
1761 static inline int regmap_fields_force_write(struct regmap_field *field,
1762 unsigned int id, unsigned int val)
1764 WARN_ONCE(1, "regmap API is disabled");
1769 regmap_fields_update_bits(struct regmap_field *field, unsigned int id,
1770 unsigned int mask, unsigned int val)
1772 WARN_ONCE(1, "regmap API is disabled");
1777 regmap_fields_force_update_bits(struct regmap_field *field, unsigned int id,
1778 unsigned int mask, unsigned int val)
1780 WARN_ONCE(1, "regmap API is disabled");
1784 static inline int regmap_get_val_bytes(struct regmap *map)
1786 WARN_ONCE(1, "regmap API is disabled");
1790 static inline int regmap_get_max_register(struct regmap *map)
1792 WARN_ONCE(1, "regmap API is disabled");
1796 static inline int regmap_get_reg_stride(struct regmap *map)
1798 WARN_ONCE(1, "regmap API is disabled");
1802 static inline int regcache_sync(struct regmap *map)
1804 WARN_ONCE(1, "regmap API is disabled");
1808 static inline int regcache_sync_region(struct regmap *map, unsigned int min,
1811 WARN_ONCE(1, "regmap API is disabled");
1815 static inline int regcache_drop_region(struct regmap *map, unsigned int min,
1818 WARN_ONCE(1, "regmap API is disabled");
1822 static inline void regcache_cache_only(struct regmap *map, bool enable)
1824 WARN_ONCE(1, "regmap API is disabled");
1827 static inline void regcache_cache_bypass(struct regmap *map, bool enable)
1829 WARN_ONCE(1, "regmap API is disabled");
1832 static inline void regcache_mark_dirty(struct regmap *map)
1834 WARN_ONCE(1, "regmap API is disabled");
1837 static inline void regmap_async_complete(struct regmap *map)
1839 WARN_ONCE(1, "regmap API is disabled");
1842 static inline int regmap_register_patch(struct regmap *map,
1843 const struct reg_sequence *regs,
1846 WARN_ONCE(1, "regmap API is disabled");
1850 static inline int regmap_parse_val(struct regmap *map, const void *buf,
1853 WARN_ONCE(1, "regmap API is disabled");
1857 static inline struct regmap *dev_get_regmap(struct device *dev,
1863 static inline struct device *regmap_get_device(struct regmap *map)
1865 WARN_ONCE(1, "regmap API is disabled");