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/err.h>
19 #include <linux/bug.h>
27 struct regmap_range_cfg;
30 /* An enum of all the supported cache types */
39 * Default value for a register. We use an array of structs rather
40 * than a simple array as many modern devices have very sparse
43 * @reg: Register address.
44 * @def: Register default value.
54 /* Unspecified -> 0 -> Backwards compatible default */
55 REGMAP_ENDIAN_DEFAULT = 0,
62 * A register range, used for access related checks
63 * (readable/writeable/volatile/precious checks)
65 * @range_min: address of first register
66 * @range_max: address of last register
69 unsigned int range_min;
70 unsigned int range_max;
73 #define regmap_reg_range(low, high) { .range_min = low, .range_max = high, }
76 * A table of ranges including some yes ranges and some no ranges.
77 * If a register belongs to a no_range, the corresponding check function
78 * will return false. If a register belongs to a yes range, the corresponding
79 * check function will return true. "no_ranges" are searched first.
81 * @yes_ranges : pointer to an array of regmap ranges used as "yes ranges"
82 * @n_yes_ranges: size of the above array
83 * @no_ranges: pointer to an array of regmap ranges used as "no ranges"
84 * @n_no_ranges: size of the above array
86 struct regmap_access_table {
87 const struct regmap_range *yes_ranges;
88 unsigned int n_yes_ranges;
89 const struct regmap_range *no_ranges;
90 unsigned int n_no_ranges;
93 typedef void (*regmap_lock)(void *);
94 typedef void (*regmap_unlock)(void *);
97 * Configuration for the register map of a device.
99 * @name: Optional name of the regmap. Useful when a device has multiple
102 * @reg_bits: Number of bits in a register address, mandatory.
103 * @reg_stride: The register address stride. Valid register addresses are a
104 * multiple of this value. If set to 0, a value of 1 will be
106 * @pad_bits: Number of bits of padding between register and value.
107 * @val_bits: Number of bits in a register value, mandatory.
109 * @writeable_reg: Optional callback returning true if the register
110 * can be written to. If this field is NULL but wr_table
111 * (see below) is not, the check is performed on such table
112 * (a register is writeable if it belongs to one of the ranges
113 * specified by wr_table).
114 * @readable_reg: Optional callback returning true if the register
115 * can be read from. If this field is NULL but rd_table
116 * (see below) is not, the check is performed on such table
117 * (a register is readable if it belongs to one of the ranges
118 * specified by rd_table).
119 * @volatile_reg: Optional callback returning true if the register
120 * value can't be cached. If this field is NULL but
121 * volatile_table (see below) is not, the check is performed on
122 * such table (a register is volatile if it belongs to one of
123 * the ranges specified by volatile_table).
124 * @precious_reg: Optional callback returning true if the rgister
125 * should not be read outside of a call from the driver
126 * (eg, a clear on read interrupt status register). If this
127 * field is NULL but precious_table (see below) is not, the
128 * check is performed on such table (a register is precious if
129 * it belongs to one of the ranges specified by precious_table).
130 * @lock: Optional lock callback (overrides regmap's default lock
131 * function, based on spinlock or mutex).
132 * @unlock: As above for unlocking.
133 * @lock_arg: this field is passed as the only argument of lock/unlock
134 * functions (ignored in case regular lock/unlock functions
135 * are not overridden).
136 * @reg_read: Optional callback that if filled will be used to perform
137 * all the reads from the registers. Should only be provided for
138 * devices whos read operation cannot be represented as a simple read
139 * operation on a bus such as SPI, I2C, etc. Most of the devices do
141 * @reg_write: Same as above for writing.
142 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
143 * to perform locking. This field is ignored if custom lock/unlock
144 * functions are used (see fields lock/unlock of struct regmap_config).
145 * This field is a duplicate of a similar file in
146 * 'struct regmap_bus' and serves exact same purpose.
147 * Use it only for "no-bus" cases.
148 * @max_register: Optional, specifies the maximum valid register index.
149 * @wr_table: Optional, points to a struct regmap_access_table specifying
150 * valid ranges for write access.
151 * @rd_table: As above, for read access.
152 * @volatile_table: As above, for volatile registers.
153 * @precious_table: As above, for precious registers.
154 * @reg_defaults: Power on reset values for registers (for use with
155 * register cache support).
156 * @num_reg_defaults: Number of elements in reg_defaults.
158 * @read_flag_mask: Mask to be set in the top byte of the register when doing
160 * @write_flag_mask: Mask to be set in the top byte of the register when doing
161 * a write. If both read_flag_mask and write_flag_mask are
162 * empty the regmap_bus default masks are used.
163 * @use_single_rw: If set, converts the bulk read and write operations into
164 * a series of single read and write operations. This is useful
165 * for device that does not support bulk read and write.
167 * @cache_type: The actual cache type.
168 * @reg_defaults_raw: Power on reset values for registers (for use with
169 * register cache support).
170 * @num_reg_defaults_raw: Number of elements in reg_defaults_raw.
171 * @reg_format_endian: Endianness for formatted register addresses. If this is
172 * DEFAULT, the @reg_format_endian_default value from the
173 * regmap bus is used.
174 * @val_format_endian: Endianness for formatted register values. If this is
175 * DEFAULT, the @reg_format_endian_default value from the
176 * regmap bus is used.
178 * @ranges: Array of configuration entries for virtual address ranges.
179 * @num_ranges: Number of range configuration entries.
181 struct regmap_config {
189 bool (*writeable_reg)(struct device *dev, unsigned int reg);
190 bool (*readable_reg)(struct device *dev, unsigned int reg);
191 bool (*volatile_reg)(struct device *dev, unsigned int reg);
192 bool (*precious_reg)(struct device *dev, unsigned int reg);
194 regmap_unlock unlock;
197 int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
198 int (*reg_write)(void *context, unsigned int reg, unsigned int val);
202 unsigned int max_register;
203 const struct regmap_access_table *wr_table;
204 const struct regmap_access_table *rd_table;
205 const struct regmap_access_table *volatile_table;
206 const struct regmap_access_table *precious_table;
207 const struct reg_default *reg_defaults;
208 unsigned int num_reg_defaults;
209 enum regcache_type cache_type;
210 const void *reg_defaults_raw;
211 unsigned int num_reg_defaults_raw;
218 enum regmap_endian reg_format_endian;
219 enum regmap_endian val_format_endian;
221 const struct regmap_range_cfg *ranges;
222 unsigned int num_ranges;
226 * Configuration for indirectly accessed or paged registers.
227 * Registers, mapped to this virtual range, are accessed in two steps:
228 * 1. page selector register update;
229 * 2. access through data window registers.
231 * @name: Descriptive name for diagnostics
233 * @range_min: Address of the lowest register address in virtual range.
234 * @range_max: Address of the highest register in virtual range.
236 * @page_sel_reg: Register with selector field.
237 * @page_sel_mask: Bit shift for selector value.
238 * @page_sel_shift: Bit mask for selector value.
240 * @window_start: Address of first (lowest) register in data window.
241 * @window_len: Number of registers in data window.
243 struct regmap_range_cfg {
246 /* Registers of virtual address range */
247 unsigned int range_min;
248 unsigned int range_max;
250 /* Page selector for indirect addressing */
251 unsigned int selector_reg;
252 unsigned int selector_mask;
255 /* Data window (per each page) */
256 unsigned int window_start;
257 unsigned int window_len;
262 typedef int (*regmap_hw_write)(void *context, const void *data,
264 typedef int (*regmap_hw_gather_write)(void *context,
265 const void *reg, size_t reg_len,
266 const void *val, size_t val_len);
267 typedef int (*regmap_hw_async_write)(void *context,
268 const void *reg, size_t reg_len,
269 const void *val, size_t val_len,
270 struct regmap_async *async);
271 typedef int (*regmap_hw_read)(void *context,
272 const void *reg_buf, size_t reg_size,
273 void *val_buf, size_t val_size);
274 typedef struct regmap_async *(*regmap_hw_async_alloc)(void);
275 typedef void (*regmap_hw_free_context)(void *context);
278 * Description of a hardware bus for the register map infrastructure.
280 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
281 * to perform locking. This field is ignored if custom lock/unlock
282 * functions are used (see fields lock/unlock of
283 * struct regmap_config).
284 * @write: Write operation.
285 * @gather_write: Write operation with split register/value, return -ENOTSUPP
286 * if not implemented on a given device.
287 * @async_write: Write operation which completes asynchronously, optional and
288 * must serialise with respect to non-async I/O.
289 * @read: Read operation. Data is returned in the buffer used to transmit
291 * @async_alloc: Allocate a regmap_async() structure.
292 * @read_flag_mask: Mask to be set in the top byte of the register when doing
294 * @reg_format_endian_default: Default endianness for formatted register
295 * addresses. Used when the regmap_config specifies DEFAULT. If this is
296 * DEFAULT, BIG is assumed.
297 * @val_format_endian_default: Default endianness for formatted register
298 * values. Used when the regmap_config specifies DEFAULT. If this is
299 * DEFAULT, BIG is assumed.
300 * @async_size: Size of struct used for async work.
304 regmap_hw_write write;
305 regmap_hw_gather_write gather_write;
306 regmap_hw_async_write async_write;
308 regmap_hw_free_context free_context;
309 regmap_hw_async_alloc async_alloc;
311 enum regmap_endian reg_format_endian_default;
312 enum regmap_endian val_format_endian_default;
315 struct regmap *regmap_init(struct device *dev,
316 const struct regmap_bus *bus,
318 const struct regmap_config *config);
319 struct regmap *regmap_init_i2c(struct i2c_client *i2c,
320 const struct regmap_config *config);
321 struct regmap *regmap_init_spi(struct spi_device *dev,
322 const struct regmap_config *config);
323 struct regmap *regmap_init_mmio_clk(struct device *dev, const char *clk_id,
325 const struct regmap_config *config);
327 struct regmap *devm_regmap_init(struct device *dev,
328 const struct regmap_bus *bus,
330 const struct regmap_config *config);
331 struct regmap *devm_regmap_init_i2c(struct i2c_client *i2c,
332 const struct regmap_config *config);
333 struct regmap *devm_regmap_init_spi(struct spi_device *dev,
334 const struct regmap_config *config);
335 struct regmap *devm_regmap_init_mmio_clk(struct device *dev, const char *clk_id,
337 const struct regmap_config *config);
340 * regmap_init_mmio(): Initialise register map
342 * @dev: Device that will be interacted with
343 * @regs: Pointer to memory-mapped IO region
344 * @config: Configuration for register map
346 * The return value will be an ERR_PTR() on error or a valid pointer to
349 static inline struct regmap *regmap_init_mmio(struct device *dev,
351 const struct regmap_config *config)
353 return regmap_init_mmio_clk(dev, NULL, regs, config);
357 * devm_regmap_init_mmio(): Initialise managed register map
359 * @dev: Device that will be interacted with
360 * @regs: Pointer to memory-mapped IO region
361 * @config: Configuration for register map
363 * The return value will be an ERR_PTR() on error or a valid pointer
364 * to a struct regmap. The regmap will be automatically freed by the
365 * device management code.
367 static inline struct regmap *devm_regmap_init_mmio(struct device *dev,
369 const struct regmap_config *config)
371 return devm_regmap_init_mmio_clk(dev, NULL, regs, config);
374 void regmap_exit(struct regmap *map);
375 int regmap_reinit_cache(struct regmap *map,
376 const struct regmap_config *config);
377 struct regmap *dev_get_regmap(struct device *dev, const char *name);
378 int regmap_write(struct regmap *map, unsigned int reg, unsigned int val);
379 int regmap_write_async(struct regmap *map, unsigned int reg, unsigned int val);
380 int regmap_raw_write(struct regmap *map, unsigned int reg,
381 const void *val, size_t val_len);
382 int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
384 int regmap_multi_reg_write(struct regmap *map, struct reg_default *regs,
386 int regmap_raw_write_async(struct regmap *map, unsigned int reg,
387 const void *val, size_t val_len);
388 int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val);
389 int regmap_raw_read(struct regmap *map, unsigned int reg,
390 void *val, size_t val_len);
391 int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
393 int regmap_update_bits(struct regmap *map, unsigned int reg,
394 unsigned int mask, unsigned int val);
395 int regmap_update_bits_async(struct regmap *map, unsigned int reg,
396 unsigned int mask, unsigned int val);
397 int regmap_update_bits_check(struct regmap *map, unsigned int reg,
398 unsigned int mask, unsigned int val,
400 int regmap_update_bits_check_async(struct regmap *map, unsigned int reg,
401 unsigned int mask, unsigned int val,
403 int regmap_get_val_bytes(struct regmap *map);
404 int regmap_async_complete(struct regmap *map);
405 bool regmap_can_raw_write(struct regmap *map);
407 int regcache_sync(struct regmap *map);
408 int regcache_sync_region(struct regmap *map, unsigned int min,
410 int regcache_drop_region(struct regmap *map, unsigned int min,
412 void regcache_cache_only(struct regmap *map, bool enable);
413 void regcache_cache_bypass(struct regmap *map, bool enable);
414 void regcache_mark_dirty(struct regmap *map);
416 bool regmap_check_range_table(struct regmap *map, unsigned int reg,
417 const struct regmap_access_table *table);
419 int regmap_register_patch(struct regmap *map, const struct reg_default *regs,
422 static inline bool regmap_reg_in_range(unsigned int reg,
423 const struct regmap_range *range)
425 return reg >= range->range_min && reg <= range->range_max;
428 bool regmap_reg_in_ranges(unsigned int reg,
429 const struct regmap_range *ranges,
430 unsigned int nranges);
433 * Description of an register field
435 * @reg: Offset of the register within the regmap bank
436 * @lsb: lsb of the register field.
437 * @reg: msb of the register field.
438 * @id_size: port size if it has some ports
439 * @id_offset: address offset for each ports
445 unsigned int id_size;
446 unsigned int id_offset;
449 #define REG_FIELD(_reg, _lsb, _msb) { \
455 struct regmap_field *regmap_field_alloc(struct regmap *regmap,
456 struct reg_field reg_field);
457 void regmap_field_free(struct regmap_field *field);
459 struct regmap_field *devm_regmap_field_alloc(struct device *dev,
460 struct regmap *regmap, struct reg_field reg_field);
461 void devm_regmap_field_free(struct device *dev, struct regmap_field *field);
463 int regmap_field_read(struct regmap_field *field, unsigned int *val);
464 int regmap_field_write(struct regmap_field *field, unsigned int val);
465 int regmap_field_update_bits(struct regmap_field *field,
466 unsigned int mask, unsigned int val);
468 int regmap_fields_write(struct regmap_field *field, unsigned int id,
470 int regmap_fields_read(struct regmap_field *field, unsigned int id,
472 int regmap_fields_update_bits(struct regmap_field *field, unsigned int id,
473 unsigned int mask, unsigned int val);
476 * Description of an IRQ for the generic regmap irq_chip.
478 * @reg_offset: Offset of the status/mask register within the bank
479 * @mask: Mask used to flag/control the register.
482 unsigned int reg_offset;
487 * Description of a generic regmap irq_chip. This is not intended to
488 * handle every possible interrupt controller, but it should handle a
489 * substantial proportion of those that are found in the wild.
491 * @name: Descriptive name for IRQ controller.
493 * @status_base: Base status register address.
494 * @mask_base: Base mask register address.
495 * @ack_base: Base ack address. If zero then the chip is clear on read.
496 * @wake_base: Base address for wake enables. If zero unsupported.
497 * @irq_reg_stride: Stride to use for chips where registers are not contiguous.
498 * @init_ack_masked: Ack all masked interrupts once during initalization.
499 * @mask_invert: Inverted mask register: cleared bits are masked out.
500 * @wake_invert: Inverted wake register: cleared bits are wake enabled.
501 * @runtime_pm: Hold a runtime PM lock on the device when accessing it.
503 * @num_regs: Number of registers in each control bank.
504 * @irqs: Descriptors for individual IRQs. Interrupt numbers are
505 * assigned based on the index in the array of the interrupt.
506 * @num_irqs: Number of descriptors.
508 struct regmap_irq_chip {
511 unsigned int status_base;
512 unsigned int mask_base;
513 unsigned int ack_base;
514 unsigned int wake_base;
515 unsigned int irq_reg_stride;
516 bool init_ack_masked:1;
523 const struct regmap_irq *irqs;
527 struct regmap_irq_chip_data;
529 int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags,
530 int irq_base, const struct regmap_irq_chip *chip,
531 struct regmap_irq_chip_data **data);
532 void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data);
533 int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data);
534 int regmap_irq_get_virq(struct regmap_irq_chip_data *data, int irq);
535 struct irq_domain *regmap_irq_get_domain(struct regmap_irq_chip_data *data);
540 * These stubs should only ever be called by generic code which has
541 * regmap based facilities, if they ever get called at runtime
542 * something is going wrong and something probably needs to select
546 static inline int regmap_write(struct regmap *map, unsigned int reg,
549 WARN_ONCE(1, "regmap API is disabled");
553 static inline int regmap_write_async(struct regmap *map, unsigned int reg,
556 WARN_ONCE(1, "regmap API is disabled");
560 static inline int regmap_raw_write(struct regmap *map, unsigned int reg,
561 const void *val, size_t val_len)
563 WARN_ONCE(1, "regmap API is disabled");
567 static inline int regmap_raw_write_async(struct regmap *map, unsigned int reg,
568 const void *val, size_t val_len)
570 WARN_ONCE(1, "regmap API is disabled");
574 static inline int regmap_bulk_write(struct regmap *map, unsigned int reg,
575 const void *val, size_t val_count)
577 WARN_ONCE(1, "regmap API is disabled");
581 static inline int regmap_read(struct regmap *map, unsigned int reg,
584 WARN_ONCE(1, "regmap API is disabled");
588 static inline int regmap_raw_read(struct regmap *map, unsigned int reg,
589 void *val, size_t val_len)
591 WARN_ONCE(1, "regmap API is disabled");
595 static inline int regmap_bulk_read(struct regmap *map, unsigned int reg,
596 void *val, size_t val_count)
598 WARN_ONCE(1, "regmap API is disabled");
602 static inline int regmap_update_bits(struct regmap *map, unsigned int reg,
603 unsigned int mask, unsigned int val)
605 WARN_ONCE(1, "regmap API is disabled");
609 static inline int regmap_update_bits_async(struct regmap *map,
611 unsigned int mask, unsigned int val)
613 WARN_ONCE(1, "regmap API is disabled");
617 static inline int regmap_update_bits_check(struct regmap *map,
619 unsigned int mask, unsigned int val,
622 WARN_ONCE(1, "regmap API is disabled");
626 static inline int regmap_update_bits_check_async(struct regmap *map,
632 WARN_ONCE(1, "regmap API is disabled");
636 static inline int regmap_get_val_bytes(struct regmap *map)
638 WARN_ONCE(1, "regmap API is disabled");
642 static inline int regcache_sync(struct regmap *map)
644 WARN_ONCE(1, "regmap API is disabled");
648 static inline int regcache_sync_region(struct regmap *map, unsigned int min,
651 WARN_ONCE(1, "regmap API is disabled");
655 static inline int regcache_drop_region(struct regmap *map, unsigned int min,
658 WARN_ONCE(1, "regmap API is disabled");
662 static inline void regcache_cache_only(struct regmap *map, bool enable)
664 WARN_ONCE(1, "regmap API is disabled");
667 static inline void regcache_cache_bypass(struct regmap *map, bool enable)
669 WARN_ONCE(1, "regmap API is disabled");
672 static inline void regcache_mark_dirty(struct regmap *map)
674 WARN_ONCE(1, "regmap API is disabled");
677 static inline void regmap_async_complete(struct regmap *map)
679 WARN_ONCE(1, "regmap API is disabled");
682 static inline int regmap_register_patch(struct regmap *map,
683 const struct reg_default *regs,
686 WARN_ONCE(1, "regmap API is disabled");
690 static inline struct regmap *dev_get_regmap(struct device *dev,