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>
22 struct regmap_format {
27 void (*format_write)(struct regmap *map,
28 unsigned int reg, unsigned int val);
29 void (*format_reg)(void *buf, unsigned int reg, unsigned int shift);
30 void (*format_val)(void *buf, unsigned int val, unsigned int shift);
31 unsigned int (*parse_val)(void *buf);
34 typedef void (*regmap_lock)(struct regmap *map);
35 typedef void (*regmap_unlock)(struct regmap *map);
43 struct device *dev; /* Device we do I/O on */
44 void *work_buf; /* Scratch buffer used to format I/O */
45 struct regmap_format format; /* Buffer format */
46 const struct regmap_bus *bus;
50 #ifdef CONFIG_DEBUG_FS
51 struct dentry *debugfs;
52 const char *debugfs_name;
55 unsigned int max_register;
56 bool (*writeable_reg)(struct device *dev, unsigned int reg);
57 bool (*readable_reg)(struct device *dev, unsigned int reg);
58 bool (*volatile_reg)(struct device *dev, unsigned int reg);
59 bool (*precious_reg)(struct device *dev, unsigned int reg);
64 /* number of bits to (left) shift the reg value when formatting*/
68 /* regcache specific members */
69 const struct regcache_ops *cache_ops;
70 enum regcache_type cache_type;
72 /* number of bytes in reg_defaults_raw */
73 unsigned int cache_size_raw;
74 /* number of bytes per word in reg_defaults_raw */
75 unsigned int cache_word_size;
76 /* number of entries in reg_defaults */
77 unsigned int num_reg_defaults;
78 /* number of entries in reg_defaults_raw */
79 unsigned int num_reg_defaults_raw;
81 /* if set, only the cache is modified not the HW */
83 /* if set, only the HW is modified not the cache */
85 /* if set, remember to free reg_defaults_raw */
88 struct reg_default *reg_defaults;
89 const void *reg_defaults_raw;
93 struct reg_default *patch;
96 /* if set, converts bulk rw to single rw */
99 struct rb_root range_tree;
100 void *selector_work_buf; /* Scratch buffer used for selector */
103 struct regcache_ops {
105 enum regcache_type type;
106 int (*init)(struct regmap *map);
107 int (*exit)(struct regmap *map);
108 int (*read)(struct regmap *map, unsigned int reg, unsigned int *value);
109 int (*write)(struct regmap *map, unsigned int reg, unsigned int value);
110 int (*sync)(struct regmap *map, unsigned int min, unsigned int max);
113 bool regmap_writeable(struct regmap *map, unsigned int reg);
114 bool regmap_readable(struct regmap *map, unsigned int reg);
115 bool regmap_volatile(struct regmap *map, unsigned int reg);
116 bool regmap_precious(struct regmap *map, unsigned int reg);
118 int _regmap_write(struct regmap *map, unsigned int reg,
121 struct regmap_range_node {
124 unsigned int range_min;
125 unsigned int range_max;
127 unsigned int selector_reg;
128 unsigned int selector_mask;
131 unsigned int window_start;
132 unsigned int window_len;
135 #ifdef CONFIG_DEBUG_FS
136 extern void regmap_debugfs_initcall(void);
137 extern void regmap_debugfs_init(struct regmap *map, const char *name);
138 extern void regmap_debugfs_exit(struct regmap *map);
140 static inline void regmap_debugfs_initcall(void) { }
141 static inline void regmap_debugfs_init(struct regmap *map, const char *name) { }
142 static inline void regmap_debugfs_exit(struct regmap *map) { }
145 /* regcache core declarations */
146 int regcache_init(struct regmap *map, const struct regmap_config *config);
147 void regcache_exit(struct regmap *map);
148 int regcache_read(struct regmap *map,
149 unsigned int reg, unsigned int *value);
150 int regcache_write(struct regmap *map,
151 unsigned int reg, unsigned int value);
152 int regcache_sync(struct regmap *map);
154 unsigned int regcache_get_val(const void *base, unsigned int idx,
155 unsigned int word_size);
156 bool regcache_set_val(void *base, unsigned int idx,
157 unsigned int val, unsigned int word_size);
158 int regcache_lookup_reg(struct regmap *map, unsigned int reg);
160 extern struct regcache_ops regcache_rbtree_ops;
161 extern struct regcache_ops regcache_lzo_ops;