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