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>
24 /* An enum of all the supported cache types */
32 * Default value for a register. We use an array of structs rather
33 * than a simple array as many modern devices have very sparse
36 * @reg: Register address.
37 * @def: Register default value.
47 * Configuration for the register map of a device.
49 * @name: Optional name of the regmap. Useful when a device has multiple
52 * @reg_bits: Number of bits in a register address, mandatory.
53 * @reg_stride: The register address stride. Valid register addresses are a
54 * multiple of this value. If set to 0, a value of 1 will be
56 * @pad_bits: Number of bits of padding between register and value.
57 * @val_bits: Number of bits in a register value, mandatory.
59 * @writeable_reg: Optional callback returning true if the register
61 * @readable_reg: Optional callback returning true if the register
63 * @volatile_reg: Optional callback returning true if the register
64 * value can't be cached.
65 * @precious_reg: Optional callback returning true if the rgister
66 * should not be read outside of a call from the driver
67 * (eg, a clear on read interrupt status register).
69 * @max_register: Optional, specifies the maximum valid register index.
70 * @reg_defaults: Power on reset values for registers (for use with
71 * register cache support).
72 * @num_reg_defaults: Number of elements in reg_defaults.
74 * @read_flag_mask: Mask to be set in the top byte of the register when doing
76 * @write_flag_mask: Mask to be set in the top byte of the register when doing
77 * a write. If both read_flag_mask and write_flag_mask are
78 * empty the regmap_bus default masks are used.
79 * @use_single_rw: If set, converts the bulk read and write operations into
80 * a series of single read and write operations. This is useful
81 * for device that does not support bulk read and write.
83 * @cache_type: The actual cache type.
84 * @reg_defaults_raw: Power on reset values for registers (for use with
85 * register cache support).
86 * @num_reg_defaults_raw: Number of elements in reg_defaults_raw.
88 struct regmap_config
{
96 bool (*writeable_reg
)(struct device
*dev
, unsigned int reg
);
97 bool (*readable_reg
)(struct device
*dev
, unsigned int reg
);
98 bool (*volatile_reg
)(struct device
*dev
, unsigned int reg
);
99 bool (*precious_reg
)(struct device
*dev
, unsigned int reg
);
101 unsigned int max_register
;
102 const struct reg_default
*reg_defaults
;
103 unsigned int num_reg_defaults
;
104 enum regcache_type cache_type
;
105 const void *reg_defaults_raw
;
106 unsigned int num_reg_defaults_raw
;
114 typedef int (*regmap_hw_write
)(void *context
, const void *data
,
116 typedef int (*regmap_hw_gather_write
)(void *context
,
117 const void *reg
, size_t reg_len
,
118 const void *val
, size_t val_len
);
119 typedef int (*regmap_hw_read
)(void *context
,
120 const void *reg_buf
, size_t reg_size
,
121 void *val_buf
, size_t val_size
);
122 typedef void (*regmap_hw_free_context
)(void *context
);
125 * Description of a hardware bus for the register map infrastructure.
127 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
128 * to perform locking.
129 * @write: Write operation.
130 * @gather_write: Write operation with split register/value, return -ENOTSUPP
131 * if not implemented on a given device.
132 * @read: Read operation. Data is returned in the buffer used to transmit
134 * @read_flag_mask: Mask to be set in the top byte of the register when doing
139 regmap_hw_write write
;
140 regmap_hw_gather_write gather_write
;
142 regmap_hw_free_context free_context
;
146 struct regmap
*regmap_init(struct device
*dev
,
147 const struct regmap_bus
*bus
,
149 const struct regmap_config
*config
);
150 struct regmap
*regmap_init_i2c(struct i2c_client
*i2c
,
151 const struct regmap_config
*config
);
152 struct regmap
*regmap_init_spi(struct spi_device
*dev
,
153 const struct regmap_config
*config
);
154 struct regmap
*regmap_init_mmio(struct device
*dev
,
156 const struct regmap_config
*config
);
158 struct regmap
*devm_regmap_init(struct device
*dev
,
159 const struct regmap_bus
*bus
,
161 const struct regmap_config
*config
);
162 struct regmap
*devm_regmap_init_i2c(struct i2c_client
*i2c
,
163 const struct regmap_config
*config
);
164 struct regmap
*devm_regmap_init_spi(struct spi_device
*dev
,
165 const struct regmap_config
*config
);
166 struct regmap
*devm_regmap_init_mmio(struct device
*dev
,
168 const struct regmap_config
*config
);
170 void regmap_exit(struct regmap
*map
);
171 int regmap_reinit_cache(struct regmap
*map
,
172 const struct regmap_config
*config
);
173 struct regmap
*dev_get_regmap(struct device
*dev
, const char *name
);
174 int regmap_write(struct regmap
*map
, unsigned int reg
, unsigned int val
);
175 int regmap_raw_write(struct regmap
*map
, unsigned int reg
,
176 const void *val
, size_t val_len
);
177 int regmap_bulk_write(struct regmap
*map
, unsigned int reg
, const void *val
,
179 int regmap_read(struct regmap
*map
, unsigned int reg
, unsigned int *val
);
180 int regmap_raw_read(struct regmap
*map
, unsigned int reg
,
181 void *val
, size_t val_len
);
182 int regmap_bulk_read(struct regmap
*map
, unsigned int reg
, void *val
,
184 int regmap_update_bits(struct regmap
*map
, unsigned int reg
,
185 unsigned int mask
, unsigned int val
);
186 int regmap_update_bits_check(struct regmap
*map
, unsigned int reg
,
187 unsigned int mask
, unsigned int val
,
189 int regmap_get_val_bytes(struct regmap
*map
);
191 int regcache_sync(struct regmap
*map
);
192 int regcache_sync_region(struct regmap
*map
, unsigned int min
,
194 void regcache_cache_only(struct regmap
*map
, bool enable
);
195 void regcache_cache_bypass(struct regmap
*map
, bool enable
);
196 void regcache_mark_dirty(struct regmap
*map
);
198 int regmap_register_patch(struct regmap
*map
, const struct reg_default
*regs
,
202 * Description of an IRQ for the generic regmap irq_chip.
204 * @reg_offset: Offset of the status/mask register within the bank
205 * @mask: Mask used to flag/control the register.
208 unsigned int reg_offset
;
213 * Description of a generic regmap irq_chip. This is not intended to
214 * handle every possible interrupt controller, but it should handle a
215 * substantial proportion of those that are found in the wild.
217 * @name: Descriptive name for IRQ controller.
219 * @status_base: Base status register address.
220 * @mask_base: Base mask register address.
221 * @ack_base: Base ack address. If zero then the chip is clear on read.
222 * @irq_reg_stride: Stride to use for chips where registers are not contiguous.
224 * @num_regs: Number of registers in each control bank.
225 * @irqs: Descriptors for individual IRQs. Interrupt numbers are
226 * assigned based on the index in the array of the interrupt.
227 * @num_irqs: Number of descriptors.
229 struct regmap_irq_chip
{
232 unsigned int status_base
;
233 unsigned int mask_base
;
234 unsigned int ack_base
;
235 unsigned int irq_reg_stride
;
239 const struct regmap_irq
*irqs
;
243 struct regmap_irq_chip_data
;
245 int regmap_add_irq_chip(struct regmap
*map
, int irq
, int irq_flags
,
246 int irq_base
, struct regmap_irq_chip
*chip
,
247 struct regmap_irq_chip_data
**data
);
248 void regmap_del_irq_chip(int irq
, struct regmap_irq_chip_data
*data
);
249 int regmap_irq_chip_get_base(struct regmap_irq_chip_data
*data
);
250 int regmap_irq_get_virq(struct regmap_irq_chip_data
*data
, int irq
);
255 * These stubs should only ever be called by generic code which has
256 * regmap based facilities, if they ever get called at runtime
257 * something is going wrong and something probably needs to select
261 static inline int regmap_write(struct regmap
*map
, unsigned int reg
,
264 WARN_ONCE(1, "regmap API is disabled");
268 static inline int regmap_raw_write(struct regmap
*map
, unsigned int reg
,
269 const void *val
, size_t val_len
)
271 WARN_ONCE(1, "regmap API is disabled");
275 static inline int regmap_bulk_write(struct regmap
*map
, unsigned int reg
,
276 const void *val
, size_t val_count
)
278 WARN_ONCE(1, "regmap API is disabled");
282 static inline int regmap_read(struct regmap
*map
, unsigned int reg
,
285 WARN_ONCE(1, "regmap API is disabled");
289 static inline int regmap_raw_read(struct regmap
*map
, unsigned int reg
,
290 void *val
, size_t val_len
)
292 WARN_ONCE(1, "regmap API is disabled");
296 static inline int regmap_bulk_read(struct regmap
*map
, unsigned int reg
,
297 void *val
, size_t val_count
)
299 WARN_ONCE(1, "regmap API is disabled");
303 static inline int regmap_update_bits(struct regmap
*map
, unsigned int reg
,
304 unsigned int mask
, unsigned int val
)
306 WARN_ONCE(1, "regmap API is disabled");
310 static inline int regmap_update_bits_check(struct regmap
*map
,
312 unsigned int mask
, unsigned int val
,
315 WARN_ONCE(1, "regmap API is disabled");
319 static inline int regmap_get_val_bytes(struct regmap
*map
)
321 WARN_ONCE(1, "regmap API is disabled");
325 static inline int regcache_sync(struct regmap
*map
)
327 WARN_ONCE(1, "regmap API is disabled");
331 static inline int regcache_sync_region(struct regmap
*map
, unsigned int min
,
334 WARN_ONCE(1, "regmap API is disabled");
338 static inline void regcache_cache_only(struct regmap
*map
, bool enable
)
340 WARN_ONCE(1, "regmap API is disabled");
343 static inline void regcache_cache_bypass(struct regmap
*map
, bool enable
)
345 WARN_ONCE(1, "regmap API is disabled");
348 static inline void regcache_mark_dirty(struct regmap
*map
)
350 WARN_ONCE(1, "regmap API is disabled");
353 static inline int regmap_register_patch(struct regmap
*map
,
354 const struct reg_default
*regs
,
357 WARN_ONCE(1, "regmap API is disabled");
361 static inline struct regmap
*dev_get_regmap(struct device
*dev
,
364 WARN_ONCE(1, "regmap API is disabled");