drm/nouveau: fence: fix undefined fence state after emit
[platform/kernel/linux-rpi.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         map->async = true;
372
373         /* Apply any patch first */
374         map->cache_bypass = true;
375         for (i = 0; i < map->patch_regs; i++) {
376                 ret = _regmap_write(map, map->patch[i].reg, map->patch[i].def);
377                 if (ret != 0) {
378                         dev_err(map->dev, "Failed to write %x = %x: %d\n",
379                                 map->patch[i].reg, map->patch[i].def, ret);
380                         goto out;
381                 }
382         }
383         map->cache_bypass = false;
384
385         if (map->cache_ops->sync)
386                 ret = map->cache_ops->sync(map, 0, map->max_register);
387         else
388                 ret = regcache_default_sync(map, 0, map->max_register);
389
390         if (ret == 0)
391                 map->cache_dirty = false;
392
393 out:
394         /* Restore the bypass state */
395         map->async = false;
396         map->cache_bypass = bypass;
397         map->no_sync_defaults = false;
398         map->unlock(map->lock_arg);
399
400         regmap_async_complete(map);
401
402         trace_regcache_sync(map, name, "stop");
403
404         return ret;
405 }
406 EXPORT_SYMBOL_GPL(regcache_sync);
407
408 /**
409  * regcache_sync_region - Sync part  of the register cache with the hardware.
410  *
411  * @map: map to sync.
412  * @min: first register to sync
413  * @max: last register to sync
414  *
415  * Write all non-default register values in the specified region to
416  * the hardware.
417  *
418  * Return a negative value on failure, 0 on success.
419  */
420 int regcache_sync_region(struct regmap *map, unsigned int min,
421                          unsigned int max)
422 {
423         int ret = 0;
424         const char *name;
425         bool bypass;
426
427         if (WARN_ON(map->cache_type == REGCACHE_NONE))
428                 return -EINVAL;
429
430         BUG_ON(!map->cache_ops);
431
432         map->lock(map->lock_arg);
433
434         /* Remember the initial bypass state */
435         bypass = map->cache_bypass;
436
437         name = map->cache_ops->name;
438         dev_dbg(map->dev, "Syncing %s cache from %d-%d\n", name, min, max);
439
440         trace_regcache_sync(map, name, "start region");
441
442         if (!map->cache_dirty)
443                 goto out;
444
445         map->async = true;
446
447         if (map->cache_ops->sync)
448                 ret = map->cache_ops->sync(map, min, max);
449         else
450                 ret = regcache_default_sync(map, min, max);
451
452 out:
453         /* Restore the bypass state */
454         map->cache_bypass = bypass;
455         map->async = false;
456         map->no_sync_defaults = false;
457         map->unlock(map->lock_arg);
458
459         regmap_async_complete(map);
460
461         trace_regcache_sync(map, name, "stop region");
462
463         return ret;
464 }
465 EXPORT_SYMBOL_GPL(regcache_sync_region);
466
467 /**
468  * regcache_drop_region - Discard part of the register cache
469  *
470  * @map: map to operate on
471  * @min: first register to discard
472  * @max: last register to discard
473  *
474  * Discard part of the register cache.
475  *
476  * Return a negative value on failure, 0 on success.
477  */
478 int regcache_drop_region(struct regmap *map, unsigned int min,
479                          unsigned int max)
480 {
481         int ret = 0;
482
483         if (!map->cache_ops || !map->cache_ops->drop)
484                 return -EINVAL;
485
486         map->lock(map->lock_arg);
487
488         trace_regcache_drop_region(map, min, max);
489
490         ret = map->cache_ops->drop(map, min, max);
491
492         map->unlock(map->lock_arg);
493
494         return ret;
495 }
496 EXPORT_SYMBOL_GPL(regcache_drop_region);
497
498 /**
499  * regcache_cache_only - Put a register map into cache only mode
500  *
501  * @map: map to configure
502  * @enable: flag if changes should be written to the hardware
503  *
504  * When a register map is marked as cache only writes to the register
505  * map API will only update the register cache, they will not cause
506  * any hardware changes.  This is useful for allowing portions of
507  * drivers to act as though the device were functioning as normal when
508  * it is disabled for power saving reasons.
509  */
510 void regcache_cache_only(struct regmap *map, bool enable)
511 {
512         map->lock(map->lock_arg);
513         WARN_ON(map->cache_type != REGCACHE_NONE &&
514                 map->cache_bypass && enable);
515         map->cache_only = enable;
516         trace_regmap_cache_only(map, enable);
517         map->unlock(map->lock_arg);
518 }
519 EXPORT_SYMBOL_GPL(regcache_cache_only);
520
521 /**
522  * regcache_mark_dirty - Indicate that HW registers were reset to default values
523  *
524  * @map: map to mark
525  *
526  * Inform regcache that the device has been powered down or reset, so that
527  * on resume, regcache_sync() knows to write out all non-default values
528  * stored in the cache.
529  *
530  * If this function is not called, regcache_sync() will assume that
531  * the hardware state still matches the cache state, modulo any writes that
532  * happened when cache_only was true.
533  */
534 void regcache_mark_dirty(struct regmap *map)
535 {
536         map->lock(map->lock_arg);
537         map->cache_dirty = true;
538         map->no_sync_defaults = true;
539         map->unlock(map->lock_arg);
540 }
541 EXPORT_SYMBOL_GPL(regcache_mark_dirty);
542
543 /**
544  * regcache_cache_bypass - Put a register map into cache bypass mode
545  *
546  * @map: map to configure
547  * @enable: flag if changes should not be written to the cache
548  *
549  * When a register map is marked with the cache bypass option, writes
550  * to the register map API will only update the hardware and not
551  * the cache directly.  This is useful when syncing the cache back to
552  * the hardware.
553  */
554 void regcache_cache_bypass(struct regmap *map, bool enable)
555 {
556         map->lock(map->lock_arg);
557         WARN_ON(map->cache_only && enable);
558         map->cache_bypass = enable;
559         trace_regmap_cache_bypass(map, enable);
560         map->unlock(map->lock_arg);
561 }
562 EXPORT_SYMBOL_GPL(regcache_cache_bypass);
563
564 void regcache_set_val(struct regmap *map, void *base, unsigned int idx,
565                       unsigned int val)
566 {
567         /* Use device native format if possible */
568         if (map->format.format_val) {
569                 map->format.format_val(base + (map->cache_word_size * idx),
570                                        val, 0);
571                 return;
572         }
573
574         switch (map->cache_word_size) {
575         case 1: {
576                 u8 *cache = base;
577
578                 cache[idx] = val;
579                 break;
580         }
581         case 2: {
582                 u16 *cache = base;
583
584                 cache[idx] = val;
585                 break;
586         }
587         case 4: {
588                 u32 *cache = base;
589
590                 cache[idx] = val;
591                 break;
592         }
593 #ifdef CONFIG_64BIT
594         case 8: {
595                 u64 *cache = base;
596
597                 cache[idx] = val;
598                 break;
599         }
600 #endif
601         default:
602                 BUG();
603         }
604 }
605
606 unsigned int regcache_get_val(struct regmap *map, const void *base,
607                               unsigned int idx)
608 {
609         if (!base)
610                 return -EINVAL;
611
612         /* Use device native format if possible */
613         if (map->format.parse_val)
614                 return map->format.parse_val(regcache_get_val_addr(map, base,
615                                                                    idx));
616
617         switch (map->cache_word_size) {
618         case 1: {
619                 const u8 *cache = base;
620
621                 return cache[idx];
622         }
623         case 2: {
624                 const u16 *cache = base;
625
626                 return cache[idx];
627         }
628         case 4: {
629                 const u32 *cache = base;
630
631                 return cache[idx];
632         }
633 #ifdef CONFIG_64BIT
634         case 8: {
635                 const u64 *cache = base;
636
637                 return cache[idx];
638         }
639 #endif
640         default:
641                 BUG();
642         }
643         /* unreachable */
644         return -1;
645 }
646
647 static int regcache_default_cmp(const void *a, const void *b)
648 {
649         const struct reg_default *_a = a;
650         const struct reg_default *_b = b;
651
652         return _a->reg - _b->reg;
653 }
654
655 int regcache_lookup_reg(struct regmap *map, unsigned int reg)
656 {
657         struct reg_default key;
658         struct reg_default *r;
659
660         key.reg = reg;
661         key.def = 0;
662
663         r = bsearch(&key, map->reg_defaults, map->num_reg_defaults,
664                     sizeof(struct reg_default), regcache_default_cmp);
665
666         if (r)
667                 return r - map->reg_defaults;
668         else
669                 return -ENOENT;
670 }
671
672 static bool regcache_reg_present(unsigned long *cache_present, unsigned int idx)
673 {
674         if (!cache_present)
675                 return true;
676
677         return test_bit(idx, cache_present);
678 }
679
680 int regcache_sync_val(struct regmap *map, unsigned int reg, unsigned int val)
681 {
682         int ret;
683
684         if (!regcache_reg_needs_sync(map, reg, val))
685                 return 0;
686
687         map->cache_bypass = true;
688
689         ret = _regmap_write(map, reg, val);
690
691         map->cache_bypass = false;
692
693         if (ret != 0) {
694                 dev_err(map->dev, "Unable to sync register %#x. %d\n",
695                         reg, ret);
696                 return ret;
697         }
698         dev_dbg(map->dev, "Synced register %#x, value %#x\n",
699                 reg, val);
700
701         return 0;
702 }
703
704 static int regcache_sync_block_single(struct regmap *map, void *block,
705                                       unsigned long *cache_present,
706                                       unsigned int block_base,
707                                       unsigned int start, unsigned int end)
708 {
709         unsigned int i, regtmp, val;
710         int ret;
711
712         for (i = start; i < end; i++) {
713                 regtmp = block_base + (i * map->reg_stride);
714
715                 if (!regcache_reg_present(cache_present, i) ||
716                     !regmap_writeable(map, regtmp))
717                         continue;
718
719                 val = regcache_get_val(map, block, i);
720                 ret = regcache_sync_val(map, regtmp, val);
721                 if (ret != 0)
722                         return ret;
723         }
724
725         return 0;
726 }
727
728 static int regcache_sync_block_raw_flush(struct regmap *map, const void **data,
729                                          unsigned int base, unsigned int cur)
730 {
731         size_t val_bytes = map->format.val_bytes;
732         int ret, count;
733
734         if (*data == NULL)
735                 return 0;
736
737         count = (cur - base) / map->reg_stride;
738
739         dev_dbg(map->dev, "Writing %zu bytes for %d registers from 0x%x-0x%x\n",
740                 count * val_bytes, count, base, cur - map->reg_stride);
741
742         map->cache_bypass = true;
743
744         ret = _regmap_raw_write(map, base, *data, count * val_bytes, false);
745         if (ret)
746                 dev_err(map->dev, "Unable to sync registers %#x-%#x. %d\n",
747                         base, cur - map->reg_stride, ret);
748
749         map->cache_bypass = false;
750
751         *data = NULL;
752
753         return ret;
754 }
755
756 static int regcache_sync_block_raw(struct regmap *map, void *block,
757                             unsigned long *cache_present,
758                             unsigned int block_base, unsigned int start,
759                             unsigned int end)
760 {
761         unsigned int i, val;
762         unsigned int regtmp = 0;
763         unsigned int base = 0;
764         const void *data = NULL;
765         int ret;
766
767         for (i = start; i < end; i++) {
768                 regtmp = block_base + (i * map->reg_stride);
769
770                 if (!regcache_reg_present(cache_present, i) ||
771                     !regmap_writeable(map, regtmp)) {
772                         ret = regcache_sync_block_raw_flush(map, &data,
773                                                             base, regtmp);
774                         if (ret != 0)
775                                 return ret;
776                         continue;
777                 }
778
779                 val = regcache_get_val(map, block, i);
780                 if (!regcache_reg_needs_sync(map, regtmp, val)) {
781                         ret = regcache_sync_block_raw_flush(map, &data,
782                                                             base, regtmp);
783                         if (ret != 0)
784                                 return ret;
785                         continue;
786                 }
787
788                 if (!data) {
789                         data = regcache_get_val_addr(map, block, i);
790                         base = regtmp;
791                 }
792         }
793
794         return regcache_sync_block_raw_flush(map, &data, base, regtmp +
795                         map->reg_stride);
796 }
797
798 int regcache_sync_block(struct regmap *map, void *block,
799                         unsigned long *cache_present,
800                         unsigned int block_base, unsigned int start,
801                         unsigned int end)
802 {
803         if (regmap_can_raw_write(map) && !map->use_single_write)
804                 return regcache_sync_block_raw(map, block, cache_present,
805                                                block_base, start, end);
806         else
807                 return regcache_sync_block_single(map, block, cache_present,
808                                                   block_base, start, end);
809 }