1 /*
2  * MTD partitioning layer definitions
3  *
4  * (C) 2000 Nicolas Pitre <nico@fluxnic.net>
5  *
6  * This code is GPL
7  */
8 
9 #ifndef MTD_PARTITIONS_H
10 #define MTD_PARTITIONS_H
11 
12 #include <linux/types.h>
13 
14 /*
15  * Partition definition structure:
16  *
17  * An array of struct partition is passed along with a MTD object to
18  * mtd_device_register() to create them.
19  *
20  * For each partition, these fields are available:
21  * name: string that will be used to label the partition's MTD device.
22  * size: the partition size; if defined as MTDPART_SIZ_FULL, the partition
23  *	will extend to the end of the master MTD device.
24  * offset: absolute starting position within the master MTD device; if
25  *	defined as MTDPART_OFS_APPEND, the partition will start where the
26  *	previous one ended; if MTDPART_OFS_NXTBLK, at the next erase block;
27  *	if MTDPART_OFS_RETAIN, consume as much as possible, leaving size
28  *	after the end of partition.
29  * mask_flags: contains flags that have to be masked (removed) from the
30  *	master MTD flag set for the corresponding MTD partition.
31  *	For example, to force a read-only partition, simply adding
32  *	MTD_WRITEABLE to the mask_flags will do the trick.
33  *
34  * Note: writeable partitions require their size and offset be
35  * erasesize aligned (e.g. use MTDPART_OFS_NEXTBLK).
36  */
37 
38 struct mtd_partition {
39 	const char *name;		/* identifier string */
40 	uint64_t size;			/* partition size */
41 	uint64_t offset;		/* offset within the master MTD space */
42 	uint32_t mask_flags;		/* master MTD flags to mask out for this partition */
43 	struct nand_ecclayout *ecclayout;	/* out of band layout for this partition (NAND only) */
44 };
45 
46 #define MTDPART_OFS_RETAIN	(-3)
47 #define MTDPART_OFS_NXTBLK	(-2)
48 #define MTDPART_OFS_APPEND	(-1)
49 #define MTDPART_SIZ_FULL	(0)
50 
51 struct mtd_info;
52 struct device_node;
53 
54 #ifndef __UBOOT__
55 /**
56  * struct mtd_part_parser_data - used to pass data to MTD partition parsers.
57  * @origin: for RedBoot, start address of MTD device
58  * @of_node: for OF parsers, device node containing partitioning information
59  */
60 struct mtd_part_parser_data {
61 	unsigned long origin;
62 	struct device_node *of_node;
63 };
64 
65 /*
66  * Functions dealing with the various ways of partitioning the space
67  */
68 
69 struct mtd_part_parser {
70 	struct list_head list;
71 	struct module *owner;
72 	const char *name;
73 	int (*parse_fn)(struct mtd_info *, struct mtd_partition **,
74 			struct mtd_part_parser_data *);
75 };
76 
77 extern void register_mtd_parser(struct mtd_part_parser *parser);
78 extern void deregister_mtd_parser(struct mtd_part_parser *parser);
79 #endif
80 
81 int mtd_add_partition(struct mtd_info *master, const char *name,
82 		      long long offset, long long length);
83 int mtd_del_partition(struct mtd_info *master, int partno);
84 uint64_t mtd_get_device_size(const struct mtd_info *mtd);
85 
86 #if defined(CONFIG_MTD_PARTITIONS)
87 int mtd_parse_partitions(struct mtd_info *parent, const char **_mtdparts,
88 			 struct mtd_partition **_parts, int *_nparts);
89 void mtd_free_parsed_partitions(struct mtd_partition *parts,
90 				unsigned int nparts);
91 #else
92 static inline int
mtd_parse_partitions(struct mtd_info * parent,const char ** _mtdparts,struct mtd_partition ** _parts,int * _nparts)93 mtd_parse_partitions(struct mtd_info *parent, const char **_mtdparts,
94 		     struct mtd_partition **_parts, int *_nparts)
95 {
96 	*_nparts = 0;
97 
98 	return 0;
99 }
100 static inline void
mtd_free_parsed_partitions(struct mtd_partition * parts,unsigned int nparts)101 mtd_free_parsed_partitions(struct mtd_partition *parts, unsigned int nparts)
102 {
103 	return;
104 }
105 #endif /* defined(MTD_PARTITIONS) */
106 
107 #endif
108