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	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);
41};
42
43struct regmap_async {
44	struct list_head list;
45	struct regmap *map;
46	void *work_buf;
47};
48
49struct regmap {
50	union {
51		struct mutex mutex;
52		struct {
53			spinlock_t spinlock;
54			unsigned long spinlock_flags;
55		};
56	};
57	regmap_lock lock;
58	regmap_unlock unlock;
59	void *lock_arg; /* This is passed to lock/unlock functions */
60	gfp_t alloc_flags;
61
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;
66	void *bus_context;
67	const char *name;
68
69	bool async;
70	spinlock_t async_lock;
71	wait_queue_head_t async_waitq;
72	struct list_head async_list;
73	struct list_head async_free;
74	int async_ret;
75
76#ifdef CONFIG_DEBUG_FS
77	bool debugfs_disable;
78	struct dentry *debugfs;
79	const char *debugfs_name;
80
81	unsigned int debugfs_reg_len;
82	unsigned int debugfs_val_len;
83	unsigned int debugfs_tot_len;
84
85	struct list_head debugfs_off_cache;
86	struct mutex cache_lock;
87#endif
88
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;
102
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
108	bool defer_caching;
109
110	unsigned long read_flag_mask;
111	unsigned long write_flag_mask;
112
113	/* number of bits to (left) shift the reg value when formatting*/
114	int reg_shift;
115	int reg_stride;
116	int reg_stride_order;
117
118	/* regcache specific members */
119	const struct regcache_ops *cache_ops;
120	enum regcache_type cache_type;
121
122	/* number of bytes in reg_defaults_raw */
123	unsigned int cache_size_raw;
124	/* number of bytes per word in reg_defaults_raw */
125	unsigned int cache_word_size;
126	/* number of entries in reg_defaults */
127	unsigned int num_reg_defaults;
128	/* number of entries in reg_defaults_raw */
129	unsigned int num_reg_defaults_raw;
130
131	/* if set, only the cache is modified not the HW */
132	bool cache_only;
133	/* if set, only the HW is modified not the cache */
134	bool cache_bypass;
135	/* if set, remember to free reg_defaults_raw */
136	bool cache_free;
137
138	struct reg_default *reg_defaults;
139	const void *reg_defaults_raw;
140	void *cache;
141	/* if set, the cache contains newer data than the HW */
142	bool cache_dirty;
143	/* if set, the HW registers are known to match map->reg_defaults */
144	bool no_sync_defaults;
145
146	struct reg_sequence *patch;
147	int patch_regs;
148
149	/* if set, converts bulk read to single read */
150	bool use_single_read;
151	/* if set, converts bulk write to single write */
152	bool use_single_write;
153	/* if set, the device supports multi write mode */
154	bool can_multi_write;
155
156	/* if set, raw reads/writes are limited to this size */
157	size_t max_raw_read;
158	size_t max_raw_write;
159
160	struct rb_root range_tree;
161	void *selector_work_buf;	/* Scratch buffer used for selector */
162
163	struct hwspinlock *hwlock;
164
165	/* if set, the regmap core can sleep */
166	bool can_sleep;
167};
168
169struct regcache_ops {
170	const char *name;
171	enum regcache_type type;
172	int (*init)(struct regmap *map);
173	int (*exit)(struct regmap *map);
174#ifdef CONFIG_DEBUG_FS
175	void (*debugfs_init)(struct regmap *map);
176#endif
177	int (*read)(struct regmap *map, unsigned int reg, unsigned int *value);
178	int (*write)(struct regmap *map, unsigned int reg, unsigned int value);
179	int (*sync)(struct regmap *map, unsigned int min, unsigned int max);
180	int (*drop)(struct regmap *map, unsigned int min, unsigned int max);
181};
182
183bool regmap_cached(struct regmap *map, unsigned int reg);
184bool regmap_writeable(struct regmap *map, unsigned int reg);
185bool regmap_readable(struct regmap *map, unsigned int reg);
186bool regmap_volatile(struct regmap *map, unsigned int reg);
187bool regmap_precious(struct regmap *map, unsigned int reg);
188bool regmap_writeable_noinc(struct regmap *map, unsigned int reg);
189bool regmap_readable_noinc(struct regmap *map, unsigned int reg);
190
191int _regmap_write(struct regmap *map, unsigned int reg,
192		  unsigned int val);
193
194struct regmap_range_node {
195	struct rb_node node;
196	const char *name;
197	struct regmap *map;
198
199	unsigned int range_min;
200	unsigned int range_max;
201
202	unsigned int selector_reg;
203	unsigned int selector_mask;
204	int selector_shift;
205
206	unsigned int window_start;
207	unsigned int window_len;
208};
209
210struct regmap_field {
211	struct regmap *regmap;
212	unsigned int mask;
213	/* lsb */
214	unsigned int shift;
215	unsigned int reg;
216
217	unsigned int id_size;
218	unsigned int id_offset;
219};
220
221#ifdef CONFIG_DEBUG_FS
222extern void regmap_debugfs_initcall(void);
223extern void regmap_debugfs_init(struct regmap *map);
224extern void regmap_debugfs_exit(struct regmap *map);
225
226static inline void regmap_debugfs_disable(struct regmap *map)
227{
228	map->debugfs_disable = true;
229}
230
231#else
232static inline void regmap_debugfs_initcall(void) { }
233static inline void regmap_debugfs_init(struct regmap *map) { }
234static inline void regmap_debugfs_exit(struct regmap *map) { }
235static inline void regmap_debugfs_disable(struct regmap *map) { }
236#endif
237
238/* regcache core declarations */
239int regcache_init(struct regmap *map, const struct regmap_config *config);
240void regcache_exit(struct regmap *map);
241int regcache_read(struct regmap *map,
242		       unsigned int reg, unsigned int *value);
243int regcache_write(struct regmap *map,
244			unsigned int reg, unsigned int value);
245int regcache_sync(struct regmap *map);
246int regcache_sync_block(struct regmap *map, void *block,
247			unsigned long *cache_present,
248			unsigned int block_base, unsigned int start,
249			unsigned int end);
250
251static inline const void *regcache_get_val_addr(struct regmap *map,
252						const void *base,
253						unsigned int idx)
254{
255	return base + (map->cache_word_size * idx);
256}
257
258unsigned int regcache_get_val(struct regmap *map, const void *base,
259			      unsigned int idx);
260bool regcache_set_val(struct regmap *map, void *base, unsigned int idx,
261		      unsigned int val);
262int regcache_lookup_reg(struct regmap *map, unsigned int reg);
263
264int _regmap_raw_write(struct regmap *map, unsigned int reg,
265		      const void *val, size_t val_len, bool noinc);
266
267void regmap_async_complete_cb(struct regmap_async *async, int ret);
268
269enum regmap_endian regmap_get_val_endian(struct device *dev,
270					 const struct regmap_bus *bus,
271					 const struct regmap_config *config);
272
273extern struct regcache_ops regcache_rbtree_ops;
274extern struct regcache_ops regcache_lzo_ops;
275extern struct regcache_ops regcache_flat_ops;
276
277static inline const char *regmap_name(const struct regmap *map)
278{
279	if (map->dev)
280		return dev_name(map->dev);
281
282	return map->name;
283}
284
285static inline unsigned int regmap_get_offset(const struct regmap *map,
286					     unsigned int index)
287{
288	if (map->reg_stride_order >= 0)
289		return index << map->reg_stride_order;
290	else
291		return index * map->reg_stride;
292}
293
294static inline unsigned int regcache_get_index_by_order(const struct regmap *map,
295						       unsigned int reg)
296{
297	return reg >> map->reg_stride_order;
298}
299
300#endif
301