target/linux/generic/files/block/partitions/fit.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  *  fs/partitions/fit.c
   4  *  Copyright (C) 2021  Daniel Golle
   5  *
   6  *  headers extracted from U-Boot mkimage sources
   7  *  (C) Copyright 2008 Semihalf
   8  *  (C) Copyright 2000-2005
   9  *  Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  10  *
  11  *  based on existing partition parsers
  12  *  Copyright (C) 1991-1998  Linus Torvalds
  13  *  Re-organised Feb 1998 Russell King
  14  */
  15
  16 #define pr_fmt(fmt) fmt
  17
  18 #include <linux/types.h>
  19 #include <linux/of.h>
  20 #include <linux/of_device.h>
  21 #include <linux/of_fdt.h>
  22 #include <linux/libfdt.h>
  23 #include <linux/version.h>
  24
  25 #include "check.h"
  26
  27 #define FIT_IMAGES_PATH         "/images"
  28 #define FIT_CONFS_PATH          "/configurations"
  29
  30 /* hash/signature/key node */
  31 #define FIT_HASH_NODENAME       "hash"
  32 #define FIT_ALGO_PROP           "algo"
  33 #define FIT_VALUE_PROP          "value"
  34 #define FIT_IGNORE_PROP         "uboot-ignore"
  35 #define FIT_SIG_NODENAME        "signature"
  36 #define FIT_KEY_REQUIRED        "required"
  37 #define FIT_KEY_HINT            "key-name-hint"
  38
  39 /* cipher node */
  40 #define FIT_CIPHER_NODENAME     "cipher"
  41 #define FIT_ALGO_PROP           "algo"
  42
  43 /* image node */
  44 #define FIT_DATA_PROP           "data"
  45 #define FIT_DATA_POSITION_PROP  "data-position"
  46 #define FIT_DATA_OFFSET_PROP    "data-offset"
  47 #define FIT_DATA_SIZE_PROP      "data-size"
  48 #define FIT_TIMESTAMP_PROP      "timestamp"
  49 #define FIT_DESC_PROP           "description"
  50 #define FIT_ARCH_PROP           "arch"
  51 #define FIT_TYPE_PROP           "type"
  52 #define FIT_OS_PROP             "os"
  53 #define FIT_COMP_PROP           "compression"
  54 #define FIT_ENTRY_PROP          "entry"
  55 #define FIT_LOAD_PROP           "load"
  56
  57 /* configuration node */
  58 #define FIT_KERNEL_PROP         "kernel"
  59 #define FIT_FILESYSTEM_PROP     "filesystem"
  60 #define FIT_RAMDISK_PROP        "ramdisk"
  61 #define FIT_FDT_PROP            "fdt"
  62 #define FIT_LOADABLE_PROP       "loadables"
  63 #define FIT_DEFAULT_PROP        "default"
  64 #define FIT_SETUP_PROP          "setup"
  65 #define FIT_FPGA_PROP           "fpga"
  66 #define FIT_FIRMWARE_PROP       "firmware"
  67 #define FIT_STANDALONE_PROP     "standalone"
  68
  69 #define FIT_MAX_HASH_LEN        HASH_MAX_DIGEST_SIZE
  70
  71 #define MIN_FREE_SECT           16
  72 #define REMAIN_VOLNAME          "rootfs_data"
  73
  74 int parse_fit_partitions(struct parsed_partitions *state, u64 fit_start_sector, u64 sectors, int *slot, int add_remain)
  75 {
  76         struct block_device *bdev = state->disk->part0;
  77         struct address_space *mapping = bdev->bd_inode->i_mapping;
  78         struct page *page;
  79         void *fit, *init_fit;
  80         struct partition_meta_info *info;
  81         char tmp[sizeof(info->volname)];
  82         u64 dsize, dsectors, imgmaxsect = 0;
  83         u32 size, image_pos, image_len;
  84         const u32 *image_offset_be, *image_len_be, *image_pos_be;
  85         int ret = 1, node, images, config;
  86         const char *image_name, *image_type, *image_description, *config_default,
  87                 *config_description, *config_loadables;
  88         int image_name_len, image_type_len, image_description_len, config_default_len,
  89                 config_description_len, config_loadables_len;
  90         sector_t start_sect, nr_sects;
  91         size_t label_min;
  92         struct device_node *np = NULL;
  93         const char *bootconf;
  94         const char *loadable;
  95         const char *select_rootfs = NULL;
  96         bool found;
  97         int loadables_rem_len, loadable_len;
  98
  99         if (fit_start_sector % (1<<(PAGE_SHIFT - SECTOR_SHIFT)))
 100                 return -ERANGE;
 101
 102         page = read_mapping_page(mapping, fit_start_sector >> (PAGE_SHIFT - SECTOR_SHIFT), NULL);
 103         if (IS_ERR(page))
 104                 return -EFAULT;
 105
 106         if (PageError(page))
 107                 return -EFAULT;
 108
 109         init_fit = page_address(page);
 110
 111         if (!init_fit) {
 112                 put_page(page);
 113                 return -EFAULT;
 114         }
 115
 116         if (fdt_check_header(init_fit)) {
 117                 put_page(page);
 118                 return 0;
 119         }
 120
 121         dsectors = get_capacity(bdev->bd_disk);
 122         if (sectors)
 123                 dsectors = (dsectors>sectors)?sectors:dsectors;
 124
 125         dsize = dsectors << SECTOR_SHIFT;
 126         size = fdt_totalsize(init_fit);
 127
 128         /* silently skip non-external-data legacy FIT images */
 129         if (size > PAGE_SIZE) {
 130                 put_page(page);
 131                 return 0;
 132         }
 133
 134         if (size >= dsize) {
 135                 state->access_beyond_eod = 1;
 136                 put_page(page);
 137                 return -EFBIG;
 138         }
 139
 140         fit = kmemdup(init_fit, size, GFP_KERNEL);
 141         put_page(page);
 142         if (!fit)
 143                 return -ENOMEM;
 144
 145         np = of_find_node_by_path("/chosen");
 146         if (np)
 147                 bootconf = of_get_property(np, "u-boot,bootconf", NULL);
 148         else
 149                 bootconf = NULL;
 150
 151         config = fdt_path_offset(fit, FIT_CONFS_PATH);
 152         if (config < 0) {
 153                 printk(KERN_ERR "FIT: Cannot find %s node: %d\n", FIT_CONFS_PATH, images);
 154                 ret = -ENOENT;
 155                 goto ret_out;
 156         }
 157
 158         config_default = fdt_getprop(fit, config, FIT_DEFAULT_PROP, &config_default_len);
 159
 160         if (!config_default && !bootconf) {
 161                 printk(KERN_ERR "FIT: Cannot find default configuration\n");
 162                 ret = -ENOENT;
 163                 goto ret_out;
 164         }
 165
 166         node = fdt_subnode_offset(fit, config, bootconf?:config_default);
 167         if (node < 0) {
 168                 printk(KERN_ERR "FIT: Cannot find %s node: %d\n", bootconf?:config_default, node);
 169                 ret = -ENOENT;
 170                 goto ret_out;
 171         }
 172
 173         config_description = fdt_getprop(fit, node, FIT_DESC_PROP, &config_description_len);
 174         config_loadables = fdt_getprop(fit, node, FIT_LOADABLE_PROP, &config_loadables_len);
 175
 176         printk(KERN_DEBUG "FIT: %s configuration: \"%s\"%s%s%s\n",
 177                 bootconf?"Selected":"Default", bootconf?:config_default,
 178                 config_description?" (":"", config_description?:"", config_description?")":"");
 179
 180         if (!config_loadables || !config_loadables_len) {
 181                 printk(KERN_ERR "FIT: No loadables configured in \"%s\"\n", bootconf?:config_default);
 182                 ret = -ENOENT;
 183                 goto ret_out;
 184         }
 185
 186         images = fdt_path_offset(fit, FIT_IMAGES_PATH);
 187         if (images < 0) {
 188                 printk(KERN_ERR "FIT: Cannot find %s node: %d\n", FIT_IMAGES_PATH, images);
 189                 ret = -EINVAL;
 190                 goto ret_out;
 191         }
 192
 193         fdt_for_each_subnode(node, fit, images) {
 194                 image_name = fdt_get_name(fit, node, &image_name_len);
 195                 image_type = fdt_getprop(fit, node, FIT_TYPE_PROP, &image_type_len);
 196                 image_offset_be = fdt_getprop(fit, node, FIT_DATA_OFFSET_PROP, NULL);
 197                 image_pos_be = fdt_getprop(fit, node, FIT_DATA_POSITION_PROP, NULL);
 198                 image_len_be = fdt_getprop(fit, node, FIT_DATA_SIZE_PROP, NULL);
 199                 if (!image_name || !image_type || !image_len_be)
 200                         continue;
 201
 202                 image_len = be32_to_cpu(*image_len_be);
 203                 if (!image_len)
 204                         continue;
 205
 206                 if (image_offset_be)
 207                         image_pos = be32_to_cpu(*image_offset_be) + size;
 208                 else if (image_pos_be)
 209                         image_pos = be32_to_cpu(*image_pos_be);
 210                 else
 211                         continue;
 212
 213                 image_description = fdt_getprop(fit, node, FIT_DESC_PROP, &image_description_len);
 214
 215                 printk(KERN_DEBUG "FIT: %16s sub-image 0x%08x..0x%08x \"%s\" %s%s%s\n",
 216                         image_type, image_pos, image_pos + image_len - 1, image_name,
 217                         image_description?"(":"", image_description?:"", image_description?") ":"");
 218
 219                 if (strcmp(image_type, FIT_FILESYSTEM_PROP))
 220                         continue;
 221
 222                 /* check if sub-image is part of configured loadables */
 223                 found = false;
 224                 loadable = config_loadables;
 225                 loadables_rem_len = config_loadables_len;
 226                 while (loadables_rem_len > 1) {
 227                         loadable_len = strnlen(loadable, loadables_rem_len - 1) + 1;
 228                         loadables_rem_len -= loadable_len;
 229                         if (!strncmp(image_name, loadable, loadable_len)) {
 230                                 found = true;
 231                                 break;
 232                         }
 233                         loadable += loadable_len;
 234                 }
 235                 if (!found)
 236                         continue;
 237
 238                 if (image_pos & ((1 << PAGE_SHIFT)-1)) {
 239                         printk(KERN_ERR "FIT: image %s start not aligned to page boundaries, skipping\n", image_name);
 240                         continue;
 241                 }
 242
 243                 if (image_len & ((1 << PAGE_SHIFT)-1)) {
 244                         printk(KERN_ERR "FIT: sub-image %s end not aligned to page boundaries, skipping\n", image_name);
 245                         continue;
 246                 }
 247
 248                 start_sect = image_pos >> SECTOR_SHIFT;
 249                 nr_sects = image_len >> SECTOR_SHIFT;
 250                 imgmaxsect = (imgmaxsect < (start_sect + nr_sects))?(start_sect + nr_sects):imgmaxsect;
 251
 252                 if (start_sect + nr_sects > dsectors) {
 253                         state->access_beyond_eod = 1;
 254                         continue;
 255                 }
 256
 257                 put_partition(state, ++(*slot), fit_start_sector + start_sect, nr_sects);
 258                 state->parts[*slot].flags = ADDPART_FLAG_READONLY;
 259                 state->parts[*slot].has_info = true;
 260                 info = &state->parts[*slot].info;
 261
 262                 label_min = min_t(int, sizeof(info->volname) - 1, image_name_len);
 263                 strncpy(info->volname, image_name, label_min);
 264                 info->volname[label_min] = '\0';
 265
 266                 snprintf(tmp, sizeof(tmp), "(%s)", info->volname);
 267                 strlcat(state->pp_buf, tmp, PAGE_SIZE);
 268
 269                 /* Mark first loadable listed to be mounted as rootfs */
 270                 if (!strcmp(image_name, config_loadables)) {
 271                         select_rootfs = image_name;
 272                         state->parts[*slot].flags |= ADDPART_FLAG_ROOTDEV;
 273                 }
 274         }
 275
 276         if (select_rootfs)
 277                 printk(KERN_DEBUG "FIT: selecting configured loadable \"%s\" to be root filesystem\n", select_rootfs);
 278
 279         if (add_remain && (imgmaxsect + MIN_FREE_SECT) < dsectors) {
 280                 put_partition(state, ++(*slot), fit_start_sector + imgmaxsect, dsectors - imgmaxsect);
 281                 state->parts[*slot].flags = 0;
 282                 info = &state->parts[*slot].info;
 283                 strcpy(info->volname, REMAIN_VOLNAME);
 284                 snprintf(tmp, sizeof(tmp), "(%s)", REMAIN_VOLNAME);
 285                 strlcat(state->pp_buf, tmp, PAGE_SIZE);
 286         }
 287 ret_out:
 288         kfree(fit);
 289         return ret;
 290 }
 291
 292 int fit_partition(struct parsed_partitions *state) {
 293         int slot = 0;
 294         return parse_fit_partitions(state, 0, 0, &slot, 0);
 295 }