drm/nouveau: consume the return of large GSP message
[drm/drm-misc.git] / drivers / base / regmap / regcache.c
blobd3659ba3cc1122f55c53c1acd568010cb4d78f4d
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>
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>
15 #include "trace.h"
16 #include "internal.h"
18 static const struct regcache_ops *cache_types[] = {
19 &regcache_rbtree_ops,
20 &regcache_maple_ops,
21 &regcache_flat_ops,
24 static int regcache_hw_init(struct regmap *map)
26 int i, j;
27 int ret;
28 int count;
29 unsigned int reg, val;
30 void *tmp_buf;
32 if (!map->num_reg_defaults_raw)
33 return -EINVAL;
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++;
41 /* all registers are unreadable or volatile, so just bypass */
42 if (!count) {
43 map->cache_bypass = true;
44 return 0;
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;
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");
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;
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);
75 /* fill the reg_defaults */
76 for (i = 0, j = 0; i < map->num_reg_defaults_raw; i++) {
77 reg = i * map->reg_stride;
79 if (!regmap_readable(map, reg))
80 continue;
82 if (regmap_volatile(map, reg))
83 continue;
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;
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;
100 map->reg_defaults[j].reg = reg;
101 map->reg_defaults[j].def = val;
102 j++;
105 return 0;
107 err_free:
108 kfree(map->reg_defaults);
110 return ret;
113 int regcache_init(struct regmap *map, const struct regmap_config *config)
115 int ret;
116 int i;
117 void *tmp_buf;
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");
124 map->cache_bypass = true;
125 return 0;
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;
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;
140 for (i = 0; i < config->num_reg_defaults; i++)
141 if (config->reg_defaults[i].reg % map->reg_stride)
142 return -EINVAL;
144 for (i = 0; i < ARRAY_SIZE(cache_types); i++)
145 if (cache_types[i]->type == map->cache_type)
146 break;
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;
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;
160 map->cache = NULL;
161 map->cache_ops = cache_types[i];
163 if (!map->cache_ops->read ||
164 !map->cache_ops->write ||
165 !map->cache_ops->name)
166 return -EINVAL;
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.
172 if (config->reg_defaults) {
173 tmp_buf = kmemdup_array(config->reg_defaults, map->num_reg_defaults,
174 sizeof(*map->reg_defaults), 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.
183 ret = regcache_hw_init(map);
184 if (ret < 0)
185 return ret;
186 if (map->cache_bypass)
187 return 0;
190 if (!map->max_register_is_set && map->num_reg_defaults_raw) {
191 map->max_register = (map->num_reg_defaults_raw - 1) * map->reg_stride;
192 map->max_register_is_set = true;
195 if (map->cache_ops->init) {
196 dev_dbg(map->dev, "Initializing %s cache\n",
197 map->cache_ops->name);
198 map->lock(map->lock_arg);
199 ret = map->cache_ops->init(map);
200 map->unlock(map->lock_arg);
201 if (ret)
202 goto err_free;
204 return 0;
206 err_free:
207 kfree(map->reg_defaults);
208 if (map->cache_free)
209 kfree(map->reg_defaults_raw);
211 return ret;
214 void regcache_exit(struct regmap *map)
216 if (map->cache_type == REGCACHE_NONE)
217 return;
219 BUG_ON(!map->cache_ops);
221 kfree(map->reg_defaults);
222 if (map->cache_free)
223 kfree(map->reg_defaults_raw);
225 if (map->cache_ops->exit) {
226 dev_dbg(map->dev, "Destroying %s cache\n",
227 map->cache_ops->name);
228 map->lock(map->lock_arg);
229 map->cache_ops->exit(map);
230 map->unlock(map->lock_arg);
235 * regcache_read - Fetch the value of a given register from the cache.
237 * @map: map to configure.
238 * @reg: The register index.
239 * @value: The value to be returned.
241 * Return a negative value on failure, 0 on success.
243 int regcache_read(struct regmap *map,
244 unsigned int reg, unsigned int *value)
246 int ret;
248 if (map->cache_type == REGCACHE_NONE)
249 return -EINVAL;
251 BUG_ON(!map->cache_ops);
253 if (!regmap_volatile(map, reg)) {
254 ret = map->cache_ops->read(map, reg, value);
256 if (ret == 0)
257 trace_regmap_reg_read_cache(map, reg, *value);
259 return ret;
262 return -EINVAL;
266 * regcache_write - Set the value of a given register in the cache.
268 * @map: map to configure.
269 * @reg: The register index.
270 * @value: The new register value.
272 * Return a negative value on failure, 0 on success.
274 int regcache_write(struct regmap *map,
275 unsigned int reg, unsigned int value)
277 if (map->cache_type == REGCACHE_NONE)
278 return 0;
280 BUG_ON(!map->cache_ops);
282 if (!regmap_volatile(map, reg))
283 return map->cache_ops->write(map, reg, value);
285 return 0;
288 bool regcache_reg_needs_sync(struct regmap *map, unsigned int reg,
289 unsigned int val)
291 int ret;
293 if (!regmap_writeable(map, reg))
294 return false;
296 /* If we don't know the chip just got reset, then sync everything. */
297 if (!map->no_sync_defaults)
298 return true;
300 /* Is this the hardware default? If so skip. */
301 ret = regcache_lookup_reg(map, reg);
302 if (ret >= 0 && val == map->reg_defaults[ret].def)
303 return false;
304 return true;
307 static int regcache_default_sync(struct regmap *map, unsigned int min,
308 unsigned int max)
310 unsigned int reg;
312 for (reg = min; reg <= max; reg += map->reg_stride) {
313 unsigned int val;
314 int ret;
316 if (regmap_volatile(map, reg) ||
317 !regmap_writeable(map, reg))
318 continue;
320 ret = regcache_read(map, reg, &val);
321 if (ret == -ENOENT)
322 continue;
323 if (ret)
324 return ret;
326 if (!regcache_reg_needs_sync(map, reg, val))
327 continue;
329 map->cache_bypass = true;
330 ret = _regmap_write(map, reg, val);
331 map->cache_bypass = false;
332 if (ret) {
333 dev_err(map->dev, "Unable to sync register %#x. %d\n",
334 reg, ret);
335 return ret;
337 dev_dbg(map->dev, "Synced register %#x, value %#x\n", reg, val);
340 return 0;
343 static int rbtree_all(const void *key, const struct rb_node *node)
345 return 0;
349 * regcache_sync - Sync the register cache with the hardware.
351 * @map: map to configure.
353 * Any registers that should not be synced should be marked as
354 * volatile. In general drivers can choose not to use the provided
355 * syncing functionality if they so require.
357 * Return a negative value on failure, 0 on success.
359 int regcache_sync(struct regmap *map)
361 int ret = 0;
362 unsigned int i;
363 const char *name;
364 bool bypass;
365 struct rb_node *node;
367 if (WARN_ON(map->cache_type == REGCACHE_NONE))
368 return -EINVAL;
370 BUG_ON(!map->cache_ops);
372 map->lock(map->lock_arg);
373 /* Remember the initial bypass state */
374 bypass = map->cache_bypass;
375 dev_dbg(map->dev, "Syncing %s cache\n",
376 map->cache_ops->name);
377 name = map->cache_ops->name;
378 trace_regcache_sync(map, name, "start");
380 if (!map->cache_dirty)
381 goto out;
383 /* Apply any patch first */
384 map->cache_bypass = true;
385 for (i = 0; i < map->patch_regs; i++) {
386 ret = _regmap_write(map, map->patch[i].reg, map->patch[i].def);
387 if (ret != 0) {
388 dev_err(map->dev, "Failed to write %x = %x: %d\n",
389 map->patch[i].reg, map->patch[i].def, ret);
390 goto out;
393 map->cache_bypass = false;
395 if (map->cache_ops->sync)
396 ret = map->cache_ops->sync(map, 0, map->max_register);
397 else
398 ret = regcache_default_sync(map, 0, map->max_register);
400 if (ret == 0)
401 map->cache_dirty = false;
403 out:
404 /* Restore the bypass state */
405 map->cache_bypass = bypass;
406 map->no_sync_defaults = false;
409 * If we did any paging with cache bypassed and a cached
410 * paging register then the register and cache state might
411 * have gone out of sync, force writes of all the paging
412 * registers.
414 rb_for_each(node, NULL, &map->range_tree, rbtree_all) {
415 struct regmap_range_node *this =
416 rb_entry(node, struct regmap_range_node, node);
418 /* If there's nothing in the cache there's nothing to sync */
419 if (regcache_read(map, this->selector_reg, &i) != 0)
420 continue;
422 ret = _regmap_write(map, this->selector_reg, i);
423 if (ret != 0) {
424 dev_err(map->dev, "Failed to write %x = %x: %d\n",
425 this->selector_reg, i, ret);
426 break;
430 map->unlock(map->lock_arg);
432 regmap_async_complete(map);
434 trace_regcache_sync(map, name, "stop");
436 return ret;
438 EXPORT_SYMBOL_GPL(regcache_sync);
441 * regcache_sync_region - Sync part of the register cache with the hardware.
443 * @map: map to sync.
444 * @min: first register to sync
445 * @max: last register to sync
447 * Write all non-default register values in the specified region to
448 * the hardware.
450 * Return a negative value on failure, 0 on success.
452 int regcache_sync_region(struct regmap *map, unsigned int min,
453 unsigned int max)
455 int ret = 0;
456 const char *name;
457 bool bypass;
459 if (WARN_ON(map->cache_type == REGCACHE_NONE))
460 return -EINVAL;
462 BUG_ON(!map->cache_ops);
464 map->lock(map->lock_arg);
466 /* Remember the initial bypass state */
467 bypass = map->cache_bypass;
469 name = map->cache_ops->name;
470 dev_dbg(map->dev, "Syncing %s cache from %d-%d\n", name, min, max);
472 trace_regcache_sync(map, name, "start region");
474 if (!map->cache_dirty)
475 goto out;
477 map->async = true;
479 if (map->cache_ops->sync)
480 ret = map->cache_ops->sync(map, min, max);
481 else
482 ret = regcache_default_sync(map, min, max);
484 out:
485 /* Restore the bypass state */
486 map->cache_bypass = bypass;
487 map->async = false;
488 map->no_sync_defaults = false;
489 map->unlock(map->lock_arg);
491 regmap_async_complete(map);
493 trace_regcache_sync(map, name, "stop region");
495 return ret;
497 EXPORT_SYMBOL_GPL(regcache_sync_region);
500 * regcache_drop_region - Discard part of the register cache
502 * @map: map to operate on
503 * @min: first register to discard
504 * @max: last register to discard
506 * Discard part of the register cache.
508 * Return a negative value on failure, 0 on success.
510 int regcache_drop_region(struct regmap *map, unsigned int min,
511 unsigned int max)
513 int ret = 0;
515 if (!map->cache_ops || !map->cache_ops->drop)
516 return -EINVAL;
518 map->lock(map->lock_arg);
520 trace_regcache_drop_region(map, min, max);
522 ret = map->cache_ops->drop(map, min, max);
524 map->unlock(map->lock_arg);
526 return ret;
528 EXPORT_SYMBOL_GPL(regcache_drop_region);
531 * regcache_cache_only - Put a register map into cache only mode
533 * @map: map to configure
534 * @enable: flag if changes should be written to the hardware
536 * When a register map is marked as cache only writes to the register
537 * map API will only update the register cache, they will not cause
538 * any hardware changes. This is useful for allowing portions of
539 * drivers to act as though the device were functioning as normal when
540 * it is disabled for power saving reasons.
542 void regcache_cache_only(struct regmap *map, bool enable)
544 map->lock(map->lock_arg);
545 WARN_ON(map->cache_type != REGCACHE_NONE &&
546 map->cache_bypass && enable);
547 map->cache_only = enable;
548 trace_regmap_cache_only(map, enable);
549 map->unlock(map->lock_arg);
551 EXPORT_SYMBOL_GPL(regcache_cache_only);
554 * regcache_mark_dirty - Indicate that HW registers were reset to default values
556 * @map: map to mark
558 * Inform regcache that the device has been powered down or reset, so that
559 * on resume, regcache_sync() knows to write out all non-default values
560 * stored in the cache.
562 * If this function is not called, regcache_sync() will assume that
563 * the hardware state still matches the cache state, modulo any writes that
564 * happened when cache_only was true.
566 void regcache_mark_dirty(struct regmap *map)
568 map->lock(map->lock_arg);
569 map->cache_dirty = true;
570 map->no_sync_defaults = true;
571 map->unlock(map->lock_arg);
573 EXPORT_SYMBOL_GPL(regcache_mark_dirty);
576 * regcache_cache_bypass - Put a register map into cache bypass mode
578 * @map: map to configure
579 * @enable: flag if changes should not be written to the cache
581 * When a register map is marked with the cache bypass option, writes
582 * to the register map API will only update the hardware and not
583 * the cache directly. This is useful when syncing the cache back to
584 * the hardware.
586 void regcache_cache_bypass(struct regmap *map, bool enable)
588 map->lock(map->lock_arg);
589 WARN_ON(map->cache_only && enable);
590 map->cache_bypass = enable;
591 trace_regmap_cache_bypass(map, enable);
592 map->unlock(map->lock_arg);
594 EXPORT_SYMBOL_GPL(regcache_cache_bypass);
597 * regcache_reg_cached - Check if a register is cached
599 * @map: map to check
600 * @reg: register to check
602 * Reports if a register is cached.
604 bool regcache_reg_cached(struct regmap *map, unsigned int reg)
606 unsigned int val;
607 int ret;
609 map->lock(map->lock_arg);
611 ret = regcache_read(map, reg, &val);
613 map->unlock(map->lock_arg);
615 return ret == 0;
617 EXPORT_SYMBOL_GPL(regcache_reg_cached);
619 void regcache_set_val(struct regmap *map, void *base, unsigned int idx,
620 unsigned int val)
622 /* Use device native format if possible */
623 if (map->format.format_val) {
624 map->format.format_val(base + (map->cache_word_size * idx),
625 val, 0);
626 return;
629 switch (map->cache_word_size) {
630 case 1: {
631 u8 *cache = base;
633 cache[idx] = val;
634 break;
636 case 2: {
637 u16 *cache = base;
639 cache[idx] = val;
640 break;
642 case 4: {
643 u32 *cache = base;
645 cache[idx] = val;
646 break;
648 default:
649 BUG();
653 unsigned int regcache_get_val(struct regmap *map, const void *base,
654 unsigned int idx)
656 if (!base)
657 return -EINVAL;
659 /* Use device native format if possible */
660 if (map->format.parse_val)
661 return map->format.parse_val(regcache_get_val_addr(map, base,
662 idx));
664 switch (map->cache_word_size) {
665 case 1: {
666 const u8 *cache = base;
668 return cache[idx];
670 case 2: {
671 const u16 *cache = base;
673 return cache[idx];
675 case 4: {
676 const u32 *cache = base;
678 return cache[idx];
680 default:
681 BUG();
683 /* unreachable */
684 return -1;
687 static int regcache_default_cmp(const void *a, const void *b)
689 const struct reg_default *_a = a;
690 const struct reg_default *_b = b;
692 return _a->reg - _b->reg;
695 int regcache_lookup_reg(struct regmap *map, unsigned int reg)
697 struct reg_default key;
698 struct reg_default *r;
700 key.reg = reg;
701 key.def = 0;
703 r = bsearch(&key, map->reg_defaults, map->num_reg_defaults,
704 sizeof(struct reg_default), regcache_default_cmp);
706 if (r)
707 return r - map->reg_defaults;
708 else
709 return -ENOENT;
712 static bool regcache_reg_present(unsigned long *cache_present, unsigned int idx)
714 if (!cache_present)
715 return true;
717 return test_bit(idx, cache_present);
720 int regcache_sync_val(struct regmap *map, unsigned int reg, unsigned int val)
722 int ret;
724 if (!regcache_reg_needs_sync(map, reg, val))
725 return 0;
727 map->cache_bypass = true;
729 ret = _regmap_write(map, reg, val);
731 map->cache_bypass = false;
733 if (ret != 0) {
734 dev_err(map->dev, "Unable to sync register %#x. %d\n",
735 reg, ret);
736 return ret;
738 dev_dbg(map->dev, "Synced register %#x, value %#x\n",
739 reg, val);
741 return 0;
744 static int regcache_sync_block_single(struct regmap *map, void *block,
745 unsigned long *cache_present,
746 unsigned int block_base,
747 unsigned int start, unsigned int end)
749 unsigned int i, regtmp, val;
750 int ret;
752 for (i = start; i < end; i++) {
753 regtmp = block_base + (i * map->reg_stride);
755 if (!regcache_reg_present(cache_present, i) ||
756 !regmap_writeable(map, regtmp))
757 continue;
759 val = regcache_get_val(map, block, i);
760 ret = regcache_sync_val(map, regtmp, val);
761 if (ret != 0)
762 return ret;
765 return 0;
768 static int regcache_sync_block_raw_flush(struct regmap *map, const void **data,
769 unsigned int base, unsigned int cur)
771 size_t val_bytes = map->format.val_bytes;
772 int ret, count;
774 if (*data == NULL)
775 return 0;
777 count = (cur - base) / map->reg_stride;
779 dev_dbg(map->dev, "Writing %zu bytes for %d registers from 0x%x-0x%x\n",
780 count * val_bytes, count, base, cur - map->reg_stride);
782 map->cache_bypass = true;
784 ret = _regmap_raw_write(map, base, *data, count * val_bytes, false);
785 if (ret)
786 dev_err(map->dev, "Unable to sync registers %#x-%#x. %d\n",
787 base, cur - map->reg_stride, ret);
789 map->cache_bypass = false;
791 *data = NULL;
793 return ret;
796 static int regcache_sync_block_raw(struct regmap *map, void *block,
797 unsigned long *cache_present,
798 unsigned int block_base, unsigned int start,
799 unsigned int end)
801 unsigned int i, val;
802 unsigned int regtmp = 0;
803 unsigned int base = 0;
804 const void *data = NULL;
805 int ret;
807 for (i = start; i < end; i++) {
808 regtmp = block_base + (i * map->reg_stride);
810 if (!regcache_reg_present(cache_present, i) ||
811 !regmap_writeable(map, regtmp)) {
812 ret = regcache_sync_block_raw_flush(map, &data,
813 base, regtmp);
814 if (ret != 0)
815 return ret;
816 continue;
819 val = regcache_get_val(map, block, i);
820 if (!regcache_reg_needs_sync(map, regtmp, val)) {
821 ret = regcache_sync_block_raw_flush(map, &data,
822 base, regtmp);
823 if (ret != 0)
824 return ret;
825 continue;
828 if (!data) {
829 data = regcache_get_val_addr(map, block, i);
830 base = regtmp;
834 return regcache_sync_block_raw_flush(map, &data, base, regtmp +
835 map->reg_stride);
838 int regcache_sync_block(struct regmap *map, void *block,
839 unsigned long *cache_present,
840 unsigned int block_base, unsigned int start,
841 unsigned int end)
843 if (regmap_can_raw_write(map) && !map->use_single_write)
844 return regcache_sync_block_raw(map, block, cache_present,
845 block_base, start, end);
846 else
847 return regcache_sync_block_single(map, block, cache_present,
848 block_base, start, end);