| 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/list.h> |
| 17 | |
| 18 | struct module; |
| 19 | struct device; |
| 20 | struct i2c_client; |
| 21 | struct spi_device; |
| 22 | struct regmap; |
| 23 | |
| 24 | /* An enum of all the supported cache types */ |
| 25 | enum regcache_type { |
| 26 | REGCACHE_NONE, |
| 27 | REGCACHE_RBTREE, |
| 28 | REGCACHE_COMPRESSED |
| 29 | }; |
| 30 | |
| 31 | /** |
| 32 | * Default value for a register. We use an array of structs rather |
| 33 | * than a simple array as many modern devices have very sparse |
| 34 | * register maps. |
| 35 | * |
| 36 | * @reg: Register address. |
| 37 | * @def: Register default value. |
| 38 | */ |
| 39 | struct reg_default { |
| 40 | unsigned int reg; |
| 41 | unsigned int def; |
| 42 | }; |
| 43 | |
| 44 | #ifdef CONFIG_REGMAP |
| 45 | |
| 46 | /** |
| 47 | * Configuration for the register map of a device. |
| 48 | * |
| 49 | * @name: Optional name of the regmap. Useful when a device has multiple |
| 50 | * register regions. |
| 51 | * |
| 52 | * @reg_bits: Number of bits in a register address, mandatory. |
| 53 | * @reg_stride: The register address stride. Valid register addresses are a |
| 54 | * multiple of this value. If set to 0, a value of 1 will be |
| 55 | * used. |
| 56 | * @pad_bits: Number of bits of padding between register and value. |
| 57 | * @val_bits: Number of bits in a register value, mandatory. |
| 58 | * |
| 59 | * @writeable_reg: Optional callback returning true if the register |
| 60 | * can be written to. |
| 61 | * @readable_reg: Optional callback returning true if the register |
| 62 | * can be read from. |
| 63 | * @volatile_reg: Optional callback returning true if the register |
| 64 | * value can't be cached. |
| 65 | * @precious_reg: Optional callback returning true if the rgister |
| 66 | * should not be read outside of a call from the driver |
| 67 | * (eg, a clear on read interrupt status register). |
| 68 | * |
| 69 | * @max_register: Optional, specifies the maximum valid register index. |
| 70 | * @reg_defaults: Power on reset values for registers (for use with |
| 71 | * register cache support). |
| 72 | * @num_reg_defaults: Number of elements in reg_defaults. |
| 73 | * |
| 74 | * @read_flag_mask: Mask to be set in the top byte of the register when doing |
| 75 | * a read. |
| 76 | * @write_flag_mask: Mask to be set in the top byte of the register when doing |
| 77 | * a write. If both read_flag_mask and write_flag_mask are |
| 78 | * empty the regmap_bus default masks are used. |
| 79 | * @use_single_rw: If set, converts the bulk read and write operations into |
| 80 | * a series of single read and write operations. This is useful |
| 81 | * for device that does not support bulk read and write. |
| 82 | * |
| 83 | * @cache_type: The actual cache type. |
| 84 | * @reg_defaults_raw: Power on reset values for registers (for use with |
| 85 | * register cache support). |
| 86 | * @num_reg_defaults_raw: Number of elements in reg_defaults_raw. |
| 87 | */ |
| 88 | struct regmap_config { |
| 89 | const char *name; |
| 90 | |
| 91 | int reg_bits; |
| 92 | int reg_stride; |
| 93 | int pad_bits; |
| 94 | int val_bits; |
| 95 | |
| 96 | bool (*writeable_reg)(struct device *dev, unsigned int reg); |
| 97 | bool (*readable_reg)(struct device *dev, unsigned int reg); |
| 98 | bool (*volatile_reg)(struct device *dev, unsigned int reg); |
| 99 | bool (*precious_reg)(struct device *dev, unsigned int reg); |
| 100 | |
| 101 | unsigned int max_register; |
| 102 | const struct reg_default *reg_defaults; |
| 103 | unsigned int num_reg_defaults; |
| 104 | enum regcache_type cache_type; |
| 105 | const void *reg_defaults_raw; |
| 106 | unsigned int num_reg_defaults_raw; |
| 107 | |
| 108 | u8 read_flag_mask; |
| 109 | u8 write_flag_mask; |
| 110 | |
| 111 | bool use_single_rw; |
| 112 | }; |
| 113 | |
| 114 | typedef int (*regmap_hw_write)(void *context, const void *data, |
| 115 | size_t count); |
| 116 | typedef int (*regmap_hw_gather_write)(void *context, |
| 117 | const void *reg, size_t reg_len, |
| 118 | const void *val, size_t val_len); |
| 119 | typedef int (*regmap_hw_read)(void *context, |
| 120 | const void *reg_buf, size_t reg_size, |
| 121 | void *val_buf, size_t val_size); |
| 122 | typedef void (*regmap_hw_free_context)(void *context); |
| 123 | |
| 124 | /** |
| 125 | * Description of a hardware bus for the register map infrastructure. |
| 126 | * |
| 127 | * @fast_io: Register IO is fast. Use a spinlock instead of a mutex |
| 128 | * to perform locking. |
| 129 | * @write: Write operation. |
| 130 | * @gather_write: Write operation with split register/value, return -ENOTSUPP |
| 131 | * if not implemented on a given device. |
| 132 | * @read: Read operation. Data is returned in the buffer used to transmit |
| 133 | * data. |
| 134 | * @read_flag_mask: Mask to be set in the top byte of the register when doing |
| 135 | * a read. |
| 136 | */ |
| 137 | struct regmap_bus { |
| 138 | bool fast_io; |
| 139 | regmap_hw_write write; |
| 140 | regmap_hw_gather_write gather_write; |
| 141 | regmap_hw_read read; |
| 142 | regmap_hw_free_context free_context; |
| 143 | u8 read_flag_mask; |
| 144 | }; |
| 145 | |
| 146 | struct regmap *regmap_init(struct device *dev, |
| 147 | const struct regmap_bus *bus, |
| 148 | void *bus_context, |
| 149 | const struct regmap_config *config); |
| 150 | struct regmap *regmap_init_i2c(struct i2c_client *i2c, |
| 151 | const struct regmap_config *config); |
| 152 | struct regmap *regmap_init_spi(struct spi_device *dev, |
| 153 | const struct regmap_config *config); |
| 154 | struct regmap *regmap_init_mmio(struct device *dev, |
| 155 | void __iomem *regs, |
| 156 | const struct regmap_config *config); |
| 157 | |
| 158 | struct regmap *devm_regmap_init(struct device *dev, |
| 159 | const struct regmap_bus *bus, |
| 160 | void *bus_context, |
| 161 | const struct regmap_config *config); |
| 162 | struct regmap *devm_regmap_init_i2c(struct i2c_client *i2c, |
| 163 | const struct regmap_config *config); |
| 164 | struct regmap *devm_regmap_init_spi(struct spi_device *dev, |
| 165 | const struct regmap_config *config); |
| 166 | struct regmap *devm_regmap_init_mmio(struct device *dev, |
| 167 | void __iomem *regs, |
| 168 | const struct regmap_config *config); |
| 169 | |
| 170 | void regmap_exit(struct regmap *map); |
| 171 | int regmap_reinit_cache(struct regmap *map, |
| 172 | const struct regmap_config *config); |
| 173 | int regmap_write(struct regmap *map, unsigned int reg, unsigned int val); |
| 174 | int regmap_raw_write(struct regmap *map, unsigned int reg, |
| 175 | const void *val, size_t val_len); |
| 176 | int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val, |
| 177 | size_t val_count); |
| 178 | int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val); |
| 179 | int regmap_raw_read(struct regmap *map, unsigned int reg, |
| 180 | void *val, size_t val_len); |
| 181 | int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val, |
| 182 | size_t val_count); |
| 183 | int regmap_update_bits(struct regmap *map, unsigned int reg, |
| 184 | unsigned int mask, unsigned int val); |
| 185 | int regmap_update_bits_check(struct regmap *map, unsigned int reg, |
| 186 | unsigned int mask, unsigned int val, |
| 187 | bool *change); |
| 188 | int regmap_get_val_bytes(struct regmap *map); |
| 189 | |
| 190 | int regcache_sync(struct regmap *map); |
| 191 | int regcache_sync_region(struct regmap *map, unsigned int min, |
| 192 | unsigned int max); |
| 193 | void regcache_cache_only(struct regmap *map, bool enable); |
| 194 | void regcache_cache_bypass(struct regmap *map, bool enable); |
| 195 | void regcache_mark_dirty(struct regmap *map); |
| 196 | |
| 197 | int regmap_register_patch(struct regmap *map, const struct reg_default *regs, |
| 198 | int num_regs); |
| 199 | |
| 200 | /** |
| 201 | * Description of an IRQ for the generic regmap irq_chip. |
| 202 | * |
| 203 | * @reg_offset: Offset of the status/mask register within the bank |
| 204 | * @mask: Mask used to flag/control the register. |
| 205 | */ |
| 206 | struct regmap_irq { |
| 207 | unsigned int reg_offset; |
| 208 | unsigned int mask; |
| 209 | }; |
| 210 | |
| 211 | /** |
| 212 | * Description of a generic regmap irq_chip. This is not intended to |
| 213 | * handle every possible interrupt controller, but it should handle a |
| 214 | * substantial proportion of those that are found in the wild. |
| 215 | * |
| 216 | * @name: Descriptive name for IRQ controller. |
| 217 | * |
| 218 | * @status_base: Base status register address. |
| 219 | * @mask_base: Base mask register address. |
| 220 | * @ack_base: Base ack address. If zero then the chip is clear on read. |
| 221 | * |
| 222 | * @num_regs: Number of registers in each control bank. |
| 223 | * @irqs: Descriptors for individual IRQs. Interrupt numbers are |
| 224 | * assigned based on the index in the array of the interrupt. |
| 225 | * @num_irqs: Number of descriptors. |
| 226 | */ |
| 227 | struct regmap_irq_chip { |
| 228 | const char *name; |
| 229 | |
| 230 | unsigned int status_base; |
| 231 | unsigned int mask_base; |
| 232 | unsigned int ack_base; |
| 233 | |
| 234 | int num_regs; |
| 235 | |
| 236 | const struct regmap_irq *irqs; |
| 237 | int num_irqs; |
| 238 | }; |
| 239 | |
| 240 | struct regmap_irq_chip_data; |
| 241 | |
| 242 | int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags, |
| 243 | int irq_base, struct regmap_irq_chip *chip, |
| 244 | struct regmap_irq_chip_data **data); |
| 245 | void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data); |
| 246 | int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data); |
| 247 | |
| 248 | #else |
| 249 | |
| 250 | /* |
| 251 | * These stubs should only ever be called by generic code which has |
| 252 | * regmap based facilities, if they ever get called at runtime |
| 253 | * something is going wrong and something probably needs to select |
| 254 | * REGMAP. |
| 255 | */ |
| 256 | |
| 257 | static inline int regmap_write(struct regmap *map, unsigned int reg, |
| 258 | unsigned int val) |
| 259 | { |
| 260 | WARN_ONCE(1, "regmap API is disabled"); |
| 261 | return -EINVAL; |
| 262 | } |
| 263 | |
| 264 | static inline int regmap_raw_write(struct regmap *map, unsigned int reg, |
| 265 | const void *val, size_t val_len) |
| 266 | { |
| 267 | WARN_ONCE(1, "regmap API is disabled"); |
| 268 | return -EINVAL; |
| 269 | } |
| 270 | |
| 271 | static inline int regmap_bulk_write(struct regmap *map, unsigned int reg, |
| 272 | const void *val, size_t val_count) |
| 273 | { |
| 274 | WARN_ONCE(1, "regmap API is disabled"); |
| 275 | return -EINVAL; |
| 276 | } |
| 277 | |
| 278 | static inline int regmap_read(struct regmap *map, unsigned int reg, |
| 279 | unsigned int *val) |
| 280 | { |
| 281 | WARN_ONCE(1, "regmap API is disabled"); |
| 282 | return -EINVAL; |
| 283 | } |
| 284 | |
| 285 | static inline int regmap_raw_read(struct regmap *map, unsigned int reg, |
| 286 | void *val, size_t val_len) |
| 287 | { |
| 288 | WARN_ONCE(1, "regmap API is disabled"); |
| 289 | return -EINVAL; |
| 290 | } |
| 291 | |
| 292 | static inline int regmap_bulk_read(struct regmap *map, unsigned int reg, |
| 293 | void *val, size_t val_count) |
| 294 | { |
| 295 | WARN_ONCE(1, "regmap API is disabled"); |
| 296 | return -EINVAL; |
| 297 | } |
| 298 | |
| 299 | static inline int regmap_update_bits(struct regmap *map, unsigned int reg, |
| 300 | unsigned int mask, unsigned int val) |
| 301 | { |
| 302 | WARN_ONCE(1, "regmap API is disabled"); |
| 303 | return -EINVAL; |
| 304 | } |
| 305 | |
| 306 | static inline int regmap_update_bits_check(struct regmap *map, |
| 307 | unsigned int reg, |
| 308 | unsigned int mask, unsigned int val, |
| 309 | bool *change) |
| 310 | { |
| 311 | WARN_ONCE(1, "regmap API is disabled"); |
| 312 | return -EINVAL; |
| 313 | } |
| 314 | |
| 315 | static inline int regmap_get_val_bytes(struct regmap *map) |
| 316 | { |
| 317 | WARN_ONCE(1, "regmap API is disabled"); |
| 318 | return -EINVAL; |
| 319 | } |
| 320 | |
| 321 | static inline int regcache_sync(struct regmap *map) |
| 322 | { |
| 323 | WARN_ONCE(1, "regmap API is disabled"); |
| 324 | return -EINVAL; |
| 325 | } |
| 326 | |
| 327 | static inline int regcache_sync_region(struct regmap *map, unsigned int min, |
| 328 | unsigned int max) |
| 329 | { |
| 330 | WARN_ONCE(1, "regmap API is disabled"); |
| 331 | return -EINVAL; |
| 332 | } |
| 333 | |
| 334 | static inline void regcache_cache_only(struct regmap *map, bool enable) |
| 335 | { |
| 336 | WARN_ONCE(1, "regmap API is disabled"); |
| 337 | } |
| 338 | |
| 339 | static inline void regcache_cache_bypass(struct regmap *map, bool enable) |
| 340 | { |
| 341 | WARN_ONCE(1, "regmap API is disabled"); |
| 342 | } |
| 343 | |
| 344 | static inline void regcache_mark_dirty(struct regmap *map) |
| 345 | { |
| 346 | WARN_ONCE(1, "regmap API is disabled"); |
| 347 | } |
| 348 | |
| 349 | static inline int regmap_register_patch(struct regmap *map, |
| 350 | const struct reg_default *regs, |
| 351 | int num_regs) |
| 352 | { |
| 353 | WARN_ONCE(1, "regmap API is disabled"); |
| 354 | return -EINVAL; |
| 355 | } |
| 356 | |
| 357 | #endif |
| 358 | |
| 359 | #endif |