blob: 40f910162781cdcaf08aabd47310e819fbcc06c7 [file] [log] [blame]
Mark Brownb83a3132011-05-11 19:59:58 +02001/*
2 * Register map access API
3 *
4 * Copyright 2011 Wolfson Microelectronics plc
5 *
6 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
Stephen Warrenf5d6eba2012-03-09 13:17:28 -070013#include <linux/device.h>
Mark Brownb83a3132011-05-11 19:59:58 +020014#include <linux/slab.h>
Paul Gortmaker19694b52012-02-28 19:28:02 -050015#include <linux/export.h>
Mark Brownb83a3132011-05-11 19:59:58 +020016#include <linux/mutex.h>
17#include <linux/err.h>
18
Mark Brownfb2736b2011-07-24 21:30:55 +010019#define CREATE_TRACE_POINTS
20#include <trace/events/regmap.h>
21
Mark Brown93de9122011-07-20 22:35:37 +010022#include "internal.h"
Mark Brownb83a3132011-05-11 19:59:58 +020023
Mark Brown8de2f082011-08-10 17:14:41 +090024bool regmap_writeable(struct regmap *map, unsigned int reg)
25{
26 if (map->max_register && reg > map->max_register)
27 return false;
28
29 if (map->writeable_reg)
30 return map->writeable_reg(map->dev, reg);
31
32 return true;
33}
34
35bool regmap_readable(struct regmap *map, unsigned int reg)
36{
37 if (map->max_register && reg > map->max_register)
38 return false;
39
Wolfram Sang4191f192012-01-30 15:08:16 +010040 if (map->format.format_write)
41 return false;
42
Mark Brown8de2f082011-08-10 17:14:41 +090043 if (map->readable_reg)
44 return map->readable_reg(map->dev, reg);
45
46 return true;
47}
48
49bool regmap_volatile(struct regmap *map, unsigned int reg)
50{
Wolfram Sang4191f192012-01-30 15:08:16 +010051 if (!regmap_readable(map, reg))
Mark Brown8de2f082011-08-10 17:14:41 +090052 return false;
53
54 if (map->volatile_reg)
55 return map->volatile_reg(map->dev, reg);
56
57 return true;
58}
59
60bool regmap_precious(struct regmap *map, unsigned int reg)
61{
Wolfram Sang4191f192012-01-30 15:08:16 +010062 if (!regmap_readable(map, reg))
Mark Brown8de2f082011-08-10 17:14:41 +090063 return false;
64
65 if (map->precious_reg)
66 return map->precious_reg(map->dev, reg);
67
68 return false;
69}
70
Lars-Peter Clausen82cd9962011-11-08 18:37:25 +010071static bool regmap_volatile_range(struct regmap *map, unsigned int reg,
72 unsigned int num)
73{
74 unsigned int i;
75
76 for (i = 0; i < num; i++)
77 if (!regmap_volatile(map, reg + i))
78 return false;
79
80 return true;
81}
82
Wolfram Sang9aa50752012-01-27 16:10:22 +010083static void regmap_format_2_6_write(struct regmap *map,
84 unsigned int reg, unsigned int val)
85{
86 u8 *out = map->work_buf;
87
88 *out = (reg << 6) | val;
89}
90
Mark Brownb83a3132011-05-11 19:59:58 +020091static void regmap_format_4_12_write(struct regmap *map,
92 unsigned int reg, unsigned int val)
93{
94 __be16 *out = map->work_buf;
95 *out = cpu_to_be16((reg << 12) | val);
96}
97
98static void regmap_format_7_9_write(struct regmap *map,
99 unsigned int reg, unsigned int val)
100{
101 __be16 *out = map->work_buf;
102 *out = cpu_to_be16((reg << 9) | val);
103}
104
Lars-Peter Clausen7e5ec632011-11-16 16:28:21 +0100105static void regmap_format_10_14_write(struct regmap *map,
106 unsigned int reg, unsigned int val)
107{
108 u8 *out = map->work_buf;
109
110 out[2] = val;
111 out[1] = (val >> 8) | (reg << 6);
112 out[0] = reg >> 2;
113}
114
Marc Reillyd939fb92012-03-16 12:11:43 +1100115static void regmap_format_8(void *buf, unsigned int val, unsigned int shift)
Mark Brownb83a3132011-05-11 19:59:58 +0200116{
117 u8 *b = buf;
118
Marc Reillyd939fb92012-03-16 12:11:43 +1100119 b[0] = val << shift;
Mark Brownb83a3132011-05-11 19:59:58 +0200120}
121
Marc Reillyd939fb92012-03-16 12:11:43 +1100122static void regmap_format_16(void *buf, unsigned int val, unsigned int shift)
Mark Brownb83a3132011-05-11 19:59:58 +0200123{
124 __be16 *b = buf;
125
Marc Reillyd939fb92012-03-16 12:11:43 +1100126 b[0] = cpu_to_be16(val << shift);
Mark Brownb83a3132011-05-11 19:59:58 +0200127}
128
Marc Reillyd939fb92012-03-16 12:11:43 +1100129static void regmap_format_24(void *buf, unsigned int val, unsigned int shift)
Marc Reillyea279fc2012-03-16 12:11:42 +1100130{
131 u8 *b = buf;
132
Marc Reillyd939fb92012-03-16 12:11:43 +1100133 val <<= shift;
134
Marc Reillyea279fc2012-03-16 12:11:42 +1100135 b[0] = val >> 16;
136 b[1] = val >> 8;
137 b[2] = val;
138}
139
Marc Reillyd939fb92012-03-16 12:11:43 +1100140static void regmap_format_32(void *buf, unsigned int val, unsigned int shift)
Mark Brown7d5e5252012-02-17 15:58:25 -0800141{
142 __be32 *b = buf;
143
Marc Reillyd939fb92012-03-16 12:11:43 +1100144 b[0] = cpu_to_be32(val << shift);
Mark Brown7d5e5252012-02-17 15:58:25 -0800145}
146
Mark Brownb83a3132011-05-11 19:59:58 +0200147static unsigned int regmap_parse_8(void *buf)
148{
149 u8 *b = buf;
150
151 return b[0];
152}
153
154static unsigned int regmap_parse_16(void *buf)
155{
156 __be16 *b = buf;
157
158 b[0] = be16_to_cpu(b[0]);
159
160 return b[0];
161}
162
Marc Reillyea279fc2012-03-16 12:11:42 +1100163static unsigned int regmap_parse_24(void *buf)
164{
165 u8 *b = buf;
166 unsigned int ret = b[2];
167 ret |= ((unsigned int)b[1]) << 8;
168 ret |= ((unsigned int)b[0]) << 16;
169
170 return ret;
171}
172
Mark Brown7d5e5252012-02-17 15:58:25 -0800173static unsigned int regmap_parse_32(void *buf)
174{
175 __be32 *b = buf;
176
177 b[0] = be32_to_cpu(b[0]);
178
179 return b[0];
180}
181
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600182static void regmap_lock_mutex(struct regmap *map)
183{
184 mutex_lock(&map->mutex);
185}
186
187static void regmap_unlock_mutex(struct regmap *map)
188{
189 mutex_unlock(&map->mutex);
190}
191
192static void regmap_lock_spinlock(struct regmap *map)
193{
194 spin_lock(&map->spinlock);
195}
196
197static void regmap_unlock_spinlock(struct regmap *map)
198{
199 spin_unlock(&map->spinlock);
200}
201
Mark Brownb83a3132011-05-11 19:59:58 +0200202/**
203 * regmap_init(): Initialise register map
204 *
205 * @dev: Device that will be interacted with
206 * @bus: Bus-specific callbacks to use with device
Stephen Warren0135bbc2012-04-04 15:48:30 -0600207 * @bus_context: Data passed to bus-specific callbacks
Mark Brownb83a3132011-05-11 19:59:58 +0200208 * @config: Configuration for register map
209 *
210 * The return value will be an ERR_PTR() on error or a valid pointer to
211 * a struct regmap. This function should generally not be called
212 * directly, it should be called by bus-specific init functions.
213 */
214struct regmap *regmap_init(struct device *dev,
215 const struct regmap_bus *bus,
Stephen Warren0135bbc2012-04-04 15:48:30 -0600216 void *bus_context,
Mark Brownb83a3132011-05-11 19:59:58 +0200217 const struct regmap_config *config)
218{
219 struct regmap *map;
220 int ret = -EINVAL;
221
222 if (!bus || !config)
Lars-Peter Clausenabbb18f2011-11-14 10:40:15 +0100223 goto err;
Mark Brownb83a3132011-05-11 19:59:58 +0200224
225 map = kzalloc(sizeof(*map), GFP_KERNEL);
226 if (map == NULL) {
227 ret = -ENOMEM;
228 goto err;
229 }
230
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600231 if (bus->fast_io) {
232 spin_lock_init(&map->spinlock);
233 map->lock = regmap_lock_spinlock;
234 map->unlock = regmap_unlock_spinlock;
235 } else {
236 mutex_init(&map->mutex);
237 map->lock = regmap_lock_mutex;
238 map->unlock = regmap_unlock_mutex;
239 }
Mark Brownb83a3132011-05-11 19:59:58 +0200240 map->format.buf_size = (config->reg_bits + config->val_bits) / 8;
Wolfram Sangc212acc2012-01-28 02:16:41 +0100241 map->format.reg_bytes = DIV_ROUND_UP(config->reg_bits, 8);
Mark Brown82159ba2012-01-18 10:52:25 +0000242 map->format.pad_bytes = config->pad_bits / 8;
Wolfram Sangc212acc2012-01-28 02:16:41 +0100243 map->format.val_bytes = DIV_ROUND_UP(config->val_bits, 8);
Mark Brown82159ba2012-01-18 10:52:25 +0000244 map->format.buf_size += map->format.pad_bytes;
Marc Reillyd939fb92012-03-16 12:11:43 +1100245 map->reg_shift = config->pad_bits % 8;
Mark Brownb83a3132011-05-11 19:59:58 +0200246 map->dev = dev;
247 map->bus = bus;
Stephen Warren0135bbc2012-04-04 15:48:30 -0600248 map->bus_context = bus_context;
Mark Brown2e2ae662011-07-20 22:33:39 +0100249 map->max_register = config->max_register;
250 map->writeable_reg = config->writeable_reg;
251 map->readable_reg = config->readable_reg;
252 map->volatile_reg = config->volatile_reg;
Mark Brown2efe1642011-08-08 15:41:46 +0900253 map->precious_reg = config->precious_reg;
Dimitris Papastamos5d1729e2011-09-19 14:34:05 +0100254 map->cache_type = config->cache_type;
Mark Brownb83a3132011-05-11 19:59:58 +0200255
Lars-Peter Clausen6f306442011-09-05 20:46:32 +0200256 if (config->read_flag_mask || config->write_flag_mask) {
257 map->read_flag_mask = config->read_flag_mask;
258 map->write_flag_mask = config->write_flag_mask;
259 } else {
260 map->read_flag_mask = bus->read_flag_mask;
261 }
262
Marc Reillyd939fb92012-03-16 12:11:43 +1100263 switch (config->reg_bits + map->reg_shift) {
Wolfram Sang9aa50752012-01-27 16:10:22 +0100264 case 2:
265 switch (config->val_bits) {
266 case 6:
267 map->format.format_write = regmap_format_2_6_write;
268 break;
269 default:
270 goto err_map;
271 }
272 break;
273
Mark Brownb83a3132011-05-11 19:59:58 +0200274 case 4:
275 switch (config->val_bits) {
276 case 12:
277 map->format.format_write = regmap_format_4_12_write;
278 break;
279 default:
280 goto err_map;
281 }
282 break;
283
284 case 7:
285 switch (config->val_bits) {
286 case 9:
287 map->format.format_write = regmap_format_7_9_write;
288 break;
289 default:
290 goto err_map;
291 }
292 break;
293
Lars-Peter Clausen7e5ec632011-11-16 16:28:21 +0100294 case 10:
295 switch (config->val_bits) {
296 case 14:
297 map->format.format_write = regmap_format_10_14_write;
298 break;
299 default:
300 goto err_map;
301 }
302 break;
303
Mark Brownb83a3132011-05-11 19:59:58 +0200304 case 8:
305 map->format.format_reg = regmap_format_8;
306 break;
307
308 case 16:
309 map->format.format_reg = regmap_format_16;
310 break;
311
Mark Brown7d5e5252012-02-17 15:58:25 -0800312 case 32:
313 map->format.format_reg = regmap_format_32;
314 break;
315
Mark Brownb83a3132011-05-11 19:59:58 +0200316 default:
317 goto err_map;
318 }
319
320 switch (config->val_bits) {
321 case 8:
322 map->format.format_val = regmap_format_8;
323 map->format.parse_val = regmap_parse_8;
324 break;
325 case 16:
326 map->format.format_val = regmap_format_16;
327 map->format.parse_val = regmap_parse_16;
328 break;
Marc Reillyea279fc2012-03-16 12:11:42 +1100329 case 24:
330 map->format.format_val = regmap_format_24;
331 map->format.parse_val = regmap_parse_24;
332 break;
Mark Brown7d5e5252012-02-17 15:58:25 -0800333 case 32:
334 map->format.format_val = regmap_format_32;
335 map->format.parse_val = regmap_parse_32;
336 break;
Mark Brownb83a3132011-05-11 19:59:58 +0200337 }
338
339 if (!map->format.format_write &&
340 !(map->format.format_reg && map->format.format_val))
341 goto err_map;
342
Mark Brown82159ba2012-01-18 10:52:25 +0000343 map->work_buf = kzalloc(map->format.buf_size, GFP_KERNEL);
Mark Brownb83a3132011-05-11 19:59:58 +0200344 if (map->work_buf == NULL) {
345 ret = -ENOMEM;
Mark Brown5204f5e2011-09-05 08:07:47 -0700346 goto err_map;
Mark Brownb83a3132011-05-11 19:59:58 +0200347 }
348
Stephen Warrend3c242e2012-04-04 15:48:29 -0600349 regmap_debugfs_init(map, config->name);
Mark Brown052d2cd2011-11-21 19:05:13 +0000350
Lars-Peter Clausene5e3b8a2011-11-16 16:28:16 +0100351 ret = regcache_init(map, config);
Dimitris Papastamos5d1729e2011-09-19 14:34:05 +0100352 if (ret < 0)
Lars-Peter Clausen58072cb2011-11-10 18:15:15 +0100353 goto err_free_workbuf;
Dimitris Papastamos5d1729e2011-09-19 14:34:05 +0100354
Mark Brownb83a3132011-05-11 19:59:58 +0200355 return map;
356
Lars-Peter Clausen58072cb2011-11-10 18:15:15 +0100357err_free_workbuf:
358 kfree(map->work_buf);
Mark Brownb83a3132011-05-11 19:59:58 +0200359err_map:
360 kfree(map);
361err:
362 return ERR_PTR(ret);
363}
364EXPORT_SYMBOL_GPL(regmap_init);
365
Mark Brownc0eb4672012-01-30 19:56:52 +0000366static void devm_regmap_release(struct device *dev, void *res)
367{
368 regmap_exit(*(struct regmap **)res);
369}
370
371/**
372 * devm_regmap_init(): Initialise managed register map
373 *
374 * @dev: Device that will be interacted with
375 * @bus: Bus-specific callbacks to use with device
Stephen Warren0135bbc2012-04-04 15:48:30 -0600376 * @bus_context: Data passed to bus-specific callbacks
Mark Brownc0eb4672012-01-30 19:56:52 +0000377 * @config: Configuration for register map
378 *
379 * The return value will be an ERR_PTR() on error or a valid pointer
380 * to a struct regmap. This function should generally not be called
381 * directly, it should be called by bus-specific init functions. The
382 * map will be automatically freed by the device management code.
383 */
384struct regmap *devm_regmap_init(struct device *dev,
385 const struct regmap_bus *bus,
Stephen Warren0135bbc2012-04-04 15:48:30 -0600386 void *bus_context,
Mark Brownc0eb4672012-01-30 19:56:52 +0000387 const struct regmap_config *config)
388{
389 struct regmap **ptr, *regmap;
390
391 ptr = devres_alloc(devm_regmap_release, sizeof(*ptr), GFP_KERNEL);
392 if (!ptr)
393 return ERR_PTR(-ENOMEM);
394
Stephen Warren0135bbc2012-04-04 15:48:30 -0600395 regmap = regmap_init(dev, bus, bus_context, config);
Mark Brownc0eb4672012-01-30 19:56:52 +0000396 if (!IS_ERR(regmap)) {
397 *ptr = regmap;
398 devres_add(dev, ptr);
399 } else {
400 devres_free(ptr);
401 }
402
403 return regmap;
404}
405EXPORT_SYMBOL_GPL(devm_regmap_init);
406
Mark Brownb83a3132011-05-11 19:59:58 +0200407/**
Mark Brownbf315172011-12-03 17:06:20 +0000408 * regmap_reinit_cache(): Reinitialise the current register cache
409 *
410 * @map: Register map to operate on.
411 * @config: New configuration. Only the cache data will be used.
412 *
413 * Discard any existing register cache for the map and initialize a
414 * new cache. This can be used to restore the cache to defaults or to
415 * update the cache configuration to reflect runtime discovery of the
416 * hardware.
417 */
418int regmap_reinit_cache(struct regmap *map, const struct regmap_config *config)
419{
420 int ret;
421
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600422 map->lock(map);
Mark Brownbf315172011-12-03 17:06:20 +0000423
424 regcache_exit(map);
Mark Browna24f64a2012-01-26 18:30:16 +0000425 regmap_debugfs_exit(map);
Mark Brownbf315172011-12-03 17:06:20 +0000426
427 map->max_register = config->max_register;
428 map->writeable_reg = config->writeable_reg;
429 map->readable_reg = config->readable_reg;
430 map->volatile_reg = config->volatile_reg;
431 map->precious_reg = config->precious_reg;
432 map->cache_type = config->cache_type;
433
Stephen Warrend3c242e2012-04-04 15:48:29 -0600434 regmap_debugfs_init(map, config->name);
Mark Browna24f64a2012-01-26 18:30:16 +0000435
Mark Brown421e8d22012-01-20 13:39:37 +0000436 map->cache_bypass = false;
437 map->cache_only = false;
438
Mark Brownbf315172011-12-03 17:06:20 +0000439 ret = regcache_init(map, config);
440
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600441 map->unlock(map);
Mark Brownbf315172011-12-03 17:06:20 +0000442
443 return ret;
444}
445
446/**
Mark Brownb83a3132011-05-11 19:59:58 +0200447 * regmap_exit(): Free a previously allocated register map
448 */
449void regmap_exit(struct regmap *map)
450{
Dimitris Papastamos5d1729e2011-09-19 14:34:05 +0100451 regcache_exit(map);
Mark Brown31244e32011-07-20 22:56:53 +0100452 regmap_debugfs_exit(map);
Stephen Warren0135bbc2012-04-04 15:48:30 -0600453 if (map->bus->free_context)
454 map->bus->free_context(map->bus_context);
Mark Brownb83a3132011-05-11 19:59:58 +0200455 kfree(map->work_buf);
Mark Brownb83a3132011-05-11 19:59:58 +0200456 kfree(map);
457}
458EXPORT_SYMBOL_GPL(regmap_exit);
459
460static int _regmap_raw_write(struct regmap *map, unsigned int reg,
461 const void *val, size_t val_len)
462{
Lars-Peter Clausen6f306442011-09-05 20:46:32 +0200463 u8 *u8 = map->work_buf;
Mark Brownb83a3132011-05-11 19:59:58 +0200464 void *buf;
465 int ret = -ENOTSUPP;
466 size_t len;
Mark Brown73304782011-07-24 11:46:20 +0100467 int i;
468
469 /* Check for unwritable registers before we start */
470 if (map->writeable_reg)
471 for (i = 0; i < val_len / map->format.val_bytes; i++)
472 if (!map->writeable_reg(map->dev, reg + i))
473 return -EINVAL;
Mark Brownb83a3132011-05-11 19:59:58 +0200474
Laxman Dewanganc9157192012-02-10 21:30:27 +0530475 if (!map->cache_bypass && map->format.parse_val) {
476 unsigned int ival;
477 int val_bytes = map->format.val_bytes;
478 for (i = 0; i < val_len / val_bytes; i++) {
479 memcpy(map->work_buf, val + (i * val_bytes), val_bytes);
480 ival = map->format.parse_val(map->work_buf);
481 ret = regcache_write(map, reg + i, ival);
482 if (ret) {
483 dev_err(map->dev,
484 "Error in caching of register: %u ret: %d\n",
485 reg + i, ret);
486 return ret;
487 }
488 }
489 if (map->cache_only) {
490 map->cache_dirty = true;
491 return 0;
492 }
493 }
494
Marc Reillyd939fb92012-03-16 12:11:43 +1100495 map->format.format_reg(map->work_buf, reg, map->reg_shift);
Mark Brownb83a3132011-05-11 19:59:58 +0200496
Lars-Peter Clausen6f306442011-09-05 20:46:32 +0200497 u8[0] |= map->write_flag_mask;
498
Mark Brownfb2736b2011-07-24 21:30:55 +0100499 trace_regmap_hw_write_start(map->dev, reg,
500 val_len / map->format.val_bytes);
501
Mark Brown2547e202011-07-20 21:47:22 +0100502 /* If we're doing a single register write we can probably just
503 * send the work_buf directly, otherwise try to do a gather
504 * write.
505 */
Mark Brown82159ba2012-01-18 10:52:25 +0000506 if (val == (map->work_buf + map->format.pad_bytes +
507 map->format.reg_bytes))
Stephen Warren0135bbc2012-04-04 15:48:30 -0600508 ret = map->bus->write(map->bus_context, map->work_buf,
Mark Brown82159ba2012-01-18 10:52:25 +0000509 map->format.reg_bytes +
510 map->format.pad_bytes +
511 val_len);
Mark Brown2547e202011-07-20 21:47:22 +0100512 else if (map->bus->gather_write)
Stephen Warren0135bbc2012-04-04 15:48:30 -0600513 ret = map->bus->gather_write(map->bus_context, map->work_buf,
Mark Brown82159ba2012-01-18 10:52:25 +0000514 map->format.reg_bytes +
515 map->format.pad_bytes,
Mark Brownb83a3132011-05-11 19:59:58 +0200516 val, val_len);
517
Mark Brown2547e202011-07-20 21:47:22 +0100518 /* If that didn't work fall back on linearising by hand. */
Mark Brownb83a3132011-05-11 19:59:58 +0200519 if (ret == -ENOTSUPP) {
Mark Brown82159ba2012-01-18 10:52:25 +0000520 len = map->format.reg_bytes + map->format.pad_bytes + val_len;
521 buf = kzalloc(len, GFP_KERNEL);
Mark Brownb83a3132011-05-11 19:59:58 +0200522 if (!buf)
523 return -ENOMEM;
524
525 memcpy(buf, map->work_buf, map->format.reg_bytes);
Mark Brown82159ba2012-01-18 10:52:25 +0000526 memcpy(buf + map->format.reg_bytes + map->format.pad_bytes,
527 val, val_len);
Stephen Warren0135bbc2012-04-04 15:48:30 -0600528 ret = map->bus->write(map->bus_context, buf, len);
Mark Brownb83a3132011-05-11 19:59:58 +0200529
530 kfree(buf);
531 }
532
Mark Brownfb2736b2011-07-24 21:30:55 +0100533 trace_regmap_hw_write_done(map->dev, reg,
534 val_len / map->format.val_bytes);
535
Mark Brownb83a3132011-05-11 19:59:58 +0200536 return ret;
537}
538
Dimitris Papastamos4d2dc092011-09-29 10:39:07 +0100539int _regmap_write(struct regmap *map, unsigned int reg,
540 unsigned int val)
Mark Brownb83a3132011-05-11 19:59:58 +0200541{
Mark Brownfb2736b2011-07-24 21:30:55 +0100542 int ret;
Mark Brownb83a3132011-05-11 19:59:58 +0200543 BUG_ON(!map->format.format_write && !map->format.format_val);
544
Laxman Dewanganc9157192012-02-10 21:30:27 +0530545 if (!map->cache_bypass && map->format.format_write) {
Dimitris Papastamos5d1729e2011-09-19 14:34:05 +0100546 ret = regcache_write(map, reg, val);
547 if (ret != 0)
548 return ret;
Mark Brown8ae0d7e2011-10-26 10:34:22 +0200549 if (map->cache_only) {
550 map->cache_dirty = true;
Dimitris Papastamos5d1729e2011-09-19 14:34:05 +0100551 return 0;
Mark Brown8ae0d7e2011-10-26 10:34:22 +0200552 }
Dimitris Papastamos5d1729e2011-09-19 14:34:05 +0100553 }
554
Mark Brownfb2736b2011-07-24 21:30:55 +0100555 trace_regmap_reg_write(map->dev, reg, val);
556
Mark Brownb83a3132011-05-11 19:59:58 +0200557 if (map->format.format_write) {
558 map->format.format_write(map, reg, val);
559
Mark Brownfb2736b2011-07-24 21:30:55 +0100560 trace_regmap_hw_write_start(map->dev, reg, 1);
561
Stephen Warren0135bbc2012-04-04 15:48:30 -0600562 ret = map->bus->write(map->bus_context, map->work_buf,
Mark Brownfb2736b2011-07-24 21:30:55 +0100563 map->format.buf_size);
564
565 trace_regmap_hw_write_done(map->dev, reg, 1);
566
567 return ret;
Mark Brownb83a3132011-05-11 19:59:58 +0200568 } else {
Mark Brown82159ba2012-01-18 10:52:25 +0000569 map->format.format_val(map->work_buf + map->format.reg_bytes
Marc Reillyd939fb92012-03-16 12:11:43 +1100570 + map->format.pad_bytes, val, 0);
Mark Brownb83a3132011-05-11 19:59:58 +0200571 return _regmap_raw_write(map, reg,
Mark Brown82159ba2012-01-18 10:52:25 +0000572 map->work_buf +
573 map->format.reg_bytes +
574 map->format.pad_bytes,
Mark Brownb83a3132011-05-11 19:59:58 +0200575 map->format.val_bytes);
576 }
577}
578
579/**
580 * regmap_write(): Write a value to a single register
581 *
582 * @map: Register map to write to
583 * @reg: Register to write to
584 * @val: Value to be written
585 *
586 * A value of zero will be returned on success, a negative errno will
587 * be returned in error cases.
588 */
589int regmap_write(struct regmap *map, unsigned int reg, unsigned int val)
590{
591 int ret;
592
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600593 map->lock(map);
Mark Brownb83a3132011-05-11 19:59:58 +0200594
595 ret = _regmap_write(map, reg, val);
596
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600597 map->unlock(map);
Mark Brownb83a3132011-05-11 19:59:58 +0200598
599 return ret;
600}
601EXPORT_SYMBOL_GPL(regmap_write);
602
603/**
604 * regmap_raw_write(): Write raw values to one or more registers
605 *
606 * @map: Register map to write to
607 * @reg: Initial register to write to
608 * @val: Block of data to be written, laid out for direct transmission to the
609 * device
610 * @val_len: Length of data pointed to by val.
611 *
612 * This function is intended to be used for things like firmware
613 * download where a large block of data needs to be transferred to the
614 * device. No formatting will be done on the data provided.
615 *
616 * A value of zero will be returned on success, a negative errno will
617 * be returned in error cases.
618 */
619int regmap_raw_write(struct regmap *map, unsigned int reg,
620 const void *val, size_t val_len)
621{
622 int ret;
623
Stephen Warren851960b2012-04-06 15:16:03 -0600624 if (val_len % map->format.val_bytes)
625 return -EINVAL;
626
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600627 map->lock(map);
Mark Brownb83a3132011-05-11 19:59:58 +0200628
629 ret = _regmap_raw_write(map, reg, val, val_len);
630
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600631 map->unlock(map);
Mark Brownb83a3132011-05-11 19:59:58 +0200632
633 return ret;
634}
635EXPORT_SYMBOL_GPL(regmap_raw_write);
636
Laxman Dewangan8eaeb212012-02-12 19:49:43 +0530637/*
638 * regmap_bulk_write(): Write multiple registers to the device
639 *
640 * @map: Register map to write to
641 * @reg: First register to be write from
642 * @val: Block of data to be written, in native register size for device
643 * @val_count: Number of registers to write
644 *
645 * This function is intended to be used for writing a large block of
646 * data to be device either in single transfer or multiple transfer.
647 *
648 * A value of zero will be returned on success, a negative errno will
649 * be returned in error cases.
650 */
651int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
652 size_t val_count)
653{
654 int ret = 0, i;
655 size_t val_bytes = map->format.val_bytes;
656 void *wval;
657
658 if (!map->format.parse_val)
659 return -EINVAL;
660
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600661 map->lock(map);
Laxman Dewangan8eaeb212012-02-12 19:49:43 +0530662
663 /* No formatting is require if val_byte is 1 */
664 if (val_bytes == 1) {
665 wval = (void *)val;
666 } else {
667 wval = kmemdup(val, val_count * val_bytes, GFP_KERNEL);
668 if (!wval) {
669 ret = -ENOMEM;
670 dev_err(map->dev, "Error in memory allocation\n");
671 goto out;
672 }
673 for (i = 0; i < val_count * val_bytes; i += val_bytes)
674 map->format.parse_val(wval + i);
675 }
676 ret = _regmap_raw_write(map, reg, wval, val_bytes * val_count);
677
678 if (val_bytes != 1)
679 kfree(wval);
680
681out:
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600682 map->unlock(map);
Laxman Dewangan8eaeb212012-02-12 19:49:43 +0530683 return ret;
684}
685EXPORT_SYMBOL_GPL(regmap_bulk_write);
686
Mark Brownb83a3132011-05-11 19:59:58 +0200687static int _regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
688 unsigned int val_len)
689{
690 u8 *u8 = map->work_buf;
691 int ret;
692
Marc Reillyd939fb92012-03-16 12:11:43 +1100693 map->format.format_reg(map->work_buf, reg, map->reg_shift);
Mark Brownb83a3132011-05-11 19:59:58 +0200694
695 /*
Lars-Peter Clausen6f306442011-09-05 20:46:32 +0200696 * Some buses or devices flag reads by setting the high bits in the
Mark Brownb83a3132011-05-11 19:59:58 +0200697 * register addresss; since it's always the high bits for all
698 * current formats we can do this here rather than in
699 * formatting. This may break if we get interesting formats.
700 */
Lars-Peter Clausen6f306442011-09-05 20:46:32 +0200701 u8[0] |= map->read_flag_mask;
Mark Brownb83a3132011-05-11 19:59:58 +0200702
Mark Brownfb2736b2011-07-24 21:30:55 +0100703 trace_regmap_hw_read_start(map->dev, reg,
704 val_len / map->format.val_bytes);
705
Stephen Warren0135bbc2012-04-04 15:48:30 -0600706 ret = map->bus->read(map->bus_context, map->work_buf,
Mark Brown82159ba2012-01-18 10:52:25 +0000707 map->format.reg_bytes + map->format.pad_bytes,
Mark Brown40c5cc22011-07-24 22:39:12 +0100708 val, val_len);
Mark Brownb83a3132011-05-11 19:59:58 +0200709
Mark Brownfb2736b2011-07-24 21:30:55 +0100710 trace_regmap_hw_read_done(map->dev, reg,
711 val_len / map->format.val_bytes);
712
713 return ret;
Mark Brownb83a3132011-05-11 19:59:58 +0200714}
715
716static int _regmap_read(struct regmap *map, unsigned int reg,
717 unsigned int *val)
718{
719 int ret;
720
Dimitris Papastamos5d1729e2011-09-19 14:34:05 +0100721 if (!map->cache_bypass) {
722 ret = regcache_read(map, reg, val);
723 if (ret == 0)
724 return 0;
725 }
726
Lars-Peter Clausen19254412011-11-16 16:28:19 +0100727 if (!map->format.parse_val)
728 return -EINVAL;
729
Dimitris Papastamos5d1729e2011-09-19 14:34:05 +0100730 if (map->cache_only)
731 return -EBUSY;
732
Mark Brownb83a3132011-05-11 19:59:58 +0200733 ret = _regmap_raw_read(map, reg, map->work_buf, map->format.val_bytes);
Mark Brownfb2736b2011-07-24 21:30:55 +0100734 if (ret == 0) {
Mark Brownb83a3132011-05-11 19:59:58 +0200735 *val = map->format.parse_val(map->work_buf);
Mark Brownfb2736b2011-07-24 21:30:55 +0100736 trace_regmap_reg_read(map->dev, reg, *val);
737 }
Mark Brownb83a3132011-05-11 19:59:58 +0200738
739 return ret;
740}
741
742/**
743 * regmap_read(): Read a value from a single register
744 *
745 * @map: Register map to write to
746 * @reg: Register to be read from
747 * @val: Pointer to store read value
748 *
749 * A value of zero will be returned on success, a negative errno will
750 * be returned in error cases.
751 */
752int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val)
753{
754 int ret;
755
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600756 map->lock(map);
Mark Brownb83a3132011-05-11 19:59:58 +0200757
758 ret = _regmap_read(map, reg, val);
759
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600760 map->unlock(map);
Mark Brownb83a3132011-05-11 19:59:58 +0200761
762 return ret;
763}
764EXPORT_SYMBOL_GPL(regmap_read);
765
766/**
767 * regmap_raw_read(): Read raw data from the device
768 *
769 * @map: Register map to write to
770 * @reg: First register to be read from
771 * @val: Pointer to store read value
772 * @val_len: Size of data to read
773 *
774 * A value of zero will be returned on success, a negative errno will
775 * be returned in error cases.
776 */
777int regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
778 size_t val_len)
779{
Mark Brownb8fb5ab2012-02-21 19:12:47 +0000780 size_t val_bytes = map->format.val_bytes;
781 size_t val_count = val_len / val_bytes;
782 unsigned int v;
783 int ret, i;
Mark Brown04e016a2011-10-09 13:35:43 +0100784
Stephen Warren851960b2012-04-06 15:16:03 -0600785 if (val_len % map->format.val_bytes)
786 return -EINVAL;
787
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600788 map->lock(map);
Mark Brownb83a3132011-05-11 19:59:58 +0200789
Mark Brownb8fb5ab2012-02-21 19:12:47 +0000790 if (regmap_volatile_range(map, reg, val_count) || map->cache_bypass ||
791 map->cache_type == REGCACHE_NONE) {
792 /* Physical block read if there's no cache involved */
793 ret = _regmap_raw_read(map, reg, val, val_len);
Mark Brownb83a3132011-05-11 19:59:58 +0200794
Mark Brownb8fb5ab2012-02-21 19:12:47 +0000795 } else {
796 /* Otherwise go word by word for the cache; should be low
797 * cost as we expect to hit the cache.
798 */
799 for (i = 0; i < val_count; i++) {
800 ret = _regmap_read(map, reg + i, &v);
801 if (ret != 0)
802 goto out;
803
Marc Reillyd939fb92012-03-16 12:11:43 +1100804 map->format.format_val(val + (i * val_bytes), v, 0);
Mark Brownb8fb5ab2012-02-21 19:12:47 +0000805 }
806 }
807
808 out:
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600809 map->unlock(map);
Mark Brownb83a3132011-05-11 19:59:58 +0200810
811 return ret;
812}
813EXPORT_SYMBOL_GPL(regmap_raw_read);
814
815/**
816 * regmap_bulk_read(): Read multiple registers from the device
817 *
818 * @map: Register map to write to
819 * @reg: First register to be read from
820 * @val: Pointer to store read value, in native register size for device
821 * @val_count: Number of registers to read
822 *
823 * A value of zero will be returned on success, a negative errno will
824 * be returned in error cases.
825 */
826int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
827 size_t val_count)
828{
829 int ret, i;
830 size_t val_bytes = map->format.val_bytes;
Lars-Peter Clausen82cd9962011-11-08 18:37:25 +0100831 bool vol = regmap_volatile_range(map, reg, val_count);
Dimitris Papastamos5d1729e2011-09-19 14:34:05 +0100832
Mark Brownb83a3132011-05-11 19:59:58 +0200833 if (!map->format.parse_val)
834 return -EINVAL;
835
Mark Brownde2d8082011-10-10 13:24:52 +0100836 if (vol || map->cache_type == REGCACHE_NONE) {
837 ret = regmap_raw_read(map, reg, val, val_bytes * val_count);
838 if (ret != 0)
839 return ret;
840
841 for (i = 0; i < val_count * val_bytes; i += val_bytes)
842 map->format.parse_val(val + i);
843 } else {
844 for (i = 0; i < val_count; i++) {
845 ret = regmap_read(map, reg + i, val + (i * val_bytes));
846 if (ret != 0)
847 return ret;
848 }
849 }
Mark Brownb83a3132011-05-11 19:59:58 +0200850
851 return 0;
852}
853EXPORT_SYMBOL_GPL(regmap_bulk_read);
854
Mark Brown018690d2011-11-29 20:10:36 +0000855static int _regmap_update_bits(struct regmap *map, unsigned int reg,
856 unsigned int mask, unsigned int val,
857 bool *change)
Mark Brownb83a3132011-05-11 19:59:58 +0200858{
859 int ret;
Mark Brownd91e8db22011-11-18 16:03:50 +0000860 unsigned int tmp, orig;
Mark Brownb83a3132011-05-11 19:59:58 +0200861
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600862 map->lock(map);
Mark Brownb83a3132011-05-11 19:59:58 +0200863
Mark Brownd91e8db22011-11-18 16:03:50 +0000864 ret = _regmap_read(map, reg, &orig);
Mark Brownb83a3132011-05-11 19:59:58 +0200865 if (ret != 0)
866 goto out;
867
Mark Brownd91e8db22011-11-18 16:03:50 +0000868 tmp = orig & ~mask;
Mark Brownb83a3132011-05-11 19:59:58 +0200869 tmp |= val & mask;
870
Mark Brown018690d2011-11-29 20:10:36 +0000871 if (tmp != orig) {
Mark Brownd91e8db22011-11-18 16:03:50 +0000872 ret = _regmap_write(map, reg, tmp);
Mark Brown018690d2011-11-29 20:10:36 +0000873 *change = true;
874 } else {
875 *change = false;
876 }
Mark Brownb83a3132011-05-11 19:59:58 +0200877
878out:
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600879 map->unlock(map);
Mark Brownb83a3132011-05-11 19:59:58 +0200880
881 return ret;
882}
Mark Brown018690d2011-11-29 20:10:36 +0000883
884/**
885 * regmap_update_bits: Perform a read/modify/write cycle on the register map
886 *
887 * @map: Register map to update
888 * @reg: Register to update
889 * @mask: Bitmask to change
890 * @val: New value for bitmask
891 *
892 * Returns zero for success, a negative number on error.
893 */
894int regmap_update_bits(struct regmap *map, unsigned int reg,
895 unsigned int mask, unsigned int val)
896{
897 bool change;
898 return _regmap_update_bits(map, reg, mask, val, &change);
899}
Mark Brownb83a3132011-05-11 19:59:58 +0200900EXPORT_SYMBOL_GPL(regmap_update_bits);
Mark Brown31244e32011-07-20 22:56:53 +0100901
Mark Brown018690d2011-11-29 20:10:36 +0000902/**
903 * regmap_update_bits_check: Perform a read/modify/write cycle on the
904 * register map and report if updated
905 *
906 * @map: Register map to update
907 * @reg: Register to update
908 * @mask: Bitmask to change
909 * @val: New value for bitmask
910 * @change: Boolean indicating if a write was done
911 *
912 * Returns zero for success, a negative number on error.
913 */
914int regmap_update_bits_check(struct regmap *map, unsigned int reg,
915 unsigned int mask, unsigned int val,
916 bool *change)
917{
918 return _regmap_update_bits(map, reg, mask, val, change);
919}
920EXPORT_SYMBOL_GPL(regmap_update_bits_check);
921
Mark Brown22f0d902012-01-21 12:01:14 +0000922/**
923 * regmap_register_patch: Register and apply register updates to be applied
924 * on device initialistion
925 *
926 * @map: Register map to apply updates to.
927 * @regs: Values to update.
928 * @num_regs: Number of entries in regs.
929 *
930 * Register a set of register updates to be applied to the device
931 * whenever the device registers are synchronised with the cache and
932 * apply them immediately. Typically this is used to apply
933 * corrections to be applied to the device defaults on startup, such
934 * as the updates some vendors provide to undocumented registers.
935 */
936int regmap_register_patch(struct regmap *map, const struct reg_default *regs,
937 int num_regs)
938{
939 int i, ret;
940 bool bypass;
941
942 /* If needed the implementation can be extended to support this */
943 if (map->patch)
944 return -EBUSY;
945
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600946 map->lock(map);
Mark Brown22f0d902012-01-21 12:01:14 +0000947
948 bypass = map->cache_bypass;
949
950 map->cache_bypass = true;
951
952 /* Write out first; it's useful to apply even if we fail later. */
953 for (i = 0; i < num_regs; i++) {
954 ret = _regmap_write(map, regs[i].reg, regs[i].def);
955 if (ret != 0) {
956 dev_err(map->dev, "Failed to write %x = %x: %d\n",
957 regs[i].reg, regs[i].def, ret);
958 goto out;
959 }
960 }
961
Axel Lin2a14d7d92012-02-10 19:29:55 +0800962 map->patch = kcalloc(num_regs, sizeof(struct reg_default), GFP_KERNEL);
Mark Brown22f0d902012-01-21 12:01:14 +0000963 if (map->patch != NULL) {
964 memcpy(map->patch, regs,
965 num_regs * sizeof(struct reg_default));
966 map->patch_regs = num_regs;
967 } else {
968 ret = -ENOMEM;
969 }
970
971out:
972 map->cache_bypass = bypass;
973
Stephen Warrenbacdbe02012-04-04 15:48:28 -0600974 map->unlock(map);
Mark Brown22f0d902012-01-21 12:01:14 +0000975
976 return ret;
977}
978EXPORT_SYMBOL_GPL(regmap_register_patch);
979
Mark Browneae4b512012-03-14 13:15:03 +0000980/*
Mark Browna6539c32012-02-17 14:20:14 -0800981 * regmap_get_val_bytes(): Report the size of a register value
982 *
983 * Report the size of a register value, mainly intended to for use by
984 * generic infrastructure built on top of regmap.
985 */
986int regmap_get_val_bytes(struct regmap *map)
987{
988 if (map->format.format_write)
989 return -EINVAL;
990
991 return map->format.val_bytes;
992}
993EXPORT_SYMBOL_GPL(regmap_get_val_bytes);
994
Mark Brown31244e32011-07-20 22:56:53 +0100995static int __init regmap_initcall(void)
996{
997 regmap_debugfs_initcall();
998
999 return 0;
1000}
1001postcore_initcall(regmap_initcall);