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
;
54 unsigned long spinlock_flags
;
57 void *lock_arg
; /* This is passed to lock/unlock functions */
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
;
66 spinlock_t async_lock
;
67 wait_queue_head_t async_waitq
;
68 struct list_head async_list
;
69 struct list_head async_free
;
72 #ifdef CONFIG_DEBUG_FS
73 struct dentry
*debugfs
;
74 const char *debugfs_name
;
76 unsigned int debugfs_reg_len
;
77 unsigned int debugfs_val_len
;
78 unsigned int debugfs_tot_len
;
80 struct list_head debugfs_off_cache
;
81 struct mutex cache_lock
;
84 unsigned int max_register
;
85 bool (*writeable_reg
)(struct device
*dev
, unsigned int reg
);
86 bool (*readable_reg
)(struct device
*dev
, unsigned int reg
);
87 bool (*volatile_reg
)(struct device
*dev
, unsigned int reg
);
88 bool (*precious_reg
)(struct device
*dev
, unsigned int reg
);
89 const struct regmap_access_table
*wr_table
;
90 const struct regmap_access_table
*rd_table
;
91 const struct regmap_access_table
*volatile_table
;
92 const struct regmap_access_table
*precious_table
;
94 int (*reg_read
)(void *context
, unsigned int reg
, unsigned int *val
);
95 int (*reg_write
)(void *context
, unsigned int reg
, unsigned int val
);
102 /* number of bits to (left) shift the reg value when formatting*/
106 /* regcache specific members */
107 const struct regcache_ops
*cache_ops
;
108 enum regcache_type cache_type
;
110 /* number of bytes in reg_defaults_raw */
111 unsigned int cache_size_raw
;
112 /* number of bytes per word in reg_defaults_raw */
113 unsigned int cache_word_size
;
114 /* number of entries in reg_defaults */
115 unsigned int num_reg_defaults
;
116 /* number of entries in reg_defaults_raw */
117 unsigned int num_reg_defaults_raw
;
119 /* if set, only the cache is modified not the HW */
121 /* if set, only the HW is modified not the cache */
123 /* if set, remember to free reg_defaults_raw */
126 struct reg_default
*reg_defaults
;
127 const void *reg_defaults_raw
;
131 struct reg_default
*patch
;
134 /* if set, converts bulk rw to single rw */
137 struct rb_root range_tree
;
138 void *selector_work_buf
; /* Scratch buffer used for selector */
141 struct regcache_ops
{
143 enum regcache_type type
;
144 int (*init
)(struct regmap
*map
);
145 int (*exit
)(struct regmap
*map
);
146 int (*read
)(struct regmap
*map
, unsigned int reg
, unsigned int *value
);
147 int (*write
)(struct regmap
*map
, unsigned int reg
, unsigned int value
);
148 int (*sync
)(struct regmap
*map
, unsigned int min
, unsigned int max
);
149 int (*drop
)(struct regmap
*map
, unsigned int min
, unsigned int max
);
152 bool regmap_writeable(struct regmap
*map
, unsigned int reg
);
153 bool regmap_readable(struct regmap
*map
, unsigned int reg
);
154 bool regmap_volatile(struct regmap
*map
, unsigned int reg
);
155 bool regmap_precious(struct regmap
*map
, unsigned int reg
);
157 int _regmap_write(struct regmap
*map
, unsigned int reg
,
160 struct regmap_range_node
{
165 unsigned int range_min
;
166 unsigned int range_max
;
168 unsigned int selector_reg
;
169 unsigned int selector_mask
;
172 unsigned int window_start
;
173 unsigned int window_len
;
176 struct regmap_field
{
177 struct regmap
*regmap
;
184 #ifdef CONFIG_DEBUG_FS
185 extern void regmap_debugfs_initcall(void);
186 extern void regmap_debugfs_init(struct regmap
*map
, const char *name
);
187 extern void regmap_debugfs_exit(struct regmap
*map
);
189 static inline void regmap_debugfs_initcall(void) { }
190 static inline void regmap_debugfs_init(struct regmap
*map
, const char *name
) { }
191 static inline void regmap_debugfs_exit(struct regmap
*map
) { }
194 /* regcache core declarations */
195 int regcache_init(struct regmap
*map
, const struct regmap_config
*config
);
196 void regcache_exit(struct regmap
*map
);
197 int regcache_read(struct regmap
*map
,
198 unsigned int reg
, unsigned int *value
);
199 int regcache_write(struct regmap
*map
,
200 unsigned int reg
, unsigned int value
);
201 int regcache_sync(struct regmap
*map
);
202 int regcache_sync_block(struct regmap
*map
, void *block
,
203 unsigned long *cache_present
,
204 unsigned int block_base
, unsigned int start
,
207 static inline const void *regcache_get_val_addr(struct regmap
*map
,
211 return base
+ (map
->cache_word_size
* idx
);
214 unsigned int regcache_get_val(struct regmap
*map
, const void *base
,
216 bool regcache_set_val(struct regmap
*map
, void *base
, unsigned int idx
,
218 int regcache_lookup_reg(struct regmap
*map
, unsigned int reg
);
220 int _regmap_raw_write(struct regmap
*map
, unsigned int reg
,
221 const void *val
, size_t val_len
, bool async
);
223 void regmap_async_complete_cb(struct regmap_async
*async
, int ret
);
225 extern struct regcache_ops regcache_rbtree_ops
;
226 extern struct regcache_ops regcache_lzo_ops
;
227 extern struct regcache_ops regcache_flat_ops
;