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
)(struct device
*dev
, const void *data
,
102 typedef int (*regmap_hw_gather_write
)(struct device
*dev
,
103 const void *reg
, size_t reg_len
,
104 const void *val
, size_t val_len
);
105 typedef int (*regmap_hw_read
)(struct device
*dev
,
106 const void *reg_buf
, size_t reg_size
,
107 void *val_buf
, size_t val_size
);
110 * Description of a hardware bus for the register map infrastructure.
112 * @write: Write operation.
113 * @gather_write: Write operation with split register/value, return -ENOTSUPP
114 * if not implemented on a given device.
115 * @read: Read operation. Data is returned in the buffer used to transmit
117 * @read_flag_mask: Mask to be set in the top byte of the register when doing
121 regmap_hw_write write
;
122 regmap_hw_gather_write gather_write
;
127 struct regmap
*regmap_init(struct device
*dev
,
128 const struct regmap_bus
*bus
,
129 const struct regmap_config
*config
);
130 struct regmap
*regmap_init_i2c(struct i2c_client
*i2c
,
131 const struct regmap_config
*config
);
132 struct regmap
*regmap_init_spi(struct spi_device
*dev
,
133 const struct regmap_config
*config
);
135 struct regmap
*devm_regmap_init(struct device
*dev
,
136 const struct regmap_bus
*bus
,
137 const struct regmap_config
*config
);
138 struct regmap
*devm_regmap_init_i2c(struct i2c_client
*i2c
,
139 const struct regmap_config
*config
);
140 struct regmap
*devm_regmap_init_spi(struct spi_device
*dev
,
141 const struct regmap_config
*config
);
143 void regmap_exit(struct regmap
*map
);
144 int regmap_reinit_cache(struct regmap
*map
,
145 const struct regmap_config
*config
);
146 int regmap_write(struct regmap
*map
, unsigned int reg
, unsigned int val
);
147 int regmap_raw_write(struct regmap
*map
, unsigned int reg
,
148 const void *val
, size_t val_len
);
149 int regmap_bulk_write(struct regmap
*map
, unsigned int reg
, const void *val
,
151 int regmap_read(struct regmap
*map
, unsigned int reg
, unsigned int *val
);
152 int regmap_raw_read(struct regmap
*map
, unsigned int reg
,
153 void *val
, size_t val_len
);
154 int regmap_bulk_read(struct regmap
*map
, unsigned int reg
, void *val
,
156 int regmap_update_bits(struct regmap
*map
, unsigned int reg
,
157 unsigned int mask
, unsigned int val
);
158 int regmap_update_bits_check(struct regmap
*map
, unsigned int reg
,
159 unsigned int mask
, unsigned int val
,
161 int regmap_get_val_bytes(struct regmap
*map
);
163 int regcache_sync(struct regmap
*map
);
164 int regcache_sync_region(struct regmap
*map
, unsigned int min
,
166 void regcache_cache_only(struct regmap
*map
, bool enable
);
167 void regcache_cache_bypass(struct regmap
*map
, bool enable
);
168 void regcache_mark_dirty(struct regmap
*map
);
170 int regmap_register_patch(struct regmap
*map
, const struct reg_default
*regs
,
174 * Description of an IRQ for the generic regmap irq_chip.
176 * @reg_offset: Offset of the status/mask register within the bank
177 * @mask: Mask used to flag/control the register.
180 unsigned int reg_offset
;
185 * Description of a generic regmap irq_chip. This is not intended to
186 * handle every possible interrupt controller, but it should handle a
187 * substantial proportion of those that are found in the wild.
189 * @name: Descriptive name for IRQ controller.
191 * @status_base: Base status register address.
192 * @mask_base: Base mask register address.
193 * @ack_base: Base ack address. If zero then the chip is clear on read.
195 * @num_regs: Number of registers in each control bank.
196 * @irqs: Descriptors for individual IRQs. Interrupt numbers are
197 * assigned based on the index in the array of the interrupt.
198 * @num_irqs: Number of descriptors.
200 struct regmap_irq_chip
{
203 unsigned int status_base
;
204 unsigned int mask_base
;
205 unsigned int ack_base
;
209 const struct regmap_irq
*irqs
;
213 struct regmap_irq_chip_data
;
215 int regmap_add_irq_chip(struct regmap
*map
, int irq
, int irq_flags
,
216 int irq_base
, struct regmap_irq_chip
*chip
,
217 struct regmap_irq_chip_data
**data
);
218 void regmap_del_irq_chip(int irq
, struct regmap_irq_chip_data
*data
);
219 int regmap_irq_chip_get_base(struct regmap_irq_chip_data
*data
);
224 * These stubs should only ever be called by generic code which has
225 * regmap based facilities, if they ever get called at runtime
226 * something is going wrong and something probably needs to select
230 static inline int regmap_write(struct regmap
*map
, unsigned int reg
,
233 WARN_ONCE(1, "regmap API is disabled");
237 static inline int regmap_raw_write(struct regmap
*map
, unsigned int reg
,
238 const void *val
, size_t val_len
)
240 WARN_ONCE(1, "regmap API is disabled");
244 static inline int regmap_bulk_write(struct regmap
*map
, unsigned int reg
,
245 const void *val
, size_t val_count
)
247 WARN_ONCE(1, "regmap API is disabled");
251 static inline int regmap_read(struct regmap
*map
, unsigned int reg
,
254 WARN_ONCE(1, "regmap API is disabled");
258 static inline int regmap_raw_read(struct regmap
*map
, unsigned int reg
,
259 void *val
, size_t val_len
)
261 WARN_ONCE(1, "regmap API is disabled");
265 static inline int regmap_bulk_read(struct regmap
*map
, unsigned int reg
,
266 void *val
, size_t val_count
)
268 WARN_ONCE(1, "regmap API is disabled");
272 static inline int regmap_update_bits(struct regmap
*map
, unsigned int reg
,
273 unsigned int mask
, unsigned int val
)
275 WARN_ONCE(1, "regmap API is disabled");
279 static inline int regmap_update_bits_check(struct regmap
*map
,
281 unsigned int mask
, unsigned int val
,
284 WARN_ONCE(1, "regmap API is disabled");
288 static inline int regmap_get_val_bytes(struct regmap
*map
)
290 WARN_ONCE(1, "regmap API is disabled");
294 static inline int regcache_sync(struct regmap
*map
)
296 WARN_ONCE(1, "regmap API is disabled");
300 static inline int regcache_sync_region(struct regmap
*map
, unsigned int min
,
303 WARN_ONCE(1, "regmap API is disabled");
307 static inline void regcache_cache_only(struct regmap
*map
, bool enable
)
309 WARN_ONCE(1, "regmap API is disabled");
312 static inline void regcache_cache_bypass(struct regmap
*map
, bool enable
)
314 WARN_ONCE(1, "regmap API is disabled");
317 static inline void regcache_mark_dirty(struct regmap
*map
)
319 WARN_ONCE(1, "regmap API is disabled");
322 static inline int regmap_register_patch(struct regmap
*map
,
323 const struct reg_default
*regs
,
326 WARN_ONCE(1, "regmap API is disabled");