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