Use correct spelling of "U-Boot"
[platform/kernel/u-boot.git] / arch / x86 / lib / bootm.c
1 /*
2  * (C) Copyright 2002
3  * Sysgo Real-Time Solutions, GmbH <www.elinos.com>
4  * Marius Groeger <mgroeger@sysgo.de>
5  *
6  * Copyright (C) 2001  Erik Mouw (J.A.K.Mouw@its.tudelft.nl)
7  *
8  * SPDX-License-Identifier:     GPL-2.0+
9  */
10
11 #include <common.h>
12 #include <command.h>
13 #include <errno.h>
14 #include <fdt_support.h>
15 #include <image.h>
16 #include <u-boot/zlib.h>
17 #include <asm/bootparam.h>
18 #include <asm/cpu.h>
19 #include <asm/byteorder.h>
20 #include <asm/zimage.h>
21 #ifdef CONFIG_SYS_COREBOOT
22 #include <asm/arch/timestamp.h>
23 #endif
24
25 DECLARE_GLOBAL_DATA_PTR;
26
27 #define COMMAND_LINE_OFFSET 0x9000
28
29 /*
30  * Implement a weak default function for boards that optionally
31  * need to clean up the system before jumping to the kernel.
32  */
33 __weak void board_final_cleanup(void)
34 {
35 }
36
37 void bootm_announce_and_cleanup(void)
38 {
39         printf("\nStarting kernel ...\n\n");
40
41 #ifdef CONFIG_SYS_COREBOOT
42         timestamp_add_now(TS_U_BOOT_START_KERNEL);
43 #endif
44         bootstage_mark_name(BOOTSTAGE_ID_BOOTM_HANDOFF, "start_kernel");
45 #ifdef CONFIG_BOOTSTAGE_REPORT
46         bootstage_report();
47 #endif
48         board_final_cleanup();
49 }
50
51 #if defined(CONFIG_OF_LIBFDT) && !defined(CONFIG_OF_NO_KERNEL)
52 int arch_fixup_memory_node(void *blob)
53 {
54         bd_t    *bd = gd->bd;
55         int bank;
56         u64 start[CONFIG_NR_DRAM_BANKS];
57         u64 size[CONFIG_NR_DRAM_BANKS];
58
59         for (bank = 0; bank < CONFIG_NR_DRAM_BANKS; bank++) {
60                 start[bank] = bd->bi_dram[bank].start;
61                 size[bank] = bd->bi_dram[bank].size;
62         }
63
64         return fdt_fixup_memory_banks(blob, start, size, CONFIG_NR_DRAM_BANKS);
65 }
66 #endif
67
68 /* Subcommand: PREP */
69 static int boot_prep_linux(bootm_headers_t *images)
70 {
71         char *cmd_line_dest = NULL;
72         image_header_t *hdr;
73         int is_zimage = 0;
74         void *data = NULL;
75         size_t len;
76         int ret;
77
78 #ifdef CONFIG_OF_LIBFDT
79         if (images->ft_len) {
80                 debug("using: FDT\n");
81                 if (image_setup_linux(images)) {
82                         puts("FDT creation failed! hanging...");
83                         hang();
84                 }
85         }
86 #endif
87         if (images->legacy_hdr_valid) {
88                 hdr = images->legacy_hdr_os;
89                 if (image_check_type(hdr, IH_TYPE_MULTI)) {
90                         ulong os_data, os_len;
91
92                         /* if multi-part image, we need to get first subimage */
93                         image_multi_getimg(hdr, 0, &os_data, &os_len);
94                         data = (void *)os_data;
95                         len = os_len;
96                 } else {
97                         /* otherwise get image data */
98                         data = (void *)image_get_data(hdr);
99                         len = image_get_data_size(hdr);
100                 }
101                 is_zimage = 1;
102 #if defined(CONFIG_FIT)
103         } else if (images->fit_uname_os && is_zimage) {
104                 ret = fit_image_get_data(images->fit_hdr_os,
105                                 images->fit_noffset_os,
106                                 (const void **)&data, &len);
107                 if (ret) {
108                         puts("Can't get image data/size!\n");
109                         goto error;
110                 }
111                 is_zimage = 1;
112 #endif
113         }
114
115         if (is_zimage) {
116                 ulong load_address;
117                 char *base_ptr;
118
119                 base_ptr = (char *)load_zimage(data, len, &load_address);
120                 images->os.load = load_address;
121                 cmd_line_dest = base_ptr + COMMAND_LINE_OFFSET;
122                 images->ep = (ulong)base_ptr;
123         } else if (images->ep) {
124                 cmd_line_dest = (void *)images->ep + COMMAND_LINE_OFFSET;
125         } else {
126                 printf("## Kernel loading failed (missing x86 kernel setup) ...\n");
127                 goto error;
128         }
129
130         printf("Setup at %#08lx\n", images->ep);
131         ret = setup_zimage((void *)images->ep, cmd_line_dest,
132                         0, images->rd_start,
133                         images->rd_end - images->rd_start);
134
135         if (ret) {
136                 printf("## Setting up boot parameters failed ...\n");
137                 return 1;
138         }
139
140         return 0;
141
142 error:
143         return 1;
144 }
145
146 int boot_linux_kernel(ulong setup_base, ulong load_address, bool image_64bit)
147 {
148         bootm_announce_and_cleanup();
149
150 #ifdef CONFIG_SYS_COREBOOT
151         timestamp_add_now(TS_U_BOOT_START_KERNEL);
152 #endif
153         if (image_64bit) {
154                 if (!cpu_has_64bit()) {
155                         puts("Cannot boot 64-bit kernel on 32-bit machine\n");
156                         return -EFAULT;
157                 }
158                 return cpu_jump_to_64bit(setup_base, load_address);
159         } else {
160                 /*
161                 * Set %ebx, %ebp, and %edi to 0, %esi to point to the
162                 * boot_params structure, and then jump to the kernel. We
163                 * assume that %cs is 0x10, 4GB flat, and read/execute, and
164                 * the data segments are 0x18, 4GB flat, and read/write.
165                 * U-Boot is setting them up that way for itself in
166                 * arch/i386/cpu/cpu.c.
167                 *
168                 * Note that we cannot currently boot a kernel while running as
169                 * an EFI application. Please use the payload option for that.
170                 */
171 #ifndef CONFIG_EFI_APP
172                 __asm__ __volatile__ (
173                 "movl $0, %%ebp\n"
174                 "cli\n"
175                 "jmp *%[kernel_entry]\n"
176                 :: [kernel_entry]"a"(load_address),
177                 [boot_params] "S"(setup_base),
178                 "b"(0), "D"(0)
179                 );
180 #endif
181         }
182
183         /* We can't get to here */
184         return -EFAULT;
185 }
186
187 /* Subcommand: GO */
188 static int boot_jump_linux(bootm_headers_t *images)
189 {
190         debug("## Transferring control to Linux (at address %08lx, kernel %08lx) ...\n",
191               images->ep, images->os.load);
192
193         return boot_linux_kernel(images->ep, images->os.load,
194                                  images->os.arch == IH_ARCH_X86_64);
195 }
196
197 int do_bootm_linux(int flag, int argc, char * const argv[],
198                 bootm_headers_t *images)
199 {
200         /* No need for those on x86 */
201         if (flag & BOOTM_STATE_OS_BD_T || flag & BOOTM_STATE_OS_CMDLINE)
202                 return -1;
203
204         if (flag & BOOTM_STATE_OS_PREP)
205                 return boot_prep_linux(images);
206
207         if (flag & BOOTM_STATE_OS_GO)
208                 return boot_jump_linux(images);
209
210         return boot_jump_linux(images);
211 }