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