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