drivers/base/regmap/internal.h

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