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