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         /*
  54          * create copy of header so that we can blank out the
  55          * checksum field for checking - this can't be done
  56          * on the PROT_READ mapped data.
  57          */
  58         memcpy(hdr, ptr, sizeof(struct legacy_img_hdr));
  59
  60         if (be32_to_cpu(hdr->ih_magic) != IH_MAGIC) {
  61                 debug("%s: Bad Magic Number: \"%s\" is no valid image\n",
  62                       params->cmdname, params->imagefile);
  63                 return -FDT_ERR_BADMAGIC;
  64         }
  65
  66         data = (const unsigned char *)hdr;
  67         len  = sizeof(struct legacy_img_hdr);
  68
  69         checksum = be32_to_cpu(hdr->ih_hcrc);
  70         hdr->ih_hcrc = cpu_to_be32(0);  /* clear for re-calculation */
  71
  72         if (crc32(0, data, len) != checksum) {
  73                 debug("%s: ERROR: \"%s\" has bad header checksum!\n",
  74                       params->cmdname, params->imagefile);
  75                 return -FDT_ERR_BADSTATE;
  76         }
  77
  78         data = (const unsigned char *)ptr + sizeof(struct legacy_img_hdr);
  79         len  = image_size - sizeof(struct legacy_img_hdr);
  80
  81         checksum = be32_to_cpu(hdr->ih_dcrc);
  82         if (crc32(0, data, len) != checksum) {
  83                 debug("%s: ERROR: \"%s\" has corrupted data!\n",
  84                       params->cmdname, params->imagefile);
  85                 return -FDT_ERR_BADSTRUCTURE;
  86         }
  87         return 0;
  88 }
  89
  90 static void image_set_header(void *ptr, struct stat *sbuf, int ifd,
  91                                 struct image_tool_params *params)
  92 {
  93         uint32_t checksum;
  94         time_t time;
  95         uint32_t imagesize;
  96         uint32_t ep;
  97         uint32_t addr;
  98         int type;
  99         struct legacy_img_hdr *hdr = (struct legacy_img_hdr *)ptr;
 100
 101         checksum = crc32(0,
 102                         (const unsigned char *)(ptr +
 103                                 sizeof(struct legacy_img_hdr)),
 104                         sbuf->st_size - sizeof(struct legacy_img_hdr));
 105
 106         time = imagetool_get_source_date(params->cmdname, sbuf->st_mtime);
 107         ep = params->ep;
 108         addr = params->addr;
 109
 110         if (params->type == IH_TYPE_FIRMWARE_IVT)
 111                 /* Add size of CSF minus IVT */
 112                 imagesize = sbuf->st_size - sizeof(struct legacy_img_hdr)
 113                             + 0x2060 - sizeof(flash_header_v2_t);
 114
 115         else
 116                 imagesize = sbuf->st_size - sizeof(struct legacy_img_hdr);
 117
 118         if (params->type == IH_TYPE_FDT_LEGACY)
 119                 type = IH_TYPE_FLATDT;
 120         else
 121                 type = params->type;
 122
 123         if (params->os == IH_OS_TEE) {
 124                 addr = optee_image_get_load_addr(hdr);
 125                 ep = optee_image_get_entry_point(hdr);
 126         }
 127
 128         /* Build new header */
 129         image_set_magic(hdr, IH_MAGIC);
 130         image_set_time(hdr, time);
 131         image_set_size(hdr, imagesize);
 132         image_set_load(hdr, addr);
 133         image_set_ep(hdr, ep);
 134         image_set_dcrc(hdr, checksum);
 135         image_set_os(hdr, params->os);
 136         image_set_arch(hdr, params->arch);
 137         image_set_type(hdr, type);
 138         image_set_comp(hdr, params->comp);
 139
 140         image_set_name(hdr, params->imagename);
 141
 142         checksum = crc32(0, (const unsigned char *)hdr,
 143                                 sizeof(struct legacy_img_hdr));
 144
 145         image_set_hcrc(hdr, checksum);
 146 }
 147
 148 static int image_extract_subimage(void *ptr, struct image_tool_params *params)
 149 {
 150         const struct legacy_img_hdr *hdr = (const struct legacy_img_hdr *)ptr;
 151         ulong file_data;
 152         ulong file_len;
 153
 154         if (image_check_type(hdr, IH_TYPE_MULTI)) {
 155                 ulong idx = params->pflag;
 156                 ulong count;
 157
 158                 /* get the number of data files present in the image */
 159                 count = image_multi_count(hdr);
 160
 161                 /* retrieve the "data file" at the idx position */
 162                 image_multi_getimg(hdr, idx, &file_data, &file_len);
 163
 164                 if ((file_len == 0) || (idx >= count)) {
 165                         fprintf(stderr, "%s: No such data file %ld in \"%s\"\n",
 166                                 params->cmdname, idx, params->imagefile);
 167                         return -1;
 168                 }
 169         } else {
 170                 file_data = image_get_data(hdr);
 171                 file_len = image_get_size(hdr);
 172         }
 173
 174         /* save the "data file" into the file system */
 175         return imagetool_save_subimage(params->outfile, file_data, file_len);
 176 }
 177
 178 /*
 179  * Default image type parameters definition
 180  */
 181 U_BOOT_IMAGE_TYPE(
 182         defimage,
 183         "Default Image support",
 184         sizeof(struct legacy_img_hdr),
 185         (void *)&header,
 186         image_check_params,
 187         image_verify_header,
 188         image_print_contents,
 189         image_set_header,
 190         image_extract_subimage,
 191         image_check_image_types,
 192         NULL,
 193         NULL
 194 );