blob: 1781b6cb793c4cf7541d54d0379551feaf6d541c [file] [log] [blame]
Mark Brownb83a3132011-05-11 19:59:58 +02001#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
Mark Brownb83a3132011-05-11 19:59:58 +020016#include <linux/list.h>
Krystian Garbaciak6863ca62012-06-15 11:23:56 +010017#include <linux/rbtree.h>
Sean Wangf15cd6d2018-04-23 14:42:44 +080018#include <linux/ktime.h>
Masahiro Yamadaadf08d42016-10-13 19:07:54 +090019#include <linux/delay.h>
Mateusz Krawczuk49ccc142013-08-06 18:34:40 +020020#include <linux/err.h>
Kevin Hilman3f0fa9a2013-08-14 16:05:02 -070021#include <linux/bug.h>
Nicolas Boichat3cfe7a72015-07-08 14:30:18 +080022#include <linux/lockdep.h>
Mark Brownb83a3132011-05-11 19:59:58 +020023
Paul Gortmakerde477252011-05-26 13:46:22 -040024struct module;
Maxime Ripard31895662018-02-21 10:20:25 +010025struct clk;
Paul Gortmaker313162d2012-01-30 11:46:54 -050026struct device;
Mark Brown9943fa32011-06-20 19:02:29 +010027struct i2c_client;
Mark Brown90f790d2012-08-20 21:45:05 +010028struct irq_domain;
Srinivas Kandagatla7d6f7fb2017-12-11 23:43:02 +000029struct slim_device;
Mark Browna676f082011-05-12 11:42:10 +020030struct spi_device;
Josh Cartwrighta01779f2013-10-28 13:12:35 -050031struct spmi_device;
Mark Brownb83d2ff2012-03-11 11:49:17 +000032struct regmap;
Krystian Garbaciak6863ca62012-06-15 11:23:56 +010033struct regmap_range_cfg;
Srinivas Kandagatla67252282013-06-11 13:18:15 +010034struct regmap_field;
Mark Brown22853222014-11-18 19:45:51 +010035struct snd_ac97;
Vinod Koul7c22ce62018-01-08 15:50:59 +053036struct sdw_slave;
Mark Brown9943fa32011-06-20 19:02:29 +010037
Dimitris Papastamos9fabe242011-09-19 14:34:00 +010038/* An enum of all the supported cache types */
39enum regcache_type {
40 REGCACHE_NONE,
Dimitris Papastamos28644c802011-09-19 14:34:02 +010041 REGCACHE_RBTREE,
Mark Brown2ac902c2012-12-19 14:51:55 +000042 REGCACHE_COMPRESSED,
43 REGCACHE_FLAT,
Dimitris Papastamos9fabe242011-09-19 14:34:00 +010044};
45
Mark Browndd898b22011-07-20 22:28:58 +010046/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +000047 * struct reg_default - Default value for a register.
Mark Brownbd20eb52011-08-19 18:09:38 +090048 *
49 * @reg: Register address.
50 * @def: Register default value.
Charles Keepax2cf8e2d2017-01-12 11:17:39 +000051 *
52 * We use an array of structs rather than a simple array as many modern devices
53 * have very sparse register maps.
Mark Brownbd20eb52011-08-19 18:09:38 +090054 */
55struct reg_default {
56 unsigned int reg;
57 unsigned int def;
58};
59
Nariman Poushin8019ff62015-07-16 16:36:21 +010060/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +000061 * struct reg_sequence - An individual write from a sequence of writes.
Nariman Poushin8019ff62015-07-16 16:36:21 +010062 *
63 * @reg: Register address.
64 * @def: Register value.
Nariman Poushin2de9d602015-07-16 16:36:22 +010065 * @delay_us: Delay to be applied after the register write in microseconds
Charles Keepax2cf8e2d2017-01-12 11:17:39 +000066 *
67 * Register/value pairs for sequences of writes with an optional delay in
68 * microseconds to be applied after each write.
Nariman Poushin8019ff62015-07-16 16:36:21 +010069 */
70struct reg_sequence {
71 unsigned int reg;
72 unsigned int def;
Nariman Poushin2de9d602015-07-16 16:36:22 +010073 unsigned int delay_us;
Nariman Poushin8019ff62015-07-16 16:36:21 +010074};
75
Kuninori Morimotoca7a9442016-02-15 05:22:42 +000076#define regmap_update_bits(map, reg, mask, val) \
77 regmap_update_bits_base(map, reg, mask, val, NULL, false, false)
Kuninori Morimoto30ed9cb2016-02-15 05:23:01 +000078#define regmap_update_bits_async(map, reg, mask, val)\
79 regmap_update_bits_base(map, reg, mask, val, NULL, true, false)
Kuninori Morimoto98c2dc42016-02-15 05:23:17 +000080#define regmap_update_bits_check(map, reg, mask, val, change)\
81 regmap_update_bits_base(map, reg, mask, val, change, false, false)
Kuninori Morimoto89d8d4b2016-02-15 05:23:37 +000082#define regmap_update_bits_check_async(map, reg, mask, val, change)\
83 regmap_update_bits_base(map, reg, mask, val, change, true, false)
Kuninori Morimotoca7a9442016-02-15 05:22:42 +000084
Kuninori Morimotob8219572016-03-03 00:48:30 +000085#define regmap_write_bits(map, reg, mask, val) \
86 regmap_update_bits_base(map, reg, mask, val, NULL, false, true)
87
Kuninori Morimoto36741242016-02-15 05:24:15 +000088#define regmap_field_write(field, val) \
89 regmap_field_update_bits_base(field, ~0, val, NULL, false, false)
Kuninori Morimoto489061b2016-02-15 05:25:54 +000090#define regmap_field_force_write(field, val) \
91 regmap_field_update_bits_base(field, ~0, val, NULL, false, true)
Kuninori Morimoto721ed642016-02-15 05:24:33 +000092#define regmap_field_update_bits(field, mask, val)\
93 regmap_field_update_bits_base(field, mask, val, NULL, false, false)
Kuninori Morimoto489061b2016-02-15 05:25:54 +000094#define regmap_field_force_update_bits(field, mask, val) \
95 regmap_field_update_bits_base(field, mask, val, NULL, false, true)
Kuninori Morimoto36741242016-02-15 05:24:15 +000096
Kuninori Morimotobbf2c462016-02-15 05:25:15 +000097#define regmap_fields_write(field, id, val) \
98 regmap_fields_update_bits_base(field, id, ~0, val, NULL, false, false)
Kuninori Morimotoe6ef2432016-02-15 05:26:14 +000099#define regmap_fields_force_write(field, id, val) \
100 regmap_fields_update_bits_base(field, id, ~0, val, NULL, false, true)
Kuninori Morimoto48138602016-02-15 05:25:32 +0000101#define regmap_fields_update_bits(field, id, mask, val)\
102 regmap_fields_update_bits_base(field, id, mask, val, NULL, false, false)
Kuninori Morimotoe6ef2432016-02-15 05:26:14 +0000103#define regmap_fields_force_update_bits(field, id, mask, val) \
104 regmap_fields_update_bits_base(field, id, mask, val, NULL, false, true)
Kuninori Morimotobbf2c462016-02-15 05:25:15 +0000105
Philipp Zabel08188ba2016-07-06 16:19:41 +0200106/**
107 * regmap_read_poll_timeout - Poll until a condition is met or a timeout occurs
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000108 *
Philipp Zabel08188ba2016-07-06 16:19:41 +0200109 * @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({ \
Arnd Bergmann1b0c22e2017-10-13 14:12:45 +0200127 u64 __timeout_us = (timeout_us); \
128 unsigned long __sleep_us = (sleep_us); \
129 ktime_t __timeout = ktime_add_us(ktime_get(), __timeout_us); \
Ramesh Shanmugasundaram780b1352017-07-03 12:04:21 +0100130 int __ret; \
Arnd Bergmann1b0c22e2017-10-13 14:12:45 +0200131 might_sleep_if(__sleep_us); \
Philipp Zabel08188ba2016-07-06 16:19:41 +0200132 for (;;) { \
Ramesh Shanmugasundaram780b1352017-07-03 12:04:21 +0100133 __ret = regmap_read((map), (addr), &(val)); \
134 if (__ret) \
Philipp Zabel08188ba2016-07-06 16:19:41 +0200135 break; \
136 if (cond) \
137 break; \
Arnd Bergmann1b0c22e2017-10-13 14:12:45 +0200138 if ((__timeout_us) && \
Ramesh Shanmugasundaram780b1352017-07-03 12:04:21 +0100139 ktime_compare(ktime_get(), __timeout) > 0) { \
140 __ret = regmap_read((map), (addr), &(val)); \
Philipp Zabel08188ba2016-07-06 16:19:41 +0200141 break; \
142 } \
Arnd Bergmann1b0c22e2017-10-13 14:12:45 +0200143 if (__sleep_us) \
144 usleep_range((__sleep_us >> 2) + 1, __sleep_us); \
Philipp Zabel08188ba2016-07-06 16:19:41 +0200145 } \
Ramesh Shanmugasundaram780b1352017-07-03 12:04:21 +0100146 __ret ?: ((cond) ? 0 : -ETIMEDOUT); \
Philipp Zabel08188ba2016-07-06 16:19:41 +0200147})
148
Chen-Yu Tsai667063a2017-09-29 16:23:01 +0800149/**
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({ \
Arnd Bergmann1b0c22e2017-10-13 14:12:45 +0200169 u64 __timeout_us = (timeout_us); \
170 unsigned long __sleep_us = (sleep_us); \
171 ktime_t timeout = ktime_add_us(ktime_get(), __timeout_us); \
Chen-Yu Tsai667063a2017-09-29 16:23:01 +0800172 int pollret; \
Arnd Bergmann1b0c22e2017-10-13 14:12:45 +0200173 might_sleep_if(__sleep_us); \
Chen-Yu Tsai667063a2017-09-29 16:23:01 +0800174 for (;;) { \
175 pollret = regmap_field_read((field), &(val)); \
176 if (pollret) \
177 break; \
178 if (cond) \
179 break; \
Arnd Bergmann1b0c22e2017-10-13 14:12:45 +0200180 if (__timeout_us && ktime_compare(ktime_get(), timeout) > 0) { \
Chen-Yu Tsai667063a2017-09-29 16:23:01 +0800181 pollret = regmap_field_read((field), &(val)); \
182 break; \
183 } \
Arnd Bergmann1b0c22e2017-10-13 14:12:45 +0200184 if (__sleep_us) \
185 usleep_range((__sleep_us >> 2) + 1, __sleep_us); \
Chen-Yu Tsai667063a2017-09-29 16:23:01 +0800186 } \
187 pollret ?: ((cond) ? 0 : -ETIMEDOUT); \
188})
189
Mark Brownb83d2ff2012-03-11 11:49:17 +0000190#ifdef CONFIG_REGMAP
191
Stephen Warren141eba22012-05-24 10:47:26 -0600192enum 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
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100200/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000201 * struct regmap_range - A register range, used for access related checks
202 * (readable/writeable/volatile/precious checks)
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100203 *
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
Laxman Dewangan6112fe62013-09-20 18:00:10 +0530212#define regmap_reg_range(low, high) { .range_min = low, .range_max = high, }
213
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000214/**
215 * struct regmap_access_table - A table of register ranges for access checks
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100216 *
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
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000221 *
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.
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100226 */
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
Davide Ciminaghi0d4529c2012-10-16 15:56:59 +0200234typedef void (*regmap_lock)(void *);
235typedef void (*regmap_unlock)(void *);
236
Mark Brownbd20eb52011-08-19 18:09:38 +0900237/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000238 * struct regmap_config - Configuration for the register map of a device.
Mark Browndd898b22011-07-20 22:28:58 +0100239 *
Stephen Warrend3c242e2012-04-04 15:48:29 -0600240 * @name: Optional name of the regmap. Useful when a device has multiple
241 * register regions.
242 *
Mark Browndd898b22011-07-20 22:28:58 +0100243 * @reg_bits: Number of bits in a register address, mandatory.
Stephen Warrenf01ee602012-04-09 13:40:24 -0600244 * @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.
Mark Brown82159ba2012-01-18 10:52:25 +0000247 * @pad_bits: Number of bits of padding between register and value.
Mark Browndd898b22011-07-20 22:28:58 +0100248 * @val_bits: Number of bits in a register value, mandatory.
Mark Brown2e2ae662011-07-20 22:33:39 +0100249 *
Mark Brown3566cc92011-08-09 10:23:22 +0900250 * @writeable_reg: Optional callback returning true if the register
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100251 * 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).
Mark Brown3566cc92011-08-09 10:23:22 +0900255 * @readable_reg: Optional callback returning true if the register
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100256 * 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).
Mark Brown3566cc92011-08-09 10:23:22 +0900260 * @volatile_reg: Optional callback returning true if the register
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100261 * 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).
Laszlo Pappbdc39642014-01-09 14:13:41 +0000265 * @precious_reg: Optional callback returning true if the register
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100266 * should not be read outside of a call from the driver
Laszlo Pappbdc39642014-01-09 14:13:41 +0000267 * (e.g., a clear on read interrupt status register). If this
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100268 * 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).
Ben Whittencdf6b112018-10-19 10:33:50 +0100271 * @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).
Crestez Dan Leonard74fe7b52018-08-07 17:52:17 +0300278 * @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).
Bartosz Golaszewskic9b41fc2017-12-06 15:26:21 +0100285 * @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.
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100288 * @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).
Andrey Smirnovd2a58842013-01-27 10:49:05 -0800294 * @reg_read: Optional callback that if filled will be used to perform
295 * all the reads from the registers. Should only be provided for
Laszlo Pappbdc39642014-01-09 14:13:41 +0000296 * 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.
Andrey Smirnovd2a58842013-01-27 10:49:05 -0800299 * @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.
Stefan Agnerb429fab2016-01-19 17:14:39 -0800306 * @max_register: Optional, specifies the maximum valid register address.
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100307 * @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.
Ben Whittencdf6b112018-10-19 10:33:50 +0100312 * @wr_noinc_table: As above, for no increment writeable registers.
Crestez Dan Leonard74fe7b52018-08-07 17:52:17 +0300313 * @rd_noinc_table: As above, for no increment readable registers.
Mark Brownbd20eb52011-08-19 18:09:38 +0900314 * @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.
Lars-Peter Clausen6f306442011-09-05 20:46:32 +0200317 *
Tony Lindgrenf50e38c2016-09-15 13:56:10 -0700318 * @read_flag_mask: Mask to be set in the top bytes of the register when doing
Lars-Peter Clausen6f306442011-09-05 20:46:32 +0200319 * a read.
Tony Lindgrenf50e38c2016-09-15 13:56:10 -0700320 * @write_flag_mask: Mask to be set in the top bytes of the register when doing
Lars-Peter Clausen6f306442011-09-05 20:46:32 +0200321 * a write. If both read_flag_mask and write_flag_mask are
Andrew F. Davis9bf485c2018-01-07 17:19:09 -0600322 * 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.
David Frey1c96a2f2018-09-01 09:50:41 -0700326 * @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.
Opensource [Anthony Olech]e894c3f2014-03-04 13:54:02 +0000332 * @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
Dimitris Papastamos9fabe242011-09-19 14:34:00 +0100335 *
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.
Stephen Warren141eba22012-05-24 10:47:26 -0600340 * @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.
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100346 *
347 * @ranges: Array of configuration entries for virtual address ranges.
348 * @num_ranges: Number of range configuration entries.
Baolin Wanga4887812017-12-25 14:37:09 +0800349 * @use_hwlock: Indicate if a hardware spinlock should be used.
Baolin Wang8698b932017-11-01 10:11:55 +0800350 * @hwlock_id: Specify the hardware spinlock id.
351 * @hwlock_mode: The hardware spinlock mode, should be HWLOCK_IRQSTATE,
352 * HWLOCK_IRQ or 0.
Mark Browndd898b22011-07-20 22:28:58 +0100353 */
Mark Brownb83a3132011-05-11 19:59:58 +0200354struct regmap_config {
Stephen Warrend3c242e2012-04-04 15:48:29 -0600355 const char *name;
356
Mark Brownb83a3132011-05-11 19:59:58 +0200357 int reg_bits;
Stephen Warrenf01ee602012-04-09 13:40:24 -0600358 int reg_stride;
Mark Brown82159ba2012-01-18 10:52:25 +0000359 int pad_bits;
Mark Brownb83a3132011-05-11 19:59:58 +0200360 int val_bits;
Mark Brown2e2ae662011-07-20 22:33:39 +0100361
Mark Brown2e2ae662011-07-20 22:33:39 +0100362 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);
Mark Brown18694882011-08-08 15:40:22 +0900365 bool (*precious_reg)(struct device *dev, unsigned int reg);
Ben Whittencdf6b112018-10-19 10:33:50 +0100366 bool (*writeable_noinc_reg)(struct device *dev, unsigned int reg);
Crestez Dan Leonard74fe7b52018-08-07 17:52:17 +0300367 bool (*readable_noinc_reg)(struct device *dev, unsigned int reg);
Bartosz Golaszewskic9b41fc2017-12-06 15:26:21 +0100368
369 bool disable_locking;
Davide Ciminaghi0d4529c2012-10-16 15:56:59 +0200370 regmap_lock lock;
371 regmap_unlock unlock;
372 void *lock_arg;
Mark Brownbd20eb52011-08-19 18:09:38 +0900373
Andrey Smirnovd2a58842013-01-27 10:49:05 -0800374 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
Mark Brownbd20eb52011-08-19 18:09:38 +0900379 unsigned int max_register;
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100380 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;
Ben Whittencdf6b112018-10-19 10:33:50 +0100384 const struct regmap_access_table *wr_noinc_table;
Crestez Dan Leonard74fe7b52018-08-07 17:52:17 +0300385 const struct regmap_access_table *rd_noinc_table;
Lars-Peter Clausen720e4612011-11-16 16:28:17 +0100386 const struct reg_default *reg_defaults;
Dimitris Papastamos9fabe242011-09-19 14:34:00 +0100387 unsigned int num_reg_defaults;
388 enum regcache_type cache_type;
389 const void *reg_defaults_raw;
390 unsigned int num_reg_defaults_raw;
Lars-Peter Clausen6f306442011-09-05 20:46:32 +0200391
Tony Lindgrenf50e38c2016-09-15 13:56:10 -0700392 unsigned long read_flag_mask;
393 unsigned long write_flag_mask;
Andrew F. Davis9bf485c2018-01-07 17:19:09 -0600394 bool zero_flag_mask;
Ashish Jangam2e33caf2012-04-30 23:23:40 +0100395
David Frey1c96a2f2018-09-01 09:50:41 -0700396 bool use_single_read;
397 bool use_single_write;
Opensource [Anthony Olech]e894c3f2014-03-04 13:54:02 +0000398 bool can_multi_write;
Stephen Warren141eba22012-05-24 10:47:26 -0600399
400 enum regmap_endian reg_format_endian;
401 enum regmap_endian val_format_endian;
Mark Brown38e23192012-07-22 19:26:07 +0100402
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100403 const struct regmap_range_cfg *ranges;
Mark Browne3549cd2012-10-02 20:17:15 +0100404 unsigned int num_ranges;
Baolin Wang8698b932017-11-01 10:11:55 +0800405
Baolin Wanga4887812017-12-25 14:37:09 +0800406 bool use_hwlock;
Baolin Wang8698b932017-11-01 10:11:55 +0800407 unsigned int hwlock_id;
408 unsigned int hwlock_mode;
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100409};
410
411/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000412 * struct regmap_range_cfg - Configuration for indirectly accessed or paged
413 * registers.
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100414 *
Mark Brownd058bb42012-10-03 12:40:47 +0100415 * @name: Descriptive name for diagnostics
416 *
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100417 * @range_min: Address of the lowest register address in virtual range.
418 * @range_max: Address of the highest register in virtual range.
419 *
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000420 * @selector_reg: Register with selector field.
421 * @selector_mask: Bit shift for selector value.
422 * @selector_shift: Bit mask for selector value.
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100423 *
424 * @window_start: Address of first (lowest) register in data window.
425 * @window_len: Number of registers in data window.
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000426 *
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.
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100430 */
431struct regmap_range_cfg {
Mark Brownd058bb42012-10-03 12:40:47 +0100432 const char *name;
433
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100434 /* 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;
Mark Brownb83a3132011-05-11 19:59:58 +0200446};
447
Mark Brown0d509f22013-01-27 22:07:38 +0800448struct regmap_async;
449
Stephen Warren0135bbc2012-04-04 15:48:30 -0600450typedef int (*regmap_hw_write)(void *context, const void *data,
Mark Brownb83a3132011-05-11 19:59:58 +0200451 size_t count);
Stephen Warren0135bbc2012-04-04 15:48:30 -0600452typedef int (*regmap_hw_gather_write)(void *context,
Mark Brownb83a3132011-05-11 19:59:58 +0200453 const void *reg, size_t reg_len,
454 const void *val, size_t val_len);
Mark Brown0d509f22013-01-27 22:07:38 +0800455typedef 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);
Stephen Warren0135bbc2012-04-04 15:48:30 -0600459typedef int (*regmap_hw_read)(void *context,
Mark Brownb83a3132011-05-11 19:59:58 +0200460 const void *reg_buf, size_t reg_size,
461 void *val_buf, size_t val_size);
Boris BREZILLON3ac17032014-04-17 11:40:11 +0200462typedef 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);
Jon Ringle77792b12015-10-01 12:38:07 -0400466typedef int (*regmap_hw_reg_update_bits)(void *context, unsigned int reg,
467 unsigned int mask, unsigned int val);
Mark Brown0d509f22013-01-27 22:07:38 +0800468typedef struct regmap_async *(*regmap_hw_async_alloc)(void);
Stephen Warren0135bbc2012-04-04 15:48:30 -0600469typedef void (*regmap_hw_free_context)(void *context);
Mark Brownb83a3132011-05-11 19:59:58 +0200470
471/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000472 * struct regmap_bus - Description of a hardware bus for the register map
473 * infrastructure.
Mark Brownb83a3132011-05-11 19:59:58 +0200474 *
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600475 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
Davide Ciminaghi0d4529c2012-10-16 15:56:59 +0200476 * to perform locking. This field is ignored if custom lock/unlock
477 * functions are used (see fields lock/unlock of
478 * struct regmap_config).
Mark Brownb83a3132011-05-11 19:59:58 +0200479 * @write: Write operation.
480 * @gather_write: Write operation with split register/value, return -ENOTSUPP
481 * if not implemented on a given device.
Mark Brown0d509f22013-01-27 22:07:38 +0800482 * @async_write: Write operation which completes asynchronously, optional and
483 * must serialise with respect to non-async I/O.
Markus Pargmannc5f58f22015-08-21 10:26:40 +0200484 * @reg_write: Write a single register value to the given register address. This
485 * write operation has to complete when returning from the function.
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000486 * @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.
Mark Brownb83a3132011-05-11 19:59:58 +0200490 * @read: Read operation. Data is returned in the buffer used to transmit
491 * data.
Markus Pargmannc5f58f22015-08-21 10:26:40 +0200492 * @reg_read: Read a single register value from a given register address.
493 * @free_context: Free context.
Mark Brown0d509f22013-01-27 22:07:38 +0800494 * @async_alloc: Allocate a regmap_async() structure.
Mark Brownb83a3132011-05-11 19:59:58 +0200495 * @read_flag_mask: Mask to be set in the top byte of the register when doing
496 * a read.
Stephen Warren141eba22012-05-24 10:47:26 -0600497 * @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.
Markus Pargmannadaac452015-08-30 09:33:53 +0200503 * @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.
Mark Brownb83a3132011-05-11 19:59:58 +0200505 */
506struct regmap_bus {
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600507 bool fast_io;
Mark Brownb83a3132011-05-11 19:59:58 +0200508 regmap_hw_write write;
509 regmap_hw_gather_write gather_write;
Mark Brown0d509f22013-01-27 22:07:38 +0800510 regmap_hw_async_write async_write;
Boris BREZILLON3ac17032014-04-17 11:40:11 +0200511 regmap_hw_reg_write reg_write;
Jon Ringle77792b12015-10-01 12:38:07 -0400512 regmap_hw_reg_update_bits reg_update_bits;
Mark Brownb83a3132011-05-11 19:59:58 +0200513 regmap_hw_read read;
Boris BREZILLON3ac17032014-04-17 11:40:11 +0200514 regmap_hw_reg_read reg_read;
Stephen Warren0135bbc2012-04-04 15:48:30 -0600515 regmap_hw_free_context free_context;
Mark Brown0d509f22013-01-27 22:07:38 +0800516 regmap_hw_async_alloc async_alloc;
Mark Brownb83a3132011-05-11 19:59:58 +0200517 u8 read_flag_mask;
Stephen Warren141eba22012-05-24 10:47:26 -0600518 enum regmap_endian reg_format_endian_default;
519 enum regmap_endian val_format_endian_default;
Markus Pargmannadaac452015-08-30 09:33:53 +0200520 size_t max_raw_read;
521 size_t max_raw_write;
Mark Brownb83a3132011-05-11 19:59:58 +0200522};
523
Nicolas Boichat3cfe7a72015-07-08 14:30:18 +0800524/*
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);
Akinobu Mitabcf7eac2018-07-17 00:47:48 +0900541struct 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);
Srinivas Kandagatla7d6f7fb2017-12-11 23:43:02 +0000545struct 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);
Nicolas Boichat3cfe7a72015-07-08 14:30:18 +0800549struct 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);
Alex A. Mihaylovcc5d0db2017-06-02 10:06:27 +0300561struct 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);
Nicolas Boichat3cfe7a72015-07-08 14:30:18 +0800565struct 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);
Vinod Koul7c22ce62018-01-08 15:50:59 +0530574struct 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);
Nicolas Boichat3cfe7a72015-07-08 14:30:18 +0800578
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);
Akinobu Mitabcf7eac2018-07-17 00:47:48 +0900589struct 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);
Nicolas Boichat3cfe7a72015-07-08 14:30:18 +0800593struct 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);
Alex A. Mihaylovcc5d0db2017-06-02 10:06:27 +0300605struct 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);
Nicolas Boichat3cfe7a72015-07-08 14:30:18 +0800609struct 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);
Vinod Koul7c22ce62018-01-08 15:50:59 +0530619struct 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);
Srinivas Kandagatlaed24d562018-05-25 14:50:36 +0100623struct 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);
Nicolas Boichat3cfe7a72015-07-08 14:30:18 +0800627/*
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
Nicolas Boichat1ed81112015-08-11 18:04:21 +0800649/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000650 * regmap_init() - Initialise register map
Nicolas Boichat1ed81112015-08-11 18:04:21 +0800651 *
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 */
Nicolas Boichat3cfe7a72015-07-08 14:30:18 +0800661#define regmap_init(dev, bus, bus_context, config) \
662 __regmap_lockdep_wrapper(__regmap_init, #config, \
663 dev, bus, bus_context, config)
Michal Simek6cfec042014-02-10 16:22:33 +0100664int regmap_attach_dev(struct device *dev, struct regmap *map,
Nicolas Boichat3cfe7a72015-07-08 14:30:18 +0800665 const struct regmap_config *config);
Mark Browna676f082011-05-12 11:42:10 +0200666
Nicolas Boichat1ed81112015-08-11 18:04:21 +0800667/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000668 * regmap_init_i2c() - Initialise register map
Nicolas Boichat1ed81112015-08-11 18:04:21 +0800669 *
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 */
Nicolas Boichat3cfe7a72015-07-08 14:30:18 +0800676#define regmap_init_i2c(i2c, config) \
677 __regmap_lockdep_wrapper(__regmap_init_i2c, #config, \
678 i2c, config)
Mark Brown22853222014-11-18 19:45:51 +0100679
Nicolas Boichat1ed81112015-08-11 18:04:21 +0800680/**
Akinobu Mitabcf7eac2018-07-17 00:47:48 +0900681 * 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
693/**
Srinivas Kandagatla7d6f7fb2017-12-11 23:43:02 +0000694 * 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
706/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000707 * regmap_init_spi() - Initialise register map
Nicolas Boichat1ed81112015-08-11 18:04:21 +0800708 *
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000709 * @dev: Device that will be interacted with
Nicolas Boichat1ed81112015-08-11 18:04:21 +0800710 * @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 */
Nicolas Boichat3cfe7a72015-07-08 14:30:18 +0800715#define regmap_init_spi(dev, config) \
716 __regmap_lockdep_wrapper(__regmap_init_spi, #config, \
717 dev, config)
Nicolas Boichat1ed81112015-08-11 18:04:21 +0800718
719/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000720 * regmap_init_spmi_base() - Create regmap for the Base register space
721 *
722 * @dev: SPMI device that will be interacted with
Nicolas Boichat1ed81112015-08-11 18:04:21 +0800723 * @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 */
Nicolas Boichat3cfe7a72015-07-08 14:30:18 +0800728#define regmap_init_spmi_base(dev, config) \
729 __regmap_lockdep_wrapper(__regmap_init_spmi_base, #config, \
730 dev, config)
Nicolas Boichat1ed81112015-08-11 18:04:21 +0800731
732/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000733 * regmap_init_spmi_ext() - Create regmap for Ext register space
734 *
735 * @dev: Device that will be interacted with
Nicolas Boichat1ed81112015-08-11 18:04:21 +0800736 * @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 */
Nicolas Boichat3cfe7a72015-07-08 14:30:18 +0800741#define regmap_init_spmi_ext(dev, config) \
742 __regmap_lockdep_wrapper(__regmap_init_spmi_ext, #config, \
743 dev, config)
Nicolas Boichat1ed81112015-08-11 18:04:21 +0800744
745/**
Alex A. Mihaylovcc5d0db2017-06-02 10:06:27 +0300746 * 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
758/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000759 * regmap_init_mmio_clk() - Initialise register map with register clock
Nicolas Boichat1ed81112015-08-11 18:04:21 +0800760 *
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 */
Nicolas Boichat3cfe7a72015-07-08 14:30:18 +0800769#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)
Philipp Zabel878ec672013-02-14 17:39:08 +0100772
773/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000774 * regmap_init_mmio() - Initialise register map
Philipp Zabel878ec672013-02-14 17:39:08 +0100775 *
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 */
Nicolas Boichat3cfe7a72015-07-08 14:30:18 +0800783#define regmap_init_mmio(dev, regs, config) \
784 regmap_init_mmio_clk(dev, NULL, regs, config)
Philipp Zabel878ec672013-02-14 17:39:08 +0100785
786/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000787 * regmap_init_ac97() - Initialise AC'97 register map
Nicolas Boichat1ed81112015-08-11 18:04:21 +0800788 *
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 */
795#define regmap_init_ac97(ac97, config) \
796 __regmap_lockdep_wrapper(__regmap_init_ac97, #config, \
797 ac97, config)
798bool regmap_ac97_default_volatile(struct device *dev, unsigned int reg);
799
800/**
Vinod Koul7c22ce62018-01-08 15:50:59 +0530801 * 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
814/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000815 * devm_regmap_init() - Initialise managed register map
Nicolas Boichat1ed81112015-08-11 18:04:21 +0800816 *
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 */
827#define devm_regmap_init(dev, bus, bus_context, config) \
828 __regmap_lockdep_wrapper(__devm_regmap_init, #config, \
829 dev, bus, bus_context, config)
830
831/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000832 * devm_regmap_init_i2c() - Initialise managed register map
Nicolas Boichat1ed81112015-08-11 18:04:21 +0800833 *
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 */
841#define devm_regmap_init_i2c(i2c, config) \
842 __regmap_lockdep_wrapper(__devm_regmap_init_i2c, #config, \
843 i2c, config)
844
845/**
Akinobu Mitabcf7eac2018-07-17 00:47:48 +0900846 * 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
859/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000860 * devm_regmap_init_spi() - Initialise register map
Nicolas Boichat1ed81112015-08-11 18:04:21 +0800861 *
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000862 * @dev: Device that will be interacted with
Nicolas Boichat1ed81112015-08-11 18:04:21 +0800863 * @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 */
869#define devm_regmap_init_spi(dev, config) \
870 __regmap_lockdep_wrapper(__devm_regmap_init_spi, #config, \
871 dev, config)
872
873/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000874 * devm_regmap_init_spmi_base() - Create managed regmap for Base register space
875 *
876 * @dev: SPMI device that will be interacted with
Nicolas Boichat1ed81112015-08-11 18:04:21 +0800877 * @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 */
883#define devm_regmap_init_spmi_base(dev, config) \
884 __regmap_lockdep_wrapper(__devm_regmap_init_spmi_base, #config, \
885 dev, config)
886
887/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000888 * devm_regmap_init_spmi_ext() - Create managed regmap for Ext register space
889 *
890 * @dev: SPMI device that will be interacted with
Nicolas Boichat1ed81112015-08-11 18:04:21 +0800891 * @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 */
897#define devm_regmap_init_spmi_ext(dev, config) \
898 __regmap_lockdep_wrapper(__devm_regmap_init_spmi_ext, #config, \
899 dev, config)
900
901/**
Alex A. Mihaylovcc5d0db2017-06-02 10:06:27 +0300902 * 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)
914/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000915 * devm_regmap_init_mmio_clk() - Initialise managed register map with clock
Nicolas Boichat1ed81112015-08-11 18:04:21 +0800916 *
917 * @dev: Device that will be interacted with
918 * @clk_id: register clock consumer ID
919 * @regs: Pointer to memory-mapped IO region
920 * @config: Configuration for register map
921 *
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.
925 */
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)
Philipp Zabel878ec672013-02-14 17:39:08 +0100929
930/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000931 * devm_regmap_init_mmio() - Initialise managed register map
Philipp Zabel878ec672013-02-14 17:39:08 +0100932 *
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 */
Nicolas Boichat3cfe7a72015-07-08 14:30:18 +0800941#define devm_regmap_init_mmio(dev, regs, config) \
942 devm_regmap_init_mmio_clk(dev, NULL, regs, config)
Mark Brownc0eb4672012-01-30 19:56:52 +0000943
Nicolas Boichat1ed81112015-08-11 18:04:21 +0800944/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +0000945 * devm_regmap_init_ac97() - Initialise AC'97 register map
Nicolas Boichat1ed81112015-08-11 18:04:21 +0800946 *
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)
Mark Brownb83a3132011-05-11 19:59:58 +0200957
Vinod Koul7c22ce62018-01-08 15:50:59 +0530958/**
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
Srinivas Kandagatlaed24d562018-05-25 14:50:36 +0100972/**
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)
Maxime Ripard31895662018-02-21 10:20:25 +0100985int regmap_mmio_attach_clk(struct regmap *map, struct clk *clk);
986void regmap_mmio_detach_clk(struct regmap *map);
Mark Brownb83a3132011-05-11 19:59:58 +0200987void regmap_exit(struct regmap *map);
988int regmap_reinit_cache(struct regmap *map,
989 const struct regmap_config *config);
Mark Brown72b39f62012-05-08 17:44:40 +0100990struct regmap *dev_get_regmap(struct device *dev, const char *name);
Tuomas Tynkkynen8d7d3972014-07-21 18:38:47 +0300991struct device *regmap_get_device(struct regmap *map);
Mark Brownb83a3132011-05-11 19:59:58 +0200992int regmap_write(struct regmap *map, unsigned int reg, unsigned int val);
Mark Brown915f4412013-10-09 13:30:10 +0100993int regmap_write_async(struct regmap *map, unsigned int reg, unsigned int val);
Mark Brownb83a3132011-05-11 19:59:58 +0200994int regmap_raw_write(struct regmap *map, unsigned int reg,
995 const void *val, size_t val_len);
Ben Whittencdf6b112018-10-19 10:33:50 +0100996int regmap_noinc_write(struct regmap *map, unsigned int reg,
997 const void *val, size_t val_len);
Laxman Dewangan8eaeb212012-02-12 19:49:43 +0530998int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
999 size_t val_count);
Nariman Poushin8019ff62015-07-16 16:36:21 +01001000int regmap_multi_reg_write(struct regmap *map, const struct reg_sequence *regs,
Anthony Oleche33fabd2013-10-11 15:31:11 +01001001 int num_regs);
Charles Keepax1d5b40b2014-02-25 13:45:50 +00001002int regmap_multi_reg_write_bypassed(struct regmap *map,
Nariman Poushin8019ff62015-07-16 16:36:21 +01001003 const struct reg_sequence *regs,
Charles Keepax1d5b40b2014-02-25 13:45:50 +00001004 int num_regs);
Mark Brown0d509f22013-01-27 22:07:38 +08001005int regmap_raw_write_async(struct regmap *map, unsigned int reg,
1006 const void *val, size_t val_len);
Mark Brownb83a3132011-05-11 19:59:58 +02001007int 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);
Crestez Dan Leonard74fe7b52018-08-07 17:52:17 +03001010int regmap_noinc_read(struct regmap *map, unsigned int reg,
1011 void *val, size_t val_len);
Mark Brownb83a3132011-05-11 19:59:58 +02001012int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
1013 size_t val_count);
Kuninori Morimoto91d31b92016-02-15 05:22:18 +00001014int regmap_update_bits_base(struct regmap *map, unsigned int reg,
1015 unsigned int mask, unsigned int val,
1016 bool *change, bool async, bool force);
Mark Browna6539c32012-02-17 14:20:14 -08001017int regmap_get_val_bytes(struct regmap *map);
Srinivas Kandagatla668abc72015-05-21 17:42:43 +01001018int regmap_get_max_register(struct regmap *map);
Srinivas Kandagatlaa2f776c2015-05-21 17:42:54 +01001019int regmap_get_reg_stride(struct regmap *map);
Mark Brown0d509f22013-01-27 22:07:38 +08001020int regmap_async_complete(struct regmap *map);
Mark Brown221ad7f2013-03-26 21:24:20 +00001021bool regmap_can_raw_write(struct regmap *map);
Markus Pargmannf50c9eb2015-08-30 09:33:54 +02001022size_t regmap_get_raw_read_max(struct regmap *map);
1023size_t regmap_get_raw_write_max(struct regmap *map);
Mark Brownb83a3132011-05-11 19:59:58 +02001024
Mark Brown39a58432011-09-19 18:21:49 +01001025int regcache_sync(struct regmap *map);
Mark Brown4d4cfd12012-02-23 20:53:37 +00001026int regcache_sync_region(struct regmap *map, unsigned int min,
1027 unsigned int max);
Mark Brown697e85b2013-05-08 13:55:22 +01001028int regcache_drop_region(struct regmap *map, unsigned int min,
1029 unsigned int max);
Mark Brown92afb282011-09-19 18:22:14 +01001030void regcache_cache_only(struct regmap *map, bool enable);
Dimitris Papastamos6eb0f5e2011-09-29 14:36:27 +01001031void regcache_cache_bypass(struct regmap *map, bool enable);
Mark Brown8ae0d7e2011-10-26 10:34:22 +02001032void regcache_mark_dirty(struct regmap *map);
Mark Brown92afb282011-09-19 18:22:14 +01001033
Mark Brown154881e2013-05-08 13:55:23 +01001034bool regmap_check_range_table(struct regmap *map, unsigned int reg,
1035 const struct regmap_access_table *table);
1036
Nariman Poushin8019ff62015-07-16 16:36:21 +01001037int regmap_register_patch(struct regmap *map, const struct reg_sequence *regs,
Mark Brown22f0d902012-01-21 12:01:14 +00001038 int num_regs);
Nenghua Cao13ff50c2014-02-19 18:44:13 +08001039int regmap_parse_val(struct regmap *map, const void *buf,
1040 unsigned int *val);
Mark Brown22f0d902012-01-21 12:01:14 +00001041
Davide Ciminaghi76aad392012-11-20 15:20:30 +01001042static 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
Mark Brownf8beab22011-10-28 23:50:49 +02001052/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +00001053 * struct reg_field - Description of an register field
Srinivas Kandagatla67252282013-06-11 13:18:15 +01001054 *
1055 * @reg: Offset of the register within the regmap bank
1056 * @lsb: lsb of the register field.
Bintian Wangf27b37f2015-01-27 20:50:29 +08001057 * @msb: msb of the register field.
Kuninori Morimotoa0102372013-09-01 20:30:50 -07001058 * @id_size: port size if it has some ports
1059 * @id_offset: address offset for each ports
Srinivas Kandagatla67252282013-06-11 13:18:15 +01001060 */
1061struct reg_field {
1062 unsigned int reg;
1063 unsigned int lsb;
1064 unsigned int msb;
Kuninori Morimotoa0102372013-09-01 20:30:50 -07001065 unsigned int id_size;
1066 unsigned int id_offset;
Srinivas Kandagatla67252282013-06-11 13:18:15 +01001067};
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);
Kuninori Morimoto28972ea2016-02-15 05:23:55 +00001084int regmap_field_update_bits_base(struct regmap_field *field,
1085 unsigned int mask, unsigned int val,
1086 bool *change, bool async, bool force);
Kuninori Morimotoa0102372013-09-01 20:30:50 -07001087int regmap_fields_read(struct regmap_field *field, unsigned int id,
1088 unsigned int *val);
Kuninori Morimotoe126ede2016-02-15 05:24:51 +00001089int 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);
Matti Vaittinen1c2928e2018-12-18 13:59:31 +02001092/**
1093 * struct regmap_irq_type - IRQ type definitions.
1094 *
1095 * @type_reg_offset: Offset register for the irq type setting.
1096 * @type_rising_val: Register value to configure RISING type irq.
1097 * @type_falling_val: Register value to configure FALLING type irq.
1098 * @type_level_low_val: Register value to configure LEVEL_LOW type irq.
1099 * @type_level_high_val: Register value to configure LEVEL_HIGH type irq.
1100 * @types_supported: logical OR of IRQ_TYPE_* flags indicating supported types.
1101 */
1102struct regmap_irq_type {
1103 unsigned int type_reg_offset;
1104 unsigned int type_reg_mask;
1105 unsigned int type_rising_val;
1106 unsigned int type_falling_val;
1107 unsigned int type_level_low_val;
1108 unsigned int type_level_high_val;
1109 unsigned int types_supported;
1110};
Srinivas Kandagatla67252282013-06-11 13:18:15 +01001111
1112/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +00001113 * struct regmap_irq - Description of an IRQ for the generic regmap irq_chip.
Mark Brownf8beab22011-10-28 23:50:49 +02001114 *
1115 * @reg_offset: Offset of the status/mask register within the bank
1116 * @mask: Mask used to flag/control the register.
Matti Vaittinen1c2928e2018-12-18 13:59:31 +02001117 * @type: IRQ trigger type setting details if supported.
Mark Brownf8beab22011-10-28 23:50:49 +02001118 */
1119struct regmap_irq {
1120 unsigned int reg_offset;
1121 unsigned int mask;
Matti Vaittinen1c2928e2018-12-18 13:59:31 +02001122 struct regmap_irq_type type;
Mark Brownf8beab22011-10-28 23:50:49 +02001123};
1124
Qipeng Zhab4fe8ba2015-09-15 00:39:17 +08001125#define REGMAP_IRQ_REG(_irq, _off, _mask) \
1126 [_irq] = { .reg_offset = (_off), .mask = (_mask) }
1127
Tony Xie43fac322018-10-30 18:07:56 +08001128#define REGMAP_IRQ_REG_LINE(_id, _reg_bits) \
1129 [_id] = { \
1130 .mask = BIT((_id) % (_reg_bits)), \
1131 .reg_offset = (_id) / (_reg_bits), \
1132 }
1133
Mark Brownf8beab22011-10-28 23:50:49 +02001134/**
Charles Keepax2cf8e2d2017-01-12 11:17:39 +00001135 * struct regmap_irq_chip - Description of a generic regmap irq_chip.
Mark Brownf8beab22011-10-28 23:50:49 +02001136 *
1137 * @name: Descriptive name for IRQ controller.
1138 *
1139 * @status_base: Base status register address.
1140 * @mask_base: Base mask register address.
Michael Grzeschika71411d2017-06-23 14:35:09 +02001141 * @mask_writeonly: Base mask register is write only.
Guo Zeng7b7d1962015-09-17 05:23:20 +00001142 * @unmask_base: Base unmask register address. for chips who have
1143 * separate mask and unmask registers
Alexander Shiyand3233432013-12-15 13:36:51 +04001144 * @ack_base: Base ack address. If zero then the chip is clear on read.
1145 * Using zero value is possible with @use_ack bit.
Mark Browna43fd502012-06-05 14:34:03 +01001146 * @wake_base: Base address for wake enables. If zero unsupported.
Laxman Dewangan7a78479f2015-12-22 18:25:26 +05301147 * @type_base: Base address for irq type. If zero unsupported.
Graeme Gregory022f926a2012-05-14 22:40:43 +09001148 * @irq_reg_stride: Stride to use for chips where registers are not contiguous.
Philipp Zabel2753e6f2013-07-22 17:15:52 +02001149 * @init_ack_masked: Ack all masked interrupts once during initalization.
Philipp Zabel68622bd2013-07-24 10:26:48 +02001150 * @mask_invert: Inverted mask register: cleared bits are masked out.
Alexander Shiyand3233432013-12-15 13:36:51 +04001151 * @use_ack: Use @ack register even if it is zero.
Guo Zenga650fdd2015-09-17 05:23:21 +00001152 * @ack_invert: Inverted ack register: cleared bits for ack.
Philipp Zabel68622bd2013-07-24 10:26:48 +02001153 * @wake_invert: Inverted wake register: cleared bits are wake enabled.
Laxman Dewangan7a78479f2015-12-22 18:25:26 +05301154 * @type_invert: Invert the type flags.
Bartosz Golaszewskibc998a72018-12-07 14:04:52 +01001155 * @type_in_mask: Use the mask registers for controlling irq type. For
1156 * interrupts defining type_rising/falling_mask use mask_base
1157 * for edge configuration and never update bits in type_base.
Bartosz Golaszewskic82ea332018-12-19 12:18:05 +01001158 * @clear_on_unmask: For chips with interrupts cleared on read: read the status
1159 * registers before unmasking interrupts to clear any bits
1160 * set when they were masked.
Mark Brown0c00c502012-07-24 15:41:19 +01001161 * @runtime_pm: Hold a runtime PM lock on the device when accessing it.
Mark Brownf8beab22011-10-28 23:50:49 +02001162 *
1163 * @num_regs: Number of registers in each control bank.
1164 * @irqs: Descriptors for individual IRQs. Interrupt numbers are
1165 * assigned based on the index in the array of the interrupt.
1166 * @num_irqs: Number of descriptors.
Laxman Dewangan7a78479f2015-12-22 18:25:26 +05301167 * @num_type_reg: Number of type registers.
1168 * @type_reg_stride: Stride to use for chips where type registers are not
1169 * contiguous.
Laxman Dewanganccc12562016-05-20 20:40:26 +05301170 * @handle_pre_irq: Driver specific callback to handle interrupt from device
1171 * before regmap_irq_handler process the interrupts.
1172 * @handle_post_irq: Driver specific callback to handle interrupt from device
1173 * after handling the interrupts in regmap_irq_handler().
1174 * @irq_drv_data: Driver specific IRQ data which is passed as parameter when
1175 * driver specific pre/post interrupt handler is called.
Charles Keepax2cf8e2d2017-01-12 11:17:39 +00001176 *
1177 * This is not intended to handle every possible interrupt controller, but
1178 * it should handle a substantial proportion of those that are found in the
1179 * wild.
Mark Brownf8beab22011-10-28 23:50:49 +02001180 */
1181struct regmap_irq_chip {
1182 const char *name;
1183
1184 unsigned int status_base;
1185 unsigned int mask_base;
Guo Zeng7b7d1962015-09-17 05:23:20 +00001186 unsigned int unmask_base;
Mark Brownf8beab22011-10-28 23:50:49 +02001187 unsigned int ack_base;
Mark Browna43fd502012-06-05 14:34:03 +01001188 unsigned int wake_base;
Laxman Dewangan7a78479f2015-12-22 18:25:26 +05301189 unsigned int type_base;
Graeme Gregory022f926a2012-05-14 22:40:43 +09001190 unsigned int irq_reg_stride;
Michael Grzeschika71411d2017-06-23 14:35:09 +02001191 bool mask_writeonly:1;
Philipp Zabelf484f7a2013-07-24 10:26:42 +02001192 bool init_ack_masked:1;
1193 bool mask_invert:1;
Alexander Shiyand3233432013-12-15 13:36:51 +04001194 bool use_ack:1;
Guo Zenga650fdd2015-09-17 05:23:21 +00001195 bool ack_invert:1;
Philipp Zabelf484f7a2013-07-24 10:26:42 +02001196 bool wake_invert:1;
1197 bool runtime_pm:1;
Laxman Dewangan7a78479f2015-12-22 18:25:26 +05301198 bool type_invert:1;
Bartosz Golaszewskibc998a72018-12-07 14:04:52 +01001199 bool type_in_mask:1;
Bartosz Golaszewskic82ea332018-12-19 12:18:05 +01001200 bool clear_on_unmask:1;
Mark Brownf8beab22011-10-28 23:50:49 +02001201
1202 int num_regs;
1203
1204 const struct regmap_irq *irqs;
1205 int num_irqs;
Laxman Dewangan7a78479f2015-12-22 18:25:26 +05301206
1207 int num_type_reg;
1208 unsigned int type_reg_stride;
Laxman Dewanganccc12562016-05-20 20:40:26 +05301209
1210 int (*handle_pre_irq)(void *irq_drv_data);
1211 int (*handle_post_irq)(void *irq_drv_data);
1212 void *irq_drv_data;
Mark Brownf8beab22011-10-28 23:50:49 +02001213};
1214
1215struct regmap_irq_chip_data;
1216
1217int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags,
Mark Brownb026ddb2012-05-31 21:01:46 +01001218 int irq_base, const struct regmap_irq_chip *chip,
Mark Brownf8beab22011-10-28 23:50:49 +02001219 struct regmap_irq_chip_data **data);
1220void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data);
Laxman Dewangan045b9842016-02-10 14:29:50 +05301221
1222int devm_regmap_add_irq_chip(struct device *dev, struct regmap *map, int irq,
1223 int irq_flags, int irq_base,
1224 const struct regmap_irq_chip *chip,
1225 struct regmap_irq_chip_data **data);
1226void devm_regmap_del_irq_chip(struct device *dev, int irq,
1227 struct regmap_irq_chip_data *data);
1228
Mark Brown209a6002011-12-05 16:10:15 +00001229int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data);
Mark Brown4af8be62012-05-13 10:59:56 +01001230int regmap_irq_get_virq(struct regmap_irq_chip_data *data, int irq);
Mark Brown90f790d2012-08-20 21:45:05 +01001231struct irq_domain *regmap_irq_get_domain(struct regmap_irq_chip_data *data);
Mark Brownb83a3132011-05-11 19:59:58 +02001232
Mark Brown9cde5fc2012-02-17 14:49:51 -08001233#else
1234
1235/*
1236 * These stubs should only ever be called by generic code which has
1237 * regmap based facilities, if they ever get called at runtime
1238 * something is going wrong and something probably needs to select
1239 * REGMAP.
1240 */
1241
1242static inline int regmap_write(struct regmap *map, unsigned int reg,
1243 unsigned int val)
1244{
1245 WARN_ONCE(1, "regmap API is disabled");
1246 return -EINVAL;
1247}
1248
Mark Brown915f4412013-10-09 13:30:10 +01001249static inline int regmap_write_async(struct regmap *map, unsigned int reg,
1250 unsigned int val)
1251{
1252 WARN_ONCE(1, "regmap API is disabled");
1253 return -EINVAL;
1254}
1255
Mark Brown9cde5fc2012-02-17 14:49:51 -08001256static inline int regmap_raw_write(struct regmap *map, unsigned int reg,
1257 const void *val, size_t val_len)
1258{
1259 WARN_ONCE(1, "regmap API is disabled");
1260 return -EINVAL;
1261}
1262
Mark Brown0d509f22013-01-27 22:07:38 +08001263static inline int regmap_raw_write_async(struct regmap *map, unsigned int reg,
1264 const void *val, size_t val_len)
1265{
1266 WARN_ONCE(1, "regmap API is disabled");
1267 return -EINVAL;
1268}
1269
Ben Whittencdf6b112018-10-19 10:33:50 +01001270static inline int regmap_noinc_write(struct regmap *map, unsigned int reg,
1271 const void *val, size_t val_len)
1272{
1273 WARN_ONCE(1, "regmap API is disabled");
1274 return -EINVAL;
1275}
1276
Mark Brown9cde5fc2012-02-17 14:49:51 -08001277static inline int regmap_bulk_write(struct regmap *map, unsigned int reg,
1278 const void *val, size_t val_count)
1279{
1280 WARN_ONCE(1, "regmap API is disabled");
1281 return -EINVAL;
1282}
1283
1284static inline int regmap_read(struct regmap *map, unsigned int reg,
1285 unsigned int *val)
1286{
1287 WARN_ONCE(1, "regmap API is disabled");
1288 return -EINVAL;
1289}
1290
1291static inline int regmap_raw_read(struct regmap *map, unsigned int reg,
1292 void *val, size_t val_len)
1293{
1294 WARN_ONCE(1, "regmap API is disabled");
1295 return -EINVAL;
1296}
1297
Crestez Dan Leonard74fe7b52018-08-07 17:52:17 +03001298static inline int regmap_noinc_read(struct regmap *map, unsigned int reg,
1299 void *val, size_t val_len)
1300{
1301 WARN_ONCE(1, "regmap API is disabled");
1302 return -EINVAL;
1303}
1304
Mark Brown9cde5fc2012-02-17 14:49:51 -08001305static inline int regmap_bulk_read(struct regmap *map, unsigned int reg,
1306 void *val, size_t val_count)
1307{
1308 WARN_ONCE(1, "regmap API is disabled");
1309 return -EINVAL;
1310}
1311
Kuninori Morimoto91d31b92016-02-15 05:22:18 +00001312static inline int regmap_update_bits_base(struct regmap *map, unsigned int reg,
1313 unsigned int mask, unsigned int val,
1314 bool *change, bool async, bool force)
Mark Brown9cde5fc2012-02-17 14:49:51 -08001315{
1316 WARN_ONCE(1, "regmap API is disabled");
1317 return -EINVAL;
1318}
1319
Kuninori Morimoto28972ea2016-02-15 05:23:55 +00001320static inline int regmap_field_update_bits_base(struct regmap_field *field,
1321 unsigned int mask, unsigned int val,
1322 bool *change, bool async, bool force)
Kuninori Morimotofd4b7286c2015-06-16 08:52:39 +00001323{
1324 WARN_ONCE(1, "regmap API is disabled");
1325 return -EINVAL;
1326}
1327
Kuninori Morimotoe126ede2016-02-15 05:24:51 +00001328static inline int regmap_fields_update_bits_base(struct regmap_field *field,
1329 unsigned int id,
1330 unsigned int mask, unsigned int val,
1331 bool *change, bool async, bool force)
Mark Brown915f4412013-10-09 13:30:10 +01001332{
1333 WARN_ONCE(1, "regmap API is disabled");
1334 return -EINVAL;
1335}
1336
Mark Brown9cde5fc2012-02-17 14:49:51 -08001337static inline int regmap_get_val_bytes(struct regmap *map)
1338{
1339 WARN_ONCE(1, "regmap API is disabled");
1340 return -EINVAL;
1341}
1342
Srinivas Kandagatla668abc72015-05-21 17:42:43 +01001343static inline int regmap_get_max_register(struct regmap *map)
1344{
1345 WARN_ONCE(1, "regmap API is disabled");
1346 return -EINVAL;
1347}
1348
Srinivas Kandagatlaa2f776c2015-05-21 17:42:54 +01001349static inline int regmap_get_reg_stride(struct regmap *map)
1350{
1351 WARN_ONCE(1, "regmap API is disabled");
1352 return -EINVAL;
1353}
1354
Mark Brown9cde5fc2012-02-17 14:49:51 -08001355static inline int regcache_sync(struct regmap *map)
1356{
1357 WARN_ONCE(1, "regmap API is disabled");
1358 return -EINVAL;
1359}
1360
Mark Browna313f9f2012-02-23 19:49:43 +00001361static inline int regcache_sync_region(struct regmap *map, unsigned int min,
1362 unsigned int max)
1363{
1364 WARN_ONCE(1, "regmap API is disabled");
1365 return -EINVAL;
1366}
1367
Mark Brown697e85b2013-05-08 13:55:22 +01001368static inline int regcache_drop_region(struct regmap *map, unsigned int min,
1369 unsigned int max)
1370{
1371 WARN_ONCE(1, "regmap API is disabled");
1372 return -EINVAL;
1373}
1374
Mark Brown9cde5fc2012-02-17 14:49:51 -08001375static inline void regcache_cache_only(struct regmap *map, bool enable)
1376{
1377 WARN_ONCE(1, "regmap API is disabled");
1378}
1379
1380static inline void regcache_cache_bypass(struct regmap *map, bool enable)
1381{
1382 WARN_ONCE(1, "regmap API is disabled");
1383}
1384
1385static inline void regcache_mark_dirty(struct regmap *map)
1386{
1387 WARN_ONCE(1, "regmap API is disabled");
1388}
1389
Mark Brown0d509f22013-01-27 22:07:38 +08001390static inline void regmap_async_complete(struct regmap *map)
1391{
1392 WARN_ONCE(1, "regmap API is disabled");
1393}
1394
Mark Brown9cde5fc2012-02-17 14:49:51 -08001395static inline int regmap_register_patch(struct regmap *map,
Daniel Wagnera6baa3d2015-11-30 16:20:15 +01001396 const struct reg_sequence *regs,
Mark Brown9cde5fc2012-02-17 14:49:51 -08001397 int num_regs)
1398{
1399 WARN_ONCE(1, "regmap API is disabled");
1400 return -EINVAL;
1401}
1402
Nenghua Cao13ff50c2014-02-19 18:44:13 +08001403static inline int regmap_parse_val(struct regmap *map, const void *buf,
1404 unsigned int *val)
1405{
1406 WARN_ONCE(1, "regmap API is disabled");
1407 return -EINVAL;
1408}
1409
Mark Brown72b39f62012-05-08 17:44:40 +01001410static inline struct regmap *dev_get_regmap(struct device *dev,
1411 const char *name)
1412{
Mark Brown72b39f62012-05-08 17:44:40 +01001413 return NULL;
1414}
1415
Tuomas Tynkkynen8d7d3972014-07-21 18:38:47 +03001416static inline struct device *regmap_get_device(struct regmap *map)
1417{
1418 WARN_ONCE(1, "regmap API is disabled");
Mark Brown1d33dc62014-07-25 19:01:53 +01001419 return NULL;
Tuomas Tynkkynen8d7d3972014-07-21 18:38:47 +03001420}
1421
Mark Brown9cde5fc2012-02-17 14:49:51 -08001422#endif
1423
Mark Brownb83a3132011-05-11 19:59:58 +02001424#endif