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