drivers/mtd/parsers/redboot.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  * Parse RedBoot-style Flash Image System (FIS) tables and
   4  * produce a Linux partition array to match.
   5  *
   6  * Copyright © 2001      Red Hat UK Limited
   7  * Copyright © 2001-2010 David Woodhouse <dwmw2@infradead.org>
   8  */
   9
  10 #include <linux/kernel.h>
  11 #include <linux/slab.h>
  12 #include <linux/init.h>
  13 #include <linux/vmalloc.h>
  14 #include <linux/of.h>
  15 #include <linux/mtd/mtd.h>
  16 #include <linux/mtd/partitions.h>
  17 #include <linux/module.h>
  18
  19 struct fis_image_desc {
  20     unsigned char name[16];      // Null terminated name
  21     uint32_t      flash_base;    // Address within FLASH of image
  22     uint32_t      mem_base;      // Address in memory where it executes
  23     uint32_t      size;          // Length of image
  24     uint32_t      entry_point;   // Execution entry point
  25     uint32_t      data_length;   // Length of actual data
  26     unsigned char _pad[256-(16+7*sizeof(uint32_t))];
  27     uint32_t      desc_cksum;    // Checksum over image descriptor
  28     uint32_t      file_cksum;    // Checksum over image data
  29 };
  30
  31 struct fis_list {
  32         struct fis_image_desc *img;
  33         struct fis_list *next;
  34 };
  35
  36 static int directory = CONFIG_MTD_REDBOOT_DIRECTORY_BLOCK;
  37 module_param(directory, int, 0);
  38
  39 static inline int redboot_checksum(struct fis_image_desc *img)
  40 {
  41         /* RedBoot doesn't actually write the desc_cksum field yet AFAICT */
  42         return 1;
  43 }
  44
  45 static void parse_redboot_of(struct mtd_info *master)
  46 {
  47         struct device_node *np;
  48         struct device_node *npart;
  49         u32 dirblock;
  50         int ret;
  51
  52         np = mtd_get_of_node(master);
  53         if (!np)
  54                 return;
  55
  56         npart = of_get_child_by_name(np, "partitions");
  57         if (!npart)
  58                 return;
  59
  60         ret = of_property_read_u32(npart, "fis-index-block", &dirblock);
  61         if (ret)
  62                 return;
  63
  64         /*
  65          * Assign the block found in the device tree to the local
  66          * directory block pointer.
  67          */
  68         directory = dirblock;
  69 }
  70
  71 static int parse_redboot_partitions(struct mtd_info *master,
  72                                     const struct mtd_partition **pparts,
  73                                     struct mtd_part_parser_data *data)
  74 {
  75         int nrparts = 0;
  76         struct fis_image_desc *buf;
  77         struct mtd_partition *parts;
  78         struct fis_list *fl = NULL, *tmp_fl;
  79         int ret, i;
  80         size_t retlen;
  81         char *names;
  82         char *nullname;
  83         int namelen = 0;
  84         int nulllen = 0;
  85         int numslots;
  86         unsigned long offset;
  87 #ifdef CONFIG_MTD_REDBOOT_PARTS_UNALLOCATED
  88         static char nullstring[] = "unallocated";
  89 #endif
  90
  91         parse_redboot_of(master);
  92
  93         if ( directory < 0 ) {
  94                 offset = master->size + directory * master->erasesize;
  95                 while (mtd_block_isbad(master, offset)) {
  96                         if (!offset) {
  97                         nogood:
  98                                 printk(KERN_NOTICE "Failed to find a non-bad block to check for RedBoot partition table\n");
  99                                 return -EIO;
 100                         }
 101                         offset -= master->erasesize;
 102                 }
 103         } else {
 104                 offset = directory * master->erasesize;
 105                 while (mtd_block_isbad(master, offset)) {
 106                         offset += master->erasesize;
 107                         if (offset == master->size)
 108                                 goto nogood;
 109                 }
 110         }
 111         buf = vmalloc(master->erasesize);
 112
 113         if (!buf)
 114                 return -ENOMEM;
 115
 116         printk(KERN_NOTICE "Searching for RedBoot partition table in %s at offset 0x%lx\n",
 117                master->name, offset);
 118
 119         ret = mtd_read(master, offset, master->erasesize, &retlen,
 120                        (void *)buf);
 121
 122         if (ret)
 123                 goto out;
 124
 125         if (retlen != master->erasesize) {
 126                 ret = -EIO;
 127                 goto out;
 128         }
 129
 130         numslots = (master->erasesize / sizeof(struct fis_image_desc));
 131         for (i = 0; i < numslots; i++) {
 132                 if (!memcmp(buf[i].name, "FIS directory", 14)) {
 133                         /* This is apparently the FIS directory entry for the
 134                          * FIS directory itself.  The FIS directory size is
 135                          * one erase block; if the buf[i].size field is
 136                          * swab32(erasesize) then we know we are looking at
 137                          * a byte swapped FIS directory - swap all the entries!
 138                          * (NOTE: this is 'size' not 'data_length'; size is
 139                          * the full size of the entry.)
 140                          */
 141
 142                         /* RedBoot can combine the FIS directory and
 143                            config partitions into a single eraseblock;
 144                            we assume wrong-endian if either the swapped
 145                            'size' matches the eraseblock size precisely,
 146                            or if the swapped size actually fits in an
 147                            eraseblock while the unswapped size doesn't. */
 148                         if (swab32(buf[i].size) == master->erasesize ||
 149                             (buf[i].size > master->erasesize
 150                              && swab32(buf[i].size) < master->erasesize)) {
 151                                 int j;
 152                                 /* Update numslots based on actual FIS directory size */
 153                                 numslots = swab32(buf[i].size) / sizeof (struct fis_image_desc);
 154                                 for (j = 0; j < numslots; ++j) {
 155
 156                                         /* A single 0xff denotes a deleted entry.
 157                                          * Two of them in a row is the end of the table.
 158                                          */
 159                                         if (buf[j].name[0] == 0xff) {
 160                                                 if (buf[j].name[1] == 0xff) {
 161                                                         break;
 162                                                 } else {
 163                                                         continue;
 164                                                 }
 165                                         }
 166
 167                                         /* The unsigned long fields were written with the
 168                                          * wrong byte sex, name and pad have no byte sex.
 169                                          */
 170                                         swab32s(&buf[j].flash_base);
 171                                         swab32s(&buf[j].mem_base);
 172                                         swab32s(&buf[j].size);
 173                                         swab32s(&buf[j].entry_point);
 174                                         swab32s(&buf[j].data_length);
 175                                         swab32s(&buf[j].desc_cksum);
 176                                         swab32s(&buf[j].file_cksum);
 177                                 }
 178                         } else if (buf[i].size < master->erasesize) {
 179                                 /* Update numslots based on actual FIS directory size */
 180                                 numslots = buf[i].size / sizeof(struct fis_image_desc);
 181                         }
 182                         break;
 183                 }
 184         }
 185         if (i == numslots) {
 186                 /* Didn't find it */
 187                 printk(KERN_NOTICE "No RedBoot partition table detected in %s\n",
 188                        master->name);
 189                 ret = 0;
 190                 goto out;
 191         }
 192
 193         for (i = 0; i < numslots; i++) {
 194                 struct fis_list *new_fl, **prev;
 195
 196                 if (buf[i].name[0] == 0xff) {
 197                         if (buf[i].name[1] == 0xff) {
 198                                 break;
 199                         } else {
 200                                 continue;
 201                         }
 202                 }
 203                 if (!redboot_checksum(&buf[i]))
 204                         break;
 205
 206                 new_fl = kmalloc(sizeof(struct fis_list), GFP_KERNEL);
 207                 namelen += strlen(buf[i].name)+1;
 208                 if (!new_fl) {
 209                         ret = -ENOMEM;
 210                         goto out;
 211                 }
 212                 new_fl->img = &buf[i];
 213                 if (data && data->origin)
 214                         buf[i].flash_base -= data->origin;
 215                 else
 216                         buf[i].flash_base &= master->size-1;
 217
 218                 /* I'm sure the JFFS2 code has done me permanent damage.
 219                  * I now think the following is _normal_
 220                  */
 221                 prev = &fl;
 222                 while(*prev && (*prev)->img->flash_base < new_fl->img->flash_base)
 223                         prev = &(*prev)->next;
 224                 new_fl->next = *prev;
 225                 *prev = new_fl;
 226
 227                 nrparts++;
 228         }
 229 #ifdef CONFIG_MTD_REDBOOT_PARTS_UNALLOCATED
 230         if (fl->img->flash_base) {
 231                 nrparts++;
 232                 nulllen = sizeof(nullstring);
 233         }
 234
 235         for (tmp_fl = fl; tmp_fl->next; tmp_fl = tmp_fl->next) {
 236                 if (tmp_fl->img->flash_base + tmp_fl->img->size + master->erasesize <= tmp_fl->next->img->flash_base) {
 237                         nrparts++;
 238                         nulllen = sizeof(nullstring);
 239                 }
 240         }
 241 #endif
 242         parts = kzalloc(sizeof(*parts)*nrparts + nulllen + namelen, GFP_KERNEL);
 243
 244         if (!parts) {
 245                 ret = -ENOMEM;
 246                 goto out;
 247         }
 248
 249         nullname = (char *)&parts[nrparts];
 250 #ifdef CONFIG_MTD_REDBOOT_PARTS_UNALLOCATED
 251         if (nulllen > 0) {
 252                 strcpy(nullname, nullstring);
 253         }
 254 #endif
 255         names = nullname + nulllen;
 256
 257         i=0;
 258
 259 #ifdef CONFIG_MTD_REDBOOT_PARTS_UNALLOCATED
 260         if (fl->img->flash_base) {
 261                parts[0].name = nullname;
 262                parts[0].size = fl->img->flash_base;
 263                parts[0].offset = 0;
 264                 i++;
 265         }
 266 #endif
 267         for ( ; i<nrparts; i++) {
 268                 parts[i].size = fl->img->size;
 269                 parts[i].offset = fl->img->flash_base;
 270                 parts[i].name = names;
 271
 272                 strcpy(names, fl->img->name);
 273 #ifdef CONFIG_MTD_REDBOOT_PARTS_READONLY
 274                 if (!memcmp(names, "RedBoot", 8) ||
 275                                 !memcmp(names, "RedBoot config", 15) ||
 276                                 !memcmp(names, "FIS directory", 14)) {
 277                         parts[i].mask_flags = MTD_WRITEABLE;
 278                 }
 279 #endif
 280                 names += strlen(names)+1;
 281
 282 #ifdef CONFIG_MTD_REDBOOT_PARTS_UNALLOCATED
 283                 if(fl->next && fl->img->flash_base + fl->img->size + master->erasesize <= fl->next->img->flash_base) {
 284                         i++;
 285                         parts[i].offset = parts[i-1].size + parts[i-1].offset;
 286                         parts[i].size = fl->next->img->flash_base - parts[i].offset;
 287                         parts[i].name = nullname;
 288                 }
 289 #endif
 290                 tmp_fl = fl;
 291                 fl = fl->next;
 292                 kfree(tmp_fl);
 293         }
 294         ret = nrparts;
 295         *pparts = parts;
 296  out:
 297         while (fl) {
 298                 struct fis_list *old = fl;
 299                 fl = fl->next;
 300                 kfree(old);
 301         }
 302         vfree(buf);
 303         return ret;
 304 }
 305
 306 static const struct of_device_id mtd_parser_redboot_of_match_table[] = {
 307         { .compatible = "redboot-fis" },
 308         {},
 309 };
 310 MODULE_DEVICE_TABLE(of, mtd_parser_redboot_of_match_table);
 311
 312 static struct mtd_part_parser redboot_parser = {
 313         .parse_fn = parse_redboot_partitions,
 314         .name = "RedBoot",
 315         .of_match_table = mtd_parser_redboot_of_match_table,
 316 };
 317 module_mtd_part_parser(redboot_parser);
 318
 319 /* mtd parsers will request the module by parser name */
 320 MODULE_ALIAS("RedBoot");
 321 MODULE_LICENSE("GPL");
 322 MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
 323 MODULE_DESCRIPTION("Parsing code for RedBoot Flash Image System (FIS) tables");