Commit | Line | Data |
---|---|---|
b83a313b MB |
1 | #ifndef __LINUX_REGMAP_H |
2 | #define __LINUX_REGMAP_H | |
3 | ||
4 | /* | |
5 | * Register map access API | |
6 | * | |
7 | * Copyright 2011 Wolfson Microelectronics plc | |
8 | * | |
9 | * Author: Mark Brown <broonie@opensource.wolfsonmicro.com> | |
10 | * | |
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. | |
14 | */ | |
15 | ||
b83a313b | 16 | #include <linux/list.h> |
b83a313b | 17 | |
de477254 | 18 | struct module; |
313162d0 | 19 | struct device; |
9943fa30 | 20 | struct i2c_client; |
a676f083 | 21 | struct spi_device; |
b83d2ff0 | 22 | struct regmap; |
9943fa30 | 23 | |
9fabe24e DP |
24 | /* An enum of all the supported cache types */ |
25 | enum regcache_type { | |
26 | REGCACHE_NONE, | |
28644c80 | 27 | REGCACHE_RBTREE, |
50b776fc | 28 | REGCACHE_COMPRESSED |
9fabe24e DP |
29 | }; |
30 | ||
bd20eb54 MB |
31 | /** |
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 | |
34 | * register maps. | |
35 | * | |
36 | * @reg: Register address. | |
37 | * @def: Register default value. | |
38 | */ | |
39 | struct reg_default { | |
40 | unsigned int reg; | |
41 | unsigned int def; | |
42 | }; | |
43 | ||
b83d2ff0 MB |
44 | #ifdef CONFIG_REGMAP |
45 | ||
dd898b20 MB |
46 | /** |
47 | * Configuration for the register map of a device. | |
48 | * | |
d3c242e1 SW |
49 | * @name: Optional name of the regmap. Useful when a device has multiple |
50 | * register regions. | |
51 | * | |
dd898b20 | 52 | * @reg_bits: Number of bits in a register address, mandatory. |
82159ba8 | 53 | * @pad_bits: Number of bits of padding between register and value. |
dd898b20 | 54 | * @val_bits: Number of bits in a register value, mandatory. |
2e2ae66d | 55 | * |
3566cc9d MB |
56 | * @writeable_reg: Optional callback returning true if the register |
57 | * can be written to. | |
58 | * @readable_reg: Optional callback returning true if the register | |
59 | * can be read from. | |
60 | * @volatile_reg: Optional callback returning true if the register | |
61 | * value can't be cached. | |
62 | * @precious_reg: Optional callback returning true if the rgister | |
63 | * should not be read outside of a call from the driver | |
64 | * (eg, a clear on read interrupt status register). | |
bd20eb54 MB |
65 | * |
66 | * @max_register: Optional, specifies the maximum valid register index. | |
67 | * @reg_defaults: Power on reset values for registers (for use with | |
68 | * register cache support). | |
69 | * @num_reg_defaults: Number of elements in reg_defaults. | |
6f306441 LPC |
70 | * |
71 | * @read_flag_mask: Mask to be set in the top byte of the register when doing | |
72 | * a read. | |
73 | * @write_flag_mask: Mask to be set in the top byte of the register when doing | |
74 | * a write. If both read_flag_mask and write_flag_mask are | |
75 | * empty the regmap_bus default masks are used. | |
9fabe24e DP |
76 | * |
77 | * @cache_type: The actual cache type. | |
78 | * @reg_defaults_raw: Power on reset values for registers (for use with | |
79 | * register cache support). | |
80 | * @num_reg_defaults_raw: Number of elements in reg_defaults_raw. | |
dd898b20 | 81 | */ |
b83a313b | 82 | struct regmap_config { |
d3c242e1 SW |
83 | const char *name; |
84 | ||
b83a313b | 85 | int reg_bits; |
82159ba8 | 86 | int pad_bits; |
b83a313b | 87 | int val_bits; |
2e2ae66d | 88 | |
2e2ae66d MB |
89 | bool (*writeable_reg)(struct device *dev, unsigned int reg); |
90 | bool (*readable_reg)(struct device *dev, unsigned int reg); | |
91 | bool (*volatile_reg)(struct device *dev, unsigned int reg); | |
18694886 | 92 | bool (*precious_reg)(struct device *dev, unsigned int reg); |
bd20eb54 MB |
93 | |
94 | unsigned int max_register; | |
720e4616 | 95 | const struct reg_default *reg_defaults; |
9fabe24e DP |
96 | unsigned int num_reg_defaults; |
97 | enum regcache_type cache_type; | |
98 | const void *reg_defaults_raw; | |
99 | unsigned int num_reg_defaults_raw; | |
6f306441 LPC |
100 | |
101 | u8 read_flag_mask; | |
102 | u8 write_flag_mask; | |
b83a313b MB |
103 | }; |
104 | ||
0135bbcc | 105 | typedef int (*regmap_hw_write)(void *context, const void *data, |
b83a313b | 106 | size_t count); |
0135bbcc | 107 | typedef int (*regmap_hw_gather_write)(void *context, |
b83a313b MB |
108 | const void *reg, size_t reg_len, |
109 | const void *val, size_t val_len); | |
0135bbcc | 110 | typedef int (*regmap_hw_read)(void *context, |
b83a313b MB |
111 | const void *reg_buf, size_t reg_size, |
112 | void *val_buf, size_t val_size); | |
0135bbcc | 113 | typedef void (*regmap_hw_free_context)(void *context); |
b83a313b MB |
114 | |
115 | /** | |
116 | * Description of a hardware bus for the register map infrastructure. | |
117 | * | |
bacdbe07 SW |
118 | * @fast_io: Register IO is fast. Use a spinlock instead of a mutex |
119 | * to perform locking. | |
b83a313b MB |
120 | * @write: Write operation. |
121 | * @gather_write: Write operation with split register/value, return -ENOTSUPP | |
122 | * if not implemented on a given device. | |
123 | * @read: Read operation. Data is returned in the buffer used to transmit | |
124 | * data. | |
b83a313b MB |
125 | * @read_flag_mask: Mask to be set in the top byte of the register when doing |
126 | * a read. | |
127 | */ | |
128 | struct regmap_bus { | |
bacdbe07 | 129 | bool fast_io; |
b83a313b MB |
130 | regmap_hw_write write; |
131 | regmap_hw_gather_write gather_write; | |
132 | regmap_hw_read read; | |
0135bbcc | 133 | regmap_hw_free_context free_context; |
b83a313b MB |
134 | u8 read_flag_mask; |
135 | }; | |
136 | ||
137 | struct regmap *regmap_init(struct device *dev, | |
138 | const struct regmap_bus *bus, | |
0135bbcc | 139 | void *bus_context, |
b83a313b | 140 | const struct regmap_config *config); |
9943fa30 MB |
141 | struct regmap *regmap_init_i2c(struct i2c_client *i2c, |
142 | const struct regmap_config *config); | |
a676f083 MB |
143 | struct regmap *regmap_init_spi(struct spi_device *dev, |
144 | const struct regmap_config *config); | |
45f5ff81 SW |
145 | struct regmap *regmap_init_mmio(struct device *dev, |
146 | void __iomem *regs, | |
147 | const struct regmap_config *config); | |
a676f083 | 148 | |
c0eb4676 MB |
149 | struct regmap *devm_regmap_init(struct device *dev, |
150 | const struct regmap_bus *bus, | |
0135bbcc | 151 | void *bus_context, |
c0eb4676 MB |
152 | const struct regmap_config *config); |
153 | struct regmap *devm_regmap_init_i2c(struct i2c_client *i2c, | |
154 | const struct regmap_config *config); | |
155 | struct regmap *devm_regmap_init_spi(struct spi_device *dev, | |
156 | const struct regmap_config *config); | |
45f5ff81 SW |
157 | struct regmap *devm_regmap_init_mmio(struct device *dev, |
158 | void __iomem *regs, | |
159 | const struct regmap_config *config); | |
c0eb4676 | 160 | |
b83a313b | 161 | void regmap_exit(struct regmap *map); |
bf315173 MB |
162 | int regmap_reinit_cache(struct regmap *map, |
163 | const struct regmap_config *config); | |
b83a313b MB |
164 | int regmap_write(struct regmap *map, unsigned int reg, unsigned int val); |
165 | int regmap_raw_write(struct regmap *map, unsigned int reg, | |
166 | const void *val, size_t val_len); | |
8eaeb219 LD |
167 | int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val, |
168 | size_t val_count); | |
b83a313b MB |
169 | int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val); |
170 | int regmap_raw_read(struct regmap *map, unsigned int reg, | |
171 | void *val, size_t val_len); | |
172 | int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val, | |
173 | size_t val_count); | |
174 | int regmap_update_bits(struct regmap *map, unsigned int reg, | |
175 | unsigned int mask, unsigned int val); | |
018690d3 MB |
176 | int regmap_update_bits_check(struct regmap *map, unsigned int reg, |
177 | unsigned int mask, unsigned int val, | |
178 | bool *change); | |
a6539c32 | 179 | int regmap_get_val_bytes(struct regmap *map); |
b83a313b | 180 | |
39a58439 | 181 | int regcache_sync(struct regmap *map); |
4d4cfd16 MB |
182 | int regcache_sync_region(struct regmap *map, unsigned int min, |
183 | unsigned int max); | |
92afb286 | 184 | void regcache_cache_only(struct regmap *map, bool enable); |
6eb0f5e0 | 185 | void regcache_cache_bypass(struct regmap *map, bool enable); |
8ae0d7e8 | 186 | void regcache_mark_dirty(struct regmap *map); |
92afb286 | 187 | |
22f0d90a MB |
188 | int regmap_register_patch(struct regmap *map, const struct reg_default *regs, |
189 | int num_regs); | |
190 | ||
f8beab2b MB |
191 | /** |
192 | * Description of an IRQ for the generic regmap irq_chip. | |
193 | * | |
194 | * @reg_offset: Offset of the status/mask register within the bank | |
195 | * @mask: Mask used to flag/control the register. | |
196 | */ | |
197 | struct regmap_irq { | |
198 | unsigned int reg_offset; | |
199 | unsigned int mask; | |
200 | }; | |
201 | ||
202 | /** | |
203 | * Description of a generic regmap irq_chip. This is not intended to | |
204 | * handle every possible interrupt controller, but it should handle a | |
205 | * substantial proportion of those that are found in the wild. | |
206 | * | |
207 | * @name: Descriptive name for IRQ controller. | |
208 | * | |
209 | * @status_base: Base status register address. | |
210 | * @mask_base: Base mask register address. | |
211 | * @ack_base: Base ack address. If zero then the chip is clear on read. | |
212 | * | |
213 | * @num_regs: Number of registers in each control bank. | |
214 | * @irqs: Descriptors for individual IRQs. Interrupt numbers are | |
215 | * assigned based on the index in the array of the interrupt. | |
216 | * @num_irqs: Number of descriptors. | |
217 | */ | |
218 | struct regmap_irq_chip { | |
219 | const char *name; | |
220 | ||
221 | unsigned int status_base; | |
222 | unsigned int mask_base; | |
223 | unsigned int ack_base; | |
224 | ||
225 | int num_regs; | |
226 | ||
227 | const struct regmap_irq *irqs; | |
228 | int num_irqs; | |
229 | }; | |
230 | ||
231 | struct regmap_irq_chip_data; | |
232 | ||
233 | int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags, | |
234 | int irq_base, struct regmap_irq_chip *chip, | |
235 | struct regmap_irq_chip_data **data); | |
236 | void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data); | |
209a6006 | 237 | int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data); |
92afb286 | 238 | |
9cde5fcd MB |
239 | #else |
240 | ||
241 | /* | |
242 | * These stubs should only ever be called by generic code which has | |
243 | * regmap based facilities, if they ever get called at runtime | |
244 | * something is going wrong and something probably needs to select | |
245 | * REGMAP. | |
246 | */ | |
247 | ||
248 | static inline int regmap_write(struct regmap *map, unsigned int reg, | |
249 | unsigned int val) | |
250 | { | |
251 | WARN_ONCE(1, "regmap API is disabled"); | |
252 | return -EINVAL; | |
253 | } | |
254 | ||
255 | static inline int regmap_raw_write(struct regmap *map, unsigned int reg, | |
256 | const void *val, size_t val_len) | |
257 | { | |
258 | WARN_ONCE(1, "regmap API is disabled"); | |
259 | return -EINVAL; | |
260 | } | |
261 | ||
262 | static inline int regmap_bulk_write(struct regmap *map, unsigned int reg, | |
263 | const void *val, size_t val_count) | |
264 | { | |
265 | WARN_ONCE(1, "regmap API is disabled"); | |
266 | return -EINVAL; | |
267 | } | |
268 | ||
269 | static inline int regmap_read(struct regmap *map, unsigned int reg, | |
270 | unsigned int *val) | |
271 | { | |
272 | WARN_ONCE(1, "regmap API is disabled"); | |
273 | return -EINVAL; | |
274 | } | |
275 | ||
276 | static inline int regmap_raw_read(struct regmap *map, unsigned int reg, | |
277 | void *val, size_t val_len) | |
278 | { | |
279 | WARN_ONCE(1, "regmap API is disabled"); | |
280 | return -EINVAL; | |
281 | } | |
282 | ||
283 | static inline int regmap_bulk_read(struct regmap *map, unsigned int reg, | |
284 | void *val, size_t val_count) | |
285 | { | |
286 | WARN_ONCE(1, "regmap API is disabled"); | |
287 | return -EINVAL; | |
288 | } | |
289 | ||
290 | static inline int regmap_update_bits(struct regmap *map, unsigned int reg, | |
291 | unsigned int mask, unsigned int val) | |
292 | { | |
293 | WARN_ONCE(1, "regmap API is disabled"); | |
294 | return -EINVAL; | |
295 | } | |
296 | ||
297 | static inline int regmap_update_bits_check(struct regmap *map, | |
298 | unsigned int reg, | |
299 | unsigned int mask, unsigned int val, | |
300 | bool *change) | |
301 | { | |
302 | WARN_ONCE(1, "regmap API is disabled"); | |
303 | return -EINVAL; | |
304 | } | |
305 | ||
306 | static inline int regmap_get_val_bytes(struct regmap *map) | |
307 | { | |
308 | WARN_ONCE(1, "regmap API is disabled"); | |
309 | return -EINVAL; | |
310 | } | |
311 | ||
312 | static inline int regcache_sync(struct regmap *map) | |
313 | { | |
314 | WARN_ONCE(1, "regmap API is disabled"); | |
315 | return -EINVAL; | |
316 | } | |
317 | ||
a313f9f5 MB |
318 | static inline int regcache_sync_region(struct regmap *map, unsigned int min, |
319 | unsigned int max) | |
320 | { | |
321 | WARN_ONCE(1, "regmap API is disabled"); | |
322 | return -EINVAL; | |
323 | } | |
324 | ||
9cde5fcd MB |
325 | static inline void regcache_cache_only(struct regmap *map, bool enable) |
326 | { | |
327 | WARN_ONCE(1, "regmap API is disabled"); | |
328 | } | |
329 | ||
330 | static inline void regcache_cache_bypass(struct regmap *map, bool enable) | |
331 | { | |
332 | WARN_ONCE(1, "regmap API is disabled"); | |
333 | } | |
334 | ||
335 | static inline void regcache_mark_dirty(struct regmap *map) | |
336 | { | |
337 | WARN_ONCE(1, "regmap API is disabled"); | |
338 | } | |
339 | ||
340 | static inline int regmap_register_patch(struct regmap *map, | |
341 | const struct reg_default *regs, | |
342 | int num_regs) | |
343 | { | |
344 | WARN_ONCE(1, "regmap API is disabled"); | |
345 | return -EINVAL; | |
346 | } | |
347 | ||
348 | #endif | |
349 | ||
b83a313b | 350 | #endif |