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