tools/default_image.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2008 Semihalf
   4  *
   5  * (C) Copyright 2000-2004
   6  * DENX Software Engineering
   7  * Wolfgang Denk, wd@denx.de
   8  *
   9  * Updated-by: Prafulla Wadaskar <prafulla@marvell.com>
  10  *              default_image specific code abstracted from mkimage.c
  11  *              some functions added to address abstraction
  12  *
  13  * All rights reserved.
  14  */
  15
  16 #include "imagetool.h"
  17 #include "mkimage.h"
  18 #include <u-boot/crc.h>
  19
  20 #include <image.h>
  21 #include <tee/optee.h>
  22 #include <u-boot/crc.h>
  23 #include <imximage.h>
  24
  25 static struct legacy_img_hdr header;
  26
  27 static int image_check_image_types(uint8_t type)
  28 {
  29         if (((type > IH_TYPE_INVALID) && (type < IH_TYPE_FLATDT)) ||
  30             (type == IH_TYPE_KERNEL_NOLOAD) || (type == IH_TYPE_FIRMWARE_IVT) ||
  31             (type == IH_TYPE_FDT_LEGACY))
  32                 return EXIT_SUCCESS;
  33         else
  34                 return EXIT_FAILURE;
  35 }
  36
  37 static int image_check_params(struct image_tool_params *params)
  38 {
  39         return  ((params->dflag && (params->fflag || params->lflag)) ||
  40                 (params->fflag && (params->dflag || params->lflag)) ||
  41                 (params->lflag && (params->dflag || params->fflag)));
  42 }
  43
  44 static int image_verify_header(unsigned char *ptr, int image_size,
  45                         struct image_tool_params *params)
  46 {
  47         uint32_t len;
  48         const unsigned char *data;
  49         uint32_t checksum;
  50         struct legacy_img_hdr header;
  51         struct legacy_img_hdr *hdr = &header;
  52
  53         if (image_size < sizeof(struct legacy_img_hdr)) {
  54                 debug("%s: Bad image size: \"%s\" is no valid image\n",
  55                       params->cmdname, params->imagefile);
  56                 return -FDT_ERR_BADSTRUCTURE;
  57         }
  58
  59         /*
  60          * create copy of header so that we can blank out the
  61          * checksum field for checking - this can't be done
  62          * on the PROT_READ mapped data.
  63          */
  64         memcpy(hdr, ptr, sizeof(struct legacy_img_hdr));
  65
  66         if (be32_to_cpu(hdr->ih_magic) != IH_MAGIC) {
  67                 debug("%s: Bad Magic Number: \"%s\" is no valid image\n",
  68                       params->cmdname, params->imagefile);
  69                 return -FDT_ERR_BADMAGIC;
  70         }
  71
  72         data = (const unsigned char *)hdr;
  73         len  = sizeof(struct legacy_img_hdr);
  74
  75         checksum = be32_to_cpu(hdr->ih_hcrc);
  76         hdr->ih_hcrc = cpu_to_be32(0);  /* clear for re-calculation */
  77
  78         if (crc32(0, data, len) != checksum) {
  79                 debug("%s: ERROR: \"%s\" has bad header checksum!\n",
  80                       params->cmdname, params->imagefile);
  81                 return -FDT_ERR_BADSTATE;
  82         }
  83
  84         data = (const unsigned char *)ptr + sizeof(struct legacy_img_hdr);
  85         len = image_get_data_size(hdr);
  86
  87         if (image_get_type(hdr) == IH_TYPE_FIRMWARE_IVT)
  88                 /* Add size of CSF minus IVT */
  89                 len -= 0x2060 - sizeof(flash_header_v2_t);
  90
  91         if (image_size - sizeof(struct legacy_img_hdr) < len) {
  92                 debug("%s: Bad image size: \"%s\" is no valid image\n",
  93                       params->cmdname, params->imagefile);
  94                 return -FDT_ERR_BADSTRUCTURE;
  95         }
  96
  97         checksum = be32_to_cpu(hdr->ih_dcrc);
  98         if (crc32(0, data, len) != checksum) {
  99                 debug("%s: ERROR: \"%s\" has corrupted data!\n",
 100                       params->cmdname, params->imagefile);
 101                 return -FDT_ERR_BADSTRUCTURE;
 102         }
 103         return 0;
 104 }
 105
 106 static void image_set_header(void *ptr, struct stat *sbuf, int ifd,
 107                                 struct image_tool_params *params)
 108 {
 109         uint32_t checksum;
 110         time_t time;
 111         uint32_t imagesize;
 112         uint32_t ep;
 113         uint32_t addr;
 114         int type;
 115         struct legacy_img_hdr *hdr = (struct legacy_img_hdr *)ptr;
 116
 117         checksum = crc32(0,
 118                         (const unsigned char *)(ptr +
 119                                 sizeof(struct legacy_img_hdr)),
 120                         sbuf->st_size - sizeof(struct legacy_img_hdr));
 121
 122         time = imagetool_get_source_date(params->cmdname, sbuf->st_mtime);
 123         ep = params->ep;
 124         addr = params->addr;
 125
 126         if (params->type == IH_TYPE_FIRMWARE_IVT)
 127                 /* Add size of CSF minus IVT */
 128                 imagesize = sbuf->st_size - sizeof(struct legacy_img_hdr)
 129                             + 0x2060 - sizeof(flash_header_v2_t);
 130
 131         else
 132                 imagesize = sbuf->st_size - sizeof(struct legacy_img_hdr);
 133
 134         if (params->type == IH_TYPE_FDT_LEGACY)
 135                 type = IH_TYPE_FLATDT;
 136         else
 137                 type = params->type;
 138
 139         if (params->os == IH_OS_TEE) {
 140                 addr = optee_image_get_load_addr(hdr);
 141                 ep = optee_image_get_entry_point(hdr);
 142         }
 143
 144         /* Build new header */
 145         image_set_magic(hdr, IH_MAGIC);
 146         image_set_time(hdr, time);
 147         image_set_size(hdr, imagesize);
 148         image_set_load(hdr, addr);
 149         image_set_ep(hdr, ep);
 150         image_set_dcrc(hdr, checksum);
 151         image_set_os(hdr, params->os);
 152         image_set_arch(hdr, params->arch);
 153         image_set_type(hdr, type);
 154         image_set_comp(hdr, params->comp);
 155
 156         image_set_name(hdr, params->imagename);
 157
 158         checksum = crc32(0, (const unsigned char *)hdr,
 159                                 sizeof(struct legacy_img_hdr));
 160
 161         image_set_hcrc(hdr, checksum);
 162 }
 163
 164 static int image_extract_subimage(void *ptr, struct image_tool_params *params)
 165 {
 166         const struct legacy_img_hdr *hdr = (const struct legacy_img_hdr *)ptr;
 167         ulong file_data;
 168         ulong file_len;
 169
 170         if (image_check_type(hdr, IH_TYPE_MULTI)) {
 171                 ulong idx = params->pflag;
 172                 ulong count;
 173
 174                 /* get the number of data files present in the image */
 175                 count = image_multi_count(hdr);
 176
 177                 /* retrieve the "data file" at the idx position */
 178                 image_multi_getimg(hdr, idx, &file_data, &file_len);
 179
 180                 if ((file_len == 0) || (idx >= count)) {
 181                         fprintf(stderr, "%s: No such data file %ld in \"%s\"\n",
 182                                 params->cmdname, idx, params->imagefile);
 183                         return -1;
 184                 }
 185         } else {
 186                 file_data = image_get_data(hdr);
 187                 file_len = image_get_size(hdr);
 188         }
 189
 190         /* save the "data file" into the file system */
 191         return imagetool_save_subimage(params->outfile, file_data, file_len);
 192 }
 193
 194 /*
 195  * Default image type parameters definition
 196  */
 197 U_BOOT_IMAGE_TYPE(
 198         defimage,
 199         "Default Image support",
 200         sizeof(struct legacy_img_hdr),
 201         (void *)&header,
 202         image_check_params,
 203         image_verify_header,
 204         image_print_contents,
 205         image_set_header,
 206         image_extract_subimage,
 207         image_check_image_types,
 208         NULL,
 209         NULL
 210 );