[linux.git] / drivers / mtd / cmdlinepart.c

/*
 * $Id: cmdlinepart.c,v 1.19 2005/11/07 11:14:19 gleixner Exp $
 *
 * Read flash partition table from command line
 *
 * Copyright 2002 SYSGO Real-Time Solutions GmbH
 *
 * The format for the command line is as follows:
 *
 * mtdparts=<mtddef>[;<mtddef]
 * <mtddef>  := <mtd-id>:<partdef>[,<partdef>]
 * <partdef> := <size>[@offset][<name>][ro][lk]
 * <mtd-id>  := unique name used in mapping driver/device (mtd->name)
 * <size>    := standard linux memsize OR "-" to denote all remaining space
 * <name>    := '(' NAME ')'
 *
 * Examples:
 *
 * 1 NOR Flash, with 1 single writable partition:
 * edb7312-nor:-
 *
 * 1 NOR Flash with 2 partitions, 1 NAND with one
 * edb7312-nor:256k(ARMboot)ro,-(root);edb7312-nand:-(home)
 */

#include <linux/kernel.h>
#include <linux/slab.h>

#include <linux/mtd/mtd.h>
#include <linux/mtd/partitions.h>
#include <linux/bootmem.h>

/* error message prefix */
#define ERRP "mtd: "

/* debug macro */
#if 0
#define dbg(x) do { printk("DEBUG-CMDLINE-PART: "); printk x; } while(0)
#else
#define dbg(x)
#endif


/* special size referring to all the remaining space in a partition */
#define SIZE_REMAINING UINT_MAX
#define OFFSET_CONTINUOUS UINT_MAX

struct cmdline_mtd_partition {
	struct cmdline_mtd_partition *next;
	char *mtd_id;
	int num_parts;
	struct mtd_partition *parts;
};

/* mtdpart_setup() parses into here */
static struct cmdline_mtd_partition *partitions;

/* the command line passed to mtdpart_setupd() */
static char *cmdline;
static int cmdline_parsed = 0;

/*
 * Parse one partition definition for an MTD. Since there can be many
 * comma separated partition definitions, this function calls itself
 * recursively until no more partition definitions are found. Nice side
 * effect: the memory to keep the mtd_partition structs and the names
 * is allocated upon the last definition being found. At that point the
 * syntax has been verified ok.
 */
static struct mtd_partition * newpart(char *s,
                                      char **retptr,
                                      int *num_parts,
                                      int this_part,
                                      unsigned char **extra_mem_ptr,
                                      int extra_mem_size)
{
	struct mtd_partition *parts;
	unsigned long size;
	unsigned long offset = OFFSET_CONTINUOUS;
	char *name;
	int name_len;
	unsigned char *extra_mem;
	char delim;
	unsigned int mask_flags;

	/* fetch the partition size */
	if (*s == '-')
	{	/* assign all remaining space to this partition */
		size = SIZE_REMAINING;
		s++;
	}
	else
	{
		size = memparse(s, &s);
		if (size < PAGE_SIZE)
		{
			printk(KERN_ERR ERRP "partition size too small (%lx)\n", size);
			return NULL;
		}
	}

	/* fetch partition name and flags */
	mask_flags = 0; /* this is going to be a regular partition */
	delim = 0;
        /* check for offset */
        if (*s == '@')
	{
                s++;
                offset = memparse(s, &s);
        }
        /* now look for name */
	if (*s == '(')
	{
		delim = ')';
	}

	if (delim)
	{
		char *p;

	    	name = ++s;
		p = strchr(name, delim);
		if (!p)
		{
			printk(KERN_ERR ERRP "no closing %c found in partition name\n", delim);
			return NULL;
		}
		name_len = p - name;
		s = p + 1;
	}
	else
	{
	    	name = NULL;
		name_len = 13; /* Partition_000 */
	}

	/* record name length for memory allocation later */
	extra_mem_size += name_len + 1;

        /* test for options */
        if (strncmp(s, "ro", 2) == 0)
	{
		mask_flags |= MTD_WRITEABLE;
		s += 2;
        }

        /* if lk is found do NOT unlock the MTD partition*/
        if (strncmp(s, "lk", 2) == 0)
	{
		mask_flags |= MTD_POWERUP_LOCK;
		s += 2;
        }

	/* test if more partitions are following */
	if (*s == ',')
	{
		if (size == SIZE_REMAINING)
		{
			printk(KERN_ERR ERRP "no partitions allowed after a fill-up partition\n");
			return NULL;
		}
		/* more partitions follow, parse them */
		parts = newpart(s + 1, &s, num_parts, this_part + 1,
				&extra_mem, extra_mem_size);
		if (!parts)
			return NULL;
	}
	else
	{	/* this is the last partition: allocate space for all */
		int alloc_size;

		*num_parts = this_part + 1;
		alloc_size = *num_parts * sizeof(struct mtd_partition) +
			     extra_mem_size;
		parts = kzalloc(alloc_size, GFP_KERNEL);
		if (!parts)
		{
			printk(KERN_ERR ERRP "out of memory\n");
			return NULL;
		}
		extra_mem = (unsigned char *)(parts + *num_parts);
	}
	/* enter this partition (offset will be calculated later if it is zero at this point) */
	parts[this_part].size = size;
	parts[this_part].offset = offset;
	parts[this_part].mask_flags = mask_flags;
	if (name)
	{
		strlcpy(extra_mem, name, name_len + 1);
	}
	else
	{
		sprintf(extra_mem, "Partition_%03d", this_part);
	}
	parts[this_part].name = extra_mem;
	extra_mem += name_len + 1;

	dbg(("partition %d: name <%s>, offset %x, size %x, mask flags %x\n",
	     this_part,
	     parts[this_part].name,
	     parts[this_part].offset,
	     parts[this_part].size,
	     parts[this_part].mask_flags));

	/* return (updated) pointer to extra_mem memory */
	if (extra_mem_ptr)
	  *extra_mem_ptr = extra_mem;

	/* return (updated) pointer command line string */
	*retptr = s;

	/* return partition table */
	return parts;
}

/*
 * Parse the command line.
 */
static int mtdpart_setup_real(char *s)
{
	cmdline_parsed = 1;

	for( ; s != NULL; )
	{
		struct cmdline_mtd_partition *this_mtd;
		struct mtd_partition *parts;
	    	int mtd_id_len;
		int num_parts;
		char *p, *mtd_id;

	    	mtd_id = s;
		/* fetch <mtd-id> */
		if (!(p = strchr(s, ':')))
		{
			printk(KERN_ERR ERRP "no mtd-id\n");
			return 0;
		}
		mtd_id_len = p - mtd_id;

		dbg(("parsing <%s>\n", p+1));

		/*
		 * parse one mtd. have it reserve memory for the
		 * struct cmdline_mtd_partition and the mtd-id string.
		 */
		parts = newpart(p + 1,		/* cmdline */
				&s,		/* out: updated cmdline ptr */
				&num_parts,	/* out: number of parts */
				0,		/* first partition */
				(unsigned char**)&this_mtd, /* out: extra mem */
				mtd_id_len + 1 + sizeof(*this_mtd) +
				sizeof(void*)-1 /*alignment*/);
		if(!parts)
		{
			/*
			 * An error occurred. We're either:
			 * a) out of memory, or
			 * b) in the middle of the partition spec
			 * Either way, this mtd is hosed and we're
			 * unlikely to succeed in parsing any more
			 */
			 return 0;
		 }

		/* align this_mtd */
		this_mtd = (struct cmdline_mtd_partition *)
			ALIGN((unsigned long)this_mtd, sizeof(void*));
		/* enter results */
		this_mtd->parts = parts;
		this_mtd->num_parts = num_parts;
		this_mtd->mtd_id = (char*)(this_mtd + 1);
		strlcpy(this_mtd->mtd_id, mtd_id, mtd_id_len + 1);

		/* link into chain */
		this_mtd->next = partitions;
		partitions = this_mtd;

		dbg(("mtdid=<%s> num_parts=<%d>\n",
		     this_mtd->mtd_id, this_mtd->num_parts));


		/* EOS - we're done */
		if (*s == 0)
			break;

		/* does another spec follow? */
		if (*s != ';')
		{
			printk(KERN_ERR ERRP "bad character after partition (%c)\n", *s);
			return 0;
		}
		s++;
	}
	return 1;
}

/*
 * Main function to be called from the MTD mapping driver/device to
 * obtain the partitioning information. At this point the command line
 * arguments will actually be parsed and turned to struct mtd_partition
 * information. It returns partitions for the requested mtd device, or
 * the first one in the chain if a NULL mtd_id is passed in.
 */
static int parse_cmdline_partitions(struct mtd_info *master,
                             struct mtd_partition **pparts,
                             unsigned long origin)
{
	unsigned long offset;
	int i;
	struct cmdline_mtd_partition *part;
	char *mtd_id = master->name;

	/* parse command line */
	if (!cmdline_parsed)
		mtdpart_setup_real(cmdline);

	for(part = partitions; part; part = part->next)
	{
		if ((!mtd_id) || (!strcmp(part->mtd_id, mtd_id)))
		{
			for(i = 0, offset = 0; i < part->num_parts; i++)
			{
				if (part->parts[i].offset == OFFSET_CONTINUOUS)
				  part->parts[i].offset = offset;
				else
				  offset = part->parts[i].offset;
				if (part->parts[i].size == SIZE_REMAINING)
				  part->parts[i].size = master->size - offset;
				if (offset + part->parts[i].size > master->size)
				{
					printk(KERN_WARNING ERRP
					       "%s: partitioning exceeds flash size, truncating\n",
					       part->mtd_id);
					part->parts[i].size = master->size - offset;
					part->num_parts = i;
				}
				offset += part->parts[i].size;
			}
			*pparts = part->parts;
			return part->num_parts;
		}
	}
	return 0;
}


/*
 * This is the handler for our kernel parameter, called from
 * main.c::checksetup(). Note that we can not yet kmalloc() anything,
 * so we only save the commandline for later processing.
 *
 * This function needs to be visible for bootloaders.
 */
static int mtdpart_setup(char *s)
{
	cmdline = s;
	return 1;
}

__setup("mtdparts=", mtdpart_setup);

static struct mtd_part_parser cmdline_parser = {
	.owner = THIS_MODULE,
	.parse_fn = parse_cmdline_partitions,
	.name = "cmdlinepart",
};

static int __init cmdline_parser_init(void)
{
	return register_mtd_parser(&cmdline_parser);
}

module_init(cmdline_parser_init);

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