[deliverable/linux.git] / drivers / mtd / bcm63xxpart.c

/*
 * BCM63XX CFE image tag parser
 *
 * Copyright © 2006-2008  Florian Fainelli <florian@openwrt.org>
 *			  Mike Albon <malbon@openwrt.org>
 * Copyright © 2009-2010  Daniel Dickinson <openwrt@cshore.neomailbox.net>
 * Copyright © 2011 Jonas Gorski <jonas.gorski@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/slab.h>
#include <linux/vmalloc.h>
#include <linux/mtd/mtd.h>
#include <linux/mtd/partitions.h>

#include <asm/mach-bcm63xx/bcm963xx_tag.h>
#include <asm/mach-bcm63xx/board_bcm963xx.h>

#define BCM63XX_EXTENDED_SIZE	0xBFC00000	/* Extended flash address */

#define BCM63XX_MIN_CFE_SIZE	0x10000		/* always at least 64KiB */
#define BCM63XX_MIN_NVRAM_SIZE	0x10000		/* always at least 64KiB */

#define BCM63XX_CFE_MAGIC_OFFSET 0x4e0

static int bcm63xx_detect_cfe(struct mtd_info *master)
{
	char buf[9];
	int ret;
	size_t retlen;

	ret = master->read(master, BCM963XX_CFE_VERSION_OFFSET, 5, &retlen,
			   (void *)buf);
	buf[retlen] = 0;

	if (ret)
		return ret;

	if (strncmp("cfe-v", buf, 5) == 0)
		return 0;

	/* very old CFE's do not have the cfe-v string, so check for magic */
	ret = master->read(master, BCM63XX_CFE_MAGIC_OFFSET, 8, &retlen,
			   (void *)buf);
	buf[retlen] = 0;

	return strncmp("CFE1CFE1", buf, 8);
}

static int bcm63xx_parse_cfe_partitions(struct mtd_info *master,
					struct mtd_partition **pparts,
					struct mtd_part_parser_data *data)
{
	/* CFE, NVRAM and global Linux are always present */
	int nrparts = 3, curpart = 0;
	struct bcm_tag *buf;
	struct mtd_partition *parts;
	int ret;
	size_t retlen;
	unsigned int rootfsaddr, kerneladdr, spareaddr;
	unsigned int rootfslen, kernellen, sparelen, totallen;
	unsigned int cfelen, nvramlen;
	int namelen = 0;
	int i;
	char *boardid;
	char *tagversion;

	if (bcm63xx_detect_cfe(master))
		return -EINVAL;

	cfelen = max_t(uint32_t, master->erasesize, BCM63XX_MIN_CFE_SIZE);
	nvramlen = max_t(uint32_t, master->erasesize, BCM63XX_MIN_NVRAM_SIZE);

	/* Allocate memory for buffer */
	buf = vmalloc(sizeof(struct bcm_tag));
	if (!buf)
		return -ENOMEM;

	/* Get the tag */
	ret = master->read(master, cfelen, sizeof(struct bcm_tag), &retlen,
			   (void *)buf);

	if (retlen != sizeof(struct bcm_tag)) {
		vfree(buf);
		return -EIO;
	}

	sscanf(buf->kernel_address, "%u", &kerneladdr);
	sscanf(buf->kernel_length, "%u", &kernellen);
	sscanf(buf->total_length, "%u", &totallen);
	tagversion = &(buf->tag_version[0]);
	boardid = &(buf->board_id[0]);

	pr_info("CFE boot tag found with version %s and board type %s\n",
		tagversion, boardid);

	kerneladdr = kerneladdr - BCM63XX_EXTENDED_SIZE;
	rootfsaddr = kerneladdr + kernellen;
	spareaddr = roundup(totallen, master->erasesize) + cfelen;
	sparelen = master->size - spareaddr - nvramlen;
	rootfslen = spareaddr - rootfsaddr;

	/* Determine number of partitions */
	namelen = 8;
	if (rootfslen > 0) {
		nrparts++;
		namelen += 6;
	}
	if (kernellen > 0) {
		nrparts++;
		namelen += 6;
	}

	/* Ask kernel for more memory */
	parts = kzalloc(sizeof(*parts) * nrparts + 10 * nrparts, GFP_KERNEL);
	if (!parts) {
		vfree(buf);
		return -ENOMEM;
	}

	/* Start building partition list */
	parts[curpart].name = "CFE";
	parts[curpart].offset = 0;
	parts[curpart].size = cfelen;
	curpart++;

	if (kernellen > 0) {
		parts[curpart].name = "kernel";
		parts[curpart].offset = kerneladdr;
		parts[curpart].size = kernellen;
		curpart++;
	}

	if (rootfslen > 0) {
		parts[curpart].name = "rootfs";
		parts[curpart].offset = rootfsaddr;
		parts[curpart].size = rootfslen;
		if (sparelen > 0)
			parts[curpart].size += sparelen;
		curpart++;
	}

	parts[curpart].name = "nvram";
	parts[curpart].offset = master->size - nvramlen;
	parts[curpart].size = nvramlen;

	/* Global partition "linux" to make easy firmware upgrade */
	curpart++;
	parts[curpart].name = "linux";
	parts[curpart].offset = cfelen;
	parts[curpart].size = master->size - cfelen - nvramlen;

	for (i = 0; i < nrparts; i++)
		pr_info("Partition %d is %s offset %lx and length %lx\n", i,
			parts[i].name, (long unsigned int)(parts[i].offset),
			(long unsigned int)(parts[i].size));

	pr_info("Spare partition is offset %x and length %x\n",	spareaddr,
		sparelen);

	*pparts = parts;
	vfree(buf);

	return nrparts;
};

static struct mtd_part_parser bcm63xx_cfe_parser = {
	.owner = THIS_MODULE,
	.parse_fn = bcm63xx_parse_cfe_partitions,
	.name = "bcm63xxpart",
};

static int __init bcm63xx_cfe_parser_init(void)
{
	return register_mtd_parser(&bcm63xx_cfe_parser);
}

static void __exit bcm63xx_cfe_parser_exit(void)
{
	deregister_mtd_parser(&bcm63xx_cfe_parser);
}

module_init(bcm63xx_cfe_parser_init);
module_exit(bcm63xx_cfe_parser_exit);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Daniel Dickinson <openwrt@cshore.neomailbox.net>");
MODULE_AUTHOR("Florian Fainelli <florian@openwrt.org>");
MODULE_AUTHOR("Mike Albon <malbon@openwrt.org>");
MODULE_AUTHOR("Jonas Gorski <jonas.gorski@gmail.com");
MODULE_DESCRIPTION("MTD partitioning for BCM63XX CFE bootloaders");
Commit	Line	Data
70a3c167 JG	1	/*
	2	* BCM63XX CFE image tag parser
	3	*
	4	* Copyright © 2006-2008 Florian Fainelli <florian@openwrt.org>
	5	* Mike Albon <malbon@openwrt.org>
	6	* Copyright © 2009-2010 Daniel Dickinson <openwrt@cshore.neomailbox.net>
	7	* Copyright © 2011 Jonas Gorski <jonas.gorski@gmail.com>
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License as published by
	11	* the Free Software Foundation; either version 2 of the License, or
	12	* (at your option) any later version.
	13	*
	14	* This program is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	* GNU General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, write to the Free Software
	21	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	22	*
	23	*/
	24
	25	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
	26
	27	#include <linux/module.h>
	28	#include <linux/kernel.h>
	29	#include <linux/slab.h>
	30	#include <linux/vmalloc.h>
	31	#include <linux/mtd/mtd.h>
	32	#include <linux/mtd/partitions.h>
	33
	34	#include <asm/mach-bcm63xx/bcm963xx_tag.h>
f2d9739b	35	#include <asm/mach-bcm63xx/board_bcm963xx.h>
70a3c167 JG	36
	37	#define BCM63XX_EXTENDED_SIZE 0xBFC00000 /* Extended flash address */
	38
678eb9bb JG	39	#define BCM63XX_MIN_CFE_SIZE 0x10000 /* always at least 64KiB */
	40	#define BCM63XX_MIN_NVRAM_SIZE 0x10000 /* always at least 64KiB */
	41
f2d9739b JG	42	#define BCM63XX_CFE_MAGIC_OFFSET 0x4e0
f2d9739b JG	43
70a3c167 JG	44	static int bcm63xx_detect_cfe(struct mtd_info *master)
70a3c167 JG	45	{
70a3c167 JG	46	char buf[9];
	47	int ret;
	48	size_t retlen;
	49
f2d9739b JG	50	ret = master->read(master, BCM963XX_CFE_VERSION_OFFSET, 5, &retlen,
	51	(void *)buf);
	52	buf[retlen] = 0;
	53
	54	if (ret)
	55	return ret;
	56
	57	if (strncmp("cfe-v", buf, 5) == 0)
	58	return 0;
	59
	60	/* very old CFE's do not have the cfe-v string, so check for magic */
	61	ret = master->read(master, BCM63XX_CFE_MAGIC_OFFSET, 8, &retlen,
	62	(void *)buf);
70a3c167	63	buf[retlen] = 0;
70a3c167	64
f2d9739b	65	return strncmp("CFE1CFE1", buf, 8);
70a3c167 JG	66	}
	67
	68	static int bcm63xx_parse_cfe_partitions(struct mtd_info *master,
	69	struct mtd_partition **pparts,
	70	struct mtd_part_parser_data *data)
	71	{
	72	/* CFE, NVRAM and global Linux are always present */
	73	int nrparts = 3, curpart = 0;
	74	struct bcm_tag *buf;
	75	struct mtd_partition *parts;
	76	int ret;
	77	size_t retlen;
	78	unsigned int rootfsaddr, kerneladdr, spareaddr;
	79	unsigned int rootfslen, kernellen, sparelen, totallen;
678eb9bb	80	unsigned int cfelen, nvramlen;
70a3c167 JG	81	int namelen = 0;
	82	int i;
	83	char *boardid;
	84	char *tagversion;
	85
	86	if (bcm63xx_detect_cfe(master))
	87	return -EINVAL;
	88
678eb9bb JG	89	cfelen = max_t(uint32_t, master->erasesize, BCM63XX_MIN_CFE_SIZE);
	90	nvramlen = max_t(uint32_t, master->erasesize, BCM63XX_MIN_NVRAM_SIZE);
	91
70a3c167 JG	92	/* Allocate memory for buffer */
	93	buf = vmalloc(sizeof(struct bcm_tag));
	94	if (!buf)
	95	return -ENOMEM;
	96
	97	/* Get the tag */
678eb9bb JG	98	ret = master->read(master, cfelen, sizeof(struct bcm_tag), &retlen,
	99	(void *)buf);
	100
70a3c167 JG	101	if (retlen != sizeof(struct bcm_tag)) {
	102	vfree(buf);
	103	return -EIO;
	104	}
	105
	106	sscanf(buf->kernel_address, "%u", &kerneladdr);
	107	sscanf(buf->kernel_length, "%u", &kernellen);
	108	sscanf(buf->total_length, "%u", &totallen);
	109	tagversion = &(buf->tag_version[0]);
	110	boardid = &(buf->board_id[0]);
	111
	112	pr_info("CFE boot tag found with version %s and board type %s\n",
	113	tagversion, boardid);
	114
	115	kerneladdr = kerneladdr - BCM63XX_EXTENDED_SIZE;
	116	rootfsaddr = kerneladdr + kernellen;
678eb9bb JG	117	spareaddr = roundup(totallen, master->erasesize) + cfelen;
678eb9bb JG	118	sparelen = master->size - spareaddr - nvramlen;
70a3c167 JG	119	rootfslen = spareaddr - rootfsaddr;
	120
	121	/* Determine number of partitions */
	122	namelen = 8;
	123	if (rootfslen > 0) {
	124	nrparts++;
	125	namelen += 6;
	126	}
	127	if (kernellen > 0) {
	128	nrparts++;
	129	namelen += 6;
	130	}
	131
	132	/* Ask kernel for more memory */
	133	parts = kzalloc(sizeof(parts) nrparts + 10 * nrparts, GFP_KERNEL);
	134	if (!parts) {
	135	vfree(buf);
	136	return -ENOMEM;
	137	}
	138
	139	/* Start building partition list */
	140	parts[curpart].name = "CFE";
	141	parts[curpart].offset = 0;
678eb9bb	142	parts[curpart].size = cfelen;
70a3c167 JG	143	curpart++;
	144
	145	if (kernellen > 0) {
	146	parts[curpart].name = "kernel";
	147	parts[curpart].offset = kerneladdr;
	148	parts[curpart].size = kernellen;
	149	curpart++;
	150	}
	151
	152	if (rootfslen > 0) {
	153	parts[curpart].name = "rootfs";
	154	parts[curpart].offset = rootfsaddr;
	155	parts[curpart].size = rootfslen;
	156	if (sparelen > 0)
	157	parts[curpart].size += sparelen;
	158	curpart++;
	159	}
	160
	161	parts[curpart].name = "nvram";
678eb9bb JG	162	parts[curpart].offset = master->size - nvramlen;
678eb9bb JG	163	parts[curpart].size = nvramlen;
70a3c167 JG	164
	165	/* Global partition "linux" to make easy firmware upgrade */
	166	curpart++;
	167	parts[curpart].name = "linux";
327c62c5 JG	168	parts[curpart].offset = cfelen;
327c62c5 JG	169	parts[curpart].size = master->size - cfelen - nvramlen;
70a3c167 JG	170
	171	for (i = 0; i < nrparts; i++)
	172	pr_info("Partition %d is %s offset %lx and length %lx\n", i,
	173	parts[i].name, (long unsigned int)(parts[i].offset),
	174	(long unsigned int)(parts[i].size));
	175
	176	pr_info("Spare partition is offset %x and length %x\n", spareaddr,
	177	sparelen);
	178
	179	*pparts = parts;
	180	vfree(buf);
	181
	182	return nrparts;
	183	};
	184
	185	static struct mtd_part_parser bcm63xx_cfe_parser = {
	186	.owner = THIS_MODULE,
	187	.parse_fn = bcm63xx_parse_cfe_partitions,
	188	.name = "bcm63xxpart",
	189	};
	190
	191	static int __init bcm63xx_cfe_parser_init(void)
	192	{
	193	return register_mtd_parser(&bcm63xx_cfe_parser);
	194	}
	195
	196	static void __exit bcm63xx_cfe_parser_exit(void)
	197	{
	198	deregister_mtd_parser(&bcm63xx_cfe_parser);
	199	}
	200
	201	module_init(bcm63xx_cfe_parser_init);
	202	module_exit(bcm63xx_cfe_parser_exit);
	203
	204	MODULE_LICENSE("GPL");
	205	MODULE_AUTHOR("Daniel Dickinson <openwrt@cshore.neomailbox.net>");
	206	MODULE_AUTHOR("Florian Fainelli <florian@openwrt.org>");
	207	MODULE_AUTHOR("Mike Albon <malbon@openwrt.org>");
	208	MODULE_AUTHOR("Jonas Gorski <jonas.gorski@gmail.com");
	209	MODULE_DESCRIPTION("MTD partitioning for BCM63XX CFE bootloaders");