xref: /rk3399_rockchip-uboot/arch/x86/lib/zimage.c (revision 00caae6d47645e68d6e5277aceb69592b49381a6)
1fea25720SGraeme Russ /*
2d3a2bc3fSGabe Black  * Copyright (c) 2011 The Chromium OS Authors.
3fea25720SGraeme Russ  * (C) Copyright 2002
4fa82f871SAlbert ARIBAUD  * Daniel Engström, Omicron Ceti AB, <daniel@omicron.se>
5fea25720SGraeme Russ  *
61a459660SWolfgang Denk  * SPDX-License-Identifier:	GPL-2.0+
7fea25720SGraeme Russ  */
8fea25720SGraeme Russ 
9fea25720SGraeme Russ /*
10fea25720SGraeme Russ  * Linux x86 zImage and bzImage loading
11fea25720SGraeme Russ  *
12fea25720SGraeme Russ  * based on the procdure described in
13fea25720SGraeme Russ  * linux/Documentation/i386/boot.txt
14fea25720SGraeme Russ  */
15fea25720SGraeme Russ 
16fea25720SGraeme Russ #include <common.h>
17fea25720SGraeme Russ #include <asm/io.h>
18fea25720SGraeme Russ #include <asm/ptrace.h>
19fea25720SGraeme Russ #include <asm/zimage.h>
20fea25720SGraeme Russ #include <asm/byteorder.h>
210d0ba59cSSimon Glass #include <asm/bootm.h>
22fea25720SGraeme Russ #include <asm/bootparam.h>
233cdc18a8SVadim Bendebury #ifdef CONFIG_SYS_COREBOOT
243cdc18a8SVadim Bendebury #include <asm/arch/timestamp.h>
253cdc18a8SVadim Bendebury #endif
2661e0ea90SStefan Reinauer #include <linux/compiler.h>
27fea25720SGraeme Russ 
2854c6001bSBin Meng DECLARE_GLOBAL_DATA_PTR;
2954c6001bSBin Meng 
30fea25720SGraeme Russ /*
31fea25720SGraeme Russ  * Memory lay-out:
32fea25720SGraeme Russ  *
33fea25720SGraeme Russ  * relative to setup_base (which is 0x90000 currently)
34fea25720SGraeme Russ  *
35fea25720SGraeme Russ  *	0x0000-0x7FFF	Real mode kernel
36fea25720SGraeme Russ  *	0x8000-0x8FFF	Stack and heap
37fea25720SGraeme Russ  *	0x9000-0x90FF	Kernel command line
38fea25720SGraeme Russ  */
39fea25720SGraeme Russ #define DEFAULT_SETUP_BASE	0x90000
40fea25720SGraeme Russ #define COMMAND_LINE_OFFSET	0x9000
41fea25720SGraeme Russ #define HEAP_END_OFFSET		0x8e00
42fea25720SGraeme Russ 
43fea25720SGraeme Russ #define COMMAND_LINE_SIZE	2048
44fea25720SGraeme Russ 
build_command_line(char * command_line,int auto_boot)45fea25720SGraeme Russ static void build_command_line(char *command_line, int auto_boot)
46fea25720SGraeme Russ {
47fea25720SGraeme Russ 	char *env_command_line;
48fea25720SGraeme Russ 
49fea25720SGraeme Russ 	command_line[0] = '\0';
50fea25720SGraeme Russ 
51*00caae6dSSimon Glass 	env_command_line =  env_get("bootargs");
52fea25720SGraeme Russ 
53fea25720SGraeme Russ 	/* set console= argument if we use a serial console */
5483088afbSGraeme Russ 	if (!strstr(env_command_line, "console=")) {
55*00caae6dSSimon Glass 		if (!strcmp(env_get("stdout"), "serial")) {
56fea25720SGraeme Russ 
57fea25720SGraeme Russ 			/* We seem to use serial console */
58fea25720SGraeme Russ 			sprintf(command_line, "console=ttyS0,%s ",
59*00caae6dSSimon Glass 				env_get("baudrate"));
60fea25720SGraeme Russ 		}
61fea25720SGraeme Russ 	}
62fea25720SGraeme Russ 
6383088afbSGraeme Russ 	if (auto_boot)
64fea25720SGraeme Russ 		strcat(command_line, "auto ");
65fea25720SGraeme Russ 
6683088afbSGraeme Russ 	if (env_command_line)
67fea25720SGraeme Russ 		strcat(command_line, env_command_line);
68fea25720SGraeme Russ 
69fea25720SGraeme Russ 	printf("Kernel command line: \"%s\"\n", command_line);
70fea25720SGraeme Russ }
71fea25720SGraeme Russ 
kernel_magic_ok(struct setup_header * hdr)7269370d14SGabe Black static int kernel_magic_ok(struct setup_header *hdr)
7369370d14SGabe Black {
7469370d14SGabe Black 	if (KERNEL_MAGIC != hdr->boot_flag) {
7569370d14SGabe Black 		printf("Error: Invalid Boot Flag "
7669370d14SGabe Black 			"(found 0x%04x, expected 0x%04x)\n",
7769370d14SGabe Black 			hdr->boot_flag, KERNEL_MAGIC);
7869370d14SGabe Black 		return 0;
7969370d14SGabe Black 	} else {
8069370d14SGabe Black 		printf("Valid Boot Flag\n");
8169370d14SGabe Black 		return 1;
8269370d14SGabe Black 	}
8369370d14SGabe Black }
8469370d14SGabe Black 
get_boot_protocol(struct setup_header * hdr)8569370d14SGabe Black static int get_boot_protocol(struct setup_header *hdr)
8669370d14SGabe Black {
8769370d14SGabe Black 	if (hdr->header == KERNEL_V2_MAGIC) {
8869370d14SGabe Black 		printf("Magic signature found\n");
8969370d14SGabe Black 		return hdr->version;
9069370d14SGabe Black 	} else {
9169370d14SGabe Black 		/* Very old kernel */
9269370d14SGabe Black 		printf("Magic signature not found\n");
9369370d14SGabe Black 		return 0x0100;
9469370d14SGabe Black 	}
9569370d14SGabe Black }
9669370d14SGabe Black 
load_zimage(char * image,unsigned long kernel_size,ulong * load_addressp)9769370d14SGabe Black struct boot_params *load_zimage(char *image, unsigned long kernel_size,
9876539383SSimon Glass 				ulong *load_addressp)
99fea25720SGraeme Russ {
100d3a2bc3fSGabe Black 	struct boot_params *setup_base;
101fea25720SGraeme Russ 	int setup_size;
102fea25720SGraeme Russ 	int bootproto;
103fea25720SGraeme Russ 	int big_image;
104fea25720SGraeme Russ 
105d3a2bc3fSGabe Black 	struct boot_params *params = (struct boot_params *)image;
106d3a2bc3fSGabe Black 	struct setup_header *hdr = &params->hdr;
107fea25720SGraeme Russ 
10883088afbSGraeme Russ 	/* base address for real-mode segment */
109d3a2bc3fSGabe Black 	setup_base = (struct boot_params *)DEFAULT_SETUP_BASE;
110fea25720SGraeme Russ 
11169370d14SGabe Black 	if (!kernel_magic_ok(hdr))
112fea25720SGraeme Russ 		return 0;
113fea25720SGraeme Russ 
114fea25720SGraeme Russ 	/* determine size of setup */
115fea25720SGraeme Russ 	if (0 == hdr->setup_sects) {
116fea25720SGraeme Russ 		printf("Setup Sectors = 0 (defaulting to 4)\n");
117fea25720SGraeme Russ 		setup_size = 5 * 512;
118fea25720SGraeme Russ 	} else {
119fea25720SGraeme Russ 		setup_size = (hdr->setup_sects + 1) * 512;
120fea25720SGraeme Russ 	}
121fea25720SGraeme Russ 
122fea25720SGraeme Russ 	printf("Setup Size = 0x%8.8lx\n", (ulong)setup_size);
123fea25720SGraeme Russ 
12483088afbSGraeme Russ 	if (setup_size > SETUP_MAX_SIZE)
125fea25720SGraeme Russ 		printf("Error: Setup is too large (%d bytes)\n", setup_size);
126fea25720SGraeme Russ 
12769370d14SGabe Black 	/* determine boot protocol version */
12869370d14SGabe Black 	bootproto = get_boot_protocol(hdr);
12969370d14SGabe Black 
13069370d14SGabe Black 	printf("Using boot protocol version %x.%02x\n",
13169370d14SGabe Black 	       (bootproto & 0xff00) >> 8, bootproto & 0xff);
13269370d14SGabe Black 
13369370d14SGabe Black 	if (bootproto >= 0x0200) {
13469370d14SGabe Black 		if (hdr->setup_sects >= 15) {
13569370d14SGabe Black 			printf("Linux kernel version %s\n",
13669370d14SGabe Black 				(char *)params +
13769370d14SGabe Black 				hdr->kernel_version + 0x200);
13869370d14SGabe Black 		} else {
13969370d14SGabe Black 			printf("Setup Sectors < 15 - "
14069370d14SGabe Black 				"Cannot print kernel version.\n");
14169370d14SGabe Black 		}
14269370d14SGabe Black 	}
14369370d14SGabe Black 
144fea25720SGraeme Russ 	/* Determine image type */
14583088afbSGraeme Russ 	big_image = (bootproto >= 0x0200) &&
14683088afbSGraeme Russ 		    (hdr->loadflags & BIG_KERNEL_FLAG);
147fea25720SGraeme Russ 
148fea25720SGraeme Russ 	/* Determine load address */
149d3a2bc3fSGabe Black 	if (big_image)
15076539383SSimon Glass 		*load_addressp = BZIMAGE_LOAD_ADDR;
151d3a2bc3fSGabe Black 	else
15276539383SSimon Glass 		*load_addressp = ZIMAGE_LOAD_ADDR;
153fea25720SGraeme Russ 
154233dbc11SGabe Black 	printf("Building boot_params at 0x%8.8lx\n", (ulong)setup_base);
155233dbc11SGabe Black 	memset(setup_base, 0, sizeof(*setup_base));
156233dbc11SGabe Black 	setup_base->hdr = params->hdr;
157fea25720SGraeme Russ 
15869370d14SGabe Black 	if (bootproto >= 0x0204)
15969370d14SGabe Black 		kernel_size = hdr->syssize * 16;
16069370d14SGabe Black 	else
16169370d14SGabe Black 		kernel_size -= setup_size;
162fea25720SGraeme Russ 
163fea25720SGraeme Russ 	if (bootproto == 0x0100) {
16483088afbSGraeme Russ 		/*
16583088afbSGraeme Russ 		 * A very old kernel MUST have its real-mode code
16683088afbSGraeme Russ 		 * loaded at 0x90000
16783088afbSGraeme Russ 		 */
16842fd8c19SSimon Glass 		if ((ulong)setup_base != 0x90000) {
169fea25720SGraeme Russ 			/* Copy the real-mode kernel */
170fea25720SGraeme Russ 			memmove((void *)0x90000, setup_base, setup_size);
17183088afbSGraeme Russ 
172fea25720SGraeme Russ 			/* Copy the command line */
17383088afbSGraeme Russ 			memmove((void *)0x99000,
174d3a2bc3fSGabe Black 				(u8 *)setup_base + COMMAND_LINE_OFFSET,
175fea25720SGraeme Russ 				COMMAND_LINE_SIZE);
176fea25720SGraeme Russ 
17783088afbSGraeme Russ 			 /* Relocated */
178d3a2bc3fSGabe Black 			setup_base = (struct boot_params *)0x90000;
179fea25720SGraeme Russ 		}
180fea25720SGraeme Russ 
181fea25720SGraeme Russ 		/* It is recommended to clear memory up to the 32K mark */
182d3a2bc3fSGabe Black 		memset((u8 *)0x90000 + setup_size, 0,
18383088afbSGraeme Russ 		       SETUP_MAX_SIZE - setup_size);
184fea25720SGraeme Russ 	}
185fea25720SGraeme Russ 
18669370d14SGabe Black 	if (big_image) {
18769370d14SGabe Black 		if (kernel_size > BZIMAGE_MAX_SIZE) {
18869370d14SGabe Black 			printf("Error: bzImage kernel too big! "
18969370d14SGabe Black 				"(size: %ld, max: %d)\n",
19069370d14SGabe Black 				kernel_size, BZIMAGE_MAX_SIZE);
19169370d14SGabe Black 			return 0;
19269370d14SGabe Black 		}
19369370d14SGabe Black 	} else if ((kernel_size) > ZIMAGE_MAX_SIZE) {
19469370d14SGabe Black 		printf("Error: zImage kernel too big! (size: %ld, max: %d)\n",
19569370d14SGabe Black 		       kernel_size, ZIMAGE_MAX_SIZE);
19669370d14SGabe Black 		return 0;
19769370d14SGabe Black 	}
198fea25720SGraeme Russ 
19976539383SSimon Glass 	printf("Loading %s at address %lx (%ld bytes)\n",
20076539383SSimon Glass 	       big_image ? "bzImage" : "zImage", *load_addressp, kernel_size);
20169370d14SGabe Black 
20276539383SSimon Glass 	memmove((void *)*load_addressp, image + setup_size, kernel_size);
20369370d14SGabe Black 
20469370d14SGabe Black 	return setup_base;
20569370d14SGabe Black }
20669370d14SGabe Black 
setup_zimage(struct boot_params * setup_base,char * cmd_line,int auto_boot,unsigned long initrd_addr,unsigned long initrd_size)20769370d14SGabe Black int setup_zimage(struct boot_params *setup_base, char *cmd_line, int auto_boot,
20869370d14SGabe Black 		 unsigned long initrd_addr, unsigned long initrd_size)
20969370d14SGabe Black {
21069370d14SGabe Black 	struct setup_header *hdr = &setup_base->hdr;
21169370d14SGabe Black 	int bootproto = get_boot_protocol(hdr);
21269370d14SGabe Black 
21369370d14SGabe Black 	setup_base->e820_entries = install_e820_map(
21469370d14SGabe Black 		ARRAY_SIZE(setup_base->e820_map), setup_base->e820_map);
21569370d14SGabe Black 
21669370d14SGabe Black 	if (bootproto == 0x0100) {
21769370d14SGabe Black 		setup_base->screen_info.cl_magic = COMMAND_LINE_MAGIC;
21869370d14SGabe Black 		setup_base->screen_info.cl_offset = COMMAND_LINE_OFFSET;
21969370d14SGabe Black 	}
220fea25720SGraeme Russ 	if (bootproto >= 0x0200) {
221fea25720SGraeme Russ 		hdr->type_of_loader = 8;
222fea25720SGraeme Russ 
223fea25720SGraeme Russ 		if (initrd_addr) {
224d3a2bc3fSGabe Black 			printf("Initial RAM disk at linear address "
225d3a2bc3fSGabe Black 			       "0x%08lx, size %ld bytes\n",
226fea25720SGraeme Russ 			       initrd_addr, initrd_size);
227fea25720SGraeme Russ 
228fea25720SGraeme Russ 			hdr->ramdisk_image = initrd_addr;
229fea25720SGraeme Russ 			hdr->ramdisk_size = initrd_size;
230fea25720SGraeme Russ 		}
231fea25720SGraeme Russ 	}
232fea25720SGraeme Russ 
233fea25720SGraeme Russ 	if (bootproto >= 0x0201) {
234fea25720SGraeme Russ 		hdr->heap_end_ptr = HEAP_END_OFFSET;
235fea25720SGraeme Russ 		hdr->loadflags |= HEAP_FLAG;
236fea25720SGraeme Russ 	}
237fea25720SGraeme Russ 
23897d1e0c8SSimon Glass 	if (cmd_line) {
239fea25720SGraeme Russ 		if (bootproto >= 0x0202) {
24069370d14SGabe Black 			hdr->cmd_line_ptr = (uintptr_t)cmd_line;
241fea25720SGraeme Russ 		} else if (bootproto >= 0x0200) {
242d3a2bc3fSGabe Black 			setup_base->screen_info.cl_magic = COMMAND_LINE_MAGIC;
24369370d14SGabe Black 			setup_base->screen_info.cl_offset =
24469370d14SGabe Black 				(uintptr_t)cmd_line - (uintptr_t)setup_base;
245fea25720SGraeme Russ 
246fea25720SGraeme Russ 			hdr->setup_move_size = 0x9100;
247fea25720SGraeme Russ 		}
248fea25720SGraeme Russ 
24920bfac05SVincent Tinelli #if defined(CONFIG_INTEL_MID)
25020bfac05SVincent Tinelli 		hdr->hardware_subarch = X86_SUBARCH_INTEL_MID;
25120bfac05SVincent Tinelli #endif
25220bfac05SVincent Tinelli 
253fea25720SGraeme Russ 		/* build command line at COMMAND_LINE_OFFSET */
25469370d14SGabe Black 		build_command_line(cmd_line, auto_boot);
25597d1e0c8SSimon Glass 	}
25697d1e0c8SSimon Glass 
257a4520022SBin Meng 	setup_video(&setup_base->screen_info);
258a4520022SBin Meng 
25969370d14SGabe Black 	return 0;
260fea25720SGraeme Russ }
261fea25720SGraeme Russ 
2628e18e6e1SGraeme Russ void setup_pcat_compatibility(void)
2638e18e6e1SGraeme Russ 	__attribute__((weak, alias("__setup_pcat_compatibility")));
2648e18e6e1SGraeme Russ 
__setup_pcat_compatibility(void)2658e18e6e1SGraeme Russ void __setup_pcat_compatibility(void)
2668e18e6e1SGraeme Russ {
2678e18e6e1SGraeme Russ }
2688e18e6e1SGraeme Russ 
do_zboot(cmd_tbl_t * cmdtp,int flag,int argc,char * const argv[])269fea25720SGraeme Russ int do_zboot(cmd_tbl_t *cmdtp, int flag, int argc, char *const argv[])
270fea25720SGraeme Russ {
27169370d14SGabe Black 	struct boot_params *base_ptr;
272fea25720SGraeme Russ 	void *bzImage_addr = NULL;
27376539383SSimon Glass 	ulong load_address;
274fea25720SGraeme Russ 	char *s;
275fea25720SGraeme Russ 	ulong bzImage_size = 0;
2766f9d9986SGabe Black 	ulong initrd_addr = 0;
2776f9d9986SGabe Black 	ulong initrd_size = 0;
278fea25720SGraeme Russ 
279fea25720SGraeme Russ 	disable_interrupts();
280fea25720SGraeme Russ 
281fea25720SGraeme Russ 	/* Setup board for maximum PC/AT Compatibility */
282fea25720SGraeme Russ 	setup_pcat_compatibility();
283fea25720SGraeme Russ 
284d3a2bc3fSGabe Black 	if (argc >= 2) {
285fea25720SGraeme Russ 		/* argv[1] holds the address of the bzImage */
286fea25720SGraeme Russ 		s = argv[1];
287d3a2bc3fSGabe Black 	} else {
288*00caae6dSSimon Glass 		s = env_get("fileaddr");
289d3a2bc3fSGabe Black 	}
290fea25720SGraeme Russ 
291fea25720SGraeme Russ 	if (s)
292fea25720SGraeme Russ 		bzImage_addr = (void *)simple_strtoul(s, NULL, 16);
293fea25720SGraeme Russ 
2946f9d9986SGabe Black 	if (argc >= 3) {
295fea25720SGraeme Russ 		/* argv[2] holds the size of the bzImage */
296fea25720SGraeme Russ 		bzImage_size = simple_strtoul(argv[2], NULL, 16);
2976f9d9986SGabe Black 	}
2986f9d9986SGabe Black 
2996f9d9986SGabe Black 	if (argc >= 4)
3006f9d9986SGabe Black 		initrd_addr = simple_strtoul(argv[3], NULL, 16);
3016f9d9986SGabe Black 	if (argc >= 5)
3026f9d9986SGabe Black 		initrd_size = simple_strtoul(argv[4], NULL, 16);
303fea25720SGraeme Russ 
304fea25720SGraeme Russ 	/* Lets look for */
30569370d14SGabe Black 	base_ptr = load_zimage(bzImage_addr, bzImage_size, &load_address);
306fea25720SGraeme Russ 
30783088afbSGraeme Russ 	if (!base_ptr) {
3082c363cb0SSimon Glass 		puts("## Kernel loading failed ...\n");
30969370d14SGabe Black 		return -1;
31069370d14SGabe Black 	}
31169370d14SGabe Black 	if (setup_zimage(base_ptr, (char *)base_ptr + COMMAND_LINE_OFFSET,
3126f9d9986SGabe Black 			0, initrd_addr, initrd_size)) {
3132c363cb0SSimon Glass 		puts("Setting up boot parameters failed ...\n");
31469370d14SGabe Black 		return -1;
31569370d14SGabe Black 	}
31669370d14SGabe Black 
317fea25720SGraeme Russ 	/* we assume that the kernel is in place */
31876539383SSimon Glass 	return boot_linux_kernel((ulong)base_ptr, load_address, false);
319fea25720SGraeme Russ }
320fea25720SGraeme Russ 
321fea25720SGraeme Russ U_BOOT_CMD(
3226f9d9986SGabe Black 	zboot, 5, 0,	do_zboot,
323fea25720SGraeme Russ 	"Boot bzImage",
3246f9d9986SGabe Black 	"[addr] [size] [initrd addr] [initrd size]\n"
3256f9d9986SGabe Black 	"      addr -        The optional starting address of the bzimage.\n"
3266f9d9986SGabe Black 	"                    If not set it defaults to the environment\n"
3276f9d9986SGabe Black 	"                    variable \"fileaddr\".\n"
3286f9d9986SGabe Black 	"      size -        The optional size of the bzimage. Defaults to\n"
3296f9d9986SGabe Black 	"                    zero.\n"
3306f9d9986SGabe Black 	"      initrd addr - The address of the initrd image to use, if any.\n"
3316f9d9986SGabe Black 	"      initrd size - The size of the initrd image to use, if any.\n"
332fea25720SGraeme Russ );
333