blob: eebea9b5f43e15498f553aa38e28ca050e28504c [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>
Mark Brownb83a3132011-05-11 19:59:58 +020018
Paul Gortmakerde477252011-05-26 13:46:22 -040019struct module;
Paul Gortmaker313162d2012-01-30 11:46:54 -050020struct device;
Mark Brown9943fa32011-06-20 19:02:29 +010021struct i2c_client;
Mark Brown90f790d2012-08-20 21:45:05 +010022struct irq_domain;
Mark Browna676f082011-05-12 11:42:10 +020023struct spi_device;
Mark Brownb83d2ff2012-03-11 11:49:17 +000024struct regmap;
Krystian Garbaciak6863ca62012-06-15 11:23:56 +010025struct regmap_range_cfg;
Srinivas Kandagatla67252282013-06-11 13:18:15 +010026struct regmap_field;
Mark Brown9943fa32011-06-20 19:02:29 +010027
Dimitris Papastamos9fabe242011-09-19 14:34:00 +010028/* An enum of all the supported cache types */
29enum regcache_type {
30 REGCACHE_NONE,
Dimitris Papastamos28644c802011-09-19 14:34:02 +010031 REGCACHE_RBTREE,
Mark Brown2ac902c2012-12-19 14:51:55 +000032 REGCACHE_COMPRESSED,
33 REGCACHE_FLAT,
Dimitris Papastamos9fabe242011-09-19 14:34:00 +010034};
35
Mark Browndd898b22011-07-20 22:28:58 +010036/**
Mark Brownbd20eb52011-08-19 18:09:38 +090037 * Default value for a register. We use an array of structs rather
38 * than a simple array as many modern devices have very sparse
39 * register maps.
40 *
41 * @reg: Register address.
42 * @def: Register default value.
43 */
44struct reg_default {
45 unsigned int reg;
46 unsigned int def;
47};
48
Mark Brownb83d2ff2012-03-11 11:49:17 +000049#ifdef CONFIG_REGMAP
50
Stephen Warren141eba22012-05-24 10:47:26 -060051enum regmap_endian {
52 /* Unspecified -> 0 -> Backwards compatible default */
53 REGMAP_ENDIAN_DEFAULT = 0,
54 REGMAP_ENDIAN_BIG,
55 REGMAP_ENDIAN_LITTLE,
56 REGMAP_ENDIAN_NATIVE,
57};
58
Davide Ciminaghi76aad392012-11-20 15:20:30 +010059/**
60 * A register range, used for access related checks
61 * (readable/writeable/volatile/precious checks)
62 *
63 * @range_min: address of first register
64 * @range_max: address of last register
65 */
66struct regmap_range {
67 unsigned int range_min;
68 unsigned int range_max;
69};
70
71/*
72 * A table of ranges including some yes ranges and some no ranges.
73 * If a register belongs to a no_range, the corresponding check function
74 * will return false. If a register belongs to a yes range, the corresponding
75 * check function will return true. "no_ranges" are searched first.
76 *
77 * @yes_ranges : pointer to an array of regmap ranges used as "yes ranges"
78 * @n_yes_ranges: size of the above array
79 * @no_ranges: pointer to an array of regmap ranges used as "no ranges"
80 * @n_no_ranges: size of the above array
81 */
82struct regmap_access_table {
83 const struct regmap_range *yes_ranges;
84 unsigned int n_yes_ranges;
85 const struct regmap_range *no_ranges;
86 unsigned int n_no_ranges;
87};
88
Davide Ciminaghi0d4529c2012-10-16 15:56:59 +020089typedef void (*regmap_lock)(void *);
90typedef void (*regmap_unlock)(void *);
91
Mark Brownbd20eb52011-08-19 18:09:38 +090092/**
Mark Browndd898b22011-07-20 22:28:58 +010093 * Configuration for the register map of a device.
94 *
Stephen Warrend3c242e2012-04-04 15:48:29 -060095 * @name: Optional name of the regmap. Useful when a device has multiple
96 * register regions.
97 *
Mark Browndd898b22011-07-20 22:28:58 +010098 * @reg_bits: Number of bits in a register address, mandatory.
Stephen Warrenf01ee602012-04-09 13:40:24 -060099 * @reg_stride: The register address stride. Valid register addresses are a
100 * multiple of this value. If set to 0, a value of 1 will be
101 * used.
Mark Brown82159ba2012-01-18 10:52:25 +0000102 * @pad_bits: Number of bits of padding between register and value.
Mark Browndd898b22011-07-20 22:28:58 +0100103 * @val_bits: Number of bits in a register value, mandatory.
Mark Brown2e2ae662011-07-20 22:33:39 +0100104 *
Mark Brown3566cc92011-08-09 10:23:22 +0900105 * @writeable_reg: Optional callback returning true if the register
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100106 * can be written to. If this field is NULL but wr_table
107 * (see below) is not, the check is performed on such table
108 * (a register is writeable if it belongs to one of the ranges
109 * specified by wr_table).
Mark Brown3566cc92011-08-09 10:23:22 +0900110 * @readable_reg: Optional callback returning true if the register
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100111 * can be read from. If this field is NULL but rd_table
112 * (see below) is not, the check is performed on such table
113 * (a register is readable if it belongs to one of the ranges
114 * specified by rd_table).
Mark Brown3566cc92011-08-09 10:23:22 +0900115 * @volatile_reg: Optional callback returning true if the register
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100116 * value can't be cached. If this field is NULL but
117 * volatile_table (see below) is not, the check is performed on
118 * such table (a register is volatile if it belongs to one of
119 * the ranges specified by volatile_table).
Mark Brown3566cc92011-08-09 10:23:22 +0900120 * @precious_reg: Optional callback returning true if the rgister
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100121 * should not be read outside of a call from the driver
122 * (eg, a clear on read interrupt status register). If this
123 * field is NULL but precious_table (see below) is not, the
124 * check is performed on such table (a register is precious if
125 * it belongs to one of the ranges specified by precious_table).
126 * @lock: Optional lock callback (overrides regmap's default lock
127 * function, based on spinlock or mutex).
128 * @unlock: As above for unlocking.
129 * @lock_arg: this field is passed as the only argument of lock/unlock
130 * functions (ignored in case regular lock/unlock functions
131 * are not overridden).
Andrey Smirnovd2a58842013-01-27 10:49:05 -0800132 * @reg_read: Optional callback that if filled will be used to perform
133 * all the reads from the registers. Should only be provided for
134 * devices whos read operation cannot be represented as a simple read
135 * operation on a bus such as SPI, I2C, etc. Most of the devices do
136 * not need this.
137 * @reg_write: Same as above for writing.
138 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
139 * to perform locking. This field is ignored if custom lock/unlock
140 * functions are used (see fields lock/unlock of struct regmap_config).
141 * This field is a duplicate of a similar file in
142 * 'struct regmap_bus' and serves exact same purpose.
143 * Use it only for "no-bus" cases.
Mark Brownbd20eb52011-08-19 18:09:38 +0900144 * @max_register: Optional, specifies the maximum valid register index.
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100145 * @wr_table: Optional, points to a struct regmap_access_table specifying
146 * valid ranges for write access.
147 * @rd_table: As above, for read access.
148 * @volatile_table: As above, for volatile registers.
149 * @precious_table: As above, for precious registers.
Mark Brownbd20eb52011-08-19 18:09:38 +0900150 * @reg_defaults: Power on reset values for registers (for use with
151 * register cache support).
152 * @num_reg_defaults: Number of elements in reg_defaults.
Lars-Peter Clausen6f306442011-09-05 20:46:32 +0200153 *
154 * @read_flag_mask: Mask to be set in the top byte of the register when doing
155 * a read.
156 * @write_flag_mask: Mask to be set in the top byte of the register when doing
157 * a write. If both read_flag_mask and write_flag_mask are
158 * empty the regmap_bus default masks are used.
Ashish Jangam2e33caf2012-04-30 23:23:40 +0100159 * @use_single_rw: If set, converts the bulk read and write operations into
160 * a series of single read and write operations. This is useful
161 * for device that does not support bulk read and write.
Dimitris Papastamos9fabe242011-09-19 14:34:00 +0100162 *
163 * @cache_type: The actual cache type.
164 * @reg_defaults_raw: Power on reset values for registers (for use with
165 * register cache support).
166 * @num_reg_defaults_raw: Number of elements in reg_defaults_raw.
Stephen Warren141eba22012-05-24 10:47:26 -0600167 * @reg_format_endian: Endianness for formatted register addresses. If this is
168 * DEFAULT, the @reg_format_endian_default value from the
169 * regmap bus is used.
170 * @val_format_endian: Endianness for formatted register values. If this is
171 * DEFAULT, the @reg_format_endian_default value from the
172 * regmap bus is used.
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100173 *
174 * @ranges: Array of configuration entries for virtual address ranges.
175 * @num_ranges: Number of range configuration entries.
Mark Browndd898b22011-07-20 22:28:58 +0100176 */
Mark Brownb83a3132011-05-11 19:59:58 +0200177struct regmap_config {
Stephen Warrend3c242e2012-04-04 15:48:29 -0600178 const char *name;
179
Mark Brownb83a3132011-05-11 19:59:58 +0200180 int reg_bits;
Stephen Warrenf01ee602012-04-09 13:40:24 -0600181 int reg_stride;
Mark Brown82159ba2012-01-18 10:52:25 +0000182 int pad_bits;
Mark Brownb83a3132011-05-11 19:59:58 +0200183 int val_bits;
Mark Brown2e2ae662011-07-20 22:33:39 +0100184
Mark Brown2e2ae662011-07-20 22:33:39 +0100185 bool (*writeable_reg)(struct device *dev, unsigned int reg);
186 bool (*readable_reg)(struct device *dev, unsigned int reg);
187 bool (*volatile_reg)(struct device *dev, unsigned int reg);
Mark Brown18694882011-08-08 15:40:22 +0900188 bool (*precious_reg)(struct device *dev, unsigned int reg);
Davide Ciminaghi0d4529c2012-10-16 15:56:59 +0200189 regmap_lock lock;
190 regmap_unlock unlock;
191 void *lock_arg;
Mark Brownbd20eb52011-08-19 18:09:38 +0900192
Andrey Smirnovd2a58842013-01-27 10:49:05 -0800193 int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
194 int (*reg_write)(void *context, unsigned int reg, unsigned int val);
195
196 bool fast_io;
197
Mark Brownbd20eb52011-08-19 18:09:38 +0900198 unsigned int max_register;
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100199 const struct regmap_access_table *wr_table;
200 const struct regmap_access_table *rd_table;
201 const struct regmap_access_table *volatile_table;
202 const struct regmap_access_table *precious_table;
Lars-Peter Clausen720e4612011-11-16 16:28:17 +0100203 const struct reg_default *reg_defaults;
Dimitris Papastamos9fabe242011-09-19 14:34:00 +0100204 unsigned int num_reg_defaults;
205 enum regcache_type cache_type;
206 const void *reg_defaults_raw;
207 unsigned int num_reg_defaults_raw;
Lars-Peter Clausen6f306442011-09-05 20:46:32 +0200208
209 u8 read_flag_mask;
210 u8 write_flag_mask;
Ashish Jangam2e33caf2012-04-30 23:23:40 +0100211
212 bool use_single_rw;
Stephen Warren141eba22012-05-24 10:47:26 -0600213
214 enum regmap_endian reg_format_endian;
215 enum regmap_endian val_format_endian;
Mark Brown38e23192012-07-22 19:26:07 +0100216
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100217 const struct regmap_range_cfg *ranges;
Mark Browne3549cd2012-10-02 20:17:15 +0100218 unsigned int num_ranges;
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100219};
220
221/**
222 * Configuration for indirectly accessed or paged registers.
223 * Registers, mapped to this virtual range, are accessed in two steps:
224 * 1. page selector register update;
225 * 2. access through data window registers.
226 *
Mark Brownd058bb42012-10-03 12:40:47 +0100227 * @name: Descriptive name for diagnostics
228 *
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100229 * @range_min: Address of the lowest register address in virtual range.
230 * @range_max: Address of the highest register in virtual range.
231 *
232 * @page_sel_reg: Register with selector field.
233 * @page_sel_mask: Bit shift for selector value.
234 * @page_sel_shift: Bit mask for selector value.
235 *
236 * @window_start: Address of first (lowest) register in data window.
237 * @window_len: Number of registers in data window.
238 */
239struct regmap_range_cfg {
Mark Brownd058bb42012-10-03 12:40:47 +0100240 const char *name;
241
Krystian Garbaciak6863ca62012-06-15 11:23:56 +0100242 /* Registers of virtual address range */
243 unsigned int range_min;
244 unsigned int range_max;
245
246 /* Page selector for indirect addressing */
247 unsigned int selector_reg;
248 unsigned int selector_mask;
249 int selector_shift;
250
251 /* Data window (per each page) */
252 unsigned int window_start;
253 unsigned int window_len;
Mark Brownb83a3132011-05-11 19:59:58 +0200254};
255
Mark Brown0d509f22013-01-27 22:07:38 +0800256struct regmap_async;
257
Stephen Warren0135bbc2012-04-04 15:48:30 -0600258typedef int (*regmap_hw_write)(void *context, const void *data,
Mark Brownb83a3132011-05-11 19:59:58 +0200259 size_t count);
Stephen Warren0135bbc2012-04-04 15:48:30 -0600260typedef int (*regmap_hw_gather_write)(void *context,
Mark Brownb83a3132011-05-11 19:59:58 +0200261 const void *reg, size_t reg_len,
262 const void *val, size_t val_len);
Mark Brown0d509f22013-01-27 22:07:38 +0800263typedef int (*regmap_hw_async_write)(void *context,
264 const void *reg, size_t reg_len,
265 const void *val, size_t val_len,
266 struct regmap_async *async);
Stephen Warren0135bbc2012-04-04 15:48:30 -0600267typedef int (*regmap_hw_read)(void *context,
Mark Brownb83a3132011-05-11 19:59:58 +0200268 const void *reg_buf, size_t reg_size,
269 void *val_buf, size_t val_size);
Mark Brown0d509f22013-01-27 22:07:38 +0800270typedef struct regmap_async *(*regmap_hw_async_alloc)(void);
Stephen Warren0135bbc2012-04-04 15:48:30 -0600271typedef void (*regmap_hw_free_context)(void *context);
Mark Brownb83a3132011-05-11 19:59:58 +0200272
273/**
274 * Description of a hardware bus for the register map infrastructure.
275 *
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600276 * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
Davide Ciminaghi0d4529c2012-10-16 15:56:59 +0200277 * to perform locking. This field is ignored if custom lock/unlock
278 * functions are used (see fields lock/unlock of
279 * struct regmap_config).
Mark Brownb83a3132011-05-11 19:59:58 +0200280 * @write: Write operation.
281 * @gather_write: Write operation with split register/value, return -ENOTSUPP
282 * if not implemented on a given device.
Mark Brown0d509f22013-01-27 22:07:38 +0800283 * @async_write: Write operation which completes asynchronously, optional and
284 * must serialise with respect to non-async I/O.
Mark Brownb83a3132011-05-11 19:59:58 +0200285 * @read: Read operation. Data is returned in the buffer used to transmit
286 * data.
Mark Brown0d509f22013-01-27 22:07:38 +0800287 * @async_alloc: Allocate a regmap_async() structure.
Mark Brownb83a3132011-05-11 19:59:58 +0200288 * @read_flag_mask: Mask to be set in the top byte of the register when doing
289 * a read.
Stephen Warren141eba22012-05-24 10:47:26 -0600290 * @reg_format_endian_default: Default endianness for formatted register
291 * addresses. Used when the regmap_config specifies DEFAULT. If this is
292 * DEFAULT, BIG is assumed.
293 * @val_format_endian_default: Default endianness for formatted register
294 * values. Used when the regmap_config specifies DEFAULT. If this is
295 * DEFAULT, BIG is assumed.
Mark Brown0d509f22013-01-27 22:07:38 +0800296 * @async_size: Size of struct used for async work.
Mark Brownb83a3132011-05-11 19:59:58 +0200297 */
298struct regmap_bus {
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600299 bool fast_io;
Mark Brownb83a3132011-05-11 19:59:58 +0200300 regmap_hw_write write;
301 regmap_hw_gather_write gather_write;
Mark Brown0d509f22013-01-27 22:07:38 +0800302 regmap_hw_async_write async_write;
Mark Brownb83a3132011-05-11 19:59:58 +0200303 regmap_hw_read read;
Stephen Warren0135bbc2012-04-04 15:48:30 -0600304 regmap_hw_free_context free_context;
Mark Brown0d509f22013-01-27 22:07:38 +0800305 regmap_hw_async_alloc async_alloc;
Mark Brownb83a3132011-05-11 19:59:58 +0200306 u8 read_flag_mask;
Stephen Warren141eba22012-05-24 10:47:26 -0600307 enum regmap_endian reg_format_endian_default;
308 enum regmap_endian val_format_endian_default;
Mark Brownb83a3132011-05-11 19:59:58 +0200309};
310
311struct regmap *regmap_init(struct device *dev,
312 const struct regmap_bus *bus,
Stephen Warren0135bbc2012-04-04 15:48:30 -0600313 void *bus_context,
Mark Brownb83a3132011-05-11 19:59:58 +0200314 const struct regmap_config *config);
Mark Brown9943fa32011-06-20 19:02:29 +0100315struct regmap *regmap_init_i2c(struct i2c_client *i2c,
316 const struct regmap_config *config);
Mark Browna676f082011-05-12 11:42:10 +0200317struct regmap *regmap_init_spi(struct spi_device *dev,
318 const struct regmap_config *config);
Philipp Zabel878ec672013-02-14 17:39:08 +0100319struct regmap *regmap_init_mmio_clk(struct device *dev, const char *clk_id,
320 void __iomem *regs,
321 const struct regmap_config *config);
Mark Browna676f082011-05-12 11:42:10 +0200322
Mark Brownc0eb4672012-01-30 19:56:52 +0000323struct regmap *devm_regmap_init(struct device *dev,
324 const struct regmap_bus *bus,
Stephen Warren0135bbc2012-04-04 15:48:30 -0600325 void *bus_context,
Mark Brownc0eb4672012-01-30 19:56:52 +0000326 const struct regmap_config *config);
327struct regmap *devm_regmap_init_i2c(struct i2c_client *i2c,
328 const struct regmap_config *config);
329struct regmap *devm_regmap_init_spi(struct spi_device *dev,
330 const struct regmap_config *config);
Philipp Zabel878ec672013-02-14 17:39:08 +0100331struct regmap *devm_regmap_init_mmio_clk(struct device *dev, const char *clk_id,
332 void __iomem *regs,
333 const struct regmap_config *config);
334
335/**
336 * regmap_init_mmio(): Initialise register map
337 *
338 * @dev: Device that will be interacted with
339 * @regs: Pointer to memory-mapped IO region
340 * @config: Configuration for register map
341 *
342 * The return value will be an ERR_PTR() on error or a valid pointer to
343 * a struct regmap.
344 */
345static inline struct regmap *regmap_init_mmio(struct device *dev,
346 void __iomem *regs,
347 const struct regmap_config *config)
348{
349 return regmap_init_mmio_clk(dev, NULL, regs, config);
350}
351
352/**
353 * devm_regmap_init_mmio(): Initialise managed register map
354 *
355 * @dev: Device that will be interacted with
356 * @regs: Pointer to memory-mapped IO region
357 * @config: Configuration for register map
358 *
359 * The return value will be an ERR_PTR() on error or a valid pointer
360 * to a struct regmap. The regmap will be automatically freed by the
361 * device management code.
362 */
363static inline struct regmap *devm_regmap_init_mmio(struct device *dev,
364 void __iomem *regs,
365 const struct regmap_config *config)
366{
367 return devm_regmap_init_mmio_clk(dev, NULL, regs, config);
368}
Mark Brownc0eb4672012-01-30 19:56:52 +0000369
Mark Brownb83a3132011-05-11 19:59:58 +0200370void regmap_exit(struct regmap *map);
Mark Brownbf315172011-12-03 17:06:20 +0000371int regmap_reinit_cache(struct regmap *map,
372 const struct regmap_config *config);
Mark Brown72b39f62012-05-08 17:44:40 +0100373struct regmap *dev_get_regmap(struct device *dev, const char *name);
Mark Brownb83a3132011-05-11 19:59:58 +0200374int regmap_write(struct regmap *map, unsigned int reg, unsigned int val);
375int regmap_raw_write(struct regmap *map, unsigned int reg,
376 const void *val, size_t val_len);
Laxman Dewangan8eaeb212012-02-12 19:49:43 +0530377int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
378 size_t val_count);
Mark Brown0d509f22013-01-27 22:07:38 +0800379int regmap_raw_write_async(struct regmap *map, unsigned int reg,
380 const void *val, size_t val_len);
Mark Brownb83a3132011-05-11 19:59:58 +0200381int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val);
382int regmap_raw_read(struct regmap *map, unsigned int reg,
383 void *val, size_t val_len);
384int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
385 size_t val_count);
386int regmap_update_bits(struct regmap *map, unsigned int reg,
387 unsigned int mask, unsigned int val);
Mark Brown018690d2011-11-29 20:10:36 +0000388int regmap_update_bits_check(struct regmap *map, unsigned int reg,
389 unsigned int mask, unsigned int val,
390 bool *change);
Mark Browna6539c32012-02-17 14:20:14 -0800391int regmap_get_val_bytes(struct regmap *map);
Mark Brown0d509f22013-01-27 22:07:38 +0800392int regmap_async_complete(struct regmap *map);
Mark Brown221ad7f2013-03-26 21:24:20 +0000393bool regmap_can_raw_write(struct regmap *map);
Mark Brownb83a3132011-05-11 19:59:58 +0200394
Mark Brown39a58432011-09-19 18:21:49 +0100395int regcache_sync(struct regmap *map);
Mark Brown4d4cfd12012-02-23 20:53:37 +0000396int regcache_sync_region(struct regmap *map, unsigned int min,
397 unsigned int max);
Mark Brown92afb282011-09-19 18:22:14 +0100398void regcache_cache_only(struct regmap *map, bool enable);
Dimitris Papastamos6eb0f5e2011-09-29 14:36:27 +0100399void regcache_cache_bypass(struct regmap *map, bool enable);
Mark Brown8ae0d7e2011-10-26 10:34:22 +0200400void regcache_mark_dirty(struct regmap *map);
Mark Brown92afb282011-09-19 18:22:14 +0100401
Mark Brown22f0d902012-01-21 12:01:14 +0000402int regmap_register_patch(struct regmap *map, const struct reg_default *regs,
403 int num_regs);
404
Davide Ciminaghi76aad392012-11-20 15:20:30 +0100405static inline bool regmap_reg_in_range(unsigned int reg,
406 const struct regmap_range *range)
407{
408 return reg >= range->range_min && reg <= range->range_max;
409}
410
411bool regmap_reg_in_ranges(unsigned int reg,
412 const struct regmap_range *ranges,
413 unsigned int nranges);
414
Mark Brownf8beab22011-10-28 23:50:49 +0200415/**
Srinivas Kandagatla67252282013-06-11 13:18:15 +0100416 * Description of an register field
417 *
418 * @reg: Offset of the register within the regmap bank
419 * @lsb: lsb of the register field.
420 * @reg: msb of the register field.
421 */
422struct reg_field {
423 unsigned int reg;
424 unsigned int lsb;
425 unsigned int msb;
426};
427
428#define REG_FIELD(_reg, _lsb, _msb) { \
429 .reg = _reg, \
430 .lsb = _lsb, \
431 .msb = _msb, \
432 }
433
434struct regmap_field *regmap_field_alloc(struct regmap *regmap,
435 struct reg_field reg_field);
436void regmap_field_free(struct regmap_field *field);
437
438struct regmap_field *devm_regmap_field_alloc(struct device *dev,
439 struct regmap *regmap, struct reg_field reg_field);
440void devm_regmap_field_free(struct device *dev, struct regmap_field *field);
441
442int regmap_field_read(struct regmap_field *field, unsigned int *val);
443int regmap_field_write(struct regmap_field *field, unsigned int val);
444
445/**
Mark Brownf8beab22011-10-28 23:50:49 +0200446 * Description of an IRQ for the generic regmap irq_chip.
447 *
448 * @reg_offset: Offset of the status/mask register within the bank
449 * @mask: Mask used to flag/control the register.
450 */
451struct regmap_irq {
452 unsigned int reg_offset;
453 unsigned int mask;
454};
455
456/**
457 * Description of a generic regmap irq_chip. This is not intended to
458 * handle every possible interrupt controller, but it should handle a
459 * substantial proportion of those that are found in the wild.
460 *
461 * @name: Descriptive name for IRQ controller.
462 *
463 * @status_base: Base status register address.
464 * @mask_base: Base mask register address.
465 * @ack_base: Base ack address. If zero then the chip is clear on read.
Mark Browna43fd502012-06-05 14:34:03 +0100466 * @wake_base: Base address for wake enables. If zero unsupported.
Graeme Gregory022f926a2012-05-14 22:40:43 +0900467 * @irq_reg_stride: Stride to use for chips where registers are not contiguous.
Mark Brown0c00c502012-07-24 15:41:19 +0100468 * @runtime_pm: Hold a runtime PM lock on the device when accessing it.
Mark Brownf8beab22011-10-28 23:50:49 +0200469 *
470 * @num_regs: Number of registers in each control bank.
471 * @irqs: Descriptors for individual IRQs. Interrupt numbers are
472 * assigned based on the index in the array of the interrupt.
473 * @num_irqs: Number of descriptors.
474 */
475struct regmap_irq_chip {
476 const char *name;
477
478 unsigned int status_base;
479 unsigned int mask_base;
480 unsigned int ack_base;
Mark Browna43fd502012-06-05 14:34:03 +0100481 unsigned int wake_base;
Graeme Gregory022f926a2012-05-14 22:40:43 +0900482 unsigned int irq_reg_stride;
Xiaofan Tian36ac9142012-08-30 17:03:35 +0800483 unsigned int mask_invert;
Mark Brown94424902013-01-04 16:35:07 +0000484 unsigned int wake_invert;
Mark Brown0c00c502012-07-24 15:41:19 +0100485 bool runtime_pm;
Mark Brownf8beab22011-10-28 23:50:49 +0200486
487 int num_regs;
488
489 const struct regmap_irq *irqs;
490 int num_irqs;
491};
492
493struct regmap_irq_chip_data;
494
495int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags,
Mark Brownb026ddb2012-05-31 21:01:46 +0100496 int irq_base, const struct regmap_irq_chip *chip,
Mark Brownf8beab22011-10-28 23:50:49 +0200497 struct regmap_irq_chip_data **data);
498void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data);
Mark Brown209a6002011-12-05 16:10:15 +0000499int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data);
Mark Brown4af8be62012-05-13 10:59:56 +0100500int regmap_irq_get_virq(struct regmap_irq_chip_data *data, int irq);
Mark Brown90f790d2012-08-20 21:45:05 +0100501struct irq_domain *regmap_irq_get_domain(struct regmap_irq_chip_data *data);
Mark Brownb83a3132011-05-11 19:59:58 +0200502
Mark Brown9cde5fc2012-02-17 14:49:51 -0800503#else
504
505/*
506 * These stubs should only ever be called by generic code which has
507 * regmap based facilities, if they ever get called at runtime
508 * something is going wrong and something probably needs to select
509 * REGMAP.
510 */
511
512static inline int regmap_write(struct regmap *map, unsigned int reg,
513 unsigned int val)
514{
515 WARN_ONCE(1, "regmap API is disabled");
516 return -EINVAL;
517}
518
519static inline int regmap_raw_write(struct regmap *map, unsigned int reg,
520 const void *val, size_t val_len)
521{
522 WARN_ONCE(1, "regmap API is disabled");
523 return -EINVAL;
524}
525
Mark Brown0d509f22013-01-27 22:07:38 +0800526static inline int regmap_raw_write_async(struct regmap *map, unsigned int reg,
527 const void *val, size_t val_len)
528{
529 WARN_ONCE(1, "regmap API is disabled");
530 return -EINVAL;
531}
532
Mark Brown9cde5fc2012-02-17 14:49:51 -0800533static inline int regmap_bulk_write(struct regmap *map, unsigned int reg,
534 const void *val, size_t val_count)
535{
536 WARN_ONCE(1, "regmap API is disabled");
537 return -EINVAL;
538}
539
540static inline int regmap_read(struct regmap *map, unsigned int reg,
541 unsigned int *val)
542{
543 WARN_ONCE(1, "regmap API is disabled");
544 return -EINVAL;
545}
546
547static inline int regmap_raw_read(struct regmap *map, unsigned int reg,
548 void *val, size_t val_len)
549{
550 WARN_ONCE(1, "regmap API is disabled");
551 return -EINVAL;
552}
553
554static inline int regmap_bulk_read(struct regmap *map, unsigned int reg,
555 void *val, size_t val_count)
556{
557 WARN_ONCE(1, "regmap API is disabled");
558 return -EINVAL;
559}
560
561static inline int regmap_update_bits(struct regmap *map, unsigned int reg,
562 unsigned int mask, unsigned int val)
563{
564 WARN_ONCE(1, "regmap API is disabled");
565 return -EINVAL;
566}
567
568static inline int regmap_update_bits_check(struct regmap *map,
569 unsigned int reg,
570 unsigned int mask, unsigned int val,
571 bool *change)
572{
573 WARN_ONCE(1, "regmap API is disabled");
574 return -EINVAL;
575}
576
577static inline int regmap_get_val_bytes(struct regmap *map)
578{
579 WARN_ONCE(1, "regmap API is disabled");
580 return -EINVAL;
581}
582
583static inline int regcache_sync(struct regmap *map)
584{
585 WARN_ONCE(1, "regmap API is disabled");
586 return -EINVAL;
587}
588
Mark Browna313f9f2012-02-23 19:49:43 +0000589static inline int regcache_sync_region(struct regmap *map, unsigned int min,
590 unsigned int max)
591{
592 WARN_ONCE(1, "regmap API is disabled");
593 return -EINVAL;
594}
595
Mark Brown9cde5fc2012-02-17 14:49:51 -0800596static inline void regcache_cache_only(struct regmap *map, bool enable)
597{
598 WARN_ONCE(1, "regmap API is disabled");
599}
600
601static inline void regcache_cache_bypass(struct regmap *map, bool enable)
602{
603 WARN_ONCE(1, "regmap API is disabled");
604}
605
606static inline void regcache_mark_dirty(struct regmap *map)
607{
608 WARN_ONCE(1, "regmap API is disabled");
609}
610
Mark Brown0d509f22013-01-27 22:07:38 +0800611static inline void regmap_async_complete(struct regmap *map)
612{
613 WARN_ONCE(1, "regmap API is disabled");
614}
615
Mark Brown9cde5fc2012-02-17 14:49:51 -0800616static inline int regmap_register_patch(struct regmap *map,
617 const struct reg_default *regs,
618 int num_regs)
619{
620 WARN_ONCE(1, "regmap API is disabled");
621 return -EINVAL;
622}
623
Mark Brown72b39f62012-05-08 17:44:40 +0100624static inline struct regmap *dev_get_regmap(struct device *dev,
625 const char *name)
626{
Mark Brown72b39f62012-05-08 17:44:40 +0100627 return NULL;
628}
629
Mark Brown9cde5fc2012-02-17 14:49:51 -0800630#endif
631
Mark Brownb83a3132011-05-11 19:59:58 +0200632#endif