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