1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * Copyright (c) 2011 The Chromium OS Authors.
4 * (C) Copyright 2002
5 * Daniel Engström, Omicron Ceti AB, <daniel@omicron.se>
6 */
7
8 /*
9 * Linux x86 zImage and bzImage loading
10 *
11 * based on the procdure described in
12 * linux/Documentation/i386/boot.txt
13 */
14
15 #include <common.h>
16 #include <env.h>
17 #include <irq_func.h>
18 #include <malloc.h>
19 #include <asm/acpi_table.h>
20 #include <asm/io.h>
21 #include <asm/ptrace.h>
22 #include <asm/zimage.h>
23 #include <asm/byteorder.h>
24 #include <asm/bootm.h>
25 #include <asm/bootparam.h>
26 #ifdef CONFIG_SYS_COREBOOT
27 #include <asm/arch/timestamp.h>
28 #endif
29 #include <linux/compiler.h>
30 #include <linux/libfdt.h>
31
32 /*
33 * Memory lay-out:
34 *
35 * relative to setup_base (which is 0x90000 currently)
36 *
37 * 0x0000-0x7FFF Real mode kernel
38 * 0x8000-0x8FFF Stack and heap
39 * 0x9000-0x90FF Kernel command line
40 */
41 #define DEFAULT_SETUP_BASE 0x90000
42 #define COMMAND_LINE_OFFSET 0x9000
43 #define HEAP_END_OFFSET 0x8e00
44
45 #define COMMAND_LINE_SIZE 2048
46
build_command_line(char * command_line,int auto_boot)47 static void build_command_line(char *command_line, int auto_boot)
48 {
49 char *env_command_line;
50
51 command_line[0] = '\0';
52
53 env_command_line = env_get("bootargs");
54
55 /* set console= argument if we use a serial console */
56 if (!strstr(env_command_line, "console=")) {
57 if (!strcmp(env_get("stdout"), "serial")) {
58
59 /* We seem to use serial console */
60 sprintf(command_line, "console=ttyS0,%s ",
61 env_get("baudrate"));
62 }
63 }
64
65 if (auto_boot)
66 strcat(command_line, "auto ");
67
68 if (env_command_line)
69 strcat(command_line, env_command_line);
70
71 printf("Kernel command line: \"%s\"\n", command_line);
72 }
73
kernel_magic_ok(struct setup_header * hdr)74 static int kernel_magic_ok(struct setup_header *hdr)
75 {
76 if (KERNEL_MAGIC != hdr->boot_flag) {
77 printf("Error: Invalid Boot Flag "
78 "(found 0x%04x, expected 0x%04x)\n",
79 hdr->boot_flag, KERNEL_MAGIC);
80 return 0;
81 } else {
82 printf("Valid Boot Flag\n");
83 return 1;
84 }
85 }
86
get_boot_protocol(struct setup_header * hdr)87 static int get_boot_protocol(struct setup_header *hdr)
88 {
89 if (hdr->header == KERNEL_V2_MAGIC) {
90 printf("Magic signature found\n");
91 return hdr->version;
92 } else {
93 /* Very old kernel */
94 printf("Magic signature not found\n");
95 return 0x0100;
96 }
97 }
98
setup_device_tree(struct setup_header * hdr,const void * fdt_blob)99 static int setup_device_tree(struct setup_header *hdr, const void *fdt_blob)
100 {
101 int bootproto = get_boot_protocol(hdr);
102 struct setup_data *sd;
103 int size;
104
105 if (bootproto < 0x0209)
106 return -ENOTSUPP;
107
108 if (!fdt_blob)
109 return 0;
110
111 size = fdt_totalsize(fdt_blob);
112 if (size < 0)
113 return -EINVAL;
114
115 size += sizeof(struct setup_data);
116 sd = (struct setup_data *)malloc(size);
117 if (!sd) {
118 printf("Not enough memory for DTB setup data\n");
119 return -ENOMEM;
120 }
121
122 sd->next = hdr->setup_data;
123 sd->type = SETUP_DTB;
124 sd->len = fdt_totalsize(fdt_blob);
125 memcpy(sd->data, fdt_blob, sd->len);
126 hdr->setup_data = (unsigned long)sd;
127
128 return 0;
129 }
130
load_zimage(char * image,unsigned long kernel_size,ulong * load_addressp)131 struct boot_params *load_zimage(char *image, unsigned long kernel_size,
132 ulong *load_addressp)
133 {
134 struct boot_params *setup_base;
135 int setup_size;
136 int bootproto;
137 int big_image;
138
139 struct boot_params *params = (struct boot_params *)image;
140 struct setup_header *hdr = ¶ms->hdr;
141
142 /* base address for real-mode segment */
143 setup_base = (struct boot_params *)DEFAULT_SETUP_BASE;
144
145 if (!kernel_magic_ok(hdr))
146 return 0;
147
148 /* determine size of setup */
149 if (0 == hdr->setup_sects) {
150 printf("Setup Sectors = 0 (defaulting to 4)\n");
151 setup_size = 5 * 512;
152 } else {
153 setup_size = (hdr->setup_sects + 1) * 512;
154 }
155
156 printf("Setup Size = 0x%8.8lx\n", (ulong)setup_size);
157
158 if (setup_size > SETUP_MAX_SIZE)
159 printf("Error: Setup is too large (%d bytes)\n", setup_size);
160
161 /* determine boot protocol version */
162 bootproto = get_boot_protocol(hdr);
163
164 printf("Using boot protocol version %x.%02x\n",
165 (bootproto & 0xff00) >> 8, bootproto & 0xff);
166
167 if (bootproto >= 0x0200) {
168 if (hdr->setup_sects >= 15) {
169 printf("Linux kernel version %s\n",
170 (char *)params +
171 hdr->kernel_version + 0x200);
172 } else {
173 printf("Setup Sectors < 15 - "
174 "Cannot print kernel version.\n");
175 }
176 }
177
178 /* Determine image type */
179 big_image = (bootproto >= 0x0200) &&
180 (hdr->loadflags & BIG_KERNEL_FLAG);
181
182 /* Determine load address */
183 if (big_image)
184 *load_addressp = BZIMAGE_LOAD_ADDR;
185 else
186 *load_addressp = ZIMAGE_LOAD_ADDR;
187
188 printf("Building boot_params at 0x%8.8lx\n", (ulong)setup_base);
189 memset(setup_base, 0, sizeof(*setup_base));
190 setup_base->hdr = params->hdr;
191
192 if (bootproto >= 0x0204)
193 kernel_size = hdr->syssize * 16;
194 else
195 kernel_size -= setup_size;
196
197 if (bootproto == 0x0100) {
198 /*
199 * A very old kernel MUST have its real-mode code
200 * loaded at 0x90000
201 */
202 if ((ulong)setup_base != 0x90000) {
203 /* Copy the real-mode kernel */
204 memmove((void *)0x90000, setup_base, setup_size);
205
206 /* Copy the command line */
207 memmove((void *)0x99000,
208 (u8 *)setup_base + COMMAND_LINE_OFFSET,
209 COMMAND_LINE_SIZE);
210
211 /* Relocated */
212 setup_base = (struct boot_params *)0x90000;
213 }
214
215 /* It is recommended to clear memory up to the 32K mark */
216 memset((u8 *)0x90000 + setup_size, 0,
217 SETUP_MAX_SIZE - setup_size);
218 }
219
220 if (big_image) {
221 if (kernel_size > BZIMAGE_MAX_SIZE) {
222 printf("Error: bzImage kernel too big! "
223 "(size: %ld, max: %d)\n",
224 kernel_size, BZIMAGE_MAX_SIZE);
225 return 0;
226 }
227 } else if ((kernel_size) > ZIMAGE_MAX_SIZE) {
228 printf("Error: zImage kernel too big! (size: %ld, max: %d)\n",
229 kernel_size, ZIMAGE_MAX_SIZE);
230 return 0;
231 }
232
233 printf("Loading %s at address %lx (%ld bytes)\n",
234 big_image ? "bzImage" : "zImage", *load_addressp, kernel_size);
235
236 memmove((void *)*load_addressp, image + setup_size, kernel_size);
237
238 return setup_base;
239 }
240
setup_zimage(struct boot_params * setup_base,char * cmd_line,int auto_boot,unsigned long initrd_addr,unsigned long initrd_size)241 int setup_zimage(struct boot_params *setup_base, char *cmd_line, int auto_boot,
242 unsigned long initrd_addr, unsigned long initrd_size)
243 {
244 struct setup_header *hdr = &setup_base->hdr;
245 int bootproto = get_boot_protocol(hdr);
246
247 setup_base->e820_entries = install_e820_map(
248 ARRAY_SIZE(setup_base->e820_map), setup_base->e820_map);
249
250 if (bootproto == 0x0100) {
251 setup_base->screen_info.cl_magic = COMMAND_LINE_MAGIC;
252 setup_base->screen_info.cl_offset = COMMAND_LINE_OFFSET;
253 }
254 if (bootproto >= 0x0200) {
255 hdr->type_of_loader = 8;
256
257 if (initrd_addr) {
258 printf("Initial RAM disk at linear address "
259 "0x%08lx, size %ld bytes\n",
260 initrd_addr, initrd_size);
261
262 hdr->ramdisk_image = initrd_addr;
263 hdr->ramdisk_size = initrd_size;
264 }
265 }
266
267 if (bootproto >= 0x0201) {
268 hdr->heap_end_ptr = HEAP_END_OFFSET;
269 hdr->loadflags |= HEAP_FLAG;
270 }
271
272 if (cmd_line) {
273 if (bootproto >= 0x0202) {
274 hdr->cmd_line_ptr = (uintptr_t)cmd_line;
275 } else if (bootproto >= 0x0200) {
276 setup_base->screen_info.cl_magic = COMMAND_LINE_MAGIC;
277 setup_base->screen_info.cl_offset =
278 (uintptr_t)cmd_line - (uintptr_t)setup_base;
279
280 hdr->setup_move_size = 0x9100;
281 }
282
283 /* build command line at COMMAND_LINE_OFFSET */
284 build_command_line(cmd_line, auto_boot);
285 }
286
287 #ifdef CONFIG_INTEL_MID
288 if (bootproto >= 0x0207)
289 hdr->hardware_subarch = X86_SUBARCH_INTEL_MID;
290 #endif
291
292 #ifdef CONFIG_GENERATE_ACPI_TABLE
293 setup_base->acpi_rsdp_addr = acpi_get_rsdp_addr();
294 #endif
295
296 setup_device_tree(hdr, (const void *)env_get_hex("fdtaddr", 0));
297 setup_video(&setup_base->screen_info);
298
299 #ifdef CONFIG_EFI_STUB
300 setup_efi_info(&setup_base->efi_info);
301 #endif
302
303 return 0;
304 }
305
306 void setup_pcat_compatibility(void)
307 __attribute__((weak, alias("__setup_pcat_compatibility")));
308
__setup_pcat_compatibility(void)309 void __setup_pcat_compatibility(void)
310 {
311 }
312
do_zboot(cmd_tbl_t * cmdtp,int flag,int argc,char * const argv[])313 int do_zboot(cmd_tbl_t *cmdtp, int flag, int argc, char *const argv[])
314 {
315 struct boot_params *base_ptr;
316 void *bzImage_addr = NULL;
317 ulong load_address;
318 char *s;
319 ulong bzImage_size = 0;
320 ulong initrd_addr = 0;
321 ulong initrd_size = 0;
322
323 disable_interrupts();
324
325 /* Setup board for maximum PC/AT Compatibility */
326 setup_pcat_compatibility();
327
328 if (argc >= 2) {
329 /* argv[1] holds the address of the bzImage */
330 s = argv[1];
331 } else {
332 s = env_get("fileaddr");
333 }
334
335 if (s)
336 bzImage_addr = (void *)simple_strtoul(s, NULL, 16);
337
338 if (argc >= 3) {
339 /* argv[2] holds the size of the bzImage */
340 bzImage_size = simple_strtoul(argv[2], NULL, 16);
341 }
342
343 if (argc >= 4)
344 initrd_addr = simple_strtoul(argv[3], NULL, 16);
345 if (argc >= 5)
346 initrd_size = simple_strtoul(argv[4], NULL, 16);
347
348 /* Lets look for */
349 base_ptr = load_zimage(bzImage_addr, bzImage_size, &load_address);
350
351 if (!base_ptr) {
352 puts("## Kernel loading failed ...\n");
353 return -1;
354 }
355 if (setup_zimage(base_ptr, (char *)base_ptr + COMMAND_LINE_OFFSET,
356 0, initrd_addr, initrd_size)) {
357 puts("Setting up boot parameters failed ...\n");
358 return -1;
359 }
360
361 /* we assume that the kernel is in place */
362 return boot_linux_kernel((ulong)base_ptr, load_address, false);
363 }
364
365 U_BOOT_CMD(
366 zboot, 5, 0, do_zboot,
367 "Boot bzImage",
368 "[addr] [size] [initrd addr] [initrd size]\n"
369 " addr - The optional starting address of the bzimage.\n"
370 " If not set it defaults to the environment\n"
371 " variable \"fileaddr\".\n"
372 " size - The optional size of the bzimage. Defaults to\n"
373 " zero.\n"
374 " initrd addr - The address of the initrd image to use, if any.\n"
375 " initrd size - The size of the initrd image to use, if any.\n"
376 );
377