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