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 /**
  24  * Default value for a register.  We use an array of structs rather
  25  * than a simple array as many modern devices have very sparse
  26  * register maps.
  27  *
  28  * @reg: Register address.
  29  * @def: Register default value.
  30  */
  31 struct reg_default {
  32         unsigned int reg;
  33         unsigned int def;
  34 };
  35
  36 /**
  37  * Configuration for the register map of a device.
  38  *
  39  * @reg_bits: Number of bits in a register address, mandatory.
  40  * @val_bits: Number of bits in a register value, mandatory.
  41  *
  42  * @writeable_reg: Optional callback returning true if the register
  43  *                 can be written to.
  44  * @readable_reg: Optional callback returning true if the register
  45  *                can be read from.
  46  * @volatile_reg: Optional callback returning true if the register
  47  *                value can't be cached.
  48  * @precious_reg: Optional callback returning true if the rgister
  49  *                should not be read outside of a call from the driver
  50  *                (eg, a clear on read interrupt status register).
  51  *
  52  * @max_register: Optional, specifies the maximum valid register index.
  53  * @reg_defaults: Power on reset values for registers (for use with
  54  *                register cache support).
  55  * @num_reg_defaults: Number of elements in reg_defaults.
  56  *
  57  * @read_flag_mask: Mask to be set in the top byte of the register when doing
  58  *                  a read.
  59  * @write_flag_mask: Mask to be set in the top byte of the register when doing
  60  *                   a write. If both read_flag_mask and write_flag_mask are
  61  *                   empty the regmap_bus default masks are used.
  62  */
  63 struct regmap_config {
  64         int reg_bits;
  65         int val_bits;
  66
  67         bool (*writeable_reg)(struct device *dev, unsigned int reg);
  68         bool (*readable_reg)(struct device *dev, unsigned int reg);
  69         bool (*volatile_reg)(struct device *dev, unsigned int reg);
  70         bool (*precious_reg)(struct device *dev, unsigned int reg);
  71
  72         unsigned int max_register;
  73         struct reg_default *reg_defaults;
  74         int num_reg_defaults;
  75
  76         u8 read_flag_mask;
  77         u8 write_flag_mask;
  78 };
  79
  80 typedef int (*regmap_hw_write)(struct device *dev, const void *data,
  81                                size_t count);
  82 typedef int (*regmap_hw_gather_write)(struct device *dev,
  83                                       const void *reg, size_t reg_len,
  84                                       const void *val, size_t val_len);
  85 typedef int (*regmap_hw_read)(struct device *dev,
  86                               const void *reg_buf, size_t reg_size,
  87                               void *val_buf, size_t val_size);
  88
  89 /**
  90  * Description of a hardware bus for the register map infrastructure.
  91  *
  92  * @list: Internal use.
  93  * @type: Bus type, used to identify bus to be used for a device.
  94  * @write: Write operation.
  95  * @gather_write: Write operation with split register/value, return -ENOTSUPP
  96  *                if not implemented  on a given device.
  97  * @read: Read operation.  Data is returned in the buffer used to transmit
  98  *         data.
  99  * @owner: Module with the bus implementation, used to pin the implementation
 100  *         in memory.
 101  * @read_flag_mask: Mask to be set in the top byte of the register when doing
 102  *                  a read.
 103  */
 104 struct regmap_bus {
 105         struct list_head list;
 106         struct bus_type *type;
 107         regmap_hw_write write;
 108         regmap_hw_gather_write gather_write;
 109         regmap_hw_read read;
 110         struct module *owner;
 111         u8 read_flag_mask;
 112 };
 113
 114 struct regmap *regmap_init(struct device *dev,
 115                            const struct regmap_bus *bus,
 116                            const struct regmap_config *config);
 117 struct regmap *regmap_init_i2c(struct i2c_client *i2c,
 118                                const struct regmap_config *config);
 119 struct regmap *regmap_init_spi(struct spi_device *dev,
 120                                const struct regmap_config *config);
 121
 122 void regmap_exit(struct regmap *map);
 123 int regmap_write(struct regmap *map, unsigned int reg, unsigned int val);
 124 int regmap_raw_write(struct regmap *map, unsigned int reg,
 125                      const void *val, size_t val_len);
 126 int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val);
 127 int regmap_raw_read(struct regmap *map, unsigned int reg,
 128                     void *val, size_t val_len);
 129 int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
 130                      size_t val_count);
 131 int regmap_update_bits(struct regmap *map, unsigned int reg,
 132                        unsigned int mask, unsigned int val);
 133
 134 #endif