[linux-2.6-block.git] / drivers / mtd / bcm63xxpart.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * 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-2013  Jonas Gorski <jonas.gorski@gmail.com>
 */

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <linux/bcm963xx_nvram.h>
#include <linux/bcm963xx_tag.h>
#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 <linux/of.h>

#define BCM963XX_CFE_BLOCK_SIZE		SZ_64K	/* always at least 64KiB */

#define BCM963XX_CFE_MAGIC_OFFSET	0x4e0
#define BCM963XX_CFE_VERSION_OFFSET	0x570
#define BCM963XX_NVRAM_OFFSET		0x580

/* Ensure strings read from flash structs are null terminated */
#define STR_NULL_TERMINATE(x) \
	do { char *_str = (x); _str[sizeof(x) - 1] = 0; } while (0)

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, BCM963XX_CFE_MAGIC_OFFSET, 8, &retlen,
		       (void *)buf);
	buf[retlen] = 0;

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

static int bcm63xx_read_nvram(struct mtd_info *master,
	struct bcm963xx_nvram *nvram)
{
	u32 actual_crc, expected_crc;
	size_t retlen;
	int ret;

	/* extract nvram data */
	ret = mtd_read(master, BCM963XX_NVRAM_OFFSET, BCM963XX_NVRAM_V5_SIZE,
			&retlen, (void *)nvram);
	if (ret)
		return ret;

	ret = bcm963xx_nvram_checksum(nvram, &expected_crc, &actual_crc);
	if (ret)
		pr_warn("nvram checksum failed, contents may be invalid (expected %08x, got %08x)\n",
			expected_crc, actual_crc);

	if (!nvram->psi_size)
		nvram->psi_size = BCM963XX_DEFAULT_PSI_SIZE;

	return 0;
}

static const char * const bcm63xx_cfe_part_types[] = {
	"bcm963xx-imagetag",
	NULL,
};

static int bcm63xx_parse_cfe_nor_partitions(struct mtd_info *master,
	const struct mtd_partition **pparts, struct bcm963xx_nvram *nvram)
{
	struct mtd_partition *parts;
	int nrparts = 3, curpart = 0;
	unsigned int cfelen, nvramlen;
	unsigned int cfe_erasesize;
	int i;

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

	cfelen = cfe_erasesize;
	nvramlen = nvram->psi_size * SZ_1K;
	nvramlen = roundup(nvramlen, cfe_erasesize);

	parts = kzalloc(sizeof(*parts) * nrparts + 10 * nrparts, GFP_KERNEL);
	if (!parts)
		return -ENOMEM;

	/* Start building partition list */
	parts[curpart].name = "CFE";
	parts[curpart].offset = 0;
	parts[curpart].size = cfelen;
	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;
	parts[curpart].types = bcm63xx_cfe_part_types;

	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);

	*pparts = parts;

	return nrparts;
}

static int bcm63xx_parse_cfe_partitions(struct mtd_info *master,
					const struct mtd_partition **pparts,
					struct mtd_part_parser_data *data)
{
	struct bcm963xx_nvram *nvram = NULL;
	int ret;

	if (bcm63xx_detect_cfe(master))
		return -EINVAL;

	nvram = vzalloc(sizeof(*nvram));
	if (!nvram)
		return -ENOMEM;

	ret = bcm63xx_read_nvram(master, nvram);
	if (ret)
		goto out;

	if (!mtd_type_is_nand(master))
		ret = bcm63xx_parse_cfe_nor_partitions(master, pparts, nvram);
	else
		ret = -EINVAL;

out:
	vfree(nvram);
	return ret;
};

static const struct of_device_id parse_bcm63xx_cfe_match_table[] = {
	{ .compatible = "brcm,bcm963xx-cfe-nor-partitions" },
	{},
};
MODULE_DEVICE_TABLE(of, parse_bcm63xx_cfe_match_table);

static struct mtd_part_parser bcm63xx_cfe_parser = {
	.parse_fn = bcm63xx_parse_cfe_partitions,
	.name = "bcm63xxpart",
	.of_match_table = parse_bcm63xx_cfe_match_table,
};
module_mtd_part_parser(bcm63xx_cfe_parser);

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
fd534e9b	1	// SPDX-License-Identifier: GPL-2.0-or-later
70a3c167 JG	2	/*
	3	* BCM63XX CFE image tag parser
	4	*
	5	* Copyright © 2006-2008 Florian Fainelli <florian@openwrt.org>
	6	* Mike Albon <malbon@openwrt.org>
	7	* Copyright © 2009-2010 Daniel Dickinson <openwrt@cshore.neomailbox.net>
d085eea1	8	* Copyright © 2011-2013 Jonas Gorski <jonas.gorski@gmail.com>
70a3c167 JG	9	*/
	10
	11	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
	12
436e94a6	13	#include <linux/bcm963xx_nvram.h>
8fce60b8	14	#include <linux/bcm963xx_tag.h>
f98872fc	15	#include <linux/crc32.h>
70a3c167 JG	16	#include <linux/module.h>
70a3c167 JG	17	#include <linux/kernel.h>
c88fd9d9	18	#include <linux/sizes.h>
70a3c167 JG	19	#include <linux/slab.h>
	20	#include <linux/vmalloc.h>
	21	#include <linux/mtd/mtd.h>
	22	#include <linux/mtd/partitions.h>
e651de47	23	#include <linux/of.h>
70a3c167	24
436e94a6	25	#define BCM963XX_CFE_BLOCK_SIZE SZ_64K /* always at least 64KiB */
70a3c167	26
436e94a6 SA	27	#define BCM963XX_CFE_MAGIC_OFFSET 0x4e0
	28	#define BCM963XX_CFE_VERSION_OFFSET 0x570
	29	#define BCM963XX_NVRAM_OFFSET 0x580
f2d9739b	30
7fffa694 SA	31	/* Ensure strings read from flash structs are null terminated */
	32	#define STR_NULL_TERMINATE(x) \
	33	do { char *_str = (x); _str[sizeof(x) - 1] = 0; } while (0)
	34
70a3c167 JG	35	static int bcm63xx_detect_cfe(struct mtd_info *master)
70a3c167 JG	36	{
70a3c167 JG	37	char buf[9];
	38	int ret;
	39	size_t retlen;
	40
329ad399 AB	41	ret = mtd_read(master, BCM963XX_CFE_VERSION_OFFSET, 5, &retlen,
329ad399 AB	42	(void *)buf);
f2d9739b JG	43	buf[retlen] = 0;
	44
	45	if (ret)
	46	return ret;
	47
	48	if (strncmp("cfe-v", buf, 5) == 0)
	49	return 0;
	50
	51	/* very old CFE's do not have the cfe-v string, so check for magic */
436e94a6	52	ret = mtd_read(master, BCM963XX_CFE_MAGIC_OFFSET, 8, &retlen,
329ad399	53	(void *)buf);
70a3c167	54	buf[retlen] = 0;
70a3c167	55
f2d9739b	56	return strncmp("CFE1CFE1", buf, 8);
70a3c167 JG	57	}
70a3c167 JG	58
436e94a6 SA	59	static int bcm63xx_read_nvram(struct mtd_info *master,
	60	struct bcm963xx_nvram *nvram)
	61	{
	62	u32 actual_crc, expected_crc;
	63	size_t retlen;
	64	int ret;
	65
	66	/* extract nvram data */
	67	ret = mtd_read(master, BCM963XX_NVRAM_OFFSET, BCM963XX_NVRAM_V5_SIZE,
	68	&retlen, (void *)nvram);
	69	if (ret)
	70	return ret;
	71
	72	ret = bcm963xx_nvram_checksum(nvram, &expected_crc, &actual_crc);
	73	if (ret)
	74	pr_warn("nvram checksum failed, contents may be invalid (expected %08x, got %08x)\n",
	75	expected_crc, actual_crc);
	76
	77	if (!nvram->psi_size)
	78	nvram->psi_size = BCM963XX_DEFAULT_PSI_SIZE;
	79
	80	return 0;
	81	}
	82
dd84cb02 JG	83	static const char * const bcm63xx_cfe_part_types[] = {
	84	"bcm963xx-imagetag",
	85	NULL,
	86	};
7fffa694	87
4110fdd2 SA	88	static int bcm63xx_parse_cfe_nor_partitions(struct mtd_info *master,
4110fdd2 SA	89	const struct mtd_partition *pparts, struct bcm963xx_nvram nvram)
70a3c167	90	{
70a3c167	91	struct mtd_partition *parts;
dd84cb02	92	int nrparts = 3, curpart = 0;
678eb9bb	93	unsigned int cfelen, nvramlen;
4e4fb639	94	unsigned int cfe_erasesize;
70a3c167	95	int i;
70a3c167	96
4e4fb639	97	cfe_erasesize = max_t(uint32_t, master->erasesize,
436e94a6	98	BCM963XX_CFE_BLOCK_SIZE);
4e4fb639 JG	99
4e4fb639 JG	100	cfelen = cfe_erasesize;
436e94a6	101	nvramlen = nvram->psi_size * SZ_1K;
d085eea1	102	nvramlen = roundup(nvramlen, cfe_erasesize);
678eb9bb	103
70a3c167	104	parts = kzalloc(sizeof(parts) nrparts + 10 * nrparts, GFP_KERNEL);
dd84cb02 JG	105	if (!parts)
dd84cb02 JG	106	return -ENOMEM;
70a3c167 JG	107
	108	/* Start building partition list */
	109	parts[curpart].name = "CFE";
	110	parts[curpart].offset = 0;
678eb9bb	111	parts[curpart].size = cfelen;
70a3c167 JG	112	curpart++;
70a3c167 JG	113
70a3c167	114	parts[curpart].name = "nvram";
678eb9bb JG	115	parts[curpart].offset = master->size - nvramlen;
678eb9bb JG	116	parts[curpart].size = nvramlen;
f3f9a5da	117	curpart++;
70a3c167 JG	118
70a3c167 JG	119	/* Global partition "linux" to make easy firmware upgrade */
70a3c167	120	parts[curpart].name = "linux";
327c62c5 JG	121	parts[curpart].offset = cfelen;
327c62c5 JG	122	parts[curpart].size = master->size - cfelen - nvramlen;
dd84cb02	123	parts[curpart].types = bcm63xx_cfe_part_types;
70a3c167 JG	124
70a3c167 JG	125	for (i = 0; i < nrparts; i++)
60768368 JG	126	pr_info("Partition %d is %s offset %llx and length %llx\n", i,
60768368 JG	127	parts[i].name, parts[i].offset, parts[i].size);
70a3c167	128
70a3c167	129	*pparts = parts;
436e94a6	130
70a3c167	131	return nrparts;
4110fdd2 SA	132	}
	133
	134	static int bcm63xx_parse_cfe_partitions(struct mtd_info *master,
	135	const struct mtd_partition **pparts,
	136	struct mtd_part_parser_data *data)
	137	{
	138	struct bcm963xx_nvram *nvram = NULL;
	139	int ret;
	140
	141	if (bcm63xx_detect_cfe(master))
	142	return -EINVAL;
	143
	144	nvram = vzalloc(sizeof(*nvram));
	145	if (!nvram)
	146	return -ENOMEM;
	147
	148	ret = bcm63xx_read_nvram(master, nvram);
	149	if (ret)
	150	goto out;
	151
	152	if (!mtd_type_is_nand(master))
	153	ret = bcm63xx_parse_cfe_nor_partitions(master, pparts, nvram);
	154	else
	155	ret = -EINVAL;
	156
	157	out:
	158	vfree(nvram);
	159	return ret;
70a3c167 JG	160	};
70a3c167 JG	161
e651de47 JG	162	static const struct of_device_id parse_bcm63xx_cfe_match_table[] = {
	163	{ .compatible = "brcm,bcm963xx-cfe-nor-partitions" },
	164	{},
	165	};
	166	MODULE_DEVICE_TABLE(of, parse_bcm63xx_cfe_match_table);
	167
70a3c167	168	static struct mtd_part_parser bcm63xx_cfe_parser = {
70a3c167 JG	169	.parse_fn = bcm63xx_parse_cfe_partitions,
70a3c167 JG	170	.name = "bcm63xxpart",
e651de47	171	.of_match_table = parse_bcm63xx_cfe_match_table,
70a3c167	172	};
b8f70bad	173	module_mtd_part_parser(bcm63xx_cfe_parser);
70a3c167 JG	174
	175	MODULE_LICENSE("GPL");
	176	MODULE_AUTHOR("Daniel Dickinson <openwrt@cshore.neomailbox.net>");
	177	MODULE_AUTHOR("Florian Fainelli <florian@openwrt.org>");
	178	MODULE_AUTHOR("Mike Albon <malbon@openwrt.org>");
	179	MODULE_AUTHOR("Jonas Gorski <jonas.gorski@gmail.com");
	180	MODULE_DESCRIPTION("MTD partitioning for BCM63XX CFE bootloaders");