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