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