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 struct dentry *debugfs;
81 const char *debugfs_name;
82
83 unsigned int debugfs_reg_len;
84 unsigned int debugfs_val_len;
85 unsigned int debugfs_tot_len;
86
87 struct list_head debugfs_off_cache;
88 struct mutex cache_lock;
89#endif
90
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);
95 bool (*precious_reg)(struct device *dev, unsigned int reg);
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;
100
101 int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
102 int (*reg_write)(void *context, unsigned int reg, unsigned int val);
103 int (*reg_update_bits)(void *context, unsigned int reg,
104 unsigned int mask, unsigned int val);
105
106 bool defer_caching;
107
108 unsigned long read_flag_mask;
109 unsigned long write_flag_mask;
110
111 /* number of bits to (left) shift the reg value when formatting*/
112 int reg_shift;
113 int reg_stride;
114 int reg_stride_order;
115
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 */
130 bool cache_only;
131 /* if set, only the HW is modified not the cache */
132 bool cache_bypass;
133 /* if set, remember to free reg_defaults_raw */
134 bool cache_free;
135
136 struct reg_default *reg_defaults;
137 const void *reg_defaults_raw;
138 void *cache;
139 /* if set, the cache contains newer data than the HW */
140 bool cache_dirty;
141 /* if set, the HW registers are known to match map->reg_defaults */
142 bool no_sync_defaults;
143
144 struct reg_sequence *patch;
145 int patch_regs;
146
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;
151 /* if set, the device supports multi write mode */
152 bool can_multi_write;
153
154 /* if set, raw reads/writes are limited to this size */
155 size_t max_raw_read;
156 size_t max_raw_write;
157
158 struct rb_root range_tree;
159 void *selector_work_buf; /* Scratch buffer used for selector */
160};
161
162struct regcache_ops {
163 const char *name;
164 enum regcache_type type;
165 int (*init)(struct regmap *map);
166 int (*exit)(struct regmap *map);
167#ifdef CONFIG_DEBUG_FS
168 void (*debugfs_init)(struct regmap *map);
169#endif
170 int (*read)(struct regmap *map, unsigned int reg, unsigned int *value);
171 int (*write)(struct regmap *map, unsigned int reg, unsigned int value);
172 int (*sync)(struct regmap *map, unsigned int min, unsigned int max);
173 int (*drop)(struct regmap *map, unsigned int min, unsigned int max);
174};
175
176bool regmap_cached(struct regmap *map, unsigned int reg);
177bool regmap_writeable(struct regmap *map, unsigned int reg);
178bool regmap_readable(struct regmap *map, unsigned int reg);
179bool regmap_volatile(struct regmap *map, unsigned int reg);
180bool regmap_precious(struct regmap *map, unsigned int reg);
181
182int _regmap_write(struct regmap *map, unsigned int reg,
183 unsigned int val);
184
185struct regmap_range_node {
186 struct rb_node node;
187 const char *name;
188 struct regmap *map;
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
201struct regmap_field {
202 struct regmap *regmap;
203 unsigned int mask;
204 /* lsb */
205 unsigned int shift;
206 unsigned int reg;
207
208 unsigned int id_size;
209 unsigned int id_offset;
210};
211
212#ifdef CONFIG_DEBUG_FS
213extern void regmap_debugfs_initcall(void);
214extern void regmap_debugfs_init(struct regmap *map, const char *name);
215extern void regmap_debugfs_exit(struct regmap *map);
216#else
217static inline void regmap_debugfs_initcall(void) { }
218static inline void regmap_debugfs_init(struct regmap *map, const char *name) { }
219static inline void regmap_debugfs_exit(struct regmap *map) { }
220#endif
221
222/* regcache core declarations */
223int regcache_init(struct regmap *map, const struct regmap_config *config);
224void regcache_exit(struct regmap *map);
225int regcache_read(struct regmap *map,
226 unsigned int reg, unsigned int *value);
227int regcache_write(struct regmap *map,
228 unsigned int reg, unsigned int value);
229int regcache_sync(struct regmap *map);
230int regcache_sync_block(struct regmap *map, void *block,
231 unsigned long *cache_present,
232 unsigned int block_base, unsigned int start,
233 unsigned int end);
234
235static 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
242unsigned int regcache_get_val(struct regmap *map, const void *base,
243 unsigned int idx);
244bool regcache_set_val(struct regmap *map, void *base, unsigned int idx,
245 unsigned int val);
246int regcache_lookup_reg(struct regmap *map, unsigned int reg);
247
248int _regmap_raw_write(struct regmap *map, unsigned int reg,
249 const void *val, size_t val_len);
250
251void regmap_async_complete_cb(struct regmap_async *async, int ret);
252
253enum regmap_endian regmap_get_val_endian(struct device *dev,
254 const struct regmap_bus *bus,
255 const struct regmap_config *config);
256
257extern struct regcache_ops regcache_rbtree_ops;
258extern struct regcache_ops regcache_lzo_ops;
259extern struct regcache_ops regcache_flat_ops;
260
261static 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
269static 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
278static 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
284#endif