tools/default_image.c

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