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 regmap *map;
48	void *work_buf;
49};
50
51struct regmap {
52	union {
53		struct mutex mutex;
54		struct {
55			spinlock_t spinlock;
56			unsigned long spinlock_flags;
57		};
58	};
59	regmap_lock lock;
60	regmap_unlock unlock;
61	void *lock_arg; /* This is passed to lock/unlock functions */
62
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;
67	void *bus_context;
68	const char *name;
69
70	bool async;
71	spinlock_t async_lock;
72	wait_queue_head_t async_waitq;
73	struct list_head async_list;
74	struct list_head async_free;
75	int async_ret;
76
77#ifdef CONFIG_DEBUG_FS
78	struct dentry *debugfs;
79	const char *debugfs_name;
80
81	unsigned int debugfs_reg_len;
82	unsigned int debugfs_val_len;
83	unsigned int debugfs_tot_len;
84
85	struct list_head debugfs_off_cache;
86	struct mutex cache_lock;
87#endif
88
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;
98
99	int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
100	int (*reg_write)(void *context, unsigned int reg, unsigned int val);
101
102	bool defer_caching;
103
104	u8 read_flag_mask;
105	u8 write_flag_mask;
106
107	/* number of bits to (left) shift the reg value when formatting*/
108	int reg_shift;
109	int reg_stride;
110
111	/* regcache specific members */
112	const struct regcache_ops *cache_ops;
113	enum regcache_type cache_type;
114
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;
123
124	/* if set, only the cache is modified not the HW */
125	u32 cache_only;
126	/* if set, only the HW is modified not the cache */
127	u32 cache_bypass;
128	/* if set, remember to free reg_defaults_raw */
129	bool cache_free;
130
131	struct reg_default *reg_defaults;
132	const void *reg_defaults_raw;
133	void *cache;
134	u32 cache_dirty;
135
136	struct reg_default *patch;
137	int patch_regs;
138
139	/* if set, converts bulk rw to single rw */
140	bool use_single_rw;
141	/* if set, the device supports multi write mode */
142	bool can_multi_write;
143
144	struct rb_root range_tree;
145	void *selector_work_buf;	/* Scratch buffer used for selector */
146};
147
148struct regcache_ops {
149	const char *name;
150	enum regcache_type type;
151	int (*init)(struct regmap *map);
152	int (*exit)(struct regmap *map);
153#ifdef CONFIG_DEBUG_FS
154	void (*debugfs_init)(struct regmap *map);
155#endif
156	int (*read)(struct regmap *map, unsigned int reg, unsigned int *value);
157	int (*write)(struct regmap *map, unsigned int reg, unsigned int value);
158	int (*sync)(struct regmap *map, unsigned int min, unsigned int max);
159	int (*drop)(struct regmap *map, unsigned int min, unsigned int max);
160};
161
162bool regmap_writeable(struct regmap *map, unsigned int reg);
163bool regmap_readable(struct regmap *map, unsigned int reg);
164bool regmap_volatile(struct regmap *map, unsigned int reg);
165bool regmap_precious(struct regmap *map, unsigned int reg);
166
167int _regmap_write(struct regmap *map, unsigned int reg,
168		  unsigned int val);
169
170struct regmap_range_node {
171	struct rb_node node;
172	const char *name;
173	struct regmap *map;
174
175	unsigned int range_min;
176	unsigned int range_max;
177
178	unsigned int selector_reg;
179	unsigned int selector_mask;
180	int selector_shift;
181
182	unsigned int window_start;
183	unsigned int window_len;
184};
185
186struct regmap_field {
187	struct regmap *regmap;
188	unsigned int mask;
189	/* lsb */
190	unsigned int shift;
191	unsigned int reg;
192
193	unsigned int id_size;
194	unsigned int id_offset;
195};
196
197#ifdef CONFIG_DEBUG_FS
198extern void regmap_debugfs_initcall(void);
199extern void regmap_debugfs_init(struct regmap *map, const char *name);
200extern void regmap_debugfs_exit(struct regmap *map);
201#else
202static inline void regmap_debugfs_initcall(void) { }
203static inline void regmap_debugfs_init(struct regmap *map, const char *name) { }
204static inline void regmap_debugfs_exit(struct regmap *map) { }
205#endif
206
207/* regcache core declarations */
208int regcache_init(struct regmap *map, const struct regmap_config *config);
209void regcache_exit(struct regmap *map);
210int regcache_read(struct regmap *map,
211		       unsigned int reg, unsigned int *value);
212int regcache_write(struct regmap *map,
213			unsigned int reg, unsigned int value);
214int regcache_sync(struct regmap *map);
215int regcache_sync_block(struct regmap *map, void *block,
216			unsigned long *cache_present,
217			unsigned int block_base, unsigned int start,
218			unsigned int end);
219
220static inline const void *regcache_get_val_addr(struct regmap *map,
221						const void *base,
222						unsigned int idx)
223{
224	return base + (map->cache_word_size * idx);
225}
226
227unsigned int regcache_get_val(struct regmap *map, const void *base,
228			      unsigned int idx);
229bool regcache_set_val(struct regmap *map, void *base, unsigned int idx,
230		      unsigned int val);
231int regcache_lookup_reg(struct regmap *map, unsigned int reg);
232
233int _regmap_raw_write(struct regmap *map, unsigned int reg,
234		      const void *val, size_t val_len);
235
236void regmap_async_complete_cb(struct regmap_async *async, int ret);
237
238enum regmap_endian regmap_get_val_endian(struct device *dev,
239					 const struct regmap_bus *bus,
240					 const struct regmap_config *config);
241
242extern struct regcache_ops regcache_rbtree_ops;
243extern struct regcache_ops regcache_lzo_ops;
244extern struct regcache_ops regcache_flat_ops;
245
246static inline const char *regmap_name(const struct regmap *map)
247{
248	if (map->dev)
249		return dev_name(map->dev);
250
251	return map->name;
252}
253
254#endif
255