blob: 6a35e6de5da174fc7b9f82f67be421f4d74a1cc3 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * MTD partitioning layer definitions
3 *
Nicolas Pitre2f82af02009-09-14 03:25:28 -04004 * (C) 2000 Nicolas Pitre <nico@fluxnic.net>
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
6 * This code is GPL
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 */
8
9#ifndef MTD_PARTITIONS_H
10#define MTD_PARTITIONS_H
11
12#include <linux/types.h>
13
14
15/*
16 * Partition definition structure:
Thomas Gleixner61ecfa82005-11-07 11:15:31 +000017 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070018 * An array of struct partition is passed along with a MTD object to
Jamie Ilesf5671ab2011-05-23 17:15:46 +010019 * mtd_device_register() to create them.
Linus Torvalds1da177e2005-04-16 15:20:36 -070020 *
21 * For each partition, these fields are available:
22 * name: string that will be used to label the partition's MTD device.
Thomas Gleixner61ecfa82005-11-07 11:15:31 +000023 * size: the partition size; if defined as MTDPART_SIZ_FULL, the partition
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 * will extend to the end of the master MTD device.
Thomas Gleixner61ecfa82005-11-07 11:15:31 +000025 * offset: absolute starting position within the master MTD device; if
26 * defined as MTDPART_OFS_APPEND, the partition will start where the
Dmitry Eremin-Solenikov1a313682011-06-06 18:04:14 +040027 * previous one ended; if MTDPART_OFS_NXTBLK, at the next erase block;
28 * if MTDPART_OFS_RETAIN, consume as much as possible, leaving size
29 * after the end of partition.
Thomas Gleixner61ecfa82005-11-07 11:15:31 +000030 * mask_flags: contains flags that have to be masked (removed) from the
Linus Torvalds1da177e2005-04-16 15:20:36 -070031 * master MTD flag set for the corresponding MTD partition.
Thomas Gleixner61ecfa82005-11-07 11:15:31 +000032 * For example, to force a read-only partition, simply adding
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 * MTD_WRITEABLE to the mask_flags will do the trick.
34 *
Thomas Gleixner61ecfa82005-11-07 11:15:31 +000035 * Note: writeable partitions require their size and offset be
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 * erasesize aligned (e.g. use MTDPART_OFS_NEXTBLK).
Thomas Gleixner61ecfa82005-11-07 11:15:31 +000037 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
39struct mtd_partition {
Geert Uytterhoeven26a6d242013-11-12 20:11:26 +010040 const char *name; /* identifier string */
Adrian Hunter69423d92008-12-10 13:37:21 +000041 uint64_t size; /* partition size */
42 uint64_t offset; /* offset within the master MTD space */
David Woodhouse26cdb672008-12-10 14:08:12 +000043 uint32_t mask_flags; /* master MTD flags to mask out for this partition */
Brian Norriscc26c3c2010-08-24 18:12:00 -070044 struct nand_ecclayout *ecclayout; /* out of band layout for this partition (NAND only) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070045};
46
Dmitry Eremin-Solenikov1a313682011-06-06 18:04:14 +040047#define MTDPART_OFS_RETAIN (-3)
Linus Torvalds1da177e2005-04-16 15:20:36 -070048#define MTDPART_OFS_NXTBLK (-2)
49#define MTDPART_OFS_APPEND (-1)
50#define MTDPART_SIZ_FULL (0)
51
52
Nicolas Pitre7699ad32009-06-15 01:10:18 -040053struct mtd_info;
Dmitry Eremin-Solenikovd26c87d2011-05-29 21:32:33 +040054struct device_node;
Nicolas Pitre7699ad32009-06-15 01:10:18 -040055
Dmitry Eremin-Solenikovc7975332011-06-10 18:18:28 +040056/**
57 * struct mtd_part_parser_data - used to pass data to MTD partition parsers.
58 * @origin: for RedBoot, start address of MTD device
Dmitry Eremin-Solenikovd26c87d2011-05-29 21:32:33 +040059 * @of_node: for OF parsers, device node containing partitioning information
Dmitry Eremin-Solenikovc7975332011-06-10 18:18:28 +040060 */
61struct mtd_part_parser_data {
62 unsigned long origin;
Dmitry Eremin-Solenikovd26c87d2011-05-29 21:32:33 +040063 struct device_node *of_node;
Dmitry Eremin-Solenikovc7975332011-06-10 18:18:28 +040064};
65
66
Linus Torvalds1da177e2005-04-16 15:20:36 -070067/*
68 * Functions dealing with the various ways of partitioning the space
69 */
70
71struct mtd_part_parser {
72 struct list_head list;
73 struct module *owner;
74 const char *name;
Dmitry Eremin-Solenikovc7975332011-06-10 18:18:28 +040075 int (*parse_fn)(struct mtd_info *, struct mtd_partition **,
76 struct mtd_part_parser_data *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070077};
78
Axel Lin6e14a612013-12-01 19:01:06 +080079extern void register_mtd_parser(struct mtd_part_parser *parser);
Axel Lincf3b2b12013-12-01 18:59:15 +080080extern void deregister_mtd_parser(struct mtd_part_parser *parser);
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
Richard Genoud5dee4672012-07-10 18:23:39 +020082int mtd_is_partition(const struct mtd_info *mtd);
Geert Uytterhoeven26a6d242013-11-12 20:11:26 +010083int mtd_add_partition(struct mtd_info *master, const char *name,
Roman Tereshonkov5daa7b22010-09-17 13:31:41 +030084 long long offset, long long length);
85int mtd_del_partition(struct mtd_info *master, int partno);
Richard Genoud62082e52012-07-10 18:23:40 +020086uint64_t mtd_get_device_size(const struct mtd_info *mtd);
Roman Tereshonkov5daa7b22010-09-17 13:31:41 +030087
Scott Wood9a310d22008-01-15 17:54:43 -060088#endif