tools/mkimage.c

   1 /*
   2  * (C) Copyright 2008 Semihalf
   3  *
   4  * (C) Copyright 2000-2009
   5  * DENX Software Engineering
   6  * Wolfgang Denk, wd@denx.de
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License as
  10  * published by the Free Software Foundation; either version 2 of
  11  * the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  21  * MA 02111-1307 USA
  22  */
  23
  24 #include "mkimage.h"
  25 #include <image.h>
  26 #include <version.h>
  27
  28 static void copy_file(int, const char *, int);
  29 static void usage(void);
  30
  31 /* image_type_params link list to maintain registered image type supports */
  32 struct image_type_params *mkimage_tparams = NULL;
  33
  34 /* parameters initialized by core will be used by the image type code */
  35 struct mkimage_params params = {
  36         .os = IH_OS_LINUX,
  37         .arch = IH_ARCH_PPC,
  38         .type = IH_TYPE_KERNEL,
  39         .comp = IH_COMP_GZIP,
  40         .dtc = MKIMAGE_DEFAULT_DTC_OPTIONS,
  41         .imagename = "",
  42         .imagename2 = "",
  43 };
  44
  45 /*
  46  * mkimage_register -
  47  *
  48  * It is used to register respective image generation/list support to the
  49  * mkimage core
  50  *
  51  * the input struct image_type_params is checked and appended to the link
  52  * list, if the input structure is already registered, error
  53  */
  54 void mkimage_register (struct image_type_params *tparams)
  55 {
  56         struct image_type_params **tp;
  57
  58         if (!tparams) {
  59                 fprintf (stderr, "%s: %s: Null input\n",
  60                         params.cmdname, __FUNCTION__);
  61                 exit (EXIT_FAILURE);
  62         }
  63
  64         /* scan the linked list, check for registry and point the last one */
  65         for (tp = &mkimage_tparams; *tp != NULL; tp = &(*tp)->next) {
  66                 if (!strcmp((*tp)->name, tparams->name)) {
  67                         fprintf (stderr, "%s: %s already registered\n",
  68                                 params.cmdname, tparams->name);
  69                         return;
  70                 }
  71         }
  72
  73         /* add input struct entry at the end of link list */
  74         *tp = tparams;
  75         /* mark input entry as last entry in the link list */
  76         tparams->next = NULL;
  77
  78         debug ("Registered %s\n", tparams->name);
  79 }
  80
  81 /*
  82  * mkimage_get_type -
  83  *
  84  * It scans all registers image type supports
  85  * checks the input type_id for each supported image type
  86  *
  87  * if successful,
  88  *      returns respective image_type_params pointer if success
  89  * if input type_id is not supported by any of image_type_support
  90  *      returns NULL
  91  */
  92 struct image_type_params *mkimage_get_type(int type)
  93 {
  94         struct image_type_params *curr;
  95
  96         for (curr = mkimage_tparams; curr != NULL; curr = curr->next) {
  97                 if (curr->check_image_type) {
  98                         if (!curr->check_image_type (type))
  99                                 return curr;
 100                 }
 101         }
 102         return NULL;
 103 }
 104
 105 /*
 106  * mkimage_verify_print_header -
 107  *
 108  * It scans mkimage_tparams link list,
 109  * verifies image_header for each supported image type
 110  * if verification is successful, prints respective header
 111  *
 112  * returns negative if input image format does not match with any of
 113  * supported image types
 114  */
 115 int mkimage_verify_print_header (void *ptr, struct stat *sbuf)
 116 {
 117         int retval = -1;
 118         struct image_type_params *curr;
 119
 120         for (curr = mkimage_tparams; curr != NULL; curr = curr->next ) {
 121                 if (curr->verify_header) {
 122                         retval = curr->verify_header (
 123                                 (unsigned char *)ptr, sbuf->st_size,
 124                                 &params);
 125
 126                         if (retval == 0) {
 127                                 /*
 128                                  * Print the image information
 129                                  * if verify is successful
 130                                  */
 131                                 if (curr->print_header)
 132                                         curr->print_header (ptr);
 133                                 else {
 134                                         fprintf (stderr,
 135                                         "%s: print_header undefined for %s\n",
 136                                         params.cmdname, curr->name);
 137                                 }
 138                                 break;
 139                         }
 140                 }
 141         }
 142         return retval;
 143 }
 144
 145 int
 146 main (int argc, char **argv)
 147 {
 148         int ifd = -1;
 149         struct stat sbuf;
 150         char *ptr;
 151         int retval = 0;
 152         struct image_type_params *tparams = NULL;
 153
 154         /* Init Freescale PBL Boot image generation/list support */
 155         init_pbl_image_type();
 156         /* Init Kirkwood Boot image generation/list support */
 157         init_kwb_image_type ();
 158         /* Init Freescale imx Boot image generation/list support */
 159         init_imx_image_type ();
 160         /* Init FIT image generation/list support */
 161         init_fit_image_type ();
 162         /* Init TI OMAP Boot image generation/list support */
 163         init_omap_image_type();
 164         /* Init Default image generation/list support */
 165         init_default_image_type ();
 166         /* Init Davinci UBL support */
 167         init_ubl_image_type();
 168         /* Init Davinci AIS support */
 169         init_ais_image_type();
 170
 171         params.cmdname = *argv;
 172         params.addr = params.ep = 0;
 173
 174         while (--argc > 0 && **++argv == '-') {
 175                 while (*++*argv) {
 176                         switch (**argv) {
 177                         case 'l':
 178                                 params.lflag = 1;
 179                                 break;
 180                         case 'A':
 181                                 if ((--argc <= 0) ||
 182                                         (params.arch =
 183                                         genimg_get_arch_id (*++argv)) < 0)
 184                                         usage ();
 185                                 goto NXTARG;
 186                         case 'C':
 187                                 if ((--argc <= 0) ||
 188                                         (params.comp =
 189                                         genimg_get_comp_id (*++argv)) < 0)
 190                                         usage ();
 191                                 goto NXTARG;
 192                         case 'D':
 193                                 if (--argc <= 0)
 194                                         usage ();
 195                                 params.dtc = *++argv;
 196                                 goto NXTARG;
 197
 198                         case 'O':
 199                                 if ((--argc <= 0) ||
 200                                         (params.os =
 201                                         genimg_get_os_id (*++argv)) < 0)
 202                                         usage ();
 203                                 goto NXTARG;
 204                         case 'T':
 205                                 if ((--argc <= 0) ||
 206                                         (params.type =
 207                                         genimg_get_type_id (*++argv)) < 0)
 208                                         usage ();
 209                                 goto NXTARG;
 210
 211                         case 'a':
 212                                 if (--argc <= 0)
 213                                         usage ();
 214                                 params.addr = strtoul (*++argv, &ptr, 16);
 215                                 if (*ptr) {
 216                                         fprintf (stderr,
 217                                                 "%s: invalid load address %s\n",
 218                                                 params.cmdname, *argv);
 219                                         exit (EXIT_FAILURE);
 220                                 }
 221                                 goto NXTARG;
 222                         case 'd':
 223                                 if (--argc <= 0)
 224                                         usage ();
 225                                 params.datafile = *++argv;
 226                                 params.dflag = 1;
 227                                 goto NXTARG;
 228                         case 'e':
 229                                 if (--argc <= 0)
 230                                         usage ();
 231                                 params.ep = strtoul (*++argv, &ptr, 16);
 232                                 if (*ptr) {
 233                                         fprintf (stderr,
 234                                                 "%s: invalid entry point %s\n",
 235                                                 params.cmdname, *argv);
 236                                         exit (EXIT_FAILURE);
 237                                 }
 238                                 params.eflag = 1;
 239                                 goto NXTARG;
 240                         case 'f':
 241                                 if (--argc <= 0)
 242                                         usage ();
 243                                 /*
 244                                  * The flattened image tree (FIT) format
 245                                  * requires a flattened device tree image type
 246                                  */
 247                                 params.type = IH_TYPE_FLATDT;
 248                                 params.datafile = *++argv;
 249                                 params.fflag = 1;
 250                                 goto NXTARG;
 251                         case 'k':
 252                                 if (--argc <= 0)
 253                                         usage();
 254                                 params.keydir = *++argv;
 255                                 goto NXTARG;
 256                         case 'K':
 257                                 if (--argc <= 0)
 258                                         usage();
 259                                 params.keydest = *++argv;
 260                                 goto NXTARG;
 261                         case 'n':
 262                                 if (--argc <= 0)
 263                                         usage ();
 264                                 params.imagename = *++argv;
 265                                 goto NXTARG;
 266                         case 'R':
 267                                 if (--argc <= 0)
 268                                         usage();
 269                                 /*
 270                                  * This entry is for the second configuration
 271                                  * file, if only one is not enough.
 272                                  */
 273                                 params.imagename2 = *++argv;
 274                                 goto NXTARG;
 275                         case 's':
 276                                 params.skipcpy = 1;
 277                                 break;
 278                         case 'v':
 279                                 params.vflag++;
 280                                 break;
 281                         case 'V':
 282                                 printf("mkimage version %s\n", PLAIN_VERSION);
 283                                 exit(EXIT_SUCCESS);
 284                         case 'x':
 285                                 params.xflag++;
 286                                 break;
 287                         default:
 288                                 usage ();
 289                         }
 290                 }
 291 NXTARG:         ;
 292         }
 293
 294         if (argc != 1)
 295                 usage ();
 296
 297         /* set tparams as per input type_id */
 298         tparams = mkimage_get_type(params.type);
 299         if (tparams == NULL) {
 300                 fprintf (stderr, "%s: unsupported type %s\n",
 301                         params.cmdname, genimg_get_type_name(params.type));
 302                 exit (EXIT_FAILURE);
 303         }
 304
 305         /*
 306          * check the passed arguments parameters meets the requirements
 307          * as per image type to be generated/listed
 308          */
 309         if (tparams->check_params)
 310                 if (tparams->check_params (&params))
 311                         usage ();
 312
 313         if (!params.eflag) {
 314                 params.ep = params.addr;
 315                 /* If XIP, entry point must be after the U-Boot header */
 316                 if (params.xflag)
 317                         params.ep += tparams->header_size;
 318         }
 319
 320         params.imagefile = *argv;
 321
 322         if (params.fflag){
 323                 if (tparams->fflag_handle)
 324                         /*
 325                          * in some cases, some additional processing needs
 326                          * to be done if fflag is defined
 327                          *
 328                          * For ex. fit_handle_file for Fit file support
 329                          */
 330                         retval = tparams->fflag_handle(&params);
 331
 332                 if (retval != EXIT_SUCCESS)
 333                         exit (retval);
 334         }
 335
 336         if (params.lflag || params.fflag) {
 337                 ifd = open (params.imagefile, O_RDONLY|O_BINARY);
 338         } else {
 339                 ifd = open (params.imagefile,
 340                         O_RDWR|O_CREAT|O_TRUNC|O_BINARY, 0666);
 341         }
 342
 343         if (ifd < 0) {
 344                 fprintf (stderr, "%s: Can't open %s: %s\n",
 345                         params.cmdname, params.imagefile,
 346                         strerror(errno));
 347                 exit (EXIT_FAILURE);
 348         }
 349
 350         if (params.lflag || params.fflag) {
 351                 /*
 352                  * list header information of existing image
 353                  */
 354                 if (fstat(ifd, &sbuf) < 0) {
 355                         fprintf (stderr, "%s: Can't stat %s: %s\n",
 356                                 params.cmdname, params.imagefile,
 357                                 strerror(errno));
 358                         exit (EXIT_FAILURE);
 359                 }
 360
 361                 if ((unsigned)sbuf.st_size < tparams->header_size) {
 362                         fprintf (stderr,
 363                                 "%s: Bad size: \"%s\" is not valid image\n",
 364                                 params.cmdname, params.imagefile);
 365                         exit (EXIT_FAILURE);
 366                 }
 367
 368                 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, ifd, 0);
 369                 if (ptr == MAP_FAILED) {
 370                         fprintf (stderr, "%s: Can't read %s: %s\n",
 371                                 params.cmdname, params.imagefile,
 372                                 strerror(errno));
 373                         exit (EXIT_FAILURE);
 374                 }
 375
 376                 /*
 377                  * scan through mkimage registry for all supported image types
 378                  * and verify the input image file header for match
 379                  * Print the image information for matched image type
 380                  * Returns the error code if not matched
 381                  */
 382                 retval = mkimage_verify_print_header (ptr, &sbuf);
 383
 384                 (void) munmap((void *)ptr, sbuf.st_size);
 385                 (void) close (ifd);
 386
 387                 exit (retval);
 388         }
 389
 390         /*
 391          * In case there an header with a variable
 392          * length will be added, the corresponding
 393          * function is called. This is responsible to
 394          * allocate memory for the header itself.
 395          */
 396         if (tparams->vrec_header)
 397                 tparams->vrec_header(&params, tparams);
 398         else
 399                 memset(tparams->hdr, 0, tparams->header_size);
 400
 401         if (write(ifd, tparams->hdr, tparams->header_size)
 402                                         != tparams->header_size) {
 403                 fprintf (stderr, "%s: Write error on %s: %s\n",
 404                         params.cmdname, params.imagefile, strerror(errno));
 405                 exit (EXIT_FAILURE);
 406         }
 407
 408         if (!params.skipcpy) {
 409                 if (params.type == IH_TYPE_MULTI ||
 410                     params.type == IH_TYPE_SCRIPT) {
 411                         char *file = params.datafile;
 412                         uint32_t size;
 413
 414                         for (;;) {
 415                                 char *sep = NULL;
 416
 417                                 if (file) {
 418                                         if ((sep = strchr(file, ':')) != NULL) {
 419                                                 *sep = '\0';
 420                                         }
 421
 422                                         if (stat (file, &sbuf) < 0) {
 423                                                 fprintf (stderr, "%s: Can't stat %s: %s\n",
 424                                                          params.cmdname, file, strerror(errno));
 425                                                 exit (EXIT_FAILURE);
 426                                         }
 427                                         size = cpu_to_uimage (sbuf.st_size);
 428                                 } else {
 429                                         size = 0;
 430                                 }
 431
 432                                 if (write(ifd, (char *)&size, sizeof(size)) != sizeof(size)) {
 433                                         fprintf (stderr, "%s: Write error on %s: %s\n",
 434                                                  params.cmdname, params.imagefile,
 435                                                  strerror(errno));
 436                                         exit (EXIT_FAILURE);
 437                                 }
 438
 439                                 if (!file) {
 440                                         break;
 441                                 }
 442
 443                                 if (sep) {
 444                                         *sep = ':';
 445                                         file = sep + 1;
 446                                 } else {
 447                                         file = NULL;
 448                                 }
 449                         }
 450
 451                         file = params.datafile;
 452
 453                         for (;;) {
 454                                 char *sep = strchr(file, ':');
 455                                 if (sep) {
 456                                         *sep = '\0';
 457                                         copy_file (ifd, file, 1);
 458                                         *sep++ = ':';
 459                                         file = sep;
 460                                 } else {
 461                                         copy_file (ifd, file, 0);
 462                                         break;
 463                                 }
 464                         }
 465                 } else if (params.type == IH_TYPE_PBLIMAGE) {
 466                         /* PBL has special Image format, implements its' own */
 467                         pbl_load_uboot(ifd, &params);
 468                 } else {
 469                         copy_file (ifd, params.datafile, 0);
 470                 }
 471         }
 472
 473         /* We're a bit of paranoid */
 474 #if defined(_POSIX_SYNCHRONIZED_IO) && \
 475    !defined(__sun__) && \
 476    !defined(__FreeBSD__) && \
 477    !defined(__APPLE__)
 478         (void) fdatasync (ifd);
 479 #else
 480         (void) fsync (ifd);
 481 #endif
 482
 483         if (fstat(ifd, &sbuf) < 0) {
 484                 fprintf (stderr, "%s: Can't stat %s: %s\n",
 485                         params.cmdname, params.imagefile, strerror(errno));
 486                 exit (EXIT_FAILURE);
 487         }
 488
 489         ptr = mmap(0, sbuf.st_size, PROT_READ|PROT_WRITE, MAP_SHARED, ifd, 0);
 490         if (ptr == MAP_FAILED) {
 491                 fprintf (stderr, "%s: Can't map %s: %s\n",
 492                         params.cmdname, params.imagefile, strerror(errno));
 493                 exit (EXIT_FAILURE);
 494         }
 495
 496         /* Setup the image header as per input image type*/
 497         if (tparams->set_header)
 498                 tparams->set_header (ptr, &sbuf, ifd, &params);
 499         else {
 500                 fprintf (stderr, "%s: Can't set header for %s: %s\n",
 501                         params.cmdname, tparams->name, strerror(errno));
 502                 exit (EXIT_FAILURE);
 503         }
 504
 505         /* Print the image information by processing image header */
 506         if (tparams->print_header)
 507                 tparams->print_header (ptr);
 508         else {
 509                 fprintf (stderr, "%s: Can't print header for %s: %s\n",
 510                         params.cmdname, tparams->name, strerror(errno));
 511                 exit (EXIT_FAILURE);
 512         }
 513
 514         (void) munmap((void *)ptr, sbuf.st_size);
 515
 516         /* We're a bit of paranoid */
 517 #if defined(_POSIX_SYNCHRONIZED_IO) && \
 518    !defined(__sun__) && \
 519    !defined(__FreeBSD__) && \
 520    !defined(__APPLE__)
 521         (void) fdatasync (ifd);
 522 #else
 523         (void) fsync (ifd);
 524 #endif
 525
 526         if (close(ifd)) {
 527                 fprintf (stderr, "%s: Write error on %s: %s\n",
 528                         params.cmdname, params.imagefile, strerror(errno));
 529                 exit (EXIT_FAILURE);
 530         }
 531
 532         exit (EXIT_SUCCESS);
 533 }
 534
 535 static void
 536 copy_file (int ifd, const char *datafile, int pad)
 537 {
 538         int dfd;
 539         struct stat sbuf;
 540         unsigned char *ptr;
 541         int tail;
 542         int zero = 0;
 543         int offset = 0;
 544         int size;
 545         struct image_type_params *tparams = mkimage_get_type (params.type);
 546
 547         if (params.vflag) {
 548                 fprintf (stderr, "Adding Image %s\n", datafile);
 549         }
 550
 551         if ((dfd = open(datafile, O_RDONLY|O_BINARY)) < 0) {
 552                 fprintf (stderr, "%s: Can't open %s: %s\n",
 553                         params.cmdname, datafile, strerror(errno));
 554                 exit (EXIT_FAILURE);
 555         }
 556
 557         if (fstat(dfd, &sbuf) < 0) {
 558                 fprintf (stderr, "%s: Can't stat %s: %s\n",
 559                         params.cmdname, datafile, strerror(errno));
 560                 exit (EXIT_FAILURE);
 561         }
 562
 563         ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, dfd, 0);
 564         if (ptr == MAP_FAILED) {
 565                 fprintf (stderr, "%s: Can't read %s: %s\n",
 566                         params.cmdname, datafile, strerror(errno));
 567                 exit (EXIT_FAILURE);
 568         }
 569
 570         if (params.xflag) {
 571                 unsigned char *p = NULL;
 572                 /*
 573                  * XIP: do not append the image_header_t at the
 574                  * beginning of the file, but consume the space
 575                  * reserved for it.
 576                  */
 577
 578                 if ((unsigned)sbuf.st_size < tparams->header_size) {
 579                         fprintf (stderr,
 580                                 "%s: Bad size: \"%s\" is too small for XIP\n",
 581                                 params.cmdname, datafile);
 582                         exit (EXIT_FAILURE);
 583                 }
 584
 585                 for (p = ptr; p < ptr + tparams->header_size; p++) {
 586                         if ( *p != 0xff ) {
 587                                 fprintf (stderr,
 588                                         "%s: Bad file: \"%s\" has invalid buffer for XIP\n",
 589                                         params.cmdname, datafile);
 590                                 exit (EXIT_FAILURE);
 591                         }
 592                 }
 593
 594                 offset = tparams->header_size;
 595         }
 596
 597         size = sbuf.st_size - offset;
 598         if (write(ifd, ptr + offset, size) != size) {
 599                 fprintf (stderr, "%s: Write error on %s: %s\n",
 600                         params.cmdname, params.imagefile, strerror(errno));
 601                 exit (EXIT_FAILURE);
 602         }
 603
 604         if (pad && ((tail = size % 4) != 0)) {
 605
 606                 if (write(ifd, (char *)&zero, 4-tail) != 4-tail) {
 607                         fprintf (stderr, "%s: Write error on %s: %s\n",
 608                                 params.cmdname, params.imagefile,
 609                                 strerror(errno));
 610                         exit (EXIT_FAILURE);
 611                 }
 612         }
 613
 614         (void) munmap((void *)ptr, sbuf.st_size);
 615         (void) close (dfd);
 616 }
 617
 618 void
 619 usage ()
 620 {
 621         fprintf (stderr, "Usage: %s -l image\n"
 622                          "          -l ==> list image header information\n",
 623                 params.cmdname);
 624         fprintf (stderr, "       %s [-x] -A arch -O os -T type -C comp "
 625                          "-a addr -e ep -n name -d data_file[:data_file...] image\n"
 626                          "          -A ==> set architecture to 'arch'\n"
 627                          "          -O ==> set operating system to 'os'\n"
 628                          "          -T ==> set image type to 'type'\n"
 629                          "          -C ==> set compression type 'comp'\n"
 630                          "          -a ==> set load address to 'addr' (hex)\n"
 631                          "          -e ==> set entry point to 'ep' (hex)\n"
 632                          "          -n ==> set image name to 'name'\n"
 633                          "          -d ==> use image data from 'datafile'\n"
 634                          "          -x ==> set XIP (execute in place)\n",
 635                 params.cmdname);
 636         fprintf(stderr, "       %s [-D dtc_options] -f fit-image.its fit-image\n",
 637                 params.cmdname);
 638         fprintf(stderr, "          -D => set options for device tree compiler\n"
 639                         "          -f => input filename for FIT source\n");
 640 #ifdef CONFIG_FIT_SIGNATURE
 641         fprintf(stderr, "Signing / verified boot options: [-k keydir] [-K dtb]\n"
 642                         "          -k => set directory containing private keys\n"
 643                         "          -K => write public keys to this .dtb file\n");
 644 #else
 645         fprintf(stderr, "Signing / verified boot not supported (CONFIG_FIT_SIGNATURE undefined)\n");
 646 #endif
 647         fprintf (stderr, "       %s -V ==> print version information and exit\n",
 648                 params.cmdname);
 649
 650         exit (EXIT_FAILURE);
 651 }