[people/ms/u-boot.git] / arch / arm / cpu / armv7 / omap-common / spl.c

/*
 * (C) Copyright 2010
 * Texas Instruments, <www.ti.com>
 *
 * Aneesh V <aneesh@ti.com>
 *
 * See file CREDITS for list of people who contributed to this
 * project.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307 USA
 */
#include <common.h>
#include <asm/u-boot.h>
#include <asm/utils.h>
#include <asm/arch/sys_proto.h>
#include <nand.h>
#include <mmc.h>
#include <fat.h>
#include <version.h>
#include <asm/omap_common.h>
#include <asm/arch/mmc_host_def.h>
#include <i2c.h>
#include <image.h>
#include <malloc.h>
#include <linux/compiler.h>

DECLARE_GLOBAL_DATA_PTR;

u32* boot_params_ptr = NULL;
struct spl_image_info spl_image;

/* Define global data structure pointer to it*/
static gd_t gdata __attribute__ ((section(".data")));
static bd_t bdata __attribute__ ((section(".data")));

inline void hang(void)
{
	puts("### ERROR ### Please RESET the board ###\n");
	for (;;)
		;
}

void board_init_f(ulong dummy)
{
	/*
	 * We call relocate_code() with relocation target same as the
	 * CONFIG_SYS_SPL_TEXT_BASE. This will result in relocation getting
	 * skipped. Instead, only .bss initialization will happen. That's
	 * all we need
	 */
	debug(">>board_init_f()\n");
	relocate_code(CONFIG_SPL_STACK, &gdata, CONFIG_SPL_TEXT_BASE);
}

/*
 * Default function to determine if u-boot or the OS should
 * be started. This implementation always returns 1.
 *
 * Please implement your own board specific funcion to do this.
 *
 * RETURN
 * 0 to not start u-boot
 * positive if u-boot should start
 */
#ifdef CONFIG_SPL_OS_BOOT
__weak int spl_start_uboot(void)
{
	printf("SPL: Please implement spl_start_uboot() for your board\n");
	printf("SPL: Direct Linux boot not active!\n");
	return 1;
}
#endif

void spl_parse_image_header(const struct image_header *header)
{
	u32 header_size = sizeof(struct image_header);

	if (__be32_to_cpu(header->ih_magic) == IH_MAGIC) {
		spl_image.size = __be32_to_cpu(header->ih_size) + header_size;
		spl_image.entry_point = __be32_to_cpu(header->ih_load);
		/* Load including the header */
		spl_image.load_addr = spl_image.entry_point - header_size;
		spl_image.os = header->ih_os;
		spl_image.name = (const char *)&header->ih_name;
		debug("spl: payload image: %s load addr: 0x%x size: %d\n",
			spl_image.name, spl_image.load_addr, spl_image.size);
	} else {
		/* Signature not found - assume u-boot.bin */
		printf("mkimage signature not found - ih_magic = %x\n",
			header->ih_magic);
		debug("Assuming u-boot.bin ..\n");
		/* Let's assume U-Boot will not be more than 200 KB */
		spl_image.size = 200 * 1024;
		spl_image.entry_point = CONFIG_SYS_TEXT_BASE;
		spl_image.load_addr = CONFIG_SYS_TEXT_BASE;
		spl_image.os = IH_OS_U_BOOT;
		spl_image.name = "U-Boot";
	}
}

/*
 * This function jumps to an image with argument. Normally an FDT or ATAGS
 * image.
 * arg: Pointer to paramter image in RAM
 */
#ifdef CONFIG_SPL_OS_BOOT
static void __noreturn jump_to_image_linux(void *arg)
{
	debug("Entering kernel arg pointer: 0x%p\n", arg);
	typedef void (*image_entry_arg_t)(int, int, void *)
		__attribute__ ((noreturn));
	image_entry_arg_t image_entry =
		(image_entry_arg_t) spl_image.entry_point;
	cleanup_before_linux();
	image_entry(0, CONFIG_MACH_TYPE, arg);
}
#endif

static void __noreturn jump_to_image_no_args(void)
{
	typedef void __noreturn (*image_entry_noargs_t)(u32 *);
	image_entry_noargs_t image_entry =
			(image_entry_noargs_t) spl_image.entry_point;

	debug("image entry point: 0x%X\n", spl_image.entry_point);
	/* Pass the saved boot_params from rom code */
#if defined(CONFIG_VIRTIO) || defined(CONFIG_ZEBU)
	image_entry = (image_entry_noargs_t)0x80100000;
#endif
	u32 boot_params_ptr_addr = (u32)&boot_params_ptr;
	image_entry((u32 *)boot_params_ptr_addr);
}

void board_init_r(gd_t *id, ulong dummy)
{
	u32 boot_device;
	debug(">>spl:board_init_r()\n");

	mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
			CONFIG_SYS_SPL_MALLOC_SIZE);

#ifdef CONFIG_SPL_BOARD_INIT
	spl_board_init();
#endif

	boot_device = spl_boot_device();
	debug("boot device - %d\n", boot_device);
	switch (boot_device) {
#ifdef CONFIG_SPL_MMC_SUPPORT
	case BOOT_DEVICE_MMC1:
	case BOOT_DEVICE_MMC2:
	case BOOT_DEVICE_MMC2_2:
		spl_mmc_load_image();
		break;
#endif
#ifdef CONFIG_SPL_NAND_SUPPORT
	case BOOT_DEVICE_NAND:
		spl_nand_load_image();
		break;
#endif
#ifdef CONFIG_SPL_YMODEM_SUPPORT
	case BOOT_DEVICE_UART:
		spl_ymodem_load_image();
		break;
#endif
	default:
		printf("SPL: Un-supported Boot Device - %d!!!\n", boot_device);
		hang();
		break;
	}

	switch (spl_image.os) {
	case IH_OS_U_BOOT:
		debug("Jumping to U-Boot\n");
		jump_to_image_no_args();
		break;
#ifdef CONFIG_SPL_OS_BOOT
	case IH_OS_LINUX:
		debug("Jumping to Linux\n");
		spl_board_prepare_for_linux();
		jump_to_image_linux((void *)CONFIG_SYS_SPL_ARGS_ADDR);
		break;
#endif
	default:
		puts("Unsupported OS image.. Jumping nevertheless..\n");
		jump_to_image_no_args();
	}
}

/* This requires UART clocks to be enabled */
void preloader_console_init(void)
{
	const char *u_boot_rev = U_BOOT_VERSION;

	gd = &gdata;
	gd->bd = &bdata;
	gd->flags |= GD_FLG_RELOC;
	gd->baudrate = CONFIG_BAUDRATE;

	serial_init();		/* serial communications setup */

	gd->have_console = 1;

	/* Avoid a second "U-Boot" coming from this string */
	u_boot_rev = &u_boot_rev[7];

	printf("\nU-Boot SPL %s (%s - %s)\n", u_boot_rev, U_BOOT_DATE,
		U_BOOT_TIME);
#ifdef CONFIG_SPL_DISPLAY_PRINT
	spl_display_print();
#endif
}
Commit	Line	Data
bcae7211 A	1	/*
	2	* (C) Copyright 2010
	3	* Texas Instruments, <www.ti.com>
	4	*
	5	* Aneesh V <aneesh@ti.com>
	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	#include <common.h>
	26	#include <asm/u-boot.h>
8cf686e1	27	#include <asm/utils.h>
bcae7211	28	#include <asm/arch/sys_proto.h>
bb085b87	29	#include <nand.h>
8cf686e1 A	30	#include <mmc.h>
8cf686e1 A	31	#include <fat.h>
efb2172e	32	#include <version.h>
8cf686e1 A	33	#include <asm/omap_common.h>
	34	#include <asm/arch/mmc_host_def.h>
	35	#include <i2c.h>
	36	#include <image.h>
2d01dd95	37	#include <malloc.h>
761ca31e	38	#include <linux/compiler.h>
bcae7211 A	39
	40	DECLARE_GLOBAL_DATA_PTR;
	41
78f455c0	42	u32* boot_params_ptr = NULL;
9ea5c6ef SS	43	struct spl_image_info spl_image;
9ea5c6ef SS	44
bcae7211 A	45	/* Define global data structure pointer to it*/
	46	static gd_t gdata __attribute__ ((section(".data")));
	47	static bd_t bdata __attribute__ ((section(".data")));
	48
	49	inline void hang(void)
	50	{
	51	puts("### ERROR ### Please RESET the board ###\n");
	52	for (;;)
	53	;
	54	}
	55
	56	void board_init_f(ulong dummy)
	57	{
	58	/*
	59	* We call relocate_code() with relocation target same as the
	60	* CONFIG_SYS_SPL_TEXT_BASE. This will result in relocation getting
	61	* skipped. Instead, only .bss initialization will happen. That's
	62	* all we need
	63	*/
	64	debug(">>board_init_f()\n");
	65	relocate_code(CONFIG_SPL_STACK, &gdata, CONFIG_SPL_TEXT_BASE);
	66	}
	67
379c19ab SS	68	/*
	69	* Default function to determine if u-boot or the OS should
	70	* be started. This implementation always returns 1.
	71	*
	72	* Please implement your own board specific funcion to do this.
	73	*
	74	* RETURN
	75	* 0 to not start u-boot
	76	* positive if u-boot should start
	77	*/
	78	#ifdef CONFIG_SPL_OS_BOOT
	79	__weak int spl_start_uboot(void)
	80	{
	81	printf("SPL: Please implement spl_start_uboot() for your board\n");
	82	printf("SPL: Direct Linux boot not active!\n");
	83	return 1;
	84	}
	85	#endif
	86
9ea5c6ef	87	void spl_parse_image_header(const struct image_header *header)
8cf686e1 A	88	{
	89	u32 header_size = sizeof(struct image_header);
	90
	91	if (__be32_to_cpu(header->ih_magic) == IH_MAGIC) {
9ea5c6ef SS	92	spl_image.size = __be32_to_cpu(header->ih_size) + header_size;
9ea5c6ef SS	93	spl_image.entry_point = __be32_to_cpu(header->ih_load);
8cf686e1	94	/* Load including the header */
9ea5c6ef SS	95	spl_image.load_addr = spl_image.entry_point - header_size;
	96	spl_image.os = header->ih_os;
	97	spl_image.name = (const char *)&header->ih_name;
8cf686e1	98	debug("spl: payload image: %s load addr: 0x%x size: %d\n",
9ea5c6ef	99	spl_image.name, spl_image.load_addr, spl_image.size);
8cf686e1 A	100	} else {
	101	/* Signature not found - assume u-boot.bin */
	102	printf("mkimage signature not found - ih_magic = %x\n",
	103	header->ih_magic);
ace73189	104	debug("Assuming u-boot.bin ..\n");
8cf686e1	105	/* Let's assume U-Boot will not be more than 200 KB */
9ea5c6ef SS	106	spl_image.size = 200 * 1024;
	107	spl_image.entry_point = CONFIG_SYS_TEXT_BASE;
	108	spl_image.load_addr = CONFIG_SYS_TEXT_BASE;
	109	spl_image.os = IH_OS_U_BOOT;
	110	spl_image.name = "U-Boot";
8cf686e1 A	111	}
	112	}
	113
379c19ab SS	114	/*
	115	* This function jumps to an image with argument. Normally an FDT or ATAGS
	116	* image.
	117	* arg: Pointer to paramter image in RAM
	118	*/
	119	#ifdef CONFIG_SPL_OS_BOOT
	120	static void __noreturn jump_to_image_linux(void *arg)
	121	{
	122	debug("Entering kernel arg pointer: 0x%p\n", arg);
	123	typedef void (image_entry_arg_t)(int, int, void )
	124	__attribute__ ((noreturn));
	125	image_entry_arg_t image_entry =
	126	(image_entry_arg_t) spl_image.entry_point;
53c4492c	127	cleanup_before_linux();
379c19ab SS	128	image_entry(0, CONFIG_MACH_TYPE, arg);
	129	}
	130	#endif
	131
ad1820a3	132	static void __noreturn jump_to_image_no_args(void)
8cf686e1	133	{
ad1820a3	134	typedef void __noreturn (image_entry_noargs_t)(u32 );
8cf686e1	135	image_entry_noargs_t image_entry =
9ea5c6ef	136	(image_entry_noargs_t) spl_image.entry_point;
8cf686e1	137
9ea5c6ef	138	debug("image entry point: 0x%X\n", spl_image.entry_point);
78f455c0 S	139	/* Pass the saved boot_params from rom code */
78f455c0 S	140	#if defined(CONFIG_VIRTIO) \|\| defined(CONFIG_ZEBU)
b0a86a27	141	image_entry = (image_entry_noargs_t)0x80100000;
78f455c0	142	#endif
b0a86a27 AG	143	u32 boot_params_ptr_addr = (u32)&boot_params_ptr;
b0a86a27 AG	144	image_entry((u32 *)boot_params_ptr_addr);
8cf686e1 A	145	}
8cf686e1 A	146
bcae7211 A	147	void board_init_r(gd_t *id, ulong dummy)
bcae7211 A	148	{
8cf686e1 A	149	u32 boot_device;
	150	debug(">>spl:board_init_r()\n");
	151
2d01dd95 A	152	mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
	153	CONFIG_SYS_SPL_MALLOC_SIZE);
	154
ee08a826 TR	155	#ifdef CONFIG_SPL_BOARD_INIT
	156	spl_board_init();
	157	#endif
	158
8e1b836e	159	boot_device = spl_boot_device();
8cf686e1 A	160	debug("boot device - %d\n", boot_device);
8cf686e1 A	161	switch (boot_device) {
bb085b87	162	#ifdef CONFIG_SPL_MMC_SUPPORT
8cf686e1 A	163	case BOOT_DEVICE_MMC1:
8cf686e1 A	164	case BOOT_DEVICE_MMC2:
f75231b7	165	case BOOT_DEVICE_MMC2_2:
9ea5c6ef	166	spl_mmc_load_image();
8cf686e1	167	break;
bb085b87 SS	168	#endif
	169	#ifdef CONFIG_SPL_NAND_SUPPORT
	170	case BOOT_DEVICE_NAND:
9ea5c6ef	171	spl_nand_load_image();
bb085b87	172	break;
24de357a MP	173	#endif
	174	#ifdef CONFIG_SPL_YMODEM_SUPPORT
	175	case BOOT_DEVICE_UART:
	176	spl_ymodem_load_image();
	177	break;
bb085b87	178	#endif
8cf686e1 A	179	default:
	180	printf("SPL: Un-supported Boot Device - %d!!!\n", boot_device);
	181	hang();
	182	break;
	183	}
	184
9ea5c6ef	185	switch (spl_image.os) {
8cf686e1 A	186	case IH_OS_U_BOOT:
	187	debug("Jumping to U-Boot\n");
	188	jump_to_image_no_args();
	189	break;
379c19ab SS	190	#ifdef CONFIG_SPL_OS_BOOT
	191	case IH_OS_LINUX:
	192	debug("Jumping to Linux\n");
	193	spl_board_prepare_for_linux();
	194	jump_to_image_linux((void *)CONFIG_SYS_SPL_ARGS_ADDR);
	195	break;
	196	#endif
8cf686e1 A	197	default:
	198	puts("Unsupported OS image.. Jumping nevertheless..\n");
	199	jump_to_image_no_args();
	200	}
bcae7211 A	201	}
bcae7211 A	202
63ffcfcb	203	/* This requires UART clocks to be enabled */
bcae7211 A	204	void preloader_console_init(void)
	205	{
	206	const char *u_boot_rev = U_BOOT_VERSION;
bcae7211 A	207
	208	gd = &gdata;
	209	gd->bd = &bdata;
	210	gd->flags \|= GD_FLG_RELOC;
	211	gd->baudrate = CONFIG_BAUDRATE;
	212
bcae7211 A	213	serial_init(); /* serial communications setup */
bcae7211 A	214
b88befa5 IY	215	gd->have_console = 1;
b88befa5 IY	216
bcae7211 A	217	/* Avoid a second "U-Boot" coming from this string */
	218	u_boot_rev = &u_boot_rev[7];
	219
	220	printf("\nU-Boot SPL %s (%s - %s)\n", u_boot_rev, U_BOOT_DATE,
	221	U_BOOT_TIME);
861a86f4 TR	222	#ifdef CONFIG_SPL_DISPLAY_PRINT
	223	spl_display_print();
	224	#endif
cc3f7058	225	}