[net-next-2.6.git] / include / linux / mtd / partitions.h

/*
 * MTD partitioning layer definitions
 *
 * (C) 2000 Nicolas Pitre <nico@fluxnic.net>
 *
 * This code is GPL
 */

#ifndef MTD_PARTITIONS_H
#define MTD_PARTITIONS_H

#include <linux/types.h>


/*
 * Partition definition structure:
 *
 * An array of struct partition is passed along with a MTD object to
 * add_mtd_partitions() to create them.
 *
 * For each partition, these fields are available:
 * name: string that will be used to label the partition's MTD device.
 * size: the partition size; if defined as MTDPART_SIZ_FULL, the partition
 * 	will extend to the end of the master MTD device.
 * offset: absolute starting position within the master MTD device; if
 * 	defined as MTDPART_OFS_APPEND, the partition will start where the
 * 	previous one ended; if MTDPART_OFS_NXTBLK, at the next erase block.
 * mask_flags: contains flags that have to be masked (removed) from the
 * 	master MTD flag set for the corresponding MTD partition.
 * 	For example, to force a read-only partition, simply adding
 * 	MTD_WRITEABLE to the mask_flags will do the trick.
 *
 * Note: writeable partitions require their size and offset be
 * erasesize aligned (e.g. use MTDPART_OFS_NEXTBLK).
 */

struct mtd_partition {
	char *name;			/* identifier string */
	uint64_t size;			/* partition size */
	uint64_t offset;		/* offset within the master MTD space */
	uint32_t mask_flags;		/* master MTD flags to mask out for this partition */
	struct nand_ecclayout *ecclayout;	/* out of band layout for this partition (NAND only) */
};

#define MTDPART_OFS_NXTBLK	(-2)
#define MTDPART_OFS_APPEND	(-1)
#define MTDPART_SIZ_FULL	(0)


struct mtd_info;

int add_mtd_partitions(struct mtd_info *, const struct mtd_partition *, int);
int del_mtd_partitions(struct mtd_info *);

/*
 * Functions dealing with the various ways of partitioning the space
 */

struct mtd_part_parser {
	struct list_head list;
	struct module *owner;
	const char *name;
	int (*parse_fn)(struct mtd_info *, struct mtd_partition **, unsigned long);
};

extern int register_mtd_parser(struct mtd_part_parser *parser);
extern int deregister_mtd_parser(struct mtd_part_parser *parser);
extern int parse_mtd_partitions(struct mtd_info *master, const char **types,
				struct mtd_partition **pparts, unsigned long origin);

#define put_partition_parser(p) do { module_put((p)->owner); } while(0)

struct device;
struct device_node;

int __devinit of_mtd_parse_partitions(struct device *dev,
                                      struct device_node *node,
                                      struct mtd_partition **pparts);

#ifdef CONFIG_MTD_PARTITIONS
static inline int mtd_has_partitions(void) { return 1; }
#else
static inline int mtd_has_partitions(void) { return 0; }
#endif

#ifdef CONFIG_MTD_CMDLINE_PARTS
static inline int mtd_has_cmdlinepart(void) { return 1; }
#else
static inline int mtd_has_cmdlinepart(void) { return 0; }
#endif

int mtd_is_master(struct mtd_info *mtd);
int mtd_add_partition(struct mtd_info *master, char *name,
		      long long offset, long long length);
int mtd_del_partition(struct mtd_info *master, int partno);

#endif
Commit	Line	Data
1da177e4 LT	1	/*
	2	* MTD partitioning layer definitions
	3	*
2f82af08	4	* (C) 2000 Nicolas Pitre <nico@fluxnic.net>
1da177e4 LT	5	*
1da177e4 LT	6	* This code is GPL
1da177e4 LT	7	*/
	8
	9	#ifndef MTD_PARTITIONS_H
	10	#define MTD_PARTITIONS_H
	11
	12	#include <linux/types.h>
	13
	14
	15	/*
	16	* Partition definition structure:
61ecfa87	17	*
1da177e4 LT	18	* An array of struct partition is passed along with a MTD object to
	19	* add_mtd_partitions() to create them.
	20	*
	21	* For each partition, these fields are available:
	22	* name: string that will be used to label the partition's MTD device.
61ecfa87	23	* size: the partition size; if defined as MTDPART_SIZ_FULL, the partition
1da177e4	24	* will extend to the end of the master MTD device.
61ecfa87 TG	25	* offset: absolute starting position within the master MTD device; if
61ecfa87 TG	26	* defined as MTDPART_OFS_APPEND, the partition will start where the
1da177e4	27	* previous one ended; if MTDPART_OFS_NXTBLK, at the next erase block.
61ecfa87	28	* mask_flags: contains flags that have to be masked (removed) from the
1da177e4	29	* master MTD flag set for the corresponding MTD partition.
61ecfa87	30	* For example, to force a read-only partition, simply adding
1da177e4 LT	31	* MTD_WRITEABLE to the mask_flags will do the trick.
1da177e4 LT	32	*
61ecfa87	33	* Note: writeable partitions require their size and offset be
1da177e4	34	* erasesize aligned (e.g. use MTDPART_OFS_NEXTBLK).
61ecfa87	35	*/
1da177e4 LT	36
	37	struct mtd_partition {
	38	char name; / identifier string */
69423d99 AH	39	uint64_t size; /* partition size */
69423d99 AH	40	uint64_t offset; /* offset within the master MTD space */
26cdb67c	41	uint32_t mask_flags; /* master MTD flags to mask out for this partition */
cc26c3cd	42	struct nand_ecclayout ecclayout; / out of band layout for this partition (NAND only) */
1da177e4 LT	43	};
	44
	45	#define MTDPART_OFS_NXTBLK (-2)
	46	#define MTDPART_OFS_APPEND (-1)
	47	#define MTDPART_SIZ_FULL (0)
	48
	49
7699ad35 NP	50	struct mtd_info;
7699ad35 NP	51
1da177e4 LT	52	int add_mtd_partitions(struct mtd_info , const struct mtd_partition , int);
	53	int del_mtd_partitions(struct mtd_info *);
	54
	55	/*
	56	* Functions dealing with the various ways of partitioning the space
	57	*/
	58
	59	struct 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
	66	extern int register_mtd_parser(struct mtd_part_parser *parser);
	67	extern int deregister_mtd_parser(struct mtd_part_parser *parser);
61ecfa87	68	extern int parse_mtd_partitions(struct mtd_info master, const char *types,
1da177e4 LT	69	struct mtd_partition **pparts, unsigned long origin);
	70
	71	#define put_partition_parser(p) do { module_put((p)->owner); } while(0)
	72
9a310d21 SW	73	struct device;
	74	struct device_node;
	75
	76	int __devinit of_mtd_parse_partitions(struct device *dev,
9a310d21 SW	77	struct device_node *node,
9a310d21 SW	78	struct mtd_partition **pparts);
1da177e4	79
a4b6d516 DB	80	#ifdef CONFIG_MTD_PARTITIONS
	81	static inline int mtd_has_partitions(void) { return 1; }
	82	#else
	83	static inline int mtd_has_partitions(void) { return 0; }
	84	#endif
	85
	86	#ifdef CONFIG_MTD_CMDLINE_PARTS
	87	static inline int mtd_has_cmdlinepart(void) { return 1; }
	88	#else
	89	static inline int mtd_has_cmdlinepart(void) { return 0; }
	90	#endif
	91
5daa7b21 RT	92	int mtd_is_master(struct mtd_info *mtd);
	93	int mtd_add_partition(struct mtd_info master, char name,
	94	long long offset, long long length);
	95	int mtd_del_partition(struct mtd_info *master, int partno);
	96
9a310d21	97	#endif