xref: /openbmc/u-boot/common/spl/spl.c (revision 27e780f1)
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 		/* Signature not found - assume u-boot.bin */
105 		debug("mkimage signature not found - ih_magic = %x\n",
106 			header->ih_magic);
107 		spl_set_header_raw_uboot();
108 	}
109 }
110 
111 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
112 {
113 	typedef void __noreturn (*image_entry_noargs_t)(void);
114 
115 	image_entry_noargs_t image_entry =
116 			(image_entry_noargs_t) spl_image->entry_point;
117 
118 	debug("image entry point: 0x%X\n", spl_image->entry_point);
119 	image_entry();
120 }
121 
122 #ifdef CONFIG_SPL_RAM_DEVICE
123 static void spl_ram_load_image(void)
124 {
125 	const struct image_header *header;
126 
127 	/*
128 	 * Get the header.  It will point to an address defined by handoff
129 	 * which will tell where the image located inside the flash. For
130 	 * now, it will temporary fixed to address pointed by U-Boot.
131 	 */
132 	header = (struct image_header *)
133 		(CONFIG_SYS_TEXT_BASE -	sizeof(struct image_header));
134 
135 	spl_parse_image_header(header);
136 }
137 #endif
138 
139 void board_init_r(gd_t *dummy1, ulong dummy2)
140 {
141 	u32 boot_device;
142 	debug(">>spl:board_init_r()\n");
143 
144 #if defined(CONFIG_SYS_SPL_MALLOC_START)
145 	mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
146 			CONFIG_SYS_SPL_MALLOC_SIZE);
147 	gd->flags |= GD_FLG_FULL_MALLOC_INIT;
148 #elif defined(CONFIG_SYS_MALLOC_F_LEN)
149 	gd->malloc_limit = gd->malloc_base + CONFIG_SYS_MALLOC_F_LEN;
150 	gd->malloc_ptr = 0;
151 #endif
152 #ifdef CONFIG_SPL_DM
153 	dm_init_and_scan(true);
154 #endif
155 
156 #ifndef CONFIG_PPC
157 	/*
158 	 * timer_init() does not exist on PPC systems. The timer is initialized
159 	 * and enabled (decrementer) in interrupt_init() here.
160 	 */
161 	timer_init();
162 #endif
163 
164 #ifdef CONFIG_SPL_BOARD_INIT
165 	spl_board_init();
166 #endif
167 
168 	boot_device = spl_boot_device();
169 	debug("boot device - %d\n", boot_device);
170 	switch (boot_device) {
171 #ifdef CONFIG_SPL_RAM_DEVICE
172 	case BOOT_DEVICE_RAM:
173 		spl_ram_load_image();
174 		break;
175 #endif
176 #ifdef CONFIG_SPL_MMC_SUPPORT
177 	case BOOT_DEVICE_MMC1:
178 	case BOOT_DEVICE_MMC2:
179 	case BOOT_DEVICE_MMC2_2:
180 		spl_mmc_load_image();
181 		break;
182 #endif
183 #ifdef CONFIG_SPL_NAND_SUPPORT
184 	case BOOT_DEVICE_NAND:
185 		spl_nand_load_image();
186 		break;
187 #endif
188 #ifdef CONFIG_SPL_ONENAND_SUPPORT
189 	case BOOT_DEVICE_ONENAND:
190 		spl_onenand_load_image();
191 		break;
192 #endif
193 #ifdef CONFIG_SPL_NOR_SUPPORT
194 	case BOOT_DEVICE_NOR:
195 		spl_nor_load_image();
196 		break;
197 #endif
198 #ifdef CONFIG_SPL_YMODEM_SUPPORT
199 	case BOOT_DEVICE_UART:
200 		spl_ymodem_load_image();
201 		break;
202 #endif
203 #ifdef CONFIG_SPL_SPI_SUPPORT
204 	case BOOT_DEVICE_SPI:
205 		spl_spi_load_image();
206 		break;
207 #endif
208 #ifdef CONFIG_SPL_ETH_SUPPORT
209 	case BOOT_DEVICE_CPGMAC:
210 #ifdef CONFIG_SPL_ETH_DEVICE
211 		spl_net_load_image(CONFIG_SPL_ETH_DEVICE);
212 #else
213 		spl_net_load_image(NULL);
214 #endif
215 		break;
216 #endif
217 #ifdef CONFIG_SPL_USBETH_SUPPORT
218 	case BOOT_DEVICE_USBETH:
219 		spl_net_load_image("usb_ether");
220 		break;
221 #endif
222 #ifdef CONFIG_SPL_USB_SUPPORT
223 	case BOOT_DEVICE_USB:
224 		spl_usb_load_image();
225 		break;
226 #endif
227 #ifdef CONFIG_SPL_SATA_SUPPORT
228 	case BOOT_DEVICE_SATA:
229 		spl_sata_load_image();
230 		break;
231 #endif
232 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
233 	case BOOT_DEVICE_BOARD:
234 		spl_board_load_image();
235 		break;
236 #endif
237 	default:
238 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
239 		puts("SPL: Unsupported Boot Device!\n");
240 #endif
241 		hang();
242 	}
243 
244 	switch (spl_image.os) {
245 	case IH_OS_U_BOOT:
246 		debug("Jumping to U-Boot\n");
247 		break;
248 #ifdef CONFIG_SPL_OS_BOOT
249 	case IH_OS_LINUX:
250 		debug("Jumping to Linux\n");
251 		spl_board_prepare_for_linux();
252 		jump_to_image_linux((void *)CONFIG_SYS_SPL_ARGS_ADDR);
253 #endif
254 	default:
255 		debug("Unsupported OS image.. Jumping nevertheless..\n");
256 	}
257 #if defined(CONFIG_SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
258 	debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr,
259 	      gd->malloc_ptr / 1024);
260 #endif
261 
262 	jump_to_image_no_args(&spl_image);
263 }
264 
265 /*
266  * This requires UART clocks to be enabled.  In order for this to work the
267  * caller must ensure that the gd pointer is valid.
268  */
269 void preloader_console_init(void)
270 {
271 	gd->bd = &bdata;
272 	gd->baudrate = CONFIG_BAUDRATE;
273 
274 	serial_init();		/* serial communications setup */
275 
276 	gd->have_console = 1;
277 
278 	puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
279 			U_BOOT_TIME ")\n");
280 #ifdef CONFIG_SPL_DISPLAY_PRINT
281 	spl_display_print();
282 #endif
283 }
284