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> |
6863ca62 | 17 | #include <linux/rbtree.h> |
adf08d48 | 18 | #include <linux/delay.h> |
49ccc142 | 19 | #include <linux/err.h> |
3f0fa9a8 | 20 | #include <linux/bug.h> |
3cfe7a74 | 21 | #include <linux/lockdep.h> |
b83a313b | 22 | |
de477254 | 23 | struct module; |
313162d0 | 24 | struct device; |
9943fa30 | 25 | struct i2c_client; |
90f790d2 | 26 | struct irq_domain; |
7d6f7fb0 | 27 | struct slim_device; |
a676f083 | 28 | struct spi_device; |
a01779f8 | 29 | struct spmi_device; |
b83d2ff0 | 30 | struct regmap; |
6863ca62 | 31 | struct regmap_range_cfg; |
67252287 | 32 | struct regmap_field; |
22853223 | 33 | struct snd_ac97; |
7c22ce6e | 34 | struct sdw_slave; |
9943fa30 | 35 | |
9fabe24e DP |
36 | /* An enum of all the supported cache types */ |
37 | enum regcache_type { | |
38 | REGCACHE_NONE, | |
28644c80 | 39 | REGCACHE_RBTREE, |
2ac902ce MB |
40 | REGCACHE_COMPRESSED, |
41 | REGCACHE_FLAT, | |
9fabe24e DP |
42 | }; |
43 | ||
bd20eb54 | 44 | /** |
2cf8e2df | 45 | * struct reg_default - Default value for a register. |
bd20eb54 MB |
46 | * |
47 | * @reg: Register address. | |
48 | * @def: Register default value. | |
2cf8e2df CK |
49 | * |
50 | * We use an array of structs rather than a simple array as many modern devices | |
51 | * have very sparse register maps. | |
bd20eb54 MB |
52 | */ |
53 | struct reg_default { | |
54 | unsigned int reg; | |
55 | unsigned int def; | |
56 | }; | |
57 | ||
8019ff6c | 58 | /** |
2cf8e2df | 59 | * struct reg_sequence - An individual write from a sequence of writes. |
8019ff6c NP |
60 | * |
61 | * @reg: Register address. | |
62 | * @def: Register value. | |
2de9d600 | 63 | * @delay_us: Delay to be applied after the register write in microseconds |
2cf8e2df CK |
64 | * |
65 | * Register/value pairs for sequences of writes with an optional delay in | |
66 | * microseconds to be applied after each write. | |
8019ff6c NP |
67 | */ |
68 | struct reg_sequence { | |
69 | unsigned int reg; | |
70 | unsigned int def; | |
2de9d600 | 71 | unsigned int delay_us; |
8019ff6c NP |
72 | }; |
73 | ||
ca7a9446 KM |
74 | #define regmap_update_bits(map, reg, mask, val) \ |
75 | regmap_update_bits_base(map, reg, mask, val, NULL, false, false) | |
30ed9cb7 KM |
76 | #define regmap_update_bits_async(map, reg, mask, val)\ |
77 | regmap_update_bits_base(map, reg, mask, val, NULL, true, false) | |
98c2dc48 KM |
78 | #define regmap_update_bits_check(map, reg, mask, val, change)\ |
79 | regmap_update_bits_base(map, reg, mask, val, change, false, false) | |
89d8d4b8 KM |
80 | #define regmap_update_bits_check_async(map, reg, mask, val, change)\ |
81 | regmap_update_bits_base(map, reg, mask, val, change, true, false) | |
ca7a9446 | 82 | |
b821957a KM |
83 | #define regmap_write_bits(map, reg, mask, val) \ |
84 | regmap_update_bits_base(map, reg, mask, val, NULL, false, true) | |
85 | ||
3674124b KM |
86 | #define regmap_field_write(field, val) \ |
87 | regmap_field_update_bits_base(field, ~0, val, NULL, false, false) | |
489061bb KM |
88 | #define regmap_field_force_write(field, val) \ |
89 | regmap_field_update_bits_base(field, ~0, val, NULL, false, true) | |
721ed64d KM |
90 | #define regmap_field_update_bits(field, mask, val)\ |
91 | regmap_field_update_bits_base(field, mask, val, NULL, false, false) | |
489061bb KM |
92 | #define regmap_field_force_update_bits(field, mask, val) \ |
93 | regmap_field_update_bits_base(field, mask, val, NULL, false, true) | |
3674124b | 94 | |
bbf2c46f KM |
95 | #define regmap_fields_write(field, id, val) \ |
96 | regmap_fields_update_bits_base(field, id, ~0, val, NULL, false, false) | |
e6ef243f KM |
97 | #define regmap_fields_force_write(field, id, val) \ |
98 | regmap_fields_update_bits_base(field, id, ~0, val, NULL, false, true) | |
48138609 KM |
99 | #define regmap_fields_update_bits(field, id, mask, val)\ |
100 | regmap_fields_update_bits_base(field, id, mask, val, NULL, false, false) | |
e6ef243f KM |
101 | #define regmap_fields_force_update_bits(field, id, mask, val) \ |
102 | regmap_fields_update_bits_base(field, id, mask, val, NULL, false, true) | |
bbf2c46f | 103 | |
08188ba8 PZ |
104 | /** |
105 | * regmap_read_poll_timeout - Poll until a condition is met or a timeout occurs | |
2cf8e2df | 106 | * |
08188ba8 PZ |
107 | * @map: Regmap to read from |
108 | * @addr: Address to poll | |
109 | * @val: Unsigned integer variable to read the value into | |
110 | * @cond: Break condition (usually involving @val) | |
111 | * @sleep_us: Maximum time to sleep between reads in us (0 | |
112 | * tight-loops). Should be less than ~20ms since usleep_range | |
113 | * is used (see Documentation/timers/timers-howto.txt). | |
114 | * @timeout_us: Timeout in us, 0 means never timeout | |
115 | * | |
116 | * Returns 0 on success and -ETIMEDOUT upon a timeout or the regmap_read | |
117 | * error return value in case of a error read. In the two former cases, | |
118 | * the last read value at @addr is stored in @val. Must not be called | |
119 | * from atomic context if sleep_us or timeout_us are used. | |
120 | * | |
121 | * This is modelled after the readx_poll_timeout macros in linux/iopoll.h. | |
122 | */ | |
123 | #define regmap_read_poll_timeout(map, addr, val, cond, sleep_us, timeout_us) \ | |
124 | ({ \ | |
1b0c22e4 AB |
125 | u64 __timeout_us = (timeout_us); \ |
126 | unsigned long __sleep_us = (sleep_us); \ | |
127 | ktime_t __timeout = ktime_add_us(ktime_get(), __timeout_us); \ | |
780b1350 | 128 | int __ret; \ |
1b0c22e4 | 129 | might_sleep_if(__sleep_us); \ |
08188ba8 | 130 | for (;;) { \ |
780b1350 RS |
131 | __ret = regmap_read((map), (addr), &(val)); \ |
132 | if (__ret) \ | |
08188ba8 PZ |
133 | break; \ |
134 | if (cond) \ | |
135 | break; \ | |
1b0c22e4 | 136 | if ((__timeout_us) && \ |
780b1350 RS |
137 | ktime_compare(ktime_get(), __timeout) > 0) { \ |
138 | __ret = regmap_read((map), (addr), &(val)); \ | |
08188ba8 PZ |
139 | break; \ |
140 | } \ | |
1b0c22e4 AB |
141 | if (__sleep_us) \ |
142 | usleep_range((__sleep_us >> 2) + 1, __sleep_us); \ | |
08188ba8 | 143 | } \ |
780b1350 | 144 | __ret ?: ((cond) ? 0 : -ETIMEDOUT); \ |
08188ba8 PZ |
145 | }) |
146 | ||
667063ac CYT |
147 | /** |
148 | * regmap_field_read_poll_timeout - Poll until a condition is met or timeout | |
149 | * | |
150 | * @field: Regmap field to read from | |
151 | * @val: Unsigned integer variable to read the value into | |
152 | * @cond: Break condition (usually involving @val) | |
153 | * @sleep_us: Maximum time to sleep between reads in us (0 | |
154 | * tight-loops). Should be less than ~20ms since usleep_range | |
155 | * is used (see Documentation/timers/timers-howto.txt). | |
156 | * @timeout_us: Timeout in us, 0 means never timeout | |
157 | * | |
158 | * Returns 0 on success and -ETIMEDOUT upon a timeout or the regmap_field_read | |
159 | * error return value in case of a error read. In the two former cases, | |
160 | * the last read value at @addr is stored in @val. Must not be called | |
161 | * from atomic context if sleep_us or timeout_us are used. | |
162 | * | |
163 | * This is modelled after the readx_poll_timeout macros in linux/iopoll.h. | |
164 | */ | |
165 | #define regmap_field_read_poll_timeout(field, val, cond, sleep_us, timeout_us) \ | |
166 | ({ \ | |
1b0c22e4 AB |
167 | u64 __timeout_us = (timeout_us); \ |
168 | unsigned long __sleep_us = (sleep_us); \ | |
169 | ktime_t timeout = ktime_add_us(ktime_get(), __timeout_us); \ | |
667063ac | 170 | int pollret; \ |
1b0c22e4 | 171 | might_sleep_if(__sleep_us); \ |
667063ac CYT |
172 | for (;;) { \ |
173 | pollret = regmap_field_read((field), &(val)); \ | |
174 | if (pollret) \ | |
175 | break; \ | |
176 | if (cond) \ | |
177 | break; \ | |
1b0c22e4 | 178 | if (__timeout_us && ktime_compare(ktime_get(), timeout) > 0) { \ |
667063ac CYT |
179 | pollret = regmap_field_read((field), &(val)); \ |
180 | break; \ | |
181 | } \ | |
1b0c22e4 AB |
182 | if (__sleep_us) \ |
183 | usleep_range((__sleep_us >> 2) + 1, __sleep_us); \ | |
667063ac CYT |
184 | } \ |
185 | pollret ?: ((cond) ? 0 : -ETIMEDOUT); \ | |
186 | }) | |
187 | ||
b83d2ff0 MB |
188 | #ifdef CONFIG_REGMAP |
189 | ||
141eba2e SW |
190 | enum regmap_endian { |
191 | /* Unspecified -> 0 -> Backwards compatible default */ | |
192 | REGMAP_ENDIAN_DEFAULT = 0, | |
193 | REGMAP_ENDIAN_BIG, | |
194 | REGMAP_ENDIAN_LITTLE, | |
195 | REGMAP_ENDIAN_NATIVE, | |
196 | }; | |
197 | ||
76aad392 | 198 | /** |
2cf8e2df CK |
199 | * struct regmap_range - A register range, used for access related checks |
200 | * (readable/writeable/volatile/precious checks) | |
76aad392 DC |
201 | * |
202 | * @range_min: address of first register | |
203 | * @range_max: address of last register | |
204 | */ | |
205 | struct regmap_range { | |
206 | unsigned int range_min; | |
207 | unsigned int range_max; | |
208 | }; | |
209 | ||
6112fe60 LD |
210 | #define regmap_reg_range(low, high) { .range_min = low, .range_max = high, } |
211 | ||
2cf8e2df CK |
212 | /** |
213 | * struct regmap_access_table - A table of register ranges for access checks | |
76aad392 DC |
214 | * |
215 | * @yes_ranges : pointer to an array of regmap ranges used as "yes ranges" | |
216 | * @n_yes_ranges: size of the above array | |
217 | * @no_ranges: pointer to an array of regmap ranges used as "no ranges" | |
218 | * @n_no_ranges: size of the above array | |
2cf8e2df CK |
219 | * |
220 | * A table of ranges including some yes ranges and some no ranges. | |
221 | * If a register belongs to a no_range, the corresponding check function | |
222 | * will return false. If a register belongs to a yes range, the corresponding | |
223 | * check function will return true. "no_ranges" are searched first. | |
76aad392 DC |
224 | */ |
225 | struct regmap_access_table { | |
226 | const struct regmap_range *yes_ranges; | |
227 | unsigned int n_yes_ranges; | |
228 | const struct regmap_range *no_ranges; | |
229 | unsigned int n_no_ranges; | |
230 | }; | |
231 | ||
0d4529c5 DC |
232 | typedef void (*regmap_lock)(void *); |
233 | typedef void (*regmap_unlock)(void *); | |
234 | ||
dd898b20 | 235 | /** |
2cf8e2df | 236 | * struct regmap_config - Configuration for the register map of a device. |
dd898b20 | 237 | * |
d3c242e1 SW |
238 | * @name: Optional name of the regmap. Useful when a device has multiple |
239 | * register regions. | |
240 | * | |
dd898b20 | 241 | * @reg_bits: Number of bits in a register address, mandatory. |
f01ee60f SW |
242 | * @reg_stride: The register address stride. Valid register addresses are a |
243 | * multiple of this value. If set to 0, a value of 1 will be | |
244 | * used. | |
82159ba8 | 245 | * @pad_bits: Number of bits of padding between register and value. |
dd898b20 | 246 | * @val_bits: Number of bits in a register value, mandatory. |
2e2ae66d | 247 | * |
3566cc9d | 248 | * @writeable_reg: Optional callback returning true if the register |
76aad392 DC |
249 | * can be written to. If this field is NULL but wr_table |
250 | * (see below) is not, the check is performed on such table | |
251 | * (a register is writeable if it belongs to one of the ranges | |
252 | * specified by wr_table). | |
3566cc9d | 253 | * @readable_reg: Optional callback returning true if the register |
76aad392 DC |
254 | * can be read from. If this field is NULL but rd_table |
255 | * (see below) is not, the check is performed on such table | |
256 | * (a register is readable if it belongs to one of the ranges | |
257 | * specified by rd_table). | |
3566cc9d | 258 | * @volatile_reg: Optional callback returning true if the register |
76aad392 DC |
259 | * value can't be cached. If this field is NULL but |
260 | * volatile_table (see below) is not, the check is performed on | |
261 | * such table (a register is volatile if it belongs to one of | |
262 | * the ranges specified by volatile_table). | |
bdc39644 | 263 | * @precious_reg: Optional callback returning true if the register |
76aad392 | 264 | * should not be read outside of a call from the driver |
bdc39644 | 265 | * (e.g., a clear on read interrupt status register). If this |
76aad392 DC |
266 | * field is NULL but precious_table (see below) is not, the |
267 | * check is performed on such table (a register is precious if | |
268 | * it belongs to one of the ranges specified by precious_table). | |
c9b41fcf BG |
269 | * @disable_locking: This regmap is either protected by external means or |
270 | * is guaranteed not be be accessed from multiple threads. | |
271 | * Don't use any locking mechanisms. | |
76aad392 DC |
272 | * @lock: Optional lock callback (overrides regmap's default lock |
273 | * function, based on spinlock or mutex). | |
274 | * @unlock: As above for unlocking. | |
275 | * @lock_arg: this field is passed as the only argument of lock/unlock | |
276 | * functions (ignored in case regular lock/unlock functions | |
277 | * are not overridden). | |
d2a5884a AS |
278 | * @reg_read: Optional callback that if filled will be used to perform |
279 | * all the reads from the registers. Should only be provided for | |
bdc39644 LP |
280 | * devices whose read operation cannot be represented as a simple |
281 | * read operation on a bus such as SPI, I2C, etc. Most of the | |
282 | * devices do not need this. | |
d2a5884a AS |
283 | * @reg_write: Same as above for writing. |
284 | * @fast_io: Register IO is fast. Use a spinlock instead of a mutex | |
285 | * to perform locking. This field is ignored if custom lock/unlock | |
286 | * functions are used (see fields lock/unlock of struct regmap_config). | |
287 | * This field is a duplicate of a similar file in | |
288 | * 'struct regmap_bus' and serves exact same purpose. | |
289 | * Use it only for "no-bus" cases. | |
b429fab4 | 290 | * @max_register: Optional, specifies the maximum valid register address. |
76aad392 DC |
291 | * @wr_table: Optional, points to a struct regmap_access_table specifying |
292 | * valid ranges for write access. | |
293 | * @rd_table: As above, for read access. | |
294 | * @volatile_table: As above, for volatile registers. | |
295 | * @precious_table: As above, for precious registers. | |
bd20eb54 MB |
296 | * @reg_defaults: Power on reset values for registers (for use with |
297 | * register cache support). | |
298 | * @num_reg_defaults: Number of elements in reg_defaults. | |
6f306441 | 299 | * |
f50e38c9 | 300 | * @read_flag_mask: Mask to be set in the top bytes of the register when doing |
6f306441 | 301 | * a read. |
f50e38c9 | 302 | * @write_flag_mask: Mask to be set in the top bytes of the register when doing |
6f306441 | 303 | * a write. If both read_flag_mask and write_flag_mask are |
9bf485c9 AD |
304 | * empty and zero_flag_mask is not set the regmap_bus default |
305 | * masks are used. | |
306 | * @zero_flag_mask: If set, read_flag_mask and write_flag_mask are used even | |
307 | * if they are both empty. | |
2e33caf1 AJ |
308 | * @use_single_rw: If set, converts the bulk read and write operations into |
309 | * a series of single read and write operations. This is useful | |
310 | * for device that does not support bulk read and write. | |
e894c3f4 OAO |
311 | * @can_multi_write: If set, the device supports the multi write mode of bulk |
312 | * write operations, if clear multi write requests will be | |
313 | * split into individual write operations | |
9fabe24e DP |
314 | * |
315 | * @cache_type: The actual cache type. | |
316 | * @reg_defaults_raw: Power on reset values for registers (for use with | |
317 | * register cache support). | |
318 | * @num_reg_defaults_raw: Number of elements in reg_defaults_raw. | |
141eba2e SW |
319 | * @reg_format_endian: Endianness for formatted register addresses. If this is |
320 | * DEFAULT, the @reg_format_endian_default value from the | |
321 | * regmap bus is used. | |
322 | * @val_format_endian: Endianness for formatted register values. If this is | |
323 | * DEFAULT, the @reg_format_endian_default value from the | |
324 | * regmap bus is used. | |
6863ca62 KG |
325 | * |
326 | * @ranges: Array of configuration entries for virtual address ranges. | |
327 | * @num_ranges: Number of range configuration entries. | |
a4887813 | 328 | * @use_hwlock: Indicate if a hardware spinlock should be used. |
8698b936 BW |
329 | * @hwlock_id: Specify the hardware spinlock id. |
330 | * @hwlock_mode: The hardware spinlock mode, should be HWLOCK_IRQSTATE, | |
331 | * HWLOCK_IRQ or 0. | |
dd898b20 | 332 | */ |
b83a313b | 333 | struct regmap_config { |
d3c242e1 SW |
334 | const char *name; |
335 | ||
b83a313b | 336 | int reg_bits; |
f01ee60f | 337 | int reg_stride; |
82159ba8 | 338 | int pad_bits; |
b83a313b | 339 | int val_bits; |
2e2ae66d | 340 | |
2e2ae66d MB |
341 | bool (*writeable_reg)(struct device *dev, unsigned int reg); |
342 | bool (*readable_reg)(struct device *dev, unsigned int reg); | |
343 | bool (*volatile_reg)(struct device *dev, unsigned int reg); | |
18694886 | 344 | bool (*precious_reg)(struct device *dev, unsigned int reg); |
c9b41fcf BG |
345 | |
346 | bool disable_locking; | |
0d4529c5 DC |
347 | regmap_lock lock; |
348 | regmap_unlock unlock; | |
349 | void *lock_arg; | |
bd20eb54 | 350 | |
d2a5884a AS |
351 | int (*reg_read)(void *context, unsigned int reg, unsigned int *val); |
352 | int (*reg_write)(void *context, unsigned int reg, unsigned int val); | |
353 | ||
354 | bool fast_io; | |
355 | ||
bd20eb54 | 356 | unsigned int max_register; |
76aad392 DC |
357 | const struct regmap_access_table *wr_table; |
358 | const struct regmap_access_table *rd_table; | |
359 | const struct regmap_access_table *volatile_table; | |
360 | const struct regmap_access_table *precious_table; | |
720e4616 | 361 | const struct reg_default *reg_defaults; |
9fabe24e DP |
362 | unsigned int num_reg_defaults; |
363 | enum regcache_type cache_type; | |
364 | const void *reg_defaults_raw; | |
365 | unsigned int num_reg_defaults_raw; | |
6f306441 | 366 | |
f50e38c9 TL |
367 | unsigned long read_flag_mask; |
368 | unsigned long write_flag_mask; | |
9bf485c9 | 369 | bool zero_flag_mask; |
2e33caf1 AJ |
370 | |
371 | bool use_single_rw; | |
e894c3f4 | 372 | bool can_multi_write; |
141eba2e SW |
373 | |
374 | enum regmap_endian reg_format_endian; | |
375 | enum regmap_endian val_format_endian; | |
38e23194 | 376 | |
6863ca62 | 377 | const struct regmap_range_cfg *ranges; |
e3549cd0 | 378 | unsigned int num_ranges; |
8698b936 | 379 | |
a4887813 | 380 | bool use_hwlock; |
8698b936 BW |
381 | unsigned int hwlock_id; |
382 | unsigned int hwlock_mode; | |
6863ca62 KG |
383 | }; |
384 | ||
385 | /** | |
2cf8e2df CK |
386 | * struct regmap_range_cfg - Configuration for indirectly accessed or paged |
387 | * registers. | |
6863ca62 | 388 | * |
d058bb49 MB |
389 | * @name: Descriptive name for diagnostics |
390 | * | |
6863ca62 KG |
391 | * @range_min: Address of the lowest register address in virtual range. |
392 | * @range_max: Address of the highest register in virtual range. | |
393 | * | |
2cf8e2df CK |
394 | * @selector_reg: Register with selector field. |
395 | * @selector_mask: Bit shift for selector value. | |
396 | * @selector_shift: Bit mask for selector value. | |
6863ca62 KG |
397 | * |
398 | * @window_start: Address of first (lowest) register in data window. | |
399 | * @window_len: Number of registers in data window. | |
2cf8e2df CK |
400 | * |
401 | * Registers, mapped to this virtual range, are accessed in two steps: | |
402 | * 1. page selector register update; | |
403 | * 2. access through data window registers. | |
6863ca62 KG |
404 | */ |
405 | struct regmap_range_cfg { | |
d058bb49 MB |
406 | const char *name; |
407 | ||
6863ca62 KG |
408 | /* Registers of virtual address range */ |
409 | unsigned int range_min; | |
410 | unsigned int range_max; | |
411 | ||
412 | /* Page selector for indirect addressing */ | |
413 | unsigned int selector_reg; | |
414 | unsigned int selector_mask; | |
415 | int selector_shift; | |
416 | ||
417 | /* Data window (per each page) */ | |
418 | unsigned int window_start; | |
419 | unsigned int window_len; | |
b83a313b MB |
420 | }; |
421 | ||
0d509f2b MB |
422 | struct regmap_async; |
423 | ||
0135bbcc | 424 | typedef int (*regmap_hw_write)(void *context, const void *data, |
b83a313b | 425 | size_t count); |
0135bbcc | 426 | typedef int (*regmap_hw_gather_write)(void *context, |
b83a313b MB |
427 | const void *reg, size_t reg_len, |
428 | const void *val, size_t val_len); | |
0d509f2b MB |
429 | typedef int (*regmap_hw_async_write)(void *context, |
430 | const void *reg, size_t reg_len, | |
431 | const void *val, size_t val_len, | |
432 | struct regmap_async *async); | |
0135bbcc | 433 | typedef int (*regmap_hw_read)(void *context, |
b83a313b MB |
434 | const void *reg_buf, size_t reg_size, |
435 | void *val_buf, size_t val_size); | |
3ac17037 BB |
436 | typedef int (*regmap_hw_reg_read)(void *context, unsigned int reg, |
437 | unsigned int *val); | |
438 | typedef int (*regmap_hw_reg_write)(void *context, unsigned int reg, | |
439 | unsigned int val); | |
77792b11 JR |
440 | typedef int (*regmap_hw_reg_update_bits)(void *context, unsigned int reg, |
441 | unsigned int mask, unsigned int val); | |
0d509f2b | 442 | typedef struct regmap_async *(*regmap_hw_async_alloc)(void); |
0135bbcc | 443 | typedef void (*regmap_hw_free_context)(void *context); |
b83a313b MB |
444 | |
445 | /** | |
2cf8e2df CK |
446 | * struct regmap_bus - Description of a hardware bus for the register map |
447 | * infrastructure. | |
b83a313b | 448 | * |
bacdbe07 | 449 | * @fast_io: Register IO is fast. Use a spinlock instead of a mutex |
0d4529c5 DC |
450 | * to perform locking. This field is ignored if custom lock/unlock |
451 | * functions are used (see fields lock/unlock of | |
452 | * struct regmap_config). | |
b83a313b MB |
453 | * @write: Write operation. |
454 | * @gather_write: Write operation with split register/value, return -ENOTSUPP | |
455 | * if not implemented on a given device. | |
0d509f2b MB |
456 | * @async_write: Write operation which completes asynchronously, optional and |
457 | * must serialise with respect to non-async I/O. | |
c5f58f2d MP |
458 | * @reg_write: Write a single register value to the given register address. This |
459 | * write operation has to complete when returning from the function. | |
2cf8e2df CK |
460 | * @reg_update_bits: Update bits operation to be used against volatile |
461 | * registers, intended for devices supporting some mechanism | |
462 | * for setting clearing bits without having to | |
463 | * read/modify/write. | |
b83a313b MB |
464 | * @read: Read operation. Data is returned in the buffer used to transmit |
465 | * data. | |
c5f58f2d MP |
466 | * @reg_read: Read a single register value from a given register address. |
467 | * @free_context: Free context. | |
0d509f2b | 468 | * @async_alloc: Allocate a regmap_async() structure. |
b83a313b MB |
469 | * @read_flag_mask: Mask to be set in the top byte of the register when doing |
470 | * a read. | |
141eba2e SW |
471 | * @reg_format_endian_default: Default endianness for formatted register |
472 | * addresses. Used when the regmap_config specifies DEFAULT. If this is | |
473 | * DEFAULT, BIG is assumed. | |
474 | * @val_format_endian_default: Default endianness for formatted register | |
475 | * values. Used when the regmap_config specifies DEFAULT. If this is | |
476 | * DEFAULT, BIG is assumed. | |
adaac459 MP |
477 | * @max_raw_read: Max raw read size that can be used on the bus. |
478 | * @max_raw_write: Max raw write size that can be used on the bus. | |
b83a313b MB |
479 | */ |
480 | struct regmap_bus { | |
bacdbe07 | 481 | bool fast_io; |
b83a313b MB |
482 | regmap_hw_write write; |
483 | regmap_hw_gather_write gather_write; | |
0d509f2b | 484 | regmap_hw_async_write async_write; |
3ac17037 | 485 | regmap_hw_reg_write reg_write; |
77792b11 | 486 | regmap_hw_reg_update_bits reg_update_bits; |
b83a313b | 487 | regmap_hw_read read; |
3ac17037 | 488 | regmap_hw_reg_read reg_read; |
0135bbcc | 489 | regmap_hw_free_context free_context; |
0d509f2b | 490 | regmap_hw_async_alloc async_alloc; |
b83a313b | 491 | u8 read_flag_mask; |
141eba2e SW |
492 | enum regmap_endian reg_format_endian_default; |
493 | enum regmap_endian val_format_endian_default; | |
adaac459 MP |
494 | size_t max_raw_read; |
495 | size_t max_raw_write; | |
b83a313b MB |
496 | }; |
497 | ||
3cfe7a74 NB |
498 | /* |
499 | * __regmap_init functions. | |
500 | * | |
501 | * These functions take a lock key and name parameter, and should not be called | |
502 | * directly. Instead, use the regmap_init macros that generate a key and name | |
503 | * for each call. | |
504 | */ | |
505 | struct regmap *__regmap_init(struct device *dev, | |
506 | const struct regmap_bus *bus, | |
507 | void *bus_context, | |
508 | const struct regmap_config *config, | |
509 | struct lock_class_key *lock_key, | |
510 | const char *lock_name); | |
511 | struct regmap *__regmap_init_i2c(struct i2c_client *i2c, | |
512 | const struct regmap_config *config, | |
513 | struct lock_class_key *lock_key, | |
514 | const char *lock_name); | |
7d6f7fb0 SK |
515 | struct regmap *__regmap_init_slimbus(struct slim_device *slimbus, |
516 | const struct regmap_config *config, | |
517 | struct lock_class_key *lock_key, | |
518 | const char *lock_name); | |
3cfe7a74 NB |
519 | struct regmap *__regmap_init_spi(struct spi_device *dev, |
520 | const struct regmap_config *config, | |
521 | struct lock_class_key *lock_key, | |
522 | const char *lock_name); | |
523 | struct regmap *__regmap_init_spmi_base(struct spmi_device *dev, | |
524 | const struct regmap_config *config, | |
525 | struct lock_class_key *lock_key, | |
526 | const char *lock_name); | |
527 | struct regmap *__regmap_init_spmi_ext(struct spmi_device *dev, | |
528 | const struct regmap_config *config, | |
529 | struct lock_class_key *lock_key, | |
530 | const char *lock_name); | |
cc5d0db3 AM |
531 | struct regmap *__regmap_init_w1(struct device *w1_dev, |
532 | const struct regmap_config *config, | |
533 | struct lock_class_key *lock_key, | |
534 | const char *lock_name); | |
3cfe7a74 NB |
535 | struct regmap *__regmap_init_mmio_clk(struct device *dev, const char *clk_id, |
536 | void __iomem *regs, | |
537 | const struct regmap_config *config, | |
538 | struct lock_class_key *lock_key, | |
539 | const char *lock_name); | |
540 | struct regmap *__regmap_init_ac97(struct snd_ac97 *ac97, | |
541 | const struct regmap_config *config, | |
542 | struct lock_class_key *lock_key, | |
543 | const char *lock_name); | |
7c22ce6e VK |
544 | struct regmap *__regmap_init_sdw(struct sdw_slave *sdw, |
545 | const struct regmap_config *config, | |
546 | struct lock_class_key *lock_key, | |
547 | const char *lock_name); | |
3cfe7a74 NB |
548 | |
549 | struct regmap *__devm_regmap_init(struct device *dev, | |
550 | const struct regmap_bus *bus, | |
551 | void *bus_context, | |
552 | const struct regmap_config *config, | |
553 | struct lock_class_key *lock_key, | |
554 | const char *lock_name); | |
555 | struct regmap *__devm_regmap_init_i2c(struct i2c_client *i2c, | |
556 | const struct regmap_config *config, | |
557 | struct lock_class_key *lock_key, | |
558 | const char *lock_name); | |
559 | struct regmap *__devm_regmap_init_spi(struct spi_device *dev, | |
560 | const struct regmap_config *config, | |
561 | struct lock_class_key *lock_key, | |
562 | const char *lock_name); | |
563 | struct regmap *__devm_regmap_init_spmi_base(struct spmi_device *dev, | |
564 | const struct regmap_config *config, | |
565 | struct lock_class_key *lock_key, | |
566 | const char *lock_name); | |
567 | struct regmap *__devm_regmap_init_spmi_ext(struct spmi_device *dev, | |
568 | const struct regmap_config *config, | |
569 | struct lock_class_key *lock_key, | |
570 | const char *lock_name); | |
cc5d0db3 AM |
571 | struct regmap *__devm_regmap_init_w1(struct device *w1_dev, |
572 | const struct regmap_config *config, | |
573 | struct lock_class_key *lock_key, | |
574 | const char *lock_name); | |
3cfe7a74 NB |
575 | struct regmap *__devm_regmap_init_mmio_clk(struct device *dev, |
576 | const char *clk_id, | |
577 | void __iomem *regs, | |
578 | const struct regmap_config *config, | |
579 | struct lock_class_key *lock_key, | |
580 | const char *lock_name); | |
581 | struct regmap *__devm_regmap_init_ac97(struct snd_ac97 *ac97, | |
582 | const struct regmap_config *config, | |
583 | struct lock_class_key *lock_key, | |
584 | const char *lock_name); | |
7c22ce6e VK |
585 | struct regmap *__devm_regmap_init_sdw(struct sdw_slave *sdw, |
586 | const struct regmap_config *config, | |
587 | struct lock_class_key *lock_key, | |
588 | const char *lock_name); | |
22853223 | 589 | |
3cfe7a74 NB |
590 | /* |
591 | * Wrapper for regmap_init macros to include a unique lockdep key and name | |
592 | * for each call. No-op if CONFIG_LOCKDEP is not set. | |
593 | * | |
594 | * @fn: Real function to call (in the form __[*_]regmap_init[_*]) | |
595 | * @name: Config variable name (#config in the calling macro) | |
596 | **/ | |
597 | #ifdef CONFIG_LOCKDEP | |
598 | #define __regmap_lockdep_wrapper(fn, name, ...) \ | |
599 | ( \ | |
600 | ({ \ | |
601 | static struct lock_class_key _key; \ | |
602 | fn(__VA_ARGS__, &_key, \ | |
603 | KBUILD_BASENAME ":" \ | |
604 | __stringify(__LINE__) ":" \ | |
605 | "(" name ")->lock"); \ | |
606 | }) \ | |
607 | ) | |
608 | #else | |
609 | #define __regmap_lockdep_wrapper(fn, name, ...) fn(__VA_ARGS__, NULL, NULL) | |
610 | #endif | |
611 | ||
1ed81114 | 612 | /** |
2cf8e2df | 613 | * regmap_init() - Initialise register map |
1ed81114 NB |
614 | * |
615 | * @dev: Device that will be interacted with | |
616 | * @bus: Bus-specific callbacks to use with device | |
617 | * @bus_context: Data passed to bus-specific callbacks | |
618 | * @config: Configuration for register map | |
619 | * | |
620 | * The return value will be an ERR_PTR() on error or a valid pointer to | |
621 | * a struct regmap. This function should generally not be called | |
622 | * directly, it should be called by bus-specific init functions. | |
623 | */ | |
3cfe7a74 NB |
624 | #define regmap_init(dev, bus, bus_context, config) \ |
625 | __regmap_lockdep_wrapper(__regmap_init, #config, \ | |
626 | dev, bus, bus_context, config) | |
6cfec04b | 627 | int regmap_attach_dev(struct device *dev, struct regmap *map, |
3cfe7a74 | 628 | const struct regmap_config *config); |
22853223 | 629 | |
1ed81114 | 630 | /** |
2cf8e2df | 631 | * regmap_init_i2c() - Initialise register map |
1ed81114 NB |
632 | * |
633 | * @i2c: Device that will be interacted with | |
634 | * @config: Configuration for register map | |
635 | * | |
636 | * The return value will be an ERR_PTR() on error or a valid pointer to | |
637 | * a struct regmap. | |
638 | */ | |
3cfe7a74 NB |
639 | #define regmap_init_i2c(i2c, config) \ |
640 | __regmap_lockdep_wrapper(__regmap_init_i2c, #config, \ | |
641 | i2c, config) | |
1ed81114 | 642 | |
7d6f7fb0 SK |
643 | /** |
644 | * regmap_init_slimbus() - Initialise register map | |
645 | * | |
646 | * @slimbus: Device that will be interacted with | |
647 | * @config: Configuration for register map | |
648 | * | |
649 | * The return value will be an ERR_PTR() on error or a valid pointer to | |
650 | * a struct regmap. | |
651 | */ | |
652 | #define regmap_init_slimbus(slimbus, config) \ | |
653 | __regmap_lockdep_wrapper(__regmap_init_slimbus, #config, \ | |
654 | slimbus, config) | |
655 | ||
1ed81114 | 656 | /** |
2cf8e2df | 657 | * regmap_init_spi() - Initialise register map |
1ed81114 | 658 | * |
2cf8e2df | 659 | * @dev: Device that will be interacted with |
1ed81114 NB |
660 | * @config: Configuration for register map |
661 | * | |
662 | * The return value will be an ERR_PTR() on error or a valid pointer to | |
663 | * a struct regmap. | |
664 | */ | |
3cfe7a74 NB |
665 | #define regmap_init_spi(dev, config) \ |
666 | __regmap_lockdep_wrapper(__regmap_init_spi, #config, \ | |
667 | dev, config) | |
1ed81114 NB |
668 | |
669 | /** | |
2cf8e2df CK |
670 | * regmap_init_spmi_base() - Create regmap for the Base register space |
671 | * | |
672 | * @dev: SPMI device that will be interacted with | |
1ed81114 NB |
673 | * @config: Configuration for register map |
674 | * | |
675 | * The return value will be an ERR_PTR() on error or a valid pointer to | |
676 | * a struct regmap. | |
677 | */ | |
3cfe7a74 NB |
678 | #define regmap_init_spmi_base(dev, config) \ |
679 | __regmap_lockdep_wrapper(__regmap_init_spmi_base, #config, \ | |
680 | dev, config) | |
1ed81114 NB |
681 | |
682 | /** | |
2cf8e2df CK |
683 | * regmap_init_spmi_ext() - Create regmap for Ext register space |
684 | * | |
685 | * @dev: Device that will be interacted with | |
1ed81114 NB |
686 | * @config: Configuration for register map |
687 | * | |
688 | * The return value will be an ERR_PTR() on error or a valid pointer to | |
689 | * a struct regmap. | |
690 | */ | |
3cfe7a74 NB |
691 | #define regmap_init_spmi_ext(dev, config) \ |
692 | __regmap_lockdep_wrapper(__regmap_init_spmi_ext, #config, \ | |
693 | dev, config) | |
1ed81114 | 694 | |
cc5d0db3 AM |
695 | /** |
696 | * regmap_init_w1() - Initialise register map | |
697 | * | |
698 | * @w1_dev: Device that will be interacted with | |
699 | * @config: Configuration for register map | |
700 | * | |
701 | * The return value will be an ERR_PTR() on error or a valid pointer to | |
702 | * a struct regmap. | |
703 | */ | |
704 | #define regmap_init_w1(w1_dev, config) \ | |
705 | __regmap_lockdep_wrapper(__regmap_init_w1, #config, \ | |
706 | w1_dev, config) | |
707 | ||
1ed81114 | 708 | /** |
2cf8e2df | 709 | * regmap_init_mmio_clk() - Initialise register map with register clock |
1ed81114 NB |
710 | * |
711 | * @dev: Device that will be interacted with | |
712 | * @clk_id: register clock consumer ID | |
713 | * @regs: Pointer to memory-mapped IO region | |
714 | * @config: Configuration for register map | |
715 | * | |
716 | * The return value will be an ERR_PTR() on error or a valid pointer to | |
717 | * a struct regmap. | |
718 | */ | |
3cfe7a74 NB |
719 | #define regmap_init_mmio_clk(dev, clk_id, regs, config) \ |
720 | __regmap_lockdep_wrapper(__regmap_init_mmio_clk, #config, \ | |
721 | dev, clk_id, regs, config) | |
878ec67b PZ |
722 | |
723 | /** | |
2cf8e2df | 724 | * regmap_init_mmio() - Initialise register map |
878ec67b PZ |
725 | * |
726 | * @dev: Device that will be interacted with | |
727 | * @regs: Pointer to memory-mapped IO region | |
728 | * @config: Configuration for register map | |
729 | * | |
730 | * The return value will be an ERR_PTR() on error or a valid pointer to | |
731 | * a struct regmap. | |
732 | */ | |
1ed81114 NB |
733 | #define regmap_init_mmio(dev, regs, config) \ |
734 | regmap_init_mmio_clk(dev, NULL, regs, config) | |
735 | ||
736 | /** | |
2cf8e2df | 737 | * regmap_init_ac97() - Initialise AC'97 register map |
1ed81114 NB |
738 | * |
739 | * @ac97: Device that will be interacted with | |
740 | * @config: Configuration for register map | |
741 | * | |
742 | * The return value will be an ERR_PTR() on error or a valid pointer to | |
743 | * a struct regmap. | |
744 | */ | |
3cfe7a74 NB |
745 | #define regmap_init_ac97(ac97, config) \ |
746 | __regmap_lockdep_wrapper(__regmap_init_ac97, #config, \ | |
747 | ac97, config) | |
22853223 | 748 | bool regmap_ac97_default_volatile(struct device *dev, unsigned int reg); |
878ec67b | 749 | |
7c22ce6e VK |
750 | /** |
751 | * regmap_init_sdw() - Initialise register map | |
752 | * | |
753 | * @sdw: Device that will be interacted with | |
754 | * @config: Configuration for register map | |
755 | * | |
756 | * The return value will be an ERR_PTR() on error or a valid pointer to | |
757 | * a struct regmap. | |
758 | */ | |
759 | #define regmap_init_sdw(sdw, config) \ | |
760 | __regmap_lockdep_wrapper(__regmap_init_sdw, #config, \ | |
761 | sdw, config) | |
762 | ||
763 | ||
1ed81114 | 764 | /** |
2cf8e2df | 765 | * devm_regmap_init() - Initialise managed register map |
1ed81114 NB |
766 | * |
767 | * @dev: Device that will be interacted with | |
768 | * @bus: Bus-specific callbacks to use with device | |
769 | * @bus_context: Data passed to bus-specific callbacks | |
770 | * @config: Configuration for register map | |
771 | * | |
772 | * The return value will be an ERR_PTR() on error or a valid pointer | |
773 | * to a struct regmap. This function should generally not be called | |
774 | * directly, it should be called by bus-specific init functions. The | |
775 | * map will be automatically freed by the device management code. | |
776 | */ | |
3cfe7a74 NB |
777 | #define devm_regmap_init(dev, bus, bus_context, config) \ |
778 | __regmap_lockdep_wrapper(__devm_regmap_init, #config, \ | |
779 | dev, bus, bus_context, config) | |
1ed81114 NB |
780 | |
781 | /** | |
2cf8e2df | 782 | * devm_regmap_init_i2c() - Initialise managed register map |
1ed81114 NB |
783 | * |
784 | * @i2c: Device that will be interacted with | |
785 | * @config: Configuration for register map | |
786 | * | |
787 | * The return value will be an ERR_PTR() on error or a valid pointer | |
788 | * to a struct regmap. The regmap will be automatically freed by the | |
789 | * device management code. | |
790 | */ | |
3cfe7a74 NB |
791 | #define devm_regmap_init_i2c(i2c, config) \ |
792 | __regmap_lockdep_wrapper(__devm_regmap_init_i2c, #config, \ | |
793 | i2c, config) | |
1ed81114 NB |
794 | |
795 | /** | |
2cf8e2df | 796 | * devm_regmap_init_spi() - Initialise register map |
1ed81114 | 797 | * |
2cf8e2df | 798 | * @dev: Device that will be interacted with |
1ed81114 NB |
799 | * @config: Configuration for register map |
800 | * | |
801 | * The return value will be an ERR_PTR() on error or a valid pointer | |
802 | * to a struct regmap. The map will be automatically freed by the | |
803 | * device management code. | |
804 | */ | |
3cfe7a74 NB |
805 | #define devm_regmap_init_spi(dev, config) \ |
806 | __regmap_lockdep_wrapper(__devm_regmap_init_spi, #config, \ | |
807 | dev, config) | |
1ed81114 NB |
808 | |
809 | /** | |
2cf8e2df CK |
810 | * devm_regmap_init_spmi_base() - Create managed regmap for Base register space |
811 | * | |
812 | * @dev: SPMI device that will be interacted with | |
1ed81114 NB |
813 | * @config: Configuration for register map |
814 | * | |
815 | * The return value will be an ERR_PTR() on error or a valid pointer | |
816 | * to a struct regmap. The regmap will be automatically freed by the | |
817 | * device management code. | |
818 | */ | |
3cfe7a74 NB |
819 | #define devm_regmap_init_spmi_base(dev, config) \ |
820 | __regmap_lockdep_wrapper(__devm_regmap_init_spmi_base, #config, \ | |
821 | dev, config) | |
1ed81114 NB |
822 | |
823 | /** | |
2cf8e2df CK |
824 | * devm_regmap_init_spmi_ext() - Create managed regmap for Ext register space |
825 | * | |
826 | * @dev: SPMI device that will be interacted with | |
1ed81114 NB |
827 | * @config: Configuration for register map |
828 | * | |
829 | * The return value will be an ERR_PTR() on error or a valid pointer | |
830 | * to a struct regmap. The regmap will be automatically freed by the | |
831 | * device management code. | |
832 | */ | |
3cfe7a74 NB |
833 | #define devm_regmap_init_spmi_ext(dev, config) \ |
834 | __regmap_lockdep_wrapper(__devm_regmap_init_spmi_ext, #config, \ | |
835 | dev, config) | |
3cfe7a74 | 836 | |
cc5d0db3 AM |
837 | /** |
838 | * devm_regmap_init_w1() - Initialise managed register map | |
839 | * | |
840 | * @w1_dev: Device that will be interacted with | |
841 | * @config: Configuration for register map | |
842 | * | |
843 | * The return value will be an ERR_PTR() on error or a valid pointer | |
844 | * to a struct regmap. The regmap will be automatically freed by the | |
845 | * device management code. | |
846 | */ | |
847 | #define devm_regmap_init_w1(w1_dev, config) \ | |
848 | __regmap_lockdep_wrapper(__devm_regmap_init_w1, #config, \ | |
849 | w1_dev, config) | |
878ec67b | 850 | /** |
2cf8e2df | 851 | * devm_regmap_init_mmio_clk() - Initialise managed register map with clock |
878ec67b PZ |
852 | * |
853 | * @dev: Device that will be interacted with | |
1ed81114 | 854 | * @clk_id: register clock consumer ID |
878ec67b PZ |
855 | * @regs: Pointer to memory-mapped IO region |
856 | * @config: Configuration for register map | |
857 | * | |
1ed81114 NB |
858 | * The return value will be an ERR_PTR() on error or a valid pointer |
859 | * to a struct regmap. The regmap will be automatically freed by the | |
860 | * device management code. | |
878ec67b | 861 | */ |
1ed81114 NB |
862 | #define devm_regmap_init_mmio_clk(dev, clk_id, regs, config) \ |
863 | __regmap_lockdep_wrapper(__devm_regmap_init_mmio_clk, #config, \ | |
864 | dev, clk_id, regs, config) | |
878ec67b PZ |
865 | |
866 | /** | |
2cf8e2df | 867 | * devm_regmap_init_mmio() - Initialise managed register map |
878ec67b PZ |
868 | * |
869 | * @dev: Device that will be interacted with | |
870 | * @regs: Pointer to memory-mapped IO region | |
871 | * @config: Configuration for register map | |
872 | * | |
873 | * The return value will be an ERR_PTR() on error or a valid pointer | |
874 | * to a struct regmap. The regmap will be automatically freed by the | |
875 | * device management code. | |
876 | */ | |
3cfe7a74 NB |
877 | #define devm_regmap_init_mmio(dev, regs, config) \ |
878 | devm_regmap_init_mmio_clk(dev, NULL, regs, config) | |
c0eb4676 | 879 | |
1ed81114 | 880 | /** |
2cf8e2df | 881 | * devm_regmap_init_ac97() - Initialise AC'97 register map |
1ed81114 NB |
882 | * |
883 | * @ac97: Device that will be interacted with | |
884 | * @config: Configuration for register map | |
885 | * | |
886 | * The return value will be an ERR_PTR() on error or a valid pointer | |
887 | * to a struct regmap. The regmap will be automatically freed by the | |
888 | * device management code. | |
889 | */ | |
890 | #define devm_regmap_init_ac97(ac97, config) \ | |
891 | __regmap_lockdep_wrapper(__devm_regmap_init_ac97, #config, \ | |
892 | ac97, config) | |
c0eb4676 | 893 | |
7c22ce6e VK |
894 | /** |
895 | * devm_regmap_init_sdw() - Initialise managed register map | |
896 | * | |
897 | * @sdw: Device that will be interacted with | |
898 | * @config: Configuration for register map | |
899 | * | |
900 | * The return value will be an ERR_PTR() on error or a valid pointer | |
901 | * to a struct regmap. The regmap will be automatically freed by the | |
902 | * device management code. | |
903 | */ | |
904 | #define devm_regmap_init_sdw(sdw, config) \ | |
905 | __regmap_lockdep_wrapper(__devm_regmap_init_sdw, #config, \ | |
906 | sdw, config) | |
907 | ||
b83a313b | 908 | void regmap_exit(struct regmap *map); |
bf315173 MB |
909 | int regmap_reinit_cache(struct regmap *map, |
910 | const struct regmap_config *config); | |
72b39f6f | 911 | struct regmap *dev_get_regmap(struct device *dev, const char *name); |
8d7d3972 | 912 | struct device *regmap_get_device(struct regmap *map); |
b83a313b | 913 | int regmap_write(struct regmap *map, unsigned int reg, unsigned int val); |
915f441b | 914 | int regmap_write_async(struct regmap *map, unsigned int reg, unsigned int val); |
b83a313b MB |
915 | int regmap_raw_write(struct regmap *map, unsigned int reg, |
916 | const void *val, size_t val_len); | |
8eaeb219 LD |
917 | int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val, |
918 | size_t val_count); | |
8019ff6c | 919 | int regmap_multi_reg_write(struct regmap *map, const struct reg_sequence *regs, |
e33fabd3 | 920 | int num_regs); |
1d5b40bc | 921 | int regmap_multi_reg_write_bypassed(struct regmap *map, |
8019ff6c | 922 | const struct reg_sequence *regs, |
1d5b40bc | 923 | int num_regs); |
0d509f2b MB |
924 | int regmap_raw_write_async(struct regmap *map, unsigned int reg, |
925 | const void *val, size_t val_len); | |
b83a313b MB |
926 | int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val); |
927 | int regmap_raw_read(struct regmap *map, unsigned int reg, | |
928 | void *val, size_t val_len); | |
929 | int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val, | |
930 | size_t val_count); | |
91d31b9f KM |
931 | int regmap_update_bits_base(struct regmap *map, unsigned int reg, |
932 | unsigned int mask, unsigned int val, | |
933 | bool *change, bool async, bool force); | |
a6539c32 | 934 | int regmap_get_val_bytes(struct regmap *map); |
668abc72 | 935 | int regmap_get_max_register(struct regmap *map); |
a2f776cb | 936 | int regmap_get_reg_stride(struct regmap *map); |
0d509f2b | 937 | int regmap_async_complete(struct regmap *map); |
221ad7f2 | 938 | bool regmap_can_raw_write(struct regmap *map); |
f50c9eb4 MP |
939 | size_t regmap_get_raw_read_max(struct regmap *map); |
940 | size_t regmap_get_raw_write_max(struct regmap *map); | |
b83a313b | 941 | |
39a58439 | 942 | int regcache_sync(struct regmap *map); |
4d4cfd16 MB |
943 | int regcache_sync_region(struct regmap *map, unsigned int min, |
944 | unsigned int max); | |
697e85bc MB |
945 | int regcache_drop_region(struct regmap *map, unsigned int min, |
946 | unsigned int max); | |
92afb286 | 947 | void regcache_cache_only(struct regmap *map, bool enable); |
6eb0f5e0 | 948 | void regcache_cache_bypass(struct regmap *map, bool enable); |
8ae0d7e8 | 949 | void regcache_mark_dirty(struct regmap *map); |
92afb286 | 950 | |
154881e5 MB |
951 | bool regmap_check_range_table(struct regmap *map, unsigned int reg, |
952 | const struct regmap_access_table *table); | |
953 | ||
8019ff6c | 954 | int regmap_register_patch(struct regmap *map, const struct reg_sequence *regs, |
22f0d90a | 955 | int num_regs); |
13ff50c8 NC |
956 | int regmap_parse_val(struct regmap *map, const void *buf, |
957 | unsigned int *val); | |
22f0d90a | 958 | |
76aad392 DC |
959 | static inline bool regmap_reg_in_range(unsigned int reg, |
960 | const struct regmap_range *range) | |
961 | { | |
962 | return reg >= range->range_min && reg <= range->range_max; | |
963 | } | |
964 | ||
965 | bool regmap_reg_in_ranges(unsigned int reg, | |
966 | const struct regmap_range *ranges, | |
967 | unsigned int nranges); | |
968 | ||
67252287 | 969 | /** |
2cf8e2df | 970 | * struct reg_field - Description of an register field |
67252287 SK |
971 | * |
972 | * @reg: Offset of the register within the regmap bank | |
973 | * @lsb: lsb of the register field. | |
f27b37f5 | 974 | * @msb: msb of the register field. |
a0102375 KM |
975 | * @id_size: port size if it has some ports |
976 | * @id_offset: address offset for each ports | |
67252287 SK |
977 | */ |
978 | struct reg_field { | |
979 | unsigned int reg; | |
980 | unsigned int lsb; | |
981 | unsigned int msb; | |
a0102375 KM |
982 | unsigned int id_size; |
983 | unsigned int id_offset; | |
67252287 SK |
984 | }; |
985 | ||
986 | #define REG_FIELD(_reg, _lsb, _msb) { \ | |
987 | .reg = _reg, \ | |
988 | .lsb = _lsb, \ | |
989 | .msb = _msb, \ | |
990 | } | |
991 | ||
992 | struct regmap_field *regmap_field_alloc(struct regmap *regmap, | |
993 | struct reg_field reg_field); | |
994 | void regmap_field_free(struct regmap_field *field); | |
995 | ||
996 | struct regmap_field *devm_regmap_field_alloc(struct device *dev, | |
997 | struct regmap *regmap, struct reg_field reg_field); | |
998 | void devm_regmap_field_free(struct device *dev, struct regmap_field *field); | |
999 | ||
1000 | int regmap_field_read(struct regmap_field *field, unsigned int *val); | |
28972eaa KM |
1001 | int regmap_field_update_bits_base(struct regmap_field *field, |
1002 | unsigned int mask, unsigned int val, | |
1003 | bool *change, bool async, bool force); | |
a0102375 KM |
1004 | int regmap_fields_read(struct regmap_field *field, unsigned int id, |
1005 | unsigned int *val); | |
e126edec KM |
1006 | int regmap_fields_update_bits_base(struct regmap_field *field, unsigned int id, |
1007 | unsigned int mask, unsigned int val, | |
1008 | bool *change, bool async, bool force); | |
76aad392 | 1009 | |
f8beab2b | 1010 | /** |
2cf8e2df | 1011 | * struct regmap_irq - Description of an IRQ for the generic regmap irq_chip. |
f8beab2b MB |
1012 | * |
1013 | * @reg_offset: Offset of the status/mask register within the bank | |
1014 | * @mask: Mask used to flag/control the register. | |
7a78479f LD |
1015 | * @type_reg_offset: Offset register for the irq type setting. |
1016 | * @type_rising_mask: Mask bit to configure RISING type irq. | |
1017 | * @type_falling_mask: Mask bit to configure FALLING type irq. | |
f8beab2b MB |
1018 | */ |
1019 | struct regmap_irq { | |
1020 | unsigned int reg_offset; | |
1021 | unsigned int mask; | |
7a78479f LD |
1022 | unsigned int type_reg_offset; |
1023 | unsigned int type_rising_mask; | |
1024 | unsigned int type_falling_mask; | |
f8beab2b MB |
1025 | }; |
1026 | ||
b4fe8ba7 QZ |
1027 | #define REGMAP_IRQ_REG(_irq, _off, _mask) \ |
1028 | [_irq] = { .reg_offset = (_off), .mask = (_mask) } | |
1029 | ||
f8beab2b | 1030 | /** |
2cf8e2df | 1031 | * struct regmap_irq_chip - Description of a generic regmap irq_chip. |
f8beab2b MB |
1032 | * |
1033 | * @name: Descriptive name for IRQ controller. | |
1034 | * | |
1035 | * @status_base: Base status register address. | |
1036 | * @mask_base: Base mask register address. | |
a71411db | 1037 | * @mask_writeonly: Base mask register is write only. |
7b7d1968 GZ |
1038 | * @unmask_base: Base unmask register address. for chips who have |
1039 | * separate mask and unmask registers | |
d3233433 AS |
1040 | * @ack_base: Base ack address. If zero then the chip is clear on read. |
1041 | * Using zero value is possible with @use_ack bit. | |
a43fd50d | 1042 | * @wake_base: Base address for wake enables. If zero unsupported. |
7a78479f | 1043 | * @type_base: Base address for irq type. If zero unsupported. |
022f926a | 1044 | * @irq_reg_stride: Stride to use for chips where registers are not contiguous. |
2753e6f8 | 1045 | * @init_ack_masked: Ack all masked interrupts once during initalization. |
68622bdf | 1046 | * @mask_invert: Inverted mask register: cleared bits are masked out. |
d3233433 | 1047 | * @use_ack: Use @ack register even if it is zero. |
a650fdd9 | 1048 | * @ack_invert: Inverted ack register: cleared bits for ack. |
68622bdf | 1049 | * @wake_invert: Inverted wake register: cleared bits are wake enabled. |
7a78479f | 1050 | * @type_invert: Invert the type flags. |
0c00c50b | 1051 | * @runtime_pm: Hold a runtime PM lock on the device when accessing it. |
f8beab2b MB |
1052 | * |
1053 | * @num_regs: Number of registers in each control bank. | |
1054 | * @irqs: Descriptors for individual IRQs. Interrupt numbers are | |
1055 | * assigned based on the index in the array of the interrupt. | |
1056 | * @num_irqs: Number of descriptors. | |
7a78479f LD |
1057 | * @num_type_reg: Number of type registers. |
1058 | * @type_reg_stride: Stride to use for chips where type registers are not | |
1059 | * contiguous. | |
ccc12561 LD |
1060 | * @handle_pre_irq: Driver specific callback to handle interrupt from device |
1061 | * before regmap_irq_handler process the interrupts. | |
1062 | * @handle_post_irq: Driver specific callback to handle interrupt from device | |
1063 | * after handling the interrupts in regmap_irq_handler(). | |
1064 | * @irq_drv_data: Driver specific IRQ data which is passed as parameter when | |
1065 | * driver specific pre/post interrupt handler is called. | |
2cf8e2df CK |
1066 | * |
1067 | * This is not intended to handle every possible interrupt controller, but | |
1068 | * it should handle a substantial proportion of those that are found in the | |
1069 | * wild. | |
f8beab2b MB |
1070 | */ |
1071 | struct regmap_irq_chip { | |
1072 | const char *name; | |
1073 | ||
1074 | unsigned int status_base; | |
1075 | unsigned int mask_base; | |
7b7d1968 | 1076 | unsigned int unmask_base; |
f8beab2b | 1077 | unsigned int ack_base; |
a43fd50d | 1078 | unsigned int wake_base; |
7a78479f | 1079 | unsigned int type_base; |
022f926a | 1080 | unsigned int irq_reg_stride; |
a71411db | 1081 | bool mask_writeonly:1; |
f484f7a6 PZ |
1082 | bool init_ack_masked:1; |
1083 | bool mask_invert:1; | |
d3233433 | 1084 | bool use_ack:1; |
a650fdd9 | 1085 | bool ack_invert:1; |
f484f7a6 PZ |
1086 | bool wake_invert:1; |
1087 | bool runtime_pm:1; | |
7a78479f | 1088 | bool type_invert:1; |
f8beab2b MB |
1089 | |
1090 | int num_regs; | |
1091 | ||
1092 | const struct regmap_irq *irqs; | |
1093 | int num_irqs; | |
7a78479f LD |
1094 | |
1095 | int num_type_reg; | |
1096 | unsigned int type_reg_stride; | |
ccc12561 LD |
1097 | |
1098 | int (*handle_pre_irq)(void *irq_drv_data); | |
1099 | int (*handle_post_irq)(void *irq_drv_data); | |
1100 | void *irq_drv_data; | |
f8beab2b MB |
1101 | }; |
1102 | ||
1103 | struct regmap_irq_chip_data; | |
1104 | ||
1105 | int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags, | |
b026ddbb | 1106 | int irq_base, const struct regmap_irq_chip *chip, |
f8beab2b MB |
1107 | struct regmap_irq_chip_data **data); |
1108 | void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data); | |
045b9848 LD |
1109 | |
1110 | int devm_regmap_add_irq_chip(struct device *dev, struct regmap *map, int irq, | |
1111 | int irq_flags, int irq_base, | |
1112 | const struct regmap_irq_chip *chip, | |
1113 | struct regmap_irq_chip_data **data); | |
1114 | void devm_regmap_del_irq_chip(struct device *dev, int irq, | |
1115 | struct regmap_irq_chip_data *data); | |
1116 | ||
209a6006 | 1117 | int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data); |
4af8be67 | 1118 | int regmap_irq_get_virq(struct regmap_irq_chip_data *data, int irq); |
90f790d2 | 1119 | struct irq_domain *regmap_irq_get_domain(struct regmap_irq_chip_data *data); |
92afb286 | 1120 | |
9cde5fcd MB |
1121 | #else |
1122 | ||
1123 | /* | |
1124 | * These stubs should only ever be called by generic code which has | |
1125 | * regmap based facilities, if they ever get called at runtime | |
1126 | * something is going wrong and something probably needs to select | |
1127 | * REGMAP. | |
1128 | */ | |
1129 | ||
1130 | static inline int regmap_write(struct regmap *map, unsigned int reg, | |
1131 | unsigned int val) | |
1132 | { | |
1133 | WARN_ONCE(1, "regmap API is disabled"); | |
1134 | return -EINVAL; | |
1135 | } | |
1136 | ||
915f441b MB |
1137 | static inline int regmap_write_async(struct regmap *map, unsigned int reg, |
1138 | unsigned int val) | |
1139 | { | |
1140 | WARN_ONCE(1, "regmap API is disabled"); | |
1141 | return -EINVAL; | |
1142 | } | |
1143 | ||
9cde5fcd MB |
1144 | static inline int regmap_raw_write(struct regmap *map, unsigned int reg, |
1145 | const void *val, size_t val_len) | |
1146 | { | |
1147 | WARN_ONCE(1, "regmap API is disabled"); | |
1148 | return -EINVAL; | |
1149 | } | |
1150 | ||
0d509f2b MB |
1151 | static inline int regmap_raw_write_async(struct regmap *map, unsigned int reg, |
1152 | const void *val, size_t val_len) | |
1153 | { | |
1154 | WARN_ONCE(1, "regmap API is disabled"); | |
1155 | return -EINVAL; | |
1156 | } | |
1157 | ||
9cde5fcd MB |
1158 | static inline int regmap_bulk_write(struct regmap *map, unsigned int reg, |
1159 | const void *val, size_t val_count) | |
1160 | { | |
1161 | WARN_ONCE(1, "regmap API is disabled"); | |
1162 | return -EINVAL; | |
1163 | } | |
1164 | ||
1165 | static inline int regmap_read(struct regmap *map, unsigned int reg, | |
1166 | unsigned int *val) | |
1167 | { | |
1168 | WARN_ONCE(1, "regmap API is disabled"); | |
1169 | return -EINVAL; | |
1170 | } | |
1171 | ||
1172 | static inline int regmap_raw_read(struct regmap *map, unsigned int reg, | |
1173 | void *val, size_t val_len) | |
1174 | { | |
1175 | WARN_ONCE(1, "regmap API is disabled"); | |
1176 | return -EINVAL; | |
1177 | } | |
1178 | ||
1179 | static inline int regmap_bulk_read(struct regmap *map, unsigned int reg, | |
1180 | void *val, size_t val_count) | |
1181 | { | |
1182 | WARN_ONCE(1, "regmap API is disabled"); | |
1183 | return -EINVAL; | |
1184 | } | |
1185 | ||
91d31b9f KM |
1186 | static inline int regmap_update_bits_base(struct regmap *map, unsigned int reg, |
1187 | unsigned int mask, unsigned int val, | |
1188 | bool *change, bool async, bool force) | |
fd4b7286 KM |
1189 | { |
1190 | WARN_ONCE(1, "regmap API is disabled"); | |
1191 | return -EINVAL; | |
1192 | } | |
1193 | ||
28972eaa KM |
1194 | static inline int regmap_field_update_bits_base(struct regmap_field *field, |
1195 | unsigned int mask, unsigned int val, | |
1196 | bool *change, bool async, bool force) | |
915f441b MB |
1197 | { |
1198 | WARN_ONCE(1, "regmap API is disabled"); | |
1199 | return -EINVAL; | |
1200 | } | |
1201 | ||
e126edec KM |
1202 | static inline int regmap_fields_update_bits_base(struct regmap_field *field, |
1203 | unsigned int id, | |
1204 | unsigned int mask, unsigned int val, | |
1205 | bool *change, bool async, bool force) | |
915f441b MB |
1206 | { |
1207 | WARN_ONCE(1, "regmap API is disabled"); | |
1208 | return -EINVAL; | |
1209 | } | |
1210 | ||
9cde5fcd MB |
1211 | static inline int regmap_get_val_bytes(struct regmap *map) |
1212 | { | |
1213 | WARN_ONCE(1, "regmap API is disabled"); | |
1214 | return -EINVAL; | |
1215 | } | |
1216 | ||
668abc72 SK |
1217 | static inline int regmap_get_max_register(struct regmap *map) |
1218 | { | |
1219 | WARN_ONCE(1, "regmap API is disabled"); | |
1220 | return -EINVAL; | |
1221 | } | |
1222 | ||
a2f776cb SK |
1223 | static inline int regmap_get_reg_stride(struct regmap *map) |
1224 | { | |
1225 | WARN_ONCE(1, "regmap API is disabled"); | |
1226 | return -EINVAL; | |
1227 | } | |
1228 | ||
9cde5fcd MB |
1229 | static inline int regcache_sync(struct regmap *map) |
1230 | { | |
1231 | WARN_ONCE(1, "regmap API is disabled"); | |
1232 | return -EINVAL; | |
1233 | } | |
1234 | ||
a313f9f5 MB |
1235 | static inline int regcache_sync_region(struct regmap *map, unsigned int min, |
1236 | unsigned int max) | |
1237 | { | |
1238 | WARN_ONCE(1, "regmap API is disabled"); | |
1239 | return -EINVAL; | |
1240 | } | |
1241 | ||
697e85bc MB |
1242 | static inline int regcache_drop_region(struct regmap *map, unsigned int min, |
1243 | unsigned int max) | |
1244 | { | |
1245 | WARN_ONCE(1, "regmap API is disabled"); | |
1246 | return -EINVAL; | |
1247 | } | |
1248 | ||
9cde5fcd MB |
1249 | static inline void regcache_cache_only(struct regmap *map, bool enable) |
1250 | { | |
1251 | WARN_ONCE(1, "regmap API is disabled"); | |
1252 | } | |
1253 | ||
1254 | static inline void regcache_cache_bypass(struct regmap *map, bool enable) | |
1255 | { | |
1256 | WARN_ONCE(1, "regmap API is disabled"); | |
1257 | } | |
1258 | ||
1259 | static inline void regcache_mark_dirty(struct regmap *map) | |
1260 | { | |
1261 | WARN_ONCE(1, "regmap API is disabled"); | |
1262 | } | |
1263 | ||
0d509f2b MB |
1264 | static inline void regmap_async_complete(struct regmap *map) |
1265 | { | |
1266 | WARN_ONCE(1, "regmap API is disabled"); | |
1267 | } | |
1268 | ||
9cde5fcd | 1269 | static inline int regmap_register_patch(struct regmap *map, |
a6baa3de | 1270 | const struct reg_sequence *regs, |
9cde5fcd MB |
1271 | int num_regs) |
1272 | { | |
1273 | WARN_ONCE(1, "regmap API is disabled"); | |
1274 | return -EINVAL; | |
1275 | } | |
1276 | ||
13ff50c8 NC |
1277 | static inline int regmap_parse_val(struct regmap *map, const void *buf, |
1278 | unsigned int *val) | |
1279 | { | |
1280 | WARN_ONCE(1, "regmap API is disabled"); | |
1281 | return -EINVAL; | |
1282 | } | |
1283 | ||
72b39f6f MB |
1284 | static inline struct regmap *dev_get_regmap(struct device *dev, |
1285 | const char *name) | |
1286 | { | |
72b39f6f MB |
1287 | return NULL; |
1288 | } | |
1289 | ||
8d7d3972 TT |
1290 | static inline struct device *regmap_get_device(struct regmap *map) |
1291 | { | |
1292 | WARN_ONCE(1, "regmap API is disabled"); | |
1d33dc6b | 1293 | return NULL; |
8d7d3972 TT |
1294 | } |
1295 | ||
9cde5fcd MB |
1296 | #endif |
1297 | ||
b83a313b | 1298 | #endif |