blob: 85691b9b4fa76a778db7f338874849c27d99d74c [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 Brown9943fa32011-06-20 19:02:29 +010030
Dimitris Papastamos9fabe242011-09-19 14:34:00 +010031/* An enum of all the supported cache types */
32enum regcache_type {
33 REGCACHE_NONE,
Dimitris Papastamos28644c802011-09-19 14:34:02 +010034 REGCACHE_RBTREE,
Mark Brown2ac902c2012-12-19 14:51:55 +000035 REGCACHE_COMPRESSED,
36 REGCACHE_FLAT,
Dimitris Papastamos9fabe242011-09-19 14:34:00 +010037};
38
Mark Browndd898b22011-07-20 22:28:58 +010039/**
Mark Brownbd20eb52011-08-19 18:09:38 +090040 * Default value for a register. We use an array of structs rather
41 * than a simple array as many modern devices have very sparse
42 * register maps.
43 *
44 * @reg: Register address.
45 * @def: Register default value.
46 */
47struct reg_default {
48 unsigned int reg;
49 unsigned int def;
50};
51
Mark Brownb83d2ff2012-03-11 11:49:17 +000052#ifdef CONFIG_REGMAP
53
Stephen Warren141eba22012-05-24 10:47:26 -060054enum regmap_endian {
55 /* Unspecified -> 0 -> Backwards compatible default */
56 REGMAP_ENDIAN_DEFAULT = 0,
57 REGMAP_ENDIAN_BIG,
58 REGMAP_ENDIAN_LITTLE,
59 REGMAP_ENDIAN_NATIVE,
60};
61
Davide Ciminaghi76aad392012-11-20 15:20:30 +010062/**
63 * A register range, used for access related checks
64 * (readable/writeable/volatile/precious checks)
65 *
66 * @range_min: address of first register
67 * @range_max: address of last register
68 */
69struct regmap_range {
70 unsigned int range_min;
71 unsigned int range_max;
72};
73
Laxman Dewangan6112fe62013-09-20 18:00:10 +053074#define regmap_reg_range(low, high) { .range_min = low, .range_max = high, }
75
Davide Ciminaghi76aad392012-11-20 15:20:30 +010076/*
77 * A table of ranges including some yes ranges and some no ranges.
78 * If a register belongs to a no_range, the corresponding check function
79 * will return false. If a register belongs to a yes range, the corresponding
80 * check function will return true. "no_ranges" are searched first.
81 *
82 * @yes_ranges : pointer to an array of regmap ranges used as "yes ranges"
83 * @n_yes_ranges: size of the above array
84 * @no_ranges: pointer to an array of regmap ranges used as "no ranges"
85 * @n_no_ranges: size of the above array
86 */
87struct regmap_access_table {
88 const struct regmap_range *yes_ranges;
89 unsigned int n_yes_ranges;
90 const struct regmap_range *no_ranges;
91 unsigned int n_no_ranges;
92};
93
Davide Ciminaghi0d4529c2012-10-16 15:56:59 +020094typedef void (*regmap_lock)(void *);
95typedef void (*regmap_unlock)(void *);
96
Mark Brownbd20eb52011-08-19 18:09:38 +090097/**
Mark Browndd898b22011-07-20 22:28:58 +010098 * Configuration for the register map of a device.
99 *
Stephen Warrend3c242e2012-04-04 15:48:29 -0600100 * @name: Optional name of the regmap. Useful when a device has multiple
101 * register regions.
102 *
Mark Browndd898b22011-07-20 22:28:58 +0100103 * @reg_bits: Number of bits in a register address, mandatory.
Stephen Warrenf01ee602012-04-09 13:40:24 -0600104 * @reg_stride: The register address stride. Valid register addresses are a
105 * multiple of this value. If set to 0, a value of 1 will be
106 * used.
Mark Brown82159ba2012-01-18 10:52:25 +0000107 * @pad_bits: Number of bits of padding between register and value.
Mark Browndd898b22011-07-20 22:28:58 +0100108 * @val_bits: Number of bits in a register value, mandatory.
Mark Brown2e2ae662011-07-20 22:33:39 +0100109 *
Mark Brown3566cc92011-08-09 10:23:22 +0900110 * @writeable_reg: Optional callback returning true if the register
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100111 * can be written to. If this field is NULL but wr_table
112 * (see below) is not, the check is performed on such table
113 * (a register is writeable if it belongs to one of the ranges
114 * specified by wr_table).
Mark Brown3566cc92011-08-09 10:23:22 +0900115 * @readable_reg: Optional callback returning true if the register
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100116 * can be read from. If this field is NULL but rd_table
117 * (see below) is not, the check is performed on such table
118 * (a register is readable if it belongs to one of the ranges
119 * specified by rd_table).
Mark Brown3566cc92011-08-09 10:23:22 +0900120 * @volatile_reg: Optional callback returning true if the register
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100121 * value can't be cached. If this field is NULL but
122 * volatile_table (see below) is not, the check is performed on
123 * such table (a register is volatile if it belongs to one of
124 * the ranges specified by volatile_table).
Laszlo Pappbdc39642014-01-09 14:13:41 +0000125 * @precious_reg: Optional callback returning true if the register
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100126 * should not be read outside of a call from the driver
Laszlo Pappbdc39642014-01-09 14:13:41 +0000127 * (e.g., a clear on read interrupt status register). If this
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100128 * field is NULL but precious_table (see below) is not, the
129 * check is performed on such table (a register is precious if
130 * it belongs to one of the ranges specified by precious_table).
131 * @lock: Optional lock callback (overrides regmap's default lock
132 * function, based on spinlock or mutex).
133 * @unlock: As above for unlocking.
134 * @lock_arg: this field is passed as the only argument of lock/unlock
135 * functions (ignored in case regular lock/unlock functions
136 * are not overridden).
Andrey Smirnovd2a58842013-01-27 10:49:05 -0800137 * @reg_read: Optional callback that if filled will be used to perform
138 * all the reads from the registers. Should only be provided for
Laszlo Pappbdc39642014-01-09 14:13:41 +0000139 * devices whose read operation cannot be represented as a simple
140 * read operation on a bus such as SPI, I2C, etc. Most of the
141 * devices do not need this.
Andrey Smirnovd2a58842013-01-27 10:49:05 -0800142 * @reg_write: Same as above for writing.
143 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
144 * to perform locking. This field is ignored if custom lock/unlock
145 * functions are used (see fields lock/unlock of struct regmap_config).
146 * This field is a duplicate of a similar file in
147 * 'struct regmap_bus' and serves exact same purpose.
148 * Use it only for "no-bus" cases.
Mark Brownbd20eb52011-08-19 18:09:38 +0900149 * @max_register: Optional, specifies the maximum valid register index.
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100150 * @wr_table: Optional, points to a struct regmap_access_table specifying
151 * valid ranges for write access.
152 * @rd_table: As above, for read access.
153 * @volatile_table: As above, for volatile registers.
154 * @precious_table: As above, for precious registers.
Mark Brownbd20eb52011-08-19 18:09:38 +0900155 * @reg_defaults: Power on reset values for registers (for use with
156 * register cache support).
157 * @num_reg_defaults: Number of elements in reg_defaults.
Lars-Peter Clausen6f306442011-09-05 20:46:32 +0200158 *
159 * @read_flag_mask: Mask to be set in the top byte of the register when doing
160 * a read.
161 * @write_flag_mask: Mask to be set in the top byte of the register when doing
162 * a write. If both read_flag_mask and write_flag_mask are
163 * empty the regmap_bus default masks are used.
Ashish Jangam2e33caf2012-04-30 23:23:40 +0100164 * @use_single_rw: If set, converts the bulk read and write operations into
165 * a series of single read and write operations. This is useful
166 * for device that does not support bulk read and write.
Opensource [Anthony Olech]e894c3f2014-03-04 13:54:02 +0000167 * @can_multi_write: If set, the device supports the multi write mode of bulk
168 * write operations, if clear multi write requests will be
169 * split into individual write operations
Dimitris Papastamos9fabe242011-09-19 14:34:00 +0100170 *
171 * @cache_type: The actual cache type.
172 * @reg_defaults_raw: Power on reset values for registers (for use with
173 * register cache support).
174 * @num_reg_defaults_raw: Number of elements in reg_defaults_raw.
Stephen Warren141eba22012-05-24 10:47:26 -0600175 * @reg_format_endian: Endianness for formatted register addresses. If this is
176 * DEFAULT, the @reg_format_endian_default value from the
177 * regmap bus is used.
178 * @val_format_endian: Endianness for formatted register values. If this is
179 * DEFAULT, the @reg_format_endian_default value from the
180 * regmap bus is used.
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100181 *
182 * @ranges: Array of configuration entries for virtual address ranges.
183 * @num_ranges: Number of range configuration entries.
Mark Browndd898b22011-07-20 22:28:58 +0100184 */
Mark Brownb83a3132011-05-11 19:59:58 +0200185struct regmap_config {
Stephen Warrend3c242e2012-04-04 15:48:29 -0600186 const char *name;
187
Mark Brownb83a3132011-05-11 19:59:58 +0200188 int reg_bits;
Stephen Warrenf01ee602012-04-09 13:40:24 -0600189 int reg_stride;
Mark Brown82159ba2012-01-18 10:52:25 +0000190 int pad_bits;
Mark Brownb83a3132011-05-11 19:59:58 +0200191 int val_bits;
Mark Brown2e2ae662011-07-20 22:33:39 +0100192
Mark Brown2e2ae662011-07-20 22:33:39 +0100193 bool (*writeable_reg)(struct device *dev, unsigned int reg);
194 bool (*readable_reg)(struct device *dev, unsigned int reg);
195 bool (*volatile_reg)(struct device *dev, unsigned int reg);
Mark Brown18694882011-08-08 15:40:22 +0900196 bool (*precious_reg)(struct device *dev, unsigned int reg);
Davide Ciminaghi0d4529c2012-10-16 15:56:59 +0200197 regmap_lock lock;
198 regmap_unlock unlock;
199 void *lock_arg;
Mark Brownbd20eb52011-08-19 18:09:38 +0900200
Andrey Smirnovd2a58842013-01-27 10:49:05 -0800201 int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
202 int (*reg_write)(void *context, unsigned int reg, unsigned int val);
203
204 bool fast_io;
205
Mark Brownbd20eb52011-08-19 18:09:38 +0900206 unsigned int max_register;
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100207 const struct regmap_access_table *wr_table;
208 const struct regmap_access_table *rd_table;
209 const struct regmap_access_table *volatile_table;
210 const struct regmap_access_table *precious_table;
Lars-Peter Clausen720e4612011-11-16 16:28:17 +0100211 const struct reg_default *reg_defaults;
Dimitris Papastamos9fabe242011-09-19 14:34:00 +0100212 unsigned int num_reg_defaults;
213 enum regcache_type cache_type;
214 const void *reg_defaults_raw;
215 unsigned int num_reg_defaults_raw;
Lars-Peter Clausen6f306442011-09-05 20:46:32 +0200216
217 u8 read_flag_mask;
218 u8 write_flag_mask;
Ashish Jangam2e33caf2012-04-30 23:23:40 +0100219
220 bool use_single_rw;
Opensource [Anthony Olech]e894c3f2014-03-04 13:54:02 +0000221 bool can_multi_write;
Stephen Warren141eba22012-05-24 10:47:26 -0600222
223 enum regmap_endian reg_format_endian;
224 enum regmap_endian val_format_endian;
Mark Brown38e23192012-07-22 19:26:07 +0100225
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100226 const struct regmap_range_cfg *ranges;
Mark Browne3549cd2012-10-02 20:17:15 +0100227 unsigned int num_ranges;
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100228};
229
230/**
231 * Configuration for indirectly accessed or paged registers.
232 * Registers, mapped to this virtual range, are accessed in two steps:
233 * 1. page selector register update;
234 * 2. access through data window registers.
235 *
Mark Brownd058bb42012-10-03 12:40:47 +0100236 * @name: Descriptive name for diagnostics
237 *
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100238 * @range_min: Address of the lowest register address in virtual range.
239 * @range_max: Address of the highest register in virtual range.
240 *
241 * @page_sel_reg: Register with selector field.
242 * @page_sel_mask: Bit shift for selector value.
243 * @page_sel_shift: Bit mask for selector value.
244 *
245 * @window_start: Address of first (lowest) register in data window.
246 * @window_len: Number of registers in data window.
247 */
248struct regmap_range_cfg {
Mark Brownd058bb42012-10-03 12:40:47 +0100249 const char *name;
250
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100251 /* Registers of virtual address range */
252 unsigned int range_min;
253 unsigned int range_max;
254
255 /* Page selector for indirect addressing */
256 unsigned int selector_reg;
257 unsigned int selector_mask;
258 int selector_shift;
259
260 /* Data window (per each page) */
261 unsigned int window_start;
262 unsigned int window_len;
Mark Brownb83a3132011-05-11 19:59:58 +0200263};
264
Mark Brown0d509f22013-01-27 22:07:38 +0800265struct regmap_async;
266
Stephen Warren0135bbc2012-04-04 15:48:30 -0600267typedef int (*regmap_hw_write)(void *context, const void *data,
Mark Brownb83a3132011-05-11 19:59:58 +0200268 size_t count);
Stephen Warren0135bbc2012-04-04 15:48:30 -0600269typedef int (*regmap_hw_gather_write)(void *context,
Mark Brownb83a3132011-05-11 19:59:58 +0200270 const void *reg, size_t reg_len,
271 const void *val, size_t val_len);
Mark Brown0d509f22013-01-27 22:07:38 +0800272typedef int (*regmap_hw_async_write)(void *context,
273 const void *reg, size_t reg_len,
274 const void *val, size_t val_len,
275 struct regmap_async *async);
Stephen Warren0135bbc2012-04-04 15:48:30 -0600276typedef int (*regmap_hw_read)(void *context,
Mark Brownb83a3132011-05-11 19:59:58 +0200277 const void *reg_buf, size_t reg_size,
278 void *val_buf, size_t val_size);
Mark Brown0d509f22013-01-27 22:07:38 +0800279typedef struct regmap_async *(*regmap_hw_async_alloc)(void);
Stephen Warren0135bbc2012-04-04 15:48:30 -0600280typedef void (*regmap_hw_free_context)(void *context);
Mark Brownb83a3132011-05-11 19:59:58 +0200281
282/**
283 * Description of a hardware bus for the register map infrastructure.
284 *
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600285 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
Davide Ciminaghi0d4529c2012-10-16 15:56:59 +0200286 * to perform locking. This field is ignored if custom lock/unlock
287 * functions are used (see fields lock/unlock of
288 * struct regmap_config).
Mark Brownb83a3132011-05-11 19:59:58 +0200289 * @write: Write operation.
290 * @gather_write: Write operation with split register/value, return -ENOTSUPP
291 * if not implemented on a given device.
Mark Brown0d509f22013-01-27 22:07:38 +0800292 * @async_write: Write operation which completes asynchronously, optional and
293 * must serialise with respect to non-async I/O.
Mark Brownb83a3132011-05-11 19:59:58 +0200294 * @read: Read operation. Data is returned in the buffer used to transmit
295 * data.
Mark Brown0d509f22013-01-27 22:07:38 +0800296 * @async_alloc: Allocate a regmap_async() structure.
Mark Brownb83a3132011-05-11 19:59:58 +0200297 * @read_flag_mask: Mask to be set in the top byte of the register when doing
298 * a read.
Stephen Warren141eba22012-05-24 10:47:26 -0600299 * @reg_format_endian_default: Default endianness for formatted register
300 * addresses. Used when the regmap_config specifies DEFAULT. If this is
301 * DEFAULT, BIG is assumed.
302 * @val_format_endian_default: Default endianness for formatted register
303 * values. Used when the regmap_config specifies DEFAULT. If this is
304 * DEFAULT, BIG is assumed.
Mark Brown0d509f22013-01-27 22:07:38 +0800305 * @async_size: Size of struct used for async work.
Mark Brownb83a3132011-05-11 19:59:58 +0200306 */
307struct regmap_bus {
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600308 bool fast_io;
Mark Brownb83a3132011-05-11 19:59:58 +0200309 regmap_hw_write write;
310 regmap_hw_gather_write gather_write;
Mark Brown0d509f22013-01-27 22:07:38 +0800311 regmap_hw_async_write async_write;
Mark Brownb83a3132011-05-11 19:59:58 +0200312 regmap_hw_read read;
Stephen Warren0135bbc2012-04-04 15:48:30 -0600313 regmap_hw_free_context free_context;
Mark Brown0d509f22013-01-27 22:07:38 +0800314 regmap_hw_async_alloc async_alloc;
Mark Brownb83a3132011-05-11 19:59:58 +0200315 u8 read_flag_mask;
Stephen Warren141eba22012-05-24 10:47:26 -0600316 enum regmap_endian reg_format_endian_default;
317 enum regmap_endian val_format_endian_default;
Mark Brownb83a3132011-05-11 19:59:58 +0200318};
319
320struct regmap *regmap_init(struct device *dev,
321 const struct regmap_bus *bus,
Stephen Warren0135bbc2012-04-04 15:48:30 -0600322 void *bus_context,
Mark Brownb83a3132011-05-11 19:59:58 +0200323 const struct regmap_config *config);
Michal Simek6cfec042014-02-10 16:22:33 +0100324int regmap_attach_dev(struct device *dev, struct regmap *map,
325 const struct regmap_config *config);
Mark Brown9943fa32011-06-20 19:02:29 +0100326struct regmap *regmap_init_i2c(struct i2c_client *i2c,
327 const struct regmap_config *config);
Mark Browna676f082011-05-12 11:42:10 +0200328struct regmap *regmap_init_spi(struct spi_device *dev,
329 const struct regmap_config *config);
Josh Cartwrightc9afbb02014-02-12 13:44:27 -0600330struct regmap *regmap_init_spmi_base(struct spmi_device *dev,
331 const struct regmap_config *config);
332struct regmap *regmap_init_spmi_ext(struct spmi_device *dev,
333 const struct regmap_config *config);
Philipp Zabel878ec672013-02-14 17:39:08 +0100334struct regmap *regmap_init_mmio_clk(struct device *dev, const char *clk_id,
335 void __iomem *regs,
336 const struct regmap_config *config);
Mark Browna676f082011-05-12 11:42:10 +0200337
Mark Brownc0eb4672012-01-30 19:56:52 +0000338struct regmap *devm_regmap_init(struct device *dev,
339 const struct regmap_bus *bus,
Stephen Warren0135bbc2012-04-04 15:48:30 -0600340 void *bus_context,
Mark Brownc0eb4672012-01-30 19:56:52 +0000341 const struct regmap_config *config);
342struct regmap *devm_regmap_init_i2c(struct i2c_client *i2c,
343 const struct regmap_config *config);
344struct regmap *devm_regmap_init_spi(struct spi_device *dev,
345 const struct regmap_config *config);
Josh Cartwrightc9afbb02014-02-12 13:44:27 -0600346struct regmap *devm_regmap_init_spmi_base(struct spmi_device *dev,
347 const struct regmap_config *config);
348struct regmap *devm_regmap_init_spmi_ext(struct spmi_device *dev,
349 const struct regmap_config *config);
Philipp Zabel878ec672013-02-14 17:39:08 +0100350struct regmap *devm_regmap_init_mmio_clk(struct device *dev, const char *clk_id,
351 void __iomem *regs,
352 const struct regmap_config *config);
353
354/**
355 * regmap_init_mmio(): Initialise register map
356 *
357 * @dev: Device that will be interacted with
358 * @regs: Pointer to memory-mapped IO region
359 * @config: Configuration for register map
360 *
361 * The return value will be an ERR_PTR() on error or a valid pointer to
362 * a struct regmap.
363 */
364static inline struct regmap *regmap_init_mmio(struct device *dev,
365 void __iomem *regs,
366 const struct regmap_config *config)
367{
368 return regmap_init_mmio_clk(dev, NULL, regs, config);
369}
370
371/**
372 * devm_regmap_init_mmio(): Initialise managed register map
373 *
374 * @dev: Device that will be interacted with
375 * @regs: Pointer to memory-mapped IO region
376 * @config: Configuration for register map
377 *
378 * The return value will be an ERR_PTR() on error or a valid pointer
379 * to a struct regmap. The regmap will be automatically freed by the
380 * device management code.
381 */
382static inline struct regmap *devm_regmap_init_mmio(struct device *dev,
383 void __iomem *regs,
384 const struct regmap_config *config)
385{
386 return devm_regmap_init_mmio_clk(dev, NULL, regs, config);
387}
Mark Brownc0eb4672012-01-30 19:56:52 +0000388
Mark Brownb83a3132011-05-11 19:59:58 +0200389void regmap_exit(struct regmap *map);
Mark Brownbf315172011-12-03 17:06:20 +0000390int regmap_reinit_cache(struct regmap *map,
391 const struct regmap_config *config);
Mark Brown72b39f62012-05-08 17:44:40 +0100392struct regmap *dev_get_regmap(struct device *dev, const char *name);
Mark Brownb83a3132011-05-11 19:59:58 +0200393int regmap_write(struct regmap *map, unsigned int reg, unsigned int val);
Mark Brown915f4412013-10-09 13:30:10 +0100394int regmap_write_async(struct regmap *map, unsigned int reg, unsigned int val);
Mark Brownb83a3132011-05-11 19:59:58 +0200395int regmap_raw_write(struct regmap *map, unsigned int reg,
396 const void *val, size_t val_len);
Laxman Dewangan8eaeb212012-02-12 19:49:43 +0530397int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
398 size_t val_count);
Charles Keepaxf7e2cec2014-02-25 13:45:49 +0000399int regmap_multi_reg_write(struct regmap *map, const struct reg_default *regs,
Anthony Oleche33fabd2013-10-11 15:31:11 +0100400 int num_regs);
Charles Keepax1d5b40b2014-02-25 13:45:50 +0000401int regmap_multi_reg_write_bypassed(struct regmap *map,
402 const struct reg_default *regs,
403 int num_regs);
Mark Brown0d509f22013-01-27 22:07:38 +0800404int regmap_raw_write_async(struct regmap *map, unsigned int reg,
405 const void *val, size_t val_len);
Mark Brownb83a3132011-05-11 19:59:58 +0200406int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val);
407int regmap_raw_read(struct regmap *map, unsigned int reg,
408 void *val, size_t val_len);
409int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
410 size_t val_count);
411int regmap_update_bits(struct regmap *map, unsigned int reg,
412 unsigned int mask, unsigned int val);
Mark Brown915f4412013-10-09 13:30:10 +0100413int regmap_update_bits_async(struct regmap *map, unsigned int reg,
414 unsigned int mask, unsigned int val);
Mark Brown018690d2011-11-29 20:10:36 +0000415int regmap_update_bits_check(struct regmap *map, unsigned int reg,
416 unsigned int mask, unsigned int val,
417 bool *change);
Mark Brown915f4412013-10-09 13:30:10 +0100418int regmap_update_bits_check_async(struct regmap *map, unsigned int reg,
419 unsigned int mask, unsigned int val,
420 bool *change);
Mark Browna6539c32012-02-17 14:20:14 -0800421int regmap_get_val_bytes(struct regmap *map);
Mark Brown0d509f22013-01-27 22:07:38 +0800422int regmap_async_complete(struct regmap *map);
Mark Brown221ad7f2013-03-26 21:24:20 +0000423bool regmap_can_raw_write(struct regmap *map);
Mark Brownb83a3132011-05-11 19:59:58 +0200424
Mark Brown39a58432011-09-19 18:21:49 +0100425int regcache_sync(struct regmap *map);
Mark Brown4d4cfd12012-02-23 20:53:37 +0000426int regcache_sync_region(struct regmap *map, unsigned int min,
427 unsigned int max);
Mark Brown697e85b2013-05-08 13:55:22 +0100428int regcache_drop_region(struct regmap *map, unsigned int min,
429 unsigned int max);
Mark Brown92afb282011-09-19 18:22:14 +0100430void regcache_cache_only(struct regmap *map, bool enable);
Dimitris Papastamos6eb0f5e2011-09-29 14:36:27 +0100431void regcache_cache_bypass(struct regmap *map, bool enable);
Mark Brown8ae0d7e2011-10-26 10:34:22 +0200432void regcache_mark_dirty(struct regmap *map);
Mark Brown92afb282011-09-19 18:22:14 +0100433
Mark Brown154881e2013-05-08 13:55:23 +0100434bool regmap_check_range_table(struct regmap *map, unsigned int reg,
435 const struct regmap_access_table *table);
436
Mark Brown22f0d902012-01-21 12:01:14 +0000437int regmap_register_patch(struct regmap *map, const struct reg_default *regs,
438 int num_regs);
Nenghua Cao13ff50c2014-02-19 18:44:13 +0800439int regmap_parse_val(struct regmap *map, const void *buf,
440 unsigned int *val);
Mark Brown22f0d902012-01-21 12:01:14 +0000441
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100442static inline bool regmap_reg_in_range(unsigned int reg,
443 const struct regmap_range *range)
444{
445 return reg >= range->range_min && reg <= range->range_max;
446}
447
448bool regmap_reg_in_ranges(unsigned int reg,
449 const struct regmap_range *ranges,
450 unsigned int nranges);
451
Mark Brownf8beab22011-10-28 23:50:49 +0200452/**
Srinivas Kandagatla67252282013-06-11 13:18:15 +0100453 * Description of an register field
454 *
455 * @reg: Offset of the register within the regmap bank
456 * @lsb: lsb of the register field.
457 * @reg: msb of the register field.
Kuninori Morimotoa0102372013-09-01 20:30:50 -0700458 * @id_size: port size if it has some ports
459 * @id_offset: address offset for each ports
Srinivas Kandagatla67252282013-06-11 13:18:15 +0100460 */
461struct reg_field {
462 unsigned int reg;
463 unsigned int lsb;
464 unsigned int msb;
Kuninori Morimotoa0102372013-09-01 20:30:50 -0700465 unsigned int id_size;
466 unsigned int id_offset;
Srinivas Kandagatla67252282013-06-11 13:18:15 +0100467};
468
469#define REG_FIELD(_reg, _lsb, _msb) { \
470 .reg = _reg, \
471 .lsb = _lsb, \
472 .msb = _msb, \
473 }
474
475struct regmap_field *regmap_field_alloc(struct regmap *regmap,
476 struct reg_field reg_field);
477void regmap_field_free(struct regmap_field *field);
478
479struct regmap_field *devm_regmap_field_alloc(struct device *dev,
480 struct regmap *regmap, struct reg_field reg_field);
481void devm_regmap_field_free(struct device *dev, struct regmap_field *field);
482
483int regmap_field_read(struct regmap_field *field, unsigned int *val);
484int regmap_field_write(struct regmap_field *field, unsigned int val);
Kuninori Morimotofdf20022013-09-01 20:24:50 -0700485int regmap_field_update_bits(struct regmap_field *field,
486 unsigned int mask, unsigned int val);
Srinivas Kandagatla67252282013-06-11 13:18:15 +0100487
Kuninori Morimotoa0102372013-09-01 20:30:50 -0700488int regmap_fields_write(struct regmap_field *field, unsigned int id,
489 unsigned int val);
490int regmap_fields_read(struct regmap_field *field, unsigned int id,
491 unsigned int *val);
492int regmap_fields_update_bits(struct regmap_field *field, unsigned int id,
493 unsigned int mask, unsigned int val);
Srinivas Kandagatla67252282013-06-11 13:18:15 +0100494
495/**
Mark Brownf8beab22011-10-28 23:50:49 +0200496 * Description of an IRQ for the generic regmap irq_chip.
497 *
498 * @reg_offset: Offset of the status/mask register within the bank
499 * @mask: Mask used to flag/control the register.
500 */
501struct regmap_irq {
502 unsigned int reg_offset;
503 unsigned int mask;
504};
505
506/**
507 * Description of a generic regmap irq_chip. This is not intended to
508 * handle every possible interrupt controller, but it should handle a
509 * substantial proportion of those that are found in the wild.
510 *
511 * @name: Descriptive name for IRQ controller.
512 *
513 * @status_base: Base status register address.
514 * @mask_base: Base mask register address.
Alexander Shiyand3233432013-12-15 13:36:51 +0400515 * @ack_base: Base ack address. If zero then the chip is clear on read.
516 * Using zero value is possible with @use_ack bit.
Mark Browna43fd502012-06-05 14:34:03 +0100517 * @wake_base: Base address for wake enables. If zero unsupported.
Graeme Gregory022f926a2012-05-14 22:40:43 +0900518 * @irq_reg_stride: Stride to use for chips where registers are not contiguous.
Philipp Zabel2753e6f2013-07-22 17:15:52 +0200519 * @init_ack_masked: Ack all masked interrupts once during initalization.
Philipp Zabel68622bd2013-07-24 10:26:48 +0200520 * @mask_invert: Inverted mask register: cleared bits are masked out.
Alexander Shiyand3233432013-12-15 13:36:51 +0400521 * @use_ack: Use @ack register even if it is zero.
Philipp Zabel68622bd2013-07-24 10:26:48 +0200522 * @wake_invert: Inverted wake register: cleared bits are wake enabled.
Mark Brown0c00c502012-07-24 15:41:19 +0100523 * @runtime_pm: Hold a runtime PM lock on the device when accessing it.
Mark Brownf8beab22011-10-28 23:50:49 +0200524 *
525 * @num_regs: Number of registers in each control bank.
526 * @irqs: Descriptors for individual IRQs. Interrupt numbers are
527 * assigned based on the index in the array of the interrupt.
528 * @num_irqs: Number of descriptors.
529 */
530struct regmap_irq_chip {
531 const char *name;
532
533 unsigned int status_base;
534 unsigned int mask_base;
535 unsigned int ack_base;
Mark Browna43fd502012-06-05 14:34:03 +0100536 unsigned int wake_base;
Graeme Gregory022f926a2012-05-14 22:40:43 +0900537 unsigned int irq_reg_stride;
Philipp Zabelf484f7a2013-07-24 10:26:42 +0200538 bool init_ack_masked:1;
539 bool mask_invert:1;
Alexander Shiyand3233432013-12-15 13:36:51 +0400540 bool use_ack:1;
Philipp Zabelf484f7a2013-07-24 10:26:42 +0200541 bool wake_invert:1;
542 bool runtime_pm:1;
Mark Brownf8beab22011-10-28 23:50:49 +0200543
544 int num_regs;
545
546 const struct regmap_irq *irqs;
547 int num_irqs;
548};
549
550struct regmap_irq_chip_data;
551
552int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags,
Mark Brownb026ddb2012-05-31 21:01:46 +0100553 int irq_base, const struct regmap_irq_chip *chip,
Mark Brownf8beab22011-10-28 23:50:49 +0200554 struct regmap_irq_chip_data **data);
555void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data);
Mark Brown209a6002011-12-05 16:10:15 +0000556int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data);
Mark Brown4af8be62012-05-13 10:59:56 +0100557int regmap_irq_get_virq(struct regmap_irq_chip_data *data, int irq);
Mark Brown90f790d2012-08-20 21:45:05 +0100558struct irq_domain *regmap_irq_get_domain(struct regmap_irq_chip_data *data);
Mark Brownb83a3132011-05-11 19:59:58 +0200559
Mark Brown9cde5fc2012-02-17 14:49:51 -0800560#else
561
562/*
563 * These stubs should only ever be called by generic code which has
564 * regmap based facilities, if they ever get called at runtime
565 * something is going wrong and something probably needs to select
566 * REGMAP.
567 */
568
569static inline int regmap_write(struct regmap *map, unsigned int reg,
570 unsigned int val)
571{
572 WARN_ONCE(1, "regmap API is disabled");
573 return -EINVAL;
574}
575
Mark Brown915f4412013-10-09 13:30:10 +0100576static inline int regmap_write_async(struct regmap *map, unsigned int reg,
577 unsigned int val)
578{
579 WARN_ONCE(1, "regmap API is disabled");
580 return -EINVAL;
581}
582
Mark Brown9cde5fc2012-02-17 14:49:51 -0800583static inline int regmap_raw_write(struct regmap *map, unsigned int reg,
584 const void *val, size_t val_len)
585{
586 WARN_ONCE(1, "regmap API is disabled");
587 return -EINVAL;
588}
589
Mark Brown0d509f22013-01-27 22:07:38 +0800590static inline int regmap_raw_write_async(struct regmap *map, unsigned int reg,
591 const void *val, size_t val_len)
592{
593 WARN_ONCE(1, "regmap API is disabled");
594 return -EINVAL;
595}
596
Mark Brown9cde5fc2012-02-17 14:49:51 -0800597static inline int regmap_bulk_write(struct regmap *map, unsigned int reg,
598 const void *val, size_t val_count)
599{
600 WARN_ONCE(1, "regmap API is disabled");
601 return -EINVAL;
602}
603
604static inline int regmap_read(struct regmap *map, unsigned int reg,
605 unsigned int *val)
606{
607 WARN_ONCE(1, "regmap API is disabled");
608 return -EINVAL;
609}
610
611static inline int regmap_raw_read(struct regmap *map, unsigned int reg,
612 void *val, size_t val_len)
613{
614 WARN_ONCE(1, "regmap API is disabled");
615 return -EINVAL;
616}
617
618static inline int regmap_bulk_read(struct regmap *map, unsigned int reg,
619 void *val, size_t val_count)
620{
621 WARN_ONCE(1, "regmap API is disabled");
622 return -EINVAL;
623}
624
625static inline int regmap_update_bits(struct regmap *map, unsigned int reg,
626 unsigned int mask, unsigned int val)
627{
628 WARN_ONCE(1, "regmap API is disabled");
629 return -EINVAL;
630}
631
Mark Brown915f4412013-10-09 13:30:10 +0100632static inline int regmap_update_bits_async(struct regmap *map,
633 unsigned int reg,
634 unsigned int mask, unsigned int val)
635{
636 WARN_ONCE(1, "regmap API is disabled");
637 return -EINVAL;
638}
639
Mark Brown9cde5fc2012-02-17 14:49:51 -0800640static inline int regmap_update_bits_check(struct regmap *map,
641 unsigned int reg,
642 unsigned int mask, unsigned int val,
643 bool *change)
644{
645 WARN_ONCE(1, "regmap API is disabled");
646 return -EINVAL;
647}
648
Mark Brown915f4412013-10-09 13:30:10 +0100649static inline int regmap_update_bits_check_async(struct regmap *map,
650 unsigned int reg,
651 unsigned int mask,
652 unsigned int val,
653 bool *change)
654{
655 WARN_ONCE(1, "regmap API is disabled");
656 return -EINVAL;
657}
658
Mark Brown9cde5fc2012-02-17 14:49:51 -0800659static inline int regmap_get_val_bytes(struct regmap *map)
660{
661 WARN_ONCE(1, "regmap API is disabled");
662 return -EINVAL;
663}
664
665static inline int regcache_sync(struct regmap *map)
666{
667 WARN_ONCE(1, "regmap API is disabled");
668 return -EINVAL;
669}
670
Mark Browna313f9f2012-02-23 19:49:43 +0000671static inline int regcache_sync_region(struct regmap *map, unsigned int min,
672 unsigned int max)
673{
674 WARN_ONCE(1, "regmap API is disabled");
675 return -EINVAL;
676}
677
Mark Brown697e85b2013-05-08 13:55:22 +0100678static inline int regcache_drop_region(struct regmap *map, unsigned int min,
679 unsigned int max)
680{
681 WARN_ONCE(1, "regmap API is disabled");
682 return -EINVAL;
683}
684
Mark Brown9cde5fc2012-02-17 14:49:51 -0800685static inline void regcache_cache_only(struct regmap *map, bool enable)
686{
687 WARN_ONCE(1, "regmap API is disabled");
688}
689
690static inline void regcache_cache_bypass(struct regmap *map, bool enable)
691{
692 WARN_ONCE(1, "regmap API is disabled");
693}
694
695static inline void regcache_mark_dirty(struct regmap *map)
696{
697 WARN_ONCE(1, "regmap API is disabled");
698}
699
Mark Brown0d509f22013-01-27 22:07:38 +0800700static inline void regmap_async_complete(struct regmap *map)
701{
702 WARN_ONCE(1, "regmap API is disabled");
703}
704
Mark Brown9cde5fc2012-02-17 14:49:51 -0800705static inline int regmap_register_patch(struct regmap *map,
706 const struct reg_default *regs,
707 int num_regs)
708{
709 WARN_ONCE(1, "regmap API is disabled");
710 return -EINVAL;
711}
712
Nenghua Cao13ff50c2014-02-19 18:44:13 +0800713static inline int regmap_parse_val(struct regmap *map, const void *buf,
714 unsigned int *val)
715{
716 WARN_ONCE(1, "regmap API is disabled");
717 return -EINVAL;
718}
719
Mark Brown72b39f62012-05-08 17:44:40 +0100720static inline struct regmap *dev_get_regmap(struct device *dev,
721 const char *name)
722{
Mark Brown72b39f62012-05-08 17:44:40 +0100723 return NULL;
724}
725
Mark Brown9cde5fc2012-02-17 14:49:51 -0800726#endif
727
Mark Brownb83a3132011-05-11 19:59:58 +0200728#endif