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