xref: /openbmc/u-boot/common/spl/spl.c (revision b97cd681)
1 /*
2  * (C) Copyright 2010
3  * Texas Instruments, <www.ti.com>
4  *
5  * Aneesh V <aneesh@ti.com>
6  *
7  * SPDX-License-Identifier:	GPL-2.0+
8  */
9 #include <common.h>
10 #include <spl.h>
11 #include <asm/u-boot.h>
12 #include <nand.h>
13 #include <fat.h>
14 #include <version.h>
15 #include <i2c.h>
16 #include <image.h>
17 #include <malloc.h>
18 #include <linux/compiler.h>
19 
20 DECLARE_GLOBAL_DATA_PTR;
21 
22 #ifndef CONFIG_SYS_UBOOT_START
23 #define CONFIG_SYS_UBOOT_START	CONFIG_SYS_TEXT_BASE
24 #endif
25 #ifndef CONFIG_SYS_MONITOR_LEN
26 /* Unknown U-Boot size, let's assume it will not be more than 200 KB */
27 #define CONFIG_SYS_MONITOR_LEN	(200 * 1024)
28 #endif
29 
30 u32 *boot_params_ptr = NULL;
31 struct spl_image_info spl_image;
32 
33 /* Define board data structure */
34 static bd_t bdata __attribute__ ((section(".data")));
35 
36 /*
37  * Default function to determine if u-boot or the OS should
38  * be started. This implementation always returns 1.
39  *
40  * Please implement your own board specific funcion to do this.
41  *
42  * RETURN
43  * 0 to not start u-boot
44  * positive if u-boot should start
45  */
46 #ifdef CONFIG_SPL_OS_BOOT
47 __weak int spl_start_uboot(void)
48 {
49 	puts("SPL: Please implement spl_start_uboot() for your board\n");
50 	puts("SPL: Direct Linux boot not active!\n");
51 	return 1;
52 }
53 #endif
54 
55 /*
56  * Weak default function for board specific cleanup/preparation before
57  * Linux boot. Some boards/platforms might not need it, so just provide
58  * an empty stub here.
59  */
60 __weak void spl_board_prepare_for_linux(void)
61 {
62 	/* Nothing to do! */
63 }
64 
65 void spl_parse_image_header(const struct image_header *header)
66 {
67 	u32 header_size = sizeof(struct image_header);
68 
69 	if (image_get_magic(header) == IH_MAGIC) {
70 		if (spl_image.flags & SPL_COPY_PAYLOAD_ONLY) {
71 			/*
72 			 * On some system (e.g. powerpc), the load-address and
73 			 * entry-point is located at address 0. We can't load
74 			 * to 0-0x40. So skip header in this case.
75 			 */
76 			spl_image.load_addr = image_get_load(header);
77 			spl_image.entry_point = image_get_ep(header);
78 			spl_image.size = image_get_data_size(header);
79 		} else {
80 			spl_image.entry_point = image_get_load(header);
81 			/* Load including the header */
82 			spl_image.load_addr = spl_image.entry_point -
83 				header_size;
84 			spl_image.size = image_get_data_size(header) +
85 				header_size;
86 		}
87 		spl_image.os = image_get_os(header);
88 		spl_image.name = image_get_name(header);
89 		debug("spl: payload image: %.*s load addr: 0x%x size: %d\n",
90 			(int)sizeof(spl_image.name), spl_image.name,
91 			spl_image.load_addr, spl_image.size);
92 	} else {
93 		/* Signature not found - assume u-boot.bin */
94 		debug("mkimage signature not found - ih_magic = %x\n",
95 			header->ih_magic);
96 		spl_image.size = CONFIG_SYS_MONITOR_LEN;
97 		spl_image.entry_point = CONFIG_SYS_UBOOT_START;
98 		spl_image.load_addr = CONFIG_SYS_TEXT_BASE;
99 		spl_image.os = IH_OS_U_BOOT;
100 		spl_image.name = "U-Boot";
101 	}
102 }
103 
104 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
105 {
106 	typedef void __noreturn (*image_entry_noargs_t)(void);
107 
108 	image_entry_noargs_t image_entry =
109 			(image_entry_noargs_t) spl_image->entry_point;
110 
111 	debug("image entry point: 0x%X\n", spl_image->entry_point);
112 	image_entry();
113 }
114 
115 #ifdef CONFIG_SPL_RAM_DEVICE
116 static void spl_ram_load_image(void)
117 {
118 	const struct image_header *header;
119 
120 	/*
121 	 * Get the header.  It will point to an address defined by handoff
122 	 * which will tell where the image located inside the flash. For
123 	 * now, it will temporary fixed to address pointed by U-Boot.
124 	 */
125 	header = (struct image_header *)
126 		(CONFIG_SYS_TEXT_BASE -	sizeof(struct image_header));
127 
128 	spl_parse_image_header(header);
129 }
130 #endif
131 
132 void board_init_r(gd_t *dummy1, ulong dummy2)
133 {
134 	u32 boot_device;
135 	debug(">>spl:board_init_r()\n");
136 
137 #ifdef CONFIG_SYS_SPL_MALLOC_START
138 	mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
139 			CONFIG_SYS_SPL_MALLOC_SIZE);
140 #endif
141 
142 #ifndef CONFIG_PPC
143 	/*
144 	 * timer_init() does not exist on PPC systems. The timer is initialized
145 	 * and enabled (decrementer) in interrupt_init() here.
146 	 */
147 	timer_init();
148 #endif
149 
150 #ifdef CONFIG_SPL_BOARD_INIT
151 	spl_board_init();
152 #endif
153 
154 	boot_device = spl_boot_device();
155 	debug("boot device - %d\n", boot_device);
156 	switch (boot_device) {
157 #ifdef CONFIG_SPL_RAM_DEVICE
158 	case BOOT_DEVICE_RAM:
159 		spl_ram_load_image();
160 		break;
161 #endif
162 #ifdef CONFIG_SPL_MMC_SUPPORT
163 	case BOOT_DEVICE_MMC1:
164 	case BOOT_DEVICE_MMC2:
165 	case BOOT_DEVICE_MMC2_2:
166 		spl_mmc_load_image();
167 		break;
168 #endif
169 #ifdef CONFIG_SPL_NAND_SUPPORT
170 	case BOOT_DEVICE_NAND:
171 		spl_nand_load_image();
172 		break;
173 #endif
174 #ifdef CONFIG_SPL_ONENAND_SUPPORT
175 	case BOOT_DEVICE_ONENAND:
176 		spl_onenand_load_image();
177 		break;
178 #endif
179 #ifdef CONFIG_SPL_NOR_SUPPORT
180 	case BOOT_DEVICE_NOR:
181 		spl_nor_load_image();
182 		break;
183 #endif
184 #ifdef CONFIG_SPL_YMODEM_SUPPORT
185 	case BOOT_DEVICE_UART:
186 		spl_ymodem_load_image();
187 		break;
188 #endif
189 #ifdef CONFIG_SPL_SPI_SUPPORT
190 	case BOOT_DEVICE_SPI:
191 		spl_spi_load_image();
192 		break;
193 #endif
194 #ifdef CONFIG_SPL_ETH_SUPPORT
195 	case BOOT_DEVICE_CPGMAC:
196 #ifdef CONFIG_SPL_ETH_DEVICE
197 		spl_net_load_image(CONFIG_SPL_ETH_DEVICE);
198 #else
199 		spl_net_load_image(NULL);
200 #endif
201 		break;
202 #endif
203 #ifdef CONFIG_SPL_USBETH_SUPPORT
204 	case BOOT_DEVICE_USBETH:
205 		spl_net_load_image("usb_ether");
206 		break;
207 #endif
208 #ifdef CONFIG_SPL_USB_SUPPORT
209 	case BOOT_DEVICE_USB:
210 		spl_usb_load_image();
211 		break;
212 #endif
213 #ifdef CONFIG_SPL_SATA_SUPPORT
214 	case BOOT_DEVICE_SATA:
215 		spl_sata_load_image();
216 		break;
217 #endif
218 	default:
219 		debug("SPL: Un-supported Boot Device\n");
220 		hang();
221 	}
222 
223 	switch (spl_image.os) {
224 	case IH_OS_U_BOOT:
225 		debug("Jumping to U-Boot\n");
226 		break;
227 #ifdef CONFIG_SPL_OS_BOOT
228 	case IH_OS_LINUX:
229 		debug("Jumping to Linux\n");
230 		spl_board_prepare_for_linux();
231 		jump_to_image_linux((void *)CONFIG_SYS_SPL_ARGS_ADDR);
232 #endif
233 	default:
234 		debug("Unsupported OS image.. Jumping nevertheless..\n");
235 	}
236 	jump_to_image_no_args(&spl_image);
237 }
238 
239 /*
240  * This requires UART clocks to be enabled.  In order for this to work the
241  * caller must ensure that the gd pointer is valid.
242  */
243 void preloader_console_init(void)
244 {
245 	gd->bd = &bdata;
246 	gd->baudrate = CONFIG_BAUDRATE;
247 
248 	serial_init();		/* serial communications setup */
249 
250 	gd->have_console = 1;
251 
252 	puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
253 			U_BOOT_TIME ")\n");
254 #ifdef CONFIG_SPL_DISPLAY_PRINT
255 	spl_display_print();
256 #endif
257 }
258