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>
28 struct regmap_range_cfg;
32 /* An enum of all the supported cache types */
41 * Default value for a register. We use an array of structs rather
42 * than a simple array as many modern devices have very sparse
45 * @reg: Register address.
46 * @def: Register default value.
56 /* Unspecified -> 0 -> Backwards compatible default */
57 REGMAP_ENDIAN_DEFAULT = 0,
64 * A register range, used for access related checks
65 * (readable/writeable/volatile/precious checks)
67 * @range_min: address of first register
68 * @range_max: address of last register
71 unsigned int range_min;
72 unsigned int range_max;
75 #define regmap_reg_range(low, high) { .range_min = low, .range_max = high, }
78 * A table of ranges including some yes ranges and some no ranges.
79 * If a register belongs to a no_range, the corresponding check function
80 * will return false. If a register belongs to a yes range, the corresponding
81 * check function will return true. "no_ranges" are searched first.
83 * @yes_ranges : pointer to an array of regmap ranges used as "yes ranges"
84 * @n_yes_ranges: size of the above array
85 * @no_ranges: pointer to an array of regmap ranges used as "no ranges"
86 * @n_no_ranges: size of the above array
88 struct regmap_access_table {
89 const struct regmap_range *yes_ranges;
90 unsigned int n_yes_ranges;
91 const struct regmap_range *no_ranges;
92 unsigned int n_no_ranges;
95 typedef void (*regmap_lock)(void *);
96 typedef void (*regmap_unlock)(void *);
99 * Configuration for the register map of a device.
101 * @name: Optional name of the regmap. Useful when a device has multiple
104 * @reg_bits: Number of bits in a register address, mandatory.
105 * @reg_stride: The register address stride. Valid register addresses are a
106 * multiple of this value. If set to 0, a value of 1 will be
108 * @pad_bits: Number of bits of padding between register and value.
109 * @val_bits: Number of bits in a register value, mandatory.
111 * @writeable_reg: Optional callback returning true if the register
112 * can be written to. If this field is NULL but wr_table
113 * (see below) is not, the check is performed on such table
114 * (a register is writeable if it belongs to one of the ranges
115 * specified by wr_table).
116 * @readable_reg: Optional callback returning true if the register
117 * can be read from. If this field is NULL but rd_table
118 * (see below) is not, the check is performed on such table
119 * (a register is readable if it belongs to one of the ranges
120 * specified by rd_table).
121 * @volatile_reg: Optional callback returning true if the register
122 * value can't be cached. If this field is NULL but
123 * volatile_table (see below) is not, the check is performed on
124 * such table (a register is volatile if it belongs to one of
125 * the ranges specified by volatile_table).
126 * @precious_reg: Optional callback returning true if the register
127 * should not be read outside of a call from the driver
128 * (e.g., a clear on read interrupt status register). If this
129 * field is NULL but precious_table (see below) is not, the
130 * check is performed on such table (a register is precious if
131 * it belongs to one of the ranges specified by precious_table).
132 * @lock: Optional lock callback (overrides regmap's default lock
133 * function, based on spinlock or mutex).
134 * @unlock: As above for unlocking.
135 * @lock_arg: this field is passed as the only argument of lock/unlock
136 * functions (ignored in case regular lock/unlock functions
137 * are not overridden).
138 * @reg_read: Optional callback that if filled will be used to perform
139 * all the reads from the registers. Should only be provided for
140 * devices whose read operation cannot be represented as a simple
141 * read operation on a bus such as SPI, I2C, etc. Most of the
142 * devices do not need this.
143 * @reg_write: Same as above for writing.
144 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
145 * to perform locking. This field is ignored if custom lock/unlock
146 * functions are used (see fields lock/unlock of struct regmap_config).
147 * This field is a duplicate of a similar file in
148 * 'struct regmap_bus' and serves exact same purpose.
149 * Use it only for "no-bus" cases.
150 * @max_register: Optional, specifies the maximum valid register index.
151 * @wr_table: Optional, points to a struct regmap_access_table specifying
152 * valid ranges for write access.
153 * @rd_table: As above, for read access.
154 * @volatile_table: As above, for volatile registers.
155 * @precious_table: As above, for precious registers.
156 * @reg_defaults: Power on reset values for registers (for use with
157 * register cache support).
158 * @num_reg_defaults: Number of elements in reg_defaults.
160 * @read_flag_mask: Mask to be set in the top byte of the register when doing
162 * @write_flag_mask: Mask to be set in the top byte of the register when doing
163 * a write. If both read_flag_mask and write_flag_mask are
164 * empty the regmap_bus default masks are used.
165 * @use_single_rw: If set, converts the bulk read and write operations into
166 * a series of single read and write operations. This is useful
167 * for device that does not support bulk read and write.
168 * @can_multi_write: If set, the device supports the multi write mode of bulk
169 * write operations, if clear multi write requests will be
170 * split into individual write operations
172 * @cache_type: The actual cache type.
173 * @reg_defaults_raw: Power on reset values for registers (for use with
174 * register cache support).
175 * @num_reg_defaults_raw: Number of elements in reg_defaults_raw.
176 * @reg_format_endian: Endianness for formatted register addresses. If this is
177 * DEFAULT, the @reg_format_endian_default value from the
178 * regmap bus is used.
179 * @val_format_endian: Endianness for formatted register values. If this is
180 * DEFAULT, the @reg_format_endian_default value from the
181 * regmap bus is used.
183 * @ranges: Array of configuration entries for virtual address ranges.
184 * @num_ranges: Number of range configuration entries.
186 struct regmap_config {
194 bool (*writeable_reg)(struct device *dev, unsigned int reg);
195 bool (*readable_reg)(struct device *dev, unsigned int reg);
196 bool (*volatile_reg)(struct device *dev, unsigned int reg);
197 bool (*precious_reg)(struct device *dev, unsigned int reg);
199 regmap_unlock unlock;
202 int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
203 int (*reg_write)(void *context, unsigned int reg, unsigned int val);
207 unsigned int max_register;
208 const struct regmap_access_table *wr_table;
209 const struct regmap_access_table *rd_table;
210 const struct regmap_access_table *volatile_table;
211 const struct regmap_access_table *precious_table;
212 const struct reg_default *reg_defaults;
213 unsigned int num_reg_defaults;
214 enum regcache_type cache_type;
215 const void *reg_defaults_raw;
216 unsigned int num_reg_defaults_raw;
222 bool can_multi_write;
224 enum regmap_endian reg_format_endian;
225 enum regmap_endian val_format_endian;
227 const struct regmap_range_cfg *ranges;
228 unsigned int num_ranges;
232 * Configuration for indirectly accessed or paged registers.
233 * Registers, mapped to this virtual range, are accessed in two steps:
234 * 1. page selector register update;
235 * 2. access through data window registers.
237 * @name: Descriptive name for diagnostics
239 * @range_min: Address of the lowest register address in virtual range.
240 * @range_max: Address of the highest register in virtual range.
242 * @page_sel_reg: Register with selector field.
243 * @page_sel_mask: Bit shift for selector value.
244 * @page_sel_shift: Bit mask for selector value.
246 * @window_start: Address of first (lowest) register in data window.
247 * @window_len: Number of registers in data window.
249 struct regmap_range_cfg {
252 /* Registers of virtual address range */
253 unsigned int range_min;
254 unsigned int range_max;
256 /* Page selector for indirect addressing */
257 unsigned int selector_reg;
258 unsigned int selector_mask;
261 /* Data window (per each page) */
262 unsigned int window_start;
263 unsigned int window_len;
268 typedef int (*regmap_hw_write)(void *context, const void *data,
270 typedef int (*regmap_hw_gather_write)(void *context,
271 const void *reg, size_t reg_len,
272 const void *val, size_t val_len);
273 typedef int (*regmap_hw_async_write)(void *context,
274 const void *reg, size_t reg_len,
275 const void *val, size_t val_len,
276 struct regmap_async *async);
277 typedef int (*regmap_hw_read)(void *context,
278 const void *reg_buf, size_t reg_size,
279 void *val_buf, size_t val_size);
280 typedef int (*regmap_hw_reg_read)(void *context, unsigned int reg,
282 typedef int (*regmap_hw_reg_write)(void *context, unsigned int reg,
284 typedef struct regmap_async *(*regmap_hw_async_alloc)(void);
285 typedef void (*regmap_hw_free_context)(void *context);
288 * Description of a hardware bus for the register map infrastructure.
290 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
291 * to perform locking. This field is ignored if custom lock/unlock
292 * functions are used (see fields lock/unlock of
293 * struct regmap_config).
294 * @write: Write operation.
295 * @gather_write: Write operation with split register/value, return -ENOTSUPP
296 * if not implemented on a given device.
297 * @async_write: Write operation which completes asynchronously, optional and
298 * must serialise with respect to non-async I/O.
299 * @read: Read operation. Data is returned in the buffer used to transmit
301 * @async_alloc: Allocate a regmap_async() structure.
302 * @read_flag_mask: Mask to be set in the top byte of the register when doing
304 * @reg_format_endian_default: Default endianness for formatted register
305 * addresses. Used when the regmap_config specifies DEFAULT. If this is
306 * DEFAULT, BIG is assumed.
307 * @val_format_endian_default: Default endianness for formatted register
308 * values. Used when the regmap_config specifies DEFAULT. If this is
309 * DEFAULT, BIG is assumed.
310 * @async_size: Size of struct used for async work.
314 regmap_hw_write write;
315 regmap_hw_gather_write gather_write;
316 regmap_hw_async_write async_write;
317 regmap_hw_reg_write reg_write;
319 regmap_hw_reg_read reg_read;
320 regmap_hw_free_context free_context;
321 regmap_hw_async_alloc async_alloc;
323 enum regmap_endian reg_format_endian_default;
324 enum regmap_endian val_format_endian_default;
327 struct regmap *regmap_init(struct device *dev,
328 const struct regmap_bus *bus,
330 const struct regmap_config *config);
331 int regmap_attach_dev(struct device *dev, struct regmap *map,
332 const struct regmap_config *config);
333 struct regmap *regmap_init_i2c(struct i2c_client *i2c,
334 const struct regmap_config *config);
335 struct regmap *regmap_init_spi(struct spi_device *dev,
336 const struct regmap_config *config);
337 struct regmap *regmap_init_spmi_base(struct spmi_device *dev,
338 const struct regmap_config *config);
339 struct regmap *regmap_init_spmi_ext(struct spmi_device *dev,
340 const struct regmap_config *config);
341 struct regmap *regmap_init_mmio_clk(struct device *dev, const char *clk_id,
343 const struct regmap_config *config);
344 struct regmap *regmap_init_ac97(struct snd_ac97 *ac97,
345 const struct regmap_config *config);
347 struct regmap *devm_regmap_init(struct device *dev,
348 const struct regmap_bus *bus,
350 const struct regmap_config *config);
351 struct regmap *devm_regmap_init_i2c(struct i2c_client *i2c,
352 const struct regmap_config *config);
353 struct regmap *devm_regmap_init_spi(struct spi_device *dev,
354 const struct regmap_config *config);
355 struct regmap *devm_regmap_init_spmi_base(struct spmi_device *dev,
356 const struct regmap_config *config);
357 struct regmap *devm_regmap_init_spmi_ext(struct spmi_device *dev,
358 const struct regmap_config *config);
359 struct regmap *devm_regmap_init_mmio_clk(struct device *dev, const char *clk_id,
361 const struct regmap_config *config);
362 struct regmap *devm_regmap_init_ac97(struct snd_ac97 *ac97,
363 const struct regmap_config *config);
365 bool regmap_ac97_default_volatile(struct device *dev, unsigned int reg);
368 * regmap_init_mmio(): Initialise register map
370 * @dev: Device that will be interacted with
371 * @regs: Pointer to memory-mapped IO region
372 * @config: Configuration for register map
374 * The return value will be an ERR_PTR() on error or a valid pointer to
377 static inline struct regmap *regmap_init_mmio(struct device *dev,
379 const struct regmap_config *config)
381 return regmap_init_mmio_clk(dev, NULL, regs, config);
385 * devm_regmap_init_mmio(): Initialise managed register map
387 * @dev: Device that will be interacted with
388 * @regs: Pointer to memory-mapped IO region
389 * @config: Configuration for register map
391 * The return value will be an ERR_PTR() on error or a valid pointer
392 * to a struct regmap. The regmap will be automatically freed by the
393 * device management code.
395 static inline struct regmap *devm_regmap_init_mmio(struct device *dev,
397 const struct regmap_config *config)
399 return devm_regmap_init_mmio_clk(dev, NULL, regs, config);
402 void regmap_exit(struct regmap *map);
403 int regmap_reinit_cache(struct regmap *map,
404 const struct regmap_config *config);
405 struct regmap *dev_get_regmap(struct device *dev, const char *name);
406 struct device *regmap_get_device(struct regmap *map);
407 int regmap_write(struct regmap *map, unsigned int reg, unsigned int val);
408 int regmap_write_async(struct regmap *map, unsigned int reg, unsigned int val);
409 int regmap_raw_write(struct regmap *map, unsigned int reg,
410 const void *val, size_t val_len);
411 int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
413 int regmap_multi_reg_write(struct regmap *map, const struct reg_default *regs,
415 int regmap_multi_reg_write_bypassed(struct regmap *map,
416 const struct reg_default *regs,
418 int regmap_raw_write_async(struct regmap *map, unsigned int reg,
419 const void *val, size_t val_len);
420 int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val);
421 int regmap_raw_read(struct regmap *map, unsigned int reg,
422 void *val, size_t val_len);
423 int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
425 int regmap_update_bits(struct regmap *map, unsigned int reg,
426 unsigned int mask, unsigned int val);
427 int regmap_update_bits_async(struct regmap *map, unsigned int reg,
428 unsigned int mask, unsigned int val);
429 int regmap_update_bits_check(struct regmap *map, unsigned int reg,
430 unsigned int mask, unsigned int val,
432 int regmap_update_bits_check_async(struct regmap *map, unsigned int reg,
433 unsigned int mask, unsigned int val,
435 int regmap_get_val_bytes(struct regmap *map);
436 int regmap_get_max_register(struct regmap *map);
437 int regmap_async_complete(struct regmap *map);
438 bool regmap_can_raw_write(struct regmap *map);
440 int regcache_sync(struct regmap *map);
441 int regcache_sync_region(struct regmap *map, unsigned int min,
443 int regcache_drop_region(struct regmap *map, unsigned int min,
445 void regcache_cache_only(struct regmap *map, bool enable);
446 void regcache_cache_bypass(struct regmap *map, bool enable);
447 void regcache_mark_dirty(struct regmap *map);
449 bool regmap_check_range_table(struct regmap *map, unsigned int reg,
450 const struct regmap_access_table *table);
452 int regmap_register_patch(struct regmap *map, const struct reg_default *regs,
454 int regmap_parse_val(struct regmap *map, const void *buf,
457 static inline bool regmap_reg_in_range(unsigned int reg,
458 const struct regmap_range *range)
460 return reg >= range->range_min && reg <= range->range_max;
463 bool regmap_reg_in_ranges(unsigned int reg,
464 const struct regmap_range *ranges,
465 unsigned int nranges);
468 * Description of an register field
470 * @reg: Offset of the register within the regmap bank
471 * @lsb: lsb of the register field.
472 * @msb: msb of the register field.
473 * @id_size: port size if it has some ports
474 * @id_offset: address offset for each ports
480 unsigned int id_size;
481 unsigned int id_offset;
484 #define REG_FIELD(_reg, _lsb, _msb) { \
490 struct regmap_field *regmap_field_alloc(struct regmap *regmap,
491 struct reg_field reg_field);
492 void regmap_field_free(struct regmap_field *field);
494 struct regmap_field *devm_regmap_field_alloc(struct device *dev,
495 struct regmap *regmap, struct reg_field reg_field);
496 void devm_regmap_field_free(struct device *dev, struct regmap_field *field);
498 int regmap_field_read(struct regmap_field *field, unsigned int *val);
499 int regmap_field_write(struct regmap_field *field, unsigned int val);
500 int regmap_field_update_bits(struct regmap_field *field,
501 unsigned int mask, unsigned int val);
503 int regmap_fields_write(struct regmap_field *field, unsigned int id,
505 int regmap_fields_read(struct regmap_field *field, unsigned int id,
507 int regmap_fields_update_bits(struct regmap_field *field, unsigned int id,
508 unsigned int mask, unsigned int val);
511 * Description of an IRQ for the generic regmap irq_chip.
513 * @reg_offset: Offset of the status/mask register within the bank
514 * @mask: Mask used to flag/control the register.
517 unsigned int reg_offset;
522 * Description of a generic regmap irq_chip. This is not intended to
523 * handle every possible interrupt controller, but it should handle a
524 * substantial proportion of those that are found in the wild.
526 * @name: Descriptive name for IRQ controller.
528 * @status_base: Base status register address.
529 * @mask_base: Base mask register address.
530 * @ack_base: Base ack address. If zero then the chip is clear on read.
531 * Using zero value is possible with @use_ack bit.
532 * @wake_base: Base address for wake enables. If zero unsupported.
533 * @irq_reg_stride: Stride to use for chips where registers are not contiguous.
534 * @init_ack_masked: Ack all masked interrupts once during initalization.
535 * @mask_invert: Inverted mask register: cleared bits are masked out.
536 * @use_ack: Use @ack register even if it is zero.
537 * @wake_invert: Inverted wake register: cleared bits are wake enabled.
538 * @runtime_pm: Hold a runtime PM lock on the device when accessing it.
540 * @num_regs: Number of registers in each control bank.
541 * @irqs: Descriptors for individual IRQs. Interrupt numbers are
542 * assigned based on the index in the array of the interrupt.
543 * @num_irqs: Number of descriptors.
545 struct regmap_irq_chip {
548 unsigned int status_base;
549 unsigned int mask_base;
550 unsigned int ack_base;
551 unsigned int wake_base;
552 unsigned int irq_reg_stride;
553 bool init_ack_masked:1;
561 const struct regmap_irq *irqs;
565 struct regmap_irq_chip_data;
567 int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags,
568 int irq_base, const struct regmap_irq_chip *chip,
569 struct regmap_irq_chip_data **data);
570 void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data);
571 int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data);
572 int regmap_irq_get_virq(struct regmap_irq_chip_data *data, int irq);
573 struct irq_domain *regmap_irq_get_domain(struct regmap_irq_chip_data *data);
578 * These stubs should only ever be called by generic code which has
579 * regmap based facilities, if they ever get called at runtime
580 * something is going wrong and something probably needs to select
584 static inline int regmap_write(struct regmap *map, unsigned int reg,
587 WARN_ONCE(1, "regmap API is disabled");
591 static inline int regmap_write_async(struct regmap *map, unsigned int reg,
594 WARN_ONCE(1, "regmap API is disabled");
598 static inline int regmap_raw_write(struct regmap *map, unsigned int reg,
599 const void *val, size_t val_len)
601 WARN_ONCE(1, "regmap API is disabled");
605 static inline int regmap_raw_write_async(struct regmap *map, unsigned int reg,
606 const void *val, size_t val_len)
608 WARN_ONCE(1, "regmap API is disabled");
612 static inline int regmap_bulk_write(struct regmap *map, unsigned int reg,
613 const void *val, size_t val_count)
615 WARN_ONCE(1, "regmap API is disabled");
619 static inline int regmap_read(struct regmap *map, unsigned int reg,
622 WARN_ONCE(1, "regmap API is disabled");
626 static inline int regmap_raw_read(struct regmap *map, unsigned int reg,
627 void *val, size_t val_len)
629 WARN_ONCE(1, "regmap API is disabled");
633 static inline int regmap_bulk_read(struct regmap *map, unsigned int reg,
634 void *val, size_t val_count)
636 WARN_ONCE(1, "regmap API is disabled");
640 static inline int regmap_update_bits(struct regmap *map, unsigned int reg,
641 unsigned int mask, unsigned int val)
643 WARN_ONCE(1, "regmap API is disabled");
647 static inline int regmap_update_bits_async(struct regmap *map,
649 unsigned int mask, unsigned int val)
651 WARN_ONCE(1, "regmap API is disabled");
655 static inline int regmap_update_bits_check(struct regmap *map,
657 unsigned int mask, unsigned int val,
660 WARN_ONCE(1, "regmap API is disabled");
664 static inline int regmap_update_bits_check_async(struct regmap *map,
670 WARN_ONCE(1, "regmap API is disabled");
674 static inline int regmap_get_val_bytes(struct regmap *map)
676 WARN_ONCE(1, "regmap API is disabled");
680 static inline int regmap_get_max_register(struct regmap *map)
682 WARN_ONCE(1, "regmap API is disabled");
686 static inline int regcache_sync(struct regmap *map)
688 WARN_ONCE(1, "regmap API is disabled");
692 static inline int regcache_sync_region(struct regmap *map, unsigned int min,
695 WARN_ONCE(1, "regmap API is disabled");
699 static inline int regcache_drop_region(struct regmap *map, unsigned int min,
702 WARN_ONCE(1, "regmap API is disabled");
706 static inline void regcache_cache_only(struct regmap *map, bool enable)
708 WARN_ONCE(1, "regmap API is disabled");
711 static inline void regcache_cache_bypass(struct regmap *map, bool enable)
713 WARN_ONCE(1, "regmap API is disabled");
716 static inline void regcache_mark_dirty(struct regmap *map)
718 WARN_ONCE(1, "regmap API is disabled");
721 static inline void regmap_async_complete(struct regmap *map)
723 WARN_ONCE(1, "regmap API is disabled");
726 static inline int regmap_register_patch(struct regmap *map,
727 const struct reg_default *regs,
730 WARN_ONCE(1, "regmap API is disabled");
734 static inline int regmap_parse_val(struct regmap *map, const void *buf,
737 WARN_ONCE(1, "regmap API is disabled");
741 static inline struct regmap *dev_get_regmap(struct device *dev,
747 static inline struct device *regmap_get_device(struct regmap *map)
749 WARN_ONCE(1, "regmap API is disabled");