drivers/base/regmap/regmap.c

   1 /*
   2  * Register map access API
   3  *
   4  * Copyright 2011 Wolfson Microelectronics plc
   5  *
   6  * Author: Mark Brown <broonie@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/slab.h>
  14 #include <linux/module.h>
  15 #include <linux/mutex.h>
  16 #include <linux/err.h>
  17
  18 #define CREATE_TRACE_POINTS
  19 #include <trace/events/regmap.h>
  20
  21 #include "internal.h"
  22
  23 bool regmap_writeable(struct regmap *map, unsigned int reg)
  24 {
  25         if (map->max_register && reg > map->max_register)
  26                 return false;
  27
  28         if (map->writeable_reg)
  29                 return map->writeable_reg(map->dev, reg);
  30
  31         return true;
  32 }
  33
  34 bool regmap_readable(struct regmap *map, unsigned int reg)
  35 {
  36         if (map->max_register && reg > map->max_register)
  37                 return false;
  38
  39         if (map->format.format_write)
  40                 return false;
  41
  42         if (map->readable_reg)
  43                 return map->readable_reg(map->dev, reg);
  44
  45         return true;
  46 }
  47
  48 bool regmap_volatile(struct regmap *map, unsigned int reg)
  49 {
  50         if (!map->format.format_write && !regmap_readable(map, reg))
  51                 return false;
  52
  53         if (map->volatile_reg)
  54                 return map->volatile_reg(map->dev, reg);
  55
  56         return true;
  57 }
  58
  59 bool regmap_precious(struct regmap *map, unsigned int reg)
  60 {
  61         if (!regmap_readable(map, reg))
  62                 return false;
  63
  64         if (map->precious_reg)
  65                 return map->precious_reg(map->dev, reg);
  66
  67         return false;
  68 }
  69
  70 static void regmap_format_4_12_write(struct regmap *map,
  71                                      unsigned int reg, unsigned int val)
  72 {
  73         __be16 *out = map->work_buf;
  74         *out = cpu_to_be16((reg << 12) | val);
  75 }
  76
  77 static void regmap_format_7_9_write(struct regmap *map,
  78                                     unsigned int reg, unsigned int val)
  79 {
  80         __be16 *out = map->work_buf;
  81         *out = cpu_to_be16((reg << 9) | val);
  82 }
  83
  84 static void regmap_format_8(void *buf, unsigned int val)
  85 {
  86         u8 *b = buf;
  87
  88         b[0] = val;
  89 }
  90
  91 static void regmap_format_16(void *buf, unsigned int val)
  92 {
  93         __be16 *b = buf;
  94
  95         b[0] = cpu_to_be16(val);
  96 }
  97
  98 static unsigned int regmap_parse_8(void *buf)
  99 {
 100         u8 *b = buf;
 101
 102         return b[0];
 103 }
 104
 105 static unsigned int regmap_parse_16(void *buf)
 106 {
 107         __be16 *b = buf;
 108
 109         b[0] = be16_to_cpu(b[0]);
 110
 111         return b[0];
 112 }
 113
 114 /**
 115  * regmap_init(): Initialise register map
 116  *
 117  * @dev: Device that will be interacted with
 118  * @bus: Bus-specific callbacks to use with device
 119  * @config: Configuration for register map
 120  *
 121  * The return value will be an ERR_PTR() on error or a valid pointer to
 122  * a struct regmap.  This function should generally not be called
 123  * directly, it should be called by bus-specific init functions.
 124  */
 125 struct regmap *regmap_init(struct device *dev,
 126                            const struct regmap_bus *bus,
 127                            const struct regmap_config *config)
 128 {
 129         struct regmap *map;
 130         int ret = -EINVAL;
 131
 132         if (!bus || !config)
 133                 return NULL;
 134
 135         map = kzalloc(sizeof(*map), GFP_KERNEL);
 136         if (map == NULL) {
 137                 ret = -ENOMEM;
 138                 goto err;
 139         }
 140
 141         mutex_init(&map->lock);
 142         map->format.buf_size = (config->reg_bits + config->val_bits) / 8;
 143         map->format.reg_bytes = config->reg_bits / 8;
 144         map->format.val_bytes = config->val_bits / 8;
 145         map->dev = dev;
 146         map->bus = bus;
 147         map->max_register = config->max_register;
 148         map->writeable_reg = config->writeable_reg;
 149         map->readable_reg = config->readable_reg;
 150         map->volatile_reg = config->volatile_reg;
 151         map->precious_reg = config->precious_reg;
 152         map->cache_type = config->cache_type;
 153         map->reg_defaults = config->reg_defaults;
 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_size_raw = (config->val_bits / 8) * config->num_reg_defaults_raw;
 158         map->cache_word_size = config->val_bits / 8;
 159
 160         if (config->read_flag_mask || config->write_flag_mask) {
 161                 map->read_flag_mask = config->read_flag_mask;
 162                 map->write_flag_mask = config->write_flag_mask;
 163         } else {
 164                 map->read_flag_mask = bus->read_flag_mask;
 165         }
 166
 167         switch (config->reg_bits) {
 168         case 4:
 169                 switch (config->val_bits) {
 170                 case 12:
 171                         map->format.format_write = regmap_format_4_12_write;
 172                         break;
 173                 default:
 174                         goto err_map;
 175                 }
 176                 break;
 177
 178         case 7:
 179                 switch (config->val_bits) {
 180                 case 9:
 181                         map->format.format_write = regmap_format_7_9_write;
 182                         break;
 183                 default:
 184                         goto err_map;
 185                 }
 186                 break;
 187
 188         case 8:
 189                 map->format.format_reg = regmap_format_8;
 190                 break;
 191
 192         case 16:
 193                 map->format.format_reg = regmap_format_16;
 194                 break;
 195
 196         default:
 197                 goto err_map;
 198         }
 199
 200         switch (config->val_bits) {
 201         case 8:
 202                 map->format.format_val = regmap_format_8;
 203                 map->format.parse_val = regmap_parse_8;
 204                 break;
 205         case 16:
 206                 map->format.format_val = regmap_format_16;
 207                 map->format.parse_val = regmap_parse_16;
 208                 break;
 209         }
 210
 211         if (!map->format.format_write &&
 212             !(map->format.format_reg && map->format.format_val))
 213                 goto err_map;
 214
 215         map->work_buf = kmalloc(map->format.buf_size, GFP_KERNEL);
 216         if (map->work_buf == NULL) {
 217                 ret = -ENOMEM;
 218                 goto err_map;
 219         }
 220
 221         ret = regcache_init(map);
 222         if (ret < 0)
 223                 goto err_map;
 224
 225         regmap_debugfs_init(map);
 226
 227         return map;
 228
 229 err_map:
 230         kfree(map);
 231 err:
 232         return ERR_PTR(ret);
 233 }
 234 EXPORT_SYMBOL_GPL(regmap_init);
 235
 236 /**
 237  * regmap_exit(): Free a previously allocated register map
 238  */
 239 void regmap_exit(struct regmap *map)
 240 {
 241         regcache_exit(map);
 242         regmap_debugfs_exit(map);
 243         kfree(map->work_buf);
 244         kfree(map);
 245 }
 246 EXPORT_SYMBOL_GPL(regmap_exit);
 247
 248 static int _regmap_raw_write(struct regmap *map, unsigned int reg,
 249                              const void *val, size_t val_len)
 250 {
 251         u8 *u8 = map->work_buf;
 252         void *buf;
 253         int ret = -ENOTSUPP;
 254         size_t len;
 255         int i;
 256
 257         /* Check for unwritable registers before we start */
 258         if (map->writeable_reg)
 259                 for (i = 0; i < val_len / map->format.val_bytes; i++)
 260                         if (!map->writeable_reg(map->dev, reg + i))
 261                                 return -EINVAL;
 262
 263         map->format.format_reg(map->work_buf, reg);
 264
 265         u8[0] |= map->write_flag_mask;
 266
 267         trace_regmap_hw_write_start(map->dev, reg,
 268                                     val_len / map->format.val_bytes);
 269
 270         /* If we're doing a single register write we can probably just
 271          * send the work_buf directly, otherwise try to do a gather
 272          * write.
 273          */
 274         if (val == map->work_buf + map->format.reg_bytes)
 275                 ret = map->bus->write(map->dev, map->work_buf,
 276                                       map->format.reg_bytes + val_len);
 277         else if (map->bus->gather_write)
 278                 ret = map->bus->gather_write(map->dev, map->work_buf,
 279                                              map->format.reg_bytes,
 280                                              val, val_len);
 281
 282         /* If that didn't work fall back on linearising by hand. */
 283         if (ret == -ENOTSUPP) {
 284                 len = map->format.reg_bytes + val_len;
 285                 buf = kmalloc(len, GFP_KERNEL);
 286                 if (!buf)
 287                         return -ENOMEM;
 288
 289                 memcpy(buf, map->work_buf, map->format.reg_bytes);
 290                 memcpy(buf + map->format.reg_bytes, val, val_len);
 291                 ret = map->bus->write(map->dev, buf, len);
 292
 293                 kfree(buf);
 294         }
 295
 296         trace_regmap_hw_write_done(map->dev, reg,
 297                                    val_len / map->format.val_bytes);
 298
 299         return ret;
 300 }
 301
 302 int _regmap_write(struct regmap *map, unsigned int reg,
 303                   unsigned int val)
 304 {
 305         int ret;
 306         BUG_ON(!map->format.format_write && !map->format.format_val);
 307
 308         if (!map->cache_bypass) {
 309                 ret = regcache_write(map, reg, val);
 310                 if (ret != 0)
 311                         return ret;
 312                 if (map->cache_only)
 313                         return 0;
 314         }
 315
 316         trace_regmap_reg_write(map->dev, reg, val);
 317
 318         if (map->format.format_write) {
 319                 map->format.format_write(map, reg, val);
 320
 321                 trace_regmap_hw_write_start(map->dev, reg, 1);
 322
 323                 ret = map->bus->write(map->dev, map->work_buf,
 324                                       map->format.buf_size);
 325
 326                 trace_regmap_hw_write_done(map->dev, reg, 1);
 327
 328                 return ret;
 329         } else {
 330                 map->format.format_val(map->work_buf + map->format.reg_bytes,
 331                                        val);
 332                 return _regmap_raw_write(map, reg,
 333                                          map->work_buf + map->format.reg_bytes,
 334                                          map->format.val_bytes);
 335         }
 336 }
 337
 338 /**
 339  * regmap_write(): Write a value to a single register
 340  *
 341  * @map: Register map to write to
 342  * @reg: Register to write to
 343  * @val: Value to be written
 344  *
 345  * A value of zero will be returned on success, a negative errno will
 346  * be returned in error cases.
 347  */
 348 int regmap_write(struct regmap *map, unsigned int reg, unsigned int val)
 349 {
 350         int ret;
 351
 352         mutex_lock(&map->lock);
 353
 354         ret = _regmap_write(map, reg, val);
 355
 356         mutex_unlock(&map->lock);
 357
 358         return ret;
 359 }
 360 EXPORT_SYMBOL_GPL(regmap_write);
 361
 362 /**
 363  * regmap_raw_write(): Write raw values to one or more registers
 364  *
 365  * @map: Register map to write to
 366  * @reg: Initial register to write to
 367  * @val: Block of data to be written, laid out for direct transmission to the
 368  *       device
 369  * @val_len: Length of data pointed to by val.
 370  *
 371  * This function is intended to be used for things like firmware
 372  * download where a large block of data needs to be transferred to the
 373  * device.  No formatting will be done on the data provided.
 374  *
 375  * A value of zero will be returned on success, a negative errno will
 376  * be returned in error cases.
 377  */
 378 int regmap_raw_write(struct regmap *map, unsigned int reg,
 379                      const void *val, size_t val_len)
 380 {
 381         int ret;
 382
 383         WARN_ON(map->cache_type != REGCACHE_NONE);
 384
 385         mutex_lock(&map->lock);
 386
 387         ret = _regmap_raw_write(map, reg, val, val_len);
 388
 389         mutex_unlock(&map->lock);
 390
 391         return ret;
 392 }
 393 EXPORT_SYMBOL_GPL(regmap_raw_write);
 394
 395 static int _regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
 396                             unsigned int val_len)
 397 {
 398         u8 *u8 = map->work_buf;
 399         int ret;
 400
 401         map->format.format_reg(map->work_buf, reg);
 402
 403         /*
 404          * Some buses or devices flag reads by setting the high bits in the
 405          * register addresss; since it's always the high bits for all
 406          * current formats we can do this here rather than in
 407          * formatting.  This may break if we get interesting formats.
 408          */
 409         u8[0] |= map->read_flag_mask;
 410
 411         trace_regmap_hw_read_start(map->dev, reg,
 412                                    val_len / map->format.val_bytes);
 413
 414         ret = map->bus->read(map->dev, map->work_buf, map->format.reg_bytes,
 415                              val, val_len);
 416
 417         trace_regmap_hw_read_done(map->dev, reg,
 418                                   val_len / map->format.val_bytes);
 419
 420         return ret;
 421 }
 422
 423 static int _regmap_read(struct regmap *map, unsigned int reg,
 424                         unsigned int *val)
 425 {
 426         int ret;
 427
 428         if (!map->format.parse_val)
 429                 return -EINVAL;
 430
 431         if (!map->cache_bypass) {
 432                 ret = regcache_read(map, reg, val);
 433                 if (ret == 0)
 434                         return 0;
 435         }
 436
 437         if (map->cache_only)
 438                 return -EBUSY;
 439
 440         ret = _regmap_raw_read(map, reg, map->work_buf, map->format.val_bytes);
 441         if (ret == 0) {
 442                 *val = map->format.parse_val(map->work_buf);
 443                 trace_regmap_reg_read(map->dev, reg, *val);
 444         }
 445
 446         return ret;
 447 }
 448
 449 /**
 450  * regmap_read(): Read a value from a single register
 451  *
 452  * @map: Register map to write to
 453  * @reg: Register to be read from
 454  * @val: Pointer to store read value
 455  *
 456  * A value of zero will be returned on success, a negative errno will
 457  * be returned in error cases.
 458  */
 459 int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val)
 460 {
 461         int ret;
 462
 463         mutex_lock(&map->lock);
 464
 465         ret = _regmap_read(map, reg, val);
 466
 467         mutex_unlock(&map->lock);
 468
 469         return ret;
 470 }
 471 EXPORT_SYMBOL_GPL(regmap_read);
 472
 473 /**
 474  * regmap_raw_read(): Read raw data from the device
 475  *
 476  * @map: Register map to write to
 477  * @reg: First register to be read from
 478  * @val: Pointer to store read value
 479  * @val_len: Size of data to read
 480  *
 481  * A value of zero will be returned on success, a negative errno will
 482  * be returned in error cases.
 483  */
 484 int regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
 485                     size_t val_len)
 486 {
 487         int ret;
 488         int i;
 489         bool vol = true;
 490
 491         for (i = 0; i < val_len / map->format.val_bytes; i++)
 492                 if (!regmap_volatile(map, reg + i))
 493                         vol = false;
 494
 495         WARN_ON(!vol && map->cache_type != REGCACHE_NONE);
 496
 497         mutex_lock(&map->lock);
 498
 499         ret = _regmap_raw_read(map, reg, val, val_len);
 500
 501         mutex_unlock(&map->lock);
 502
 503         return ret;
 504 }
 505 EXPORT_SYMBOL_GPL(regmap_raw_read);
 506
 507 /**
 508  * regmap_bulk_read(): Read multiple registers from the device
 509  *
 510  * @map: Register map to write to
 511  * @reg: First register to be read from
 512  * @val: Pointer to store read value, in native register size for device
 513  * @val_count: Number of registers to read
 514  *
 515  * A value of zero will be returned on success, a negative errno will
 516  * be returned in error cases.
 517  */
 518 int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
 519                      size_t val_count)
 520 {
 521         int ret, i;
 522         size_t val_bytes = map->format.val_bytes;
 523         bool vol = true;
 524
 525         if (!map->format.parse_val)
 526                 return -EINVAL;
 527
 528         /* Is this a block of volatile registers? */
 529         for (i = 0; i < val_count; i++)
 530                 if (!regmap_volatile(map, reg + i))
 531                         vol = false;
 532
 533         if (vol || map->cache_type == REGCACHE_NONE) {
 534                 ret = regmap_raw_read(map, reg, val, val_bytes * val_count);
 535                 if (ret != 0)
 536                         return ret;
 537
 538                 for (i = 0; i < val_count * val_bytes; i += val_bytes)
 539                         map->format.parse_val(val + i);
 540         } else {
 541                 for (i = 0; i < val_count; i++) {
 542                         ret = regmap_read(map, reg + i, val + (i * val_bytes));
 543                         if (ret != 0)
 544                                 return ret;
 545                 }
 546         }
 547
 548         return 0;
 549 }
 550 EXPORT_SYMBOL_GPL(regmap_bulk_read);
 551
 552 /**
 553  * remap_update_bits: Perform a read/modify/write cycle on the register map
 554  *
 555  * @map: Register map to update
 556  * @reg: Register to update
 557  * @mask: Bitmask to change
 558  * @val: New value for bitmask
 559  *
 560  * Returns zero for success, a negative number on error.
 561  */
 562 int regmap_update_bits(struct regmap *map, unsigned int reg,
 563                        unsigned int mask, unsigned int val)
 564 {
 565         int ret;
 566         unsigned int tmp;
 567
 568         mutex_lock(&map->lock);
 569
 570         ret = _regmap_read(map, reg, &tmp);
 571         if (ret != 0)
 572                 goto out;
 573
 574         tmp &= ~mask;
 575         tmp |= val & mask;
 576
 577         ret = _regmap_write(map, reg, tmp);
 578
 579 out:
 580         mutex_unlock(&map->lock);
 581
 582         return ret;
 583 }
 584 EXPORT_SYMBOL_GPL(regmap_update_bits);
 585
 586 static int __init regmap_initcall(void)
 587 {
 588         regmap_debugfs_initcall();
 589
 590         return 0;
 591 }
 592 postcore_initcall(regmap_initcall);