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 s8 reg_shift; 36 void (*format_write)(struct regmap *map, 37 unsigned int reg, unsigned int val); 38 void (*format_reg)(void *buf, unsigned int reg, unsigned int shift); 39 void (*format_val)(void *buf, unsigned int val, unsigned int shift); 40 unsigned int (*parse_val)(const void *buf); 41 void (*parse_inplace)(void *buf); 42 }; 43 44 struct regmap_async { 45 struct list_head list; 46 struct regmap *map; 47 void *work_buf; 48 }; 49 50 struct regmap { 51 union { 52 struct mutex mutex; 53 struct { 54 spinlock_t spinlock; 55 unsigned long spinlock_flags; 56 }; 57 struct { 58 raw_spinlock_t raw_spinlock; 59 unsigned long raw_spinlock_flags; 60 }; 61 }; 62 struct lock_class_key *lock_key; 63 regmap_lock lock; 64 regmap_unlock unlock; 65 void *lock_arg; /* This is passed to lock/unlock functions */ 66 gfp_t alloc_flags; 67 unsigned int reg_base; 68 69 struct device *dev; /* Device we do I/O on */ 70 void *work_buf; /* Scratch buffer used to format I/O */ 71 struct regmap_format format; /* Buffer format */ 72 const struct regmap_bus *bus; 73 void *bus_context; 74 const char *name; 75 76 spinlock_t async_lock; 77 wait_queue_head_t async_waitq; 78 struct list_head async_list; 79 struct list_head async_free; 80 int async_ret; 81 bool async; 82 83 #ifdef CONFIG_DEBUG_FS 84 bool debugfs_disable; 85 struct dentry *debugfs; 86 const char *debugfs_name; 87 88 unsigned int debugfs_reg_len; 89 unsigned int debugfs_val_len; 90 unsigned int debugfs_tot_len; 91 92 struct list_head debugfs_off_cache; 93 struct mutex cache_lock; 94 #endif 95 96 unsigned int max_register; 97 bool max_register_is_set; 98 bool (*writeable_reg)(struct device *dev, unsigned int reg); 99 bool (*readable_reg)(struct device *dev, unsigned int reg); 100 bool (*volatile_reg)(struct device *dev, unsigned int reg); 101 bool (*precious_reg)(struct device *dev, unsigned int reg); 102 bool (*writeable_noinc_reg)(struct device *dev, unsigned int reg); 103 bool (*readable_noinc_reg)(struct device *dev, unsigned int reg); 104 const struct regmap_access_table *wr_table; 105 const struct regmap_access_table *rd_table; 106 const struct regmap_access_table *volatile_table; 107 const struct regmap_access_table *precious_table; 108 const struct regmap_access_table *wr_noinc_table; 109 const struct regmap_access_table *rd_noinc_table; 110 111 int (*reg_read)(void *context, unsigned int reg, unsigned int *val); 112 int (*reg_write)(void *context, unsigned int reg, unsigned int val); 113 int (*reg_update_bits)(void *context, unsigned int reg, 114 unsigned int mask, unsigned int val); 115 /* Bulk read/write */ 116 int (*read)(void *context, const void *reg_buf, size_t reg_size, 117 void *val_buf, size_t val_size); 118 int (*write)(void *context, const void *data, size_t count); 119 120 int (*reg_default_cb)(struct device *dev, unsigned int reg, 121 unsigned int *val); 122 123 unsigned long read_flag_mask; 124 unsigned long write_flag_mask; 125 126 /* number of bits to (left) shift the reg value when formatting*/ 127 int reg_shift; 128 int reg_stride; 129 int reg_stride_order; 130 131 bool defer_caching; 132 133 /* If set, will always write field to HW. */ 134 bool force_write_field; 135 136 /* regcache specific members */ 137 const struct regcache_ops *cache_ops; 138 enum regcache_type cache_type; 139 140 /* number of bytes in reg_defaults_raw */ 141 unsigned int cache_size_raw; 142 /* number of bytes per word in reg_defaults_raw */ 143 unsigned int cache_word_size; 144 /* number of entries in reg_defaults */ 145 unsigned int num_reg_defaults; 146 /* number of entries in reg_defaults_raw */ 147 unsigned int num_reg_defaults_raw; 148 149 /* if set, only the cache is modified not the HW */ 150 bool cache_only; 151 /* if set, only the HW is modified not the cache */ 152 bool cache_bypass; 153 /* if set, remember to free reg_defaults_raw */ 154 bool cache_free; 155 156 struct reg_default *reg_defaults; 157 const void *reg_defaults_raw; 158 void *cache; 159 /* if set, the cache contains newer data than the HW */ 160 bool cache_dirty; 161 /* if set, the HW registers are known to match map->reg_defaults */ 162 bool no_sync_defaults; 163 164 struct reg_sequence *patch; 165 int patch_regs; 166 167 /* if set, the regmap core can sleep */ 168 bool can_sleep; 169 170 /* if set, converts bulk read to single read */ 171 bool use_single_read; 172 /* if set, converts bulk write to single write */ 173 bool use_single_write; 174 /* if set, the device supports multi write mode */ 175 bool can_multi_write; 176 177 /* if set, raw reads/writes are limited to this size */ 178 size_t max_raw_read; 179 size_t max_raw_write; 180 181 struct rb_root range_tree; 182 void *selector_work_buf; /* Scratch buffer used for selector */ 183 184 struct hwspinlock *hwlock; 185 }; 186 187 struct regcache_ops { 188 const char *name; 189 enum regcache_type type; 190 int (*init)(struct regmap *map); 191 int (*exit)(struct regmap *map); 192 int (*populate)(struct regmap *map); 193 #ifdef CONFIG_DEBUG_FS 194 void (*debugfs_init)(struct regmap *map); 195 #endif 196 int (*read)(struct regmap *map, unsigned int reg, unsigned int *value); 197 int (*write)(struct regmap *map, unsigned int reg, unsigned int value); 198 int (*sync)(struct regmap *map, unsigned int min, unsigned int max); 199 int (*drop)(struct regmap *map, unsigned int min, unsigned int max); 200 }; 201 202 bool regmap_cached(struct regmap *map, unsigned int reg); 203 bool regmap_writeable(struct regmap *map, unsigned int reg); 204 bool regmap_readable(struct regmap *map, unsigned int reg); 205 bool regmap_volatile(struct regmap *map, unsigned int reg); 206 bool regmap_precious(struct regmap *map, unsigned int reg); 207 bool regmap_writeable_noinc(struct regmap *map, unsigned int reg); 208 bool regmap_readable_noinc(struct regmap *map, unsigned int reg); 209 210 int _regmap_write(struct regmap *map, unsigned int reg, 211 unsigned int val); 212 213 struct regmap_range_node { 214 struct rb_node node; 215 const char *name; 216 struct regmap *map; 217 218 unsigned int range_min; 219 unsigned int range_max; 220 221 unsigned int selector_reg; 222 unsigned int selector_mask; 223 int selector_shift; 224 225 unsigned int window_start; 226 unsigned int window_len; 227 }; 228 229 struct regmap_field { 230 struct regmap *regmap; 231 unsigned int mask; 232 /* lsb */ 233 unsigned int shift; 234 unsigned int reg; 235 236 unsigned int id_size; 237 unsigned int id_offset; 238 }; 239 240 #ifdef CONFIG_DEBUG_FS 241 extern void regmap_debugfs_initcall(void); 242 extern void regmap_debugfs_init(struct regmap *map); 243 extern void regmap_debugfs_exit(struct regmap *map); 244 245 static inline void regmap_debugfs_disable(struct regmap *map) 246 { 247 map->debugfs_disable = true; 248 } 249 250 #else 251 static inline void regmap_debugfs_initcall(void) { } 252 static inline void regmap_debugfs_init(struct regmap *map) { } 253 static inline void regmap_debugfs_exit(struct regmap *map) { } 254 static inline void regmap_debugfs_disable(struct regmap *map) { } 255 #endif 256 257 /* regcache core declarations */ 258 int regcache_init(struct regmap *map, const struct regmap_config *config); 259 void regcache_exit(struct regmap *map); 260 int regcache_read(struct regmap *map, 261 unsigned int reg, unsigned int *value); 262 int regcache_write(struct regmap *map, 263 unsigned int reg, unsigned int value); 264 int regcache_sync(struct regmap *map); 265 int regcache_sync_block(struct regmap *map, void *block, 266 unsigned long *cache_present, 267 unsigned int block_base, unsigned int start, 268 unsigned int end); 269 bool regcache_reg_needs_sync(struct regmap *map, unsigned int reg, 270 unsigned int val); 271 272 static inline const void *regcache_get_val_addr(struct regmap *map, 273 const void *base, 274 unsigned int idx) 275 { 276 return base + (map->cache_word_size * idx); 277 } 278 279 unsigned int regcache_get_val(struct regmap *map, const void *base, 280 unsigned int idx); 281 void regcache_set_val(struct regmap *map, void *base, unsigned int idx, 282 unsigned int val); 283 int regcache_lookup_reg(struct regmap *map, unsigned int reg); 284 int regcache_sync_val(struct regmap *map, unsigned int reg, unsigned int val); 285 286 int _regmap_raw_write(struct regmap *map, unsigned int reg, 287 const void *val, size_t val_len, bool noinc); 288 289 void regmap_async_complete_cb(struct regmap_async *async, int ret); 290 291 enum regmap_endian regmap_get_val_endian(struct device *dev, 292 const struct regmap_bus *bus, 293 const struct regmap_config *config); 294 295 extern struct regcache_ops regcache_flat_sparse_ops; 296 extern struct regcache_ops regcache_rbtree_ops; 297 extern struct regcache_ops regcache_maple_ops; 298 extern struct regcache_ops regcache_flat_ops; 299 300 static inline const char *regmap_name(const struct regmap *map) 301 { 302 if (map->dev) 303 return dev_name(map->dev); 304 305 return map->name; 306 } 307 308 static inline unsigned int regmap_get_offset(const struct regmap *map, 309 unsigned int index) 310 { 311 if (map->reg_stride_order >= 0) 312 return index << map->reg_stride_order; 313 else 314 return index * map->reg_stride; 315 } 316 317 static inline unsigned int regcache_get_index_by_order(const struct regmap *map, 318 unsigned int reg) 319 { 320 return reg >> map->reg_stride_order; 321 } 322 323 struct regmap_ram_data { 324 unsigned int *vals; /* Allocatd by caller */ 325 bool *read; 326 bool *written; 327 enum regmap_endian reg_endian; 328 bool (*noinc_reg)(struct regmap_ram_data *data, unsigned int reg); 329 }; 330 331 /* 332 * Create a test register map with data stored in RAM, not intended 333 * for practical use. 334 */ 335 struct regmap *__regmap_init_ram(struct device *dev, 336 const struct regmap_config *config, 337 struct regmap_ram_data *data, 338 struct lock_class_key *lock_key, 339 const char *lock_name); 340 341 #define regmap_init_ram(dev, config, data) \ 342 __regmap_lockdep_wrapper(__regmap_init_ram, #dev, dev, config, data) 343 344 struct regmap *__regmap_init_raw_ram(struct device *dev, 345 const struct regmap_config *config, 346 struct regmap_ram_data *data, 347 struct lock_class_key *lock_key, 348 const char *lock_name); 349 350 #define regmap_init_raw_ram(dev, config, data) \ 351 __regmap_lockdep_wrapper(__regmap_init_raw_ram, #dev, dev, config, data) 352 353 #endif 354