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 * @reg_write: Write a single register value to the given register address. This
300 * write operation has to complete when returning from the function.
301 * @read: Read operation. Data is returned in the buffer used to transmit
303 * @reg_read: Read a single register value from a given register address.
304 * @free_context: Free context.
305 * @async_alloc: Allocate a regmap_async() structure.
306 * @read_flag_mask: Mask to be set in the top byte of the register when doing
308 * @reg_format_endian_default: Default endianness for formatted register
309 * addresses. Used when the regmap_config specifies DEFAULT. If this is
310 * DEFAULT, BIG is assumed.
311 * @val_format_endian_default: Default endianness for formatted register
312 * values. Used when the regmap_config specifies DEFAULT. If this is
313 * DEFAULT, BIG is assumed.
314 * @max_raw_read: Max raw read size that can be used on the bus.
315 * @max_raw_write: Max raw write size that can be used on the bus.
319 regmap_hw_write write;
320 regmap_hw_gather_write gather_write;
321 regmap_hw_async_write async_write;
322 regmap_hw_reg_write reg_write;
324 regmap_hw_reg_read reg_read;
325 regmap_hw_free_context free_context;
326 regmap_hw_async_alloc async_alloc;
328 enum regmap_endian reg_format_endian_default;
329 enum regmap_endian val_format_endian_default;
331 size_t max_raw_write;
334 struct regmap *regmap_init(struct device *dev,
335 const struct regmap_bus *bus,
337 const struct regmap_config *config);
338 int regmap_attach_dev(struct device *dev, struct regmap *map,
339 const struct regmap_config *config);
340 struct regmap *regmap_init_i2c(struct i2c_client *i2c,
341 const struct regmap_config *config);
342 struct regmap *regmap_init_spi(struct spi_device *dev,
343 const struct regmap_config *config);
344 struct regmap *regmap_init_spmi_base(struct spmi_device *dev,
345 const struct regmap_config *config);
346 struct regmap *regmap_init_spmi_ext(struct spmi_device *dev,
347 const struct regmap_config *config);
348 struct regmap *regmap_init_mmio_clk(struct device *dev, const char *clk_id,
350 const struct regmap_config *config);
351 struct regmap *regmap_init_ac97(struct snd_ac97 *ac97,
352 const struct regmap_config *config);
354 struct regmap *devm_regmap_init(struct device *dev,
355 const struct regmap_bus *bus,
357 const struct regmap_config *config);
358 struct regmap *devm_regmap_init_i2c(struct i2c_client *i2c,
359 const struct regmap_config *config);
360 struct regmap *devm_regmap_init_spi(struct spi_device *dev,
361 const struct regmap_config *config);
362 struct regmap *devm_regmap_init_spmi_base(struct spmi_device *dev,
363 const struct regmap_config *config);
364 struct regmap *devm_regmap_init_spmi_ext(struct spmi_device *dev,
365 const struct regmap_config *config);
366 struct regmap *devm_regmap_init_mmio_clk(struct device *dev, const char *clk_id,
368 const struct regmap_config *config);
369 struct regmap *devm_regmap_init_ac97(struct snd_ac97 *ac97,
370 const struct regmap_config *config);
372 bool regmap_ac97_default_volatile(struct device *dev, unsigned int reg);
375 * regmap_init_mmio(): Initialise register map
377 * @dev: Device that will be interacted with
378 * @regs: Pointer to memory-mapped IO region
379 * @config: Configuration for register map
381 * The return value will be an ERR_PTR() on error or a valid pointer to
384 static inline struct regmap *regmap_init_mmio(struct device *dev,
386 const struct regmap_config *config)
388 return regmap_init_mmio_clk(dev, NULL, regs, config);
392 * devm_regmap_init_mmio(): Initialise managed register map
394 * @dev: Device that will be interacted with
395 * @regs: Pointer to memory-mapped IO region
396 * @config: Configuration for register map
398 * The return value will be an ERR_PTR() on error or a valid pointer
399 * to a struct regmap. The regmap will be automatically freed by the
400 * device management code.
402 static inline struct regmap *devm_regmap_init_mmio(struct device *dev,
404 const struct regmap_config *config)
406 return devm_regmap_init_mmio_clk(dev, NULL, regs, config);
409 void regmap_exit(struct regmap *map);
410 int regmap_reinit_cache(struct regmap *map,
411 const struct regmap_config *config);
412 struct regmap *dev_get_regmap(struct device *dev, const char *name);
413 struct device *regmap_get_device(struct regmap *map);
414 int regmap_write(struct regmap *map, unsigned int reg, unsigned int val);
415 int regmap_write_async(struct regmap *map, unsigned int reg, unsigned int val);
416 int regmap_raw_write(struct regmap *map, unsigned int reg,
417 const void *val, size_t val_len);
418 int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
420 int regmap_multi_reg_write(struct regmap *map, const struct reg_default *regs,
422 int regmap_multi_reg_write_bypassed(struct regmap *map,
423 const struct reg_default *regs,
425 int regmap_raw_write_async(struct regmap *map, unsigned int reg,
426 const void *val, size_t val_len);
427 int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val);
428 int regmap_raw_read(struct regmap *map, unsigned int reg,
429 void *val, size_t val_len);
430 int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
432 int regmap_update_bits(struct regmap *map, unsigned int reg,
433 unsigned int mask, unsigned int val);
434 int regmap_write_bits(struct regmap *map, unsigned int reg,
435 unsigned int mask, unsigned int val);
436 int regmap_update_bits_async(struct regmap *map, unsigned int reg,
437 unsigned int mask, unsigned int val);
438 int regmap_update_bits_check(struct regmap *map, unsigned int reg,
439 unsigned int mask, unsigned int val,
441 int regmap_update_bits_check_async(struct regmap *map, unsigned int reg,
442 unsigned int mask, unsigned int val,
444 int regmap_get_val_bytes(struct regmap *map);
445 int regmap_get_max_register(struct regmap *map);
446 int regmap_get_reg_stride(struct regmap *map);
447 int regmap_async_complete(struct regmap *map);
448 bool regmap_can_raw_write(struct regmap *map);
449 size_t regmap_get_raw_read_max(struct regmap *map);
450 size_t regmap_get_raw_write_max(struct regmap *map);
452 int regcache_sync(struct regmap *map);
453 int regcache_sync_region(struct regmap *map, unsigned int min,
455 int regcache_drop_region(struct regmap *map, unsigned int min,
457 void regcache_cache_only(struct regmap *map, bool enable);
458 void regcache_cache_bypass(struct regmap *map, bool enable);
459 void regcache_mark_dirty(struct regmap *map);
461 bool regmap_check_range_table(struct regmap *map, unsigned int reg,
462 const struct regmap_access_table *table);
464 int regmap_register_patch(struct regmap *map, const struct reg_default *regs,
466 int regmap_parse_val(struct regmap *map, const void *buf,
469 static inline bool regmap_reg_in_range(unsigned int reg,
470 const struct regmap_range *range)
472 return reg >= range->range_min && reg <= range->range_max;
475 bool regmap_reg_in_ranges(unsigned int reg,
476 const struct regmap_range *ranges,
477 unsigned int nranges);
480 * Description of an register field
482 * @reg: Offset of the register within the regmap bank
483 * @lsb: lsb of the register field.
484 * @msb: msb of the register field.
485 * @id_size: port size if it has some ports
486 * @id_offset: address offset for each ports
492 unsigned int id_size;
493 unsigned int id_offset;
496 #define REG_FIELD(_reg, _lsb, _msb) { \
502 struct regmap_field *regmap_field_alloc(struct regmap *regmap,
503 struct reg_field reg_field);
504 void regmap_field_free(struct regmap_field *field);
506 struct regmap_field *devm_regmap_field_alloc(struct device *dev,
507 struct regmap *regmap, struct reg_field reg_field);
508 void devm_regmap_field_free(struct device *dev, struct regmap_field *field);
510 int regmap_field_read(struct regmap_field *field, unsigned int *val);
511 int regmap_field_write(struct regmap_field *field, unsigned int val);
512 int regmap_field_update_bits(struct regmap_field *field,
513 unsigned int mask, unsigned int val);
515 int regmap_fields_write(struct regmap_field *field, unsigned int id,
517 int regmap_fields_force_write(struct regmap_field *field, unsigned int id,
519 int regmap_fields_read(struct regmap_field *field, unsigned int id,
521 int regmap_fields_update_bits(struct regmap_field *field, unsigned int id,
522 unsigned int mask, unsigned int val);
525 * Description of an IRQ for the generic regmap irq_chip.
527 * @reg_offset: Offset of the status/mask register within the bank
528 * @mask: Mask used to flag/control the register.
531 unsigned int reg_offset;
536 * Description of a generic regmap irq_chip. This is not intended to
537 * handle every possible interrupt controller, but it should handle a
538 * substantial proportion of those that are found in the wild.
540 * @name: Descriptive name for IRQ controller.
542 * @status_base: Base status register address.
543 * @mask_base: Base mask register address.
544 * @ack_base: Base ack address. If zero then the chip is clear on read.
545 * Using zero value is possible with @use_ack bit.
546 * @wake_base: Base address for wake enables. If zero unsupported.
547 * @irq_reg_stride: Stride to use for chips where registers are not contiguous.
548 * @init_ack_masked: Ack all masked interrupts once during initalization.
549 * @mask_invert: Inverted mask register: cleared bits are masked out.
550 * @use_ack: Use @ack register even if it is zero.
551 * @wake_invert: Inverted wake register: cleared bits are wake enabled.
552 * @runtime_pm: Hold a runtime PM lock on the device when accessing it.
554 * @num_regs: Number of registers in each control bank.
555 * @irqs: Descriptors for individual IRQs. Interrupt numbers are
556 * assigned based on the index in the array of the interrupt.
557 * @num_irqs: Number of descriptors.
559 struct regmap_irq_chip {
562 unsigned int status_base;
563 unsigned int mask_base;
564 unsigned int ack_base;
565 unsigned int wake_base;
566 unsigned int irq_reg_stride;
567 bool init_ack_masked:1;
575 const struct regmap_irq *irqs;
579 struct regmap_irq_chip_data;
581 int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags,
582 int irq_base, const struct regmap_irq_chip *chip,
583 struct regmap_irq_chip_data **data);
584 void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data);
585 int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data);
586 int regmap_irq_get_virq(struct regmap_irq_chip_data *data, int irq);
587 struct irq_domain *regmap_irq_get_domain(struct regmap_irq_chip_data *data);
592 * These stubs should only ever be called by generic code which has
593 * regmap based facilities, if they ever get called at runtime
594 * something is going wrong and something probably needs to select
598 static inline int regmap_write(struct regmap *map, unsigned int reg,
601 WARN_ONCE(1, "regmap API is disabled");
605 static inline int regmap_write_async(struct regmap *map, unsigned int reg,
608 WARN_ONCE(1, "regmap API is disabled");
612 static inline int regmap_raw_write(struct regmap *map, unsigned int reg,
613 const void *val, size_t val_len)
615 WARN_ONCE(1, "regmap API is disabled");
619 static inline int regmap_raw_write_async(struct regmap *map, unsigned int reg,
620 const void *val, size_t val_len)
622 WARN_ONCE(1, "regmap API is disabled");
626 static inline int regmap_bulk_write(struct regmap *map, unsigned int reg,
627 const void *val, size_t val_count)
629 WARN_ONCE(1, "regmap API is disabled");
633 static inline int regmap_read(struct regmap *map, unsigned int reg,
636 WARN_ONCE(1, "regmap API is disabled");
640 static inline int regmap_raw_read(struct regmap *map, unsigned int reg,
641 void *val, size_t val_len)
643 WARN_ONCE(1, "regmap API is disabled");
647 static inline int regmap_bulk_read(struct regmap *map, unsigned int reg,
648 void *val, size_t val_count)
650 WARN_ONCE(1, "regmap API is disabled");
654 static inline int regmap_update_bits(struct regmap *map, unsigned int reg,
655 unsigned int mask, unsigned int val)
657 WARN_ONCE(1, "regmap API is disabled");
661 static inline int regmap_write_bits(struct regmap *map, unsigned int reg,
662 unsigned int mask, unsigned int val)
664 WARN_ONCE(1, "regmap API is disabled");
668 static inline int regmap_update_bits_async(struct regmap *map,
670 unsigned int mask, unsigned int val)
672 WARN_ONCE(1, "regmap API is disabled");
676 static inline int regmap_update_bits_check(struct regmap *map,
678 unsigned int mask, unsigned int val,
681 WARN_ONCE(1, "regmap API is disabled");
685 static inline int regmap_update_bits_check_async(struct regmap *map,
691 WARN_ONCE(1, "regmap API is disabled");
695 static inline int regmap_get_val_bytes(struct regmap *map)
697 WARN_ONCE(1, "regmap API is disabled");
701 static inline int regmap_get_max_register(struct regmap *map)
703 WARN_ONCE(1, "regmap API is disabled");
707 static inline int regmap_get_reg_stride(struct regmap *map)
709 WARN_ONCE(1, "regmap API is disabled");
713 static inline int regcache_sync(struct regmap *map)
715 WARN_ONCE(1, "regmap API is disabled");
719 static inline int regcache_sync_region(struct regmap *map, unsigned int min,
722 WARN_ONCE(1, "regmap API is disabled");
726 static inline int regcache_drop_region(struct regmap *map, unsigned int min,
729 WARN_ONCE(1, "regmap API is disabled");
733 static inline void regcache_cache_only(struct regmap *map, bool enable)
735 WARN_ONCE(1, "regmap API is disabled");
738 static inline void regcache_cache_bypass(struct regmap *map, bool enable)
740 WARN_ONCE(1, "regmap API is disabled");
743 static inline void regcache_mark_dirty(struct regmap *map)
745 WARN_ONCE(1, "regmap API is disabled");
748 static inline void regmap_async_complete(struct regmap *map)
750 WARN_ONCE(1, "regmap API is disabled");
753 static inline int regmap_register_patch(struct regmap *map,
754 const struct reg_default *regs,
757 WARN_ONCE(1, "regmap API is disabled");
761 static inline int regmap_parse_val(struct regmap *map, const void *buf,
764 WARN_ONCE(1, "regmap API is disabled");
768 static inline struct regmap *dev_get_regmap(struct device *dev,
774 static inline struct device *regmap_get_device(struct regmap *map)
776 WARN_ONCE(1, "regmap API is disabled");