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