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 * SPDX-License-Identifier: GPL-2.0+
13 #include <linux/module.h>
14 #include <linux/types.h>
15 #include <linux/kernel.h>
16 #include <linux/slab.h>
17 #include <linux/list.h>
18 #include <linux/kmod.h>
23 #include <asm/errno.h>
24 #include <linux/compat.h>
25 #include <ubi_uboot.h>
27 #include <linux/mtd/mtd.h>
28 #include <linux/mtd/partitions.h>
29 #include <linux/err.h>
33 /* Our partition linked list */
34 static LIST_HEAD(mtd_partitions
);
36 static DEFINE_MUTEX(mtd_partitions_mutex
);
38 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))
60 * kstrdup - allocate space for and copy an existing string
61 * @s: the string to duplicate
62 * @gfp: the GFP mask used in the kmalloc() call when allocating memory
64 char *kstrdup(const char *s
, gfp_t gfp
)
73 buf
= kmalloc(len
, gfp
);
81 * MTD methods which simply translate the effective address and pass through
82 * to the _real_ device.
85 static int part_read(struct mtd_info
*mtd
, loff_t from
, size_t len
,
86 size_t *retlen
, u_char
*buf
)
88 struct mtd_part
*part
= PART(mtd
);
89 struct mtd_ecc_stats stats
;
92 stats
= part
->master
->ecc_stats
;
93 res
= part
->master
->_read(part
->master
, from
+ part
->offset
, len
,
95 if (unlikely(mtd_is_eccerr(res
)))
96 mtd
->ecc_stats
.failed
+=
97 part
->master
->ecc_stats
.failed
- stats
.failed
;
99 mtd
->ecc_stats
.corrected
+=
100 part
->master
->ecc_stats
.corrected
- stats
.corrected
;
105 static int part_point(struct mtd_info
*mtd
, loff_t from
, size_t len
,
106 size_t *retlen
, void **virt
, resource_size_t
*phys
)
108 struct mtd_part
*part
= PART(mtd
);
110 return part
->master
->_point(part
->master
, from
+ part
->offset
, len
,
114 static int part_unpoint(struct mtd_info
*mtd
, loff_t from
, size_t len
)
116 struct mtd_part
*part
= PART(mtd
);
118 return part
->master
->_unpoint(part
->master
, from
+ part
->offset
, len
);
122 static unsigned long part_get_unmapped_area(struct mtd_info
*mtd
,
124 unsigned long offset
,
127 struct mtd_part
*part
= PART(mtd
);
129 offset
+= part
->offset
;
130 return part
->master
->_get_unmapped_area(part
->master
, len
, offset
,
134 static int part_read_oob(struct mtd_info
*mtd
, loff_t from
,
135 struct mtd_oob_ops
*ops
)
137 struct mtd_part
*part
= PART(mtd
);
140 if (from
>= mtd
->size
)
142 if (ops
->datbuf
&& from
+ ops
->len
> mtd
->size
)
146 * If OOB is also requested, make sure that we do not read past the end
152 if (ops
->mode
== MTD_OPS_AUTO_OOB
)
156 pages
= mtd_div_by_ws(mtd
->size
, mtd
);
157 pages
-= mtd_div_by_ws(from
, mtd
);
158 if (ops
->ooboffs
+ ops
->ooblen
> pages
* len
)
162 res
= part
->master
->_read_oob(part
->master
, from
+ part
->offset
, ops
);
164 if (mtd_is_bitflip(res
))
165 mtd
->ecc_stats
.corrected
++;
166 if (mtd_is_eccerr(res
))
167 mtd
->ecc_stats
.failed
++;
172 static int part_read_user_prot_reg(struct mtd_info
*mtd
, loff_t from
,
173 size_t len
, size_t *retlen
, u_char
*buf
)
175 struct mtd_part
*part
= PART(mtd
);
176 return part
->master
->_read_user_prot_reg(part
->master
, from
, len
,
180 static int part_get_user_prot_info(struct mtd_info
*mtd
, size_t len
,
181 size_t *retlen
, struct otp_info
*buf
)
183 struct mtd_part
*part
= PART(mtd
);
184 return part
->master
->_get_user_prot_info(part
->master
, len
, retlen
,
188 static int part_read_fact_prot_reg(struct mtd_info
*mtd
, loff_t from
,
189 size_t len
, size_t *retlen
, u_char
*buf
)
191 struct mtd_part
*part
= PART(mtd
);
192 return part
->master
->_read_fact_prot_reg(part
->master
, from
, len
,
196 static int part_get_fact_prot_info(struct mtd_info
*mtd
, size_t len
,
197 size_t *retlen
, struct otp_info
*buf
)
199 struct mtd_part
*part
= PART(mtd
);
200 return part
->master
->_get_fact_prot_info(part
->master
, len
, retlen
,
204 static int part_write(struct mtd_info
*mtd
, loff_t to
, size_t len
,
205 size_t *retlen
, const u_char
*buf
)
207 struct mtd_part
*part
= PART(mtd
);
208 return part
->master
->_write(part
->master
, to
+ part
->offset
, len
,
212 static int part_panic_write(struct mtd_info
*mtd
, loff_t to
, size_t len
,
213 size_t *retlen
, const u_char
*buf
)
215 struct mtd_part
*part
= PART(mtd
);
216 return part
->master
->_panic_write(part
->master
, to
+ part
->offset
, len
,
220 static int part_write_oob(struct mtd_info
*mtd
, loff_t to
,
221 struct mtd_oob_ops
*ops
)
223 struct mtd_part
*part
= PART(mtd
);
227 if (ops
->datbuf
&& to
+ ops
->len
> mtd
->size
)
229 return part
->master
->_write_oob(part
->master
, to
+ part
->offset
, ops
);
232 static int part_write_user_prot_reg(struct mtd_info
*mtd
, loff_t from
,
233 size_t len
, size_t *retlen
, u_char
*buf
)
235 struct mtd_part
*part
= PART(mtd
);
236 return part
->master
->_write_user_prot_reg(part
->master
, from
, len
,
240 static int part_lock_user_prot_reg(struct mtd_info
*mtd
, loff_t from
,
243 struct mtd_part
*part
= PART(mtd
);
244 return part
->master
->_lock_user_prot_reg(part
->master
, from
, len
);
248 static int part_writev(struct mtd_info
*mtd
, const struct kvec
*vecs
,
249 unsigned long count
, loff_t to
, size_t *retlen
)
251 struct mtd_part
*part
= PART(mtd
);
252 return part
->master
->_writev(part
->master
, vecs
, count
,
253 to
+ part
->offset
, retlen
);
257 static int part_erase(struct mtd_info
*mtd
, struct erase_info
*instr
)
259 struct mtd_part
*part
= PART(mtd
);
262 instr
->addr
+= part
->offset
;
263 ret
= part
->master
->_erase(part
->master
, instr
);
265 if (instr
->fail_addr
!= MTD_FAIL_ADDR_UNKNOWN
)
266 instr
->fail_addr
-= part
->offset
;
267 instr
->addr
-= part
->offset
;
272 void mtd_erase_callback(struct erase_info
*instr
)
274 if (instr
->mtd
->_erase
== part_erase
) {
275 struct mtd_part
*part
= PART(instr
->mtd
);
277 if (instr
->fail_addr
!= MTD_FAIL_ADDR_UNKNOWN
)
278 instr
->fail_addr
-= part
->offset
;
279 instr
->addr
-= part
->offset
;
282 instr
->callback(instr
);
284 EXPORT_SYMBOL_GPL(mtd_erase_callback
);
286 static int part_lock(struct mtd_info
*mtd
, loff_t ofs
, uint64_t len
)
288 struct mtd_part
*part
= PART(mtd
);
289 return part
->master
->_lock(part
->master
, ofs
+ part
->offset
, len
);
292 static int part_unlock(struct mtd_info
*mtd
, loff_t ofs
, uint64_t len
)
294 struct mtd_part
*part
= PART(mtd
);
295 return part
->master
->_unlock(part
->master
, ofs
+ part
->offset
, len
);
298 static int part_is_locked(struct mtd_info
*mtd
, loff_t ofs
, uint64_t len
)
300 struct mtd_part
*part
= PART(mtd
);
301 return part
->master
->_is_locked(part
->master
, ofs
+ part
->offset
, len
);
304 static void part_sync(struct mtd_info
*mtd
)
306 struct mtd_part
*part
= PART(mtd
);
307 part
->master
->_sync(part
->master
);
311 static int part_suspend(struct mtd_info
*mtd
)
313 struct mtd_part
*part
= PART(mtd
);
314 return part
->master
->_suspend(part
->master
);
317 static void part_resume(struct mtd_info
*mtd
)
319 struct mtd_part
*part
= PART(mtd
);
320 part
->master
->_resume(part
->master
);
324 static int part_block_isbad(struct mtd_info
*mtd
, loff_t ofs
)
326 struct mtd_part
*part
= PART(mtd
);
328 return part
->master
->_block_isbad(part
->master
, ofs
);
331 static int part_block_markbad(struct mtd_info
*mtd
, loff_t ofs
)
333 struct mtd_part
*part
= PART(mtd
);
337 res
= part
->master
->_block_markbad(part
->master
, ofs
);
339 mtd
->ecc_stats
.badblocks
++;
343 static inline void free_partition(struct mtd_part
*p
)
350 * This function unregisters and destroy all slave MTD objects which are
351 * attached to the given master MTD object.
354 int del_mtd_partitions(struct mtd_info
*master
)
356 struct mtd_part
*slave
, *next
;
359 mutex_lock(&mtd_partitions_mutex
);
360 list_for_each_entry_safe(slave
, next
, &mtd_partitions
, list
)
361 if (slave
->master
== master
) {
362 ret
= del_mtd_device(&slave
->mtd
);
367 list_del(&slave
->list
);
368 free_partition(slave
);
370 mutex_unlock(&mtd_partitions_mutex
);
375 static struct mtd_part
*allocate_partition(struct mtd_info
*master
,
376 const struct mtd_partition
*part
, int partno
,
379 struct mtd_part
*slave
;
382 /* allocate the partition structure */
383 slave
= kzalloc(sizeof(*slave
), GFP_KERNEL
);
384 name
= kstrdup(part
->name
, GFP_KERNEL
);
385 if (!name
|| !slave
) {
386 printk(KERN_ERR
"memory allocation error while creating partitions for \"%s
\"\n",
390 return ERR_PTR(-ENOMEM);
393 /* set up the MTD object for this partition */
394 slave->mtd.type = master->type;
395 slave->mtd.flags = master->flags & ~part->mask_flags;
396 slave->mtd.size = part->size;
397 slave->mtd.writesize = master->writesize;
398 slave->mtd.writebufsize = master->writebufsize;
399 slave->mtd.oobsize = master->oobsize;
400 slave->mtd.oobavail = master->oobavail;
401 slave->mtd.subpage_sft = master->subpage_sft;
403 slave->mtd.name = name;
404 slave->mtd.owner = master->owner;
406 slave->mtd.backing_dev_info = master->backing_dev_info;
408 /* NOTE: we don't arrange MTDs as a tree; it'd be error-prone
409 * to have the same data be in two different partitions.
411 slave->mtd.dev.parent = master->dev.parent;
414 slave->mtd._read = part_read;
415 slave->mtd._write = part_write;
417 if (master->_panic_write)
418 slave->mtd._panic_write = part_panic_write;
421 if (master->_point && master->_unpoint) {
422 slave->mtd._point = part_point;
423 slave->mtd._unpoint = part_unpoint;
427 if (master->_get_unmapped_area)
428 slave->mtd._get_unmapped_area = part_get_unmapped_area;
429 if (master->_read_oob)
430 slave->mtd._read_oob = part_read_oob;
431 if (master->_write_oob)
432 slave->mtd._write_oob = part_write_oob;
433 if (master->_read_user_prot_reg)
434 slave->mtd._read_user_prot_reg = part_read_user_prot_reg;
435 if (master->_read_fact_prot_reg)
436 slave->mtd._read_fact_prot_reg = part_read_fact_prot_reg;
437 if (master->_write_user_prot_reg)
438 slave->mtd._write_user_prot_reg = part_write_user_prot_reg;
439 if (master->_lock_user_prot_reg)
440 slave->mtd._lock_user_prot_reg = part_lock_user_prot_reg;
441 if (master->_get_user_prot_info)
442 slave->mtd._get_user_prot_info = part_get_user_prot_info;
443 if (master->_get_fact_prot_info)
444 slave->mtd._get_fact_prot_info = part_get_fact_prot_info;
446 slave->mtd._sync = part_sync;
448 if (!partno && !master->dev.class && master->_suspend &&
450 slave->mtd._suspend = part_suspend;
451 slave->mtd._resume = part_resume;
454 slave->mtd._writev = part_writev;
457 slave->mtd._lock = part_lock;
459 slave->mtd._unlock = part_unlock;
460 if (master->_is_locked)
461 slave->mtd._is_locked = part_is_locked;
462 if (master->_block_isbad)
463 slave->mtd._block_isbad = part_block_isbad;
464 if (master->_block_markbad)
465 slave->mtd._block_markbad = part_block_markbad;
466 slave->mtd._erase = part_erase;
467 slave->master = master;
468 slave->offset = part->offset;
470 if (slave->offset == MTDPART_OFS_APPEND)
471 slave->offset = cur_offset;
472 if (slave->offset == MTDPART_OFS_NXTBLK) {
473 slave->offset = cur_offset;
474 if (mtd_mod_by_eb(cur_offset, master) != 0) {
475 /* Round up to next erasesize */
476 slave->offset = (mtd_div_by_eb(cur_offset, master) + 1) * master->erasesize;
477 debug("Moving partition
%d
: "
478 "0x
%012llx
-> 0x
%012llx
\n", partno,
479 (unsigned long long)cur_offset, (unsigned long long)slave->offset);
482 if (slave->offset == MTDPART_OFS_RETAIN) {
483 slave->offset = cur_offset;
484 if (master->size - slave->offset >= slave->mtd.size) {
485 slave->mtd.size = master->size - slave->offset
488 debug("mtd partition
\"%s
\" doesn
't have enough space: %#llx < %#llx, disabled\n",
489 part->name, master->size - slave->offset,
491 /* register to preserve ordering */
495 if (slave->mtd.size == MTDPART_SIZ_FULL)
496 slave->mtd.size = master->size - slave->offset;
498 debug("0x%012llx-0x%012llx : \"%s\"\n", (unsigned long long)slave->offset,
499 (unsigned long long)(slave->offset + slave->mtd.size), slave->mtd.name);
501 /* let's
do some sanity checks */
502 if (slave
->offset
>= master
->size
) {
503 /* let's register it anyway to preserve ordering */
506 printk(KERN_ERR
"mtd: partition \"%s
\" is out of reach
-- disabled
\n",
510 if (slave->offset + slave->mtd.size > master->size) {
511 slave->mtd.size = master->size - slave->offset;
512 printk(KERN_WARNING"mtd
: partition
\"%s
\" extends beyond the end of device
\"%s
\" -- size truncated to
%#llx\n",
513 part->name, master->name, (unsigned long long)slave->mtd.size);
515 if (master->numeraseregions > 1) {
516 /* Deal with variable erase size stuff */
517 int i, max = master->numeraseregions;
518 u64 end = slave->offset + slave->mtd.size;
519 struct mtd_erase_region_info *regions = master->eraseregions;
521 /* Find the first erase regions which is part of this
523 for (i = 0; i < max && regions[i].offset <= slave->offset; i++)
525 /* The loop searched for the region _behind_ the first one */
529 /* Pick biggest erasesize */
530 for (; i < max && regions[i].offset < end; i++) {
531 if (slave->mtd.erasesize < regions[i].erasesize) {
532 slave->mtd.erasesize = regions[i].erasesize;
535 BUG_ON(slave->mtd.erasesize == 0);
537 /* Single erase size */
538 slave->mtd.erasesize = master->erasesize;
541 if ((slave->mtd.flags & MTD_WRITEABLE) &&
542 mtd_mod_by_eb(slave->offset, &slave->mtd)) {
543 /* Doesn't start on a boundary of major erase size */
544 /* FIXME: Let it be writable if it is on a boundary of
545 * _minor_ erase size though */
546 slave->mtd.flags &= ~MTD_WRITEABLE;
547 printk(KERN_WARNING"mtd: partition \"%s\" doesn't start on an erase block boundary -- force read-only\n",
550 if ((slave->mtd.flags & MTD_WRITEABLE) &&
551 mtd_mod_by_eb(slave->mtd.size, &slave->mtd)) {
552 slave->mtd.flags &= ~MTD_WRITEABLE;
553 printk(KERN_WARNING"mtd: partition \"%s\" doesn't end on an erase block -- force read-only\n",
557 slave->mtd.ecclayout = master->ecclayout;
558 slave->mtd.ecc_step_size = master->ecc_step_size;
559 slave->mtd.ecc_strength = master->ecc_strength;
560 slave->mtd.bitflip_threshold = master->bitflip_threshold;
562 if (master->_block_isbad) {
565 while (offs < slave->mtd.size) {
566 if (mtd_block_isbad(master, offs + slave->offset))
567 slave->mtd.ecc_stats.badblocks++;
568 offs += slave->mtd.erasesize;
577 int mtd_add_partition(struct mtd_info *master, const char *name,
578 long long offset, long long length)
580 struct mtd_partition part;
581 struct mtd_part *p, *new;
585 /* the direct offset is expected */
586 if (offset == MTDPART_OFS_APPEND ||
587 offset == MTDPART_OFS_NXTBLK)
590 if (length == MTDPART_SIZ_FULL)
591 length = master->size - offset;
598 part.offset = offset;
600 part.ecclayout = NULL;
602 new = allocate_partition(master, &part, -1, offset);
607 end = offset + length;
609 mutex_lock(&mtd_partitions_mutex);
610 list_for_each_entry(p, &mtd_partitions, list)
611 if (p->master == master) {
612 if ((start >= p->offset) &&
613 (start < (p->offset + p->mtd.size)))
616 if ((end >= p->offset) &&
617 (end < (p->offset + p->mtd.size)))
621 list_add(&new->list, &mtd_partitions);
622 mutex_unlock(&mtd_partitions_mutex);
624 add_mtd_device(&new->mtd);
628 mutex_unlock(&mtd_partitions_mutex);
632 EXPORT_SYMBOL_GPL(mtd_add_partition);
634 int mtd_del_partition(struct mtd_info *master, int partno)
636 struct mtd_part *slave, *next;
639 mutex_lock(&mtd_partitions_mutex);
640 list_for_each_entry_safe(slave, next, &mtd_partitions, list)
641 if ((slave->master == master) &&
642 (slave->mtd.index == partno)) {
643 ret = del_mtd_device(&slave->mtd);
647 list_del(&slave->list);
648 free_partition(slave);
651 mutex_unlock(&mtd_partitions_mutex);
655 EXPORT_SYMBOL_GPL(mtd_del_partition);
659 * This function, given a master MTD object and a partition table, creates
660 * and registers slave MTD objects which are bound to the master according to
661 * the partition definitions.
663 * We don't register the master, or expect the caller to have done so,
664 * for reasons of data integrity.
667 int add_mtd_partitions(struct mtd_info *master,
668 const struct mtd_partition *parts,
671 struct mtd_part *slave;
672 uint64_t cur_offset = 0;
677 * Need to init the list here, since LIST_INIT() does not
678 * work on platforms where relocation has problems (like MIPS
681 if (mtd_partitions.next == NULL)
682 INIT_LIST_HEAD(&mtd_partitions);
685 debug("Creating %d MTD partitions on \"%s\":\n", nbparts, master->name);
687 for (i = 0; i < nbparts; i++) {
688 slave = allocate_partition(master, parts + i, i, cur_offset);
690 return PTR_ERR(slave);
692 mutex_lock(&mtd_partitions_mutex);
693 list_add(&slave->list, &mtd_partitions);
694 mutex_unlock(&mtd_partitions_mutex);
696 add_mtd_device(&slave->mtd);
698 cur_offset = slave->offset + slave->mtd.size;
705 static DEFINE_SPINLOCK(part_parser_lock);
706 static LIST_HEAD(part_parsers);
708 static struct mtd_part_parser *get_partition_parser(const char *name)
710 struct mtd_part_parser *p, *ret = NULL;
712 spin_lock(&part_parser_lock);
714 list_for_each_entry(p, &part_parsers, list)
715 if (!strcmp(p->name, name) && try_module_get(p->owner)) {
720 spin_unlock(&part_parser_lock);
725 #define put_partition_parser(p) do { module_put((p)->owner); } while (0)
727 void register_mtd_parser(struct mtd_part_parser *p)
729 spin_lock(&part_parser_lock);
730 list_add(&p->list, &part_parsers);
731 spin_unlock(&part_parser_lock);
733 EXPORT_SYMBOL_GPL(register_mtd_parser);
735 void deregister_mtd_parser(struct mtd_part_parser *p)
737 spin_lock(&part_parser_lock);
739 spin_unlock(&part_parser_lock);
741 EXPORT_SYMBOL_GPL(deregister_mtd_parser);
744 * Do not forget to update 'parse_mtd_partitions()' kerneldoc comment if you
745 * are changing this array!
747 static const char * const default_mtd_part_types[] = {
754 * parse_mtd_partitions - parse MTD partitions
755 * @master: the master partition (describes whole MTD device)
756 * @types: names of partition parsers to try or %NULL
757 * @pparts: array of partitions found is returned here
758 * @data: MTD partition parser-specific data
760 * This function tries to find partition on MTD device @master. It uses MTD
761 * partition parsers, specified in @types. However, if @types is %NULL, then
762 * the default list of parsers is used. The default list contains only the
763 * "cmdlinepart" and "ofpart" parsers ATM.
764 * Note: If there are more then one parser in @types, the kernel only takes the
765 * partitions parsed out by the first parser.
767 * This function may return:
768 * o a negative error code in case of failure
769 * o zero if no partitions were found
770 * o a positive number of found partitions, in which case on exit @pparts will
771 * point to an array containing this number of &struct mtd_info objects.
773 int parse_mtd_partitions(struct mtd_info *master, const char *const *types,
774 struct mtd_partition **pparts,
775 struct mtd_part_parser_data *data)
777 struct mtd_part_parser *parser;
781 types = default_mtd_part_types;
783 for ( ; ret <= 0 && *types; types++) {
784 parser = get_partition_parser(*types);
785 if (!parser && !request_module("%s", *types))
786 parser = get_partition_parser(*types);
789 ret = (*parser->parse_fn)(master, pparts, data);
790 put_partition_parser(parser);
792 printk(KERN_NOTICE "%d %s partitions found on MTD device %s\n",
793 ret, parser->name, master->name);
801 int mtd_is_partition(const struct mtd_info *mtd)
803 struct mtd_part *part;
806 mutex_lock(&mtd_partitions_mutex);
807 list_for_each_entry(part, &mtd_partitions, list)
808 if (&part->mtd == mtd) {
812 mutex_unlock(&mtd_partitions_mutex);
816 EXPORT_SYMBOL_GPL(mtd_is_partition);
818 /* Returns the size of the entire flash chip */
819 uint64_t mtd_get_device_size(const struct mtd_info *mtd)
821 if (!mtd_is_partition(mtd))
824 return PART(mtd)->master->size;
826 EXPORT_SYMBOL_GPL(mtd_get_device_size);