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