target/linux/generic/files/drivers/mtd/mtdsplit/mtdsplit_bcm_wfi.c

   1 /*
   2  * MTD split for Broadcom Whole Flash Image
   3  *
   4  * Copyright (C) 2020 Álvaro Fernández Rojas <noltari@gmail.com>
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License version 2 as published
   8  * by the Free Software Foundation.
   9  *
  10  */
  11
  12 #define je16_to_cpu(x) ((x).v16)
  13 #define je32_to_cpu(x) ((x).v32)
  14
  15 #include <linux/crc32.h>
  16 #include <linux/init.h>
  17 #include <linux/jffs2.h>
  18 #include <linux/kernel.h>
  19 #include <linux/module.h>
  20 #include <linux/slab.h>
  21 #include <linux/byteorder/generic.h>
  22 #include <linux/mtd/mtd.h>
  23 #include <linux/mtd/partitions.h>
  24
  25 #include "mtdsplit.h"
  26
  27 #define BCM_WFI_PARTS           3
  28
  29 #define CFERAM_NAME             "cferam"
  30 #define CFERAM_NAME_LEN         (sizeof(CFERAM_NAME) - 1)
  31 #define KERNEL_NAME             "vmlinux.lz"
  32 #define KERNEL_NAME_LEN         (sizeof(KERNEL_NAME) - 1)
  33 #define OPENWRT_NAME            "1-openwrt"
  34 #define OPENWRT_NAME_LEN        (sizeof(OPENWRT_NAME) - 1)
  35
  36 #define UBI_MAGIC               0x55424923
  37
  38 static u32 jffs2_dirent_crc(struct jffs2_raw_dirent *node)
  39 {
  40         return crc32(0, node, sizeof(struct jffs2_raw_dirent) - 8);
  41 }
  42
  43 static bool jffs2_dirent_valid(struct jffs2_raw_dirent *node)
  44 {
  45         return ((je16_to_cpu(node->magic) == JFFS2_MAGIC_BITMASK) &&
  46                 (je16_to_cpu(node->nodetype) == JFFS2_NODETYPE_DIRENT) &&
  47                 je32_to_cpu(node->ino) &&
  48                 je32_to_cpu(node->node_crc) == jffs2_dirent_crc(node));
  49 }
  50
  51 static int jffs2_find_file(struct mtd_info *master, uint8_t *buf,
  52                            const char *name, size_t name_len,
  53                            loff_t *offs)
  54 {
  55         struct jffs2_raw_dirent *node;
  56         bool valid = false;
  57         size_t retlen;
  58         uint16_t magic;
  59         int rc;
  60
  61         for (; *offs < master->size; *offs += master->erasesize) {
  62                 unsigned int block_offs = 0;
  63
  64                 /* Skip CFE erased blocks */
  65                 rc = mtd_read(master, *offs, sizeof(magic), &retlen,
  66                               (void *) &magic);
  67                 if (rc || retlen != sizeof(magic)) {
  68                         continue;
  69                 }
  70
  71                 /* Skip blocks not starting with JFFS2 magic */
  72                 if (magic != JFFS2_MAGIC_BITMASK)
  73                         continue;
  74
  75                 /* Read full block */
  76                 rc = mtd_read(master, *offs, master->erasesize, &retlen,
  77                               (void *) buf);
  78                 if (rc)
  79                         return rc;
  80                 if (retlen != master->erasesize)
  81                         return -EINVAL;
  82
  83                 while (block_offs < master->erasesize) {
  84                         node = (struct jffs2_raw_dirent *) &buf[block_offs];
  85
  86                         if (!jffs2_dirent_valid(node)) {
  87                                 block_offs += 4;
  88                                 continue;
  89                         }
  90
  91                         if (!memcmp(node->name, OPENWRT_NAME,
  92                                     OPENWRT_NAME_LEN))
  93                                 valid = true;
  94                         else if (!memcmp(node->name, name, name_len))
  95                                 return valid ? 0 : -EINVAL;
  96
  97                         block_offs += je32_to_cpu(node->totlen);
  98                         block_offs = (block_offs + 0x3) & ~0x3;
  99                 }
 100         }
 101
 102         return -ENOENT;
 103 }
 104
 105 static int ubifs_find(struct mtd_info *master, loff_t *offs)
 106 {
 107         uint32_t magic;
 108         size_t retlen;
 109         int rc;
 110
 111         for (; *offs < master->size; *offs += master->erasesize) {
 112                 rc = mtd_read(master, *offs, sizeof(magic), &retlen,
 113                               (unsigned char *) &magic);
 114                 if (rc || retlen != sizeof(magic))
 115                         continue;
 116
 117                 if (be32_to_cpu(magic) == UBI_MAGIC)
 118                         return 0;
 119         }
 120
 121         return -ENOENT;
 122 }
 123
 124 static int mtdsplit_parse_bcm_wfi(struct mtd_info *master,
 125                                   const struct mtd_partition **pparts,
 126                                   struct mtd_part_parser_data *data)
 127 {
 128         struct mtd_partition *parts;
 129         struct device_node *mtd_node;
 130         loff_t cfe_off, kernel_off, rootfs_off;
 131         bool cfe_part = true;
 132         unsigned int num_parts = BCM_WFI_PARTS, cur_part = 0;
 133         uint8_t *buf;
 134         int ret;
 135
 136         buf = kzalloc(master->erasesize, GFP_KERNEL);
 137         if (!buf)
 138                 return -ENOMEM;
 139
 140         mtd_node = mtd_get_of_node(master);
 141         if (!mtd_node)
 142                 return -EINVAL;
 143
 144         if (of_device_is_compatible(mtd_node, "brcm,wfi-sercomm"))
 145                 cfe_part = false;
 146
 147         if (cfe_part) {
 148                 num_parts++;
 149                 cfe_off = 0;
 150
 151                 ret = jffs2_find_file(master, buf, CFERAM_NAME,
 152                                       CFERAM_NAME_LEN, &cfe_off);
 153                 if (ret) {
 154                         kfree(buf);
 155                         return ret;
 156                 }
 157
 158                 kernel_off = cfe_off + master->erasesize;
 159         } else {
 160                 kernel_off = 0;
 161         }
 162
 163         ret = jffs2_find_file(master, buf, KERNEL_NAME, KERNEL_NAME_LEN,
 164                               &kernel_off);
 165         kfree(buf);
 166         if (ret)
 167                 return ret;
 168
 169         rootfs_off = kernel_off + master->erasesize;
 170         ret = ubifs_find(master, &rootfs_off);
 171         if (ret)
 172                 return ret;
 173
 174         parts = kzalloc(num_parts * sizeof(*parts), GFP_KERNEL);
 175         if (!parts)
 176                 return -ENOMEM;
 177
 178         if (cfe_part) {
 179                 parts[cur_part].name = "cferam";
 180                 parts[cur_part].mask_flags = MTD_WRITEABLE;
 181                 parts[cur_part].offset = 0;
 182                 parts[cur_part].size = kernel_off;
 183                 cur_part++;
 184         }
 185
 186         parts[cur_part].name = "firmware";
 187         parts[cur_part].offset = kernel_off;
 188         parts[cur_part].size = master->size - kernel_off;
 189         cur_part++;
 190
 191         parts[cur_part].name = KERNEL_PART_NAME;
 192         parts[cur_part].offset = kernel_off;
 193         parts[cur_part].size = rootfs_off - kernel_off;
 194         cur_part++;
 195
 196         parts[cur_part].name = UBI_PART_NAME;
 197         parts[cur_part].offset = rootfs_off;
 198         parts[cur_part].size = master->size - rootfs_off;
 199         cur_part++;
 200
 201         *pparts = parts;
 202
 203         return num_parts;
 204 }
 205
 206 static const struct of_device_id mtdsplit_fit_of_match_table[] = {
 207         { .compatible = "brcm,wfi" },
 208         { .compatible = "brcm,wfi-sercomm" },
 209         { },
 210 };
 211
 212 static struct mtd_part_parser mtdsplit_bcm_wfi_parser = {
 213         .owner = THIS_MODULE,
 214         .name = "bcm-wfi-fw",
 215         .of_match_table = mtdsplit_fit_of_match_table,
 216         .parse_fn = mtdsplit_parse_bcm_wfi,
 217         .type = MTD_PARSER_TYPE_FIRMWARE,
 218 };
 219
 220 static int __init mtdsplit_bcm_wfi_init(void)
 221 {
 222         register_mtd_parser(&mtdsplit_bcm_wfi_parser);
 223
 224         return 0;
 225 }
 226
 227 module_init(mtdsplit_bcm_wfi_init);