mtd: implement common reboot notifier boilerplate
[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         if (mtd->_reboot) {
581                 mtd->reboot_notifier.notifier_call = mtd_reboot_notifier;
582                 register_reboot_notifier(&mtd->reboot_notifier);
583         }
584
585         return err;
586 }
587 EXPORT_SYMBOL_GPL(mtd_device_parse_register);
588
589 /**
590  * mtd_device_unregister - unregister an existing MTD device.
591  *
592  * @master: the MTD device to unregister.  This will unregister both the master
593  *          and any partitions if registered.
594  */
595 int mtd_device_unregister(struct mtd_info *master)
596 {
597         int err;
598
599         if (master->_reboot)
600                 unregister_reboot_notifier(&master->reboot_notifier);
601
602         err = del_mtd_partitions(master);
603         if (err)
604                 return err;
605
606         if (!device_is_registered(&master->dev))
607                 return 0;
608
609         return del_mtd_device(master);
610 }
611 EXPORT_SYMBOL_GPL(mtd_device_unregister);
612
613 /**
614  *      register_mtd_user - register a 'user' of MTD devices.
615  *      @new: pointer to notifier info structure
616  *
617  *      Registers a pair of callbacks function to be called upon addition
618  *      or removal of MTD devices. Causes the 'add' callback to be immediately
619  *      invoked for each MTD device currently present in the system.
620  */
621 void register_mtd_user (struct mtd_notifier *new)
622 {
623         struct mtd_info *mtd;
624
625         mutex_lock(&mtd_table_mutex);
626
627         list_add(&new->list, &mtd_notifiers);
628
629         __module_get(THIS_MODULE);
630
631         mtd_for_each_device(mtd)
632                 new->add(mtd);
633
634         mutex_unlock(&mtd_table_mutex);
635 }
636 EXPORT_SYMBOL_GPL(register_mtd_user);
637
638 /**
639  *      unregister_mtd_user - unregister a 'user' of MTD devices.
640  *      @old: pointer to notifier info structure
641  *
642  *      Removes a callback function pair from the list of 'users' to be
643  *      notified upon addition or removal of MTD devices. Causes the
644  *      'remove' callback to be immediately invoked for each MTD device
645  *      currently present in the system.
646  */
647 int unregister_mtd_user (struct mtd_notifier *old)
648 {
649         struct mtd_info *mtd;
650
651         mutex_lock(&mtd_table_mutex);
652
653         module_put(THIS_MODULE);
654
655         mtd_for_each_device(mtd)
656                 old->remove(mtd);
657
658         list_del(&old->list);
659         mutex_unlock(&mtd_table_mutex);
660         return 0;
661 }
662 EXPORT_SYMBOL_GPL(unregister_mtd_user);
663
664 /**
665  *      get_mtd_device - obtain a validated handle for an MTD device
666  *      @mtd: last known address of the required MTD device
667  *      @num: internal device number of the required MTD device
668  *
669  *      Given a number and NULL address, return the num'th entry in the device
670  *      table, if any.  Given an address and num == -1, search the device table
671  *      for a device with that address and return if it's still present. Given
672  *      both, return the num'th driver only if its address matches. Return
673  *      error code if not.
674  */
675 struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num)
676 {
677         struct mtd_info *ret = NULL, *other;
678         int err = -ENODEV;
679
680         mutex_lock(&mtd_table_mutex);
681
682         if (num == -1) {
683                 mtd_for_each_device(other) {
684                         if (other == mtd) {
685                                 ret = mtd;
686                                 break;
687                         }
688                 }
689         } else if (num >= 0) {
690                 ret = idr_find(&mtd_idr, num);
691                 if (mtd && mtd != ret)
692                         ret = NULL;
693         }
694
695         if (!ret) {
696                 ret = ERR_PTR(err);
697                 goto out;
698         }
699
700         err = __get_mtd_device(ret);
701         if (err)
702                 ret = ERR_PTR(err);
703 out:
704         mutex_unlock(&mtd_table_mutex);
705         return ret;
706 }
707 EXPORT_SYMBOL_GPL(get_mtd_device);
708
709
710 int __get_mtd_device(struct mtd_info *mtd)
711 {
712         int err;
713
714         if (!try_module_get(mtd->owner))
715                 return -ENODEV;
716
717         if (mtd->_get_device) {
718                 err = mtd->_get_device(mtd);
719
720                 if (err) {
721                         module_put(mtd->owner);
722                         return err;
723                 }
724         }
725         mtd->usecount++;
726         return 0;
727 }
728 EXPORT_SYMBOL_GPL(__get_mtd_device);
729
730 /**
731  *      get_mtd_device_nm - obtain a validated handle for an MTD device by
732  *      device name
733  *      @name: MTD device name to open
734  *
735  *      This function returns MTD device description structure in case of
736  *      success and an error code in case of failure.
737  */
738 struct mtd_info *get_mtd_device_nm(const char *name)
739 {
740         int err = -ENODEV;
741         struct mtd_info *mtd = NULL, *other;
742
743         mutex_lock(&mtd_table_mutex);
744
745         mtd_for_each_device(other) {
746                 if (!strcmp(name, other->name)) {
747                         mtd = other;
748                         break;
749                 }
750         }
751
752         if (!mtd)
753                 goto out_unlock;
754
755         err = __get_mtd_device(mtd);
756         if (err)
757                 goto out_unlock;
758
759         mutex_unlock(&mtd_table_mutex);
760         return mtd;
761
762 out_unlock:
763         mutex_unlock(&mtd_table_mutex);
764         return ERR_PTR(err);
765 }
766 EXPORT_SYMBOL_GPL(get_mtd_device_nm);
767
768 void put_mtd_device(struct mtd_info *mtd)
769 {
770         mutex_lock(&mtd_table_mutex);
771         __put_mtd_device(mtd);
772         mutex_unlock(&mtd_table_mutex);
773
774 }
775 EXPORT_SYMBOL_GPL(put_mtd_device);
776
777 void __put_mtd_device(struct mtd_info *mtd)
778 {
779         --mtd->usecount;
780         BUG_ON(mtd->usecount < 0);
781
782         if (mtd->_put_device)
783                 mtd->_put_device(mtd);
784
785         module_put(mtd->owner);
786 }
787 EXPORT_SYMBOL_GPL(__put_mtd_device);
788
789 /*
790  * Erase is an asynchronous operation.  Device drivers are supposed
791  * to call instr->callback() whenever the operation completes, even
792  * if it completes with a failure.
793  * Callers are supposed to pass a callback function and wait for it
794  * to be called before writing to the block.
795  */
796 int mtd_erase(struct mtd_info *mtd, struct erase_info *instr)
797 {
798         if (instr->addr >= mtd->size || instr->len > mtd->size - instr->addr)
799                 return -EINVAL;
800         if (!(mtd->flags & MTD_WRITEABLE))
801                 return -EROFS;
802         instr->fail_addr = MTD_FAIL_ADDR_UNKNOWN;
803         if (!instr->len) {
804                 instr->state = MTD_ERASE_DONE;
805                 mtd_erase_callback(instr);
806                 return 0;
807         }
808         return mtd->_erase(mtd, instr);
809 }
810 EXPORT_SYMBOL_GPL(mtd_erase);
811
812 /*
813  * This stuff for eXecute-In-Place. phys is optional and may be set to NULL.
814  */
815 int mtd_point(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
816               void **virt, resource_size_t *phys)
817 {
818         *retlen = 0;
819         *virt = NULL;
820         if (phys)
821                 *phys = 0;
822         if (!mtd->_point)
823                 return -EOPNOTSUPP;
824         if (from < 0 || from >= mtd->size || len > mtd->size - from)
825                 return -EINVAL;
826         if (!len)
827                 return 0;
828         return mtd->_point(mtd, from, len, retlen, virt, phys);
829 }
830 EXPORT_SYMBOL_GPL(mtd_point);
831
832 /* We probably shouldn't allow XIP if the unpoint isn't a NULL */
833 int mtd_unpoint(struct mtd_info *mtd, loff_t from, size_t len)
834 {
835         if (!mtd->_point)
836                 return -EOPNOTSUPP;
837         if (from < 0 || from >= mtd->size || len > mtd->size - from)
838                 return -EINVAL;
839         if (!len)
840                 return 0;
841         return mtd->_unpoint(mtd, from, len);
842 }
843 EXPORT_SYMBOL_GPL(mtd_unpoint);
844
845 /*
846  * Allow NOMMU mmap() to directly map the device (if not NULL)
847  * - return the address to which the offset maps
848  * - return -ENOSYS to indicate refusal to do the mapping
849  */
850 unsigned long mtd_get_unmapped_area(struct mtd_info *mtd, unsigned long len,
851                                     unsigned long offset, unsigned long flags)
852 {
853         if (!mtd->_get_unmapped_area)
854                 return -EOPNOTSUPP;
855         if (offset >= mtd->size || len > mtd->size - offset)
856                 return -EINVAL;
857         return mtd->_get_unmapped_area(mtd, len, offset, flags);
858 }
859 EXPORT_SYMBOL_GPL(mtd_get_unmapped_area);
860
861 int mtd_read(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
862              u_char *buf)
863 {
864         int ret_code;
865         *retlen = 0;
866         if (from < 0 || from >= mtd->size || len > mtd->size - from)
867                 return -EINVAL;
868         if (!len)
869                 return 0;
870
871         /*
872          * In the absence of an error, drivers return a non-negative integer
873          * representing the maximum number of bitflips that were corrected on
874          * any one ecc region (if applicable; zero otherwise).
875          */
876         ret_code = mtd->_read(mtd, from, len, retlen, buf);
877         if (unlikely(ret_code < 0))
878                 return ret_code;
879         if (mtd->ecc_strength == 0)
880                 return 0;       /* device lacks ecc */
881         return ret_code >= mtd->bitflip_threshold ? -EUCLEAN : 0;
882 }
883 EXPORT_SYMBOL_GPL(mtd_read);
884
885 int mtd_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
886               const u_char *buf)
887 {
888         *retlen = 0;
889         if (to < 0 || to >= mtd->size || len > mtd->size - to)
890                 return -EINVAL;
891         if (!mtd->_write || !(mtd->flags & MTD_WRITEABLE))
892                 return -EROFS;
893         if (!len)
894                 return 0;
895         return mtd->_write(mtd, to, len, retlen, buf);
896 }
897 EXPORT_SYMBOL_GPL(mtd_write);
898
899 /*
900  * In blackbox flight recorder like scenarios we want to make successful writes
901  * in interrupt context. panic_write() is only intended to be called when its
902  * known the kernel is about to panic and we need the write to succeed. Since
903  * the kernel is not going to be running for much longer, this function can
904  * break locks and delay to ensure the write succeeds (but not sleep).
905  */
906 int mtd_panic_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
907                     const u_char *buf)
908 {
909         *retlen = 0;
910         if (!mtd->_panic_write)
911                 return -EOPNOTSUPP;
912         if (to < 0 || to >= mtd->size || len > mtd->size - to)
913                 return -EINVAL;
914         if (!(mtd->flags & MTD_WRITEABLE))
915                 return -EROFS;
916         if (!len)
917                 return 0;
918         return mtd->_panic_write(mtd, to, len, retlen, buf);
919 }
920 EXPORT_SYMBOL_GPL(mtd_panic_write);
921
922 int mtd_read_oob(struct mtd_info *mtd, loff_t from, struct mtd_oob_ops *ops)
923 {
924         int ret_code;
925         ops->retlen = ops->oobretlen = 0;
926         if (!mtd->_read_oob)
927                 return -EOPNOTSUPP;
928         /*
929          * In cases where ops->datbuf != NULL, mtd->_read_oob() has semantics
930          * similar to mtd->_read(), returning a non-negative integer
931          * representing max bitflips. In other cases, mtd->_read_oob() may
932          * return -EUCLEAN. In all cases, perform similar logic to mtd_read().
933          */
934         ret_code = mtd->_read_oob(mtd, from, ops);
935         if (unlikely(ret_code < 0))
936                 return ret_code;
937         if (mtd->ecc_strength == 0)
938                 return 0;       /* device lacks ecc */
939         return ret_code >= mtd->bitflip_threshold ? -EUCLEAN : 0;
940 }
941 EXPORT_SYMBOL_GPL(mtd_read_oob);
942
943 /*
944  * Method to access the protection register area, present in some flash
945  * devices. The user data is one time programmable but the factory data is read
946  * only.
947  */
948 int mtd_get_fact_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen,
949                            struct otp_info *buf)
950 {
951         if (!mtd->_get_fact_prot_info)
952                 return -EOPNOTSUPP;
953         if (!len)
954                 return 0;
955         return mtd->_get_fact_prot_info(mtd, len, retlen, buf);
956 }
957 EXPORT_SYMBOL_GPL(mtd_get_fact_prot_info);
958
959 int mtd_read_fact_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
960                            size_t *retlen, u_char *buf)
961 {
962         *retlen = 0;
963         if (!mtd->_read_fact_prot_reg)
964                 return -EOPNOTSUPP;
965         if (!len)
966                 return 0;
967         return mtd->_read_fact_prot_reg(mtd, from, len, retlen, buf);
968 }
969 EXPORT_SYMBOL_GPL(mtd_read_fact_prot_reg);
970
971 int mtd_get_user_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen,
972                            struct otp_info *buf)
973 {
974         if (!mtd->_get_user_prot_info)
975                 return -EOPNOTSUPP;
976         if (!len)
977                 return 0;
978         return mtd->_get_user_prot_info(mtd, len, retlen, buf);
979 }
980 EXPORT_SYMBOL_GPL(mtd_get_user_prot_info);
981
982 int mtd_read_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
983                            size_t *retlen, u_char *buf)
984 {
985         *retlen = 0;
986         if (!mtd->_read_user_prot_reg)
987                 return -EOPNOTSUPP;
988         if (!len)
989                 return 0;
990         return mtd->_read_user_prot_reg(mtd, from, len, retlen, buf);
991 }
992 EXPORT_SYMBOL_GPL(mtd_read_user_prot_reg);
993
994 int mtd_write_user_prot_reg(struct mtd_info *mtd, loff_t to, size_t len,
995                             size_t *retlen, u_char *buf)
996 {
997         int ret;
998
999         *retlen = 0;
1000         if (!mtd->_write_user_prot_reg)
1001                 return -EOPNOTSUPP;
1002         if (!len)
1003                 return 0;
1004         ret = mtd->_write_user_prot_reg(mtd, to, len, retlen, buf);
1005         if (ret)
1006                 return ret;
1007
1008         /*
1009          * If no data could be written at all, we are out of memory and
1010          * must return -ENOSPC.
1011          */
1012         return (*retlen) ? 0 : -ENOSPC;
1013 }
1014 EXPORT_SYMBOL_GPL(mtd_write_user_prot_reg);
1015
1016 int mtd_lock_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len)
1017 {
1018         if (!mtd->_lock_user_prot_reg)
1019                 return -EOPNOTSUPP;
1020         if (!len)
1021                 return 0;
1022         return mtd->_lock_user_prot_reg(mtd, from, len);
1023 }
1024 EXPORT_SYMBOL_GPL(mtd_lock_user_prot_reg);
1025
1026 /* Chip-supported device locking */
1027 int mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
1028 {
1029         if (!mtd->_lock)
1030                 return -EOPNOTSUPP;
1031         if (ofs < 0 || ofs >= mtd->size || len > mtd->size - ofs)
1032                 return -EINVAL;
1033         if (!len)
1034                 return 0;
1035         return mtd->_lock(mtd, ofs, len);
1036 }
1037 EXPORT_SYMBOL_GPL(mtd_lock);
1038
1039 int mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
1040 {
1041         if (!mtd->_unlock)
1042                 return -EOPNOTSUPP;
1043         if (ofs < 0 || ofs >= mtd->size || len > mtd->size - ofs)
1044                 return -EINVAL;
1045         if (!len)
1046                 return 0;
1047         return mtd->_unlock(mtd, ofs, len);
1048 }
1049 EXPORT_SYMBOL_GPL(mtd_unlock);
1050
1051 int mtd_is_locked(struct mtd_info *mtd, loff_t ofs, uint64_t len)
1052 {
1053         if (!mtd->_is_locked)
1054                 return -EOPNOTSUPP;
1055         if (ofs < 0 || ofs >= mtd->size || len > mtd->size - ofs)
1056                 return -EINVAL;
1057         if (!len)
1058                 return 0;
1059         return mtd->_is_locked(mtd, ofs, len);
1060 }
1061 EXPORT_SYMBOL_GPL(mtd_is_locked);
1062
1063 int mtd_block_isreserved(struct mtd_info *mtd, loff_t ofs)
1064 {
1065         if (ofs < 0 || ofs >= mtd->size)
1066                 return -EINVAL;
1067         if (!mtd->_block_isreserved)
1068                 return 0;
1069         return mtd->_block_isreserved(mtd, ofs);
1070 }
1071 EXPORT_SYMBOL_GPL(mtd_block_isreserved);
1072
1073 int mtd_block_isbad(struct mtd_info *mtd, loff_t ofs)
1074 {
1075         if (ofs < 0 || ofs >= mtd->size)
1076                 return -EINVAL;
1077         if (!mtd->_block_isbad)
1078                 return 0;
1079         return mtd->_block_isbad(mtd, ofs);
1080 }
1081 EXPORT_SYMBOL_GPL(mtd_block_isbad);
1082
1083 int mtd_block_markbad(struct mtd_info *mtd, loff_t ofs)
1084 {
1085         if (!mtd->_block_markbad)
1086                 return -EOPNOTSUPP;
1087         if (ofs < 0 || ofs >= mtd->size)
1088                 return -EINVAL;
1089         if (!(mtd->flags & MTD_WRITEABLE))
1090                 return -EROFS;
1091         return mtd->_block_markbad(mtd, ofs);
1092 }
1093 EXPORT_SYMBOL_GPL(mtd_block_markbad);
1094
1095 /*
1096  * default_mtd_writev - the default writev method
1097  * @mtd: mtd device description object pointer
1098  * @vecs: the vectors to write
1099  * @count: count of vectors in @vecs
1100  * @to: the MTD device offset to write to
1101  * @retlen: on exit contains the count of bytes written to the MTD device.
1102  *
1103  * This function returns zero in case of success and a negative error code in
1104  * case of failure.
1105  */
1106 static int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
1107                               unsigned long count, loff_t to, size_t *retlen)
1108 {
1109         unsigned long i;
1110         size_t totlen = 0, thislen;
1111         int ret = 0;
1112
1113         for (i = 0; i < count; i++) {
1114                 if (!vecs[i].iov_len)
1115                         continue;
1116                 ret = mtd_write(mtd, to, vecs[i].iov_len, &thislen,
1117                                 vecs[i].iov_base);
1118                 totlen += thislen;
1119                 if (ret || thislen != vecs[i].iov_len)
1120                         break;
1121                 to += vecs[i].iov_len;
1122         }
1123         *retlen = totlen;
1124         return ret;
1125 }
1126
1127 /*
1128  * mtd_writev - the vector-based MTD write method
1129  * @mtd: mtd device description object pointer
1130  * @vecs: the vectors to write
1131  * @count: count of vectors in @vecs
1132  * @to: the MTD device offset to write to
1133  * @retlen: on exit contains the count of bytes written to the MTD device.
1134  *
1135  * This function returns zero in case of success and a negative error code in
1136  * case of failure.
1137  */
1138 int mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
1139                unsigned long count, loff_t to, size_t *retlen)
1140 {
1141         *retlen = 0;
1142         if (!(mtd->flags & MTD_WRITEABLE))
1143                 return -EROFS;
1144         if (!mtd->_writev)
1145                 return default_mtd_writev(mtd, vecs, count, to, retlen);
1146         return mtd->_writev(mtd, vecs, count, to, retlen);
1147 }
1148 EXPORT_SYMBOL_GPL(mtd_writev);
1149
1150 /**
1151  * mtd_kmalloc_up_to - allocate a contiguous buffer up to the specified size
1152  * @mtd: mtd device description object pointer
1153  * @size: a pointer to the ideal or maximum size of the allocation, points
1154  *        to the actual allocation size on success.
1155  *
1156  * This routine attempts to allocate a contiguous kernel buffer up to
1157  * the specified size, backing off the size of the request exponentially
1158  * until the request succeeds or until the allocation size falls below
1159  * the system page size. This attempts to make sure it does not adversely
1160  * impact system performance, so when allocating more than one page, we
1161  * ask the memory allocator to avoid re-trying, swapping, writing back
1162  * or performing I/O.
1163  *
1164  * Note, this function also makes sure that the allocated buffer is aligned to
1165  * the MTD device's min. I/O unit, i.e. the "mtd->writesize" value.
1166  *
1167  * This is called, for example by mtd_{read,write} and jffs2_scan_medium,
1168  * to handle smaller (i.e. degraded) buffer allocations under low- or
1169  * fragmented-memory situations where such reduced allocations, from a
1170  * requested ideal, are allowed.
1171  *
1172  * Returns a pointer to the allocated buffer on success; otherwise, NULL.
1173  */
1174 void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size)
1175 {
1176         gfp_t flags = __GFP_NOWARN | __GFP_WAIT |
1177                        __GFP_NORETRY | __GFP_NO_KSWAPD;
1178         size_t min_alloc = max_t(size_t, mtd->writesize, PAGE_SIZE);
1179         void *kbuf;
1180
1181         *size = min_t(size_t, *size, KMALLOC_MAX_SIZE);
1182
1183         while (*size > min_alloc) {
1184                 kbuf = kmalloc(*size, flags);
1185                 if (kbuf)
1186                         return kbuf;
1187
1188                 *size >>= 1;
1189                 *size = ALIGN(*size, mtd->writesize);
1190         }
1191
1192         /*
1193          * For the last resort allocation allow 'kmalloc()' to do all sorts of
1194          * things (write-back, dropping caches, etc) by using GFP_KERNEL.
1195          */
1196         return kmalloc(*size, GFP_KERNEL);
1197 }
1198 EXPORT_SYMBOL_GPL(mtd_kmalloc_up_to);
1199
1200 #ifdef CONFIG_PROC_FS
1201
1202 /*====================================================================*/
1203 /* Support for /proc/mtd */
1204
1205 static int mtd_proc_show(struct seq_file *m, void *v)
1206 {
1207         struct mtd_info *mtd;
1208
1209         seq_puts(m, "dev:    size   erasesize  name\n");
1210         mutex_lock(&mtd_table_mutex);
1211         mtd_for_each_device(mtd) {
1212                 seq_printf(m, "mtd%d: %8.8llx %8.8x \"%s\"\n",
1213                            mtd->index, (unsigned long long)mtd->size,
1214                            mtd->erasesize, mtd->name);
1215         }
1216         mutex_unlock(&mtd_table_mutex);
1217         return 0;
1218 }
1219
1220 static int mtd_proc_open(struct inode *inode, struct file *file)
1221 {
1222         return single_open(file, mtd_proc_show, NULL);
1223 }
1224
1225 static const struct file_operations mtd_proc_ops = {
1226         .open           = mtd_proc_open,
1227         .read           = seq_read,
1228         .llseek         = seq_lseek,
1229         .release        = single_release,
1230 };
1231 #endif /* CONFIG_PROC_FS */
1232
1233 /*====================================================================*/
1234 /* Init code */
1235
1236 static int __init mtd_bdi_init(struct backing_dev_info *bdi, const char *name)
1237 {
1238         int ret;
1239
1240         ret = bdi_init(bdi);
1241         if (!ret)
1242                 ret = bdi_register(bdi, NULL, "%s", name);
1243
1244         if (ret)
1245                 bdi_destroy(bdi);
1246
1247         return ret;
1248 }
1249
1250 static struct proc_dir_entry *proc_mtd;
1251
1252 static int __init init_mtd(void)
1253 {
1254         int ret;
1255
1256         ret = class_register(&mtd_class);
1257         if (ret)
1258                 goto err_reg;
1259
1260         ret = mtd_bdi_init(&mtd_bdi_unmappable, "mtd-unmap");
1261         if (ret)
1262                 goto err_bdi1;
1263
1264         ret = mtd_bdi_init(&mtd_bdi_ro_mappable, "mtd-romap");
1265         if (ret)
1266                 goto err_bdi2;
1267
1268         ret = mtd_bdi_init(&mtd_bdi_rw_mappable, "mtd-rwmap");
1269         if (ret)
1270                 goto err_bdi3;
1271
1272         proc_mtd = proc_create("mtd", 0, NULL, &mtd_proc_ops);
1273
1274         ret = init_mtdchar();
1275         if (ret)
1276                 goto out_procfs;
1277
1278         return 0;
1279
1280 out_procfs:
1281         if (proc_mtd)
1282                 remove_proc_entry("mtd", NULL);
1283 err_bdi3:
1284         bdi_destroy(&mtd_bdi_ro_mappable);
1285 err_bdi2:
1286         bdi_destroy(&mtd_bdi_unmappable);
1287 err_bdi1:
1288         class_unregister(&mtd_class);
1289 err_reg:
1290         pr_err("Error registering mtd class or bdi: %d\n", ret);
1291         return ret;
1292 }
1293
1294 static void __exit cleanup_mtd(void)
1295 {
1296         cleanup_mtdchar();
1297         if (proc_mtd)
1298                 remove_proc_entry("mtd", NULL);
1299         class_unregister(&mtd_class);
1300         bdi_destroy(&mtd_bdi_unmappable);
1301         bdi_destroy(&mtd_bdi_ro_mappable);
1302         bdi_destroy(&mtd_bdi_rw_mappable);
1303 }
1304
1305 module_init(init_mtd);
1306 module_exit(cleanup_mtd);
1307
1308 MODULE_LICENSE("GPL");
1309 MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
1310 MODULE_DESCRIPTION("Core MTD registration and access routines");