1 #ifndef __LINUX_REGMAP_H
2 #define __LINUX_REGMAP_H
5 * Register map access API
7 * Copyright 2011 Wolfson Microelectronics plc
9 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License version 2 as
13 * published by the Free Software Foundation.
16 #include <linux/list.h>
17 #include <linux/rbtree.h>
18 #include <linux/delay.h>
19 #include <linux/err.h>
20 #include <linux/bug.h>
21 #include <linux/lockdep.h>
30 struct regmap_range_cfg;
34 /* An enum of all the supported cache types */
43 * Default value for a register. We use an array of structs rather
44 * than a simple array as many modern devices have very sparse
47 * @reg: Register address.
48 * @def: Register default value.
56 * Register/value pairs for sequences of writes with an optional delay in
57 * microseconds to be applied after each write.
59 * @reg: Register address.
60 * @def: Register value.
61 * @delay_us: Delay to be applied after the register write in microseconds
66 unsigned int delay_us;
69 #define regmap_update_bits(map, reg, mask, val) \
70 regmap_update_bits_base(map, reg, mask, val, NULL, false, false)
71 #define regmap_update_bits_async(map, reg, mask, val)\
72 regmap_update_bits_base(map, reg, mask, val, NULL, true, false)
73 #define regmap_update_bits_check(map, reg, mask, val, change)\
74 regmap_update_bits_base(map, reg, mask, val, change, false, false)
75 #define regmap_update_bits_check_async(map, reg, mask, val, change)\
76 regmap_update_bits_base(map, reg, mask, val, change, true, false)
78 #define regmap_write_bits(map, reg, mask, val) \
79 regmap_update_bits_base(map, reg, mask, val, NULL, false, true)
81 #define regmap_field_write(field, val) \
82 regmap_field_update_bits_base(field, ~0, val, NULL, false, false)
83 #define regmap_field_force_write(field, val) \
84 regmap_field_update_bits_base(field, ~0, val, NULL, false, true)
85 #define regmap_field_update_bits(field, mask, val)\
86 regmap_field_update_bits_base(field, mask, val, NULL, false, false)
87 #define regmap_field_force_update_bits(field, mask, val) \
88 regmap_field_update_bits_base(field, mask, val, NULL, false, true)
90 #define regmap_fields_write(field, id, val) \
91 regmap_fields_update_bits_base(field, id, ~0, val, NULL, false, false)
92 #define regmap_fields_force_write(field, id, val) \
93 regmap_fields_update_bits_base(field, id, ~0, val, NULL, false, true)
94 #define regmap_fields_update_bits(field, id, mask, val)\
95 regmap_fields_update_bits_base(field, id, mask, val, NULL, false, false)
96 #define regmap_fields_force_update_bits(field, id, mask, val) \
97 regmap_fields_update_bits_base(field, id, mask, val, NULL, false, true)
100 * regmap_read_poll_timeout - Poll until a condition is met or a timeout occurs
101 * @map: Regmap to read from
102 * @addr: Address to poll
103 * @val: Unsigned integer variable to read the value into
104 * @cond: Break condition (usually involving @val)
105 * @sleep_us: Maximum time to sleep between reads in us (0
106 * tight-loops). Should be less than ~20ms since usleep_range
107 * is used (see Documentation/timers/timers-howto.txt).
108 * @timeout_us: Timeout in us, 0 means never timeout
110 * Returns 0 on success and -ETIMEDOUT upon a timeout or the regmap_read
111 * error return value in case of a error read. In the two former cases,
112 * the last read value at @addr is stored in @val. Must not be called
113 * from atomic context if sleep_us or timeout_us are used.
115 * This is modelled after the readx_poll_timeout macros in linux/iopoll.h.
117 #define regmap_read_poll_timeout(map, addr, val, cond, sleep_us, timeout_us) \
119 ktime_t timeout = ktime_add_us(ktime_get(), timeout_us); \
121 might_sleep_if(sleep_us); \
123 pollret = regmap_read((map), (addr), &(val)); \
128 if (timeout_us && ktime_compare(ktime_get(), timeout) > 0) { \
129 pollret = regmap_read((map), (addr), &(val)); \
133 usleep_range((sleep_us >> 2) + 1, sleep_us); \
135 pollret ?: ((cond) ? 0 : -ETIMEDOUT); \
141 /* Unspecified -> 0 -> Backwards compatible default */
142 REGMAP_ENDIAN_DEFAULT = 0,
144 REGMAP_ENDIAN_LITTLE,
145 REGMAP_ENDIAN_NATIVE,
149 * A register range, used for access related checks
150 * (readable/writeable/volatile/precious checks)
152 * @range_min: address of first register
153 * @range_max: address of last register
155 struct regmap_range {
156 unsigned int range_min;
157 unsigned int range_max;
160 #define regmap_reg_range(low, high) { .range_min = low, .range_max = high, }
163 * A table of ranges including some yes ranges and some no ranges.
164 * If a register belongs to a no_range, the corresponding check function
165 * will return false. If a register belongs to a yes range, the corresponding
166 * check function will return true. "no_ranges" are searched first.
168 * @yes_ranges : pointer to an array of regmap ranges used as "yes ranges"
169 * @n_yes_ranges: size of the above array
170 * @no_ranges: pointer to an array of regmap ranges used as "no ranges"
171 * @n_no_ranges: size of the above array
173 struct regmap_access_table {
174 const struct regmap_range *yes_ranges;
175 unsigned int n_yes_ranges;
176 const struct regmap_range *no_ranges;
177 unsigned int n_no_ranges;
180 typedef void (*regmap_lock)(void *);
181 typedef void (*regmap_unlock)(void *);
184 * Configuration for the register map of a device.
186 * @name: Optional name of the regmap. Useful when a device has multiple
189 * @reg_bits: Number of bits in a register address, mandatory.
190 * @reg_stride: The register address stride. Valid register addresses are a
191 * multiple of this value. If set to 0, a value of 1 will be
193 * @pad_bits: Number of bits of padding between register and value.
194 * @val_bits: Number of bits in a register value, mandatory.
196 * @writeable_reg: Optional callback returning true if the register
197 * can be written to. If this field is NULL but wr_table
198 * (see below) is not, the check is performed on such table
199 * (a register is writeable if it belongs to one of the ranges
200 * specified by wr_table).
201 * @readable_reg: Optional callback returning true if the register
202 * can be read from. If this field is NULL but rd_table
203 * (see below) is not, the check is performed on such table
204 * (a register is readable if it belongs to one of the ranges
205 * specified by rd_table).
206 * @volatile_reg: Optional callback returning true if the register
207 * value can't be cached. If this field is NULL but
208 * volatile_table (see below) is not, the check is performed on
209 * such table (a register is volatile if it belongs to one of
210 * the ranges specified by volatile_table).
211 * @precious_reg: Optional callback returning true if the register
212 * should not be read outside of a call from the driver
213 * (e.g., a clear on read interrupt status register). If this
214 * field is NULL but precious_table (see below) is not, the
215 * check is performed on such table (a register is precious if
216 * it belongs to one of the ranges specified by precious_table).
217 * @lock: Optional lock callback (overrides regmap's default lock
218 * function, based on spinlock or mutex).
219 * @unlock: As above for unlocking.
220 * @lock_arg: this field is passed as the only argument of lock/unlock
221 * functions (ignored in case regular lock/unlock functions
222 * are not overridden).
223 * @reg_read: Optional callback that if filled will be used to perform
224 * all the reads from the registers. Should only be provided for
225 * devices whose read operation cannot be represented as a simple
226 * read operation on a bus such as SPI, I2C, etc. Most of the
227 * devices do not need this.
228 * @reg_write: Same as above for writing.
229 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
230 * to perform locking. This field is ignored if custom lock/unlock
231 * functions are used (see fields lock/unlock of struct regmap_config).
232 * This field is a duplicate of a similar file in
233 * 'struct regmap_bus' and serves exact same purpose.
234 * Use it only for "no-bus" cases.
235 * @max_register: Optional, specifies the maximum valid register address.
236 * @wr_table: Optional, points to a struct regmap_access_table specifying
237 * valid ranges for write access.
238 * @rd_table: As above, for read access.
239 * @volatile_table: As above, for volatile registers.
240 * @precious_table: As above, for precious registers.
241 * @reg_defaults: Power on reset values for registers (for use with
242 * register cache support).
243 * @num_reg_defaults: Number of elements in reg_defaults.
245 * @read_flag_mask: Mask to be set in the top bytes of the register when doing
247 * @write_flag_mask: Mask to be set in the top bytes of the register when doing
248 * a write. If both read_flag_mask and write_flag_mask are
249 * empty the regmap_bus default masks are used.
250 * @use_single_rw: If set, converts the bulk read and write operations into
251 * a series of single read and write operations. This is useful
252 * for device that does not support bulk read and write.
253 * @can_multi_write: If set, the device supports the multi write mode of bulk
254 * write operations, if clear multi write requests will be
255 * split into individual write operations
257 * @cache_type: The actual cache type.
258 * @reg_defaults_raw: Power on reset values for registers (for use with
259 * register cache support).
260 * @num_reg_defaults_raw: Number of elements in reg_defaults_raw.
261 * @reg_format_endian: Endianness for formatted register addresses. If this is
262 * DEFAULT, the @reg_format_endian_default value from the
263 * regmap bus is used.
264 * @val_format_endian: Endianness for formatted register values. If this is
265 * DEFAULT, the @reg_format_endian_default value from the
266 * regmap bus is used.
268 * @ranges: Array of configuration entries for virtual address ranges.
269 * @num_ranges: Number of range configuration entries.
271 struct regmap_config {
279 bool (*writeable_reg)(struct device *dev, unsigned int reg);
280 bool (*readable_reg)(struct device *dev, unsigned int reg);
281 bool (*volatile_reg)(struct device *dev, unsigned int reg);
282 bool (*precious_reg)(struct device *dev, unsigned int reg);
284 regmap_unlock unlock;
287 int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
288 int (*reg_write)(void *context, unsigned int reg, unsigned int val);
292 unsigned int max_register;
293 const struct regmap_access_table *wr_table;
294 const struct regmap_access_table *rd_table;
295 const struct regmap_access_table *volatile_table;
296 const struct regmap_access_table *precious_table;
297 const struct reg_default *reg_defaults;
298 unsigned int num_reg_defaults;
299 enum regcache_type cache_type;
300 const void *reg_defaults_raw;
301 unsigned int num_reg_defaults_raw;
303 unsigned long read_flag_mask;
304 unsigned long write_flag_mask;
307 bool can_multi_write;
309 enum regmap_endian reg_format_endian;
310 enum regmap_endian val_format_endian;
312 const struct regmap_range_cfg *ranges;
313 unsigned int num_ranges;
317 * Configuration for indirectly accessed or paged registers.
318 * Registers, mapped to this virtual range, are accessed in two steps:
319 * 1. page selector register update;
320 * 2. access through data window registers.
322 * @name: Descriptive name for diagnostics
324 * @range_min: Address of the lowest register address in virtual range.
325 * @range_max: Address of the highest register in virtual range.
327 * @page_sel_reg: Register with selector field.
328 * @page_sel_mask: Bit shift for selector value.
329 * @page_sel_shift: Bit mask for selector value.
331 * @window_start: Address of first (lowest) register in data window.
332 * @window_len: Number of registers in data window.
334 struct regmap_range_cfg {
337 /* Registers of virtual address range */
338 unsigned int range_min;
339 unsigned int range_max;
341 /* Page selector for indirect addressing */
342 unsigned int selector_reg;
343 unsigned int selector_mask;
346 /* Data window (per each page) */
347 unsigned int window_start;
348 unsigned int window_len;
353 typedef int (*regmap_hw_write)(void *context, const void *data,
355 typedef int (*regmap_hw_gather_write)(void *context,
356 const void *reg, size_t reg_len,
357 const void *val, size_t val_len);
358 typedef int (*regmap_hw_async_write)(void *context,
359 const void *reg, size_t reg_len,
360 const void *val, size_t val_len,
361 struct regmap_async *async);
362 typedef int (*regmap_hw_read)(void *context,
363 const void *reg_buf, size_t reg_size,
364 void *val_buf, size_t val_size);
365 typedef int (*regmap_hw_reg_read)(void *context, unsigned int reg,
367 typedef int (*regmap_hw_reg_write)(void *context, unsigned int reg,
369 typedef int (*regmap_hw_reg_update_bits)(void *context, unsigned int reg,
370 unsigned int mask, unsigned int val);
371 typedef struct regmap_async *(*regmap_hw_async_alloc)(void);
372 typedef void (*regmap_hw_free_context)(void *context);
375 * Description of a hardware bus for the register map infrastructure.
377 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
378 * to perform locking. This field is ignored if custom lock/unlock
379 * functions are used (see fields lock/unlock of
380 * struct regmap_config).
381 * @write: Write operation.
382 * @gather_write: Write operation with split register/value, return -ENOTSUPP
383 * if not implemented on a given device.
384 * @async_write: Write operation which completes asynchronously, optional and
385 * must serialise with respect to non-async I/O.
386 * @reg_write: Write a single register value to the given register address. This
387 * write operation has to complete when returning from the function.
388 * @read: Read operation. Data is returned in the buffer used to transmit
390 * @reg_read: Read a single register value from a given register address.
391 * @free_context: Free context.
392 * @async_alloc: Allocate a regmap_async() structure.
393 * @read_flag_mask: Mask to be set in the top byte of the register when doing
395 * @reg_format_endian_default: Default endianness for formatted register
396 * addresses. Used when the regmap_config specifies DEFAULT. If this is
397 * DEFAULT, BIG is assumed.
398 * @val_format_endian_default: Default endianness for formatted register
399 * values. Used when the regmap_config specifies DEFAULT. If this is
400 * DEFAULT, BIG is assumed.
401 * @max_raw_read: Max raw read size that can be used on the bus.
402 * @max_raw_write: Max raw write size that can be used on the bus.
406 regmap_hw_write write;
407 regmap_hw_gather_write gather_write;
408 regmap_hw_async_write async_write;
409 regmap_hw_reg_write reg_write;
410 regmap_hw_reg_update_bits reg_update_bits;
412 regmap_hw_reg_read reg_read;
413 regmap_hw_free_context free_context;
414 regmap_hw_async_alloc async_alloc;
416 enum regmap_endian reg_format_endian_default;
417 enum regmap_endian val_format_endian_default;
419 size_t max_raw_write;
423 * __regmap_init functions.
425 * These functions take a lock key and name parameter, and should not be called
426 * directly. Instead, use the regmap_init macros that generate a key and name
429 struct regmap *__regmap_init(struct device *dev,
430 const struct regmap_bus *bus,
432 const struct regmap_config *config,
433 struct lock_class_key *lock_key,
434 const char *lock_name);
435 struct regmap *__regmap_init_i2c(struct i2c_client *i2c,
436 const struct regmap_config *config,
437 struct lock_class_key *lock_key,
438 const char *lock_name);
439 struct regmap *__regmap_init_spi(struct spi_device *dev,
440 const struct regmap_config *config,
441 struct lock_class_key *lock_key,
442 const char *lock_name);
443 struct regmap *__regmap_init_spmi_base(struct spmi_device *dev,
444 const struct regmap_config *config,
445 struct lock_class_key *lock_key,
446 const char *lock_name);
447 struct regmap *__regmap_init_spmi_ext(struct spmi_device *dev,
448 const struct regmap_config *config,
449 struct lock_class_key *lock_key,
450 const char *lock_name);
451 struct regmap *__regmap_init_mmio_clk(struct device *dev, const char *clk_id,
453 const struct regmap_config *config,
454 struct lock_class_key *lock_key,
455 const char *lock_name);
456 struct regmap *__regmap_init_ac97(struct snd_ac97 *ac97,
457 const struct regmap_config *config,
458 struct lock_class_key *lock_key,
459 const char *lock_name);
461 struct regmap *__devm_regmap_init(struct device *dev,
462 const struct regmap_bus *bus,
464 const struct regmap_config *config,
465 struct lock_class_key *lock_key,
466 const char *lock_name);
467 struct regmap *__devm_regmap_init_i2c(struct i2c_client *i2c,
468 const struct regmap_config *config,
469 struct lock_class_key *lock_key,
470 const char *lock_name);
471 struct regmap *__devm_regmap_init_spi(struct spi_device *dev,
472 const struct regmap_config *config,
473 struct lock_class_key *lock_key,
474 const char *lock_name);
475 struct regmap *__devm_regmap_init_spmi_base(struct spmi_device *dev,
476 const struct regmap_config *config,
477 struct lock_class_key *lock_key,
478 const char *lock_name);
479 struct regmap *__devm_regmap_init_spmi_ext(struct spmi_device *dev,
480 const struct regmap_config *config,
481 struct lock_class_key *lock_key,
482 const char *lock_name);
483 struct regmap *__devm_regmap_init_mmio_clk(struct device *dev,
486 const struct regmap_config *config,
487 struct lock_class_key *lock_key,
488 const char *lock_name);
489 struct regmap *__devm_regmap_init_ac97(struct snd_ac97 *ac97,
490 const struct regmap_config *config,
491 struct lock_class_key *lock_key,
492 const char *lock_name);
495 * Wrapper for regmap_init macros to include a unique lockdep key and name
496 * for each call. No-op if CONFIG_LOCKDEP is not set.
498 * @fn: Real function to call (in the form __[*_]regmap_init[_*])
499 * @name: Config variable name (#config in the calling macro)
501 #ifdef CONFIG_LOCKDEP
502 #define __regmap_lockdep_wrapper(fn, name, ...) \
505 static struct lock_class_key _key; \
506 fn(__VA_ARGS__, &_key, \
507 KBUILD_BASENAME ":" \
508 __stringify(__LINE__) ":" \
509 "(" name ")->lock"); \
513 #define __regmap_lockdep_wrapper(fn, name, ...) fn(__VA_ARGS__, NULL, NULL)
517 * regmap_init(): Initialise register map
519 * @dev: Device that will be interacted with
520 * @bus: Bus-specific callbacks to use with device
521 * @bus_context: Data passed to bus-specific callbacks
522 * @config: Configuration for register map
524 * The return value will be an ERR_PTR() on error or a valid pointer to
525 * a struct regmap. This function should generally not be called
526 * directly, it should be called by bus-specific init functions.
528 #define regmap_init(dev, bus, bus_context, config) \
529 __regmap_lockdep_wrapper(__regmap_init, #config, \
530 dev, bus, bus_context, config)
531 int regmap_attach_dev(struct device *dev, struct regmap *map,
532 const struct regmap_config *config);
535 * regmap_init_i2c(): Initialise register map
537 * @i2c: Device that will be interacted with
538 * @config: Configuration for register map
540 * The return value will be an ERR_PTR() on error or a valid pointer to
543 #define regmap_init_i2c(i2c, config) \
544 __regmap_lockdep_wrapper(__regmap_init_i2c, #config, \
548 * regmap_init_spi(): Initialise register map
550 * @spi: Device that will be interacted with
551 * @config: Configuration for register map
553 * The return value will be an ERR_PTR() on error or a valid pointer to
556 #define regmap_init_spi(dev, config) \
557 __regmap_lockdep_wrapper(__regmap_init_spi, #config, \
561 * regmap_init_spmi_base(): Create regmap for the Base register space
562 * @sdev: SPMI device that will be interacted with
563 * @config: Configuration for register map
565 * The return value will be an ERR_PTR() on error or a valid pointer to
568 #define regmap_init_spmi_base(dev, config) \
569 __regmap_lockdep_wrapper(__regmap_init_spmi_base, #config, \
573 * regmap_init_spmi_ext(): Create regmap for Ext register space
574 * @sdev: Device that will be interacted with
575 * @config: Configuration for register map
577 * The return value will be an ERR_PTR() on error or a valid pointer to
580 #define regmap_init_spmi_ext(dev, config) \
581 __regmap_lockdep_wrapper(__regmap_init_spmi_ext, #config, \
585 * regmap_init_mmio_clk(): Initialise register map with register clock
587 * @dev: Device that will be interacted with
588 * @clk_id: register clock consumer ID
589 * @regs: Pointer to memory-mapped IO region
590 * @config: Configuration for register map
592 * The return value will be an ERR_PTR() on error or a valid pointer to
595 #define regmap_init_mmio_clk(dev, clk_id, regs, config) \
596 __regmap_lockdep_wrapper(__regmap_init_mmio_clk, #config, \
597 dev, clk_id, regs, config)
600 * regmap_init_mmio(): Initialise register map
602 * @dev: Device that will be interacted with
603 * @regs: Pointer to memory-mapped IO region
604 * @config: Configuration for register map
606 * The return value will be an ERR_PTR() on error or a valid pointer to
609 #define regmap_init_mmio(dev, regs, config) \
610 regmap_init_mmio_clk(dev, NULL, regs, config)
613 * regmap_init_ac97(): Initialise AC'97 register map
615 * @ac97: Device that will be interacted with
616 * @config: Configuration for register map
618 * The return value will be an ERR_PTR() on error or a valid pointer to
621 #define regmap_init_ac97(ac97, config) \
622 __regmap_lockdep_wrapper(__regmap_init_ac97, #config, \
624 bool regmap_ac97_default_volatile(struct device *dev, unsigned int reg);
627 * devm_regmap_init(): Initialise managed register map
629 * @dev: Device that will be interacted with
630 * @bus: Bus-specific callbacks to use with device
631 * @bus_context: Data passed to bus-specific callbacks
632 * @config: Configuration for register map
634 * The return value will be an ERR_PTR() on error or a valid pointer
635 * to a struct regmap. This function should generally not be called
636 * directly, it should be called by bus-specific init functions. The
637 * map will be automatically freed by the device management code.
639 #define devm_regmap_init(dev, bus, bus_context, config) \
640 __regmap_lockdep_wrapper(__devm_regmap_init, #config, \
641 dev, bus, bus_context, config)
644 * devm_regmap_init_i2c(): Initialise managed register map
646 * @i2c: Device that will be interacted with
647 * @config: Configuration for register map
649 * The return value will be an ERR_PTR() on error or a valid pointer
650 * to a struct regmap. The regmap will be automatically freed by the
651 * device management code.
653 #define devm_regmap_init_i2c(i2c, config) \
654 __regmap_lockdep_wrapper(__devm_regmap_init_i2c, #config, \
658 * devm_regmap_init_spi(): Initialise register map
660 * @spi: Device that will be interacted with
661 * @config: Configuration for register map
663 * The return value will be an ERR_PTR() on error or a valid pointer
664 * to a struct regmap. The map will be automatically freed by the
665 * device management code.
667 #define devm_regmap_init_spi(dev, config) \
668 __regmap_lockdep_wrapper(__devm_regmap_init_spi, #config, \
672 * devm_regmap_init_spmi_base(): Create managed regmap for Base register space
673 * @sdev: SPMI device that will be interacted with
674 * @config: Configuration for register map
676 * The return value will be an ERR_PTR() on error or a valid pointer
677 * to a struct regmap. The regmap will be automatically freed by the
678 * device management code.
680 #define devm_regmap_init_spmi_base(dev, config) \
681 __regmap_lockdep_wrapper(__devm_regmap_init_spmi_base, #config, \
685 * devm_regmap_init_spmi_ext(): Create managed regmap for Ext register space
686 * @sdev: SPMI device that will be interacted with
687 * @config: Configuration for register map
689 * The return value will be an ERR_PTR() on error or a valid pointer
690 * to a struct regmap. The regmap will be automatically freed by the
691 * device management code.
693 #define devm_regmap_init_spmi_ext(dev, config) \
694 __regmap_lockdep_wrapper(__devm_regmap_init_spmi_ext, #config, \
698 * devm_regmap_init_mmio_clk(): Initialise managed register map with clock
700 * @dev: Device that will be interacted with
701 * @clk_id: register clock consumer ID
702 * @regs: Pointer to memory-mapped IO region
703 * @config: Configuration for register map
705 * The return value will be an ERR_PTR() on error or a valid pointer
706 * to a struct regmap. The regmap will be automatically freed by the
707 * device management code.
709 #define devm_regmap_init_mmio_clk(dev, clk_id, regs, config) \
710 __regmap_lockdep_wrapper(__devm_regmap_init_mmio_clk, #config, \
711 dev, clk_id, regs, config)
714 * devm_regmap_init_mmio(): Initialise managed register map
716 * @dev: Device that will be interacted with
717 * @regs: Pointer to memory-mapped IO region
718 * @config: Configuration for register map
720 * The return value will be an ERR_PTR() on error or a valid pointer
721 * to a struct regmap. The regmap will be automatically freed by the
722 * device management code.
724 #define devm_regmap_init_mmio(dev, regs, config) \
725 devm_regmap_init_mmio_clk(dev, NULL, regs, config)
728 * devm_regmap_init_ac97(): Initialise AC'97 register map
730 * @ac97: Device that will be interacted with
731 * @config: Configuration for register map
733 * The return value will be an ERR_PTR() on error or a valid pointer
734 * to a struct regmap. The regmap will be automatically freed by the
735 * device management code.
737 #define devm_regmap_init_ac97(ac97, config) \
738 __regmap_lockdep_wrapper(__devm_regmap_init_ac97, #config, \
741 void regmap_exit(struct regmap *map);
742 int regmap_reinit_cache(struct regmap *map,
743 const struct regmap_config *config);
744 struct regmap *dev_get_regmap(struct device *dev, const char *name);
745 struct device *regmap_get_device(struct regmap *map);
746 int regmap_write(struct regmap *map, unsigned int reg, unsigned int val);
747 int regmap_write_async(struct regmap *map, unsigned int reg, unsigned int val);
748 int regmap_raw_write(struct regmap *map, unsigned int reg,
749 const void *val, size_t val_len);
750 int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
752 int regmap_multi_reg_write(struct regmap *map, const struct reg_sequence *regs,
754 int regmap_multi_reg_write_bypassed(struct regmap *map,
755 const struct reg_sequence *regs,
757 int regmap_raw_write_async(struct regmap *map, unsigned int reg,
758 const void *val, size_t val_len);
759 int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val);
760 int regmap_raw_read(struct regmap *map, unsigned int reg,
761 void *val, size_t val_len);
762 int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
764 int regmap_update_bits_base(struct regmap *map, unsigned int reg,
765 unsigned int mask, unsigned int val,
766 bool *change, bool async, bool force);
767 int regmap_get_val_bytes(struct regmap *map);
768 int regmap_get_max_register(struct regmap *map);
769 int regmap_get_reg_stride(struct regmap *map);
770 int regmap_async_complete(struct regmap *map);
771 bool regmap_can_raw_write(struct regmap *map);
772 size_t regmap_get_raw_read_max(struct regmap *map);
773 size_t regmap_get_raw_write_max(struct regmap *map);
775 int regcache_sync(struct regmap *map);
776 int regcache_sync_region(struct regmap *map, unsigned int min,
778 int regcache_drop_region(struct regmap *map, unsigned int min,
780 void regcache_cache_only(struct regmap *map, bool enable);
781 void regcache_cache_bypass(struct regmap *map, bool enable);
782 void regcache_mark_dirty(struct regmap *map);
784 bool regmap_check_range_table(struct regmap *map, unsigned int reg,
785 const struct regmap_access_table *table);
787 int regmap_register_patch(struct regmap *map, const struct reg_sequence *regs,
789 int regmap_parse_val(struct regmap *map, const void *buf,
792 static inline bool regmap_reg_in_range(unsigned int reg,
793 const struct regmap_range *range)
795 return reg >= range->range_min && reg <= range->range_max;
798 bool regmap_reg_in_ranges(unsigned int reg,
799 const struct regmap_range *ranges,
800 unsigned int nranges);
803 * Description of an register field
805 * @reg: Offset of the register within the regmap bank
806 * @lsb: lsb of the register field.
807 * @msb: msb of the register field.
808 * @id_size: port size if it has some ports
809 * @id_offset: address offset for each ports
815 unsigned int id_size;
816 unsigned int id_offset;
819 #define REG_FIELD(_reg, _lsb, _msb) { \
825 struct regmap_field *regmap_field_alloc(struct regmap *regmap,
826 struct reg_field reg_field);
827 void regmap_field_free(struct regmap_field *field);
829 struct regmap_field *devm_regmap_field_alloc(struct device *dev,
830 struct regmap *regmap, struct reg_field reg_field);
831 void devm_regmap_field_free(struct device *dev, struct regmap_field *field);
833 int regmap_field_read(struct regmap_field *field, unsigned int *val);
834 int regmap_field_update_bits_base(struct regmap_field *field,
835 unsigned int mask, unsigned int val,
836 bool *change, bool async, bool force);
837 int regmap_fields_read(struct regmap_field *field, unsigned int id,
839 int regmap_fields_update_bits_base(struct regmap_field *field, unsigned int id,
840 unsigned int mask, unsigned int val,
841 bool *change, bool async, bool force);
844 * Description of an IRQ for the generic regmap irq_chip.
846 * @reg_offset: Offset of the status/mask register within the bank
847 * @mask: Mask used to flag/control the register.
848 * @type_reg_offset: Offset register for the irq type setting.
849 * @type_rising_mask: Mask bit to configure RISING type irq.
850 * @type_falling_mask: Mask bit to configure FALLING type irq.
853 unsigned int reg_offset;
855 unsigned int type_reg_offset;
856 unsigned int type_rising_mask;
857 unsigned int type_falling_mask;
860 #define REGMAP_IRQ_REG(_irq, _off, _mask) \
861 [_irq] = { .reg_offset = (_off), .mask = (_mask) }
864 * Description of a generic regmap irq_chip. This is not intended to
865 * handle every possible interrupt controller, but it should handle a
866 * substantial proportion of those that are found in the wild.
868 * @name: Descriptive name for IRQ controller.
870 * @status_base: Base status register address.
871 * @mask_base: Base mask register address.
872 * @unmask_base: Base unmask register address. for chips who have
873 * separate mask and unmask registers
874 * @ack_base: Base ack address. If zero then the chip is clear on read.
875 * Using zero value is possible with @use_ack bit.
876 * @wake_base: Base address for wake enables. If zero unsupported.
877 * @type_base: Base address for irq type. If zero unsupported.
878 * @irq_reg_stride: Stride to use for chips where registers are not contiguous.
879 * @init_ack_masked: Ack all masked interrupts once during initalization.
880 * @mask_invert: Inverted mask register: cleared bits are masked out.
881 * @use_ack: Use @ack register even if it is zero.
882 * @ack_invert: Inverted ack register: cleared bits for ack.
883 * @wake_invert: Inverted wake register: cleared bits are wake enabled.
884 * @type_invert: Invert the type flags.
885 * @runtime_pm: Hold a runtime PM lock on the device when accessing it.
887 * @num_regs: Number of registers in each control bank.
888 * @irqs: Descriptors for individual IRQs. Interrupt numbers are
889 * assigned based on the index in the array of the interrupt.
890 * @num_irqs: Number of descriptors.
891 * @num_type_reg: Number of type registers.
892 * @type_reg_stride: Stride to use for chips where type registers are not
894 * @handle_pre_irq: Driver specific callback to handle interrupt from device
895 * before regmap_irq_handler process the interrupts.
896 * @handle_post_irq: Driver specific callback to handle interrupt from device
897 * after handling the interrupts in regmap_irq_handler().
898 * @irq_drv_data: Driver specific IRQ data which is passed as parameter when
899 * driver specific pre/post interrupt handler is called.
901 struct regmap_irq_chip {
904 unsigned int status_base;
905 unsigned int mask_base;
906 unsigned int unmask_base;
907 unsigned int ack_base;
908 unsigned int wake_base;
909 unsigned int type_base;
910 unsigned int irq_reg_stride;
911 bool init_ack_masked:1;
921 const struct regmap_irq *irqs;
925 unsigned int type_reg_stride;
927 int (*handle_pre_irq)(void *irq_drv_data);
928 int (*handle_post_irq)(void *irq_drv_data);
932 struct regmap_irq_chip_data;
934 int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags,
935 int irq_base, const struct regmap_irq_chip *chip,
936 struct regmap_irq_chip_data **data);
937 void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data);
939 int devm_regmap_add_irq_chip(struct device *dev, struct regmap *map, int irq,
940 int irq_flags, int irq_base,
941 const struct regmap_irq_chip *chip,
942 struct regmap_irq_chip_data **data);
943 void devm_regmap_del_irq_chip(struct device *dev, int irq,
944 struct regmap_irq_chip_data *data);
946 int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data);
947 int regmap_irq_get_virq(struct regmap_irq_chip_data *data, int irq);
948 struct irq_domain *regmap_irq_get_domain(struct regmap_irq_chip_data *data);
953 * These stubs should only ever be called by generic code which has
954 * regmap based facilities, if they ever get called at runtime
955 * something is going wrong and something probably needs to select
959 static inline int regmap_write(struct regmap *map, unsigned int reg,
962 WARN_ONCE(1, "regmap API is disabled");
966 static inline int regmap_write_async(struct regmap *map, unsigned int reg,
969 WARN_ONCE(1, "regmap API is disabled");
973 static inline int regmap_raw_write(struct regmap *map, unsigned int reg,
974 const void *val, size_t val_len)
976 WARN_ONCE(1, "regmap API is disabled");
980 static inline int regmap_raw_write_async(struct regmap *map, unsigned int reg,
981 const void *val, size_t val_len)
983 WARN_ONCE(1, "regmap API is disabled");
987 static inline int regmap_bulk_write(struct regmap *map, unsigned int reg,
988 const void *val, size_t val_count)
990 WARN_ONCE(1, "regmap API is disabled");
994 static inline int regmap_read(struct regmap *map, unsigned int reg,
997 WARN_ONCE(1, "regmap API is disabled");
1001 static inline int regmap_raw_read(struct regmap *map, unsigned int reg,
1002 void *val, size_t val_len)
1004 WARN_ONCE(1, "regmap API is disabled");
1008 static inline int regmap_bulk_read(struct regmap *map, unsigned int reg,
1009 void *val, size_t val_count)
1011 WARN_ONCE(1, "regmap API is disabled");
1015 static inline int regmap_update_bits_base(struct regmap *map, unsigned int reg,
1016 unsigned int mask, unsigned int val,
1017 bool *change, bool async, bool force)
1019 WARN_ONCE(1, "regmap API is disabled");
1023 static inline int regmap_field_update_bits_base(struct regmap_field *field,
1024 unsigned int mask, unsigned int val,
1025 bool *change, bool async, bool force)
1027 WARN_ONCE(1, "regmap API is disabled");
1031 static inline int regmap_fields_update_bits_base(struct regmap_field *field,
1033 unsigned int mask, unsigned int val,
1034 bool *change, bool async, bool force)
1036 WARN_ONCE(1, "regmap API is disabled");
1040 static inline int regmap_get_val_bytes(struct regmap *map)
1042 WARN_ONCE(1, "regmap API is disabled");
1046 static inline int regmap_get_max_register(struct regmap *map)
1048 WARN_ONCE(1, "regmap API is disabled");
1052 static inline int regmap_get_reg_stride(struct regmap *map)
1054 WARN_ONCE(1, "regmap API is disabled");
1058 static inline int regcache_sync(struct regmap *map)
1060 WARN_ONCE(1, "regmap API is disabled");
1064 static inline int regcache_sync_region(struct regmap *map, unsigned int min,
1067 WARN_ONCE(1, "regmap API is disabled");
1071 static inline int regcache_drop_region(struct regmap *map, unsigned int min,
1074 WARN_ONCE(1, "regmap API is disabled");
1078 static inline void regcache_cache_only(struct regmap *map, bool enable)
1080 WARN_ONCE(1, "regmap API is disabled");
1083 static inline void regcache_cache_bypass(struct regmap *map, bool enable)
1085 WARN_ONCE(1, "regmap API is disabled");
1088 static inline void regcache_mark_dirty(struct regmap *map)
1090 WARN_ONCE(1, "regmap API is disabled");
1093 static inline void regmap_async_complete(struct regmap *map)
1095 WARN_ONCE(1, "regmap API is disabled");
1098 static inline int regmap_register_patch(struct regmap *map,
1099 const struct reg_sequence *regs,
1102 WARN_ONCE(1, "regmap API is disabled");
1106 static inline int regmap_parse_val(struct regmap *map, const void *buf,
1109 WARN_ONCE(1, "regmap API is disabled");
1113 static inline struct regmap *dev_get_regmap(struct device *dev,
1119 static inline struct device *regmap_get_device(struct regmap *map)
1121 WARN_ONCE(1, "regmap API is disabled");