]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - include/linux/regmap.h
regmap: Introduce max_raw_read/write for regmap_bulk_read/write
[mirror_ubuntu-zesty-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>
49ccc142 18#include <linux/err.h>
3f0fa9a8 19#include <linux/bug.h>
b83a313b 20
de477254 21struct module;
313162d0 22struct device;
9943fa30 23struct i2c_client;
90f790d2 24struct irq_domain;
a676f083 25struct spi_device;
a01779f8 26struct spmi_device;
b83d2ff0 27struct regmap;
6863ca62 28struct regmap_range_cfg;
67252287 29struct regmap_field;
22853223 30struct snd_ac97;
9943fa30 31
9fabe24e
DP
32/* An enum of all the supported cache types */
33enum regcache_type {
34 REGCACHE_NONE,
28644c80 35 REGCACHE_RBTREE,
2ac902ce
MB
36 REGCACHE_COMPRESSED,
37 REGCACHE_FLAT,
9fabe24e
DP
38};
39
bd20eb54
MB
40/**
41 * Default value for a register. We use an array of structs rather
42 * than a simple array as many modern devices have very sparse
43 * register maps.
44 *
45 * @reg: Register address.
46 * @def: Register default value.
47 */
48struct reg_default {
49 unsigned int reg;
50 unsigned int def;
51};
52
b83d2ff0
MB
53#ifdef CONFIG_REGMAP
54
141eba2e
SW
55enum regmap_endian {
56 /* Unspecified -> 0 -> Backwards compatible default */
57 REGMAP_ENDIAN_DEFAULT = 0,
58 REGMAP_ENDIAN_BIG,
59 REGMAP_ENDIAN_LITTLE,
60 REGMAP_ENDIAN_NATIVE,
61};
62
76aad392
DC
63/**
64 * A register range, used for access related checks
65 * (readable/writeable/volatile/precious checks)
66 *
67 * @range_min: address of first register
68 * @range_max: address of last register
69 */
70struct regmap_range {
71 unsigned int range_min;
72 unsigned int range_max;
73};
74
6112fe60
LD
75#define regmap_reg_range(low, high) { .range_min = low, .range_max = high, }
76
76aad392
DC
77/*
78 * A table of ranges including some yes ranges and some no ranges.
79 * If a register belongs to a no_range, the corresponding check function
80 * will return false. If a register belongs to a yes range, the corresponding
81 * check function will return true. "no_ranges" are searched first.
82 *
83 * @yes_ranges : pointer to an array of regmap ranges used as "yes ranges"
84 * @n_yes_ranges: size of the above array
85 * @no_ranges: pointer to an array of regmap ranges used as "no ranges"
86 * @n_no_ranges: size of the above array
87 */
88struct regmap_access_table {
89 const struct regmap_range *yes_ranges;
90 unsigned int n_yes_ranges;
91 const struct regmap_range *no_ranges;
92 unsigned int n_no_ranges;
93};
94
0d4529c5
DC
95typedef void (*regmap_lock)(void *);
96typedef void (*regmap_unlock)(void *);
97
dd898b20
MB
98/**
99 * Configuration for the register map of a device.
100 *
d3c242e1
SW
101 * @name: Optional name of the regmap. Useful when a device has multiple
102 * register regions.
103 *
dd898b20 104 * @reg_bits: Number of bits in a register address, mandatory.
f01ee60f
SW
105 * @reg_stride: The register address stride. Valid register addresses are a
106 * multiple of this value. If set to 0, a value of 1 will be
107 * used.
82159ba8 108 * @pad_bits: Number of bits of padding between register and value.
dd898b20 109 * @val_bits: Number of bits in a register value, mandatory.
2e2ae66d 110 *
3566cc9d 111 * @writeable_reg: Optional callback returning true if the register
76aad392
DC
112 * can be written to. If this field is NULL but wr_table
113 * (see below) is not, the check is performed on such table
114 * (a register is writeable if it belongs to one of the ranges
115 * specified by wr_table).
3566cc9d 116 * @readable_reg: Optional callback returning true if the register
76aad392
DC
117 * can be read from. If this field is NULL but rd_table
118 * (see below) is not, the check is performed on such table
119 * (a register is readable if it belongs to one of the ranges
120 * specified by rd_table).
3566cc9d 121 * @volatile_reg: Optional callback returning true if the register
76aad392
DC
122 * value can't be cached. If this field is NULL but
123 * volatile_table (see below) is not, the check is performed on
124 * such table (a register is volatile if it belongs to one of
125 * the ranges specified by volatile_table).
bdc39644 126 * @precious_reg: Optional callback returning true if the register
76aad392 127 * should not be read outside of a call from the driver
bdc39644 128 * (e.g., a clear on read interrupt status register). If this
76aad392
DC
129 * field is NULL but precious_table (see below) is not, the
130 * check is performed on such table (a register is precious if
131 * it belongs to one of the ranges specified by precious_table).
132 * @lock: Optional lock callback (overrides regmap's default lock
133 * function, based on spinlock or mutex).
134 * @unlock: As above for unlocking.
135 * @lock_arg: this field is passed as the only argument of lock/unlock
136 * functions (ignored in case regular lock/unlock functions
137 * are not overridden).
d2a5884a
AS
138 * @reg_read: Optional callback that if filled will be used to perform
139 * all the reads from the registers. Should only be provided for
bdc39644
LP
140 * devices whose read operation cannot be represented as a simple
141 * read operation on a bus such as SPI, I2C, etc. Most of the
142 * devices do not need this.
d2a5884a
AS
143 * @reg_write: Same as above for writing.
144 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
145 * to perform locking. This field is ignored if custom lock/unlock
146 * functions are used (see fields lock/unlock of struct regmap_config).
147 * This field is a duplicate of a similar file in
148 * 'struct regmap_bus' and serves exact same purpose.
149 * Use it only for "no-bus" cases.
bd20eb54 150 * @max_register: Optional, specifies the maximum valid register index.
76aad392
DC
151 * @wr_table: Optional, points to a struct regmap_access_table specifying
152 * valid ranges for write access.
153 * @rd_table: As above, for read access.
154 * @volatile_table: As above, for volatile registers.
155 * @precious_table: As above, for precious registers.
bd20eb54
MB
156 * @reg_defaults: Power on reset values for registers (for use with
157 * register cache support).
158 * @num_reg_defaults: Number of elements in reg_defaults.
6f306441
LPC
159 *
160 * @read_flag_mask: Mask to be set in the top byte of the register when doing
161 * a read.
162 * @write_flag_mask: Mask to be set in the top byte of the register when doing
163 * a write. If both read_flag_mask and write_flag_mask are
164 * empty the regmap_bus default masks are used.
2e33caf1
AJ
165 * @use_single_rw: If set, converts the bulk read and write operations into
166 * a series of single read and write operations. This is useful
167 * for device that does not support bulk read and write.
e894c3f4
OAO
168 * @can_multi_write: If set, the device supports the multi write mode of bulk
169 * write operations, if clear multi write requests will be
170 * split into individual write operations
9fabe24e
DP
171 *
172 * @cache_type: The actual cache type.
173 * @reg_defaults_raw: Power on reset values for registers (for use with
174 * register cache support).
175 * @num_reg_defaults_raw: Number of elements in reg_defaults_raw.
141eba2e
SW
176 * @reg_format_endian: Endianness for formatted register addresses. If this is
177 * DEFAULT, the @reg_format_endian_default value from the
178 * regmap bus is used.
179 * @val_format_endian: Endianness for formatted register values. If this is
180 * DEFAULT, the @reg_format_endian_default value from the
181 * regmap bus is used.
6863ca62
KG
182 *
183 * @ranges: Array of configuration entries for virtual address ranges.
184 * @num_ranges: Number of range configuration entries.
dd898b20 185 */
b83a313b 186struct regmap_config {
d3c242e1
SW
187 const char *name;
188
b83a313b 189 int reg_bits;
f01ee60f 190 int reg_stride;
82159ba8 191 int pad_bits;
b83a313b 192 int val_bits;
2e2ae66d 193
2e2ae66d
MB
194 bool (*writeable_reg)(struct device *dev, unsigned int reg);
195 bool (*readable_reg)(struct device *dev, unsigned int reg);
196 bool (*volatile_reg)(struct device *dev, unsigned int reg);
18694886 197 bool (*precious_reg)(struct device *dev, unsigned int reg);
0d4529c5
DC
198 regmap_lock lock;
199 regmap_unlock unlock;
200 void *lock_arg;
bd20eb54 201
d2a5884a
AS
202 int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
203 int (*reg_write)(void *context, unsigned int reg, unsigned int val);
204
205 bool fast_io;
206
bd20eb54 207 unsigned int max_register;
76aad392
DC
208 const struct regmap_access_table *wr_table;
209 const struct regmap_access_table *rd_table;
210 const struct regmap_access_table *volatile_table;
211 const struct regmap_access_table *precious_table;
720e4616 212 const struct reg_default *reg_defaults;
9fabe24e
DP
213 unsigned int num_reg_defaults;
214 enum regcache_type cache_type;
215 const void *reg_defaults_raw;
216 unsigned int num_reg_defaults_raw;
6f306441
LPC
217
218 u8 read_flag_mask;
219 u8 write_flag_mask;
2e33caf1
AJ
220
221 bool use_single_rw;
e894c3f4 222 bool can_multi_write;
141eba2e
SW
223
224 enum regmap_endian reg_format_endian;
225 enum regmap_endian val_format_endian;
38e23194 226
6863ca62 227 const struct regmap_range_cfg *ranges;
e3549cd0 228 unsigned int num_ranges;
6863ca62
KG
229};
230
231/**
232 * Configuration for indirectly accessed or paged registers.
233 * Registers, mapped to this virtual range, are accessed in two steps:
234 * 1. page selector register update;
235 * 2. access through data window registers.
236 *
d058bb49
MB
237 * @name: Descriptive name for diagnostics
238 *
6863ca62
KG
239 * @range_min: Address of the lowest register address in virtual range.
240 * @range_max: Address of the highest register in virtual range.
241 *
242 * @page_sel_reg: Register with selector field.
243 * @page_sel_mask: Bit shift for selector value.
244 * @page_sel_shift: Bit mask for selector value.
245 *
246 * @window_start: Address of first (lowest) register in data window.
247 * @window_len: Number of registers in data window.
248 */
249struct regmap_range_cfg {
d058bb49
MB
250 const char *name;
251
6863ca62
KG
252 /* Registers of virtual address range */
253 unsigned int range_min;
254 unsigned int range_max;
255
256 /* Page selector for indirect addressing */
257 unsigned int selector_reg;
258 unsigned int selector_mask;
259 int selector_shift;
260
261 /* Data window (per each page) */
262 unsigned int window_start;
263 unsigned int window_len;
b83a313b
MB
264};
265
0d509f2b
MB
266struct regmap_async;
267
0135bbcc 268typedef int (*regmap_hw_write)(void *context, const void *data,
b83a313b 269 size_t count);
0135bbcc 270typedef int (*regmap_hw_gather_write)(void *context,
b83a313b
MB
271 const void *reg, size_t reg_len,
272 const void *val, size_t val_len);
0d509f2b
MB
273typedef int (*regmap_hw_async_write)(void *context,
274 const void *reg, size_t reg_len,
275 const void *val, size_t val_len,
276 struct regmap_async *async);
0135bbcc 277typedef int (*regmap_hw_read)(void *context,
b83a313b
MB
278 const void *reg_buf, size_t reg_size,
279 void *val_buf, size_t val_size);
3ac17037
BB
280typedef int (*regmap_hw_reg_read)(void *context, unsigned int reg,
281 unsigned int *val);
282typedef int (*regmap_hw_reg_write)(void *context, unsigned int reg,
283 unsigned int val);
0d509f2b 284typedef struct regmap_async *(*regmap_hw_async_alloc)(void);
0135bbcc 285typedef void (*regmap_hw_free_context)(void *context);
b83a313b
MB
286
287/**
288 * Description of a hardware bus for the register map infrastructure.
289 *
bacdbe07 290 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
0d4529c5
DC
291 * to perform locking. This field is ignored if custom lock/unlock
292 * functions are used (see fields lock/unlock of
293 * struct regmap_config).
b83a313b
MB
294 * @write: Write operation.
295 * @gather_write: Write operation with split register/value, return -ENOTSUPP
296 * if not implemented on a given device.
0d509f2b
MB
297 * @async_write: Write operation which completes asynchronously, optional and
298 * must serialise with respect to non-async I/O.
c5f58f2d
MP
299 * @reg_write: Write a single register value to the given register address. This
300 * write operation has to complete when returning from the function.
b83a313b
MB
301 * @read: Read operation. Data is returned in the buffer used to transmit
302 * data.
c5f58f2d
MP
303 * @reg_read: Read a single register value from a given register address.
304 * @free_context: Free context.
0d509f2b 305 * @async_alloc: Allocate a regmap_async() structure.
b83a313b
MB
306 * @read_flag_mask: Mask to be set in the top byte of the register when doing
307 * a read.
141eba2e
SW
308 * @reg_format_endian_default: Default endianness for formatted register
309 * addresses. Used when the regmap_config specifies DEFAULT. If this is
310 * DEFAULT, BIG is assumed.
311 * @val_format_endian_default: Default endianness for formatted register
312 * values. Used when the regmap_config specifies DEFAULT. If this is
313 * DEFAULT, BIG is assumed.
adaac459
MP
314 * @max_raw_read: Max raw read size that can be used on the bus.
315 * @max_raw_write: Max raw write size that can be used on the bus.
b83a313b
MB
316 */
317struct regmap_bus {
bacdbe07 318 bool fast_io;
b83a313b
MB
319 regmap_hw_write write;
320 regmap_hw_gather_write gather_write;
0d509f2b 321 regmap_hw_async_write async_write;
3ac17037 322 regmap_hw_reg_write reg_write;
b83a313b 323 regmap_hw_read read;
3ac17037 324 regmap_hw_reg_read reg_read;
0135bbcc 325 regmap_hw_free_context free_context;
0d509f2b 326 regmap_hw_async_alloc async_alloc;
b83a313b 327 u8 read_flag_mask;
141eba2e
SW
328 enum regmap_endian reg_format_endian_default;
329 enum regmap_endian val_format_endian_default;
adaac459
MP
330 size_t max_raw_read;
331 size_t max_raw_write;
b83a313b
MB
332};
333
334struct regmap *regmap_init(struct device *dev,
335 const struct regmap_bus *bus,
0135bbcc 336 void *bus_context,
b83a313b 337 const struct regmap_config *config);
6cfec04b
MS
338int regmap_attach_dev(struct device *dev, struct regmap *map,
339 const struct regmap_config *config);
9943fa30
MB
340struct regmap *regmap_init_i2c(struct i2c_client *i2c,
341 const struct regmap_config *config);
a676f083
MB
342struct regmap *regmap_init_spi(struct spi_device *dev,
343 const struct regmap_config *config);
c9afbb05
JC
344struct regmap *regmap_init_spmi_base(struct spmi_device *dev,
345 const struct regmap_config *config);
346struct regmap *regmap_init_spmi_ext(struct spmi_device *dev,
347 const struct regmap_config *config);
878ec67b
PZ
348struct regmap *regmap_init_mmio_clk(struct device *dev, const char *clk_id,
349 void __iomem *regs,
350 const struct regmap_config *config);
22853223
MB
351struct regmap *regmap_init_ac97(struct snd_ac97 *ac97,
352 const struct regmap_config *config);
a676f083 353
c0eb4676
MB
354struct regmap *devm_regmap_init(struct device *dev,
355 const struct regmap_bus *bus,
0135bbcc 356 void *bus_context,
c0eb4676
MB
357 const struct regmap_config *config);
358struct regmap *devm_regmap_init_i2c(struct i2c_client *i2c,
359 const struct regmap_config *config);
360struct regmap *devm_regmap_init_spi(struct spi_device *dev,
361 const struct regmap_config *config);
c9afbb05
JC
362struct regmap *devm_regmap_init_spmi_base(struct spmi_device *dev,
363 const struct regmap_config *config);
364struct regmap *devm_regmap_init_spmi_ext(struct spmi_device *dev,
365 const struct regmap_config *config);
878ec67b
PZ
366struct regmap *devm_regmap_init_mmio_clk(struct device *dev, const char *clk_id,
367 void __iomem *regs,
368 const struct regmap_config *config);
22853223
MB
369struct regmap *devm_regmap_init_ac97(struct snd_ac97 *ac97,
370 const struct regmap_config *config);
371
372bool regmap_ac97_default_volatile(struct device *dev, unsigned int reg);
878ec67b
PZ
373
374/**
375 * regmap_init_mmio(): Initialise register map
376 *
377 * @dev: Device that will be interacted with
378 * @regs: Pointer to memory-mapped IO region
379 * @config: Configuration for register map
380 *
381 * The return value will be an ERR_PTR() on error or a valid pointer to
382 * a struct regmap.
383 */
384static inline struct regmap *regmap_init_mmio(struct device *dev,
385 void __iomem *regs,
386 const struct regmap_config *config)
387{
388 return regmap_init_mmio_clk(dev, NULL, regs, config);
389}
390
391/**
392 * devm_regmap_init_mmio(): Initialise managed register map
393 *
394 * @dev: Device that will be interacted with
395 * @regs: Pointer to memory-mapped IO region
396 * @config: Configuration for register map
397 *
398 * The return value will be an ERR_PTR() on error or a valid pointer
399 * to a struct regmap. The regmap will be automatically freed by the
400 * device management code.
401 */
402static inline struct regmap *devm_regmap_init_mmio(struct device *dev,
403 void __iomem *regs,
404 const struct regmap_config *config)
405{
406 return devm_regmap_init_mmio_clk(dev, NULL, regs, config);
407}
c0eb4676 408
b83a313b 409void regmap_exit(struct regmap *map);
bf315173
MB
410int regmap_reinit_cache(struct regmap *map,
411 const struct regmap_config *config);
72b39f6f 412struct regmap *dev_get_regmap(struct device *dev, const char *name);
8d7d3972 413struct device *regmap_get_device(struct regmap *map);
b83a313b 414int regmap_write(struct regmap *map, unsigned int reg, unsigned int val);
915f441b 415int regmap_write_async(struct regmap *map, unsigned int reg, unsigned int val);
b83a313b
MB
416int regmap_raw_write(struct regmap *map, unsigned int reg,
417 const void *val, size_t val_len);
8eaeb219
LD
418int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
419 size_t val_count);
f7e2cec0 420int regmap_multi_reg_write(struct regmap *map, const struct reg_default *regs,
e33fabd3 421 int num_regs);
1d5b40bc
CK
422int regmap_multi_reg_write_bypassed(struct regmap *map,
423 const struct reg_default *regs,
424 int num_regs);
0d509f2b
MB
425int regmap_raw_write_async(struct regmap *map, unsigned int reg,
426 const void *val, size_t val_len);
b83a313b
MB
427int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val);
428int regmap_raw_read(struct regmap *map, unsigned int reg,
429 void *val, size_t val_len);
430int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
431 size_t val_count);
432int regmap_update_bits(struct regmap *map, unsigned int reg,
433 unsigned int mask, unsigned int val);
915f441b
MB
434int regmap_update_bits_async(struct regmap *map, unsigned int reg,
435 unsigned int mask, unsigned int val);
018690d3
MB
436int regmap_update_bits_check(struct regmap *map, unsigned int reg,
437 unsigned int mask, unsigned int val,
438 bool *change);
915f441b
MB
439int regmap_update_bits_check_async(struct regmap *map, unsigned int reg,
440 unsigned int mask, unsigned int val,
441 bool *change);
a6539c32 442int regmap_get_val_bytes(struct regmap *map);
668abc72 443int regmap_get_max_register(struct regmap *map);
a2f776cb 444int regmap_get_reg_stride(struct regmap *map);
0d509f2b 445int regmap_async_complete(struct regmap *map);
221ad7f2 446bool regmap_can_raw_write(struct regmap *map);
b83a313b 447
39a58439 448int regcache_sync(struct regmap *map);
4d4cfd16
MB
449int regcache_sync_region(struct regmap *map, unsigned int min,
450 unsigned int max);
697e85bc
MB
451int regcache_drop_region(struct regmap *map, unsigned int min,
452 unsigned int max);
92afb286 453void regcache_cache_only(struct regmap *map, bool enable);
6eb0f5e0 454void regcache_cache_bypass(struct regmap *map, bool enable);
8ae0d7e8 455void regcache_mark_dirty(struct regmap *map);
92afb286 456
154881e5
MB
457bool regmap_check_range_table(struct regmap *map, unsigned int reg,
458 const struct regmap_access_table *table);
459
22f0d90a
MB
460int regmap_register_patch(struct regmap *map, const struct reg_default *regs,
461 int num_regs);
13ff50c8
NC
462int regmap_parse_val(struct regmap *map, const void *buf,
463 unsigned int *val);
22f0d90a 464
76aad392
DC
465static inline bool regmap_reg_in_range(unsigned int reg,
466 const struct regmap_range *range)
467{
468 return reg >= range->range_min && reg <= range->range_max;
469}
470
471bool regmap_reg_in_ranges(unsigned int reg,
472 const struct regmap_range *ranges,
473 unsigned int nranges);
474
67252287
SK
475/**
476 * Description of an register field
477 *
478 * @reg: Offset of the register within the regmap bank
479 * @lsb: lsb of the register field.
f27b37f5 480 * @msb: msb of the register field.
a0102375
KM
481 * @id_size: port size if it has some ports
482 * @id_offset: address offset for each ports
67252287
SK
483 */
484struct reg_field {
485 unsigned int reg;
486 unsigned int lsb;
487 unsigned int msb;
a0102375
KM
488 unsigned int id_size;
489 unsigned int id_offset;
67252287
SK
490};
491
492#define REG_FIELD(_reg, _lsb, _msb) { \
493 .reg = _reg, \
494 .lsb = _lsb, \
495 .msb = _msb, \
496 }
497
498struct regmap_field *regmap_field_alloc(struct regmap *regmap,
499 struct reg_field reg_field);
500void regmap_field_free(struct regmap_field *field);
501
502struct regmap_field *devm_regmap_field_alloc(struct device *dev,
503 struct regmap *regmap, struct reg_field reg_field);
504void devm_regmap_field_free(struct device *dev, struct regmap_field *field);
505
506int regmap_field_read(struct regmap_field *field, unsigned int *val);
507int regmap_field_write(struct regmap_field *field, unsigned int val);
fdf20029
KM
508int regmap_field_update_bits(struct regmap_field *field,
509 unsigned int mask, unsigned int val);
76aad392 510
a0102375
KM
511int regmap_fields_write(struct regmap_field *field, unsigned int id,
512 unsigned int val);
513int regmap_fields_read(struct regmap_field *field, unsigned int id,
514 unsigned int *val);
515int regmap_fields_update_bits(struct regmap_field *field, unsigned int id,
516 unsigned int mask, unsigned int val);
76aad392 517
f8beab2b
MB
518/**
519 * Description of an IRQ for the generic regmap irq_chip.
520 *
521 * @reg_offset: Offset of the status/mask register within the bank
522 * @mask: Mask used to flag/control the register.
523 */
524struct regmap_irq {
525 unsigned int reg_offset;
526 unsigned int mask;
527};
528
529/**
530 * Description of a generic regmap irq_chip. This is not intended to
531 * handle every possible interrupt controller, but it should handle a
532 * substantial proportion of those that are found in the wild.
533 *
534 * @name: Descriptive name for IRQ controller.
535 *
536 * @status_base: Base status register address.
537 * @mask_base: Base mask register address.
d3233433
AS
538 * @ack_base: Base ack address. If zero then the chip is clear on read.
539 * Using zero value is possible with @use_ack bit.
a43fd50d 540 * @wake_base: Base address for wake enables. If zero unsupported.
022f926a 541 * @irq_reg_stride: Stride to use for chips where registers are not contiguous.
2753e6f8 542 * @init_ack_masked: Ack all masked interrupts once during initalization.
68622bdf 543 * @mask_invert: Inverted mask register: cleared bits are masked out.
d3233433 544 * @use_ack: Use @ack register even if it is zero.
68622bdf 545 * @wake_invert: Inverted wake register: cleared bits are wake enabled.
0c00c50b 546 * @runtime_pm: Hold a runtime PM lock on the device when accessing it.
f8beab2b
MB
547 *
548 * @num_regs: Number of registers in each control bank.
549 * @irqs: Descriptors for individual IRQs. Interrupt numbers are
550 * assigned based on the index in the array of the interrupt.
551 * @num_irqs: Number of descriptors.
552 */
553struct regmap_irq_chip {
554 const char *name;
555
556 unsigned int status_base;
557 unsigned int mask_base;
558 unsigned int ack_base;
a43fd50d 559 unsigned int wake_base;
022f926a 560 unsigned int irq_reg_stride;
f484f7a6
PZ
561 bool init_ack_masked:1;
562 bool mask_invert:1;
d3233433 563 bool use_ack:1;
f484f7a6
PZ
564 bool wake_invert:1;
565 bool runtime_pm:1;
f8beab2b
MB
566
567 int num_regs;
568
569 const struct regmap_irq *irqs;
570 int num_irqs;
571};
572
573struct regmap_irq_chip_data;
574
575int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags,
b026ddbb 576 int irq_base, const struct regmap_irq_chip *chip,
f8beab2b
MB
577 struct regmap_irq_chip_data **data);
578void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data);
209a6006 579int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data);
4af8be67 580int regmap_irq_get_virq(struct regmap_irq_chip_data *data, int irq);
90f790d2 581struct irq_domain *regmap_irq_get_domain(struct regmap_irq_chip_data *data);
92afb286 582
9cde5fcd
MB
583#else
584
585/*
586 * These stubs should only ever be called by generic code which has
587 * regmap based facilities, if they ever get called at runtime
588 * something is going wrong and something probably needs to select
589 * REGMAP.
590 */
591
592static inline int regmap_write(struct regmap *map, unsigned int reg,
593 unsigned int val)
594{
595 WARN_ONCE(1, "regmap API is disabled");
596 return -EINVAL;
597}
598
915f441b
MB
599static inline int regmap_write_async(struct regmap *map, unsigned int reg,
600 unsigned int val)
601{
602 WARN_ONCE(1, "regmap API is disabled");
603 return -EINVAL;
604}
605
9cde5fcd
MB
606static inline int regmap_raw_write(struct regmap *map, unsigned int reg,
607 const void *val, size_t val_len)
608{
609 WARN_ONCE(1, "regmap API is disabled");
610 return -EINVAL;
611}
612
0d509f2b
MB
613static inline int regmap_raw_write_async(struct regmap *map, unsigned int reg,
614 const void *val, size_t val_len)
615{
616 WARN_ONCE(1, "regmap API is disabled");
617 return -EINVAL;
618}
619
9cde5fcd
MB
620static inline int regmap_bulk_write(struct regmap *map, unsigned int reg,
621 const void *val, size_t val_count)
622{
623 WARN_ONCE(1, "regmap API is disabled");
624 return -EINVAL;
625}
626
627static inline int regmap_read(struct regmap *map, unsigned int reg,
628 unsigned int *val)
629{
630 WARN_ONCE(1, "regmap API is disabled");
631 return -EINVAL;
632}
633
634static inline int regmap_raw_read(struct regmap *map, unsigned int reg,
635 void *val, size_t val_len)
636{
637 WARN_ONCE(1, "regmap API is disabled");
638 return -EINVAL;
639}
640
641static inline int regmap_bulk_read(struct regmap *map, unsigned int reg,
642 void *val, size_t val_count)
643{
644 WARN_ONCE(1, "regmap API is disabled");
645 return -EINVAL;
646}
647
648static inline int regmap_update_bits(struct regmap *map, unsigned int reg,
649 unsigned int mask, unsigned int val)
650{
651 WARN_ONCE(1, "regmap API is disabled");
652 return -EINVAL;
653}
654
915f441b
MB
655static inline int regmap_update_bits_async(struct regmap *map,
656 unsigned int reg,
657 unsigned int mask, unsigned int val)
658{
659 WARN_ONCE(1, "regmap API is disabled");
660 return -EINVAL;
661}
662
9cde5fcd
MB
663static inline int regmap_update_bits_check(struct regmap *map,
664 unsigned int reg,
665 unsigned int mask, unsigned int val,
666 bool *change)
667{
668 WARN_ONCE(1, "regmap API is disabled");
669 return -EINVAL;
670}
671
915f441b
MB
672static inline int regmap_update_bits_check_async(struct regmap *map,
673 unsigned int reg,
674 unsigned int mask,
675 unsigned int val,
676 bool *change)
677{
678 WARN_ONCE(1, "regmap API is disabled");
679 return -EINVAL;
680}
681
9cde5fcd
MB
682static inline int regmap_get_val_bytes(struct regmap *map)
683{
684 WARN_ONCE(1, "regmap API is disabled");
685 return -EINVAL;
686}
687
668abc72
SK
688static inline int regmap_get_max_register(struct regmap *map)
689{
690 WARN_ONCE(1, "regmap API is disabled");
691 return -EINVAL;
692}
693
a2f776cb
SK
694static inline int regmap_get_reg_stride(struct regmap *map)
695{
696 WARN_ONCE(1, "regmap API is disabled");
697 return -EINVAL;
698}
699
9cde5fcd
MB
700static inline int regcache_sync(struct regmap *map)
701{
702 WARN_ONCE(1, "regmap API is disabled");
703 return -EINVAL;
704}
705
a313f9f5
MB
706static inline int regcache_sync_region(struct regmap *map, unsigned int min,
707 unsigned int max)
708{
709 WARN_ONCE(1, "regmap API is disabled");
710 return -EINVAL;
711}
712
697e85bc
MB
713static inline int regcache_drop_region(struct regmap *map, unsigned int min,
714 unsigned int max)
715{
716 WARN_ONCE(1, "regmap API is disabled");
717 return -EINVAL;
718}
719
9cde5fcd
MB
720static inline void regcache_cache_only(struct regmap *map, bool enable)
721{
722 WARN_ONCE(1, "regmap API is disabled");
723}
724
725static inline void regcache_cache_bypass(struct regmap *map, bool enable)
726{
727 WARN_ONCE(1, "regmap API is disabled");
728}
729
730static inline void regcache_mark_dirty(struct regmap *map)
731{
732 WARN_ONCE(1, "regmap API is disabled");
733}
734
0d509f2b
MB
735static inline void regmap_async_complete(struct regmap *map)
736{
737 WARN_ONCE(1, "regmap API is disabled");
738}
739
9cde5fcd
MB
740static inline int regmap_register_patch(struct regmap *map,
741 const struct reg_default *regs,
742 int num_regs)
743{
744 WARN_ONCE(1, "regmap API is disabled");
745 return -EINVAL;
746}
747
13ff50c8
NC
748static inline int regmap_parse_val(struct regmap *map, const void *buf,
749 unsigned int *val)
750{
751 WARN_ONCE(1, "regmap API is disabled");
752 return -EINVAL;
753}
754
72b39f6f
MB
755static inline struct regmap *dev_get_regmap(struct device *dev,
756 const char *name)
757{
72b39f6f
MB
758 return NULL;
759}
760
8d7d3972
TT
761static inline struct device *regmap_get_device(struct regmap *map)
762{
763 WARN_ONCE(1, "regmap API is disabled");
1d33dc6b 764 return NULL;
8d7d3972
TT
765}
766
9cde5fcd
MB
767#endif
768
b83a313b 769#endif