blob: 59c55ea0f0b50c270d64bebe9dd6c25a717ca5ec [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
Mark Brownb83d2ff2012-03-11 11:49:17 +000053#ifdef CONFIG_REGMAP
54
Stephen Warren141eba22012-05-24 10:47:26 -060055enum regmap_endian {
56 /* Unspecified -> 0 -> Backwards compatible default */
57 REGMAP_ENDIAN_DEFAULT = 0,
58 REGMAP_ENDIAN_BIG,
59 REGMAP_ENDIAN_LITTLE,
60 REGMAP_ENDIAN_NATIVE,
61};
62
Davide Ciminaghi76aad392012-11-20 15:20:30 +010063/**
64 * A register range, used for access related checks
65 * (readable/writeable/volatile/precious checks)
66 *
67 * @range_min: address of first register
68 * @range_max: address of last register
69 */
70struct regmap_range {
71 unsigned int range_min;
72 unsigned int range_max;
73};
74
Laxman Dewangan6112fe62013-09-20 18:00:10 +053075#define regmap_reg_range(low, high) { .range_min = low, .range_max = high, }
76
Davide Ciminaghi76aad392012-11-20 15:20:30 +010077/*
78 * A table of ranges including some yes ranges and some no ranges.
79 * If a register belongs to a no_range, the corresponding check function
80 * will return false. If a register belongs to a yes range, the corresponding
81 * check function will return true. "no_ranges" are searched first.
82 *
83 * @yes_ranges : pointer to an array of regmap ranges used as "yes ranges"
84 * @n_yes_ranges: size of the above array
85 * @no_ranges: pointer to an array of regmap ranges used as "no ranges"
86 * @n_no_ranges: size of the above array
87 */
88struct regmap_access_table {
89 const struct regmap_range *yes_ranges;
90 unsigned int n_yes_ranges;
91 const struct regmap_range *no_ranges;
92 unsigned int n_no_ranges;
93};
94
Davide Ciminaghi0d4529c2012-10-16 15:56:59 +020095typedef void (*regmap_lock)(void *);
96typedef void (*regmap_unlock)(void *);
97
Mark Brownbd20eb52011-08-19 18:09:38 +090098/**
Mark Browndd898b22011-07-20 22:28:58 +010099 * Configuration for the register map of a device.
100 *
Stephen Warrend3c242e2012-04-04 15:48:29 -0600101 * @name: Optional name of the regmap. Useful when a device has multiple
102 * register regions.
103 *
Mark Browndd898b22011-07-20 22:28:58 +0100104 * @reg_bits: Number of bits in a register address, mandatory.
Stephen Warrenf01ee602012-04-09 13:40:24 -0600105 * @reg_stride: The register address stride. Valid register addresses are a
106 * multiple of this value. If set to 0, a value of 1 will be
107 * used.
Mark Brown82159ba2012-01-18 10:52:25 +0000108 * @pad_bits: Number of bits of padding between register and value.
Mark Browndd898b22011-07-20 22:28:58 +0100109 * @val_bits: Number of bits in a register value, mandatory.
Mark Brown2e2ae662011-07-20 22:33:39 +0100110 *
Mark Brown3566cc92011-08-09 10:23:22 +0900111 * @writeable_reg: Optional callback returning true if the register
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100112 * can be written to. If this field is NULL but wr_table
113 * (see below) is not, the check is performed on such table
114 * (a register is writeable if it belongs to one of the ranges
115 * specified by wr_table).
Mark Brown3566cc92011-08-09 10:23:22 +0900116 * @readable_reg: Optional callback returning true if the register
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100117 * can be read from. If this field is NULL but rd_table
118 * (see below) is not, the check is performed on such table
119 * (a register is readable if it belongs to one of the ranges
120 * specified by rd_table).
Mark Brown3566cc92011-08-09 10:23:22 +0900121 * @volatile_reg: Optional callback returning true if the register
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100122 * value can't be cached. If this field is NULL but
123 * volatile_table (see below) is not, the check is performed on
124 * such table (a register is volatile if it belongs to one of
125 * the ranges specified by volatile_table).
Laszlo Pappbdc39642014-01-09 14:13:41 +0000126 * @precious_reg: Optional callback returning true if the register
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100127 * should not be read outside of a call from the driver
Laszlo Pappbdc39642014-01-09 14:13:41 +0000128 * (e.g., a clear on read interrupt status register). If this
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100129 * field is NULL but precious_table (see below) is not, the
130 * check is performed on such table (a register is precious if
131 * it belongs to one of the ranges specified by precious_table).
132 * @lock: Optional lock callback (overrides regmap's default lock
133 * function, based on spinlock or mutex).
134 * @unlock: As above for unlocking.
135 * @lock_arg: this field is passed as the only argument of lock/unlock
136 * functions (ignored in case regular lock/unlock functions
137 * are not overridden).
Andrey Smirnovd2a58842013-01-27 10:49:05 -0800138 * @reg_read: Optional callback that if filled will be used to perform
139 * all the reads from the registers. Should only be provided for
Laszlo Pappbdc39642014-01-09 14:13:41 +0000140 * devices whose read operation cannot be represented as a simple
141 * read operation on a bus such as SPI, I2C, etc. Most of the
142 * devices do not need this.
Andrey Smirnovd2a58842013-01-27 10:49:05 -0800143 * @reg_write: Same as above for writing.
144 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
145 * to perform locking. This field is ignored if custom lock/unlock
146 * functions are used (see fields lock/unlock of struct regmap_config).
147 * This field is a duplicate of a similar file in
148 * 'struct regmap_bus' and serves exact same purpose.
149 * Use it only for "no-bus" cases.
Mark Brownbd20eb52011-08-19 18:09:38 +0900150 * @max_register: Optional, specifies the maximum valid register index.
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100151 * @wr_table: Optional, points to a struct regmap_access_table specifying
152 * valid ranges for write access.
153 * @rd_table: As above, for read access.
154 * @volatile_table: As above, for volatile registers.
155 * @precious_table: As above, for precious registers.
Mark Brownbd20eb52011-08-19 18:09:38 +0900156 * @reg_defaults: Power on reset values for registers (for use with
157 * register cache support).
158 * @num_reg_defaults: Number of elements in reg_defaults.
Lars-Peter Clausen6f306442011-09-05 20:46:32 +0200159 *
160 * @read_flag_mask: Mask to be set in the top byte of the register when doing
161 * a read.
162 * @write_flag_mask: Mask to be set in the top byte of the register when doing
163 * a write. If both read_flag_mask and write_flag_mask are
164 * empty the regmap_bus default masks are used.
Ashish Jangam2e33caf2012-04-30 23:23:40 +0100165 * @use_single_rw: If set, converts the bulk read and write operations into
166 * a series of single read and write operations. This is useful
167 * for device that does not support bulk read and write.
Opensource [Anthony Olech]e894c3f2014-03-04 13:54:02 +0000168 * @can_multi_write: If set, the device supports the multi write mode of bulk
169 * write operations, if clear multi write requests will be
170 * split into individual write operations
Dimitris Papastamos9fabe242011-09-19 14:34:00 +0100171 *
172 * @cache_type: The actual cache type.
173 * @reg_defaults_raw: Power on reset values for registers (for use with
174 * register cache support).
175 * @num_reg_defaults_raw: Number of elements in reg_defaults_raw.
Stephen Warren141eba22012-05-24 10:47:26 -0600176 * @reg_format_endian: Endianness for formatted register addresses. If this is
177 * DEFAULT, the @reg_format_endian_default value from the
178 * regmap bus is used.
179 * @val_format_endian: Endianness for formatted register values. If this is
180 * DEFAULT, the @reg_format_endian_default value from the
181 * regmap bus is used.
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100182 *
183 * @ranges: Array of configuration entries for virtual address ranges.
184 * @num_ranges: Number of range configuration entries.
Mark Browndd898b22011-07-20 22:28:58 +0100185 */
Mark Brownb83a3132011-05-11 19:59:58 +0200186struct regmap_config {
Stephen Warrend3c242e2012-04-04 15:48:29 -0600187 const char *name;
188
Mark Brownb83a3132011-05-11 19:59:58 +0200189 int reg_bits;
Stephen Warrenf01ee602012-04-09 13:40:24 -0600190 int reg_stride;
Mark Brown82159ba2012-01-18 10:52:25 +0000191 int pad_bits;
Mark Brownb83a3132011-05-11 19:59:58 +0200192 int val_bits;
Mark Brown2e2ae662011-07-20 22:33:39 +0100193
Mark Brown2e2ae662011-07-20 22:33:39 +0100194 bool (*writeable_reg)(struct device *dev, unsigned int reg);
195 bool (*readable_reg)(struct device *dev, unsigned int reg);
196 bool (*volatile_reg)(struct device *dev, unsigned int reg);
Mark Brown18694882011-08-08 15:40:22 +0900197 bool (*precious_reg)(struct device *dev, unsigned int reg);
Davide Ciminaghi0d4529c2012-10-16 15:56:59 +0200198 regmap_lock lock;
199 regmap_unlock unlock;
200 void *lock_arg;
Mark Brownbd20eb52011-08-19 18:09:38 +0900201
Andrey Smirnovd2a58842013-01-27 10:49:05 -0800202 int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
203 int (*reg_write)(void *context, unsigned int reg, unsigned int val);
204
205 bool fast_io;
206
Mark Brownbd20eb52011-08-19 18:09:38 +0900207 unsigned int max_register;
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100208 const struct regmap_access_table *wr_table;
209 const struct regmap_access_table *rd_table;
210 const struct regmap_access_table *volatile_table;
211 const struct regmap_access_table *precious_table;
Lars-Peter Clausen720e4612011-11-16 16:28:17 +0100212 const struct reg_default *reg_defaults;
Dimitris Papastamos9fabe242011-09-19 14:34:00 +0100213 unsigned int num_reg_defaults;
214 enum regcache_type cache_type;
215 const void *reg_defaults_raw;
216 unsigned int num_reg_defaults_raw;
Lars-Peter Clausen6f306442011-09-05 20:46:32 +0200217
218 u8 read_flag_mask;
219 u8 write_flag_mask;
Ashish Jangam2e33caf2012-04-30 23:23:40 +0100220
221 bool use_single_rw;
Opensource [Anthony Olech]e894c3f2014-03-04 13:54:02 +0000222 bool can_multi_write;
Stephen Warren141eba22012-05-24 10:47:26 -0600223
224 enum regmap_endian reg_format_endian;
225 enum regmap_endian val_format_endian;
Mark Brown38e23192012-07-22 19:26:07 +0100226
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100227 const struct regmap_range_cfg *ranges;
Mark Browne3549cd2012-10-02 20:17:15 +0100228 unsigned int num_ranges;
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100229};
230
231/**
232 * Configuration for indirectly accessed or paged registers.
233 * Registers, mapped to this virtual range, are accessed in two steps:
234 * 1. page selector register update;
235 * 2. access through data window registers.
236 *
Mark Brownd058bb42012-10-03 12:40:47 +0100237 * @name: Descriptive name for diagnostics
238 *
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100239 * @range_min: Address of the lowest register address in virtual range.
240 * @range_max: Address of the highest register in virtual range.
241 *
242 * @page_sel_reg: Register with selector field.
243 * @page_sel_mask: Bit shift for selector value.
244 * @page_sel_shift: Bit mask for selector value.
245 *
246 * @window_start: Address of first (lowest) register in data window.
247 * @window_len: Number of registers in data window.
248 */
249struct regmap_range_cfg {
Mark Brownd058bb42012-10-03 12:40:47 +0100250 const char *name;
251
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100252 /* Registers of virtual address range */
253 unsigned int range_min;
254 unsigned int range_max;
255
256 /* Page selector for indirect addressing */
257 unsigned int selector_reg;
258 unsigned int selector_mask;
259 int selector_shift;
260
261 /* Data window (per each page) */
262 unsigned int window_start;
263 unsigned int window_len;
Mark Brownb83a3132011-05-11 19:59:58 +0200264};
265
Mark Brown0d509f22013-01-27 22:07:38 +0800266struct regmap_async;
267
Stephen Warren0135bbc2012-04-04 15:48:30 -0600268typedef int (*regmap_hw_write)(void *context, const void *data,
Mark Brownb83a3132011-05-11 19:59:58 +0200269 size_t count);
Stephen Warren0135bbc2012-04-04 15:48:30 -0600270typedef int (*regmap_hw_gather_write)(void *context,
Mark Brownb83a3132011-05-11 19:59:58 +0200271 const void *reg, size_t reg_len,
272 const void *val, size_t val_len);
Mark Brown0d509f22013-01-27 22:07:38 +0800273typedef int (*regmap_hw_async_write)(void *context,
274 const void *reg, size_t reg_len,
275 const void *val, size_t val_len,
276 struct regmap_async *async);
Stephen Warren0135bbc2012-04-04 15:48:30 -0600277typedef int (*regmap_hw_read)(void *context,
Mark Brownb83a3132011-05-11 19:59:58 +0200278 const void *reg_buf, size_t reg_size,
279 void *val_buf, size_t val_size);
Boris BREZILLON3ac17032014-04-17 11:40:11 +0200280typedef int (*regmap_hw_reg_read)(void *context, unsigned int reg,
281 unsigned int *val);
282typedef int (*regmap_hw_reg_write)(void *context, unsigned int reg,
283 unsigned int val);
Mark Brown0d509f22013-01-27 22:07:38 +0800284typedef struct regmap_async *(*regmap_hw_async_alloc)(void);
Stephen Warren0135bbc2012-04-04 15:48:30 -0600285typedef void (*regmap_hw_free_context)(void *context);
Mark Brownb83a3132011-05-11 19:59:58 +0200286
287/**
288 * Description of a hardware bus for the register map infrastructure.
289 *
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600290 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
Davide Ciminaghi0d4529c2012-10-16 15:56:59 +0200291 * to perform locking. This field is ignored if custom lock/unlock
292 * functions are used (see fields lock/unlock of
293 * struct regmap_config).
Mark Brownb83a3132011-05-11 19:59:58 +0200294 * @write: Write operation.
295 * @gather_write: Write operation with split register/value, return -ENOTSUPP
296 * if not implemented on a given device.
Mark Brown0d509f22013-01-27 22:07:38 +0800297 * @async_write: Write operation which completes asynchronously, optional and
298 * must serialise with respect to non-async I/O.
Mark Brownb83a3132011-05-11 19:59:58 +0200299 * @read: Read operation. Data is returned in the buffer used to transmit
300 * data.
Mark Brown0d509f22013-01-27 22:07:38 +0800301 * @async_alloc: Allocate a regmap_async() structure.
Mark Brownb83a3132011-05-11 19:59:58 +0200302 * @read_flag_mask: Mask to be set in the top byte of the register when doing
303 * a read.
Stephen Warren141eba22012-05-24 10:47:26 -0600304 * @reg_format_endian_default: Default endianness for formatted register
305 * addresses. Used when the regmap_config specifies DEFAULT. If this is
306 * DEFAULT, BIG is assumed.
307 * @val_format_endian_default: Default endianness for formatted register
308 * values. Used when the regmap_config specifies DEFAULT. If this is
309 * DEFAULT, BIG is assumed.
Mark Brown0d509f22013-01-27 22:07:38 +0800310 * @async_size: Size of struct used for async work.
Mark Brownb83a3132011-05-11 19:59:58 +0200311 */
312struct regmap_bus {
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600313 bool fast_io;
Mark Brownb83a3132011-05-11 19:59:58 +0200314 regmap_hw_write write;
315 regmap_hw_gather_write gather_write;
Mark Brown0d509f22013-01-27 22:07:38 +0800316 regmap_hw_async_write async_write;
Boris BREZILLON3ac17032014-04-17 11:40:11 +0200317 regmap_hw_reg_write reg_write;
Mark Brownb83a3132011-05-11 19:59:58 +0200318 regmap_hw_read read;
Boris BREZILLON3ac17032014-04-17 11:40:11 +0200319 regmap_hw_reg_read reg_read;
Stephen Warren0135bbc2012-04-04 15:48:30 -0600320 regmap_hw_free_context free_context;
Mark Brown0d509f22013-01-27 22:07:38 +0800321 regmap_hw_async_alloc async_alloc;
Mark Brownb83a3132011-05-11 19:59:58 +0200322 u8 read_flag_mask;
Stephen Warren141eba22012-05-24 10:47:26 -0600323 enum regmap_endian reg_format_endian_default;
324 enum regmap_endian val_format_endian_default;
Mark Brownb83a3132011-05-11 19:59:58 +0200325};
326
327struct regmap *regmap_init(struct device *dev,
328 const struct regmap_bus *bus,
Stephen Warren0135bbc2012-04-04 15:48:30 -0600329 void *bus_context,
Mark Brownb83a3132011-05-11 19:59:58 +0200330 const struct regmap_config *config);
Michal Simek6cfec042014-02-10 16:22:33 +0100331int regmap_attach_dev(struct device *dev, struct regmap *map,
332 const struct regmap_config *config);
Mark Brown9943fa32011-06-20 19:02:29 +0100333struct regmap *regmap_init_i2c(struct i2c_client *i2c,
334 const struct regmap_config *config);
Mark Browna676f082011-05-12 11:42:10 +0200335struct regmap *regmap_init_spi(struct spi_device *dev,
336 const struct regmap_config *config);
Josh Cartwrightc9afbb02014-02-12 13:44:27 -0600337struct regmap *regmap_init_spmi_base(struct spmi_device *dev,
338 const struct regmap_config *config);
339struct regmap *regmap_init_spmi_ext(struct spmi_device *dev,
340 const struct regmap_config *config);
Philipp Zabel878ec672013-02-14 17:39:08 +0100341struct regmap *regmap_init_mmio_clk(struct device *dev, const char *clk_id,
342 void __iomem *regs,
343 const struct regmap_config *config);
Mark Brown22853222014-11-18 19:45:51 +0100344struct regmap *regmap_init_ac97(struct snd_ac97 *ac97,
345 const struct regmap_config *config);
Mark Browna676f082011-05-12 11:42:10 +0200346
Mark Brownc0eb4672012-01-30 19:56:52 +0000347struct regmap *devm_regmap_init(struct device *dev,
348 const struct regmap_bus *bus,
Stephen Warren0135bbc2012-04-04 15:48:30 -0600349 void *bus_context,
Mark Brownc0eb4672012-01-30 19:56:52 +0000350 const struct regmap_config *config);
351struct regmap *devm_regmap_init_i2c(struct i2c_client *i2c,
352 const struct regmap_config *config);
353struct regmap *devm_regmap_init_spi(struct spi_device *dev,
354 const struct regmap_config *config);
Josh Cartwrightc9afbb02014-02-12 13:44:27 -0600355struct regmap *devm_regmap_init_spmi_base(struct spmi_device *dev,
356 const struct regmap_config *config);
357struct regmap *devm_regmap_init_spmi_ext(struct spmi_device *dev,
358 const struct regmap_config *config);
Philipp Zabel878ec672013-02-14 17:39:08 +0100359struct regmap *devm_regmap_init_mmio_clk(struct device *dev, const char *clk_id,
360 void __iomem *regs,
361 const struct regmap_config *config);
Mark Brown22853222014-11-18 19:45:51 +0100362struct regmap *devm_regmap_init_ac97(struct snd_ac97 *ac97,
363 const struct regmap_config *config);
364
365bool regmap_ac97_default_volatile(struct device *dev, unsigned int reg);
Philipp Zabel878ec672013-02-14 17:39:08 +0100366
367/**
368 * regmap_init_mmio(): Initialise register map
369 *
370 * @dev: Device that will be interacted with
371 * @regs: Pointer to memory-mapped IO region
372 * @config: Configuration for register map
373 *
374 * The return value will be an ERR_PTR() on error or a valid pointer to
375 * a struct regmap.
376 */
377static inline struct regmap *regmap_init_mmio(struct device *dev,
378 void __iomem *regs,
379 const struct regmap_config *config)
380{
381 return regmap_init_mmio_clk(dev, NULL, regs, config);
382}
383
384/**
385 * devm_regmap_init_mmio(): Initialise managed register map
386 *
387 * @dev: Device that will be interacted with
388 * @regs: Pointer to memory-mapped IO region
389 * @config: Configuration for register map
390 *
391 * The return value will be an ERR_PTR() on error or a valid pointer
392 * to a struct regmap. The regmap will be automatically freed by the
393 * device management code.
394 */
395static inline struct regmap *devm_regmap_init_mmio(struct device *dev,
396 void __iomem *regs,
397 const struct regmap_config *config)
398{
399 return devm_regmap_init_mmio_clk(dev, NULL, regs, config);
400}
Mark Brownc0eb4672012-01-30 19:56:52 +0000401
Mark Brownb83a3132011-05-11 19:59:58 +0200402void regmap_exit(struct regmap *map);
Mark Brownbf315172011-12-03 17:06:20 +0000403int regmap_reinit_cache(struct regmap *map,
404 const struct regmap_config *config);
Mark Brown72b39f62012-05-08 17:44:40 +0100405struct regmap *dev_get_regmap(struct device *dev, const char *name);
Tuomas Tynkkynen8d7d3972014-07-21 18:38:47 +0300406struct device *regmap_get_device(struct regmap *map);
Mark Brownb83a3132011-05-11 19:59:58 +0200407int regmap_write(struct regmap *map, unsigned int reg, unsigned int val);
Mark Brown915f4412013-10-09 13:30:10 +0100408int regmap_write_async(struct regmap *map, unsigned int reg, unsigned int val);
Mark Brownb83a3132011-05-11 19:59:58 +0200409int regmap_raw_write(struct regmap *map, unsigned int reg,
410 const void *val, size_t val_len);
Laxman Dewangan8eaeb212012-02-12 19:49:43 +0530411int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
412 size_t val_count);
Charles Keepaxf7e2cec2014-02-25 13:45:49 +0000413int regmap_multi_reg_write(struct regmap *map, const struct reg_default *regs,
Anthony Oleche33fabd2013-10-11 15:31:11 +0100414 int num_regs);
Charles Keepax1d5b40b2014-02-25 13:45:50 +0000415int regmap_multi_reg_write_bypassed(struct regmap *map,
416 const struct reg_default *regs,
417 int num_regs);
Mark Brown0d509f22013-01-27 22:07:38 +0800418int regmap_raw_write_async(struct regmap *map, unsigned int reg,
419 const void *val, size_t val_len);
Mark Brownb83a3132011-05-11 19:59:58 +0200420int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val);
421int regmap_raw_read(struct regmap *map, unsigned int reg,
422 void *val, size_t val_len);
423int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
424 size_t val_count);
425int regmap_update_bits(struct regmap *map, unsigned int reg,
426 unsigned int mask, unsigned int val);
Mark Brown915f4412013-10-09 13:30:10 +0100427int regmap_update_bits_async(struct regmap *map, unsigned int reg,
428 unsigned int mask, unsigned int val);
Mark Brown018690d2011-11-29 20:10:36 +0000429int regmap_update_bits_check(struct regmap *map, unsigned int reg,
430 unsigned int mask, unsigned int val,
431 bool *change);
Mark Brown915f4412013-10-09 13:30:10 +0100432int regmap_update_bits_check_async(struct regmap *map, unsigned int reg,
433 unsigned int mask, unsigned int val,
434 bool *change);
Mark Browna6539c32012-02-17 14:20:14 -0800435int regmap_get_val_bytes(struct regmap *map);
Srinivas Kandagatla668abc72015-05-21 17:42:43 +0100436int regmap_get_max_register(struct regmap *map);
Srinivas Kandagatlaa2f776c2015-05-21 17:42:54 +0100437int regmap_get_reg_stride(struct regmap *map);
Mark Brown0d509f22013-01-27 22:07:38 +0800438int regmap_async_complete(struct regmap *map);
Mark Brown221ad7f2013-03-26 21:24:20 +0000439bool regmap_can_raw_write(struct regmap *map);
Mark Brownb83a3132011-05-11 19:59:58 +0200440
Mark Brown39a58432011-09-19 18:21:49 +0100441int regcache_sync(struct regmap *map);
Mark Brown4d4cfd12012-02-23 20:53:37 +0000442int regcache_sync_region(struct regmap *map, unsigned int min,
443 unsigned int max);
Mark Brown697e85b2013-05-08 13:55:22 +0100444int regcache_drop_region(struct regmap *map, unsigned int min,
445 unsigned int max);
Mark Brown92afb282011-09-19 18:22:14 +0100446void regcache_cache_only(struct regmap *map, bool enable);
Dimitris Papastamos6eb0f5e2011-09-29 14:36:27 +0100447void regcache_cache_bypass(struct regmap *map, bool enable);
Mark Brown8ae0d7e2011-10-26 10:34:22 +0200448void regcache_mark_dirty(struct regmap *map);
Mark Brown92afb282011-09-19 18:22:14 +0100449
Mark Brown154881e2013-05-08 13:55:23 +0100450bool regmap_check_range_table(struct regmap *map, unsigned int reg,
451 const struct regmap_access_table *table);
452
Mark Brown22f0d902012-01-21 12:01:14 +0000453int regmap_register_patch(struct regmap *map, const struct reg_default *regs,
454 int num_regs);
Nenghua Cao13ff50c2014-02-19 18:44:13 +0800455int regmap_parse_val(struct regmap *map, const void *buf,
456 unsigned int *val);
Mark Brown22f0d902012-01-21 12:01:14 +0000457
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100458static inline bool regmap_reg_in_range(unsigned int reg,
459 const struct regmap_range *range)
460{
461 return reg >= range->range_min && reg <= range->range_max;
462}
463
464bool regmap_reg_in_ranges(unsigned int reg,
465 const struct regmap_range *ranges,
466 unsigned int nranges);
467
Mark Brownf8beab22011-10-28 23:50:49 +0200468/**
Srinivas Kandagatla67252282013-06-11 13:18:15 +0100469 * Description of an register field
470 *
471 * @reg: Offset of the register within the regmap bank
472 * @lsb: lsb of the register field.
Bintian Wangf27b37f2015-01-27 20:50:29 +0800473 * @msb: msb of the register field.
Kuninori Morimotoa0102372013-09-01 20:30:50 -0700474 * @id_size: port size if it has some ports
475 * @id_offset: address offset for each ports
Srinivas Kandagatla67252282013-06-11 13:18:15 +0100476 */
477struct reg_field {
478 unsigned int reg;
479 unsigned int lsb;
480 unsigned int msb;
Kuninori Morimotoa0102372013-09-01 20:30:50 -0700481 unsigned int id_size;
482 unsigned int id_offset;
Srinivas Kandagatla67252282013-06-11 13:18:15 +0100483};
484
485#define REG_FIELD(_reg, _lsb, _msb) { \
486 .reg = _reg, \
487 .lsb = _lsb, \
488 .msb = _msb, \
489 }
490
491struct regmap_field *regmap_field_alloc(struct regmap *regmap,
492 struct reg_field reg_field);
493void regmap_field_free(struct regmap_field *field);
494
495struct regmap_field *devm_regmap_field_alloc(struct device *dev,
496 struct regmap *regmap, struct reg_field reg_field);
497void devm_regmap_field_free(struct device *dev, struct regmap_field *field);
498
499int regmap_field_read(struct regmap_field *field, unsigned int *val);
500int regmap_field_write(struct regmap_field *field, unsigned int val);
Kuninori Morimotofdf20022013-09-01 20:24:50 -0700501int regmap_field_update_bits(struct regmap_field *field,
502 unsigned int mask, unsigned int val);
Srinivas Kandagatla67252282013-06-11 13:18:15 +0100503
Kuninori Morimotoa0102372013-09-01 20:30:50 -0700504int regmap_fields_write(struct regmap_field *field, unsigned int id,
505 unsigned int val);
506int regmap_fields_read(struct regmap_field *field, unsigned int id,
507 unsigned int *val);
508int regmap_fields_update_bits(struct regmap_field *field, unsigned int id,
509 unsigned int mask, unsigned int val);
Srinivas Kandagatla67252282013-06-11 13:18:15 +0100510
511/**
Mark Brownf8beab22011-10-28 23:50:49 +0200512 * Description of an IRQ for the generic regmap irq_chip.
513 *
514 * @reg_offset: Offset of the status/mask register within the bank
515 * @mask: Mask used to flag/control the register.
516 */
517struct regmap_irq {
518 unsigned int reg_offset;
519 unsigned int mask;
520};
521
522/**
523 * Description of a generic regmap irq_chip. This is not intended to
524 * handle every possible interrupt controller, but it should handle a
525 * substantial proportion of those that are found in the wild.
526 *
527 * @name: Descriptive name for IRQ controller.
528 *
529 * @status_base: Base status register address.
530 * @mask_base: Base mask register address.
Alexander Shiyand3233432013-12-15 13:36:51 +0400531 * @ack_base: Base ack address. If zero then the chip is clear on read.
532 * Using zero value is possible with @use_ack bit.
Mark Browna43fd502012-06-05 14:34:03 +0100533 * @wake_base: Base address for wake enables. If zero unsupported.
Graeme Gregory022f926a2012-05-14 22:40:43 +0900534 * @irq_reg_stride: Stride to use for chips where registers are not contiguous.
Philipp Zabel2753e6f2013-07-22 17:15:52 +0200535 * @init_ack_masked: Ack all masked interrupts once during initalization.
Philipp Zabel68622bd2013-07-24 10:26:48 +0200536 * @mask_invert: Inverted mask register: cleared bits are masked out.
Alexander Shiyand3233432013-12-15 13:36:51 +0400537 * @use_ack: Use @ack register even if it is zero.
Philipp Zabel68622bd2013-07-24 10:26:48 +0200538 * @wake_invert: Inverted wake register: cleared bits are wake enabled.
Mark Brown0c00c502012-07-24 15:41:19 +0100539 * @runtime_pm: Hold a runtime PM lock on the device when accessing it.
Mark Brownf8beab22011-10-28 23:50:49 +0200540 *
541 * @num_regs: Number of registers in each control bank.
542 * @irqs: Descriptors for individual IRQs. Interrupt numbers are
543 * assigned based on the index in the array of the interrupt.
544 * @num_irqs: Number of descriptors.
545 */
546struct regmap_irq_chip {
547 const char *name;
548
549 unsigned int status_base;
550 unsigned int mask_base;
551 unsigned int ack_base;
Mark Browna43fd502012-06-05 14:34:03 +0100552 unsigned int wake_base;
Graeme Gregory022f926a2012-05-14 22:40:43 +0900553 unsigned int irq_reg_stride;
Philipp Zabelf484f7a2013-07-24 10:26:42 +0200554 bool init_ack_masked:1;
555 bool mask_invert:1;
Alexander Shiyand3233432013-12-15 13:36:51 +0400556 bool use_ack:1;
Philipp Zabelf484f7a2013-07-24 10:26:42 +0200557 bool wake_invert:1;
558 bool runtime_pm:1;
Mark Brownf8beab22011-10-28 23:50:49 +0200559
560 int num_regs;
561
562 const struct regmap_irq *irqs;
563 int num_irqs;
564};
565
566struct regmap_irq_chip_data;
567
568int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags,
Mark Brownb026ddb2012-05-31 21:01:46 +0100569 int irq_base, const struct regmap_irq_chip *chip,
Mark Brownf8beab22011-10-28 23:50:49 +0200570 struct regmap_irq_chip_data **data);
571void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data);
Mark Brown209a6002011-12-05 16:10:15 +0000572int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data);
Mark Brown4af8be62012-05-13 10:59:56 +0100573int regmap_irq_get_virq(struct regmap_irq_chip_data *data, int irq);
Mark Brown90f790d2012-08-20 21:45:05 +0100574struct irq_domain *regmap_irq_get_domain(struct regmap_irq_chip_data *data);
Mark Brownb83a3132011-05-11 19:59:58 +0200575
Mark Brown9cde5fc2012-02-17 14:49:51 -0800576#else
577
578/*
579 * These stubs should only ever be called by generic code which has
580 * regmap based facilities, if they ever get called at runtime
581 * something is going wrong and something probably needs to select
582 * REGMAP.
583 */
584
585static inline int regmap_write(struct regmap *map, unsigned int reg,
586 unsigned int val)
587{
588 WARN_ONCE(1, "regmap API is disabled");
589 return -EINVAL;
590}
591
Mark Brown915f4412013-10-09 13:30:10 +0100592static inline int regmap_write_async(struct regmap *map, unsigned int reg,
593 unsigned int val)
594{
595 WARN_ONCE(1, "regmap API is disabled");
596 return -EINVAL;
597}
598
Mark Brown9cde5fc2012-02-17 14:49:51 -0800599static inline int regmap_raw_write(struct regmap *map, unsigned int reg,
600 const void *val, size_t val_len)
601{
602 WARN_ONCE(1, "regmap API is disabled");
603 return -EINVAL;
604}
605
Mark Brown0d509f22013-01-27 22:07:38 +0800606static inline int regmap_raw_write_async(struct regmap *map, unsigned int reg,
607 const void *val, size_t val_len)
608{
609 WARN_ONCE(1, "regmap API is disabled");
610 return -EINVAL;
611}
612
Mark Brown9cde5fc2012-02-17 14:49:51 -0800613static inline int regmap_bulk_write(struct regmap *map, unsigned int reg,
614 const void *val, size_t val_count)
615{
616 WARN_ONCE(1, "regmap API is disabled");
617 return -EINVAL;
618}
619
620static inline int regmap_read(struct regmap *map, unsigned int reg,
621 unsigned int *val)
622{
623 WARN_ONCE(1, "regmap API is disabled");
624 return -EINVAL;
625}
626
627static inline int regmap_raw_read(struct regmap *map, unsigned int reg,
628 void *val, size_t val_len)
629{
630 WARN_ONCE(1, "regmap API is disabled");
631 return -EINVAL;
632}
633
634static inline int regmap_bulk_read(struct regmap *map, unsigned int reg,
635 void *val, size_t val_count)
636{
637 WARN_ONCE(1, "regmap API is disabled");
638 return -EINVAL;
639}
640
641static inline int regmap_update_bits(struct regmap *map, unsigned int reg,
642 unsigned int mask, unsigned int val)
643{
644 WARN_ONCE(1, "regmap API is disabled");
645 return -EINVAL;
646}
647
Mark Brown915f4412013-10-09 13:30:10 +0100648static inline int regmap_update_bits_async(struct regmap *map,
649 unsigned int reg,
650 unsigned int mask, unsigned int val)
651{
652 WARN_ONCE(1, "regmap API is disabled");
653 return -EINVAL;
654}
655
Mark Brown9cde5fc2012-02-17 14:49:51 -0800656static inline int regmap_update_bits_check(struct regmap *map,
657 unsigned int reg,
658 unsigned int mask, unsigned int val,
659 bool *change)
660{
661 WARN_ONCE(1, "regmap API is disabled");
662 return -EINVAL;
663}
664
Mark Brown915f4412013-10-09 13:30:10 +0100665static inline int regmap_update_bits_check_async(struct regmap *map,
666 unsigned int reg,
667 unsigned int mask,
668 unsigned int val,
669 bool *change)
670{
671 WARN_ONCE(1, "regmap API is disabled");
672 return -EINVAL;
673}
674
Mark Brown9cde5fc2012-02-17 14:49:51 -0800675static inline int regmap_get_val_bytes(struct regmap *map)
676{
677 WARN_ONCE(1, "regmap API is disabled");
678 return -EINVAL;
679}
680
Srinivas Kandagatla668abc72015-05-21 17:42:43 +0100681static inline int regmap_get_max_register(struct regmap *map)
682{
683 WARN_ONCE(1, "regmap API is disabled");
684 return -EINVAL;
685}
686
Srinivas Kandagatlaa2f776c2015-05-21 17:42:54 +0100687static inline int regmap_get_reg_stride(struct regmap *map)
688{
689 WARN_ONCE(1, "regmap API is disabled");
690 return -EINVAL;
691}
692
Mark Brown9cde5fc2012-02-17 14:49:51 -0800693static inline int regcache_sync(struct regmap *map)
694{
695 WARN_ONCE(1, "regmap API is disabled");
696 return -EINVAL;
697}
698
Mark Browna313f9f2012-02-23 19:49:43 +0000699static inline int regcache_sync_region(struct regmap *map, unsigned int min,
700 unsigned int max)
701{
702 WARN_ONCE(1, "regmap API is disabled");
703 return -EINVAL;
704}
705
Mark Brown697e85b2013-05-08 13:55:22 +0100706static inline int regcache_drop_region(struct regmap *map, unsigned int min,
707 unsigned int max)
708{
709 WARN_ONCE(1, "regmap API is disabled");
710 return -EINVAL;
711}
712
Mark Brown9cde5fc2012-02-17 14:49:51 -0800713static inline void regcache_cache_only(struct regmap *map, bool enable)
714{
715 WARN_ONCE(1, "regmap API is disabled");
716}
717
718static inline void regcache_cache_bypass(struct regmap *map, bool enable)
719{
720 WARN_ONCE(1, "regmap API is disabled");
721}
722
723static inline void regcache_mark_dirty(struct regmap *map)
724{
725 WARN_ONCE(1, "regmap API is disabled");
726}
727
Mark Brown0d509f22013-01-27 22:07:38 +0800728static inline void regmap_async_complete(struct regmap *map)
729{
730 WARN_ONCE(1, "regmap API is disabled");
731}
732
Mark Brown9cde5fc2012-02-17 14:49:51 -0800733static inline int regmap_register_patch(struct regmap *map,
734 const struct reg_default *regs,
735 int num_regs)
736{
737 WARN_ONCE(1, "regmap API is disabled");
738 return -EINVAL;
739}
740
Nenghua Cao13ff50c2014-02-19 18:44:13 +0800741static inline int regmap_parse_val(struct regmap *map, const void *buf,
742 unsigned int *val)
743{
744 WARN_ONCE(1, "regmap API is disabled");
745 return -EINVAL;
746}
747
Mark Brown72b39f62012-05-08 17:44:40 +0100748static inline struct regmap *dev_get_regmap(struct device *dev,
749 const char *name)
750{
Mark Brown72b39f62012-05-08 17:44:40 +0100751 return NULL;
752}
753
Tuomas Tynkkynen8d7d3972014-07-21 18:38:47 +0300754static inline struct device *regmap_get_device(struct regmap *map)
755{
756 WARN_ONCE(1, "regmap API is disabled");
Mark Brown1d33dc62014-07-25 19:01:53 +0100757 return NULL;
Tuomas Tynkkynen8d7d3972014-07-21 18:38:47 +0300758}
759
Mark Brown9cde5fc2012-02-17 14:49:51 -0800760#endif
761
Mark Brownb83a3132011-05-11 19:59:58 +0200762#endif