travis: Split bcm SoCs into their own build job
[oweals/u-boot.git] / tools / mkimage.c
index ff3024a8f172c8557bfaa02612d995bdcdd04f2d..42171883109480524c4d0d8c4ffd2f2be5d12359 100644 (file)
@@ -1,14 +1,14 @@
+// SPDX-License-Identifier: GPL-2.0+
 /*
  * (C) Copyright 2008 Semihalf
  *
  * (C) Copyright 2000-2009
  * DENX Software Engineering
  * Wolfgang Denk, wd@denx.de
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 #include "mkimage.h"
+#include "imximage.h"
 #include <image.h>
 #include <version.h>
 
@@ -25,45 +25,48 @@ static struct image_tool_params params = {
        .imagename2 = "",
 };
 
-static int h_compare_image_name(const void *vtype1, const void *vtype2)
+static enum ih_category cur_category;
+
+static int h_compare_category_name(const void *vtype1, const void *vtype2)
 {
        const int *type1 = vtype1;
        const int *type2 = vtype2;
-       const char *name1 = genimg_get_type_short_name(*type1);
-       const char *name2 = genimg_get_type_short_name(*type2);
+       const char *name1 = genimg_get_cat_short_name(cur_category, *type1);
+       const char *name2 = genimg_get_cat_short_name(cur_category, *type2);
 
        return strcmp(name1, name2);
 }
 
-/* Show all image types supported by mkimage */
-static void show_image_types(void)
+static int show_valid_options(enum ih_category category)
 {
-       struct image_type_params *tparams;
-       int order[IH_TYPE_COUNT];
+       int *order;
        int count;
-       int type;
+       int item;
        int i;
 
+       count = genimg_get_cat_count(category);
+       order = calloc(count, sizeof(*order));
+       if (!order)
+               return -ENOMEM;
+
        /* Sort the names in order of short name for easier reading */
-       memset(order, '\0', sizeof(order));
-       for (count = 0, type = 0; type < IH_TYPE_COUNT; type++) {
-               tparams = imagetool_get_type(type);
-               if (tparams)
-                       order[count++] = type;
-       }
-       qsort(order, count, sizeof(int), h_compare_image_name);
+       for (item = 0; item < count; item++)
+               order[item] = item;
+       cur_category = category;
+       qsort(order, count, sizeof(int), h_compare_category_name);
 
-       fprintf(stderr, "\nInvalid image type. Supported image types:\n");
+       fprintf(stderr, "\nInvalid %s, supported are:\n",
+               genimg_get_cat_desc(category));
        for (i = 0; i < count; i++) {
-               type = order[i];
-               tparams = imagetool_get_type(type);
-               if (tparams) {
-                       fprintf(stderr, "\t%-15s  %s\n",
-                               genimg_get_type_short_name(type),
-                               genimg_get_type_name(type));
-               }
+               item = order[i];
+               fprintf(stderr, "\t%-15s  %s\n",
+                       genimg_get_cat_short_name(category, item),
+                       genimg_get_cat_name(category, item));
        }
        fprintf(stderr, "\n");
+       free(order);
+
+       return 0;
 }
 
 static void usage(const char *msg)
@@ -85,29 +88,31 @@ static void usage(const char *msg)
                "          -x ==> set XIP (execute in place)\n",
                params.cmdname);
        fprintf(stderr,
-               "       %s [-D dtc_options] [-f fit-image.its|-f auto|-F] [-b <dtb> [-b <dtb>]] fit-image\n"
-               "           <dtb> file is used with -f auto, it may occour multiple times.\n",
+               "       %s [-D dtc_options] [-f fit-image.its|-f auto|-F] [-b <dtb> [-b <dtb>]] [-i <ramdisk.cpio.gz>] fit-image\n"
+               "           <dtb> file is used with -f auto, it may occur multiple times.\n",
                params.cmdname);
        fprintf(stderr,
                "          -D => set all options for device tree compiler\n"
-               "          -f => input filename for FIT source\n");
+               "          -f => input filename for FIT source\n"
+               "          -i => input filename for ramdisk file\n");
 #ifdef CONFIG_FIT_SIGNATURE
        fprintf(stderr,
-               "Signing / verified boot options: [-E] [-k keydir] [-K dtb] [ -c <comment>] [-p addr] [-r]\n"
+               "Signing / verified boot options: [-E] [-k keydir] [-K dtb] [ -c <comment>] [-p addr] [-r] [-N engine]\n"
                "          -E => place data outside of the FIT structure\n"
                "          -k => set directory containing private keys\n"
                "          -K => write public keys to this .dtb file\n"
                "          -c => add comment in signature node\n"
                "          -F => re-sign existing FIT image\n"
                "          -p => place external data at a static position\n"
-               "          -r => mark keys used as 'required' in dtb\n");
+               "          -r => mark keys used as 'required' in dtb\n"
+               "          -N => openssl engine to use for signing\n");
 #else
        fprintf(stderr,
                "Signing / verified boot not supported (CONFIG_FIT_SIGNATURE undefined)\n");
 #endif
        fprintf(stderr, "       %s -V ==> print version information and exit\n",
                params.cmdname);
-       fprintf(stderr, "Use -T to see a list of available image types\n");
+       fprintf(stderr, "Use '-T list' to see a list of available image types\n");
 
        exit(EXIT_FAILURE);
 }
@@ -138,7 +143,7 @@ static void process_args(int argc, char **argv)
        int opt;
 
        while ((opt = getopt(argc, argv,
-                            "a:A:b:cC:d:D:e:Ef:Fk:K:ln:p:O:rR:qsT:vVx")) != -1) {
+                            "a:A:b:c:C:d:D:e:Ef:Fk:i:K:ln:N:p:O:rR:qsT:vVx")) != -1) {
                switch (opt) {
                case 'a':
                        params.addr = strtoull(optarg, &ptr, 16);
@@ -150,8 +155,10 @@ static void process_args(int argc, char **argv)
                        break;
                case 'A':
                        params.arch = genimg_get_arch_id(optarg);
-                       if (params.arch < 0)
+                       if (params.arch < 0) {
+                               show_valid_options(IH_ARCH);
                                usage("Invalid architecture");
+                       }
                        break;
                case 'b':
                        if (add_content(IH_TYPE_FLATDT, optarg)) {
@@ -166,8 +173,10 @@ static void process_args(int argc, char **argv)
                        break;
                case 'C':
                        params.comp = genimg_get_comp_id(optarg);
-                       if (params.comp < 0)
+                       if (params.comp < 0) {
+                               show_valid_options(IH_COMP);
                                usage("Invalid compression type");
+                       }
                        break;
                case 'd':
                        params.datafile = optarg;
@@ -197,10 +206,12 @@ static void process_args(int argc, char **argv)
                         * The flattened image tree (FIT) format
                         * requires a flattened device tree image type
                         */
-                       params.fit_image_type = params.type;
                        params.type = IH_TYPE_FLATDT;
                        params.fflag = 1;
                        break;
+               case 'i':
+                       params.fit_ramdisk = optarg;
+                       break;
                case 'k':
                        params.keydir = optarg;
                        break;
@@ -213,10 +224,15 @@ static void process_args(int argc, char **argv)
                case 'n':
                        params.imagename = optarg;
                        break;
+               case 'N':
+                       params.engine_id = optarg;
+                       break;
                case 'O':
                        params.os = genimg_get_os_id(optarg);
-                       if (params.os < 0)
+                       if (params.os < 0) {
+                               show_valid_options(IH_OS);
                                usage("Invalid operating system");
+                       }
                        break;
                case 'p':
                        params.external_offset = strtoull(optarg, &ptr, 16);
@@ -225,6 +241,7 @@ static void process_args(int argc, char **argv)
                                        params.cmdname, optarg);
                                exit(EXIT_FAILURE);
                        }
+                       break;
                case 'q':
                        params.quiet = 1;
                        break;
@@ -242,9 +259,13 @@ static void process_args(int argc, char **argv)
                        params.skipcpy = 1;
                        break;
                case 'T':
+                       if (strcmp(optarg, "list") == 0) {
+                               show_valid_options(IH_TYPE);
+                               exit(EXIT_SUCCESS);
+                       }
                        type = genimg_get_type_id(optarg);
                        if (type < 0) {
-                               show_image_types();
+                               show_valid_options(IH_TYPE);
                                usage("Invalid image type");
                        }
                        break;
@@ -272,10 +293,15 @@ static void process_args(int argc, char **argv)
         * will always be IH_TYPE_FLATDT in this case).
         */
        if (params.type == IH_TYPE_FLATDT) {
-               params.fit_image_type = type;
+               params.fit_image_type = type ? type : IH_TYPE_KERNEL;
+               /* For auto_its, datafile is always 'auto' */
                if (!params.auto_its)
                        params.datafile = datafile;
+               else if (!params.datafile)
+                       usage("Missing data file for auto-FIT (use -d)");
        } else if (type != IH_TYPE_INVALID) {
+               if (type == IH_TYPE_SCRIPT && !params.datafile)
+                       usage("Missing data file for script (use -d)");
                params.type = type;
        }
 
@@ -283,7 +309,6 @@ static void process_args(int argc, char **argv)
                usage("Missing output filename");
 }
 
-
 int main(int argc, char **argv)
 {
        int ifd = -1;
@@ -293,6 +318,7 @@ int main(int argc, char **argv)
        struct image_type_params *tparams = NULL;
        int pad_len = 0;
        int dfd;
+       size_t map_len;
 
        params.cmdname = *argv;
        params.addr = 0;
@@ -377,14 +403,21 @@ int main(int argc, char **argv)
                        exit (EXIT_FAILURE);
                }
 
-               /*
-                * scan through mkimage registry for all supported image types
-                * and verify the input image file header for match
-                * Print the image information for matched image type
-                * Returns the error code if not matched
-                */
-               retval = imagetool_verify_print_header(ptr, &sbuf,
-                               tparams, &params);
+               if (params.fflag) {
+                       /*
+                        * Verifies the header format based on the expected header for image
+                        * type in tparams
+                        */
+                       retval = imagetool_verify_print_header_by_type(ptr, &sbuf,
+                                       tparams, &params);
+               } else {
+                       /**
+                        * When listing the image, we are not given the image type. Simply check all
+                        * image types to find one that matches our header
+                        */
+                       retval = imagetool_verify_print_header(ptr, &sbuf,
+                                       tparams, &params);
+               }
 
                (void) munmap((void *)ptr, sbuf.st_size);
                (void) close (ifd);
@@ -490,9 +523,61 @@ int main(int argc, char **argv)
                } else if (params.type == IH_TYPE_PBLIMAGE) {
                        /* PBL has special Image format, implements its' own */
                        pbl_load_uboot(ifd, &params);
+               } else if (params.type == IH_TYPE_ZYNQMPBIF) {
+                       /* Image file is meta, walk through actual targets */
+                       int ret;
+
+                       ret = zynqmpbif_copy_image(ifd, &params);
+                       if (ret)
+                               return ret;
+               } else if (params.type == IH_TYPE_IMX8IMAGE) {
+                       /* i.MX8/8X has special Image format */
+                       int ret;
+
+                       ret = imx8image_copy_image(ifd, &params);
+                       if (ret)
+                               return ret;
+               } else if (params.type == IH_TYPE_IMX8MIMAGE) {
+                       /* i.MX8M has special Image format */
+                       int ret;
+
+                       ret = imx8mimage_copy_image(ifd, &params);
+                       if (ret)
+                               return ret;
                } else {
                        copy_file(ifd, params.datafile, pad_len);
                }
+               if (params.type == IH_TYPE_FIRMWARE_IVT) {
+                       /* Add alignment and IVT */
+                       uint32_t aligned_filesize = (params.file_size + 0x1000
+                                       - 1) & ~(0x1000 - 1);
+                       flash_header_v2_t ivt_header = { { 0xd1, 0x2000, 0x40 },
+                                       params.addr, 0, 0, 0, params.addr
+                                                       + aligned_filesize
+                                                       - tparams->header_size,
+                                       params.addr + aligned_filesize
+                                                       - tparams->header_size
+                                                       + 0x20, 0 };
+                       int i = params.file_size;
+                       for (; i < aligned_filesize; i++) {
+                               if (write(ifd, (char *) &i, 1) != 1) {
+                                       fprintf(stderr,
+                                                       "%s: Write error on %s: %s\n",
+                                                       params.cmdname,
+                                                       params.imagefile,
+                                                       strerror(errno));
+                                       exit(EXIT_FAILURE);
+                               }
+                       }
+                       if (write(ifd, &ivt_header, sizeof(flash_header_v2_t))
+                                       != sizeof(flash_header_v2_t)) {
+                               fprintf(stderr, "%s: Write error on %s: %s\n",
+                                               params.cmdname,
+                                               params.imagefile,
+                                               strerror(errno));
+                               exit(EXIT_FAILURE);
+                       }
+               }
        }
 
        /* We're a bit of paranoid */
@@ -513,7 +598,8 @@ int main(int argc, char **argv)
        }
        params.file_size = sbuf.st_size;
 
-       ptr = mmap(0, sbuf.st_size, PROT_READ|PROT_WRITE, MAP_SHARED, ifd, 0);
+       map_len = sbuf.st_size;
+       ptr = mmap(0, map_len, PROT_READ | PROT_WRITE, MAP_SHARED, ifd, 0);
        if (ptr == MAP_FAILED) {
                fprintf (stderr, "%s: Can't map %s: %s\n",
                        params.cmdname, params.imagefile, strerror(errno));
@@ -533,12 +619,11 @@ int main(int argc, char **argv)
        if (tparams->print_header)
                tparams->print_header (ptr);
        else {
-               fprintf (stderr, "%s: Can't print header for %s: %s\n",
-                       params.cmdname, tparams->name, strerror(errno));
-               exit (EXIT_FAILURE);
+               fprintf (stderr, "%s: Can't print header for %s\n",
+                       params.cmdname, tparams->name);
        }
 
-       (void) munmap((void *)ptr, sbuf.st_size);
+       (void)munmap((void *)ptr, map_len);
 
        /* We're a bit of paranoid */
 #if defined(_POSIX_SYNCHRONIZED_IO) && \