Merge tag 'dma-mapping-6.6-2023-08-29' of git://git.infradead.org/users/hch/dma-mapping
[linux-2.6-microblaze.git] / drivers / base / regmap / regcache.c
1 // SPDX-License-Identifier: GPL-2.0
2 //
3 // Register cache access API
4 //
5 // Copyright 2011 Wolfson Microelectronics plc
6 //
7 // Author: Dimitris Papastamos <dp@opensource.wolfsonmicro.com>
8
9 #include <linux/bsearch.h>
10 #include <linux/device.h>
11 #include <linux/export.h>
12 #include <linux/slab.h>
13 #include <linux/sort.h>
14
15 #include "trace.h"
16 #include "internal.h"
17
18 static const struct regcache_ops *cache_types[] = {
19         &regcache_rbtree_ops,
20         &regcache_maple_ops,
21         &regcache_flat_ops,
22 };
23
24 static int regcache_hw_init(struct regmap *map)
25 {
26         int i, j;
27         int ret;
28         int count;
29         unsigned int reg, val;
30         void *tmp_buf;
31
32         if (!map->num_reg_defaults_raw)
33                 return -EINVAL;
34
35         /* calculate the size of reg_defaults */
36         for (count = 0, i = 0; i < map->num_reg_defaults_raw; i++)
37                 if (regmap_readable(map, i * map->reg_stride) &&
38                     !regmap_volatile(map, i * map->reg_stride))
39                         count++;
40
41         /* all registers are unreadable or volatile, so just bypass */
42         if (!count) {
43                 map->cache_bypass = true;
44                 return 0;
45         }
46
47         map->num_reg_defaults = count;
48         map->reg_defaults = kmalloc_array(count, sizeof(struct reg_default),
49                                           GFP_KERNEL);
50         if (!map->reg_defaults)
51                 return -ENOMEM;
52
53         if (!map->reg_defaults_raw) {
54                 bool cache_bypass = map->cache_bypass;
55                 dev_warn(map->dev, "No cache defaults, reading back from HW\n");
56
57                 /* Bypass the cache access till data read from HW */
58                 map->cache_bypass = true;
59                 tmp_buf = kmalloc(map->cache_size_raw, GFP_KERNEL);
60                 if (!tmp_buf) {
61                         ret = -ENOMEM;
62                         goto err_free;
63                 }
64                 ret = regmap_raw_read(map, 0, tmp_buf,
65                                       map->cache_size_raw);
66                 map->cache_bypass = cache_bypass;
67                 if (ret == 0) {
68                         map->reg_defaults_raw = tmp_buf;
69                         map->cache_free = true;
70                 } else {
71                         kfree(tmp_buf);
72                 }
73         }
74
75         /* fill the reg_defaults */
76         for (i = 0, j = 0; i < map->num_reg_defaults_raw; i++) {
77                 reg = i * map->reg_stride;
78
79                 if (!regmap_readable(map, reg))
80                         continue;
81
82                 if (regmap_volatile(map, reg))
83                         continue;
84
85                 if (map->reg_defaults_raw) {
86                         val = regcache_get_val(map, map->reg_defaults_raw, i);
87                 } else {
88                         bool cache_bypass = map->cache_bypass;
89
90                         map->cache_bypass = true;
91                         ret = regmap_read(map, reg, &val);
92                         map->cache_bypass = cache_bypass;
93                         if (ret != 0) {
94                                 dev_err(map->dev, "Failed to read %d: %d\n",
95                                         reg, ret);
96                                 goto err_free;
97                         }
98                 }
99
100                 map->reg_defaults[j].reg = reg;
101                 map->reg_defaults[j].def = val;
102                 j++;
103         }
104
105         return 0;
106
107 err_free:
108         kfree(map->reg_defaults);
109
110         return ret;
111 }
112
113 int regcache_init(struct regmap *map, const struct regmap_config *config)
114 {
115         int ret;
116         int i;
117         void *tmp_buf;
118
119         if (map->cache_type == REGCACHE_NONE) {
120                 if (config->reg_defaults || config->num_reg_defaults_raw)
121                         dev_warn(map->dev,
122                                  "No cache used with register defaults set!\n");
123
124                 map->cache_bypass = true;
125                 return 0;
126         }
127
128         if (config->reg_defaults && !config->num_reg_defaults) {
129                 dev_err(map->dev,
130                          "Register defaults are set without the number!\n");
131                 return -EINVAL;
132         }
133
134         if (config->num_reg_defaults && !config->reg_defaults) {
135                 dev_err(map->dev,
136                         "Register defaults number are set without the reg!\n");
137                 return -EINVAL;
138         }
139
140         for (i = 0; i < config->num_reg_defaults; i++)
141                 if (config->reg_defaults[i].reg % map->reg_stride)
142                         return -EINVAL;
143
144         for (i = 0; i < ARRAY_SIZE(cache_types); i++)
145                 if (cache_types[i]->type == map->cache_type)
146                         break;
147
148         if (i == ARRAY_SIZE(cache_types)) {
149                 dev_err(map->dev, "Could not match cache type: %d\n",
150                         map->cache_type);
151                 return -EINVAL;
152         }
153
154         map->num_reg_defaults = config->num_reg_defaults;
155         map->num_reg_defaults_raw = config->num_reg_defaults_raw;
156         map->reg_defaults_raw = config->reg_defaults_raw;
157         map->cache_word_size = DIV_ROUND_UP(config->val_bits, 8);
158         map->cache_size_raw = map->cache_word_size * config->num_reg_defaults_raw;
159
160         map->cache = NULL;
161         map->cache_ops = cache_types[i];
162
163         if (!map->cache_ops->read ||
164             !map->cache_ops->write ||
165             !map->cache_ops->name)
166                 return -EINVAL;
167
168         /* We still need to ensure that the reg_defaults
169          * won't vanish from under us.  We'll need to make
170          * a copy of it.
171          */
172         if (config->reg_defaults) {
173                 tmp_buf = kmemdup(config->reg_defaults, map->num_reg_defaults *
174                                   sizeof(struct reg_default), GFP_KERNEL);
175                 if (!tmp_buf)
176                         return -ENOMEM;
177                 map->reg_defaults = tmp_buf;
178         } else if (map->num_reg_defaults_raw) {
179                 /* Some devices such as PMICs don't have cache defaults,
180                  * we cope with this by reading back the HW registers and
181                  * crafting the cache defaults by hand.
182                  */
183                 ret = regcache_hw_init(map);
184                 if (ret < 0)
185                         return ret;
186                 if (map->cache_bypass)
187                         return 0;
188         }
189
190         if (!map->max_register && map->num_reg_defaults_raw)
191                 map->max_register = (map->num_reg_defaults_raw  - 1) * map->reg_stride;
192
193         if (map->cache_ops->init) {
194                 dev_dbg(map->dev, "Initializing %s cache\n",
195                         map->cache_ops->name);
196                 ret = map->cache_ops->init(map);
197                 if (ret)
198                         goto err_free;
199         }
200         return 0;
201
202 err_free:
203         kfree(map->reg_defaults);
204         if (map->cache_free)
205                 kfree(map->reg_defaults_raw);
206
207         return ret;
208 }
209
210 void regcache_exit(struct regmap *map)
211 {
212         if (map->cache_type == REGCACHE_NONE)
213                 return;
214
215         BUG_ON(!map->cache_ops);
216
217         kfree(map->reg_defaults);
218         if (map->cache_free)
219                 kfree(map->reg_defaults_raw);
220
221         if (map->cache_ops->exit) {
222                 dev_dbg(map->dev, "Destroying %s cache\n",
223                         map->cache_ops->name);
224                 map->cache_ops->exit(map);
225         }
226 }
227
228 /**
229  * regcache_read - Fetch the value of a given register from the cache.
230  *
231  * @map: map to configure.
232  * @reg: The register index.
233  * @value: The value to be returned.
234  *
235  * Return a negative value on failure, 0 on success.
236  */
237 int regcache_read(struct regmap *map,
238                   unsigned int reg, unsigned int *value)
239 {
240         int ret;
241
242         if (map->cache_type == REGCACHE_NONE)
243                 return -EINVAL;
244
245         BUG_ON(!map->cache_ops);
246
247         if (!regmap_volatile(map, reg)) {
248                 ret = map->cache_ops->read(map, reg, value);
249
250                 if (ret == 0)
251                         trace_regmap_reg_read_cache(map, reg, *value);
252
253                 return ret;
254         }
255
256         return -EINVAL;
257 }
258
259 /**
260  * regcache_write - Set the value of a given register in the cache.
261  *
262  * @map: map to configure.
263  * @reg: The register index.
264  * @value: The new register value.
265  *
266  * Return a negative value on failure, 0 on success.
267  */
268 int regcache_write(struct regmap *map,
269                    unsigned int reg, unsigned int value)
270 {
271         if (map->cache_type == REGCACHE_NONE)
272                 return 0;
273
274         BUG_ON(!map->cache_ops);
275
276         if (!regmap_volatile(map, reg))
277                 return map->cache_ops->write(map, reg, value);
278
279         return 0;
280 }
281
282 bool regcache_reg_needs_sync(struct regmap *map, unsigned int reg,
283                              unsigned int val)
284 {
285         int ret;
286
287         if (!regmap_writeable(map, reg))
288                 return false;
289
290         /* If we don't know the chip just got reset, then sync everything. */
291         if (!map->no_sync_defaults)
292                 return true;
293
294         /* Is this the hardware default?  If so skip. */
295         ret = regcache_lookup_reg(map, reg);
296         if (ret >= 0 && val == map->reg_defaults[ret].def)
297                 return false;
298         return true;
299 }
300
301 static int regcache_default_sync(struct regmap *map, unsigned int min,
302                                  unsigned int max)
303 {
304         unsigned int reg;
305
306         for (reg = min; reg <= max; reg += map->reg_stride) {
307                 unsigned int val;
308                 int ret;
309
310                 if (regmap_volatile(map, reg) ||
311                     !regmap_writeable(map, reg))
312                         continue;
313
314                 ret = regcache_read(map, reg, &val);
315                 if (ret == -ENOENT)
316                         continue;
317                 if (ret)
318                         return ret;
319
320                 if (!regcache_reg_needs_sync(map, reg, val))
321                         continue;
322
323                 map->cache_bypass = true;
324                 ret = _regmap_write(map, reg, val);
325                 map->cache_bypass = false;
326                 if (ret) {
327                         dev_err(map->dev, "Unable to sync register %#x. %d\n",
328                                 reg, ret);
329                         return ret;
330                 }
331                 dev_dbg(map->dev, "Synced register %#x, value %#x\n", reg, val);
332         }
333
334         return 0;
335 }
336
337 /**
338  * regcache_sync - Sync the register cache with the hardware.
339  *
340  * @map: map to configure.
341  *
342  * Any registers that should not be synced should be marked as
343  * volatile.  In general drivers can choose not to use the provided
344  * syncing functionality if they so require.
345  *
346  * Return a negative value on failure, 0 on success.
347  */
348 int regcache_sync(struct regmap *map)
349 {
350         int ret = 0;
351         unsigned int i;
352         const char *name;
353         bool bypass;
354
355         if (WARN_ON(map->cache_type == REGCACHE_NONE))
356                 return -EINVAL;
357
358         BUG_ON(!map->cache_ops);
359
360         map->lock(map->lock_arg);
361         /* Remember the initial bypass state */
362         bypass = map->cache_bypass;
363         dev_dbg(map->dev, "Syncing %s cache\n",
364                 map->cache_ops->name);
365         name = map->cache_ops->name;
366         trace_regcache_sync(map, name, "start");
367
368         if (!map->cache_dirty)
369                 goto out;
370
371         /* Apply any patch first */
372         map->cache_bypass = true;
373         for (i = 0; i < map->patch_regs; i++) {
374                 ret = _regmap_write(map, map->patch[i].reg, map->patch[i].def);
375                 if (ret != 0) {
376                         dev_err(map->dev, "Failed to write %x = %x: %d\n",
377                                 map->patch[i].reg, map->patch[i].def, ret);
378                         goto out;
379                 }
380         }
381         map->cache_bypass = false;
382
383         if (map->cache_ops->sync)
384                 ret = map->cache_ops->sync(map, 0, map->max_register);
385         else
386                 ret = regcache_default_sync(map, 0, map->max_register);
387
388         if (ret == 0)
389                 map->cache_dirty = false;
390
391 out:
392         /* Restore the bypass state */
393         map->cache_bypass = bypass;
394         map->no_sync_defaults = false;
395         map->unlock(map->lock_arg);
396
397         regmap_async_complete(map);
398
399         trace_regcache_sync(map, name, "stop");
400
401         return ret;
402 }
403 EXPORT_SYMBOL_GPL(regcache_sync);
404
405 /**
406  * regcache_sync_region - Sync part  of the register cache with the hardware.
407  *
408  * @map: map to sync.
409  * @min: first register to sync
410  * @max: last register to sync
411  *
412  * Write all non-default register values in the specified region to
413  * the hardware.
414  *
415  * Return a negative value on failure, 0 on success.
416  */
417 int regcache_sync_region(struct regmap *map, unsigned int min,
418                          unsigned int max)
419 {
420         int ret = 0;
421         const char *name;
422         bool bypass;
423
424         if (WARN_ON(map->cache_type == REGCACHE_NONE))
425                 return -EINVAL;
426
427         BUG_ON(!map->cache_ops);
428
429         map->lock(map->lock_arg);
430
431         /* Remember the initial bypass state */
432         bypass = map->cache_bypass;
433
434         name = map->cache_ops->name;
435         dev_dbg(map->dev, "Syncing %s cache from %d-%d\n", name, min, max);
436
437         trace_regcache_sync(map, name, "start region");
438
439         if (!map->cache_dirty)
440                 goto out;
441
442         map->async = true;
443
444         if (map->cache_ops->sync)
445                 ret = map->cache_ops->sync(map, min, max);
446         else
447                 ret = regcache_default_sync(map, min, max);
448
449 out:
450         /* Restore the bypass state */
451         map->cache_bypass = bypass;
452         map->async = false;
453         map->no_sync_defaults = false;
454         map->unlock(map->lock_arg);
455
456         regmap_async_complete(map);
457
458         trace_regcache_sync(map, name, "stop region");
459
460         return ret;
461 }
462 EXPORT_SYMBOL_GPL(regcache_sync_region);
463
464 /**
465  * regcache_drop_region - Discard part of the register cache
466  *
467  * @map: map to operate on
468  * @min: first register to discard
469  * @max: last register to discard
470  *
471  * Discard part of the register cache.
472  *
473  * Return a negative value on failure, 0 on success.
474  */
475 int regcache_drop_region(struct regmap *map, unsigned int min,
476                          unsigned int max)
477 {
478         int ret = 0;
479
480         if (!map->cache_ops || !map->cache_ops->drop)
481                 return -EINVAL;
482
483         map->lock(map->lock_arg);
484
485         trace_regcache_drop_region(map, min, max);
486
487         ret = map->cache_ops->drop(map, min, max);
488
489         map->unlock(map->lock_arg);
490
491         return ret;
492 }
493 EXPORT_SYMBOL_GPL(regcache_drop_region);
494
495 /**
496  * regcache_cache_only - Put a register map into cache only mode
497  *
498  * @map: map to configure
499  * @enable: flag if changes should be written to the hardware
500  *
501  * When a register map is marked as cache only writes to the register
502  * map API will only update the register cache, they will not cause
503  * any hardware changes.  This is useful for allowing portions of
504  * drivers to act as though the device were functioning as normal when
505  * it is disabled for power saving reasons.
506  */
507 void regcache_cache_only(struct regmap *map, bool enable)
508 {
509         map->lock(map->lock_arg);
510         WARN_ON(map->cache_type != REGCACHE_NONE &&
511                 map->cache_bypass && enable);
512         map->cache_only = enable;
513         trace_regmap_cache_only(map, enable);
514         map->unlock(map->lock_arg);
515 }
516 EXPORT_SYMBOL_GPL(regcache_cache_only);
517
518 /**
519  * regcache_mark_dirty - Indicate that HW registers were reset to default values
520  *
521  * @map: map to mark
522  *
523  * Inform regcache that the device has been powered down or reset, so that
524  * on resume, regcache_sync() knows to write out all non-default values
525  * stored in the cache.
526  *
527  * If this function is not called, regcache_sync() will assume that
528  * the hardware state still matches the cache state, modulo any writes that
529  * happened when cache_only was true.
530  */
531 void regcache_mark_dirty(struct regmap *map)
532 {
533         map->lock(map->lock_arg);
534         map->cache_dirty = true;
535         map->no_sync_defaults = true;
536         map->unlock(map->lock_arg);
537 }
538 EXPORT_SYMBOL_GPL(regcache_mark_dirty);
539
540 /**
541  * regcache_cache_bypass - Put a register map into cache bypass mode
542  *
543  * @map: map to configure
544  * @enable: flag if changes should not be written to the cache
545  *
546  * When a register map is marked with the cache bypass option, writes
547  * to the register map API will only update the hardware and not
548  * the cache directly.  This is useful when syncing the cache back to
549  * the hardware.
550  */
551 void regcache_cache_bypass(struct regmap *map, bool enable)
552 {
553         map->lock(map->lock_arg);
554         WARN_ON(map->cache_only && enable);
555         map->cache_bypass = enable;
556         trace_regmap_cache_bypass(map, enable);
557         map->unlock(map->lock_arg);
558 }
559 EXPORT_SYMBOL_GPL(regcache_cache_bypass);
560
561 /**
562  * regcache_reg_cached - Check if a register is cached
563  *
564  * @map: map to check
565  * @reg: register to check
566  *
567  * Reports if a register is cached.
568  */
569 bool regcache_reg_cached(struct regmap *map, unsigned int reg)
570 {
571         unsigned int val;
572         int ret;
573
574         map->lock(map->lock_arg);
575
576         ret = regcache_read(map, reg, &val);
577
578         map->unlock(map->lock_arg);
579
580         return ret == 0;
581 }
582 EXPORT_SYMBOL_GPL(regcache_reg_cached);
583
584 void regcache_set_val(struct regmap *map, void *base, unsigned int idx,
585                       unsigned int val)
586 {
587         /* Use device native format if possible */
588         if (map->format.format_val) {
589                 map->format.format_val(base + (map->cache_word_size * idx),
590                                        val, 0);
591                 return;
592         }
593
594         switch (map->cache_word_size) {
595         case 1: {
596                 u8 *cache = base;
597
598                 cache[idx] = val;
599                 break;
600         }
601         case 2: {
602                 u16 *cache = base;
603
604                 cache[idx] = val;
605                 break;
606         }
607         case 4: {
608                 u32 *cache = base;
609
610                 cache[idx] = val;
611                 break;
612         }
613         default:
614                 BUG();
615         }
616 }
617
618 unsigned int regcache_get_val(struct regmap *map, const void *base,
619                               unsigned int idx)
620 {
621         if (!base)
622                 return -EINVAL;
623
624         /* Use device native format if possible */
625         if (map->format.parse_val)
626                 return map->format.parse_val(regcache_get_val_addr(map, base,
627                                                                    idx));
628
629         switch (map->cache_word_size) {
630         case 1: {
631                 const u8 *cache = base;
632
633                 return cache[idx];
634         }
635         case 2: {
636                 const u16 *cache = base;
637
638                 return cache[idx];
639         }
640         case 4: {
641                 const u32 *cache = base;
642
643                 return cache[idx];
644         }
645         default:
646                 BUG();
647         }
648         /* unreachable */
649         return -1;
650 }
651
652 static int regcache_default_cmp(const void *a, const void *b)
653 {
654         const struct reg_default *_a = a;
655         const struct reg_default *_b = b;
656
657         return _a->reg - _b->reg;
658 }
659
660 int regcache_lookup_reg(struct regmap *map, unsigned int reg)
661 {
662         struct reg_default key;
663         struct reg_default *r;
664
665         key.reg = reg;
666         key.def = 0;
667
668         r = bsearch(&key, map->reg_defaults, map->num_reg_defaults,
669                     sizeof(struct reg_default), regcache_default_cmp);
670
671         if (r)
672                 return r - map->reg_defaults;
673         else
674                 return -ENOENT;
675 }
676
677 static bool regcache_reg_present(unsigned long *cache_present, unsigned int idx)
678 {
679         if (!cache_present)
680                 return true;
681
682         return test_bit(idx, cache_present);
683 }
684
685 int regcache_sync_val(struct regmap *map, unsigned int reg, unsigned int val)
686 {
687         int ret;
688
689         if (!regcache_reg_needs_sync(map, reg, val))
690                 return 0;
691
692         map->cache_bypass = true;
693
694         ret = _regmap_write(map, reg, val);
695
696         map->cache_bypass = false;
697
698         if (ret != 0) {
699                 dev_err(map->dev, "Unable to sync register %#x. %d\n",
700                         reg, ret);
701                 return ret;
702         }
703         dev_dbg(map->dev, "Synced register %#x, value %#x\n",
704                 reg, val);
705
706         return 0;
707 }
708
709 static int regcache_sync_block_single(struct regmap *map, void *block,
710                                       unsigned long *cache_present,
711                                       unsigned int block_base,
712                                       unsigned int start, unsigned int end)
713 {
714         unsigned int i, regtmp, val;
715         int ret;
716
717         for (i = start; i < end; i++) {
718                 regtmp = block_base + (i * map->reg_stride);
719
720                 if (!regcache_reg_present(cache_present, i) ||
721                     !regmap_writeable(map, regtmp))
722                         continue;
723
724                 val = regcache_get_val(map, block, i);
725                 ret = regcache_sync_val(map, regtmp, val);
726                 if (ret != 0)
727                         return ret;
728         }
729
730         return 0;
731 }
732
733 static int regcache_sync_block_raw_flush(struct regmap *map, const void **data,
734                                          unsigned int base, unsigned int cur)
735 {
736         size_t val_bytes = map->format.val_bytes;
737         int ret, count;
738
739         if (*data == NULL)
740                 return 0;
741
742         count = (cur - base) / map->reg_stride;
743
744         dev_dbg(map->dev, "Writing %zu bytes for %d registers from 0x%x-0x%x\n",
745                 count * val_bytes, count, base, cur - map->reg_stride);
746
747         map->cache_bypass = true;
748
749         ret = _regmap_raw_write(map, base, *data, count * val_bytes, false);
750         if (ret)
751                 dev_err(map->dev, "Unable to sync registers %#x-%#x. %d\n",
752                         base, cur - map->reg_stride, ret);
753
754         map->cache_bypass = false;
755
756         *data = NULL;
757
758         return ret;
759 }
760
761 static int regcache_sync_block_raw(struct regmap *map, void *block,
762                             unsigned long *cache_present,
763                             unsigned int block_base, unsigned int start,
764                             unsigned int end)
765 {
766         unsigned int i, val;
767         unsigned int regtmp = 0;
768         unsigned int base = 0;
769         const void *data = NULL;
770         int ret;
771
772         for (i = start; i < end; i++) {
773                 regtmp = block_base + (i * map->reg_stride);
774
775                 if (!regcache_reg_present(cache_present, i) ||
776                     !regmap_writeable(map, regtmp)) {
777                         ret = regcache_sync_block_raw_flush(map, &data,
778                                                             base, regtmp);
779                         if (ret != 0)
780                                 return ret;
781                         continue;
782                 }
783
784                 val = regcache_get_val(map, block, i);
785                 if (!regcache_reg_needs_sync(map, regtmp, val)) {
786                         ret = regcache_sync_block_raw_flush(map, &data,
787                                                             base, regtmp);
788                         if (ret != 0)
789                                 return ret;
790                         continue;
791                 }
792
793                 if (!data) {
794                         data = regcache_get_val_addr(map, block, i);
795                         base = regtmp;
796                 }
797         }
798
799         return regcache_sync_block_raw_flush(map, &data, base, regtmp +
800                         map->reg_stride);
801 }
802
803 int regcache_sync_block(struct regmap *map, void *block,
804                         unsigned long *cache_present,
805                         unsigned int block_base, unsigned int start,
806                         unsigned int end)
807 {
808         if (regmap_can_raw_write(map) && !map->use_single_write)
809                 return regcache_sync_block_raw(map, block, cache_present,
810                                                block_base, start, end);
811         else
812                 return regcache_sync_block_single(map, block, cache_present,
813                                                   block_base, start, end);
814 }