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