blob: da6b3d6f12a7642442642032f58b4e917ee6b3e4 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * MTD partitioning layer definitions
3 *
4 * (C) 2000 Nicolas Pitre <nico@cam.org>
5 *
6 * This code is GPL
7 *
Thomas Gleixner61ecfa82005-11-07 11:15:31 +00008 * $Id: partitions.h,v 1.17 2005/11/07 11:14:55 gleixner Exp $
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 */
10
11#ifndef MTD_PARTITIONS_H
12#define MTD_PARTITIONS_H
13
14#include <linux/types.h>
15
16
17/*
18 * Partition definition structure:
Thomas Gleixner61ecfa82005-11-07 11:15:31 +000019 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070020 * 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.
Thomas Gleixner61ecfa82005-11-07 11:15:31 +000025 * size: the partition size; if defined as MTDPART_SIZ_FULL, the partition
Linus Torvalds1da177e2005-04-16 15:20:36 -070026 * will extend to the end of the master MTD device.
Thomas Gleixner61ecfa82005-11-07 11:15:31 +000027 * offset: absolute starting position within the master MTD device; if
28 * defined as MTDPART_OFS_APPEND, the partition will start where the
Linus Torvalds1da177e2005-04-16 15:20:36 -070029 * previous one ended; if MTDPART_OFS_NXTBLK, at the next erase block.
Thomas Gleixner61ecfa82005-11-07 11:15:31 +000030 * mask_flags: contains flags that have to be masked (removed) from the
Linus Torvalds1da177e2005-04-16 15:20:36 -070031 * master MTD flag set for the corresponding MTD partition.
Thomas Gleixner61ecfa82005-11-07 11:15:31 +000032 * For example, to force a read-only partition, simply adding
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 * MTD_WRITEABLE to the mask_flags will do the trick.
34 *
Thomas Gleixner61ecfa82005-11-07 11:15:31 +000035 * Note: writeable partitions require their size and offset be
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 * erasesize aligned (e.g. use MTDPART_OFS_NEXTBLK).
Thomas Gleixner61ecfa82005-11-07 11:15:31 +000037 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
39struct 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 */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020044 struct nand_ecclayout *ecclayout; /* out of band layout for this partition (NAND only)*/
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 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
53int add_mtd_partitions(struct mtd_info *, const struct mtd_partition *, int);
54int del_mtd_partitions(struct mtd_info *);
55
56/*
57 * Functions dealing with the various ways of partitioning the space
58 */
59
60struct 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
67extern int register_mtd_parser(struct mtd_part_parser *parser);
68extern int deregister_mtd_parser(struct mtd_part_parser *parser);
Thomas Gleixner61ecfa82005-11-07 11:15:31 +000069extern int parse_mtd_partitions(struct mtd_info *master, const char **types,
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 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