1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2011 The Chromium OS Authors.
9 * Linux x86 zImage and bzImage loading
11 * based on the procdure described in
12 * linux/Documentation/i386/boot.txt
15 #define LOG_CATEGORY LOGC_BOOT
26 #include <acpi/acpi_table.h>
28 #include <asm/ptrace.h>
29 #include <asm/zimage.h>
30 #include <asm/byteorder.h>
31 #include <asm/bootm.h>
32 #include <asm/bootparam.h>
34 #include <asm/global_data.h>
35 #ifdef CONFIG_SYS_COREBOOT
36 #include <asm/arch/timestamp.h>
38 #include <linux/compiler.h>
39 #include <linux/ctype.h>
40 #include <linux/libfdt.h>
42 DECLARE_GLOBAL_DATA_PTR;
47 * relative to setup_base (which is 0x90000 currently)
49 * 0x0000-0x7FFF Real mode kernel
50 * 0x8000-0x8FFF Stack and heap
51 * 0x9000-0x90FF Kernel command line
53 #define DEFAULT_SETUP_BASE 0x90000
54 #define COMMAND_LINE_OFFSET 0x9000
55 #define HEAP_END_OFFSET 0x8e00
57 #define COMMAND_LINE_SIZE 2048
59 /* Current state of the boot */
60 struct zboot_state state;
62 static void build_command_line(char *command_line, int auto_boot)
64 char *env_command_line;
66 command_line[0] = '\0';
68 env_command_line = env_get("bootargs");
70 /* set console= argument if we use a serial console */
71 if (!strstr(env_command_line, "console=")) {
72 if (!strcmp(env_get("stdout"), "serial")) {
74 /* We seem to use serial console */
75 sprintf(command_line, "console=ttyS0,%s ",
81 strcat(command_line, "auto ");
84 strcat(command_line, env_command_line);
86 printf("Kernel command line:");
92 static int kernel_magic_ok(struct setup_header *hdr)
94 if (KERNEL_MAGIC != hdr->boot_flag) {
95 printf("Error: Invalid Boot Flag "
96 "(found 0x%04x, expected 0x%04x)\n",
97 hdr->boot_flag, KERNEL_MAGIC);
100 printf("Valid Boot Flag\n");
105 static int get_boot_protocol(struct setup_header *hdr, bool verbose)
107 if (hdr->header == KERNEL_V2_MAGIC) {
109 printf("Magic signature found\n");
112 /* Very old kernel */
114 printf("Magic signature not found\n");
119 static int setup_device_tree(struct setup_header *hdr, const void *fdt_blob)
121 int bootproto = get_boot_protocol(hdr, false);
122 struct setup_data *sd;
125 if (bootproto < 0x0209)
131 size = fdt_totalsize(fdt_blob);
135 size += sizeof(struct setup_data);
136 sd = (struct setup_data *)malloc(size);
138 printf("Not enough memory for DTB setup data\n");
142 sd->next = hdr->setup_data;
143 sd->type = SETUP_DTB;
144 sd->len = fdt_totalsize(fdt_blob);
145 memcpy(sd->data, fdt_blob, sd->len);
146 hdr->setup_data = (unsigned long)sd;
151 const char *zimage_get_kernel_version(struct boot_params *params,
154 struct setup_header *hdr = ¶ms->hdr;
158 bootproto = get_boot_protocol(hdr, false);
159 log_debug("bootproto %x, hdr->setup_sects %x\n", bootproto,
161 if (bootproto < 0x0200 || hdr->setup_sects < 15)
164 /* sanity-check the kernel version in case it is missing */
165 log_debug("hdr->kernel_version %x, str at %p\n", hdr->kernel_version,
166 kernel_base + hdr->kernel_version + 0x200);
167 for (s = kernel_base + hdr->kernel_version + 0x200, end = s + 0x100; *s;
173 return kernel_base + hdr->kernel_version + 0x200;
176 struct boot_params *load_zimage(char *image, unsigned long kernel_size,
177 ulong *load_addressp)
179 struct boot_params *setup_base;
185 struct boot_params *params = (struct boot_params *)image;
186 struct setup_header *hdr = ¶ms->hdr;
188 /* base address for real-mode segment */
189 setup_base = (struct boot_params *)DEFAULT_SETUP_BASE;
191 if (!kernel_magic_ok(hdr))
194 /* determine size of setup */
195 if (0 == hdr->setup_sects) {
196 log_warning("Setup Sectors = 0 (defaulting to 4)\n");
197 setup_size = 5 * 512;
199 setup_size = (hdr->setup_sects + 1) * 512;
202 log_debug("Setup Size = 0x%8.8lx\n", (ulong)setup_size);
204 if (setup_size > SETUP_MAX_SIZE)
205 printf("Error: Setup is too large (%d bytes)\n", setup_size);
207 /* determine boot protocol version */
208 bootproto = get_boot_protocol(hdr, true);
210 log_debug("Using boot protocol version %x.%02x\n",
211 (bootproto & 0xff00) >> 8, bootproto & 0xff);
213 version = zimage_get_kernel_version(params, image);
215 printf("Linux kernel version %s\n", version);
217 printf("Setup Sectors < 15 - Cannot print kernel version\n");
219 /* Determine image type */
220 big_image = (bootproto >= 0x0200) &&
221 (hdr->loadflags & BIG_KERNEL_FLAG);
223 /* Determine load address */
225 *load_addressp = BZIMAGE_LOAD_ADDR;
227 *load_addressp = ZIMAGE_LOAD_ADDR;
229 printf("Building boot_params at 0x%8.8lx\n", (ulong)setup_base);
230 memset(setup_base, 0, sizeof(*setup_base));
231 setup_base->hdr = params->hdr;
233 if (bootproto >= 0x0204)
234 kernel_size = hdr->syssize * 16;
236 kernel_size -= setup_size;
238 if (bootproto == 0x0100) {
240 * A very old kernel MUST have its real-mode code
243 if ((ulong)setup_base != 0x90000) {
244 /* Copy the real-mode kernel */
245 memmove((void *)0x90000, setup_base, setup_size);
247 /* Copy the command line */
248 memmove((void *)0x99000,
249 (u8 *)setup_base + COMMAND_LINE_OFFSET,
253 setup_base = (struct boot_params *)0x90000;
256 /* It is recommended to clear memory up to the 32K mark */
257 memset((u8 *)0x90000 + setup_size, 0,
258 SETUP_MAX_SIZE - setup_size);
262 if (kernel_size > BZIMAGE_MAX_SIZE) {
263 printf("Error: bzImage kernel too big! "
264 "(size: %ld, max: %d)\n",
265 kernel_size, BZIMAGE_MAX_SIZE);
268 } else if ((kernel_size) > ZIMAGE_MAX_SIZE) {
269 printf("Error: zImage kernel too big! (size: %ld, max: %d)\n",
270 kernel_size, ZIMAGE_MAX_SIZE);
274 printf("Loading %s at address %lx (%ld bytes)\n",
275 big_image ? "bzImage" : "zImage", *load_addressp, kernel_size);
277 memmove((void *)*load_addressp, image + setup_size, kernel_size);
282 int setup_zimage(struct boot_params *setup_base, char *cmd_line, int auto_boot,
283 ulong initrd_addr, ulong initrd_size, ulong cmdline_force)
285 struct setup_header *hdr = &setup_base->hdr;
286 int bootproto = get_boot_protocol(hdr, false);
288 log_debug("Setup E820 entries\n");
289 if (IS_ENABLED(CONFIG_COREBOOT_SYSINFO)) {
290 setup_base->e820_entries = cb_install_e820_map(
291 ARRAY_SIZE(setup_base->e820_map), setup_base->e820_map);
293 setup_base->e820_entries = install_e820_map(
294 ARRAY_SIZE(setup_base->e820_map), setup_base->e820_map);
297 if (bootproto == 0x0100) {
298 setup_base->screen_info.cl_magic = COMMAND_LINE_MAGIC;
299 setup_base->screen_info.cl_offset = COMMAND_LINE_OFFSET;
301 if (bootproto >= 0x0200) {
302 hdr->type_of_loader = 0x80; /* U-Boot version 0 */
304 printf("Initial RAM disk at linear address "
305 "0x%08lx, size %ld bytes\n",
306 initrd_addr, initrd_size);
308 hdr->ramdisk_image = initrd_addr;
309 hdr->ramdisk_size = initrd_size;
313 if (bootproto >= 0x0201) {
314 hdr->heap_end_ptr = HEAP_END_OFFSET;
315 hdr->loadflags |= HEAP_FLAG;
322 log_debug("Setup cmdline\n");
323 if (bootproto >= 0x0206)
324 max_size = hdr->cmdline_size;
325 if (bootproto >= 0x0202) {
326 hdr->cmd_line_ptr = (uintptr_t)cmd_line;
327 } else if (bootproto >= 0x0200) {
328 setup_base->screen_info.cl_magic = COMMAND_LINE_MAGIC;
329 setup_base->screen_info.cl_offset =
330 (uintptr_t)cmd_line - (uintptr_t)setup_base;
332 hdr->setup_move_size = 0x9100;
335 /* build command line at COMMAND_LINE_OFFSET */
337 strcpy(cmd_line, (char *)cmdline_force);
339 build_command_line(cmd_line, auto_boot);
340 if (IS_ENABLED(CONFIG_CMD_BOOTM)) {
341 ret = bootm_process_cmdline(cmd_line, max_size,
344 printf("Cmdline setup failed (max_size=%x, bootproto=%x, err=%d)\n",
345 max_size, bootproto, ret);
349 printf("Kernel command line: \"");
354 if (IS_ENABLED(CONFIG_INTEL_MID) && bootproto >= 0x0207)
355 hdr->hardware_subarch = X86_SUBARCH_INTEL_MID;
357 if (IS_ENABLED(CONFIG_GENERATE_ACPI_TABLE))
358 setup_base->acpi_rsdp_addr = acpi_get_rsdp_addr();
360 log_debug("Setup devicetree\n");
361 setup_device_tree(hdr, (const void *)env_get_hex("fdtaddr", 0));
362 setup_video(&setup_base->screen_info);
364 if (IS_ENABLED(CONFIG_EFI_STUB))
365 setup_efi_info(&setup_base->efi_info);
372 struct boot_params *base_ptr;
375 if (state.base_ptr) {
376 struct boot_params *from = (struct boot_params *)state.base_ptr;
378 base_ptr = (struct boot_params *)DEFAULT_SETUP_BASE;
379 log_debug("Building boot_params at 0x%8.8lx\n",
381 memset(base_ptr, '\0', sizeof(*base_ptr));
382 base_ptr->hdr = from->hdr;
384 base_ptr = load_zimage((void *)state.bzimage_addr, state.bzimage_size,
385 &state.load_address);
387 puts("## Kernel loading failed ...\n");
391 state.base_ptr = base_ptr;
393 ret = env_set_hex("zbootbase", map_to_sysmem(state.base_ptr));
395 ret = env_set_hex("zbootaddr", state.load_address);
402 int zboot_setup(void)
404 struct boot_params *base_ptr = state.base_ptr;
407 ret = setup_zimage(base_ptr, (char *)base_ptr + COMMAND_LINE_OFFSET,
408 0, state.initrd_addr, state.initrd_size,
409 (ulong)state.cmdline);
418 struct boot_params *params = state.base_ptr;
419 struct setup_header *hdr = ¶ms->hdr;
424 disable_interrupts();
426 entry = state.load_address;
428 if (IS_ENABLED(CONFIG_X86_RUN_64BIT) &&
429 (hdr->xloadflags & XLF_KERNEL_64)) {
434 /* we assume that the kernel is in place */
435 ret = boot_linux_kernel((ulong)state.base_ptr, entry, image_64bit);
440 int zboot_run(ulong addr, ulong size, ulong initrd, ulong initrd_size,
441 ulong base, char *cmdline)
445 zboot_start(addr, size, initrd, initrd_size, base, cmdline);
448 return log_msg_ret("ld", ret);
451 return log_msg_ret("set", ret);
454 return log_msg_ret("go", ret);
459 static void print_num(const char *name, ulong value)
461 printf("%-20s: %lx\n", name, value);
464 static void print_num64(const char *name, u64 value)
466 printf("%-20s: %llx\n", name, value);
469 static const char *const e820_type_name[E820_COUNT] = {
471 [E820_RESERVED] = "Reserved",
472 [E820_ACPI] = "ACPI",
473 [E820_NVS] = "ACPI NVS",
474 [E820_UNUSABLE] = "Unusable",
477 static const char *const bootloader_id[] = {
482 "Etherboot/gPXE/iPXE",
490 "Arcturus Networks uCbootloader",
495 "Minimal Linux Bootloader",
496 "OVMF UEFI virtualization stack",
504 static struct flag_info load_flags[] = {
505 { LOADED_HIGH, "loaded-high" },
506 { QUIET_FLAG, "quiet" },
507 { KEEP_SEGMENTS, "keep-segments" },
508 { CAN_USE_HEAP, "can-use-heap" },
511 static struct flag_info xload_flags[] = {
512 { XLF_KERNEL_64, "64-bit-entry" },
513 { XLF_CAN_BE_LOADED_ABOVE_4G, "can-load-above-4gb" },
514 { XLF_EFI_HANDOVER_32, "32-efi-handoff" },
515 { XLF_EFI_HANDOVER_64, "64-efi-handoff" },
516 { XLF_EFI_KEXEC, "kexec-efi-runtime" },
519 static void print_flags(struct flag_info *flags, int count, uint value)
523 printf("%-20s:", "");
524 for (i = 0; i < count; i++) {
525 uint mask = flags[i].bit;
528 printf(" %s", flags[i].name);
533 static void show_loader(struct setup_header *hdr)
535 bool version_valid = false;
539 type = hdr->type_of_loader >> 4;
540 version = hdr->type_of_loader & 0xf;
542 type = 0x10 + hdr->ext_loader_type;
543 version |= hdr->ext_loader_ver << 4;
544 if (!hdr->type_of_loader) {
545 name = "pre-2.00 bootloader";
546 } else if (hdr->type_of_loader == 0xff) {
548 } else if (type < ARRAY_SIZE(bootloader_id)) {
549 name = bootloader_id[type];
550 version_valid = true;
554 printf("%20s %s", "", name);
556 printf(", version %x", version);
560 void zimage_dump(struct boot_params *base_ptr, bool show_cmdline)
562 struct setup_header *hdr;
566 printf("Setup located at %p:\n\n", base_ptr);
567 print_num64("ACPI RSDP addr", base_ptr->acpi_rsdp_addr);
569 printf("E820: %d entries\n", base_ptr->e820_entries);
570 if (base_ptr->e820_entries) {
571 printf("%12s %10s %s\n", "Addr", "Size", "Type");
572 for (i = 0; i < base_ptr->e820_entries; i++) {
573 struct e820_entry *entry = &base_ptr->e820_map[i];
575 printf("%12llx %10llx %s\n", entry->addr, entry->size,
576 entry->type < E820_COUNT ?
577 e820_type_name[entry->type] :
578 simple_itoa(entry->type));
582 hdr = &base_ptr->hdr;
583 print_num("Setup sectors", hdr->setup_sects);
584 print_num("Root flags", hdr->root_flags);
585 print_num("Sys size", hdr->syssize);
586 print_num("RAM size", hdr->ram_size);
587 print_num("Video mode", hdr->vid_mode);
588 print_num("Root dev", hdr->root_dev);
589 print_num("Boot flag", hdr->boot_flag);
590 print_num("Jump", hdr->jump);
591 print_num("Header", hdr->header);
592 if (hdr->header == KERNEL_V2_MAGIC)
593 printf("%-20s %s\n", "", "Kernel V2");
595 printf("%-20s %s\n", "", "Ancient kernel, using version 100");
596 print_num("Version", hdr->version);
597 print_num("Real mode switch", hdr->realmode_swtch);
598 print_num("Start sys seg", hdr->start_sys_seg);
599 print_num("Kernel version", hdr->kernel_version);
600 version = zimage_get_kernel_version(base_ptr,
601 (void *)state.bzimage_addr);
603 printf(" @%p: %s\n", version, version);
604 print_num("Type of loader", hdr->type_of_loader);
606 print_num("Load flags", hdr->loadflags);
607 print_flags(load_flags, ARRAY_SIZE(load_flags), hdr->loadflags);
608 print_num("Setup move size", hdr->setup_move_size);
609 print_num("Code32 start", hdr->code32_start);
610 print_num("Ramdisk image", hdr->ramdisk_image);
611 print_num("Ramdisk size", hdr->ramdisk_size);
612 print_num("Bootsect kludge", hdr->bootsect_kludge);
613 print_num("Heap end ptr", hdr->heap_end_ptr);
614 print_num("Ext loader ver", hdr->ext_loader_ver);
615 print_num("Ext loader type", hdr->ext_loader_type);
616 print_num("Command line ptr", hdr->cmd_line_ptr);
617 if (show_cmdline && hdr->cmd_line_ptr) {
619 /* Use puts() to avoid limits from CONFIG_SYS_PBSIZE */
620 puts((char *)(ulong)hdr->cmd_line_ptr);
623 print_num("Initrd addr max", hdr->initrd_addr_max);
624 print_num("Kernel alignment", hdr->kernel_alignment);
625 print_num("Relocatable kernel", hdr->relocatable_kernel);
626 print_num("Min alignment", hdr->min_alignment);
627 if (hdr->min_alignment)
628 printf("%-20s: %x\n", "", 1 << hdr->min_alignment);
629 print_num("Xload flags", hdr->xloadflags);
630 print_flags(xload_flags, ARRAY_SIZE(xload_flags), hdr->xloadflags);
631 print_num("Cmdline size", hdr->cmdline_size);
632 print_num("Hardware subarch", hdr->hardware_subarch);
633 print_num64("HW subarch data", hdr->hardware_subarch_data);
634 print_num("Payload offset", hdr->payload_offset);
635 print_num("Payload length", hdr->payload_length);
636 print_num64("Setup data", hdr->setup_data);
637 print_num64("Pref address", hdr->pref_address);
638 print_num("Init size", hdr->init_size);
639 print_num("Handover offset", hdr->handover_offset);
640 if (get_boot_protocol(hdr, false) >= 0x215)
641 print_num("Kernel info offset", hdr->kernel_info_offset);
644 void zboot_start(ulong bzimage_addr, ulong bzimage_size, ulong initrd_addr,
645 ulong initrd_size, ulong base_addr, const char *cmdline)
647 memset(&state, '\0', sizeof(state));
649 state.bzimage_size = bzimage_size;
650 state.initrd_addr = initrd_addr;
651 state.initrd_size = initrd_size;
653 state.base_ptr = map_sysmem(base_addr, 0);
654 state.load_address = bzimage_addr;
656 state.bzimage_addr = bzimage_addr;
658 state.cmdline = cmdline;
661 void zboot_info(void)
663 printf("Kernel loaded at %08lx, setup_base=%p\n",
664 state.load_address, state.base_ptr);