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 'n':
 257                                 if (--argc <= 0)
 258                                         usage ();
 259                                 params.imagename = *++argv;
 260                                 goto NXTARG;
 261                         case 'R':
 262                                 if (--argc <= 0)
 263                                         usage();
 264                                 /*
 265                                  * This entry is for the second configuration
 266                                  * file, if only one is not enough.
 267                                  */
 268                                 params.imagename2 = *++argv;
 269                                 goto NXTARG;
 270                         case 's':
 271                                 params.skipcpy = 1;
 272                                 break;
 273                         case 'v':
 274                                 params.vflag++;
 275                                 break;
 276                         case 'V':
 277                                 printf("mkimage version %s\n", PLAIN_VERSION);
 278                                 exit(EXIT_SUCCESS);
 279                         case 'x':
 280                                 params.xflag++;
 281                                 break;
 282                         default:
 283                                 usage ();
 284                         }
 285                 }
 286 NXTARG:         ;
 287         }
 288
 289         if (argc != 1)
 290                 usage ();
 291
 292         /* set tparams as per input type_id */
 293         tparams = mkimage_get_type(params.type);
 294         if (tparams == NULL) {
 295                 fprintf (stderr, "%s: unsupported type %s\n",
 296                         params.cmdname, genimg_get_type_name(params.type));
 297                 exit (EXIT_FAILURE);
 298         }
 299
 300         /*
 301          * check the passed arguments parameters meets the requirements
 302          * as per image type to be generated/listed
 303          */
 304         if (tparams->check_params)
 305                 if (tparams->check_params (&params))
 306                         usage ();
 307
 308         if (!params.eflag) {
 309                 params.ep = params.addr;
 310                 /* If XIP, entry point must be after the U-Boot header */
 311                 if (params.xflag)
 312                         params.ep += tparams->header_size;
 313         }
 314
 315         params.imagefile = *argv;
 316
 317         if (params.fflag){
 318                 if (tparams->fflag_handle)
 319                         /*
 320                          * in some cases, some additional processing needs
 321                          * to be done if fflag is defined
 322                          *
 323                          * For ex. fit_handle_file for Fit file support
 324                          */
 325                         retval = tparams->fflag_handle(&params);
 326
 327                 if (retval != EXIT_SUCCESS)
 328                         exit (retval);
 329         }
 330
 331         if (params.lflag || params.fflag) {
 332                 ifd = open (params.imagefile, O_RDONLY|O_BINARY);
 333         } else {
 334                 ifd = open (params.imagefile,
 335                         O_RDWR|O_CREAT|O_TRUNC|O_BINARY, 0666);
 336         }
 337
 338         if (ifd < 0) {
 339                 fprintf (stderr, "%s: Can't open %s: %s\n",
 340                         params.cmdname, params.imagefile,
 341                         strerror(errno));
 342                 exit (EXIT_FAILURE);
 343         }
 344
 345         if (params.lflag || params.fflag) {
 346                 /*
 347                  * list header information of existing image
 348                  */
 349                 if (fstat(ifd, &sbuf) < 0) {
 350                         fprintf (stderr, "%s: Can't stat %s: %s\n",
 351                                 params.cmdname, params.imagefile,
 352                                 strerror(errno));
 353                         exit (EXIT_FAILURE);
 354                 }
 355
 356                 if ((unsigned)sbuf.st_size < tparams->header_size) {
 357                         fprintf (stderr,
 358                                 "%s: Bad size: \"%s\" is not valid image\n",
 359                                 params.cmdname, params.imagefile);
 360                         exit (EXIT_FAILURE);
 361                 }
 362
 363                 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, ifd, 0);
 364                 if (ptr == MAP_FAILED) {
 365                         fprintf (stderr, "%s: Can't read %s: %s\n",
 366                                 params.cmdname, params.imagefile,
 367                                 strerror(errno));
 368                         exit (EXIT_FAILURE);
 369                 }
 370
 371                 /*
 372                  * scan through mkimage registry for all supported image types
 373                  * and verify the input image file header for match
 374                  * Print the image information for matched image type
 375                  * Returns the error code if not matched
 376                  */
 377                 retval = mkimage_verify_print_header (ptr, &sbuf);
 378
 379                 (void) munmap((void *)ptr, sbuf.st_size);
 380                 (void) close (ifd);
 381
 382                 exit (retval);
 383         }
 384
 385         /*
 386          * In case there an header with a variable
 387          * length will be added, the corresponding
 388          * function is called. This is responsible to
 389          * allocate memory for the header itself.
 390          */
 391         if (tparams->vrec_header)
 392                 tparams->vrec_header(&params, tparams);
 393         else
 394                 memset(tparams->hdr, 0, tparams->header_size);
 395
 396         if (write(ifd, tparams->hdr, tparams->header_size)
 397                                         != tparams->header_size) {
 398                 fprintf (stderr, "%s: Write error on %s: %s\n",
 399                         params.cmdname, params.imagefile, strerror(errno));
 400                 exit (EXIT_FAILURE);
 401         }
 402
 403         if (!params.skipcpy) {
 404                 if (params.type == IH_TYPE_MULTI ||
 405                     params.type == IH_TYPE_SCRIPT) {
 406                         char *file = params.datafile;
 407                         uint32_t size;
 408
 409                         for (;;) {
 410                                 char *sep = NULL;
 411
 412                                 if (file) {
 413                                         if ((sep = strchr(file, ':')) != NULL) {
 414                                                 *sep = '\0';
 415                                         }
 416
 417                                         if (stat (file, &sbuf) < 0) {
 418                                                 fprintf (stderr, "%s: Can't stat %s: %s\n",
 419                                                          params.cmdname, file, strerror(errno));
 420                                                 exit (EXIT_FAILURE);
 421                                         }
 422                                         size = cpu_to_uimage (sbuf.st_size);
 423                                 } else {
 424                                         size = 0;
 425                                 }
 426
 427                                 if (write(ifd, (char *)&size, sizeof(size)) != sizeof(size)) {
 428                                         fprintf (stderr, "%s: Write error on %s: %s\n",
 429                                                  params.cmdname, params.imagefile,
 430                                                  strerror(errno));
 431                                         exit (EXIT_FAILURE);
 432                                 }
 433
 434                                 if (!file) {
 435                                         break;
 436                                 }
 437
 438                                 if (sep) {
 439                                         *sep = ':';
 440                                         file = sep + 1;
 441                                 } else {
 442                                         file = NULL;
 443                                 }
 444                         }
 445
 446                         file = params.datafile;
 447
 448                         for (;;) {
 449                                 char *sep = strchr(file, ':');
 450                                 if (sep) {
 451                                         *sep = '\0';
 452                                         copy_file (ifd, file, 1);
 453                                         *sep++ = ':';
 454                                         file = sep;
 455                                 } else {
 456                                         copy_file (ifd, file, 0);
 457                                         break;
 458                                 }
 459                         }
 460                 } else if (params.type == IH_TYPE_PBLIMAGE) {
 461                         /* PBL has special Image format, implements its' own */
 462                         pbl_load_uboot(ifd, &params);
 463                 } else {
 464                         copy_file (ifd, params.datafile, 0);
 465                 }
 466         }
 467
 468         /* We're a bit of paranoid */
 469 #if defined(_POSIX_SYNCHRONIZED_IO) && \
 470    !defined(__sun__) && \
 471    !defined(__FreeBSD__) && \
 472    !defined(__APPLE__)
 473         (void) fdatasync (ifd);
 474 #else
 475         (void) fsync (ifd);
 476 #endif
 477
 478         if (fstat(ifd, &sbuf) < 0) {
 479                 fprintf (stderr, "%s: Can't stat %s: %s\n",
 480                         params.cmdname, params.imagefile, strerror(errno));
 481                 exit (EXIT_FAILURE);
 482         }
 483
 484         ptr = mmap(0, sbuf.st_size, PROT_READ|PROT_WRITE, MAP_SHARED, ifd, 0);
 485         if (ptr == MAP_FAILED) {
 486                 fprintf (stderr, "%s: Can't map %s: %s\n",
 487                         params.cmdname, params.imagefile, strerror(errno));
 488                 exit (EXIT_FAILURE);
 489         }
 490
 491         /* Setup the image header as per input image type*/
 492         if (tparams->set_header)
 493                 tparams->set_header (ptr, &sbuf, ifd, &params);
 494         else {
 495                 fprintf (stderr, "%s: Can't set header for %s: %s\n",
 496                         params.cmdname, tparams->name, strerror(errno));
 497                 exit (EXIT_FAILURE);
 498         }
 499
 500         /* Print the image information by processing image header */
 501         if (tparams->print_header)
 502                 tparams->print_header (ptr);
 503         else {
 504                 fprintf (stderr, "%s: Can't print header for %s: %s\n",
 505                         params.cmdname, tparams->name, strerror(errno));
 506                 exit (EXIT_FAILURE);
 507         }
 508
 509         (void) munmap((void *)ptr, sbuf.st_size);
 510
 511         /* We're a bit of paranoid */
 512 #if defined(_POSIX_SYNCHRONIZED_IO) && \
 513    !defined(__sun__) && \
 514    !defined(__FreeBSD__) && \
 515    !defined(__APPLE__)
 516         (void) fdatasync (ifd);
 517 #else
 518         (void) fsync (ifd);
 519 #endif
 520
 521         if (close(ifd)) {
 522                 fprintf (stderr, "%s: Write error on %s: %s\n",
 523                         params.cmdname, params.imagefile, strerror(errno));
 524                 exit (EXIT_FAILURE);
 525         }
 526
 527         exit (EXIT_SUCCESS);
 528 }
 529
 530 static void
 531 copy_file (int ifd, const char *datafile, int pad)
 532 {
 533         int dfd;
 534         struct stat sbuf;
 535         unsigned char *ptr;
 536         int tail;
 537         int zero = 0;
 538         int offset = 0;
 539         int size;
 540         struct image_type_params *tparams = mkimage_get_type (params.type);
 541
 542         if (params.vflag) {
 543                 fprintf (stderr, "Adding Image %s\n", datafile);
 544         }
 545
 546         if ((dfd = open(datafile, O_RDONLY|O_BINARY)) < 0) {
 547                 fprintf (stderr, "%s: Can't open %s: %s\n",
 548                         params.cmdname, datafile, strerror(errno));
 549                 exit (EXIT_FAILURE);
 550         }
 551
 552         if (fstat(dfd, &sbuf) < 0) {
 553                 fprintf (stderr, "%s: Can't stat %s: %s\n",
 554                         params.cmdname, datafile, strerror(errno));
 555                 exit (EXIT_FAILURE);
 556         }
 557
 558         ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, dfd, 0);
 559         if (ptr == MAP_FAILED) {
 560                 fprintf (stderr, "%s: Can't read %s: %s\n",
 561                         params.cmdname, datafile, strerror(errno));
 562                 exit (EXIT_FAILURE);
 563         }
 564
 565         if (params.xflag) {
 566                 unsigned char *p = NULL;
 567                 /*
 568                  * XIP: do not append the image_header_t at the
 569                  * beginning of the file, but consume the space
 570                  * reserved for it.
 571                  */
 572
 573                 if ((unsigned)sbuf.st_size < tparams->header_size) {
 574                         fprintf (stderr,
 575                                 "%s: Bad size: \"%s\" is too small for XIP\n",
 576                                 params.cmdname, datafile);
 577                         exit (EXIT_FAILURE);
 578                 }
 579
 580                 for (p = ptr; p < ptr + tparams->header_size; p++) {
 581                         if ( *p != 0xff ) {
 582                                 fprintf (stderr,
 583                                         "%s: Bad file: \"%s\" has invalid buffer for XIP\n",
 584                                         params.cmdname, datafile);
 585                                 exit (EXIT_FAILURE);
 586                         }
 587                 }
 588
 589                 offset = tparams->header_size;
 590         }
 591
 592         size = sbuf.st_size - offset;
 593         if (write(ifd, ptr + offset, size) != size) {
 594                 fprintf (stderr, "%s: Write error on %s: %s\n",
 595                         params.cmdname, params.imagefile, strerror(errno));
 596                 exit (EXIT_FAILURE);
 597         }
 598
 599         if (pad && ((tail = size % 4) != 0)) {
 600
 601                 if (write(ifd, (char *)&zero, 4-tail) != 4-tail) {
 602                         fprintf (stderr, "%s: Write error on %s: %s\n",
 603                                 params.cmdname, params.imagefile,
 604                                 strerror(errno));
 605                         exit (EXIT_FAILURE);
 606                 }
 607         }
 608
 609         (void) munmap((void *)ptr, sbuf.st_size);
 610         (void) close (dfd);
 611 }
 612
 613 void
 614 usage ()
 615 {
 616         fprintf (stderr, "Usage: %s -l image\n"
 617                          "          -l ==> list image header information\n",
 618                 params.cmdname);
 619         fprintf (stderr, "       %s [-x] -A arch -O os -T type -C comp "
 620                          "-a addr -e ep -n name -d data_file[:data_file...] image\n"
 621                          "          -A ==> set architecture to 'arch'\n"
 622                          "          -O ==> set operating system to 'os'\n"
 623                          "          -T ==> set image type to 'type'\n"
 624                          "          -C ==> set compression type 'comp'\n"
 625                          "          -a ==> set load address to 'addr' (hex)\n"
 626                          "          -e ==> set entry point to 'ep' (hex)\n"
 627                          "          -n ==> set image name to 'name'\n"
 628                          "          -d ==> use image data from 'datafile'\n"
 629                          "          -x ==> set XIP (execute in place)\n",
 630                 params.cmdname);
 631         fprintf(stderr, "       %s [-D dtc_options] -f fit-image.its fit-image\n",
 632                 params.cmdname);
 633         fprintf(stderr, "          -D => set options for device tree compiler\n"
 634                         "          -f => input filename for FIT source\n");
 635 #ifdef CONFIG_FIT_SIGNATURE
 636         fprintf(stderr, "Signing / verified boot options: [-k keydir]\n"
 637                         "          -k => set directory containing private keys\n");
 638 #else
 639         fprintf(stderr, "Signing / verified boot not supported (CONFIG_FIT_SIGNATURE undefined)\n");
 640 #endif
 641         fprintf (stderr, "       %s -V ==> print version information and exit\n",
 642                 params.cmdname);
 643
 644         exit (EXIT_FAILURE);
 645 }