blob: 3822237f2ad6193781e7b2657a226803f1140fe9 [file] [log] [blame]
Kyungmin Parkad7ae362008-11-19 16:32:36 +01001/*
2 * MTD partitioning layer definitions
3 *
Heiko Schocherf5895d12014-06-24 10:10:04 +02004 * (C) 2000 Nicolas Pitre <nico@fluxnic.net>
Kyungmin Parkad7ae362008-11-19 16:32:36 +01005 *
6 * This code is GPL
Kyungmin Parkad7ae362008-11-19 16:32:36 +01007 */
8
9#ifndef MTD_PARTITIONS_H
10#define MTD_PARTITIONS_H
11
12#include <linux/types.h>
13
14
15/*
16 * Partition definition structure:
17 *
18 * An array of struct partition is passed along with a MTD object to
Heiko Schocherf5895d12014-06-24 10:10:04 +020019 * mtd_device_register() to create them.
Kyungmin Parkad7ae362008-11-19 16:32:36 +010020 *
21 * For each partition, these fields are available:
22 * name: string that will be used to label the partition's MTD device.
23 * size: the partition size; if defined as MTDPART_SIZ_FULL, the partition
24 * will extend to the end of the master MTD device.
25 * offset: absolute starting position within the master MTD device; if
26 * defined as MTDPART_OFS_APPEND, the partition will start where the
Heiko Schocherf5895d12014-06-24 10:10:04 +020027 * previous one ended; if MTDPART_OFS_NXTBLK, at the next erase block;
28 * if MTDPART_OFS_RETAIN, consume as much as possible, leaving size
29 * after the end of partition.
Kyungmin Parkad7ae362008-11-19 16:32:36 +010030 * 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
39struct mtd_partition {
Heiko Schocherf5895d12014-06-24 10:10:04 +020040 const char *name; /* identifier string */
Sandeep Paulrajeab580c2009-10-30 13:51:23 -040041 uint64_t size; /* partition size */
42 uint64_t offset; /* offset within the master MTD space */
Heiko Schocherf5895d12014-06-24 10:10:04 +020043 uint32_t mask_flags; /* master MTD flags to mask out for this partition */
44 struct nand_ecclayout *ecclayout; /* out of band layout for this partition (NAND only) */
Kyungmin Parkad7ae362008-11-19 16:32:36 +010045};
46
Heiko Schocherf5895d12014-06-24 10:10:04 +020047#define MTDPART_OFS_RETAIN (-3)
Kyungmin Parkad7ae362008-11-19 16:32:36 +010048#define MTDPART_OFS_NXTBLK (-2)
49#define MTDPART_OFS_APPEND (-1)
50#define MTDPART_SIZ_FULL (0)
51
Heiko Schocherf5895d12014-06-24 10:10:04 +020052
53struct mtd_info;
54struct device_node;
55
56#ifndef __UBOOT__
57/**
58 * struct mtd_part_parser_data - used to pass data to MTD partition parsers.
59 * @origin: for RedBoot, start address of MTD device
60 * @of_node: for OF parsers, device node containing partitioning information
61 */
62struct mtd_part_parser_data {
63 unsigned long origin;
64 struct device_node *of_node;
65};
Kyungmin Parkad7ae362008-11-19 16:32:36 +010066
Kyungmin Parkad7ae362008-11-19 16:32:36 +010067
Kyungmin Parkad7ae362008-11-19 16:32:36 +010068/*
69 * Functions dealing with the various ways of partitioning the space
70 */
71
72struct mtd_part_parser {
73 struct list_head list;
74 struct module *owner;
75 const char *name;
Heiko Schocherf5895d12014-06-24 10:10:04 +020076 int (*parse_fn)(struct mtd_info *, struct mtd_partition **,
77 struct mtd_part_parser_data *);
Kyungmin Parkad7ae362008-11-19 16:32:36 +010078};
79
Heiko Schocherf5895d12014-06-24 10:10:04 +020080extern void register_mtd_parser(struct mtd_part_parser *parser);
81extern void deregister_mtd_parser(struct mtd_part_parser *parser);
Kyungmin Parkad7ae362008-11-19 16:32:36 +010082#endif
83
Heiko Schocherf5895d12014-06-24 10:10:04 +020084int mtd_add_partition(struct mtd_info *master, const char *name,
85 long long offset, long long length);
86int mtd_del_partition(struct mtd_info *master, int partno);
87uint64_t mtd_get_device_size(const struct mtd_info *mtd);
88
Miquel Raynal6f381d52018-09-29 12:58:25 +020089#if defined(CONFIG_MTD_PARTITIONS)
90int mtd_parse_partitions(struct mtd_info *parent, const char **_mtdparts,
91 struct mtd_partition **_parts, int *_nparts);
92void mtd_free_parsed_partitions(struct mtd_partition *parts,
93 unsigned int nparts);
94#else
95static inline int
96mtd_parse_partitions(struct mtd_info *parent, const char **_mtdparts,
97 struct mtd_partition **_parts, int *_nparts)
98{
99 *_nparts = 0;
100
101 return 0;
102}
103static inline void
104mtd_free_parsed_partitions(struct mtd_partition *parts, unsigned int nparts)
105{
106 return;
107}
108#endif /* defined(MTD_PARTITIONS) */
109
Kyungmin Parkad7ae362008-11-19 16:32:36 +0100110#endif