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