/*

   * (C) Copyright 2000-2009

   * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   *

   * SPDX-License-Identifier:	GPL-2.0+

   */

  /*
   * Boot support
   */
  #include <common.h>
  #include <watchdog.h>
  #include <command.h>

  #include <image.h>
  #include <malloc.h>

  #include <u-boot/zlib.h>

  #include <bzlib.h>

  #include <environment.h>

  #include <lmb.h>

  #include <linux/ctype.h>

  #include <asm/byteorder.h>

  #include <asm/io.h>

  #include <linux/compiler.h>

  #if defined(CONFIG_BOOTM_VXWORKS) && \
  	(defined(CONFIG_PPC) || defined(CONFIG_ARM))
  #include <vxworks.h>
  #endif

  #if defined(CONFIG_CMD_USB)

  #include <usb.h>
  #endif

  #ifdef CONFIG_SYS_HUSH_PARSER

  #include <hush.h>
  #endif

  #if defined(CONFIG_OF_LIBFDT)

  #include <libfdt.h>
  #include <fdt_support.h>
  #endif

  #ifdef CONFIG_LZMA

  #include <lzma/LzmaTypes.h>

  #include <lzma/LzmaDec.h>

  #include <lzma/LzmaTools.h>
  #endif /* CONFIG_LZMA */

  #ifdef CONFIG_LZO
  #include <linux/lzo.h>
  #endif /* CONFIG_LZO */

  DECLARE_GLOBAL_DATA_PTR;

  #ifndef CONFIG_SYS_BOOTM_LEN
  #define CONFIG_SYS_BOOTM_LEN	0x800000	/* use 8MByte as default max gunzip size */

  #endif

  #ifdef CONFIG_BZIP2
  extern void bz_internal_error(int);

  #endif

  #if defined(CONFIG_CMD_IMI)

  static int image_info(unsigned long addr);

  #endif

  #if defined(CONFIG_CMD_IMLS)

  #include <flash.h>

  #include <mtd/cfi_flash.h>

  extern flash_info_t flash_info[]; /* info for FLASH chips */

  #endif
  
  #if defined(CONFIG_CMD_IMLS) || defined(CONFIG_CMD_IMLS_NAND)

  static int do_imls(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);

  #endif

  #include <linux/err.h>
  #include <nand.h>

  #if defined(CONFIG_SILENT_CONSOLE) && !defined(CONFIG_SILENT_U_BOOT_ONLY)

  static void fixup_silent_linux(void);

  #endif

  static int do_bootm_standalone(int flag, int argc, char * const argv[],
  			       bootm_headers_t *images);

  static const void *boot_get_kernel(cmd_tbl_t *cmdtp, int flag, int argc,

  				char * const argv[], bootm_headers_t *images,
  				ulong *os_data, ulong *os_len);

  
  /*
   *  Continue booting an OS image; caller already has:
   *  - copied image header to global variable `header'
   *  - checked header magic number, checksums (both header & image),
   *  - verified image architecture (PPC) and type (KERNEL or MULTI),
   *  - loaded (first part of) image to header load address,
   *  - disabled interrupts.

   *

   * @flag: Flags indicating what to do (BOOTM_STATE_...)

   * @argc: Number of arguments. Note that the arguments are shifted down
   *	 so that 0 is the first argument not processed by U-Boot, and
   *	 argc is adjusted accordingly. This avoids confusion as to how
   *	 many arguments are available for the OS.
   * @images: Pointers to os/initrd/fdt
   * @return 1 on error. On success the OS boots so this function does
   * not return.

   */

  typedef int boot_os_fn(int flag, int argc, char * const argv[],

  			bootm_headers_t *images);

  #ifdef CONFIG_BOOTM_LINUX

  extern boot_os_fn do_bootm_linux;

  #endif
  #ifdef CONFIG_BOOTM_NETBSD

  static boot_os_fn do_bootm_netbsd;

  #endif

  #if defined(CONFIG_LYNXKDI)

  static boot_os_fn do_bootm_lynxkdi;

  extern void lynxkdi_boot(image_header_t *);

  #endif

  #ifdef CONFIG_BOOTM_RTEMS

  static boot_os_fn do_bootm_rtems;

  #endif

  #if defined(CONFIG_BOOTM_OSE)
  static boot_os_fn do_bootm_ose;
  #endif

  #if defined(CONFIG_BOOTM_PLAN9)
  static boot_os_fn do_bootm_plan9;
  #endif

  #if defined(CONFIG_BOOTM_VXWORKS) && \
  	(defined(CONFIG_PPC) || defined(CONFIG_ARM))

  static boot_os_fn do_bootm_vxworks;

  #endif
  #if defined(CONFIG_CMD_ELF)

  static boot_os_fn do_bootm_qnxelf;

  int do_bootvx(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
  int do_bootelf(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);

  #endif

  #if defined(CONFIG_INTEGRITY)
  static boot_os_fn do_bootm_integrity;
  #endif

  static boot_os_fn *boot_os[] = {

  	[IH_OS_U_BOOT] = do_bootm_standalone,

  #ifdef CONFIG_BOOTM_LINUX

  	[IH_OS_LINUX] = do_bootm_linux,

  #endif
  #ifdef CONFIG_BOOTM_NETBSD

  	[IH_OS_NETBSD] = do_bootm_netbsd,

  #endif

  #ifdef CONFIG_LYNXKDI
  	[IH_OS_LYNXOS] = do_bootm_lynxkdi,
  #endif

  #ifdef CONFIG_BOOTM_RTEMS

  	[IH_OS_RTEMS] = do_bootm_rtems,

  #endif

  #if defined(CONFIG_BOOTM_OSE)
  	[IH_OS_OSE] = do_bootm_ose,
  #endif

  #if defined(CONFIG_BOOTM_PLAN9)
  	[IH_OS_PLAN9] = do_bootm_plan9,
  #endif

  #if defined(CONFIG_BOOTM_VXWORKS) && \
  	(defined(CONFIG_PPC) || defined(CONFIG_ARM))

  	[IH_OS_VXWORKS] = do_bootm_vxworks,

  #endif
  #if defined(CONFIG_CMD_ELF)

  	[IH_OS_QNX] = do_bootm_qnxelf,
  #endif
  #ifdef CONFIG_INTEGRITY
  	[IH_OS_INTEGRITY] = do_bootm_integrity,
  #endif
  };

  bootm_headers_t images;		/* pointers to os/initrd/fdt images */

  /* Allow for arch specific config before we boot */

  static void __arch_preboot_os(void)

  {
  	/* please define platform specific arch_preboot_os() */
  }
  void arch_preboot_os(void) __attribute__((weak, alias("__arch_preboot_os")));

  #define IH_INITRD_ARCH IH_ARCH_DEFAULT

  #ifdef CONFIG_LMB

  static void boot_start_lmb(bootm_headers_t *images)
  {

  	ulong		mem_start;
  	phys_size_t	mem_size;

  	lmb_init(&images->lmb);

  	mem_start = getenv_bootm_low();
  	mem_size = getenv_bootm_size();

  	lmb_add(&images->lmb, (phys_addr_t)mem_start, mem_size);

  	arch_lmb_reserve(&images->lmb);
  	board_lmb_reserve(&images->lmb);
  }

  #else

  #define lmb_reserve(lmb, base, size)

  static inline void boot_start_lmb(bootm_headers_t *images) { }

  #endif

  static int bootm_start(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])

  {

  	memset((void *)&images, 0, sizeof(images));
  	images.verify = getenv_yesno("verify");

  	boot_start_lmb(&images);

  	bootstage_mark_name(BOOTSTAGE_ID_BOOTM_START, "bootm_start");

  	images.state = BOOTM_STATE_START;
  
  	return 0;
  }
  
  static int bootm_find_os(cmd_tbl_t *cmdtp, int flag, int argc,
  			 char * const argv[])
  {
  	const void *os_hdr;

  	/* get kernel image header, start address and length */

  	os_hdr = boot_get_kernel(cmdtp, flag, argc, argv,

  			&images, &images.os.image_start, &images.os.image_len);
  	if (images.os.image_len == 0) {

  		puts("ERROR: can't get kernel image!
  ");

  		return 1;

  	}

  	/* get image parameters */

  	switch (genimg_get_format(os_hdr)) {

  	case IMAGE_FORMAT_LEGACY:

  		images.os.type = image_get_type(os_hdr);
  		images.os.comp = image_get_comp(os_hdr);
  		images.os.os = image_get_os(os_hdr);

  		images.os.end = image_get_image_end(os_hdr);
  		images.os.load = image_get_load(os_hdr);

  		break;
  #if defined(CONFIG_FIT)
  	case IMAGE_FORMAT_FIT:

  		if (fit_image_get_type(images.fit_hdr_os,

  					images.fit_noffset_os, &images.os.type)) {

  			puts("Can't get image type!
  ");

  			bootstage_error(BOOTSTAGE_ID_FIT_TYPE);

  			return 1;
  		}

  		if (fit_image_get_comp(images.fit_hdr_os,

  					images.fit_noffset_os, &images.os.comp)) {

  			puts("Can't get image compression!
  ");

  			bootstage_error(BOOTSTAGE_ID_FIT_COMPRESSION);

  			return 1;
  		}

  		if (fit_image_get_os(images.fit_hdr_os,

  					images.fit_noffset_os, &images.os.os)) {

  			puts("Can't get image OS!
  ");

  			bootstage_error(BOOTSTAGE_ID_FIT_OS);

  			return 1;
  		}

  		images.os.end = fit_get_end(images.fit_hdr_os);

  		if (fit_image_get_load(images.fit_hdr_os, images.fit_noffset_os,

  					&images.os.load)) {

  			puts("Can't get image load address!
  ");

  			bootstage_error(BOOTSTAGE_ID_FIT_LOADADDR);

  			return 1;

  		}
  		break;

  #endif
  	default:

  		puts("ERROR: unknown image format type!
  ");

  		return 1;
  	}

  	/* find kernel entry point */
  	if (images.legacy_hdr_valid) {

  		images.ep = image_get_ep(&images.legacy_hdr_os_copy);

  #if defined(CONFIG_FIT)
  	} else if (images.fit_uname_os) {

  		int ret;

  		ret = fit_image_get_entry(images.fit_hdr_os,

  					  images.fit_noffset_os, &images.ep);

  		if (ret) {

  			puts("Can't get entry point property!
  ");

  			return 1;
  		}
  #endif
  	} else {

  		puts("Could not find kernel entry point!
  ");

  		return 1;
  	}

  	if (images.os.type == IH_TYPE_KERNEL_NOLOAD) {
  		images.os.load = images.os.image_start;
  		images.ep += images.os.load;
  	}

  	images.os.start = (ulong)os_hdr;
  
  	return 0;
  }

  static int bootm_find_ramdisk(int flag, int argc, char * const argv[])
  {
  	int ret;
  
  	/* find ramdisk */
  	ret = boot_get_ramdisk(argc, argv, &images, IH_INITRD_ARCH,
  			       &images.rd_start, &images.rd_end);
  	if (ret) {
  		puts("Ramdisk image is corrupt or invalid
  ");
  		return 1;
  	}
  
  	return 0;
  }
  
  #if defined(CONFIG_OF_LIBFDT)
  static int bootm_find_fdt(int flag, int argc, char * const argv[])

  {
  	int ret;

  	/* find flattened device tree */
  	ret = boot_get_fdt(flag, argc, argv, IH_ARCH_DEFAULT, &images,
  			   &images.ft_addr, &images.ft_len);
  	if (ret) {
  		puts("Could not find a valid device tree
  ");
  		return 1;
  	}
  
  	set_working_fdt_addr(images.ft_addr);
  
  	return 0;
  }
  #endif
  
  static int bootm_find_other(cmd_tbl_t *cmdtp, int flag, int argc,
  			    char * const argv[])
  {

  	if (((images.os.type == IH_TYPE_KERNEL) ||

  	     (images.os.type == IH_TYPE_KERNEL_NOLOAD) ||

  	     (images.os.type == IH_TYPE_MULTI)) &&

  	    (images.os.os == IH_OS_LINUX ||
  		 images.os.os == IH_OS_VXWORKS)) {

  		if (bootm_find_ramdisk(flag, argc, argv))

  			return 1;

  
  #if defined(CONFIG_OF_LIBFDT)

  		if (bootm_find_fdt(flag, argc, argv))

  			return 1;

  #endif

  	}

  	return 0;
  }

  #define BOOTM_ERR_RESET		-1
  #define BOOTM_ERR_OVERLAP	-2
  #define BOOTM_ERR_UNIMPLEMENTED	-3

  static int bootm_load_os(bootm_headers_t *images, unsigned long *load_end,
  		int boot_progress)

  {

  	image_info_t os = images->os;

  	uint8_t comp = os.comp;
  	ulong load = os.load;
  	ulong blob_start = os.start;
  	ulong blob_end = os.end;
  	ulong image_start = os.image_start;
  	ulong image_len = os.image_len;

  	__maybe_unused uint unc_len = CONFIG_SYS_BOOTM_LEN;

  	int no_overlap = 0;

  	void *load_buf, *image_buf;

  #if defined(CONFIG_LZMA) || defined(CONFIG_LZO)
  	int ret;
  #endif /* defined(CONFIG_LZMA) || defined(CONFIG_LZO) */

  	const char *type_name = genimg_get_type_name(os.type);

  	load_buf = map_sysmem(load, unc_len);

  	image_buf = map_sysmem(image_start, image_len);

  	switch (comp) {

  	case IH_COMP_NONE:

  		if (load == blob_start || load == image_start) {

  			printf("   XIP %s ... ", type_name);

  			no_overlap = 1;

  		} else {

  			printf("   Loading %s ... ", type_name);

  			memmove_wd(load_buf, image_buf, image_len, CHUNKSZ);

  		}

  		*load_end = load + image_len;

  		break;

  #ifdef CONFIG_GZIP

  	case IH_COMP_GZIP:

  		printf("   Uncompressing %s ... ", type_name);

  		if (gunzip(load_buf, unc_len, image_buf, &image_len) != 0) {

  			puts("GUNZIP: uncompress, out-of-mem or overwrite "
  				"error - must RESET board to recover
  ");

  			if (boot_progress)

  				bootstage_error(BOOTSTAGE_ID_DECOMP_IMAGE);

  			return BOOTM_ERR_RESET;

  		}

  		*load_end = load + image_len;

  		break;

  #endif /* CONFIG_GZIP */

  #ifdef CONFIG_BZIP2
  	case IH_COMP_BZIP2:

  		printf("   Uncompressing %s ... ", type_name);

  		/*
  		 * If we've got less than 4 MB of malloc() space,
  		 * use slower decompression algorithm which requires
  		 * at most 2300 KB of memory.
  		 */

  		int i = BZ2_bzBuffToBuffDecompress(load_buf, &unc_len,
  			image_buf, image_len,
  			CONFIG_SYS_MALLOC_LEN < (4096 * 1024), 0);

  		if (i != BZ_OK) {

  			printf("BUNZIP2: uncompress or overwrite error %d "

  				"- must RESET board to recover
  ", i);

  			if (boot_progress)

  				bootstage_error(BOOTSTAGE_ID_DECOMP_IMAGE);

  			return BOOTM_ERR_RESET;

  		}

  		*load_end = load + unc_len;

  		break;
  #endif /* CONFIG_BZIP2 */

  #ifdef CONFIG_LZMA

  	case IH_COMP_LZMA: {
  		SizeT lzma_len = unc_len;

  		printf("   Uncompressing %s ... ", type_name);

  		ret = lzmaBuffToBuffDecompress(load_buf, &lzma_len,
  					       image_buf, image_len);

  		unc_len = lzma_len;

  		if (ret != SZ_OK) {

  			printf("LZMA: uncompress or overwrite error %d "

  				"- must RESET board to recover
  ", ret);

  			bootstage_error(BOOTSTAGE_ID_DECOMP_IMAGE);

  			return BOOTM_ERR_RESET;
  		}
  		*load_end = load + unc_len;
  		break;

  	}

  #endif /* CONFIG_LZMA */

  #ifdef CONFIG_LZO

  	case IH_COMP_LZO: {
  		size_t size;

  		printf("   Uncompressing %s ... ", type_name);

  		ret = lzop_decompress(image_buf, image_len, load_buf, &size);

  		if (ret != LZO_E_OK) {

  			printf("LZO: uncompress or overwrite error %d "

  			      "- must RESET board to recover
  ", ret);
  			if (boot_progress)

  				bootstage_error(BOOTSTAGE_ID_DECOMP_IMAGE);

  			return BOOTM_ERR_RESET;
  		}

  		*load_end = load + size;

  		break;

  	}

  #endif /* CONFIG_LZO */

  	default:

  		printf("Unimplemented compression type %d
  ", comp);

  		return BOOTM_ERR_UNIMPLEMENTED;

  	}

  
  	flush_cache(load, (*load_end - load) * sizeof(ulong));

  	puts("OK
  ");
  	debug("   kernel loaded at 0x%08lx, end = 0x%08lx
  ", load, *load_end);

  	bootstage_mark(BOOTSTAGE_ID_KERNEL_LOADED);

  	if (!no_overlap && (load < blob_end) && (*load_end > blob_start)) {

  		debug("images.os.start = 0x%lX, images.os.end = 0x%lx
  ",
  			blob_start, blob_end);
  		debug("images.os.load = 0x%lx, load_end = 0x%lx
  ", load,
  			*load_end);

  		/* Check what type of image this is. */
  		if (images->legacy_hdr_valid) {
  			if (image_get_type(&images->legacy_hdr_os_copy)
  					== IH_TYPE_MULTI)
  				puts("WARNING: legacy format multi component image overwritten
  ");
  			return BOOTM_ERR_OVERLAP;
  		} else {
  			puts("ERROR: new format image overwritten - must RESET the board to recover
  ");
  			bootstage_error(BOOTSTAGE_ID_OVERWRITTEN);
  			return BOOTM_ERR_RESET;
  		}

  	}
  
  	return 0;
  }

  static int do_bootm_standalone(int flag, int argc, char * const argv[],
  			       bootm_headers_t *images)

  {
  	char  *s;

  	int   (*appl)(int, char * const []);

  
  	/* Don't start if "autostart" is set to "no" */
  	if (((s = getenv("autostart")) != NULL) && (strcmp(s, "no") == 0)) {

  		setenv_hex("filesize", images->os.image_len);

  		return 0;
  	}

  	appl = (int (*)(int, char * const []))images->ep;
  	appl(argc, argv);

  	return 0;
  }

  /* we overload the cmd field with our state machine info instead of a
   * function pointer */

  static cmd_tbl_t cmd_bootm_sub[] = {

  	U_BOOT_CMD_MKENT(start, 0, 1, (void *)BOOTM_STATE_START, "", ""),
  	U_BOOT_CMD_MKENT(loados, 0, 1, (void *)BOOTM_STATE_LOADOS, "", ""),

  #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH

  	U_BOOT_CMD_MKENT(ramdisk, 0, 1, (void *)BOOTM_STATE_RAMDISK, "", ""),
  #endif
  #ifdef CONFIG_OF_LIBFDT
  	U_BOOT_CMD_MKENT(fdt, 0, 1, (void *)BOOTM_STATE_FDT, "", ""),
  #endif

  	U_BOOT_CMD_MKENT(cmdline, 0, 1, (void *)BOOTM_STATE_OS_CMDLINE, "", ""),

  	U_BOOT_CMD_MKENT(bdt, 0, 1, (void *)BOOTM_STATE_OS_BD_T, "", ""),

  	U_BOOT_CMD_MKENT(prep, 0, 1, (void *)BOOTM_STATE_OS_PREP, "", ""),

  	U_BOOT_CMD_MKENT(fake, 0, 1, (void *)BOOTM_STATE_OS_FAKE_GO, "", ""),

  	U_BOOT_CMD_MKENT(go, 0, 1, (void *)BOOTM_STATE_OS_GO, "", ""),
  };

  static int boot_selected_os(int argc, char * const argv[], int state,

  		bootm_headers_t *images, boot_os_fn *boot_fn)

  {

  	arch_preboot_os();
  	boot_fn(state, argc, argv, images);

  
  	/* Stand-alone may return when 'autostart' is 'no' */
  	if (images->os.type == IH_TYPE_STANDALONE ||
  	    state == BOOTM_STATE_OS_FAKE_GO) /* We expect to return */

  		return 0;

  	bootstage_error(BOOTSTAGE_ID_BOOT_OS_RETURNED);
  #ifdef DEBUG
  	puts("
  ## Control returned to monitor - resetting...
  ");
  #endif
  	return BOOTM_ERR_RESET;
  }
  
  /**

   * bootm_disable_interrupts() - Disable interrupts in preparation for load/boot
   *
   * @return interrupt flag (0 if interrupts were disabled, non-zero if they were
   *	enabled)
   */
  static ulong bootm_disable_interrupts(void)
  {
  	ulong iflag;
  
  	/*
  	 * We have reached the point of no return: we are going to
  	 * overwrite all exception vector code, so we cannot easily
  	 * recover from any failures any more...
  	 */
  	iflag = disable_interrupts();
  #ifdef CONFIG_NETCONSOLE
  	/* Stop the ethernet stack if NetConsole could have left it up */
  	eth_halt();

  	eth_unregister(eth_get_dev());

  #endif
  
  #if defined(CONFIG_CMD_USB)
  	/*
  	 * turn off USB to prevent the host controller from writing to the
  	 * SDRAM while Linux is booting. This could happen (at least for OHCI
  	 * controller), because the HCCA (Host Controller Communication Area)
  	 * lies within the SDRAM and the host controller writes continously to
  	 * this area (as busmaster!). The HccaFrameNumber is for example
  	 * updated every 1 ms within the HCCA structure in SDRAM! For more
  	 * details see the OpenHCI specification.
  	 */
  	usb_stop();
  #endif
  	return iflag;
  }
  
  /**

   * Execute selected states of the bootm command.
   *
   * Note the arguments to this state must be the first argument, Any 'bootm'
   * or sub-command arguments must have already been taken.
   *
   * Note that if states contains more than one flag it MUST contain
   * BOOTM_STATE_START, since this handles and consumes the command line args.
   *

   * Also note that aside from boot_os_fn functions and bootm_load_os no other
   * functions we store the return value of in 'ret' may use a negative return
   * value, without special handling.
   *

   * @param cmdtp		Pointer to bootm command table entry
   * @param flag		Command flags (CMD_FLAG_...)
   * @param argc		Number of subcommand arguments (0 = no arguments)
   * @param argv		Arguments
   * @param states	Mask containing states to run (BOOTM_STATE_...)
   * @param images	Image header information
   * @param boot_progress 1 to show boot progress, 0 to not do this
   * @return 0 if ok, something else on error. Some errors will cause this
   *	function to perform a reboot! If states contains BOOTM_STATE_OS_GO
   *	then the intent is to boot an OS, so this function will not return
   *	unless the image type is standalone.
   */
  static int do_bootm_states(cmd_tbl_t *cmdtp, int flag, int argc,
  		char * const argv[], int states, bootm_headers_t *images,
  		int boot_progress)
  {
  	boot_os_fn *boot_fn;
  	ulong iflag = 0;

  	int ret = 0, need_boot_fn;

  
  	images->state |= states;
  
  	/*
  	 * Work through the states and see how far we get. We stop on
  	 * any error.
  	 */
  	if (states & BOOTM_STATE_START)
  		ret = bootm_start(cmdtp, flag, argc, argv);
  
  	if (!ret && (states & BOOTM_STATE_FINDOS))
  		ret = bootm_find_os(cmdtp, flag, argc, argv);
  
  	if (!ret && (states & BOOTM_STATE_FINDOTHER)) {
  		ret = bootm_find_other(cmdtp, flag, argc, argv);
  		argc = 0;	/* consume the args */
  	}
  
  	/* Load the OS */
  	if (!ret && (states & BOOTM_STATE_LOADOS)) {
  		ulong load_end;

  		iflag = bootm_disable_interrupts();

  		ret = bootm_load_os(images, &load_end, 0);

  		if (ret == 0)

  			lmb_reserve(&images->lmb, images->os.load,
  				    (load_end - images->os.load));

  		else if (ret && ret != BOOTM_ERR_OVERLAP)
  			goto err;

  		else if (ret == BOOTM_ERR_OVERLAP)
  			ret = 0;

  #if defined(CONFIG_SILENT_CONSOLE) && !defined(CONFIG_SILENT_U_BOOT_ONLY)

  		if (images->os.os == IH_OS_LINUX)
  			fixup_silent_linux();
  #endif

  	}
  
  	/* Relocate the ramdisk */
  #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
  	if (!ret && (states & BOOTM_STATE_RAMDISK)) {
  		ulong rd_len = images->rd_end - images->rd_start;
  
  		ret = boot_ramdisk_high(&images->lmb, images->rd_start,
  			rd_len, &images->initrd_start, &images->initrd_end);
  		if (!ret) {
  			setenv_hex("initrd_start", images->initrd_start);
  			setenv_hex("initrd_end", images->initrd_end);
  		}
  	}
  #endif
  #if defined(CONFIG_OF_LIBFDT) && defined(CONFIG_LMB)
  	if (!ret && (states & BOOTM_STATE_FDT)) {
  		boot_fdt_add_mem_rsv_regions(&images->lmb, images->ft_addr);
  		ret = boot_relocate_fdt(&images->lmb, &images->ft_addr,
  					&images->ft_len);
  	}
  #endif
  
  	/* From now on, we need the OS boot function */
  	if (ret)
  		return ret;
  	boot_fn = boot_os[images->os.os];

  	need_boot_fn = states & (BOOTM_STATE_OS_CMDLINE |
  			BOOTM_STATE_OS_BD_T | BOOTM_STATE_OS_PREP |
  			BOOTM_STATE_OS_FAKE_GO | BOOTM_STATE_OS_GO);
  	if (boot_fn == NULL && need_boot_fn) {

  		if (iflag)
  			enable_interrupts();
  		printf("ERROR: booting os '%s' (%d) is not supported
  ",
  		       genimg_get_os_name(images->os.os), images->os.os);
  		bootstage_error(BOOTSTAGE_ID_CHECK_BOOT_OS);
  		return 1;
  	}
  
  	/* Call various other states that are not generally used */
  	if (!ret && (states & BOOTM_STATE_OS_CMDLINE))
  		ret = boot_fn(BOOTM_STATE_OS_CMDLINE, argc, argv, images);
  	if (!ret && (states & BOOTM_STATE_OS_BD_T))
  		ret = boot_fn(BOOTM_STATE_OS_BD_T, argc, argv, images);
  	if (!ret && (states & BOOTM_STATE_OS_PREP))
  		ret = boot_fn(BOOTM_STATE_OS_PREP, argc, argv, images);

  #ifdef CONFIG_TRACE
  	/* Pretend to run the OS, then run a user command */
  	if (!ret && (states & BOOTM_STATE_OS_FAKE_GO)) {
  		char *cmd_list = getenv("fakegocmd");
  
  		ret = boot_selected_os(argc, argv, BOOTM_STATE_OS_FAKE_GO,

  				images, boot_fn);

  		if (!ret && cmd_list)
  			ret = run_command_list(cmd_list, -1, flag);
  	}
  #endif

  
  	/* Check for unsupported subcommand. */
  	if (ret) {
  		puts("subcommand not supported
  ");
  		return ret;
  	}

  	/* Now run the OS! We hope this doesn't return */

  	if (!ret && (states & BOOTM_STATE_OS_GO))

  		ret = boot_selected_os(argc, argv, BOOTM_STATE_OS_GO,

  				images, boot_fn);

  
  	/* Deal with any fallout */

  err:

  	if (iflag)
  		enable_interrupts();

  
  	if (ret == BOOTM_ERR_UNIMPLEMENTED)
  		bootstage_error(BOOTSTAGE_ID_DECOMP_UNIMPL);
  	else if (ret == BOOTM_ERR_RESET)
  		do_reset(cmdtp, flag, argc, argv);

  
  	return ret;
  }

  static int do_bootm_subcommand(cmd_tbl_t *cmdtp, int flag, int argc,

  			char * const argv[])

  {
  	int ret = 0;

  	long state;

  	cmd_tbl_t *c;

  	c = find_cmd_tbl(argv[0], &cmd_bootm_sub[0], ARRAY_SIZE(cmd_bootm_sub));
  	argc--; argv++;

  
  	if (c) {

  		state = (long)c->cmd;

  		if (state == BOOTM_STATE_START)

  			state |= BOOTM_STATE_FINDOS | BOOTM_STATE_FINDOTHER;

  	} else {
  		/* Unrecognized command */

  		return CMD_RET_USAGE;

  	}

  	if (state != BOOTM_STATE_START && images.state >= state) {

  		printf("Trying to execute a command out of order
  ");

  		return CMD_RET_USAGE;

  	}

  	ret = do_bootm_states(cmdtp, flag, argc, argv, state, &images, 0);

  
  	return ret;
  }

  /*******************************************************************/
  /* bootm - boot application image from image in memory */
  /*******************************************************************/

  int do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])

  {

  #ifdef CONFIG_NEEDS_MANUAL_RELOC

  	static int relocated = 0;

  	if (!relocated) {
  		int i;

  
  		/* relocate boot function table */

  		for (i = 0; i < ARRAY_SIZE(boot_os); i++)

  			if (boot_os[i] != NULL)
  				boot_os[i] += gd->reloc_off;

  
  		/* relocate names of sub-command table */
  		for (i = 0; i < ARRAY_SIZE(cmd_bootm_sub); i++)
  			cmd_bootm_sub[i].name += gd->reloc_off;

  		relocated = 1;
  	}

  #endif

  	/* determine if we have a sub command */

  	argc--; argv++;
  	if (argc > 0) {

  		char *endp;

  		simple_strtoul(argv[0], &endp, 16);
  		/* endp pointing to NULL means that argv[0] was just a

  		 * valid number, pass it along to the normal bootm processing
  		 *
  		 * If endp is ':' or '#' assume a FIT identifier so pass
  		 * along for normal processing.
  		 *
  		 * Right now we assume the first arg should never be '-'
  		 */
  		if ((*endp != 0) && (*endp != ':') && (*endp != '#'))
  			return do_bootm_subcommand(cmdtp, flag, argc, argv);
  	}

  	return do_bootm_states(cmdtp, flag, argc, argv, BOOTM_STATE_START |
  		BOOTM_STATE_FINDOS | BOOTM_STATE_FINDOTHER |

  		BOOTM_STATE_LOADOS |
  #if defined(CONFIG_PPC) || defined(CONFIG_MIPS)
  		BOOTM_STATE_OS_CMDLINE |
  #endif

  		BOOTM_STATE_OS_PREP | BOOTM_STATE_OS_FAKE_GO |
  		BOOTM_STATE_OS_GO, &images, 1);

  }

  int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd)
  {
  	const char *ep = getenv("autostart");
  
  	if (ep && !strcmp(ep, "yes")) {
  		char *local_args[2];
  		local_args[0] = (char *)cmd;
  		local_args[1] = NULL;
  		printf("Automatic boot of image at addr 0x%08lX ...
  ", load_addr);
  		return do_bootm(cmdtp, 0, 1, local_args);
  	}
  
  	return 0;
  }

  /**

   * image_get_kernel - verify legacy format kernel image
   * @img_addr: in RAM address of the legacy format image to be verified
   * @verify: data CRC verification flag

   *

   * image_get_kernel() verifies legacy image integrity and returns pointer to
   * legacy image header if image verification was completed successfully.

   *
   * returns:

   *     pointer to a legacy image header if valid image was found
   *     otherwise return NULL

   */

  static image_header_t *image_get_kernel(ulong img_addr, int verify)

  {

  	image_header_t *hdr = (image_header_t *)img_addr;

  	if (!image_check_magic(hdr)) {

  		puts("Bad Magic Number
  ");

  		bootstage_error(BOOTSTAGE_ID_CHECK_MAGIC);

  		return NULL;
  	}

  	bootstage_mark(BOOTSTAGE_ID_CHECK_HEADER);

  	if (!image_check_hcrc(hdr)) {
  		puts("Bad Header Checksum
  ");

  		bootstage_error(BOOTSTAGE_ID_CHECK_HEADER);

  		return NULL;
  	}

  	bootstage_mark(BOOTSTAGE_ID_CHECK_CHECKSUM);

  	image_print_contents(hdr);

  
  	if (verify) {

  		puts("   Verifying Checksum ... ");
  		if (!image_check_dcrc(hdr)) {
  			printf("Bad Data CRC
  ");

  			bootstage_error(BOOTSTAGE_ID_CHECK_CHECKSUM);

  			return NULL;

  		}

  		puts("OK
  ");

  	}

  	bootstage_mark(BOOTSTAGE_ID_CHECK_ARCH);

  	if (!image_check_target_arch(hdr)) {
  		printf("Unsupported Architecture 0x%x
  ", image_get_arch(hdr));

  		bootstage_error(BOOTSTAGE_ID_CHECK_ARCH);

  		return NULL;
  	}
  	return hdr;

  }

  /**

   * boot_get_kernel - find kernel image

   * @os_data: pointer to a ulong variable, will hold os data start address
   * @os_len: pointer to a ulong variable, will hold os data length
   *

   * boot_get_kernel() tries to find a kernel image, verifies its integrity

   * and locates kernel data.
   *
   * returns:
   *     pointer to image header if valid image was found, plus kernel start
   *     address and length, otherwise NULL
   */

  static const void *boot_get_kernel(cmd_tbl_t *cmdtp, int flag, int argc,

  		char * const argv[], bootm_headers_t *images, ulong *os_data,
  		ulong *os_len)

  {
  	image_header_t	*hdr;
  	ulong		img_addr;

  	const void *buf;

  #if defined(CONFIG_FIT)

  	const char	*fit_uname_config = NULL;
  	const char	*fit_uname_kernel = NULL;

  	int		os_noffset;

  #endif

  	/* find out kernel image address */

  	if (argc < 1) {

  		img_addr = load_addr;

  		debug("*  kernel: default image load address = 0x%08lx
  ",

  				load_addr);
  #if defined(CONFIG_FIT)

  	} else if (fit_parse_conf(argv[0], load_addr, &img_addr,

  							&fit_uname_config)) {

  		debug("*  kernel: config '%s' from image at 0x%08lx
  ",

  				fit_uname_config, img_addr);

  	} else if (fit_parse_subimage(argv[0], load_addr, &img_addr,

  							&fit_uname_kernel)) {

  		debug("*  kernel: subimage '%s' from image at 0x%08lx
  ",

  				fit_uname_kernel, img_addr);
  #endif

  	} else {

  		img_addr = simple_strtoul(argv[0], NULL, 16);

  		debug("*  kernel: cmdline image address = 0x%08lx
  ", img_addr);

  	}

  	bootstage_mark(BOOTSTAGE_ID_CHECK_MAGIC);

  	/* copy from dataflash if needed */

  	img_addr = genimg_get_image(img_addr);

  	/* check image type, for FIT images get FIT kernel node */

  	*os_data = *os_len = 0;

  	buf = map_sysmem(img_addr, 0);
  	switch (genimg_get_format(buf)) {

  	case IMAGE_FORMAT_LEGACY:

  		printf("## Booting kernel from Legacy Image at %08lx ...
  ",

  				img_addr);

  		hdr = image_get_kernel(img_addr, images->verify);

  		if (!hdr)

  			return NULL;

  		bootstage_mark(BOOTSTAGE_ID_CHECK_IMAGETYPE);

  		/* get os_data and os_len */

  		switch (image_get_type(hdr)) {

  		case IH_TYPE_KERNEL:

  		case IH_TYPE_KERNEL_NOLOAD:

  			*os_data = image_get_data(hdr);
  			*os_len = image_get_data_size(hdr);

  			break;
  		case IH_TYPE_MULTI:

  			image_multi_getimg(hdr, 0, os_data, os_len);

  			break;

  		case IH_TYPE_STANDALONE:

  			*os_data = image_get_data(hdr);
  			*os_len = image_get_data_size(hdr);

  			break;

  		default:

  			printf("Wrong Image Type for %s command
  ",
  				cmdtp->name);

  			bootstage_error(BOOTSTAGE_ID_CHECK_IMAGETYPE);

  			return NULL;
  		}

  
  		/*

  		 * copy image header to allow for image overwrites during
  		 * kernel decompression.

  		 */

  		memmove(&images->legacy_hdr_os_copy, hdr,
  			sizeof(image_header_t));

  
  		/* save pointer to image header */

  		images->legacy_hdr_os = hdr;

  		images->legacy_hdr_valid = 1;

  		bootstage_mark(BOOTSTAGE_ID_DECOMP_IMAGE);

  		break;

  #if defined(CONFIG_FIT)
  	case IMAGE_FORMAT_FIT:

  		os_noffset = fit_image_load(images, FIT_KERNEL_PROP,
  				img_addr,

  				&fit_uname_kernel, &fit_uname_config,

  				IH_ARCH_DEFAULT, IH_TYPE_KERNEL,
  				BOOTSTAGE_ID_FIT_KERNEL_START,
  				FIT_LOAD_IGNORED, os_data, os_len);
  		if (os_noffset < 0)

  			return NULL;

  		images->fit_hdr_os = map_sysmem(img_addr, 0);

  		images->fit_uname_os = fit_uname_kernel;

  		images->fit_uname_cfg = fit_uname_config;

  		images->fit_noffset_os = os_noffset;

  		break;

  #endif

  	default:

  		printf("Wrong Image Format for %s command
  ", cmdtp->name);

  		bootstage_error(BOOTSTAGE_ID_FIT_KERNEL_INFO);

  		return NULL;

  	}

  	debug("   kernel data at 0x%08lx, len = 0x%08lx (%ld)
  ",

  			*os_data, *os_len, *os_len);

  	return buf;

  }

  #ifdef CONFIG_SYS_LONGHELP
  static char bootm_help_text[] =

  	"[addr [arg ...]]
      - boot application image stored in memory
  "
  	"\tpassing arguments 'arg ...'; when booting a Linux kernel,
  "
  	"\t'arg' can be the address of an initrd image
  "

  #if defined(CONFIG_OF_LIBFDT)

  	"\tWhen booting a Linux kernel which requires a flat device-tree
  "

  	"\ta third argument is required which is the address of the
  "

  	"\tdevice-tree blob. To boot that kernel without an initrd image,
  "
  	"\tuse a '-' for the second argument. If you do not pass a third
  "
  	"\ta bd_info struct will be passed instead
  "

  #endif

  #if defined(CONFIG_FIT)
  	"\t
  For the new multi component uImage format (FIT) addresses
  "
  	"\tmust be extened to include component or configuration unit name:
  "
  	"\taddr:<subimg_uname> - direct component image specification
  "
  	"\taddr#<conf_uname>   - configuration specification
  "
  	"\tUse iminfo command to get the list of existing component
  "
  	"\timages and configurations.
  "
  #endif

  	"
  Sub-commands to do part of the bootm sequence.  The sub-commands "
  	"must be
  "
  	"issued in the order below (it's ok to not issue all sub-commands):
  "
  	"\tstart [addr [arg ...]]
  "
  	"\tloados  - load OS image
  "

  #if defined(CONFIG_SYS_BOOT_RAMDISK_HIGH)

  	"\tramdisk - relocate initrd, set env initrd_start/initrd_end
  "
  #endif
  #if defined(CONFIG_OF_LIBFDT)
  	"\tfdt     - relocate flat device tree
  "
  #endif

  	"\tcmdline - OS specific command line processing/setup
  "

  	"\tbdt     - OS specific bd_t processing
  "

  	"\tprep    - OS specific prep before relocation or go
  "

  	"\tgo      - start OS";
  #endif
  
  U_BOOT_CMD(
  	bootm,	CONFIG_SYS_MAXARGS,	1,	do_bootm,
  	"boot application image from memory", bootm_help_text

  );

  /*******************************************************************/
  /* bootd - boot default image */
  /*******************************************************************/

  #if defined(CONFIG_CMD_BOOTD)

  int do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])

  {
  	int rcode = 0;

  	if (run_command(getenv("bootcmd"), flag) < 0)

  		rcode = 1;

  	return rcode;
  }

  U_BOOT_CMD(

  	boot,	1,	1,	do_bootd,

  	"boot default, i.e., run 'bootcmd'",

  	""

  );

  /* keep old command name "bootd" for backward compatibility */

  U_BOOT_CMD(

  	bootd, 1,	1,	do_bootd,

  	"boot default, i.e., run 'bootcmd'",

  	""

  );

  #endif

  /*******************************************************************/
  /* iminfo - print header info for a requested image */
  /*******************************************************************/

  #if defined(CONFIG_CMD_IMI)

  static int do_iminfo(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])

  {
  	int	arg;
  	ulong	addr;

  	int	rcode = 0;

  	if (argc < 2) {

  		return image_info(load_addr);

  	}

  	for (arg = 1; arg < argc; ++arg) {

  		addr = simple_strtoul(argv[arg], NULL, 16);
  		if (image_info(addr) != 0)

  			rcode = 1;

  	}
  	return rcode;
  }

  static int image_info(ulong addr)

  {

  	void *hdr = (void *)addr;

  	printf("
  ## Checking Image at %08lx ...
  ", addr);

  	switch (genimg_get_format(hdr)) {

  	case IMAGE_FORMAT_LEGACY:

  		puts("   Legacy image found
  ");
  		if (!image_check_magic(hdr)) {
  			puts("   Bad Magic Number
  ");

  			return 1;
  		}

  		if (!image_check_hcrc(hdr)) {
  			puts("   Bad Header Checksum
  ");

  			return 1;

  		}

  		image_print_contents(hdr);

  		puts("   Verifying Checksum ... ");
  		if (!image_check_dcrc(hdr)) {
  			puts("   Bad Data CRC
  ");

  			return 1;

  		}

  		puts("OK
  ");

  		return 0;
  #if defined(CONFIG_FIT)
  	case IMAGE_FORMAT_FIT:

  		puts("   FIT image found
  ");

  		if (!fit_check_format(hdr)) {
  			puts("Bad FIT image format!
  ");

  			return 1;

  		}

  		fit_print_contents(hdr);

  		if (!fit_all_image_verify(hdr)) {

  			puts("Bad hash in FIT image!
  ");

  			return 1;
  		}

  		return 0;
  #endif
  	default:

  		puts("Unknown image format!
  ");

  		break;

  	}

  	return 1;

  }

  
  U_BOOT_CMD(

  	iminfo,	CONFIG_SYS_MAXARGS,	1,	do_iminfo,

  	"print header information for application image",

  	"addr [addr ...]
  "
  	"    - print header information for application image starting at
  "
  	"      address 'addr' in memory; this includes verification of the
  "

  	"      image contents (magic number, header and payload checksums)"

  );

  #endif

  /*******************************************************************/
  /* imls - list all images found in flash */
  /*******************************************************************/

  #if defined(CONFIG_CMD_IMLS)

  static int do_imls_nor(void)

  {
  	flash_info_t *info;
  	int i, j;

  	void *hdr;

  	for (i = 0, info = &flash_info[0];

  		i < CONFIG_SYS_MAX_FLASH_BANKS; ++i, ++info) {

  		if (info->flash_id == FLASH_UNKNOWN)
  			goto next_bank;

  		for (j = 0; j < info->sector_count; ++j) {

  			hdr = (void *)info->start[j];
  			if (!hdr)

  				goto next_sector;

  			switch (genimg_get_format(hdr)) {

  			case IMAGE_FORMAT_LEGACY:

  				if (!image_check_hcrc(hdr))

  					goto next_sector;

  				printf("Legacy Image at %08lX:
  ", (ulong)hdr);
  				image_print_contents(hdr);

  				puts("   Verifying Checksum ... ");
  				if (!image_check_dcrc(hdr)) {
  					puts("Bad Data CRC
  ");

  				} else {

  					puts("OK
  ");

  				}
  				break;
  #if defined(CONFIG_FIT)
  			case IMAGE_FORMAT_FIT:

  				if (!fit_check_format(hdr))

  					goto next_sector;

  				printf("FIT Image at %08lX:
  ", (ulong)hdr);
  				fit_print_contents(hdr);