blob: c9ef2ec69142e2309b5fc80784657f5abe79d4c7 [file] [log] [blame]
Mark Brownb83a3132011-05-11 19:59:58 +02001#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
Mark Brownb83a3132011-05-11 19:59:58 +020016#include <linux/list.h>
Krystian Garbaciak6863ca62012-06-15 11:23:56 +010017#include <linux/rbtree.h>
Mateusz Krawczuk49ccc142013-08-06 18:34:40 +020018#include <linux/err.h>
Kevin Hilman3f0fa9a2013-08-14 16:05:02 -070019#include <linux/bug.h>
Mark Brownb83a3132011-05-11 19:59:58 +020020
Paul Gortmakerde477252011-05-26 13:46:22 -040021struct module;
Paul Gortmaker313162d2012-01-30 11:46:54 -050022struct device;
Mark Brown9943fa32011-06-20 19:02:29 +010023struct i2c_client;
Mark Brown90f790d2012-08-20 21:45:05 +010024struct irq_domain;
Mark Browna676f082011-05-12 11:42:10 +020025struct spi_device;
Josh Cartwrighta01779f2013-10-28 13:12:35 -050026struct spmi_device;
Mark Brownb83d2ff2012-03-11 11:49:17 +000027struct regmap;
Krystian Garbaciak6863ca62012-06-15 11:23:56 +010028struct regmap_range_cfg;
Srinivas Kandagatla67252282013-06-11 13:18:15 +010029struct regmap_field;
Mark Brown22853222014-11-18 19:45:51 +010030struct snd_ac97;
Mark Brown9943fa32011-06-20 19:02:29 +010031
Dimitris Papastamos9fabe242011-09-19 14:34:00 +010032/* An enum of all the supported cache types */
33enum regcache_type {
34 REGCACHE_NONE,
Dimitris Papastamos28644c802011-09-19 14:34:02 +010035 REGCACHE_RBTREE,
Mark Brown2ac902c2012-12-19 14:51:55 +000036 REGCACHE_COMPRESSED,
37 REGCACHE_FLAT,
Dimitris Papastamos9fabe242011-09-19 14:34:00 +010038};
39
Mark Browndd898b22011-07-20 22:28:58 +010040/**
Mark Brownbd20eb52011-08-19 18:09:38 +090041 * Default value for a register. We use an array of structs rather
42 * than a simple array as many modern devices have very sparse
43 * register maps.
44 *
45 * @reg: Register address.
46 * @def: Register default value.
47 */
48struct reg_default {
49 unsigned int reg;
50 unsigned int def;
51};
52
Nariman Poushin8019ff62015-07-16 16:36:21 +010053/**
54 * Register/value pairs for sequences of writes
55 *
56 * @reg: Register address.
57 * @def: Register value.
58 */
59struct reg_sequence {
60 unsigned int reg;
61 unsigned int def;
62};
63
Mark Brownb83d2ff2012-03-11 11:49:17 +000064#ifdef CONFIG_REGMAP
65
Stephen Warren141eba22012-05-24 10:47:26 -060066enum regmap_endian {
67 /* Unspecified -> 0 -> Backwards compatible default */
68 REGMAP_ENDIAN_DEFAULT = 0,
69 REGMAP_ENDIAN_BIG,
70 REGMAP_ENDIAN_LITTLE,
71 REGMAP_ENDIAN_NATIVE,
72};
73
Davide Ciminaghi76aad392012-11-20 15:20:30 +010074/**
75 * A register range, used for access related checks
76 * (readable/writeable/volatile/precious checks)
77 *
78 * @range_min: address of first register
79 * @range_max: address of last register
80 */
81struct regmap_range {
82 unsigned int range_min;
83 unsigned int range_max;
84};
85
Laxman Dewangan6112fe62013-09-20 18:00:10 +053086#define regmap_reg_range(low, high) { .range_min = low, .range_max = high, }
87
Davide Ciminaghi76aad392012-11-20 15:20:30 +010088/*
89 * A table of ranges including some yes ranges and some no ranges.
90 * If a register belongs to a no_range, the corresponding check function
91 * will return false. If a register belongs to a yes range, the corresponding
92 * check function will return true. "no_ranges" are searched first.
93 *
94 * @yes_ranges : pointer to an array of regmap ranges used as "yes ranges"
95 * @n_yes_ranges: size of the above array
96 * @no_ranges: pointer to an array of regmap ranges used as "no ranges"
97 * @n_no_ranges: size of the above array
98 */
99struct regmap_access_table {
100 const struct regmap_range *yes_ranges;
101 unsigned int n_yes_ranges;
102 const struct regmap_range *no_ranges;
103 unsigned int n_no_ranges;
104};
105
Davide Ciminaghi0d4529c2012-10-16 15:56:59 +0200106typedef void (*regmap_lock)(void *);
107typedef void (*regmap_unlock)(void *);
108
Mark Brownbd20eb52011-08-19 18:09:38 +0900109/**
Mark Browndd898b22011-07-20 22:28:58 +0100110 * Configuration for the register map of a device.
111 *
Stephen Warrend3c242e2012-04-04 15:48:29 -0600112 * @name: Optional name of the regmap. Useful when a device has multiple
113 * register regions.
114 *
Mark Browndd898b22011-07-20 22:28:58 +0100115 * @reg_bits: Number of bits in a register address, mandatory.
Stephen Warrenf01ee602012-04-09 13:40:24 -0600116 * @reg_stride: The register address stride. Valid register addresses are a
117 * multiple of this value. If set to 0, a value of 1 will be
118 * used.
Mark Brown82159ba2012-01-18 10:52:25 +0000119 * @pad_bits: Number of bits of padding between register and value.
Mark Browndd898b22011-07-20 22:28:58 +0100120 * @val_bits: Number of bits in a register value, mandatory.
Mark Brown2e2ae662011-07-20 22:33:39 +0100121 *
Mark Brown3566cc92011-08-09 10:23:22 +0900122 * @writeable_reg: Optional callback returning true if the register
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100123 * can be written to. If this field is NULL but wr_table
124 * (see below) is not, the check is performed on such table
125 * (a register is writeable if it belongs to one of the ranges
126 * specified by wr_table).
Mark Brown3566cc92011-08-09 10:23:22 +0900127 * @readable_reg: Optional callback returning true if the register
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100128 * can be read from. If this field is NULL but rd_table
129 * (see below) is not, the check is performed on such table
130 * (a register is readable if it belongs to one of the ranges
131 * specified by rd_table).
Mark Brown3566cc92011-08-09 10:23:22 +0900132 * @volatile_reg: Optional callback returning true if the register
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100133 * value can't be cached. If this field is NULL but
134 * volatile_table (see below) is not, the check is performed on
135 * such table (a register is volatile if it belongs to one of
136 * the ranges specified by volatile_table).
Laszlo Pappbdc39642014-01-09 14:13:41 +0000137 * @precious_reg: Optional callback returning true if the register
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100138 * should not be read outside of a call from the driver
Laszlo Pappbdc39642014-01-09 14:13:41 +0000139 * (e.g., a clear on read interrupt status register). If this
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100140 * field is NULL but precious_table (see below) is not, the
141 * check is performed on such table (a register is precious if
142 * it belongs to one of the ranges specified by precious_table).
143 * @lock: Optional lock callback (overrides regmap's default lock
144 * function, based on spinlock or mutex).
145 * @unlock: As above for unlocking.
146 * @lock_arg: this field is passed as the only argument of lock/unlock
147 * functions (ignored in case regular lock/unlock functions
148 * are not overridden).
Andrey Smirnovd2a58842013-01-27 10:49:05 -0800149 * @reg_read: Optional callback that if filled will be used to perform
150 * all the reads from the registers. Should only be provided for
Laszlo Pappbdc39642014-01-09 14:13:41 +0000151 * devices whose read operation cannot be represented as a simple
152 * read operation on a bus such as SPI, I2C, etc. Most of the
153 * devices do not need this.
Andrey Smirnovd2a58842013-01-27 10:49:05 -0800154 * @reg_write: Same as above for writing.
155 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
156 * to perform locking. This field is ignored if custom lock/unlock
157 * functions are used (see fields lock/unlock of struct regmap_config).
158 * This field is a duplicate of a similar file in
159 * 'struct regmap_bus' and serves exact same purpose.
160 * Use it only for "no-bus" cases.
Mark Brownbd20eb52011-08-19 18:09:38 +0900161 * @max_register: Optional, specifies the maximum valid register index.
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100162 * @wr_table: Optional, points to a struct regmap_access_table specifying
163 * valid ranges for write access.
164 * @rd_table: As above, for read access.
165 * @volatile_table: As above, for volatile registers.
166 * @precious_table: As above, for precious registers.
Mark Brownbd20eb52011-08-19 18:09:38 +0900167 * @reg_defaults: Power on reset values for registers (for use with
168 * register cache support).
169 * @num_reg_defaults: Number of elements in reg_defaults.
Lars-Peter Clausen6f306442011-09-05 20:46:32 +0200170 *
171 * @read_flag_mask: Mask to be set in the top byte of the register when doing
172 * a read.
173 * @write_flag_mask: Mask to be set in the top byte of the register when doing
174 * a write. If both read_flag_mask and write_flag_mask are
175 * empty the regmap_bus default masks are used.
Ashish Jangam2e33caf2012-04-30 23:23:40 +0100176 * @use_single_rw: If set, converts the bulk read and write operations into
177 * a series of single read and write operations. This is useful
178 * for device that does not support bulk read and write.
Opensource [Anthony Olech]e894c3f2014-03-04 13:54:02 +0000179 * @can_multi_write: If set, the device supports the multi write mode of bulk
180 * write operations, if clear multi write requests will be
181 * split into individual write operations
Dimitris Papastamos9fabe242011-09-19 14:34:00 +0100182 *
183 * @cache_type: The actual cache type.
184 * @reg_defaults_raw: Power on reset values for registers (for use with
185 * register cache support).
186 * @num_reg_defaults_raw: Number of elements in reg_defaults_raw.
Stephen Warren141eba22012-05-24 10:47:26 -0600187 * @reg_format_endian: Endianness for formatted register addresses. If this is
188 * DEFAULT, the @reg_format_endian_default value from the
189 * regmap bus is used.
190 * @val_format_endian: Endianness for formatted register values. If this is
191 * DEFAULT, the @reg_format_endian_default value from the
192 * regmap bus is used.
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100193 *
194 * @ranges: Array of configuration entries for virtual address ranges.
195 * @num_ranges: Number of range configuration entries.
Mark Browndd898b22011-07-20 22:28:58 +0100196 */
Mark Brownb83a3132011-05-11 19:59:58 +0200197struct regmap_config {
Stephen Warrend3c242e2012-04-04 15:48:29 -0600198 const char *name;
199
Mark Brownb83a3132011-05-11 19:59:58 +0200200 int reg_bits;
Stephen Warrenf01ee602012-04-09 13:40:24 -0600201 int reg_stride;
Mark Brown82159ba2012-01-18 10:52:25 +0000202 int pad_bits;
Mark Brownb83a3132011-05-11 19:59:58 +0200203 int val_bits;
Mark Brown2e2ae662011-07-20 22:33:39 +0100204
Mark Brown2e2ae662011-07-20 22:33:39 +0100205 bool (*writeable_reg)(struct device *dev, unsigned int reg);
206 bool (*readable_reg)(struct device *dev, unsigned int reg);
207 bool (*volatile_reg)(struct device *dev, unsigned int reg);
Mark Brown18694882011-08-08 15:40:22 +0900208 bool (*precious_reg)(struct device *dev, unsigned int reg);
Davide Ciminaghi0d4529c2012-10-16 15:56:59 +0200209 regmap_lock lock;
210 regmap_unlock unlock;
211 void *lock_arg;
Mark Brownbd20eb52011-08-19 18:09:38 +0900212
Andrey Smirnovd2a58842013-01-27 10:49:05 -0800213 int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
214 int (*reg_write)(void *context, unsigned int reg, unsigned int val);
215
216 bool fast_io;
217
Mark Brownbd20eb52011-08-19 18:09:38 +0900218 unsigned int max_register;
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100219 const struct regmap_access_table *wr_table;
220 const struct regmap_access_table *rd_table;
221 const struct regmap_access_table *volatile_table;
222 const struct regmap_access_table *precious_table;
Lars-Peter Clausen720e4612011-11-16 16:28:17 +0100223 const struct reg_default *reg_defaults;
Dimitris Papastamos9fabe242011-09-19 14:34:00 +0100224 unsigned int num_reg_defaults;
225 enum regcache_type cache_type;
226 const void *reg_defaults_raw;
227 unsigned int num_reg_defaults_raw;
Lars-Peter Clausen6f306442011-09-05 20:46:32 +0200228
229 u8 read_flag_mask;
230 u8 write_flag_mask;
Ashish Jangam2e33caf2012-04-30 23:23:40 +0100231
232 bool use_single_rw;
Opensource [Anthony Olech]e894c3f2014-03-04 13:54:02 +0000233 bool can_multi_write;
Stephen Warren141eba22012-05-24 10:47:26 -0600234
235 enum regmap_endian reg_format_endian;
236 enum regmap_endian val_format_endian;
Mark Brown38e23192012-07-22 19:26:07 +0100237
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100238 const struct regmap_range_cfg *ranges;
Mark Browne3549cd2012-10-02 20:17:15 +0100239 unsigned int num_ranges;
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100240};
241
242/**
243 * Configuration for indirectly accessed or paged registers.
244 * Registers, mapped to this virtual range, are accessed in two steps:
245 * 1. page selector register update;
246 * 2. access through data window registers.
247 *
Mark Brownd058bb42012-10-03 12:40:47 +0100248 * @name: Descriptive name for diagnostics
249 *
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100250 * @range_min: Address of the lowest register address in virtual range.
251 * @range_max: Address of the highest register in virtual range.
252 *
253 * @page_sel_reg: Register with selector field.
254 * @page_sel_mask: Bit shift for selector value.
255 * @page_sel_shift: Bit mask for selector value.
256 *
257 * @window_start: Address of first (lowest) register in data window.
258 * @window_len: Number of registers in data window.
259 */
260struct regmap_range_cfg {
Mark Brownd058bb42012-10-03 12:40:47 +0100261 const char *name;
262
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100263 /* Registers of virtual address range */
264 unsigned int range_min;
265 unsigned int range_max;
266
267 /* Page selector for indirect addressing */
268 unsigned int selector_reg;
269 unsigned int selector_mask;
270 int selector_shift;
271
272 /* Data window (per each page) */
273 unsigned int window_start;
274 unsigned int window_len;
Mark Brownb83a3132011-05-11 19:59:58 +0200275};
276
Mark Brown0d509f22013-01-27 22:07:38 +0800277struct regmap_async;
278
Stephen Warren0135bbc2012-04-04 15:48:30 -0600279typedef int (*regmap_hw_write)(void *context, const void *data,
Mark Brownb83a3132011-05-11 19:59:58 +0200280 size_t count);
Stephen Warren0135bbc2012-04-04 15:48:30 -0600281typedef int (*regmap_hw_gather_write)(void *context,
Mark Brownb83a3132011-05-11 19:59:58 +0200282 const void *reg, size_t reg_len,
283 const void *val, size_t val_len);
Mark Brown0d509f22013-01-27 22:07:38 +0800284typedef int (*regmap_hw_async_write)(void *context,
285 const void *reg, size_t reg_len,
286 const void *val, size_t val_len,
287 struct regmap_async *async);
Stephen Warren0135bbc2012-04-04 15:48:30 -0600288typedef int (*regmap_hw_read)(void *context,
Mark Brownb83a3132011-05-11 19:59:58 +0200289 const void *reg_buf, size_t reg_size,
290 void *val_buf, size_t val_size);
Boris BREZILLON3ac17032014-04-17 11:40:11 +0200291typedef int (*regmap_hw_reg_read)(void *context, unsigned int reg,
292 unsigned int *val);
293typedef int (*regmap_hw_reg_write)(void *context, unsigned int reg,
294 unsigned int val);
Mark Brown0d509f22013-01-27 22:07:38 +0800295typedef struct regmap_async *(*regmap_hw_async_alloc)(void);
Stephen Warren0135bbc2012-04-04 15:48:30 -0600296typedef void (*regmap_hw_free_context)(void *context);
Mark Brownb83a3132011-05-11 19:59:58 +0200297
298/**
299 * Description of a hardware bus for the register map infrastructure.
300 *
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600301 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
Davide Ciminaghi0d4529c2012-10-16 15:56:59 +0200302 * to perform locking. This field is ignored if custom lock/unlock
303 * functions are used (see fields lock/unlock of
304 * struct regmap_config).
Mark Brownb83a3132011-05-11 19:59:58 +0200305 * @write: Write operation.
306 * @gather_write: Write operation with split register/value, return -ENOTSUPP
307 * if not implemented on a given device.
Mark Brown0d509f22013-01-27 22:07:38 +0800308 * @async_write: Write operation which completes asynchronously, optional and
309 * must serialise with respect to non-async I/O.
Mark Brownb83a3132011-05-11 19:59:58 +0200310 * @read: Read operation. Data is returned in the buffer used to transmit
311 * data.
Mark Brown0d509f22013-01-27 22:07:38 +0800312 * @async_alloc: Allocate a regmap_async() structure.
Mark Brownb83a3132011-05-11 19:59:58 +0200313 * @read_flag_mask: Mask to be set in the top byte of the register when doing
314 * a read.
Stephen Warren141eba22012-05-24 10:47:26 -0600315 * @reg_format_endian_default: Default endianness for formatted register
316 * addresses. Used when the regmap_config specifies DEFAULT. If this is
317 * DEFAULT, BIG is assumed.
318 * @val_format_endian_default: Default endianness for formatted register
319 * values. Used when the regmap_config specifies DEFAULT. If this is
320 * DEFAULT, BIG is assumed.
Mark Brown0d509f22013-01-27 22:07:38 +0800321 * @async_size: Size of struct used for async work.
Mark Brownb83a3132011-05-11 19:59:58 +0200322 */
323struct regmap_bus {
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600324 bool fast_io;
Mark Brownb83a3132011-05-11 19:59:58 +0200325 regmap_hw_write write;
326 regmap_hw_gather_write gather_write;
Mark Brown0d509f22013-01-27 22:07:38 +0800327 regmap_hw_async_write async_write;
Boris BREZILLON3ac17032014-04-17 11:40:11 +0200328 regmap_hw_reg_write reg_write;
Mark Brownb83a3132011-05-11 19:59:58 +0200329 regmap_hw_read read;
Boris BREZILLON3ac17032014-04-17 11:40:11 +0200330 regmap_hw_reg_read reg_read;
Stephen Warren0135bbc2012-04-04 15:48:30 -0600331 regmap_hw_free_context free_context;
Mark Brown0d509f22013-01-27 22:07:38 +0800332 regmap_hw_async_alloc async_alloc;
Mark Brownb83a3132011-05-11 19:59:58 +0200333 u8 read_flag_mask;
Stephen Warren141eba22012-05-24 10:47:26 -0600334 enum regmap_endian reg_format_endian_default;
335 enum regmap_endian val_format_endian_default;
Mark Brownb83a3132011-05-11 19:59:58 +0200336};
337
338struct regmap *regmap_init(struct device *dev,
339 const struct regmap_bus *bus,
Stephen Warren0135bbc2012-04-04 15:48:30 -0600340 void *bus_context,
Mark Brownb83a3132011-05-11 19:59:58 +0200341 const struct regmap_config *config);
Michal Simek6cfec042014-02-10 16:22:33 +0100342int regmap_attach_dev(struct device *dev, struct regmap *map,
343 const struct regmap_config *config);
Mark Brown9943fa32011-06-20 19:02:29 +0100344struct regmap *regmap_init_i2c(struct i2c_client *i2c,
345 const struct regmap_config *config);
Mark Browna676f082011-05-12 11:42:10 +0200346struct regmap *regmap_init_spi(struct spi_device *dev,
347 const struct regmap_config *config);
Josh Cartwrightc9afbb02014-02-12 13:44:27 -0600348struct regmap *regmap_init_spmi_base(struct spmi_device *dev,
349 const struct regmap_config *config);
350struct regmap *regmap_init_spmi_ext(struct spmi_device *dev,
351 const struct regmap_config *config);
Philipp Zabel878ec672013-02-14 17:39:08 +0100352struct regmap *regmap_init_mmio_clk(struct device *dev, const char *clk_id,
353 void __iomem *regs,
354 const struct regmap_config *config);
Mark Brown22853222014-11-18 19:45:51 +0100355struct regmap *regmap_init_ac97(struct snd_ac97 *ac97,
356 const struct regmap_config *config);
Mark Browna676f082011-05-12 11:42:10 +0200357
Mark Brownc0eb4672012-01-30 19:56:52 +0000358struct regmap *devm_regmap_init(struct device *dev,
359 const struct regmap_bus *bus,
Stephen Warren0135bbc2012-04-04 15:48:30 -0600360 void *bus_context,
Mark Brownc0eb4672012-01-30 19:56:52 +0000361 const struct regmap_config *config);
362struct regmap *devm_regmap_init_i2c(struct i2c_client *i2c,
363 const struct regmap_config *config);
364struct regmap *devm_regmap_init_spi(struct spi_device *dev,
365 const struct regmap_config *config);
Josh Cartwrightc9afbb02014-02-12 13:44:27 -0600366struct regmap *devm_regmap_init_spmi_base(struct spmi_device *dev,
367 const struct regmap_config *config);
368struct regmap *devm_regmap_init_spmi_ext(struct spmi_device *dev,
369 const struct regmap_config *config);
Philipp Zabel878ec672013-02-14 17:39:08 +0100370struct regmap *devm_regmap_init_mmio_clk(struct device *dev, const char *clk_id,
371 void __iomem *regs,
372 const struct regmap_config *config);
Mark Brown22853222014-11-18 19:45:51 +0100373struct regmap *devm_regmap_init_ac97(struct snd_ac97 *ac97,
374 const struct regmap_config *config);
375
376bool regmap_ac97_default_volatile(struct device *dev, unsigned int reg);
Philipp Zabel878ec672013-02-14 17:39:08 +0100377
378/**
379 * regmap_init_mmio(): Initialise register map
380 *
381 * @dev: Device that will be interacted with
382 * @regs: Pointer to memory-mapped IO region
383 * @config: Configuration for register map
384 *
385 * The return value will be an ERR_PTR() on error or a valid pointer to
386 * a struct regmap.
387 */
388static inline struct regmap *regmap_init_mmio(struct device *dev,
389 void __iomem *regs,
390 const struct regmap_config *config)
391{
392 return regmap_init_mmio_clk(dev, NULL, regs, config);
393}
394
395/**
396 * devm_regmap_init_mmio(): Initialise managed register map
397 *
398 * @dev: Device that will be interacted with
399 * @regs: Pointer to memory-mapped IO region
400 * @config: Configuration for register map
401 *
402 * The return value will be an ERR_PTR() on error or a valid pointer
403 * to a struct regmap. The regmap will be automatically freed by the
404 * device management code.
405 */
406static inline struct regmap *devm_regmap_init_mmio(struct device *dev,
407 void __iomem *regs,
408 const struct regmap_config *config)
409{
410 return devm_regmap_init_mmio_clk(dev, NULL, regs, config);
411}
Mark Brownc0eb4672012-01-30 19:56:52 +0000412
Mark Brownb83a3132011-05-11 19:59:58 +0200413void regmap_exit(struct regmap *map);
Mark Brownbf315172011-12-03 17:06:20 +0000414int regmap_reinit_cache(struct regmap *map,
415 const struct regmap_config *config);
Mark Brown72b39f62012-05-08 17:44:40 +0100416struct regmap *dev_get_regmap(struct device *dev, const char *name);
Tuomas Tynkkynen8d7d3972014-07-21 18:38:47 +0300417struct device *regmap_get_device(struct regmap *map);
Mark Brownb83a3132011-05-11 19:59:58 +0200418int regmap_write(struct regmap *map, unsigned int reg, unsigned int val);
Mark Brown915f4412013-10-09 13:30:10 +0100419int regmap_write_async(struct regmap *map, unsigned int reg, unsigned int val);
Mark Brownb83a3132011-05-11 19:59:58 +0200420int regmap_raw_write(struct regmap *map, unsigned int reg,
421 const void *val, size_t val_len);
Laxman Dewangan8eaeb212012-02-12 19:49:43 +0530422int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
423 size_t val_count);
Nariman Poushin8019ff62015-07-16 16:36:21 +0100424int regmap_multi_reg_write(struct regmap *map, const struct reg_sequence *regs,
Anthony Oleche33fabd2013-10-11 15:31:11 +0100425 int num_regs);
Charles Keepax1d5b40b2014-02-25 13:45:50 +0000426int regmap_multi_reg_write_bypassed(struct regmap *map,
Nariman Poushin8019ff62015-07-16 16:36:21 +0100427 const struct reg_sequence *regs,
Charles Keepax1d5b40b2014-02-25 13:45:50 +0000428 int num_regs);
Mark Brown0d509f22013-01-27 22:07:38 +0800429int regmap_raw_write_async(struct regmap *map, unsigned int reg,
430 const void *val, size_t val_len);
Mark Brownb83a3132011-05-11 19:59:58 +0200431int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val);
432int regmap_raw_read(struct regmap *map, unsigned int reg,
433 void *val, size_t val_len);
434int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
435 size_t val_count);
436int regmap_update_bits(struct regmap *map, unsigned int reg,
437 unsigned int mask, unsigned int val);
Mark Brown915f4412013-10-09 13:30:10 +0100438int regmap_update_bits_async(struct regmap *map, unsigned int reg,
439 unsigned int mask, unsigned int val);
Mark Brown018690d2011-11-29 20:10:36 +0000440int regmap_update_bits_check(struct regmap *map, unsigned int reg,
441 unsigned int mask, unsigned int val,
442 bool *change);
Mark Brown915f4412013-10-09 13:30:10 +0100443int regmap_update_bits_check_async(struct regmap *map, unsigned int reg,
444 unsigned int mask, unsigned int val,
445 bool *change);
Mark Browna6539c32012-02-17 14:20:14 -0800446int regmap_get_val_bytes(struct regmap *map);
Srinivas Kandagatla668abc72015-05-21 17:42:43 +0100447int regmap_get_max_register(struct regmap *map);
Srinivas Kandagatlaa2f776c2015-05-21 17:42:54 +0100448int regmap_get_reg_stride(struct regmap *map);
Mark Brown0d509f22013-01-27 22:07:38 +0800449int regmap_async_complete(struct regmap *map);
Mark Brown221ad7f2013-03-26 21:24:20 +0000450bool regmap_can_raw_write(struct regmap *map);
Mark Brownb83a3132011-05-11 19:59:58 +0200451
Mark Brown39a58432011-09-19 18:21:49 +0100452int regcache_sync(struct regmap *map);
Mark Brown4d4cfd12012-02-23 20:53:37 +0000453int regcache_sync_region(struct regmap *map, unsigned int min,
454 unsigned int max);
Mark Brown697e85b2013-05-08 13:55:22 +0100455int regcache_drop_region(struct regmap *map, unsigned int min,
456 unsigned int max);
Mark Brown92afb282011-09-19 18:22:14 +0100457void regcache_cache_only(struct regmap *map, bool enable);
Dimitris Papastamos6eb0f5e2011-09-29 14:36:27 +0100458void regcache_cache_bypass(struct regmap *map, bool enable);
Mark Brown8ae0d7e2011-10-26 10:34:22 +0200459void regcache_mark_dirty(struct regmap *map);
Mark Brown92afb282011-09-19 18:22:14 +0100460
Mark Brown154881e2013-05-08 13:55:23 +0100461bool regmap_check_range_table(struct regmap *map, unsigned int reg,
462 const struct regmap_access_table *table);
463
Nariman Poushin8019ff62015-07-16 16:36:21 +0100464int regmap_register_patch(struct regmap *map, const struct reg_sequence *regs,
Mark Brown22f0d902012-01-21 12:01:14 +0000465 int num_regs);
Nenghua Cao13ff50c2014-02-19 18:44:13 +0800466int regmap_parse_val(struct regmap *map, const void *buf,
467 unsigned int *val);
Mark Brown22f0d902012-01-21 12:01:14 +0000468
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100469static inline bool regmap_reg_in_range(unsigned int reg,
470 const struct regmap_range *range)
471{
472 return reg >= range->range_min && reg <= range->range_max;
473}
474
475bool regmap_reg_in_ranges(unsigned int reg,
476 const struct regmap_range *ranges,
477 unsigned int nranges);
478
Mark Brownf8beab22011-10-28 23:50:49 +0200479/**
Srinivas Kandagatla67252282013-06-11 13:18:15 +0100480 * Description of an register field
481 *
482 * @reg: Offset of the register within the regmap bank
483 * @lsb: lsb of the register field.
Bintian Wangf27b37f2015-01-27 20:50:29 +0800484 * @msb: msb of the register field.
Kuninori Morimotoa0102372013-09-01 20:30:50 -0700485 * @id_size: port size if it has some ports
486 * @id_offset: address offset for each ports
Srinivas Kandagatla67252282013-06-11 13:18:15 +0100487 */
488struct reg_field {
489 unsigned int reg;
490 unsigned int lsb;
491 unsigned int msb;
Kuninori Morimotoa0102372013-09-01 20:30:50 -0700492 unsigned int id_size;
493 unsigned int id_offset;
Srinivas Kandagatla67252282013-06-11 13:18:15 +0100494};
495
496#define REG_FIELD(_reg, _lsb, _msb) { \
497 .reg = _reg, \
498 .lsb = _lsb, \
499 .msb = _msb, \
500 }
501
502struct regmap_field *regmap_field_alloc(struct regmap *regmap,
503 struct reg_field reg_field);
504void regmap_field_free(struct regmap_field *field);
505
506struct regmap_field *devm_regmap_field_alloc(struct device *dev,
507 struct regmap *regmap, struct reg_field reg_field);
508void devm_regmap_field_free(struct device *dev, struct regmap_field *field);
509
510int regmap_field_read(struct regmap_field *field, unsigned int *val);
511int regmap_field_write(struct regmap_field *field, unsigned int val);
Kuninori Morimotofdf20022013-09-01 20:24:50 -0700512int regmap_field_update_bits(struct regmap_field *field,
513 unsigned int mask, unsigned int val);
Srinivas Kandagatla67252282013-06-11 13:18:15 +0100514
Kuninori Morimotoa0102372013-09-01 20:30:50 -0700515int regmap_fields_write(struct regmap_field *field, unsigned int id,
516 unsigned int val);
517int regmap_fields_read(struct regmap_field *field, unsigned int id,
518 unsigned int *val);
519int regmap_fields_update_bits(struct regmap_field *field, unsigned int id,
520 unsigned int mask, unsigned int val);
Srinivas Kandagatla67252282013-06-11 13:18:15 +0100521
522/**
Mark Brownf8beab22011-10-28 23:50:49 +0200523 * Description of an IRQ for the generic regmap irq_chip.
524 *
525 * @reg_offset: Offset of the status/mask register within the bank
526 * @mask: Mask used to flag/control the register.
527 */
528struct regmap_irq {
529 unsigned int reg_offset;
530 unsigned int mask;
531};
532
533/**
534 * Description of a generic regmap irq_chip. This is not intended to
535 * handle every possible interrupt controller, but it should handle a
536 * substantial proportion of those that are found in the wild.
537 *
538 * @name: Descriptive name for IRQ controller.
539 *
540 * @status_base: Base status register address.
541 * @mask_base: Base mask register address.
Alexander Shiyand3233432013-12-15 13:36:51 +0400542 * @ack_base: Base ack address. If zero then the chip is clear on read.
543 * Using zero value is possible with @use_ack bit.
Mark Browna43fd502012-06-05 14:34:03 +0100544 * @wake_base: Base address for wake enables. If zero unsupported.
Graeme Gregory022f926a2012-05-14 22:40:43 +0900545 * @irq_reg_stride: Stride to use for chips where registers are not contiguous.
Philipp Zabel2753e6f2013-07-22 17:15:52 +0200546 * @init_ack_masked: Ack all masked interrupts once during initalization.
Philipp Zabel68622bd2013-07-24 10:26:48 +0200547 * @mask_invert: Inverted mask register: cleared bits are masked out.
Alexander Shiyand3233432013-12-15 13:36:51 +0400548 * @use_ack: Use @ack register even if it is zero.
Philipp Zabel68622bd2013-07-24 10:26:48 +0200549 * @wake_invert: Inverted wake register: cleared bits are wake enabled.
Mark Brown0c00c502012-07-24 15:41:19 +0100550 * @runtime_pm: Hold a runtime PM lock on the device when accessing it.
Mark Brownf8beab22011-10-28 23:50:49 +0200551 *
552 * @num_regs: Number of registers in each control bank.
553 * @irqs: Descriptors for individual IRQs. Interrupt numbers are
554 * assigned based on the index in the array of the interrupt.
555 * @num_irqs: Number of descriptors.
556 */
557struct regmap_irq_chip {
558 const char *name;
559
560 unsigned int status_base;
561 unsigned int mask_base;
562 unsigned int ack_base;
Mark Browna43fd502012-06-05 14:34:03 +0100563 unsigned int wake_base;
Graeme Gregory022f926a2012-05-14 22:40:43 +0900564 unsigned int irq_reg_stride;
Philipp Zabelf484f7a2013-07-24 10:26:42 +0200565 bool init_ack_masked:1;
566 bool mask_invert:1;
Alexander Shiyand3233432013-12-15 13:36:51 +0400567 bool use_ack:1;
Philipp Zabelf484f7a2013-07-24 10:26:42 +0200568 bool wake_invert:1;
569 bool runtime_pm:1;
Mark Brownf8beab22011-10-28 23:50:49 +0200570
571 int num_regs;
572
573 const struct regmap_irq *irqs;
574 int num_irqs;
575};
576
577struct regmap_irq_chip_data;
578
579int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags,
Mark Brownb026ddb2012-05-31 21:01:46 +0100580 int irq_base, const struct regmap_irq_chip *chip,
Mark Brownf8beab22011-10-28 23:50:49 +0200581 struct regmap_irq_chip_data **data);
582void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data);
Mark Brown209a6002011-12-05 16:10:15 +0000583int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data);
Mark Brown4af8be62012-05-13 10:59:56 +0100584int regmap_irq_get_virq(struct regmap_irq_chip_data *data, int irq);
Mark Brown90f790d2012-08-20 21:45:05 +0100585struct irq_domain *regmap_irq_get_domain(struct regmap_irq_chip_data *data);
Mark Brownb83a3132011-05-11 19:59:58 +0200586
Mark Brown9cde5fc2012-02-17 14:49:51 -0800587#else
588
589/*
590 * These stubs should only ever be called by generic code which has
591 * regmap based facilities, if they ever get called at runtime
592 * something is going wrong and something probably needs to select
593 * REGMAP.
594 */
595
596static inline int regmap_write(struct regmap *map, unsigned int reg,
597 unsigned int val)
598{
599 WARN_ONCE(1, "regmap API is disabled");
600 return -EINVAL;
601}
602
Mark Brown915f4412013-10-09 13:30:10 +0100603static inline int regmap_write_async(struct regmap *map, unsigned int reg,
604 unsigned int val)
605{
606 WARN_ONCE(1, "regmap API is disabled");
607 return -EINVAL;
608}
609
Mark Brown9cde5fc2012-02-17 14:49:51 -0800610static inline int regmap_raw_write(struct regmap *map, unsigned int reg,
611 const void *val, size_t val_len)
612{
613 WARN_ONCE(1, "regmap API is disabled");
614 return -EINVAL;
615}
616
Mark Brown0d509f22013-01-27 22:07:38 +0800617static inline int regmap_raw_write_async(struct regmap *map, unsigned int reg,
618 const void *val, size_t val_len)
619{
620 WARN_ONCE(1, "regmap API is disabled");
621 return -EINVAL;
622}
623
Mark Brown9cde5fc2012-02-17 14:49:51 -0800624static inline int regmap_bulk_write(struct regmap *map, unsigned int reg,
625 const void *val, size_t val_count)
626{
627 WARN_ONCE(1, "regmap API is disabled");
628 return -EINVAL;
629}
630
631static inline int regmap_read(struct regmap *map, unsigned int reg,
632 unsigned int *val)
633{
634 WARN_ONCE(1, "regmap API is disabled");
635 return -EINVAL;
636}
637
638static inline int regmap_raw_read(struct regmap *map, unsigned int reg,
639 void *val, size_t val_len)
640{
641 WARN_ONCE(1, "regmap API is disabled");
642 return -EINVAL;
643}
644
645static inline int regmap_bulk_read(struct regmap *map, unsigned int reg,
646 void *val, size_t val_count)
647{
648 WARN_ONCE(1, "regmap API is disabled");
649 return -EINVAL;
650}
651
652static inline int regmap_update_bits(struct regmap *map, unsigned int reg,
653 unsigned int mask, unsigned int val)
654{
655 WARN_ONCE(1, "regmap API is disabled");
656 return -EINVAL;
657}
658
Mark Brown915f4412013-10-09 13:30:10 +0100659static inline int regmap_update_bits_async(struct regmap *map,
660 unsigned int reg,
661 unsigned int mask, unsigned int val)
662{
663 WARN_ONCE(1, "regmap API is disabled");
664 return -EINVAL;
665}
666
Mark Brown9cde5fc2012-02-17 14:49:51 -0800667static inline int regmap_update_bits_check(struct regmap *map,
668 unsigned int reg,
669 unsigned int mask, unsigned int val,
670 bool *change)
671{
672 WARN_ONCE(1, "regmap API is disabled");
673 return -EINVAL;
674}
675
Mark Brown915f4412013-10-09 13:30:10 +0100676static inline int regmap_update_bits_check_async(struct regmap *map,
677 unsigned int reg,
678 unsigned int mask,
679 unsigned int val,
680 bool *change)
681{
682 WARN_ONCE(1, "regmap API is disabled");
683 return -EINVAL;
684}
685
Mark Brown9cde5fc2012-02-17 14:49:51 -0800686static inline int regmap_get_val_bytes(struct regmap *map)
687{
688 WARN_ONCE(1, "regmap API is disabled");
689 return -EINVAL;
690}
691
Srinivas Kandagatla668abc72015-05-21 17:42:43 +0100692static inline int regmap_get_max_register(struct regmap *map)
693{
694 WARN_ONCE(1, "regmap API is disabled");
695 return -EINVAL;
696}
697
Srinivas Kandagatlaa2f776c2015-05-21 17:42:54 +0100698static inline int regmap_get_reg_stride(struct regmap *map)
699{
700 WARN_ONCE(1, "regmap API is disabled");
701 return -EINVAL;
702}
703
Mark Brown9cde5fc2012-02-17 14:49:51 -0800704static inline int regcache_sync(struct regmap *map)
705{
706 WARN_ONCE(1, "regmap API is disabled");
707 return -EINVAL;
708}
709
Mark Browna313f9f2012-02-23 19:49:43 +0000710static inline int regcache_sync_region(struct regmap *map, unsigned int min,
711 unsigned int max)
712{
713 WARN_ONCE(1, "regmap API is disabled");
714 return -EINVAL;
715}
716
Mark Brown697e85b2013-05-08 13:55:22 +0100717static inline int regcache_drop_region(struct regmap *map, unsigned int min,
718 unsigned int max)
719{
720 WARN_ONCE(1, "regmap API is disabled");
721 return -EINVAL;
722}
723
Mark Brown9cde5fc2012-02-17 14:49:51 -0800724static inline void regcache_cache_only(struct regmap *map, bool enable)
725{
726 WARN_ONCE(1, "regmap API is disabled");
727}
728
729static inline void regcache_cache_bypass(struct regmap *map, bool enable)
730{
731 WARN_ONCE(1, "regmap API is disabled");
732}
733
734static inline void regcache_mark_dirty(struct regmap *map)
735{
736 WARN_ONCE(1, "regmap API is disabled");
737}
738
Mark Brown0d509f22013-01-27 22:07:38 +0800739static inline void regmap_async_complete(struct regmap *map)
740{
741 WARN_ONCE(1, "regmap API is disabled");
742}
743
Mark Brown9cde5fc2012-02-17 14:49:51 -0800744static inline int regmap_register_patch(struct regmap *map,
745 const struct reg_default *regs,
746 int num_regs)
747{
748 WARN_ONCE(1, "regmap API is disabled");
749 return -EINVAL;
750}
751
Nenghua Cao13ff50c2014-02-19 18:44:13 +0800752static inline int regmap_parse_val(struct regmap *map, const void *buf,
753 unsigned int *val)
754{
755 WARN_ONCE(1, "regmap API is disabled");
756 return -EINVAL;
757}
758
Mark Brown72b39f62012-05-08 17:44:40 +0100759static inline struct regmap *dev_get_regmap(struct device *dev,
760 const char *name)
761{
Mark Brown72b39f62012-05-08 17:44:40 +0100762 return NULL;
763}
764
Tuomas Tynkkynen8d7d3972014-07-21 18:38:47 +0300765static inline struct device *regmap_get_device(struct regmap *map)
766{
767 WARN_ONCE(1, "regmap API is disabled");
Mark Brown1d33dc62014-07-25 19:01:53 +0100768 return NULL;
Tuomas Tynkkynen8d7d3972014-07-21 18:38:47 +0300769}
770
Mark Brown9cde5fc2012-02-17 14:49:51 -0800771#endif
772
Mark Brownb83a3132011-05-11 19:59:58 +0200773#endif