]> git.kernelconcepts.de Git - karo-tx-uboot.git/blobdiff - tools/mkimage.c
ARM: keystone2: Cleanup PLL init code
[karo-tx-uboot.git] / tools / mkimage.c
index 8a20594f316e558a63d9511316fadc38f946846d..e81d4550835c6763bcab21e0b2b8ab2bf46baba3 100644 (file)
  * DENX Software Engineering
  * Wolfgang Denk, wd@denx.de
  *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License as
- * published by the Free Software Foundation; either version 2 of
- * the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
- * MA 02111-1307 USA
+ * SPDX-License-Identifier:    GPL-2.0+
  */
 
 #include "mkimage.h"
 #include <image.h>
+#include <version.h>
 
 static void copy_file(int, const char *, int);
 static void usage(void);
 
-/* image_type_params link list to maintain registered image type supports */
-struct image_type_params *mkimage_tparams = NULL;
-
 /* parameters initialized by core will be used by the image type code */
-struct mkimage_params params = {
+struct image_tool_params params = {
        .os = IH_OS_LINUX,
        .arch = IH_ARCH_PPC,
        .type = IH_TYPE_KERNEL,
        .comp = IH_COMP_GZIP,
        .dtc = MKIMAGE_DEFAULT_DTC_OPTIONS,
+       .imagename = "",
+       .imagename2 = "",
 };
 
-/*
- * mkimage_register -
- *
- * It is used to register respective image generation/list support to the
- * mkimage core
- *
- * the input struct image_type_params is checked and appended to the link
- * list, if the input structure is already registered, error
- */
-void mkimage_register (struct image_type_params *tparams)
+static int h_compare_image_name(const void *vtype1, const void *vtype2)
 {
-       struct image_type_params **tp;
-
-       if (!tparams) {
-               fprintf (stderr, "%s: %s: Null input\n",
-                       params.cmdname, __FUNCTION__);
-               exit (EXIT_FAILURE);
-       }
-
-       /* scan the linked list, check for registry and point the last one */
-       for (tp = &mkimage_tparams; *tp != NULL; tp = &(*tp)->next) {
-               if (!strcmp((*tp)->name, tparams->name)) {
-                       fprintf (stderr, "%s: %s already registered\n",
-                               params.cmdname, tparams->name);
-                       return;
-               }
-       }
-
-       /* add input struct entry at the end of link list */
-       *tp = tparams;
-       /* mark input entry as last entry in the link list */
-       tparams->next = NULL;
+       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);
 
-       debug ("Registered %s\n", tparams->name);
+       return strcmp(name1, name2);
 }
 
-/*
- * mkimage_get_type -
- *
- * It scans all registers image type supports
- * checks the input type_id for each supported image type
- *
- * if successful,
- *     returns respective image_type_params pointer if success
- * if input type_id is not supported by any of image_type_support
- *     returns NULL
- */
-struct image_type_params *mkimage_get_type(int type)
+/* Show all image types supported by mkimage */
+static void show_image_types(void)
 {
-       struct image_type_params *curr;
-
-       for (curr = mkimage_tparams; curr != NULL; curr = curr->next) {
-               if (curr->check_image_type) {
-                       if (!curr->check_image_type (type))
-                               return curr;
-               }
+       struct image_type_params *tparams;
+       int order[IH_TYPE_COUNT];
+       int count;
+       int type;
+       int i;
+
+       /* 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;
        }
-       return NULL;
-}
-
-/*
- * mkimage_verify_print_header -
- *
- * It scans mkimage_tparams link list,
- * verifies image_header for each supported image type
- * if verification is successful, prints respective header
- *
- * returns negative if input image format does not match with any of
- * supported image types
- */
-int mkimage_verify_print_header (void *ptr, struct stat *sbuf)
-{
-       int retval = -1;
-       struct image_type_params *curr;
-
-       for (curr = mkimage_tparams; curr != NULL; curr = curr->next ) {
-               if (curr->verify_header) {
-                       retval = curr->verify_header (
-                               (unsigned char *)ptr, sbuf->st_size,
-                               &params);
-
-                       if (retval == 0) {
-                               /*
-                                * Print the image information
-                                * if verify is successful
-                                */
-                               if (curr->print_header)
-                                       curr->print_header (ptr);
-                               else {
-                                       fprintf (stderr,
-                                       "%s: print_header undefined for %s\n",
-                                       params.cmdname, curr->name);
-                               }
-                               break;
-                       }
+       qsort(order, count, sizeof(int), h_compare_image_name);
+
+       fprintf(stderr, "\nInvalid image type. Supported image types:\n");
+       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));
                }
        }
-       return retval;
+       fprintf(stderr, "\n");
 }
 
-int
-main (int argc, char **argv)
+int main(int argc, char **argv)
 {
        int ifd = -1;
        struct stat sbuf;
-       unsigned char *ptr;
+       char *ptr;
        int retval = 0;
        struct image_type_params *tparams = NULL;
-
-       /* Init Kirkwood Boot image generation/list support */
-       init_kwb_image_type ();
-       /* Init FIT image generation/list support */
-       init_fit_image_type ();
-       /* Init Default image generation/list support */
-       init_default_image_type ();
+       int pad_len = 0;
+       int dfd;
 
        params.cmdname = *argv;
        params.addr = params.ep = 0;
@@ -170,6 +92,11 @@ main (int argc, char **argv)
                                        genimg_get_arch_id (*++argv)) < 0)
                                        usage ();
                                goto NXTARG;
+                       case 'c':
+                               if (--argc <= 0)
+                                       usage();
+                               params.comment = *++argv;
+                               goto NXTARG;
                        case 'C':
                                if ((--argc <= 0) ||
                                        (params.comp =
@@ -189,17 +116,20 @@ main (int argc, char **argv)
                                        usage ();
                                goto NXTARG;
                        case 'T':
-                               if ((--argc <= 0) ||
-                                       (params.type =
-                                       genimg_get_type_id (*++argv)) < 0)
-                                       usage ();
+                               params.type = -1;
+                               if (--argc >= 0 && argv[1]) {
+                                       params.type =
+                                               genimg_get_type_id(*++argv);
+                               }
+                               if (params.type < 0) {
+                                       show_image_types();
+                                       usage();
+                               }
                                goto NXTARG;
-
                        case 'a':
                                if (--argc <= 0)
                                        usage ();
-                               params.addr = strtoul (*++argv,
-                                       (char **)&ptr, 16);
+                               params.addr = strtoul (*++argv, &ptr, 16);
                                if (*ptr) {
                                        fprintf (stderr,
                                                "%s: invalid load address %s\n",
@@ -216,8 +146,7 @@ main (int argc, char **argv)
                        case 'e':
                                if (--argc <= 0)
                                        usage ();
-                               params.ep = strtoul (*++argv,
-                                               (char **)&ptr, 16);
+                               params.ep = strtoul (*++argv, &ptr, 16);
                                if (*ptr) {
                                        fprintf (stderr,
                                                "%s: invalid entry point %s\n",
@@ -229,18 +158,52 @@ main (int argc, char **argv)
                        case 'f':
                                if (--argc <= 0)
                                        usage ();
-                               params.type = IH_TYPE_FLATDT;
                                params.datafile = *++argv;
+                               /* no break */
+                       case 'F':
+                               /*
+                                * The flattened image tree (FIT) format
+                                * requires a flattened device tree image type
+                                */
+                               params.type = IH_TYPE_FLATDT;
                                params.fflag = 1;
                                goto NXTARG;
+                       case 'k':
+                               if (--argc <= 0)
+                                       usage();
+                               params.keydir = *++argv;
+                               goto NXTARG;
+                       case 'K':
+                               if (--argc <= 0)
+                                       usage();
+                               params.keydest = *++argv;
+                               goto NXTARG;
                        case 'n':
                                if (--argc <= 0)
                                        usage ();
                                params.imagename = *++argv;
                                goto NXTARG;
+                       case 'r':
+                               params.require_keys = 1;
+                               break;
+                       case 'R':
+                               if (--argc <= 0)
+                                       usage();
+                               /*
+                                * This entry is for the second configuration
+                                * file, if only one is not enough.
+                                */
+                               params.imagename2 = *++argv;
+                               goto NXTARG;
+                       case 's':
+                               params.skipcpy = 1;
+                               break;
                        case 'v':
                                params.vflag++;
                                break;
+                       case 'V':
+                               printf("mkimage version %s\n", PLAIN_VERSION);
+                               exit(EXIT_SUCCESS);
                        case 'x':
                                params.xflag++;
                                break;
@@ -255,7 +218,7 @@ NXTARG:             ;
                usage ();
 
        /* set tparams as per input type_id */
-       tparams = mkimage_get_type(params.type);
+       tparams = imagetool_get_type(params.type);
        if (tparams == NULL) {
                fprintf (stderr, "%s: unsupported type %s\n",
                        params.cmdname, genimg_get_type_name(params.type));
@@ -277,39 +240,37 @@ NXTARG:           ;
                        params.ep += tparams->header_size;
        }
 
-       /*
-        * If XIP, ensure the entry point is equal to the load address plus
-        * the size of the U-Boot header.
-        */
-       if (params.xflag) {
-               if (params.ep != params.addr + tparams->header_size) {
-                       fprintf (stderr,
-                               "%s: For XIP, the entry point must be the load addr + %lu\n",
-                               params.cmdname,
-                               (unsigned long)tparams->header_size);
-                       exit (EXIT_FAILURE);
-               }
-       }
-
        params.imagefile = *argv;
 
-       if (!params.fflag){
-               if (params.lflag) {
-                       ifd = open (params.imagefile, O_RDONLY|O_BINARY);
-               } else {
-                       ifd = open (params.imagefile,
-                               O_RDWR|O_CREAT|O_TRUNC|O_BINARY, 0666);
-               }
+       if (params.fflag){
+               if (tparams->fflag_handle)
+                       /*
+                        * in some cases, some additional processing needs
+                        * to be done if fflag is defined
+                        *
+                        * For ex. fit_handle_file for Fit file support
+                        */
+                       retval = tparams->fflag_handle(&params);
 
-               if (ifd < 0) {
-                       fprintf (stderr, "%s: Can't open %s: %s\n",
-                               params.cmdname, params.imagefile,
-                               strerror(errno));
-                       exit (EXIT_FAILURE);
-               }
+               if (retval != EXIT_SUCCESS)
+                       exit (retval);
+       }
+
+       if (params.lflag || params.fflag) {
+               ifd = open (params.imagefile, O_RDONLY|O_BINARY);
+       } else {
+               ifd = open (params.imagefile,
+                       O_RDWR|O_CREAT|O_TRUNC|O_BINARY, 0666);
+       }
+
+       if (ifd < 0) {
+               fprintf (stderr, "%s: Can't open %s: %s\n",
+                       params.cmdname, params.imagefile,
+                       strerror(errno));
+               exit (EXIT_FAILURE);
        }
 
-       if (params.lflag) {
+       if (params.lflag || params.fflag) {
                /*
                 * list header information of existing image
                 */
@@ -341,31 +302,41 @@ NXTARG:           ;
                 * Print the image information for matched image type
                 * Returns the error code if not matched
                 */
-               retval = mkimage_verify_print_header (ptr, &sbuf);
+               retval = imagetool_verify_print_header(ptr, &sbuf,
+                               tparams, &params);
 
                (void) munmap((void *)ptr, sbuf.st_size);
                (void) close (ifd);
 
                exit (retval);
-       } else if (params.fflag) {
-               if (tparams->fflag_handle)
-                       /*
-                        * in some cases, some additional processing needs
-                        * to be done if fflag is defined
-                        *
-                        * For ex. fit_handle_file for Fit file support
-                        */
-                       retval = tparams->fflag_handle(&params);
+       }
 
-               exit (retval);
+       dfd = open(params.datafile, O_RDONLY | O_BINARY);
+       if (dfd < 0) {
+               fprintf(stderr, "%s: Can't open %s: %s\n",
+                       params.cmdname, params.datafile, strerror(errno));
+               exit(EXIT_FAILURE);
+       }
+
+       if (fstat(dfd, &sbuf) < 0) {
+               fprintf(stderr, "%s: Can't stat %s: %s\n",
+                       params.cmdname, params.datafile, strerror(errno));
+               exit(EXIT_FAILURE);
        }
 
+       params.file_size = sbuf.st_size + tparams->header_size;
+       close(dfd);
+
        /*
-        * Must be -w then:
-        *
-        * write dummy header, to be fixed later
+        * In case there an header with a variable
+        * length will be added, the corresponding
+        * function is called. This is responsible to
+        * allocate memory for the header itself.
         */
-       memset (tparams->hdr, 0, tparams->header_size);
+       if (tparams->vrec_header)
+               pad_len = tparams->vrec_header(&params, tparams);
+       else
+               memset(tparams->hdr, 0, tparams->header_size);
 
        if (write(ifd, tparams->hdr, tparams->header_size)
                                        != tparams->header_size) {
@@ -374,69 +345,76 @@ NXTARG:           ;
                exit (EXIT_FAILURE);
        }
 
-       if (params.type == IH_TYPE_MULTI || params.type == IH_TYPE_SCRIPT) {
-               char *file = params.datafile;
-               uint32_t size;
-
-               for (;;) {
-                       char *sep = NULL;
-
-                       if (file) {
-                               if ((sep = strchr(file, ':')) != NULL) {
-                                       *sep = '\0';
+       if (!params.skipcpy) {
+               if (params.type == IH_TYPE_MULTI ||
+                   params.type == IH_TYPE_SCRIPT) {
+                       char *file = params.datafile;
+                       uint32_t size;
+
+                       for (;;) {
+                               char *sep = NULL;
+
+                               if (file) {
+                                       if ((sep = strchr(file, ':')) != NULL) {
+                                               *sep = '\0';
+                                       }
+
+                                       if (stat (file, &sbuf) < 0) {
+                                               fprintf (stderr, "%s: Can't stat %s: %s\n",
+                                                        params.cmdname, file, strerror(errno));
+                                               exit (EXIT_FAILURE);
+                                       }
+                                       size = cpu_to_uimage (sbuf.st_size);
+                               } else {
+                                       size = 0;
                                }
 
-                               if (stat (file, &sbuf) < 0) {
-                                       fprintf (stderr, "%s: Can't stat %s: %s\n",
-                                               params.cmdname, file, strerror(errno));
+                               if (write(ifd, (char *)&size, sizeof(size)) != sizeof(size)) {
+                                       fprintf (stderr, "%s: Write error on %s: %s\n",
+                                                params.cmdname, params.imagefile,
+                                                strerror(errno));
                                        exit (EXIT_FAILURE);
                                }
-                               size = cpu_to_uimage (sbuf.st_size);
-                       } else {
-                               size = 0;
-                       }
 
-                       if (write(ifd, (char *)&size, sizeof(size)) != sizeof(size)) {
-                               fprintf (stderr, "%s: Write error on %s: %s\n",
-                                       params.cmdname, params.imagefile,
-                                       strerror(errno));
-                               exit (EXIT_FAILURE);
-                       }
+                               if (!file) {
+                                       break;
+                               }
 
-                       if (!file) {
-                               break;
+                               if (sep) {
+                                       *sep = ':';
+                                       file = sep + 1;
+                               } else {
+                                       file = NULL;
+                               }
                        }
 
-                       if (sep) {
-                               *sep = ':';
-                               file = sep + 1;
-                       } else {
-                               file = NULL;
-                       }
-               }
+                       file = params.datafile;
 
-               file = params.datafile;
-
-               for (;;) {
-                       char *sep = strchr(file, ':');
-                       if (sep) {
-                               *sep = '\0';
-                               copy_file (ifd, file, 1);
-                               *sep++ = ':';
-                               file = sep;
-                       } else {
-                               copy_file (ifd, file, 0);
-                               break;
+                       for (;;) {
+                               char *sep = strchr(file, ':');
+                               if (sep) {
+                                       *sep = '\0';
+                                       copy_file (ifd, file, 1);
+                                       *sep++ = ':';
+                                       file = sep;
+                               } else {
+                                       copy_file (ifd, file, 0);
+                                       break;
+                               }
                        }
+               } else if (params.type == IH_TYPE_PBLIMAGE) {
+                       /* PBL has special Image format, implements its' own */
+                       pbl_load_uboot(ifd, &params);
+               } else {
+                       copy_file(ifd, params.datafile, pad_len);
                }
-       } else {
-               copy_file (ifd, params.datafile, 0);
        }
 
        /* We're a bit of paranoid */
 #if defined(_POSIX_SYNCHRONIZED_IO) && \
    !defined(__sun__) && \
    !defined(__FreeBSD__) && \
+   !defined(__OpenBSD__) && \
    !defined(__APPLE__)
        (void) fdatasync (ifd);
 #else
@@ -448,6 +426,7 @@ NXTARG:             ;
                        params.cmdname, params.imagefile, strerror(errno));
                exit (EXIT_FAILURE);
        }
+       params.file_size = sbuf.st_size;
 
        ptr = mmap(0, sbuf.st_size, PROT_READ|PROT_WRITE, MAP_SHARED, ifd, 0);
        if (ptr == MAP_FAILED) {
@@ -480,6 +459,7 @@ NXTARG:             ;
 #if defined(_POSIX_SYNCHRONIZED_IO) && \
    !defined(__sun__) && \
    !defined(__FreeBSD__) && \
+   !defined(__OpenBSD__) && \
    !defined(__APPLE__)
        (void) fdatasync (ifd);
 #else
@@ -503,9 +483,18 @@ copy_file (int ifd, const char *datafile, int pad)
        unsigned char *ptr;
        int tail;
        int zero = 0;
+       uint8_t zeros[4096];
        int offset = 0;
        int size;
-       struct image_type_params *tparams = mkimage_get_type (params.type);
+       struct image_type_params *tparams = imagetool_get_type(params.type);
+
+       if (pad >= sizeof(zeros)) {
+               fprintf(stderr, "%s: Can't pad to %d\n",
+                       params.cmdname, pad);
+               exit(EXIT_FAILURE);
+       }
+
+       memset(zeros, 0, sizeof(zeros));
 
        if (params.vflag) {
                fprintf (stderr, "Adding Image %s\n", datafile);
@@ -564,7 +553,8 @@ copy_file (int ifd, const char *datafile, int pad)
                exit (EXIT_FAILURE);
        }
 
-       if (pad && ((tail = size % 4) != 0)) {
+       tail = size % 4;
+       if ((pad == 1) && (tail != 0)) {
 
                if (write(ifd, (char *)&zero, 4-tail) != 4-tail) {
                        fprintf (stderr, "%s: Write error on %s: %s\n",
@@ -572,14 +562,20 @@ copy_file (int ifd, const char *datafile, int pad)
                                strerror(errno));
                        exit (EXIT_FAILURE);
                }
+       } else if (pad > 1) {
+               if (write(ifd, (char *)&zeros, pad) != pad) {
+                       fprintf(stderr, "%s: Write error on %s: %s\n",
+                               params.cmdname, params.imagefile,
+                               strerror(errno));
+                       exit(EXIT_FAILURE);
+               }
        }
 
        (void) munmap((void *)ptr, sbuf.st_size);
        (void) close (dfd);
 }
 
-void
-usage ()
+static void usage(void)
 {
        fprintf (stderr, "Usage: %s -l image\n"
                         "          -l ==> list image header information\n",
@@ -596,8 +592,23 @@ usage ()
                         "          -d ==> use image data from 'datafile'\n"
                         "          -x ==> set XIP (execute in place)\n",
                params.cmdname);
-       fprintf (stderr, "       %s [-D dtc_options] -f fit-image.its fit-image\n",
+       fprintf(stderr, "       %s [-D dtc_options] [-f fit-image.its|-F] fit-image\n",
+               params.cmdname);
+       fprintf(stderr, "          -D => set options for device tree compiler\n"
+                       "          -f => input filename for FIT source\n");
+#ifdef CONFIG_FIT_SIGNATURE
+       fprintf(stderr, "Signing / verified boot options: [-k keydir] [-K dtb] [ -c <comment>] [-r]\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"
+                       "          -r => mark keys used as 'required' in dtb\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");
 
        exit (EXIT_FAILURE);
 }