]> git.ipfire.org Git - thirdparty/kernel/linux.git/blame - include/linux/regmap.h
Merge branches 'regmap-core', 'regmap-stride', 'regmap-mmio' and 'regmap-irq' into...
[thirdparty/kernel/linux.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>
b83a313b 17
de477254 18struct module;
313162d0 19struct device;
9943fa30 20struct i2c_client;
a676f083 21struct spi_device;
b83d2ff0 22struct regmap;
9943fa30 23
9fabe24e
DP
24/* An enum of all the supported cache types */
25enum regcache_type {
26 REGCACHE_NONE,
28644c80 27 REGCACHE_RBTREE,
50b776fc 28 REGCACHE_COMPRESSED
9fabe24e
DP
29};
30
bd20eb54
MB
31/**
32 * Default value for a register. We use an array of structs rather
33 * than a simple array as many modern devices have very sparse
34 * register maps.
35 *
36 * @reg: Register address.
37 * @def: Register default value.
38 */
39struct reg_default {
40 unsigned int reg;
41 unsigned int def;
42};
43
b83d2ff0
MB
44#ifdef CONFIG_REGMAP
45
dd898b20
MB
46/**
47 * Configuration for the register map of a device.
48 *
d3c242e1
SW
49 * @name: Optional name of the regmap. Useful when a device has multiple
50 * register regions.
51 *
dd898b20 52 * @reg_bits: Number of bits in a register address, mandatory.
f01ee60f
SW
53 * @reg_stride: The register address stride. Valid register addresses are a
54 * multiple of this value. If set to 0, a value of 1 will be
55 * used.
82159ba8 56 * @pad_bits: Number of bits of padding between register and value.
dd898b20 57 * @val_bits: Number of bits in a register value, mandatory.
2e2ae66d 58 *
3566cc9d
MB
59 * @writeable_reg: Optional callback returning true if the register
60 * can be written to.
61 * @readable_reg: Optional callback returning true if the register
62 * can be read from.
63 * @volatile_reg: Optional callback returning true if the register
64 * value can't be cached.
65 * @precious_reg: Optional callback returning true if the rgister
66 * should not be read outside of a call from the driver
67 * (eg, a clear on read interrupt status register).
bd20eb54
MB
68 *
69 * @max_register: Optional, specifies the maximum valid register index.
70 * @reg_defaults: Power on reset values for registers (for use with
71 * register cache support).
72 * @num_reg_defaults: Number of elements in reg_defaults.
6f306441
LPC
73 *
74 * @read_flag_mask: Mask to be set in the top byte of the register when doing
75 * a read.
76 * @write_flag_mask: Mask to be set in the top byte of the register when doing
77 * a write. If both read_flag_mask and write_flag_mask are
78 * empty the regmap_bus default masks are used.
2e33caf1
AJ
79 * @use_single_rw: If set, converts the bulk read and write operations into
80 * a series of single read and write operations. This is useful
81 * for device that does not support bulk read and write.
9fabe24e
DP
82 *
83 * @cache_type: The actual cache type.
84 * @reg_defaults_raw: Power on reset values for registers (for use with
85 * register cache support).
86 * @num_reg_defaults_raw: Number of elements in reg_defaults_raw.
dd898b20 87 */
b83a313b 88struct regmap_config {
d3c242e1
SW
89 const char *name;
90
b83a313b 91 int reg_bits;
f01ee60f 92 int reg_stride;
82159ba8 93 int pad_bits;
b83a313b 94 int val_bits;
2e2ae66d 95
2e2ae66d
MB
96 bool (*writeable_reg)(struct device *dev, unsigned int reg);
97 bool (*readable_reg)(struct device *dev, unsigned int reg);
98 bool (*volatile_reg)(struct device *dev, unsigned int reg);
18694886 99 bool (*precious_reg)(struct device *dev, unsigned int reg);
bd20eb54
MB
100
101 unsigned int max_register;
720e4616 102 const struct reg_default *reg_defaults;
9fabe24e
DP
103 unsigned int num_reg_defaults;
104 enum regcache_type cache_type;
105 const void *reg_defaults_raw;
106 unsigned int num_reg_defaults_raw;
6f306441
LPC
107
108 u8 read_flag_mask;
109 u8 write_flag_mask;
2e33caf1
AJ
110
111 bool use_single_rw;
b83a313b
MB
112};
113
0135bbcc 114typedef int (*regmap_hw_write)(void *context, const void *data,
b83a313b 115 size_t count);
0135bbcc 116typedef int (*regmap_hw_gather_write)(void *context,
b83a313b
MB
117 const void *reg, size_t reg_len,
118 const void *val, size_t val_len);
0135bbcc 119typedef int (*regmap_hw_read)(void *context,
b83a313b
MB
120 const void *reg_buf, size_t reg_size,
121 void *val_buf, size_t val_size);
0135bbcc 122typedef void (*regmap_hw_free_context)(void *context);
b83a313b
MB
123
124/**
125 * Description of a hardware bus for the register map infrastructure.
126 *
bacdbe07
SW
127 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
128 * to perform locking.
b83a313b
MB
129 * @write: Write operation.
130 * @gather_write: Write operation with split register/value, return -ENOTSUPP
131 * if not implemented on a given device.
132 * @read: Read operation. Data is returned in the buffer used to transmit
133 * data.
b83a313b
MB
134 * @read_flag_mask: Mask to be set in the top byte of the register when doing
135 * a read.
136 */
137struct regmap_bus {
bacdbe07 138 bool fast_io;
b83a313b
MB
139 regmap_hw_write write;
140 regmap_hw_gather_write gather_write;
141 regmap_hw_read read;
0135bbcc 142 regmap_hw_free_context free_context;
b83a313b
MB
143 u8 read_flag_mask;
144};
145
146struct regmap *regmap_init(struct device *dev,
147 const struct regmap_bus *bus,
0135bbcc 148 void *bus_context,
b83a313b 149 const struct regmap_config *config);
9943fa30
MB
150struct regmap *regmap_init_i2c(struct i2c_client *i2c,
151 const struct regmap_config *config);
a676f083
MB
152struct regmap *regmap_init_spi(struct spi_device *dev,
153 const struct regmap_config *config);
45f5ff81
SW
154struct regmap *regmap_init_mmio(struct device *dev,
155 void __iomem *regs,
156 const struct regmap_config *config);
a676f083 157
c0eb4676
MB
158struct regmap *devm_regmap_init(struct device *dev,
159 const struct regmap_bus *bus,
0135bbcc 160 void *bus_context,
c0eb4676
MB
161 const struct regmap_config *config);
162struct regmap *devm_regmap_init_i2c(struct i2c_client *i2c,
163 const struct regmap_config *config);
164struct regmap *devm_regmap_init_spi(struct spi_device *dev,
165 const struct regmap_config *config);
45f5ff81
SW
166struct regmap *devm_regmap_init_mmio(struct device *dev,
167 void __iomem *regs,
168 const struct regmap_config *config);
c0eb4676 169
b83a313b 170void regmap_exit(struct regmap *map);
bf315173
MB
171int regmap_reinit_cache(struct regmap *map,
172 const struct regmap_config *config);
72b39f6f 173struct regmap *dev_get_regmap(struct device *dev, const char *name);
b83a313b
MB
174int regmap_write(struct regmap *map, unsigned int reg, unsigned int val);
175int regmap_raw_write(struct regmap *map, unsigned int reg,
176 const void *val, size_t val_len);
8eaeb219
LD
177int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
178 size_t val_count);
b83a313b
MB
179int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val);
180int regmap_raw_read(struct regmap *map, unsigned int reg,
181 void *val, size_t val_len);
182int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
183 size_t val_count);
184int regmap_update_bits(struct regmap *map, unsigned int reg,
185 unsigned int mask, unsigned int val);
018690d3
MB
186int regmap_update_bits_check(struct regmap *map, unsigned int reg,
187 unsigned int mask, unsigned int val,
188 bool *change);
a6539c32 189int regmap_get_val_bytes(struct regmap *map);
b83a313b 190
39a58439 191int regcache_sync(struct regmap *map);
4d4cfd16
MB
192int regcache_sync_region(struct regmap *map, unsigned int min,
193 unsigned int max);
92afb286 194void regcache_cache_only(struct regmap *map, bool enable);
6eb0f5e0 195void regcache_cache_bypass(struct regmap *map, bool enable);
8ae0d7e8 196void regcache_mark_dirty(struct regmap *map);
92afb286 197
22f0d90a
MB
198int regmap_register_patch(struct regmap *map, const struct reg_default *regs,
199 int num_regs);
200
f8beab2b
MB
201/**
202 * Description of an IRQ for the generic regmap irq_chip.
203 *
204 * @reg_offset: Offset of the status/mask register within the bank
205 * @mask: Mask used to flag/control the register.
206 */
207struct regmap_irq {
208 unsigned int reg_offset;
209 unsigned int mask;
210};
211
212/**
213 * Description of a generic regmap irq_chip. This is not intended to
214 * handle every possible interrupt controller, but it should handle a
215 * substantial proportion of those that are found in the wild.
216 *
217 * @name: Descriptive name for IRQ controller.
218 *
219 * @status_base: Base status register address.
220 * @mask_base: Base mask register address.
221 * @ack_base: Base ack address. If zero then the chip is clear on read.
222 *
223 * @num_regs: Number of registers in each control bank.
224 * @irqs: Descriptors for individual IRQs. Interrupt numbers are
225 * assigned based on the index in the array of the interrupt.
226 * @num_irqs: Number of descriptors.
227 */
228struct regmap_irq_chip {
229 const char *name;
230
231 unsigned int status_base;
232 unsigned int mask_base;
233 unsigned int ack_base;
234
235 int num_regs;
236
237 const struct regmap_irq *irqs;
238 int num_irqs;
239};
240
241struct regmap_irq_chip_data;
242
243int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags,
244 int irq_base, struct regmap_irq_chip *chip,
245 struct regmap_irq_chip_data **data);
246void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data);
209a6006 247int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data);
92afb286 248
9cde5fcd
MB
249#else
250
251/*
252 * These stubs should only ever be called by generic code which has
253 * regmap based facilities, if they ever get called at runtime
254 * something is going wrong and something probably needs to select
255 * REGMAP.
256 */
257
258static inline int regmap_write(struct regmap *map, unsigned int reg,
259 unsigned int val)
260{
261 WARN_ONCE(1, "regmap API is disabled");
262 return -EINVAL;
263}
264
265static inline int regmap_raw_write(struct regmap *map, unsigned int reg,
266 const void *val, size_t val_len)
267{
268 WARN_ONCE(1, "regmap API is disabled");
269 return -EINVAL;
270}
271
272static inline int regmap_bulk_write(struct regmap *map, unsigned int reg,
273 const void *val, size_t val_count)
274{
275 WARN_ONCE(1, "regmap API is disabled");
276 return -EINVAL;
277}
278
279static inline int regmap_read(struct regmap *map, unsigned int reg,
280 unsigned int *val)
281{
282 WARN_ONCE(1, "regmap API is disabled");
283 return -EINVAL;
284}
285
286static inline int regmap_raw_read(struct regmap *map, unsigned int reg,
287 void *val, size_t val_len)
288{
289 WARN_ONCE(1, "regmap API is disabled");
290 return -EINVAL;
291}
292
293static inline int regmap_bulk_read(struct regmap *map, unsigned int reg,
294 void *val, size_t val_count)
295{
296 WARN_ONCE(1, "regmap API is disabled");
297 return -EINVAL;
298}
299
300static inline int regmap_update_bits(struct regmap *map, unsigned int reg,
301 unsigned int mask, unsigned int val)
302{
303 WARN_ONCE(1, "regmap API is disabled");
304 return -EINVAL;
305}
306
307static inline int regmap_update_bits_check(struct regmap *map,
308 unsigned int reg,
309 unsigned int mask, unsigned int val,
310 bool *change)
311{
312 WARN_ONCE(1, "regmap API is disabled");
313 return -EINVAL;
314}
315
316static inline int regmap_get_val_bytes(struct regmap *map)
317{
318 WARN_ONCE(1, "regmap API is disabled");
319 return -EINVAL;
320}
321
322static inline int regcache_sync(struct regmap *map)
323{
324 WARN_ONCE(1, "regmap API is disabled");
325 return -EINVAL;
326}
327
a313f9f5
MB
328static inline int regcache_sync_region(struct regmap *map, unsigned int min,
329 unsigned int max)
330{
331 WARN_ONCE(1, "regmap API is disabled");
332 return -EINVAL;
333}
334
9cde5fcd
MB
335static inline void regcache_cache_only(struct regmap *map, bool enable)
336{
337 WARN_ONCE(1, "regmap API is disabled");
338}
339
340static inline void regcache_cache_bypass(struct regmap *map, bool enable)
341{
342 WARN_ONCE(1, "regmap API is disabled");
343}
344
345static inline void regcache_mark_dirty(struct regmap *map)
346{
347 WARN_ONCE(1, "regmap API is disabled");
348}
349
350static inline int regmap_register_patch(struct regmap *map,
351 const struct reg_default *regs,
352 int num_regs)
353{
354 WARN_ONCE(1, "regmap API is disabled");
355 return -EINVAL;
356}
357
72b39f6f
MB
358static inline struct regmap *dev_get_regmap(struct device *dev,
359 const char *name)
360{
361 WARN_ONCE(1, "regmap API is disabled");
362 return NULL;
363}
364
9cde5fcd
MB
365#endif
366
b83a313b 367#endif