mmc: core: Fix PowerOff Notify suspend/resume
[linux-2.6.git] / include / linux / regmap.h
1 #ifndef __LINUX_REGMAP_H
2 #define __LINUX_REGMAP_H
3
4 /*
5  * Register map access API
6  *
7  * Copyright 2011 Wolfson Microelectronics plc
8  *
9  * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License version 2 as
13  * published by the Free Software Foundation.
14  */
15
16 #include <linux/device.h>
17 #include <linux/list.h>
18 #include <linux/module.h>
19
20 struct i2c_client;
21 struct spi_device;
22
23 /* An enum of all the supported cache types */
24 enum regcache_type {
25         REGCACHE_NONE,
26         REGCACHE_RBTREE,
27         REGCACHE_COMPRESSED
28 };
29
30 /**
31  * Default value for a register.  We use an array of structs rather
32  * than a simple array as many modern devices have very sparse
33  * register maps.
34  *
35  * @reg: Register address.
36  * @def: Register default value.
37  */
38 struct reg_default {
39         unsigned int reg;
40         unsigned int def;
41 };
42
43 /**
44  * Configuration for the register map of a device.
45  *
46  * @name: Optional name of the regmap. Useful when a device has multiple
47  *        register regions.
48  *
49  * @reg_bits: Number of bits in a register address, mandatory.
50  * @reg_stride: The register address stride. Valid register addresses are a
51  *              multiple of this value. If set to 0, a value of 1 will be
52  *              used.
53  * @pad_bits: Number of bits of padding between register and value.
54  * @val_bits: Number of bits in a register value, mandatory.
55  *
56  * @writeable_reg: Optional callback returning true if the register
57  *                 can be written to.
58  * @readable_reg: Optional callback returning true if the register
59  *                can be read from.
60  * @volatile_reg: Optional callback returning true if the register
61  *                value can't be cached.
62  * @precious_reg: Optional callback returning true if the rgister
63  *                should not be read outside of a call from the driver
64  *                (eg, a clear on read interrupt status register).
65  *
66  * @max_register: Optional, specifies the maximum valid register index.
67  * @reg_defaults: Power on reset values for registers (for use with
68  *                register cache support).
69  * @num_reg_defaults: Number of elements in reg_defaults.
70  *
71  * @read_flag_mask: Mask to be set in the top byte of the register when doing
72  *                  a read.
73  * @write_flag_mask: Mask to be set in the top byte of the register when doing
74  *                   a write. If both read_flag_mask and write_flag_mask are
75  *                   empty the regmap_bus default masks are used.
76  *
77  * @cache_type: The actual cache type.
78  * @reg_defaults_raw: Power on reset values for registers (for use with
79  *                    register cache support).
80  * @num_reg_defaults_raw: Number of elements in reg_defaults_raw.
81  */
82 struct regmap_config {
83         const char *name;
84
85         int reg_bits;
86         int reg_stride;
87         int pad_bits;
88         int val_bits;
89
90         bool (*writeable_reg)(struct device *dev, unsigned int reg);
91         bool (*readable_reg)(struct device *dev, unsigned int reg);
92         bool (*volatile_reg)(struct device *dev, unsigned int reg);
93         bool (*precious_reg)(struct device *dev, unsigned int reg);
94
95         unsigned int max_register;
96         const struct reg_default *reg_defaults;
97         unsigned int num_reg_defaults;
98         enum regcache_type cache_type;
99         const void *reg_defaults_raw;
100         unsigned int num_reg_defaults_raw;
101
102         u8 read_flag_mask;
103         u8 write_flag_mask;
104 };
105
106 typedef int (*regmap_hw_write)(void *context, const void *data,
107                                size_t count);
108 typedef int (*regmap_hw_gather_write)(void *context,
109                                       const void *reg, size_t reg_len,
110                                       const void *val, size_t val_len);
111 typedef int (*regmap_hw_read)(void *context,
112                               const void *reg_buf, size_t reg_size,
113                               void *val_buf, size_t val_size);
114 typedef void (*regmap_hw_free_context)(void *context);
115
116 /**
117  * Description of a hardware bus for the register map infrastructure.
118  *
119  * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
120  *           to perform locking.
121  * @write: Write operation.
122  * @gather_write: Write operation with split register/value, return -ENOTSUPP
123  *                if not implemented  on a given device.
124  * @read: Read operation.  Data is returned in the buffer used to transmit
125  *         data.
126  * @read_flag_mask: Mask to be set in the top byte of the register when doing
127  *                  a read.
128  */
129 struct regmap_bus {
130         bool fast_io;
131         regmap_hw_write write;
132         regmap_hw_gather_write gather_write;
133         regmap_hw_read read;
134         regmap_hw_free_context free_context;
135         u8 read_flag_mask;
136 };
137
138 struct regmap *regmap_init(struct device *dev,
139                            const struct regmap_bus *bus,
140                            void *bus_context,
141                            const struct regmap_config *config);
142 struct regmap *regmap_init_i2c(struct i2c_client *i2c,
143                                const struct regmap_config *config);
144 struct regmap *regmap_init_spi(struct spi_device *dev,
145                                const struct regmap_config *config);
146 struct regmap *regmap_init_mmio(struct device *dev,
147                                 void __iomem *regs,
148                                 const struct regmap_config *config);
149
150 struct regmap *devm_regmap_init(struct device *dev,
151                                 const struct regmap_bus *bus,
152                                 void *bus_context,
153                                 const struct regmap_config *config);
154 struct regmap *devm_regmap_init_i2c(struct i2c_client *i2c,
155                                     const struct regmap_config *config);
156 struct regmap *devm_regmap_init_spi(struct spi_device *dev,
157                                     const struct regmap_config *config);
158 struct regmap *devm_regmap_init_mmio(struct device *dev,
159                                      void __iomem *regs,
160                                      const struct regmap_config *config);
161
162 void regmap_exit(struct regmap *map);
163 int regmap_reinit_cache(struct regmap *map,
164                         const struct regmap_config *config);
165 int regmap_write(struct regmap *map, unsigned int reg, unsigned int val);
166 int regmap_raw_write(struct regmap *map, unsigned int reg,
167                      const void *val, size_t val_len);
168 int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
169                         size_t val_count);
170 int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val);
171 int regmap_raw_read(struct regmap *map, unsigned int reg,
172                     void *val, size_t val_len);
173 int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
174                      size_t val_count);
175 int regmap_update_bits(struct regmap *map, unsigned int reg,
176                        unsigned int mask, unsigned int val);
177 int regmap_update_bits_lazy(struct regmap *map, unsigned int reg,
178                        unsigned int mask, unsigned int val);
179 int regmap_update_bits_check(struct regmap *map, unsigned int reg,
180                              unsigned int mask, unsigned int val,
181                              bool *change);
182 int regmap_get_val_bytes(struct regmap *map);
183
184 int regcache_sync(struct regmap *map);
185 int regcache_sync_region(struct regmap *map, unsigned int min,
186                          unsigned int max);
187 void regcache_cache_only(struct regmap *map, bool enable);
188 void regcache_cache_bypass(struct regmap *map, bool enable);
189 void regcache_mark_dirty(struct regmap *map);
190
191 int regmap_register_patch(struct regmap *map, const struct reg_default *regs,
192                           int num_regs);
193
194 /**
195  * Description of an IRQ for the generic regmap irq_chip.
196  *
197  * @reg_offset: Offset of the status/mask register within the bank
198  * @mask:       Mask used to flag/control the register.
199  */
200 struct regmap_irq {
201         unsigned int reg_offset;
202         unsigned int mask;
203 };
204
205 /**
206  * Description of a generic regmap irq_chip.  This is not intended to
207  * handle every possible interrupt controller, but it should handle a
208  * substantial proportion of those that are found in the wild.
209  *
210  * @name:        Descriptive name for IRQ controller.
211  *
212  * @status_base: Base status register address.
213  * @mask_base:   Base mask register address.
214  * @ack_base:    Base ack address.  If zero then the chip is clear on read.
215  * @irq_reg_stride:  Stride to use for chips where registers are not contiguous.
216  *
217  * @num_regs:    Number of registers in each control bank.
218  * @irqs:        Descriptors for individual IRQs.  Interrupt numbers are
219  *               assigned based on the index in the array of the interrupt.
220  * @num_irqs:    Number of descriptors.
221  */
222 struct regmap_irq_chip {
223         const char *name;
224
225         unsigned int status_base;
226         unsigned int mask_base;
227         unsigned int ack_base;
228         unsigned int irq_reg_stride;
229
230         int num_regs;
231
232         const struct regmap_irq *irqs;
233         int num_irqs;
234 };
235
236 struct regmap_irq_chip_data;
237
238 int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags,
239                         int irq_base, struct regmap_irq_chip *chip,
240                         struct regmap_irq_chip_data **data);
241 void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data);
242 int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data);
243
244 #endif