Linux-2.6.12-rc2
[linux-flexiantxendom0-natty.git] / include / linux / mtd / partitions.h
1 /*
2  * MTD partitioning layer definitions
3  *
4  * (C) 2000 Nicolas Pitre <nico@cam.org>
5  *
6  * This code is GPL
7  *
8  * $Id: partitions.h,v 1.16 2004/11/16 18:34:40 dwmw2 Exp $
9  */
10
11 #ifndef MTD_PARTITIONS_H
12 #define MTD_PARTITIONS_H
13
14 #include <linux/types.h>
15
16
17 /*
18  * Partition definition structure:
19  * 
20  * An array of struct partition is passed along with a MTD object to
21  * add_mtd_partitions() to create them.
22  *
23  * For each partition, these fields are available:
24  * name: string that will be used to label the partition's MTD device.
25  * size: the partition size; if defined as MTDPART_SIZ_FULL, the partition 
26  *      will extend to the end of the master MTD device.
27  * offset: absolute starting position within the master MTD device; if 
28  *      defined as MTDPART_OFS_APPEND, the partition will start where the 
29  *      previous one ended; if MTDPART_OFS_NXTBLK, at the next erase block.
30  * mask_flags: contains flags that have to be masked (removed) from the 
31  *      master MTD flag set for the corresponding MTD partition.
32  *      For example, to force a read-only partition, simply adding 
33  *      MTD_WRITEABLE to the mask_flags will do the trick.
34  *
35  * Note: writeable partitions require their size and offset be 
36  * erasesize aligned (e.g. use MTDPART_OFS_NEXTBLK).
37  */ 
38
39 struct mtd_partition {
40         char *name;                     /* identifier string */
41         u_int32_t size;                 /* partition size */
42         u_int32_t offset;               /* offset within the master MTD space */
43         u_int32_t mask_flags;           /* master MTD flags to mask out for this partition */
44         struct nand_oobinfo *oobsel;    /* out of band layout for this partition (NAND only)*/
45         struct mtd_info **mtdp;         /* pointer to store the MTD object */
46 };
47
48 #define MTDPART_OFS_NXTBLK      (-2)
49 #define MTDPART_OFS_APPEND      (-1)
50 #define MTDPART_SIZ_FULL        (0)
51
52
53 int add_mtd_partitions(struct mtd_info *, const struct mtd_partition *, int);
54 int del_mtd_partitions(struct mtd_info *);
55
56 /*
57  * Functions dealing with the various ways of partitioning the space
58  */
59
60 struct mtd_part_parser {
61         struct list_head list;
62         struct module *owner;
63         const char *name;
64         int (*parse_fn)(struct mtd_info *, struct mtd_partition **, unsigned long);
65 };
66
67 extern int register_mtd_parser(struct mtd_part_parser *parser);
68 extern int deregister_mtd_parser(struct mtd_part_parser *parser);
69 extern int parse_mtd_partitions(struct mtd_info *master, const char **types, 
70                                 struct mtd_partition **pparts, unsigned long origin);
71
72 #define put_partition_parser(p) do { module_put((p)->owner); } while(0)
73
74 #endif
75