2 * Simple MTD partitioning layer
4 * Copyright © 2000 Nicolas Pitre <nico@fluxnic.net>
5 * Copyright © 2002 Thomas Gleixner <gleixner@linutronix.de>
6 * Copyright © 2000-2010 David Woodhouse <dwmw2@infradead.org>
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.
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.
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
24 #include <linux/module.h>
25 #include <linux/types.h>
26 #include <linux/kernel.h>
27 #include <linux/slab.h>
28 #include <linux/list.h>
29 #include <linux/kmod.h>
30 #include <linux/mtd/mtd.h>
31 #include <linux/mtd/partitions.h>
32 #include <linux/err.h>
33 #include <linux/kconfig.h>
37 /* Our partition linked list */
38 static LIST_HEAD(mtd_partitions);
39 static DEFINE_MUTEX(mtd_partitions_mutex);
41 /* Our partition node structure */
44 struct mtd_info *master;
46 struct list_head list;
50 * Given a pointer to the MTD object in the mtd_part structure, we can retrieve
51 * the pointer to that structure with this macro.
53 #define PART(x) ((struct mtd_part *)(x))
57 * MTD methods which simply translate the effective address and pass through
58 * to the _real_ device.
61 static int part_read(struct mtd_info *mtd, loff_t from, size_t len,
62 size_t *retlen, u_char *buf)
64 struct mtd_part *part = PART(mtd);
65 struct mtd_ecc_stats stats;
68 stats = part->master->ecc_stats;
69 res = part->master->_read(part->master, from + part->offset, len,
71 if (unlikely(mtd_is_eccerr(res)))
72 mtd->ecc_stats.failed +=
73 part->master->ecc_stats.failed - stats.failed;
75 mtd->ecc_stats.corrected +=
76 part->master->ecc_stats.corrected - stats.corrected;
80 static int part_point(struct mtd_info *mtd, loff_t from, size_t len,
81 size_t *retlen, void **virt, resource_size_t *phys)
83 struct mtd_part *part = PART(mtd);
85 return part->master->_point(part->master, from + part->offset, len,
89 static int part_unpoint(struct mtd_info *mtd, loff_t from, size_t len)
91 struct mtd_part *part = PART(mtd);
93 return part->master->_unpoint(part->master, from + part->offset, len);
96 static unsigned long part_get_unmapped_area(struct mtd_info *mtd,
101 struct mtd_part *part = PART(mtd);
103 offset += part->offset;
104 return part->master->_get_unmapped_area(part->master, len, offset,
108 static int part_read_oob(struct mtd_info *mtd, loff_t from,
109 struct mtd_oob_ops *ops)
111 struct mtd_part *part = PART(mtd);
114 if (from >= mtd->size)
116 if (ops->datbuf && from + ops->len > mtd->size)
120 * If OOB is also requested, make sure that we do not read past the end
126 if (ops->mode == MTD_OPS_AUTO_OOB)
130 pages = mtd_div_by_ws(mtd->size, mtd);
131 pages -= mtd_div_by_ws(from, mtd);
132 if (ops->ooboffs + ops->ooblen > pages * len)
136 res = part->master->_read_oob(part->master, from + part->offset, ops);
138 if (mtd_is_bitflip(res))
139 mtd->ecc_stats.corrected++;
140 if (mtd_is_eccerr(res))
141 mtd->ecc_stats.failed++;
146 static int part_read_user_prot_reg(struct mtd_info *mtd, loff_t from,
147 size_t len, size_t *retlen, u_char *buf)
149 struct mtd_part *part = PART(mtd);
150 return part->master->_read_user_prot_reg(part->master, from, len,
154 static int part_get_user_prot_info(struct mtd_info *mtd, size_t len,
155 size_t *retlen, struct otp_info *buf)
157 struct mtd_part *part = PART(mtd);
158 return part->master->_get_user_prot_info(part->master, len, retlen,
162 static int part_read_fact_prot_reg(struct mtd_info *mtd, loff_t from,
163 size_t len, size_t *retlen, u_char *buf)
165 struct mtd_part *part = PART(mtd);
166 return part->master->_read_fact_prot_reg(part->master, from, len,
170 static int part_get_fact_prot_info(struct mtd_info *mtd, size_t len,
171 size_t *retlen, struct otp_info *buf)
173 struct mtd_part *part = PART(mtd);
174 return part->master->_get_fact_prot_info(part->master, len, retlen,
178 static int part_write(struct mtd_info *mtd, loff_t to, size_t len,
179 size_t *retlen, const u_char *buf)
181 struct mtd_part *part = PART(mtd);
182 return part->master->_write(part->master, to + part->offset, len,
186 static int part_panic_write(struct mtd_info *mtd, loff_t to, size_t len,
187 size_t *retlen, const u_char *buf)
189 struct mtd_part *part = PART(mtd);
190 return part->master->_panic_write(part->master, to + part->offset, len,
194 static int part_write_oob(struct mtd_info *mtd, loff_t to,
195 struct mtd_oob_ops *ops)
197 struct mtd_part *part = PART(mtd);
201 if (ops->datbuf && to + ops->len > mtd->size)
203 return part->master->_write_oob(part->master, to + part->offset, ops);
206 static int part_write_user_prot_reg(struct mtd_info *mtd, loff_t from,
207 size_t len, size_t *retlen, u_char *buf)
209 struct mtd_part *part = PART(mtd);
210 return part->master->_write_user_prot_reg(part->master, from, len,
214 static int part_lock_user_prot_reg(struct mtd_info *mtd, loff_t from,
217 struct mtd_part *part = PART(mtd);
218 return part->master->_lock_user_prot_reg(part->master, from, len);
221 static int part_writev(struct mtd_info *mtd, const struct kvec *vecs,
222 unsigned long count, loff_t to, size_t *retlen)
224 struct mtd_part *part = PART(mtd);
225 return part->master->_writev(part->master, vecs, count,
226 to + part->offset, retlen);
229 static int part_erase(struct mtd_info *mtd, struct erase_info *instr)
231 struct mtd_part *part = PART(mtd);
234 instr->addr += part->offset;
235 ret = part->master->_erase(part->master, instr);
237 if (instr->fail_addr != MTD_FAIL_ADDR_UNKNOWN)
238 instr->fail_addr -= part->offset;
239 instr->addr -= part->offset;
244 void mtd_erase_callback(struct erase_info *instr)
246 if (instr->mtd->_erase == part_erase) {
247 struct mtd_part *part = PART(instr->mtd);
249 if (instr->fail_addr != MTD_FAIL_ADDR_UNKNOWN)
250 instr->fail_addr -= part->offset;
251 instr->addr -= part->offset;
254 instr->callback(instr);
256 EXPORT_SYMBOL_GPL(mtd_erase_callback);
258 static int part_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
260 struct mtd_part *part = PART(mtd);
261 return part->master->_lock(part->master, ofs + part->offset, len);
264 static int part_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
266 struct mtd_part *part = PART(mtd);
267 return part->master->_unlock(part->master, ofs + part->offset, len);
270 static int part_is_locked(struct mtd_info *mtd, loff_t ofs, uint64_t len)
272 struct mtd_part *part = PART(mtd);
273 return part->master->_is_locked(part->master, ofs + part->offset, len);
276 static void part_sync(struct mtd_info *mtd)
278 struct mtd_part *part = PART(mtd);
279 part->master->_sync(part->master);
282 static int part_suspend(struct mtd_info *mtd)
284 struct mtd_part *part = PART(mtd);
285 return part->master->_suspend(part->master);
288 static void part_resume(struct mtd_info *mtd)
290 struct mtd_part *part = PART(mtd);
291 part->master->_resume(part->master);
294 static int part_block_isreserved(struct mtd_info *mtd, loff_t ofs)
296 struct mtd_part *part = PART(mtd);
298 return part->master->_block_isreserved(part->master, ofs);
301 static int part_block_isbad(struct mtd_info *mtd, loff_t ofs)
303 struct mtd_part *part = PART(mtd);
305 return part->master->_block_isbad(part->master, ofs);
308 static int part_block_markbad(struct mtd_info *mtd, loff_t ofs)
310 struct mtd_part *part = PART(mtd);
314 res = part->master->_block_markbad(part->master, ofs);
316 mtd->ecc_stats.badblocks++;
320 static inline void free_partition(struct mtd_part *p)
327 * This function unregisters and destroy all slave MTD objects which are
328 * attached to the given master MTD object.
331 int del_mtd_partitions(struct mtd_info *master)
333 struct mtd_part *slave, *next;
336 mutex_lock(&mtd_partitions_mutex);
337 list_for_each_entry_safe(slave, next, &mtd_partitions, list)
338 if (slave->master == master) {
339 ret = del_mtd_device(&slave->mtd);
344 list_del(&slave->list);
345 free_partition(slave);
347 mutex_unlock(&mtd_partitions_mutex);
352 static struct mtd_part *allocate_partition(struct mtd_info *master,
353 const struct mtd_partition *part, int partno,
356 struct mtd_part *slave;
359 /* allocate the partition structure */
360 slave = kzalloc(sizeof(*slave), GFP_KERNEL);
361 name = kstrdup(part->name, GFP_KERNEL);
362 if (!name || !slave) {
363 printk(KERN_ERR"memory allocation error while creating partitions for \"%s\"\n",
367 return ERR_PTR(-ENOMEM);
370 /* set up the MTD object for this partition */
371 slave->mtd.type = master->type;
372 slave->mtd.flags = master->flags & ~part->mask_flags;
373 slave->mtd.size = part->size;
374 slave->mtd.writesize = master->writesize;
375 slave->mtd.writebufsize = master->writebufsize;
376 slave->mtd.oobsize = master->oobsize;
377 slave->mtd.oobavail = master->oobavail;
378 slave->mtd.subpage_sft = master->subpage_sft;
380 slave->mtd.name = name;
381 slave->mtd.owner = master->owner;
383 /* NOTE: Historically, we didn't arrange MTDs as a tree out of
384 * concern for showing the same data in multiple partitions.
385 * However, it is very useful to have the master node present,
386 * so the MTD_PARTITIONED_MASTER option allows that. The master
387 * will have device nodes etc only if this is set, so make the
388 * parent conditional on that option. Note, this is a way to
389 * distinguish between the master and the partition in sysfs.
391 slave->mtd.dev.parent = IS_ENABLED(CONFIG_MTD_PARTITIONED_MASTER) ?
395 slave->mtd._read = part_read;
396 slave->mtd._write = part_write;
398 if (master->_panic_write)
399 slave->mtd._panic_write = part_panic_write;
401 if (master->_point && master->_unpoint) {
402 slave->mtd._point = part_point;
403 slave->mtd._unpoint = part_unpoint;
406 if (master->_get_unmapped_area)
407 slave->mtd._get_unmapped_area = part_get_unmapped_area;
408 if (master->_read_oob)
409 slave->mtd._read_oob = part_read_oob;
410 if (master->_write_oob)
411 slave->mtd._write_oob = part_write_oob;
412 if (master->_read_user_prot_reg)
413 slave->mtd._read_user_prot_reg = part_read_user_prot_reg;
414 if (master->_read_fact_prot_reg)
415 slave->mtd._read_fact_prot_reg = part_read_fact_prot_reg;
416 if (master->_write_user_prot_reg)
417 slave->mtd._write_user_prot_reg = part_write_user_prot_reg;
418 if (master->_lock_user_prot_reg)
419 slave->mtd._lock_user_prot_reg = part_lock_user_prot_reg;
420 if (master->_get_user_prot_info)
421 slave->mtd._get_user_prot_info = part_get_user_prot_info;
422 if (master->_get_fact_prot_info)
423 slave->mtd._get_fact_prot_info = part_get_fact_prot_info;
425 slave->mtd._sync = part_sync;
426 if (!partno && !master->dev.class && master->_suspend &&
428 slave->mtd._suspend = part_suspend;
429 slave->mtd._resume = part_resume;
432 slave->mtd._writev = part_writev;
434 slave->mtd._lock = part_lock;
436 slave->mtd._unlock = part_unlock;
437 if (master->_is_locked)
438 slave->mtd._is_locked = part_is_locked;
439 if (master->_block_isreserved)
440 slave->mtd._block_isreserved = part_block_isreserved;
441 if (master->_block_isbad)
442 slave->mtd._block_isbad = part_block_isbad;
443 if (master->_block_markbad)
444 slave->mtd._block_markbad = part_block_markbad;
445 slave->mtd._erase = part_erase;
446 slave->master = master;
447 slave->offset = part->offset;
449 if (slave->offset == MTDPART_OFS_APPEND)
450 slave->offset = cur_offset;
451 if (slave->offset == MTDPART_OFS_NXTBLK) {
452 slave->offset = cur_offset;
453 if (mtd_mod_by_eb(cur_offset, master) != 0) {
454 /* Round up to next erasesize */
455 slave->offset = (mtd_div_by_eb(cur_offset, master) + 1) * master->erasesize;
456 printk(KERN_NOTICE "Moving partition %d: "
457 "0x%012llx -> 0x%012llx\n", partno,
458 (unsigned long long)cur_offset, (unsigned long long)slave->offset);
461 if (slave->offset == MTDPART_OFS_RETAIN) {
462 slave->offset = cur_offset;
463 if (master->size - slave->offset >= slave->mtd.size) {
464 slave->mtd.size = master->size - slave->offset
467 printk(KERN_ERR "mtd partition \"%s\" doesn't have enough space: %#llx < %#llx, disabled\n",
468 part->name, master->size - slave->offset,
470 /* register to preserve ordering */
474 if (slave->mtd.size == MTDPART_SIZ_FULL)
475 slave->mtd.size = master->size - slave->offset;
477 printk(KERN_NOTICE "0x%012llx-0x%012llx : \"%s\"\n", (unsigned long long)slave->offset,
478 (unsigned long long)(slave->offset + slave->mtd.size), slave->mtd.name);
480 /* let's do some sanity checks */
481 if (slave->offset >= master->size) {
482 /* let's register it anyway to preserve ordering */
485 printk(KERN_ERR"mtd: partition \"%s\" is out of reach -- disabled\n",
489 if (slave->offset + slave->mtd.size > master->size) {
490 slave->mtd.size = master->size - slave->offset;
491 printk(KERN_WARNING"mtd: partition \"%s\" extends beyond the end of device \"%s\" -- size truncated to %#llx\n",
492 part->name, master->name, (unsigned long long)slave->mtd.size);
494 if (master->numeraseregions > 1) {
495 /* Deal with variable erase size stuff */
496 int i, max = master->numeraseregions;
497 u64 end = slave->offset + slave->mtd.size;
498 struct mtd_erase_region_info *regions = master->eraseregions;
500 /* Find the first erase regions which is part of this
502 for (i = 0; i < max && regions[i].offset <= slave->offset; i++)
504 /* The loop searched for the region _behind_ the first one */
508 /* Pick biggest erasesize */
509 for (; i < max && regions[i].offset < end; i++) {
510 if (slave->mtd.erasesize < regions[i].erasesize) {
511 slave->mtd.erasesize = regions[i].erasesize;
514 BUG_ON(slave->mtd.erasesize == 0);
516 /* Single erase size */
517 slave->mtd.erasesize = master->erasesize;
520 if ((slave->mtd.flags & MTD_WRITEABLE) &&
521 mtd_mod_by_eb(slave->offset, &slave->mtd)) {
522 /* Doesn't start on a boundary of major erase size */
523 /* FIXME: Let it be writable if it is on a boundary of
524 * _minor_ erase size though */
525 slave->mtd.flags &= ~MTD_WRITEABLE;
526 printk(KERN_WARNING"mtd: partition \"%s\" doesn't start on an erase block boundary -- force read-only\n",
529 if ((slave->mtd.flags & MTD_WRITEABLE) &&
530 mtd_mod_by_eb(slave->mtd.size, &slave->mtd)) {
531 slave->mtd.flags &= ~MTD_WRITEABLE;
532 printk(KERN_WARNING"mtd: partition \"%s\" doesn't end on an erase block -- force read-only\n",
536 slave->mtd.ecclayout = master->ecclayout;
537 slave->mtd.ecc_step_size = master->ecc_step_size;
538 slave->mtd.ecc_strength = master->ecc_strength;
539 slave->mtd.bitflip_threshold = master->bitflip_threshold;
541 if (master->_block_isbad) {
544 while (offs < slave->mtd.size) {
545 if (mtd_block_isreserved(master, offs + slave->offset))
546 slave->mtd.ecc_stats.bbtblocks++;
547 else if (mtd_block_isbad(master, offs + slave->offset))
548 slave->mtd.ecc_stats.badblocks++;
549 offs += slave->mtd.erasesize;
557 static ssize_t mtd_partition_offset_show(struct device *dev,
558 struct device_attribute *attr, char *buf)
560 struct mtd_info *mtd = dev_get_drvdata(dev);
561 struct mtd_part *part = PART(mtd);
562 return snprintf(buf, PAGE_SIZE, "%lld\n", part->offset);
565 static DEVICE_ATTR(offset, S_IRUGO, mtd_partition_offset_show, NULL);
567 static const struct attribute *mtd_partition_attrs[] = {
568 &dev_attr_offset.attr,
572 static int mtd_add_partition_attrs(struct mtd_part *new)
574 int ret = sysfs_create_files(&new->mtd.dev.kobj, mtd_partition_attrs);
577 "mtd: failed to create partition attrs, err=%d\n", ret);
581 int mtd_add_partition(struct mtd_info *master, const char *name,
582 long long offset, long long length)
584 struct mtd_partition part;
585 struct mtd_part *new;
588 /* the direct offset is expected */
589 if (offset == MTDPART_OFS_APPEND ||
590 offset == MTDPART_OFS_NXTBLK)
593 if (length == MTDPART_SIZ_FULL)
594 length = master->size - offset;
601 part.offset = offset;
603 part.ecclayout = NULL;
605 new = allocate_partition(master, &part, -1, offset);
609 mutex_lock(&mtd_partitions_mutex);
610 list_add(&new->list, &mtd_partitions);
611 mutex_unlock(&mtd_partitions_mutex);
613 add_mtd_device(&new->mtd);
615 mtd_add_partition_attrs(new);
619 EXPORT_SYMBOL_GPL(mtd_add_partition);
621 int mtd_del_partition(struct mtd_info *master, int partno)
623 struct mtd_part *slave, *next;
626 mutex_lock(&mtd_partitions_mutex);
627 list_for_each_entry_safe(slave, next, &mtd_partitions, list)
628 if ((slave->master == master) &&
629 (slave->mtd.index == partno)) {
630 sysfs_remove_files(&slave->mtd.dev.kobj,
631 mtd_partition_attrs);
632 ret = del_mtd_device(&slave->mtd);
636 list_del(&slave->list);
637 free_partition(slave);
640 mutex_unlock(&mtd_partitions_mutex);
644 EXPORT_SYMBOL_GPL(mtd_del_partition);
647 * This function, given a master MTD object and a partition table, creates
648 * and registers slave MTD objects which are bound to the master according to
649 * the partition definitions.
651 * For historical reasons, this function's caller only registers the master
652 * if the MTD_PARTITIONED_MASTER config option is set.
655 int add_mtd_partitions(struct mtd_info *master,
656 const struct mtd_partition *parts,
659 struct mtd_part *slave;
660 uint64_t cur_offset = 0;
663 printk(KERN_NOTICE "Creating %d MTD partitions on \"%s\":\n", nbparts, master->name);
665 for (i = 0; i < nbparts; i++) {
666 slave = allocate_partition(master, parts + i, i, cur_offset);
668 del_mtd_partitions(master);
669 return PTR_ERR(slave);
672 mutex_lock(&mtd_partitions_mutex);
673 list_add(&slave->list, &mtd_partitions);
674 mutex_unlock(&mtd_partitions_mutex);
676 add_mtd_device(&slave->mtd);
677 mtd_add_partition_attrs(slave);
679 cur_offset = slave->offset + slave->mtd.size;
685 static DEFINE_SPINLOCK(part_parser_lock);
686 static LIST_HEAD(part_parsers);
688 static struct mtd_part_parser *get_partition_parser(const char *name)
690 struct mtd_part_parser *p, *ret = NULL;
692 spin_lock(&part_parser_lock);
694 list_for_each_entry(p, &part_parsers, list)
695 if (!strcmp(p->name, name) && try_module_get(p->owner)) {
700 spin_unlock(&part_parser_lock);
705 #define put_partition_parser(p) do { module_put((p)->owner); } while (0)
707 void register_mtd_parser(struct mtd_part_parser *p)
709 spin_lock(&part_parser_lock);
710 list_add(&p->list, &part_parsers);
711 spin_unlock(&part_parser_lock);
713 EXPORT_SYMBOL_GPL(register_mtd_parser);
715 void deregister_mtd_parser(struct mtd_part_parser *p)
717 spin_lock(&part_parser_lock);
719 spin_unlock(&part_parser_lock);
721 EXPORT_SYMBOL_GPL(deregister_mtd_parser);
724 * Do not forget to update 'parse_mtd_partitions()' kerneldoc comment if you
725 * are changing this array!
727 static const char * const default_mtd_part_types[] = {
734 * parse_mtd_partitions - parse MTD partitions
735 * @master: the master partition (describes whole MTD device)
736 * @types: names of partition parsers to try or %NULL
737 * @pparts: array of partitions found is returned here
738 * @data: MTD partition parser-specific data
740 * This function tries to find partition on MTD device @master. It uses MTD
741 * partition parsers, specified in @types. However, if @types is %NULL, then
742 * the default list of parsers is used. The default list contains only the
743 * "cmdlinepart" and "ofpart" parsers ATM.
744 * Note: If there are more then one parser in @types, the kernel only takes the
745 * partitions parsed out by the first parser.
747 * This function may return:
748 * o a negative error code in case of failure
749 * o zero if no partitions were found
750 * o a positive number of found partitions, in which case on exit @pparts will
751 * point to an array containing this number of &struct mtd_info objects.
753 int parse_mtd_partitions(struct mtd_info *master, const char *const *types,
754 struct mtd_partition **pparts,
755 struct mtd_part_parser_data *data)
757 struct mtd_part_parser *parser;
761 types = default_mtd_part_types;
763 for ( ; *types; types++) {
764 pr_debug("%s: parsing partitions %s\n", master->name, *types);
765 parser = get_partition_parser(*types);
766 if (!parser && !request_module("%s", *types))
767 parser = get_partition_parser(*types);
768 pr_debug("%s: got parser %s\n", master->name,
769 parser ? parser->name : NULL);
772 ret = (*parser->parse_fn)(master, pparts, data);
773 pr_debug("%s: parser %s: %i\n",
774 master->name, parser->name, ret);
775 put_partition_parser(parser);
777 printk(KERN_NOTICE "%d %s partitions found on MTD device %s\n",
778 ret, parser->name, master->name);
782 * Stash the first error we see; only report it if no parser
791 int mtd_is_partition(const struct mtd_info *mtd)
793 struct mtd_part *part;
796 mutex_lock(&mtd_partitions_mutex);
797 list_for_each_entry(part, &mtd_partitions, list)
798 if (&part->mtd == mtd) {
802 mutex_unlock(&mtd_partitions_mutex);
806 EXPORT_SYMBOL_GPL(mtd_is_partition);
808 /* Returns the size of the entire flash chip */
809 uint64_t mtd_get_device_size(const struct mtd_info *mtd)
811 if (!mtd_is_partition(mtd))
814 return PART(mtd)->master->size;
816 EXPORT_SYMBOL_GPL(mtd_get_device_size);