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         &regcache_lzo_ops,
  25         &regcache_flat_ops,
  26 };
  27
  28 static int regcache_hw_init(struct regmap *map)
  29 {
  30         int i, j;
  31         int ret;
  32         int count;
  33         unsigned int val;
  34         void *tmp_buf;
  35
  36         if (!map->num_reg_defaults_raw)
  37                 return -EINVAL;
  38
  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))
  42                         count++;
  43
  44         /* all registers are volatile, so just bypass */
  45         if (!count) {
  46                 map->cache_bypass = true;
  47                 return 0;
  48         }
  49
  50         map->num_reg_defaults = count;
  51         map->reg_defaults = kmalloc_array(count, sizeof(struct reg_default),
  52                                           GFP_KERNEL);
  53         if (!map->reg_defaults)
  54                 return -ENOMEM;
  55
  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");
  59
  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);
  63                 if (!tmp_buf) {
  64                         ret = -ENOMEM;
  65                         goto err_free;
  66                 }
  67                 ret = regmap_raw_read(map, 0, tmp_buf,
  68                                       map->num_reg_defaults_raw);
  69                 map->cache_bypass = cache_bypass;
  70                 if (ret < 0)
  71                         goto err_cache_free;
  72
  73                 map->reg_defaults_raw = tmp_buf;
  74                 map->cache_free = 1;
  75         }
  76
  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))
  80                         continue;
  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;
  84                 j++;
  85         }
  86
  87         return 0;
  88
  89 err_cache_free:
  90         kfree(tmp_buf);
  91 err_free:
  92         kfree(map->reg_defaults);
  93
  94         return ret;
  95 }
  96
  97 int regcache_init(struct regmap *map, const struct regmap_config *config)
  98 {
  99         int ret;
 100         int i;
 101         void *tmp_buf;
 102
 103         for (i = 0; i < config->num_reg_defaults; i++)
 104                 if (config->reg_defaults[i].reg % map->reg_stride)
 105                         return -EINVAL;
 106
 107         if (map->cache_type == REGCACHE_NONE) {
 108                 map->cache_bypass = true;
 109                 return 0;
 110         }
 111
 112         for (i = 0; i < ARRAY_SIZE(cache_types); i++)
 113                 if (cache_types[i]->type == map->cache_type)
 114                         break;
 115
 116         if (i == ARRAY_SIZE(cache_types)) {
 117                 dev_err(map->dev, "Could not match compress type: %d\n",
 118                         map->cache_type);
 119                 return -EINVAL;
 120         }
 121
 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;
 127
 128         map->cache = NULL;
 129         map->cache_ops = cache_types[i];
 130
 131         if (!map->cache_ops->read ||
 132             !map->cache_ops->write ||
 133             !map->cache_ops->name)
 134                 return -EINVAL;
 135
 136         /* We still need to ensure that the reg_defaults
 137          * won't vanish from under us.  We'll need to make
 138          * a copy of it.
 139          */
 140         if (config->reg_defaults) {
 141                 if (!map->num_reg_defaults)
 142                         return -EINVAL;
 143                 tmp_buf = kmemdup(config->reg_defaults, map->num_reg_defaults *
 144                                   sizeof(struct reg_default), GFP_KERNEL);
 145                 if (!tmp_buf)
 146                         return -ENOMEM;
 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.
 152                  */
 153                 ret = regcache_hw_init(map);
 154                 if (ret < 0)
 155                         return ret;
 156                 if (map->cache_bypass)
 157                         return 0;
 158         }
 159
 160         if (!map->max_register)
 161                 map->max_register = map->num_reg_defaults_raw;
 162
 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);
 167                 if (ret)
 168                         goto err_free;
 169         }
 170         return 0;
 171
 172 err_free:
 173         kfree(map->reg_defaults);
 174         if (map->cache_free)
 175                 kfree(map->reg_defaults_raw);
 176
 177         return ret;
 178 }
 179
 180 void regcache_exit(struct regmap *map)
 181 {
 182         if (map->cache_type == REGCACHE_NONE)
 183                 return;
 184
 185         BUG_ON(!map->cache_ops);
 186
 187         kfree(map->reg_defaults);
 188         if (map->cache_free)
 189                 kfree(map->reg_defaults_raw);
 190
 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);
 195         }
 196 }
 197
 198 /**
 199  * regcache_read: Fetch the value of a given register from the cache.
 200  *
 201  * @map: map to configure.
 202  * @reg: The register index.
 203  * @value: The value to be returned.
 204  *
 205  * Return a negative value on failure, 0 on success.
 206  */
 207 int regcache_read(struct regmap *map,
 208                   unsigned int reg, unsigned int *value)
 209 {
 210         int ret;
 211
 212         if (map->cache_type == REGCACHE_NONE)
 213                 return -ENOSYS;
 214
 215         BUG_ON(!map->cache_ops);
 216
 217         if (!regmap_volatile(map, reg)) {
 218                 ret = map->cache_ops->read(map, reg, value);
 219
 220                 if (ret == 0)
 221                         trace_regmap_reg_read_cache(map, reg, *value);
 222
 223                 return ret;
 224         }
 225
 226         return -EINVAL;
 227 }
 228
 229 /**
 230  * regcache_write: Set the value of a given register in the cache.
 231  *
 232  * @map: map to configure.
 233  * @reg: The register index.
 234  * @value: The new register value.
 235  *
 236  * Return a negative value on failure, 0 on success.
 237  */
 238 int regcache_write(struct regmap *map,
 239                    unsigned int reg, unsigned int value)
 240 {
 241         if (map->cache_type == REGCACHE_NONE)
 242                 return 0;
 243
 244         BUG_ON(!map->cache_ops);
 245
 246         if (!regmap_volatile(map, reg))
 247                 return map->cache_ops->write(map, reg, value);
 248
 249         return 0;
 250 }
 251
 252 static bool regcache_reg_needs_sync(struct regmap *map, unsigned int reg,
 253                                     unsigned int val)
 254 {
 255         int ret;
 256
 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)
 260                 return false;
 261         return true;
 262 }
 263
 264 static int regcache_default_sync(struct regmap *map, unsigned int min,
 265                                  unsigned int max)
 266 {
 267         unsigned int reg;
 268
 269         for (reg = min; reg <= max; reg += map->reg_stride) {
 270                 unsigned int val;
 271                 int ret;
 272
 273                 if (regmap_volatile(map, reg) ||
 274                     !regmap_writeable(map, reg))
 275                         continue;
 276
 277                 ret = regcache_read(map, reg, &val);
 278                 if (ret)
 279                         return ret;
 280
 281                 if (!regcache_reg_needs_sync(map, reg, val))
 282                         continue;
 283
 284                 map->cache_bypass = 1;
 285                 ret = _regmap_write(map, reg, val);
 286                 map->cache_bypass = 0;
 287                 if (ret) {
 288                         dev_err(map->dev, "Unable to sync register %#x. %d\n",
 289                                 reg, ret);
 290                         return ret;
 291                 }
 292                 dev_dbg(map->dev, "Synced register %#x, value %#x\n", reg, val);
 293         }
 294
 295         return 0;
 296 }
 297
 298 /**
 299  * regcache_sync: Sync the register cache with the hardware.
 300  *
 301  * @map: map to configure.
 302  *
 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.
 306  *
 307  * Return a negative value on failure, 0 on success.
 308  */
 309 int regcache_sync(struct regmap *map)
 310 {
 311         int ret = 0;
 312         unsigned int i;
 313         const char *name;
 314         unsigned int bypass;
 315
 316         BUG_ON(!map->cache_ops);
 317
 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");
 325
 326         if (!map->cache_dirty)
 327                 goto out;
 328
 329         map->async = true;
 330
 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);
 335                 if (ret != 0) {
 336                         dev_err(map->dev, "Failed to write %x = %x: %d\n",
 337                                 map->patch[i].reg, map->patch[i].def, ret);
 338                         goto out;
 339                 }
 340         }
 341         map->cache_bypass = 0;
 342
 343         if (map->cache_ops->sync)
 344                 ret = map->cache_ops->sync(map, 0, map->max_register);
 345         else
 346                 ret = regcache_default_sync(map, 0, map->max_register);
 347
 348         if (ret == 0)
 349                 map->cache_dirty = false;
 350
 351 out:
 352         /* Restore the bypass state */
 353         map->async = false;
 354         map->cache_bypass = bypass;
 355         map->unlock(map->lock_arg);
 356
 357         regmap_async_complete(map);
 358
 359         trace_regcache_sync(map, name, "stop");
 360
 361         return ret;
 362 }
 363 EXPORT_SYMBOL_GPL(regcache_sync);
 364
 365 /**
 366  * regcache_sync_region: Sync part  of the register cache with the hardware.
 367  *
 368  * @map: map to sync.
 369  * @min: first register to sync
 370  * @max: last register to sync
 371  *
 372  * Write all non-default register values in the specified region to
 373  * the hardware.
 374  *
 375  * Return a negative value on failure, 0 on success.
 376  */
 377 int regcache_sync_region(struct regmap *map, unsigned int min,
 378                          unsigned int max)
 379 {
 380         int ret = 0;
 381         const char *name;
 382         unsigned int bypass;
 383
 384         BUG_ON(!map->cache_ops);
 385
 386         map->lock(map->lock_arg);
 387
 388         /* Remember the initial bypass state */
 389         bypass = map->cache_bypass;
 390
 391         name = map->cache_ops->name;
 392         dev_dbg(map->dev, "Syncing %s cache from %d-%d\n", name, min, max);
 393
 394         trace_regcache_sync(map, name, "start region");
 395
 396         if (!map->cache_dirty)
 397                 goto out;
 398
 399         map->async = true;
 400
 401         if (map->cache_ops->sync)
 402                 ret = map->cache_ops->sync(map, min, max);
 403         else
 404                 ret = regcache_default_sync(map, min, max);
 405
 406 out:
 407         /* Restore the bypass state */
 408         map->cache_bypass = bypass;
 409         map->async = false;
 410         map->unlock(map->lock_arg);
 411
 412         regmap_async_complete(map);
 413
 414         trace_regcache_sync(map, name, "stop region");
 415
 416         return ret;
 417 }
 418 EXPORT_SYMBOL_GPL(regcache_sync_region);
 419
 420 /**
 421  * regcache_drop_region: Discard part of the register cache
 422  *
 423  * @map: map to operate on
 424  * @min: first register to discard
 425  * @max: last register to discard
 426  *
 427  * Discard part of the register cache.
 428  *
 429  * Return a negative value on failure, 0 on success.
 430  */
 431 int regcache_drop_region(struct regmap *map, unsigned int min,
 432                          unsigned int max)
 433 {
 434         int ret = 0;
 435
 436         if (!map->cache_ops || !map->cache_ops->drop)
 437                 return -EINVAL;
 438
 439         map->lock(map->lock_arg);
 440
 441         trace_regcache_drop_region(map, min, max);
 442
 443         ret = map->cache_ops->drop(map, min, max);
 444
 445         map->unlock(map->lock_arg);
 446
 447         return ret;
 448 }
 449 EXPORT_SYMBOL_GPL(regcache_drop_region);
 450
 451 /**
 452  * regcache_cache_only: Put a register map into cache only mode
 453  *
 454  * @map: map to configure
 455  * @cache_only: flag if changes should be written to the hardware
 456  *
 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.
 462  */
 463 void regcache_cache_only(struct regmap *map, bool enable)
 464 {
 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);
 470 }
 471 EXPORT_SYMBOL_GPL(regcache_cache_only);
 472
 473 /**
 474  * regcache_mark_dirty: Mark the register cache as dirty
 475  *
 476  * @map: map to mark
 477  *
 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.
 481  */
 482 void regcache_mark_dirty(struct regmap *map)
 483 {
 484         map->lock(map->lock_arg);
 485         map->cache_dirty = true;
 486         map->unlock(map->lock_arg);
 487 }
 488 EXPORT_SYMBOL_GPL(regcache_mark_dirty);
 489
 490 /**
 491  * regcache_cache_bypass: Put a register map into cache bypass mode
 492  *
 493  * @map: map to configure
 494  * @cache_bypass: flag if changes should not be written to the hardware
 495  *
 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
 499  * the hardware.
 500  */
 501 void regcache_cache_bypass(struct regmap *map, bool enable)
 502 {
 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);
 508 }
 509 EXPORT_SYMBOL_GPL(regcache_cache_bypass);
 510
 511 bool regcache_set_val(struct regmap *map, void *base, unsigned int idx,
 512                       unsigned int val)
 513 {
 514         if (regcache_get_val(map, base, idx) == val)
 515                 return true;
 516
 517         /* Use device native format if possible */
 518         if (map->format.format_val) {
 519                 map->format.format_val(base + (map->cache_word_size * idx),
 520                                        val, 0);
 521                 return false;
 522         }
 523
 524         switch (map->cache_word_size) {
 525         case 1: {
 526                 u8 *cache = base;
 527                 cache[idx] = val;
 528                 break;
 529         }
 530         case 2: {
 531                 u16 *cache = base;
 532                 cache[idx] = val;
 533                 break;
 534         }
 535         case 4: {
 536                 u32 *cache = base;
 537                 cache[idx] = val;
 538                 break;
 539         }
 540         default:
 541                 BUG();
 542         }
 543         return false;
 544 }
 545
 546 unsigned int regcache_get_val(struct regmap *map, const void *base,
 547                               unsigned int idx)
 548 {
 549         if (!base)
 550                 return -EINVAL;
 551
 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,
 555                                                                    idx));
 556
 557         switch (map->cache_word_size) {
 558         case 1: {
 559                 const u8 *cache = base;
 560                 return cache[idx];
 561         }
 562         case 2: {
 563                 const u16 *cache = base;
 564                 return cache[idx];
 565         }
 566         case 4: {
 567                 const u32 *cache = base;
 568                 return cache[idx];
 569         }
 570         default:
 571                 BUG();
 572         }
 573         /* unreachable */
 574         return -1;
 575 }
 576
 577 static int regcache_default_cmp(const void *a, const void *b)
 578 {
 579         const struct reg_default *_a = a;
 580         const struct reg_default *_b = b;
 581
 582         return _a->reg - _b->reg;
 583 }
 584
 585 int regcache_lookup_reg(struct regmap *map, unsigned int reg)
 586 {
 587         struct reg_default key;
 588         struct reg_default *r;
 589
 590         key.reg = reg;
 591         key.def = 0;
 592
 593         r = bsearch(&key, map->reg_defaults, map->num_reg_defaults,
 594                     sizeof(struct reg_default), regcache_default_cmp);
 595
 596         if (r)
 597                 return r - map->reg_defaults;
 598         else
 599                 return -ENOENT;
 600 }
 601
 602 static bool regcache_reg_present(unsigned long *cache_present, unsigned int idx)
 603 {
 604         if (!cache_present)
 605                 return true;
 606
 607         return test_bit(idx, cache_present);
 608 }
 609
 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)
 614 {
 615         unsigned int i, regtmp, val;
 616         int ret;
 617
 618         for (i = start; i < end; i++) {
 619                 regtmp = block_base + (i * map->reg_stride);
 620
 621                 if (!regcache_reg_present(cache_present, i) ||
 622                     !regmap_writeable(map, regtmp))
 623                         continue;
 624
 625                 val = regcache_get_val(map, block, i);
 626                 if (!regcache_reg_needs_sync(map, regtmp, val))
 627                         continue;
 628
 629                 map->cache_bypass = 1;
 630
 631                 ret = _regmap_write(map, regtmp, val);
 632
 633                 map->cache_bypass = 0;
 634                 if (ret != 0) {
 635                         dev_err(map->dev, "Unable to sync register %#x. %d\n",
 636                                 regtmp, ret);
 637                         return ret;
 638                 }
 639                 dev_dbg(map->dev, "Synced register %#x, value %#x\n",
 640                         regtmp, val);
 641         }
 642
 643         return 0;
 644 }
 645
 646 static int regcache_sync_block_raw_flush(struct regmap *map, const void **data,
 647                                          unsigned int base, unsigned int cur)
 648 {
 649         size_t val_bytes = map->format.val_bytes;
 650         int ret, count;
 651
 652         if (*data == NULL)
 653                 return 0;
 654
 655         count = (cur - base) / map->reg_stride;
 656
 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);
 659
 660         map->cache_bypass = 1;
 661
 662         ret = _regmap_raw_write(map, base, *data, count * val_bytes);
 663         if (ret)
 664                 dev_err(map->dev, "Unable to sync registers %#x-%#x. %d\n",
 665                         base, cur - map->reg_stride, ret);
 666
 667         map->cache_bypass = 0;
 668
 669         *data = NULL;
 670
 671         return ret;
 672 }
 673
 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,
 677                             unsigned int end)
 678 {
 679         unsigned int i, val;
 680         unsigned int regtmp = 0;
 681         unsigned int base = 0;
 682         const void *data = NULL;
 683         int ret;
 684
 685         for (i = start; i < end; i++) {
 686                 regtmp = block_base + (i * map->reg_stride);
 687
 688                 if (!regcache_reg_present(cache_present, i) ||
 689                     !regmap_writeable(map, regtmp)) {
 690                         ret = regcache_sync_block_raw_flush(map, &data,
 691                                                             base, regtmp);
 692                         if (ret != 0)
 693                                 return ret;
 694                         continue;
 695                 }
 696
 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,
 700                                                             base, regtmp);
 701                         if (ret != 0)
 702                                 return ret;
 703                         continue;
 704                 }
 705
 706                 if (!data) {
 707                         data = regcache_get_val_addr(map, block, i);
 708                         base = regtmp;
 709                 }
 710         }
 711
 712         return regcache_sync_block_raw_flush(map, &data, base, regtmp +
 713                         map->reg_stride);
 714 }
 715
 716 int regcache_sync_block(struct regmap *map, void *block,
 717                         unsigned long *cache_present,
 718                         unsigned int block_base, unsigned int start,
 719                         unsigned int end)
 720 {
 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);
 724         else
 725                 return regcache_sync_block_single(map, block, cache_present,
 726                                                   block_base, start, end);
 727 }