blob: 998a6cf3516761e71657aad2205797d89b26755b [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
Linus Torvalds1da177e2005-04-16 15:20:36 -070027 * previous one ended; if MTDPART_OFS_NXTBLK, at the next erase block.
Thomas Gleixner61ecfa82005-11-07 11:15:31 +000028 * mask_flags: contains flags that have to be masked (removed) from the
Linus Torvalds1da177e2005-04-16 15:20:36 -070029 * master MTD flag set for the corresponding MTD partition.
Thomas Gleixner61ecfa82005-11-07 11:15:31 +000030 * For example, to force a read-only partition, simply adding
Linus Torvalds1da177e2005-04-16 15:20:36 -070031 * MTD_WRITEABLE to the mask_flags will do the trick.
32 *
Thomas Gleixner61ecfa82005-11-07 11:15:31 +000033 * Note: writeable partitions require their size and offset be
Linus Torvalds1da177e2005-04-16 15:20:36 -070034 * erasesize aligned (e.g. use MTDPART_OFS_NEXTBLK).
Thomas Gleixner61ecfa82005-11-07 11:15:31 +000035 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
37struct mtd_partition {
38 char *name; /* identifier string */
Adrian Hunter69423d92008-12-10 13:37:21 +000039 uint64_t size; /* partition size */
40 uint64_t offset; /* offset within the master MTD space */
David Woodhouse26cdb672008-12-10 14:08:12 +000041 uint32_t mask_flags; /* master MTD flags to mask out for this partition */
Brian Norriscc26c3c2010-08-24 18:12:00 -070042 struct nand_ecclayout *ecclayout; /* out of band layout for this partition (NAND only) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070043};
44
45#define MTDPART_OFS_NXTBLK (-2)
46#define MTDPART_OFS_APPEND (-1)
47#define MTDPART_SIZ_FULL (0)
48
49
Nicolas Pitre7699ad32009-06-15 01:10:18 -040050struct mtd_info;
51
Linus Torvalds1da177e2005-04-16 15:20:36 -070052int add_mtd_partitions(struct mtd_info *, const struct mtd_partition *, int);
53int del_mtd_partitions(struct mtd_info *);
54
55/*
56 * Functions dealing with the various ways of partitioning the space
57 */
58
59struct mtd_part_parser {
60 struct list_head list;
61 struct module *owner;
62 const char *name;
63 int (*parse_fn)(struct mtd_info *, struct mtd_partition **, unsigned long);
64};
65
66extern int register_mtd_parser(struct mtd_part_parser *parser);
67extern int deregister_mtd_parser(struct mtd_part_parser *parser);
Thomas Gleixner61ecfa82005-11-07 11:15:31 +000068extern int parse_mtd_partitions(struct mtd_info *master, const char **types,
Linus Torvalds1da177e2005-04-16 15:20:36 -070069 struct mtd_partition **pparts, unsigned long origin);
70
71#define put_partition_parser(p) do { module_put((p)->owner); } while(0)
72
Scott Wood9a310d22008-01-15 17:54:43 -060073struct device;
74struct device_node;
Linus Torvalds1da177e2005-04-16 15:20:36 -070075
Scott Wood9a310d22008-01-15 17:54:43 -060076int __devinit of_mtd_parse_partitions(struct device *dev,
Scott Wood9a310d22008-01-15 17:54:43 -060077 struct device_node *node,
78 struct mtd_partition **pparts);
79
David Brownella4b6d512009-03-04 12:01:41 -080080#ifdef CONFIG_MTD_PARTITIONS
81static inline int mtd_has_partitions(void) { return 1; }
82#else
83static inline int mtd_has_partitions(void) { return 0; }
84#endif
85
86#ifdef CONFIG_MTD_CMDLINE_PARTS
87static inline int mtd_has_cmdlinepart(void) { return 1; }
88#else
89static inline int mtd_has_cmdlinepart(void) { return 0; }
90#endif
91
Roman Tereshonkova7e93dc2010-11-23 14:17:17 +020092int mtd_is_partition(struct mtd_info *mtd);
Roman Tereshonkov5daa7b22010-09-17 13:31:41 +030093int mtd_add_partition(struct mtd_info *master, char *name,
94 long long offset, long long length);
95int mtd_del_partition(struct mtd_info *master, int partno);
96
Scott Wood9a310d22008-01-15 17:54:43 -060097#endif