2 * Register cache access API
4 * Copyright 2011 Wolfson Microelectronics plc
6 * Author: Dimitris Papastamos <dp@opensource.wolfsonmicro.com>
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.
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>
22 static const struct regcache_ops *cache_types[] = {
28 static int regcache_hw_init(struct regmap *map)
36 if (!map->num_reg_defaults_raw)
39 /* calculate the size of reg_defaults */
40 for (count = 0, i = 0; i < map->num_reg_defaults_raw; i++)
41 if (!regmap_volatile(map, i * map->reg_stride))
44 /* all registers are volatile, so just bypass */
46 map->cache_bypass = true;
50 map->num_reg_defaults = count;
51 map->reg_defaults = kmalloc_array(count, sizeof(struct reg_default),
53 if (!map->reg_defaults)
56 if (!map->reg_defaults_raw) {
57 u32 cache_bypass = map->cache_bypass;
58 dev_warn(map->dev, "No cache defaults, reading back from HW\n");
60 /* Bypass the cache access till data read from HW*/
61 map->cache_bypass = 1;
62 tmp_buf = kmalloc(map->cache_size_raw, GFP_KERNEL);
67 ret = regmap_raw_read(map, 0, tmp_buf,
68 map->num_reg_defaults_raw);
69 map->cache_bypass = cache_bypass;
73 map->reg_defaults_raw = tmp_buf;
77 /* fill the reg_defaults */
78 for (i = 0, j = 0; i < map->num_reg_defaults_raw; i++) {
79 if (regmap_volatile(map, i * map->reg_stride))
81 val = regcache_get_val(map, map->reg_defaults_raw, i);
82 map->reg_defaults[j].reg = i * map->reg_stride;
83 map->reg_defaults[j].def = val;
92 kfree(map->reg_defaults);
97 int regcache_init(struct regmap *map, const struct regmap_config *config)
103 for (i = 0; i < config->num_reg_defaults; i++)
104 if (config->reg_defaults[i].reg % map->reg_stride)
107 if (map->cache_type == REGCACHE_NONE) {
108 map->cache_bypass = true;
112 for (i = 0; i < ARRAY_SIZE(cache_types); i++)
113 if (cache_types[i]->type == map->cache_type)
116 if (i == ARRAY_SIZE(cache_types)) {
117 dev_err(map->dev, "Could not match compress type: %d\n",
122 map->num_reg_defaults = config->num_reg_defaults;
123 map->num_reg_defaults_raw = config->num_reg_defaults_raw;
124 map->reg_defaults_raw = config->reg_defaults_raw;
125 map->cache_word_size = DIV_ROUND_UP(config->val_bits, 8);
126 map->cache_size_raw = map->cache_word_size * config->num_reg_defaults_raw;
129 map->cache_ops = cache_types[i];
131 if (!map->cache_ops->read ||
132 !map->cache_ops->write ||
133 !map->cache_ops->name)
136 /* We still need to ensure that the reg_defaults
137 * won't vanish from under us. We'll need to make
140 if (config->reg_defaults) {
141 if (!map->num_reg_defaults)
143 tmp_buf = kmemdup(config->reg_defaults, map->num_reg_defaults *
144 sizeof(struct reg_default), GFP_KERNEL);
147 map->reg_defaults = tmp_buf;
148 } else if (map->num_reg_defaults_raw) {
149 /* Some devices such as PMICs don't have cache defaults,
150 * we cope with this by reading back the HW registers and
151 * crafting the cache defaults by hand.
153 ret = regcache_hw_init(map);
156 if (map->cache_bypass)
160 if (!map->max_register)
161 map->max_register = map->num_reg_defaults_raw;
163 if (map->cache_ops->init) {
164 dev_dbg(map->dev, "Initializing %s cache\n",
165 map->cache_ops->name);
166 ret = map->cache_ops->init(map);
173 kfree(map->reg_defaults);
175 kfree(map->reg_defaults_raw);
180 void regcache_exit(struct regmap *map)
182 if (map->cache_type == REGCACHE_NONE)
185 BUG_ON(!map->cache_ops);
187 kfree(map->reg_defaults);
189 kfree(map->reg_defaults_raw);
191 if (map->cache_ops->exit) {
192 dev_dbg(map->dev, "Destroying %s cache\n",
193 map->cache_ops->name);
194 map->cache_ops->exit(map);
199 * regcache_read: Fetch the value of a given register from the cache.
201 * @map: map to configure.
202 * @reg: The register index.
203 * @value: The value to be returned.
205 * Return a negative value on failure, 0 on success.
207 int regcache_read(struct regmap *map,
208 unsigned int reg, unsigned int *value)
212 if (map->cache_type == REGCACHE_NONE)
215 BUG_ON(!map->cache_ops);
217 if (!regmap_volatile(map, reg)) {
218 ret = map->cache_ops->read(map, reg, value);
221 trace_regmap_reg_read_cache(map, reg, *value);
230 * regcache_write: Set the value of a given register in the cache.
232 * @map: map to configure.
233 * @reg: The register index.
234 * @value: The new register value.
236 * Return a negative value on failure, 0 on success.
238 int regcache_write(struct regmap *map,
239 unsigned int reg, unsigned int value)
241 if (map->cache_type == REGCACHE_NONE)
244 BUG_ON(!map->cache_ops);
246 if (!regmap_volatile(map, reg))
247 return map->cache_ops->write(map, reg, value);
252 static bool regcache_reg_needs_sync(struct regmap *map, unsigned int reg,
257 /* Is this the hardware default? If so skip. */
258 ret = regcache_lookup_reg(map, reg);
259 if (ret >= 0 && val == map->reg_defaults[ret].def)
264 static int regcache_default_sync(struct regmap *map, unsigned int min,
269 for (reg = min; reg <= max; reg += map->reg_stride) {
273 if (regmap_volatile(map, reg) ||
274 !regmap_writeable(map, reg))
277 ret = regcache_read(map, reg, &val);
281 if (!regcache_reg_needs_sync(map, reg, val))
284 map->cache_bypass = 1;
285 ret = _regmap_write(map, reg, val);
286 map->cache_bypass = 0;
288 dev_err(map->dev, "Unable to sync register %#x. %d\n",
292 dev_dbg(map->dev, "Synced register %#x, value %#x\n", reg, val);
299 * regcache_sync: Sync the register cache with the hardware.
301 * @map: map to configure.
303 * Any registers that should not be synced should be marked as
304 * volatile. In general drivers can choose not to use the provided
305 * syncing functionality if they so require.
307 * Return a negative value on failure, 0 on success.
309 int regcache_sync(struct regmap *map)
316 BUG_ON(!map->cache_ops);
318 map->lock(map->lock_arg);
319 /* Remember the initial bypass state */
320 bypass = map->cache_bypass;
321 dev_dbg(map->dev, "Syncing %s cache\n",
322 map->cache_ops->name);
323 name = map->cache_ops->name;
324 trace_regcache_sync(map, name, "start");
326 if (!map->cache_dirty)
331 /* Apply any patch first */
332 map->cache_bypass = 1;
333 for (i = 0; i < map->patch_regs; i++) {
334 ret = _regmap_write(map, map->patch[i].reg, map->patch[i].def);
336 dev_err(map->dev, "Failed to write %x = %x: %d\n",
337 map->patch[i].reg, map->patch[i].def, ret);
341 map->cache_bypass = 0;
343 if (map->cache_ops->sync)
344 ret = map->cache_ops->sync(map, 0, map->max_register);
346 ret = regcache_default_sync(map, 0, map->max_register);
349 map->cache_dirty = false;
352 /* Restore the bypass state */
354 map->cache_bypass = bypass;
355 map->unlock(map->lock_arg);
357 regmap_async_complete(map);
359 trace_regcache_sync(map, name, "stop");
363 EXPORT_SYMBOL_GPL(regcache_sync);
366 * regcache_sync_region: Sync part of the register cache with the hardware.
369 * @min: first register to sync
370 * @max: last register to sync
372 * Write all non-default register values in the specified region to
375 * Return a negative value on failure, 0 on success.
377 int regcache_sync_region(struct regmap *map, unsigned int min,
384 BUG_ON(!map->cache_ops);
386 map->lock(map->lock_arg);
388 /* Remember the initial bypass state */
389 bypass = map->cache_bypass;
391 name = map->cache_ops->name;
392 dev_dbg(map->dev, "Syncing %s cache from %d-%d\n", name, min, max);
394 trace_regcache_sync(map, name, "start region");
396 if (!map->cache_dirty)
401 if (map->cache_ops->sync)
402 ret = map->cache_ops->sync(map, min, max);
404 ret = regcache_default_sync(map, min, max);
407 /* Restore the bypass state */
408 map->cache_bypass = bypass;
410 map->unlock(map->lock_arg);
412 regmap_async_complete(map);
414 trace_regcache_sync(map, name, "stop region");
418 EXPORT_SYMBOL_GPL(regcache_sync_region);
421 * regcache_drop_region: Discard part of the register cache
423 * @map: map to operate on
424 * @min: first register to discard
425 * @max: last register to discard
427 * Discard part of the register cache.
429 * Return a negative value on failure, 0 on success.
431 int regcache_drop_region(struct regmap *map, unsigned int min,
436 if (!map->cache_ops || !map->cache_ops->drop)
439 map->lock(map->lock_arg);
441 trace_regcache_drop_region(map, min, max);
443 ret = map->cache_ops->drop(map, min, max);
445 map->unlock(map->lock_arg);
449 EXPORT_SYMBOL_GPL(regcache_drop_region);
452 * regcache_cache_only: Put a register map into cache only mode
454 * @map: map to configure
455 * @cache_only: flag if changes should be written to the hardware
457 * When a register map is marked as cache only writes to the register
458 * map API will only update the register cache, they will not cause
459 * any hardware changes. This is useful for allowing portions of
460 * drivers to act as though the device were functioning as normal when
461 * it is disabled for power saving reasons.
463 void regcache_cache_only(struct regmap *map, bool enable)
465 map->lock(map->lock_arg);
466 WARN_ON(map->cache_bypass && enable);
467 map->cache_only = enable;
468 trace_regmap_cache_only(map, enable);
469 map->unlock(map->lock_arg);
471 EXPORT_SYMBOL_GPL(regcache_cache_only);
474 * regcache_mark_dirty: Mark the register cache as dirty
478 * Mark the register cache as dirty, for example due to the device
479 * having been powered down for suspend. If the cache is not marked
480 * as dirty then the cache sync will be suppressed.
482 void regcache_mark_dirty(struct regmap *map)
484 map->lock(map->lock_arg);
485 map->cache_dirty = true;
486 map->unlock(map->lock_arg);
488 EXPORT_SYMBOL_GPL(regcache_mark_dirty);
491 * regcache_cache_bypass: Put a register map into cache bypass mode
493 * @map: map to configure
494 * @cache_bypass: flag if changes should not be written to the hardware
496 * When a register map is marked with the cache bypass option, writes
497 * to the register map API will only update the hardware and not the
498 * the cache directly. This is useful when syncing the cache back to
501 void regcache_cache_bypass(struct regmap *map, bool enable)
503 map->lock(map->lock_arg);
504 WARN_ON(map->cache_only && enable);
505 map->cache_bypass = enable;
506 trace_regmap_cache_bypass(map, enable);
507 map->unlock(map->lock_arg);
509 EXPORT_SYMBOL_GPL(regcache_cache_bypass);
511 bool regcache_set_val(struct regmap *map, void *base, unsigned int idx,
514 if (regcache_get_val(map, base, idx) == val)
517 /* Use device native format if possible */
518 if (map->format.format_val) {
519 map->format.format_val(base + (map->cache_word_size * idx),
524 switch (map->cache_word_size) {
546 unsigned int regcache_get_val(struct regmap *map, const void *base,
552 /* Use device native format if possible */
553 if (map->format.parse_val)
554 return map->format.parse_val(regcache_get_val_addr(map, base,
557 switch (map->cache_word_size) {
559 const u8 *cache = base;
563 const u16 *cache = base;
567 const u32 *cache = base;
577 static int regcache_default_cmp(const void *a, const void *b)
579 const struct reg_default *_a = a;
580 const struct reg_default *_b = b;
582 return _a->reg - _b->reg;
585 int regcache_lookup_reg(struct regmap *map, unsigned int reg)
587 struct reg_default key;
588 struct reg_default *r;
593 r = bsearch(&key, map->reg_defaults, map->num_reg_defaults,
594 sizeof(struct reg_default), regcache_default_cmp);
597 return r - map->reg_defaults;
602 static bool regcache_reg_present(unsigned long *cache_present, unsigned int idx)
607 return test_bit(idx, cache_present);
610 static int regcache_sync_block_single(struct regmap *map, void *block,
611 unsigned long *cache_present,
612 unsigned int block_base,
613 unsigned int start, unsigned int end)
615 unsigned int i, regtmp, val;
618 for (i = start; i < end; i++) {
619 regtmp = block_base + (i * map->reg_stride);
621 if (!regcache_reg_present(cache_present, i) ||
622 !regmap_writeable(map, regtmp))
625 val = regcache_get_val(map, block, i);
626 if (!regcache_reg_needs_sync(map, regtmp, val))
629 map->cache_bypass = 1;
631 ret = _regmap_write(map, regtmp, val);
633 map->cache_bypass = 0;
635 dev_err(map->dev, "Unable to sync register %#x. %d\n",
639 dev_dbg(map->dev, "Synced register %#x, value %#x\n",
646 static int regcache_sync_block_raw_flush(struct regmap *map, const void **data,
647 unsigned int base, unsigned int cur)
649 size_t val_bytes = map->format.val_bytes;
655 count = (cur - base) / map->reg_stride;
657 dev_dbg(map->dev, "Writing %zu bytes for %d registers from 0x%x-0x%x\n",
658 count * val_bytes, count, base, cur - map->reg_stride);
660 map->cache_bypass = 1;
662 ret = _regmap_raw_write(map, base, *data, count * val_bytes);
664 dev_err(map->dev, "Unable to sync registers %#x-%#x. %d\n",
665 base, cur - map->reg_stride, ret);
667 map->cache_bypass = 0;
674 static int regcache_sync_block_raw(struct regmap *map, void *block,
675 unsigned long *cache_present,
676 unsigned int block_base, unsigned int start,
680 unsigned int regtmp = 0;
681 unsigned int base = 0;
682 const void *data = NULL;
685 for (i = start; i < end; i++) {
686 regtmp = block_base + (i * map->reg_stride);
688 if (!regcache_reg_present(cache_present, i) ||
689 !regmap_writeable(map, regtmp)) {
690 ret = regcache_sync_block_raw_flush(map, &data,
697 val = regcache_get_val(map, block, i);
698 if (!regcache_reg_needs_sync(map, regtmp, val)) {
699 ret = regcache_sync_block_raw_flush(map, &data,
707 data = regcache_get_val_addr(map, block, i);
712 return regcache_sync_block_raw_flush(map, &data, base, regtmp +
716 int regcache_sync_block(struct regmap *map, void *block,
717 unsigned long *cache_present,
718 unsigned int block_base, unsigned int start,
721 if (regmap_can_raw_write(map) && !map->use_single_rw)
722 return regcache_sync_block_raw(map, block, cache_present,
723 block_base, start, end);
725 return regcache_sync_block_single(map, block, cache_present,
726 block_base, start, end);