Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * Register map access API internal header
4 *
5 * Copyright 2011 Wolfson Microelectronics plc
6 *
7 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
8 */
9
10#ifndef _REGMAP_INTERNAL_H
11#define _REGMAP_INTERNAL_H
12
13#include <linux/device.h>
14#include <linux/regmap.h>
15#include <linux/fs.h>
16#include <linux/list.h>
17#include <linux/wait.h>
18
19struct regmap;
20struct regcache_ops;
21
22struct regmap_debugfs_off_cache {
23 struct list_head list;
24 off_t min;
25 off_t max;
26 unsigned int base_reg;
27 unsigned int max_reg;
28};
29
30struct regmap_format {
31 size_t buf_size;
32 size_t reg_bytes;
33 size_t pad_bytes;
34 size_t reg_downshift;
35 size_t val_bytes;
36 void (*format_write)(struct regmap *map,
37 unsigned int reg, unsigned int val);
38 void (*format_reg)(void *buf, unsigned int reg, unsigned int shift);
39 void (*format_val)(void *buf, unsigned int val, unsigned int shift);
40 unsigned int (*parse_val)(const void *buf);
41 void (*parse_inplace)(void *buf);
42};
43
44struct regmap_async {
45 struct list_head list;
46 struct regmap *map;
47 void *work_buf;
48};
49
50struct regmap {
51 union {
52 struct mutex mutex;
53 struct {
54 spinlock_t spinlock;
55 unsigned long spinlock_flags;
56 };
57 struct {
58 raw_spinlock_t raw_spinlock;
59 unsigned long raw_spinlock_flags;
60 };
61 };
62 regmap_lock lock;
63 regmap_unlock unlock;
64 void *lock_arg; /* This is passed to lock/unlock functions */
65 gfp_t alloc_flags;
66 unsigned int reg_base;
67
68 struct device *dev; /* Device we do I/O on */
69 void *work_buf; /* Scratch buffer used to format I/O */
70 struct regmap_format format; /* Buffer format */
71 const struct regmap_bus *bus;
72 void *bus_context;
73 const char *name;
74
75 bool async;
76 spinlock_t async_lock;
77 wait_queue_head_t async_waitq;
78 struct list_head async_list;
79 struct list_head async_free;
80 int async_ret;
81
82#ifdef CONFIG_DEBUG_FS
83 bool debugfs_disable;
84 struct dentry *debugfs;
85 const char *debugfs_name;
86
87 unsigned int debugfs_reg_len;
88 unsigned int debugfs_val_len;
89 unsigned int debugfs_tot_len;
90
91 struct list_head debugfs_off_cache;
92 struct mutex cache_lock;
93#endif
94
95 unsigned int max_register;
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);
99 bool (*precious_reg)(struct device *dev, unsigned int reg);
100 bool (*writeable_noinc_reg)(struct device *dev, unsigned int reg);
101 bool (*readable_noinc_reg)(struct device *dev, unsigned int reg);
102 const struct regmap_access_table *wr_table;
103 const struct regmap_access_table *rd_table;
104 const struct regmap_access_table *volatile_table;
105 const struct regmap_access_table *precious_table;
106 const struct regmap_access_table *wr_noinc_table;
107 const struct regmap_access_table *rd_noinc_table;
108
109 int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
110 int (*reg_write)(void *context, unsigned int reg, unsigned int val);
111 int (*reg_update_bits)(void *context, unsigned int reg,
112 unsigned int mask, unsigned int val);
113
114 bool defer_caching;
115
116 unsigned long read_flag_mask;
117 unsigned long write_flag_mask;
118
119 /* number of bits to (left) shift the reg value when formatting*/
120 int reg_shift;
121 int reg_stride;
122 int reg_stride_order;
123
124 /* regcache specific members */
125 const struct regcache_ops *cache_ops;
126 enum regcache_type cache_type;
127
128 /* number of bytes in reg_defaults_raw */
129 unsigned int cache_size_raw;
130 /* number of bytes per word in reg_defaults_raw */
131 unsigned int cache_word_size;
132 /* number of entries in reg_defaults */
133 unsigned int num_reg_defaults;
134 /* number of entries in reg_defaults_raw */
135 unsigned int num_reg_defaults_raw;
136
137 /* if set, only the cache is modified not the HW */
138 bool cache_only;
139 /* if set, only the HW is modified not the cache */
140 bool cache_bypass;
141 /* if set, remember to free reg_defaults_raw */
142 bool cache_free;
143
144 struct reg_default *reg_defaults;
145 const void *reg_defaults_raw;
146 void *cache;
147 /* if set, the cache contains newer data than the HW */
148 bool cache_dirty;
149 /* if set, the HW registers are known to match map->reg_defaults */
150 bool no_sync_defaults;
151
152 struct reg_sequence *patch;
153 int patch_regs;
154
155 /* if set, converts bulk read to single read */
156 bool use_single_read;
157 /* if set, converts bulk write to single write */
158 bool use_single_write;
159 /* if set, the device supports multi write mode */
160 bool can_multi_write;
161
162 /* if set, raw reads/writes are limited to this size */
163 size_t max_raw_read;
164 size_t max_raw_write;
165
166 struct rb_root range_tree;
167 void *selector_work_buf; /* Scratch buffer used for selector */
168
169 struct hwspinlock *hwlock;
170
171 /* if set, the regmap core can sleep */
172 bool can_sleep;
173};
174
175struct regcache_ops {
176 const char *name;
177 enum regcache_type type;
178 int (*init)(struct regmap *map);
179 int (*exit)(struct regmap *map);
180#ifdef CONFIG_DEBUG_FS
181 void (*debugfs_init)(struct regmap *map);
182#endif
183 int (*read)(struct regmap *map, unsigned int reg, unsigned int *value);
184 int (*write)(struct regmap *map, unsigned int reg, unsigned int value);
185 int (*sync)(struct regmap *map, unsigned int min, unsigned int max);
186 int (*drop)(struct regmap *map, unsigned int min, unsigned int max);
187};
188
189bool regmap_cached(struct regmap *map, unsigned int reg);
190bool regmap_writeable(struct regmap *map, unsigned int reg);
191bool regmap_readable(struct regmap *map, unsigned int reg);
192bool regmap_volatile(struct regmap *map, unsigned int reg);
193bool regmap_precious(struct regmap *map, unsigned int reg);
194bool regmap_writeable_noinc(struct regmap *map, unsigned int reg);
195bool regmap_readable_noinc(struct regmap *map, unsigned int reg);
196
197int _regmap_write(struct regmap *map, unsigned int reg,
198 unsigned int val);
199
200struct regmap_range_node {
201 struct rb_node node;
202 const char *name;
203 struct regmap *map;
204
205 unsigned int range_min;
206 unsigned int range_max;
207
208 unsigned int selector_reg;
209 unsigned int selector_mask;
210 int selector_shift;
211
212 unsigned int window_start;
213 unsigned int window_len;
214};
215
216struct regmap_field {
217 struct regmap *regmap;
218 unsigned int mask;
219 /* lsb */
220 unsigned int shift;
221 unsigned int reg;
222
223 unsigned int id_size;
224 unsigned int id_offset;
225};
226
227#ifdef CONFIG_DEBUG_FS
228extern void regmap_debugfs_initcall(void);
229extern void regmap_debugfs_init(struct regmap *map);
230extern void regmap_debugfs_exit(struct regmap *map);
231
232static inline void regmap_debugfs_disable(struct regmap *map)
233{
234 map->debugfs_disable = true;
235}
236
237#else
238static inline void regmap_debugfs_initcall(void) { }
239static inline void regmap_debugfs_init(struct regmap *map) { }
240static inline void regmap_debugfs_exit(struct regmap *map) { }
241static inline void regmap_debugfs_disable(struct regmap *map) { }
242#endif
243
244/* regcache core declarations */
245int regcache_init(struct regmap *map, const struct regmap_config *config);
246void regcache_exit(struct regmap *map);
247int regcache_read(struct regmap *map,
248 unsigned int reg, unsigned int *value);
249int regcache_write(struct regmap *map,
250 unsigned int reg, unsigned int value);
251int regcache_sync(struct regmap *map);
252int regcache_sync_block(struct regmap *map, void *block,
253 unsigned long *cache_present,
254 unsigned int block_base, unsigned int start,
255 unsigned int end);
256
257static inline const void *regcache_get_val_addr(struct regmap *map,
258 const void *base,
259 unsigned int idx)
260{
261 return base + (map->cache_word_size * idx);
262}
263
264unsigned int regcache_get_val(struct regmap *map, const void *base,
265 unsigned int idx);
266bool regcache_set_val(struct regmap *map, void *base, unsigned int idx,
267 unsigned int val);
268int regcache_lookup_reg(struct regmap *map, unsigned int reg);
269
270int _regmap_raw_write(struct regmap *map, unsigned int reg,
271 const void *val, size_t val_len, bool noinc);
272
273void regmap_async_complete_cb(struct regmap_async *async, int ret);
274
275enum regmap_endian regmap_get_val_endian(struct device *dev,
276 const struct regmap_bus *bus,
277 const struct regmap_config *config);
278
279extern struct regcache_ops regcache_rbtree_ops;
280extern struct regcache_ops regcache_lzo_ops;
281extern struct regcache_ops regcache_flat_ops;
282
283static inline const char *regmap_name(const struct regmap *map)
284{
285 if (map->dev)
286 return dev_name(map->dev);
287
288 return map->name;
289}
290
291static inline unsigned int regmap_get_offset(const struct regmap *map,
292 unsigned int index)
293{
294 if (map->reg_stride_order >= 0)
295 return index << map->reg_stride_order;
296 else
297 return index * map->reg_stride;
298}
299
300static inline unsigned int regcache_get_index_by_order(const struct regmap *map,
301 unsigned int reg)
302{
303 return reg >> map->reg_stride_order;
304}
305
306#endif