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