1 #ifndef __LINUX_REGMAP_H
2 #define __LINUX_REGMAP_H
5 * Register map access API
7 * Copyright 2011 Wolfson Microelectronics plc
9 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
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.
16 #include <linux/device.h>
17 #include <linux/list.h>
18 #include <linux/module.h>
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
28 * @reg: Register address.
29 * @def: Register default value.
37 * Configuration for the register map of a device.
39 * @reg_bits: Number of bits in a register address, mandatory.
40 * @val_bits: Number of bits in a register value, mandatory.
42 * @writeable_reg: Optional callback returning true if the register
44 * @readable_reg: Optional callback returning true if the register
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).
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.
57 * @read_flag_mask: Mask to be set in the top byte of the register when doing
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.
63 struct regmap_config {
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);
72 unsigned int max_register;
73 struct reg_default *reg_defaults;
80 typedef int (*regmap_hw_write)(struct device *dev, const void *data,
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);
90 * Description of a hardware bus for the register map infrastructure.
92 * @write: Write operation.
93 * @gather_write: Write operation with split register/value, return -ENOTSUPP
94 * if not implemented on a given device.
95 * @read: Read operation. Data is returned in the buffer used to transmit
97 * @read_flag_mask: Mask to be set in the top byte of the register when doing
101 regmap_hw_write write;
102 regmap_hw_gather_write gather_write;
107 struct regmap *regmap_init(struct device *dev,
108 const struct regmap_bus *bus,
109 const struct regmap_config *config);
110 struct regmap *regmap_init_i2c(struct i2c_client *i2c,
111 const struct regmap_config *config);
112 struct regmap *regmap_init_spi(struct spi_device *dev,
113 const struct regmap_config *config);
115 void regmap_exit(struct regmap *map);
116 int regmap_write(struct regmap *map, unsigned int reg, unsigned int val);
117 int regmap_raw_write(struct regmap *map, unsigned int reg,
118 const void *val, size_t val_len);
119 int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val);
120 int regmap_raw_read(struct regmap *map, unsigned int reg,
121 void *val, size_t val_len);
122 int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
124 int regmap_update_bits(struct regmap *map, unsigned int reg,
125 unsigned int mask, unsigned int val);