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