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