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