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