1 // SPDX-License-Identifier: GPL-2.0
2 //
3 // Register map access API
4 //
5 // Copyright 2011 Wolfson Microelectronics plc
6 //
7 // Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
8
9 #include <linux/device.h>
10 #include <linux/slab.h>
11 #include <linux/export.h>
12 #include <linux/mutex.h>
13 #include <linux/err.h>
14 #include <linux/property.h>
15 #include <linux/rbtree.h>
16 #include <linux/sched.h>
17 #include <linux/delay.h>
18 #include <linux/log2.h>
19 #include <linux/hwspinlock.h>
20 #include <asm/unaligned.h>
21
22 #define CREATE_TRACE_POINTS
23 #include "trace.h"
24
25 #include "internal.h"
26
27 /*
28 * Sometimes for failures during very early init the trace
29 * infrastructure isn't available early enough to be used. For this
30 * sort of problem defining LOG_DEVICE will add printks for basic
31 * register I/O on a specific device.
32 */
33 #undef LOG_DEVICE
34
35 #ifdef LOG_DEVICE
regmap_should_log(struct regmap * map)36 static inline bool regmap_should_log(struct regmap *map)
37 {
38 return (map->dev && strcmp(dev_name(map->dev), LOG_DEVICE) == 0);
39 }
40 #else
regmap_should_log(struct regmap * map)41 static inline bool regmap_should_log(struct regmap *map) { return false; }
42 #endif
43
44
45 static int _regmap_update_bits(struct regmap *map, unsigned int reg,
46 unsigned int mask, unsigned int val,
47 bool *change, bool force_write);
48
49 static int _regmap_bus_reg_read(void *context, unsigned int reg,
50 unsigned int *val);
51 static int _regmap_bus_read(void *context, unsigned int reg,
52 unsigned int *val);
53 static int _regmap_bus_formatted_write(void *context, unsigned int reg,
54 unsigned int val);
55 static int _regmap_bus_reg_write(void *context, unsigned int reg,
56 unsigned int val);
57 static int _regmap_bus_raw_write(void *context, unsigned int reg,
58 unsigned int val);
59
regmap_reg_in_ranges(unsigned int reg,const struct regmap_range * ranges,unsigned int nranges)60 bool regmap_reg_in_ranges(unsigned int reg,
61 const struct regmap_range *ranges,
62 unsigned int nranges)
63 {
64 const struct regmap_range *r;
65 int i;
66
67 for (i = 0, r = ranges; i < nranges; i++, r++)
68 if (regmap_reg_in_range(reg, r))
69 return true;
70 return false;
71 }
72 EXPORT_SYMBOL_GPL(regmap_reg_in_ranges);
73
regmap_check_range_table(struct regmap * map,unsigned int reg,const struct regmap_access_table * table)74 bool regmap_check_range_table(struct regmap *map, unsigned int reg,
75 const struct regmap_access_table *table)
76 {
77 /* Check "no ranges" first */
78 if (regmap_reg_in_ranges(reg, table->no_ranges, table->n_no_ranges))
79 return false;
80
81 /* In case zero "yes ranges" are supplied, any reg is OK */
82 if (!table->n_yes_ranges)
83 return true;
84
85 return regmap_reg_in_ranges(reg, table->yes_ranges,
86 table->n_yes_ranges);
87 }
88 EXPORT_SYMBOL_GPL(regmap_check_range_table);
89
regmap_writeable(struct regmap * map,unsigned int reg)90 bool regmap_writeable(struct regmap *map, unsigned int reg)
91 {
92 if (map->max_register && reg > map->max_register)
93 return false;
94
95 if (map->writeable_reg)
96 return map->writeable_reg(map->dev, reg);
97
98 if (map->wr_table)
99 return regmap_check_range_table(map, reg, map->wr_table);
100
101 return true;
102 }
103
regmap_cached(struct regmap * map,unsigned int reg)104 bool regmap_cached(struct regmap *map, unsigned int reg)
105 {
106 int ret;
107 unsigned int val;
108
109 if (map->cache_type == REGCACHE_NONE)
110 return false;
111
112 if (!map->cache_ops)
113 return false;
114
115 if (map->max_register && reg > map->max_register)
116 return false;
117
118 map->lock(map->lock_arg);
119 ret = regcache_read(map, reg, &val);
120 map->unlock(map->lock_arg);
121 if (ret)
122 return false;
123
124 return true;
125 }
126
regmap_readable(struct regmap * map,unsigned int reg)127 bool regmap_readable(struct regmap *map, unsigned int reg)
128 {
129 if (!map->reg_read)
130 return false;
131
132 if (map->max_register && reg > map->max_register)
133 return false;
134
135 if (map->format.format_write)
136 return false;
137
138 if (map->readable_reg)
139 return map->readable_reg(map->dev, reg);
140
141 if (map->rd_table)
142 return regmap_check_range_table(map, reg, map->rd_table);
143
144 return true;
145 }
146
regmap_volatile(struct regmap * map,unsigned int reg)147 bool regmap_volatile(struct regmap *map, unsigned int reg)
148 {
149 if (!map->format.format_write && !regmap_readable(map, reg))
150 return false;
151
152 if (map->volatile_reg)
153 return map->volatile_reg(map->dev, reg);
154
155 if (map->volatile_table)
156 return regmap_check_range_table(map, reg, map->volatile_table);
157
158 if (map->cache_ops)
159 return false;
160 else
161 return true;
162 }
163
regmap_precious(struct regmap * map,unsigned int reg)164 bool regmap_precious(struct regmap *map, unsigned int reg)
165 {
166 if (!regmap_readable(map, reg))
167 return false;
168
169 if (map->precious_reg)
170 return map->precious_reg(map->dev, reg);
171
172 if (map->precious_table)
173 return regmap_check_range_table(map, reg, map->precious_table);
174
175 return false;
176 }
177
regmap_writeable_noinc(struct regmap * map,unsigned int reg)178 bool regmap_writeable_noinc(struct regmap *map, unsigned int reg)
179 {
180 if (map->writeable_noinc_reg)
181 return map->writeable_noinc_reg(map->dev, reg);
182
183 if (map->wr_noinc_table)
184 return regmap_check_range_table(map, reg, map->wr_noinc_table);
185
186 return true;
187 }
188
regmap_readable_noinc(struct regmap * map,unsigned int reg)189 bool regmap_readable_noinc(struct regmap *map, unsigned int reg)
190 {
191 if (map->readable_noinc_reg)
192 return map->readable_noinc_reg(map->dev, reg);
193
194 if (map->rd_noinc_table)
195 return regmap_check_range_table(map, reg, map->rd_noinc_table);
196
197 return true;
198 }
199
regmap_volatile_range(struct regmap * map,unsigned int reg,size_t num)200 static bool regmap_volatile_range(struct regmap *map, unsigned int reg,
201 size_t num)
202 {
203 unsigned int i;
204
205 for (i = 0; i < num; i++)
206 if (!regmap_volatile(map, reg + regmap_get_offset(map, i)))
207 return false;
208
209 return true;
210 }
211
regmap_format_12_20_write(struct regmap * map,unsigned int reg,unsigned int val)212 static void regmap_format_12_20_write(struct regmap *map,
213 unsigned int reg, unsigned int val)
214 {
215 u8 *out = map->work_buf;
216
217 out[0] = reg >> 4;
218 out[1] = (reg << 4) | (val >> 16);
219 out[2] = val >> 8;
220 out[3] = val;
221 }
222
223
regmap_format_2_6_write(struct regmap * map,unsigned int reg,unsigned int val)224 static void regmap_format_2_6_write(struct regmap *map,
225 unsigned int reg, unsigned int val)
226 {
227 u8 *out = map->work_buf;
228
229 *out = (reg << 6) | val;
230 }
231
regmap_format_4_12_write(struct regmap * map,unsigned int reg,unsigned int val)232 static void regmap_format_4_12_write(struct regmap *map,
233 unsigned int reg, unsigned int val)
234 {
235 __be16 *out = map->work_buf;
236 *out = cpu_to_be16((reg << 12) | val);
237 }
238
regmap_format_7_9_write(struct regmap * map,unsigned int reg,unsigned int val)239 static void regmap_format_7_9_write(struct regmap *map,
240 unsigned int reg, unsigned int val)
241 {
242 __be16 *out = map->work_buf;
243 *out = cpu_to_be16((reg << 9) | val);
244 }
245
regmap_format_7_17_write(struct regmap * map,unsigned int reg,unsigned int val)246 static void regmap_format_7_17_write(struct regmap *map,
247 unsigned int reg, unsigned int val)
248 {
249 u8 *out = map->work_buf;
250
251 out[2] = val;
252 out[1] = val >> 8;
253 out[0] = (val >> 16) | (reg << 1);
254 }
255
regmap_format_10_14_write(struct regmap * map,unsigned int reg,unsigned int val)256 static void regmap_format_10_14_write(struct regmap *map,
257 unsigned int reg, unsigned int val)
258 {
259 u8 *out = map->work_buf;
260
261 out[2] = val;
262 out[1] = (val >> 8) | (reg << 6);
263 out[0] = reg >> 2;
264 }
265
regmap_format_8(void * buf,unsigned int val,unsigned int shift)266 static void regmap_format_8(void *buf, unsigned int val, unsigned int shift)
267 {
268 u8 *b = buf;
269
270 b[0] = val << shift;
271 }
272
regmap_format_16_be(void * buf,unsigned int val,unsigned int shift)273 static void regmap_format_16_be(void *buf, unsigned int val, unsigned int shift)
274 {
275 put_unaligned_be16(val << shift, buf);
276 }
277
regmap_format_16_le(void * buf,unsigned int val,unsigned int shift)278 static void regmap_format_16_le(void *buf, unsigned int val, unsigned int shift)
279 {
280 put_unaligned_le16(val << shift, buf);
281 }
282
regmap_format_16_native(void * buf,unsigned int val,unsigned int shift)283 static void regmap_format_16_native(void *buf, unsigned int val,
284 unsigned int shift)
285 {
286 u16 v = val << shift;
287
288 memcpy(buf, &v, sizeof(v));
289 }
290
regmap_format_24_be(void * buf,unsigned int val,unsigned int shift)291 static void regmap_format_24_be(void *buf, unsigned int val, unsigned int shift)
292 {
293 put_unaligned_be24(val << shift, buf);
294 }
295
regmap_format_32_be(void * buf,unsigned int val,unsigned int shift)296 static void regmap_format_32_be(void *buf, unsigned int val, unsigned int shift)
297 {
298 put_unaligned_be32(val << shift, buf);
299 }
300
regmap_format_32_le(void * buf,unsigned int val,unsigned int shift)301 static void regmap_format_32_le(void *buf, unsigned int val, unsigned int shift)
302 {
303 put_unaligned_le32(val << shift, buf);
304 }
305
regmap_format_32_native(void * buf,unsigned int val,unsigned int shift)306 static void regmap_format_32_native(void *buf, unsigned int val,
307 unsigned int shift)
308 {
309 u32 v = val << shift;
310
311 memcpy(buf, &v, sizeof(v));
312 }
313
314 #ifdef CONFIG_64BIT
regmap_format_64_be(void * buf,unsigned int val,unsigned int shift)315 static void regmap_format_64_be(void *buf, unsigned int val, unsigned int shift)
316 {
317 put_unaligned_be64((u64) val << shift, buf);
318 }
319
regmap_format_64_le(void * buf,unsigned int val,unsigned int shift)320 static void regmap_format_64_le(void *buf, unsigned int val, unsigned int shift)
321 {
322 put_unaligned_le64((u64) val << shift, buf);
323 }
324
regmap_format_64_native(void * buf,unsigned int val,unsigned int shift)325 static void regmap_format_64_native(void *buf, unsigned int val,
326 unsigned int shift)
327 {
328 u64 v = (u64) val << shift;
329
330 memcpy(buf, &v, sizeof(v));
331 }
332 #endif
333
regmap_parse_inplace_noop(void * buf)334 static void regmap_parse_inplace_noop(void *buf)
335 {
336 }
337
regmap_parse_8(const void * buf)338 static unsigned int regmap_parse_8(const void *buf)
339 {
340 const u8 *b = buf;
341
342 return b[0];
343 }
344
regmap_parse_16_be(const void * buf)345 static unsigned int regmap_parse_16_be(const void *buf)
346 {
347 return get_unaligned_be16(buf);
348 }
349
regmap_parse_16_le(const void * buf)350 static unsigned int regmap_parse_16_le(const void *buf)
351 {
352 return get_unaligned_le16(buf);
353 }
354
regmap_parse_16_be_inplace(void * buf)355 static void regmap_parse_16_be_inplace(void *buf)
356 {
357 u16 v = get_unaligned_be16(buf);
358
359 memcpy(buf, &v, sizeof(v));
360 }
361
regmap_parse_16_le_inplace(void * buf)362 static void regmap_parse_16_le_inplace(void *buf)
363 {
364 u16 v = get_unaligned_le16(buf);
365
366 memcpy(buf, &v, sizeof(v));
367 }
368
regmap_parse_16_native(const void * buf)369 static unsigned int regmap_parse_16_native(const void *buf)
370 {
371 u16 v;
372
373 memcpy(&v, buf, sizeof(v));
374 return v;
375 }
376
regmap_parse_24_be(const void * buf)377 static unsigned int regmap_parse_24_be(const void *buf)
378 {
379 return get_unaligned_be24(buf);
380 }
381
regmap_parse_32_be(const void * buf)382 static unsigned int regmap_parse_32_be(const void *buf)
383 {
384 return get_unaligned_be32(buf);
385 }
386
regmap_parse_32_le(const void * buf)387 static unsigned int regmap_parse_32_le(const void *buf)
388 {
389 return get_unaligned_le32(buf);
390 }
391
regmap_parse_32_be_inplace(void * buf)392 static void regmap_parse_32_be_inplace(void *buf)
393 {
394 u32 v = get_unaligned_be32(buf);
395
396 memcpy(buf, &v, sizeof(v));
397 }
398
regmap_parse_32_le_inplace(void * buf)399 static void regmap_parse_32_le_inplace(void *buf)
400 {
401 u32 v = get_unaligned_le32(buf);
402
403 memcpy(buf, &v, sizeof(v));
404 }
405
regmap_parse_32_native(const void * buf)406 static unsigned int regmap_parse_32_native(const void *buf)
407 {
408 u32 v;
409
410 memcpy(&v, buf, sizeof(v));
411 return v;
412 }
413
414 #ifdef CONFIG_64BIT
regmap_parse_64_be(const void * buf)415 static unsigned int regmap_parse_64_be(const void *buf)
416 {
417 return get_unaligned_be64(buf);
418 }
419
regmap_parse_64_le(const void * buf)420 static unsigned int regmap_parse_64_le(const void *buf)
421 {
422 return get_unaligned_le64(buf);
423 }
424
regmap_parse_64_be_inplace(void * buf)425 static void regmap_parse_64_be_inplace(void *buf)
426 {
427 u64 v = get_unaligned_be64(buf);
428
429 memcpy(buf, &v, sizeof(v));
430 }
431
regmap_parse_64_le_inplace(void * buf)432 static void regmap_parse_64_le_inplace(void *buf)
433 {
434 u64 v = get_unaligned_le64(buf);
435
436 memcpy(buf, &v, sizeof(v));
437 }
438
regmap_parse_64_native(const void * buf)439 static unsigned int regmap_parse_64_native(const void *buf)
440 {
441 u64 v;
442
443 memcpy(&v, buf, sizeof(v));
444 return v;
445 }
446 #endif
447
regmap_lock_hwlock(void * __map)448 static void regmap_lock_hwlock(void *__map)
449 {
450 struct regmap *map = __map;
451
452 hwspin_lock_timeout(map->hwlock, UINT_MAX);
453 }
454
regmap_lock_hwlock_irq(void * __map)455 static void regmap_lock_hwlock_irq(void *__map)
456 {
457 struct regmap *map = __map;
458
459 hwspin_lock_timeout_irq(map->hwlock, UINT_MAX);
460 }
461
regmap_lock_hwlock_irqsave(void * __map)462 static void regmap_lock_hwlock_irqsave(void *__map)
463 {
464 struct regmap *map = __map;
465
466 hwspin_lock_timeout_irqsave(map->hwlock, UINT_MAX,
467 &map->spinlock_flags);
468 }
469
regmap_unlock_hwlock(void * __map)470 static void regmap_unlock_hwlock(void *__map)
471 {
472 struct regmap *map = __map;
473
474 hwspin_unlock(map->hwlock);
475 }
476
regmap_unlock_hwlock_irq(void * __map)477 static void regmap_unlock_hwlock_irq(void *__map)
478 {
479 struct regmap *map = __map;
480
481 hwspin_unlock_irq(map->hwlock);
482 }
483
regmap_unlock_hwlock_irqrestore(void * __map)484 static void regmap_unlock_hwlock_irqrestore(void *__map)
485 {
486 struct regmap *map = __map;
487
488 hwspin_unlock_irqrestore(map->hwlock, &map->spinlock_flags);
489 }
490
regmap_lock_unlock_none(void * __map)491 static void regmap_lock_unlock_none(void *__map)
492 {
493
494 }
495
regmap_lock_mutex(void * __map)496 static void regmap_lock_mutex(void *__map)
497 {
498 struct regmap *map = __map;
499 mutex_lock(&map->mutex);
500 }
501
regmap_unlock_mutex(void * __map)502 static void regmap_unlock_mutex(void *__map)
503 {
504 struct regmap *map = __map;
505 mutex_unlock(&map->mutex);
506 }
507
regmap_lock_spinlock(void * __map)508 static void regmap_lock_spinlock(void *__map)
509 __acquires(&map->spinlock)
510 {
511 struct regmap *map = __map;
512 unsigned long flags;
513
514 spin_lock_irqsave(&map->spinlock, flags);
515 map->spinlock_flags = flags;
516 }
517
regmap_unlock_spinlock(void * __map)518 static void regmap_unlock_spinlock(void *__map)
519 __releases(&map->spinlock)
520 {
521 struct regmap *map = __map;
522 spin_unlock_irqrestore(&map->spinlock, map->spinlock_flags);
523 }
524
regmap_lock_raw_spinlock(void * __map)525 static void regmap_lock_raw_spinlock(void *__map)
526 __acquires(&map->raw_spinlock)
527 {
528 struct regmap *map = __map;
529 unsigned long flags;
530
531 raw_spin_lock_irqsave(&map->raw_spinlock, flags);
532 map->raw_spinlock_flags = flags;
533 }
534
regmap_unlock_raw_spinlock(void * __map)535 static void regmap_unlock_raw_spinlock(void *__map)
536 __releases(&map->raw_spinlock)
537 {
538 struct regmap *map = __map;
539 raw_spin_unlock_irqrestore(&map->raw_spinlock, map->raw_spinlock_flags);
540 }
541
dev_get_regmap_release(struct device * dev,void * res)542 static void dev_get_regmap_release(struct device *dev, void *res)
543 {
544 /*
545 * We don't actually have anything to do here; the goal here
546 * is not to manage the regmap but to provide a simple way to
547 * get the regmap back given a struct device.
548 */
549 }
550
_regmap_range_add(struct regmap * map,struct regmap_range_node * data)551 static bool _regmap_range_add(struct regmap *map,
552 struct regmap_range_node *data)
553 {
554 struct rb_root *root = &map->range_tree;
555 struct rb_node **new = &(root->rb_node), *parent = NULL;
556
557 while (*new) {
558 struct regmap_range_node *this =
559 rb_entry(*new, struct regmap_range_node, node);
560
561 parent = *new;
562 if (data->range_max < this->range_min)
563 new = &((*new)->rb_left);
564 else if (data->range_min > this->range_max)
565 new = &((*new)->rb_right);
566 else
567 return false;
568 }
569
570 rb_link_node(&data->node, parent, new);
571 rb_insert_color(&data->node, root);
572
573 return true;
574 }
575
_regmap_range_lookup(struct regmap * map,unsigned int reg)576 static struct regmap_range_node *_regmap_range_lookup(struct regmap *map,
577 unsigned int reg)
578 {
579 struct rb_node *node = map->range_tree.rb_node;
580
581 while (node) {
582 struct regmap_range_node *this =
583 rb_entry(node, struct regmap_range_node, node);
584
585 if (reg < this->range_min)
586 node = node->rb_left;
587 else if (reg > this->range_max)
588 node = node->rb_right;
589 else
590 return this;
591 }
592
593 return NULL;
594 }
595
regmap_range_exit(struct regmap * map)596 static void regmap_range_exit(struct regmap *map)
597 {
598 struct rb_node *next;
599 struct regmap_range_node *range_node;
600
601 next = rb_first(&map->range_tree);
602 while (next) {
603 range_node = rb_entry(next, struct regmap_range_node, node);
604 next = rb_next(&range_node->node);
605 rb_erase(&range_node->node, &map->range_tree);
606 kfree(range_node);
607 }
608
609 kfree(map->selector_work_buf);
610 }
611
regmap_set_name(struct regmap * map,const struct regmap_config * config)612 static int regmap_set_name(struct regmap *map, const struct regmap_config *config)
613 {
614 if (config->name) {
615 const char *name = kstrdup_const(config->name, GFP_KERNEL);
616
617 if (!name)
618 return -ENOMEM;
619
620 kfree_const(map->name);
621 map->name = name;
622 }
623
624 return 0;
625 }
626
regmap_attach_dev(struct device * dev,struct regmap * map,const struct regmap_config * config)627 int regmap_attach_dev(struct device *dev, struct regmap *map,
628 const struct regmap_config *config)
629 {
630 struct regmap **m;
631 int ret;
632
633 map->dev = dev;
634
635 ret = regmap_set_name(map, config);
636 if (ret)
637 return ret;
638
639 regmap_debugfs_exit(map);
640 regmap_debugfs_init(map);
641
642 /* Add a devres resource for dev_get_regmap() */
643 m = devres_alloc(dev_get_regmap_release, sizeof(*m), GFP_KERNEL);
644 if (!m) {
645 regmap_debugfs_exit(map);
646 return -ENOMEM;
647 }
648 *m = map;
649 devres_add(dev, m);
650
651 return 0;
652 }
653 EXPORT_SYMBOL_GPL(regmap_attach_dev);
654
regmap_get_reg_endian(const struct regmap_bus * bus,const struct regmap_config * config)655 static enum regmap_endian regmap_get_reg_endian(const struct regmap_bus *bus,
656 const struct regmap_config *config)
657 {
658 enum regmap_endian endian;
659
660 /* Retrieve the endianness specification from the regmap config */
661 endian = config->reg_format_endian;
662
663 /* If the regmap config specified a non-default value, use that */
664 if (endian != REGMAP_ENDIAN_DEFAULT)
665 return endian;
666
667 /* Retrieve the endianness specification from the bus config */
668 if (bus && bus->reg_format_endian_default)
669 endian = bus->reg_format_endian_default;
670
671 /* If the bus specified a non-default value, use that */
672 if (endian != REGMAP_ENDIAN_DEFAULT)
673 return endian;
674
675 /* Use this if no other value was found */
676 return REGMAP_ENDIAN_BIG;
677 }
678
regmap_get_val_endian(struct device * dev,const struct regmap_bus * bus,const struct regmap_config * config)679 enum regmap_endian regmap_get_val_endian(struct device *dev,
680 const struct regmap_bus *bus,
681 const struct regmap_config *config)
682 {
683 struct fwnode_handle *fwnode = dev ? dev_fwnode(dev) : NULL;
684 enum regmap_endian endian;
685
686 /* Retrieve the endianness specification from the regmap config */
687 endian = config->val_format_endian;
688
689 /* If the regmap config specified a non-default value, use that */
690 if (endian != REGMAP_ENDIAN_DEFAULT)
691 return endian;
692
693 /* If the firmware node exist try to get endianness from it */
694 if (fwnode_property_read_bool(fwnode, "big-endian"))
695 endian = REGMAP_ENDIAN_BIG;
696 else if (fwnode_property_read_bool(fwnode, "little-endian"))
697 endian = REGMAP_ENDIAN_LITTLE;
698 else if (fwnode_property_read_bool(fwnode, "native-endian"))
699 endian = REGMAP_ENDIAN_NATIVE;
700
701 /* If the endianness was specified in fwnode, use that */
702 if (endian != REGMAP_ENDIAN_DEFAULT)
703 return endian;
704
705 /* Retrieve the endianness specification from the bus config */
706 if (bus && bus->val_format_endian_default)
707 endian = bus->val_format_endian_default;
708
709 /* If the bus specified a non-default value, use that */
710 if (endian != REGMAP_ENDIAN_DEFAULT)
711 return endian;
712
713 /* Use this if no other value was found */
714 return REGMAP_ENDIAN_BIG;
715 }
716 EXPORT_SYMBOL_GPL(regmap_get_val_endian);
717
__regmap_init(struct device * dev,const struct regmap_bus * bus,void * bus_context,const struct regmap_config * config,struct lock_class_key * lock_key,const char * lock_name)718 struct regmap *__regmap_init(struct device *dev,
719 const struct regmap_bus *bus,
720 void *bus_context,
721 const struct regmap_config *config,
722 struct lock_class_key *lock_key,
723 const char *lock_name)
724 {
725 struct regmap *map;
726 int ret = -EINVAL;
727 enum regmap_endian reg_endian, val_endian;
728 int i, j;
729
730 if (!config)
731 goto err;
732
733 map = kzalloc(sizeof(*map), GFP_KERNEL);
734 if (map == NULL) {
735 ret = -ENOMEM;
736 goto err;
737 }
738
739 ret = regmap_set_name(map, config);
740 if (ret)
741 goto err_map;
742
743 ret = -EINVAL; /* Later error paths rely on this */
744
745 if (config->disable_locking) {
746 map->lock = map->unlock = regmap_lock_unlock_none;
747 map->can_sleep = config->can_sleep;
748 regmap_debugfs_disable(map);
749 } else if (config->lock && config->unlock) {
750 map->lock = config->lock;
751 map->unlock = config->unlock;
752 map->lock_arg = config->lock_arg;
753 map->can_sleep = config->can_sleep;
754 } else if (config->use_hwlock) {
755 map->hwlock = hwspin_lock_request_specific(config->hwlock_id);
756 if (!map->hwlock) {
757 ret = -ENXIO;
758 goto err_name;
759 }
760
761 switch (config->hwlock_mode) {
762 case HWLOCK_IRQSTATE:
763 map->lock = regmap_lock_hwlock_irqsave;
764 map->unlock = regmap_unlock_hwlock_irqrestore;
765 break;
766 case HWLOCK_IRQ:
767 map->lock = regmap_lock_hwlock_irq;
768 map->unlock = regmap_unlock_hwlock_irq;
769 break;
770 default:
771 map->lock = regmap_lock_hwlock;
772 map->unlock = regmap_unlock_hwlock;
773 break;
774 }
775
776 map->lock_arg = map;
777 } else {
778 if ((bus && bus->fast_io) ||
779 config->fast_io) {
780 if (config->use_raw_spinlock) {
781 raw_spin_lock_init(&map->raw_spinlock);
782 map->lock = regmap_lock_raw_spinlock;
783 map->unlock = regmap_unlock_raw_spinlock;
784 lockdep_set_class_and_name(&map->raw_spinlock,
785 lock_key, lock_name);
786 } else {
787 spin_lock_init(&map->spinlock);
788 map->lock = regmap_lock_spinlock;
789 map->unlock = regmap_unlock_spinlock;
790 lockdep_set_class_and_name(&map->spinlock,
791 lock_key, lock_name);
792 }
793 } else {
794 mutex_init(&map->mutex);
795 map->lock = regmap_lock_mutex;
796 map->unlock = regmap_unlock_mutex;
797 map->can_sleep = true;
798 lockdep_set_class_and_name(&map->mutex,
799 lock_key, lock_name);
800 }
801 map->lock_arg = map;
802 }
803
804 /*
805 * When we write in fast-paths with regmap_bulk_write() don't allocate
806 * scratch buffers with sleeping allocations.
807 */
808 if ((bus && bus->fast_io) || config->fast_io)
809 map->alloc_flags = GFP_ATOMIC;
810 else
811 map->alloc_flags = GFP_KERNEL;
812
813 map->reg_base = config->reg_base;
814
815 map->format.reg_bytes = DIV_ROUND_UP(config->reg_bits, 8);
816 map->format.pad_bytes = config->pad_bits / 8;
817 map->format.reg_downshift = config->reg_downshift;
818 map->format.val_bytes = DIV_ROUND_UP(config->val_bits, 8);
819 map->format.buf_size = DIV_ROUND_UP(config->reg_bits +
820 config->val_bits + config->pad_bits, 8);
821 map->reg_shift = config->pad_bits % 8;
822 if (config->reg_stride)
823 map->reg_stride = config->reg_stride;
824 else
825 map->reg_stride = 1;
826 if (is_power_of_2(map->reg_stride))
827 map->reg_stride_order = ilog2(map->reg_stride);
828 else
829 map->reg_stride_order = -1;
830 map->use_single_read = config->use_single_read || !(config->read || (bus && bus->read));
831 map->use_single_write = config->use_single_write || !(config->write || (bus && bus->write));
832 map->can_multi_write = config->can_multi_write && (config->write || (bus && bus->write));
833 if (bus) {
834 map->max_raw_read = bus->max_raw_read;
835 map->max_raw_write = bus->max_raw_write;
836 } else if (config->max_raw_read && config->max_raw_write) {
837 map->max_raw_read = config->max_raw_read;
838 map->max_raw_write = config->max_raw_write;
839 }
840 map->dev = dev;
841 map->bus = bus;
842 map->bus_context = bus_context;
843 map->max_register = config->max_register;
844 map->wr_table = config->wr_table;
845 map->rd_table = config->rd_table;
846 map->volatile_table = config->volatile_table;
847 map->precious_table = config->precious_table;
848 map->wr_noinc_table = config->wr_noinc_table;
849 map->rd_noinc_table = config->rd_noinc_table;
850 map->writeable_reg = config->writeable_reg;
851 map->readable_reg = config->readable_reg;
852 map->volatile_reg = config->volatile_reg;
853 map->precious_reg = config->precious_reg;
854 map->writeable_noinc_reg = config->writeable_noinc_reg;
855 map->readable_noinc_reg = config->readable_noinc_reg;
856 map->cache_type = config->cache_type;
857
858 spin_lock_init(&map->async_lock);
859 INIT_LIST_HEAD(&map->async_list);
860 INIT_LIST_HEAD(&map->async_free);
861 init_waitqueue_head(&map->async_waitq);
862
863 if (config->read_flag_mask ||
864 config->write_flag_mask ||
865 config->zero_flag_mask) {
866 map->read_flag_mask = config->read_flag_mask;
867 map->write_flag_mask = config->write_flag_mask;
868 } else if (bus) {
869 map->read_flag_mask = bus->read_flag_mask;
870 }
871
872 if (config && config->read && config->write) {
873 map->reg_read = _regmap_bus_read;
874 if (config->reg_update_bits)
875 map->reg_update_bits = config->reg_update_bits;
876
877 /* Bulk read/write */
878 map->read = config->read;
879 map->write = config->write;
880
881 reg_endian = REGMAP_ENDIAN_NATIVE;
882 val_endian = REGMAP_ENDIAN_NATIVE;
883 } else if (!bus) {
884 map->reg_read = config->reg_read;
885 map->reg_write = config->reg_write;
886 map->reg_update_bits = config->reg_update_bits;
887
888 map->defer_caching = false;
889 goto skip_format_initialization;
890 } else if (!bus->read || !bus->write) {
891 map->reg_read = _regmap_bus_reg_read;
892 map->reg_write = _regmap_bus_reg_write;
893 map->reg_update_bits = bus->reg_update_bits;
894
895 map->defer_caching = false;
896 goto skip_format_initialization;
897 } else {
898 map->reg_read = _regmap_bus_read;
899 map->reg_update_bits = bus->reg_update_bits;
900 /* Bulk read/write */
901 map->read = bus->read;
902 map->write = bus->write;
903
904 reg_endian = regmap_get_reg_endian(bus, config);
905 val_endian = regmap_get_val_endian(dev, bus, config);
906 }
907
908 switch (config->reg_bits + map->reg_shift) {
909 case 2:
910 switch (config->val_bits) {
911 case 6:
912 map->format.format_write = regmap_format_2_6_write;
913 break;
914 default:
915 goto err_hwlock;
916 }
917 break;
918
919 case 4:
920 switch (config->val_bits) {
921 case 12:
922 map->format.format_write = regmap_format_4_12_write;
923 break;
924 default:
925 goto err_hwlock;
926 }
927 break;
928
929 case 7:
930 switch (config->val_bits) {
931 case 9:
932 map->format.format_write = regmap_format_7_9_write;
933 break;
934 case 17:
935 map->format.format_write = regmap_format_7_17_write;
936 break;
937 default:
938 goto err_hwlock;
939 }
940 break;
941
942 case 10:
943 switch (config->val_bits) {
944 case 14:
945 map->format.format_write = regmap_format_10_14_write;
946 break;
947 default:
948 goto err_hwlock;
949 }
950 break;
951
952 case 12:
953 switch (config->val_bits) {
954 case 20:
955 map->format.format_write = regmap_format_12_20_write;
956 break;
957 default:
958 goto err_hwlock;
959 }
960 break;
961
962 case 8:
963 map->format.format_reg = regmap_format_8;
964 break;
965
966 case 16:
967 switch (reg_endian) {
968 case REGMAP_ENDIAN_BIG:
969 map->format.format_reg = regmap_format_16_be;
970 break;
971 case REGMAP_ENDIAN_LITTLE:
972 map->format.format_reg = regmap_format_16_le;
973 break;
974 case REGMAP_ENDIAN_NATIVE:
975 map->format.format_reg = regmap_format_16_native;
976 break;
977 default:
978 goto err_hwlock;
979 }
980 break;
981
982 case 24:
983 switch (reg_endian) {
984 case REGMAP_ENDIAN_BIG:
985 map->format.format_reg = regmap_format_24_be;
986 break;
987 default:
988 goto err_hwlock;
989 }
990 break;
991
992 case 32:
993 switch (reg_endian) {
994 case REGMAP_ENDIAN_BIG:
995 map->format.format_reg = regmap_format_32_be;
996 break;
997 case REGMAP_ENDIAN_LITTLE:
998 map->format.format_reg = regmap_format_32_le;
999 break;
1000 case REGMAP_ENDIAN_NATIVE:
1001 map->format.format_reg = regmap_format_32_native;
1002 break;
1003 default:
1004 goto err_hwlock;
1005 }
1006 break;
1007
1008 #ifdef CONFIG_64BIT
1009 case 64:
1010 switch (reg_endian) {
1011 case REGMAP_ENDIAN_BIG:
1012 map->format.format_reg = regmap_format_64_be;
1013 break;
1014 case REGMAP_ENDIAN_LITTLE:
1015 map->format.format_reg = regmap_format_64_le;
1016 break;
1017 case REGMAP_ENDIAN_NATIVE:
1018 map->format.format_reg = regmap_format_64_native;
1019 break;
1020 default:
1021 goto err_hwlock;
1022 }
1023 break;
1024 #endif
1025
1026 default:
1027 goto err_hwlock;
1028 }
1029
1030 if (val_endian == REGMAP_ENDIAN_NATIVE)
1031 map->format.parse_inplace = regmap_parse_inplace_noop;
1032
1033 switch (config->val_bits) {
1034 case 8:
1035 map->format.format_val = regmap_format_8;
1036 map->format.parse_val = regmap_parse_8;
1037 map->format.parse_inplace = regmap_parse_inplace_noop;
1038 break;
1039 case 16:
1040 switch (val_endian) {
1041 case REGMAP_ENDIAN_BIG:
1042 map->format.format_val = regmap_format_16_be;
1043 map->format.parse_val = regmap_parse_16_be;
1044 map->format.parse_inplace = regmap_parse_16_be_inplace;
1045 break;
1046 case REGMAP_ENDIAN_LITTLE:
1047 map->format.format_val = regmap_format_16_le;
1048 map->format.parse_val = regmap_parse_16_le;
1049 map->format.parse_inplace = regmap_parse_16_le_inplace;
1050 break;
1051 case REGMAP_ENDIAN_NATIVE:
1052 map->format.format_val = regmap_format_16_native;
1053 map->format.parse_val = regmap_parse_16_native;
1054 break;
1055 default:
1056 goto err_hwlock;
1057 }
1058 break;
1059 case 24:
1060 switch (val_endian) {
1061 case REGMAP_ENDIAN_BIG:
1062 map->format.format_val = regmap_format_24_be;
1063 map->format.parse_val = regmap_parse_24_be;
1064 break;
1065 default:
1066 goto err_hwlock;
1067 }
1068 break;
1069 case 32:
1070 switch (val_endian) {
1071 case REGMAP_ENDIAN_BIG:
1072 map->format.format_val = regmap_format_32_be;
1073 map->format.parse_val = regmap_parse_32_be;
1074 map->format.parse_inplace = regmap_parse_32_be_inplace;
1075 break;
1076 case REGMAP_ENDIAN_LITTLE:
1077 map->format.format_val = regmap_format_32_le;
1078 map->format.parse_val = regmap_parse_32_le;
1079 map->format.parse_inplace = regmap_parse_32_le_inplace;
1080 break;
1081 case REGMAP_ENDIAN_NATIVE:
1082 map->format.format_val = regmap_format_32_native;
1083 map->format.parse_val = regmap_parse_32_native;
1084 break;
1085 default:
1086 goto err_hwlock;
1087 }
1088 break;
1089 #ifdef CONFIG_64BIT
1090 case 64:
1091 switch (val_endian) {
1092 case REGMAP_ENDIAN_BIG:
1093 map->format.format_val = regmap_format_64_be;
1094 map->format.parse_val = regmap_parse_64_be;
1095 map->format.parse_inplace = regmap_parse_64_be_inplace;
1096 break;
1097 case REGMAP_ENDIAN_LITTLE:
1098 map->format.format_val = regmap_format_64_le;
1099 map->format.parse_val = regmap_parse_64_le;
1100 map->format.parse_inplace = regmap_parse_64_le_inplace;
1101 break;
1102 case REGMAP_ENDIAN_NATIVE:
1103 map->format.format_val = regmap_format_64_native;
1104 map->format.parse_val = regmap_parse_64_native;
1105 break;
1106 default:
1107 goto err_hwlock;
1108 }
1109 break;
1110 #endif
1111 }
1112
1113 if (map->format.format_write) {
1114 if ((reg_endian != REGMAP_ENDIAN_BIG) ||
1115 (val_endian != REGMAP_ENDIAN_BIG))
1116 goto err_hwlock;
1117 map->use_single_write = true;
1118 }
1119
1120 if (!map->format.format_write &&
1121 !(map->format.format_reg && map->format.format_val))
1122 goto err_hwlock;
1123
1124 map->work_buf = kzalloc(map->format.buf_size, GFP_KERNEL);
1125 if (map->work_buf == NULL) {
1126 ret = -ENOMEM;
1127 goto err_hwlock;
1128 }
1129
1130 if (map->format.format_write) {
1131 map->defer_caching = false;
1132 map->reg_write = _regmap_bus_formatted_write;
1133 } else if (map->format.format_val) {
1134 map->defer_caching = true;
1135 map->reg_write = _regmap_bus_raw_write;
1136 }
1137
1138 skip_format_initialization:
1139
1140 map->range_tree = RB_ROOT;
1141 for (i = 0; i < config->num_ranges; i++) {
1142 const struct regmap_range_cfg *range_cfg = &config->ranges[i];
1143 struct regmap_range_node *new;
1144
1145 /* Sanity check */
1146 if (range_cfg->range_max < range_cfg->range_min) {
1147 dev_err(map->dev, "Invalid range %d: %d < %d\n", i,
1148 range_cfg->range_max, range_cfg->range_min);
1149 goto err_range;
1150 }
1151
1152 if (range_cfg->range_max > map->max_register) {
1153 dev_err(map->dev, "Invalid range %d: %d > %d\n", i,
1154 range_cfg->range_max, map->max_register);
1155 goto err_range;
1156 }
1157
1158 if (range_cfg->selector_reg > map->max_register) {
1159 dev_err(map->dev,
1160 "Invalid range %d: selector out of map\n", i);
1161 goto err_range;
1162 }
1163
1164 if (range_cfg->window_len == 0) {
1165 dev_err(map->dev, "Invalid range %d: window_len 0\n",
1166 i);
1167 goto err_range;
1168 }
1169
1170 /* Make sure, that this register range has no selector
1171 or data window within its boundary */
1172 for (j = 0; j < config->num_ranges; j++) {
1173 unsigned int sel_reg = config->ranges[j].selector_reg;
1174 unsigned int win_min = config->ranges[j].window_start;
1175 unsigned int win_max = win_min +
1176 config->ranges[j].window_len - 1;
1177
1178 /* Allow data window inside its own virtual range */
1179 if (j == i)
1180 continue;
1181
1182 if (range_cfg->range_min <= sel_reg &&
1183 sel_reg <= range_cfg->range_max) {
1184 dev_err(map->dev,
1185 "Range %d: selector for %d in window\n",
1186 i, j);
1187 goto err_range;
1188 }
1189
1190 if (!(win_max < range_cfg->range_min ||
1191 win_min > range_cfg->range_max)) {
1192 dev_err(map->dev,
1193 "Range %d: window for %d in window\n",
1194 i, j);
1195 goto err_range;
1196 }
1197 }
1198
1199 new = kzalloc(sizeof(*new), GFP_KERNEL);
1200 if (new == NULL) {
1201 ret = -ENOMEM;
1202 goto err_range;
1203 }
1204
1205 new->map = map;
1206 new->name = range_cfg->name;
1207 new->range_min = range_cfg->range_min;
1208 new->range_max = range_cfg->range_max;
1209 new->selector_reg = range_cfg->selector_reg;
1210 new->selector_mask = range_cfg->selector_mask;
1211 new->selector_shift = range_cfg->selector_shift;
1212 new->window_start = range_cfg->window_start;
1213 new->window_len = range_cfg->window_len;
1214
1215 if (!_regmap_range_add(map, new)) {
1216 dev_err(map->dev, "Failed to add range %d\n", i);
1217 kfree(new);
1218 goto err_range;
1219 }
1220
1221 if (map->selector_work_buf == NULL) {
1222 map->selector_work_buf =
1223 kzalloc(map->format.buf_size, GFP_KERNEL);
1224 if (map->selector_work_buf == NULL) {
1225 ret = -ENOMEM;
1226 goto err_range;
1227 }
1228 }
1229 }
1230
1231 ret = regcache_init(map, config);
1232 if (ret != 0)
1233 goto err_range;
1234
1235 if (dev) {
1236 ret = regmap_attach_dev(dev, map, config);
1237 if (ret != 0)
1238 goto err_regcache;
1239 } else {
1240 regmap_debugfs_init(map);
1241 }
1242
1243 return map;
1244
1245 err_regcache:
1246 regcache_exit(map);
1247 err_range:
1248 regmap_range_exit(map);
1249 kfree(map->work_buf);
1250 err_hwlock:
1251 if (map->hwlock)
1252 hwspin_lock_free(map->hwlock);
1253 err_name:
1254 kfree_const(map->name);
1255 err_map:
1256 kfree(map);
1257 err:
1258 return ERR_PTR(ret);
1259 }
1260 EXPORT_SYMBOL_GPL(__regmap_init);
1261
devm_regmap_release(struct device * dev,void * res)1262 static void devm_regmap_release(struct device *dev, void *res)
1263 {
1264 regmap_exit(*(struct regmap **)res);
1265 }
1266
__devm_regmap_init(struct device * dev,const struct regmap_bus * bus,void * bus_context,const struct regmap_config * config,struct lock_class_key * lock_key,const char * lock_name)1267 struct regmap *__devm_regmap_init(struct device *dev,
1268 const struct regmap_bus *bus,
1269 void *bus_context,
1270 const struct regmap_config *config,
1271 struct lock_class_key *lock_key,
1272 const char *lock_name)
1273 {
1274 struct regmap **ptr, *regmap;
1275
1276 ptr = devres_alloc(devm_regmap_release, sizeof(*ptr), GFP_KERNEL);
1277 if (!ptr)
1278 return ERR_PTR(-ENOMEM);
1279
1280 regmap = __regmap_init(dev, bus, bus_context, config,
1281 lock_key, lock_name);
1282 if (!IS_ERR(regmap)) {
1283 *ptr = regmap;
1284 devres_add(dev, ptr);
1285 } else {
1286 devres_free(ptr);
1287 }
1288
1289 return regmap;
1290 }
1291 EXPORT_SYMBOL_GPL(__devm_regmap_init);
1292
regmap_field_init(struct regmap_field * rm_field,struct regmap * regmap,struct reg_field reg_field)1293 static void regmap_field_init(struct regmap_field *rm_field,
1294 struct regmap *regmap, struct reg_field reg_field)
1295 {
1296 rm_field->regmap = regmap;
1297 rm_field->reg = reg_field.reg;
1298 rm_field->shift = reg_field.lsb;
1299 rm_field->mask = GENMASK(reg_field.msb, reg_field.lsb);
1300
1301 WARN_ONCE(rm_field->mask == 0, "invalid empty mask defined\n");
1302
1303 rm_field->id_size = reg_field.id_size;
1304 rm_field->id_offset = reg_field.id_offset;
1305 }
1306
1307 /**
1308 * devm_regmap_field_alloc() - Allocate and initialise a register field.
1309 *
1310 * @dev: Device that will be interacted with
1311 * @regmap: regmap bank in which this register field is located.
1312 * @reg_field: Register field with in the bank.
1313 *
1314 * The return value will be an ERR_PTR() on error or a valid pointer
1315 * to a struct regmap_field. The regmap_field will be automatically freed
1316 * by the device management code.
1317 */
devm_regmap_field_alloc(struct device * dev,struct regmap * regmap,struct reg_field reg_field)1318 struct regmap_field *devm_regmap_field_alloc(struct device *dev,
1319 struct regmap *regmap, struct reg_field reg_field)
1320 {
1321 struct regmap_field *rm_field = devm_kzalloc(dev,
1322 sizeof(*rm_field), GFP_KERNEL);
1323 if (!rm_field)
1324 return ERR_PTR(-ENOMEM);
1325
1326 regmap_field_init(rm_field, regmap, reg_field);
1327
1328 return rm_field;
1329
1330 }
1331 EXPORT_SYMBOL_GPL(devm_regmap_field_alloc);
1332
1333
1334 /**
1335 * regmap_field_bulk_alloc() - Allocate and initialise a bulk register field.
1336 *
1337 * @regmap: regmap bank in which this register field is located.
1338 * @rm_field: regmap register fields within the bank.
1339 * @reg_field: Register fields within the bank.
1340 * @num_fields: Number of register fields.
1341 *
1342 * The return value will be an -ENOMEM on error or zero for success.
1343 * Newly allocated regmap_fields should be freed by calling
1344 * regmap_field_bulk_free()
1345 */
regmap_field_bulk_alloc(struct regmap * regmap,struct regmap_field ** rm_field,const struct reg_field * reg_field,int num_fields)1346 int regmap_field_bulk_alloc(struct regmap *regmap,
1347 struct regmap_field **rm_field,
1348 const struct reg_field *reg_field,
1349 int num_fields)
1350 {
1351 struct regmap_field *rf;
1352 int i;
1353
1354 rf = kcalloc(num_fields, sizeof(*rf), GFP_KERNEL);
1355 if (!rf)
1356 return -ENOMEM;
1357
1358 for (i = 0; i < num_fields; i++) {
1359 regmap_field_init(&rf[i], regmap, reg_field[i]);
1360 rm_field[i] = &rf[i];
1361 }
1362
1363 return 0;
1364 }
1365 EXPORT_SYMBOL_GPL(regmap_field_bulk_alloc);
1366
1367 /**
1368 * devm_regmap_field_bulk_alloc() - Allocate and initialise a bulk register
1369 * fields.
1370 *
1371 * @dev: Device that will be interacted with
1372 * @regmap: regmap bank in which this register field is located.
1373 * @rm_field: regmap register fields within the bank.
1374 * @reg_field: Register fields within the bank.
1375 * @num_fields: Number of register fields.
1376 *
1377 * The return value will be an -ENOMEM on error or zero for success.
1378 * Newly allocated regmap_fields will be automatically freed by the
1379 * device management code.
1380 */
devm_regmap_field_bulk_alloc(struct device * dev,struct regmap * regmap,struct regmap_field ** rm_field,const struct reg_field * reg_field,int num_fields)1381 int devm_regmap_field_bulk_alloc(struct device *dev,
1382 struct regmap *regmap,
1383 struct regmap_field **rm_field,
1384 const struct reg_field *reg_field,
1385 int num_fields)
1386 {
1387 struct regmap_field *rf;
1388 int i;
1389
1390 rf = devm_kcalloc(dev, num_fields, sizeof(*rf), GFP_KERNEL);
1391 if (!rf)
1392 return -ENOMEM;
1393
1394 for (i = 0; i < num_fields; i++) {
1395 regmap_field_init(&rf[i], regmap, reg_field[i]);
1396 rm_field[i] = &rf[i];
1397 }
1398
1399 return 0;
1400 }
1401 EXPORT_SYMBOL_GPL(devm_regmap_field_bulk_alloc);
1402
1403 /**
1404 * regmap_field_bulk_free() - Free register field allocated using
1405 * regmap_field_bulk_alloc.
1406 *
1407 * @field: regmap fields which should be freed.
1408 */
regmap_field_bulk_free(struct regmap_field * field)1409 void regmap_field_bulk_free(struct regmap_field *field)
1410 {
1411 kfree(field);
1412 }
1413 EXPORT_SYMBOL_GPL(regmap_field_bulk_free);
1414
1415 /**
1416 * devm_regmap_field_bulk_free() - Free a bulk register field allocated using
1417 * devm_regmap_field_bulk_alloc.
1418 *
1419 * @dev: Device that will be interacted with
1420 * @field: regmap field which should be freed.
1421 *
1422 * Free register field allocated using devm_regmap_field_bulk_alloc(). Usually
1423 * drivers need not call this function, as the memory allocated via devm
1424 * will be freed as per device-driver life-cycle.
1425 */
devm_regmap_field_bulk_free(struct device * dev,struct regmap_field * field)1426 void devm_regmap_field_bulk_free(struct device *dev,
1427 struct regmap_field *field)
1428 {
1429 devm_kfree(dev, field);
1430 }
1431 EXPORT_SYMBOL_GPL(devm_regmap_field_bulk_free);
1432
1433 /**
1434 * devm_regmap_field_free() - Free a register field allocated using
1435 * devm_regmap_field_alloc.
1436 *
1437 * @dev: Device that will be interacted with
1438 * @field: regmap field which should be freed.
1439 *
1440 * Free register field allocated using devm_regmap_field_alloc(). Usually
1441 * drivers need not call this function, as the memory allocated via devm
1442 * will be freed as per device-driver life-cyle.
1443 */
devm_regmap_field_free(struct device * dev,struct regmap_field * field)1444 void devm_regmap_field_free(struct device *dev,
1445 struct regmap_field *field)
1446 {
1447 devm_kfree(dev, field);
1448 }
1449 EXPORT_SYMBOL_GPL(devm_regmap_field_free);
1450
1451 /**
1452 * regmap_field_alloc() - Allocate and initialise a register field.
1453 *
1454 * @regmap: regmap bank in which this register field is located.
1455 * @reg_field: Register field with in the bank.
1456 *
1457 * The return value will be an ERR_PTR() on error or a valid pointer
1458 * to a struct regmap_field. The regmap_field should be freed by the
1459 * user once its finished working with it using regmap_field_free().
1460 */
regmap_field_alloc(struct regmap * regmap,struct reg_field reg_field)1461 struct regmap_field *regmap_field_alloc(struct regmap *regmap,
1462 struct reg_field reg_field)
1463 {
1464 struct regmap_field *rm_field = kzalloc(sizeof(*rm_field), GFP_KERNEL);
1465
1466 if (!rm_field)
1467 return ERR_PTR(-ENOMEM);
1468
1469 regmap_field_init(rm_field, regmap, reg_field);
1470
1471 return rm_field;
1472 }
1473 EXPORT_SYMBOL_GPL(regmap_field_alloc);
1474
1475 /**
1476 * regmap_field_free() - Free register field allocated using
1477 * regmap_field_alloc.
1478 *
1479 * @field: regmap field which should be freed.
1480 */
regmap_field_free(struct regmap_field * field)1481 void regmap_field_free(struct regmap_field *field)
1482 {
1483 kfree(field);
1484 }
1485 EXPORT_SYMBOL_GPL(regmap_field_free);
1486
1487 /**
1488 * regmap_reinit_cache() - Reinitialise the current register cache
1489 *
1490 * @map: Register map to operate on.
1491 * @config: New configuration. Only the cache data will be used.
1492 *
1493 * Discard any existing register cache for the map and initialize a
1494 * new cache. This can be used to restore the cache to defaults or to
1495 * update the cache configuration to reflect runtime discovery of the
1496 * hardware.
1497 *
1498 * No explicit locking is done here, the user needs to ensure that
1499 * this function will not race with other calls to regmap.
1500 */
regmap_reinit_cache(struct regmap * map,const struct regmap_config * config)1501 int regmap_reinit_cache(struct regmap *map, const struct regmap_config *config)
1502 {
1503 int ret;
1504
1505 regcache_exit(map);
1506 regmap_debugfs_exit(map);
1507
1508 map->max_register = config->max_register;
1509 map->writeable_reg = config->writeable_reg;
1510 map->readable_reg = config->readable_reg;
1511 map->volatile_reg = config->volatile_reg;
1512 map->precious_reg = config->precious_reg;
1513 map->writeable_noinc_reg = config->writeable_noinc_reg;
1514 map->readable_noinc_reg = config->readable_noinc_reg;
1515 map->cache_type = config->cache_type;
1516
1517 ret = regmap_set_name(map, config);
1518 if (ret)
1519 return ret;
1520
1521 regmap_debugfs_init(map);
1522
1523 map->cache_bypass = false;
1524 map->cache_only = false;
1525
1526 return regcache_init(map, config);
1527 }
1528 EXPORT_SYMBOL_GPL(regmap_reinit_cache);
1529
1530 /**
1531 * regmap_exit() - Free a previously allocated register map
1532 *
1533 * @map: Register map to operate on.
1534 */
regmap_exit(struct regmap * map)1535 void regmap_exit(struct regmap *map)
1536 {
1537 struct regmap_async *async;
1538
1539 regcache_exit(map);
1540 regmap_debugfs_exit(map);
1541 regmap_range_exit(map);
1542 if (map->bus && map->bus->free_context)
1543 map->bus->free_context(map->bus_context);
1544 kfree(map->work_buf);
1545 while (!list_empty(&map->async_free)) {
1546 async = list_first_entry_or_null(&map->async_free,
1547 struct regmap_async,
1548 list);
1549 list_del(&async->list);
1550 kfree(async->work_buf);
1551 kfree(async);
1552 }
1553 if (map->hwlock)
1554 hwspin_lock_free(map->hwlock);
1555 if (map->lock == regmap_lock_mutex)
1556 mutex_destroy(&map->mutex);
1557 kfree_const(map->name);
1558 kfree(map->patch);
1559 if (map->bus && map->bus->free_on_exit)
1560 kfree(map->bus);
1561 kfree(map);
1562 }
1563 EXPORT_SYMBOL_GPL(regmap_exit);
1564
dev_get_regmap_match(struct device * dev,void * res,void * data)1565 static int dev_get_regmap_match(struct device *dev, void *res, void *data)
1566 {
1567 struct regmap **r = res;
1568 if (!r || !*r) {
1569 WARN_ON(!r || !*r);
1570 return 0;
1571 }
1572
1573 /* If the user didn't specify a name match any */
1574 if (data)
1575 return !strcmp((*r)->name, data);
1576 else
1577 return 1;
1578 }
1579
1580 /**
1581 * dev_get_regmap() - Obtain the regmap (if any) for a device
1582 *
1583 * @dev: Device to retrieve the map for
1584 * @name: Optional name for the register map, usually NULL.
1585 *
1586 * Returns the regmap for the device if one is present, or NULL. If
1587 * name is specified then it must match the name specified when
1588 * registering the device, if it is NULL then the first regmap found
1589 * will be used. Devices with multiple register maps are very rare,
1590 * generic code should normally not need to specify a name.
1591 */
dev_get_regmap(struct device * dev,const char * name)1592 struct regmap *dev_get_regmap(struct device *dev, const char *name)
1593 {
1594 struct regmap **r = devres_find(dev, dev_get_regmap_release,
1595 dev_get_regmap_match, (void *)name);
1596
1597 if (!r)
1598 return NULL;
1599 return *r;
1600 }
1601 EXPORT_SYMBOL_GPL(dev_get_regmap);
1602
1603 /**
1604 * regmap_get_device() - Obtain the device from a regmap
1605 *
1606 * @map: Register map to operate on.
1607 *
1608 * Returns the underlying device that the regmap has been created for.
1609 */
regmap_get_device(struct regmap * map)1610 struct device *regmap_get_device(struct regmap *map)
1611 {
1612 return map->dev;
1613 }
1614 EXPORT_SYMBOL_GPL(regmap_get_device);
1615
_regmap_select_page(struct regmap * map,unsigned int * reg,struct regmap_range_node * range,unsigned int val_num)1616 static int _regmap_select_page(struct regmap *map, unsigned int *reg,
1617 struct regmap_range_node *range,
1618 unsigned int val_num)
1619 {
1620 void *orig_work_buf;
1621 unsigned int win_offset;
1622 unsigned int win_page;
1623 bool page_chg;
1624 int ret;
1625
1626 win_offset = (*reg - range->range_min) % range->window_len;
1627 win_page = (*reg - range->range_min) / range->window_len;
1628
1629 if (val_num > 1) {
1630 /* Bulk write shouldn't cross range boundary */
1631 if (*reg + val_num - 1 > range->range_max)
1632 return -EINVAL;
1633
1634 /* ... or single page boundary */
1635 if (val_num > range->window_len - win_offset)
1636 return -EINVAL;
1637 }
1638
1639 /* It is possible to have selector register inside data window.
1640 In that case, selector register is located on every page and
1641 it needs no page switching, when accessed alone. */
1642 if (val_num > 1 ||
1643 range->window_start + win_offset != range->selector_reg) {
1644 /* Use separate work_buf during page switching */
1645 orig_work_buf = map->work_buf;
1646 map->work_buf = map->selector_work_buf;
1647
1648 ret = _regmap_update_bits(map, range->selector_reg,
1649 range->selector_mask,
1650 win_page << range->selector_shift,
1651 &page_chg, false);
1652
1653 map->work_buf = orig_work_buf;
1654
1655 if (ret != 0)
1656 return ret;
1657 }
1658
1659 *reg = range->window_start + win_offset;
1660
1661 return 0;
1662 }
1663
regmap_set_work_buf_flag_mask(struct regmap * map,int max_bytes,unsigned long mask)1664 static void regmap_set_work_buf_flag_mask(struct regmap *map, int max_bytes,
1665 unsigned long mask)
1666 {
1667 u8 *buf;
1668 int i;
1669
1670 if (!mask || !map->work_buf)
1671 return;
1672
1673 buf = map->work_buf;
1674
1675 for (i = 0; i < max_bytes; i++)
1676 buf[i] |= (mask >> (8 * i)) & 0xff;
1677 }
1678
_regmap_raw_write_impl(struct regmap * map,unsigned int reg,const void * val,size_t val_len,bool noinc)1679 static int _regmap_raw_write_impl(struct regmap *map, unsigned int reg,
1680 const void *val, size_t val_len, bool noinc)
1681 {
1682 struct regmap_range_node *range;
1683 unsigned long flags;
1684 void *work_val = map->work_buf + map->format.reg_bytes +
1685 map->format.pad_bytes;
1686 void *buf;
1687 int ret = -ENOTSUPP;
1688 size_t len;
1689 int i;
1690
1691 /* Check for unwritable or noinc registers in range
1692 * before we start
1693 */
1694 if (!regmap_writeable_noinc(map, reg)) {
1695 for (i = 0; i < val_len / map->format.val_bytes; i++) {
1696 unsigned int element =
1697 reg + regmap_get_offset(map, i);
1698 if (!regmap_writeable(map, element) ||
1699 regmap_writeable_noinc(map, element))
1700 return -EINVAL;
1701 }
1702 }
1703
1704 if (!map->cache_bypass && map->format.parse_val) {
1705 unsigned int ival;
1706 int val_bytes = map->format.val_bytes;
1707 for (i = 0; i < val_len / val_bytes; i++) {
1708 ival = map->format.parse_val(val + (i * val_bytes));
1709 ret = regcache_write(map,
1710 reg + regmap_get_offset(map, i),
1711 ival);
1712 if (ret) {
1713 dev_err(map->dev,
1714 "Error in caching of register: %x ret: %d\n",
1715 reg + regmap_get_offset(map, i), ret);
1716 return ret;
1717 }
1718 }
1719 if (map->cache_only) {
1720 map->cache_dirty = true;
1721 return 0;
1722 }
1723 }
1724
1725 range = _regmap_range_lookup(map, reg);
1726 if (range) {
1727 int val_num = val_len / map->format.val_bytes;
1728 int win_offset = (reg - range->range_min) % range->window_len;
1729 int win_residue = range->window_len - win_offset;
1730
1731 /* If the write goes beyond the end of the window split it */
1732 while (val_num > win_residue) {
1733 dev_dbg(map->dev, "Writing window %d/%zu\n",
1734 win_residue, val_len / map->format.val_bytes);
1735 ret = _regmap_raw_write_impl(map, reg, val,
1736 win_residue *
1737 map->format.val_bytes, noinc);
1738 if (ret != 0)
1739 return ret;
1740
1741 reg += win_residue;
1742 val_num -= win_residue;
1743 val += win_residue * map->format.val_bytes;
1744 val_len -= win_residue * map->format.val_bytes;
1745
1746 win_offset = (reg - range->range_min) %
1747 range->window_len;
1748 win_residue = range->window_len - win_offset;
1749 }
1750
1751 ret = _regmap_select_page(map, ®, range, noinc ? 1 : val_num);
1752 if (ret != 0)
1753 return ret;
1754 }
1755
1756 reg += map->reg_base;
1757 reg >>= map->format.reg_downshift;
1758 map->format.format_reg(map->work_buf, reg, map->reg_shift);
1759 regmap_set_work_buf_flag_mask(map, map->format.reg_bytes,
1760 map->write_flag_mask);
1761
1762 /*
1763 * Essentially all I/O mechanisms will be faster with a single
1764 * buffer to write. Since register syncs often generate raw
1765 * writes of single registers optimise that case.
1766 */
1767 if (val != work_val && val_len == map->format.val_bytes) {
1768 memcpy(work_val, val, map->format.val_bytes);
1769 val = work_val;
1770 }
1771
1772 if (map->async && map->bus && map->bus->async_write) {
1773 struct regmap_async *async;
1774
1775 trace_regmap_async_write_start(map, reg, val_len);
1776
1777 spin_lock_irqsave(&map->async_lock, flags);
1778 async = list_first_entry_or_null(&map->async_free,
1779 struct regmap_async,
1780 list);
1781 if (async)
1782 list_del(&async->list);
1783 spin_unlock_irqrestore(&map->async_lock, flags);
1784
1785 if (!async) {
1786 async = map->bus->async_alloc();
1787 if (!async)
1788 return -ENOMEM;
1789
1790 async->work_buf = kzalloc(map->format.buf_size,
1791 GFP_KERNEL | GFP_DMA);
1792 if (!async->work_buf) {
1793 kfree(async);
1794 return -ENOMEM;
1795 }
1796 }
1797
1798 async->map = map;
1799
1800 /* If the caller supplied the value we can use it safely. */
1801 memcpy(async->work_buf, map->work_buf, map->format.pad_bytes +
1802 map->format.reg_bytes + map->format.val_bytes);
1803
1804 spin_lock_irqsave(&map->async_lock, flags);
1805 list_add_tail(&async->list, &map->async_list);
1806 spin_unlock_irqrestore(&map->async_lock, flags);
1807
1808 if (val != work_val)
1809 ret = map->bus->async_write(map->bus_context,
1810 async->work_buf,
1811 map->format.reg_bytes +
1812 map->format.pad_bytes,
1813 val, val_len, async);
1814 else
1815 ret = map->bus->async_write(map->bus_context,
1816 async->work_buf,
1817 map->format.reg_bytes +
1818 map->format.pad_bytes +
1819 val_len, NULL, 0, async);
1820
1821 if (ret != 0) {
1822 dev_err(map->dev, "Failed to schedule write: %d\n",
1823 ret);
1824
1825 spin_lock_irqsave(&map->async_lock, flags);
1826 list_move(&async->list, &map->async_free);
1827 spin_unlock_irqrestore(&map->async_lock, flags);
1828 }
1829
1830 return ret;
1831 }
1832
1833 trace_regmap_hw_write_start(map, reg, val_len / map->format.val_bytes);
1834
1835 /* If we're doing a single register write we can probably just
1836 * send the work_buf directly, otherwise try to do a gather
1837 * write.
1838 */
1839 if (val == work_val)
1840 ret = map->write(map->bus_context, map->work_buf,
1841 map->format.reg_bytes +
1842 map->format.pad_bytes +
1843 val_len);
1844 else if (map->bus && map->bus->gather_write)
1845 ret = map->bus->gather_write(map->bus_context, map->work_buf,
1846 map->format.reg_bytes +
1847 map->format.pad_bytes,
1848 val, val_len);
1849 else
1850 ret = -ENOTSUPP;
1851
1852 /* If that didn't work fall back on linearising by hand. */
1853 if (ret == -ENOTSUPP) {
1854 len = map->format.reg_bytes + map->format.pad_bytes + val_len;
1855 buf = kzalloc(len, GFP_KERNEL);
1856 if (!buf)
1857 return -ENOMEM;
1858
1859 memcpy(buf, map->work_buf, map->format.reg_bytes);
1860 memcpy(buf + map->format.reg_bytes + map->format.pad_bytes,
1861 val, val_len);
1862 ret = map->write(map->bus_context, buf, len);
1863
1864 kfree(buf);
1865 } else if (ret != 0 && !map->cache_bypass && map->format.parse_val) {
1866 /* regcache_drop_region() takes lock that we already have,
1867 * thus call map->cache_ops->drop() directly
1868 */
1869 if (map->cache_ops && map->cache_ops->drop)
1870 map->cache_ops->drop(map, reg, reg + 1);
1871 }
1872
1873 trace_regmap_hw_write_done(map, reg, val_len / map->format.val_bytes);
1874
1875 return ret;
1876 }
1877
1878 /**
1879 * regmap_can_raw_write - Test if regmap_raw_write() is supported
1880 *
1881 * @map: Map to check.
1882 */
regmap_can_raw_write(struct regmap * map)1883 bool regmap_can_raw_write(struct regmap *map)
1884 {
1885 return map->write && map->format.format_val && map->format.format_reg;
1886 }
1887 EXPORT_SYMBOL_GPL(regmap_can_raw_write);
1888
1889 /**
1890 * regmap_get_raw_read_max - Get the maximum size we can read
1891 *
1892 * @map: Map to check.
1893 */
regmap_get_raw_read_max(struct regmap * map)1894 size_t regmap_get_raw_read_max(struct regmap *map)
1895 {
1896 return map->max_raw_read;
1897 }
1898 EXPORT_SYMBOL_GPL(regmap_get_raw_read_max);
1899
1900 /**
1901 * regmap_get_raw_write_max - Get the maximum size we can read
1902 *
1903 * @map: Map to check.
1904 */
regmap_get_raw_write_max(struct regmap * map)1905 size_t regmap_get_raw_write_max(struct regmap *map)
1906 {
1907 return map->max_raw_write;
1908 }
1909 EXPORT_SYMBOL_GPL(regmap_get_raw_write_max);
1910
_regmap_bus_formatted_write(void * context,unsigned int reg,unsigned int val)1911 static int _regmap_bus_formatted_write(void *context, unsigned int reg,
1912 unsigned int val)
1913 {
1914 int ret;
1915 struct regmap_range_node *range;
1916 struct regmap *map = context;
1917
1918 WARN_ON(!map->format.format_write);
1919
1920 range = _regmap_range_lookup(map, reg);
1921 if (range) {
1922 ret = _regmap_select_page(map, ®, range, 1);
1923 if (ret != 0)
1924 return ret;
1925 }
1926
1927 reg += map->reg_base;
1928 reg >>= map->format.reg_downshift;
1929 map->format.format_write(map, reg, val);
1930
1931 trace_regmap_hw_write_start(map, reg, 1);
1932
1933 ret = map->write(map->bus_context, map->work_buf, map->format.buf_size);
1934
1935 trace_regmap_hw_write_done(map, reg, 1);
1936
1937 return ret;
1938 }
1939
_regmap_bus_reg_write(void * context,unsigned int reg,unsigned int val)1940 static int _regmap_bus_reg_write(void *context, unsigned int reg,
1941 unsigned int val)
1942 {
1943 struct regmap *map = context;
1944
1945 reg += map->reg_base;
1946 reg >>= map->format.reg_downshift;
1947 return map->bus->reg_write(map->bus_context, reg, val);
1948 }
1949
_regmap_bus_raw_write(void * context,unsigned int reg,unsigned int val)1950 static int _regmap_bus_raw_write(void *context, unsigned int reg,
1951 unsigned int val)
1952 {
1953 struct regmap *map = context;
1954
1955 WARN_ON(!map->format.format_val);
1956
1957 map->format.format_val(map->work_buf + map->format.reg_bytes
1958 + map->format.pad_bytes, val, 0);
1959 return _regmap_raw_write_impl(map, reg,
1960 map->work_buf +
1961 map->format.reg_bytes +
1962 map->format.pad_bytes,
1963 map->format.val_bytes,
1964 false);
1965 }
1966
_regmap_map_get_context(struct regmap * map)1967 static inline void *_regmap_map_get_context(struct regmap *map)
1968 {
1969 return (map->bus || (!map->bus && map->read)) ? map : map->bus_context;
1970 }
1971
_regmap_write(struct regmap * map,unsigned int reg,unsigned int val)1972 int _regmap_write(struct regmap *map, unsigned int reg,
1973 unsigned int val)
1974 {
1975 int ret;
1976 void *context = _regmap_map_get_context(map);
1977
1978 if (!regmap_writeable(map, reg))
1979 return -EIO;
1980
1981 if (!map->cache_bypass && !map->defer_caching) {
1982 ret = regcache_write(map, reg, val);
1983 if (ret != 0)
1984 return ret;
1985 if (map->cache_only) {
1986 map->cache_dirty = true;
1987 return 0;
1988 }
1989 }
1990
1991 ret = map->reg_write(context, reg, val);
1992 if (ret == 0) {
1993 if (regmap_should_log(map))
1994 dev_info(map->dev, "%x <= %x\n", reg, val);
1995
1996 trace_regmap_reg_write(map, reg, val);
1997 }
1998
1999 return ret;
2000 }
2001
2002 /**
2003 * regmap_write() - Write a value to a single register
2004 *
2005 * @map: Register map to write to
2006 * @reg: Register to write to
2007 * @val: Value to be written
2008 *
2009 * A value of zero will be returned on success, a negative errno will
2010 * be returned in error cases.
2011 */
regmap_write(struct regmap * map,unsigned int reg,unsigned int val)2012 int regmap_write(struct regmap *map, unsigned int reg, unsigned int val)
2013 {
2014 int ret;
2015
2016 if (!IS_ALIGNED(reg, map->reg_stride))
2017 return -EINVAL;
2018
2019 map->lock(map->lock_arg);
2020
2021 ret = _regmap_write(map, reg, val);
2022
2023 map->unlock(map->lock_arg);
2024
2025 return ret;
2026 }
2027 EXPORT_SYMBOL_GPL(regmap_write);
2028
2029 /**
2030 * regmap_write_async() - Write a value to a single register asynchronously
2031 *
2032 * @map: Register map to write to
2033 * @reg: Register to write to
2034 * @val: Value to be written
2035 *
2036 * A value of zero will be returned on success, a negative errno will
2037 * be returned in error cases.
2038 */
regmap_write_async(struct regmap * map,unsigned int reg,unsigned int val)2039 int regmap_write_async(struct regmap *map, unsigned int reg, unsigned int val)
2040 {
2041 int ret;
2042
2043 if (!IS_ALIGNED(reg, map->reg_stride))
2044 return -EINVAL;
2045
2046 map->lock(map->lock_arg);
2047
2048 map->async = true;
2049
2050 ret = _regmap_write(map, reg, val);
2051
2052 map->async = false;
2053
2054 map->unlock(map->lock_arg);
2055
2056 return ret;
2057 }
2058 EXPORT_SYMBOL_GPL(regmap_write_async);
2059
_regmap_raw_write(struct regmap * map,unsigned int reg,const void * val,size_t val_len,bool noinc)2060 int _regmap_raw_write(struct regmap *map, unsigned int reg,
2061 const void *val, size_t val_len, bool noinc)
2062 {
2063 size_t val_bytes = map->format.val_bytes;
2064 size_t val_count = val_len / val_bytes;
2065 size_t chunk_count, chunk_bytes;
2066 size_t chunk_regs = val_count;
2067 int ret, i;
2068
2069 if (!val_count)
2070 return -EINVAL;
2071
2072 if (map->use_single_write)
2073 chunk_regs = 1;
2074 else if (map->max_raw_write && val_len > map->max_raw_write)
2075 chunk_regs = map->max_raw_write / val_bytes;
2076
2077 chunk_count = val_count / chunk_regs;
2078 chunk_bytes = chunk_regs * val_bytes;
2079
2080 /* Write as many bytes as possible with chunk_size */
2081 for (i = 0; i < chunk_count; i++) {
2082 ret = _regmap_raw_write_impl(map, reg, val, chunk_bytes, noinc);
2083 if (ret)
2084 return ret;
2085
2086 reg += regmap_get_offset(map, chunk_regs);
2087 val += chunk_bytes;
2088 val_len -= chunk_bytes;
2089 }
2090
2091 /* Write remaining bytes */
2092 if (val_len)
2093 ret = _regmap_raw_write_impl(map, reg, val, val_len, noinc);
2094
2095 return ret;
2096 }
2097
2098 /**
2099 * regmap_raw_write() - Write raw values to one or more registers
2100 *
2101 * @map: Register map to write to
2102 * @reg: Initial register to write to
2103 * @val: Block of data to be written, laid out for direct transmission to the
2104 * device
2105 * @val_len: Length of data pointed to by val.
2106 *
2107 * This function is intended to be used for things like firmware
2108 * download where a large block of data needs to be transferred to the
2109 * device. No formatting will be done on the data provided.
2110 *
2111 * A value of zero will be returned on success, a negative errno will
2112 * be returned in error cases.
2113 */
regmap_raw_write(struct regmap * map,unsigned int reg,const void * val,size_t val_len)2114 int regmap_raw_write(struct regmap *map, unsigned int reg,
2115 const void *val, size_t val_len)
2116 {
2117 int ret;
2118
2119 if (!regmap_can_raw_write(map))
2120 return -EINVAL;
2121 if (val_len % map->format.val_bytes)
2122 return -EINVAL;
2123
2124 map->lock(map->lock_arg);
2125
2126 ret = _regmap_raw_write(map, reg, val, val_len, false);
2127
2128 map->unlock(map->lock_arg);
2129
2130 return ret;
2131 }
2132 EXPORT_SYMBOL_GPL(regmap_raw_write);
2133
regmap_noinc_readwrite(struct regmap * map,unsigned int reg,void * val,unsigned int val_len,bool write)2134 static int regmap_noinc_readwrite(struct regmap *map, unsigned int reg,
2135 void *val, unsigned int val_len, bool write)
2136 {
2137 size_t val_bytes = map->format.val_bytes;
2138 size_t val_count = val_len / val_bytes;
2139 unsigned int lastval;
2140 u8 *u8p;
2141 u16 *u16p;
2142 u32 *u32p;
2143 #ifdef CONFIG_64BIT
2144 u64 *u64p;
2145 #endif
2146 int ret;
2147 int i;
2148
2149 switch (val_bytes) {
2150 case 1:
2151 u8p = val;
2152 if (write)
2153 lastval = (unsigned int)u8p[val_count - 1];
2154 break;
2155 case 2:
2156 u16p = val;
2157 if (write)
2158 lastval = (unsigned int)u16p[val_count - 1];
2159 break;
2160 case 4:
2161 u32p = val;
2162 if (write)
2163 lastval = (unsigned int)u32p[val_count - 1];
2164 break;
2165 #ifdef CONFIG_64BIT
2166 case 8:
2167 u64p = val;
2168 if (write)
2169 lastval = (unsigned int)u64p[val_count - 1];
2170 break;
2171 #endif
2172 default:
2173 return -EINVAL;
2174 }
2175
2176 /*
2177 * Update the cache with the last value we write, the rest is just
2178 * gone down in the hardware FIFO. We can't cache FIFOs. This makes
2179 * sure a single read from the cache will work.
2180 */
2181 if (write) {
2182 if (!map->cache_bypass && !map->defer_caching) {
2183 ret = regcache_write(map, reg, lastval);
2184 if (ret != 0)
2185 return ret;
2186 if (map->cache_only) {
2187 map->cache_dirty = true;
2188 return 0;
2189 }
2190 }
2191 ret = map->bus->reg_noinc_write(map->bus_context, reg, val, val_count);
2192 } else {
2193 ret = map->bus->reg_noinc_read(map->bus_context, reg, val, val_count);
2194 }
2195
2196 if (!ret && regmap_should_log(map)) {
2197 dev_info(map->dev, "%x %s [", reg, write ? "<=" : "=>");
2198 for (i = 0; i < val_count; i++) {
2199 switch (val_bytes) {
2200 case 1:
2201 pr_cont("%x", u8p[i]);
2202 break;
2203 case 2:
2204 pr_cont("%x", u16p[i]);
2205 break;
2206 case 4:
2207 pr_cont("%x", u32p[i]);
2208 break;
2209 #ifdef CONFIG_64BIT
2210 case 8:
2211 pr_cont("%llx", u64p[i]);
2212 break;
2213 #endif
2214 default:
2215 break;
2216 }
2217 if (i == (val_count - 1))
2218 pr_cont("]\n");
2219 else
2220 pr_cont(",");
2221 }
2222 }
2223
2224 return 0;
2225 }
2226
2227 /**
2228 * regmap_noinc_write(): Write data from a register without incrementing the
2229 * register number
2230 *
2231 * @map: Register map to write to
2232 * @reg: Register to write to
2233 * @val: Pointer to data buffer
2234 * @val_len: Length of output buffer in bytes.
2235 *
2236 * The regmap API usually assumes that bulk bus write operations will write a
2237 * range of registers. Some devices have certain registers for which a write
2238 * operation can write to an internal FIFO.
2239 *
2240 * The target register must be volatile but registers after it can be
2241 * completely unrelated cacheable registers.
2242 *
2243 * This will attempt multiple writes as required to write val_len bytes.
2244 *
2245 * A value of zero will be returned on success, a negative errno will be
2246 * returned in error cases.
2247 */
regmap_noinc_write(struct regmap * map,unsigned int reg,const void * val,size_t val_len)2248 int regmap_noinc_write(struct regmap *map, unsigned int reg,
2249 const void *val, size_t val_len)
2250 {
2251 size_t write_len;
2252 int ret;
2253
2254 if (!map->write && !(map->bus && map->bus->reg_noinc_write))
2255 return -EINVAL;
2256 if (val_len % map->format.val_bytes)
2257 return -EINVAL;
2258 if (!IS_ALIGNED(reg, map->reg_stride))
2259 return -EINVAL;
2260 if (val_len == 0)
2261 return -EINVAL;
2262
2263 map->lock(map->lock_arg);
2264
2265 if (!regmap_volatile(map, reg) || !regmap_writeable_noinc(map, reg)) {
2266 ret = -EINVAL;
2267 goto out_unlock;
2268 }
2269
2270 /*
2271 * Use the accelerated operation if we can. The val drops the const
2272 * typing in order to facilitate code reuse in regmap_noinc_readwrite().
2273 */
2274 if (map->bus->reg_noinc_write) {
2275 ret = regmap_noinc_readwrite(map, reg, (void *)val, val_len, true);
2276 goto out_unlock;
2277 }
2278
2279 while (val_len) {
2280 if (map->max_raw_write && map->max_raw_write < val_len)
2281 write_len = map->max_raw_write;
2282 else
2283 write_len = val_len;
2284 ret = _regmap_raw_write(map, reg, val, write_len, true);
2285 if (ret)
2286 goto out_unlock;
2287 val = ((u8 *)val) + write_len;
2288 val_len -= write_len;
2289 }
2290
2291 out_unlock:
2292 map->unlock(map->lock_arg);
2293 return ret;
2294 }
2295 EXPORT_SYMBOL_GPL(regmap_noinc_write);
2296
2297 /**
2298 * regmap_field_update_bits_base() - Perform a read/modify/write cycle a
2299 * register field.
2300 *
2301 * @field: Register field to write to
2302 * @mask: Bitmask to change
2303 * @val: Value to be written
2304 * @change: Boolean indicating if a write was done
2305 * @async: Boolean indicating asynchronously
2306 * @force: Boolean indicating use force update
2307 *
2308 * Perform a read/modify/write cycle on the register field with change,
2309 * async, force option.
2310 *
2311 * A value of zero will be returned on success, a negative errno will
2312 * be returned in error cases.
2313 */
regmap_field_update_bits_base(struct regmap_field * field,unsigned int mask,unsigned int val,bool * change,bool async,bool force)2314 int regmap_field_update_bits_base(struct regmap_field *field,
2315 unsigned int mask, unsigned int val,
2316 bool *change, bool async, bool force)
2317 {
2318 mask = (mask << field->shift) & field->mask;
2319
2320 return regmap_update_bits_base(field->regmap, field->reg,
2321 mask, val << field->shift,
2322 change, async, force);
2323 }
2324 EXPORT_SYMBOL_GPL(regmap_field_update_bits_base);
2325
2326 /**
2327 * regmap_field_test_bits() - Check if all specified bits are set in a
2328 * register field.
2329 *
2330 * @field: Register field to operate on
2331 * @bits: Bits to test
2332 *
2333 * Returns -1 if the underlying regmap_field_read() fails, 0 if at least one of the
2334 * tested bits is not set and 1 if all tested bits are set.
2335 */
regmap_field_test_bits(struct regmap_field * field,unsigned int bits)2336 int regmap_field_test_bits(struct regmap_field *field, unsigned int bits)
2337 {
2338 unsigned int val, ret;
2339
2340 ret = regmap_field_read(field, &val);
2341 if (ret)
2342 return ret;
2343
2344 return (val & bits) == bits;
2345 }
2346 EXPORT_SYMBOL_GPL(regmap_field_test_bits);
2347
2348 /**
2349 * regmap_fields_update_bits_base() - Perform a read/modify/write cycle a
2350 * register field with port ID
2351 *
2352 * @field: Register field to write to
2353 * @id: port ID
2354 * @mask: Bitmask to change
2355 * @val: Value to be written
2356 * @change: Boolean indicating if a write was done
2357 * @async: Boolean indicating asynchronously
2358 * @force: Boolean indicating use force update
2359 *
2360 * A value of zero will be returned on success, a negative errno will
2361 * be returned in error cases.
2362 */
regmap_fields_update_bits_base(struct regmap_field * field,unsigned int id,unsigned int mask,unsigned int val,bool * change,bool async,bool force)2363 int regmap_fields_update_bits_base(struct regmap_field *field, unsigned int id,
2364 unsigned int mask, unsigned int val,
2365 bool *change, bool async, bool force)
2366 {
2367 if (id >= field->id_size)
2368 return -EINVAL;
2369
2370 mask = (mask << field->shift) & field->mask;
2371
2372 return regmap_update_bits_base(field->regmap,
2373 field->reg + (field->id_offset * id),
2374 mask, val << field->shift,
2375 change, async, force);
2376 }
2377 EXPORT_SYMBOL_GPL(regmap_fields_update_bits_base);
2378
2379 /**
2380 * regmap_bulk_write() - Write multiple registers to the device
2381 *
2382 * @map: Register map to write to
2383 * @reg: First register to be write from
2384 * @val: Block of data to be written, in native register size for device
2385 * @val_count: Number of registers to write
2386 *
2387 * This function is intended to be used for writing a large block of
2388 * data to the device either in single transfer or multiple transfer.
2389 *
2390 * A value of zero will be returned on success, a negative errno will
2391 * be returned in error cases.
2392 */
regmap_bulk_write(struct regmap * map,unsigned int reg,const void * val,size_t val_count)2393 int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
2394 size_t val_count)
2395 {
2396 int ret = 0, i;
2397 size_t val_bytes = map->format.val_bytes;
2398
2399 if (!IS_ALIGNED(reg, map->reg_stride))
2400 return -EINVAL;
2401
2402 /*
2403 * Some devices don't support bulk write, for them we have a series of
2404 * single write operations.
2405 */
2406 if (!map->write || !map->format.parse_inplace) {
2407 map->lock(map->lock_arg);
2408 for (i = 0; i < val_count; i++) {
2409 unsigned int ival;
2410
2411 switch (val_bytes) {
2412 case 1:
2413 ival = *(u8 *)(val + (i * val_bytes));
2414 break;
2415 case 2:
2416 ival = *(u16 *)(val + (i * val_bytes));
2417 break;
2418 case 4:
2419 ival = *(u32 *)(val + (i * val_bytes));
2420 break;
2421 #ifdef CONFIG_64BIT
2422 case 8:
2423 ival = *(u64 *)(val + (i * val_bytes));
2424 break;
2425 #endif
2426 default:
2427 ret = -EINVAL;
2428 goto out;
2429 }
2430
2431 ret = _regmap_write(map,
2432 reg + regmap_get_offset(map, i),
2433 ival);
2434 if (ret != 0)
2435 goto out;
2436 }
2437 out:
2438 map->unlock(map->lock_arg);
2439 } else {
2440 void *wval;
2441
2442 wval = kmemdup(val, val_count * val_bytes, map->alloc_flags);
2443 if (!wval)
2444 return -ENOMEM;
2445
2446 for (i = 0; i < val_count * val_bytes; i += val_bytes)
2447 map->format.parse_inplace(wval + i);
2448
2449 ret = regmap_raw_write(map, reg, wval, val_bytes * val_count);
2450
2451 kfree(wval);
2452 }
2453
2454 if (!ret)
2455 trace_regmap_bulk_write(map, reg, val, val_bytes * val_count);
2456
2457 return ret;
2458 }
2459 EXPORT_SYMBOL_GPL(regmap_bulk_write);
2460
2461 /*
2462 * _regmap_raw_multi_reg_write()
2463 *
2464 * the (register,newvalue) pairs in regs have not been formatted, but
2465 * they are all in the same page and have been changed to being page
2466 * relative. The page register has been written if that was necessary.
2467 */
_regmap_raw_multi_reg_write(struct regmap * map,const struct reg_sequence * regs,size_t num_regs)2468 static int _regmap_raw_multi_reg_write(struct regmap *map,
2469 const struct reg_sequence *regs,
2470 size_t num_regs)
2471 {
2472 int ret;
2473 void *buf;
2474 int i;
2475 u8 *u8;
2476 size_t val_bytes = map->format.val_bytes;
2477 size_t reg_bytes = map->format.reg_bytes;
2478 size_t pad_bytes = map->format.pad_bytes;
2479 size_t pair_size = reg_bytes + pad_bytes + val_bytes;
2480 size_t len = pair_size * num_regs;
2481
2482 if (!len)
2483 return -EINVAL;
2484
2485 buf = kzalloc(len, GFP_KERNEL);
2486 if (!buf)
2487 return -ENOMEM;
2488
2489 /* We have to linearise by hand. */
2490
2491 u8 = buf;
2492
2493 for (i = 0; i < num_regs; i++) {
2494 unsigned int reg = regs[i].reg;
2495 unsigned int val = regs[i].def;
2496 trace_regmap_hw_write_start(map, reg, 1);
2497 reg += map->reg_base;
2498 reg >>= map->format.reg_downshift;
2499 map->format.format_reg(u8, reg, map->reg_shift);
2500 u8 += reg_bytes + pad_bytes;
2501 map->format.format_val(u8, val, 0);
2502 u8 += val_bytes;
2503 }
2504 u8 = buf;
2505 *u8 |= map->write_flag_mask;
2506
2507 ret = map->write(map->bus_context, buf, len);
2508
2509 kfree(buf);
2510
2511 for (i = 0; i < num_regs; i++) {
2512 int reg = regs[i].reg;
2513 trace_regmap_hw_write_done(map, reg, 1);
2514 }
2515 return ret;
2516 }
2517
_regmap_register_page(struct regmap * map,unsigned int reg,struct regmap_range_node * range)2518 static unsigned int _regmap_register_page(struct regmap *map,
2519 unsigned int reg,
2520 struct regmap_range_node *range)
2521 {
2522 unsigned int win_page = (reg - range->range_min) / range->window_len;
2523
2524 return win_page;
2525 }
2526
_regmap_range_multi_paged_reg_write(struct regmap * map,struct reg_sequence * regs,size_t num_regs)2527 static int _regmap_range_multi_paged_reg_write(struct regmap *map,
2528 struct reg_sequence *regs,
2529 size_t num_regs)
2530 {
2531 int ret;
2532 int i, n;
2533 struct reg_sequence *base;
2534 unsigned int this_page = 0;
2535 unsigned int page_change = 0;
2536 /*
2537 * the set of registers are not neccessarily in order, but
2538 * since the order of write must be preserved this algorithm
2539 * chops the set each time the page changes. This also applies
2540 * if there is a delay required at any point in the sequence.
2541 */
2542 base = regs;
2543 for (i = 0, n = 0; i < num_regs; i++, n++) {
2544 unsigned int reg = regs[i].reg;
2545 struct regmap_range_node *range;
2546
2547 range = _regmap_range_lookup(map, reg);
2548 if (range) {
2549 unsigned int win_page = _regmap_register_page(map, reg,
2550 range);
2551
2552 if (i == 0)
2553 this_page = win_page;
2554 if (win_page != this_page) {
2555 this_page = win_page;
2556 page_change = 1;
2557 }
2558 }
2559
2560 /* If we have both a page change and a delay make sure to
2561 * write the regs and apply the delay before we change the
2562 * page.
2563 */
2564
2565 if (page_change || regs[i].delay_us) {
2566
2567 /* For situations where the first write requires
2568 * a delay we need to make sure we don't call
2569 * raw_multi_reg_write with n=0
2570 * This can't occur with page breaks as we
2571 * never write on the first iteration
2572 */
2573 if (regs[i].delay_us && i == 0)
2574 n = 1;
2575
2576 ret = _regmap_raw_multi_reg_write(map, base, n);
2577 if (ret != 0)
2578 return ret;
2579
2580 if (regs[i].delay_us) {
2581 if (map->can_sleep)
2582 fsleep(regs[i].delay_us);
2583 else
2584 udelay(regs[i].delay_us);
2585 }
2586
2587 base += n;
2588 n = 0;
2589
2590 if (page_change) {
2591 ret = _regmap_select_page(map,
2592 &base[n].reg,
2593 range, 1);
2594 if (ret != 0)
2595 return ret;
2596
2597 page_change = 0;
2598 }
2599
2600 }
2601
2602 }
2603 if (n > 0)
2604 return _regmap_raw_multi_reg_write(map, base, n);
2605 return 0;
2606 }
2607
_regmap_multi_reg_write(struct regmap * map,const struct reg_sequence * regs,size_t num_regs)2608 static int _regmap_multi_reg_write(struct regmap *map,
2609 const struct reg_sequence *regs,
2610 size_t num_regs)
2611 {
2612 int i;
2613 int ret;
2614
2615 if (!map->can_multi_write) {
2616 for (i = 0; i < num_regs; i++) {
2617 ret = _regmap_write(map, regs[i].reg, regs[i].def);
2618 if (ret != 0)
2619 return ret;
2620
2621 if (regs[i].delay_us) {
2622 if (map->can_sleep)
2623 fsleep(regs[i].delay_us);
2624 else
2625 udelay(regs[i].delay_us);
2626 }
2627 }
2628 return 0;
2629 }
2630
2631 if (!map->format.parse_inplace)
2632 return -EINVAL;
2633
2634 if (map->writeable_reg)
2635 for (i = 0; i < num_regs; i++) {
2636 int reg = regs[i].reg;
2637 if (!map->writeable_reg(map->dev, reg))
2638 return -EINVAL;
2639 if (!IS_ALIGNED(reg, map->reg_stride))
2640 return -EINVAL;
2641 }
2642
2643 if (!map->cache_bypass) {
2644 for (i = 0; i < num_regs; i++) {
2645 unsigned int val = regs[i].def;
2646 unsigned int reg = regs[i].reg;
2647 ret = regcache_write(map, reg, val);
2648 if (ret) {
2649 dev_err(map->dev,
2650 "Error in caching of register: %x ret: %d\n",
2651 reg, ret);
2652 return ret;
2653 }
2654 }
2655 if (map->cache_only) {
2656 map->cache_dirty = true;
2657 return 0;
2658 }
2659 }
2660
2661 WARN_ON(!map->bus);
2662
2663 for (i = 0; i < num_regs; i++) {
2664 unsigned int reg = regs[i].reg;
2665 struct regmap_range_node *range;
2666
2667 /* Coalesce all the writes between a page break or a delay
2668 * in a sequence
2669 */
2670 range = _regmap_range_lookup(map, reg);
2671 if (range || regs[i].delay_us) {
2672 size_t len = sizeof(struct reg_sequence)*num_regs;
2673 struct reg_sequence *base = kmemdup(regs, len,
2674 GFP_KERNEL);
2675 if (!base)
2676 return -ENOMEM;
2677 ret = _regmap_range_multi_paged_reg_write(map, base,
2678 num_regs);
2679 kfree(base);
2680
2681 return ret;
2682 }
2683 }
2684 return _regmap_raw_multi_reg_write(map, regs, num_regs);
2685 }
2686
2687 /**
2688 * regmap_multi_reg_write() - Write multiple registers to the device
2689 *
2690 * @map: Register map to write to
2691 * @regs: Array of structures containing register,value to be written
2692 * @num_regs: Number of registers to write
2693 *
2694 * Write multiple registers to the device where the set of register, value
2695 * pairs are supplied in any order, possibly not all in a single range.
2696 *
2697 * The 'normal' block write mode will send ultimately send data on the
2698 * target bus as R,V1,V2,V3,..,Vn where successively higher registers are
2699 * addressed. However, this alternative block multi write mode will send
2700 * the data as R1,V1,R2,V2,..,Rn,Vn on the target bus. The target device
2701 * must of course support the mode.
2702 *
2703 * A value of zero will be returned on success, a negative errno will be
2704 * returned in error cases.
2705 */
regmap_multi_reg_write(struct regmap * map,const struct reg_sequence * regs,int num_regs)2706 int regmap_multi_reg_write(struct regmap *map, const struct reg_sequence *regs,
2707 int num_regs)
2708 {
2709 int ret;
2710
2711 map->lock(map->lock_arg);
2712
2713 ret = _regmap_multi_reg_write(map, regs, num_regs);
2714
2715 map->unlock(map->lock_arg);
2716
2717 return ret;
2718 }
2719 EXPORT_SYMBOL_GPL(regmap_multi_reg_write);
2720
2721 /**
2722 * regmap_multi_reg_write_bypassed() - Write multiple registers to the
2723 * device but not the cache
2724 *
2725 * @map: Register map to write to
2726 * @regs: Array of structures containing register,value to be written
2727 * @num_regs: Number of registers to write
2728 *
2729 * Write multiple registers to the device but not the cache where the set
2730 * of register are supplied in any order.
2731 *
2732 * This function is intended to be used for writing a large block of data
2733 * atomically to the device in single transfer for those I2C client devices
2734 * that implement this alternative block write mode.
2735 *
2736 * A value of zero will be returned on success, a negative errno will
2737 * be returned in error cases.
2738 */
regmap_multi_reg_write_bypassed(struct regmap * map,const struct reg_sequence * regs,int num_regs)2739 int regmap_multi_reg_write_bypassed(struct regmap *map,
2740 const struct reg_sequence *regs,
2741 int num_regs)
2742 {
2743 int ret;
2744 bool bypass;
2745
2746 map->lock(map->lock_arg);
2747
2748 bypass = map->cache_bypass;
2749 map->cache_bypass = true;
2750
2751 ret = _regmap_multi_reg_write(map, regs, num_regs);
2752
2753 map->cache_bypass = bypass;
2754
2755 map->unlock(map->lock_arg);
2756
2757 return ret;
2758 }
2759 EXPORT_SYMBOL_GPL(regmap_multi_reg_write_bypassed);
2760
2761 /**
2762 * regmap_raw_write_async() - Write raw values to one or more registers
2763 * asynchronously
2764 *
2765 * @map: Register map to write to
2766 * @reg: Initial register to write to
2767 * @val: Block of data to be written, laid out for direct transmission to the
2768 * device. Must be valid until regmap_async_complete() is called.
2769 * @val_len: Length of data pointed to by val.
2770 *
2771 * This function is intended to be used for things like firmware
2772 * download where a large block of data needs to be transferred to the
2773 * device. No formatting will be done on the data provided.
2774 *
2775 * If supported by the underlying bus the write will be scheduled
2776 * asynchronously, helping maximise I/O speed on higher speed buses
2777 * like SPI. regmap_async_complete() can be called to ensure that all
2778 * asynchrnous writes have been completed.
2779 *
2780 * A value of zero will be returned on success, a negative errno will
2781 * be returned in error cases.
2782 */
regmap_raw_write_async(struct regmap * map,unsigned int reg,const void * val,size_t val_len)2783 int regmap_raw_write_async(struct regmap *map, unsigned int reg,
2784 const void *val, size_t val_len)
2785 {
2786 int ret;
2787
2788 if (val_len % map->format.val_bytes)
2789 return -EINVAL;
2790 if (!IS_ALIGNED(reg, map->reg_stride))
2791 return -EINVAL;
2792
2793 map->lock(map->lock_arg);
2794
2795 map->async = true;
2796
2797 ret = _regmap_raw_write(map, reg, val, val_len, false);
2798
2799 map->async = false;
2800
2801 map->unlock(map->lock_arg);
2802
2803 return ret;
2804 }
2805 EXPORT_SYMBOL_GPL(regmap_raw_write_async);
2806
_regmap_raw_read(struct regmap * map,unsigned int reg,void * val,unsigned int val_len,bool noinc)2807 static int _regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
2808 unsigned int val_len, bool noinc)
2809 {
2810 struct regmap_range_node *range;
2811 int ret;
2812
2813 if (!map->read)
2814 return -EINVAL;
2815
2816 range = _regmap_range_lookup(map, reg);
2817 if (range) {
2818 ret = _regmap_select_page(map, ®, range,
2819 noinc ? 1 : val_len / map->format.val_bytes);
2820 if (ret != 0)
2821 return ret;
2822 }
2823
2824 reg += map->reg_base;
2825 reg >>= map->format.reg_downshift;
2826 map->format.format_reg(map->work_buf, reg, map->reg_shift);
2827 regmap_set_work_buf_flag_mask(map, map->format.reg_bytes,
2828 map->read_flag_mask);
2829 trace_regmap_hw_read_start(map, reg, val_len / map->format.val_bytes);
2830
2831 ret = map->read(map->bus_context, map->work_buf,
2832 map->format.reg_bytes + map->format.pad_bytes,
2833 val, val_len);
2834
2835 trace_regmap_hw_read_done(map, reg, val_len / map->format.val_bytes);
2836
2837 return ret;
2838 }
2839
_regmap_bus_reg_read(void * context,unsigned int reg,unsigned int * val)2840 static int _regmap_bus_reg_read(void *context, unsigned int reg,
2841 unsigned int *val)
2842 {
2843 struct regmap *map = context;
2844
2845 reg += map->reg_base;
2846 reg >>= map->format.reg_downshift;
2847 return map->bus->reg_read(map->bus_context, reg, val);
2848 }
2849
_regmap_bus_read(void * context,unsigned int reg,unsigned int * val)2850 static int _regmap_bus_read(void *context, unsigned int reg,
2851 unsigned int *val)
2852 {
2853 int ret;
2854 struct regmap *map = context;
2855 void *work_val = map->work_buf + map->format.reg_bytes +
2856 map->format.pad_bytes;
2857
2858 if (!map->format.parse_val)
2859 return -EINVAL;
2860
2861 ret = _regmap_raw_read(map, reg, work_val, map->format.val_bytes, false);
2862 if (ret == 0)
2863 *val = map->format.parse_val(work_val);
2864
2865 return ret;
2866 }
2867
_regmap_read(struct regmap * map,unsigned int reg,unsigned int * val)2868 static int _regmap_read(struct regmap *map, unsigned int reg,
2869 unsigned int *val)
2870 {
2871 int ret;
2872 void *context = _regmap_map_get_context(map);
2873
2874 if (!map->cache_bypass) {
2875 ret = regcache_read(map, reg, val);
2876 if (ret == 0)
2877 return 0;
2878 }
2879
2880 if (map->cache_only)
2881 return -EBUSY;
2882
2883 if (!regmap_readable(map, reg))
2884 return -EIO;
2885
2886 ret = map->reg_read(context, reg, val);
2887 if (ret == 0) {
2888 if (regmap_should_log(map))
2889 dev_info(map->dev, "%x => %x\n", reg, *val);
2890
2891 trace_regmap_reg_read(map, reg, *val);
2892
2893 if (!map->cache_bypass)
2894 regcache_write(map, reg, *val);
2895 }
2896
2897 return ret;
2898 }
2899
2900 /**
2901 * regmap_read() - Read a value from a single register
2902 *
2903 * @map: Register map to read from
2904 * @reg: Register to be read from
2905 * @val: Pointer to store read value
2906 *
2907 * A value of zero will be returned on success, a negative errno will
2908 * be returned in error cases.
2909 */
regmap_read(struct regmap * map,unsigned int reg,unsigned int * val)2910 int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val)
2911 {
2912 int ret;
2913
2914 if (!IS_ALIGNED(reg, map->reg_stride))
2915 return -EINVAL;
2916
2917 map->lock(map->lock_arg);
2918
2919 ret = _regmap_read(map, reg, val);
2920
2921 map->unlock(map->lock_arg);
2922
2923 return ret;
2924 }
2925 EXPORT_SYMBOL_GPL(regmap_read);
2926
2927 /**
2928 * regmap_raw_read() - Read raw data from the device
2929 *
2930 * @map: Register map to read from
2931 * @reg: First register to be read from
2932 * @val: Pointer to store read value
2933 * @val_len: Size of data to read
2934 *
2935 * A value of zero will be returned on success, a negative errno will
2936 * be returned in error cases.
2937 */
regmap_raw_read(struct regmap * map,unsigned int reg,void * val,size_t val_len)2938 int regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
2939 size_t val_len)
2940 {
2941 size_t val_bytes = map->format.val_bytes;
2942 size_t val_count = val_len / val_bytes;
2943 unsigned int v;
2944 int ret, i;
2945
2946 if (val_len % map->format.val_bytes)
2947 return -EINVAL;
2948 if (!IS_ALIGNED(reg, map->reg_stride))
2949 return -EINVAL;
2950 if (val_count == 0)
2951 return -EINVAL;
2952
2953 map->lock(map->lock_arg);
2954
2955 if (regmap_volatile_range(map, reg, val_count) || map->cache_bypass ||
2956 map->cache_type == REGCACHE_NONE) {
2957 size_t chunk_count, chunk_bytes;
2958 size_t chunk_regs = val_count;
2959
2960 if (!map->read) {
2961 ret = -ENOTSUPP;
2962 goto out;
2963 }
2964
2965 if (map->use_single_read)
2966 chunk_regs = 1;
2967 else if (map->max_raw_read && val_len > map->max_raw_read)
2968 chunk_regs = map->max_raw_read / val_bytes;
2969
2970 chunk_count = val_count / chunk_regs;
2971 chunk_bytes = chunk_regs * val_bytes;
2972
2973 /* Read bytes that fit into whole chunks */
2974 for (i = 0; i < chunk_count; i++) {
2975 ret = _regmap_raw_read(map, reg, val, chunk_bytes, false);
2976 if (ret != 0)
2977 goto out;
2978
2979 reg += regmap_get_offset(map, chunk_regs);
2980 val += chunk_bytes;
2981 val_len -= chunk_bytes;
2982 }
2983
2984 /* Read remaining bytes */
2985 if (val_len) {
2986 ret = _regmap_raw_read(map, reg, val, val_len, false);
2987 if (ret != 0)
2988 goto out;
2989 }
2990 } else {
2991 /* Otherwise go word by word for the cache; should be low
2992 * cost as we expect to hit the cache.
2993 */
2994 for (i = 0; i < val_count; i++) {
2995 ret = _regmap_read(map, reg + regmap_get_offset(map, i),
2996 &v);
2997 if (ret != 0)
2998 goto out;
2999
3000 map->format.format_val(val + (i * val_bytes), v, 0);
3001 }
3002 }
3003
3004 out:
3005 map->unlock(map->lock_arg);
3006
3007 return ret;
3008 }
3009 EXPORT_SYMBOL_GPL(regmap_raw_read);
3010
3011 /**
3012 * regmap_noinc_read(): Read data from a register without incrementing the
3013 * register number
3014 *
3015 * @map: Register map to read from
3016 * @reg: Register to read from
3017 * @val: Pointer to data buffer
3018 * @val_len: Length of output buffer in bytes.
3019 *
3020 * The regmap API usually assumes that bulk read operations will read a
3021 * range of registers. Some devices have certain registers for which a read
3022 * operation read will read from an internal FIFO.
3023 *
3024 * The target register must be volatile but registers after it can be
3025 * completely unrelated cacheable registers.
3026 *
3027 * This will attempt multiple reads as required to read val_len bytes.
3028 *
3029 * A value of zero will be returned on success, a negative errno will be
3030 * returned in error cases.
3031 */
regmap_noinc_read(struct regmap * map,unsigned int reg,void * val,size_t val_len)3032 int regmap_noinc_read(struct regmap *map, unsigned int reg,
3033 void *val, size_t val_len)
3034 {
3035 size_t read_len;
3036 int ret;
3037
3038 if (!map->read)
3039 return -ENOTSUPP;
3040
3041 if (val_len % map->format.val_bytes)
3042 return -EINVAL;
3043 if (!IS_ALIGNED(reg, map->reg_stride))
3044 return -EINVAL;
3045 if (val_len == 0)
3046 return -EINVAL;
3047
3048 map->lock(map->lock_arg);
3049
3050 if (!regmap_volatile(map, reg) || !regmap_readable_noinc(map, reg)) {
3051 ret = -EINVAL;
3052 goto out_unlock;
3053 }
3054
3055 /* Use the accelerated operation if we can */
3056 if (map->bus->reg_noinc_read) {
3057 /*
3058 * We have not defined the FIFO semantics for cache, as the
3059 * cache is just one value deep. Should we return the last
3060 * written value? Just avoid this by always reading the FIFO
3061 * even when using cache. Cache only will not work.
3062 */
3063 if (map->cache_only) {
3064 ret = -EBUSY;
3065 goto out_unlock;
3066 }
3067 ret = regmap_noinc_readwrite(map, reg, val, val_len, false);
3068 goto out_unlock;
3069 }
3070
3071 while (val_len) {
3072 if (map->max_raw_read && map->max_raw_read < val_len)
3073 read_len = map->max_raw_read;
3074 else
3075 read_len = val_len;
3076 ret = _regmap_raw_read(map, reg, val, read_len, true);
3077 if (ret)
3078 goto out_unlock;
3079 val = ((u8 *)val) + read_len;
3080 val_len -= read_len;
3081 }
3082
3083 out_unlock:
3084 map->unlock(map->lock_arg);
3085 return ret;
3086 }
3087 EXPORT_SYMBOL_GPL(regmap_noinc_read);
3088
3089 /**
3090 * regmap_field_read(): Read a value to a single register field
3091 *
3092 * @field: Register field to read from
3093 * @val: Pointer to store read value
3094 *
3095 * A value of zero will be returned on success, a negative errno will
3096 * be returned in error cases.
3097 */
regmap_field_read(struct regmap_field * field,unsigned int * val)3098 int regmap_field_read(struct regmap_field *field, unsigned int *val)
3099 {
3100 int ret;
3101 unsigned int reg_val;
3102 ret = regmap_read(field->regmap, field->reg, ®_val);
3103 if (ret != 0)
3104 return ret;
3105
3106 reg_val &= field->mask;
3107 reg_val >>= field->shift;
3108 *val = reg_val;
3109
3110 return ret;
3111 }
3112 EXPORT_SYMBOL_GPL(regmap_field_read);
3113
3114 /**
3115 * regmap_fields_read() - Read a value to a single register field with port ID
3116 *
3117 * @field: Register field to read from
3118 * @id: port ID
3119 * @val: Pointer to store read value
3120 *
3121 * A value of zero will be returned on success, a negative errno will
3122 * be returned in error cases.
3123 */
regmap_fields_read(struct regmap_field * field,unsigned int id,unsigned int * val)3124 int regmap_fields_read(struct regmap_field *field, unsigned int id,
3125 unsigned int *val)
3126 {
3127 int ret;
3128 unsigned int reg_val;
3129
3130 if (id >= field->id_size)
3131 return -EINVAL;
3132
3133 ret = regmap_read(field->regmap,
3134 field->reg + (field->id_offset * id),
3135 ®_val);
3136 if (ret != 0)
3137 return ret;
3138
3139 reg_val &= field->mask;
3140 reg_val >>= field->shift;
3141 *val = reg_val;
3142
3143 return ret;
3144 }
3145 EXPORT_SYMBOL_GPL(regmap_fields_read);
3146
3147 /**
3148 * regmap_bulk_read() - Read multiple registers from the device
3149 *
3150 * @map: Register map to read from
3151 * @reg: First register to be read from
3152 * @val: Pointer to store read value, in native register size for device
3153 * @val_count: Number of registers to read
3154 *
3155 * A value of zero will be returned on success, a negative errno will
3156 * be returned in error cases.
3157 */
regmap_bulk_read(struct regmap * map,unsigned int reg,void * val,size_t val_count)3158 int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
3159 size_t val_count)
3160 {
3161 int ret, i;
3162 size_t val_bytes = map->format.val_bytes;
3163 bool vol = regmap_volatile_range(map, reg, val_count);
3164
3165 if (!IS_ALIGNED(reg, map->reg_stride))
3166 return -EINVAL;
3167 if (val_count == 0)
3168 return -EINVAL;
3169
3170 if (map->read && map->format.parse_inplace && (vol || map->cache_type == REGCACHE_NONE)) {
3171 ret = regmap_raw_read(map, reg, val, val_bytes * val_count);
3172 if (ret != 0)
3173 return ret;
3174
3175 for (i = 0; i < val_count * val_bytes; i += val_bytes)
3176 map->format.parse_inplace(val + i);
3177 } else {
3178 #ifdef CONFIG_64BIT
3179 u64 *u64 = val;
3180 #endif
3181 u32 *u32 = val;
3182 u16 *u16 = val;
3183 u8 *u8 = val;
3184
3185 map->lock(map->lock_arg);
3186
3187 for (i = 0; i < val_count; i++) {
3188 unsigned int ival;
3189
3190 ret = _regmap_read(map, reg + regmap_get_offset(map, i),
3191 &ival);
3192 if (ret != 0)
3193 goto out;
3194
3195 switch (map->format.val_bytes) {
3196 #ifdef CONFIG_64BIT
3197 case 8:
3198 u64[i] = ival;
3199 break;
3200 #endif
3201 case 4:
3202 u32[i] = ival;
3203 break;
3204 case 2:
3205 u16[i] = ival;
3206 break;
3207 case 1:
3208 u8[i] = ival;
3209 break;
3210 default:
3211 ret = -EINVAL;
3212 goto out;
3213 }
3214 }
3215
3216 out:
3217 map->unlock(map->lock_arg);
3218 }
3219
3220 if (!ret)
3221 trace_regmap_bulk_read(map, reg, val, val_bytes * val_count);
3222
3223 return ret;
3224 }
3225 EXPORT_SYMBOL_GPL(regmap_bulk_read);
3226
_regmap_update_bits(struct regmap * map,unsigned int reg,unsigned int mask,unsigned int val,bool * change,bool force_write)3227 static int _regmap_update_bits(struct regmap *map, unsigned int reg,
3228 unsigned int mask, unsigned int val,
3229 bool *change, bool force_write)
3230 {
3231 int ret;
3232 unsigned int tmp, orig;
3233
3234 if (change)
3235 *change = false;
3236
3237 if (regmap_volatile(map, reg) && map->reg_update_bits) {
3238 reg += map->reg_base;
3239 reg >>= map->format.reg_downshift;
3240 ret = map->reg_update_bits(map->bus_context, reg, mask, val);
3241 if (ret == 0 && change)
3242 *change = true;
3243 } else {
3244 ret = _regmap_read(map, reg, &orig);
3245 if (ret != 0)
3246 return ret;
3247
3248 tmp = orig & ~mask;
3249 tmp |= val & mask;
3250
3251 if (force_write || (tmp != orig)) {
3252 ret = _regmap_write(map, reg, tmp);
3253 if (ret == 0 && change)
3254 *change = true;
3255 }
3256 }
3257
3258 return ret;
3259 }
3260
3261 /**
3262 * regmap_update_bits_base() - Perform a read/modify/write cycle on a register
3263 *
3264 * @map: Register map to update
3265 * @reg: Register to update
3266 * @mask: Bitmask to change
3267 * @val: New value for bitmask
3268 * @change: Boolean indicating if a write was done
3269 * @async: Boolean indicating asynchronously
3270 * @force: Boolean indicating use force update
3271 *
3272 * Perform a read/modify/write cycle on a register map with change, async, force
3273 * options.
3274 *
3275 * If async is true:
3276 *
3277 * With most buses the read must be done synchronously so this is most useful
3278 * for devices with a cache which do not need to interact with the hardware to
3279 * determine the current register value.
3280 *
3281 * Returns zero for success, a negative number on error.
3282 */
regmap_update_bits_base(struct regmap * map,unsigned int reg,unsigned int mask,unsigned int val,bool * change,bool async,bool force)3283 int regmap_update_bits_base(struct regmap *map, unsigned int reg,
3284 unsigned int mask, unsigned int val,
3285 bool *change, bool async, bool force)
3286 {
3287 int ret;
3288
3289 map->lock(map->lock_arg);
3290
3291 map->async = async;
3292
3293 ret = _regmap_update_bits(map, reg, mask, val, change, force);
3294
3295 map->async = false;
3296
3297 map->unlock(map->lock_arg);
3298
3299 return ret;
3300 }
3301 EXPORT_SYMBOL_GPL(regmap_update_bits_base);
3302
3303 /**
3304 * regmap_test_bits() - Check if all specified bits are set in a register.
3305 *
3306 * @map: Register map to operate on
3307 * @reg: Register to read from
3308 * @bits: Bits to test
3309 *
3310 * Returns 0 if at least one of the tested bits is not set, 1 if all tested
3311 * bits are set and a negative error number if the underlying regmap_read()
3312 * fails.
3313 */
regmap_test_bits(struct regmap * map,unsigned int reg,unsigned int bits)3314 int regmap_test_bits(struct regmap *map, unsigned int reg, unsigned int bits)
3315 {
3316 unsigned int val, ret;
3317
3318 ret = regmap_read(map, reg, &val);
3319 if (ret)
3320 return ret;
3321
3322 return (val & bits) == bits;
3323 }
3324 EXPORT_SYMBOL_GPL(regmap_test_bits);
3325
regmap_async_complete_cb(struct regmap_async * async,int ret)3326 void regmap_async_complete_cb(struct regmap_async *async, int ret)
3327 {
3328 struct regmap *map = async->map;
3329 bool wake;
3330
3331 trace_regmap_async_io_complete(map);
3332
3333 spin_lock(&map->async_lock);
3334 list_move(&async->list, &map->async_free);
3335 wake = list_empty(&map->async_list);
3336
3337 if (ret != 0)
3338 map->async_ret = ret;
3339
3340 spin_unlock(&map->async_lock);
3341
3342 if (wake)
3343 wake_up(&map->async_waitq);
3344 }
3345 EXPORT_SYMBOL_GPL(regmap_async_complete_cb);
3346
regmap_async_is_done(struct regmap * map)3347 static int regmap_async_is_done(struct regmap *map)
3348 {
3349 unsigned long flags;
3350 int ret;
3351
3352 spin_lock_irqsave(&map->async_lock, flags);
3353 ret = list_empty(&map->async_list);
3354 spin_unlock_irqrestore(&map->async_lock, flags);
3355
3356 return ret;
3357 }
3358
3359 /**
3360 * regmap_async_complete - Ensure all asynchronous I/O has completed.
3361 *
3362 * @map: Map to operate on.
3363 *
3364 * Blocks until any pending asynchronous I/O has completed. Returns
3365 * an error code for any failed I/O operations.
3366 */
regmap_async_complete(struct regmap * map)3367 int regmap_async_complete(struct regmap *map)
3368 {
3369 unsigned long flags;
3370 int ret;
3371
3372 /* Nothing to do with no async support */
3373 if (!map->bus || !map->bus->async_write)
3374 return 0;
3375
3376 trace_regmap_async_complete_start(map);
3377
3378 wait_event(map->async_waitq, regmap_async_is_done(map));
3379
3380 spin_lock_irqsave(&map->async_lock, flags);
3381 ret = map->async_ret;
3382 map->async_ret = 0;
3383 spin_unlock_irqrestore(&map->async_lock, flags);
3384
3385 trace_regmap_async_complete_done(map);
3386
3387 return ret;
3388 }
3389 EXPORT_SYMBOL_GPL(regmap_async_complete);
3390
3391 /**
3392 * regmap_register_patch - Register and apply register updates to be applied
3393 * on device initialistion
3394 *
3395 * @map: Register map to apply updates to.
3396 * @regs: Values to update.
3397 * @num_regs: Number of entries in regs.
3398 *
3399 * Register a set of register updates to be applied to the device
3400 * whenever the device registers are synchronised with the cache and
3401 * apply them immediately. Typically this is used to apply
3402 * corrections to be applied to the device defaults on startup, such
3403 * as the updates some vendors provide to undocumented registers.
3404 *
3405 * The caller must ensure that this function cannot be called
3406 * concurrently with either itself or regcache_sync().
3407 */
regmap_register_patch(struct regmap * map,const struct reg_sequence * regs,int num_regs)3408 int regmap_register_patch(struct regmap *map, const struct reg_sequence *regs,
3409 int num_regs)
3410 {
3411 struct reg_sequence *p;
3412 int ret;
3413 bool bypass;
3414
3415 if (WARN_ONCE(num_regs <= 0, "invalid registers number (%d)\n",
3416 num_regs))
3417 return 0;
3418
3419 p = krealloc(map->patch,
3420 sizeof(struct reg_sequence) * (map->patch_regs + num_regs),
3421 GFP_KERNEL);
3422 if (p) {
3423 memcpy(p + map->patch_regs, regs, num_regs * sizeof(*regs));
3424 map->patch = p;
3425 map->patch_regs += num_regs;
3426 } else {
3427 return -ENOMEM;
3428 }
3429
3430 map->lock(map->lock_arg);
3431
3432 bypass = map->cache_bypass;
3433
3434 map->cache_bypass = true;
3435 map->async = true;
3436
3437 ret = _regmap_multi_reg_write(map, regs, num_regs);
3438
3439 map->async = false;
3440 map->cache_bypass = bypass;
3441
3442 map->unlock(map->lock_arg);
3443
3444 regmap_async_complete(map);
3445
3446 return ret;
3447 }
3448 EXPORT_SYMBOL_GPL(regmap_register_patch);
3449
3450 /**
3451 * regmap_get_val_bytes() - Report the size of a register value
3452 *
3453 * @map: Register map to operate on.
3454 *
3455 * Report the size of a register value, mainly intended to for use by
3456 * generic infrastructure built on top of regmap.
3457 */
regmap_get_val_bytes(struct regmap * map)3458 int regmap_get_val_bytes(struct regmap *map)
3459 {
3460 if (map->format.format_write)
3461 return -EINVAL;
3462
3463 return map->format.val_bytes;
3464 }
3465 EXPORT_SYMBOL_GPL(regmap_get_val_bytes);
3466
3467 /**
3468 * regmap_get_max_register() - Report the max register value
3469 *
3470 * @map: Register map to operate on.
3471 *
3472 * Report the max register value, mainly intended to for use by
3473 * generic infrastructure built on top of regmap.
3474 */
regmap_get_max_register(struct regmap * map)3475 int regmap_get_max_register(struct regmap *map)
3476 {
3477 return map->max_register ? map->max_register : -EINVAL;
3478 }
3479 EXPORT_SYMBOL_GPL(regmap_get_max_register);
3480
3481 /**
3482 * regmap_get_reg_stride() - Report the register address stride
3483 *
3484 * @map: Register map to operate on.
3485 *
3486 * Report the register address stride, mainly intended to for use by
3487 * generic infrastructure built on top of regmap.
3488 */
regmap_get_reg_stride(struct regmap * map)3489 int regmap_get_reg_stride(struct regmap *map)
3490 {
3491 return map->reg_stride;
3492 }
3493 EXPORT_SYMBOL_GPL(regmap_get_reg_stride);
3494
3495 /**
3496 * regmap_might_sleep() - Returns whether a regmap access might sleep.
3497 *
3498 * @map: Register map to operate on.
3499 *
3500 * Returns true if an access to the register might sleep, else false.
3501 */
regmap_might_sleep(struct regmap * map)3502 bool regmap_might_sleep(struct regmap *map)
3503 {
3504 return map->can_sleep;
3505 }
3506 EXPORT_SYMBOL_GPL(regmap_might_sleep);
3507
regmap_parse_val(struct regmap * map,const void * buf,unsigned int * val)3508 int regmap_parse_val(struct regmap *map, const void *buf,
3509 unsigned int *val)
3510 {
3511 if (!map->format.parse_val)
3512 return -EINVAL;
3513
3514 *val = map->format.parse_val(buf);
3515
3516 return 0;
3517 }
3518 EXPORT_SYMBOL_GPL(regmap_parse_val);
3519
regmap_initcall(void)3520 static int __init regmap_initcall(void)
3521 {
3522 regmap_debugfs_initcall();
3523
3524 return 0;
3525 }
3526 postcore_initcall(regmap_initcall);
3527