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