1 #ifndef __LINUX_REGMAP_H
2 #define __LINUX_REGMAP_H
5 * Register map access API
7 * Copyright 2011 Wolfson Microelectronics plc
9 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
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.
16 #include <linux/list.h>
24 /* An enum of all the supported cache types */
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
36 * @reg: Register address.
37 * @def: Register default value.
47 * Configuration for the register map of a device.
49 * @reg_bits: Number of bits in a register address, mandatory.
50 * @pad_bits: Number of bits of padding between register and value.
51 * @val_bits: Number of bits in a register value, mandatory.
53 * @writeable_reg: Optional callback returning true if the register
55 * @readable_reg: Optional callback returning true if the register
57 * @volatile_reg: Optional callback returning true if the register
58 * value can't be cached.
59 * @precious_reg: Optional callback returning true if the rgister
60 * should not be read outside of a call from the driver
61 * (eg, a clear on read interrupt status register).
63 * @max_register: Optional, specifies the maximum valid register index.
64 * @reg_defaults: Power on reset values for registers (for use with
65 * register cache support).
66 * @num_reg_defaults: Number of elements in reg_defaults.
68 * @read_flag_mask: Mask to be set in the top byte of the register when doing
70 * @write_flag_mask: Mask to be set in the top byte of the register when doing
71 * a write. If both read_flag_mask and write_flag_mask are
72 * empty the regmap_bus default masks are used.
74 * @cache_type: The actual cache type.
75 * @reg_defaults_raw: Power on reset values for registers (for use with
76 * register cache support).
77 * @num_reg_defaults_raw: Number of elements in reg_defaults_raw.
79 struct regmap_config
{
84 bool (*writeable_reg
)(struct device
*dev
, unsigned int reg
);
85 bool (*readable_reg
)(struct device
*dev
, unsigned int reg
);
86 bool (*volatile_reg
)(struct device
*dev
, unsigned int reg
);
87 bool (*precious_reg
)(struct device
*dev
, unsigned int reg
);
89 unsigned int max_register
;
90 const struct reg_default
*reg_defaults
;
91 unsigned int num_reg_defaults
;
92 enum regcache_type cache_type
;
93 const void *reg_defaults_raw
;
94 unsigned int num_reg_defaults_raw
;
100 typedef int (*regmap_hw_write
)(void *context
, const void *data
,
102 typedef int (*regmap_hw_gather_write
)(void *context
,
103 const void *reg
, size_t reg_len
,
104 const void *val
, size_t val_len
);
105 typedef int (*regmap_hw_read
)(void *context
,
106 const void *reg_buf
, size_t reg_size
,
107 void *val_buf
, size_t val_size
);
108 typedef void (*regmap_hw_free_context
)(void *context
);
111 * Description of a hardware bus for the register map infrastructure.
113 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
114 * to perform locking.
115 * @write: Write operation.
116 * @gather_write: Write operation with split register/value, return -ENOTSUPP
117 * if not implemented on a given device.
118 * @read: Read operation. Data is returned in the buffer used to transmit
120 * @read_flag_mask: Mask to be set in the top byte of the register when doing
125 regmap_hw_write write
;
126 regmap_hw_gather_write gather_write
;
128 regmap_hw_free_context free_context
;
132 struct regmap
*regmap_init(struct device
*dev
,
133 const struct regmap_bus
*bus
,
135 const struct regmap_config
*config
);
136 struct regmap
*regmap_init_i2c(struct i2c_client
*i2c
,
137 const struct regmap_config
*config
);
138 struct regmap
*regmap_init_spi(struct spi_device
*dev
,
139 const struct regmap_config
*config
);
140 struct regmap
*regmap_init_mmio(struct device
*dev
,
142 const struct regmap_config
*config
);
144 struct regmap
*devm_regmap_init(struct device
*dev
,
145 const struct regmap_bus
*bus
,
147 const struct regmap_config
*config
);
148 struct regmap
*devm_regmap_init_i2c(struct i2c_client
*i2c
,
149 const struct regmap_config
*config
);
150 struct regmap
*devm_regmap_init_spi(struct spi_device
*dev
,
151 const struct regmap_config
*config
);
152 struct regmap
*devm_regmap_init_mmio(struct device
*dev
,
154 const struct regmap_config
*config
);
156 void regmap_exit(struct regmap
*map
);
157 int regmap_reinit_cache(struct regmap
*map
,
158 const struct regmap_config
*config
);
159 int regmap_write(struct regmap
*map
, unsigned int reg
, unsigned int val
);
160 int regmap_raw_write(struct regmap
*map
, unsigned int reg
,
161 const void *val
, size_t val_len
);
162 int regmap_bulk_write(struct regmap
*map
, unsigned int reg
, const void *val
,
164 int regmap_read(struct regmap
*map
, unsigned int reg
, unsigned int *val
);
165 int regmap_raw_read(struct regmap
*map
, unsigned int reg
,
166 void *val
, size_t val_len
);
167 int regmap_bulk_read(struct regmap
*map
, unsigned int reg
, void *val
,
169 int regmap_update_bits(struct regmap
*map
, unsigned int reg
,
170 unsigned int mask
, unsigned int val
);
171 int regmap_update_bits_check(struct regmap
*map
, unsigned int reg
,
172 unsigned int mask
, unsigned int val
,
174 int regmap_get_val_bytes(struct regmap
*map
);
176 int regcache_sync(struct regmap
*map
);
177 int regcache_sync_region(struct regmap
*map
, unsigned int min
,
179 void regcache_cache_only(struct regmap
*map
, bool enable
);
180 void regcache_cache_bypass(struct regmap
*map
, bool enable
);
181 void regcache_mark_dirty(struct regmap
*map
);
183 int regmap_register_patch(struct regmap
*map
, const struct reg_default
*regs
,
187 * Description of an IRQ for the generic regmap irq_chip.
189 * @reg_offset: Offset of the status/mask register within the bank
190 * @mask: Mask used to flag/control the register.
193 unsigned int reg_offset
;
198 * Description of a generic regmap irq_chip. This is not intended to
199 * handle every possible interrupt controller, but it should handle a
200 * substantial proportion of those that are found in the wild.
202 * @name: Descriptive name for IRQ controller.
204 * @status_base: Base status register address.
205 * @mask_base: Base mask register address.
206 * @ack_base: Base ack address. If zero then the chip is clear on read.
208 * @num_regs: Number of registers in each control bank.
209 * @irqs: Descriptors for individual IRQs. Interrupt numbers are
210 * assigned based on the index in the array of the interrupt.
211 * @num_irqs: Number of descriptors.
213 struct regmap_irq_chip
{
216 unsigned int status_base
;
217 unsigned int mask_base
;
218 unsigned int ack_base
;
222 const struct regmap_irq
*irqs
;
226 struct regmap_irq_chip_data
;
228 int regmap_add_irq_chip(struct regmap
*map
, int irq
, int irq_flags
,
229 int irq_base
, struct regmap_irq_chip
*chip
,
230 struct regmap_irq_chip_data
**data
);
231 void regmap_del_irq_chip(int irq
, struct regmap_irq_chip_data
*data
);
232 int regmap_irq_chip_get_base(struct regmap_irq_chip_data
*data
);
237 * These stubs should only ever be called by generic code which has
238 * regmap based facilities, if they ever get called at runtime
239 * something is going wrong and something probably needs to select
243 static inline int regmap_write(struct regmap
*map
, unsigned int reg
,
246 WARN_ONCE(1, "regmap API is disabled");
250 static inline int regmap_raw_write(struct regmap
*map
, unsigned int reg
,
251 const void *val
, size_t val_len
)
253 WARN_ONCE(1, "regmap API is disabled");
257 static inline int regmap_bulk_write(struct regmap
*map
, unsigned int reg
,
258 const void *val
, size_t val_count
)
260 WARN_ONCE(1, "regmap API is disabled");
264 static inline int regmap_read(struct regmap
*map
, unsigned int reg
,
267 WARN_ONCE(1, "regmap API is disabled");
271 static inline int regmap_raw_read(struct regmap
*map
, unsigned int reg
,
272 void *val
, size_t val_len
)
274 WARN_ONCE(1, "regmap API is disabled");
278 static inline int regmap_bulk_read(struct regmap
*map
, unsigned int reg
,
279 void *val
, size_t val_count
)
281 WARN_ONCE(1, "regmap API is disabled");
285 static inline int regmap_update_bits(struct regmap
*map
, unsigned int reg
,
286 unsigned int mask
, unsigned int val
)
288 WARN_ONCE(1, "regmap API is disabled");
292 static inline int regmap_update_bits_check(struct regmap
*map
,
294 unsigned int mask
, unsigned int val
,
297 WARN_ONCE(1, "regmap API is disabled");
301 static inline int regmap_get_val_bytes(struct regmap
*map
)
303 WARN_ONCE(1, "regmap API is disabled");
307 static inline int regcache_sync(struct regmap
*map
)
309 WARN_ONCE(1, "regmap API is disabled");
313 static inline int regcache_sync_region(struct regmap
*map
, unsigned int min
,
316 WARN_ONCE(1, "regmap API is disabled");
320 static inline void regcache_cache_only(struct regmap
*map
, bool enable
)
322 WARN_ONCE(1, "regmap API is disabled");
325 static inline void regcache_cache_bypass(struct regmap
*map
, bool enable
)
327 WARN_ONCE(1, "regmap API is disabled");
330 static inline void regcache_mark_dirty(struct regmap
*map
)
332 WARN_ONCE(1, "regmap API is disabled");
335 static inline int regmap_register_patch(struct regmap
*map
,
336 const struct reg_default
*regs
,
339 WARN_ONCE(1, "regmap API is disabled");