source: GPL/branches/uniaud32-next/lib32/internal.h@ 625

Last change on this file since 625 was 625, checked in by Paul Smedley, 5 years ago

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