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