]>
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 | * | |
b83a313b MB |
113 | * @write: Write operation. |
114 | * @gather_write: Write operation with split register/value, return -ENOTSUPP | |
115 | * if not implemented on a given device. | |
116 | * @read: Read operation. Data is returned in the buffer used to transmit | |
117 | * data. | |
b83a313b MB |
118 | * @read_flag_mask: Mask to be set in the top byte of the register when doing |
119 | * a read. | |
120 | */ | |
121 | struct regmap_bus { | |
b83a313b MB |
122 | regmap_hw_write write; |
123 | regmap_hw_gather_write gather_write; | |
124 | regmap_hw_read read; | |
0135bbcc | 125 | regmap_hw_free_context free_context; |
b83a313b MB |
126 | u8 read_flag_mask; |
127 | }; | |
128 | ||
129 | struct regmap *regmap_init(struct device *dev, | |
130 | const struct regmap_bus *bus, | |
0135bbcc | 131 | void *bus_context, |
b83a313b | 132 | const struct regmap_config *config); |
9943fa30 MB |
133 | struct regmap *regmap_init_i2c(struct i2c_client *i2c, |
134 | const struct regmap_config *config); | |
a676f083 MB |
135 | struct regmap *regmap_init_spi(struct spi_device *dev, |
136 | const struct regmap_config *config); | |
137 | ||
c0eb4676 MB |
138 | struct regmap *devm_regmap_init(struct device *dev, |
139 | const struct regmap_bus *bus, | |
0135bbcc | 140 | void *bus_context, |
c0eb4676 MB |
141 | const struct regmap_config *config); |
142 | struct regmap *devm_regmap_init_i2c(struct i2c_client *i2c, | |
143 | const struct regmap_config *config); | |
144 | struct regmap *devm_regmap_init_spi(struct spi_device *dev, | |
145 | const struct regmap_config *config); | |
146 | ||
b83a313b | 147 | void regmap_exit(struct regmap *map); |
bf315173 MB |
148 | int regmap_reinit_cache(struct regmap *map, |
149 | const struct regmap_config *config); | |
b83a313b MB |
150 | int regmap_write(struct regmap *map, unsigned int reg, unsigned int val); |
151 | int regmap_raw_write(struct regmap *map, unsigned int reg, | |
152 | const void *val, size_t val_len); | |
8eaeb219 LD |
153 | int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val, |
154 | size_t val_count); | |
b83a313b MB |
155 | int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val); |
156 | int regmap_raw_read(struct regmap *map, unsigned int reg, | |
157 | void *val, size_t val_len); | |
158 | int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val, | |
159 | size_t val_count); | |
160 | int regmap_update_bits(struct regmap *map, unsigned int reg, | |
161 | unsigned int mask, unsigned int val); | |
018690d3 MB |
162 | int regmap_update_bits_check(struct regmap *map, unsigned int reg, |
163 | unsigned int mask, unsigned int val, | |
164 | bool *change); | |
a6539c32 | 165 | int regmap_get_val_bytes(struct regmap *map); |
b83a313b | 166 | |
39a58439 | 167 | int regcache_sync(struct regmap *map); |
4d4cfd16 MB |
168 | int regcache_sync_region(struct regmap *map, unsigned int min, |
169 | unsigned int max); | |
92afb286 | 170 | void regcache_cache_only(struct regmap *map, bool enable); |
6eb0f5e0 | 171 | void regcache_cache_bypass(struct regmap *map, bool enable); |
8ae0d7e8 | 172 | void regcache_mark_dirty(struct regmap *map); |
92afb286 | 173 | |
22f0d90a MB |
174 | int regmap_register_patch(struct regmap *map, const struct reg_default *regs, |
175 | int num_regs); | |
176 | ||
f8beab2b MB |
177 | /** |
178 | * Description of an IRQ for the generic regmap irq_chip. | |
179 | * | |
180 | * @reg_offset: Offset of the status/mask register within the bank | |
181 | * @mask: Mask used to flag/control the register. | |
182 | */ | |
183 | struct regmap_irq { | |
184 | unsigned int reg_offset; | |
185 | unsigned int mask; | |
186 | }; | |
187 | ||
188 | /** | |
189 | * Description of a generic regmap irq_chip. This is not intended to | |
190 | * handle every possible interrupt controller, but it should handle a | |
191 | * substantial proportion of those that are found in the wild. | |
192 | * | |
193 | * @name: Descriptive name for IRQ controller. | |
194 | * | |
195 | * @status_base: Base status register address. | |
196 | * @mask_base: Base mask register address. | |
197 | * @ack_base: Base ack address. If zero then the chip is clear on read. | |
198 | * | |
199 | * @num_regs: Number of registers in each control bank. | |
200 | * @irqs: Descriptors for individual IRQs. Interrupt numbers are | |
201 | * assigned based on the index in the array of the interrupt. | |
202 | * @num_irqs: Number of descriptors. | |
203 | */ | |
204 | struct regmap_irq_chip { | |
205 | const char *name; | |
206 | ||
207 | unsigned int status_base; | |
208 | unsigned int mask_base; | |
209 | unsigned int ack_base; | |
210 | ||
211 | int num_regs; | |
212 | ||
213 | const struct regmap_irq *irqs; | |
214 | int num_irqs; | |
215 | }; | |
216 | ||
217 | struct regmap_irq_chip_data; | |
218 | ||
219 | int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags, | |
220 | int irq_base, struct regmap_irq_chip *chip, | |
221 | struct regmap_irq_chip_data **data); | |
222 | void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data); | |
209a6006 | 223 | int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data); |
92afb286 | 224 | |
9cde5fcd MB |
225 | #else |
226 | ||
227 | /* | |
228 | * These stubs should only ever be called by generic code which has | |
229 | * regmap based facilities, if they ever get called at runtime | |
230 | * something is going wrong and something probably needs to select | |
231 | * REGMAP. | |
232 | */ | |
233 | ||
234 | static inline int regmap_write(struct regmap *map, unsigned int reg, | |
235 | unsigned int val) | |
236 | { | |
237 | WARN_ONCE(1, "regmap API is disabled"); | |
238 | return -EINVAL; | |
239 | } | |
240 | ||
241 | static inline int regmap_raw_write(struct regmap *map, unsigned int reg, | |
242 | const void *val, size_t val_len) | |
243 | { | |
244 | WARN_ONCE(1, "regmap API is disabled"); | |
245 | return -EINVAL; | |
246 | } | |
247 | ||
248 | static inline int regmap_bulk_write(struct regmap *map, unsigned int reg, | |
249 | const void *val, size_t val_count) | |
250 | { | |
251 | WARN_ONCE(1, "regmap API is disabled"); | |
252 | return -EINVAL; | |
253 | } | |
254 | ||
255 | static inline int regmap_read(struct regmap *map, unsigned int reg, | |
256 | unsigned int *val) | |
257 | { | |
258 | WARN_ONCE(1, "regmap API is disabled"); | |
259 | return -EINVAL; | |
260 | } | |
261 | ||
262 | static inline int regmap_raw_read(struct regmap *map, unsigned int reg, | |
263 | void *val, size_t val_len) | |
264 | { | |
265 | WARN_ONCE(1, "regmap API is disabled"); | |
266 | return -EINVAL; | |
267 | } | |
268 | ||
269 | static inline int regmap_bulk_read(struct regmap *map, unsigned int reg, | |
270 | void *val, size_t val_count) | |
271 | { | |
272 | WARN_ONCE(1, "regmap API is disabled"); | |
273 | return -EINVAL; | |
274 | } | |
275 | ||
276 | static inline int regmap_update_bits(struct regmap *map, unsigned int reg, | |
277 | unsigned int mask, unsigned int val) | |
278 | { | |
279 | WARN_ONCE(1, "regmap API is disabled"); | |
280 | return -EINVAL; | |
281 | } | |
282 | ||
283 | static inline int regmap_update_bits_check(struct regmap *map, | |
284 | unsigned int reg, | |
285 | unsigned int mask, unsigned int val, | |
286 | bool *change) | |
287 | { | |
288 | WARN_ONCE(1, "regmap API is disabled"); | |
289 | return -EINVAL; | |
290 | } | |
291 | ||
292 | static inline int regmap_get_val_bytes(struct regmap *map) | |
293 | { | |
294 | WARN_ONCE(1, "regmap API is disabled"); | |
295 | return -EINVAL; | |
296 | } | |
297 | ||
298 | static inline int regcache_sync(struct regmap *map) | |
299 | { | |
300 | WARN_ONCE(1, "regmap API is disabled"); | |
301 | return -EINVAL; | |
302 | } | |
303 | ||
a313f9f5 MB |
304 | static inline int regcache_sync_region(struct regmap *map, unsigned int min, |
305 | unsigned int max) | |
306 | { | |
307 | WARN_ONCE(1, "regmap API is disabled"); | |
308 | return -EINVAL; | |
309 | } | |
310 | ||
9cde5fcd MB |
311 | static inline void regcache_cache_only(struct regmap *map, bool enable) |
312 | { | |
313 | WARN_ONCE(1, "regmap API is disabled"); | |
314 | } | |
315 | ||
316 | static inline void regcache_cache_bypass(struct regmap *map, bool enable) | |
317 | { | |
318 | WARN_ONCE(1, "regmap API is disabled"); | |
319 | } | |
320 | ||
321 | static inline void regcache_mark_dirty(struct regmap *map) | |
322 | { | |
323 | WARN_ONCE(1, "regmap API is disabled"); | |
324 | } | |
325 | ||
326 | static inline int regmap_register_patch(struct regmap *map, | |
327 | const struct reg_default *regs, | |
328 | int num_regs) | |
329 | { | |
330 | WARN_ONCE(1, "regmap API is disabled"); | |
331 | return -EINVAL; | |
332 | } | |
333 | ||
334 | #endif | |
335 | ||
b83a313b | 336 | #endif |