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/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 work_struct cleanup;
48 struct regmap *map;
49 void *work_buf;
50};
51
52struct regmap {
53 struct mutex mutex;
54 spinlock_t spinlock;
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 spinlock_t async_lock;
67 wait_queue_head_t async_waitq;
68 struct list_head async_list;
69 int async_ret;
70
71#ifdef CONFIG_DEBUG_FS
72 struct dentry *debugfs;
73 const char *debugfs_name;
74
75 unsigned int debugfs_reg_len;
76 unsigned int debugfs_val_len;
77 unsigned int debugfs_tot_len;
78
79 struct list_head debugfs_off_cache;
80 struct mutex cache_lock;
81#endif
82
83 unsigned int max_register;
84 bool (*writeable_reg)(struct device *dev, unsigned int reg);
85 bool (*readable_reg)(struct device *dev, unsigned int reg);
86 bool (*volatile_reg)(struct device *dev, unsigned int reg);
87 bool (*precious_reg)(struct device *dev, unsigned int reg);
88 const struct regmap_access_table *wr_table;
89 const struct regmap_access_table *rd_table;
90 const struct regmap_access_table *volatile_table;
91 const struct regmap_access_table *precious_table;
92
93 int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
94 int (*reg_write)(void *context, unsigned int reg, unsigned int val);
95
96 bool defer_caching;
97
98 u8 read_flag_mask;
99 u8 write_flag_mask;
100
101 /* number of bits to (left) shift the reg value when formatting*/
102 int reg_shift;
103 int reg_stride;
104
105 /* regcache specific members */
106 const struct regcache_ops *cache_ops;
107 enum regcache_type cache_type;
108
109 /* number of bytes in reg_defaults_raw */
110 unsigned int cache_size_raw;
111 /* number of bytes per word in reg_defaults_raw */
112 unsigned int cache_word_size;
113 /* number of entries in reg_defaults */
114 unsigned int num_reg_defaults;
115 /* number of entries in reg_defaults_raw */
116 unsigned int num_reg_defaults_raw;
117
118 /* if set, only the cache is modified not the HW */
119 u32 cache_only;
120 /* if set, only the HW is modified not the cache */
121 u32 cache_bypass;
122 /* if set, remember to free reg_defaults_raw */
123 bool cache_free;
124
125 struct reg_default *reg_defaults;
126 const void *reg_defaults_raw;
127 void *cache;
128 u32 cache_dirty;
129
130 unsigned long *cache_present;
131 unsigned int cache_present_nbits;
132
133 struct reg_default *patch;
134 int patch_regs;
135
136 /* if set, converts bulk rw to single rw */
137 bool use_single_rw;
138
139 struct rb_root range_tree;
140 void *selector_work_buf; /* Scratch buffer used for selector */
141};
142
143struct regcache_ops {
144 const char *name;
145 enum regcache_type type;
146 int (*init)(struct regmap *map);
147 int (*exit)(struct regmap *map);
148 int (*read)(struct regmap *map, unsigned int reg, unsigned int *value);
149 int (*write)(struct regmap *map, unsigned int reg, unsigned int value);
150 int (*sync)(struct regmap *map, unsigned int min, unsigned int max);
151};
152
153bool regmap_writeable(struct regmap *map, unsigned int reg);
154bool regmap_readable(struct regmap *map, unsigned int reg);
155bool regmap_volatile(struct regmap *map, unsigned int reg);
156bool regmap_precious(struct regmap *map, unsigned int reg);
157
158int _regmap_write(struct regmap *map, unsigned int reg,
159 unsigned int val);
160
161struct regmap_range_node {
162 struct rb_node node;
163 const char *name;
164 struct regmap *map;
165
166 unsigned int range_min;
167 unsigned int range_max;
168
169 unsigned int selector_reg;
170 unsigned int selector_mask;
171 int selector_shift;
172
173 unsigned int window_start;
174 unsigned int window_len;
175};
176
177#ifdef CONFIG_DEBUG_FS
178extern void regmap_debugfs_initcall(void);
179extern void regmap_debugfs_init(struct regmap *map, const char *name);
180extern void regmap_debugfs_exit(struct regmap *map);
181#else
182static inline void regmap_debugfs_initcall(void) { }
183static inline void regmap_debugfs_init(struct regmap *map, const char *name) { }
184static inline void regmap_debugfs_exit(struct regmap *map) { }
185#endif
186
187/* regcache core declarations */
188int regcache_init(struct regmap *map, const struct regmap_config *config);
189void regcache_exit(struct regmap *map);
190int regcache_read(struct regmap *map,
191 unsigned int reg, unsigned int *value);
192int regcache_write(struct regmap *map,
193 unsigned int reg, unsigned int value);
194int regcache_sync(struct regmap *map);
195int regcache_sync_block(struct regmap *map, void *block,
196 unsigned int block_base, unsigned int start,
197 unsigned int end);
198
199static inline const void *regcache_get_val_addr(struct regmap *map,
200 const void *base,
201 unsigned int idx)
202{
203 return base + (map->cache_word_size * idx);
204}
205
206unsigned int regcache_get_val(struct regmap *map, const void *base,
207 unsigned int idx);
208bool regcache_set_val(struct regmap *map, void *base, unsigned int idx,
209 unsigned int val);
210int regcache_lookup_reg(struct regmap *map, unsigned int reg);
211int regcache_set_reg_present(struct regmap *map, unsigned int reg);
212
213static inline bool regcache_reg_present(struct regmap *map, unsigned int reg)
214{
215 if (!map->cache_present)
216 return true;
217 if (reg > map->cache_present_nbits)
218 return false;
219 return map->cache_present[BIT_WORD(reg)] & BIT_MASK(reg);
220}
221
222int _regmap_raw_write(struct regmap *map, unsigned int reg,
223 const void *val, size_t val_len, bool async);
224
225void regmap_async_complete_cb(struct regmap_async *async, int ret);
226
227extern struct regcache_ops regcache_rbtree_ops;
228extern struct regcache_ops regcache_lzo_ops;
229extern struct regcache_ops regcache_flat_ops;
230
231#endif