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
  19 struct regmap;
  20 struct regcache_ops;
  21
  22 struct regmap_format {
  23         size_t buf_size;
  24         size_t reg_bytes;
  25         size_t pad_bytes;
  26         size_t val_bytes;
  27         void (*format_write)(struct regmap *map,
  28                              unsigned int reg, unsigned int val);
  29         void (*format_reg)(void *buf, unsigned int reg, unsigned int shift);
  30         void (*format_val)(void *buf, unsigned int val, unsigned int shift);
  31         unsigned int (*parse_val)(void *buf);
  32 };
  33
  34 struct regmap {
  35         struct mutex mutex;
  36         spinlock_t spinlock;
  37         regmap_lock lock;
  38         regmap_unlock unlock;
  39         void *lock_arg; /* This is passed to lock/unlock functions */
  40
  41         struct device *dev; /* Device we do I/O on */
  42         void *work_buf;     /* Scratch buffer used to format I/O */
  43         struct regmap_format format;  /* Buffer format */
  44         const struct regmap_bus *bus;
  45         void *bus_context;
  46         const char *name;
  47
  48 #ifdef CONFIG_DEBUG_FS
  49         struct dentry *debugfs;
  50         const char *debugfs_name;
  51 #endif
  52
  53         unsigned int max_register;
  54         bool (*writeable_reg)(struct device *dev, unsigned int reg);
  55         bool (*readable_reg)(struct device *dev, unsigned int reg);
  56         bool (*volatile_reg)(struct device *dev, unsigned int reg);
  57         bool (*precious_reg)(struct device *dev, unsigned int reg);
  58
  59         u8 read_flag_mask;
  60         u8 write_flag_mask;
  61
  62         /* number of bits to (left) shift the reg value when formatting*/
  63         int reg_shift;
  64         int reg_stride;
  65
  66         /* regcache specific members */
  67         const struct regcache_ops *cache_ops;
  68         enum regcache_type cache_type;
  69
  70         /* number of bytes in reg_defaults_raw */
  71         unsigned int cache_size_raw;
  72         /* number of bytes per word in reg_defaults_raw */
  73         unsigned int cache_word_size;
  74         /* number of entries in reg_defaults */
  75         unsigned int num_reg_defaults;
  76         /* number of entries in reg_defaults_raw */
  77         unsigned int num_reg_defaults_raw;
  78
  79         /* if set, only the cache is modified not the HW */
  80         u32 cache_only;
  81         /* if set, only the HW is modified not the cache */
  82         u32 cache_bypass;
  83         /* if set, remember to free reg_defaults_raw */
  84         bool cache_free;
  85
  86         struct reg_default *reg_defaults;
  87         const void *reg_defaults_raw;
  88         void *cache;
  89         u32 cache_dirty;
  90
  91         struct reg_default *patch;
  92         int patch_regs;
  93
  94         /* if set, converts bulk rw to single rw */
  95         bool use_single_rw;
  96
  97         struct rb_root range_tree;
  98         void *selector_work_buf;        /* Scratch buffer used for selector */
  99 };
 100
 101 struct regcache_ops {
 102         const char *name;
 103         enum regcache_type type;
 104         int (*init)(struct regmap *map);
 105         int (*exit)(struct regmap *map);
 106         int (*read)(struct regmap *map, unsigned int reg, unsigned int *value);
 107         int (*write)(struct regmap *map, unsigned int reg, unsigned int value);
 108         int (*sync)(struct regmap *map, unsigned int min, unsigned int max);
 109 };
 110
 111 bool regmap_writeable(struct regmap *map, unsigned int reg);
 112 bool regmap_readable(struct regmap *map, unsigned int reg);
 113 bool regmap_volatile(struct regmap *map, unsigned int reg);
 114 bool regmap_precious(struct regmap *map, unsigned int reg);
 115
 116 int _regmap_write(struct regmap *map, unsigned int reg,
 117                   unsigned int val);
 118
 119 struct regmap_range_node {
 120         struct rb_node node;
 121         const char *name;
 122         struct regmap *map;
 123
 124         unsigned int range_min;
 125         unsigned int range_max;
 126
 127         unsigned int selector_reg;
 128         unsigned int selector_mask;
 129         int selector_shift;
 130
 131         unsigned int window_start;
 132         unsigned int window_len;
 133 };
 134
 135 #ifdef CONFIG_DEBUG_FS
 136 extern void regmap_debugfs_initcall(void);
 137 extern void regmap_debugfs_init(struct regmap *map, const char *name);
 138 extern void regmap_debugfs_exit(struct regmap *map);
 139 #else
 140 static inline void regmap_debugfs_initcall(void) { }
 141 static inline void regmap_debugfs_init(struct regmap *map, const char *name) { }
 142 static inline void regmap_debugfs_exit(struct regmap *map) { }
 143 #endif
 144
 145 /* regcache core declarations */
 146 int regcache_init(struct regmap *map, const struct regmap_config *config);
 147 void regcache_exit(struct regmap *map);
 148 int regcache_read(struct regmap *map,
 149                        unsigned int reg, unsigned int *value);
 150 int regcache_write(struct regmap *map,
 151                         unsigned int reg, unsigned int value);
 152 int regcache_sync(struct regmap *map);
 153
 154 unsigned int regcache_get_val(const void *base, unsigned int idx,
 155                               unsigned int word_size);
 156 bool regcache_set_val(void *base, unsigned int idx,
 157                       unsigned int val, unsigned int word_size);
 158 int regcache_lookup_reg(struct regmap *map, unsigned int reg);
 159
 160 extern struct regcache_ops regcache_rbtree_ops;
 161 extern struct regcache_ops regcache_lzo_ops;
 162
 163 #endif