]> git.kernelconcepts.de Git - karo-tx-uboot.git/blob - common/spl/spl.c
arm: socfpga: misc: Probe ethernet GMAC from OF
[karo-tx-uboot.git] / common / spl / spl.c
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 int spl_init(void)
152 {
153         int ret;
154
155         debug("spl_init()\n");
156 #if defined(CONFIG_SYS_MALLOC_F_LEN)
157         gd->malloc_limit = CONFIG_SYS_MALLOC_F_LEN;
158         gd->malloc_ptr = 0;
159 #endif
160         if (IS_ENABLED(CONFIG_OF_CONTROL) &&
161                         !IS_ENABLED(CONFIG_SPL_DISABLE_OF_CONTROL)) {
162                 ret = fdtdec_setup();
163                 if (ret) {
164                         debug("fdtdec_setup() returned error %d\n", ret);
165                         return ret;
166                 }
167         }
168         if (IS_ENABLED(CONFIG_SPL_DM)) {
169                 ret = dm_init_and_scan(true);
170                 if (ret) {
171                         debug("dm_init_and_scan() returned error %d\n", ret);
172                         return ret;
173                 }
174         }
175         gd->flags |= GD_FLG_SPL_INIT;
176
177         return 0;
178 }
179
180 void board_init_r(gd_t *dummy1, ulong dummy2)
181 {
182         u32 boot_device;
183
184         debug(">>spl:board_init_r()\n");
185
186 #if defined(CONFIG_SYS_SPL_MALLOC_START)
187         mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
188                         CONFIG_SYS_SPL_MALLOC_SIZE);
189         gd->flags |= GD_FLG_FULL_MALLOC_INIT;
190 #endif
191         if (!(gd->flags & GD_FLG_SPL_INIT)) {
192                 if (spl_init())
193                         hang();
194         }
195 #ifndef CONFIG_PPC
196         /*
197          * timer_init() does not exist on PPC systems. The timer is initialized
198          * and enabled (decrementer) in interrupt_init() here.
199          */
200         timer_init();
201 #endif
202
203 #ifdef CONFIG_SPL_BOARD_INIT
204         spl_board_init();
205 #endif
206
207         boot_device = spl_boot_device();
208         debug("boot device - %d\n", boot_device);
209         switch (boot_device) {
210 #ifdef CONFIG_SPL_RAM_DEVICE
211         case BOOT_DEVICE_RAM:
212                 spl_ram_load_image();
213                 break;
214 #endif
215 #ifdef CONFIG_SPL_MMC_SUPPORT
216         case BOOT_DEVICE_MMC1:
217         case BOOT_DEVICE_MMC2:
218         case BOOT_DEVICE_MMC2_2:
219                 spl_mmc_load_image();
220                 break;
221 #endif
222 #ifdef CONFIG_SPL_NAND_SUPPORT
223         case BOOT_DEVICE_NAND:
224                 if (spl_nand_load_image() == 0)
225                         break;
226                 /* fallthru in case of failure to activate ymodem download */
227 #endif
228 #ifdef CONFIG_SPL_ONENAND_SUPPORT
229         case BOOT_DEVICE_ONENAND:
230                 spl_onenand_load_image();
231                 break;
232 #endif
233 #ifdef CONFIG_SPL_NOR_SUPPORT
234         case BOOT_DEVICE_NOR:
235                 spl_nor_load_image();
236                 break;
237 #endif
238 #ifdef CONFIG_SPL_YMODEM_SUPPORT
239         case BOOT_DEVICE_UART:
240                 spl_ymodem_load_image();
241                 break;
242 #endif
243 #ifdef CONFIG_SPL_SPI_SUPPORT
244         case BOOT_DEVICE_SPI:
245                 spl_spi_load_image();
246                 break;
247 #endif
248 #ifdef CONFIG_SPL_ETH_SUPPORT
249         case BOOT_DEVICE_CPGMAC:
250 #ifdef CONFIG_SPL_ETH_DEVICE
251                 spl_net_load_image(CONFIG_SPL_ETH_DEVICE);
252 #else
253                 spl_net_load_image(NULL);
254 #endif
255                 break;
256 #endif
257 #ifdef CONFIG_SPL_USBETH_SUPPORT
258         case BOOT_DEVICE_USBETH:
259                 spl_net_load_image("usb_ether");
260                 break;
261 #endif
262 #ifdef CONFIG_SPL_USB_SUPPORT
263         case BOOT_DEVICE_USB:
264                 spl_usb_load_image();
265                 break;
266 #endif
267 #ifdef CONFIG_SPL_SATA_SUPPORT
268         case BOOT_DEVICE_SATA:
269                 spl_sata_load_image();
270                 break;
271 #endif
272 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
273         case BOOT_DEVICE_BOARD:
274                 spl_board_load_image();
275                 break;
276 #endif
277         default:
278 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
279                 puts("SPL: Unsupported Boot Device!\n");
280 #endif
281                 hang();
282         }
283
284         switch (spl_image.os) {
285         case IH_OS_U_BOOT:
286                 debug("Jumping to U-Boot\n");
287                 break;
288 #ifdef CONFIG_SPL_OS_BOOT
289         case IH_OS_LINUX:
290                 debug("Jumping to Linux\n");
291                 spl_board_prepare_for_linux();
292                 jump_to_image_linux((void *)CONFIG_SYS_SPL_ARGS_ADDR);
293 #endif
294         default:
295                 debug("Unsupported OS image.. Jumping nevertheless..\n");
296         }
297 #if defined(CONFIG_SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
298         debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr,
299               gd->malloc_ptr / 1024);
300 #endif
301
302         debug("loaded - jumping to U-Boot...");
303         jump_to_image_no_args(&spl_image);
304 }
305
306 /*
307  * This requires UART clocks to be enabled.  In order for this to work the
308  * caller must ensure that the gd pointer is valid.
309  */
310 void preloader_console_init(void)
311 {
312         gd->bd = &bdata;
313         gd->baudrate = CONFIG_BAUDRATE;
314
315         serial_init();          /* serial communications setup */
316
317         gd->have_console = 1;
318
319         puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
320                         U_BOOT_TIME ")\n");
321 #ifdef CONFIG_SPL_DISPLAY_PRINT
322         spl_display_print();
323 #endif
324 }
325
326 /**
327  * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
328  *
329  * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
330  * for the main board_init_r() execution. This is typically because we need
331  * more stack space for things like the MMC sub-system.
332  *
333  * This function calculates the stack position, copies the global_data into
334  * place and returns the new stack position. The caller is responsible for
335  * setting up the sp register.
336  *
337  * @return new stack location, or 0 to use the same stack
338  */
339 ulong spl_relocate_stack_gd(void)
340 {
341 #ifdef CONFIG_SPL_STACK_R
342         gd_t *new_gd;
343         ulong ptr;
344
345         /* Get stack position: use 8-byte alignment for ABI compliance */
346         ptr = CONFIG_SPL_STACK_R_ADDR - sizeof(gd_t);
347         ptr &= ~7;
348         new_gd = (gd_t *)ptr;
349         memcpy(new_gd, (void *)gd, sizeof(gd_t));
350         gd = new_gd;
351
352         /* Clear the BSS. */
353         memset(__bss_start, 0, __bss_end - __bss_start);
354
355         return ptr;
356 #else
357         return 0;
358 #endif
359 }