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