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