]> git.ipfire.org Git - people/ms/u-boot.git/blame - tools/mkimage.c
arm, da850evm: Add an SPL for SPI boot
[people/ms/u-boot.git] / tools / mkimage.c
CommitLineData
5b1d7137 1/*
9d25438f
BS
2 * (C) Copyright 2008 Semihalf
3 *
89a4d6b1 4 * (C) Copyright 2000-2009
5b1d7137
WD
5 * DENX Software Engineering
6 * Wolfgang Denk, wd@denx.de
0c852a28
WD
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
5b1d7137
WD
22 */
23
b97a2a0a 24#include "mkimage.h"
5b1d7137 25#include <image.h>
976b38c0 26#include <version.h>
89a4d6b1
PW
27
28static void copy_file(int, const char *, int);
29static void usage(void);
30
31/* image_type_params link list to maintain registered image type supports */
32struct image_type_params *mkimage_tparams = NULL;
33
34/* parameters initialized by core will be used by the image type code */
35struct 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,
04387d24 41 .imagename = "",
89a4d6b1
PW
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 */
53void 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 */
91struct 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 */
114int 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}
5b1d7137
WD
143
144int
145main (int argc, char **argv)
146{
9d25438f 147 int ifd = -1;
5b1d7137 148 struct stat sbuf;
a2513e27 149 char *ptr;
449609f5 150 int retval = 0;
89a4d6b1 151 struct image_type_params *tparams = NULL;
5b1d7137 152
aa0c7a86
PW
153 /* Init Kirkwood Boot image generation/list support */
154 init_kwb_image_type ();
8edcde5e
SB
155 /* Init Freescale imx Boot image generation/list support */
156 init_imx_image_type ();
89a4d6b1
PW
157 /* Init FIT image generation/list support */
158 init_fit_image_type ();
3decb14a
JR
159 /* Init TI OMAP Boot image generation/list support */
160 init_omap_image_type();
89a4d6b1
PW
161 /* Init Default image generation/list support */
162 init_default_image_type ();
7816f2cf
HS
163 /* Init Davinci UBL support */
164 init_ubl_image_type();
4962e38e
SB
165 /* Init Davinci AIS support */
166 init_ais_image_type();
5b1d7137 167
89a4d6b1
PW
168 params.cmdname = *argv;
169 params.addr = params.ep = 0;
5b1d7137
WD
170
171 while (--argc > 0 && **++argv == '-') {
172 while (*++*argv) {
173 switch (**argv) {
174 case 'l':
89a4d6b1 175 params.lflag = 1;
5b1d7137
WD
176 break;
177 case 'A':
178 if ((--argc <= 0) ||
89a4d6b1
PW
179 (params.arch =
180 genimg_get_arch_id (*++argv)) < 0)
5b1d7137
WD
181 usage ();
182 goto NXTARG;
183 case 'C':
184 if ((--argc <= 0) ||
89a4d6b1
PW
185 (params.comp =
186 genimg_get_comp_id (*++argv)) < 0)
5b1d7137
WD
187 usage ();
188 goto NXTARG;
9d25438f
BS
189 case 'D':
190 if (--argc <= 0)
191 usage ();
89a4d6b1 192 params.dtc = *++argv;
9d25438f
BS
193 goto NXTARG;
194
5b1d7137
WD
195 case 'O':
196 if ((--argc <= 0) ||
89a4d6b1
PW
197 (params.os =
198 genimg_get_os_id (*++argv)) < 0)
5b1d7137
WD
199 usage ();
200 goto NXTARG;
201 case 'T':
202 if ((--argc <= 0) ||
89a4d6b1
PW
203 (params.type =
204 genimg_get_type_id (*++argv)) < 0)
5b1d7137
WD
205 usage ();
206 goto NXTARG;
207
208 case 'a':
209 if (--argc <= 0)
210 usage ();
a2513e27 211 params.addr = strtoul (*++argv, &ptr, 16);
5b1d7137
WD
212 if (*ptr) {
213 fprintf (stderr,
214 "%s: invalid load address %s\n",
89a4d6b1 215 params.cmdname, *argv);
5b1d7137
WD
216 exit (EXIT_FAILURE);
217 }
218 goto NXTARG;
219 case 'd':
220 if (--argc <= 0)
221 usage ();
89a4d6b1
PW
222 params.datafile = *++argv;
223 params.dflag = 1;
5b1d7137
WD
224 goto NXTARG;
225 case 'e':
226 if (--argc <= 0)
227 usage ();
a2513e27 228 params.ep = strtoul (*++argv, &ptr, 16);
5b1d7137
WD
229 if (*ptr) {
230 fprintf (stderr,
231 "%s: invalid entry point %s\n",
89a4d6b1 232 params.cmdname, *argv);
5b1d7137
WD
233 exit (EXIT_FAILURE);
234 }
89a4d6b1 235 params.eflag = 1;
5b1d7137 236 goto NXTARG;
9d25438f
BS
237 case 'f':
238 if (--argc <= 0)
239 usage ();
1a99de2c
PT
240 /*
241 * The flattened image tree (FIT) format
242 * requires a flattened device tree image type
243 */
244 params.type = IH_TYPE_FLATDT;
fbc1c8f6
PT
245 params.datafile = *++argv;
246 params.fflag = 1;
9d25438f 247 goto NXTARG;
5b1d7137
WD
248 case 'n':
249 if (--argc <= 0)
250 usage ();
89a4d6b1 251 params.imagename = *++argv;
5b1d7137 252 goto NXTARG;
f0662105
SB
253 case 's':
254 params.skipcpy = 1;
255 break;
5b1d7137 256 case 'v':
89a4d6b1 257 params.vflag++;
5b1d7137 258 break;
976b38c0
WD
259 case 'V':
260 printf("mkimage version %s\n", PLAIN_VERSION);
261 exit(EXIT_SUCCESS);
5b1d7137 262 case 'x':
89a4d6b1 263 params.xflag++;
5b1d7137
WD
264 break;
265 default:
266 usage ();
267 }
268 }
269NXTARG: ;
270 }
271
89a4d6b1
PW
272 if (argc != 1)
273 usage ();
274
275 /* set tparams as per input type_id */
276 tparams = mkimage_get_type(params.type);
277 if (tparams == NULL) {
278 fprintf (stderr, "%s: unsupported type %s\n",
279 params.cmdname, genimg_get_type_name(params.type));
280 exit (EXIT_FAILURE);
281 }
5b1d7137 282
89a4d6b1
PW
283 /*
284 * check the passed arguments parameters meets the requirements
285 * as per image type to be generated/listed
286 */
287 if (tparams->check_params)
288 if (tparams->check_params (&params))
289 usage ();
290
291 if (!params.eflag) {
292 params.ep = params.addr;
5b1d7137 293 /* If XIP, entry point must be after the U-Boot header */
89a4d6b1
PW
294 if (params.xflag)
295 params.ep += tparams->header_size;
5b1d7137
WD
296 }
297
89a4d6b1 298 params.imagefile = *argv;
5b1d7137 299
c81296c1
PT
300 if (params.fflag){
301 if (tparams->fflag_handle)
302 /*
303 * in some cases, some additional processing needs
304 * to be done if fflag is defined
305 *
306 * For ex. fit_handle_file for Fit file support
307 */
308 retval = tparams->fflag_handle(&params);
5b1d7137 309
c81296c1
PT
310 if (retval != EXIT_SUCCESS)
311 exit (retval);
312 }
313
314 if (params.lflag || params.fflag) {
315 ifd = open (params.imagefile, O_RDONLY|O_BINARY);
316 } else {
317 ifd = open (params.imagefile,
318 O_RDWR|O_CREAT|O_TRUNC|O_BINARY, 0666);
319 }
320
321 if (ifd < 0) {
322 fprintf (stderr, "%s: Can't open %s: %s\n",
323 params.cmdname, params.imagefile,
324 strerror(errno));
325 exit (EXIT_FAILURE);
5b1d7137
WD
326 }
327
c81296c1 328 if (params.lflag || params.fflag) {
5b1d7137
WD
329 /*
330 * list header information of existing image
331 */
332 if (fstat(ifd, &sbuf) < 0) {
333 fprintf (stderr, "%s: Can't stat %s: %s\n",
89a4d6b1
PW
334 params.cmdname, params.imagefile,
335 strerror(errno));
5b1d7137
WD
336 exit (EXIT_FAILURE);
337 }
338
89a4d6b1 339 if ((unsigned)sbuf.st_size < tparams->header_size) {
5b1d7137 340 fprintf (stderr,
89a4d6b1
PW
341 "%s: Bad size: \"%s\" is not valid image\n",
342 params.cmdname, params.imagefile);
5b1d7137
WD
343 exit (EXIT_FAILURE);
344 }
345
fa956fde
MF
346 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, ifd, 0);
347 if (ptr == MAP_FAILED) {
5b1d7137 348 fprintf (stderr, "%s: Can't read %s: %s\n",
89a4d6b1
PW
349 params.cmdname, params.imagefile,
350 strerror(errno));
5b1d7137
WD
351 exit (EXIT_FAILURE);
352 }
353
89a4d6b1
PW
354 /*
355 * scan through mkimage registry for all supported image types
356 * and verify the input image file header for match
357 * Print the image information for matched image type
358 * Returns the error code if not matched
359 */
360 retval = mkimage_verify_print_header (ptr, &sbuf);
5b1d7137 361
5b1d7137
WD
362 (void) munmap((void *)ptr, sbuf.st_size);
363 (void) close (ifd);
364
f7644c0b 365 exit (retval);
5b1d7137
WD
366 }
367
368 /*
f0662105
SB
369 * In case there an header with a variable
370 * length will be added, the corresponding
371 * function is called. This is responsible to
372 * allocate memory for the header itself.
5b1d7137 373 */
f0662105
SB
374 if (tparams->vrec_header)
375 tparams->vrec_header(&params, tparams);
376 else
377 memset(tparams->hdr, 0, tparams->header_size);
5b1d7137 378
89a4d6b1
PW
379 if (write(ifd, tparams->hdr, tparams->header_size)
380 != tparams->header_size) {
5b1d7137 381 fprintf (stderr, "%s: Write error on %s: %s\n",
89a4d6b1 382 params.cmdname, params.imagefile, strerror(errno));
5b1d7137
WD
383 exit (EXIT_FAILURE);
384 }
385
f0662105
SB
386 if (!params.skipcpy &&
387 (params.type == IH_TYPE_MULTI ||
388 params.type == IH_TYPE_SCRIPT)) {
89a4d6b1 389 char *file = params.datafile;
3bb66806 390 uint32_t size;
5b1d7137
WD
391
392 for (;;) {
393 char *sep = NULL;
394
395 if (file) {
396 if ((sep = strchr(file, ':')) != NULL) {
397 *sep = '\0';
398 }
399
400 if (stat (file, &sbuf) < 0) {
401 fprintf (stderr, "%s: Can't stat %s: %s\n",
89a4d6b1 402 params.cmdname, file, strerror(errno));
5b1d7137
WD
403 exit (EXIT_FAILURE);
404 }
9a4daad0 405 size = cpu_to_uimage (sbuf.st_size);
5b1d7137
WD
406 } else {
407 size = 0;
408 }
409
410 if (write(ifd, (char *)&size, sizeof(size)) != sizeof(size)) {
411 fprintf (stderr, "%s: Write error on %s: %s\n",
89a4d6b1
PW
412 params.cmdname, params.imagefile,
413 strerror(errno));
5b1d7137
WD
414 exit (EXIT_FAILURE);
415 }
416
417 if (!file) {
418 break;
419 }
420
421 if (sep) {
422 *sep = ':';
423 file = sep + 1;
424 } else {
425 file = NULL;
426 }
427 }
428
89a4d6b1 429 file = params.datafile;
5b1d7137
WD
430
431 for (;;) {
432 char *sep = strchr(file, ':');
433 if (sep) {
434 *sep = '\0';
435 copy_file (ifd, file, 1);
436 *sep++ = ':';
437 file = sep;
438 } else {
439 copy_file (ifd, file, 0);
440 break;
441 }
442 }
443 } else {
89a4d6b1 444 copy_file (ifd, params.datafile, 0);
5b1d7137
WD
445 }
446
447 /* We're a bit of paranoid */
89a4d6b1
PW
448#if defined(_POSIX_SYNCHRONIZED_IO) && \
449 !defined(__sun__) && \
450 !defined(__FreeBSD__) && \
451 !defined(__APPLE__)
5b1d7137
WD
452 (void) fdatasync (ifd);
453#else
454 (void) fsync (ifd);
455#endif
456
457 if (fstat(ifd, &sbuf) < 0) {
458 fprintf (stderr, "%s: Can't stat %s: %s\n",
89a4d6b1 459 params.cmdname, params.imagefile, strerror(errno));
5b1d7137
WD
460 exit (EXIT_FAILURE);
461 }
462
fa956fde
MF
463 ptr = mmap(0, sbuf.st_size, PROT_READ|PROT_WRITE, MAP_SHARED, ifd, 0);
464 if (ptr == MAP_FAILED) {
5b1d7137 465 fprintf (stderr, "%s: Can't map %s: %s\n",
89a4d6b1 466 params.cmdname, params.imagefile, strerror(errno));
5b1d7137
WD
467 exit (EXIT_FAILURE);
468 }
469
89a4d6b1
PW
470 /* Setup the image header as per input image type*/
471 if (tparams->set_header)
472 tparams->set_header (ptr, &sbuf, ifd, &params);
473 else {
474 fprintf (stderr, "%s: Can't set header for %s: %s\n",
475 params.cmdname, tparams->name, strerror(errno));
476 exit (EXIT_FAILURE);
477 }
5b1d7137 478
89a4d6b1
PW
479 /* Print the image information by processing image header */
480 if (tparams->print_header)
481 tparams->print_header (ptr);
482 else {
483 fprintf (stderr, "%s: Can't print header for %s: %s\n",
484 params.cmdname, tparams->name, strerror(errno));
485 exit (EXIT_FAILURE);
486 }
5b1d7137
WD
487
488 (void) munmap((void *)ptr, sbuf.st_size);
489
490 /* We're a bit of paranoid */
89a4d6b1
PW
491#if defined(_POSIX_SYNCHRONIZED_IO) && \
492 !defined(__sun__) && \
493 !defined(__FreeBSD__) && \
494 !defined(__APPLE__)
5b1d7137
WD
495 (void) fdatasync (ifd);
496#else
497 (void) fsync (ifd);
498#endif
499
500 if (close(ifd)) {
501 fprintf (stderr, "%s: Write error on %s: %s\n",
89a4d6b1 502 params.cmdname, params.imagefile, strerror(errno));
5b1d7137
WD
503 exit (EXIT_FAILURE);
504 }
505
506 exit (EXIT_SUCCESS);
507}
508
509static void
510copy_file (int ifd, const char *datafile, int pad)
511{
512 int dfd;
513 struct stat sbuf;
514 unsigned char *ptr;
515 int tail;
516 int zero = 0;
517 int offset = 0;
518 int size;
89a4d6b1 519 struct image_type_params *tparams = mkimage_get_type (params.type);
5b1d7137 520
89a4d6b1 521 if (params.vflag) {
5b1d7137
WD
522 fprintf (stderr, "Adding Image %s\n", datafile);
523 }
524
ef1464cc 525 if ((dfd = open(datafile, O_RDONLY|O_BINARY)) < 0) {
5b1d7137 526 fprintf (stderr, "%s: Can't open %s: %s\n",
89a4d6b1 527 params.cmdname, datafile, strerror(errno));
5b1d7137
WD
528 exit (EXIT_FAILURE);
529 }
530
531 if (fstat(dfd, &sbuf) < 0) {
532 fprintf (stderr, "%s: Can't stat %s: %s\n",
89a4d6b1 533 params.cmdname, datafile, strerror(errno));
5b1d7137
WD
534 exit (EXIT_FAILURE);
535 }
536
fa956fde
MF
537 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, dfd, 0);
538 if (ptr == MAP_FAILED) {
5b1d7137 539 fprintf (stderr, "%s: Can't read %s: %s\n",
89a4d6b1 540 params.cmdname, datafile, strerror(errno));
5b1d7137
WD
541 exit (EXIT_FAILURE);
542 }
543
89a4d6b1 544 if (params.xflag) {
5b1d7137
WD
545 unsigned char *p = NULL;
546 /*
547 * XIP: do not append the image_header_t at the
548 * beginning of the file, but consume the space
549 * reserved for it.
550 */
551
89a4d6b1 552 if ((unsigned)sbuf.st_size < tparams->header_size) {
5b1d7137
WD
553 fprintf (stderr,
554 "%s: Bad size: \"%s\" is too small for XIP\n",
89a4d6b1 555 params.cmdname, datafile);
5b1d7137
WD
556 exit (EXIT_FAILURE);
557 }
558
89a4d6b1 559 for (p = ptr; p < ptr + tparams->header_size; p++) {
5b1d7137
WD
560 if ( *p != 0xff ) {
561 fprintf (stderr,
562 "%s: Bad file: \"%s\" has invalid buffer for XIP\n",
89a4d6b1 563 params.cmdname, datafile);
5b1d7137
WD
564 exit (EXIT_FAILURE);
565 }
566 }
567
89a4d6b1 568 offset = tparams->header_size;
5b1d7137
WD
569 }
570
571 size = sbuf.st_size - offset;
572 if (write(ifd, ptr + offset, size) != size) {
573 fprintf (stderr, "%s: Write error on %s: %s\n",
89a4d6b1 574 params.cmdname, params.imagefile, strerror(errno));
5b1d7137
WD
575 exit (EXIT_FAILURE);
576 }
577
578 if (pad && ((tail = size % 4) != 0)) {
579
580 if (write(ifd, (char *)&zero, 4-tail) != 4-tail) {
581 fprintf (stderr, "%s: Write error on %s: %s\n",
89a4d6b1
PW
582 params.cmdname, params.imagefile,
583 strerror(errno));
5b1d7137
WD
584 exit (EXIT_FAILURE);
585 }
586 }
587
588 (void) munmap((void *)ptr, sbuf.st_size);
589 (void) close (dfd);
590}
591
592void
593usage ()
594{
595 fprintf (stderr, "Usage: %s -l image\n"
9d25438f 596 " -l ==> list image header information\n",
89a4d6b1 597 params.cmdname);
9d25438f
BS
598 fprintf (stderr, " %s [-x] -A arch -O os -T type -C comp "
599 "-a addr -e ep -n name -d data_file[:data_file...] image\n"
600 " -A ==> set architecture to 'arch'\n"
5b1d7137
WD
601 " -O ==> set operating system to 'os'\n"
602 " -T ==> set image type to 'type'\n"
603 " -C ==> set compression type 'comp'\n"
604 " -a ==> set load address to 'addr' (hex)\n"
605 " -e ==> set entry point to 'ep' (hex)\n"
606 " -n ==> set image name to 'name'\n"
607 " -d ==> use image data from 'datafile'\n"
9d25438f 608 " -x ==> set XIP (execute in place)\n",
89a4d6b1 609 params.cmdname);
9d25438f 610 fprintf (stderr, " %s [-D dtc_options] -f fit-image.its fit-image\n",
89a4d6b1 611 params.cmdname);
976b38c0
WD
612 fprintf (stderr, " %s -V ==> print version information and exit\n",
613 params.cmdname);
9d25438f 614
5b1d7137
WD
615 exit (EXIT_FAILURE);
616}