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