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