Merge branch 'master' of git://git.denx.de/u-boot-spi
[platform/kernel/u-boot.git] / common / image.c
1 /*
2  * (C) Copyright 2008 Semihalf
3  *
4  * (C) Copyright 2000-2006
5  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
6  *
7  * SPDX-License-Identifier:     GPL-2.0+
8  */
9
10 #ifndef USE_HOSTCC
11 #include <common.h>
12 #include <watchdog.h>
13
14 #ifdef CONFIG_SHOW_BOOT_PROGRESS
15 #include <status_led.h>
16 #endif
17
18 #ifdef CONFIG_HAS_DATAFLASH
19 #include <dataflash.h>
20 #endif
21
22 #ifdef CONFIG_LOGBUFFER
23 #include <logbuff.h>
24 #endif
25
26 #include <rtc.h>
27
28 #include <environment.h>
29 #include <image.h>
30
31 #if defined(CONFIG_FIT) || defined(CONFIG_OF_LIBFDT)
32 #include <libfdt.h>
33 #include <fdt_support.h>
34 #endif
35
36 #include <u-boot/md5.h>
37 #include <u-boot/sha1.h>
38 #include <asm/errno.h>
39 #include <asm/io.h>
40
41 #ifdef CONFIG_CMD_BDI
42 extern int do_bdinfo(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
43 #endif
44
45 DECLARE_GLOBAL_DATA_PTR;
46
47 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
48 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
49                                                 int verify);
50 #endif
51 #else
52 #include "mkimage.h"
53 #include <u-boot/md5.h>
54 #include <time.h>
55 #include <image.h>
56 #endif /* !USE_HOSTCC*/
57
58 #include <u-boot/crc.h>
59
60 #ifndef CONFIG_SYS_BARGSIZE
61 #define CONFIG_SYS_BARGSIZE 512
62 #endif
63
64 static const table_entry_t uimage_arch[] = {
65         {       IH_ARCH_INVALID,        NULL,           "Invalid ARCH", },
66         {       IH_ARCH_ALPHA,          "alpha",        "Alpha",        },
67         {       IH_ARCH_ARM,            "arm",          "ARM",          },
68         {       IH_ARCH_I386,           "x86",          "Intel x86",    },
69         {       IH_ARCH_IA64,           "ia64",         "IA64",         },
70         {       IH_ARCH_M68K,           "m68k",         "M68K",         },
71         {       IH_ARCH_MICROBLAZE,     "microblaze",   "MicroBlaze",   },
72         {       IH_ARCH_MIPS,           "mips",         "MIPS",         },
73         {       IH_ARCH_MIPS64,         "mips64",       "MIPS 64 Bit",  },
74         {       IH_ARCH_NIOS2,          "nios2",        "NIOS II",      },
75         {       IH_ARCH_PPC,            "powerpc",      "PowerPC",      },
76         {       IH_ARCH_PPC,            "ppc",          "PowerPC",      },
77         {       IH_ARCH_S390,           "s390",         "IBM S390",     },
78         {       IH_ARCH_SH,             "sh",           "SuperH",       },
79         {       IH_ARCH_SPARC,          "sparc",        "SPARC",        },
80         {       IH_ARCH_SPARC64,        "sparc64",      "SPARC 64 Bit", },
81         {       IH_ARCH_BLACKFIN,       "blackfin",     "Blackfin",     },
82         {       IH_ARCH_AVR32,          "avr32",        "AVR32",        },
83         {       IH_ARCH_NDS32,          "nds32",        "NDS32",        },
84         {       IH_ARCH_OPENRISC,       "or1k",         "OpenRISC 1000",},
85         {       IH_ARCH_SANDBOX,        "sandbox",      "Sandbox",      },
86         {       IH_ARCH_ARM64,          "arm64",        "AArch64",      },
87         {       IH_ARCH_ARC,            "arc",          "ARC",          },
88         {       IH_ARCH_X86_64,         "x86_64",       "AMD x86_64",   },
89         {       -1,                     "",             "",             },
90 };
91
92 static const table_entry_t uimage_os[] = {
93         {       IH_OS_INVALID,  NULL,           "Invalid OS",           },
94         {       IH_OS_LINUX,    "linux",        "Linux",                },
95 #if defined(CONFIG_LYNXKDI) || defined(USE_HOSTCC)
96         {       IH_OS_LYNXOS,   "lynxos",       "LynxOS",               },
97 #endif
98         {       IH_OS_NETBSD,   "netbsd",       "NetBSD",               },
99         {       IH_OS_OSE,      "ose",          "Enea OSE",             },
100         {       IH_OS_PLAN9,    "plan9",        "Plan 9",               },
101         {       IH_OS_RTEMS,    "rtems",        "RTEMS",                },
102         {       IH_OS_U_BOOT,   "u-boot",       "U-Boot",               },
103         {       IH_OS_VXWORKS,  "vxworks",      "VxWorks",              },
104 #if defined(CONFIG_CMD_ELF) || defined(USE_HOSTCC)
105         {       IH_OS_QNX,      "qnx",          "QNX",                  },
106 #endif
107 #if defined(CONFIG_INTEGRITY) || defined(USE_HOSTCC)
108         {       IH_OS_INTEGRITY,"integrity",    "INTEGRITY",            },
109 #endif
110 #ifdef USE_HOSTCC
111         {       IH_OS_4_4BSD,   "4_4bsd",       "4_4BSD",               },
112         {       IH_OS_DELL,     "dell",         "Dell",                 },
113         {       IH_OS_ESIX,     "esix",         "Esix",                 },
114         {       IH_OS_FREEBSD,  "freebsd",      "FreeBSD",              },
115         {       IH_OS_IRIX,     "irix",         "Irix",                 },
116         {       IH_OS_NCR,      "ncr",          "NCR",                  },
117         {       IH_OS_OPENBSD,  "openbsd",      "OpenBSD",              },
118         {       IH_OS_PSOS,     "psos",         "pSOS",                 },
119         {       IH_OS_SCO,      "sco",          "SCO",                  },
120         {       IH_OS_SOLARIS,  "solaris",      "Solaris",              },
121         {       IH_OS_SVR4,     "svr4",         "SVR4",                 },
122 #endif
123         {       -1,             "",             "",                     },
124 };
125
126 static const table_entry_t uimage_type[] = {
127         {       IH_TYPE_AISIMAGE,   "aisimage",   "Davinci AIS image",},
128         {       IH_TYPE_FILESYSTEM, "filesystem", "Filesystem Image",   },
129         {       IH_TYPE_FIRMWARE,   "firmware",   "Firmware",           },
130         {       IH_TYPE_FLATDT,     "flat_dt",    "Flat Device Tree",   },
131         {       IH_TYPE_GPIMAGE,    "gpimage",    "TI Keystone SPL Image",},
132         {       IH_TYPE_KERNEL,     "kernel",     "Kernel Image",       },
133         {       IH_TYPE_KERNEL_NOLOAD, "kernel_noload",  "Kernel Image (no loading done)", },
134         {       IH_TYPE_KWBIMAGE,   "kwbimage",   "Kirkwood Boot Image",},
135         {       IH_TYPE_IMXIMAGE,   "imximage",   "Freescale i.MX Boot Image",},
136         {       IH_TYPE_INVALID,    NULL,         "Invalid Image",      },
137         {       IH_TYPE_MULTI,      "multi",      "Multi-File Image",   },
138         {       IH_TYPE_OMAPIMAGE,  "omapimage",  "TI OMAP SPL With GP CH",},
139         {       IH_TYPE_PBLIMAGE,   "pblimage",   "Freescale PBL Boot Image",},
140         {       IH_TYPE_RAMDISK,    "ramdisk",    "RAMDisk Image",      },
141         {       IH_TYPE_SCRIPT,     "script",     "Script",             },
142         {       IH_TYPE_SOCFPGAIMAGE, "socfpgaimage", "Altera SOCFPGA preloader",},
143         {       IH_TYPE_STANDALONE, "standalone", "Standalone Program", },
144         {       IH_TYPE_UBLIMAGE,   "ublimage",   "Davinci UBL image",},
145         {       IH_TYPE_MXSIMAGE,   "mxsimage",   "Freescale MXS Boot Image",},
146         {       IH_TYPE_ATMELIMAGE, "atmelimage", "ATMEL ROM-Boot Image",},
147         {       IH_TYPE_X86_SETUP,  "x86_setup",  "x86 setup.bin",    },
148         {       -1,                 "",           "",                   },
149 };
150
151 static const table_entry_t uimage_comp[] = {
152         {       IH_COMP_NONE,   "none",         "uncompressed",         },
153         {       IH_COMP_BZIP2,  "bzip2",        "bzip2 compressed",     },
154         {       IH_COMP_GZIP,   "gzip",         "gzip compressed",      },
155         {       IH_COMP_LZMA,   "lzma",         "lzma compressed",      },
156         {       IH_COMP_LZO,    "lzo",          "lzo compressed",       },
157         {       -1,             "",             "",                     },
158 };
159
160 /*****************************************************************************/
161 /* Legacy format routines */
162 /*****************************************************************************/
163 int image_check_hcrc(const image_header_t *hdr)
164 {
165         ulong hcrc;
166         ulong len = image_get_header_size();
167         image_header_t header;
168
169         /* Copy header so we can blank CRC field for re-calculation */
170         memmove(&header, (char *)hdr, image_get_header_size());
171         image_set_hcrc(&header, 0);
172
173         hcrc = crc32(0, (unsigned char *)&header, len);
174
175         return (hcrc == image_get_hcrc(hdr));
176 }
177
178 int image_check_dcrc(const image_header_t *hdr)
179 {
180         ulong data = image_get_data(hdr);
181         ulong len = image_get_data_size(hdr);
182         ulong dcrc = crc32_wd(0, (unsigned char *)data, len, CHUNKSZ_CRC32);
183
184         return (dcrc == image_get_dcrc(hdr));
185 }
186
187 /**
188  * image_multi_count - get component (sub-image) count
189  * @hdr: pointer to the header of the multi component image
190  *
191  * image_multi_count() returns number of components in a multi
192  * component image.
193  *
194  * Note: no checking of the image type is done, caller must pass
195  * a valid multi component image.
196  *
197  * returns:
198  *     number of components
199  */
200 ulong image_multi_count(const image_header_t *hdr)
201 {
202         ulong i, count = 0;
203         uint32_t *size;
204
205         /* get start of the image payload, which in case of multi
206          * component images that points to a table of component sizes */
207         size = (uint32_t *)image_get_data(hdr);
208
209         /* count non empty slots */
210         for (i = 0; size[i]; ++i)
211                 count++;
212
213         return count;
214 }
215
216 /**
217  * image_multi_getimg - get component data address and size
218  * @hdr: pointer to the header of the multi component image
219  * @idx: index of the requested component
220  * @data: pointer to a ulong variable, will hold component data address
221  * @len: pointer to a ulong variable, will hold component size
222  *
223  * image_multi_getimg() returns size and data address for the requested
224  * component in a multi component image.
225  *
226  * Note: no checking of the image type is done, caller must pass
227  * a valid multi component image.
228  *
229  * returns:
230  *     data address and size of the component, if idx is valid
231  *     0 in data and len, if idx is out of range
232  */
233 void image_multi_getimg(const image_header_t *hdr, ulong idx,
234                         ulong *data, ulong *len)
235 {
236         int i;
237         uint32_t *size;
238         ulong offset, count, img_data;
239
240         /* get number of component */
241         count = image_multi_count(hdr);
242
243         /* get start of the image payload, which in case of multi
244          * component images that points to a table of component sizes */
245         size = (uint32_t *)image_get_data(hdr);
246
247         /* get address of the proper component data start, which means
248          * skipping sizes table (add 1 for last, null entry) */
249         img_data = image_get_data(hdr) + (count + 1) * sizeof(uint32_t);
250
251         if (idx < count) {
252                 *len = uimage_to_cpu(size[idx]);
253                 offset = 0;
254
255                 /* go over all indices preceding requested component idx */
256                 for (i = 0; i < idx; i++) {
257                         /* add up i-th component size, rounding up to 4 bytes */
258                         offset += (uimage_to_cpu(size[i]) + 3) & ~3 ;
259                 }
260
261                 /* calculate idx-th component data address */
262                 *data = img_data + offset;
263         } else {
264                 *len = 0;
265                 *data = 0;
266         }
267 }
268
269 static void image_print_type(const image_header_t *hdr)
270 {
271         const char *os, *arch, *type, *comp;
272
273         os = genimg_get_os_name(image_get_os(hdr));
274         arch = genimg_get_arch_name(image_get_arch(hdr));
275         type = genimg_get_type_name(image_get_type(hdr));
276         comp = genimg_get_comp_name(image_get_comp(hdr));
277
278         printf("%s %s %s (%s)\n", arch, os, type, comp);
279 }
280
281 /**
282  * image_print_contents - prints out the contents of the legacy format image
283  * @ptr: pointer to the legacy format image header
284  * @p: pointer to prefix string
285  *
286  * image_print_contents() formats a multi line legacy image contents description.
287  * The routine prints out all header fields followed by the size/offset data
288  * for MULTI/SCRIPT images.
289  *
290  * returns:
291  *     no returned results
292  */
293 void image_print_contents(const void *ptr)
294 {
295         const image_header_t *hdr = (const image_header_t *)ptr;
296         const char *p;
297
298         p = IMAGE_INDENT_STRING;
299         printf("%sImage Name:   %.*s\n", p, IH_NMLEN, image_get_name(hdr));
300         if (IMAGE_ENABLE_TIMESTAMP) {
301                 printf("%sCreated:      ", p);
302                 genimg_print_time((time_t)image_get_time(hdr));
303         }
304         printf("%sImage Type:   ", p);
305         image_print_type(hdr);
306         printf("%sData Size:    ", p);
307         genimg_print_size(image_get_data_size(hdr));
308         printf("%sLoad Address: %08x\n", p, image_get_load(hdr));
309         printf("%sEntry Point:  %08x\n", p, image_get_ep(hdr));
310
311         if (image_check_type(hdr, IH_TYPE_MULTI) ||
312                         image_check_type(hdr, IH_TYPE_SCRIPT)) {
313                 int i;
314                 ulong data, len;
315                 ulong count = image_multi_count(hdr);
316
317                 printf("%sContents:\n", p);
318                 for (i = 0; i < count; i++) {
319                         image_multi_getimg(hdr, i, &data, &len);
320
321                         printf("%s   Image %d: ", p, i);
322                         genimg_print_size(len);
323
324                         if (image_check_type(hdr, IH_TYPE_SCRIPT) && i > 0) {
325                                 /*
326                                  * the user may need to know offsets
327                                  * if planning to do something with
328                                  * multiple files
329                                  */
330                                 printf("%s    Offset = 0x%08lx\n", p, data);
331                         }
332                 }
333         }
334 }
335
336
337 #ifndef USE_HOSTCC
338 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
339 /**
340  * image_get_ramdisk - get and verify ramdisk image
341  * @rd_addr: ramdisk image start address
342  * @arch: expected ramdisk architecture
343  * @verify: checksum verification flag
344  *
345  * image_get_ramdisk() returns a pointer to the verified ramdisk image
346  * header. Routine receives image start address and expected architecture
347  * flag. Verification done covers data and header integrity and os/type/arch
348  * fields checking.
349  *
350  * If dataflash support is enabled routine checks for dataflash addresses
351  * and handles required dataflash reads.
352  *
353  * returns:
354  *     pointer to a ramdisk image header, if image was found and valid
355  *     otherwise, return NULL
356  */
357 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
358                                                 int verify)
359 {
360         const image_header_t *rd_hdr = (const image_header_t *)rd_addr;
361
362         if (!image_check_magic(rd_hdr)) {
363                 puts("Bad Magic Number\n");
364                 bootstage_error(BOOTSTAGE_ID_RD_MAGIC);
365                 return NULL;
366         }
367
368         if (!image_check_hcrc(rd_hdr)) {
369                 puts("Bad Header Checksum\n");
370                 bootstage_error(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
371                 return NULL;
372         }
373
374         bootstage_mark(BOOTSTAGE_ID_RD_MAGIC);
375         image_print_contents(rd_hdr);
376
377         if (verify) {
378                 puts("   Verifying Checksum ... ");
379                 if (!image_check_dcrc(rd_hdr)) {
380                         puts("Bad Data CRC\n");
381                         bootstage_error(BOOTSTAGE_ID_RD_CHECKSUM);
382                         return NULL;
383                 }
384                 puts("OK\n");
385         }
386
387         bootstage_mark(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
388
389         if (!image_check_os(rd_hdr, IH_OS_LINUX) ||
390             !image_check_arch(rd_hdr, arch) ||
391             !image_check_type(rd_hdr, IH_TYPE_RAMDISK)) {
392                 printf("No Linux %s Ramdisk Image\n",
393                                 genimg_get_arch_name(arch));
394                 bootstage_error(BOOTSTAGE_ID_RAMDISK);
395                 return NULL;
396         }
397
398         return rd_hdr;
399 }
400 #endif
401 #endif /* !USE_HOSTCC */
402
403 /*****************************************************************************/
404 /* Shared dual-format routines */
405 /*****************************************************************************/
406 #ifndef USE_HOSTCC
407 ulong load_addr = CONFIG_SYS_LOAD_ADDR; /* Default Load Address */
408 ulong save_addr;                        /* Default Save Address */
409 ulong save_size;                        /* Default Save Size (in bytes) */
410
411 static int on_loadaddr(const char *name, const char *value, enum env_op op,
412         int flags)
413 {
414         switch (op) {
415         case env_op_create:
416         case env_op_overwrite:
417                 load_addr = simple_strtoul(value, NULL, 16);
418                 break;
419         default:
420                 break;
421         }
422
423         return 0;
424 }
425 U_BOOT_ENV_CALLBACK(loadaddr, on_loadaddr);
426
427 ulong getenv_bootm_low(void)
428 {
429         char *s = getenv("bootm_low");
430         if (s) {
431                 ulong tmp = simple_strtoul(s, NULL, 16);
432                 return tmp;
433         }
434
435 #if defined(CONFIG_SYS_SDRAM_BASE)
436         return CONFIG_SYS_SDRAM_BASE;
437 #elif defined(CONFIG_ARM)
438         return gd->bd->bi_dram[0].start;
439 #else
440         return 0;
441 #endif
442 }
443
444 phys_size_t getenv_bootm_size(void)
445 {
446         phys_size_t tmp;
447         char *s = getenv("bootm_size");
448         if (s) {
449                 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
450                 return tmp;
451         }
452         s = getenv("bootm_low");
453         if (s)
454                 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
455         else
456                 tmp = 0;
457
458
459 #if defined(CONFIG_ARM)
460         return gd->bd->bi_dram[0].size - tmp;
461 #else
462         return gd->bd->bi_memsize - tmp;
463 #endif
464 }
465
466 phys_size_t getenv_bootm_mapsize(void)
467 {
468         phys_size_t tmp;
469         char *s = getenv("bootm_mapsize");
470         if (s) {
471                 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
472                 return tmp;
473         }
474
475 #if defined(CONFIG_SYS_BOOTMAPSZ)
476         return CONFIG_SYS_BOOTMAPSZ;
477 #else
478         return getenv_bootm_size();
479 #endif
480 }
481
482 void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
483 {
484         if (to == from)
485                 return;
486
487 #if defined(CONFIG_HW_WATCHDOG) || defined(CONFIG_WATCHDOG)
488         while (len > 0) {
489                 size_t tail = (len > chunksz) ? chunksz : len;
490                 WATCHDOG_RESET();
491                 memmove(to, from, tail);
492                 to += tail;
493                 from += tail;
494                 len -= tail;
495         }
496 #else   /* !(CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG) */
497         memmove(to, from, len);
498 #endif  /* CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG */
499 }
500 #endif /* !USE_HOSTCC */
501
502 void genimg_print_size(uint32_t size)
503 {
504 #ifndef USE_HOSTCC
505         printf("%d Bytes = ", size);
506         print_size(size, "\n");
507 #else
508         printf("%d Bytes = %.2f kB = %.2f MB\n",
509                         size, (double)size / 1.024e3,
510                         (double)size / 1.048576e6);
511 #endif
512 }
513
514 #if IMAGE_ENABLE_TIMESTAMP
515 void genimg_print_time(time_t timestamp)
516 {
517 #ifndef USE_HOSTCC
518         struct rtc_time tm;
519
520         to_tm(timestamp, &tm);
521         printf("%4d-%02d-%02d  %2d:%02d:%02d UTC\n",
522                         tm.tm_year, tm.tm_mon, tm.tm_mday,
523                         tm.tm_hour, tm.tm_min, tm.tm_sec);
524 #else
525         printf("%s", ctime(&timestamp));
526 #endif
527 }
528 #endif
529
530 /**
531  * get_table_entry_name - translate entry id to long name
532  * @table: pointer to a translation table for entries of a specific type
533  * @msg: message to be returned when translation fails
534  * @id: entry id to be translated
535  *
536  * get_table_entry_name() will go over translation table trying to find
537  * entry that matches given id. If matching entry is found, its long
538  * name is returned to the caller.
539  *
540  * returns:
541  *     long entry name if translation succeeds
542  *     msg otherwise
543  */
544 char *get_table_entry_name(const table_entry_t *table, char *msg, int id)
545 {
546         for (; table->id >= 0; ++table) {
547                 if (table->id == id)
548 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
549                         return table->lname;
550 #else
551                         return table->lname + gd->reloc_off;
552 #endif
553         }
554         return (msg);
555 }
556
557 const char *genimg_get_os_name(uint8_t os)
558 {
559         return (get_table_entry_name(uimage_os, "Unknown OS", os));
560 }
561
562 const char *genimg_get_arch_name(uint8_t arch)
563 {
564         return (get_table_entry_name(uimage_arch, "Unknown Architecture",
565                                         arch));
566 }
567
568 const char *genimg_get_type_name(uint8_t type)
569 {
570         return (get_table_entry_name(uimage_type, "Unknown Image", type));
571 }
572
573 const char *genimg_get_comp_name(uint8_t comp)
574 {
575         return (get_table_entry_name(uimage_comp, "Unknown Compression",
576                                         comp));
577 }
578
579 /**
580  * get_table_entry_id - translate short entry name to id
581  * @table: pointer to a translation table for entries of a specific type
582  * @table_name: to be used in case of error
583  * @name: entry short name to be translated
584  *
585  * get_table_entry_id() will go over translation table trying to find
586  * entry that matches given short name. If matching entry is found,
587  * its id returned to the caller.
588  *
589  * returns:
590  *     entry id if translation succeeds
591  *     -1 otherwise
592  */
593 int get_table_entry_id(const table_entry_t *table,
594                 const char *table_name, const char *name)
595 {
596         const table_entry_t *t;
597 #ifdef USE_HOSTCC
598         int first = 1;
599
600         for (t = table; t->id >= 0; ++t) {
601                 if (t->sname && strcasecmp(t->sname, name) == 0)
602                         return(t->id);
603         }
604
605         fprintf(stderr, "\nInvalid %s Type - valid names are", table_name);
606         for (t = table; t->id >= 0; ++t) {
607                 if (t->sname == NULL)
608                         continue;
609                 fprintf(stderr, "%c %s", (first) ? ':' : ',', t->sname);
610                 first = 0;
611         }
612         fprintf(stderr, "\n");
613 #else
614         for (t = table; t->id >= 0; ++t) {
615 #ifdef CONFIG_NEEDS_MANUAL_RELOC
616                 if (t->sname && strcmp(t->sname + gd->reloc_off, name) == 0)
617 #else
618                 if (t->sname && strcmp(t->sname, name) == 0)
619 #endif
620                         return (t->id);
621         }
622         debug("Invalid %s Type: %s\n", table_name, name);
623 #endif /* USE_HOSTCC */
624         return (-1);
625 }
626
627 int genimg_get_os_id(const char *name)
628 {
629         return (get_table_entry_id(uimage_os, "OS", name));
630 }
631
632 int genimg_get_arch_id(const char *name)
633 {
634         return (get_table_entry_id(uimage_arch, "CPU", name));
635 }
636
637 int genimg_get_type_id(const char *name)
638 {
639         return (get_table_entry_id(uimage_type, "Image", name));
640 }
641
642 int genimg_get_comp_id(const char *name)
643 {
644         return (get_table_entry_id(uimage_comp, "Compression", name));
645 }
646
647 #ifndef USE_HOSTCC
648 /**
649  * genimg_get_kernel_addr_fit - get the real kernel address and return 2
650  *                              FIT strings
651  * @img_addr: a string might contain real image address
652  * @fit_uname_config: double pointer to a char, will hold pointer to a
653  *                    configuration unit name
654  * @fit_uname_kernel: double pointer to a char, will hold pointer to a subimage
655  *                    name
656  *
657  * genimg_get_kernel_addr_fit get the real kernel start address from a string
658  * which is normally the first argv of bootm/bootz
659  *
660  * returns:
661  *     kernel start address
662  */
663 ulong genimg_get_kernel_addr_fit(char * const img_addr,
664                              const char **fit_uname_config,
665                              const char **fit_uname_kernel)
666 {
667         ulong kernel_addr;
668
669         /* find out kernel image address */
670         if (!img_addr) {
671                 kernel_addr = load_addr;
672                 debug("*  kernel: default image load address = 0x%08lx\n",
673                       load_addr);
674 #if defined(CONFIG_FIT)
675         } else if (fit_parse_conf(img_addr, load_addr, &kernel_addr,
676                                   fit_uname_config)) {
677                 debug("*  kernel: config '%s' from image at 0x%08lx\n",
678                       *fit_uname_config, kernel_addr);
679         } else if (fit_parse_subimage(img_addr, load_addr, &kernel_addr,
680                                      fit_uname_kernel)) {
681                 debug("*  kernel: subimage '%s' from image at 0x%08lx\n",
682                       *fit_uname_kernel, kernel_addr);
683 #endif
684         } else {
685                 kernel_addr = simple_strtoul(img_addr, NULL, 16);
686                 debug("*  kernel: cmdline image address = 0x%08lx\n",
687                       kernel_addr);
688         }
689
690         return kernel_addr;
691 }
692
693 /**
694  * genimg_get_kernel_addr() is the simple version of
695  * genimg_get_kernel_addr_fit(). It ignores those return FIT strings
696  */
697 ulong genimg_get_kernel_addr(char * const img_addr)
698 {
699         const char *fit_uname_config = NULL;
700         const char *fit_uname_kernel = NULL;
701
702         return genimg_get_kernel_addr_fit(img_addr, &fit_uname_config,
703                                           &fit_uname_kernel);
704 }
705
706 /**
707  * genimg_get_format - get image format type
708  * @img_addr: image start address
709  *
710  * genimg_get_format() checks whether provided address points to a valid
711  * legacy or FIT image.
712  *
713  * New uImage format and FDT blob are based on a libfdt. FDT blob
714  * may be passed directly or embedded in a FIT image. In both situations
715  * genimg_get_format() must be able to dectect libfdt header.
716  *
717  * returns:
718  *     image format type or IMAGE_FORMAT_INVALID if no image is present
719  */
720 int genimg_get_format(const void *img_addr)
721 {
722 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
723         const image_header_t *hdr;
724
725         hdr = (const image_header_t *)img_addr;
726         if (image_check_magic(hdr))
727                 return IMAGE_FORMAT_LEGACY;
728 #endif
729 #if defined(CONFIG_FIT) || defined(CONFIG_OF_LIBFDT)
730         if (fdt_check_header(img_addr) == 0)
731                 return IMAGE_FORMAT_FIT;
732 #endif
733 #ifdef CONFIG_ANDROID_BOOT_IMAGE
734         if (android_image_check_header(img_addr) == 0)
735                 return IMAGE_FORMAT_ANDROID;
736 #endif
737
738         return IMAGE_FORMAT_INVALID;
739 }
740
741 /**
742  * genimg_get_image - get image from special storage (if necessary)
743  * @img_addr: image start address
744  *
745  * genimg_get_image() checks if provided image start adddress is located
746  * in a dataflash storage. If so, image is moved to a system RAM memory.
747  *
748  * returns:
749  *     image start address after possible relocation from special storage
750  */
751 ulong genimg_get_image(ulong img_addr)
752 {
753         ulong ram_addr = img_addr;
754
755 #ifdef CONFIG_HAS_DATAFLASH
756         ulong h_size, d_size;
757
758         if (addr_dataflash(img_addr)) {
759                 void *buf;
760
761                 /* ger RAM address */
762                 ram_addr = CONFIG_SYS_LOAD_ADDR;
763
764                 /* get header size */
765                 h_size = image_get_header_size();
766 #if defined(CONFIG_FIT)
767                 if (sizeof(struct fdt_header) > h_size)
768                         h_size = sizeof(struct fdt_header);
769 #endif
770
771                 /* read in header */
772                 debug("   Reading image header from dataflash address "
773                         "%08lx to RAM address %08lx\n", img_addr, ram_addr);
774
775                 buf = map_sysmem(ram_addr, 0);
776                 read_dataflash(img_addr, h_size, buf);
777
778                 /* get data size */
779                 switch (genimg_get_format(buf)) {
780 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
781                 case IMAGE_FORMAT_LEGACY:
782                         d_size = image_get_data_size(buf);
783                         debug("   Legacy format image found at 0x%08lx, "
784                                         "size 0x%08lx\n",
785                                         ram_addr, d_size);
786                         break;
787 #endif
788 #if defined(CONFIG_FIT)
789                 case IMAGE_FORMAT_FIT:
790                         d_size = fit_get_size(buf) - h_size;
791                         debug("   FIT/FDT format image found at 0x%08lx, "
792                                         "size 0x%08lx\n",
793                                         ram_addr, d_size);
794                         break;
795 #endif
796                 default:
797                         printf("   No valid image found at 0x%08lx\n",
798                                 img_addr);
799                         return ram_addr;
800                 }
801
802                 /* read in image data */
803                 debug("   Reading image remaining data from dataflash address "
804                         "%08lx to RAM address %08lx\n", img_addr + h_size,
805                         ram_addr + h_size);
806
807                 read_dataflash(img_addr + h_size, d_size,
808                                 (char *)(buf + h_size));
809
810         }
811 #endif /* CONFIG_HAS_DATAFLASH */
812
813         return ram_addr;
814 }
815
816 /**
817  * fit_has_config - check if there is a valid FIT configuration
818  * @images: pointer to the bootm command headers structure
819  *
820  * fit_has_config() checks if there is a FIT configuration in use
821  * (if FTI support is present).
822  *
823  * returns:
824  *     0, no FIT support or no configuration found
825  *     1, configuration found
826  */
827 int genimg_has_config(bootm_headers_t *images)
828 {
829 #if defined(CONFIG_FIT)
830         if (images->fit_uname_cfg)
831                 return 1;
832 #endif
833         return 0;
834 }
835
836 /**
837  * boot_get_ramdisk - main ramdisk handling routine
838  * @argc: command argument count
839  * @argv: command argument list
840  * @images: pointer to the bootm images structure
841  * @arch: expected ramdisk architecture
842  * @rd_start: pointer to a ulong variable, will hold ramdisk start address
843  * @rd_end: pointer to a ulong variable, will hold ramdisk end
844  *
845  * boot_get_ramdisk() is responsible for finding a valid ramdisk image.
846  * Curently supported are the following ramdisk sources:
847  *      - multicomponent kernel/ramdisk image,
848  *      - commandline provided address of decicated ramdisk image.
849  *
850  * returns:
851  *     0, if ramdisk image was found and valid, or skiped
852  *     rd_start and rd_end are set to ramdisk start/end addresses if
853  *     ramdisk image is found and valid
854  *
855  *     1, if ramdisk image is found but corrupted, or invalid
856  *     rd_start and rd_end are set to 0 if no ramdisk exists
857  */
858 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
859                 uint8_t arch, ulong *rd_start, ulong *rd_end)
860 {
861         ulong rd_addr, rd_load;
862         ulong rd_data, rd_len;
863 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
864         const image_header_t *rd_hdr;
865 #endif
866         void *buf;
867 #ifdef CONFIG_SUPPORT_RAW_INITRD
868         char *end;
869 #endif
870 #if defined(CONFIG_FIT)
871         const char      *fit_uname_config = images->fit_uname_cfg;
872         const char      *fit_uname_ramdisk = NULL;
873         ulong           default_addr;
874         int             rd_noffset;
875 #endif
876         const char *select = NULL;
877
878         *rd_start = 0;
879         *rd_end = 0;
880
881         if (argc >= 2)
882                 select = argv[1];
883         /*
884          * Look for a '-' which indicates to ignore the
885          * ramdisk argument
886          */
887         if (select && strcmp(select, "-") ==  0) {
888                 debug("## Skipping init Ramdisk\n");
889                 rd_len = rd_data = 0;
890         } else if (select || genimg_has_config(images)) {
891 #if defined(CONFIG_FIT)
892                 if (select) {
893                         /*
894                          * If the init ramdisk comes from the FIT image and
895                          * the FIT image address is omitted in the command
896                          * line argument, try to use os FIT image address or
897                          * default load address.
898                          */
899                         if (images->fit_uname_os)
900                                 default_addr = (ulong)images->fit_hdr_os;
901                         else
902                                 default_addr = load_addr;
903
904                         if (fit_parse_conf(select, default_addr,
905                                            &rd_addr, &fit_uname_config)) {
906                                 debug("*  ramdisk: config '%s' from image at "
907                                                 "0x%08lx\n",
908                                                 fit_uname_config, rd_addr);
909                         } else if (fit_parse_subimage(select, default_addr,
910                                                 &rd_addr, &fit_uname_ramdisk)) {
911                                 debug("*  ramdisk: subimage '%s' from image at "
912                                                 "0x%08lx\n",
913                                                 fit_uname_ramdisk, rd_addr);
914                         } else
915 #endif
916                         {
917                                 rd_addr = simple_strtoul(select, NULL, 16);
918                                 debug("*  ramdisk: cmdline image address = "
919                                                 "0x%08lx\n",
920                                                 rd_addr);
921                         }
922 #if defined(CONFIG_FIT)
923                 } else {
924                         /* use FIT configuration provided in first bootm
925                          * command argument. If the property is not defined,
926                          * quit silently.
927                          */
928                         rd_addr = map_to_sysmem(images->fit_hdr_os);
929                         rd_noffset = fit_get_node_from_config(images,
930                                         FIT_RAMDISK_PROP, rd_addr);
931                         if (rd_noffset == -ENOLINK)
932                                 return 0;
933                         else if (rd_noffset < 0)
934                                 return 1;
935                 }
936 #endif
937
938                 /* copy from dataflash if needed */
939                 rd_addr = genimg_get_image(rd_addr);
940
941                 /*
942                  * Check if there is an initrd image at the
943                  * address provided in the second bootm argument
944                  * check image type, for FIT images get FIT node.
945                  */
946                 buf = map_sysmem(rd_addr, 0);
947                 switch (genimg_get_format(buf)) {
948 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
949                 case IMAGE_FORMAT_LEGACY:
950                         printf("## Loading init Ramdisk from Legacy "
951                                         "Image at %08lx ...\n", rd_addr);
952
953                         bootstage_mark(BOOTSTAGE_ID_CHECK_RAMDISK);
954                         rd_hdr = image_get_ramdisk(rd_addr, arch,
955                                                         images->verify);
956
957                         if (rd_hdr == NULL)
958                                 return 1;
959
960                         rd_data = image_get_data(rd_hdr);
961                         rd_len = image_get_data_size(rd_hdr);
962                         rd_load = image_get_load(rd_hdr);
963                         break;
964 #endif
965 #if defined(CONFIG_FIT)
966                 case IMAGE_FORMAT_FIT:
967                         rd_noffset = fit_image_load(images,
968                                         rd_addr, &fit_uname_ramdisk,
969                                         &fit_uname_config, arch,
970                                         IH_TYPE_RAMDISK,
971                                         BOOTSTAGE_ID_FIT_RD_START,
972                                         FIT_LOAD_OPTIONAL_NON_ZERO,
973                                         &rd_data, &rd_len);
974                         if (rd_noffset < 0)
975                                 return 1;
976
977                         images->fit_hdr_rd = map_sysmem(rd_addr, 0);
978                         images->fit_uname_rd = fit_uname_ramdisk;
979                         images->fit_noffset_rd = rd_noffset;
980                         break;
981 #endif
982                 default:
983 #ifdef CONFIG_SUPPORT_RAW_INITRD
984                         end = NULL;
985                         if (select)
986                                 end = strchr(select, ':');
987                         if (end) {
988                                 rd_len = simple_strtoul(++end, NULL, 16);
989                                 rd_data = rd_addr;
990                         } else
991 #endif
992                         {
993                                 puts("Wrong Ramdisk Image Format\n");
994                                 rd_data = rd_len = rd_load = 0;
995                                 return 1;
996                         }
997                 }
998         } else if (images->legacy_hdr_valid &&
999                         image_check_type(&images->legacy_hdr_os_copy,
1000                                                 IH_TYPE_MULTI)) {
1001
1002                 /*
1003                  * Now check if we have a legacy mult-component image,
1004                  * get second entry data start address and len.
1005                  */
1006                 bootstage_mark(BOOTSTAGE_ID_RAMDISK);
1007                 printf("## Loading init Ramdisk from multi component "
1008                                 "Legacy Image at %08lx ...\n",
1009                                 (ulong)images->legacy_hdr_os);
1010
1011                 image_multi_getimg(images->legacy_hdr_os, 1, &rd_data, &rd_len);
1012         }
1013 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1014         else if ((genimg_get_format((void *)images->os.start)
1015                         == IMAGE_FORMAT_ANDROID) &&
1016                  (!android_image_get_ramdisk((void *)images->os.start,
1017                  &rd_data, &rd_len))) {
1018                 /* empty */
1019         }
1020 #endif
1021         else {
1022                 /*
1023                  * no initrd image
1024                  */
1025                 bootstage_mark(BOOTSTAGE_ID_NO_RAMDISK);
1026                 rd_len = rd_data = 0;
1027         }
1028
1029         if (!rd_data) {
1030                 debug("## No init Ramdisk\n");
1031         } else {
1032                 *rd_start = rd_data;
1033                 *rd_end = rd_data + rd_len;
1034         }
1035         debug("   ramdisk start = 0x%08lx, ramdisk end = 0x%08lx\n",
1036                         *rd_start, *rd_end);
1037
1038         return 0;
1039 }
1040
1041 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
1042 /**
1043  * boot_ramdisk_high - relocate init ramdisk
1044  * @lmb: pointer to lmb handle, will be used for memory mgmt
1045  * @rd_data: ramdisk data start address
1046  * @rd_len: ramdisk data length
1047  * @initrd_start: pointer to a ulong variable, will hold final init ramdisk
1048  *      start address (after possible relocation)
1049  * @initrd_end: pointer to a ulong variable, will hold final init ramdisk
1050  *      end address (after possible relocation)
1051  *
1052  * boot_ramdisk_high() takes a relocation hint from "initrd_high" environment
1053  * variable and if requested ramdisk data is moved to a specified location.
1054  *
1055  * Initrd_start and initrd_end are set to final (after relocation) ramdisk
1056  * start/end addresses if ramdisk image start and len were provided,
1057  * otherwise set initrd_start and initrd_end set to zeros.
1058  *
1059  * returns:
1060  *      0 - success
1061  *     -1 - failure
1062  */
1063 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
1064                   ulong *initrd_start, ulong *initrd_end)
1065 {
1066         char    *s;
1067         ulong   initrd_high;
1068         int     initrd_copy_to_ram = 1;
1069
1070         if ((s = getenv("initrd_high")) != NULL) {
1071                 /* a value of "no" or a similar string will act like 0,
1072                  * turning the "load high" feature off. This is intentional.
1073                  */
1074                 initrd_high = simple_strtoul(s, NULL, 16);
1075                 if (initrd_high == ~0)
1076                         initrd_copy_to_ram = 0;
1077         } else {
1078                 /* not set, no restrictions to load high */
1079                 initrd_high = ~0;
1080         }
1081
1082
1083 #ifdef CONFIG_LOGBUFFER
1084         /* Prevent initrd from overwriting logbuffer */
1085         lmb_reserve(lmb, logbuffer_base() - LOGBUFF_OVERHEAD, LOGBUFF_RESERVE);
1086 #endif
1087
1088         debug("## initrd_high = 0x%08lx, copy_to_ram = %d\n",
1089                         initrd_high, initrd_copy_to_ram);
1090
1091         if (rd_data) {
1092                 if (!initrd_copy_to_ram) {      /* zero-copy ramdisk support */
1093                         debug("   in-place initrd\n");
1094                         *initrd_start = rd_data;
1095                         *initrd_end = rd_data + rd_len;
1096                         lmb_reserve(lmb, rd_data, rd_len);
1097                 } else {
1098                         if (initrd_high)
1099                                 *initrd_start = (ulong)lmb_alloc_base(lmb,
1100                                                 rd_len, 0x1000, initrd_high);
1101                         else
1102                                 *initrd_start = (ulong)lmb_alloc(lmb, rd_len,
1103                                                                  0x1000);
1104
1105                         if (*initrd_start == 0) {
1106                                 puts("ramdisk - allocation error\n");
1107                                 goto error;
1108                         }
1109                         bootstage_mark(BOOTSTAGE_ID_COPY_RAMDISK);
1110
1111                         *initrd_end = *initrd_start + rd_len;
1112                         printf("   Loading Ramdisk to %08lx, end %08lx ... ",
1113                                         *initrd_start, *initrd_end);
1114
1115                         memmove_wd((void *)*initrd_start,
1116                                         (void *)rd_data, rd_len, CHUNKSZ);
1117
1118 #ifdef CONFIG_MP
1119                         /*
1120                          * Ensure the image is flushed to memory to handle
1121                          * AMP boot scenarios in which we might not be
1122                          * HW cache coherent
1123                          */
1124                         flush_cache((unsigned long)*initrd_start, rd_len);
1125 #endif
1126                         puts("OK\n");
1127                 }
1128         } else {
1129                 *initrd_start = 0;
1130                 *initrd_end = 0;
1131         }
1132         debug("   ramdisk load start = 0x%08lx, ramdisk load end = 0x%08lx\n",
1133                         *initrd_start, *initrd_end);
1134
1135         return 0;
1136
1137 error:
1138         return -1;
1139 }
1140 #endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
1141
1142 int boot_get_setup(bootm_headers_t *images, uint8_t arch,
1143                    ulong *setup_start, ulong *setup_len)
1144 {
1145 #if defined(CONFIG_FIT)
1146         return boot_get_setup_fit(images, arch, setup_start, setup_len);
1147 #else
1148         return -ENOENT;
1149 #endif
1150 }
1151
1152 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
1153 /**
1154  * boot_get_cmdline - allocate and initialize kernel cmdline
1155  * @lmb: pointer to lmb handle, will be used for memory mgmt
1156  * @cmd_start: pointer to a ulong variable, will hold cmdline start
1157  * @cmd_end: pointer to a ulong variable, will hold cmdline end
1158  *
1159  * boot_get_cmdline() allocates space for kernel command line below
1160  * BOOTMAPSZ + getenv_bootm_low() address. If "bootargs" U-boot environemnt
1161  * variable is present its contents is copied to allocated kernel
1162  * command line.
1163  *
1164  * returns:
1165  *      0 - success
1166  *     -1 - failure
1167  */
1168 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end)
1169 {
1170         char *cmdline;
1171         char *s;
1172
1173         cmdline = (char *)(ulong)lmb_alloc_base(lmb, CONFIG_SYS_BARGSIZE, 0xf,
1174                                 getenv_bootm_mapsize() + getenv_bootm_low());
1175
1176         if (cmdline == NULL)
1177                 return -1;
1178
1179         if ((s = getenv("bootargs")) == NULL)
1180                 s = "";
1181
1182         strcpy(cmdline, s);
1183
1184         *cmd_start = (ulong) & cmdline[0];
1185         *cmd_end = *cmd_start + strlen(cmdline);
1186
1187         debug("## cmdline at 0x%08lx ... 0x%08lx\n", *cmd_start, *cmd_end);
1188
1189         return 0;
1190 }
1191 #endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
1192
1193 #ifdef CONFIG_SYS_BOOT_GET_KBD
1194 /**
1195  * boot_get_kbd - allocate and initialize kernel copy of board info
1196  * @lmb: pointer to lmb handle, will be used for memory mgmt
1197  * @kbd: double pointer to board info data
1198  *
1199  * boot_get_kbd() allocates space for kernel copy of board info data below
1200  * BOOTMAPSZ + getenv_bootm_low() address and kernel board info is initialized
1201  * with the current u-boot board info data.
1202  *
1203  * returns:
1204  *      0 - success
1205  *     -1 - failure
1206  */
1207 int boot_get_kbd(struct lmb *lmb, bd_t **kbd)
1208 {
1209         *kbd = (bd_t *)(ulong)lmb_alloc_base(lmb, sizeof(bd_t), 0xf,
1210                                 getenv_bootm_mapsize() + getenv_bootm_low());
1211         if (*kbd == NULL)
1212                 return -1;
1213
1214         **kbd = *(gd->bd);
1215
1216         debug("## kernel board info at 0x%08lx\n", (ulong)*kbd);
1217
1218 #if defined(DEBUG) && defined(CONFIG_CMD_BDI)
1219         do_bdinfo(NULL, 0, 0, NULL);
1220 #endif
1221
1222         return 0;
1223 }
1224 #endif /* CONFIG_SYS_BOOT_GET_KBD */
1225
1226 #ifdef CONFIG_LMB
1227 int image_setup_linux(bootm_headers_t *images)
1228 {
1229         ulong of_size = images->ft_len;
1230         char **of_flat_tree = &images->ft_addr;
1231         ulong *initrd_start = &images->initrd_start;
1232         ulong *initrd_end = &images->initrd_end;
1233         struct lmb *lmb = &images->lmb;
1234         ulong rd_len;
1235         int ret;
1236
1237         if (IMAGE_ENABLE_OF_LIBFDT)
1238                 boot_fdt_add_mem_rsv_regions(lmb, *of_flat_tree);
1239
1240         if (IMAGE_BOOT_GET_CMDLINE) {
1241                 ret = boot_get_cmdline(lmb, &images->cmdline_start,
1242                                 &images->cmdline_end);
1243                 if (ret) {
1244                         puts("ERROR with allocation of cmdline\n");
1245                         return ret;
1246                 }
1247         }
1248         if (IMAGE_ENABLE_RAMDISK_HIGH) {
1249                 rd_len = images->rd_end - images->rd_start;
1250                 ret = boot_ramdisk_high(lmb, images->rd_start, rd_len,
1251                                 initrd_start, initrd_end);
1252                 if (ret)
1253                         return ret;
1254         }
1255
1256         if (IMAGE_ENABLE_OF_LIBFDT) {
1257                 ret = boot_relocate_fdt(lmb, of_flat_tree, &of_size);
1258                 if (ret)
1259                         return ret;
1260         }
1261
1262         if (IMAGE_ENABLE_OF_LIBFDT && of_size) {
1263                 ret = image_setup_libfdt(images, *of_flat_tree, of_size, lmb);
1264                 if (ret)
1265                         return ret;
1266         }
1267
1268         return 0;
1269 }
1270 #endif /* CONFIG_LMB */
1271 #endif /* !USE_HOSTCC */