Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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 bool (*writeable_noinc_reg)(struct device *dev, unsigned int reg);
98 bool (*readable_noinc_reg)(struct device *dev, unsigned int reg);
99 const struct regmap_access_table *wr_table;
100 const struct regmap_access_table *rd_table;
101 const struct regmap_access_table *volatile_table;
102 const struct regmap_access_table *precious_table;
103 const struct regmap_access_table *wr_noinc_table;
104 const struct regmap_access_table *rd_noinc_table;
105
106 int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
107 int (*reg_write)(void *context, unsigned int reg, unsigned int val);
108 int (*reg_update_bits)(void *context, unsigned int reg,
109 unsigned int mask, unsigned int val);
110
111 bool defer_caching;
112
113 unsigned long read_flag_mask;
114 unsigned long write_flag_mask;
115
116 /* number of bits to (left) shift the reg value when formatting*/
117 int reg_shift;
118 int reg_stride;
119 int reg_stride_order;
120
121 /* regcache specific members */
122 const struct regcache_ops *cache_ops;
123 enum regcache_type cache_type;
124
125 /* number of bytes in reg_defaults_raw */
126 unsigned int cache_size_raw;
127 /* number of bytes per word in reg_defaults_raw */
128 unsigned int cache_word_size;
129 /* number of entries in reg_defaults */
130 unsigned int num_reg_defaults;
131 /* number of entries in reg_defaults_raw */
132 unsigned int num_reg_defaults_raw;
133
134 /* if set, only the cache is modified not the HW */
135 bool cache_only;
136 /* if set, only the HW is modified not the cache */
137 bool cache_bypass;
138 /* if set, remember to free reg_defaults_raw */
139 bool cache_free;
140
141 struct reg_default *reg_defaults;
142 const void *reg_defaults_raw;
143 void *cache;
144 /* if set, the cache contains newer data than the HW */
145 bool cache_dirty;
146 /* if set, the HW registers are known to match map->reg_defaults */
147 bool no_sync_defaults;
148
149 struct reg_sequence *patch;
150 int patch_regs;
151
152 /* if set, converts bulk read to single read */
153 bool use_single_read;
154 /* if set, converts bulk write to single write */
155 bool use_single_write;
156 /* if set, the device supports multi write mode */
157 bool can_multi_write;
158
159 /* if set, raw reads/writes are limited to this size */
160 size_t max_raw_read;
161 size_t max_raw_write;
162
163 struct rb_root range_tree;
164 void *selector_work_buf; /* Scratch buffer used for selector */
165
166 struct hwspinlock *hwlock;
167};
168
169struct regcache_ops {
170 const char *name;
171 enum regcache_type type;
172 int (*init)(struct regmap *map);
173 int (*exit)(struct regmap *map);
174#ifdef CONFIG_DEBUG_FS
175 void (*debugfs_init)(struct regmap *map);
176#endif
177 int (*read)(struct regmap *map, unsigned int reg, unsigned int *value);
178 int (*write)(struct regmap *map, unsigned int reg, unsigned int value);
179 int (*sync)(struct regmap *map, unsigned int min, unsigned int max);
180 int (*drop)(struct regmap *map, unsigned int min, unsigned int max);
181};
182
183bool regmap_cached(struct regmap *map, unsigned int reg);
184bool regmap_writeable(struct regmap *map, unsigned int reg);
185bool regmap_readable(struct regmap *map, unsigned int reg);
186bool regmap_volatile(struct regmap *map, unsigned int reg);
187bool regmap_precious(struct regmap *map, unsigned int reg);
188bool regmap_writeable_noinc(struct regmap *map, unsigned int reg);
189bool regmap_readable_noinc(struct regmap *map, unsigned int reg);
190
191int _regmap_write(struct regmap *map, unsigned int reg,
192 unsigned int val);
193
194struct regmap_range_node {
195 struct rb_node node;
196 const char *name;
197 struct regmap *map;
198
199 unsigned int range_min;
200 unsigned int range_max;
201
202 unsigned int selector_reg;
203 unsigned int selector_mask;
204 int selector_shift;
205
206 unsigned int window_start;
207 unsigned int window_len;
208};
209
210struct regmap_field {
211 struct regmap *regmap;
212 unsigned int mask;
213 /* lsb */
214 unsigned int shift;
215 unsigned int reg;
216
217 unsigned int id_size;
218 unsigned int id_offset;
219};
220
221#ifdef CONFIG_DEBUG_FS
222extern void regmap_debugfs_initcall(void);
223extern void regmap_debugfs_init(struct regmap *map, const char *name);
224extern void regmap_debugfs_exit(struct regmap *map);
225
226static inline void regmap_debugfs_disable(struct regmap *map)
227{
228 map->debugfs_disable = true;
229}
230
231#else
232static inline void regmap_debugfs_initcall(void) { }
233static inline void regmap_debugfs_init(struct regmap *map, const char *name) { }
234static inline void regmap_debugfs_exit(struct regmap *map) { }
235static inline void regmap_debugfs_disable(struct regmap *map) { }
236#endif
237
238/* regcache core declarations */
239int regcache_init(struct regmap *map, const struct regmap_config *config);
240void regcache_exit(struct regmap *map);
241int regcache_read(struct regmap *map,
242 unsigned int reg, unsigned int *value);
243int regcache_write(struct regmap *map,
244 unsigned int reg, unsigned int value);
245int regcache_sync(struct regmap *map);
246int regcache_sync_block(struct regmap *map, void *block,
247 unsigned long *cache_present,
248 unsigned int block_base, unsigned int start,
249 unsigned int end);
250
251static inline const void *regcache_get_val_addr(struct regmap *map,
252 const void *base,
253 unsigned int idx)
254{
255 return base + (map->cache_word_size * idx);
256}
257
258unsigned int regcache_get_val(struct regmap *map, const void *base,
259 unsigned int idx);
260bool regcache_set_val(struct regmap *map, void *base, unsigned int idx,
261 unsigned int val);
262int regcache_lookup_reg(struct regmap *map, unsigned int reg);
263
264int _regmap_raw_write(struct regmap *map, unsigned int reg,
265 const void *val, size_t val_len);
266
267void regmap_async_complete_cb(struct regmap_async *async, int ret);
268
269enum regmap_endian regmap_get_val_endian(struct device *dev,
270 const struct regmap_bus *bus,
271 const struct regmap_config *config);
272
273extern struct regcache_ops regcache_rbtree_ops;
274extern struct regcache_ops regcache_lzo_ops;
275extern struct regcache_ops regcache_flat_ops;
276
277static inline const char *regmap_name(const struct regmap *map)
278{
279 if (map->dev)
280 return dev_name(map->dev);
281
282 return map->name;
283}
284
285static inline unsigned int regmap_get_offset(const struct regmap *map,
286 unsigned int index)
287{
288 if (map->reg_stride_order >= 0)
289 return index << map->reg_stride_order;
290 else
291 return index * map->reg_stride;
292}
293
294static inline unsigned int regcache_get_index_by_order(const struct regmap *map,
295 unsigned int reg)
296{
297 return reg >> map->reg_stride_order;
298}
299
300#endif