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 lock;
  36
  37         struct device *dev; /* Device we do I/O on */
  38         void *work_buf;     /* Scratch buffer used to format I/O */
  39         struct regmap_format format;  /* Buffer format */
  40         const struct regmap_bus *bus;
  41
  42 #ifdef CONFIG_DEBUG_FS
  43         struct dentry *debugfs;
  44 #endif
  45
  46         unsigned int max_register;
  47         bool (*writeable_reg)(struct device *dev, unsigned int reg);
  48         bool (*readable_reg)(struct device *dev, unsigned int reg);
  49         bool (*volatile_reg)(struct device *dev, unsigned int reg);
  50         bool (*precious_reg)(struct device *dev, unsigned int reg);
  51
  52         u8 read_flag_mask;
  53         u8 write_flag_mask;
  54
  55         /* number of bits to (left) shift the reg value when formatting*/
  56         int reg_shift;
  57
  58         /* regcache specific members */
  59         const struct regcache_ops *cache_ops;
  60         enum regcache_type cache_type;
  61
  62         /* number of bytes in reg_defaults_raw */
  63         unsigned int cache_size_raw;
  64         /* number of bytes per word in reg_defaults_raw */
  65         unsigned int cache_word_size;
  66         /* number of entries in reg_defaults */
  67         unsigned int num_reg_defaults;
  68         /* number of entries in reg_defaults_raw */
  69         unsigned int num_reg_defaults_raw;
  70
  71         /* if set, only the cache is modified not the HW */
  72         u32 cache_only;
  73         /* if set, only the HW is modified not the cache */
  74         u32 cache_bypass;
  75         /* if set, remember to free reg_defaults_raw */
  76         bool cache_free;
  77
  78         struct reg_default *reg_defaults;
  79         const void *reg_defaults_raw;
  80         void *cache;
  81         u32 cache_dirty;
  82
  83         struct reg_default *patch;
  84         int patch_regs;
  85 };
  86
  87 struct regcache_ops {
  88         const char *name;
  89         enum regcache_type type;
  90         int (*init)(struct regmap *map);
  91         int (*exit)(struct regmap *map);
  92         int (*read)(struct regmap *map, unsigned int reg, unsigned int *value);
  93         int (*write)(struct regmap *map, unsigned int reg, unsigned int value);
  94         int (*sync)(struct regmap *map, unsigned int min, unsigned int max);
  95 };
  96
  97 bool regmap_writeable(struct regmap *map, unsigned int reg);
  98 bool regmap_readable(struct regmap *map, unsigned int reg);
  99 bool regmap_volatile(struct regmap *map, unsigned int reg);
 100 bool regmap_precious(struct regmap *map, unsigned int reg);
 101
 102 int _regmap_write(struct regmap *map, unsigned int reg,
 103                   unsigned int val);
 104
 105 #ifdef CONFIG_DEBUG_FS
 106 extern void regmap_debugfs_initcall(void);
 107 extern void regmap_debugfs_init(struct regmap *map);
 108 extern void regmap_debugfs_exit(struct regmap *map);
 109 #else
 110 static inline void regmap_debugfs_initcall(void) { }
 111 static inline void regmap_debugfs_init(struct regmap *map) { }
 112 static inline void regmap_debugfs_exit(struct regmap *map) { }
 113 #endif
 114
 115 /* regcache core declarations */
 116 int regcache_init(struct regmap *map, const struct regmap_config *config);
 117 void regcache_exit(struct regmap *map);
 118 int regcache_read(struct regmap *map,
 119                        unsigned int reg, unsigned int *value);
 120 int regcache_write(struct regmap *map,
 121                         unsigned int reg, unsigned int value);
 122 int regcache_sync(struct regmap *map);
 123
 124 unsigned int regcache_get_val(const void *base, unsigned int idx,
 125                               unsigned int word_size);
 126 bool regcache_set_val(void *base, unsigned int idx,
 127                       unsigned int val, unsigned int word_size);
 128 int regcache_lookup_reg(struct regmap *map, unsigned int reg);
 129
 130 extern struct regcache_ops regcache_rbtree_ops;
 131 extern struct regcache_ops regcache_lzo_ops;
 132
 133 #endif