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