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