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         if (config->read_flag_mask || config->write_flag_mask) {
 151                 map->read_flag_mask = config->read_flag_mask;
 152                 map->write_flag_mask = config->write_flag_mask;
 153         } else {
 154                 map->read_flag_mask = bus->read_flag_mask;
 155         }
 156
 157         switch (config->reg_bits) {
 158         case 4:
 159                 switch (config->val_bits) {
 160                 case 12:
 161                         map->format.format_write = regmap_format_4_12_write;
 162                         break;
 163                 default:
 164                         goto err_map;
 165                 }
 166                 break;
 167
 168         case 7:
 169                 switch (config->val_bits) {
 170                 case 9:
 171                         map->format.format_write = regmap_format_7_9_write;
 172                         break;
 173                 default:
 174                         goto err_map;
 175                 }
 176                 break;
 177
 178         case 8:
 179                 map->format.format_reg = regmap_format_8;
 180                 break;
 181
 182         case 16:
 183                 map->format.format_reg = regmap_format_16;
 184                 break;
 185
 186         default:
 187                 goto err_map;
 188         }
 189
 190         switch (config->val_bits) {
 191         case 8:
 192                 map->format.format_val = regmap_format_8;
 193                 map->format.parse_val = regmap_parse_8;
 194                 break;
 195         case 16:
 196                 map->format.format_val = regmap_format_16;
 197                 map->format.parse_val = regmap_parse_16;
 198                 break;
 199         }
 200
 201         if (!map->format.format_write &&
 202             !(map->format.format_reg && map->format.format_val))
 203                 goto err_map;
 204
 205         map->work_buf = kmalloc(map->format.buf_size, GFP_KERNEL);
 206         if (map->work_buf == NULL) {
 207                 ret = -ENOMEM;
 208                 goto err_map;
 209         }
 210
 211         regmap_debugfs_init(map);
 212
 213         return map;
 214
 215 err_map:
 216         kfree(map);
 217 err:
 218         return ERR_PTR(ret);
 219 }
 220 EXPORT_SYMBOL_GPL(regmap_init);
 221
 222 /**
 223  * regmap_exit(): Free a previously allocated register map
 224  */
 225 void regmap_exit(struct regmap *map)
 226 {
 227         regmap_debugfs_exit(map);
 228         kfree(map->work_buf);
 229         kfree(map);
 230 }
 231 EXPORT_SYMBOL_GPL(regmap_exit);
 232
 233 static int _regmap_raw_write(struct regmap *map, unsigned int reg,
 234                              const void *val, size_t val_len)
 235 {
 236         u8 *u8 = map->work_buf;
 237         void *buf;
 238         int ret = -ENOTSUPP;
 239         size_t len;
 240         int i;
 241
 242         /* Check for unwritable registers before we start */
 243         if (map->writeable_reg)
 244                 for (i = 0; i < val_len / map->format.val_bytes; i++)
 245                         if (!map->writeable_reg(map->dev, reg + i))
 246                                 return -EINVAL;
 247
 248         map->format.format_reg(map->work_buf, reg);
 249
 250         u8[0] |= map->write_flag_mask;
 251
 252         trace_regmap_hw_write_start(map->dev, reg,
 253                                     val_len / map->format.val_bytes);
 254
 255         /* If we're doing a single register write we can probably just
 256          * send the work_buf directly, otherwise try to do a gather
 257          * write.
 258          */
 259         if (val == map->work_buf + map->format.reg_bytes)
 260                 ret = map->bus->write(map->dev, map->work_buf,
 261                                       map->format.reg_bytes + val_len);
 262         else if (map->bus->gather_write)
 263                 ret = map->bus->gather_write(map->dev, map->work_buf,
 264                                              map->format.reg_bytes,
 265                                              val, val_len);
 266
 267         /* If that didn't work fall back on linearising by hand. */
 268         if (ret == -ENOTSUPP) {
 269                 len = map->format.reg_bytes + val_len;
 270                 buf = kmalloc(len, GFP_KERNEL);
 271                 if (!buf)
 272                         return -ENOMEM;
 273
 274                 memcpy(buf, map->work_buf, map->format.reg_bytes);
 275                 memcpy(buf + map->format.reg_bytes, val, val_len);
 276                 ret = map->bus->write(map->dev, buf, len);
 277
 278                 kfree(buf);
 279         }
 280
 281         trace_regmap_hw_write_done(map->dev, reg,
 282                                    val_len / map->format.val_bytes);
 283
 284         return ret;
 285 }
 286
 287 static int _regmap_write(struct regmap *map, unsigned int reg,
 288                          unsigned int val)
 289 {
 290         int ret;
 291         BUG_ON(!map->format.format_write && !map->format.format_val);
 292
 293         trace_regmap_reg_write(map->dev, reg, val);
 294
 295         if (map->format.format_write) {
 296                 map->format.format_write(map, reg, val);
 297
 298                 trace_regmap_hw_write_start(map->dev, reg, 1);
 299
 300                 ret = map->bus->write(map->dev, map->work_buf,
 301                                       map->format.buf_size);
 302
 303                 trace_regmap_hw_write_done(map->dev, reg, 1);
 304
 305                 return ret;
 306         } else {
 307                 map->format.format_val(map->work_buf + map->format.reg_bytes,
 308                                        val);
 309                 return _regmap_raw_write(map, reg,
 310                                          map->work_buf + map->format.reg_bytes,
 311                                          map->format.val_bytes);
 312         }
 313 }
 314
 315 /**
 316  * regmap_write(): Write a value to a single register
 317  *
 318  * @map: Register map to write to
 319  * @reg: Register to write to
 320  * @val: Value to be written
 321  *
 322  * A value of zero will be returned on success, a negative errno will
 323  * be returned in error cases.
 324  */
 325 int regmap_write(struct regmap *map, unsigned int reg, unsigned int val)
 326 {
 327         int ret;
 328
 329         mutex_lock(&map->lock);
 330
 331         ret = _regmap_write(map, reg, val);
 332
 333         mutex_unlock(&map->lock);
 334
 335         return ret;
 336 }
 337 EXPORT_SYMBOL_GPL(regmap_write);
 338
 339 /**
 340  * regmap_raw_write(): Write raw values to one or more registers
 341  *
 342  * @map: Register map to write to
 343  * @reg: Initial register to write to
 344  * @val: Block of data to be written, laid out for direct transmission to the
 345  *       device
 346  * @val_len: Length of data pointed to by val.
 347  *
 348  * This function is intended to be used for things like firmware
 349  * download where a large block of data needs to be transferred to the
 350  * device.  No formatting will be done on the data provided.
 351  *
 352  * A value of zero will be returned on success, a negative errno will
 353  * be returned in error cases.
 354  */
 355 int regmap_raw_write(struct regmap *map, unsigned int reg,
 356                      const void *val, size_t val_len)
 357 {
 358         int ret;
 359
 360         mutex_lock(&map->lock);
 361
 362         ret = _regmap_raw_write(map, reg, val, val_len);
 363
 364         mutex_unlock(&map->lock);
 365
 366         return ret;
 367 }
 368 EXPORT_SYMBOL_GPL(regmap_raw_write);
 369
 370 static int _regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
 371                             unsigned int val_len)
 372 {
 373         u8 *u8 = map->work_buf;
 374         int ret;
 375
 376         map->format.format_reg(map->work_buf, reg);
 377
 378         /*
 379          * Some buses or devices flag reads by setting the high bits in the
 380          * register addresss; since it's always the high bits for all
 381          * current formats we can do this here rather than in
 382          * formatting.  This may break if we get interesting formats.
 383          */
 384         u8[0] |= map->read_flag_mask;
 385
 386         trace_regmap_hw_read_start(map->dev, reg,
 387                                    val_len / map->format.val_bytes);
 388
 389         ret = map->bus->read(map->dev, map->work_buf, map->format.reg_bytes,
 390                              val, val_len);
 391
 392         trace_regmap_hw_read_done(map->dev, reg,
 393                                   val_len / map->format.val_bytes);
 394
 395         return ret;
 396 }
 397
 398 static int _regmap_read(struct regmap *map, unsigned int reg,
 399                         unsigned int *val)
 400 {
 401         int ret;
 402
 403         if (!map->format.parse_val)
 404                 return -EINVAL;
 405
 406         ret = _regmap_raw_read(map, reg, map->work_buf, map->format.val_bytes);
 407         if (ret == 0) {
 408                 *val = map->format.parse_val(map->work_buf);
 409                 trace_regmap_reg_read(map->dev, reg, *val);
 410         }
 411
 412         return ret;
 413 }
 414
 415 /**
 416  * regmap_read(): Read a value from a single register
 417  *
 418  * @map: Register map to write to
 419  * @reg: Register to be read from
 420  * @val: Pointer to store read value
 421  *
 422  * A value of zero will be returned on success, a negative errno will
 423  * be returned in error cases.
 424  */
 425 int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val)
 426 {
 427         int ret;
 428
 429         mutex_lock(&map->lock);
 430
 431         ret = _regmap_read(map, reg, val);
 432
 433         mutex_unlock(&map->lock);
 434
 435         return ret;
 436 }
 437 EXPORT_SYMBOL_GPL(regmap_read);
 438
 439 /**
 440  * regmap_raw_read(): Read raw data from the device
 441  *
 442  * @map: Register map to write to
 443  * @reg: First register to be read from
 444  * @val: Pointer to store read value
 445  * @val_len: Size of data to read
 446  *
 447  * A value of zero will be returned on success, a negative errno will
 448  * be returned in error cases.
 449  */
 450 int regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
 451                     size_t val_len)
 452 {
 453         int ret;
 454
 455         mutex_lock(&map->lock);
 456
 457         ret = _regmap_raw_read(map, reg, val, val_len);
 458
 459         mutex_unlock(&map->lock);
 460
 461         return ret;
 462 }
 463 EXPORT_SYMBOL_GPL(regmap_raw_read);
 464
 465 /**
 466  * regmap_bulk_read(): Read multiple registers from the device
 467  *
 468  * @map: Register map to write to
 469  * @reg: First register to be read from
 470  * @val: Pointer to store read value, in native register size for device
 471  * @val_count: Number of registers to read
 472  *
 473  * A value of zero will be returned on success, a negative errno will
 474  * be returned in error cases.
 475  */
 476 int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
 477                      size_t val_count)
 478 {
 479         int ret, i;
 480         size_t val_bytes = map->format.val_bytes;
 481
 482         if (!map->format.parse_val)
 483                 return -EINVAL;
 484
 485         ret = regmap_raw_read(map, reg, val, val_bytes * val_count);
 486         if (ret != 0)
 487                 return ret;
 488
 489         for (i = 0; i < val_count * val_bytes; i += val_bytes)
 490                 map->format.parse_val(val + i);
 491
 492         return 0;
 493 }
 494 EXPORT_SYMBOL_GPL(regmap_bulk_read);
 495
 496 /**
 497  * remap_update_bits: Perform a read/modify/write cycle on the register map
 498  *
 499  * @map: Register map to update
 500  * @reg: Register to update
 501  * @mask: Bitmask to change
 502  * @val: New value for bitmask
 503  *
 504  * Returns zero for success, a negative number on error.
 505  */
 506 int regmap_update_bits(struct regmap *map, unsigned int reg,
 507                        unsigned int mask, unsigned int val)
 508 {
 509         int ret;
 510         unsigned int tmp;
 511
 512         mutex_lock(&map->lock);
 513
 514         ret = _regmap_read(map, reg, &tmp);
 515         if (ret != 0)
 516                 goto out;
 517
 518         tmp &= ~mask;
 519         tmp |= val & mask;
 520
 521         ret = _regmap_write(map, reg, tmp);
 522
 523 out:
 524         mutex_unlock(&map->lock);
 525
 526         return ret;
 527 }
 528 EXPORT_SYMBOL_GPL(regmap_update_bits);
 529
 530 static int __init regmap_initcall(void)
 531 {
 532         regmap_debugfs_initcall();
 533
 534         return 0;
 535 }
 536 postcore_initcall(regmap_initcall);