GNU Linux-libre 4.14.328-gnu1
[releases.git] / drivers / base / regmap / regcache.c
1 /*
2  * Register cache access API
3  *
4  * Copyright 2011 Wolfson Microelectronics plc
5  *
6  * Author: Dimitris Papastamos <dp@opensource.wolfsonmicro.com>
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 as
10  * published by the Free Software Foundation.
11  */
12
13 #include <linux/bsearch.h>
14 #include <linux/device.h>
15 #include <linux/export.h>
16 #include <linux/slab.h>
17 #include <linux/sort.h>
18
19 #include "trace.h"
20 #include "internal.h"
21
22 static const struct regcache_ops *cache_types[] = {
23         &regcache_rbtree_ops,
24 #if IS_ENABLED(CONFIG_REGCACHE_COMPRESSED)
25         &regcache_lzo_ops,
26 #endif
27         &regcache_flat_ops,
28 };
29
30 static int regcache_hw_init(struct regmap *map)
31 {
32         int i, j;
33         int ret;
34         int count;
35         unsigned int reg, val;
36         void *tmp_buf;
37
38         if (!map->num_reg_defaults_raw)
39                 return -EINVAL;
40
41         /* calculate the size of reg_defaults */
42         for (count = 0, i = 0; i < map->num_reg_defaults_raw; i++)
43                 if (regmap_readable(map, i * map->reg_stride) &&
44                     !regmap_volatile(map, i * map->reg_stride))
45                         count++;
46
47         /* all registers are unreadable or volatile, so just bypass */
48         if (!count) {
49                 map->cache_bypass = true;
50                 return 0;
51         }
52
53         map->num_reg_defaults = count;
54         map->reg_defaults = kmalloc_array(count, sizeof(struct reg_default),
55                                           GFP_KERNEL);
56         if (!map->reg_defaults)
57                 return -ENOMEM;
58
59         if (!map->reg_defaults_raw) {
60                 bool cache_bypass = map->cache_bypass;
61                 dev_warn(map->dev, "No cache defaults, reading back from HW\n");
62
63                 /* Bypass the cache access till data read from HW */
64                 map->cache_bypass = true;
65                 tmp_buf = kmalloc(map->cache_size_raw, GFP_KERNEL);
66                 if (!tmp_buf) {
67                         ret = -ENOMEM;
68                         goto err_free;
69                 }
70                 ret = regmap_raw_read(map, 0, tmp_buf,
71                                       map->cache_size_raw);
72                 map->cache_bypass = cache_bypass;
73                 if (ret == 0) {
74                         map->reg_defaults_raw = tmp_buf;
75                         map->cache_free = 1;
76                 } else {
77                         kfree(tmp_buf);
78                 }
79         }
80
81         /* fill the reg_defaults */
82         for (i = 0, j = 0; i < map->num_reg_defaults_raw; i++) {
83                 reg = i * map->reg_stride;
84
85                 if (!regmap_readable(map, reg))
86                         continue;
87
88                 if (regmap_volatile(map, reg))
89                         continue;
90
91                 if (map->reg_defaults_raw) {
92                         val = regcache_get_val(map, map->reg_defaults_raw, i);
93                 } else {
94                         bool cache_bypass = map->cache_bypass;
95
96                         map->cache_bypass = true;
97                         ret = regmap_read(map, reg, &val);
98                         map->cache_bypass = cache_bypass;
99                         if (ret != 0) {
100                                 dev_err(map->dev, "Failed to read %d: %d\n",
101                                         reg, ret);
102                                 goto err_free;
103                         }
104                 }
105
106                 map->reg_defaults[j].reg = reg;
107                 map->reg_defaults[j].def = val;
108                 j++;
109         }
110
111         return 0;
112
113 err_free:
114         kfree(map->reg_defaults);
115
116         return ret;
117 }
118
119 int regcache_init(struct regmap *map, const struct regmap_config *config)
120 {
121         int ret;
122         int i;
123         void *tmp_buf;
124
125         if (map->cache_type == REGCACHE_NONE) {
126                 if (config->reg_defaults || config->num_reg_defaults_raw)
127                         dev_warn(map->dev,
128                                  "No cache used with register defaults set!\n");
129
130                 map->cache_bypass = true;
131                 return 0;
132         }
133
134         if (config->reg_defaults && !config->num_reg_defaults) {
135                 dev_err(map->dev,
136                          "Register defaults are set without the number!\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 compress 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)
191                 map->max_register = map->num_reg_defaults_raw;
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 -ENOSYS;
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 static bool regcache_reg_needs_sync(struct regmap *map, unsigned int reg,
283                                     unsigned int val)
284 {
285         int ret;
286
287         /* If we don't know the chip just got reset, then sync everything. */
288         if (!map->no_sync_defaults)
289                 return true;
290
291         /* Is this the hardware default?  If so skip. */
292         ret = regcache_lookup_reg(map, reg);
293         if (ret >= 0 && val == map->reg_defaults[ret].def)
294                 return false;
295         return true;
296 }
297
298 static int regcache_default_sync(struct regmap *map, unsigned int min,
299                                  unsigned int max)
300 {
301         unsigned int reg;
302
303         for (reg = min; reg <= max; reg += map->reg_stride) {
304                 unsigned int val;
305                 int ret;
306
307                 if (regmap_volatile(map, reg) ||
308                     !regmap_writeable(map, reg))
309                         continue;
310
311                 ret = regcache_read(map, reg, &val);
312                 if (ret)
313                         return ret;
314
315                 if (!regcache_reg_needs_sync(map, reg, val))
316                         continue;
317
318                 map->cache_bypass = true;
319                 ret = _regmap_write(map, reg, val);
320                 map->cache_bypass = false;
321                 if (ret) {
322                         dev_err(map->dev, "Unable to sync register %#x. %d\n",
323                                 reg, ret);
324                         return ret;
325                 }
326                 dev_dbg(map->dev, "Synced register %#x, value %#x\n", reg, val);
327         }
328
329         return 0;
330 }
331
332 /**
333  * regcache_sync - Sync the register cache with the hardware.
334  *
335  * @map: map to configure.
336  *
337  * Any registers that should not be synced should be marked as
338  * volatile.  In general drivers can choose not to use the provided
339  * syncing functionality if they so require.
340  *
341  * Return a negative value on failure, 0 on success.
342  */
343 int regcache_sync(struct regmap *map)
344 {
345         int ret = 0;
346         unsigned int i;
347         const char *name;
348         bool bypass;
349
350         if (WARN_ON(map->cache_type == REGCACHE_NONE))
351                 return -EINVAL;
352
353         BUG_ON(!map->cache_ops);
354
355         map->lock(map->lock_arg);
356         /* Remember the initial bypass state */
357         bypass = map->cache_bypass;
358         dev_dbg(map->dev, "Syncing %s cache\n",
359                 map->cache_ops->name);
360         name = map->cache_ops->name;
361         trace_regcache_sync(map, name, "start");
362
363         if (!map->cache_dirty)
364                 goto out;
365
366         map->async = true;
367
368         /* Apply any patch first */
369         map->cache_bypass = true;
370         for (i = 0; i < map->patch_regs; i++) {
371                 ret = _regmap_write(map, map->patch[i].reg, map->patch[i].def);
372                 if (ret != 0) {
373                         dev_err(map->dev, "Failed to write %x = %x: %d\n",
374                                 map->patch[i].reg, map->patch[i].def, ret);
375                         goto out;
376                 }
377         }
378         map->cache_bypass = false;
379
380         if (map->cache_ops->sync)
381                 ret = map->cache_ops->sync(map, 0, map->max_register);
382         else
383                 ret = regcache_default_sync(map, 0, map->max_register);
384
385         if (ret == 0)
386                 map->cache_dirty = false;
387
388 out:
389         /* Restore the bypass state */
390         map->async = false;
391         map->cache_bypass = bypass;
392         map->no_sync_defaults = false;
393         map->unlock(map->lock_arg);
394
395         regmap_async_complete(map);
396
397         trace_regcache_sync(map, name, "stop");
398
399         return ret;
400 }
401 EXPORT_SYMBOL_GPL(regcache_sync);
402
403 /**
404  * regcache_sync_region - Sync part  of the register cache with the hardware.
405  *
406  * @map: map to sync.
407  * @min: first register to sync
408  * @max: last register to sync
409  *
410  * Write all non-default register values in the specified region to
411  * the hardware.
412  *
413  * Return a negative value on failure, 0 on success.
414  */
415 int regcache_sync_region(struct regmap *map, unsigned int min,
416                          unsigned int max)
417 {
418         int ret = 0;
419         const char *name;
420         bool bypass;
421
422         if (WARN_ON(map->cache_type == REGCACHE_NONE))
423                 return -EINVAL;
424
425         BUG_ON(!map->cache_ops);
426
427         map->lock(map->lock_arg);
428
429         /* Remember the initial bypass state */
430         bypass = map->cache_bypass;
431
432         name = map->cache_ops->name;
433         dev_dbg(map->dev, "Syncing %s cache from %d-%d\n", name, min, max);
434
435         trace_regcache_sync(map, name, "start region");
436
437         if (!map->cache_dirty)
438                 goto out;
439
440         map->async = true;
441
442         if (map->cache_ops->sync)
443                 ret = map->cache_ops->sync(map, min, max);
444         else
445                 ret = regcache_default_sync(map, min, max);
446
447 out:
448         /* Restore the bypass state */
449         map->cache_bypass = bypass;
450         map->async = false;
451         map->no_sync_defaults = false;
452         map->unlock(map->lock_arg);
453
454         regmap_async_complete(map);
455
456         trace_regcache_sync(map, name, "stop region");
457
458         return ret;
459 }
460 EXPORT_SYMBOL_GPL(regcache_sync_region);
461
462 /**
463  * regcache_drop_region - Discard part of the register cache
464  *
465  * @map: map to operate on
466  * @min: first register to discard
467  * @max: last register to discard
468  *
469  * Discard part of the register cache.
470  *
471  * Return a negative value on failure, 0 on success.
472  */
473 int regcache_drop_region(struct regmap *map, unsigned int min,
474                          unsigned int max)
475 {
476         int ret = 0;
477
478         if (!map->cache_ops || !map->cache_ops->drop)
479                 return -EINVAL;
480
481         map->lock(map->lock_arg);
482
483         trace_regcache_drop_region(map, min, max);
484
485         ret = map->cache_ops->drop(map, min, max);
486
487         map->unlock(map->lock_arg);
488
489         return ret;
490 }
491 EXPORT_SYMBOL_GPL(regcache_drop_region);
492
493 /**
494  * regcache_cache_only - Put a register map into cache only mode
495  *
496  * @map: map to configure
497  * @enable: flag if changes should be written to the hardware
498  *
499  * When a register map is marked as cache only writes to the register
500  * map API will only update the register cache, they will not cause
501  * any hardware changes.  This is useful for allowing portions of
502  * drivers to act as though the device were functioning as normal when
503  * it is disabled for power saving reasons.
504  */
505 void regcache_cache_only(struct regmap *map, bool enable)
506 {
507         map->lock(map->lock_arg);
508         WARN_ON(map->cache_bypass && enable);
509         map->cache_only = enable;
510         trace_regmap_cache_only(map, enable);
511         map->unlock(map->lock_arg);
512 }
513 EXPORT_SYMBOL_GPL(regcache_cache_only);
514
515 /**
516  * regcache_mark_dirty - Indicate that HW registers were reset to default values
517  *
518  * @map: map to mark
519  *
520  * Inform regcache that the device has been powered down or reset, so that
521  * on resume, regcache_sync() knows to write out all non-default values
522  * stored in the cache.
523  *
524  * If this function is not called, regcache_sync() will assume that
525  * the hardware state still matches the cache state, modulo any writes that
526  * happened when cache_only was true.
527  */
528 void regcache_mark_dirty(struct regmap *map)
529 {
530         map->lock(map->lock_arg);
531         map->cache_dirty = true;
532         map->no_sync_defaults = true;
533         map->unlock(map->lock_arg);
534 }
535 EXPORT_SYMBOL_GPL(regcache_mark_dirty);
536
537 /**
538  * regcache_cache_bypass - Put a register map into cache bypass mode
539  *
540  * @map: map to configure
541  * @enable: flag if changes should not be written to the cache
542  *
543  * When a register map is marked with the cache bypass option, writes
544  * to the register map API will only update the hardware and not the
545  * the cache directly.  This is useful when syncing the cache back to
546  * the hardware.
547  */
548 void regcache_cache_bypass(struct regmap *map, bool enable)
549 {
550         map->lock(map->lock_arg);
551         WARN_ON(map->cache_only && enable);
552         map->cache_bypass = enable;
553         trace_regmap_cache_bypass(map, enable);
554         map->unlock(map->lock_arg);
555 }
556 EXPORT_SYMBOL_GPL(regcache_cache_bypass);
557
558 bool regcache_set_val(struct regmap *map, void *base, unsigned int idx,
559                       unsigned int val)
560 {
561         if (regcache_get_val(map, base, idx) == val)
562                 return true;
563
564         /* Use device native format if possible */
565         if (map->format.format_val) {
566                 map->format.format_val(base + (map->cache_word_size * idx),
567                                        val, 0);
568                 return false;
569         }
570
571         switch (map->cache_word_size) {
572         case 1: {
573                 u8 *cache = base;
574
575                 cache[idx] = val;
576                 break;
577         }
578         case 2: {
579                 u16 *cache = base;
580
581                 cache[idx] = val;
582                 break;
583         }
584         case 4: {
585                 u32 *cache = base;
586
587                 cache[idx] = val;
588                 break;
589         }
590 #ifdef CONFIG_64BIT
591         case 8: {
592                 u64 *cache = base;
593
594                 cache[idx] = val;
595                 break;
596         }
597 #endif
598         default:
599                 BUG();
600         }
601         return false;
602 }
603
604 unsigned int regcache_get_val(struct regmap *map, const void *base,
605                               unsigned int idx)
606 {
607         if (!base)
608                 return -EINVAL;
609
610         /* Use device native format if possible */
611         if (map->format.parse_val)
612                 return map->format.parse_val(regcache_get_val_addr(map, base,
613                                                                    idx));
614
615         switch (map->cache_word_size) {
616         case 1: {
617                 const u8 *cache = base;
618
619                 return cache[idx];
620         }
621         case 2: {
622                 const u16 *cache = base;
623
624                 return cache[idx];
625         }
626         case 4: {
627                 const u32 *cache = base;
628
629                 return cache[idx];
630         }
631 #ifdef CONFIG_64BIT
632         case 8: {
633                 const u64 *cache = base;
634
635                 return cache[idx];
636         }
637 #endif
638         default:
639                 BUG();
640         }
641         /* unreachable */
642         return -1;
643 }
644
645 static int regcache_default_cmp(const void *a, const void *b)
646 {
647         const struct reg_default *_a = a;
648         const struct reg_default *_b = b;
649
650         return _a->reg - _b->reg;
651 }
652
653 int regcache_lookup_reg(struct regmap *map, unsigned int reg)
654 {
655         struct reg_default key;
656         struct reg_default *r;
657
658         key.reg = reg;
659         key.def = 0;
660
661         r = bsearch(&key, map->reg_defaults, map->num_reg_defaults,
662                     sizeof(struct reg_default), regcache_default_cmp);
663
664         if (r)
665                 return r - map->reg_defaults;
666         else
667                 return -ENOENT;
668 }
669
670 static bool regcache_reg_present(unsigned long *cache_present, unsigned int idx)
671 {
672         if (!cache_present)
673                 return true;
674
675         return test_bit(idx, cache_present);
676 }
677
678 static int regcache_sync_block_single(struct regmap *map, void *block,
679                                       unsigned long *cache_present,
680                                       unsigned int block_base,
681                                       unsigned int start, unsigned int end)
682 {
683         unsigned int i, regtmp, val;
684         int ret;
685
686         for (i = start; i < end; i++) {
687                 regtmp = block_base + (i * map->reg_stride);
688
689                 if (!regcache_reg_present(cache_present, i) ||
690                     !regmap_writeable(map, regtmp))
691                         continue;
692
693                 val = regcache_get_val(map, block, i);
694                 if (!regcache_reg_needs_sync(map, regtmp, val))
695                         continue;
696
697                 map->cache_bypass = true;
698
699                 ret = _regmap_write(map, regtmp, val);
700
701                 map->cache_bypass = false;
702                 if (ret != 0) {
703                         dev_err(map->dev, "Unable to sync register %#x. %d\n",
704                                 regtmp, ret);
705                         return ret;
706                 }
707                 dev_dbg(map->dev, "Synced register %#x, value %#x\n",
708                         regtmp, val);
709         }
710
711         return 0;
712 }
713
714 static int regcache_sync_block_raw_flush(struct regmap *map, const void **data,
715                                          unsigned int base, unsigned int cur)
716 {
717         size_t val_bytes = map->format.val_bytes;
718         int ret, count;
719
720         if (*data == NULL)
721                 return 0;
722
723         count = (cur - base) / map->reg_stride;
724
725         dev_dbg(map->dev, "Writing %zu bytes for %d registers from 0x%x-0x%x\n",
726                 count * val_bytes, count, base, cur - map->reg_stride);
727
728         map->cache_bypass = true;
729
730         ret = _regmap_raw_write(map, base, *data, count * val_bytes);
731         if (ret)
732                 dev_err(map->dev, "Unable to sync registers %#x-%#x. %d\n",
733                         base, cur - map->reg_stride, ret);
734
735         map->cache_bypass = false;
736
737         *data = NULL;
738
739         return ret;
740 }
741
742 static int regcache_sync_block_raw(struct regmap *map, void *block,
743                             unsigned long *cache_present,
744                             unsigned int block_base, unsigned int start,
745                             unsigned int end)
746 {
747         unsigned int i, val;
748         unsigned int regtmp = 0;
749         unsigned int base = 0;
750         const void *data = NULL;
751         int ret;
752
753         for (i = start; i < end; i++) {
754                 regtmp = block_base + (i * map->reg_stride);
755
756                 if (!regcache_reg_present(cache_present, i) ||
757                     !regmap_writeable(map, regtmp)) {
758                         ret = regcache_sync_block_raw_flush(map, &data,
759                                                             base, regtmp);
760                         if (ret != 0)
761                                 return ret;
762                         continue;
763                 }
764
765                 val = regcache_get_val(map, block, i);
766                 if (!regcache_reg_needs_sync(map, regtmp, val)) {
767                         ret = regcache_sync_block_raw_flush(map, &data,
768                                                             base, regtmp);
769                         if (ret != 0)
770                                 return ret;
771                         continue;
772                 }
773
774                 if (!data) {
775                         data = regcache_get_val_addr(map, block, i);
776                         base = regtmp;
777                 }
778         }
779
780         return regcache_sync_block_raw_flush(map, &data, base, regtmp +
781                         map->reg_stride);
782 }
783
784 int regcache_sync_block(struct regmap *map, void *block,
785                         unsigned long *cache_present,
786                         unsigned int block_base, unsigned int start,
787                         unsigned int end)
788 {
789         if (regmap_can_raw_write(map) && !map->use_single_write)
790                 return regcache_sync_block_raw(map, block, cache_present,
791                                                block_base, start, end);
792         else
793                 return regcache_sync_block_single(map, block, cache_present,
794                                                   block_base, start, end);
795 }