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.
54 * Register/value pairs for sequences of writes
56 * @reg: Register address.
57 * @def: Register value.
67 /* Unspecified -> 0 -> Backwards compatible default */
68 REGMAP_ENDIAN_DEFAULT = 0,
75 * A register range, used for access related checks
76 * (readable/writeable/volatile/precious checks)
78 * @range_min: address of first register
79 * @range_max: address of last register
82 unsigned int range_min;
83 unsigned int range_max;
86 #define regmap_reg_range(low, high) { .range_min = low, .range_max = high, }
89 * A table of ranges including some yes ranges and some no ranges.
90 * If a register belongs to a no_range, the corresponding check function
91 * will return false. If a register belongs to a yes range, the corresponding
92 * check function will return true. "no_ranges" are searched first.
94 * @yes_ranges : pointer to an array of regmap ranges used as "yes ranges"
95 * @n_yes_ranges: size of the above array
96 * @no_ranges: pointer to an array of regmap ranges used as "no ranges"
97 * @n_no_ranges: size of the above array
99 struct regmap_access_table {
100 const struct regmap_range *yes_ranges;
101 unsigned int n_yes_ranges;
102 const struct regmap_range *no_ranges;
103 unsigned int n_no_ranges;
106 typedef void (*regmap_lock)(void *);
107 typedef void (*regmap_unlock)(void *);
110 * Configuration for the register map of a device.
112 * @name: Optional name of the regmap. Useful when a device has multiple
115 * @reg_bits: Number of bits in a register address, mandatory.
116 * @reg_stride: The register address stride. Valid register addresses are a
117 * multiple of this value. If set to 0, a value of 1 will be
119 * @pad_bits: Number of bits of padding between register and value.
120 * @val_bits: Number of bits in a register value, mandatory.
122 * @writeable_reg: Optional callback returning true if the register
123 * can be written to. If this field is NULL but wr_table
124 * (see below) is not, the check is performed on such table
125 * (a register is writeable if it belongs to one of the ranges
126 * specified by wr_table).
127 * @readable_reg: Optional callback returning true if the register
128 * can be read from. If this field is NULL but rd_table
129 * (see below) is not, the check is performed on such table
130 * (a register is readable if it belongs to one of the ranges
131 * specified by rd_table).
132 * @volatile_reg: Optional callback returning true if the register
133 * value can't be cached. If this field is NULL but
134 * volatile_table (see below) is not, the check is performed on
135 * such table (a register is volatile if it belongs to one of
136 * the ranges specified by volatile_table).
137 * @precious_reg: Optional callback returning true if the register
138 * should not be read outside of a call from the driver
139 * (e.g., a clear on read interrupt status register). If this
140 * field is NULL but precious_table (see below) is not, the
141 * check is performed on such table (a register is precious if
142 * it belongs to one of the ranges specified by precious_table).
143 * @lock: Optional lock callback (overrides regmap's default lock
144 * function, based on spinlock or mutex).
145 * @unlock: As above for unlocking.
146 * @lock_arg: this field is passed as the only argument of lock/unlock
147 * functions (ignored in case regular lock/unlock functions
148 * are not overridden).
149 * @reg_read: Optional callback that if filled will be used to perform
150 * all the reads from the registers. Should only be provided for
151 * devices whose read operation cannot be represented as a simple
152 * read operation on a bus such as SPI, I2C, etc. Most of the
153 * devices do not need this.
154 * @reg_write: Same as above for writing.
155 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
156 * to perform locking. This field is ignored if custom lock/unlock
157 * functions are used (see fields lock/unlock of struct regmap_config).
158 * This field is a duplicate of a similar file in
159 * 'struct regmap_bus' and serves exact same purpose.
160 * Use it only for "no-bus" cases.
161 * @max_register: Optional, specifies the maximum valid register index.
162 * @wr_table: Optional, points to a struct regmap_access_table specifying
163 * valid ranges for write access.
164 * @rd_table: As above, for read access.
165 * @volatile_table: As above, for volatile registers.
166 * @precious_table: As above, for precious registers.
167 * @reg_defaults: Power on reset values for registers (for use with
168 * register cache support).
169 * @num_reg_defaults: Number of elements in reg_defaults.
171 * @read_flag_mask: Mask to be set in the top byte of the register when doing
173 * @write_flag_mask: Mask to be set in the top byte of the register when doing
174 * a write. If both read_flag_mask and write_flag_mask are
175 * empty the regmap_bus default masks are used.
176 * @use_single_rw: If set, converts the bulk read and write operations into
177 * a series of single read and write operations. This is useful
178 * for device that does not support bulk read and write.
179 * @can_multi_write: If set, the device supports the multi write mode of bulk
180 * write operations, if clear multi write requests will be
181 * split into individual write operations
183 * @cache_type: The actual cache type.
184 * @reg_defaults_raw: Power on reset values for registers (for use with
185 * register cache support).
186 * @num_reg_defaults_raw: Number of elements in reg_defaults_raw.
187 * @reg_format_endian: Endianness for formatted register addresses. If this is
188 * DEFAULT, the @reg_format_endian_default value from the
189 * regmap bus is used.
190 * @val_format_endian: Endianness for formatted register values. If this is
191 * DEFAULT, the @reg_format_endian_default value from the
192 * regmap bus is used.
194 * @ranges: Array of configuration entries for virtual address ranges.
195 * @num_ranges: Number of range configuration entries.
197 struct regmap_config {
205 bool (*writeable_reg)(struct device *dev, unsigned int reg);
206 bool (*readable_reg)(struct device *dev, unsigned int reg);
207 bool (*volatile_reg)(struct device *dev, unsigned int reg);
208 bool (*precious_reg)(struct device *dev, unsigned int reg);
210 regmap_unlock unlock;
213 int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
214 int (*reg_write)(void *context, unsigned int reg, unsigned int val);
218 unsigned int max_register;
219 const struct regmap_access_table *wr_table;
220 const struct regmap_access_table *rd_table;
221 const struct regmap_access_table *volatile_table;
222 const struct regmap_access_table *precious_table;
223 const struct reg_default *reg_defaults;
224 unsigned int num_reg_defaults;
225 enum regcache_type cache_type;
226 const void *reg_defaults_raw;
227 unsigned int num_reg_defaults_raw;
233 bool can_multi_write;
235 enum regmap_endian reg_format_endian;
236 enum regmap_endian val_format_endian;
238 const struct regmap_range_cfg *ranges;
239 unsigned int num_ranges;
243 * Configuration for indirectly accessed or paged registers.
244 * Registers, mapped to this virtual range, are accessed in two steps:
245 * 1. page selector register update;
246 * 2. access through data window registers.
248 * @name: Descriptive name for diagnostics
250 * @range_min: Address of the lowest register address in virtual range.
251 * @range_max: Address of the highest register in virtual range.
253 * @page_sel_reg: Register with selector field.
254 * @page_sel_mask: Bit shift for selector value.
255 * @page_sel_shift: Bit mask for selector value.
257 * @window_start: Address of first (lowest) register in data window.
258 * @window_len: Number of registers in data window.
260 struct regmap_range_cfg {
263 /* Registers of virtual address range */
264 unsigned int range_min;
265 unsigned int range_max;
267 /* Page selector for indirect addressing */
268 unsigned int selector_reg;
269 unsigned int selector_mask;
272 /* Data window (per each page) */
273 unsigned int window_start;
274 unsigned int window_len;
279 typedef int (*regmap_hw_write)(void *context, const void *data,
281 typedef int (*regmap_hw_gather_write)(void *context,
282 const void *reg, size_t reg_len,
283 const void *val, size_t val_len);
284 typedef int (*regmap_hw_async_write)(void *context,
285 const void *reg, size_t reg_len,
286 const void *val, size_t val_len,
287 struct regmap_async *async);
288 typedef int (*regmap_hw_read)(void *context,
289 const void *reg_buf, size_t reg_size,
290 void *val_buf, size_t val_size);
291 typedef int (*regmap_hw_reg_read)(void *context, unsigned int reg,
293 typedef int (*regmap_hw_reg_write)(void *context, unsigned int reg,
295 typedef struct regmap_async *(*regmap_hw_async_alloc)(void);
296 typedef void (*regmap_hw_free_context)(void *context);
299 * Description of a hardware bus for the register map infrastructure.
301 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
302 * to perform locking. This field is ignored if custom lock/unlock
303 * functions are used (see fields lock/unlock of
304 * struct regmap_config).
305 * @write: Write operation.
306 * @gather_write: Write operation with split register/value, return -ENOTSUPP
307 * if not implemented on a given device.
308 * @async_write: Write operation which completes asynchronously, optional and
309 * must serialise with respect to non-async I/O.
310 * @read: Read operation. Data is returned in the buffer used to transmit
312 * @async_alloc: Allocate a regmap_async() structure.
313 * @read_flag_mask: Mask to be set in the top byte of the register when doing
315 * @reg_format_endian_default: Default endianness for formatted register
316 * addresses. Used when the regmap_config specifies DEFAULT. If this is
317 * DEFAULT, BIG is assumed.
318 * @val_format_endian_default: Default endianness for formatted register
319 * values. Used when the regmap_config specifies DEFAULT. If this is
320 * DEFAULT, BIG is assumed.
321 * @async_size: Size of struct used for async work.
325 regmap_hw_write write;
326 regmap_hw_gather_write gather_write;
327 regmap_hw_async_write async_write;
328 regmap_hw_reg_write reg_write;
330 regmap_hw_reg_read reg_read;
331 regmap_hw_free_context free_context;
332 regmap_hw_async_alloc async_alloc;
334 enum regmap_endian reg_format_endian_default;
335 enum regmap_endian val_format_endian_default;
338 struct regmap *regmap_init(struct device *dev,
339 const struct regmap_bus *bus,
341 const struct regmap_config *config);
342 int regmap_attach_dev(struct device *dev, struct regmap *map,
343 const struct regmap_config *config);
344 struct regmap *regmap_init_i2c(struct i2c_client *i2c,
345 const struct regmap_config *config);
346 struct regmap *regmap_init_spi(struct spi_device *dev,
347 const struct regmap_config *config);
348 struct regmap *regmap_init_spmi_base(struct spmi_device *dev,
349 const struct regmap_config *config);
350 struct regmap *regmap_init_spmi_ext(struct spmi_device *dev,
351 const struct regmap_config *config);
352 struct regmap *regmap_init_mmio_clk(struct device *dev, const char *clk_id,
354 const struct regmap_config *config);
355 struct regmap *regmap_init_ac97(struct snd_ac97 *ac97,
356 const struct regmap_config *config);
358 struct regmap *devm_regmap_init(struct device *dev,
359 const struct regmap_bus *bus,
361 const struct regmap_config *config);
362 struct regmap *devm_regmap_init_i2c(struct i2c_client *i2c,
363 const struct regmap_config *config);
364 struct regmap *devm_regmap_init_spi(struct spi_device *dev,
365 const struct regmap_config *config);
366 struct regmap *devm_regmap_init_spmi_base(struct spmi_device *dev,
367 const struct regmap_config *config);
368 struct regmap *devm_regmap_init_spmi_ext(struct spmi_device *dev,
369 const struct regmap_config *config);
370 struct regmap *devm_regmap_init_mmio_clk(struct device *dev, const char *clk_id,
372 const struct regmap_config *config);
373 struct regmap *devm_regmap_init_ac97(struct snd_ac97 *ac97,
374 const struct regmap_config *config);
376 bool regmap_ac97_default_volatile(struct device *dev, unsigned int reg);
379 * regmap_init_mmio(): Initialise register map
381 * @dev: Device that will be interacted with
382 * @regs: Pointer to memory-mapped IO region
383 * @config: Configuration for register map
385 * The return value will be an ERR_PTR() on error or a valid pointer to
388 static inline struct regmap *regmap_init_mmio(struct device *dev,
390 const struct regmap_config *config)
392 return regmap_init_mmio_clk(dev, NULL, regs, config);
396 * devm_regmap_init_mmio(): Initialise managed register map
398 * @dev: Device that will be interacted with
399 * @regs: Pointer to memory-mapped IO region
400 * @config: Configuration for register map
402 * The return value will be an ERR_PTR() on error or a valid pointer
403 * to a struct regmap. The regmap will be automatically freed by the
404 * device management code.
406 static inline struct regmap *devm_regmap_init_mmio(struct device *dev,
408 const struct regmap_config *config)
410 return devm_regmap_init_mmio_clk(dev, NULL, regs, config);
413 void regmap_exit(struct regmap *map);
414 int regmap_reinit_cache(struct regmap *map,
415 const struct regmap_config *config);
416 struct regmap *dev_get_regmap(struct device *dev, const char *name);
417 struct device *regmap_get_device(struct regmap *map);
418 int regmap_write(struct regmap *map, unsigned int reg, unsigned int val);
419 int regmap_write_async(struct regmap *map, unsigned int reg, unsigned int val);
420 int regmap_raw_write(struct regmap *map, unsigned int reg,
421 const void *val, size_t val_len);
422 int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
424 int regmap_multi_reg_write(struct regmap *map, const struct reg_sequence *regs,
426 int regmap_multi_reg_write_bypassed(struct regmap *map,
427 const struct reg_sequence *regs,
429 int regmap_raw_write_async(struct regmap *map, unsigned int reg,
430 const void *val, size_t val_len);
431 int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val);
432 int regmap_raw_read(struct regmap *map, unsigned int reg,
433 void *val, size_t val_len);
434 int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
436 int regmap_update_bits(struct regmap *map, unsigned int reg,
437 unsigned int mask, unsigned int val);
438 int regmap_write_bits(struct regmap *map, unsigned int reg,
439 unsigned int mask, unsigned int val);
440 int regmap_update_bits_async(struct regmap *map, unsigned int reg,
441 unsigned int mask, unsigned int val);
442 int regmap_update_bits_check(struct regmap *map, unsigned int reg,
443 unsigned int mask, unsigned int val,
445 int regmap_update_bits_check_async(struct regmap *map, unsigned int reg,
446 unsigned int mask, unsigned int val,
448 int regmap_get_val_bytes(struct regmap *map);
449 int regmap_get_max_register(struct regmap *map);
450 int regmap_get_reg_stride(struct regmap *map);
451 int regmap_async_complete(struct regmap *map);
452 bool regmap_can_raw_write(struct regmap *map);
454 int regcache_sync(struct regmap *map);
455 int regcache_sync_region(struct regmap *map, unsigned int min,
457 int regcache_drop_region(struct regmap *map, unsigned int min,
459 void regcache_cache_only(struct regmap *map, bool enable);
460 void regcache_cache_bypass(struct regmap *map, bool enable);
461 void regcache_mark_dirty(struct regmap *map);
463 bool regmap_check_range_table(struct regmap *map, unsigned int reg,
464 const struct regmap_access_table *table);
466 int regmap_register_patch(struct regmap *map, const struct reg_sequence *regs,
468 int regmap_parse_val(struct regmap *map, const void *buf,
471 static inline bool regmap_reg_in_range(unsigned int reg,
472 const struct regmap_range *range)
474 return reg >= range->range_min && reg <= range->range_max;
477 bool regmap_reg_in_ranges(unsigned int reg,
478 const struct regmap_range *ranges,
479 unsigned int nranges);
482 * Description of an register field
484 * @reg: Offset of the register within the regmap bank
485 * @lsb: lsb of the register field.
486 * @msb: msb of the register field.
487 * @id_size: port size if it has some ports
488 * @id_offset: address offset for each ports
494 unsigned int id_size;
495 unsigned int id_offset;
498 #define REG_FIELD(_reg, _lsb, _msb) { \
504 struct regmap_field *regmap_field_alloc(struct regmap *regmap,
505 struct reg_field reg_field);
506 void regmap_field_free(struct regmap_field *field);
508 struct regmap_field *devm_regmap_field_alloc(struct device *dev,
509 struct regmap *regmap, struct reg_field reg_field);
510 void devm_regmap_field_free(struct device *dev, struct regmap_field *field);
512 int regmap_field_read(struct regmap_field *field, unsigned int *val);
513 int regmap_field_write(struct regmap_field *field, unsigned int val);
514 int regmap_field_update_bits(struct regmap_field *field,
515 unsigned int mask, unsigned int val);
517 int regmap_fields_write(struct regmap_field *field, unsigned int id,
519 int regmap_fields_force_write(struct regmap_field *field, unsigned int id,
521 int regmap_fields_read(struct regmap_field *field, unsigned int id,
523 int regmap_fields_update_bits(struct regmap_field *field, unsigned int id,
524 unsigned int mask, unsigned int val);
527 * Description of an IRQ for the generic regmap irq_chip.
529 * @reg_offset: Offset of the status/mask register within the bank
530 * @mask: Mask used to flag/control the register.
533 unsigned int reg_offset;
538 * Description of a generic regmap irq_chip. This is not intended to
539 * handle every possible interrupt controller, but it should handle a
540 * substantial proportion of those that are found in the wild.
542 * @name: Descriptive name for IRQ controller.
544 * @status_base: Base status register address.
545 * @mask_base: Base mask register address.
546 * @ack_base: Base ack address. If zero then the chip is clear on read.
547 * Using zero value is possible with @use_ack bit.
548 * @wake_base: Base address for wake enables. If zero unsupported.
549 * @irq_reg_stride: Stride to use for chips where registers are not contiguous.
550 * @init_ack_masked: Ack all masked interrupts once during initalization.
551 * @mask_invert: Inverted mask register: cleared bits are masked out.
552 * @use_ack: Use @ack register even if it is zero.
553 * @wake_invert: Inverted wake register: cleared bits are wake enabled.
554 * @runtime_pm: Hold a runtime PM lock on the device when accessing it.
556 * @num_regs: Number of registers in each control bank.
557 * @irqs: Descriptors for individual IRQs. Interrupt numbers are
558 * assigned based on the index in the array of the interrupt.
559 * @num_irqs: Number of descriptors.
561 struct regmap_irq_chip {
564 unsigned int status_base;
565 unsigned int mask_base;
566 unsigned int ack_base;
567 unsigned int wake_base;
568 unsigned int irq_reg_stride;
569 bool init_ack_masked:1;
577 const struct regmap_irq *irqs;
581 struct regmap_irq_chip_data;
583 int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags,
584 int irq_base, const struct regmap_irq_chip *chip,
585 struct regmap_irq_chip_data **data);
586 void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data);
587 int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data);
588 int regmap_irq_get_virq(struct regmap_irq_chip_data *data, int irq);
589 struct irq_domain *regmap_irq_get_domain(struct regmap_irq_chip_data *data);
594 * These stubs should only ever be called by generic code which has
595 * regmap based facilities, if they ever get called at runtime
596 * something is going wrong and something probably needs to select
600 static inline int regmap_write(struct regmap *map, unsigned int reg,
603 WARN_ONCE(1, "regmap API is disabled");
607 static inline int regmap_write_async(struct regmap *map, unsigned int reg,
610 WARN_ONCE(1, "regmap API is disabled");
614 static inline int regmap_raw_write(struct regmap *map, unsigned int reg,
615 const void *val, size_t val_len)
617 WARN_ONCE(1, "regmap API is disabled");
621 static inline int regmap_raw_write_async(struct regmap *map, unsigned int reg,
622 const void *val, size_t val_len)
624 WARN_ONCE(1, "regmap API is disabled");
628 static inline int regmap_bulk_write(struct regmap *map, unsigned int reg,
629 const void *val, size_t val_count)
631 WARN_ONCE(1, "regmap API is disabled");
635 static inline int regmap_read(struct regmap *map, unsigned int reg,
638 WARN_ONCE(1, "regmap API is disabled");
642 static inline int regmap_raw_read(struct regmap *map, unsigned int reg,
643 void *val, size_t val_len)
645 WARN_ONCE(1, "regmap API is disabled");
649 static inline int regmap_bulk_read(struct regmap *map, unsigned int reg,
650 void *val, size_t val_count)
652 WARN_ONCE(1, "regmap API is disabled");
656 static inline int regmap_update_bits(struct regmap *map, unsigned int reg,
657 unsigned int mask, unsigned int val)
659 WARN_ONCE(1, "regmap API is disabled");
663 static inline int regmap_write_bits(struct regmap *map, unsigned int reg,
664 unsigned int mask, unsigned int val)
666 WARN_ONCE(1, "regmap API is disabled");
670 static inline int regmap_update_bits_async(struct regmap *map,
672 unsigned int mask, unsigned int val)
674 WARN_ONCE(1, "regmap API is disabled");
678 static inline int regmap_update_bits_check(struct regmap *map,
680 unsigned int mask, unsigned int val,
683 WARN_ONCE(1, "regmap API is disabled");
687 static inline int regmap_update_bits_check_async(struct regmap *map,
693 WARN_ONCE(1, "regmap API is disabled");
697 static inline int regmap_get_val_bytes(struct regmap *map)
699 WARN_ONCE(1, "regmap API is disabled");
703 static inline int regmap_get_max_register(struct regmap *map)
705 WARN_ONCE(1, "regmap API is disabled");
709 static inline int regmap_get_reg_stride(struct regmap *map)
711 WARN_ONCE(1, "regmap API is disabled");
715 static inline int regcache_sync(struct regmap *map)
717 WARN_ONCE(1, "regmap API is disabled");
721 static inline int regcache_sync_region(struct regmap *map, unsigned int min,
724 WARN_ONCE(1, "regmap API is disabled");
728 static inline int regcache_drop_region(struct regmap *map, unsigned int min,
731 WARN_ONCE(1, "regmap API is disabled");
735 static inline void regcache_cache_only(struct regmap *map, bool enable)
737 WARN_ONCE(1, "regmap API is disabled");
740 static inline void regcache_cache_bypass(struct regmap *map, bool enable)
742 WARN_ONCE(1, "regmap API is disabled");
745 static inline void regcache_mark_dirty(struct regmap *map)
747 WARN_ONCE(1, "regmap API is disabled");
750 static inline void regmap_async_complete(struct regmap *map)
752 WARN_ONCE(1, "regmap API is disabled");
755 static inline int regmap_register_patch(struct regmap *map,
756 const struct reg_default *regs,
759 WARN_ONCE(1, "regmap API is disabled");
763 static inline int regmap_parse_val(struct regmap *map, const void *buf,
766 WARN_ONCE(1, "regmap API is disabled");
770 static inline struct regmap *dev_get_regmap(struct device *dev,
776 static inline struct device *regmap_get_device(struct regmap *map)
778 WARN_ONCE(1, "regmap API is disabled");