Commit | Line | Data |
---|---|---|
b83a313b MB |
1 | /* |
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 | ||
13 | #include <linux/slab.h> | |
14 | #include <linux/module.h> | |
15 | #include <linux/mutex.h> | |
16 | #include <linux/err.h> | |
17 | ||
fb2736bb MB |
18 | #define CREATE_TRACE_POINTS |
19 | #include <trace/events/regmap.h> | |
20 | ||
93de9124 | 21 | #include "internal.h" |
b83a313b | 22 | |
8de2f081 MB |
23 | bool regmap_writeable(struct regmap *map, unsigned int reg) |
24 | { | |
25 | if (map->max_register && reg > map->max_register) | |
26 | return false; | |
27 | ||
28 | if (map->writeable_reg) | |
29 | return map->writeable_reg(map->dev, reg); | |
30 | ||
31 | return true; | |
32 | } | |
33 | ||
34 | bool regmap_readable(struct regmap *map, unsigned int reg) | |
35 | { | |
36 | if (map->max_register && reg > map->max_register) | |
37 | return false; | |
38 | ||
39 | if (map->readable_reg) | |
40 | return map->readable_reg(map->dev, reg); | |
41 | ||
42 | return true; | |
43 | } | |
44 | ||
45 | bool regmap_volatile(struct regmap *map, unsigned int reg) | |
46 | { | |
47 | if (map->max_register && reg > map->max_register) | |
48 | return false; | |
49 | ||
50 | if (map->volatile_reg) | |
51 | return map->volatile_reg(map->dev, reg); | |
52 | ||
53 | return true; | |
54 | } | |
55 | ||
56 | bool regmap_precious(struct regmap *map, unsigned int reg) | |
57 | { | |
58 | if (map->max_register && reg > map->max_register) | |
59 | return false; | |
60 | ||
61 | if (map->precious_reg) | |
62 | return map->precious_reg(map->dev, reg); | |
63 | ||
64 | return false; | |
65 | } | |
66 | ||
82cd9965 LPC |
67 | static bool regmap_volatile_range(struct regmap *map, unsigned int reg, |
68 | unsigned int num) | |
69 | { | |
70 | unsigned int i; | |
71 | ||
72 | for (i = 0; i < num; i++) | |
73 | if (!regmap_volatile(map, reg + i)) | |
74 | return false; | |
75 | ||
76 | return true; | |
77 | } | |
78 | ||
b83a313b MB |
79 | static void regmap_format_4_12_write(struct regmap *map, |
80 | unsigned int reg, unsigned int val) | |
81 | { | |
82 | __be16 *out = map->work_buf; | |
83 | *out = cpu_to_be16((reg << 12) | val); | |
84 | } | |
85 | ||
86 | static void regmap_format_7_9_write(struct regmap *map, | |
87 | unsigned int reg, unsigned int val) | |
88 | { | |
89 | __be16 *out = map->work_buf; | |
90 | *out = cpu_to_be16((reg << 9) | val); | |
91 | } | |
92 | ||
93 | static void regmap_format_8(void *buf, unsigned int val) | |
94 | { | |
95 | u8 *b = buf; | |
96 | ||
97 | b[0] = val; | |
98 | } | |
99 | ||
100 | static void regmap_format_16(void *buf, unsigned int val) | |
101 | { | |
102 | __be16 *b = buf; | |
103 | ||
104 | b[0] = cpu_to_be16(val); | |
105 | } | |
106 | ||
107 | static unsigned int regmap_parse_8(void *buf) | |
108 | { | |
109 | u8 *b = buf; | |
110 | ||
111 | return b[0]; | |
112 | } | |
113 | ||
114 | static unsigned int regmap_parse_16(void *buf) | |
115 | { | |
116 | __be16 *b = buf; | |
117 | ||
118 | b[0] = be16_to_cpu(b[0]); | |
119 | ||
120 | return b[0]; | |
121 | } | |
122 | ||
123 | /** | |
124 | * regmap_init(): Initialise register map | |
125 | * | |
126 | * @dev: Device that will be interacted with | |
127 | * @bus: Bus-specific callbacks to use with device | |
128 | * @config: Configuration for register map | |
129 | * | |
130 | * The return value will be an ERR_PTR() on error or a valid pointer to | |
131 | * a struct regmap. This function should generally not be called | |
132 | * directly, it should be called by bus-specific init functions. | |
133 | */ | |
134 | struct regmap *regmap_init(struct device *dev, | |
135 | const struct regmap_bus *bus, | |
136 | const struct regmap_config *config) | |
137 | { | |
138 | struct regmap *map; | |
139 | int ret = -EINVAL; | |
140 | ||
141 | if (!bus || !config) | |
abbb18fb | 142 | goto err; |
b83a313b MB |
143 | |
144 | map = kzalloc(sizeof(*map), GFP_KERNEL); | |
145 | if (map == NULL) { | |
146 | ret = -ENOMEM; | |
147 | goto err; | |
148 | } | |
149 | ||
150 | mutex_init(&map->lock); | |
151 | map->format.buf_size = (config->reg_bits + config->val_bits) / 8; | |
152 | map->format.reg_bytes = config->reg_bits / 8; | |
153 | map->format.val_bytes = config->val_bits / 8; | |
154 | map->dev = dev; | |
155 | map->bus = bus; | |
2e2ae66d MB |
156 | map->max_register = config->max_register; |
157 | map->writeable_reg = config->writeable_reg; | |
158 | map->readable_reg = config->readable_reg; | |
159 | map->volatile_reg = config->volatile_reg; | |
2efe1642 | 160 | map->precious_reg = config->precious_reg; |
5d1729e7 DP |
161 | map->cache_type = config->cache_type; |
162 | map->reg_defaults = config->reg_defaults; | |
163 | map->num_reg_defaults = config->num_reg_defaults; | |
164 | map->num_reg_defaults_raw = config->num_reg_defaults_raw; | |
165 | map->reg_defaults_raw = config->reg_defaults_raw; | |
166 | map->cache_size_raw = (config->val_bits / 8) * config->num_reg_defaults_raw; | |
167 | map->cache_word_size = config->val_bits / 8; | |
b83a313b | 168 | |
6f306441 LPC |
169 | if (config->read_flag_mask || config->write_flag_mask) { |
170 | map->read_flag_mask = config->read_flag_mask; | |
171 | map->write_flag_mask = config->write_flag_mask; | |
172 | } else { | |
173 | map->read_flag_mask = bus->read_flag_mask; | |
174 | } | |
175 | ||
b83a313b MB |
176 | switch (config->reg_bits) { |
177 | case 4: | |
178 | switch (config->val_bits) { | |
179 | case 12: | |
180 | map->format.format_write = regmap_format_4_12_write; | |
181 | break; | |
182 | default: | |
183 | goto err_map; | |
184 | } | |
185 | break; | |
186 | ||
187 | case 7: | |
188 | switch (config->val_bits) { | |
189 | case 9: | |
190 | map->format.format_write = regmap_format_7_9_write; | |
191 | break; | |
192 | default: | |
193 | goto err_map; | |
194 | } | |
195 | break; | |
196 | ||
197 | case 8: | |
198 | map->format.format_reg = regmap_format_8; | |
199 | break; | |
200 | ||
201 | case 16: | |
202 | map->format.format_reg = regmap_format_16; | |
203 | break; | |
204 | ||
205 | default: | |
206 | goto err_map; | |
207 | } | |
208 | ||
209 | switch (config->val_bits) { | |
210 | case 8: | |
211 | map->format.format_val = regmap_format_8; | |
212 | map->format.parse_val = regmap_parse_8; | |
213 | break; | |
214 | case 16: | |
215 | map->format.format_val = regmap_format_16; | |
216 | map->format.parse_val = regmap_parse_16; | |
217 | break; | |
218 | } | |
219 | ||
220 | if (!map->format.format_write && | |
221 | !(map->format.format_reg && map->format.format_val)) | |
222 | goto err_map; | |
223 | ||
224 | map->work_buf = kmalloc(map->format.buf_size, GFP_KERNEL); | |
225 | if (map->work_buf == NULL) { | |
226 | ret = -ENOMEM; | |
5204f5e3 | 227 | goto err_map; |
b83a313b MB |
228 | } |
229 | ||
5d1729e7 DP |
230 | ret = regcache_init(map); |
231 | if (ret < 0) | |
58072cbf | 232 | goto err_free_workbuf; |
5d1729e7 | 233 | |
31244e39 MB |
234 | regmap_debugfs_init(map); |
235 | ||
b83a313b MB |
236 | return map; |
237 | ||
58072cbf LPC |
238 | err_free_workbuf: |
239 | kfree(map->work_buf); | |
b83a313b MB |
240 | err_map: |
241 | kfree(map); | |
242 | err: | |
243 | return ERR_PTR(ret); | |
244 | } | |
245 | EXPORT_SYMBOL_GPL(regmap_init); | |
246 | ||
247 | /** | |
248 | * regmap_exit(): Free a previously allocated register map | |
249 | */ | |
250 | void regmap_exit(struct regmap *map) | |
251 | { | |
5d1729e7 | 252 | regcache_exit(map); |
31244e39 | 253 | regmap_debugfs_exit(map); |
b83a313b | 254 | kfree(map->work_buf); |
b83a313b MB |
255 | kfree(map); |
256 | } | |
257 | EXPORT_SYMBOL_GPL(regmap_exit); | |
258 | ||
259 | static int _regmap_raw_write(struct regmap *map, unsigned int reg, | |
260 | const void *val, size_t val_len) | |
261 | { | |
6f306441 | 262 | u8 *u8 = map->work_buf; |
b83a313b MB |
263 | void *buf; |
264 | int ret = -ENOTSUPP; | |
265 | size_t len; | |
73304781 MB |
266 | int i; |
267 | ||
268 | /* Check for unwritable registers before we start */ | |
269 | if (map->writeable_reg) | |
270 | for (i = 0; i < val_len / map->format.val_bytes; i++) | |
271 | if (!map->writeable_reg(map->dev, reg + i)) | |
272 | return -EINVAL; | |
b83a313b MB |
273 | |
274 | map->format.format_reg(map->work_buf, reg); | |
275 | ||
6f306441 LPC |
276 | u8[0] |= map->write_flag_mask; |
277 | ||
fb2736bb MB |
278 | trace_regmap_hw_write_start(map->dev, reg, |
279 | val_len / map->format.val_bytes); | |
280 | ||
2547e201 MB |
281 | /* If we're doing a single register write we can probably just |
282 | * send the work_buf directly, otherwise try to do a gather | |
283 | * write. | |
284 | */ | |
285 | if (val == map->work_buf + map->format.reg_bytes) | |
286 | ret = map->bus->write(map->dev, map->work_buf, | |
287 | map->format.reg_bytes + val_len); | |
288 | else if (map->bus->gather_write) | |
b83a313b MB |
289 | ret = map->bus->gather_write(map->dev, map->work_buf, |
290 | map->format.reg_bytes, | |
291 | val, val_len); | |
292 | ||
2547e201 | 293 | /* If that didn't work fall back on linearising by hand. */ |
b83a313b MB |
294 | if (ret == -ENOTSUPP) { |
295 | len = map->format.reg_bytes + val_len; | |
296 | buf = kmalloc(len, GFP_KERNEL); | |
297 | if (!buf) | |
298 | return -ENOMEM; | |
299 | ||
300 | memcpy(buf, map->work_buf, map->format.reg_bytes); | |
301 | memcpy(buf + map->format.reg_bytes, val, val_len); | |
302 | ret = map->bus->write(map->dev, buf, len); | |
303 | ||
304 | kfree(buf); | |
305 | } | |
306 | ||
fb2736bb MB |
307 | trace_regmap_hw_write_done(map->dev, reg, |
308 | val_len / map->format.val_bytes); | |
309 | ||
b83a313b MB |
310 | return ret; |
311 | } | |
312 | ||
4d2dc095 DP |
313 | int _regmap_write(struct regmap *map, unsigned int reg, |
314 | unsigned int val) | |
b83a313b | 315 | { |
fb2736bb | 316 | int ret; |
b83a313b MB |
317 | BUG_ON(!map->format.format_write && !map->format.format_val); |
318 | ||
5d1729e7 DP |
319 | if (!map->cache_bypass) { |
320 | ret = regcache_write(map, reg, val); | |
321 | if (ret != 0) | |
322 | return ret; | |
8ae0d7e8 MB |
323 | if (map->cache_only) { |
324 | map->cache_dirty = true; | |
5d1729e7 | 325 | return 0; |
8ae0d7e8 | 326 | } |
5d1729e7 DP |
327 | } |
328 | ||
fb2736bb MB |
329 | trace_regmap_reg_write(map->dev, reg, val); |
330 | ||
b83a313b MB |
331 | if (map->format.format_write) { |
332 | map->format.format_write(map, reg, val); | |
333 | ||
fb2736bb MB |
334 | trace_regmap_hw_write_start(map->dev, reg, 1); |
335 | ||
336 | ret = map->bus->write(map->dev, map->work_buf, | |
337 | map->format.buf_size); | |
338 | ||
339 | trace_regmap_hw_write_done(map->dev, reg, 1); | |
340 | ||
341 | return ret; | |
b83a313b MB |
342 | } else { |
343 | map->format.format_val(map->work_buf + map->format.reg_bytes, | |
344 | val); | |
345 | return _regmap_raw_write(map, reg, | |
346 | map->work_buf + map->format.reg_bytes, | |
347 | map->format.val_bytes); | |
348 | } | |
349 | } | |
350 | ||
351 | /** | |
352 | * regmap_write(): Write a value to a single register | |
353 | * | |
354 | * @map: Register map to write to | |
355 | * @reg: Register to write to | |
356 | * @val: Value to be written | |
357 | * | |
358 | * A value of zero will be returned on success, a negative errno will | |
359 | * be returned in error cases. | |
360 | */ | |
361 | int regmap_write(struct regmap *map, unsigned int reg, unsigned int val) | |
362 | { | |
363 | int ret; | |
364 | ||
365 | mutex_lock(&map->lock); | |
366 | ||
367 | ret = _regmap_write(map, reg, val); | |
368 | ||
369 | mutex_unlock(&map->lock); | |
370 | ||
371 | return ret; | |
372 | } | |
373 | EXPORT_SYMBOL_GPL(regmap_write); | |
374 | ||
375 | /** | |
376 | * regmap_raw_write(): Write raw values to one or more registers | |
377 | * | |
378 | * @map: Register map to write to | |
379 | * @reg: Initial register to write to | |
380 | * @val: Block of data to be written, laid out for direct transmission to the | |
381 | * device | |
382 | * @val_len: Length of data pointed to by val. | |
383 | * | |
384 | * This function is intended to be used for things like firmware | |
385 | * download where a large block of data needs to be transferred to the | |
386 | * device. No formatting will be done on the data provided. | |
387 | * | |
388 | * A value of zero will be returned on success, a negative errno will | |
389 | * be returned in error cases. | |
390 | */ | |
391 | int regmap_raw_write(struct regmap *map, unsigned int reg, | |
392 | const void *val, size_t val_len) | |
393 | { | |
c48a9d74 | 394 | size_t val_count = val_len / map->format.val_bytes; |
b83a313b MB |
395 | int ret; |
396 | ||
c48a9d74 LPC |
397 | WARN_ON(!regmap_volatile_range(map, reg, val_count) && |
398 | map->cache_type != REGCACHE_NONE); | |
04e016ad | 399 | |
b83a313b MB |
400 | mutex_lock(&map->lock); |
401 | ||
402 | ret = _regmap_raw_write(map, reg, val, val_len); | |
403 | ||
404 | mutex_unlock(&map->lock); | |
405 | ||
406 | return ret; | |
407 | } | |
408 | EXPORT_SYMBOL_GPL(regmap_raw_write); | |
409 | ||
410 | static int _regmap_raw_read(struct regmap *map, unsigned int reg, void *val, | |
411 | unsigned int val_len) | |
412 | { | |
413 | u8 *u8 = map->work_buf; | |
414 | int ret; | |
415 | ||
416 | map->format.format_reg(map->work_buf, reg); | |
417 | ||
418 | /* | |
6f306441 | 419 | * Some buses or devices flag reads by setting the high bits in the |
b83a313b MB |
420 | * register addresss; since it's always the high bits for all |
421 | * current formats we can do this here rather than in | |
422 | * formatting. This may break if we get interesting formats. | |
423 | */ | |
6f306441 | 424 | u8[0] |= map->read_flag_mask; |
b83a313b | 425 | |
fb2736bb MB |
426 | trace_regmap_hw_read_start(map->dev, reg, |
427 | val_len / map->format.val_bytes); | |
428 | ||
b83a313b | 429 | ret = map->bus->read(map->dev, map->work_buf, map->format.reg_bytes, |
40c5cc26 | 430 | val, val_len); |
b83a313b | 431 | |
fb2736bb MB |
432 | trace_regmap_hw_read_done(map->dev, reg, |
433 | val_len / map->format.val_bytes); | |
434 | ||
435 | return ret; | |
b83a313b MB |
436 | } |
437 | ||
438 | static int _regmap_read(struct regmap *map, unsigned int reg, | |
439 | unsigned int *val) | |
440 | { | |
441 | int ret; | |
442 | ||
443 | if (!map->format.parse_val) | |
444 | return -EINVAL; | |
445 | ||
5d1729e7 DP |
446 | if (!map->cache_bypass) { |
447 | ret = regcache_read(map, reg, val); | |
448 | if (ret == 0) | |
449 | return 0; | |
450 | } | |
451 | ||
452 | if (map->cache_only) | |
453 | return -EBUSY; | |
454 | ||
b83a313b | 455 | ret = _regmap_raw_read(map, reg, map->work_buf, map->format.val_bytes); |
fb2736bb | 456 | if (ret == 0) { |
b83a313b | 457 | *val = map->format.parse_val(map->work_buf); |
fb2736bb MB |
458 | trace_regmap_reg_read(map->dev, reg, *val); |
459 | } | |
b83a313b MB |
460 | |
461 | return ret; | |
462 | } | |
463 | ||
464 | /** | |
465 | * regmap_read(): Read a value from a single register | |
466 | * | |
467 | * @map: Register map to write to | |
468 | * @reg: Register to be read from | |
469 | * @val: Pointer to store read value | |
470 | * | |
471 | * A value of zero will be returned on success, a negative errno will | |
472 | * be returned in error cases. | |
473 | */ | |
474 | int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val) | |
475 | { | |
476 | int ret; | |
477 | ||
478 | mutex_lock(&map->lock); | |
479 | ||
480 | ret = _regmap_read(map, reg, val); | |
481 | ||
482 | mutex_unlock(&map->lock); | |
483 | ||
484 | return ret; | |
485 | } | |
486 | EXPORT_SYMBOL_GPL(regmap_read); | |
487 | ||
488 | /** | |
489 | * regmap_raw_read(): Read raw data from the device | |
490 | * | |
491 | * @map: Register map to write to | |
492 | * @reg: First register to be read from | |
493 | * @val: Pointer to store read value | |
494 | * @val_len: Size of data to read | |
495 | * | |
496 | * A value of zero will be returned on success, a negative errno will | |
497 | * be returned in error cases. | |
498 | */ | |
499 | int regmap_raw_read(struct regmap *map, unsigned int reg, void *val, | |
500 | size_t val_len) | |
501 | { | |
82cd9965 | 502 | size_t val_count = val_len / map->format.val_bytes; |
b83a313b | 503 | int ret; |
de2d808f | 504 | |
82cd9965 LPC |
505 | WARN_ON(!regmap_volatile_range(map, reg, val_count) && |
506 | map->cache_type != REGCACHE_NONE); | |
04e016ad | 507 | |
b83a313b MB |
508 | mutex_lock(&map->lock); |
509 | ||
510 | ret = _regmap_raw_read(map, reg, val, val_len); | |
511 | ||
512 | mutex_unlock(&map->lock); | |
513 | ||
514 | return ret; | |
515 | } | |
516 | EXPORT_SYMBOL_GPL(regmap_raw_read); | |
517 | ||
518 | /** | |
519 | * regmap_bulk_read(): Read multiple registers from the device | |
520 | * | |
521 | * @map: Register map to write to | |
522 | * @reg: First register to be read from | |
523 | * @val: Pointer to store read value, in native register size for device | |
524 | * @val_count: Number of registers to read | |
525 | * | |
526 | * A value of zero will be returned on success, a negative errno will | |
527 | * be returned in error cases. | |
528 | */ | |
529 | int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val, | |
530 | size_t val_count) | |
531 | { | |
532 | int ret, i; | |
533 | size_t val_bytes = map->format.val_bytes; | |
82cd9965 | 534 | bool vol = regmap_volatile_range(map, reg, val_count); |
5d1729e7 | 535 | |
b83a313b MB |
536 | if (!map->format.parse_val) |
537 | return -EINVAL; | |
538 | ||
de2d808f MB |
539 | if (vol || map->cache_type == REGCACHE_NONE) { |
540 | ret = regmap_raw_read(map, reg, val, val_bytes * val_count); | |
541 | if (ret != 0) | |
542 | return ret; | |
543 | ||
544 | for (i = 0; i < val_count * val_bytes; i += val_bytes) | |
545 | map->format.parse_val(val + i); | |
546 | } else { | |
547 | for (i = 0; i < val_count; i++) { | |
548 | ret = regmap_read(map, reg + i, val + (i * val_bytes)); | |
549 | if (ret != 0) | |
550 | return ret; | |
551 | } | |
552 | } | |
b83a313b MB |
553 | |
554 | return 0; | |
555 | } | |
556 | EXPORT_SYMBOL_GPL(regmap_bulk_read); | |
557 | ||
558 | /** | |
b973aa36 | 559 | * regmap_update_bits: Perform a read/modify/write cycle on the register map |
b83a313b MB |
560 | * |
561 | * @map: Register map to update | |
562 | * @reg: Register to update | |
563 | * @mask: Bitmask to change | |
564 | * @val: New value for bitmask | |
565 | * | |
566 | * Returns zero for success, a negative number on error. | |
567 | */ | |
568 | int regmap_update_bits(struct regmap *map, unsigned int reg, | |
569 | unsigned int mask, unsigned int val) | |
570 | { | |
571 | int ret; | |
572 | unsigned int tmp; | |
573 | ||
574 | mutex_lock(&map->lock); | |
575 | ||
576 | ret = _regmap_read(map, reg, &tmp); | |
577 | if (ret != 0) | |
578 | goto out; | |
579 | ||
580 | tmp &= ~mask; | |
581 | tmp |= val & mask; | |
582 | ||
583 | ret = _regmap_write(map, reg, tmp); | |
584 | ||
585 | out: | |
586 | mutex_unlock(&map->lock); | |
587 | ||
588 | return ret; | |
589 | } | |
590 | EXPORT_SYMBOL_GPL(regmap_update_bits); | |
31244e39 MB |
591 | |
592 | static int __init regmap_initcall(void) | |
593 | { | |
594 | regmap_debugfs_initcall(); | |
595 | ||
596 | return 0; | |
597 | } | |
598 | postcore_initcall(regmap_initcall); |