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/device.h>
 17#include <linux/regmap.h>
 18#include <linux/fs.h>
 19#include <linux/list.h>
 20#include <linux/wait.h>
 21
 22struct regmap;
 23struct regcache_ops;
 24
 25struct regmap_debugfs_off_cache {
 26	struct list_head list;
 27	off_t min;
 28	off_t max;
 29	unsigned int base_reg;
 30	unsigned int max_reg;
 31};
 32
 33struct regmap_format {
 34	size_t buf_size;
 35	size_t reg_bytes;
 36	size_t pad_bytes;
 37	size_t val_bytes;
 38	void (*format_write)(struct regmap *map,
 39			     unsigned int reg, unsigned int val);
 40	void (*format_reg)(void *buf, unsigned int reg, unsigned int shift);
 41	void (*format_val)(void *buf, unsigned int val, unsigned int shift);
 42	unsigned int (*parse_val)(const void *buf);
 43	void (*parse_inplace)(void *buf);
 44};
 45
 46struct regmap_async {
 47	struct list_head list;
 48	struct regmap *map;
 49	void *work_buf;
 50};
 51
 52struct regmap {
 53	union {
 54		struct mutex mutex;
 55		struct {
 56			spinlock_t spinlock;
 57			unsigned long spinlock_flags;
 58		};
 59	};
 60	regmap_lock lock;
 61	regmap_unlock unlock;
 62	void *lock_arg; /* This is passed to lock/unlock functions */
 63	gfp_t alloc_flags;
 64
 65	struct device *dev; /* Device we do I/O on */
 66	void *work_buf;     /* Scratch buffer used to format I/O */
 67	struct regmap_format format;  /* Buffer format */
 68	const struct regmap_bus *bus;
 69	void *bus_context;
 70	const char *name;
 71
 72	bool async;
 73	spinlock_t async_lock;
 74	wait_queue_head_t async_waitq;
 75	struct list_head async_list;
 76	struct list_head async_free;
 77	int async_ret;
 78
 79#ifdef CONFIG_DEBUG_FS
 80	struct dentry *debugfs;
 81	const char *debugfs_name;
 82
 83	unsigned int debugfs_reg_len;
 84	unsigned int debugfs_val_len;
 85	unsigned int debugfs_tot_len;
 86
 87	struct list_head debugfs_off_cache;
 88	struct mutex cache_lock;
 89#endif
 90
 91	unsigned int max_register;
 92	bool (*writeable_reg)(struct device *dev, unsigned int reg);
 93	bool (*readable_reg)(struct device *dev, unsigned int reg);
 94	bool (*volatile_reg)(struct device *dev, unsigned int reg);
 95	bool (*precious_reg)(struct device *dev, unsigned int reg);
 96	const struct regmap_access_table *wr_table;
 97	const struct regmap_access_table *rd_table;
 98	const struct regmap_access_table *volatile_table;
 99	const struct regmap_access_table *precious_table;
100
101	int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
102	int (*reg_write)(void *context, unsigned int reg, unsigned int val);
103	int (*reg_update_bits)(void *context, unsigned int reg,
104			       unsigned int mask, unsigned int val);
105
106	bool defer_caching;
107
108	u8 read_flag_mask;
109	u8 write_flag_mask;
110
111	/* number of bits to (left) shift the reg value when formatting*/
112	int reg_shift;
113	int reg_stride;
114	int reg_stride_order;
115
116	/* regcache specific members */
117	const struct regcache_ops *cache_ops;
118	enum regcache_type cache_type;
119
120	/* number of bytes in reg_defaults_raw */
121	unsigned int cache_size_raw;
122	/* number of bytes per word in reg_defaults_raw */
123	unsigned int cache_word_size;
124	/* number of entries in reg_defaults */
125	unsigned int num_reg_defaults;
126	/* number of entries in reg_defaults_raw */
127	unsigned int num_reg_defaults_raw;
128
129	/* if set, only the cache is modified not the HW */
130	bool cache_only;
131	/* if set, only the HW is modified not the cache */
132	bool cache_bypass;
133	/* if set, remember to free reg_defaults_raw */
134	bool cache_free;
135
136	struct reg_default *reg_defaults;
137	const void *reg_defaults_raw;
138	void *cache;
139	/* if set, the cache contains newer data than the HW */
140	bool cache_dirty;
141	/* if set, the HW registers are known to match map->reg_defaults */
142	bool no_sync_defaults;
143
144	struct reg_sequence *patch;
145	int patch_regs;
146
147	/* if set, converts bulk read to single read */
148	bool use_single_read;
149	/* if set, converts bulk read to single read */
150	bool use_single_write;
151	/* if set, the device supports multi write mode */
152	bool can_multi_write;
153
154	/* if set, raw reads/writes are limited to this size */
155	size_t max_raw_read;
156	size_t max_raw_write;
157
158	struct rb_root range_tree;
159	void *selector_work_buf;	/* Scratch buffer used for selector */
160};
161
162struct regcache_ops {
163	const char *name;
164	enum regcache_type type;
165	int (*init)(struct regmap *map);
166	int (*exit)(struct regmap *map);
167#ifdef CONFIG_DEBUG_FS
168	void (*debugfs_init)(struct regmap *map);
169#endif
170	int (*read)(struct regmap *map, unsigned int reg, unsigned int *value);
171	int (*write)(struct regmap *map, unsigned int reg, unsigned int value);
172	int (*sync)(struct regmap *map, unsigned int min, unsigned int max);
173	int (*drop)(struct regmap *map, unsigned int min, unsigned int max);
174};
175
176bool regmap_writeable(struct regmap *map, unsigned int reg);
177bool regmap_readable(struct regmap *map, unsigned int reg);
178bool regmap_volatile(struct regmap *map, unsigned int reg);
179bool regmap_precious(struct regmap *map, unsigned int reg);
180
181int _regmap_write(struct regmap *map, unsigned int reg,
182		  unsigned int val);
183
184struct regmap_range_node {
185	struct rb_node node;
186	const char *name;
187	struct regmap *map;
188
189	unsigned int range_min;
190	unsigned int range_max;
191
192	unsigned int selector_reg;
193	unsigned int selector_mask;
194	int selector_shift;
195
196	unsigned int window_start;
197	unsigned int window_len;
198};
199
200struct regmap_field {
201	struct regmap *regmap;
202	unsigned int mask;
203	/* lsb */
204	unsigned int shift;
205	unsigned int reg;
206
207	unsigned int id_size;
208	unsigned int id_offset;
209};
210
211#ifdef CONFIG_DEBUG_FS
212extern void regmap_debugfs_initcall(void);
213extern void regmap_debugfs_init(struct regmap *map, const char *name);
214extern void regmap_debugfs_exit(struct regmap *map);
215#else
216static inline void regmap_debugfs_initcall(void) { }
217static inline void regmap_debugfs_init(struct regmap *map, const char *name) { }
218static inline void regmap_debugfs_exit(struct regmap *map) { }
219#endif
220
221/* regcache core declarations */
222int regcache_init(struct regmap *map, const struct regmap_config *config);
223void regcache_exit(struct regmap *map);
224int regcache_read(struct regmap *map,
225		       unsigned int reg, unsigned int *value);
226int regcache_write(struct regmap *map,
227			unsigned int reg, unsigned int value);
228int regcache_sync(struct regmap *map);
229int regcache_sync_block(struct regmap *map, void *block,
230			unsigned long *cache_present,
231			unsigned int block_base, unsigned int start,
232			unsigned int end);
233
234static inline const void *regcache_get_val_addr(struct regmap *map,
235						const void *base,
236						unsigned int idx)
237{
238	return base + (map->cache_word_size * idx);
239}
240
241unsigned int regcache_get_val(struct regmap *map, const void *base,
242			      unsigned int idx);
243bool regcache_set_val(struct regmap *map, void *base, unsigned int idx,
244		      unsigned int val);
245int regcache_lookup_reg(struct regmap *map, unsigned int reg);
246
247int _regmap_raw_write(struct regmap *map, unsigned int reg,
248		      const void *val, size_t val_len);
249
250void regmap_async_complete_cb(struct regmap_async *async, int ret);
251
252enum regmap_endian regmap_get_val_endian(struct device *dev,
253					 const struct regmap_bus *bus,
254					 const struct regmap_config *config);
255
256extern struct regcache_ops regcache_rbtree_ops;
257extern struct regcache_ops regcache_lzo_ops;
258extern struct regcache_ops regcache_flat_ops;
259
260static inline const char *regmap_name(const struct regmap *map)
261{
262	if (map->dev)
263		return dev_name(map->dev);
264
265	return map->name;
266}
267
268static inline unsigned int regmap_get_offset(const struct regmap *map,
269					     unsigned int index)
270{
271	if (map->reg_stride_order >= 0)
272		return index << map->reg_stride_order;
273	else
274		return index * map->reg_stride;
275}
276
277static inline unsigned int regcache_get_index_by_order(const struct regmap *map,
278						       unsigned int reg)
279{
280	return reg >> map->reg_stride_order;
281}
282
283#endif