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