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 21 struct regmap; 22 struct regcache_ops; 23 24 struct 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 32 struct 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 45 struct regmap_async { 46 struct list_head list; 47 struct regmap *map; 48 void *work_buf; 49 }; 50 51 struct 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 /* if set, the cache contains newer data than the HW */ 135 u32 cache_dirty; 136 /* if set, the HW registers are known to match map->reg_defaults */ 137 bool no_sync_defaults; 138 139 struct reg_default *patch; 140 int patch_regs; 141 142 /* if set, converts bulk rw to single rw */ 143 bool use_single_rw; 144 /* if set, the device supports multi write mode */ 145 bool can_multi_write; 146 147 struct rb_root range_tree; 148 void *selector_work_buf; /* Scratch buffer used for selector */ 149 }; 150 151 struct regcache_ops { 152 const char *name; 153 enum regcache_type type; 154 int (*init)(struct regmap *map); 155 int (*exit)(struct regmap *map); 156 #ifdef CONFIG_DEBUG_FS 157 void (*debugfs_init)(struct regmap *map); 158 #endif 159 int (*read)(struct regmap *map, unsigned int reg, unsigned int *value); 160 int (*write)(struct regmap *map, unsigned int reg, unsigned int value); 161 int (*sync)(struct regmap *map, unsigned int min, unsigned int max); 162 int (*drop)(struct regmap *map, unsigned int min, unsigned int max); 163 }; 164 165 bool regmap_writeable(struct regmap *map, unsigned int reg); 166 bool regmap_readable(struct regmap *map, unsigned int reg); 167 bool regmap_volatile(struct regmap *map, unsigned int reg); 168 bool regmap_precious(struct regmap *map, unsigned int reg); 169 170 int _regmap_write(struct regmap *map, unsigned int reg, 171 unsigned int val); 172 173 struct regmap_range_node { 174 struct rb_node node; 175 const char *name; 176 struct regmap *map; 177 178 unsigned int range_min; 179 unsigned int range_max; 180 181 unsigned int selector_reg; 182 unsigned int selector_mask; 183 int selector_shift; 184 185 unsigned int window_start; 186 unsigned int window_len; 187 }; 188 189 struct regmap_field { 190 struct regmap *regmap; 191 unsigned int mask; 192 /* lsb */ 193 unsigned int shift; 194 unsigned int reg; 195 196 unsigned int id_size; 197 unsigned int id_offset; 198 }; 199 200 #ifdef CONFIG_DEBUG_FS 201 extern void regmap_debugfs_initcall(void); 202 extern void regmap_debugfs_init(struct regmap *map, const char *name); 203 extern void regmap_debugfs_exit(struct regmap *map); 204 #else 205 static inline void regmap_debugfs_initcall(void) { } 206 static inline void regmap_debugfs_init(struct regmap *map, const char *name) { } 207 static inline void regmap_debugfs_exit(struct regmap *map) { } 208 #endif 209 210 /* regcache core declarations */ 211 int regcache_init(struct regmap *map, const struct regmap_config *config); 212 void regcache_exit(struct regmap *map); 213 int regcache_read(struct regmap *map, 214 unsigned int reg, unsigned int *value); 215 int regcache_write(struct regmap *map, 216 unsigned int reg, unsigned int value); 217 int regcache_sync(struct regmap *map); 218 int regcache_sync_block(struct regmap *map, void *block, 219 unsigned long *cache_present, 220 unsigned int block_base, unsigned int start, 221 unsigned int end); 222 223 static inline const void *regcache_get_val_addr(struct regmap *map, 224 const void *base, 225 unsigned int idx) 226 { 227 return base + (map->cache_word_size * idx); 228 } 229 230 unsigned int regcache_get_val(struct regmap *map, const void *base, 231 unsigned int idx); 232 bool regcache_set_val(struct regmap *map, void *base, unsigned int idx, 233 unsigned int val); 234 int regcache_lookup_reg(struct regmap *map, unsigned int reg); 235 236 int _regmap_raw_write(struct regmap *map, unsigned int reg, 237 const void *val, size_t val_len); 238 239 void regmap_async_complete_cb(struct regmap_async *async, int ret); 240 241 enum regmap_endian regmap_get_val_endian(struct device *dev, 242 const struct regmap_bus *bus, 243 const struct regmap_config *config); 244 245 extern struct regcache_ops regcache_rbtree_ops; 246 extern struct regcache_ops regcache_lzo_ops; 247 extern struct regcache_ops regcache_flat_ops; 248 249 static inline const char *regmap_name(const struct regmap *map) 250 { 251 if (map->dev) 252 return dev_name(map->dev); 253 254 return map->name; 255 } 256 257 #endif 258