]>
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 */ |
93de9124 MB |
62 | |
63 | struct device *dev; /* Device we do I/O on */ | |
64 | void *work_buf; /* Scratch buffer used to format I/O */ | |
65 | struct regmap_format format; /* Buffer format */ | |
66 | const struct regmap_bus *bus; | |
0135bbcc | 67 | void *bus_context; |
72b39f6f | 68 | const char *name; |
93de9124 | 69 | |
0a819809 | 70 | bool async; |
0d509f2b MB |
71 | spinlock_t async_lock; |
72 | wait_queue_head_t async_waitq; | |
73 | struct list_head async_list; | |
7e09a979 | 74 | struct list_head async_free; |
0d509f2b MB |
75 | int async_ret; |
76 | ||
31244e39 MB |
77 | #ifdef CONFIG_DEBUG_FS |
78 | struct dentry *debugfs; | |
d3c242e1 | 79 | const char *debugfs_name; |
cbc1938b MB |
80 | |
81 | unsigned int debugfs_reg_len; | |
82 | unsigned int debugfs_val_len; | |
83 | unsigned int debugfs_tot_len; | |
5166b7c0 MB |
84 | |
85 | struct list_head debugfs_off_cache; | |
065b4c58 | 86 | struct mutex cache_lock; |
31244e39 MB |
87 | #endif |
88 | ||
93de9124 MB |
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); | |
2efe1642 | 93 | bool (*precious_reg)(struct device *dev, unsigned int reg); |
76aad392 DC |
94 | const struct regmap_access_table *wr_table; |
95 | const struct regmap_access_table *rd_table; | |
96 | const struct regmap_access_table *volatile_table; | |
97 | const struct regmap_access_table *precious_table; | |
6f306441 | 98 | |
ad278406 | 99 | int (*reg_read)(void *context, unsigned int reg, unsigned int *val); |
07c320dc | 100 | int (*reg_write)(void *context, unsigned int reg, unsigned int val); |
ad278406 | 101 | |
d2a5884a AS |
102 | bool defer_caching; |
103 | ||
6f306441 LPC |
104 | u8 read_flag_mask; |
105 | u8 write_flag_mask; | |
9fabe24e | 106 | |
d939fb9a MR |
107 | /* number of bits to (left) shift the reg value when formatting*/ |
108 | int reg_shift; | |
f01ee60f | 109 | int reg_stride; |
d939fb9a | 110 | |
9fabe24e DP |
111 | /* regcache specific members */ |
112 | const struct regcache_ops *cache_ops; | |
113 | enum regcache_type cache_type; | |
114 | ||
115 | /* number of bytes in reg_defaults_raw */ | |
116 | unsigned int cache_size_raw; | |
117 | /* number of bytes per word in reg_defaults_raw */ | |
118 | unsigned int cache_word_size; | |
119 | /* number of entries in reg_defaults */ | |
120 | unsigned int num_reg_defaults; | |
121 | /* number of entries in reg_defaults_raw */ | |
122 | unsigned int num_reg_defaults_raw; | |
123 | ||
124 | /* if set, only the cache is modified not the HW */ | |
847fb6fd | 125 | u32 cache_only; |
9fabe24e | 126 | /* if set, only the HW is modified not the cache */ |
847fb6fd | 127 | u32 cache_bypass; |
9fabe24e | 128 | /* if set, remember to free reg_defaults_raw */ |
847fb6fd | 129 | bool cache_free; |
9fabe24e DP |
130 | |
131 | struct reg_default *reg_defaults; | |
132 | const void *reg_defaults_raw; | |
133 | void *cache; | |
847fb6fd | 134 | u32 cache_dirty; |
22f0d90a MB |
135 | |
136 | struct reg_default *patch; | |
137 | int patch_regs; | |
2e33caf1 AJ |
138 | |
139 | /* if set, converts bulk rw to single rw */ | |
140 | bool use_single_rw; | |
e894c3f4 OAO |
141 | /* if set, the device supports multi write mode */ |
142 | bool can_multi_write; | |
6863ca62 KG |
143 | |
144 | struct rb_root range_tree; | |
145 | void *selector_work_buf; /* Scratch buffer used for selector */ | |
9fabe24e DP |
146 | }; |
147 | ||
148 | struct regcache_ops { | |
149 | const char *name; | |
150 | enum regcache_type type; | |
151 | int (*init)(struct regmap *map); | |
152 | int (*exit)(struct regmap *map); | |
5e0cbe78 LPC |
153 | #ifdef CONFIG_DEBUG_FS |
154 | void (*debugfs_init)(struct regmap *map); | |
155 | #endif | |
9fabe24e DP |
156 | int (*read)(struct regmap *map, unsigned int reg, unsigned int *value); |
157 | int (*write)(struct regmap *map, unsigned int reg, unsigned int value); | |
ac8d91c8 | 158 | int (*sync)(struct regmap *map, unsigned int min, unsigned int max); |
697e85bc | 159 | int (*drop)(struct regmap *map, unsigned int min, unsigned int max); |
93de9124 MB |
160 | }; |
161 | ||
8de2f081 MB |
162 | bool regmap_writeable(struct regmap *map, unsigned int reg); |
163 | bool regmap_readable(struct regmap *map, unsigned int reg); | |
164 | bool regmap_volatile(struct regmap *map, unsigned int reg); | |
165 | bool regmap_precious(struct regmap *map, unsigned int reg); | |
166 | ||
4d2dc095 DP |
167 | int _regmap_write(struct regmap *map, unsigned int reg, |
168 | unsigned int val); | |
169 | ||
6863ca62 KG |
170 | struct regmap_range_node { |
171 | struct rb_node node; | |
d058bb49 | 172 | const char *name; |
4b020b3f | 173 | struct regmap *map; |
6863ca62 KG |
174 | |
175 | unsigned int range_min; | |
176 | unsigned int range_max; | |
177 | ||
178 | unsigned int selector_reg; | |
179 | unsigned int selector_mask; | |
180 | int selector_shift; | |
181 | ||
182 | unsigned int window_start; | |
183 | unsigned int window_len; | |
184 | }; | |
185 | ||
67252287 SK |
186 | struct regmap_field { |
187 | struct regmap *regmap; | |
188 | unsigned int mask; | |
189 | /* lsb */ | |
190 | unsigned int shift; | |
191 | unsigned int reg; | |
a0102375 KM |
192 | |
193 | unsigned int id_size; | |
194 | unsigned int id_offset; | |
67252287 SK |
195 | }; |
196 | ||
31244e39 MB |
197 | #ifdef CONFIG_DEBUG_FS |
198 | extern void regmap_debugfs_initcall(void); | |
d3c242e1 | 199 | extern void regmap_debugfs_init(struct regmap *map, const char *name); |
31244e39 MB |
200 | extern void regmap_debugfs_exit(struct regmap *map); |
201 | #else | |
bbcf61ca | 202 | static inline void regmap_debugfs_initcall(void) { } |
abec95ad | 203 | static inline void regmap_debugfs_init(struct regmap *map, const char *name) { } |
bbcf61ca | 204 | static inline void regmap_debugfs_exit(struct regmap *map) { } |
31244e39 MB |
205 | #endif |
206 | ||
9fabe24e | 207 | /* regcache core declarations */ |
e5e3b8ab | 208 | int regcache_init(struct regmap *map, const struct regmap_config *config); |
9fabe24e DP |
209 | void regcache_exit(struct regmap *map); |
210 | int regcache_read(struct regmap *map, | |
211 | unsigned int reg, unsigned int *value); | |
212 | int regcache_write(struct regmap *map, | |
213 | unsigned int reg, unsigned int value); | |
214 | int regcache_sync(struct regmap *map); | |
f8bd822c | 215 | int regcache_sync_block(struct regmap *map, void *block, |
3f4ff561 | 216 | unsigned long *cache_present, |
f8bd822c MB |
217 | unsigned int block_base, unsigned int start, |
218 | unsigned int end); | |
9fabe24e | 219 | |
8817796b MB |
220 | static inline const void *regcache_get_val_addr(struct regmap *map, |
221 | const void *base, | |
222 | unsigned int idx) | |
223 | { | |
224 | return base + (map->cache_word_size * idx); | |
225 | } | |
226 | ||
879082c9 MB |
227 | unsigned int regcache_get_val(struct regmap *map, const void *base, |
228 | unsigned int idx); | |
229 | bool regcache_set_val(struct regmap *map, void *base, unsigned int idx, | |
230 | unsigned int val); | |
9fabe24e | 231 | int regcache_lookup_reg(struct regmap *map, unsigned int reg); |
9fabe24e | 232 | |
584de329 | 233 | int _regmap_raw_write(struct regmap *map, unsigned int reg, |
0a819809 | 234 | const void *val, size_t val_len); |
584de329 | 235 | |
0d509f2b MB |
236 | void regmap_async_complete_cb(struct regmap_async *async, int ret); |
237 | ||
3c174d29 GR |
238 | enum regmap_endian regmap_get_val_endian(struct device *dev, |
239 | const struct regmap_bus *bus, | |
240 | const struct regmap_config *config); | |
241 | ||
28644c80 | 242 | extern struct regcache_ops regcache_rbtree_ops; |
2cbbb579 | 243 | extern struct regcache_ops regcache_lzo_ops; |
2ac902ce | 244 | extern struct regcache_ops regcache_flat_ops; |
2cbbb579 | 245 | |
93de9124 | 246 | #endif |