Commit | Line | Data |
---|---|---|
93de9124 MB |
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/regmap.h> | |
31244e39 | 17 | #include <linux/fs.h> |
5166b7c0 | 18 | #include <linux/list.h> |
0d509f2b | 19 | #include <linux/wait.h> |
93de9124 MB |
20 | |
21 | struct regmap; | |
9fabe24e | 22 | struct regcache_ops; |
93de9124 | 23 | |
5166b7c0 MB |
24 | struct regmap_debugfs_off_cache { |
25 | struct list_head list; | |
26 | off_t min; | |
27 | off_t max; | |
28 | unsigned int base_reg; | |
c2c1ee66 | 29 | unsigned int max_reg; |
5166b7c0 MB |
30 | }; |
31 | ||
93de9124 MB |
32 | struct regmap_format { |
33 | size_t buf_size; | |
34 | size_t reg_bytes; | |
82159ba8 | 35 | size_t pad_bytes; |
93de9124 MB |
36 | size_t val_bytes; |
37 | void (*format_write)(struct regmap *map, | |
38 | unsigned int reg, unsigned int val); | |
d939fb9a MR |
39 | void (*format_reg)(void *buf, unsigned int reg, unsigned int shift); |
40 | void (*format_val)(void *buf, unsigned int val, unsigned int shift); | |
8a819ff8 MB |
41 | unsigned int (*parse_val)(const void *buf); |
42 | void (*parse_inplace)(void *buf); | |
93de9124 MB |
43 | }; |
44 | ||
0d509f2b MB |
45 | struct regmap_async { |
46 | struct list_head list; | |
0d509f2b MB |
47 | struct regmap *map; |
48 | void *work_buf; | |
49 | }; | |
50 | ||
93de9124 | 51 | struct regmap { |
336fb81b WY |
52 | union { |
53 | struct mutex mutex; | |
f93d1be2 WY |
54 | struct { |
55 | spinlock_t spinlock; | |
56 | unsigned long spinlock_flags; | |
57 | }; | |
336fb81b | 58 | }; |
bacdbe07 SW |
59 | regmap_lock lock; |
60 | regmap_unlock unlock; | |
0d4529c5 | 61 | void *lock_arg; /* This is passed to lock/unlock functions */ |
b4a21fc2 | 62 | gfp_t alloc_flags; |
93de9124 MB |
63 | |
64 | struct device *dev; /* Device we do I/O on */ | |
65 | void *work_buf; /* Scratch buffer used to format I/O */ | |
66 | struct regmap_format format; /* Buffer format */ | |
67 | const struct regmap_bus *bus; | |
0135bbcc | 68 | void *bus_context; |
72b39f6f | 69 | const char *name; |
93de9124 | 70 | |
0a819809 | 71 | bool async; |
0d509f2b MB |
72 | spinlock_t async_lock; |
73 | wait_queue_head_t async_waitq; | |
74 | struct list_head async_list; | |
7e09a979 | 75 | struct list_head async_free; |
0d509f2b MB |
76 | int async_ret; |
77 | ||
31244e39 MB |
78 | #ifdef CONFIG_DEBUG_FS |
79 | struct dentry *debugfs; | |
d3c242e1 | 80 | const char *debugfs_name; |
cbc1938b MB |
81 | |
82 | unsigned int debugfs_reg_len; | |
83 | unsigned int debugfs_val_len; | |
84 | unsigned int debugfs_tot_len; | |
5166b7c0 MB |
85 | |
86 | struct list_head debugfs_off_cache; | |
065b4c58 | 87 | struct mutex cache_lock; |
31244e39 MB |
88 | #endif |
89 | ||
93de9124 MB |
90 | unsigned int max_register; |
91 | bool (*writeable_reg)(struct device *dev, unsigned int reg); | |
92 | bool (*readable_reg)(struct device *dev, unsigned int reg); | |
93 | bool (*volatile_reg)(struct device *dev, unsigned int reg); | |
2efe1642 | 94 | bool (*precious_reg)(struct device *dev, unsigned int reg); |
76aad392 DC |
95 | const struct regmap_access_table *wr_table; |
96 | const struct regmap_access_table *rd_table; | |
97 | const struct regmap_access_table *volatile_table; | |
98 | const struct regmap_access_table *precious_table; | |
6f306441 | 99 | |
ad278406 | 100 | int (*reg_read)(void *context, unsigned int reg, unsigned int *val); |
07c320dc | 101 | int (*reg_write)(void *context, unsigned int reg, unsigned int val); |
77792b11 JR |
102 | int (*reg_update_bits)(void *context, unsigned int reg, |
103 | unsigned int mask, unsigned int val); | |
ad278406 | 104 | |
d2a5884a AS |
105 | bool defer_caching; |
106 | ||
6f306441 LPC |
107 | u8 read_flag_mask; |
108 | u8 write_flag_mask; | |
9fabe24e | 109 | |
d939fb9a MR |
110 | /* number of bits to (left) shift the reg value when formatting*/ |
111 | int reg_shift; | |
f01ee60f | 112 | int reg_stride; |
ca747be2 | 113 | int reg_stride_order; |
d939fb9a | 114 | |
9fabe24e DP |
115 | /* regcache specific members */ |
116 | const struct regcache_ops *cache_ops; | |
117 | enum regcache_type cache_type; | |
118 | ||
119 | /* number of bytes in reg_defaults_raw */ | |
120 | unsigned int cache_size_raw; | |
121 | /* number of bytes per word in reg_defaults_raw */ | |
122 | unsigned int cache_word_size; | |
123 | /* number of entries in reg_defaults */ | |
124 | unsigned int num_reg_defaults; | |
125 | /* number of entries in reg_defaults_raw */ | |
126 | unsigned int num_reg_defaults_raw; | |
127 | ||
128 | /* if set, only the cache is modified not the HW */ | |
621a5f7a | 129 | bool cache_only; |
9fabe24e | 130 | /* if set, only the HW is modified not the cache */ |
621a5f7a | 131 | bool cache_bypass; |
9fabe24e | 132 | /* if set, remember to free reg_defaults_raw */ |
847fb6fd | 133 | bool cache_free; |
9fabe24e DP |
134 | |
135 | struct reg_default *reg_defaults; | |
136 | const void *reg_defaults_raw; | |
137 | void *cache; | |
1c79771a | 138 | /* if set, the cache contains newer data than the HW */ |
621a5f7a | 139 | bool cache_dirty; |
1c79771a KC |
140 | /* if set, the HW registers are known to match map->reg_defaults */ |
141 | bool no_sync_defaults; | |
22f0d90a | 142 | |
8019ff6c | 143 | struct reg_sequence *patch; |
22f0d90a | 144 | int patch_regs; |
2e33caf1 | 145 | |
67921a1a MP |
146 | /* if set, converts bulk read to single read */ |
147 | bool use_single_read; | |
148 | /* if set, converts bulk read to single read */ | |
149 | bool use_single_write; | |
e894c3f4 OAO |
150 | /* if set, the device supports multi write mode */ |
151 | bool can_multi_write; | |
6863ca62 | 152 | |
adaac459 MP |
153 | /* if set, raw reads/writes are limited to this size */ |
154 | size_t max_raw_read; | |
155 | size_t max_raw_write; | |
156 | ||
6863ca62 KG |
157 | struct rb_root range_tree; |
158 | void *selector_work_buf; /* Scratch buffer used for selector */ | |
9fabe24e DP |
159 | }; |
160 | ||
161 | struct regcache_ops { | |
162 | const char *name; | |
163 | enum regcache_type type; | |
164 | int (*init)(struct regmap *map); | |
165 | int (*exit)(struct regmap *map); | |
5e0cbe78 LPC |
166 | #ifdef CONFIG_DEBUG_FS |
167 | void (*debugfs_init)(struct regmap *map); | |
168 | #endif | |
9fabe24e DP |
169 | int (*read)(struct regmap *map, unsigned int reg, unsigned int *value); |
170 | int (*write)(struct regmap *map, unsigned int reg, unsigned int value); | |
ac8d91c8 | 171 | int (*sync)(struct regmap *map, unsigned int min, unsigned int max); |
697e85bc | 172 | int (*drop)(struct regmap *map, unsigned int min, unsigned int max); |
93de9124 MB |
173 | }; |
174 | ||
8de2f081 MB |
175 | bool regmap_writeable(struct regmap *map, unsigned int reg); |
176 | bool regmap_readable(struct regmap *map, unsigned int reg); | |
177 | bool regmap_volatile(struct regmap *map, unsigned int reg); | |
178 | bool regmap_precious(struct regmap *map, unsigned int reg); | |
179 | ||
4d2dc095 DP |
180 | int _regmap_write(struct regmap *map, unsigned int reg, |
181 | unsigned int val); | |
182 | ||
6863ca62 KG |
183 | struct regmap_range_node { |
184 | struct rb_node node; | |
d058bb49 | 185 | const char *name; |
4b020b3f | 186 | struct regmap *map; |
6863ca62 KG |
187 | |
188 | unsigned int range_min; | |
189 | unsigned int range_max; | |
190 | ||
191 | unsigned int selector_reg; | |
192 | unsigned int selector_mask; | |
193 | int selector_shift; | |
194 | ||
195 | unsigned int window_start; | |
196 | unsigned int window_len; | |
197 | }; | |
198 | ||
67252287 SK |
199 | struct regmap_field { |
200 | struct regmap *regmap; | |
201 | unsigned int mask; | |
202 | /* lsb */ | |
203 | unsigned int shift; | |
204 | unsigned int reg; | |
a0102375 KM |
205 | |
206 | unsigned int id_size; | |
207 | unsigned int id_offset; | |
67252287 SK |
208 | }; |
209 | ||
31244e39 MB |
210 | #ifdef CONFIG_DEBUG_FS |
211 | extern void regmap_debugfs_initcall(void); | |
d3c242e1 | 212 | extern void regmap_debugfs_init(struct regmap *map, const char *name); |
31244e39 MB |
213 | extern void regmap_debugfs_exit(struct regmap *map); |
214 | #else | |
bbcf61ca | 215 | static inline void regmap_debugfs_initcall(void) { } |
abec95ad | 216 | static inline void regmap_debugfs_init(struct regmap *map, const char *name) { } |
bbcf61ca | 217 | static inline void regmap_debugfs_exit(struct regmap *map) { } |
31244e39 MB |
218 | #endif |
219 | ||
9fabe24e | 220 | /* regcache core declarations */ |
e5e3b8ab | 221 | int regcache_init(struct regmap *map, const struct regmap_config *config); |
9fabe24e DP |
222 | void regcache_exit(struct regmap *map); |
223 | int regcache_read(struct regmap *map, | |
224 | unsigned int reg, unsigned int *value); | |
225 | int regcache_write(struct regmap *map, | |
226 | unsigned int reg, unsigned int value); | |
227 | int regcache_sync(struct regmap *map); | |
f8bd822c | 228 | int regcache_sync_block(struct regmap *map, void *block, |
3f4ff561 | 229 | unsigned long *cache_present, |
f8bd822c MB |
230 | unsigned int block_base, unsigned int start, |
231 | unsigned int end); | |
9fabe24e | 232 | |
8817796b MB |
233 | static inline const void *regcache_get_val_addr(struct regmap *map, |
234 | const void *base, | |
235 | unsigned int idx) | |
236 | { | |
237 | return base + (map->cache_word_size * idx); | |
238 | } | |
239 | ||
879082c9 MB |
240 | unsigned int regcache_get_val(struct regmap *map, const void *base, |
241 | unsigned int idx); | |
242 | bool regcache_set_val(struct regmap *map, void *base, unsigned int idx, | |
243 | unsigned int val); | |
9fabe24e | 244 | int regcache_lookup_reg(struct regmap *map, unsigned int reg); |
9fabe24e | 245 | |
584de329 | 246 | int _regmap_raw_write(struct regmap *map, unsigned int reg, |
0a819809 | 247 | const void *val, size_t val_len); |
584de329 | 248 | |
0d509f2b MB |
249 | void regmap_async_complete_cb(struct regmap_async *async, int ret); |
250 | ||
3c174d29 GR |
251 | enum regmap_endian regmap_get_val_endian(struct device *dev, |
252 | const struct regmap_bus *bus, | |
253 | const struct regmap_config *config); | |
254 | ||
28644c80 | 255 | extern struct regcache_ops regcache_rbtree_ops; |
2cbbb579 | 256 | extern struct regcache_ops regcache_lzo_ops; |
2ac902ce | 257 | extern struct regcache_ops regcache_flat_ops; |
2cbbb579 | 258 | |
c6b570d9 PZ |
259 | static inline const char *regmap_name(const struct regmap *map) |
260 | { | |
261 | if (map->dev) | |
262 | return dev_name(map->dev); | |
263 | ||
264 | return map->name; | |
265 | } | |
266 | ||
ca747be2 XL |
267 | static inline unsigned int regmap_get_offset(const struct regmap *map, |
268 | unsigned int index) | |
269 | { | |
270 | if (map->reg_stride_order >= 0) | |
271 | return index << map->reg_stride_order; | |
272 | else | |
273 | return index * map->reg_stride; | |
274 | } | |
275 | ||
8b31ec55 XL |
276 | static inline unsigned int regcache_get_index_by_order(const struct regmap *map, |
277 | unsigned int reg) | |
278 | { | |
279 | return reg >> map->reg_stride_order; | |
280 | } | |
281 | ||
93de9124 | 282 | #endif |