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
;
31 /* An enum of all the supported cache types */
40 * Default value for a register. We use an array of structs rather
41 * than a simple array as many modern devices have very sparse
44 * @reg: Register address.
45 * @def: Register default value.
55 /* Unspecified -> 0 -> Backwards compatible default */
56 REGMAP_ENDIAN_DEFAULT
= 0,
63 * A register range, used for access related checks
64 * (readable/writeable/volatile/precious checks)
66 * @range_min: address of first register
67 * @range_max: address of last register
70 unsigned int range_min
;
71 unsigned int range_max
;
74 #define regmap_reg_range(low, high) { .range_min = low, .range_max = high, }
77 * A table of ranges including some yes ranges and some no ranges.
78 * If a register belongs to a no_range, the corresponding check function
79 * will return false. If a register belongs to a yes range, the corresponding
80 * check function will return true. "no_ranges" are searched first.
82 * @yes_ranges : pointer to an array of regmap ranges used as "yes ranges"
83 * @n_yes_ranges: size of the above array
84 * @no_ranges: pointer to an array of regmap ranges used as "no ranges"
85 * @n_no_ranges: size of the above array
87 struct regmap_access_table
{
88 const struct regmap_range
*yes_ranges
;
89 unsigned int n_yes_ranges
;
90 const struct regmap_range
*no_ranges
;
91 unsigned int n_no_ranges
;
94 typedef void (*regmap_lock
)(void *);
95 typedef void (*regmap_unlock
)(void *);
98 * Configuration for the register map of a device.
100 * @name: Optional name of the regmap. Useful when a device has multiple
103 * @reg_bits: Number of bits in a register address, mandatory.
104 * @reg_stride: The register address stride. Valid register addresses are a
105 * multiple of this value. If set to 0, a value of 1 will be
107 * @pad_bits: Number of bits of padding between register and value.
108 * @val_bits: Number of bits in a register value, mandatory.
110 * @writeable_reg: Optional callback returning true if the register
111 * can be written to. If this field is NULL but wr_table
112 * (see below) is not, the check is performed on such table
113 * (a register is writeable if it belongs to one of the ranges
114 * specified by wr_table).
115 * @readable_reg: Optional callback returning true if the register
116 * can be read from. If this field is NULL but rd_table
117 * (see below) is not, the check is performed on such table
118 * (a register is readable if it belongs to one of the ranges
119 * specified by rd_table).
120 * @volatile_reg: Optional callback returning true if the register
121 * value can't be cached. If this field is NULL but
122 * volatile_table (see below) is not, the check is performed on
123 * such table (a register is volatile if it belongs to one of
124 * the ranges specified by volatile_table).
125 * @precious_reg: Optional callback returning true if the register
126 * should not be read outside of a call from the driver
127 * (e.g., a clear on read interrupt status register). If this
128 * field is NULL but precious_table (see below) is not, the
129 * check is performed on such table (a register is precious if
130 * it belongs to one of the ranges specified by precious_table).
131 * @lock: Optional lock callback (overrides regmap's default lock
132 * function, based on spinlock or mutex).
133 * @unlock: As above for unlocking.
134 * @lock_arg: this field is passed as the only argument of lock/unlock
135 * functions (ignored in case regular lock/unlock functions
136 * are not overridden).
137 * @reg_read: Optional callback that if filled will be used to perform
138 * all the reads from the registers. Should only be provided for
139 * devices whose read operation cannot be represented as a simple
140 * read operation on a bus such as SPI, I2C, etc. Most of the
141 * devices do not need this.
142 * @reg_write: Same as above for writing.
143 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
144 * to perform locking. This field is ignored if custom lock/unlock
145 * functions are used (see fields lock/unlock of struct regmap_config).
146 * This field is a duplicate of a similar file in
147 * 'struct regmap_bus' and serves exact same purpose.
148 * Use it only for "no-bus" cases.
149 * @max_register: Optional, specifies the maximum valid register index.
150 * @wr_table: Optional, points to a struct regmap_access_table specifying
151 * valid ranges for write access.
152 * @rd_table: As above, for read access.
153 * @volatile_table: As above, for volatile registers.
154 * @precious_table: As above, for precious registers.
155 * @reg_defaults: Power on reset values for registers (for use with
156 * register cache support).
157 * @num_reg_defaults: Number of elements in reg_defaults.
159 * @read_flag_mask: Mask to be set in the top byte of the register when doing
161 * @write_flag_mask: Mask to be set in the top byte of the register when doing
162 * a write. If both read_flag_mask and write_flag_mask are
163 * empty the regmap_bus default masks are used.
164 * @use_single_rw: If set, converts the bulk read and write operations into
165 * a series of single read and write operations. This is useful
166 * for device that does not support bulk read and write.
167 * @can_multi_write: If set, the device supports the multi write mode of bulk
168 * write operations, if clear multi write requests will be
169 * split into individual write operations
171 * @cache_type: The actual cache type.
172 * @reg_defaults_raw: Power on reset values for registers (for use with
173 * register cache support).
174 * @num_reg_defaults_raw: Number of elements in reg_defaults_raw.
175 * @reg_format_endian: Endianness for formatted register addresses. If this is
176 * DEFAULT, the @reg_format_endian_default value from the
177 * regmap bus is used.
178 * @val_format_endian: Endianness for formatted register values. If this is
179 * DEFAULT, the @reg_format_endian_default value from the
180 * regmap bus is used.
182 * @ranges: Array of configuration entries for virtual address ranges.
183 * @num_ranges: Number of range configuration entries.
185 struct regmap_config
{
193 bool (*writeable_reg
)(struct device
*dev
, unsigned int reg
);
194 bool (*readable_reg
)(struct device
*dev
, unsigned int reg
);
195 bool (*volatile_reg
)(struct device
*dev
, unsigned int reg
);
196 bool (*precious_reg
)(struct device
*dev
, unsigned int reg
);
198 regmap_unlock unlock
;
201 int (*reg_read
)(void *context
, unsigned int reg
, unsigned int *val
);
202 int (*reg_write
)(void *context
, unsigned int reg
, unsigned int val
);
206 unsigned int max_register
;
207 const struct regmap_access_table
*wr_table
;
208 const struct regmap_access_table
*rd_table
;
209 const struct regmap_access_table
*volatile_table
;
210 const struct regmap_access_table
*precious_table
;
211 const struct reg_default
*reg_defaults
;
212 unsigned int num_reg_defaults
;
213 enum regcache_type cache_type
;
214 const void *reg_defaults_raw
;
215 unsigned int num_reg_defaults_raw
;
221 bool can_multi_write
;
223 enum regmap_endian reg_format_endian
;
224 enum regmap_endian val_format_endian
;
226 const struct regmap_range_cfg
*ranges
;
227 unsigned int num_ranges
;
231 * Configuration for indirectly accessed or paged registers.
232 * Registers, mapped to this virtual range, are accessed in two steps:
233 * 1. page selector register update;
234 * 2. access through data window registers.
236 * @name: Descriptive name for diagnostics
238 * @range_min: Address of the lowest register address in virtual range.
239 * @range_max: Address of the highest register in virtual range.
241 * @page_sel_reg: Register with selector field.
242 * @page_sel_mask: Bit shift for selector value.
243 * @page_sel_shift: Bit mask for selector value.
245 * @window_start: Address of first (lowest) register in data window.
246 * @window_len: Number of registers in data window.
248 struct regmap_range_cfg
{
251 /* Registers of virtual address range */
252 unsigned int range_min
;
253 unsigned int range_max
;
255 /* Page selector for indirect addressing */
256 unsigned int selector_reg
;
257 unsigned int selector_mask
;
260 /* Data window (per each page) */
261 unsigned int window_start
;
262 unsigned int window_len
;
267 typedef int (*regmap_hw_write
)(void *context
, const void *data
,
269 typedef int (*regmap_hw_gather_write
)(void *context
,
270 const void *reg
, size_t reg_len
,
271 const void *val
, size_t val_len
);
272 typedef int (*regmap_hw_async_write
)(void *context
,
273 const void *reg
, size_t reg_len
,
274 const void *val
, size_t val_len
,
275 struct regmap_async
*async
);
276 typedef int (*regmap_hw_read
)(void *context
,
277 const void *reg_buf
, size_t reg_size
,
278 void *val_buf
, size_t val_size
);
279 typedef int (*regmap_hw_reg_read
)(void *context
, unsigned int reg
,
281 typedef int (*regmap_hw_reg_write
)(void *context
, unsigned int reg
,
283 typedef struct regmap_async
*(*regmap_hw_async_alloc
)(void);
284 typedef void (*regmap_hw_free_context
)(void *context
);
287 * Description of a hardware bus for the register map infrastructure.
289 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
290 * to perform locking. This field is ignored if custom lock/unlock
291 * functions are used (see fields lock/unlock of
292 * struct regmap_config).
293 * @write: Write operation.
294 * @gather_write: Write operation with split register/value, return -ENOTSUPP
295 * if not implemented on a given device.
296 * @async_write: Write operation which completes asynchronously, optional and
297 * must serialise with respect to non-async I/O.
298 * @read: Read operation. Data is returned in the buffer used to transmit
300 * @async_alloc: Allocate a regmap_async() structure.
301 * @read_flag_mask: Mask to be set in the top byte of the register when doing
303 * @reg_format_endian_default: Default endianness for formatted register
304 * addresses. Used when the regmap_config specifies DEFAULT. If this is
305 * DEFAULT, BIG is assumed.
306 * @val_format_endian_default: Default endianness for formatted register
307 * values. Used when the regmap_config specifies DEFAULT. If this is
308 * DEFAULT, BIG is assumed.
309 * @async_size: Size of struct used for async work.
313 regmap_hw_write write
;
314 regmap_hw_gather_write gather_write
;
315 regmap_hw_async_write async_write
;
316 regmap_hw_reg_write reg_write
;
318 regmap_hw_reg_read reg_read
;
319 regmap_hw_free_context free_context
;
320 regmap_hw_async_alloc async_alloc
;
322 enum regmap_endian reg_format_endian_default
;
323 enum regmap_endian val_format_endian_default
;
326 struct regmap
*regmap_init(struct device
*dev
,
327 const struct regmap_bus
*bus
,
329 const struct regmap_config
*config
);
330 int regmap_attach_dev(struct device
*dev
, struct regmap
*map
,
331 const struct regmap_config
*config
);
332 struct regmap
*regmap_init_i2c(struct i2c_client
*i2c
,
333 const struct regmap_config
*config
);
334 struct regmap
*regmap_init_spi(struct spi_device
*dev
,
335 const struct regmap_config
*config
);
336 struct regmap
*regmap_init_spmi_base(struct spmi_device
*dev
,
337 const struct regmap_config
*config
);
338 struct regmap
*regmap_init_spmi_ext(struct spmi_device
*dev
,
339 const struct regmap_config
*config
);
340 struct regmap
*regmap_init_mmio_clk(struct device
*dev
, const char *clk_id
,
342 const struct regmap_config
*config
);
344 struct regmap
*devm_regmap_init(struct device
*dev
,
345 const struct regmap_bus
*bus
,
347 const struct regmap_config
*config
);
348 struct regmap
*devm_regmap_init_i2c(struct i2c_client
*i2c
,
349 const struct regmap_config
*config
);
350 struct regmap
*devm_regmap_init_spi(struct spi_device
*dev
,
351 const struct regmap_config
*config
);
352 struct regmap
*devm_regmap_init_spmi_base(struct spmi_device
*dev
,
353 const struct regmap_config
*config
);
354 struct regmap
*devm_regmap_init_spmi_ext(struct spmi_device
*dev
,
355 const struct regmap_config
*config
);
356 struct regmap
*devm_regmap_init_mmio_clk(struct device
*dev
, const char *clk_id
,
358 const struct regmap_config
*config
);
361 * regmap_init_mmio(): Initialise register map
363 * @dev: Device that will be interacted with
364 * @regs: Pointer to memory-mapped IO region
365 * @config: Configuration for register map
367 * The return value will be an ERR_PTR() on error or a valid pointer to
370 static inline struct regmap
*regmap_init_mmio(struct device
*dev
,
372 const struct regmap_config
*config
)
374 return regmap_init_mmio_clk(dev
, NULL
, regs
, config
);
378 * devm_regmap_init_mmio(): Initialise managed register map
380 * @dev: Device that will be interacted with
381 * @regs: Pointer to memory-mapped IO region
382 * @config: Configuration for register map
384 * The return value will be an ERR_PTR() on error or a valid pointer
385 * to a struct regmap. The regmap will be automatically freed by the
386 * device management code.
388 static inline struct regmap
*devm_regmap_init_mmio(struct device
*dev
,
390 const struct regmap_config
*config
)
392 return devm_regmap_init_mmio_clk(dev
, NULL
, regs
, config
);
395 void regmap_exit(struct regmap
*map
);
396 int regmap_reinit_cache(struct regmap
*map
,
397 const struct regmap_config
*config
);
398 struct regmap
*dev_get_regmap(struct device
*dev
, const char *name
);
399 struct device
*regmap_get_device(struct regmap
*map
);
400 int regmap_write(struct regmap
*map
, unsigned int reg
, unsigned int val
);
401 int regmap_write_async(struct regmap
*map
, unsigned int reg
, unsigned int val
);
402 int regmap_raw_write(struct regmap
*map
, unsigned int reg
,
403 const void *val
, size_t val_len
);
404 int regmap_bulk_write(struct regmap
*map
, unsigned int reg
, const void *val
,
406 int regmap_multi_reg_write(struct regmap
*map
, const struct reg_default
*regs
,
408 int regmap_multi_reg_write_bypassed(struct regmap
*map
,
409 const struct reg_default
*regs
,
411 int regmap_raw_write_async(struct regmap
*map
, unsigned int reg
,
412 const void *val
, size_t val_len
);
413 int regmap_read(struct regmap
*map
, unsigned int reg
, unsigned int *val
);
414 int regmap_raw_read(struct regmap
*map
, unsigned int reg
,
415 void *val
, size_t val_len
);
416 int regmap_bulk_read(struct regmap
*map
, unsigned int reg
, void *val
,
418 int regmap_update_bits(struct regmap
*map
, unsigned int reg
,
419 unsigned int mask
, unsigned int val
);
420 int regmap_update_bits_async(struct regmap
*map
, unsigned int reg
,
421 unsigned int mask
, unsigned int val
);
422 int regmap_update_bits_check(struct regmap
*map
, unsigned int reg
,
423 unsigned int mask
, unsigned int val
,
425 int regmap_update_bits_check_async(struct regmap
*map
, unsigned int reg
,
426 unsigned int mask
, unsigned int val
,
428 int regmap_get_val_bytes(struct regmap
*map
);
429 int regmap_async_complete(struct regmap
*map
);
430 bool regmap_can_raw_write(struct regmap
*map
);
432 int regcache_sync(struct regmap
*map
);
433 int regcache_sync_region(struct regmap
*map
, unsigned int min
,
435 int regcache_drop_region(struct regmap
*map
, unsigned int min
,
437 void regcache_cache_only(struct regmap
*map
, bool enable
);
438 void regcache_cache_bypass(struct regmap
*map
, bool enable
);
439 void regcache_mark_dirty(struct regmap
*map
);
441 bool regmap_check_range_table(struct regmap
*map
, unsigned int reg
,
442 const struct regmap_access_table
*table
);
444 int regmap_register_patch(struct regmap
*map
, const struct reg_default
*regs
,
446 int regmap_parse_val(struct regmap
*map
, const void *buf
,
449 static inline bool regmap_reg_in_range(unsigned int reg
,
450 const struct regmap_range
*range
)
452 return reg
>= range
->range_min
&& reg
<= range
->range_max
;
455 bool regmap_reg_in_ranges(unsigned int reg
,
456 const struct regmap_range
*ranges
,
457 unsigned int nranges
);
460 * Description of an register field
462 * @reg: Offset of the register within the regmap bank
463 * @lsb: lsb of the register field.
464 * @reg: msb of the register field.
465 * @id_size: port size if it has some ports
466 * @id_offset: address offset for each ports
472 unsigned int id_size
;
473 unsigned int id_offset
;
476 #define REG_FIELD(_reg, _lsb, _msb) { \
482 struct regmap_field
*regmap_field_alloc(struct regmap
*regmap
,
483 struct reg_field reg_field
);
484 void regmap_field_free(struct regmap_field
*field
);
486 struct regmap_field
*devm_regmap_field_alloc(struct device
*dev
,
487 struct regmap
*regmap
, struct reg_field reg_field
);
488 void devm_regmap_field_free(struct device
*dev
, struct regmap_field
*field
);
490 int regmap_field_read(struct regmap_field
*field
, unsigned int *val
);
491 int regmap_field_write(struct regmap_field
*field
, unsigned int val
);
492 int regmap_field_update_bits(struct regmap_field
*field
,
493 unsigned int mask
, unsigned int val
);
495 int regmap_fields_write(struct regmap_field
*field
, unsigned int id
,
497 int regmap_fields_read(struct regmap_field
*field
, unsigned int id
,
499 int regmap_fields_update_bits(struct regmap_field
*field
, unsigned int id
,
500 unsigned int mask
, unsigned int val
);
503 * Description of an IRQ for the generic regmap irq_chip.
505 * @reg_offset: Offset of the status/mask register within the bank
506 * @mask: Mask used to flag/control the register.
509 unsigned int reg_offset
;
514 * Description of a generic regmap irq_chip. This is not intended to
515 * handle every possible interrupt controller, but it should handle a
516 * substantial proportion of those that are found in the wild.
518 * @name: Descriptive name for IRQ controller.
520 * @status_base: Base status register address.
521 * @mask_base: Base mask register address.
522 * @ack_base: Base ack address. If zero then the chip is clear on read.
523 * Using zero value is possible with @use_ack bit.
524 * @wake_base: Base address for wake enables. If zero unsupported.
525 * @irq_reg_stride: Stride to use for chips where registers are not contiguous.
526 * @init_ack_masked: Ack all masked interrupts once during initalization.
527 * @mask_invert: Inverted mask register: cleared bits are masked out.
528 * @use_ack: Use @ack register even if it is zero.
529 * @wake_invert: Inverted wake register: cleared bits are wake enabled.
530 * @runtime_pm: Hold a runtime PM lock on the device when accessing it.
532 * @num_regs: Number of registers in each control bank.
533 * @irqs: Descriptors for individual IRQs. Interrupt numbers are
534 * assigned based on the index in the array of the interrupt.
535 * @num_irqs: Number of descriptors.
537 struct regmap_irq_chip
{
540 unsigned int status_base
;
541 unsigned int mask_base
;
542 unsigned int ack_base
;
543 unsigned int wake_base
;
544 unsigned int irq_reg_stride
;
545 bool init_ack_masked
:1;
553 const struct regmap_irq
*irqs
;
557 struct regmap_irq_chip_data
;
559 int regmap_add_irq_chip(struct regmap
*map
, int irq
, int irq_flags
,
560 int irq_base
, const struct regmap_irq_chip
*chip
,
561 struct regmap_irq_chip_data
**data
);
562 void regmap_del_irq_chip(int irq
, struct regmap_irq_chip_data
*data
);
563 int regmap_irq_chip_get_base(struct regmap_irq_chip_data
*data
);
564 int regmap_irq_get_virq(struct regmap_irq_chip_data
*data
, int irq
);
565 struct irq_domain
*regmap_irq_get_domain(struct regmap_irq_chip_data
*data
);
570 * These stubs should only ever be called by generic code which has
571 * regmap based facilities, if they ever get called at runtime
572 * something is going wrong and something probably needs to select
576 static inline int regmap_write(struct regmap
*map
, unsigned int reg
,
579 WARN_ONCE(1, "regmap API is disabled");
583 static inline int regmap_write_async(struct regmap
*map
, unsigned int reg
,
586 WARN_ONCE(1, "regmap API is disabled");
590 static inline int regmap_raw_write(struct regmap
*map
, unsigned int reg
,
591 const void *val
, size_t val_len
)
593 WARN_ONCE(1, "regmap API is disabled");
597 static inline int regmap_raw_write_async(struct regmap
*map
, unsigned int reg
,
598 const void *val
, size_t val_len
)
600 WARN_ONCE(1, "regmap API is disabled");
604 static inline int regmap_bulk_write(struct regmap
*map
, unsigned int reg
,
605 const void *val
, size_t val_count
)
607 WARN_ONCE(1, "regmap API is disabled");
611 static inline int regmap_read(struct regmap
*map
, unsigned int reg
,
614 WARN_ONCE(1, "regmap API is disabled");
618 static inline int regmap_raw_read(struct regmap
*map
, unsigned int reg
,
619 void *val
, size_t val_len
)
621 WARN_ONCE(1, "regmap API is disabled");
625 static inline int regmap_bulk_read(struct regmap
*map
, unsigned int reg
,
626 void *val
, size_t val_count
)
628 WARN_ONCE(1, "regmap API is disabled");
632 static inline int regmap_update_bits(struct regmap
*map
, unsigned int reg
,
633 unsigned int mask
, unsigned int val
)
635 WARN_ONCE(1, "regmap API is disabled");
639 static inline int regmap_update_bits_async(struct regmap
*map
,
641 unsigned int mask
, unsigned int val
)
643 WARN_ONCE(1, "regmap API is disabled");
647 static inline int regmap_update_bits_check(struct regmap
*map
,
649 unsigned int mask
, unsigned int val
,
652 WARN_ONCE(1, "regmap API is disabled");
656 static inline int regmap_update_bits_check_async(struct regmap
*map
,
662 WARN_ONCE(1, "regmap API is disabled");
666 static inline int regmap_get_val_bytes(struct regmap
*map
)
668 WARN_ONCE(1, "regmap API is disabled");
672 static inline int regcache_sync(struct regmap
*map
)
674 WARN_ONCE(1, "regmap API is disabled");
678 static inline int regcache_sync_region(struct regmap
*map
, unsigned int min
,
681 WARN_ONCE(1, "regmap API is disabled");
685 static inline int regcache_drop_region(struct regmap
*map
, unsigned int min
,
688 WARN_ONCE(1, "regmap API is disabled");
692 static inline void regcache_cache_only(struct regmap
*map
, bool enable
)
694 WARN_ONCE(1, "regmap API is disabled");
697 static inline void regcache_cache_bypass(struct regmap
*map
, bool enable
)
699 WARN_ONCE(1, "regmap API is disabled");
702 static inline void regcache_mark_dirty(struct regmap
*map
)
704 WARN_ONCE(1, "regmap API is disabled");
707 static inline void regmap_async_complete(struct regmap
*map
)
709 WARN_ONCE(1, "regmap API is disabled");
712 static inline int regmap_register_patch(struct regmap
*map
,
713 const struct reg_default
*regs
,
716 WARN_ONCE(1, "regmap API is disabled");
720 static inline int regmap_parse_val(struct regmap
*map
, const void *buf
,
723 WARN_ONCE(1, "regmap API is disabled");
727 static inline struct regmap
*dev_get_regmap(struct device
*dev
,
733 static inline struct device
*regmap_get_device(struct regmap
*map
)
735 WARN_ONCE(1, "regmap API is disabled");