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