]> git.proxmox.com Git - mirror_qemu.git/blame - hw/i386/multiboot.c
Merge remote-tracking branch 'remotes/bonzini/tags/for-upstream' into staging
[mirror_qemu.git] / hw / i386 / multiboot.c
CommitLineData
52001445
AL
1/*
2 * QEMU PC System Emulator
3 *
4 * Copyright (c) 2003-2004 Fabrice Bellard
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24
b6a0aa05 25#include "qemu/osdep.h"
922a01a0 26#include "qemu/option.h"
4771d756 27#include "cpu.h"
83c9f4ca 28#include "hw/hw.h"
0d09e41a 29#include "hw/nvram/fw_cfg.h"
47b43a1f 30#include "multiboot.h"
83c9f4ca 31#include "hw/loader.h"
52001445 32#include "elf.h"
9c17d615 33#include "sysemu/sysemu.h"
4b9006a4 34#include "qemu/error-report.h"
52001445
AL
35
36/* Show multiboot debug output */
37//#define DEBUG_MULTIBOOT
38
39#ifdef DEBUG_MULTIBOOT
4b9006a4 40#define mb_debug(a...) error_report(a)
52001445
AL
41#else
42#define mb_debug(a...)
43#endif
44
45#define MULTIBOOT_STRUCT_ADDR 0x9000
46
47#if MULTIBOOT_STRUCT_ADDR > 0xf0000
48#error multiboot struct needs to fit in 16 bit real mode
49#endif
50
51enum {
52 /* Multiboot info */
53 MBI_FLAGS = 0,
54 MBI_MEM_LOWER = 4,
55 MBI_MEM_UPPER = 8,
56 MBI_BOOT_DEVICE = 12,
57 MBI_CMDLINE = 16,
58 MBI_MODS_COUNT = 20,
59 MBI_MODS_ADDR = 24,
60 MBI_MMAP_ADDR = 48,
5eba5a66 61 MBI_BOOTLOADER = 64,
52001445
AL
62
63 MBI_SIZE = 88,
64
65 /* Multiboot modules */
66 MB_MOD_START = 0,
67 MB_MOD_END = 4,
68 MB_MOD_CMDLINE = 8,
69
70 MB_MOD_SIZE = 16,
71
72 /* Region offsets */
73 ADDR_E820_MAP = MULTIBOOT_STRUCT_ADDR + 0,
74 ADDR_MBI = ADDR_E820_MAP + 0x500,
75
76 /* Multiboot flags */
77 MULTIBOOT_FLAGS_MEMORY = 1 << 0,
78 MULTIBOOT_FLAGS_BOOT_DEVICE = 1 << 1,
79 MULTIBOOT_FLAGS_CMDLINE = 1 << 2,
80 MULTIBOOT_FLAGS_MODULES = 1 << 3,
81 MULTIBOOT_FLAGS_MMAP = 1 << 6,
5eba5a66 82 MULTIBOOT_FLAGS_BOOTLOADER = 1 << 9,
52001445
AL
83};
84
85typedef struct {
86 /* buffer holding kernel, cmdlines and mb_infos */
87 void *mb_buf;
88 /* address in target */
a8170e5e 89 hwaddr mb_buf_phys;
52001445
AL
90 /* size of mb_buf in bytes */
91 unsigned mb_buf_size;
92 /* offset of mb-info's in bytes */
a8170e5e 93 hwaddr offset_mbinfo;
52001445 94 /* offset in buffer for cmdlines in bytes */
a8170e5e 95 hwaddr offset_cmdlines;
5eba5a66
DD
96 /* offset in buffer for bootloader name in bytes */
97 hwaddr offset_bootloader;
52001445 98 /* offset of modules in bytes */
a8170e5e 99 hwaddr offset_mods;
52001445
AL
100 /* available slots for mb modules infos */
101 int mb_mods_avail;
102 /* currently used slots of mb modules */
103 int mb_mods_count;
104} MultibootState;
105
5eba5a66
DD
106const char *bootloader_name = "qemu";
107
52001445
AL
108static uint32_t mb_add_cmdline(MultibootState *s, const char *cmdline)
109{
a8170e5e 110 hwaddr p = s->offset_cmdlines;
49e40b66 111 char *b = (char *)s->mb_buf + p;
52001445 112
96a3d392 113 memcpy(b, cmdline, strlen(cmdline) + 1);
49e40b66 114 s->offset_cmdlines += strlen(b) + 1;
52001445
AL
115 return s->mb_buf_phys + p;
116}
117
5eba5a66
DD
118static uint32_t mb_add_bootloader(MultibootState *s, const char *bootloader)
119{
120 hwaddr p = s->offset_bootloader;
121 char *b = (char *)s->mb_buf + p;
122
123 memcpy(b, bootloader, strlen(bootloader) + 1);
124 s->offset_bootloader += strlen(b) + 1;
125 return s->mb_buf_phys + p;
126}
127
52001445 128static void mb_add_mod(MultibootState *s,
a8170e5e
AK
129 hwaddr start, hwaddr end,
130 hwaddr cmdline_phys)
52001445
AL
131{
132 char *p;
133 assert(s->mb_mods_count < s->mb_mods_avail);
134
135 p = (char *)s->mb_buf + s->offset_mbinfo + MB_MOD_SIZE * s->mb_mods_count;
136
137 stl_p(p + MB_MOD_START, start);
138 stl_p(p + MB_MOD_END, end);
139 stl_p(p + MB_MOD_CMDLINE, cmdline_phys);
140
4b9006a4 141 mb_debug("mod%02d: "TARGET_FMT_plx" - "TARGET_FMT_plx,
bd418d90 142 s->mb_mods_count, start, end);
52001445
AL
143
144 s->mb_mods_count++;
145}
146
a88b362c 147int load_multiboot(FWCfgState *fw_cfg,
52001445
AL
148 FILE *f,
149 const char *kernel_filename,
150 const char *initrd_filename,
151 const char *kernel_cmdline,
152 int kernel_file_size,
153 uint8_t *header)
154{
155 int i, is_multiboot = 0;
156 uint32_t flags = 0;
157 uint32_t mh_entry_addr;
158 uint32_t mh_load_addr;
159 uint32_t mb_kernel_size;
160 MultibootState mbs;
161 uint8_t bootinfo[MBI_SIZE];
162 uint8_t *mb_bootinfo_data;
b4168498 163 uint32_t cmdline_len;
f8da93a0 164 GList *mods = NULL;
52001445
AL
165
166 /* Ok, let's see if it is a multiboot image.
167 The header is 12x32bit long, so the latest entry may be 8192 - 48. */
168 for (i = 0; i < (8192 - 48); i += 4) {
169 if (ldl_p(header+i) == 0x1BADB002) {
170 uint32_t checksum = ldl_p(header+i+8);
171 flags = ldl_p(header+i+4);
172 checksum += flags;
173 checksum += (uint32_t)0x1BADB002;
174 if (!checksum) {
175 is_multiboot = 1;
176 break;
177 }
178 }
179 }
180
181 if (!is_multiboot)
182 return 0; /* no multiboot */
183
371b74e2 184 mb_debug("I believe we found a multiboot image!");
52001445
AL
185 memset(bootinfo, 0, sizeof(bootinfo));
186 memset(&mbs, 0, sizeof(mbs));
187
188 if (flags & 0x00000004) { /* MULTIBOOT_HEADER_HAS_VBE */
371b74e2 189 error_report("multiboot knows VBE. we don't");
52001445
AL
190 }
191 if (!(flags & 0x00010000)) { /* MULTIBOOT_HEADER_HAS_ADDR */
192 uint64_t elf_entry;
193 uint64_t elf_low, elf_high;
194 int kernel_size;
195 fclose(f);
96968466
AL
196
197 if (((struct elf64_hdr*)header)->e_machine == EM_X86_64) {
4b9006a4 198 error_report("Cannot load x86-64 image, give a 32bit one.");
96968466
AL
199 exit(1);
200 }
201
4366e1db 202 kernel_size = load_elf(kernel_filename, NULL, NULL, NULL, &elf_entry,
7ef295ea
PC
203 &elf_low, &elf_high, 0, I386_ELF_MACHINE,
204 0, 0);
52001445 205 if (kernel_size < 0) {
4b9006a4 206 error_report("Error while loading elf kernel");
52001445
AL
207 exit(1);
208 }
209 mh_load_addr = elf_low;
210 mb_kernel_size = elf_high - elf_low;
211 mh_entry_addr = elf_entry;
212
7267c094 213 mbs.mb_buf = g_malloc(mb_kernel_size);
52001445 214 if (rom_copy(mbs.mb_buf, mh_load_addr, mb_kernel_size) != mb_kernel_size) {
4b9006a4 215 error_report("Error while fetching elf kernel from rom");
52001445
AL
216 exit(1);
217 }
218
371b74e2 219 mb_debug("loading multiboot-elf kernel "
4b9006a4
JS
220 "(%#x bytes) with entry %#zx",
221 mb_kernel_size, (size_t)mh_entry_addr);
52001445
AL
222 } else {
223 /* Valid if mh_flags sets MULTIBOOT_HEADER_HAS_ADDR. */
224 uint32_t mh_header_addr = ldl_p(header+i+12);
6b8273a1
GW
225 uint32_t mh_load_end_addr = ldl_p(header+i+20);
226 uint32_t mh_bss_end_addr = ldl_p(header+i+24);
ed4f86e8 227
52001445 228 mh_load_addr = ldl_p(header+i+16);
ed4f86e8 229 if (mh_header_addr < mh_load_addr) {
4b9006a4 230 error_report("invalid load_addr address");
ed4f86e8
PP
231 exit(1);
232 }
dbf2dce7
KW
233 if (mh_header_addr - mh_load_addr > i) {
234 error_report("invalid header_addr address");
235 exit(1);
236 }
ed4f86e8 237
52001445 238 uint32_t mb_kernel_text_offset = i - (mh_header_addr - mh_load_addr);
9c3a596a 239 uint32_t mb_load_size = 0;
52001445 240 mh_entry_addr = ldl_p(header+i+28);
9c3a596a
SM
241
242 if (mh_load_end_addr) {
ed4f86e8 243 if (mh_load_end_addr < mh_load_addr) {
4b9006a4 244 error_report("invalid load_end_addr address");
ed4f86e8
PP
245 exit(1);
246 }
9c3a596a
SM
247 mb_load_size = mh_load_end_addr - mh_load_addr;
248 } else {
ed4f86e8 249 if (kernel_file_size < mb_kernel_text_offset) {
4b9006a4 250 error_report("invalid kernel_file_size");
ed4f86e8
PP
251 exit(1);
252 }
2a8fcd11
JS
253 mb_load_size = kernel_file_size - mb_kernel_text_offset;
254 }
b17a9054
KW
255 if (mb_load_size > UINT32_MAX - mh_load_addr) {
256 error_report("kernel does not fit in address space");
257 exit(1);
258 }
2a8fcd11
JS
259 if (mh_bss_end_addr) {
260 if (mh_bss_end_addr < (mh_load_addr + mb_load_size)) {
4b9006a4 261 error_report("invalid bss_end_addr address");
2a8fcd11
JS
262 exit(1);
263 }
264 mb_kernel_size = mh_bss_end_addr - mh_load_addr;
265 } else {
266 mb_kernel_size = mb_load_size;
9c3a596a 267 }
52001445 268
4b9006a4
JS
269 mb_debug("multiboot: header_addr = %#x", mh_header_addr);
270 mb_debug("multiboot: load_addr = %#x", mh_load_addr);
271 mb_debug("multiboot: load_end_addr = %#x", mh_load_end_addr);
272 mb_debug("multiboot: bss_end_addr = %#x", mh_bss_end_addr);
371b74e2 273 mb_debug("loading multiboot kernel (%#x bytes) at %#x",
6b8273a1 274 mb_load_size, mh_load_addr);
52001445 275
7267c094 276 mbs.mb_buf = g_malloc(mb_kernel_size);
52001445 277 fseek(f, mb_kernel_text_offset, SEEK_SET);
6b8273a1 278 if (fread(mbs.mb_buf, 1, mb_load_size, f) != mb_load_size) {
4b9006a4 279 error_report("fread() failed");
52001445
AL
280 exit(1);
281 }
6b8273a1 282 memset(mbs.mb_buf + mb_load_size, 0, mb_kernel_size - mb_load_size);
52001445
AL
283 fclose(f);
284 }
285
286 mbs.mb_buf_phys = mh_load_addr;
287
288 mbs.mb_buf_size = TARGET_PAGE_ALIGN(mb_kernel_size);
289 mbs.offset_mbinfo = mbs.mb_buf_size;
290
5eba5a66 291 /* Calculate space for cmdlines, bootloader name, and mb_mods */
b4168498
KW
292 cmdline_len = strlen(kernel_filename) + 1;
293 cmdline_len += strlen(kernel_cmdline) + 1;
52001445 294 if (initrd_filename) {
f8da93a0 295 const char *r = initrd_filename;
6e3ad3f0 296 cmdline_len += strlen(initrd_filename) + 1;
f8da93a0
DB
297 while (*r) {
298 char *value;
299 r = get_opt_value(r, &value);
950c4e6c 300 mbs.mb_mods_avail++;
f8da93a0
DB
301 mods = g_list_append(mods, value);
302 if (*r) {
303 r++;
950c4e6c 304 }
52001445 305 }
52001445
AL
306 }
307
b4168498
KW
308 mbs.mb_buf_size += cmdline_len;
309 mbs.mb_buf_size += MB_MOD_SIZE * mbs.mb_mods_avail;
310 mbs.mb_buf_size += strlen(bootloader_name) + 1;
311
52001445
AL
312 mbs.mb_buf_size = TARGET_PAGE_ALIGN(mbs.mb_buf_size);
313
5eba5a66
DD
314 /* enlarge mb_buf to hold cmdlines, bootloader, mb-info structs */
315 mbs.mb_buf = g_realloc(mbs.mb_buf, mbs.mb_buf_size);
316 mbs.offset_cmdlines = mbs.offset_mbinfo + mbs.mb_mods_avail * MB_MOD_SIZE;
b4168498 317 mbs.offset_bootloader = mbs.offset_cmdlines + cmdline_len;
52001445 318
f8da93a0
DB
319 if (mods) {
320 GList *tmpl = mods;
52001445
AL
321 mbs.offset_mods = mbs.mb_buf_size;
322
f8da93a0 323 while (tmpl) {
52001445 324 char *next_space;
37a05af0 325 int mb_mod_length;
52001445 326 uint32_t offs = mbs.mb_buf_size;
f8da93a0 327 char *one_file = tmpl->data;
52001445 328
52001445
AL
329 /* if a space comes after the module filename, treat everything
330 after that as parameters */
950c4e6c
DB
331 hwaddr c = mb_add_cmdline(&mbs, one_file);
332 next_space = strchr(one_file, ' ');
333 if (next_space) {
52001445 334 *next_space = '\0';
950c4e6c
DB
335 }
336 mb_debug("multiboot loading module: %s", one_file);
337 mb_mod_length = get_image_size(one_file);
52001445 338 if (mb_mod_length < 0) {
950c4e6c 339 error_report("Failed to open file '%s'", one_file);
52001445
AL
340 exit(1);
341 }
342
343 mbs.mb_buf_size = TARGET_PAGE_ALIGN(mb_mod_length + mbs.mb_buf_size);
7267c094 344 mbs.mb_buf = g_realloc(mbs.mb_buf, mbs.mb_buf_size);
52001445 345
5250b09e
PM
346 if (load_image_size(one_file, (unsigned char *)mbs.mb_buf + offs,
347 mbs.mb_buf_size - offs) < 0) {
348 error_report("Error loading file '%s'", one_file);
349 exit(1);
350 }
52001445
AL
351 mb_add_mod(&mbs, mbs.mb_buf_phys + offs,
352 mbs.mb_buf_phys + offs + mb_mod_length, c);
353
4b9006a4 354 mb_debug("mod_start: %p\nmod_end: %p\n cmdline: "TARGET_FMT_plx,
52001445
AL
355 (char *)mbs.mb_buf + offs,
356 (char *)mbs.mb_buf + offs + mb_mod_length, c);
950c4e6c 357 g_free(one_file);
f8da93a0
DB
358 tmpl = tmpl->next;
359 }
360 g_list_free(mods);
52001445
AL
361 }
362
363 /* Commandline support */
364 char kcmdline[strlen(kernel_filename) + strlen(kernel_cmdline) + 2];
365 snprintf(kcmdline, sizeof(kcmdline), "%s %s",
366 kernel_filename, kernel_cmdline);
367 stl_p(bootinfo + MBI_CMDLINE, mb_add_cmdline(&mbs, kcmdline));
368
5eba5a66
DD
369 stl_p(bootinfo + MBI_BOOTLOADER, mb_add_bootloader(&mbs, bootloader_name));
370
52001445
AL
371 stl_p(bootinfo + MBI_MODS_ADDR, mbs.mb_buf_phys + mbs.offset_mbinfo);
372 stl_p(bootinfo + MBI_MODS_COUNT, mbs.mb_mods_count); /* mods_count */
373
374 /* the kernel is where we want it to be now */
375 stl_p(bootinfo + MBI_FLAGS, MULTIBOOT_FLAGS_MEMORY
376 | MULTIBOOT_FLAGS_BOOT_DEVICE
377 | MULTIBOOT_FLAGS_CMDLINE
378 | MULTIBOOT_FLAGS_MODULES
5eba5a66
DD
379 | MULTIBOOT_FLAGS_MMAP
380 | MULTIBOOT_FLAGS_BOOTLOADER);
c83066d4 381 stl_p(bootinfo + MBI_BOOT_DEVICE, 0x8000ffff); /* XXX: use the -boot switch? */
52001445
AL
382 stl_p(bootinfo + MBI_MMAP_ADDR, ADDR_E820_MAP);
383
4b9006a4
JS
384 mb_debug("multiboot: entry_addr = %#x", mh_entry_addr);
385 mb_debug(" mb_buf_phys = "TARGET_FMT_plx, mbs.mb_buf_phys);
386 mb_debug(" mod_start = "TARGET_FMT_plx,
387 mbs.mb_buf_phys + mbs.offset_mods);
388 mb_debug(" mb_mods_count = %d", mbs.mb_mods_count);
52001445
AL
389
390 /* save bootinfo off the stack */
ad2c1993 391 mb_bootinfo_data = g_memdup(bootinfo, sizeof(bootinfo));
52001445
AL
392
393 /* Pass variables to option rom */
394 fw_cfg_add_i32(fw_cfg, FW_CFG_KERNEL_ENTRY, mh_entry_addr);
395 fw_cfg_add_i32(fw_cfg, FW_CFG_KERNEL_ADDR, mh_load_addr);
396 fw_cfg_add_i32(fw_cfg, FW_CFG_KERNEL_SIZE, mbs.mb_buf_size);
397 fw_cfg_add_bytes(fw_cfg, FW_CFG_KERNEL_DATA,
398 mbs.mb_buf, mbs.mb_buf_size);
399
400 fw_cfg_add_i32(fw_cfg, FW_CFG_INITRD_ADDR, ADDR_MBI);
401 fw_cfg_add_i32(fw_cfg, FW_CFG_INITRD_SIZE, sizeof(bootinfo));
402 fw_cfg_add_bytes(fw_cfg, FW_CFG_INITRD_DATA, mb_bootinfo_data,
403 sizeof(bootinfo));
404
2e55e842
GN
405 option_rom[nb_option_roms].name = "multiboot.bin";
406 option_rom[nb_option_roms].bootindex = 0;
52001445
AL
407 nb_option_roms++;
408
409 return 1; /* yes, we are multiboot */
410}