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