1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Simple MTD partitioning layer
5 * Copyright © 2000 Nicolas Pitre <nico@fluxnic.net>
6 * Copyright © 2002 Thomas Gleixner <gleixner@linutronix.de>
7 * Copyright © 2000-2010 David Woodhouse <dwmw2@infradead.org>
10 #include <linux/module.h>
11 #include <linux/types.h>
12 #include <linux/kernel.h>
13 #include <linux/slab.h>
14 #include <linux/list.h>
15 #include <linux/kmod.h>
16 #include <linux/mtd/mtd.h>
17 #include <linux/mtd/partitions.h>
18 #include <linux/err.h>
20 #include <linux/of_platform.h>
25 * MTD methods which simply translate the effective address and pass through
26 * to the _real_ device.
29 static inline void free_partition(struct mtd_info *mtd)
35 static struct mtd_info *allocate_partition(struct mtd_info *parent,
36 const struct mtd_partition *part,
37 int partno, uint64_t cur_offset)
39 struct mtd_info *master = mtd_get_master(parent);
40 int wr_alignment = (parent->flags & MTD_NO_ERASE) ?
41 master->writesize : master->erasesize;
42 u64 parent_size = mtd_is_partition(parent) ?
43 parent->part.size : parent->size;
44 struct mtd_info *child;
49 /* allocate the partition structure */
50 child = kzalloc(sizeof(*child), GFP_KERNEL);
51 name = kstrdup(part->name, GFP_KERNEL);
52 if (!name || !child) {
53 printk(KERN_ERR"memory allocation error while creating partitions for \"%s\"\n",
57 return ERR_PTR(-ENOMEM);
60 /* set up the MTD object for this partition */
61 child->type = parent->type;
62 child->part.flags = parent->flags & ~part->mask_flags;
63 child->part.flags |= part->add_flags;
64 child->flags = child->part.flags;
65 child->part.size = part->size;
66 child->writesize = parent->writesize;
67 child->writebufsize = parent->writebufsize;
68 child->oobsize = parent->oobsize;
69 child->oobavail = parent->oobavail;
70 child->subpage_sft = parent->subpage_sft;
73 child->owner = parent->owner;
75 /* NOTE: Historically, we didn't arrange MTDs as a tree out of
76 * concern for showing the same data in multiple partitions.
77 * However, it is very useful to have the master node present,
78 * so the MTD_PARTITIONED_MASTER option allows that. The master
79 * will have device nodes etc only if this is set, so make the
80 * parent conditional on that option. Note, this is a way to
81 * distinguish between the parent and its partitions in sysfs.
83 child->dev.parent = IS_ENABLED(CONFIG_MTD_PARTITIONED_MASTER) || mtd_is_partition(parent) ?
84 &parent->dev : parent->dev.parent;
85 child->dev.of_node = part->of_node;
86 child->parent = parent;
87 child->part.offset = part->offset;
88 INIT_LIST_HEAD(&child->partitions);
90 if (child->part.offset == MTDPART_OFS_APPEND)
91 child->part.offset = cur_offset;
92 if (child->part.offset == MTDPART_OFS_NXTBLK) {
94 child->part.offset = cur_offset;
95 remainder = do_div(tmp, wr_alignment);
97 child->part.offset += wr_alignment - remainder;
98 printk(KERN_NOTICE "Moving partition %d: "
99 "0x%012llx -> 0x%012llx\n", partno,
100 (unsigned long long)cur_offset,
104 if (child->part.offset == MTDPART_OFS_RETAIN) {
105 child->part.offset = cur_offset;
106 if (parent_size - child->part.offset >= child->part.size) {
107 child->part.size = parent_size - child->part.offset -
110 printk(KERN_ERR "mtd partition \"%s\" doesn't have enough space: %#llx < %#llx, disabled\n",
111 part->name, parent_size - child->part.offset,
113 /* register to preserve ordering */
117 if (child->part.size == MTDPART_SIZ_FULL)
118 child->part.size = parent_size - child->part.offset;
120 printk(KERN_NOTICE "0x%012llx-0x%012llx : \"%s\"\n",
121 child->part.offset, child->part.offset + child->part.size,
124 /* let's do some sanity checks */
125 if (child->part.offset >= parent_size) {
126 /* let's register it anyway to preserve ordering */
127 child->part.offset = 0;
128 child->part.size = 0;
130 /* Initialize ->erasesize to make add_mtd_device() happy. */
131 child->erasesize = parent->erasesize;
132 printk(KERN_ERR"mtd: partition \"%s\" is out of reach -- disabled\n",
136 if (child->part.offset + child->part.size > parent->size) {
137 child->part.size = parent_size - child->part.offset;
138 printk(KERN_WARNING"mtd: partition \"%s\" extends beyond the end of device \"%s\" -- size truncated to %#llx\n",
139 part->name, parent->name, child->part.size);
142 if (parent->numeraseregions > 1) {
143 /* Deal with variable erase size stuff */
144 int i, max = parent->numeraseregions;
145 u64 end = child->part.offset + child->part.size;
146 struct mtd_erase_region_info *regions = parent->eraseregions;
148 /* Find the first erase regions which is part of this
150 for (i = 0; i < max && regions[i].offset <= child->part.offset;
153 /* The loop searched for the region _behind_ the first one */
157 /* Pick biggest erasesize */
158 for (; i < max && regions[i].offset < end; i++) {
159 if (child->erasesize < regions[i].erasesize)
160 child->erasesize = regions[i].erasesize;
162 BUG_ON(child->erasesize == 0);
164 /* Single erase size */
165 child->erasesize = master->erasesize;
169 * Child erasesize might differ from the parent one if the parent
170 * exposes several regions with different erasesize. Adjust
171 * wr_alignment accordingly.
173 if (!(child->flags & MTD_NO_ERASE))
174 wr_alignment = child->erasesize;
176 tmp = mtd_get_master_ofs(child, 0);
177 remainder = do_div(tmp, wr_alignment);
178 if ((child->flags & MTD_WRITEABLE) && remainder) {
179 /* Doesn't start on a boundary of major erase size */
180 /* FIXME: Let it be writable if it is on a boundary of
181 * _minor_ erase size though */
182 child->flags &= ~MTD_WRITEABLE;
183 printk(KERN_WARNING"mtd: partition \"%s\" doesn't start on an erase/write block boundary -- force read-only\n",
187 tmp = mtd_get_master_ofs(child, 0) + child->part.size;
188 remainder = do_div(tmp, wr_alignment);
189 if ((child->flags & MTD_WRITEABLE) && remainder) {
190 child->flags &= ~MTD_WRITEABLE;
191 printk(KERN_WARNING"mtd: partition \"%s\" doesn't end on an erase/write block -- force read-only\n",
195 child->size = child->part.size;
196 child->ecc_step_size = parent->ecc_step_size;
197 child->ecc_strength = parent->ecc_strength;
198 child->bitflip_threshold = parent->bitflip_threshold;
200 if (master->_block_isbad) {
203 while (offs < child->part.size) {
204 if (mtd_block_isreserved(child, offs))
205 child->ecc_stats.bbtblocks++;
206 else if (mtd_block_isbad(child, offs))
207 child->ecc_stats.badblocks++;
208 offs += child->erasesize;
216 static ssize_t offset_show(struct device *dev,
217 struct device_attribute *attr, char *buf)
219 struct mtd_info *mtd = dev_get_drvdata(dev);
221 return sysfs_emit(buf, "%lld\n", mtd->part.offset);
223 static DEVICE_ATTR_RO(offset); /* mtd partition offset */
225 static const struct attribute *mtd_partition_attrs[] = {
226 &dev_attr_offset.attr,
230 static int mtd_add_partition_attrs(struct mtd_info *new)
232 int ret = sysfs_create_files(&new->dev.kobj, mtd_partition_attrs);
235 "mtd: failed to create partition attrs, err=%d\n", ret);
239 int mtd_add_partition(struct mtd_info *parent, const char *name,
240 long long offset, long long length)
242 struct mtd_info *master = mtd_get_master(parent);
243 u64 parent_size = mtd_is_partition(parent) ?
244 parent->part.size : parent->size;
245 struct mtd_partition part;
246 struct mtd_info *child;
249 /* the direct offset is expected */
250 if (offset == MTDPART_OFS_APPEND ||
251 offset == MTDPART_OFS_NXTBLK)
254 if (length == MTDPART_SIZ_FULL)
255 length = parent_size - offset;
260 memset(&part, 0, sizeof(part));
263 part.offset = offset;
265 child = allocate_partition(parent, &part, -1, offset);
267 return PTR_ERR(child);
269 mutex_lock(&master->master.partitions_lock);
270 list_add_tail(&child->part.node, &parent->partitions);
271 mutex_unlock(&master->master.partitions_lock);
273 ret = add_mtd_device(child);
275 goto err_remove_part;
277 mtd_add_partition_attrs(child);
282 mutex_lock(&master->master.partitions_lock);
283 list_del(&child->part.node);
284 mutex_unlock(&master->master.partitions_lock);
286 free_partition(child);
290 EXPORT_SYMBOL_GPL(mtd_add_partition);
293 * __mtd_del_partition - delete MTD partition
295 * @mtd: MTD structure to be deleted
297 * This function must be called with the partitions mutex locked.
299 static int __mtd_del_partition(struct mtd_info *mtd)
301 struct mtd_info *child, *next;
304 list_for_each_entry_safe(child, next, &mtd->partitions, part.node) {
305 err = __mtd_del_partition(child);
310 sysfs_remove_files(&mtd->dev.kobj, mtd_partition_attrs);
312 err = del_mtd_device(mtd);
316 list_del(&mtd->part.node);
323 * This function unregisters and destroy all slave MTD objects which are
324 * attached to the given MTD object, recursively.
326 static int __del_mtd_partitions(struct mtd_info *mtd)
328 struct mtd_info *child, *next;
332 list_for_each_entry_safe(child, next, &mtd->partitions, part.node) {
333 if (mtd_has_partitions(child))
334 __del_mtd_partitions(child);
336 pr_info("Deleting %s MTD partition\n", child->name);
337 ret = del_mtd_device(child);
339 pr_err("Error when deleting partition \"%s\" (%d)\n",
345 list_del(&child->part.node);
346 free_partition(child);
352 int del_mtd_partitions(struct mtd_info *mtd)
354 struct mtd_info *master = mtd_get_master(mtd);
357 pr_info("Deleting MTD partitions on \"%s\":\n", mtd->name);
359 mutex_lock(&master->master.partitions_lock);
360 ret = __del_mtd_partitions(mtd);
361 mutex_unlock(&master->master.partitions_lock);
366 int mtd_del_partition(struct mtd_info *mtd, int partno)
368 struct mtd_info *child, *master = mtd_get_master(mtd);
371 mutex_lock(&master->master.partitions_lock);
372 list_for_each_entry(child, &mtd->partitions, part.node) {
373 if (child->index == partno) {
374 ret = __mtd_del_partition(child);
378 mutex_unlock(&master->master.partitions_lock);
382 EXPORT_SYMBOL_GPL(mtd_del_partition);
385 * This function, given a parent MTD object and a partition table, creates
386 * and registers the child MTD objects which are bound to the parent according
387 * to the partition definitions.
389 * For historical reasons, this function's caller only registers the parent
390 * if the MTD_PARTITIONED_MASTER config option is set.
393 int add_mtd_partitions(struct mtd_info *parent,
394 const struct mtd_partition *parts,
397 struct mtd_info *child, *master = mtd_get_master(parent);
398 uint64_t cur_offset = 0;
401 printk(KERN_NOTICE "Creating %d MTD partitions on \"%s\":\n",
402 nbparts, parent->name);
404 for (i = 0; i < nbparts; i++) {
405 child = allocate_partition(parent, parts + i, i, cur_offset);
407 ret = PTR_ERR(child);
408 goto err_del_partitions;
411 mutex_lock(&master->master.partitions_lock);
412 list_add_tail(&child->part.node, &parent->partitions);
413 mutex_unlock(&master->master.partitions_lock);
415 ret = add_mtd_device(child);
417 mutex_lock(&master->master.partitions_lock);
418 list_del(&child->part.node);
419 mutex_unlock(&master->master.partitions_lock);
421 free_partition(child);
422 goto err_del_partitions;
425 mtd_add_partition_attrs(child);
427 /* Look for subpartitions */
428 parse_mtd_partitions(child, parts[i].types, NULL);
430 cur_offset = child->part.offset + child->part.size;
436 del_mtd_partitions(master);
441 static DEFINE_SPINLOCK(part_parser_lock);
442 static LIST_HEAD(part_parsers);
444 static struct mtd_part_parser *mtd_part_parser_get(const char *name)
446 struct mtd_part_parser *p, *ret = NULL;
448 spin_lock(&part_parser_lock);
450 list_for_each_entry(p, &part_parsers, list)
451 if (!strcmp(p->name, name) && try_module_get(p->owner)) {
456 spin_unlock(&part_parser_lock);
461 static inline void mtd_part_parser_put(const struct mtd_part_parser *p)
463 module_put(p->owner);
467 * Many partition parsers just expected the core to kfree() all their data in
468 * one chunk. Do that by default.
470 static void mtd_part_parser_cleanup_default(const struct mtd_partition *pparts,
476 int __register_mtd_parser(struct mtd_part_parser *p, struct module *owner)
481 p->cleanup = &mtd_part_parser_cleanup_default;
483 spin_lock(&part_parser_lock);
484 list_add(&p->list, &part_parsers);
485 spin_unlock(&part_parser_lock);
489 EXPORT_SYMBOL_GPL(__register_mtd_parser);
491 void deregister_mtd_parser(struct mtd_part_parser *p)
493 spin_lock(&part_parser_lock);
495 spin_unlock(&part_parser_lock);
497 EXPORT_SYMBOL_GPL(deregister_mtd_parser);
500 * Do not forget to update 'parse_mtd_partitions()' kerneldoc comment if you
501 * are changing this array!
503 static const char * const default_mtd_part_types[] = {
509 /* Check DT only when looking for subpartitions. */
510 static const char * const default_subpartition_types[] = {
515 static int mtd_part_do_parse(struct mtd_part_parser *parser,
516 struct mtd_info *master,
517 struct mtd_partitions *pparts,
518 struct mtd_part_parser_data *data)
522 ret = (*parser->parse_fn)(master, &pparts->parts, data);
523 pr_debug("%s: parser %s: %i\n", master->name, parser->name, ret);
527 pr_notice("%d %s partitions found on MTD device %s\n", ret,
528 parser->name, master->name);
530 pparts->nr_parts = ret;
531 pparts->parser = parser;
537 * mtd_part_get_compatible_parser - find MTD parser by a compatible string
539 * @compat: compatible string describing partitions in a device tree
541 * MTD parsers can specify supported partitions by providing a table of
542 * compatibility strings. This function finds a parser that advertises support
543 * for a passed value of "compatible".
545 static struct mtd_part_parser *mtd_part_get_compatible_parser(const char *compat)
547 struct mtd_part_parser *p, *ret = NULL;
549 spin_lock(&part_parser_lock);
551 list_for_each_entry(p, &part_parsers, list) {
552 const struct of_device_id *matches;
554 matches = p->of_match_table;
558 for (; matches->compatible[0]; matches++) {
559 if (!strcmp(matches->compatible, compat) &&
560 try_module_get(p->owner)) {
570 spin_unlock(&part_parser_lock);
575 static int mtd_part_of_parse(struct mtd_info *master,
576 struct mtd_partitions *pparts)
578 struct mtd_part_parser *parser;
579 struct device_node *np;
580 struct property *prop;
583 const char *fixed = "fixed-partitions";
587 /* Use parent device (controller) if the top level MTD is not registered */
588 if (!IS_ENABLED(CONFIG_MTD_PARTITIONED_MASTER) && !mtd_is_partition(master))
589 dev = master->dev.parent;
591 np = mtd_get_of_node(master);
592 if (mtd_is_partition(master))
595 np = of_get_child_by_name(np, "partitions");
597 of_property_for_each_string(np, "compatible", prop, compat) {
598 parser = mtd_part_get_compatible_parser(compat);
601 ret = mtd_part_do_parse(parser, master, pparts, NULL);
603 of_platform_populate(np, NULL, NULL, dev);
607 mtd_part_parser_put(parser);
611 of_platform_populate(np, NULL, NULL, dev);
615 * For backward compatibility we have to try the "fixed-partitions"
616 * parser. It supports old DT format with partitions specified as a
617 * direct subnodes of a flash device DT node without any compatibility
618 * specified we could match.
620 parser = mtd_part_parser_get(fixed);
621 if (!parser && !request_module("%s", fixed))
622 parser = mtd_part_parser_get(fixed);
624 ret = mtd_part_do_parse(parser, master, pparts, NULL);
627 mtd_part_parser_put(parser);
636 * parse_mtd_partitions - parse and register MTD partitions
638 * @master: the master partition (describes whole MTD device)
639 * @types: names of partition parsers to try or %NULL
640 * @data: MTD partition parser-specific data
642 * This function tries to find & register partitions on MTD device @master. It
643 * uses MTD partition parsers, specified in @types. However, if @types is %NULL,
644 * then the default list of parsers is used. The default list contains only the
645 * "cmdlinepart" and "ofpart" parsers ATM.
646 * Note: If there are more then one parser in @types, the kernel only takes the
647 * partitions parsed out by the first parser.
649 * This function may return:
650 * o a negative error code in case of failure
651 * o number of found partitions otherwise
653 int parse_mtd_partitions(struct mtd_info *master, const char *const *types,
654 struct mtd_part_parser_data *data)
656 struct mtd_partitions pparts = { };
657 struct mtd_part_parser *parser;
661 types = mtd_is_partition(master) ? default_subpartition_types :
662 default_mtd_part_types;
664 for ( ; *types; types++) {
666 * ofpart is a special type that means OF partitioning info
667 * should be used. It requires a bit different logic so it is
668 * handled in a separated function.
670 if (!strcmp(*types, "ofpart")) {
671 ret = mtd_part_of_parse(master, &pparts);
673 pr_debug("%s: parsing partitions %s\n", master->name,
675 parser = mtd_part_parser_get(*types);
676 if (!parser && !request_module("%s", *types))
677 parser = mtd_part_parser_get(*types);
678 pr_debug("%s: got parser %s\n", master->name,
679 parser ? parser->name : NULL);
682 ret = mtd_part_do_parse(parser, master, &pparts, data);
684 mtd_part_parser_put(parser);
686 /* Found partitions! */
688 err = add_mtd_partitions(master, pparts.parts,
690 mtd_part_parser_cleanup(&pparts);
691 return err ? err : pparts.nr_parts;
694 * Stash the first error we see; only report it if no parser
703 void mtd_part_parser_cleanup(struct mtd_partitions *parts)
705 const struct mtd_part_parser *parser;
710 parser = parts->parser;
713 parser->cleanup(parts->parts, parts->nr_parts);
715 mtd_part_parser_put(parser);
719 /* Returns the size of the entire flash chip */
720 uint64_t mtd_get_device_size(const struct mtd_info *mtd)
722 struct mtd_info *master = mtd_get_master((struct mtd_info *)mtd);
726 EXPORT_SYMBOL_GPL(mtd_get_device_size);