drivers/nvmem/core.c

   1 /*
   2  * nvmem framework core.
   3  *
   4  * Copyright (C) 2015 Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
   5  * Copyright (C) 2013 Maxime Ripard <maxime.ripard@free-electrons.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License version 2 and
   9  * only version 2 as published by the Free Software Foundation.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  */
  16
  17 #include <linux/device.h>
  18 #include <linux/export.h>
  19 #include <linux/fs.h>
  20 #include <linux/idr.h>
  21 #include <linux/init.h>
  22 #include <linux/module.h>
  23 #include <linux/nvmem-consumer.h>
  24 #include <linux/nvmem-provider.h>
  25 #include <linux/of.h>
  26 #include <linux/slab.h>
  27
  28 struct nvmem_device {
  29         const char              *name;
  30         struct module           *owner;
  31         struct device           dev;
  32         int                     stride;
  33         int                     word_size;
  34         int                     ncells;
  35         int                     id;
  36         int                     users;
  37         size_t                  size;
  38         bool                    read_only;
  39         int                     flags;
  40         struct bin_attribute    eeprom;
  41         struct device           *base_dev;
  42         nvmem_reg_read_t        reg_read;
  43         nvmem_reg_write_t       reg_write;
  44         void *priv;
  45 };
  46
  47 #define FLAG_COMPAT             BIT(0)
  48
  49 struct nvmem_cell {
  50         const char              *name;
  51         int                     offset;
  52         int                     bytes;
  53         int                     bit_offset;
  54         int                     nbits;
  55         struct nvmem_device     *nvmem;
  56         struct list_head        node;
  57 };
  58
  59 static DEFINE_MUTEX(nvmem_mutex);
  60 static DEFINE_IDA(nvmem_ida);
  61
  62 static LIST_HEAD(nvmem_cells);
  63 static DEFINE_MUTEX(nvmem_cells_mutex);
  64
  65 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  66 static struct lock_class_key eeprom_lock_key;
  67 #endif
  68
  69 #define to_nvmem_device(d) container_of(d, struct nvmem_device, dev)
  70 static int nvmem_reg_read(struct nvmem_device *nvmem, unsigned int offset,
  71                           void *val, size_t bytes)
  72 {
  73         if (nvmem->reg_read)
  74                 return nvmem->reg_read(nvmem->priv, offset, val, bytes);
  75
  76         return -EINVAL;
  77 }
  78
  79 static int nvmem_reg_write(struct nvmem_device *nvmem, unsigned int offset,
  80                            void *val, size_t bytes)
  81 {
  82         if (nvmem->reg_write)
  83                 return nvmem->reg_write(nvmem->priv, offset, val, bytes);
  84
  85         return -EINVAL;
  86 }
  87
  88 static ssize_t bin_attr_nvmem_read(struct file *filp, struct kobject *kobj,
  89                                     struct bin_attribute *attr,
  90                                     char *buf, loff_t pos, size_t count)
  91 {
  92         struct device *dev;
  93         struct nvmem_device *nvmem;
  94         int rc;
  95
  96         if (attr->private)
  97                 dev = attr->private;
  98         else
  99                 dev = container_of(kobj, struct device, kobj);
 100         nvmem = to_nvmem_device(dev);
 101
 102         /* Stop the user from reading */
 103         if (pos >= nvmem->size)
 104                 return 0;
 105
 106         if (count < nvmem->word_size)
 107                 return -EINVAL;
 108
 109         if (pos + count > nvmem->size)
 110                 count = nvmem->size - pos;
 111
 112         count = round_down(count, nvmem->word_size);
 113
 114         rc = nvmem_reg_read(nvmem, pos, buf, count);
 115
 116         if (rc)
 117                 return rc;
 118
 119         return count;
 120 }
 121
 122 static ssize_t bin_attr_nvmem_write(struct file *filp, struct kobject *kobj,
 123                                      struct bin_attribute *attr,
 124                                      char *buf, loff_t pos, size_t count)
 125 {
 126         struct device *dev;
 127         struct nvmem_device *nvmem;
 128         int rc;
 129
 130         if (attr->private)
 131                 dev = attr->private;
 132         else
 133                 dev = container_of(kobj, struct device, kobj);
 134         nvmem = to_nvmem_device(dev);
 135
 136         /* Stop the user from writing */
 137         if (pos >= nvmem->size)
 138                 return 0;
 139
 140         if (count < nvmem->word_size)
 141                 return -EINVAL;
 142
 143         if (pos + count > nvmem->size)
 144                 count = nvmem->size - pos;
 145
 146         count = round_down(count, nvmem->word_size);
 147
 148         rc = nvmem_reg_write(nvmem, pos, buf, count);
 149
 150         if (rc)
 151                 return rc;
 152
 153         return count;
 154 }
 155
 156 /* default read/write permissions */
 157 static struct bin_attribute bin_attr_rw_nvmem = {
 158         .attr   = {
 159                 .name   = "nvmem",
 160                 .mode   = S_IWUSR | S_IRUGO,
 161         },
 162         .read   = bin_attr_nvmem_read,
 163         .write  = bin_attr_nvmem_write,
 164 };
 165
 166 static struct bin_attribute *nvmem_bin_rw_attributes[] = {
 167         &bin_attr_rw_nvmem,
 168         NULL,
 169 };
 170
 171 static const struct attribute_group nvmem_bin_rw_group = {
 172         .bin_attrs      = nvmem_bin_rw_attributes,
 173 };
 174
 175 static const struct attribute_group *nvmem_rw_dev_groups[] = {
 176         &nvmem_bin_rw_group,
 177         NULL,
 178 };
 179
 180 /* read only permission */
 181 static struct bin_attribute bin_attr_ro_nvmem = {
 182         .attr   = {
 183                 .name   = "nvmem",
 184                 .mode   = S_IRUGO,
 185         },
 186         .read   = bin_attr_nvmem_read,
 187 };
 188
 189 static struct bin_attribute *nvmem_bin_ro_attributes[] = {
 190         &bin_attr_ro_nvmem,
 191         NULL,
 192 };
 193
 194 static const struct attribute_group nvmem_bin_ro_group = {
 195         .bin_attrs      = nvmem_bin_ro_attributes,
 196 };
 197
 198 static const struct attribute_group *nvmem_ro_dev_groups[] = {
 199         &nvmem_bin_ro_group,
 200         NULL,
 201 };
 202
 203 /* default read/write permissions, root only */
 204 static struct bin_attribute bin_attr_rw_root_nvmem = {
 205         .attr   = {
 206                 .name   = "nvmem",
 207                 .mode   = S_IWUSR | S_IRUSR,
 208         },
 209         .read   = bin_attr_nvmem_read,
 210         .write  = bin_attr_nvmem_write,
 211 };
 212
 213 static struct bin_attribute *nvmem_bin_rw_root_attributes[] = {
 214         &bin_attr_rw_root_nvmem,
 215         NULL,
 216 };
 217
 218 static const struct attribute_group nvmem_bin_rw_root_group = {
 219         .bin_attrs      = nvmem_bin_rw_root_attributes,
 220 };
 221
 222 static const struct attribute_group *nvmem_rw_root_dev_groups[] = {
 223         &nvmem_bin_rw_root_group,
 224         NULL,
 225 };
 226
 227 /* read only permission, root only */
 228 static struct bin_attribute bin_attr_ro_root_nvmem = {
 229         .attr   = {
 230                 .name   = "nvmem",
 231                 .mode   = S_IRUSR,
 232         },
 233         .read   = bin_attr_nvmem_read,
 234 };
 235
 236 static struct bin_attribute *nvmem_bin_ro_root_attributes[] = {
 237         &bin_attr_ro_root_nvmem,
 238         NULL,
 239 };
 240
 241 static const struct attribute_group nvmem_bin_ro_root_group = {
 242         .bin_attrs      = nvmem_bin_ro_root_attributes,
 243 };
 244
 245 static const struct attribute_group *nvmem_ro_root_dev_groups[] = {
 246         &nvmem_bin_ro_root_group,
 247         NULL,
 248 };
 249
 250 static void nvmem_release(struct device *dev)
 251 {
 252         struct nvmem_device *nvmem = to_nvmem_device(dev);
 253
 254         ida_simple_remove(&nvmem_ida, nvmem->id);
 255         kfree(nvmem);
 256 }
 257
 258 static const struct device_type nvmem_provider_type = {
 259         .release        = nvmem_release,
 260 };
 261
 262 static struct bus_type nvmem_bus_type = {
 263         .name           = "nvmem",
 264 };
 265
 266 static int of_nvmem_match(struct device *dev, void *nvmem_np)
 267 {
 268         return dev->of_node == nvmem_np;
 269 }
 270
 271 static struct nvmem_device *of_nvmem_find(struct device_node *nvmem_np)
 272 {
 273         struct device *d;
 274
 275         if (!nvmem_np)
 276                 return NULL;
 277
 278         d = bus_find_device(&nvmem_bus_type, NULL, nvmem_np, of_nvmem_match);
 279
 280         if (!d)
 281                 return NULL;
 282
 283         return to_nvmem_device(d);
 284 }
 285
 286 static struct nvmem_cell *nvmem_find_cell(const char *cell_id)
 287 {
 288         struct nvmem_cell *p;
 289
 290         list_for_each_entry(p, &nvmem_cells, node)
 291                 if (p && !strcmp(p->name, cell_id))
 292                         return p;
 293
 294         return NULL;
 295 }
 296
 297 static void nvmem_cell_drop(struct nvmem_cell *cell)
 298 {
 299         mutex_lock(&nvmem_cells_mutex);
 300         list_del(&cell->node);
 301         mutex_unlock(&nvmem_cells_mutex);
 302         kfree(cell);
 303 }
 304
 305 static void nvmem_device_remove_all_cells(const struct nvmem_device *nvmem)
 306 {
 307         struct nvmem_cell *cell;
 308         struct list_head *p, *n;
 309
 310         list_for_each_safe(p, n, &nvmem_cells) {
 311                 cell = list_entry(p, struct nvmem_cell, node);
 312                 if (cell->nvmem == nvmem)
 313                         nvmem_cell_drop(cell);
 314         }
 315 }
 316
 317 static void nvmem_cell_add(struct nvmem_cell *cell)
 318 {
 319         mutex_lock(&nvmem_cells_mutex);
 320         list_add_tail(&cell->node, &nvmem_cells);
 321         mutex_unlock(&nvmem_cells_mutex);
 322 }
 323
 324 static int nvmem_cell_info_to_nvmem_cell(struct nvmem_device *nvmem,
 325                                    const struct nvmem_cell_info *info,
 326                                    struct nvmem_cell *cell)
 327 {
 328         cell->nvmem = nvmem;
 329         cell->offset = info->offset;
 330         cell->bytes = info->bytes;
 331         cell->name = info->name;
 332
 333         cell->bit_offset = info->bit_offset;
 334         cell->nbits = info->nbits;
 335
 336         if (cell->nbits)
 337                 cell->bytes = DIV_ROUND_UP(cell->nbits + cell->bit_offset,
 338                                            BITS_PER_BYTE);
 339
 340         if (!IS_ALIGNED(cell->offset, nvmem->stride)) {
 341                 dev_err(&nvmem->dev,
 342                         "cell %s unaligned to nvmem stride %d\n",
 343                         cell->name, nvmem->stride);
 344                 return -EINVAL;
 345         }
 346
 347         return 0;
 348 }
 349
 350 static int nvmem_add_cells(struct nvmem_device *nvmem,
 351                            const struct nvmem_config *cfg)
 352 {
 353         struct nvmem_cell **cells;
 354         const struct nvmem_cell_info *info = cfg->cells;
 355         int i, rval;
 356
 357         cells = kcalloc(cfg->ncells, sizeof(*cells), GFP_KERNEL);
 358         if (!cells)
 359                 return -ENOMEM;
 360
 361         for (i = 0; i < cfg->ncells; i++) {
 362                 cells[i] = kzalloc(sizeof(**cells), GFP_KERNEL);
 363                 if (!cells[i]) {
 364                         rval = -ENOMEM;
 365                         goto err;
 366                 }
 367
 368                 rval = nvmem_cell_info_to_nvmem_cell(nvmem, &info[i], cells[i]);
 369                 if (rval) {
 370                         kfree(cells[i]);
 371                         goto err;
 372                 }
 373
 374                 nvmem_cell_add(cells[i]);
 375         }
 376
 377         nvmem->ncells = cfg->ncells;
 378         /* remove tmp array */
 379         kfree(cells);
 380
 381         return 0;
 382 err:
 383         while (i--)
 384                 nvmem_cell_drop(cells[i]);
 385
 386         kfree(cells);
 387
 388         return rval;
 389 }
 390
 391 /*
 392  * nvmem_setup_compat() - Create an additional binary entry in
 393  * drivers sys directory, to be backwards compatible with the older
 394  * drivers/misc/eeprom drivers.
 395  */
 396 static int nvmem_setup_compat(struct nvmem_device *nvmem,
 397                               const struct nvmem_config *config)
 398 {
 399         int rval;
 400
 401         if (!config->base_dev)
 402                 return -EINVAL;
 403
 404         if (nvmem->read_only) {
 405                 if (config->root_only)
 406                         nvmem->eeprom = bin_attr_ro_root_nvmem;
 407                 else
 408                         nvmem->eeprom = bin_attr_ro_nvmem;
 409         } else {
 410                 if (config->root_only)
 411                         nvmem->eeprom = bin_attr_rw_root_nvmem;
 412                 else
 413                         nvmem->eeprom = bin_attr_rw_nvmem;
 414         }
 415         nvmem->eeprom.attr.name = "eeprom";
 416         nvmem->eeprom.size = nvmem->size;
 417 #ifdef CONFIG_DEBUG_LOCK_ALLOC
 418         nvmem->eeprom.attr.key = &eeprom_lock_key;
 419 #endif
 420         nvmem->eeprom.private = &nvmem->dev;
 421         nvmem->base_dev = config->base_dev;
 422
 423         rval = device_create_bin_file(nvmem->base_dev, &nvmem->eeprom);
 424         if (rval) {
 425                 dev_err(&nvmem->dev,
 426                         "Failed to create eeprom binary file %d\n", rval);
 427                 return rval;
 428         }
 429
 430         nvmem->flags |= FLAG_COMPAT;
 431
 432         return 0;
 433 }
 434
 435 /**
 436  * nvmem_register() - Register a nvmem device for given nvmem_config.
 437  * Also creates an binary entry in /sys/bus/nvmem/devices/dev-name/nvmem
 438  *
 439  * @config: nvmem device configuration with which nvmem device is created.
 440  *
 441  * Return: Will be an ERR_PTR() on error or a valid pointer to nvmem_device
 442  * on success.
 443  */
 444
 445 struct nvmem_device *nvmem_register(const struct nvmem_config *config)
 446 {
 447         struct nvmem_device *nvmem;
 448         struct device_node *np;
 449         int rval;
 450
 451         if (!config->dev)
 452                 return ERR_PTR(-EINVAL);
 453
 454         nvmem = kzalloc(sizeof(*nvmem), GFP_KERNEL);
 455         if (!nvmem)
 456                 return ERR_PTR(-ENOMEM);
 457
 458         rval  = ida_simple_get(&nvmem_ida, 0, 0, GFP_KERNEL);
 459         if (rval < 0) {
 460                 kfree(nvmem);
 461                 return ERR_PTR(rval);
 462         }
 463
 464         nvmem->id = rval;
 465         nvmem->owner = config->owner;
 466         nvmem->stride = config->stride;
 467         nvmem->word_size = config->word_size;
 468         nvmem->size = config->size;
 469         nvmem->dev.type = &nvmem_provider_type;
 470         nvmem->dev.bus = &nvmem_bus_type;
 471         nvmem->dev.parent = config->dev;
 472         nvmem->priv = config->priv;
 473         nvmem->reg_read = config->reg_read;
 474         nvmem->reg_write = config->reg_write;
 475         np = config->dev->of_node;
 476         nvmem->dev.of_node = np;
 477         dev_set_name(&nvmem->dev, "%s%d",
 478                      config->name ? : "nvmem", config->id);
 479
 480         nvmem->read_only = of_property_read_bool(np, "read-only") |
 481                            config->read_only;
 482
 483         if (config->root_only)
 484                 nvmem->dev.groups = nvmem->read_only ?
 485                         nvmem_ro_root_dev_groups :
 486                         nvmem_rw_root_dev_groups;
 487         else
 488                 nvmem->dev.groups = nvmem->read_only ?
 489                         nvmem_ro_dev_groups :
 490                         nvmem_rw_dev_groups;
 491
 492         device_initialize(&nvmem->dev);
 493
 494         dev_dbg(&nvmem->dev, "Registering nvmem device %s\n", config->name);
 495
 496         rval = device_add(&nvmem->dev);
 497         if (rval)
 498                 goto err_put_device;
 499
 500         if (config->compat) {
 501                 rval = nvmem_setup_compat(nvmem, config);
 502                 if (rval)
 503                         goto err_device_del;
 504         }
 505
 506         if (config->cells)
 507                 nvmem_add_cells(nvmem, config);
 508
 509         return nvmem;
 510
 511 err_device_del:
 512         device_del(&nvmem->dev);
 513 err_put_device:
 514         put_device(&nvmem->dev);
 515
 516         return ERR_PTR(rval);
 517 }
 518 EXPORT_SYMBOL_GPL(nvmem_register);
 519
 520 /**
 521  * nvmem_unregister() - Unregister previously registered nvmem device
 522  *
 523  * @nvmem: Pointer to previously registered nvmem device.
 524  *
 525  * Return: Will be an negative on error or a zero on success.
 526  */
 527 int nvmem_unregister(struct nvmem_device *nvmem)
 528 {
 529         mutex_lock(&nvmem_mutex);
 530         if (nvmem->users) {
 531                 mutex_unlock(&nvmem_mutex);
 532                 return -EBUSY;
 533         }
 534         mutex_unlock(&nvmem_mutex);
 535
 536         if (nvmem->flags & FLAG_COMPAT)
 537                 device_remove_bin_file(nvmem->base_dev, &nvmem->eeprom);
 538
 539         nvmem_device_remove_all_cells(nvmem);
 540         device_del(&nvmem->dev);
 541
 542         return 0;
 543 }
 544 EXPORT_SYMBOL_GPL(nvmem_unregister);
 545
 546 static struct nvmem_device *__nvmem_device_get(struct device_node *np,
 547                                                struct nvmem_cell **cellp,
 548                                                const char *cell_id)
 549 {
 550         struct nvmem_device *nvmem = NULL;
 551
 552         mutex_lock(&nvmem_mutex);
 553
 554         if (np) {
 555                 nvmem = of_nvmem_find(np);
 556                 if (!nvmem) {
 557                         mutex_unlock(&nvmem_mutex);
 558                         return ERR_PTR(-EPROBE_DEFER);
 559                 }
 560         } else {
 561                 struct nvmem_cell *cell = nvmem_find_cell(cell_id);
 562
 563                 if (cell) {
 564                         nvmem = cell->nvmem;
 565                         *cellp = cell;
 566                 }
 567
 568                 if (!nvmem) {
 569                         mutex_unlock(&nvmem_mutex);
 570                         return ERR_PTR(-ENOENT);
 571                 }
 572         }
 573
 574         nvmem->users++;
 575         mutex_unlock(&nvmem_mutex);
 576
 577         if (!try_module_get(nvmem->owner)) {
 578                 dev_err(&nvmem->dev,
 579                         "could not increase module refcount for cell %s\n",
 580                         nvmem->name);
 581
 582                 mutex_lock(&nvmem_mutex);
 583                 nvmem->users--;
 584                 mutex_unlock(&nvmem_mutex);
 585
 586                 return ERR_PTR(-EINVAL);
 587         }
 588
 589         return nvmem;
 590 }
 591
 592 static void __nvmem_device_put(struct nvmem_device *nvmem)
 593 {
 594         module_put(nvmem->owner);
 595         mutex_lock(&nvmem_mutex);
 596         nvmem->users--;
 597         mutex_unlock(&nvmem_mutex);
 598 }
 599
 600 static int nvmem_match(struct device *dev, void *data)
 601 {
 602         return !strcmp(dev_name(dev), data);
 603 }
 604
 605 static struct nvmem_device *nvmem_find(const char *name)
 606 {
 607         struct device *d;
 608
 609         d = bus_find_device(&nvmem_bus_type, NULL, (void *)name, nvmem_match);
 610
 611         if (!d)
 612                 return ERR_PTR(-ENOENT);
 613
 614         return to_nvmem_device(d);
 615 }
 616
 617 #if IS_ENABLED(CONFIG_NVMEM) && IS_ENABLED(CONFIG_OF)
 618 /**
 619  * of_nvmem_device_get() - Get nvmem device from a given id
 620  *
 621  * @dev node: Device tree node that uses the nvmem device
 622  * @id: nvmem name from nvmem-names property.
 623  *
 624  * Return: ERR_PTR() on error or a valid pointer to a struct nvmem_device
 625  * on success.
 626  */
 627 struct nvmem_device *of_nvmem_device_get(struct device_node *np, const char *id)
 628 {
 629
 630         struct device_node *nvmem_np;
 631         int index;
 632
 633         index = of_property_match_string(np, "nvmem-names", id);
 634
 635         nvmem_np = of_parse_phandle(np, "nvmem", index);
 636         if (!nvmem_np)
 637                 return ERR_PTR(-EINVAL);
 638
 639         return __nvmem_device_get(nvmem_np, NULL, NULL);
 640 }
 641 EXPORT_SYMBOL_GPL(of_nvmem_device_get);
 642 #endif
 643
 644 /**
 645  * nvmem_device_get() - Get nvmem device from a given id
 646  *
 647  * @dev : Device that uses the nvmem device
 648  * @id: nvmem name from nvmem-names property.
 649  *
 650  * Return: ERR_PTR() on error or a valid pointer to a struct nvmem_device
 651  * on success.
 652  */
 653 struct nvmem_device *nvmem_device_get(struct device *dev, const char *dev_name)
 654 {
 655         if (dev->of_node) { /* try dt first */
 656                 struct nvmem_device *nvmem;
 657
 658                 nvmem = of_nvmem_device_get(dev->of_node, dev_name);
 659
 660                 if (!IS_ERR(nvmem) || PTR_ERR(nvmem) == -EPROBE_DEFER)
 661                         return nvmem;
 662
 663         }
 664
 665         return nvmem_find(dev_name);
 666 }
 667 EXPORT_SYMBOL_GPL(nvmem_device_get);
 668
 669 static int devm_nvmem_device_match(struct device *dev, void *res, void *data)
 670 {
 671         struct nvmem_device **nvmem = res;
 672
 673         if (WARN_ON(!nvmem || !*nvmem))
 674                 return 0;
 675
 676         return *nvmem == data;
 677 }
 678
 679 static void devm_nvmem_device_release(struct device *dev, void *res)
 680 {
 681         nvmem_device_put(*(struct nvmem_device **)res);
 682 }
 683
 684 /**
 685  * devm_nvmem_device_put() - put alredy got nvmem device
 686  *
 687  * @nvmem: pointer to nvmem device allocated by devm_nvmem_cell_get(),
 688  * that needs to be released.
 689  */
 690 void devm_nvmem_device_put(struct device *dev, struct nvmem_device *nvmem)
 691 {
 692         int ret;
 693
 694         ret = devres_release(dev, devm_nvmem_device_release,
 695                              devm_nvmem_device_match, nvmem);
 696
 697         WARN_ON(ret);
 698 }
 699 EXPORT_SYMBOL_GPL(devm_nvmem_device_put);
 700
 701 /**
 702  * nvmem_device_put() - put alredy got nvmem device
 703  *
 704  * @nvmem: pointer to nvmem device that needs to be released.
 705  */
 706 void nvmem_device_put(struct nvmem_device *nvmem)
 707 {
 708         __nvmem_device_put(nvmem);
 709 }
 710 EXPORT_SYMBOL_GPL(nvmem_device_put);
 711
 712 /**
 713  * devm_nvmem_device_get() - Get nvmem cell of device form a given id
 714  *
 715  * @dev node: Device tree node that uses the nvmem cell
 716  * @id: nvmem name in nvmems property.
 717  *
 718  * Return: ERR_PTR() on error or a valid pointer to a struct nvmem_cell
 719  * on success.  The nvmem_cell will be freed by the automatically once the
 720  * device is freed.
 721  */
 722 struct nvmem_device *devm_nvmem_device_get(struct device *dev, const char *id)
 723 {
 724         struct nvmem_device **ptr, *nvmem;
 725
 726         ptr = devres_alloc(devm_nvmem_device_release, sizeof(*ptr), GFP_KERNEL);
 727         if (!ptr)
 728                 return ERR_PTR(-ENOMEM);
 729
 730         nvmem = nvmem_device_get(dev, id);
 731         if (!IS_ERR(nvmem)) {
 732                 *ptr = nvmem;
 733                 devres_add(dev, ptr);
 734         } else {
 735                 devres_free(ptr);
 736         }
 737
 738         return nvmem;
 739 }
 740 EXPORT_SYMBOL_GPL(devm_nvmem_device_get);
 741
 742 static struct nvmem_cell *nvmem_cell_get_from_list(const char *cell_id)
 743 {
 744         struct nvmem_cell *cell = NULL;
 745         struct nvmem_device *nvmem;
 746
 747         nvmem = __nvmem_device_get(NULL, &cell, cell_id);
 748         if (IS_ERR(nvmem))
 749                 return ERR_CAST(nvmem);
 750
 751         return cell;
 752 }
 753
 754 #if IS_ENABLED(CONFIG_NVMEM) && IS_ENABLED(CONFIG_OF)
 755 /**
 756  * of_nvmem_cell_get() - Get a nvmem cell from given device node and cell id
 757  *
 758  * @dev node: Device tree node that uses the nvmem cell
 759  * @id: nvmem cell name from nvmem-cell-names property.
 760  *
 761  * Return: Will be an ERR_PTR() on error or a valid pointer
 762  * to a struct nvmem_cell.  The nvmem_cell will be freed by the
 763  * nvmem_cell_put().
 764  */
 765 struct nvmem_cell *of_nvmem_cell_get(struct device_node *np,
 766                                             const char *name)
 767 {
 768         struct device_node *cell_np, *nvmem_np;
 769         struct nvmem_cell *cell;
 770         struct nvmem_device *nvmem;
 771         const __be32 *addr;
 772         int rval, len, index;
 773
 774         index = of_property_match_string(np, "nvmem-cell-names", name);
 775
 776         cell_np = of_parse_phandle(np, "nvmem-cells", index);
 777         if (!cell_np)
 778                 return ERR_PTR(-EINVAL);
 779
 780         nvmem_np = of_get_next_parent(cell_np);
 781         if (!nvmem_np)
 782                 return ERR_PTR(-EINVAL);
 783
 784         nvmem = __nvmem_device_get(nvmem_np, NULL, NULL);
 785         if (IS_ERR(nvmem))
 786                 return ERR_CAST(nvmem);
 787
 788         addr = of_get_property(cell_np, "reg", &len);
 789         if (!addr || (len < 2 * sizeof(u32))) {
 790                 dev_err(&nvmem->dev, "nvmem: invalid reg on %s\n",
 791                         cell_np->full_name);
 792                 rval  = -EINVAL;
 793                 goto err_mem;
 794         }
 795
 796         cell = kzalloc(sizeof(*cell), GFP_KERNEL);
 797         if (!cell) {
 798                 rval = -ENOMEM;
 799                 goto err_mem;
 800         }
 801
 802         cell->nvmem = nvmem;
 803         cell->offset = be32_to_cpup(addr++);
 804         cell->bytes = be32_to_cpup(addr);
 805         cell->name = cell_np->name;
 806
 807         addr = of_get_property(cell_np, "bits", &len);
 808         if (addr && len == (2 * sizeof(u32))) {
 809                 cell->bit_offset = be32_to_cpup(addr++);
 810                 cell->nbits = be32_to_cpup(addr);
 811         }
 812
 813         if (cell->nbits)
 814                 cell->bytes = DIV_ROUND_UP(cell->nbits + cell->bit_offset,
 815                                            BITS_PER_BYTE);
 816
 817         if (!IS_ALIGNED(cell->offset, nvmem->stride)) {
 818                         dev_err(&nvmem->dev,
 819                                 "cell %s unaligned to nvmem stride %d\n",
 820                                 cell->name, nvmem->stride);
 821                 rval  = -EINVAL;
 822                 goto err_sanity;
 823         }
 824
 825         nvmem_cell_add(cell);
 826
 827         return cell;
 828
 829 err_sanity:
 830         kfree(cell);
 831
 832 err_mem:
 833         __nvmem_device_put(nvmem);
 834
 835         return ERR_PTR(rval);
 836 }
 837 EXPORT_SYMBOL_GPL(of_nvmem_cell_get);
 838 #endif
 839
 840 /**
 841  * nvmem_cell_get() - Get nvmem cell of device form a given cell name
 842  *
 843  * @dev node: Device tree node that uses the nvmem cell
 844  * @id: nvmem cell name to get.
 845  *
 846  * Return: Will be an ERR_PTR() on error or a valid pointer
 847  * to a struct nvmem_cell.  The nvmem_cell will be freed by the
 848  * nvmem_cell_put().
 849  */
 850 struct nvmem_cell *nvmem_cell_get(struct device *dev, const char *cell_id)
 851 {
 852         struct nvmem_cell *cell;
 853
 854         if (dev->of_node) { /* try dt first */
 855                 cell = of_nvmem_cell_get(dev->of_node, cell_id);
 856                 if (!IS_ERR(cell) || PTR_ERR(cell) == -EPROBE_DEFER)
 857                         return cell;
 858         }
 859
 860         return nvmem_cell_get_from_list(cell_id);
 861 }
 862 EXPORT_SYMBOL_GPL(nvmem_cell_get);
 863
 864 static void devm_nvmem_cell_release(struct device *dev, void *res)
 865 {
 866         nvmem_cell_put(*(struct nvmem_cell **)res);
 867 }
 868
 869 /**
 870  * devm_nvmem_cell_get() - Get nvmem cell of device form a given id
 871  *
 872  * @dev node: Device tree node that uses the nvmem cell
 873  * @id: nvmem id in nvmem-names property.
 874  *
 875  * Return: Will be an ERR_PTR() on error or a valid pointer
 876  * to a struct nvmem_cell.  The nvmem_cell will be freed by the
 877  * automatically once the device is freed.
 878  */
 879 struct nvmem_cell *devm_nvmem_cell_get(struct device *dev, const char *id)
 880 {
 881         struct nvmem_cell **ptr, *cell;
 882
 883         ptr = devres_alloc(devm_nvmem_cell_release, sizeof(*ptr), GFP_KERNEL);
 884         if (!ptr)
 885                 return ERR_PTR(-ENOMEM);
 886
 887         cell = nvmem_cell_get(dev, id);
 888         if (!IS_ERR(cell)) {
 889                 *ptr = cell;
 890                 devres_add(dev, ptr);
 891         } else {
 892                 devres_free(ptr);
 893         }
 894
 895         return cell;
 896 }
 897 EXPORT_SYMBOL_GPL(devm_nvmem_cell_get);
 898
 899 static int devm_nvmem_cell_match(struct device *dev, void *res, void *data)
 900 {
 901         struct nvmem_cell **c = res;
 902
 903         if (WARN_ON(!c || !*c))
 904                 return 0;
 905
 906         return *c == data;
 907 }
 908
 909 /**
 910  * devm_nvmem_cell_put() - Release previously allocated nvmem cell
 911  * from devm_nvmem_cell_get.
 912  *
 913  * @cell: Previously allocated nvmem cell by devm_nvmem_cell_get()
 914  */
 915 void devm_nvmem_cell_put(struct device *dev, struct nvmem_cell *cell)
 916 {
 917         int ret;
 918
 919         ret = devres_release(dev, devm_nvmem_cell_release,
 920                                 devm_nvmem_cell_match, cell);
 921
 922         WARN_ON(ret);
 923 }
 924 EXPORT_SYMBOL(devm_nvmem_cell_put);
 925
 926 /**
 927  * nvmem_cell_put() - Release previously allocated nvmem cell.
 928  *
 929  * @cell: Previously allocated nvmem cell by nvmem_cell_get()
 930  */
 931 void nvmem_cell_put(struct nvmem_cell *cell)
 932 {
 933         struct nvmem_device *nvmem = cell->nvmem;
 934
 935         __nvmem_device_put(nvmem);
 936         nvmem_cell_drop(cell);
 937 }
 938 EXPORT_SYMBOL_GPL(nvmem_cell_put);
 939
 940 static inline void nvmem_shift_read_buffer_in_place(struct nvmem_cell *cell,
 941                                                     void *buf)
 942 {
 943         u8 *p, *b;
 944         int i, extra, bit_offset = cell->bit_offset;
 945
 946         p = b = buf;
 947         if (bit_offset) {
 948                 /* First shift */
 949                 *b++ >>= bit_offset;
 950
 951                 /* setup rest of the bytes if any */
 952                 for (i = 1; i < cell->bytes; i++) {
 953                         /* Get bits from next byte and shift them towards msb */
 954                         *p |= *b << (BITS_PER_BYTE - bit_offset);
 955
 956                         p = b;
 957                         *b++ >>= bit_offset;
 958                 }
 959         } else {
 960                 /* point to the msb */
 961                 p += cell->bytes - 1;
 962         }
 963
 964         /* result fits in less bytes */
 965         extra = cell->bytes - DIV_ROUND_UP(cell->nbits, BITS_PER_BYTE);
 966         while (--extra >= 0)
 967                 *p-- = 0;
 968
 969         /* clear msb bits if any leftover in the last byte */
 970         if (cell->nbits % BITS_PER_BYTE)
 971                 *p &= GENMASK((cell->nbits % BITS_PER_BYTE) - 1, 0);
 972 }
 973
 974 static int __nvmem_cell_read(struct nvmem_device *nvmem,
 975                       struct nvmem_cell *cell,
 976                       void *buf, size_t *len)
 977 {
 978         int rc;
 979
 980         rc = nvmem_reg_read(nvmem, cell->offset, buf, cell->bytes);
 981
 982         if (rc)
 983                 return rc;
 984
 985         /* shift bits in-place */
 986         if (cell->bit_offset || cell->nbits)
 987                 nvmem_shift_read_buffer_in_place(cell, buf);
 988
 989         *len = cell->bytes;
 990
 991         return 0;
 992 }
 993
 994 /**
 995  * nvmem_cell_read() - Read a given nvmem cell
 996  *
 997  * @cell: nvmem cell to be read.
 998  * @len: pointer to length of cell which will be populated on successful read.
 999  *
1000  * Return: ERR_PTR() on error or a valid pointer to a char * buffer on success.
1001  * The buffer should be freed by the consumer with a kfree().
1002  */
1003 void *nvmem_cell_read(struct nvmem_cell *cell, size_t *len)
1004 {
1005         struct nvmem_device *nvmem = cell->nvmem;
1006         u8 *buf;
1007         int rc;
1008
1009         if (!nvmem)
1010                 return ERR_PTR(-EINVAL);
1011
1012         buf = kzalloc(cell->bytes, GFP_KERNEL);
1013         if (!buf)
1014                 return ERR_PTR(-ENOMEM);
1015
1016         rc = __nvmem_cell_read(nvmem, cell, buf, len);
1017         if (rc) {
1018                 kfree(buf);
1019                 return ERR_PTR(rc);
1020         }
1021
1022         return buf;
1023 }
1024 EXPORT_SYMBOL_GPL(nvmem_cell_read);
1025
1026 static inline void *nvmem_cell_prepare_write_buffer(struct nvmem_cell *cell,
1027                                                     u8 *_buf, int len)
1028 {
1029         struct nvmem_device *nvmem = cell->nvmem;
1030         int i, rc, nbits, bit_offset = cell->bit_offset;
1031         u8 v, *p, *buf, *b, pbyte, pbits;
1032
1033         nbits = cell->nbits;
1034         buf = kzalloc(cell->bytes, GFP_KERNEL);
1035         if (!buf)
1036                 return ERR_PTR(-ENOMEM);
1037
1038         memcpy(buf, _buf, len);
1039         p = b = buf;
1040
1041         if (bit_offset) {
1042                 pbyte = *b;
1043                 *b <<= bit_offset;
1044
1045                 /* setup the first byte with lsb bits from nvmem */
1046                 rc = nvmem_reg_read(nvmem, cell->offset, &v, 1);
1047                 if (rc)
1048                         goto err;
1049                 *b++ |= GENMASK(bit_offset - 1, 0) & v;
1050
1051                 /* setup rest of the byte if any */
1052                 for (i = 1; i < cell->bytes; i++) {
1053                         /* Get last byte bits and shift them towards lsb */
1054                         pbits = pbyte >> (BITS_PER_BYTE - 1 - bit_offset);
1055                         pbyte = *b;
1056                         p = b;
1057                         *b <<= bit_offset;
1058                         *b++ |= pbits;
1059                 }
1060         }
1061
1062         /* if it's not end on byte boundary */
1063         if ((nbits + bit_offset) % BITS_PER_BYTE) {
1064                 /* setup the last byte with msb bits from nvmem */
1065                 rc = nvmem_reg_read(nvmem,
1066                                     cell->offset + cell->bytes - 1, &v, 1);
1067                 if (rc)
1068                         goto err;
1069                 *p |= GENMASK(7, (nbits + bit_offset) % BITS_PER_BYTE) & v;
1070
1071         }
1072
1073         return buf;
1074 err:
1075         kfree(buf);
1076         return ERR_PTR(rc);
1077 }
1078
1079 /**
1080  * nvmem_cell_write() - Write to a given nvmem cell
1081  *
1082  * @cell: nvmem cell to be written.
1083  * @buf: Buffer to be written.
1084  * @len: length of buffer to be written to nvmem cell.
1085  *
1086  * Return: length of bytes written or negative on failure.
1087  */
1088 int nvmem_cell_write(struct nvmem_cell *cell, void *buf, size_t len)
1089 {
1090         struct nvmem_device *nvmem = cell->nvmem;
1091         int rc;
1092
1093         if (!nvmem || nvmem->read_only ||
1094             (cell->bit_offset == 0 && len != cell->bytes))
1095                 return -EINVAL;
1096
1097         if (cell->bit_offset || cell->nbits) {
1098                 buf = nvmem_cell_prepare_write_buffer(cell, buf, len);
1099                 if (IS_ERR(buf))
1100                         return PTR_ERR(buf);
1101         }
1102
1103         rc = nvmem_reg_write(nvmem, cell->offset, buf, cell->bytes);
1104
1105         /* free the tmp buffer */
1106         if (cell->bit_offset || cell->nbits)
1107                 kfree(buf);
1108
1109         if (rc)
1110                 return rc;
1111
1112         return len;
1113 }
1114 EXPORT_SYMBOL_GPL(nvmem_cell_write);
1115
1116 /**
1117  * nvmem_device_cell_read() - Read a given nvmem device and cell
1118  *
1119  * @nvmem: nvmem device to read from.
1120  * @info: nvmem cell info to be read.
1121  * @buf: buffer pointer which will be populated on successful read.
1122  *
1123  * Return: length of successful bytes read on success and negative
1124  * error code on error.
1125  */
1126 ssize_t nvmem_device_cell_read(struct nvmem_device *nvmem,
1127                            struct nvmem_cell_info *info, void *buf)
1128 {
1129         struct nvmem_cell cell;
1130         int rc;
1131         ssize_t len;
1132
1133         if (!nvmem)
1134                 return -EINVAL;
1135
1136         rc = nvmem_cell_info_to_nvmem_cell(nvmem, info, &cell);
1137         if (rc)
1138                 return rc;
1139
1140         rc = __nvmem_cell_read(nvmem, &cell, buf, &len);
1141         if (rc)
1142                 return rc;
1143
1144         return len;
1145 }
1146 EXPORT_SYMBOL_GPL(nvmem_device_cell_read);
1147
1148 /**
1149  * nvmem_device_cell_write() - Write cell to a given nvmem device
1150  *
1151  * @nvmem: nvmem device to be written to.
1152  * @info: nvmem cell info to be written
1153  * @buf: buffer to be written to cell.
1154  *
1155  * Return: length of bytes written or negative error code on failure.
1156  * */
1157 int nvmem_device_cell_write(struct nvmem_device *nvmem,
1158                             struct nvmem_cell_info *info, void *buf)
1159 {
1160         struct nvmem_cell cell;
1161         int rc;
1162
1163         if (!nvmem)
1164                 return -EINVAL;
1165
1166         rc = nvmem_cell_info_to_nvmem_cell(nvmem, info, &cell);
1167         if (rc)
1168                 return rc;
1169
1170         return nvmem_cell_write(&cell, buf, cell.bytes);
1171 }
1172 EXPORT_SYMBOL_GPL(nvmem_device_cell_write);
1173
1174 /**
1175  * nvmem_device_read() - Read from a given nvmem device
1176  *
1177  * @nvmem: nvmem device to read from.
1178  * @offset: offset in nvmem device.
1179  * @bytes: number of bytes to read.
1180  * @buf: buffer pointer which will be populated on successful read.
1181  *
1182  * Return: length of successful bytes read on success and negative
1183  * error code on error.
1184  */
1185 int nvmem_device_read(struct nvmem_device *nvmem,
1186                       unsigned int offset,
1187                       size_t bytes, void *buf)
1188 {
1189         int rc;
1190
1191         if (!nvmem)
1192                 return -EINVAL;
1193
1194         rc = nvmem_reg_read(nvmem, offset, buf, bytes);
1195
1196         if (rc)
1197                 return rc;
1198
1199         return bytes;
1200 }
1201 EXPORT_SYMBOL_GPL(nvmem_device_read);
1202
1203 /**
1204  * nvmem_device_write() - Write cell to a given nvmem device
1205  *
1206  * @nvmem: nvmem device to be written to.
1207  * @offset: offset in nvmem device.
1208  * @bytes: number of bytes to write.
1209  * @buf: buffer to be written.
1210  *
1211  * Return: length of bytes written or negative error code on failure.
1212  * */
1213 int nvmem_device_write(struct nvmem_device *nvmem,
1214                        unsigned int offset,
1215                        size_t bytes, void *buf)
1216 {
1217         int rc;
1218
1219         if (!nvmem)
1220                 return -EINVAL;
1221
1222         rc = nvmem_reg_write(nvmem, offset, buf, bytes);
1223
1224         if (rc)
1225                 return rc;
1226
1227
1228         return bytes;
1229 }
1230 EXPORT_SYMBOL_GPL(nvmem_device_write);
1231
1232 static int __init nvmem_init(void)
1233 {
1234         return bus_register(&nvmem_bus_type);
1235 }
1236
1237 static void __exit nvmem_exit(void)
1238 {
1239         bus_unregister(&nvmem_bus_type);
1240 }
1241
1242 subsys_initcall(nvmem_init);
1243 module_exit(nvmem_exit);
1244
1245 MODULE_AUTHOR("Srinivas Kandagatla <srinivas.kandagatla@linaro.org");
1246 MODULE_AUTHOR("Maxime Ripard <maxime.ripard@free-electrons.com");
1247 MODULE_DESCRIPTION("nvmem Driver Core");
1248 MODULE_LICENSE("GPL v2");