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