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