xref: /openbmc/u-boot/common/spl/spl.c (revision 60570df1)
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 <dm.h>
11 #include <spl.h>
12 #include <asm/u-boot.h>
13 #include <nand.h>
14 #include <fat.h>
15 #include <version.h>
16 #include <i2c.h>
17 #include <image.h>
18 #include <malloc.h>
19 #include <dm/root.h>
20 #include <linux/compiler.h>
21 
22 DECLARE_GLOBAL_DATA_PTR;
23 
24 #ifndef CONFIG_SYS_UBOOT_START
25 #define CONFIG_SYS_UBOOT_START	CONFIG_SYS_TEXT_BASE
26 #endif
27 #ifndef CONFIG_SYS_MONITOR_LEN
28 /* Unknown U-Boot size, let's assume it will not be more than 200 KB */
29 #define CONFIG_SYS_MONITOR_LEN	(200 * 1024)
30 #endif
31 
32 u32 *boot_params_ptr = NULL;
33 struct spl_image_info spl_image;
34 
35 /* Define board data structure */
36 static bd_t bdata __attribute__ ((section(".data")));
37 
38 /*
39  * Default function to determine if u-boot or the OS should
40  * be started. This implementation always returns 1.
41  *
42  * Please implement your own board specific funcion to do this.
43  *
44  * RETURN
45  * 0 to not start u-boot
46  * positive if u-boot should start
47  */
48 #ifdef CONFIG_SPL_OS_BOOT
49 __weak int spl_start_uboot(void)
50 {
51 	puts("SPL: Please implement spl_start_uboot() for your board\n");
52 	puts("SPL: Direct Linux boot not active!\n");
53 	return 1;
54 }
55 #endif
56 
57 /*
58  * Weak default function for board specific cleanup/preparation before
59  * Linux boot. Some boards/platforms might not need it, so just provide
60  * an empty stub here.
61  */
62 __weak void spl_board_prepare_for_linux(void)
63 {
64 	/* Nothing to do! */
65 }
66 
67 void spl_set_header_raw_uboot(void)
68 {
69 	spl_image.size = CONFIG_SYS_MONITOR_LEN;
70 	spl_image.entry_point = CONFIG_SYS_UBOOT_START;
71 	spl_image.load_addr = CONFIG_SYS_TEXT_BASE;
72 	spl_image.os = IH_OS_U_BOOT;
73 	spl_image.name = "U-Boot";
74 }
75 
76 void spl_parse_image_header(const struct image_header *header)
77 {
78 	u32 header_size = sizeof(struct image_header);
79 
80 	if (image_get_magic(header) == IH_MAGIC) {
81 		if (spl_image.flags & SPL_COPY_PAYLOAD_ONLY) {
82 			/*
83 			 * On some system (e.g. powerpc), the load-address and
84 			 * entry-point is located at address 0. We can't load
85 			 * to 0-0x40. So skip header in this case.
86 			 */
87 			spl_image.load_addr = image_get_load(header);
88 			spl_image.entry_point = image_get_ep(header);
89 			spl_image.size = image_get_data_size(header);
90 		} else {
91 			spl_image.entry_point = image_get_load(header);
92 			/* Load including the header */
93 			spl_image.load_addr = spl_image.entry_point -
94 				header_size;
95 			spl_image.size = image_get_data_size(header) +
96 				header_size;
97 		}
98 		spl_image.os = image_get_os(header);
99 		spl_image.name = image_get_name(header);
100 		debug("spl: payload image: %.*s load addr: 0x%x size: %d\n",
101 			(int)sizeof(spl_image.name), spl_image.name,
102 			spl_image.load_addr, spl_image.size);
103 	} else {
104 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
105 		/*
106 		 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
107 		 * code which loads images in SPL cannot guarantee that
108 		 * absolutely all read errors will be reported.
109 		 * An example is the LPC32XX MLC NAND driver, which
110 		 * will consider that a completely unreadable NAND block
111 		 * is bad, and thus should be skipped silently.
112 		 */
113 		panic("** no mkimage signature but raw image not supported");
114 #else
115 		/* Signature not found - assume u-boot.bin */
116 		debug("mkimage signature not found - ih_magic = %x\n",
117 			header->ih_magic);
118 		spl_set_header_raw_uboot();
119 #endif
120 	}
121 }
122 
123 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
124 {
125 	typedef void __noreturn (*image_entry_noargs_t)(void);
126 
127 	image_entry_noargs_t image_entry =
128 		(image_entry_noargs_t)(unsigned long)spl_image->entry_point;
129 
130 	debug("image entry point: 0x%X\n", spl_image->entry_point);
131 	image_entry();
132 }
133 
134 #ifdef CONFIG_SPL_RAM_DEVICE
135 static void spl_ram_load_image(void)
136 {
137 	const struct image_header *header;
138 
139 	/*
140 	 * Get the header.  It will point to an address defined by handoff
141 	 * which will tell where the image located inside the flash. For
142 	 * now, it will temporary fixed to address pointed by U-Boot.
143 	 */
144 	header = (struct image_header *)
145 		(CONFIG_SYS_TEXT_BASE -	sizeof(struct image_header));
146 
147 	spl_parse_image_header(header);
148 }
149 #endif
150 
151 void board_init_r(gd_t *dummy1, ulong dummy2)
152 {
153 	u32 boot_device;
154 	int ret;
155 
156 	debug(">>spl:board_init_r()\n");
157 
158 #if defined(CONFIG_SYS_SPL_MALLOC_START)
159 	mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
160 			CONFIG_SYS_SPL_MALLOC_SIZE);
161 	gd->flags |= GD_FLG_FULL_MALLOC_INIT;
162 #elif defined(CONFIG_SYS_MALLOC_F_LEN)
163 	gd->malloc_limit = CONFIG_SYS_MALLOC_F_LEN;
164 	gd->malloc_ptr = 0;
165 #endif
166 	if (IS_ENABLED(CONFIG_OF_CONTROL) &&
167 			!IS_ENABLED(CONFIG_SPL_DISABLE_OF_CONTROL)) {
168 		ret = fdtdec_setup();
169 		if (ret) {
170 			debug("fdtdec_setup() returned error %d\n", ret);
171 			hang();
172 		}
173 	}
174 	if (IS_ENABLED(CONFIG_SPL_DM)) {
175 		ret = dm_init_and_scan(true);
176 		if (ret) {
177 			debug("dm_init_and_scan() returned error %d\n", ret);
178 			hang();
179 		}
180 	}
181 
182 #ifndef CONFIG_PPC
183 	/*
184 	 * timer_init() does not exist on PPC systems. The timer is initialized
185 	 * and enabled (decrementer) in interrupt_init() here.
186 	 */
187 	timer_init();
188 #endif
189 
190 #ifdef CONFIG_SPL_BOARD_INIT
191 	spl_board_init();
192 #endif
193 
194 	boot_device = spl_boot_device();
195 	debug("boot device - %d\n", boot_device);
196 	switch (boot_device) {
197 #ifdef CONFIG_SPL_RAM_DEVICE
198 	case BOOT_DEVICE_RAM:
199 		spl_ram_load_image();
200 		break;
201 #endif
202 #ifdef CONFIG_SPL_MMC_SUPPORT
203 	case BOOT_DEVICE_MMC1:
204 	case BOOT_DEVICE_MMC2:
205 	case BOOT_DEVICE_MMC2_2:
206 		spl_mmc_load_image();
207 		break;
208 #endif
209 #ifdef CONFIG_SPL_NAND_SUPPORT
210 	case BOOT_DEVICE_NAND:
211 		spl_nand_load_image();
212 		break;
213 #endif
214 #ifdef CONFIG_SPL_ONENAND_SUPPORT
215 	case BOOT_DEVICE_ONENAND:
216 		spl_onenand_load_image();
217 		break;
218 #endif
219 #ifdef CONFIG_SPL_NOR_SUPPORT
220 	case BOOT_DEVICE_NOR:
221 		spl_nor_load_image();
222 		break;
223 #endif
224 #ifdef CONFIG_SPL_YMODEM_SUPPORT
225 	case BOOT_DEVICE_UART:
226 		spl_ymodem_load_image();
227 		break;
228 #endif
229 #ifdef CONFIG_SPL_SPI_SUPPORT
230 	case BOOT_DEVICE_SPI:
231 		spl_spi_load_image();
232 		break;
233 #endif
234 #ifdef CONFIG_SPL_ETH_SUPPORT
235 	case BOOT_DEVICE_CPGMAC:
236 #ifdef CONFIG_SPL_ETH_DEVICE
237 		spl_net_load_image(CONFIG_SPL_ETH_DEVICE);
238 #else
239 		spl_net_load_image(NULL);
240 #endif
241 		break;
242 #endif
243 #ifdef CONFIG_SPL_USBETH_SUPPORT
244 	case BOOT_DEVICE_USBETH:
245 		spl_net_load_image("usb_ether");
246 		break;
247 #endif
248 #ifdef CONFIG_SPL_USB_SUPPORT
249 	case BOOT_DEVICE_USB:
250 		spl_usb_load_image();
251 		break;
252 #endif
253 #ifdef CONFIG_SPL_SATA_SUPPORT
254 	case BOOT_DEVICE_SATA:
255 		spl_sata_load_image();
256 		break;
257 #endif
258 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
259 	case BOOT_DEVICE_BOARD:
260 		spl_board_load_image();
261 		break;
262 #endif
263 	default:
264 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
265 		puts("SPL: Unsupported Boot Device!\n");
266 #endif
267 		hang();
268 	}
269 
270 	switch (spl_image.os) {
271 	case IH_OS_U_BOOT:
272 		debug("Jumping to U-Boot\n");
273 		break;
274 #ifdef CONFIG_SPL_OS_BOOT
275 	case IH_OS_LINUX:
276 		debug("Jumping to Linux\n");
277 		spl_board_prepare_for_linux();
278 		jump_to_image_linux((void *)CONFIG_SYS_SPL_ARGS_ADDR);
279 #endif
280 	default:
281 		debug("Unsupported OS image.. Jumping nevertheless..\n");
282 	}
283 #if defined(CONFIG_SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
284 	debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr,
285 	      gd->malloc_ptr / 1024);
286 #endif
287 
288 	jump_to_image_no_args(&spl_image);
289 }
290 
291 /*
292  * This requires UART clocks to be enabled.  In order for this to work the
293  * caller must ensure that the gd pointer is valid.
294  */
295 void preloader_console_init(void)
296 {
297 	gd->bd = &bdata;
298 	gd->baudrate = CONFIG_BAUDRATE;
299 
300 	serial_init();		/* serial communications setup */
301 
302 	gd->have_console = 1;
303 
304 	puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
305 			U_BOOT_TIME ")\n");
306 #ifdef CONFIG_SPL_DISPLAY_PRINT
307 	spl_display_print();
308 #endif
309 }
310 
311 /**
312  * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
313  *
314  * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
315  * for the main board_init_r() execution. This is typically because we need
316  * more stack space for things like the MMC sub-system.
317  *
318  * This function calculates the stack position, copies the global_data into
319  * place and returns the new stack position. The caller is responsible for
320  * setting up the sp register.
321  *
322  * @return new stack location, or 0 to use the same stack
323  */
324 ulong spl_relocate_stack_gd(void)
325 {
326 #ifdef CONFIG_SPL_STACK_R
327 	gd_t *new_gd;
328 	ulong ptr;
329 
330 	/* Get stack position: use 8-byte alignment for ABI compliance */
331 	ptr = CONFIG_SPL_STACK_R - sizeof(gd_t);
332 	ptr &= ~7;
333 	new_gd = (gd_t *)ptr;
334 	memcpy(new_gd, (void *)gd, sizeof(gd_t));
335 	gd = new_gd;
336 
337 	/* Clear the BSS. */
338 	memset(__bss_start, 0, __bss_end - __bss_start);
339 
340 	return ptr;
341 #else
342 	return 0;
343 #endif
344 }
345