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