[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-2012  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/crc32.h>
#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/sizes.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_CFE_BLOCK_SIZE	SZ_64K		/* 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 = mtd_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 = mtd_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;
	unsigned int cfe_erasesize;
	int i;
	u32 computed_crc;
	bool rootfs_first = false;

	if (bcm63xx_detect_cfe(master))
		return -EINVAL;

	cfe_erasesize = max_t(uint32_t, master->erasesize,
			      BCM63XX_CFE_BLOCK_SIZE);

	cfelen = cfe_erasesize;
	nvramlen = cfe_erasesize;

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

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

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

	computed_crc = crc32_le(IMAGETAG_CRC_START, (u8 *)buf,
				offsetof(struct bcm_tag, header_crc));
	if (computed_crc == buf->header_crc) {
		char *boardid = &(buf->board_id[0]);
		char *tagversion = &(buf->tag_version[0]);

		sscanf(buf->flash_image_start, "%u", &rootfsaddr);
		sscanf(buf->kernel_address, "%u", &kerneladdr);
		sscanf(buf->kernel_length, "%u", &kernellen);
		sscanf(buf->total_length, "%u", &totallen);

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

		kerneladdr = kerneladdr - BCM63XX_EXTENDED_SIZE;
		rootfsaddr = rootfsaddr - BCM63XX_EXTENDED_SIZE;
		spareaddr = roundup(totallen, master->erasesize) + cfelen;

		if (rootfsaddr < kerneladdr) {
			/* default Broadcom layout */
			rootfslen = kerneladdr - rootfsaddr;
			rootfs_first = true;
		} else {
			/* OpenWrt layout */
			rootfsaddr = kerneladdr + kernellen;
			rootfslen = spareaddr - rootfsaddr;
		}
	} else {
		pr_warn("CFE boot tag CRC invalid (expected %08x, actual %08x)\n",
			buf->header_crc, computed_crc);
		kernellen = 0;
		rootfslen = 0;
		rootfsaddr = 0;
		spareaddr = cfelen;
	}
	sparelen = master->size - spareaddr - nvramlen;

	/* Determine number of partitions */
	if (rootfslen > 0)
		nrparts++;

	if (kernellen > 0)
		nrparts++;

	/* 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) {
		int kernelpart = curpart;

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

	if (rootfslen > 0) {
		int rootfspart = curpart;

		if (kernellen > 0 && rootfs_first)
			rootfspart--;
		parts[rootfspart].name = "rootfs";
		parts[rootfspart].offset = rootfsaddr;
		parts[rootfspart].size = rootfslen;
		if (sparelen > 0  && !rootfs_first)
			parts[rootfspart].size += sparelen;
		curpart++;
	}

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

	/* Global partition "linux" to make easy firmware upgrade */
	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 %llx and length %llx\n", i,
			parts[i].name, parts[i].offset,	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>
5329d67c	7	* Copyright © 2011-2012 Jonas Gorski <jonas.gorski@gmail.com>
70a3c167 JG	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
f98872fc	27	#include <linux/crc32.h>
70a3c167 JG	28	#include <linux/module.h>
70a3c167 JG	29	#include <linux/kernel.h>
c88fd9d9	30	#include <linux/sizes.h>
70a3c167 JG	31	#include <linux/slab.h>
	32	#include <linux/vmalloc.h>
	33	#include <linux/mtd/mtd.h>
	34	#include <linux/mtd/partitions.h>
	35
	36	#include <asm/mach-bcm63xx/bcm963xx_tag.h>
f2d9739b	37	#include <asm/mach-bcm63xx/board_bcm963xx.h>
70a3c167 JG	38
	39	#define BCM63XX_EXTENDED_SIZE 0xBFC00000 /* Extended flash address */
	40
c88fd9d9	41	#define BCM63XX_CFE_BLOCK_SIZE SZ_64K /* always at least 64KiB */
678eb9bb	42
f2d9739b JG	43	#define BCM63XX_CFE_MAGIC_OFFSET 0x4e0
f2d9739b JG	44
70a3c167 JG	45	static int bcm63xx_detect_cfe(struct mtd_info *master)
70a3c167 JG	46	{
70a3c167 JG	47	char buf[9];
	48	int ret;
	49	size_t retlen;
	50
329ad399 AB	51	ret = mtd_read(master, BCM963XX_CFE_VERSION_OFFSET, 5, &retlen,
329ad399 AB	52	(void *)buf);
f2d9739b JG	53	buf[retlen] = 0;
	54
	55	if (ret)
	56	return ret;
	57
	58	if (strncmp("cfe-v", buf, 5) == 0)
	59	return 0;
	60
	61	/* very old CFE's do not have the cfe-v string, so check for magic */
329ad399 AB	62	ret = mtd_read(master, BCM63XX_CFE_MAGIC_OFFSET, 8, &retlen,
329ad399 AB	63	(void *)buf);
70a3c167	64	buf[retlen] = 0;
70a3c167	65
f2d9739b	66	return strncmp("CFE1CFE1", buf, 8);
70a3c167 JG	67	}
	68
	69	static int bcm63xx_parse_cfe_partitions(struct mtd_info *master,
	70	struct mtd_partition **pparts,
	71	struct mtd_part_parser_data *data)
	72	{
	73	/* CFE, NVRAM and global Linux are always present */
	74	int nrparts = 3, curpart = 0;
	75	struct bcm_tag *buf;
	76	struct mtd_partition *parts;
	77	int ret;
	78	size_t retlen;
	79	unsigned int rootfsaddr, kerneladdr, spareaddr;
	80	unsigned int rootfslen, kernellen, sparelen, totallen;
678eb9bb	81	unsigned int cfelen, nvramlen;
4e4fb639	82	unsigned int cfe_erasesize;
70a3c167	83	int i;
f98872fc	84	u32 computed_crc;
5329d67c	85	bool rootfs_first = false;
70a3c167 JG	86
	87	if (bcm63xx_detect_cfe(master))
	88	return -EINVAL;
	89
4e4fb639 JG	90	cfe_erasesize = max_t(uint32_t, master->erasesize,
	91	BCM63XX_CFE_BLOCK_SIZE);
	92
	93	cfelen = cfe_erasesize;
	94	nvramlen = cfe_erasesize;
678eb9bb	95
70a3c167 JG	96	/* Allocate memory for buffer */
	97	buf = vmalloc(sizeof(struct bcm_tag));
	98	if (!buf)
	99	return -ENOMEM;
	100
	101	/* Get the tag */
329ad399 AB	102	ret = mtd_read(master, cfelen, sizeof(struct bcm_tag), &retlen,
329ad399 AB	103	(void *)buf);
678eb9bb	104
70a3c167 JG	105	if (retlen != sizeof(struct bcm_tag)) {
	106	vfree(buf);
	107	return -EIO;
	108	}
	109
f98872fc JG	110	computed_crc = crc32_le(IMAGETAG_CRC_START, (u8 *)buf,
	111	offsetof(struct bcm_tag, header_crc));
	112	if (computed_crc == buf->header_crc) {
	113	char *boardid = &(buf->board_id[0]);
	114	char *tagversion = &(buf->tag_version[0]);
	115
5329d67c	116	sscanf(buf->flash_image_start, "%u", &rootfsaddr);
f98872fc JG	117	sscanf(buf->kernel_address, "%u", &kerneladdr);
	118	sscanf(buf->kernel_length, "%u", &kernellen);
	119	sscanf(buf->total_length, "%u", &totallen);
	120
	121	pr_info("CFE boot tag found with version %s and board type %s\n",
	122	tagversion, boardid);
	123
	124	kerneladdr = kerneladdr - BCM63XX_EXTENDED_SIZE;
5329d67c	125	rootfsaddr = rootfsaddr - BCM63XX_EXTENDED_SIZE;
f98872fc	126	spareaddr = roundup(totallen, master->erasesize) + cfelen;
5329d67c JG	127
	128	if (rootfsaddr < kerneladdr) {
	129	/* default Broadcom layout */
	130	rootfslen = kerneladdr - rootfsaddr;
	131	rootfs_first = true;
	132	} else {
	133	/* OpenWrt layout */
	134	rootfsaddr = kerneladdr + kernellen;
	135	rootfslen = spareaddr - rootfsaddr;
	136	}
f98872fc JG	137	} else {
	138	pr_warn("CFE boot tag CRC invalid (expected %08x, actual %08x)\n",
	139	buf->header_crc, computed_crc);
	140	kernellen = 0;
	141	rootfslen = 0;
	142	rootfsaddr = 0;
	143	spareaddr = cfelen;
f98872fc	144	}
e190401b	145	sparelen = master->size - spareaddr - nvramlen;
70a3c167 JG	146
70a3c167 JG	147	/* Determine number of partitions */
fafc3d68	148	if (rootfslen > 0)
70a3c167	149	nrparts++;
fafc3d68 JG	150
fafc3d68 JG	151	if (kernellen > 0)
70a3c167	152	nrparts++;
70a3c167 JG	153
	154	/* Ask kernel for more memory */
	155	parts = kzalloc(sizeof(parts) nrparts + 10 * nrparts, GFP_KERNEL);
	156	if (!parts) {
	157	vfree(buf);
	158	return -ENOMEM;
	159	}
	160
	161	/* Start building partition list */
	162	parts[curpart].name = "CFE";
	163	parts[curpart].offset = 0;
678eb9bb	164	parts[curpart].size = cfelen;
70a3c167 JG	165	curpart++;
	166
	167	if (kernellen > 0) {
5329d67c JG	168	int kernelpart = curpart;
	169
	170	if (rootfslen > 0 && rootfs_first)
	171	kernelpart++;
	172	parts[kernelpart].name = "kernel";
	173	parts[kernelpart].offset = kerneladdr;
	174	parts[kernelpart].size = kernellen;
70a3c167 JG	175	curpart++;
	176	}
	177
	178	if (rootfslen > 0) {
5329d67c JG	179	int rootfspart = curpart;
	180
	181	if (kernellen > 0 && rootfs_first)
	182	rootfspart--;
	183	parts[rootfspart].name = "rootfs";
	184	parts[rootfspart].offset = rootfsaddr;
	185	parts[rootfspart].size = rootfslen;
	186	if (sparelen > 0 && !rootfs_first)
	187	parts[rootfspart].size += sparelen;
70a3c167 JG	188	curpart++;
	189	}
	190
	191	parts[curpart].name = "nvram";
678eb9bb JG	192	parts[curpart].offset = master->size - nvramlen;
678eb9bb JG	193	parts[curpart].size = nvramlen;
f3f9a5da	194	curpart++;
70a3c167 JG	195
70a3c167 JG	196	/* Global partition "linux" to make easy firmware upgrade */
70a3c167	197	parts[curpart].name = "linux";
327c62c5 JG	198	parts[curpart].offset = cfelen;
327c62c5 JG	199	parts[curpart].size = master->size - cfelen - nvramlen;
70a3c167 JG	200
70a3c167 JG	201	for (i = 0; i < nrparts; i++)
60768368 JG	202	pr_info("Partition %d is %s offset %llx and length %llx\n", i,
60768368 JG	203	parts[i].name, parts[i].offset, parts[i].size);
70a3c167 JG	204
	205	pr_info("Spare partition is offset %x and length %x\n", spareaddr,
	206	sparelen);
	207
	208	*pparts = parts;
	209	vfree(buf);
	210
	211	return nrparts;
	212	};
	213
	214	static struct mtd_part_parser bcm63xx_cfe_parser = {
	215	.owner = THIS_MODULE,
	216	.parse_fn = bcm63xx_parse_cfe_partitions,
	217	.name = "bcm63xxpart",
	218	};
	219
	220	static int __init bcm63xx_cfe_parser_init(void)
	221	{
	222	return register_mtd_parser(&bcm63xx_cfe_parser);
	223	}
	224
	225	static void __exit bcm63xx_cfe_parser_exit(void)
	226	{
	227	deregister_mtd_parser(&bcm63xx_cfe_parser);
	228	}
	229
	230	module_init(bcm63xx_cfe_parser_init);
	231	module_exit(bcm63xx_cfe_parser_exit);
	232
	233	MODULE_LICENSE("GPL");
	234	MODULE_AUTHOR("Daniel Dickinson <openwrt@cshore.neomailbox.net>");
	235	MODULE_AUTHOR("Florian Fainelli <florian@openwrt.org>");
	236	MODULE_AUTHOR("Mike Albon <malbon@openwrt.org>");
	237	MODULE_AUTHOR("Jonas Gorski <jonas.gorski@gmail.com");
	238	MODULE_DESCRIPTION("MTD partitioning for BCM63XX CFE bootloaders");