1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Register map access API internal header
5 * Copyright 2011 Wolfson Microelectronics plc
7 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
10 #ifndef _REGMAP_INTERNAL_H
11 #define _REGMAP_INTERNAL_H
13 #include <linux/device.h>
14 #include <linux/regmap.h>
16 #include <linux/list.h>
17 #include <linux/wait.h>
22 struct regmap_debugfs_off_cache {
23 struct list_head list;
26 unsigned int base_reg;
30 struct regmap_format {
35 void (*format_write)(struct regmap *map,
36 unsigned int reg, unsigned int val);
37 void (*format_reg)(void *buf, unsigned int reg, unsigned int shift);
38 void (*format_val)(void *buf, unsigned int val, unsigned int shift);
39 unsigned int (*parse_val)(const void *buf);
40 void (*parse_inplace)(void *buf);
44 struct list_head list;
54 unsigned long spinlock_flags;
59 void *lock_arg; /* This is passed to lock/unlock functions */
62 struct device *dev; /* Device we do I/O on */
63 void *work_buf; /* Scratch buffer used to format I/O */
64 struct regmap_format format; /* Buffer format */
65 const struct regmap_bus *bus;
70 spinlock_t async_lock;
71 wait_queue_head_t async_waitq;
72 struct list_head async_list;
73 struct list_head async_free;
76 #ifdef CONFIG_DEBUG_FS
78 struct dentry *debugfs;
79 const char *debugfs_name;
81 unsigned int debugfs_reg_len;
82 unsigned int debugfs_val_len;
83 unsigned int debugfs_tot_len;
85 struct list_head debugfs_off_cache;
86 struct mutex cache_lock;
89 unsigned int max_register;
90 bool (*writeable_reg)(struct device *dev, unsigned int reg);
91 bool (*readable_reg)(struct device *dev, unsigned int reg);
92 bool (*volatile_reg)(struct device *dev, unsigned int reg);
93 bool (*precious_reg)(struct device *dev, unsigned int reg);
94 bool (*writeable_noinc_reg)(struct device *dev, unsigned int reg);
95 bool (*readable_noinc_reg)(struct device *dev, unsigned int reg);
96 const struct regmap_access_table *wr_table;
97 const struct regmap_access_table *rd_table;
98 const struct regmap_access_table *volatile_table;
99 const struct regmap_access_table *precious_table;
100 const struct regmap_access_table *wr_noinc_table;
101 const struct regmap_access_table *rd_noinc_table;
103 int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
104 int (*reg_write)(void *context, unsigned int reg, unsigned int val);
105 int (*reg_update_bits)(void *context, unsigned int reg,
106 unsigned int mask, unsigned int val);
107 /* Bulk read/write */
108 int (*read)(void *context, const void *reg_buf, size_t reg_size,
109 void *val_buf, size_t val_size);
110 int (*write)(void *context, const void *data, size_t count);
114 unsigned long read_flag_mask;
115 unsigned long write_flag_mask;
117 /* number of bits to (left) shift the reg value when formatting*/
120 int reg_stride_order;
122 /* regcache specific members */
123 const struct regcache_ops *cache_ops;
124 enum regcache_type cache_type;
126 /* number of bytes in reg_defaults_raw */
127 unsigned int cache_size_raw;
128 /* number of bytes per word in reg_defaults_raw */
129 unsigned int cache_word_size;
130 /* number of entries in reg_defaults */
131 unsigned int num_reg_defaults;
132 /* number of entries in reg_defaults_raw */
133 unsigned int num_reg_defaults_raw;
135 /* if set, only the cache is modified not the HW */
137 /* if set, only the HW is modified not the cache */
139 /* if set, remember to free reg_defaults_raw */
142 struct reg_default *reg_defaults;
143 const void *reg_defaults_raw;
145 /* if set, the cache contains newer data than the HW */
147 /* if set, the HW registers are known to match map->reg_defaults */
148 bool no_sync_defaults;
150 struct reg_sequence *patch;
153 /* if set, converts bulk read to single read */
154 bool use_single_read;
155 /* if set, converts bulk write to single write */
156 bool use_single_write;
157 /* if set, the device supports multi write mode */
158 bool can_multi_write;
160 /* if set, raw reads/writes are limited to this size */
162 size_t max_raw_write;
164 struct rb_root range_tree;
165 void *selector_work_buf; /* Scratch buffer used for selector */
167 struct hwspinlock *hwlock;
169 /* if set, the regmap core can sleep */
173 struct regcache_ops {
175 enum regcache_type type;
176 int (*init)(struct regmap *map);
177 int (*exit)(struct regmap *map);
178 #ifdef CONFIG_DEBUG_FS
179 void (*debugfs_init)(struct regmap *map);
181 int (*read)(struct regmap *map, unsigned int reg, unsigned int *value);
182 int (*write)(struct regmap *map, unsigned int reg, unsigned int value);
183 int (*sync)(struct regmap *map, unsigned int min, unsigned int max);
184 int (*drop)(struct regmap *map, unsigned int min, unsigned int max);
187 bool regmap_cached(struct regmap *map, unsigned int reg);
188 bool regmap_writeable(struct regmap *map, unsigned int reg);
189 bool regmap_readable(struct regmap *map, unsigned int reg);
190 bool regmap_volatile(struct regmap *map, unsigned int reg);
191 bool regmap_precious(struct regmap *map, unsigned int reg);
192 bool regmap_writeable_noinc(struct regmap *map, unsigned int reg);
193 bool regmap_readable_noinc(struct regmap *map, unsigned int reg);
195 int _regmap_write(struct regmap *map, unsigned int reg,
198 struct regmap_range_node {
203 unsigned int range_min;
204 unsigned int range_max;
206 unsigned int selector_reg;
207 unsigned int selector_mask;
210 unsigned int window_start;
211 unsigned int window_len;
214 struct regmap_field {
215 struct regmap *regmap;
221 unsigned int id_size;
222 unsigned int id_offset;
225 #ifdef CONFIG_DEBUG_FS
226 extern void regmap_debugfs_initcall(void);
227 extern void regmap_debugfs_init(struct regmap *map);
228 extern void regmap_debugfs_exit(struct regmap *map);
230 static inline void regmap_debugfs_disable(struct regmap *map)
232 map->debugfs_disable = true;
236 static inline void regmap_debugfs_initcall(void) { }
237 static inline void regmap_debugfs_init(struct regmap *map) { }
238 static inline void regmap_debugfs_exit(struct regmap *map) { }
239 static inline void regmap_debugfs_disable(struct regmap *map) { }
242 /* regcache core declarations */
243 int regcache_init(struct regmap *map, const struct regmap_config *config);
244 void regcache_exit(struct regmap *map);
245 int regcache_read(struct regmap *map,
246 unsigned int reg, unsigned int *value);
247 int regcache_write(struct regmap *map,
248 unsigned int reg, unsigned int value);
249 int regcache_sync(struct regmap *map);
250 int regcache_sync_block(struct regmap *map, void *block,
251 unsigned long *cache_present,
252 unsigned int block_base, unsigned int start,
255 static inline const void *regcache_get_val_addr(struct regmap *map,
259 return base + (map->cache_word_size * idx);
262 unsigned int regcache_get_val(struct regmap *map, const void *base,
264 bool regcache_set_val(struct regmap *map, void *base, unsigned int idx,
266 int regcache_lookup_reg(struct regmap *map, unsigned int reg);
268 int _regmap_raw_write(struct regmap *map, unsigned int reg,
269 const void *val, size_t val_len, bool noinc);
271 void regmap_async_complete_cb(struct regmap_async *async, int ret);
273 enum regmap_endian regmap_get_val_endian(struct device *dev,
274 const struct regmap_bus *bus,
275 const struct regmap_config *config);
277 extern struct regcache_ops regcache_rbtree_ops;
278 extern struct regcache_ops regcache_lzo_ops;
279 extern struct regcache_ops regcache_flat_ops;
281 static inline const char *regmap_name(const struct regmap *map)
284 return dev_name(map->dev);
289 static inline unsigned int regmap_get_offset(const struct regmap *map,
292 if (map->reg_stride_order >= 0)
293 return index << map->reg_stride_order;
295 return index * map->reg_stride;
298 static inline unsigned int regcache_get_index_by_order(const struct regmap *map,
301 return reg >> map->reg_stride_order;