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); 30 void (*format_val)(void *buf, unsigned int val); 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 #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 /* regcache specific members */ 63 const struct regcache_ops *cache_ops; 64 enum regcache_type cache_type; 65 66 /* number of bytes in reg_defaults_raw */ 67 unsigned int cache_size_raw; 68 /* number of bytes per word in reg_defaults_raw */ 69 unsigned int cache_word_size; 70 /* number of entries in reg_defaults */ 71 unsigned int num_reg_defaults; 72 /* number of entries in reg_defaults_raw */ 73 unsigned int num_reg_defaults_raw; 74 75 /* if set, only the cache is modified not the HW */ 76 u32 cache_only; 77 /* if set, only the HW is modified not the cache */ 78 u32 cache_bypass; 79 /* if set, remember to free reg_defaults_raw */ 80 bool cache_free; 81 82 struct reg_default *reg_defaults; 83 const void *reg_defaults_raw; 84 void *cache; 85 u32 cache_dirty; 86 87 struct reg_default *patch; 88 int patch_regs; 89 }; 90 91 struct regcache_ops { 92 const char *name; 93 enum regcache_type type; 94 int (*init)(struct regmap *map); 95 int (*exit)(struct regmap *map); 96 int (*read)(struct regmap *map, unsigned int reg, unsigned int *value); 97 int (*write)(struct regmap *map, unsigned int reg, unsigned int value); 98 int (*sync)(struct regmap *map, unsigned int min, unsigned int max); 99 }; 100 101 bool regmap_writeable(struct regmap *map, unsigned int reg); 102 bool regmap_readable(struct regmap *map, unsigned int reg); 103 bool regmap_volatile(struct regmap *map, unsigned int reg); 104 bool regmap_precious(struct regmap *map, unsigned int reg); 105 106 int _regmap_write(struct regmap *map, unsigned int reg, 107 unsigned int val); 108 109 #ifdef CONFIG_DEBUG_FS 110 extern void regmap_debugfs_initcall(void); 111 extern void regmap_debugfs_init(struct regmap *map); 112 extern void regmap_debugfs_exit(struct regmap *map); 113 #else 114 static inline void regmap_debugfs_initcall(void) { } 115 static inline void regmap_debugfs_init(struct regmap *map) { } 116 static inline void regmap_debugfs_exit(struct regmap *map) { } 117 #endif 118 119 /* regcache core declarations */ 120 int regcache_init(struct regmap *map, const struct regmap_config *config); 121 void regcache_exit(struct regmap *map); 122 int regcache_read(struct regmap *map, 123 unsigned int reg, unsigned int *value); 124 int regcache_write(struct regmap *map, 125 unsigned int reg, unsigned int value); 126 int regcache_sync(struct regmap *map); 127 128 unsigned int regcache_get_val(const void *base, unsigned int idx, 129 unsigned int word_size); 130 bool regcache_set_val(void *base, unsigned int idx, 131 unsigned int val, unsigned int word_size); 132 int regcache_lookup_reg(struct regmap *map, unsigned int reg); 133 134 extern struct regcache_ops regcache_rbtree_ops; 135 extern struct regcache_ops regcache_lzo_ops; 136 137 #endif 138