2 * QEMU PC System Emulator
4 * Copyright (c) 2003-2004 Fabrice Bellard
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
26 #include "hw/nvram/fw_cfg.h"
27 #include "multiboot.h"
28 #include "hw/loader.h"
30 #include "sysemu/sysemu.h"
32 /* Show multiboot debug output */
33 //#define DEBUG_MULTIBOOT
35 #ifdef DEBUG_MULTIBOOT
36 #define mb_debug(a...) fprintf(stderr, ## a)
38 #define mb_debug(a...)
41 #define MULTIBOOT_STRUCT_ADDR 0x9000
43 #if MULTIBOOT_STRUCT_ADDR > 0xf0000
44 #error multiboot struct needs to fit in 16 bit real mode
61 /* Multiboot modules */
69 ADDR_E820_MAP
= MULTIBOOT_STRUCT_ADDR
+ 0,
70 ADDR_MBI
= ADDR_E820_MAP
+ 0x500,
73 MULTIBOOT_FLAGS_MEMORY
= 1 << 0,
74 MULTIBOOT_FLAGS_BOOT_DEVICE
= 1 << 1,
75 MULTIBOOT_FLAGS_CMDLINE
= 1 << 2,
76 MULTIBOOT_FLAGS_MODULES
= 1 << 3,
77 MULTIBOOT_FLAGS_MMAP
= 1 << 6,
78 MULTIBOOT_FLAGS_BOOTLOADER
= 1 << 9,
82 /* buffer holding kernel, cmdlines and mb_infos */
84 /* address in target */
86 /* size of mb_buf in bytes */
88 /* offset of mb-info's in bytes */
90 /* offset in buffer for cmdlines in bytes */
91 hwaddr offset_cmdlines
;
92 /* offset in buffer for bootloader name in bytes */
93 hwaddr offset_bootloader
;
94 /* offset of modules in bytes */
96 /* available slots for mb modules infos */
98 /* currently used slots of mb modules */
102 const char *bootloader_name
= "qemu";
104 static uint32_t mb_add_cmdline(MultibootState
*s
, const char *cmdline
)
106 hwaddr p
= s
->offset_cmdlines
;
107 char *b
= (char *)s
->mb_buf
+ p
;
109 get_opt_value(b
, strlen(cmdline
) + 1, cmdline
);
110 s
->offset_cmdlines
+= strlen(b
) + 1;
111 return s
->mb_buf_phys
+ p
;
114 static uint32_t mb_add_bootloader(MultibootState
*s
, const char *bootloader
)
116 hwaddr p
= s
->offset_bootloader
;
117 char *b
= (char *)s
->mb_buf
+ p
;
119 memcpy(b
, bootloader
, strlen(bootloader
) + 1);
120 s
->offset_bootloader
+= strlen(b
) + 1;
121 return s
->mb_buf_phys
+ p
;
124 static void mb_add_mod(MultibootState
*s
,
125 hwaddr start
, hwaddr end
,
129 assert(s
->mb_mods_count
< s
->mb_mods_avail
);
131 p
= (char *)s
->mb_buf
+ s
->offset_mbinfo
+ MB_MOD_SIZE
* s
->mb_mods_count
;
133 stl_p(p
+ MB_MOD_START
, start
);
134 stl_p(p
+ MB_MOD_END
, end
);
135 stl_p(p
+ MB_MOD_CMDLINE
, cmdline_phys
);
137 mb_debug("mod%02d: "TARGET_FMT_plx
" - "TARGET_FMT_plx
"\n",
138 s
->mb_mods_count
, start
, end
);
143 int load_multiboot(FWCfgState
*fw_cfg
,
145 const char *kernel_filename
,
146 const char *initrd_filename
,
147 const char *kernel_cmdline
,
148 int kernel_file_size
,
151 int i
, is_multiboot
= 0;
153 uint32_t mh_entry_addr
;
154 uint32_t mh_load_addr
;
155 uint32_t mb_kernel_size
;
157 uint8_t bootinfo
[MBI_SIZE
];
158 uint8_t *mb_bootinfo_data
;
160 /* Ok, let's see if it is a multiboot image.
161 The header is 12x32bit long, so the latest entry may be 8192 - 48. */
162 for (i
= 0; i
< (8192 - 48); i
+= 4) {
163 if (ldl_p(header
+i
) == 0x1BADB002) {
164 uint32_t checksum
= ldl_p(header
+i
+8);
165 flags
= ldl_p(header
+i
+4);
167 checksum
+= (uint32_t)0x1BADB002;
176 return 0; /* no multiboot */
178 mb_debug("qemu: I believe we found a multiboot image!\n");
179 memset(bootinfo
, 0, sizeof(bootinfo
));
180 memset(&mbs
, 0, sizeof(mbs
));
182 if (flags
& 0x00000004) { /* MULTIBOOT_HEADER_HAS_VBE */
183 fprintf(stderr
, "qemu: multiboot knows VBE. we don't.\n");
185 if (!(flags
& 0x00010000)) { /* MULTIBOOT_HEADER_HAS_ADDR */
187 uint64_t elf_low
, elf_high
;
191 if (((struct elf64_hdr
*)header
)->e_machine
== EM_X86_64
) {
192 fprintf(stderr
, "Cannot load x86-64 image, give a 32bit one.\n");
196 kernel_size
= load_elf(kernel_filename
, NULL
, NULL
, &elf_entry
,
197 &elf_low
, &elf_high
, 0, ELF_MACHINE
, 0);
198 if (kernel_size
< 0) {
199 fprintf(stderr
, "Error while loading elf kernel\n");
202 mh_load_addr
= elf_low
;
203 mb_kernel_size
= elf_high
- elf_low
;
204 mh_entry_addr
= elf_entry
;
206 mbs
.mb_buf
= g_malloc(mb_kernel_size
);
207 if (rom_copy(mbs
.mb_buf
, mh_load_addr
, mb_kernel_size
) != mb_kernel_size
) {
208 fprintf(stderr
, "Error while fetching elf kernel from rom\n");
212 mb_debug("qemu: loading multiboot-elf kernel (%#x bytes) with entry %#zx\n",
213 mb_kernel_size
, (size_t)mh_entry_addr
);
215 /* Valid if mh_flags sets MULTIBOOT_HEADER_HAS_ADDR. */
216 uint32_t mh_header_addr
= ldl_p(header
+i
+12);
217 uint32_t mh_load_end_addr
= ldl_p(header
+i
+20);
218 uint32_t mh_bss_end_addr
= ldl_p(header
+i
+24);
219 mh_load_addr
= ldl_p(header
+i
+16);
220 uint32_t mb_kernel_text_offset
= i
- (mh_header_addr
- mh_load_addr
);
221 uint32_t mb_load_size
= 0;
222 mh_entry_addr
= ldl_p(header
+i
+28);
224 if (mh_load_end_addr
) {
225 mb_kernel_size
= mh_bss_end_addr
- mh_load_addr
;
226 mb_load_size
= mh_load_end_addr
- mh_load_addr
;
228 mb_kernel_size
= kernel_file_size
- mb_kernel_text_offset
;
229 mb_load_size
= mb_kernel_size
;
232 /* Valid if mh_flags sets MULTIBOOT_HEADER_HAS_VBE.
233 uint32_t mh_mode_type = ldl_p(header+i+32);
234 uint32_t mh_width = ldl_p(header+i+36);
235 uint32_t mh_height = ldl_p(header+i+40);
236 uint32_t mh_depth = ldl_p(header+i+44); */
238 mb_debug("multiboot: mh_header_addr = %#x\n", mh_header_addr
);
239 mb_debug("multiboot: mh_load_addr = %#x\n", mh_load_addr
);
240 mb_debug("multiboot: mh_load_end_addr = %#x\n", mh_load_end_addr
);
241 mb_debug("multiboot: mh_bss_end_addr = %#x\n", mh_bss_end_addr
);
242 mb_debug("qemu: loading multiboot kernel (%#x bytes) at %#x\n",
243 mb_load_size
, mh_load_addr
);
245 mbs
.mb_buf
= g_malloc(mb_kernel_size
);
246 fseek(f
, mb_kernel_text_offset
, SEEK_SET
);
247 if (fread(mbs
.mb_buf
, 1, mb_load_size
, f
) != mb_load_size
) {
248 fprintf(stderr
, "fread() failed\n");
251 memset(mbs
.mb_buf
+ mb_load_size
, 0, mb_kernel_size
- mb_load_size
);
255 mbs
.mb_buf_phys
= mh_load_addr
;
257 mbs
.mb_buf_size
= TARGET_PAGE_ALIGN(mb_kernel_size
);
258 mbs
.offset_mbinfo
= mbs
.mb_buf_size
;
260 /* Calculate space for cmdlines, bootloader name, and mb_mods */
261 mbs
.mb_buf_size
+= strlen(kernel_filename
) + 1;
262 mbs
.mb_buf_size
+= strlen(kernel_cmdline
) + 1;
263 mbs
.mb_buf_size
+= strlen(bootloader_name
) + 1;
264 if (initrd_filename
) {
265 const char *r
= initrd_filename
;
266 mbs
.mb_buf_size
+= strlen(r
) + 1;
267 mbs
.mb_mods_avail
= 1;
268 while (*(r
= get_opt_value(NULL
, 0, r
))) {
272 mbs
.mb_buf_size
+= MB_MOD_SIZE
* mbs
.mb_mods_avail
;
275 mbs
.mb_buf_size
= TARGET_PAGE_ALIGN(mbs
.mb_buf_size
);
277 /* enlarge mb_buf to hold cmdlines, bootloader, mb-info structs */
278 mbs
.mb_buf
= g_realloc(mbs
.mb_buf
, mbs
.mb_buf_size
);
279 mbs
.offset_cmdlines
= mbs
.offset_mbinfo
+ mbs
.mb_mods_avail
* MB_MOD_SIZE
;
280 mbs
.offset_bootloader
= mbs
.offset_cmdlines
+ strlen(kernel_filename
) + 1
281 + strlen(kernel_cmdline
) + 1;
283 if (initrd_filename
) {
284 char *next_initrd
, not_last
;
286 mbs
.offset_mods
= mbs
.mb_buf_size
;
291 uint32_t offs
= mbs
.mb_buf_size
;
293 next_initrd
= (char *)get_opt_value(NULL
, 0, initrd_filename
);
294 not_last
= *next_initrd
;
296 /* if a space comes after the module filename, treat everything
297 after that as parameters */
298 hwaddr c
= mb_add_cmdline(&mbs
, initrd_filename
);
299 if ((next_space
= strchr(initrd_filename
, ' ')))
301 mb_debug("multiboot loading module: %s\n", initrd_filename
);
302 mb_mod_length
= get_image_size(initrd_filename
);
303 if (mb_mod_length
< 0) {
304 fprintf(stderr
, "Failed to open file '%s'\n", initrd_filename
);
308 mbs
.mb_buf_size
= TARGET_PAGE_ALIGN(mb_mod_length
+ mbs
.mb_buf_size
);
309 mbs
.mb_buf
= g_realloc(mbs
.mb_buf
, mbs
.mb_buf_size
);
311 load_image(initrd_filename
, (unsigned char *)mbs
.mb_buf
+ offs
);
312 mb_add_mod(&mbs
, mbs
.mb_buf_phys
+ offs
,
313 mbs
.mb_buf_phys
+ offs
+ mb_mod_length
, c
);
315 mb_debug("mod_start: %p\nmod_end: %p\n cmdline: "TARGET_FMT_plx
"\n",
316 (char *)mbs
.mb_buf
+ offs
,
317 (char *)mbs
.mb_buf
+ offs
+ mb_mod_length
, c
);
318 initrd_filename
= next_initrd
+1;
322 /* Commandline support */
323 char kcmdline
[strlen(kernel_filename
) + strlen(kernel_cmdline
) + 2];
324 snprintf(kcmdline
, sizeof(kcmdline
), "%s %s",
325 kernel_filename
, kernel_cmdline
);
326 stl_p(bootinfo
+ MBI_CMDLINE
, mb_add_cmdline(&mbs
, kcmdline
));
328 stl_p(bootinfo
+ MBI_BOOTLOADER
, mb_add_bootloader(&mbs
, bootloader_name
));
330 stl_p(bootinfo
+ MBI_MODS_ADDR
, mbs
.mb_buf_phys
+ mbs
.offset_mbinfo
);
331 stl_p(bootinfo
+ MBI_MODS_COUNT
, mbs
.mb_mods_count
); /* mods_count */
333 /* the kernel is where we want it to be now */
334 stl_p(bootinfo
+ MBI_FLAGS
, MULTIBOOT_FLAGS_MEMORY
335 | MULTIBOOT_FLAGS_BOOT_DEVICE
336 | MULTIBOOT_FLAGS_CMDLINE
337 | MULTIBOOT_FLAGS_MODULES
338 | MULTIBOOT_FLAGS_MMAP
339 | MULTIBOOT_FLAGS_BOOTLOADER
);
340 stl_p(bootinfo
+ MBI_BOOT_DEVICE
, 0x8000ffff); /* XXX: use the -boot switch? */
341 stl_p(bootinfo
+ MBI_MMAP_ADDR
, ADDR_E820_MAP
);
343 mb_debug("multiboot: mh_entry_addr = %#x\n", mh_entry_addr
);
344 mb_debug(" mb_buf_phys = "TARGET_FMT_plx
"\n", mbs
.mb_buf_phys
);
345 mb_debug(" mod_start = "TARGET_FMT_plx
"\n", mbs
.mb_buf_phys
+ mbs
.offset_mods
);
346 mb_debug(" mb_mods_count = %d\n", mbs
.mb_mods_count
);
348 /* save bootinfo off the stack */
349 mb_bootinfo_data
= g_malloc(sizeof(bootinfo
));
350 memcpy(mb_bootinfo_data
, bootinfo
, sizeof(bootinfo
));
352 /* Pass variables to option rom */
353 fw_cfg_add_i32(fw_cfg
, FW_CFG_KERNEL_ENTRY
, mh_entry_addr
);
354 fw_cfg_add_i32(fw_cfg
, FW_CFG_KERNEL_ADDR
, mh_load_addr
);
355 fw_cfg_add_i32(fw_cfg
, FW_CFG_KERNEL_SIZE
, mbs
.mb_buf_size
);
356 fw_cfg_add_bytes(fw_cfg
, FW_CFG_KERNEL_DATA
,
357 mbs
.mb_buf
, mbs
.mb_buf_size
);
359 fw_cfg_add_i32(fw_cfg
, FW_CFG_INITRD_ADDR
, ADDR_MBI
);
360 fw_cfg_add_i32(fw_cfg
, FW_CFG_INITRD_SIZE
, sizeof(bootinfo
));
361 fw_cfg_add_bytes(fw_cfg
, FW_CFG_INITRD_DATA
, mb_bootinfo_data
,
364 option_rom
[nb_option_roms
].name
= "multiboot.bin";
365 option_rom
[nb_option_roms
].bootindex
= 0;
368 return 1; /* yes, we are multiboot */