1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Core registration and callback routines for MTD
6 * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org>
7 * Copyright © 2006 Red Hat UK Limited
10 #include <linux/module.h>
11 #include <linux/kernel.h>
12 #include <linux/ptrace.h>
13 #include <linux/seq_file.h>
14 #include <linux/string.h>
15 #include <linux/timer.h>
16 #include <linux/major.h>
18 #include <linux/err.h>
19 #include <linux/ioctl.h>
20 #include <linux/init.h>
22 #include <linux/proc_fs.h>
23 #include <linux/idr.h>
24 #include <linux/backing-dev.h>
25 #include <linux/gfp.h>
26 #include <linux/slab.h>
27 #include <linux/reboot.h>
28 #include <linux/leds.h>
29 #include <linux/debugfs.h>
30 #include <linux/nvmem-provider.h>
32 #include <linux/mtd/mtd.h>
33 #include <linux/mtd/partitions.h>
37 struct backing_dev_info *mtd_bdi;
39 #ifdef CONFIG_PM_SLEEP
41 static int mtd_cls_suspend(struct device *dev)
43 struct mtd_info *mtd = dev_get_drvdata(dev);
45 return mtd ? mtd_suspend(mtd) : 0;
48 static int mtd_cls_resume(struct device *dev)
50 struct mtd_info *mtd = dev_get_drvdata(dev);
57 static SIMPLE_DEV_PM_OPS(mtd_cls_pm_ops, mtd_cls_suspend, mtd_cls_resume);
58 #define MTD_CLS_PM_OPS (&mtd_cls_pm_ops)
60 #define MTD_CLS_PM_OPS NULL
63 static struct class mtd_class = {
69 static DEFINE_IDR(mtd_idr);
71 /* These are exported solely for the purpose of mtd_blkdevs.c. You
72 should not use them for _anything_ else */
73 DEFINE_MUTEX(mtd_table_mutex);
74 EXPORT_SYMBOL_GPL(mtd_table_mutex);
76 struct mtd_info *__mtd_next_device(int i)
78 return idr_get_next(&mtd_idr, &i);
80 EXPORT_SYMBOL_GPL(__mtd_next_device);
82 static LIST_HEAD(mtd_notifiers);
85 #define MTD_DEVT(index) MKDEV(MTD_CHAR_MAJOR, (index)*2)
87 /* REVISIT once MTD uses the driver model better, whoever allocates
88 * the mtd_info will probably want to use the release() hook...
90 static void mtd_release(struct device *dev)
92 struct mtd_info *mtd = dev_get_drvdata(dev);
93 dev_t index = MTD_DEVT(mtd->index);
95 /* remove /dev/mtdXro node */
96 device_destroy(&mtd_class, index + 1);
99 #define MTD_DEVICE_ATTR_RO(name) \
100 static DEVICE_ATTR(name, 0444, mtd_##name##_show, NULL)
102 #define MTD_DEVICE_ATTR_RW(name) \
103 static DEVICE_ATTR(name, 0644, mtd_##name##_show, mtd_##name##_store)
105 static ssize_t mtd_type_show(struct device *dev,
106 struct device_attribute *attr, char *buf)
108 struct mtd_info *mtd = dev_get_drvdata(dev);
133 case MTD_MLCNANDFLASH:
140 return sysfs_emit(buf, "%s\n", type);
142 MTD_DEVICE_ATTR_RO(type);
144 static ssize_t mtd_flags_show(struct device *dev,
145 struct device_attribute *attr, char *buf)
147 struct mtd_info *mtd = dev_get_drvdata(dev);
149 return sysfs_emit(buf, "0x%lx\n", (unsigned long)mtd->flags);
151 MTD_DEVICE_ATTR_RO(flags);
153 static ssize_t mtd_size_show(struct device *dev,
154 struct device_attribute *attr, char *buf)
156 struct mtd_info *mtd = dev_get_drvdata(dev);
158 return sysfs_emit(buf, "%llu\n", (unsigned long long)mtd->size);
160 MTD_DEVICE_ATTR_RO(size);
162 static ssize_t mtd_erasesize_show(struct device *dev,
163 struct device_attribute *attr, char *buf)
165 struct mtd_info *mtd = dev_get_drvdata(dev);
167 return sysfs_emit(buf, "%lu\n", (unsigned long)mtd->erasesize);
169 MTD_DEVICE_ATTR_RO(erasesize);
171 static ssize_t mtd_writesize_show(struct device *dev,
172 struct device_attribute *attr, char *buf)
174 struct mtd_info *mtd = dev_get_drvdata(dev);
176 return sysfs_emit(buf, "%lu\n", (unsigned long)mtd->writesize);
178 MTD_DEVICE_ATTR_RO(writesize);
180 static ssize_t mtd_subpagesize_show(struct device *dev,
181 struct device_attribute *attr, char *buf)
183 struct mtd_info *mtd = dev_get_drvdata(dev);
184 unsigned int subpagesize = mtd->writesize >> mtd->subpage_sft;
186 return sysfs_emit(buf, "%u\n", subpagesize);
188 MTD_DEVICE_ATTR_RO(subpagesize);
190 static ssize_t mtd_oobsize_show(struct device *dev,
191 struct device_attribute *attr, char *buf)
193 struct mtd_info *mtd = dev_get_drvdata(dev);
195 return sysfs_emit(buf, "%lu\n", (unsigned long)mtd->oobsize);
197 MTD_DEVICE_ATTR_RO(oobsize);
199 static ssize_t mtd_oobavail_show(struct device *dev,
200 struct device_attribute *attr, char *buf)
202 struct mtd_info *mtd = dev_get_drvdata(dev);
204 return sysfs_emit(buf, "%u\n", mtd->oobavail);
206 MTD_DEVICE_ATTR_RO(oobavail);
208 static ssize_t mtd_numeraseregions_show(struct device *dev,
209 struct device_attribute *attr, char *buf)
211 struct mtd_info *mtd = dev_get_drvdata(dev);
213 return sysfs_emit(buf, "%u\n", mtd->numeraseregions);
215 MTD_DEVICE_ATTR_RO(numeraseregions);
217 static ssize_t mtd_name_show(struct device *dev,
218 struct device_attribute *attr, char *buf)
220 struct mtd_info *mtd = dev_get_drvdata(dev);
222 return sysfs_emit(buf, "%s\n", mtd->name);
224 MTD_DEVICE_ATTR_RO(name);
226 static ssize_t mtd_ecc_strength_show(struct device *dev,
227 struct device_attribute *attr, char *buf)
229 struct mtd_info *mtd = dev_get_drvdata(dev);
231 return sysfs_emit(buf, "%u\n", mtd->ecc_strength);
233 MTD_DEVICE_ATTR_RO(ecc_strength);
235 static ssize_t mtd_bitflip_threshold_show(struct device *dev,
236 struct device_attribute *attr,
239 struct mtd_info *mtd = dev_get_drvdata(dev);
241 return sysfs_emit(buf, "%u\n", mtd->bitflip_threshold);
244 static ssize_t mtd_bitflip_threshold_store(struct device *dev,
245 struct device_attribute *attr,
246 const char *buf, size_t count)
248 struct mtd_info *mtd = dev_get_drvdata(dev);
249 unsigned int bitflip_threshold;
252 retval = kstrtouint(buf, 0, &bitflip_threshold);
256 mtd->bitflip_threshold = bitflip_threshold;
259 MTD_DEVICE_ATTR_RW(bitflip_threshold);
261 static ssize_t mtd_ecc_step_size_show(struct device *dev,
262 struct device_attribute *attr, char *buf)
264 struct mtd_info *mtd = dev_get_drvdata(dev);
266 return sysfs_emit(buf, "%u\n", mtd->ecc_step_size);
269 MTD_DEVICE_ATTR_RO(ecc_step_size);
271 static ssize_t mtd_corrected_bits_show(struct device *dev,
272 struct device_attribute *attr, char *buf)
274 struct mtd_info *mtd = dev_get_drvdata(dev);
275 struct mtd_ecc_stats *ecc_stats = &mtd->ecc_stats;
277 return sysfs_emit(buf, "%u\n", ecc_stats->corrected);
279 MTD_DEVICE_ATTR_RO(corrected_bits); /* ecc stats corrected */
281 static ssize_t mtd_ecc_failures_show(struct device *dev,
282 struct device_attribute *attr, char *buf)
284 struct mtd_info *mtd = dev_get_drvdata(dev);
285 struct mtd_ecc_stats *ecc_stats = &mtd->ecc_stats;
287 return sysfs_emit(buf, "%u\n", ecc_stats->failed);
289 MTD_DEVICE_ATTR_RO(ecc_failures); /* ecc stats errors */
291 static ssize_t mtd_bad_blocks_show(struct device *dev,
292 struct device_attribute *attr, char *buf)
294 struct mtd_info *mtd = dev_get_drvdata(dev);
295 struct mtd_ecc_stats *ecc_stats = &mtd->ecc_stats;
297 return sysfs_emit(buf, "%u\n", ecc_stats->badblocks);
299 MTD_DEVICE_ATTR_RO(bad_blocks);
301 static ssize_t mtd_bbt_blocks_show(struct device *dev,
302 struct device_attribute *attr, char *buf)
304 struct mtd_info *mtd = dev_get_drvdata(dev);
305 struct mtd_ecc_stats *ecc_stats = &mtd->ecc_stats;
307 return sysfs_emit(buf, "%u\n", ecc_stats->bbtblocks);
309 MTD_DEVICE_ATTR_RO(bbt_blocks);
311 static struct attribute *mtd_attrs[] = {
313 &dev_attr_flags.attr,
315 &dev_attr_erasesize.attr,
316 &dev_attr_writesize.attr,
317 &dev_attr_subpagesize.attr,
318 &dev_attr_oobsize.attr,
319 &dev_attr_oobavail.attr,
320 &dev_attr_numeraseregions.attr,
322 &dev_attr_ecc_strength.attr,
323 &dev_attr_ecc_step_size.attr,
324 &dev_attr_corrected_bits.attr,
325 &dev_attr_ecc_failures.attr,
326 &dev_attr_bad_blocks.attr,
327 &dev_attr_bbt_blocks.attr,
328 &dev_attr_bitflip_threshold.attr,
331 ATTRIBUTE_GROUPS(mtd);
333 static const struct device_type mtd_devtype = {
335 .groups = mtd_groups,
336 .release = mtd_release,
339 static bool mtd_expert_analysis_mode;
341 #ifdef CONFIG_DEBUG_FS
342 bool mtd_check_expert_analysis_mode(void)
344 const char *mtd_expert_analysis_warning =
345 "Bad block checks have been entirely disabled.\n"
346 "This is only reserved for post-mortem forensics and debug purposes.\n"
347 "Never enable this mode if you do not know what you are doing!\n";
349 return WARN_ONCE(mtd_expert_analysis_mode, mtd_expert_analysis_warning);
351 EXPORT_SYMBOL_GPL(mtd_check_expert_analysis_mode);
354 static struct dentry *dfs_dir_mtd;
356 static void mtd_debugfs_populate(struct mtd_info *mtd)
358 struct device *dev = &mtd->dev;
360 if (IS_ERR_OR_NULL(dfs_dir_mtd))
363 mtd->dbg.dfs_dir = debugfs_create_dir(dev_name(dev), dfs_dir_mtd);
367 unsigned mtd_mmap_capabilities(struct mtd_info *mtd)
371 return NOMMU_MAP_COPY | NOMMU_MAP_DIRECT | NOMMU_MAP_EXEC |
372 NOMMU_MAP_READ | NOMMU_MAP_WRITE;
374 return NOMMU_MAP_COPY | NOMMU_MAP_DIRECT | NOMMU_MAP_EXEC |
377 return NOMMU_MAP_COPY;
380 EXPORT_SYMBOL_GPL(mtd_mmap_capabilities);
383 static int mtd_reboot_notifier(struct notifier_block *n, unsigned long state,
386 struct mtd_info *mtd;
388 mtd = container_of(n, struct mtd_info, reboot_notifier);
395 * mtd_wunit_to_pairing_info - get pairing information of a wunit
396 * @mtd: pointer to new MTD device info structure
397 * @wunit: write unit we are interested in
398 * @info: returned pairing information
400 * Retrieve pairing information associated to the wunit.
401 * This is mainly useful when dealing with MLC/TLC NANDs where pages can be
402 * paired together, and where programming a page may influence the page it is
404 * The notion of page is replaced by the term wunit (write-unit) to stay
405 * consistent with the ->writesize field.
407 * The @wunit argument can be extracted from an absolute offset using
408 * mtd_offset_to_wunit(). @info is filled with the pairing information attached
411 * From the pairing info the MTD user can find all the wunits paired with
412 * @wunit using the following loop:
414 * for (i = 0; i < mtd_pairing_groups(mtd); i++) {
416 * mtd_pairing_info_to_wunit(mtd, &info);
420 int mtd_wunit_to_pairing_info(struct mtd_info *mtd, int wunit,
421 struct mtd_pairing_info *info)
423 struct mtd_info *master = mtd_get_master(mtd);
424 int npairs = mtd_wunit_per_eb(master) / mtd_pairing_groups(master);
426 if (wunit < 0 || wunit >= npairs)
429 if (master->pairing && master->pairing->get_info)
430 return master->pairing->get_info(master, wunit, info);
437 EXPORT_SYMBOL_GPL(mtd_wunit_to_pairing_info);
440 * mtd_pairing_info_to_wunit - get wunit from pairing information
441 * @mtd: pointer to new MTD device info structure
442 * @info: pairing information struct
444 * Returns a positive number representing the wunit associated to the info
445 * struct, or a negative error code.
447 * This is the reverse of mtd_wunit_to_pairing_info(), and can help one to
448 * iterate over all wunits of a given pair (see mtd_wunit_to_pairing_info()
451 * It can also be used to only program the first page of each pair (i.e.
452 * page attached to group 0), which allows one to use an MLC NAND in
453 * software-emulated SLC mode:
456 * npairs = mtd_wunit_per_eb(mtd) / mtd_pairing_groups(mtd);
457 * for (info.pair = 0; info.pair < npairs; info.pair++) {
458 * wunit = mtd_pairing_info_to_wunit(mtd, &info);
459 * mtd_write(mtd, mtd_wunit_to_offset(mtd, blkoffs, wunit),
460 * mtd->writesize, &retlen, buf + (i * mtd->writesize));
463 int mtd_pairing_info_to_wunit(struct mtd_info *mtd,
464 const struct mtd_pairing_info *info)
466 struct mtd_info *master = mtd_get_master(mtd);
467 int ngroups = mtd_pairing_groups(master);
468 int npairs = mtd_wunit_per_eb(master) / ngroups;
470 if (!info || info->pair < 0 || info->pair >= npairs ||
471 info->group < 0 || info->group >= ngroups)
474 if (master->pairing && master->pairing->get_wunit)
475 return mtd->pairing->get_wunit(master, info);
479 EXPORT_SYMBOL_GPL(mtd_pairing_info_to_wunit);
482 * mtd_pairing_groups - get the number of pairing groups
483 * @mtd: pointer to new MTD device info structure
485 * Returns the number of pairing groups.
487 * This number is usually equal to the number of bits exposed by a single
488 * cell, and can be used in conjunction with mtd_pairing_info_to_wunit()
489 * to iterate over all pages of a given pair.
491 int mtd_pairing_groups(struct mtd_info *mtd)
493 struct mtd_info *master = mtd_get_master(mtd);
495 if (!master->pairing || !master->pairing->ngroups)
498 return master->pairing->ngroups;
500 EXPORT_SYMBOL_GPL(mtd_pairing_groups);
502 static int mtd_nvmem_reg_read(void *priv, unsigned int offset,
503 void *val, size_t bytes)
505 struct mtd_info *mtd = priv;
509 err = mtd_read(mtd, offset, bytes, &retlen, val);
510 if (err && err != -EUCLEAN)
513 return retlen == bytes ? 0 : -EIO;
516 static int mtd_nvmem_add(struct mtd_info *mtd)
518 struct device_node *node = mtd_get_of_node(mtd);
519 struct nvmem_config config = {};
522 config.dev = &mtd->dev;
523 config.name = dev_name(&mtd->dev);
524 config.owner = THIS_MODULE;
525 config.reg_read = mtd_nvmem_reg_read;
526 config.size = mtd->size;
527 config.word_size = 1;
529 config.read_only = true;
530 config.root_only = true;
531 config.ignore_wp = true;
532 config.no_of_node = !of_device_is_compatible(node, "nvmem-cells");
535 mtd->nvmem = nvmem_register(&config);
536 if (IS_ERR(mtd->nvmem)) {
537 /* Just ignore if there is no NVMEM support in the kernel */
538 if (PTR_ERR(mtd->nvmem) == -EOPNOTSUPP) {
541 dev_err(&mtd->dev, "Failed to register NVMEM device\n");
542 return PTR_ERR(mtd->nvmem);
549 static void mtd_check_of_node(struct mtd_info *mtd)
551 struct device_node *partitions, *parent_dn, *mtd_dn = NULL;
552 const char *pname, *prefix = "partition-";
553 int plen, mtd_name_len, offset, prefix_len;
554 struct mtd_info *parent;
557 /* Check if MTD already has a device node */
558 if (dev_of_node(&mtd->dev))
561 /* Check if a partitions node exist */
562 if (!mtd_is_partition(mtd))
564 parent = mtd->parent;
565 parent_dn = dev_of_node(&parent->dev);
569 partitions = of_get_child_by_name(parent_dn, "partitions");
573 prefix_len = strlen(prefix);
574 mtd_name_len = strlen(mtd->name);
576 /* Search if a partition is defined with the same name */
577 for_each_child_of_node(partitions, mtd_dn) {
580 /* Skip partition with no/wrong prefix */
581 if (!of_node_name_prefix(mtd_dn, "partition-"))
584 /* Label have priority. Check that first */
585 if (of_property_read_string(mtd_dn, "label", &pname)) {
586 of_property_read_string(mtd_dn, "name", &pname);
590 plen = strlen(pname) - offset;
591 if (plen == mtd_name_len &&
592 !strncmp(mtd->name, pname + offset, plen)) {
599 goto exit_partitions;
601 /* Set of_node only for nvmem */
602 if (of_device_is_compatible(mtd_dn, "nvmem-cells"))
603 mtd_set_of_node(mtd, mtd_dn);
606 of_node_put(partitions);
608 of_node_put(parent_dn);
612 * add_mtd_device - register an MTD device
613 * @mtd: pointer to new MTD device info structure
615 * Add a device to the list of MTD devices present in the system, and
616 * notify each currently active MTD 'user' of its arrival. Returns
617 * zero on success or non-zero on failure.
620 int add_mtd_device(struct mtd_info *mtd)
622 struct device_node *np = mtd_get_of_node(mtd);
623 struct mtd_info *master = mtd_get_master(mtd);
624 struct mtd_notifier *not;
628 * May occur, for instance, on buggy drivers which call
629 * mtd_device_parse_register() multiple times on the same master MTD,
630 * especially with CONFIG_MTD_PARTITIONED_MASTER=y.
632 if (WARN_ONCE(mtd->dev.type, "MTD already registered\n"))
635 BUG_ON(mtd->writesize == 0);
638 * MTD drivers should implement ->_{write,read}() or
639 * ->_{write,read}_oob(), but not both.
641 if (WARN_ON((mtd->_write && mtd->_write_oob) ||
642 (mtd->_read && mtd->_read_oob)))
645 if (WARN_ON((!mtd->erasesize || !master->_erase) &&
646 !(mtd->flags & MTD_NO_ERASE)))
650 * MTD_SLC_ON_MLC_EMULATION can only be set on partitions, when the
651 * master is an MLC NAND and has a proper pairing scheme defined.
652 * We also reject masters that implement ->_writev() for now, because
653 * NAND controller drivers don't implement this hook, and adding the
654 * SLC -> MLC address/length conversion to this path is useless if we
657 if (mtd->flags & MTD_SLC_ON_MLC_EMULATION &&
658 (!mtd_is_partition(mtd) || master->type != MTD_MLCNANDFLASH ||
659 !master->pairing || master->_writev))
662 mutex_lock(&mtd_table_mutex);
666 ofidx = of_alias_get_id(np, "mtd");
668 i = idr_alloc(&mtd_idr, mtd, ofidx, ofidx + 1, GFP_KERNEL);
670 i = idr_alloc(&mtd_idr, mtd, 0, 0, GFP_KERNEL);
679 /* default value if not set by driver */
680 if (mtd->bitflip_threshold == 0)
681 mtd->bitflip_threshold = mtd->ecc_strength;
683 if (mtd->flags & MTD_SLC_ON_MLC_EMULATION) {
684 int ngroups = mtd_pairing_groups(master);
686 mtd->erasesize /= ngroups;
687 mtd->size = (u64)mtd_div_by_eb(mtd->size, master) *
691 if (is_power_of_2(mtd->erasesize))
692 mtd->erasesize_shift = ffs(mtd->erasesize) - 1;
694 mtd->erasesize_shift = 0;
696 if (is_power_of_2(mtd->writesize))
697 mtd->writesize_shift = ffs(mtd->writesize) - 1;
699 mtd->writesize_shift = 0;
701 mtd->erasesize_mask = (1 << mtd->erasesize_shift) - 1;
702 mtd->writesize_mask = (1 << mtd->writesize_shift) - 1;
704 /* Some chips always power up locked. Unlock them now */
705 if ((mtd->flags & MTD_WRITEABLE) && (mtd->flags & MTD_POWERUP_LOCK)) {
706 error = mtd_unlock(mtd, 0, mtd->size);
707 if (error && error != -EOPNOTSUPP)
709 "%s: unlock failed, writes may not work\n",
711 /* Ignore unlock failures? */
715 /* Caller should have set dev.parent to match the
716 * physical device, if appropriate.
718 mtd->dev.type = &mtd_devtype;
719 mtd->dev.class = &mtd_class;
720 mtd->dev.devt = MTD_DEVT(i);
721 dev_set_name(&mtd->dev, "mtd%d", i);
722 dev_set_drvdata(&mtd->dev, mtd);
723 mtd_check_of_node(mtd);
724 of_node_get(mtd_get_of_node(mtd));
725 error = device_register(&mtd->dev);
729 /* Add the nvmem provider */
730 error = mtd_nvmem_add(mtd);
734 mtd_debugfs_populate(mtd);
736 device_create(&mtd_class, mtd->dev.parent, MTD_DEVT(i) + 1, NULL,
739 pr_debug("mtd: Giving out device %d to %s\n", i, mtd->name);
740 /* No need to get a refcount on the module containing
741 the notifier, since we hold the mtd_table_mutex */
742 list_for_each_entry(not, &mtd_notifiers, list)
745 mutex_unlock(&mtd_table_mutex);
746 /* We _know_ we aren't being removed, because
747 our caller is still holding us here. So none
748 of this try_ nonsense, and no bitching about it
750 __module_get(THIS_MODULE);
754 device_unregister(&mtd->dev);
756 of_node_put(mtd_get_of_node(mtd));
757 idr_remove(&mtd_idr, i);
759 mutex_unlock(&mtd_table_mutex);
764 * del_mtd_device - unregister an MTD device
765 * @mtd: pointer to MTD device info structure
767 * Remove a device from the list of MTD devices present in the system,
768 * and notify each currently active MTD 'user' of its departure.
769 * Returns zero on success or 1 on failure, which currently will happen
770 * if the requested device does not appear to be present in the list.
773 int del_mtd_device(struct mtd_info *mtd)
776 struct mtd_notifier *not;
778 mutex_lock(&mtd_table_mutex);
780 if (idr_find(&mtd_idr, mtd->index) != mtd) {
785 /* No need to get a refcount on the module containing
786 the notifier, since we hold the mtd_table_mutex */
787 list_for_each_entry(not, &mtd_notifiers, list)
791 printk(KERN_NOTICE "Removing MTD device #%d (%s) with use count %d\n",
792 mtd->index, mtd->name, mtd->usecount);
795 debugfs_remove_recursive(mtd->dbg.dfs_dir);
797 /* Try to remove the NVMEM provider */
798 nvmem_unregister(mtd->nvmem);
800 device_unregister(&mtd->dev);
802 /* Clear dev so mtd can be safely re-registered later if desired */
803 memset(&mtd->dev, 0, sizeof(mtd->dev));
805 idr_remove(&mtd_idr, mtd->index);
806 of_node_put(mtd_get_of_node(mtd));
808 module_put(THIS_MODULE);
813 mutex_unlock(&mtd_table_mutex);
818 * Set a few defaults based on the parent devices, if not provided by the
821 static void mtd_set_dev_defaults(struct mtd_info *mtd)
823 if (mtd->dev.parent) {
824 if (!mtd->owner && mtd->dev.parent->driver)
825 mtd->owner = mtd->dev.parent->driver->owner;
827 mtd->name = dev_name(mtd->dev.parent);
829 pr_debug("mtd device won't show a device symlink in sysfs\n");
832 INIT_LIST_HEAD(&mtd->partitions);
833 mutex_init(&mtd->master.partitions_lock);
834 mutex_init(&mtd->master.chrdev_lock);
837 static ssize_t mtd_otp_size(struct mtd_info *mtd, bool is_user)
839 struct otp_info *info;
845 info = kmalloc(PAGE_SIZE, GFP_KERNEL);
850 ret = mtd_get_user_prot_info(mtd, PAGE_SIZE, &retlen, info);
852 ret = mtd_get_fact_prot_info(mtd, PAGE_SIZE, &retlen, info);
856 for (i = 0; i < retlen / sizeof(*info); i++)
857 size += info[i].length;
865 /* ENODATA means there is no OTP region. */
866 return ret == -ENODATA ? 0 : ret;
869 static struct nvmem_device *mtd_otp_nvmem_register(struct mtd_info *mtd,
870 const char *compatible,
872 nvmem_reg_read_t reg_read)
874 struct nvmem_device *nvmem = NULL;
875 struct nvmem_config config = {};
876 struct device_node *np;
878 /* DT binding is optional */
879 np = of_get_compatible_child(mtd->dev.of_node, compatible);
881 /* OTP nvmem will be registered on the physical device */
882 config.dev = mtd->dev.parent;
883 config.name = kasprintf(GFP_KERNEL, "%s-%s", dev_name(&mtd->dev), compatible);
884 config.id = NVMEM_DEVID_NONE;
885 config.owner = THIS_MODULE;
886 config.type = NVMEM_TYPE_OTP;
887 config.root_only = true;
888 config.ignore_wp = true;
889 config.reg_read = reg_read;
894 nvmem = nvmem_register(&config);
895 /* Just ignore if there is no NVMEM support in the kernel */
896 if (IS_ERR(nvmem) && PTR_ERR(nvmem) == -EOPNOTSUPP)
905 static int mtd_nvmem_user_otp_reg_read(void *priv, unsigned int offset,
906 void *val, size_t bytes)
908 struct mtd_info *mtd = priv;
912 ret = mtd_read_user_prot_reg(mtd, offset, bytes, &retlen, val);
916 return retlen == bytes ? 0 : -EIO;
919 static int mtd_nvmem_fact_otp_reg_read(void *priv, unsigned int offset,
920 void *val, size_t bytes)
922 struct mtd_info *mtd = priv;
926 ret = mtd_read_fact_prot_reg(mtd, offset, bytes, &retlen, val);
930 return retlen == bytes ? 0 : -EIO;
933 static int mtd_otp_nvmem_add(struct mtd_info *mtd)
935 struct nvmem_device *nvmem;
939 if (mtd->_get_user_prot_info && mtd->_read_user_prot_reg) {
940 size = mtd_otp_size(mtd, true);
945 nvmem = mtd_otp_nvmem_register(mtd, "user-otp", size,
946 mtd_nvmem_user_otp_reg_read);
948 dev_err(&mtd->dev, "Failed to register OTP NVMEM device\n");
949 return PTR_ERR(nvmem);
951 mtd->otp_user_nvmem = nvmem;
955 if (mtd->_get_fact_prot_info && mtd->_read_fact_prot_reg) {
956 size = mtd_otp_size(mtd, false);
963 nvmem = mtd_otp_nvmem_register(mtd, "factory-otp", size,
964 mtd_nvmem_fact_otp_reg_read);
966 dev_err(&mtd->dev, "Failed to register OTP NVMEM device\n");
967 err = PTR_ERR(nvmem);
970 mtd->otp_factory_nvmem = nvmem;
977 nvmem_unregister(mtd->otp_user_nvmem);
982 * mtd_device_parse_register - parse partitions and register an MTD device.
984 * @mtd: the MTD device to register
985 * @types: the list of MTD partition probes to try, see
986 * 'parse_mtd_partitions()' for more information
987 * @parser_data: MTD partition parser-specific data
988 * @parts: fallback partition information to register, if parsing fails;
989 * only valid if %nr_parts > %0
990 * @nr_parts: the number of partitions in parts, if zero then the full
991 * MTD device is registered if no partition info is found
993 * This function aggregates MTD partitions parsing (done by
994 * 'parse_mtd_partitions()') and MTD device and partitions registering. It
995 * basically follows the most common pattern found in many MTD drivers:
997 * * If the MTD_PARTITIONED_MASTER option is set, then the device as a whole is
999 * * Then It tries to probe partitions on MTD device @mtd using parsers
1000 * specified in @types (if @types is %NULL, then the default list of parsers
1001 * is used, see 'parse_mtd_partitions()' for more information). If none are
1002 * found this functions tries to fallback to information specified in
1004 * * If no partitions were found this function just registers the MTD device
1007 * Returns zero in case of success and a negative error code in case of failure.
1009 int mtd_device_parse_register(struct mtd_info *mtd, const char * const *types,
1010 struct mtd_part_parser_data *parser_data,
1011 const struct mtd_partition *parts,
1016 mtd_set_dev_defaults(mtd);
1018 if (IS_ENABLED(CONFIG_MTD_PARTITIONED_MASTER)) {
1019 ret = add_mtd_device(mtd);
1024 /* Prefer parsed partitions over driver-provided fallback */
1025 ret = parse_mtd_partitions(mtd, types, parser_data);
1026 if (ret == -EPROBE_DEFER)
1032 ret = add_mtd_partitions(mtd, parts, nr_parts);
1033 else if (!device_is_registered(&mtd->dev))
1034 ret = add_mtd_device(mtd);
1042 * FIXME: some drivers unfortunately call this function more than once.
1043 * So we have to check if we've already assigned the reboot notifier.
1045 * Generally, we can make multiple calls work for most cases, but it
1046 * does cause problems with parse_mtd_partitions() above (e.g.,
1047 * cmdlineparts will register partitions more than once).
1049 WARN_ONCE(mtd->_reboot && mtd->reboot_notifier.notifier_call,
1050 "MTD already registered\n");
1051 if (mtd->_reboot && !mtd->reboot_notifier.notifier_call) {
1052 mtd->reboot_notifier.notifier_call = mtd_reboot_notifier;
1053 register_reboot_notifier(&mtd->reboot_notifier);
1056 ret = mtd_otp_nvmem_add(mtd);
1059 if (ret && device_is_registered(&mtd->dev))
1060 del_mtd_device(mtd);
1064 EXPORT_SYMBOL_GPL(mtd_device_parse_register);
1067 * mtd_device_unregister - unregister an existing MTD device.
1069 * @master: the MTD device to unregister. This will unregister both the master
1070 * and any partitions if registered.
1072 int mtd_device_unregister(struct mtd_info *master)
1076 if (master->_reboot) {
1077 unregister_reboot_notifier(&master->reboot_notifier);
1078 memset(&master->reboot_notifier, 0, sizeof(master->reboot_notifier));
1081 nvmem_unregister(master->otp_user_nvmem);
1082 nvmem_unregister(master->otp_factory_nvmem);
1084 err = del_mtd_partitions(master);
1088 if (!device_is_registered(&master->dev))
1091 return del_mtd_device(master);
1093 EXPORT_SYMBOL_GPL(mtd_device_unregister);
1096 * register_mtd_user - register a 'user' of MTD devices.
1097 * @new: pointer to notifier info structure
1099 * Registers a pair of callbacks function to be called upon addition
1100 * or removal of MTD devices. Causes the 'add' callback to be immediately
1101 * invoked for each MTD device currently present in the system.
1103 void register_mtd_user (struct mtd_notifier *new)
1105 struct mtd_info *mtd;
1107 mutex_lock(&mtd_table_mutex);
1109 list_add(&new->list, &mtd_notifiers);
1111 __module_get(THIS_MODULE);
1113 mtd_for_each_device(mtd)
1116 mutex_unlock(&mtd_table_mutex);
1118 EXPORT_SYMBOL_GPL(register_mtd_user);
1121 * unregister_mtd_user - unregister a 'user' of MTD devices.
1122 * @old: pointer to notifier info structure
1124 * Removes a callback function pair from the list of 'users' to be
1125 * notified upon addition or removal of MTD devices. Causes the
1126 * 'remove' callback to be immediately invoked for each MTD device
1127 * currently present in the system.
1129 int unregister_mtd_user (struct mtd_notifier *old)
1131 struct mtd_info *mtd;
1133 mutex_lock(&mtd_table_mutex);
1135 module_put(THIS_MODULE);
1137 mtd_for_each_device(mtd)
1140 list_del(&old->list);
1141 mutex_unlock(&mtd_table_mutex);
1144 EXPORT_SYMBOL_GPL(unregister_mtd_user);
1147 * get_mtd_device - obtain a validated handle for an MTD device
1148 * @mtd: last known address of the required MTD device
1149 * @num: internal device number of the required MTD device
1151 * Given a number and NULL address, return the num'th entry in the device
1152 * table, if any. Given an address and num == -1, search the device table
1153 * for a device with that address and return if it's still present. Given
1154 * both, return the num'th driver only if its address matches. Return
1155 * error code if not.
1157 struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num)
1159 struct mtd_info *ret = NULL, *other;
1162 mutex_lock(&mtd_table_mutex);
1165 mtd_for_each_device(other) {
1171 } else if (num >= 0) {
1172 ret = idr_find(&mtd_idr, num);
1173 if (mtd && mtd != ret)
1182 err = __get_mtd_device(ret);
1186 mutex_unlock(&mtd_table_mutex);
1189 EXPORT_SYMBOL_GPL(get_mtd_device);
1192 int __get_mtd_device(struct mtd_info *mtd)
1194 struct mtd_info *master = mtd_get_master(mtd);
1197 if (!try_module_get(master->owner))
1200 if (master->_get_device) {
1201 err = master->_get_device(mtd);
1204 module_put(master->owner);
1211 while (mtd->parent) {
1218 EXPORT_SYMBOL_GPL(__get_mtd_device);
1221 * of_get_mtd_device_by_node - obtain an MTD device associated with a given node
1223 * @np: device tree node
1225 struct mtd_info *of_get_mtd_device_by_node(struct device_node *np)
1227 struct mtd_info *mtd = NULL;
1228 struct mtd_info *tmp;
1231 mutex_lock(&mtd_table_mutex);
1233 err = -EPROBE_DEFER;
1234 mtd_for_each_device(tmp) {
1235 if (mtd_get_of_node(tmp) == np) {
1237 err = __get_mtd_device(mtd);
1242 mutex_unlock(&mtd_table_mutex);
1244 return err ? ERR_PTR(err) : mtd;
1246 EXPORT_SYMBOL_GPL(of_get_mtd_device_by_node);
1249 * get_mtd_device_nm - obtain a validated handle for an MTD device by
1251 * @name: MTD device name to open
1253 * This function returns MTD device description structure in case of
1254 * success and an error code in case of failure.
1256 struct mtd_info *get_mtd_device_nm(const char *name)
1259 struct mtd_info *mtd = NULL, *other;
1261 mutex_lock(&mtd_table_mutex);
1263 mtd_for_each_device(other) {
1264 if (!strcmp(name, other->name)) {
1273 err = __get_mtd_device(mtd);
1277 mutex_unlock(&mtd_table_mutex);
1281 mutex_unlock(&mtd_table_mutex);
1282 return ERR_PTR(err);
1284 EXPORT_SYMBOL_GPL(get_mtd_device_nm);
1286 void put_mtd_device(struct mtd_info *mtd)
1288 mutex_lock(&mtd_table_mutex);
1289 __put_mtd_device(mtd);
1290 mutex_unlock(&mtd_table_mutex);
1293 EXPORT_SYMBOL_GPL(put_mtd_device);
1295 void __put_mtd_device(struct mtd_info *mtd)
1297 struct mtd_info *master = mtd_get_master(mtd);
1299 while (mtd->parent) {
1301 BUG_ON(mtd->usecount < 0);
1307 if (master->_put_device)
1308 master->_put_device(master);
1310 module_put(master->owner);
1312 EXPORT_SYMBOL_GPL(__put_mtd_device);
1315 * Erase is an synchronous operation. Device drivers are epected to return a
1316 * negative error code if the operation failed and update instr->fail_addr
1317 * to point the portion that was not properly erased.
1319 int mtd_erase(struct mtd_info *mtd, struct erase_info *instr)
1321 struct mtd_info *master = mtd_get_master(mtd);
1322 u64 mst_ofs = mtd_get_master_ofs(mtd, 0);
1323 struct erase_info adjinstr;
1326 instr->fail_addr = MTD_FAIL_ADDR_UNKNOWN;
1329 if (!mtd->erasesize || !master->_erase)
1332 if (instr->addr >= mtd->size || instr->len > mtd->size - instr->addr)
1334 if (!(mtd->flags & MTD_WRITEABLE))
1340 ledtrig_mtd_activity();
1342 if (mtd->flags & MTD_SLC_ON_MLC_EMULATION) {
1343 adjinstr.addr = (loff_t)mtd_div_by_eb(instr->addr, mtd) *
1345 adjinstr.len = ((u64)mtd_div_by_eb(instr->addr + instr->len, mtd) *
1346 master->erasesize) -
1350 adjinstr.addr += mst_ofs;
1352 ret = master->_erase(master, &adjinstr);
1354 if (adjinstr.fail_addr != MTD_FAIL_ADDR_UNKNOWN) {
1355 instr->fail_addr = adjinstr.fail_addr - mst_ofs;
1356 if (mtd->flags & MTD_SLC_ON_MLC_EMULATION) {
1357 instr->fail_addr = mtd_div_by_eb(instr->fail_addr,
1359 instr->fail_addr *= mtd->erasesize;
1365 EXPORT_SYMBOL_GPL(mtd_erase);
1368 * This stuff for eXecute-In-Place. phys is optional and may be set to NULL.
1370 int mtd_point(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
1371 void **virt, resource_size_t *phys)
1373 struct mtd_info *master = mtd_get_master(mtd);
1379 if (!master->_point)
1381 if (from < 0 || from >= mtd->size || len > mtd->size - from)
1386 from = mtd_get_master_ofs(mtd, from);
1387 return master->_point(master, from, len, retlen, virt, phys);
1389 EXPORT_SYMBOL_GPL(mtd_point);
1391 /* We probably shouldn't allow XIP if the unpoint isn't a NULL */
1392 int mtd_unpoint(struct mtd_info *mtd, loff_t from, size_t len)
1394 struct mtd_info *master = mtd_get_master(mtd);
1396 if (!master->_unpoint)
1398 if (from < 0 || from >= mtd->size || len > mtd->size - from)
1402 return master->_unpoint(master, mtd_get_master_ofs(mtd, from), len);
1404 EXPORT_SYMBOL_GPL(mtd_unpoint);
1407 * Allow NOMMU mmap() to directly map the device (if not NULL)
1408 * - return the address to which the offset maps
1409 * - return -ENOSYS to indicate refusal to do the mapping
1411 unsigned long mtd_get_unmapped_area(struct mtd_info *mtd, unsigned long len,
1412 unsigned long offset, unsigned long flags)
1418 ret = mtd_point(mtd, offset, len, &retlen, &virt, NULL);
1421 if (retlen != len) {
1422 mtd_unpoint(mtd, offset, retlen);
1425 return (unsigned long)virt;
1427 EXPORT_SYMBOL_GPL(mtd_get_unmapped_area);
1429 static void mtd_update_ecc_stats(struct mtd_info *mtd, struct mtd_info *master,
1430 const struct mtd_ecc_stats *old_stats)
1432 struct mtd_ecc_stats diff;
1437 diff = master->ecc_stats;
1438 diff.failed -= old_stats->failed;
1439 diff.corrected -= old_stats->corrected;
1441 while (mtd->parent) {
1442 mtd->ecc_stats.failed += diff.failed;
1443 mtd->ecc_stats.corrected += diff.corrected;
1448 int mtd_read(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
1451 struct mtd_oob_ops ops = {
1457 ret = mtd_read_oob(mtd, from, &ops);
1458 *retlen = ops.retlen;
1462 EXPORT_SYMBOL_GPL(mtd_read);
1464 int mtd_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
1467 struct mtd_oob_ops ops = {
1469 .datbuf = (u8 *)buf,
1473 ret = mtd_write_oob(mtd, to, &ops);
1474 *retlen = ops.retlen;
1478 EXPORT_SYMBOL_GPL(mtd_write);
1481 * In blackbox flight recorder like scenarios we want to make successful writes
1482 * in interrupt context. panic_write() is only intended to be called when its
1483 * known the kernel is about to panic and we need the write to succeed. Since
1484 * the kernel is not going to be running for much longer, this function can
1485 * break locks and delay to ensure the write succeeds (but not sleep).
1487 int mtd_panic_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
1490 struct mtd_info *master = mtd_get_master(mtd);
1493 if (!master->_panic_write)
1495 if (to < 0 || to >= mtd->size || len > mtd->size - to)
1497 if (!(mtd->flags & MTD_WRITEABLE))
1501 if (!master->oops_panic_write)
1502 master->oops_panic_write = true;
1504 return master->_panic_write(master, mtd_get_master_ofs(mtd, to), len,
1507 EXPORT_SYMBOL_GPL(mtd_panic_write);
1509 static int mtd_check_oob_ops(struct mtd_info *mtd, loff_t offs,
1510 struct mtd_oob_ops *ops)
1513 * Some users are setting ->datbuf or ->oobbuf to NULL, but are leaving
1514 * ->len or ->ooblen uninitialized. Force ->len and ->ooblen to 0 in
1523 if (offs < 0 || offs + ops->len > mtd->size)
1529 if (ops->ooboffs >= mtd_oobavail(mtd, ops))
1532 maxooblen = ((size_t)(mtd_div_by_ws(mtd->size, mtd) -
1533 mtd_div_by_ws(offs, mtd)) *
1534 mtd_oobavail(mtd, ops)) - ops->ooboffs;
1535 if (ops->ooblen > maxooblen)
1542 static int mtd_read_oob_std(struct mtd_info *mtd, loff_t from,
1543 struct mtd_oob_ops *ops)
1545 struct mtd_info *master = mtd_get_master(mtd);
1548 from = mtd_get_master_ofs(mtd, from);
1549 if (master->_read_oob)
1550 ret = master->_read_oob(master, from, ops);
1552 ret = master->_read(master, from, ops->len, &ops->retlen,
1558 static int mtd_write_oob_std(struct mtd_info *mtd, loff_t to,
1559 struct mtd_oob_ops *ops)
1561 struct mtd_info *master = mtd_get_master(mtd);
1564 to = mtd_get_master_ofs(mtd, to);
1565 if (master->_write_oob)
1566 ret = master->_write_oob(master, to, ops);
1568 ret = master->_write(master, to, ops->len, &ops->retlen,
1574 static int mtd_io_emulated_slc(struct mtd_info *mtd, loff_t start, bool read,
1575 struct mtd_oob_ops *ops)
1577 struct mtd_info *master = mtd_get_master(mtd);
1578 int ngroups = mtd_pairing_groups(master);
1579 int npairs = mtd_wunit_per_eb(master) / ngroups;
1580 struct mtd_oob_ops adjops = *ops;
1581 unsigned int wunit, oobavail;
1582 struct mtd_pairing_info info;
1583 int max_bitflips = 0;
1587 ebofs = mtd_mod_by_eb(start, mtd);
1588 base = (loff_t)mtd_div_by_eb(start, mtd) * master->erasesize;
1590 info.pair = mtd_div_by_ws(ebofs, mtd);
1591 pageofs = mtd_mod_by_ws(ebofs, mtd);
1592 oobavail = mtd_oobavail(mtd, ops);
1594 while (ops->retlen < ops->len || ops->oobretlen < ops->ooblen) {
1597 if (info.pair >= npairs) {
1599 base += master->erasesize;
1602 wunit = mtd_pairing_info_to_wunit(master, &info);
1603 pos = mtd_wunit_to_offset(mtd, base, wunit);
1605 adjops.len = ops->len - ops->retlen;
1606 if (adjops.len > mtd->writesize - pageofs)
1607 adjops.len = mtd->writesize - pageofs;
1609 adjops.ooblen = ops->ooblen - ops->oobretlen;
1610 if (adjops.ooblen > oobavail - adjops.ooboffs)
1611 adjops.ooblen = oobavail - adjops.ooboffs;
1614 ret = mtd_read_oob_std(mtd, pos + pageofs, &adjops);
1616 max_bitflips = max(max_bitflips, ret);
1618 ret = mtd_write_oob_std(mtd, pos + pageofs, &adjops);
1624 max_bitflips = max(max_bitflips, ret);
1625 ops->retlen += adjops.retlen;
1626 ops->oobretlen += adjops.oobretlen;
1627 adjops.datbuf += adjops.retlen;
1628 adjops.oobbuf += adjops.oobretlen;
1634 return max_bitflips;
1637 int mtd_read_oob(struct mtd_info *mtd, loff_t from, struct mtd_oob_ops *ops)
1639 struct mtd_info *master = mtd_get_master(mtd);
1640 struct mtd_ecc_stats old_stats = master->ecc_stats;
1643 ops->retlen = ops->oobretlen = 0;
1645 ret_code = mtd_check_oob_ops(mtd, from, ops);
1649 ledtrig_mtd_activity();
1651 /* Check the validity of a potential fallback on mtd->_read */
1652 if (!master->_read_oob && (!master->_read || ops->oobbuf))
1656 memset(ops->stats, 0, sizeof(*ops->stats));
1658 if (mtd->flags & MTD_SLC_ON_MLC_EMULATION)
1659 ret_code = mtd_io_emulated_slc(mtd, from, true, ops);
1661 ret_code = mtd_read_oob_std(mtd, from, ops);
1663 mtd_update_ecc_stats(mtd, master, &old_stats);
1666 * In cases where ops->datbuf != NULL, mtd->_read_oob() has semantics
1667 * similar to mtd->_read(), returning a non-negative integer
1668 * representing max bitflips. In other cases, mtd->_read_oob() may
1669 * return -EUCLEAN. In all cases, perform similar logic to mtd_read().
1671 if (unlikely(ret_code < 0))
1673 if (mtd->ecc_strength == 0)
1674 return 0; /* device lacks ecc */
1676 ops->stats->max_bitflips = ret_code;
1677 return ret_code >= mtd->bitflip_threshold ? -EUCLEAN : 0;
1679 EXPORT_SYMBOL_GPL(mtd_read_oob);
1681 int mtd_write_oob(struct mtd_info *mtd, loff_t to,
1682 struct mtd_oob_ops *ops)
1684 struct mtd_info *master = mtd_get_master(mtd);
1687 ops->retlen = ops->oobretlen = 0;
1689 if (!(mtd->flags & MTD_WRITEABLE))
1692 ret = mtd_check_oob_ops(mtd, to, ops);
1696 ledtrig_mtd_activity();
1698 /* Check the validity of a potential fallback on mtd->_write */
1699 if (!master->_write_oob && (!master->_write || ops->oobbuf))
1702 if (mtd->flags & MTD_SLC_ON_MLC_EMULATION)
1703 return mtd_io_emulated_slc(mtd, to, false, ops);
1705 return mtd_write_oob_std(mtd, to, ops);
1707 EXPORT_SYMBOL_GPL(mtd_write_oob);
1710 * mtd_ooblayout_ecc - Get the OOB region definition of a specific ECC section
1711 * @mtd: MTD device structure
1712 * @section: ECC section. Depending on the layout you may have all the ECC
1713 * bytes stored in a single contiguous section, or one section
1714 * per ECC chunk (and sometime several sections for a single ECC
1716 * @oobecc: OOB region struct filled with the appropriate ECC position
1719 * This function returns ECC section information in the OOB area. If you want
1720 * to get all the ECC bytes information, then you should call
1721 * mtd_ooblayout_ecc(mtd, section++, oobecc) until it returns -ERANGE.
1723 * Returns zero on success, a negative error code otherwise.
1725 int mtd_ooblayout_ecc(struct mtd_info *mtd, int section,
1726 struct mtd_oob_region *oobecc)
1728 struct mtd_info *master = mtd_get_master(mtd);
1730 memset(oobecc, 0, sizeof(*oobecc));
1732 if (!master || section < 0)
1735 if (!master->ooblayout || !master->ooblayout->ecc)
1738 return master->ooblayout->ecc(master, section, oobecc);
1740 EXPORT_SYMBOL_GPL(mtd_ooblayout_ecc);
1743 * mtd_ooblayout_free - Get the OOB region definition of a specific free
1745 * @mtd: MTD device structure
1746 * @section: Free section you are interested in. Depending on the layout
1747 * you may have all the free bytes stored in a single contiguous
1748 * section, or one section per ECC chunk plus an extra section
1749 * for the remaining bytes (or other funky layout).
1750 * @oobfree: OOB region struct filled with the appropriate free position
1753 * This function returns free bytes position in the OOB area. If you want
1754 * to get all the free bytes information, then you should call
1755 * mtd_ooblayout_free(mtd, section++, oobfree) until it returns -ERANGE.
1757 * Returns zero on success, a negative error code otherwise.
1759 int mtd_ooblayout_free(struct mtd_info *mtd, int section,
1760 struct mtd_oob_region *oobfree)
1762 struct mtd_info *master = mtd_get_master(mtd);
1764 memset(oobfree, 0, sizeof(*oobfree));
1766 if (!master || section < 0)
1769 if (!master->ooblayout || !master->ooblayout->free)
1772 return master->ooblayout->free(master, section, oobfree);
1774 EXPORT_SYMBOL_GPL(mtd_ooblayout_free);
1777 * mtd_ooblayout_find_region - Find the region attached to a specific byte
1778 * @mtd: mtd info structure
1779 * @byte: the byte we are searching for
1780 * @sectionp: pointer where the section id will be stored
1781 * @oobregion: used to retrieve the ECC position
1782 * @iter: iterator function. Should be either mtd_ooblayout_free or
1783 * mtd_ooblayout_ecc depending on the region type you're searching for
1785 * This function returns the section id and oobregion information of a
1786 * specific byte. For example, say you want to know where the 4th ECC byte is
1787 * stored, you'll use:
1789 * mtd_ooblayout_find_region(mtd, 3, §ion, &oobregion, mtd_ooblayout_ecc);
1791 * Returns zero on success, a negative error code otherwise.
1793 static int mtd_ooblayout_find_region(struct mtd_info *mtd, int byte,
1794 int *sectionp, struct mtd_oob_region *oobregion,
1795 int (*iter)(struct mtd_info *,
1797 struct mtd_oob_region *oobregion))
1799 int pos = 0, ret, section = 0;
1801 memset(oobregion, 0, sizeof(*oobregion));
1804 ret = iter(mtd, section, oobregion);
1808 if (pos + oobregion->length > byte)
1811 pos += oobregion->length;
1816 * Adjust region info to make it start at the beginning at the
1819 oobregion->offset += byte - pos;
1820 oobregion->length -= byte - pos;
1821 *sectionp = section;
1827 * mtd_ooblayout_find_eccregion - Find the ECC region attached to a specific
1829 * @mtd: mtd info structure
1830 * @eccbyte: the byte we are searching for
1831 * @section: pointer where the section id will be stored
1832 * @oobregion: OOB region information
1834 * Works like mtd_ooblayout_find_region() except it searches for a specific ECC
1837 * Returns zero on success, a negative error code otherwise.
1839 int mtd_ooblayout_find_eccregion(struct mtd_info *mtd, int eccbyte,
1841 struct mtd_oob_region *oobregion)
1843 return mtd_ooblayout_find_region(mtd, eccbyte, section, oobregion,
1846 EXPORT_SYMBOL_GPL(mtd_ooblayout_find_eccregion);
1849 * mtd_ooblayout_get_bytes - Extract OOB bytes from the oob buffer
1850 * @mtd: mtd info structure
1851 * @buf: destination buffer to store OOB bytes
1852 * @oobbuf: OOB buffer
1853 * @start: first byte to retrieve
1854 * @nbytes: number of bytes to retrieve
1855 * @iter: section iterator
1857 * Extract bytes attached to a specific category (ECC or free)
1858 * from the OOB buffer and copy them into buf.
1860 * Returns zero on success, a negative error code otherwise.
1862 static int mtd_ooblayout_get_bytes(struct mtd_info *mtd, u8 *buf,
1863 const u8 *oobbuf, int start, int nbytes,
1864 int (*iter)(struct mtd_info *,
1866 struct mtd_oob_region *oobregion))
1868 struct mtd_oob_region oobregion;
1871 ret = mtd_ooblayout_find_region(mtd, start, §ion,
1877 cnt = min_t(int, nbytes, oobregion.length);
1878 memcpy(buf, oobbuf + oobregion.offset, cnt);
1885 ret = iter(mtd, ++section, &oobregion);
1892 * mtd_ooblayout_set_bytes - put OOB bytes into the oob buffer
1893 * @mtd: mtd info structure
1894 * @buf: source buffer to get OOB bytes from
1895 * @oobbuf: OOB buffer
1896 * @start: first OOB byte to set
1897 * @nbytes: number of OOB bytes to set
1898 * @iter: section iterator
1900 * Fill the OOB buffer with data provided in buf. The category (ECC or free)
1901 * is selected by passing the appropriate iterator.
1903 * Returns zero on success, a negative error code otherwise.
1905 static int mtd_ooblayout_set_bytes(struct mtd_info *mtd, const u8 *buf,
1906 u8 *oobbuf, int start, int nbytes,
1907 int (*iter)(struct mtd_info *,
1909 struct mtd_oob_region *oobregion))
1911 struct mtd_oob_region oobregion;
1914 ret = mtd_ooblayout_find_region(mtd, start, §ion,
1920 cnt = min_t(int, nbytes, oobregion.length);
1921 memcpy(oobbuf + oobregion.offset, buf, cnt);
1928 ret = iter(mtd, ++section, &oobregion);
1935 * mtd_ooblayout_count_bytes - count the number of bytes in a OOB category
1936 * @mtd: mtd info structure
1937 * @iter: category iterator
1939 * Count the number of bytes in a given category.
1941 * Returns a positive value on success, a negative error code otherwise.
1943 static int mtd_ooblayout_count_bytes(struct mtd_info *mtd,
1944 int (*iter)(struct mtd_info *,
1946 struct mtd_oob_region *oobregion))
1948 struct mtd_oob_region oobregion;
1949 int section = 0, ret, nbytes = 0;
1952 ret = iter(mtd, section++, &oobregion);
1959 nbytes += oobregion.length;
1966 * mtd_ooblayout_get_eccbytes - extract ECC bytes from the oob buffer
1967 * @mtd: mtd info structure
1968 * @eccbuf: destination buffer to store ECC bytes
1969 * @oobbuf: OOB buffer
1970 * @start: first ECC byte to retrieve
1971 * @nbytes: number of ECC bytes to retrieve
1973 * Works like mtd_ooblayout_get_bytes(), except it acts on ECC bytes.
1975 * Returns zero on success, a negative error code otherwise.
1977 int mtd_ooblayout_get_eccbytes(struct mtd_info *mtd, u8 *eccbuf,
1978 const u8 *oobbuf, int start, int nbytes)
1980 return mtd_ooblayout_get_bytes(mtd, eccbuf, oobbuf, start, nbytes,
1983 EXPORT_SYMBOL_GPL(mtd_ooblayout_get_eccbytes);
1986 * mtd_ooblayout_set_eccbytes - set ECC bytes into the oob buffer
1987 * @mtd: mtd info structure
1988 * @eccbuf: source buffer to get ECC bytes from
1989 * @oobbuf: OOB buffer
1990 * @start: first ECC byte to set
1991 * @nbytes: number of ECC bytes to set
1993 * Works like mtd_ooblayout_set_bytes(), except it acts on ECC bytes.
1995 * Returns zero on success, a negative error code otherwise.
1997 int mtd_ooblayout_set_eccbytes(struct mtd_info *mtd, const u8 *eccbuf,
1998 u8 *oobbuf, int start, int nbytes)
2000 return mtd_ooblayout_set_bytes(mtd, eccbuf, oobbuf, start, nbytes,
2003 EXPORT_SYMBOL_GPL(mtd_ooblayout_set_eccbytes);
2006 * mtd_ooblayout_get_databytes - extract data bytes from the oob buffer
2007 * @mtd: mtd info structure
2008 * @databuf: destination buffer to store ECC bytes
2009 * @oobbuf: OOB buffer
2010 * @start: first ECC byte to retrieve
2011 * @nbytes: number of ECC bytes to retrieve
2013 * Works like mtd_ooblayout_get_bytes(), except it acts on free bytes.
2015 * Returns zero on success, a negative error code otherwise.
2017 int mtd_ooblayout_get_databytes(struct mtd_info *mtd, u8 *databuf,
2018 const u8 *oobbuf, int start, int nbytes)
2020 return mtd_ooblayout_get_bytes(mtd, databuf, oobbuf, start, nbytes,
2021 mtd_ooblayout_free);
2023 EXPORT_SYMBOL_GPL(mtd_ooblayout_get_databytes);
2026 * mtd_ooblayout_set_databytes - set data bytes into the oob buffer
2027 * @mtd: mtd info structure
2028 * @databuf: source buffer to get data bytes from
2029 * @oobbuf: OOB buffer
2030 * @start: first ECC byte to set
2031 * @nbytes: number of ECC bytes to set
2033 * Works like mtd_ooblayout_set_bytes(), except it acts on free bytes.
2035 * Returns zero on success, a negative error code otherwise.
2037 int mtd_ooblayout_set_databytes(struct mtd_info *mtd, const u8 *databuf,
2038 u8 *oobbuf, int start, int nbytes)
2040 return mtd_ooblayout_set_bytes(mtd, databuf, oobbuf, start, nbytes,
2041 mtd_ooblayout_free);
2043 EXPORT_SYMBOL_GPL(mtd_ooblayout_set_databytes);
2046 * mtd_ooblayout_count_freebytes - count the number of free bytes in OOB
2047 * @mtd: mtd info structure
2049 * Works like mtd_ooblayout_count_bytes(), except it count free bytes.
2051 * Returns zero on success, a negative error code otherwise.
2053 int mtd_ooblayout_count_freebytes(struct mtd_info *mtd)
2055 return mtd_ooblayout_count_bytes(mtd, mtd_ooblayout_free);
2057 EXPORT_SYMBOL_GPL(mtd_ooblayout_count_freebytes);
2060 * mtd_ooblayout_count_eccbytes - count the number of ECC bytes in OOB
2061 * @mtd: mtd info structure
2063 * Works like mtd_ooblayout_count_bytes(), except it count ECC bytes.
2065 * Returns zero on success, a negative error code otherwise.
2067 int mtd_ooblayout_count_eccbytes(struct mtd_info *mtd)
2069 return mtd_ooblayout_count_bytes(mtd, mtd_ooblayout_ecc);
2071 EXPORT_SYMBOL_GPL(mtd_ooblayout_count_eccbytes);
2074 * Method to access the protection register area, present in some flash
2075 * devices. The user data is one time programmable but the factory data is read
2078 int mtd_get_fact_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen,
2079 struct otp_info *buf)
2081 struct mtd_info *master = mtd_get_master(mtd);
2083 if (!master->_get_fact_prot_info)
2087 return master->_get_fact_prot_info(master, len, retlen, buf);
2089 EXPORT_SYMBOL_GPL(mtd_get_fact_prot_info);
2091 int mtd_read_fact_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
2092 size_t *retlen, u_char *buf)
2094 struct mtd_info *master = mtd_get_master(mtd);
2097 if (!master->_read_fact_prot_reg)
2101 return master->_read_fact_prot_reg(master, from, len, retlen, buf);
2103 EXPORT_SYMBOL_GPL(mtd_read_fact_prot_reg);
2105 int mtd_get_user_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen,
2106 struct otp_info *buf)
2108 struct mtd_info *master = mtd_get_master(mtd);
2110 if (!master->_get_user_prot_info)
2114 return master->_get_user_prot_info(master, len, retlen, buf);
2116 EXPORT_SYMBOL_GPL(mtd_get_user_prot_info);
2118 int mtd_read_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
2119 size_t *retlen, u_char *buf)
2121 struct mtd_info *master = mtd_get_master(mtd);
2124 if (!master->_read_user_prot_reg)
2128 return master->_read_user_prot_reg(master, from, len, retlen, buf);
2130 EXPORT_SYMBOL_GPL(mtd_read_user_prot_reg);
2132 int mtd_write_user_prot_reg(struct mtd_info *mtd, loff_t to, size_t len,
2133 size_t *retlen, const u_char *buf)
2135 struct mtd_info *master = mtd_get_master(mtd);
2139 if (!master->_write_user_prot_reg)
2143 ret = master->_write_user_prot_reg(master, to, len, retlen, buf);
2148 * If no data could be written at all, we are out of memory and
2149 * must return -ENOSPC.
2151 return (*retlen) ? 0 : -ENOSPC;
2153 EXPORT_SYMBOL_GPL(mtd_write_user_prot_reg);
2155 int mtd_lock_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len)
2157 struct mtd_info *master = mtd_get_master(mtd);
2159 if (!master->_lock_user_prot_reg)
2163 return master->_lock_user_prot_reg(master, from, len);
2165 EXPORT_SYMBOL_GPL(mtd_lock_user_prot_reg);
2167 int mtd_erase_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len)
2169 struct mtd_info *master = mtd_get_master(mtd);
2171 if (!master->_erase_user_prot_reg)
2175 return master->_erase_user_prot_reg(master, from, len);
2177 EXPORT_SYMBOL_GPL(mtd_erase_user_prot_reg);
2179 /* Chip-supported device locking */
2180 int mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
2182 struct mtd_info *master = mtd_get_master(mtd);
2186 if (ofs < 0 || ofs >= mtd->size || len > mtd->size - ofs)
2191 if (mtd->flags & MTD_SLC_ON_MLC_EMULATION) {
2192 ofs = (loff_t)mtd_div_by_eb(ofs, mtd) * master->erasesize;
2193 len = (u64)mtd_div_by_eb(len, mtd) * master->erasesize;
2196 return master->_lock(master, mtd_get_master_ofs(mtd, ofs), len);
2198 EXPORT_SYMBOL_GPL(mtd_lock);
2200 int mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
2202 struct mtd_info *master = mtd_get_master(mtd);
2204 if (!master->_unlock)
2206 if (ofs < 0 || ofs >= mtd->size || len > mtd->size - ofs)
2211 if (mtd->flags & MTD_SLC_ON_MLC_EMULATION) {
2212 ofs = (loff_t)mtd_div_by_eb(ofs, mtd) * master->erasesize;
2213 len = (u64)mtd_div_by_eb(len, mtd) * master->erasesize;
2216 return master->_unlock(master, mtd_get_master_ofs(mtd, ofs), len);
2218 EXPORT_SYMBOL_GPL(mtd_unlock);
2220 int mtd_is_locked(struct mtd_info *mtd, loff_t ofs, uint64_t len)
2222 struct mtd_info *master = mtd_get_master(mtd);
2224 if (!master->_is_locked)
2226 if (ofs < 0 || ofs >= mtd->size || len > mtd->size - ofs)
2231 if (mtd->flags & MTD_SLC_ON_MLC_EMULATION) {
2232 ofs = (loff_t)mtd_div_by_eb(ofs, mtd) * master->erasesize;
2233 len = (u64)mtd_div_by_eb(len, mtd) * master->erasesize;
2236 return master->_is_locked(master, mtd_get_master_ofs(mtd, ofs), len);
2238 EXPORT_SYMBOL_GPL(mtd_is_locked);
2240 int mtd_block_isreserved(struct mtd_info *mtd, loff_t ofs)
2242 struct mtd_info *master = mtd_get_master(mtd);
2244 if (ofs < 0 || ofs >= mtd->size)
2246 if (!master->_block_isreserved)
2249 if (mtd->flags & MTD_SLC_ON_MLC_EMULATION)
2250 ofs = (loff_t)mtd_div_by_eb(ofs, mtd) * master->erasesize;
2252 return master->_block_isreserved(master, mtd_get_master_ofs(mtd, ofs));
2254 EXPORT_SYMBOL_GPL(mtd_block_isreserved);
2256 int mtd_block_isbad(struct mtd_info *mtd, loff_t ofs)
2258 struct mtd_info *master = mtd_get_master(mtd);
2260 if (ofs < 0 || ofs >= mtd->size)
2262 if (!master->_block_isbad)
2265 if (mtd->flags & MTD_SLC_ON_MLC_EMULATION)
2266 ofs = (loff_t)mtd_div_by_eb(ofs, mtd) * master->erasesize;
2268 return master->_block_isbad(master, mtd_get_master_ofs(mtd, ofs));
2270 EXPORT_SYMBOL_GPL(mtd_block_isbad);
2272 int mtd_block_markbad(struct mtd_info *mtd, loff_t ofs)
2274 struct mtd_info *master = mtd_get_master(mtd);
2277 if (!master->_block_markbad)
2279 if (ofs < 0 || ofs >= mtd->size)
2281 if (!(mtd->flags & MTD_WRITEABLE))
2284 if (mtd->flags & MTD_SLC_ON_MLC_EMULATION)
2285 ofs = (loff_t)mtd_div_by_eb(ofs, mtd) * master->erasesize;
2287 ret = master->_block_markbad(master, mtd_get_master_ofs(mtd, ofs));
2291 while (mtd->parent) {
2292 mtd->ecc_stats.badblocks++;
2298 EXPORT_SYMBOL_GPL(mtd_block_markbad);
2301 * default_mtd_writev - the default writev method
2302 * @mtd: mtd device description object pointer
2303 * @vecs: the vectors to write
2304 * @count: count of vectors in @vecs
2305 * @to: the MTD device offset to write to
2306 * @retlen: on exit contains the count of bytes written to the MTD device.
2308 * This function returns zero in case of success and a negative error code in
2311 static int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
2312 unsigned long count, loff_t to, size_t *retlen)
2315 size_t totlen = 0, thislen;
2318 for (i = 0; i < count; i++) {
2319 if (!vecs[i].iov_len)
2321 ret = mtd_write(mtd, to, vecs[i].iov_len, &thislen,
2324 if (ret || thislen != vecs[i].iov_len)
2326 to += vecs[i].iov_len;
2333 * mtd_writev - the vector-based MTD write method
2334 * @mtd: mtd device description object pointer
2335 * @vecs: the vectors to write
2336 * @count: count of vectors in @vecs
2337 * @to: the MTD device offset to write to
2338 * @retlen: on exit contains the count of bytes written to the MTD device.
2340 * This function returns zero in case of success and a negative error code in
2343 int mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
2344 unsigned long count, loff_t to, size_t *retlen)
2346 struct mtd_info *master = mtd_get_master(mtd);
2349 if (!(mtd->flags & MTD_WRITEABLE))
2352 if (!master->_writev)
2353 return default_mtd_writev(mtd, vecs, count, to, retlen);
2355 return master->_writev(master, vecs, count,
2356 mtd_get_master_ofs(mtd, to), retlen);
2358 EXPORT_SYMBOL_GPL(mtd_writev);
2361 * mtd_kmalloc_up_to - allocate a contiguous buffer up to the specified size
2362 * @mtd: mtd device description object pointer
2363 * @size: a pointer to the ideal or maximum size of the allocation, points
2364 * to the actual allocation size on success.
2366 * This routine attempts to allocate a contiguous kernel buffer up to
2367 * the specified size, backing off the size of the request exponentially
2368 * until the request succeeds or until the allocation size falls below
2369 * the system page size. This attempts to make sure it does not adversely
2370 * impact system performance, so when allocating more than one page, we
2371 * ask the memory allocator to avoid re-trying, swapping, writing back
2372 * or performing I/O.
2374 * Note, this function also makes sure that the allocated buffer is aligned to
2375 * the MTD device's min. I/O unit, i.e. the "mtd->writesize" value.
2377 * This is called, for example by mtd_{read,write} and jffs2_scan_medium,
2378 * to handle smaller (i.e. degraded) buffer allocations under low- or
2379 * fragmented-memory situations where such reduced allocations, from a
2380 * requested ideal, are allowed.
2382 * Returns a pointer to the allocated buffer on success; otherwise, NULL.
2384 void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size)
2386 gfp_t flags = __GFP_NOWARN | __GFP_DIRECT_RECLAIM | __GFP_NORETRY;
2387 size_t min_alloc = max_t(size_t, mtd->writesize, PAGE_SIZE);
2390 *size = min_t(size_t, *size, KMALLOC_MAX_SIZE);
2392 while (*size > min_alloc) {
2393 kbuf = kmalloc(*size, flags);
2398 *size = ALIGN(*size, mtd->writesize);
2402 * For the last resort allocation allow 'kmalloc()' to do all sorts of
2403 * things (write-back, dropping caches, etc) by using GFP_KERNEL.
2405 return kmalloc(*size, GFP_KERNEL);
2407 EXPORT_SYMBOL_GPL(mtd_kmalloc_up_to);
2409 #ifdef CONFIG_PROC_FS
2411 /*====================================================================*/
2412 /* Support for /proc/mtd */
2414 static int mtd_proc_show(struct seq_file *m, void *v)
2416 struct mtd_info *mtd;
2418 seq_puts(m, "dev: size erasesize name\n");
2419 mutex_lock(&mtd_table_mutex);
2420 mtd_for_each_device(mtd) {
2421 seq_printf(m, "mtd%d: %8.8llx %8.8x \"%s\"\n",
2422 mtd->index, (unsigned long long)mtd->size,
2423 mtd->erasesize, mtd->name);
2425 mutex_unlock(&mtd_table_mutex);
2428 #endif /* CONFIG_PROC_FS */
2430 /*====================================================================*/
2433 static struct backing_dev_info * __init mtd_bdi_init(const char *name)
2435 struct backing_dev_info *bdi;
2438 bdi = bdi_alloc(NUMA_NO_NODE);
2440 return ERR_PTR(-ENOMEM);
2445 * We put '-0' suffix to the name to get the same name format as we
2446 * used to get. Since this is called only once, we get a unique name.
2448 ret = bdi_register(bdi, "%.28s-0", name);
2452 return ret ? ERR_PTR(ret) : bdi;
2455 static struct proc_dir_entry *proc_mtd;
2457 static int __init init_mtd(void)
2461 ret = class_register(&mtd_class);
2465 mtd_bdi = mtd_bdi_init("mtd");
2466 if (IS_ERR(mtd_bdi)) {
2467 ret = PTR_ERR(mtd_bdi);
2471 proc_mtd = proc_create_single("mtd", 0, NULL, mtd_proc_show);
2473 ret = init_mtdchar();
2477 dfs_dir_mtd = debugfs_create_dir("mtd", NULL);
2478 debugfs_create_bool("expert_analysis_mode", 0600, dfs_dir_mtd,
2479 &mtd_expert_analysis_mode);
2485 remove_proc_entry("mtd", NULL);
2488 class_unregister(&mtd_class);
2490 pr_err("Error registering mtd class or bdi: %d\n", ret);
2494 static void __exit cleanup_mtd(void)
2496 debugfs_remove_recursive(dfs_dir_mtd);
2499 remove_proc_entry("mtd", NULL);
2500 class_unregister(&mtd_class);
2501 bdi_unregister(mtd_bdi);
2503 idr_destroy(&mtd_idr);
2506 module_init(init_mtd);
2507 module_exit(cleanup_mtd);
2509 MODULE_LICENSE("GPL");
2510 MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
2511 MODULE_DESCRIPTION("Core MTD registration and access routines");