2 * Register map access API internal header
4 * Copyright 2011 Wolfson Microelectronics plc
6 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
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.
13 #ifndef _REGMAP_INTERNAL_H
14 #define _REGMAP_INTERNAL_H
16 #include <linux/regmap.h>
18 #include <linux/list.h>
19 #include <linux/wait.h>
24 struct regmap_debugfs_off_cache {
25 struct list_head list;
28 unsigned int base_reg;
32 struct regmap_format {
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);
46 struct list_head list;
56 unsigned long spinlock_flags;
61 void *lock_arg; /* This is passed to lock/unlock functions */
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;
71 spinlock_t async_lock;
72 wait_queue_head_t async_waitq;
73 struct list_head async_list;
74 struct list_head async_free;
77 #ifdef CONFIG_DEBUG_FS
78 struct dentry *debugfs;
79 const char *debugfs_name;
81 unsigned int debugfs_reg_len;
82 unsigned int debugfs_val_len;
83 unsigned int debugfs_tot_len;
85 struct list_head debugfs_off_cache;
86 struct mutex cache_lock;
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);
93 bool (*precious_reg)(struct device *dev, unsigned int reg);
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;
99 int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
100 int (*reg_write)(void *context, unsigned int reg, unsigned int val);
107 /* number of bits to (left) shift the reg value when formatting*/
111 /* regcache specific members */
112 const struct regcache_ops *cache_ops;
113 enum regcache_type cache_type;
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;
124 /* if set, only the cache is modified not the HW */
126 /* if set, only the HW is modified not the cache */
128 /* if set, remember to free reg_defaults_raw */
131 struct reg_default *reg_defaults;
132 const void *reg_defaults_raw;
134 /* if set, the cache contains newer data than the HW */
136 /* if set, the HW registers are known to match map->reg_defaults */
137 bool no_sync_defaults;
139 struct reg_sequence *patch;
142 /* if set, converts bulk read to single read */
143 bool use_single_read;
144 /* if set, converts bulk read to single read */
145 bool use_single_write;
146 /* if set, the device supports multi write mode */
147 bool can_multi_write;
149 /* if set, raw reads/writes are limited to this size */
151 size_t max_raw_write;
153 struct rb_root range_tree;
154 void *selector_work_buf; /* Scratch buffer used for selector */
157 struct regcache_ops {
159 enum regcache_type type;
160 int (*init)(struct regmap *map);
161 int (*exit)(struct regmap *map);
162 #ifdef CONFIG_DEBUG_FS
163 void (*debugfs_init)(struct regmap *map);
165 int (*read)(struct regmap *map, unsigned int reg, unsigned int *value);
166 int (*write)(struct regmap *map, unsigned int reg, unsigned int value);
167 int (*sync)(struct regmap *map, unsigned int min, unsigned int max);
168 int (*drop)(struct regmap *map, unsigned int min, unsigned int max);
171 bool regmap_writeable(struct regmap *map, unsigned int reg);
172 bool regmap_readable(struct regmap *map, unsigned int reg);
173 bool regmap_volatile(struct regmap *map, unsigned int reg);
174 bool regmap_precious(struct regmap *map, unsigned int reg);
176 int _regmap_write(struct regmap *map, unsigned int reg,
179 struct regmap_range_node {
184 unsigned int range_min;
185 unsigned int range_max;
187 unsigned int selector_reg;
188 unsigned int selector_mask;
191 unsigned int window_start;
192 unsigned int window_len;
195 struct regmap_field {
196 struct regmap *regmap;
202 unsigned int id_size;
203 unsigned int id_offset;
206 #ifdef CONFIG_DEBUG_FS
207 extern void regmap_debugfs_initcall(void);
208 extern void regmap_debugfs_init(struct regmap *map, const char *name);
209 extern void regmap_debugfs_exit(struct regmap *map);
211 static inline void regmap_debugfs_initcall(void) { }
212 static inline void regmap_debugfs_init(struct regmap *map, const char *name) { }
213 static inline void regmap_debugfs_exit(struct regmap *map) { }
216 /* regcache core declarations */
217 int regcache_init(struct regmap *map, const struct regmap_config *config);
218 void regcache_exit(struct regmap *map);
219 int regcache_read(struct regmap *map,
220 unsigned int reg, unsigned int *value);
221 int regcache_write(struct regmap *map,
222 unsigned int reg, unsigned int value);
223 int regcache_sync(struct regmap *map);
224 int regcache_sync_block(struct regmap *map, void *block,
225 unsigned long *cache_present,
226 unsigned int block_base, unsigned int start,
229 static inline const void *regcache_get_val_addr(struct regmap *map,
233 return base + (map->cache_word_size * idx);
236 unsigned int regcache_get_val(struct regmap *map, const void *base,
238 bool regcache_set_val(struct regmap *map, void *base, unsigned int idx,
240 int regcache_lookup_reg(struct regmap *map, unsigned int reg);
242 int _regmap_raw_write(struct regmap *map, unsigned int reg,
243 const void *val, size_t val_len);
245 void regmap_async_complete_cb(struct regmap_async *async, int ret);
247 enum regmap_endian regmap_get_val_endian(struct device *dev,
248 const struct regmap_bus *bus,
249 const struct regmap_config *config);
251 extern struct regcache_ops regcache_rbtree_ops;
252 extern struct regcache_ops regcache_lzo_ops;
253 extern struct regcache_ops regcache_flat_ops;
255 static inline const char *regmap_name(const struct regmap *map)
258 return dev_name(map->dev);