Fix misspellings of "whether" in comments.
[deliverable/linux.git] / drivers / mtd / cmdlinepart.c
CommitLineData
1da177e4 1/*
1da177e4
LT
2 * Read flash partition table from command line
3 *
a1452a37
DW
4 * Copyright © 2002 SYSGO Real-Time Solutions GmbH
5 * Copyright © 2002-2010 David Woodhouse <dwmw2@infradead.org>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
1da177e4
LT
20 *
21 * The format for the command line is as follows:
97894cda 22 *
1da177e4
LT
23 * mtdparts=<mtddef>[;<mtddef]
24 * <mtddef> := <mtd-id>:<partdef>[,<partdef>]
a0ee24a0 25 * where <mtd-id> is the name from the "cat /proc/mtd" command
e619a75f 26 * <partdef> := <size>[@offset][<name>][ro][lk]
1da177e4
LT
27 * <mtd-id> := unique name used in mapping driver/device (mtd->name)
28 * <size> := standard linux memsize OR "-" to denote all remaining space
29 * <name> := '(' NAME ')'
97894cda 30 *
1da177e4 31 * Examples:
97894cda 32 *
1da177e4
LT
33 * 1 NOR Flash, with 1 single writable partition:
34 * edb7312-nor:-
97894cda 35 *
1da177e4
LT
36 * 1 NOR Flash with 2 partitions, 1 NAND with one
37 * edb7312-nor:256k(ARMboot)ro,-(root);edb7312-nand:-(home)
38 */
39
40#include <linux/kernel.h>
41#include <linux/slab.h>
1da177e4
LT
42#include <linux/mtd/mtd.h>
43#include <linux/mtd/partitions.h>
a0e5cc58 44#include <linux/module.h>
9e0606fc 45#include <linux/err.h>
1da177e4
LT
46
47/* error message prefix */
48#define ERRP "mtd: "
49
50/* debug macro */
51#if 0
52#define dbg(x) do { printk("DEBUG-CMDLINE-PART: "); printk x; } while(0)
53#else
54#define dbg(x)
55#endif
56
57
58/* special size referring to all the remaining space in a partition */
b175d03d
AN
59#define SIZE_REMAINING UINT_MAX
60#define OFFSET_CONTINUOUS UINT_MAX
1da177e4
LT
61
62struct cmdline_mtd_partition {
63 struct cmdline_mtd_partition *next;
64 char *mtd_id;
65 int num_parts;
66 struct mtd_partition *parts;
67};
68
69/* mtdpart_setup() parses into here */
70static struct cmdline_mtd_partition *partitions;
71
8abc0d4a 72/* the command line passed to mtdpart_setup() */
1da177e4 73static char *cmdline;
aa3c5dc5 74static int cmdline_parsed;
1da177e4
LT
75
76/*
77 * Parse one partition definition for an MTD. Since there can be many
97894cda 78 * comma separated partition definitions, this function calls itself
1da177e4
LT
79 * recursively until no more partition definitions are found. Nice side
80 * effect: the memory to keep the mtd_partition structs and the names
81 * is allocated upon the last definition being found. At that point the
82 * syntax has been verified ok.
83 */
97894cda 84static struct mtd_partition * newpart(char *s,
fac0077c
AB
85 char **retptr,
86 int *num_parts,
87 int this_part,
88 unsigned char **extra_mem_ptr,
89 int extra_mem_size)
1da177e4
LT
90{
91 struct mtd_partition *parts;
fac0077c 92 unsigned long size, offset = OFFSET_CONTINUOUS;
1da177e4
LT
93 char *name;
94 int name_len;
95 unsigned char *extra_mem;
96 char delim;
97 unsigned int mask_flags;
98
99 /* fetch the partition size */
fac0077c
AB
100 if (*s == '-') {
101 /* assign all remaining space to this partition */
1da177e4
LT
102 size = SIZE_REMAINING;
103 s++;
fac0077c 104 } else {
1da177e4 105 size = memparse(s, &s);
fac0077c 106 if (size < PAGE_SIZE) {
1da177e4 107 printk(KERN_ERR ERRP "partition size too small (%lx)\n", size);
9e0606fc 108 return ERR_PTR(-EINVAL);
1da177e4
LT
109 }
110 }
111
112 /* fetch partition name and flags */
113 mask_flags = 0; /* this is going to be a regular partition */
114 delim = 0;
fac0077c
AB
115
116 /* check for offset */
117 if (*s == '@') {
118 s++;
119 offset = memparse(s, &s);
120 }
121
122 /* now look for name */
1da177e4 123 if (*s == '(')
1da177e4 124 delim = ')';
97894cda 125
fac0077c 126 if (delim) {
1da177e4
LT
127 char *p;
128
fac0077c 129 name = ++s;
ed262c4f 130 p = strchr(name, delim);
fac0077c 131 if (!p) {
1da177e4 132 printk(KERN_ERR ERRP "no closing %c found in partition name\n", delim);
9e0606fc 133 return ERR_PTR(-EINVAL);
1da177e4
LT
134 }
135 name_len = p - name;
136 s = p + 1;
fac0077c
AB
137 } else {
138 name = NULL;
1da177e4
LT
139 name_len = 13; /* Partition_000 */
140 }
97894cda 141
1da177e4
LT
142 /* record name length for memory allocation later */
143 extra_mem_size += name_len + 1;
144
fac0077c
AB
145 /* test for options */
146 if (strncmp(s, "ro", 2) == 0) {
1da177e4
LT
147 mask_flags |= MTD_WRITEABLE;
148 s += 2;
fac0077c 149 }
1da177e4 150
fac0077c
AB
151 /* if lk is found do NOT unlock the MTD partition*/
152 if (strncmp(s, "lk", 2) == 0) {
e619a75f
JT
153 mask_flags |= MTD_POWERUP_LOCK;
154 s += 2;
fac0077c 155 }
e619a75f 156
1da177e4 157 /* test if more partitions are following */
fac0077c
AB
158 if (*s == ',') {
159 if (size == SIZE_REMAINING) {
1da177e4 160 printk(KERN_ERR ERRP "no partitions allowed after a fill-up partition\n");
9e0606fc 161 return ERR_PTR(-EINVAL);
1da177e4
LT
162 }
163 /* more partitions follow, parse them */
ed262c4f
AB
164 parts = newpart(s + 1, &s, num_parts, this_part + 1,
165 &extra_mem, extra_mem_size);
9e0606fc
AB
166 if (IS_ERR(parts))
167 return parts;
fac0077c
AB
168 } else {
169 /* this is the last partition: allocate space for all */
1da177e4
LT
170 int alloc_size;
171
172 *num_parts = this_part + 1;
173 alloc_size = *num_parts * sizeof(struct mtd_partition) +
174 extra_mem_size;
fac0077c 175
95b93a0c 176 parts = kzalloc(alloc_size, GFP_KERNEL);
1da177e4 177 if (!parts)
9e0606fc 178 return ERR_PTR(-ENOMEM);
1da177e4
LT
179 extra_mem = (unsigned char *)(parts + *num_parts);
180 }
fac0077c 181
1da177e4
LT
182 /* enter this partition (offset will be calculated later if it is zero at this point) */
183 parts[this_part].size = size;
184 parts[this_part].offset = offset;
185 parts[this_part].mask_flags = mask_flags;
186 if (name)
1da177e4 187 strlcpy(extra_mem, name, name_len + 1);
1da177e4 188 else
1da177e4 189 sprintf(extra_mem, "Partition_%03d", this_part);
1da177e4
LT
190 parts[this_part].name = extra_mem;
191 extra_mem += name_len + 1;
192
342ba103 193 dbg(("partition %d: name <%s>, offset %llx, size %llx, mask flags %x\n",
fac0077c
AB
194 this_part, parts[this_part].name, parts[this_part].offset,
195 parts[this_part].size, parts[this_part].mask_flags));
1da177e4
LT
196
197 /* return (updated) pointer to extra_mem memory */
198 if (extra_mem_ptr)
fac0077c 199 *extra_mem_ptr = extra_mem;
1da177e4
LT
200
201 /* return (updated) pointer command line string */
202 *retptr = s;
203
204 /* return partition table */
205 return parts;
206}
207
97894cda
TG
208/*
209 * Parse the command line.
1da177e4
LT
210 */
211static int mtdpart_setup_real(char *s)
212{
213 cmdline_parsed = 1;
214
215 for( ; s != NULL; )
216 {
217 struct cmdline_mtd_partition *this_mtd;
218 struct mtd_partition *parts;
fac0077c 219 int mtd_id_len, num_parts;
1da177e4
LT
220 char *p, *mtd_id;
221
fac0077c
AB
222 mtd_id = s;
223
1da177e4 224 /* fetch <mtd-id> */
fac0077c
AB
225 p = strchr(s, ':');
226 if (!p) {
1da177e4 227 printk(KERN_ERR ERRP "no mtd-id\n");
9e0606fc 228 return -EINVAL;
1da177e4
LT
229 }
230 mtd_id_len = p - mtd_id;
231
232 dbg(("parsing <%s>\n", p+1));
233
97894cda 234 /*
1da177e4
LT
235 * parse one mtd. have it reserve memory for the
236 * struct cmdline_mtd_partition and the mtd-id string.
237 */
238 parts = newpart(p + 1, /* cmdline */
239 &s, /* out: updated cmdline ptr */
240 &num_parts, /* out: number of parts */
241 0, /* first partition */
242 (unsigned char**)&this_mtd, /* out: extra mem */
97894cda 243 mtd_id_len + 1 + sizeof(*this_mtd) +
be76c5fb 244 sizeof(void*)-1 /*alignment*/);
fac0077c 245 if (IS_ERR(parts)) {
1da177e4
LT
246 /*
247 * An error occurred. We're either:
248 * a) out of memory, or
249 * b) in the middle of the partition spec
250 * Either way, this mtd is hosed and we're
251 * unlikely to succeed in parsing any more
252 */
9e0606fc 253 return PTR_ERR(parts);
1da177e4
LT
254 }
255
be76c5fb 256 /* align this_mtd */
97894cda 257 this_mtd = (struct cmdline_mtd_partition *)
fac0077c 258 ALIGN((unsigned long)this_mtd, sizeof(void *));
97894cda 259 /* enter results */
1da177e4
LT
260 this_mtd->parts = parts;
261 this_mtd->num_parts = num_parts;
262 this_mtd->mtd_id = (char*)(this_mtd + 1);
263 strlcpy(this_mtd->mtd_id, mtd_id, mtd_id_len + 1);
264
265 /* link into chain */
97894cda 266 this_mtd->next = partitions;
1da177e4
LT
267 partitions = this_mtd;
268
97894cda 269 dbg(("mtdid=<%s> num_parts=<%d>\n",
1da177e4 270 this_mtd->mtd_id, this_mtd->num_parts));
97894cda 271
1da177e4
LT
272
273 /* EOS - we're done */
274 if (*s == 0)
275 break;
276
277 /* does another spec follow? */
fac0077c 278 if (*s != ';') {
1da177e4 279 printk(KERN_ERR ERRP "bad character after partition (%c)\n", *s);
9e0606fc 280 return -EINVAL;
1da177e4
LT
281 }
282 s++;
283 }
fac0077c 284
9e0606fc 285 return 0;
1da177e4
LT
286}
287
288/*
289 * Main function to be called from the MTD mapping driver/device to
290 * obtain the partitioning information. At this point the command line
291 * arguments will actually be parsed and turned to struct mtd_partition
292 * information. It returns partitions for the requested mtd device, or
293 * the first one in the chain if a NULL mtd_id is passed in.
294 */
97894cda 295static int parse_cmdline_partitions(struct mtd_info *master,
c7975330
DES
296 struct mtd_partition **pparts,
297 struct mtd_part_parser_data *data)
1da177e4
LT
298{
299 unsigned long offset;
9e0606fc 300 int i, err;
1da177e4 301 struct cmdline_mtd_partition *part;
36560d25 302 const char *mtd_id = master->name;
1da177e4 303
1da177e4 304 /* parse command line */
9e0606fc
AB
305 if (!cmdline_parsed) {
306 err = mtdpart_setup_real(cmdline);
307 if (err)
308 return err;
309 }
1da177e4 310
fac0077c
AB
311 for (part = partitions; part; part = part->next) {
312 if ((!mtd_id) || (!strcmp(part->mtd_id, mtd_id))) {
313 for (i = 0, offset = 0; i < part->num_parts; i++) {
b175d03d 314 if (part->parts[i].offset == OFFSET_CONTINUOUS)
fac0077c 315 part->parts[i].offset = offset;
1da177e4 316 else
fac0077c
AB
317 offset = part->parts[i].offset;
318
1da177e4 319 if (part->parts[i].size == SIZE_REMAINING)
fac0077c
AB
320 part->parts[i].size = master->size - offset;
321
7baf0426
SL
322 if (part->parts[i].size == 0) {
323 printk(KERN_WARNING ERRP
324 "%s: skipping zero sized partition\n",
325 part->mtd_id);
326 part->num_parts--;
327 memmove(&part->parts[i],
328 &part->parts[i + 1],
329 sizeof(*part->parts) * (part->num_parts - i));
330 continue;
331 }
332
fac0077c 333 if (offset + part->parts[i].size > master->size) {
97894cda 334 printk(KERN_WARNING ERRP
1da177e4
LT
335 "%s: partitioning exceeds flash size, truncating\n",
336 part->mtd_id);
337 part->parts[i].size = master->size - offset;
1da177e4
LT
338 }
339 offset += part->parts[i].size;
340 }
fac0077c 341
17b536cc
AN
342 *pparts = kmemdup(part->parts,
343 sizeof(*part->parts) * part->num_parts,
344 GFP_KERNEL);
345 if (!*pparts)
346 return -ENOMEM;
fac0077c 347
1da177e4
LT
348 return part->num_parts;
349 }
350 }
fac0077c 351
b0d06afb 352 return 0;
1da177e4
LT
353}
354
355
97894cda
TG
356/*
357 * This is the handler for our kernel parameter, called from
1da177e4
LT
358 * main.c::checksetup(). Note that we can not yet kmalloc() anything,
359 * so we only save the commandline for later processing.
360 *
361 * This function needs to be visible for bootloaders.
362 */
ddacff1f 363static int mtdpart_setup(char *s)
1da177e4
LT
364{
365 cmdline = s;
366 return 1;
367}
368
369__setup("mtdparts=", mtdpart_setup);
370
371static struct mtd_part_parser cmdline_parser = {
372 .owner = THIS_MODULE,
373 .parse_fn = parse_cmdline_partitions,
374 .name = "cmdlinepart",
375};
376
377static int __init cmdline_parser_init(void)
378{
379 return register_mtd_parser(&cmdline_parser);
380}
381
382module_init(cmdline_parser_init);
383
384MODULE_LICENSE("GPL");
385MODULE_AUTHOR("Marius Groeger <mag@sysgo.de>");
386MODULE_DESCRIPTION("Command line configuration of MTD partitions");
This page took 0.636204 seconds and 5 git commands to generate.