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)(void *buf);
45 struct list_head list;
46 struct work_struct cleanup;
56 void *lock_arg; /* This is passed to lock/unlock functions */
58 struct device *dev; /* Device we do I/O on */
59 void *work_buf; /* Scratch buffer used to format I/O */
60 struct regmap_format format; /* Buffer format */
61 const struct regmap_bus *bus;
65 spinlock_t async_lock;
66 wait_queue_head_t async_waitq;
67 struct list_head async_list;
70 #ifdef CONFIG_DEBUG_FS
71 struct dentry *debugfs;
72 const char *debugfs_name;
74 unsigned int debugfs_reg_len;
75 unsigned int debugfs_val_len;
76 unsigned int debugfs_tot_len;
78 struct list_head debugfs_off_cache;
81 unsigned int max_register;
82 bool (*writeable_reg)(struct device *dev, unsigned int reg);
83 bool (*readable_reg)(struct device *dev, unsigned int reg);
84 bool (*volatile_reg)(struct device *dev, unsigned int reg);
85 bool (*precious_reg)(struct device *dev, unsigned int reg);
86 const struct regmap_access_table *wr_table;
87 const struct regmap_access_table *rd_table;
88 const struct regmap_access_table *volatile_table;
89 const struct regmap_access_table *precious_table;
91 int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
92 int (*reg_write)(void *context, unsigned int reg, unsigned int val);
97 /* number of bits to (left) shift the reg value when formatting*/
101 /* regcache specific members */
102 const struct regcache_ops *cache_ops;
103 enum regcache_type cache_type;
105 /* number of bytes in reg_defaults_raw */
106 unsigned int cache_size_raw;
107 /* number of bytes per word in reg_defaults_raw */
108 unsigned int cache_word_size;
109 /* number of entries in reg_defaults */
110 unsigned int num_reg_defaults;
111 /* number of entries in reg_defaults_raw */
112 unsigned int num_reg_defaults_raw;
114 /* if set, only the cache is modified not the HW */
116 /* if set, only the HW is modified not the cache */
118 /* if set, remember to free reg_defaults_raw */
121 struct reg_default *reg_defaults;
122 const void *reg_defaults_raw;
126 struct reg_default *patch;
129 /* if set, converts bulk rw to single rw */
132 struct rb_root range_tree;
133 void *selector_work_buf; /* Scratch buffer used for selector */
136 struct regcache_ops {
138 enum regcache_type type;
139 int (*init)(struct regmap *map);
140 int (*exit)(struct regmap *map);
141 int (*read)(struct regmap *map, unsigned int reg, unsigned int *value);
142 int (*write)(struct regmap *map, unsigned int reg, unsigned int value);
143 int (*sync)(struct regmap *map, unsigned int min, unsigned int max);
146 bool regmap_writeable(struct regmap *map, unsigned int reg);
147 bool regmap_readable(struct regmap *map, unsigned int reg);
148 bool regmap_volatile(struct regmap *map, unsigned int reg);
149 bool regmap_precious(struct regmap *map, unsigned int reg);
151 int _regmap_write(struct regmap *map, unsigned int reg,
154 struct regmap_range_node {
159 unsigned int range_min;
160 unsigned int range_max;
162 unsigned int selector_reg;
163 unsigned int selector_mask;
166 unsigned int window_start;
167 unsigned int window_len;
170 #ifdef CONFIG_DEBUG_FS
171 extern void regmap_debugfs_initcall(void);
172 extern void regmap_debugfs_init(struct regmap *map, const char *name);
173 extern void regmap_debugfs_exit(struct regmap *map);
175 static inline void regmap_debugfs_initcall(void) { }
176 static inline void regmap_debugfs_init(struct regmap *map, const char *name) { }
177 static inline void regmap_debugfs_exit(struct regmap *map) { }
180 /* regcache core declarations */
181 int regcache_init(struct regmap *map, const struct regmap_config *config);
182 void regcache_exit(struct regmap *map);
183 int regcache_read(struct regmap *map,
184 unsigned int reg, unsigned int *value);
185 int regcache_write(struct regmap *map,
186 unsigned int reg, unsigned int value);
187 int regcache_sync(struct regmap *map);
189 unsigned int regcache_get_val(const void *base, unsigned int idx,
190 unsigned int word_size);
191 bool regcache_set_val(void *base, unsigned int idx,
192 unsigned int val, unsigned int word_size);
193 int regcache_lookup_reg(struct regmap *map, unsigned int reg);
195 void regmap_async_complete_cb(struct regmap_async *async, int ret);
197 extern struct regcache_ops regcache_rbtree_ops;
198 extern struct regcache_ops regcache_lzo_ops;
199 extern struct regcache_ops regcache_flat_ops;