Pileus Git - ~andy/linux/blob - drivers/mtd/mtdcore.c

   1 /*
   2  * Core registration and callback routines for MTD
   3  * drivers and users.
   4  *
   5  * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org>
   6  * Copyright © 2006      Red Hat UK Limited
   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 as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  21  *
  22  */
  23
  24 #include <linux/module.h>
  25 #include <linux/kernel.h>
  26 #include <linux/ptrace.h>
  27 #include <linux/seq_file.h>
  28 #include <linux/string.h>
  29 #include <linux/timer.h>
  30 #include <linux/major.h>
  31 #include <linux/fs.h>
  32 #include <linux/err.h>
  33 #include <linux/ioctl.h>
  34 #include <linux/init.h>
  35 #include <linux/proc_fs.h>
  36 #include <linux/idr.h>
  37 #include <linux/backing-dev.h>
  38 #include <linux/gfp.h>
  39
  40 #include <linux/mtd/mtd.h>
  41 #include <linux/mtd/partitions.h>
  42
  43 #include "mtdcore.h"
  44
  45 /*
  46  * backing device capabilities for non-mappable devices (such as NAND flash)
  47  * - permits private mappings, copies are taken of the data
  48  */
  49 static struct backing_dev_info mtd_bdi_unmappable = {
  50         .capabilities   = BDI_CAP_MAP_COPY,
  51 };
  52
  53 /*
  54  * backing device capabilities for R/O mappable devices (such as ROM)
  55  * - permits private mappings, copies are taken of the data
  56  * - permits non-writable shared mappings
  57  */
  58 static struct backing_dev_info mtd_bdi_ro_mappable = {
  59         .capabilities   = (BDI_CAP_MAP_COPY | BDI_CAP_MAP_DIRECT |
  60                            BDI_CAP_EXEC_MAP | BDI_CAP_READ_MAP),
  61 };
  62
  63 /*
  64  * backing device capabilities for writable mappable devices (such as RAM)
  65  * - permits private mappings, copies are taken of the data
  66  * - permits non-writable shared mappings
  67  */
  68 static struct backing_dev_info mtd_bdi_rw_mappable = {
  69         .capabilities   = (BDI_CAP_MAP_COPY | BDI_CAP_MAP_DIRECT |
  70                            BDI_CAP_EXEC_MAP | BDI_CAP_READ_MAP |
  71                            BDI_CAP_WRITE_MAP),
  72 };
  73
  74 static int mtd_cls_suspend(struct device *dev, pm_message_t state);
  75 static int mtd_cls_resume(struct device *dev);
  76
  77 static struct class mtd_class = {
  78         .name = "mtd",
  79         .owner = THIS_MODULE,
  80         .suspend = mtd_cls_suspend,
  81         .resume = mtd_cls_resume,
  82 };
  83
  84 static DEFINE_IDR(mtd_idr);
  85
  86 /* These are exported solely for the purpose of mtd_blkdevs.c. You
  87    should not use them for _anything_ else */
  88 DEFINE_MUTEX(mtd_table_mutex);
  89 EXPORT_SYMBOL_GPL(mtd_table_mutex);
  90
  91 struct mtd_info *__mtd_next_device(int i)
  92 {
  93         return idr_get_next(&mtd_idr, &i);
  94 }
  95 EXPORT_SYMBOL_GPL(__mtd_next_device);
  96
  97 static LIST_HEAD(mtd_notifiers);
  98
  99
 100 #define MTD_DEVT(index) MKDEV(MTD_CHAR_MAJOR, (index)*2)
 101
 102 /* REVISIT once MTD uses the driver model better, whoever allocates
 103  * the mtd_info will probably want to use the release() hook...
 104  */
 105 static void mtd_release(struct device *dev)
 106 {
 107         struct mtd_info __maybe_unused *mtd = dev_get_drvdata(dev);
 108         dev_t index = MTD_DEVT(mtd->index);
 109
 110         /* remove /dev/mtdXro node if needed */
 111         if (index)
 112                 device_destroy(&mtd_class, index + 1);
 113 }
 114
 115 static int mtd_cls_suspend(struct device *dev, pm_message_t state)
 116 {
 117         struct mtd_info *mtd = dev_get_drvdata(dev);
 118
 119         return mtd ? mtd_suspend(mtd) : 0;
 120 }
 121
 122 static int mtd_cls_resume(struct device *dev)
 123 {
 124         struct mtd_info *mtd = dev_get_drvdata(dev);
 125
 126         if (mtd)
 127                 mtd_resume(mtd);
 128         return 0;
 129 }
 130
 131 static ssize_t mtd_type_show(struct device *dev,
 132                 struct device_attribute *attr, char *buf)
 133 {
 134         struct mtd_info *mtd = dev_get_drvdata(dev);
 135         char *type;
 136
 137         switch (mtd->type) {
 138         case MTD_ABSENT:
 139                 type = "absent";
 140                 break;
 141         case MTD_RAM:
 142                 type = "ram";
 143                 break;
 144         case MTD_ROM:
 145                 type = "rom";
 146                 break;
 147         case MTD_NORFLASH:
 148                 type = "nor";
 149                 break;
 150         case MTD_NANDFLASH:
 151                 type = "nand";
 152                 break;
 153         case MTD_DATAFLASH:
 154                 type = "dataflash";
 155                 break;
 156         case MTD_UBIVOLUME:
 157                 type = "ubi";
 158                 break;
 159         default:
 160                 type = "unknown";
 161         }
 162
 163         return snprintf(buf, PAGE_SIZE, "%s\n", type);
 164 }
 165 static DEVICE_ATTR(type, S_IRUGO, mtd_type_show, NULL);
 166
 167 static ssize_t mtd_flags_show(struct device *dev,
 168                 struct device_attribute *attr, char *buf)
 169 {
 170         struct mtd_info *mtd = dev_get_drvdata(dev);
 171
 172         return snprintf(buf, PAGE_SIZE, "0x%lx\n", (unsigned long)mtd->flags);
 173
 174 }
 175 static DEVICE_ATTR(flags, S_IRUGO, mtd_flags_show, NULL);
 176
 177 static ssize_t mtd_size_show(struct device *dev,
 178                 struct device_attribute *attr, char *buf)
 179 {
 180         struct mtd_info *mtd = dev_get_drvdata(dev);
 181
 182         return snprintf(buf, PAGE_SIZE, "%llu\n",
 183                 (unsigned long long)mtd->size);
 184
 185 }
 186 static DEVICE_ATTR(size, S_IRUGO, mtd_size_show, NULL);
 187
 188 static ssize_t mtd_erasesize_show(struct device *dev,
 189                 struct device_attribute *attr, char *buf)
 190 {
 191         struct mtd_info *mtd = dev_get_drvdata(dev);
 192
 193         return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->erasesize);
 194
 195 }
 196 static DEVICE_ATTR(erasesize, S_IRUGO, mtd_erasesize_show, NULL);
 197
 198 static ssize_t mtd_writesize_show(struct device *dev,
 199                 struct device_attribute *attr, char *buf)
 200 {
 201         struct mtd_info *mtd = dev_get_drvdata(dev);
 202
 203         return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->writesize);
 204
 205 }
 206 static DEVICE_ATTR(writesize, S_IRUGO, mtd_writesize_show, NULL);
 207
 208 static ssize_t mtd_subpagesize_show(struct device *dev,
 209                 struct device_attribute *attr, char *buf)
 210 {
 211         struct mtd_info *mtd = dev_get_drvdata(dev);
 212         unsigned int subpagesize = mtd->writesize >> mtd->subpage_sft;
 213
 214         return snprintf(buf, PAGE_SIZE, "%u\n", subpagesize);
 215
 216 }
 217 static DEVICE_ATTR(subpagesize, S_IRUGO, mtd_subpagesize_show, NULL);
 218
 219 static ssize_t mtd_oobsize_show(struct device *dev,
 220                 struct device_attribute *attr, char *buf)
 221 {
 222         struct mtd_info *mtd = dev_get_drvdata(dev);
 223
 224         return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->oobsize);
 225
 226 }
 227 static DEVICE_ATTR(oobsize, S_IRUGO, mtd_oobsize_show, NULL);
 228
 229 static ssize_t mtd_numeraseregions_show(struct device *dev,
 230                 struct device_attribute *attr, char *buf)
 231 {
 232         struct mtd_info *mtd = dev_get_drvdata(dev);
 233
 234         return snprintf(buf, PAGE_SIZE, "%u\n", mtd->numeraseregions);
 235
 236 }
 237 static DEVICE_ATTR(numeraseregions, S_IRUGO, mtd_numeraseregions_show,
 238         NULL);
 239
 240 static ssize_t mtd_name_show(struct device *dev,
 241                 struct device_attribute *attr, char *buf)
 242 {
 243         struct mtd_info *mtd = dev_get_drvdata(dev);
 244
 245         return snprintf(buf, PAGE_SIZE, "%s\n", mtd->name);
 246
 247 }
 248 static DEVICE_ATTR(name, S_IRUGO, mtd_name_show, NULL);
 249
 250 static ssize_t mtd_ecc_strength_show(struct device *dev,
 251                                      struct device_attribute *attr, char *buf)
 252 {
 253         struct mtd_info *mtd = dev_get_drvdata(dev);
 254
 255         return snprintf(buf, PAGE_SIZE, "%u\n", mtd->ecc_strength);
 256 }
 257 static DEVICE_ATTR(ecc_strength, S_IRUGO, mtd_ecc_strength_show, NULL);
 258
 259 static ssize_t mtd_bitflip_threshold_show(struct device *dev,
 260                                           struct device_attribute *attr,
 261                                           char *buf)
 262 {
 263         struct mtd_info *mtd = dev_get_drvdata(dev);
 264
 265         return snprintf(buf, PAGE_SIZE, "%u\n", mtd->bitflip_threshold);
 266 }
 267
 268 static ssize_t mtd_bitflip_threshold_store(struct device *dev,
 269                                            struct device_attribute *attr,
 270                                            const char *buf, size_t count)
 271 {
 272         struct mtd_info *mtd = dev_get_drvdata(dev);
 273         unsigned int bitflip_threshold;
 274         int retval;
 275
 276         retval = kstrtouint(buf, 0, &bitflip_threshold);
 277         if (retval)
 278                 return retval;
 279
 280         mtd->bitflip_threshold = bitflip_threshold;
 281         return count;
 282 }
 283 static DEVICE_ATTR(bitflip_threshold, S_IRUGO | S_IWUSR,
 284                    mtd_bitflip_threshold_show,
 285                    mtd_bitflip_threshold_store);
 286
 287 static struct attribute *mtd_attrs[] = {
 288         &dev_attr_type.attr,
 289         &dev_attr_flags.attr,
 290         &dev_attr_size.attr,
 291         &dev_attr_erasesize.attr,
 292         &dev_attr_writesize.attr,
 293         &dev_attr_subpagesize.attr,
 294         &dev_attr_oobsize.attr,
 295         &dev_attr_numeraseregions.attr,
 296         &dev_attr_name.attr,
 297         &dev_attr_ecc_strength.attr,
 298         &dev_attr_bitflip_threshold.attr,
 299         NULL,
 300 };
 301
 302 static struct attribute_group mtd_group = {
 303         .attrs          = mtd_attrs,
 304 };
 305
 306 static const struct attribute_group *mtd_groups[] = {
 307         &mtd_group,
 308         NULL,
 309 };
 310
 311 static struct device_type mtd_devtype = {
 312         .name           = "mtd",
 313         .groups         = mtd_groups,
 314         .release        = mtd_release,
 315 };
 316
 317 /**
 318  *      add_mtd_device - register an MTD device
 319  *      @mtd: pointer to new MTD device info structure
 320  *
 321  *      Add a device to the list of MTD devices present in the system, and
 322  *      notify each currently active MTD 'user' of its arrival. Returns
 323  *      zero on success or 1 on failure, which currently will only happen
 324  *      if there is insufficient memory or a sysfs error.
 325  */
 326
 327 int add_mtd_device(struct mtd_info *mtd)
 328 {
 329         struct mtd_notifier *not;
 330         int i, error;
 331
 332         if (!mtd->backing_dev_info) {
 333                 switch (mtd->type) {
 334                 case MTD_RAM:
 335                         mtd->backing_dev_info = &mtd_bdi_rw_mappable;
 336                         break;
 337                 case MTD_ROM:
 338                         mtd->backing_dev_info = &mtd_bdi_ro_mappable;
 339                         break;
 340                 default:
 341                         mtd->backing_dev_info = &mtd_bdi_unmappable;
 342                         break;
 343                 }
 344         }
 345
 346         BUG_ON(mtd->writesize == 0);
 347         mutex_lock(&mtd_table_mutex);
 348
 349         i = idr_alloc(&mtd_idr, mtd, 0, 0, GFP_KERNEL);
 350         if (i < 0)
 351                 goto fail_locked;
 352
 353         mtd->index = i;
 354         mtd->usecount = 0;
 355
 356         /* default value if not set by driver */
 357         if (mtd->bitflip_threshold == 0)
 358                 mtd->bitflip_threshold = mtd->ecc_strength;
 359
 360         if (is_power_of_2(mtd->erasesize))
 361                 mtd->erasesize_shift = ffs(mtd->erasesize) - 1;
 362         else
 363                 mtd->erasesize_shift = 0;
 364
 365         if (is_power_of_2(mtd->writesize))
 366                 mtd->writesize_shift = ffs(mtd->writesize) - 1;
 367         else
 368                 mtd->writesize_shift = 0;
 369
 370         mtd->erasesize_mask = (1 << mtd->erasesize_shift) - 1;
 371         mtd->writesize_mask = (1 << mtd->writesize_shift) - 1;
 372
 373         /* Some chips always power up locked. Unlock them now */
 374         if ((mtd->flags & MTD_WRITEABLE) && (mtd->flags & MTD_POWERUP_LOCK)) {
 375                 error = mtd_unlock(mtd, 0, mtd->size);
 376                 if (error && error != -EOPNOTSUPP)
 377                         printk(KERN_WARNING
 378                                "%s: unlock failed, writes may not work\n",
 379                                mtd->name);
 380         }
 381
 382         /* Caller should have set dev.parent to match the
 383          * physical device.
 384          */
 385         mtd->dev.type = &mtd_devtype;
 386         mtd->dev.class = &mtd_class;
 387         mtd->dev.devt = MTD_DEVT(i);
 388         dev_set_name(&mtd->dev, "mtd%d", i);
 389         dev_set_drvdata(&mtd->dev, mtd);
 390         if (device_register(&mtd->dev) != 0)
 391                 goto fail_added;
 392
 393         if (MTD_DEVT(i))
 394                 device_create(&mtd_class, mtd->dev.parent,
 395                               MTD_DEVT(i) + 1,
 396                               NULL, "mtd%dro", i);
 397
 398         pr_debug("mtd: Giving out device %d to %s\n", i, mtd->name);
 399         /* No need to get a refcount on the module containing
 400            the notifier, since we hold the mtd_table_mutex */
 401         list_for_each_entry(not, &mtd_notifiers, list)
 402                 not->add(mtd);
 403
 404         mutex_unlock(&mtd_table_mutex);
 405         /* We _know_ we aren't being removed, because
 406            our caller is still holding us here. So none
 407            of this try_ nonsense, and no bitching about it
 408            either. :) */
 409         __module_get(THIS_MODULE);
 410         return 0;
 411
 412 fail_added:
 413         idr_remove(&mtd_idr, i);
 414 fail_locked:
 415         mutex_unlock(&mtd_table_mutex);
 416         return 1;
 417 }
 418
 419 /**
 420  *      del_mtd_device - unregister an MTD device
 421  *      @mtd: pointer to MTD device info structure
 422  *
 423  *      Remove a device from the list of MTD devices present in the system,
 424  *      and notify each currently active MTD 'user' of its departure.
 425  *      Returns zero on success or 1 on failure, which currently will happen
 426  *      if the requested device does not appear to be present in the list.
 427  */
 428
 429 int del_mtd_device(struct mtd_info *mtd)
 430 {
 431         int ret;
 432         struct mtd_notifier *not;
 433
 434         mutex_lock(&mtd_table_mutex);
 435
 436         if (idr_find(&mtd_idr, mtd->index) != mtd) {
 437                 ret = -ENODEV;
 438                 goto out_error;
 439         }
 440
 441         /* No need to get a refcount on the module containing
 442                 the notifier, since we hold the mtd_table_mutex */
 443         list_for_each_entry(not, &mtd_notifiers, list)
 444                 not->remove(mtd);
 445
 446         if (mtd->usecount) {
 447                 printk(KERN_NOTICE "Removing MTD device #%d (%s) with use count %d\n",
 448                        mtd->index, mtd->name, mtd->usecount);
 449                 ret = -EBUSY;
 450         } else {
 451                 device_unregister(&mtd->dev);
 452
 453                 idr_remove(&mtd_idr, mtd->index);
 454
 455                 module_put(THIS_MODULE);
 456                 ret = 0;
 457         }
 458
 459 out_error:
 460         mutex_unlock(&mtd_table_mutex);
 461         return ret;
 462 }
 463
 464 /**
 465  * mtd_device_parse_register - parse partitions and register an MTD device.
 466  *
 467  * @mtd: the MTD device to register
 468  * @types: the list of MTD partition probes to try, see
 469  *         'parse_mtd_partitions()' for more information
 470  * @parser_data: MTD partition parser-specific data
 471  * @parts: fallback partition information to register, if parsing fails;
 472  *         only valid if %nr_parts > %0
 473  * @nr_parts: the number of partitions in parts, if zero then the full
 474  *            MTD device is registered if no partition info is found
 475  *
 476  * This function aggregates MTD partitions parsing (done by
 477  * 'parse_mtd_partitions()') and MTD device and partitions registering. It
 478  * basically follows the most common pattern found in many MTD drivers:
 479  *
 480  * * It first tries to probe partitions on MTD device @mtd using parsers
 481  *   specified in @types (if @types is %NULL, then the default list of parsers
 482  *   is used, see 'parse_mtd_partitions()' for more information). If none are
 483  *   found this functions tries to fallback to information specified in
 484  *   @parts/@nr_parts.
 485  * * If any partitioning info was found, this function registers the found
 486  *   partitions.
 487  * * If no partitions were found this function just registers the MTD device
 488  *   @mtd and exits.
 489  *
 490  * Returns zero in case of success and a negative error code in case of failure.
 491  */
 492 int mtd_device_parse_register(struct mtd_info *mtd, const char * const *types,
 493                               struct mtd_part_parser_data *parser_data,
 494                               const struct mtd_partition *parts,
 495                               int nr_parts)
 496 {
 497         int err;
 498         struct mtd_partition *real_parts;
 499
 500         err = parse_mtd_partitions(mtd, types, &real_parts, parser_data);
 501         if (err <= 0 && nr_parts && parts) {
 502                 real_parts = kmemdup(parts, sizeof(*parts) * nr_parts,
 503                                      GFP_KERNEL);
 504                 if (!real_parts)
 505                         err = -ENOMEM;
 506                 else
 507                         err = nr_parts;
 508         }
 509
 510         if (err > 0) {
 511                 err = add_mtd_partitions(mtd, real_parts, err);
 512                 kfree(real_parts);
 513         } else if (err == 0) {
 514                 err = add_mtd_device(mtd);
 515                 if (err == 1)
 516                         err = -ENODEV;
 517         }
 518
 519         return err;
 520 }
 521 EXPORT_SYMBOL_GPL(mtd_device_parse_register);
 522
 523 /**
 524  * mtd_device_unregister - unregister an existing MTD device.
 525  *
 526  * @master: the MTD device to unregister.  This will unregister both the master
 527  *          and any partitions if registered.
 528  */
 529 int mtd_device_unregister(struct mtd_info *master)
 530 {
 531         int err;
 532
 533         err = del_mtd_partitions(master);
 534         if (err)
 535                 return err;
 536
 537         if (!device_is_registered(&master->dev))
 538                 return 0;
 539
 540         return del_mtd_device(master);
 541 }
 542 EXPORT_SYMBOL_GPL(mtd_device_unregister);
 543
 544 /**
 545  *      register_mtd_user - register a 'user' of MTD devices.
 546  *      @new: pointer to notifier info structure
 547  *
 548  *      Registers a pair of callbacks function to be called upon addition
 549  *      or removal of MTD devices. Causes the 'add' callback to be immediately
 550  *      invoked for each MTD device currently present in the system.
 551  */
 552 void register_mtd_user (struct mtd_notifier *new)
 553 {
 554         struct mtd_info *mtd;
 555
 556         mutex_lock(&mtd_table_mutex);
 557
 558         list_add(&new->list, &mtd_notifiers);
 559
 560         __module_get(THIS_MODULE);
 561
 562         mtd_for_each_device(mtd)
 563                 new->add(mtd);
 564
 565         mutex_unlock(&mtd_table_mutex);
 566 }
 567 EXPORT_SYMBOL_GPL(register_mtd_user);
 568
 569 /**
 570  *      unregister_mtd_user - unregister a 'user' of MTD devices.
 571  *      @old: pointer to notifier info structure
 572  *
 573  *      Removes a callback function pair from the list of 'users' to be
 574  *      notified upon addition or removal of MTD devices. Causes the
 575  *      'remove' callback to be immediately invoked for each MTD device
 576  *      currently present in the system.
 577  */
 578 int unregister_mtd_user (struct mtd_notifier *old)
 579 {
 580         struct mtd_info *mtd;
 581
 582         mutex_lock(&mtd_table_mutex);
 583
 584         module_put(THIS_MODULE);
 585
 586         mtd_for_each_device(mtd)
 587                 old->remove(mtd);
 588
 589         list_del(&old->list);
 590         mutex_unlock(&mtd_table_mutex);
 591         return 0;
 592 }
 593 EXPORT_SYMBOL_GPL(unregister_mtd_user);
 594
 595 /**
 596  *      get_mtd_device - obtain a validated handle for an MTD device
 597  *      @mtd: last known address of the required MTD device
 598  *      @num: internal device number of the required MTD device
 599  *
 600  *      Given a number and NULL address, return the num'th entry in the device
 601  *      table, if any.  Given an address and num == -1, search the device table
 602  *      for a device with that address and return if it's still present. Given
 603  *      both, return the num'th driver only if its address matches. Return
 604  *      error code if not.
 605  */
 606 struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num)
 607 {
 608         struct mtd_info *ret = NULL, *other;
 609         int err = -ENODEV;
 610
 611         mutex_lock(&mtd_table_mutex);
 612
 613         if (num == -1) {
 614                 mtd_for_each_device(other) {
 615                         if (other == mtd) {
 616                                 ret = mtd;
 617                                 break;
 618                         }
 619                 }
 620         } else if (num >= 0) {
 621                 ret = idr_find(&mtd_idr, num);
 622                 if (mtd && mtd != ret)
 623                         ret = NULL;
 624         }
 625
 626         if (!ret) {
 627                 ret = ERR_PTR(err);
 628                 goto out;
 629         }
 630
 631         err = __get_mtd_device(ret);
 632         if (err)
 633                 ret = ERR_PTR(err);
 634 out:
 635         mutex_unlock(&mtd_table_mutex);
 636         return ret;
 637 }
 638 EXPORT_SYMBOL_GPL(get_mtd_device);
 639
 640
 641 int __get_mtd_device(struct mtd_info *mtd)
 642 {
 643         int err;
 644
 645         if (!try_module_get(mtd->owner))
 646                 return -ENODEV;
 647
 648         if (mtd->_get_device) {
 649                 err = mtd->_get_device(mtd);
 650
 651                 if (err) {
 652                         module_put(mtd->owner);
 653                         return err;
 654                 }
 655         }
 656         mtd->usecount++;
 657         return 0;
 658 }
 659 EXPORT_SYMBOL_GPL(__get_mtd_device);
 660
 661 /**
 662  *      get_mtd_device_nm - obtain a validated handle for an MTD device by
 663  *      device name
 664  *      @name: MTD device name to open
 665  *
 666  *      This function returns MTD device description structure in case of
 667  *      success and an error code in case of failure.
 668  */
 669 struct mtd_info *get_mtd_device_nm(const char *name)
 670 {
 671         int err = -ENODEV;
 672         struct mtd_info *mtd = NULL, *other;
 673
 674         mutex_lock(&mtd_table_mutex);
 675
 676         mtd_for_each_device(other) {
 677                 if (!strcmp(name, other->name)) {
 678                         mtd = other;
 679                         break;
 680                 }
 681         }
 682
 683         if (!mtd)
 684                 goto out_unlock;
 685
 686         err = __get_mtd_device(mtd);
 687         if (err)
 688                 goto out_unlock;
 689
 690         mutex_unlock(&mtd_table_mutex);
 691         return mtd;
 692
 693 out_unlock:
 694         mutex_unlock(&mtd_table_mutex);
 695         return ERR_PTR(err);
 696 }
 697 EXPORT_SYMBOL_GPL(get_mtd_device_nm);
 698
 699 void put_mtd_device(struct mtd_info *mtd)
 700 {
 701         mutex_lock(&mtd_table_mutex);
 702         __put_mtd_device(mtd);
 703         mutex_unlock(&mtd_table_mutex);
 704
 705 }
 706 EXPORT_SYMBOL_GPL(put_mtd_device);
 707
 708 void __put_mtd_device(struct mtd_info *mtd)
 709 {
 710         --mtd->usecount;
 711         BUG_ON(mtd->usecount < 0);
 712
 713         if (mtd->_put_device)
 714                 mtd->_put_device(mtd);
 715
 716         module_put(mtd->owner);
 717 }
 718 EXPORT_SYMBOL_GPL(__put_mtd_device);
 719
 720 /*
 721  * Erase is an asynchronous operation.  Device drivers are supposed
 722  * to call instr->callback() whenever the operation completes, even
 723  * if it completes with a failure.
 724  * Callers are supposed to pass a callback function and wait for it
 725  * to be called before writing to the block.
 726  */
 727 int mtd_erase(struct mtd_info *mtd, struct erase_info *instr)
 728 {
 729         if (instr->addr > mtd->size || instr->len > mtd->size - instr->addr)
 730                 return -EINVAL;
 731         if (!(mtd->flags & MTD_WRITEABLE))
 732                 return -EROFS;
 733         instr->fail_addr = MTD_FAIL_ADDR_UNKNOWN;
 734         if (!instr->len) {
 735                 instr->state = MTD_ERASE_DONE;
 736                 mtd_erase_callback(instr);
 737                 return 0;
 738         }
 739         return mtd->_erase(mtd, instr);
 740 }
 741 EXPORT_SYMBOL_GPL(mtd_erase);
 742
 743 /*
 744  * This stuff for eXecute-In-Place. phys is optional and may be set to NULL.
 745  */
 746 int mtd_point(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
 747               void **virt, resource_size_t *phys)
 748 {
 749         *retlen = 0;
 750         *virt = NULL;
 751         if (phys)
 752                 *phys = 0;
 753         if (!mtd->_point)
 754                 return -EOPNOTSUPP;
 755         if (from < 0 || from > mtd->size || len > mtd->size - from)
 756                 return -EINVAL;
 757         if (!len)
 758                 return 0;
 759         return mtd->_point(mtd, from, len, retlen, virt, phys);
 760 }
 761 EXPORT_SYMBOL_GPL(mtd_point);
 762
 763 /* We probably shouldn't allow XIP if the unpoint isn't a NULL */
 764 int mtd_unpoint(struct mtd_info *mtd, loff_t from, size_t len)
 765 {
 766         if (!mtd->_point)
 767                 return -EOPNOTSUPP;
 768         if (from < 0 || from > mtd->size || len > mtd->size - from)
 769                 return -EINVAL;
 770         if (!len)
 771                 return 0;
 772         return mtd->_unpoint(mtd, from, len);
 773 }
 774 EXPORT_SYMBOL_GPL(mtd_unpoint);
 775
 776 /*
 777  * Allow NOMMU mmap() to directly map the device (if not NULL)
 778  * - return the address to which the offset maps
 779  * - return -ENOSYS to indicate refusal to do the mapping
 780  */
 781 unsigned long mtd_get_unmapped_area(struct mtd_info *mtd, unsigned long len,
 782                                     unsigned long offset, unsigned long flags)
 783 {
 784         if (!mtd->_get_unmapped_area)
 785                 return -EOPNOTSUPP;
 786         if (offset > mtd->size || len > mtd->size - offset)
 787                 return -EINVAL;
 788         return mtd->_get_unmapped_area(mtd, len, offset, flags);
 789 }
 790 EXPORT_SYMBOL_GPL(mtd_get_unmapped_area);
 791
 792 int mtd_read(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
 793              u_char *buf)
 794 {
 795         int ret_code;
 796         *retlen = 0;
 797         if (from < 0 || from > mtd->size || len > mtd->size - from)
 798                 return -EINVAL;
 799         if (!len)
 800                 return 0;
 801
 802         /*
 803          * In the absence of an error, drivers return a non-negative integer
 804          * representing the maximum number of bitflips that were corrected on
 805          * any one ecc region (if applicable; zero otherwise).
 806          */
 807         ret_code = mtd->_read(mtd, from, len, retlen, buf);
 808         if (unlikely(ret_code < 0))
 809                 return ret_code;
 810         if (mtd->ecc_strength == 0)
 811                 return 0;       /* device lacks ecc */
 812         return ret_code >= mtd->bitflip_threshold ? -EUCLEAN : 0;
 813 }
 814 EXPORT_SYMBOL_GPL(mtd_read);
 815
 816 int mtd_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
 817               const u_char *buf)
 818 {
 819         *retlen = 0;
 820         if (to < 0 || to > mtd->size || len > mtd->size - to)
 821                 return -EINVAL;
 822         if (!mtd->_write || !(mtd->flags & MTD_WRITEABLE))
 823                 return -EROFS;
 824         if (!len)
 825                 return 0;
 826         return mtd->_write(mtd, to, len, retlen, buf);
 827 }
 828 EXPORT_SYMBOL_GPL(mtd_write);
 829
 830 /*
 831  * In blackbox flight recorder like scenarios we want to make successful writes
 832  * in interrupt context. panic_write() is only intended to be called when its
 833  * known the kernel is about to panic and we need the write to succeed. Since
 834  * the kernel is not going to be running for much longer, this function can
 835  * break locks and delay to ensure the write succeeds (but not sleep).
 836  */
 837 int mtd_panic_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
 838                     const u_char *buf)
 839 {
 840         *retlen = 0;
 841         if (!mtd->_panic_write)
 842                 return -EOPNOTSUPP;
 843         if (to < 0 || to > mtd->size || len > mtd->size - to)
 844                 return -EINVAL;
 845         if (!(mtd->flags & MTD_WRITEABLE))
 846                 return -EROFS;
 847         if (!len)
 848                 return 0;
 849         return mtd->_panic_write(mtd, to, len, retlen, buf);
 850 }
 851 EXPORT_SYMBOL_GPL(mtd_panic_write);
 852
 853 int mtd_read_oob(struct mtd_info *mtd, loff_t from, struct mtd_oob_ops *ops)
 854 {
 855         int ret_code;
 856         ops->retlen = ops->oobretlen = 0;
 857         if (!mtd->_read_oob)
 858                 return -EOPNOTSUPP;
 859         /*
 860          * In cases where ops->datbuf != NULL, mtd->_read_oob() has semantics
 861          * similar to mtd->_read(), returning a non-negative integer
 862          * representing max bitflips. In other cases, mtd->_read_oob() may
 863          * return -EUCLEAN. In all cases, perform similar logic to mtd_read().
 864          */
 865         ret_code = mtd->_read_oob(mtd, from, ops);
 866         if (unlikely(ret_code < 0))
 867                 return ret_code;
 868         if (mtd->ecc_strength == 0)
 869                 return 0;       /* device lacks ecc */
 870         return ret_code >= mtd->bitflip_threshold ? -EUCLEAN : 0;
 871 }
 872 EXPORT_SYMBOL_GPL(mtd_read_oob);
 873
 874 /*
 875  * Method to access the protection register area, present in some flash
 876  * devices. The user data is one time programmable but the factory data is read
 877  * only.
 878  */
 879 int mtd_get_fact_prot_info(struct mtd_info *mtd, struct otp_info *buf,
 880                            size_t len)
 881 {
 882         if (!mtd->_get_fact_prot_info)
 883                 return -EOPNOTSUPP;
 884         if (!len)
 885                 return 0;
 886         return mtd->_get_fact_prot_info(mtd, buf, len);
 887 }
 888 EXPORT_SYMBOL_GPL(mtd_get_fact_prot_info);
 889
 890 int mtd_read_fact_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
 891                            size_t *retlen, u_char *buf)
 892 {
 893         *retlen = 0;
 894         if (!mtd->_read_fact_prot_reg)
 895                 return -EOPNOTSUPP;
 896         if (!len)
 897                 return 0;
 898         return mtd->_read_fact_prot_reg(mtd, from, len, retlen, buf);
 899 }
 900 EXPORT_SYMBOL_GPL(mtd_read_fact_prot_reg);
 901
 902 int mtd_get_user_prot_info(struct mtd_info *mtd, struct otp_info *buf,
 903                            size_t len)
 904 {
 905         if (!mtd->_get_user_prot_info)
 906                 return -EOPNOTSUPP;
 907         if (!len)
 908                 return 0;
 909         return mtd->_get_user_prot_info(mtd, buf, len);
 910 }
 911 EXPORT_SYMBOL_GPL(mtd_get_user_prot_info);
 912
 913 int mtd_read_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
 914                            size_t *retlen, u_char *buf)
 915 {
 916         *retlen = 0;
 917         if (!mtd->_read_user_prot_reg)
 918                 return -EOPNOTSUPP;
 919         if (!len)
 920                 return 0;
 921         return mtd->_read_user_prot_reg(mtd, from, len, retlen, buf);
 922 }
 923 EXPORT_SYMBOL_GPL(mtd_read_user_prot_reg);
 924
 925 int mtd_write_user_prot_reg(struct mtd_info *mtd, loff_t to, size_t len,
 926                             size_t *retlen, u_char *buf)
 927 {
 928         *retlen = 0;
 929         if (!mtd->_write_user_prot_reg)
 930                 return -EOPNOTSUPP;
 931         if (!len)
 932                 return 0;
 933         return mtd->_write_user_prot_reg(mtd, to, len, retlen, buf);
 934 }
 935 EXPORT_SYMBOL_GPL(mtd_write_user_prot_reg);
 936
 937 int mtd_lock_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len)
 938 {
 939         if (!mtd->_lock_user_prot_reg)
 940                 return -EOPNOTSUPP;
 941         if (!len)
 942                 return 0;
 943         return mtd->_lock_user_prot_reg(mtd, from, len);
 944 }
 945 EXPORT_SYMBOL_GPL(mtd_lock_user_prot_reg);
 946
 947 /* Chip-supported device locking */
 948 int mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
 949 {
 950         if (!mtd->_lock)
 951                 return -EOPNOTSUPP;
 952         if (ofs < 0 || ofs > mtd->size || len > mtd->size - ofs)
 953                 return -EINVAL;
 954         if (!len)
 955                 return 0;
 956         return mtd->_lock(mtd, ofs, len);
 957 }
 958 EXPORT_SYMBOL_GPL(mtd_lock);
 959
 960 int mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
 961 {
 962         if (!mtd->_unlock)
 963                 return -EOPNOTSUPP;
 964         if (ofs < 0 || ofs > mtd->size || len > mtd->size - ofs)
 965                 return -EINVAL;
 966         if (!len)
 967                 return 0;
 968         return mtd->_unlock(mtd, ofs, len);
 969 }
 970 EXPORT_SYMBOL_GPL(mtd_unlock);
 971
 972 int mtd_is_locked(struct mtd_info *mtd, loff_t ofs, uint64_t len)
 973 {
 974         if (!mtd->_is_locked)
 975                 return -EOPNOTSUPP;
 976         if (ofs < 0 || ofs > mtd->size || len > mtd->size - ofs)
 977                 return -EINVAL;
 978         if (!len)
 979                 return 0;
 980         return mtd->_is_locked(mtd, ofs, len);
 981 }
 982 EXPORT_SYMBOL_GPL(mtd_is_locked);
 983
 984 int mtd_block_isbad(struct mtd_info *mtd, loff_t ofs)
 985 {
 986         if (!mtd->_block_isbad)
 987                 return 0;
 988         if (ofs < 0 || ofs > mtd->size)
 989                 return -EINVAL;
 990         return mtd->_block_isbad(mtd, ofs);
 991 }
 992 EXPORT_SYMBOL_GPL(mtd_block_isbad);
 993
 994 int mtd_block_markbad(struct mtd_info *mtd, loff_t ofs)
 995 {
 996         if (!mtd->_block_markbad)
 997                 return -EOPNOTSUPP;
 998         if (ofs < 0 || ofs > mtd->size)
 999                 return -EINVAL;
1000         if (!(mtd->flags & MTD_WRITEABLE))
1001                 return -EROFS;
1002         return mtd->_block_markbad(mtd, ofs);
1003 }
1004 EXPORT_SYMBOL_GPL(mtd_block_markbad);
1005
1006 /*
1007  * default_mtd_writev - the default writev method
1008  * @mtd: mtd device description object pointer
1009  * @vecs: the vectors to write
1010  * @count: count of vectors in @vecs
1011  * @to: the MTD device offset to write to
1012  * @retlen: on exit contains the count of bytes written to the MTD device.
1013  *
1014  * This function returns zero in case of success and a negative error code in
1015  * case of failure.
1016  */
1017 static int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
1018                               unsigned long count, loff_t to, size_t *retlen)
1019 {
1020         unsigned long i;
1021         size_t totlen = 0, thislen;
1022         int ret = 0;
1023
1024         for (i = 0; i < count; i++) {
1025                 if (!vecs[i].iov_len)
1026                         continue;
1027                 ret = mtd_write(mtd, to, vecs[i].iov_len, &thislen,
1028                                 vecs[i].iov_base);
1029                 totlen += thislen;
1030                 if (ret || thislen != vecs[i].iov_len)
1031                         break;
1032                 to += vecs[i].iov_len;
1033         }
1034         *retlen = totlen;
1035         return ret;
1036 }
1037
1038 /*
1039  * mtd_writev - the vector-based MTD write method
1040  * @mtd: mtd device description object pointer
1041  * @vecs: the vectors to write
1042  * @count: count of vectors in @vecs
1043  * @to: the MTD device offset to write to
1044  * @retlen: on exit contains the count of bytes written to the MTD device.
1045  *
1046  * This function returns zero in case of success and a negative error code in
1047  * case of failure.
1048  */
1049 int mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
1050                unsigned long count, loff_t to, size_t *retlen)
1051 {
1052         *retlen = 0;
1053         if (!(mtd->flags & MTD_WRITEABLE))
1054                 return -EROFS;
1055         if (!mtd->_writev)
1056                 return default_mtd_writev(mtd, vecs, count, to, retlen);
1057         return mtd->_writev(mtd, vecs, count, to, retlen);
1058 }
1059 EXPORT_SYMBOL_GPL(mtd_writev);
1060
1061 /**
1062  * mtd_kmalloc_up_to - allocate a contiguous buffer up to the specified size
1063  * @mtd: mtd device description object pointer
1064  * @size: a pointer to the ideal or maximum size of the allocation, points
1065  *        to the actual allocation size on success.
1066  *
1067  * This routine attempts to allocate a contiguous kernel buffer up to
1068  * the specified size, backing off the size of the request exponentially
1069  * until the request succeeds or until the allocation size falls below
1070  * the system page size. This attempts to make sure it does not adversely
1071  * impact system performance, so when allocating more than one page, we
1072  * ask the memory allocator to avoid re-trying, swapping, writing back
1073  * or performing I/O.
1074  *
1075  * Note, this function also makes sure that the allocated buffer is aligned to
1076  * the MTD device's min. I/O unit, i.e. the "mtd->writesize" value.
1077  *
1078  * This is called, for example by mtd_{read,write} and jffs2_scan_medium,
1079  * to handle smaller (i.e. degraded) buffer allocations under low- or
1080  * fragmented-memory situations where such reduced allocations, from a
1081  * requested ideal, are allowed.
1082  *
1083  * Returns a pointer to the allocated buffer on success; otherwise, NULL.
1084  */
1085 void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size)
1086 {
1087         gfp_t flags = __GFP_NOWARN | __GFP_WAIT |
1088                        __GFP_NORETRY | __GFP_NO_KSWAPD;
1089         size_t min_alloc = max_t(size_t, mtd->writesize, PAGE_SIZE);
1090         void *kbuf;
1091
1092         *size = min_t(size_t, *size, KMALLOC_MAX_SIZE);
1093
1094         while (*size > min_alloc) {
1095                 kbuf = kmalloc(*size, flags);
1096                 if (kbuf)
1097                         return kbuf;
1098
1099                 *size >>= 1;
1100                 *size = ALIGN(*size, mtd->writesize);
1101         }
1102
1103         /*
1104          * For the last resort allocation allow 'kmalloc()' to do all sorts of
1105          * things (write-back, dropping caches, etc) by using GFP_KERNEL.
1106          */
1107         return kmalloc(*size, GFP_KERNEL);
1108 }
1109 EXPORT_SYMBOL_GPL(mtd_kmalloc_up_to);
1110
1111 #ifdef CONFIG_PROC_FS
1112
1113 /*====================================================================*/
1114 /* Support for /proc/mtd */
1115
1116 static int mtd_proc_show(struct seq_file *m, void *v)
1117 {
1118         struct mtd_info *mtd;
1119
1120         seq_puts(m, "dev:    size   erasesize  name\n");
1121         mutex_lock(&mtd_table_mutex);
1122         mtd_for_each_device(mtd) {
1123                 seq_printf(m, "mtd%d: %8.8llx %8.8x \"%s\"\n",
1124                            mtd->index, (unsigned long long)mtd->size,
1125                            mtd->erasesize, mtd->name);
1126         }
1127         mutex_unlock(&mtd_table_mutex);
1128         return 0;
1129 }
1130
1131 static int mtd_proc_open(struct inode *inode, struct file *file)
1132 {
1133         return single_open(file, mtd_proc_show, NULL);
1134 }
1135
1136 static const struct file_operations mtd_proc_ops = {
1137         .open           = mtd_proc_open,
1138         .read           = seq_read,
1139         .llseek         = seq_lseek,
1140         .release        = single_release,
1141 };
1142 #endif /* CONFIG_PROC_FS */
1143
1144 /*====================================================================*/
1145 /* Init code */
1146
1147 static int __init mtd_bdi_init(struct backing_dev_info *bdi, const char *name)
1148 {
1149         int ret;
1150
1151         ret = bdi_init(bdi);
1152         if (!ret)
1153                 ret = bdi_register(bdi, NULL, name);
1154
1155         if (ret)
1156                 bdi_destroy(bdi);
1157
1158         return ret;
1159 }
1160
1161 static struct proc_dir_entry *proc_mtd;
1162
1163 static int __init init_mtd(void)
1164 {
1165         int ret;
1166
1167         ret = class_register(&mtd_class);
1168         if (ret)
1169                 goto err_reg;
1170
1171         ret = mtd_bdi_init(&mtd_bdi_unmappable, "mtd-unmap");
1172         if (ret)
1173                 goto err_bdi1;
1174
1175         ret = mtd_bdi_init(&mtd_bdi_ro_mappable, "mtd-romap");
1176         if (ret)
1177                 goto err_bdi2;
1178
1179         ret = mtd_bdi_init(&mtd_bdi_rw_mappable, "mtd-rwmap");
1180         if (ret)
1181                 goto err_bdi3;
1182
1183         proc_mtd = proc_create("mtd", 0, NULL, &mtd_proc_ops);
1184
1185         ret = init_mtdchar();
1186         if (ret)
1187                 goto out_procfs;
1188
1189         return 0;
1190
1191 out_procfs:
1192         if (proc_mtd)
1193                 remove_proc_entry("mtd", NULL);
1194 err_bdi3:
1195         bdi_destroy(&mtd_bdi_ro_mappable);
1196 err_bdi2:
1197         bdi_destroy(&mtd_bdi_unmappable);
1198 err_bdi1:
1199         class_unregister(&mtd_class);
1200 err_reg:
1201         pr_err("Error registering mtd class or bdi: %d\n", ret);
1202         return ret;
1203 }
1204
1205 static void __exit cleanup_mtd(void)
1206 {
1207         cleanup_mtdchar();
1208         if (proc_mtd)
1209                 remove_proc_entry("mtd", NULL);
1210         class_unregister(&mtd_class);
1211         bdi_destroy(&mtd_bdi_unmappable);
1212         bdi_destroy(&mtd_bdi_ro_mappable);
1213         bdi_destroy(&mtd_bdi_rw_mappable);
1214 }
1215
1216 module_init(init_mtd);
1217 module_exit(cleanup_mtd);
1218
1219 MODULE_LICENSE("GPL");
1220 MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
1221 MODULE_DESCRIPTION("Core MTD registration and access routines");