2 * GRUB -- GRand Unified Bootloader
3 * Copyright (C) 1999,2000,2001,2002,2003,2004,2005,2007,2008,2009 Free Software Foundation, Inc.
5 * GRUB is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * GRUB is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with GRUB. If not, see <http://www.gnu.org/licenses/>.
19 #include <grub/memory.h>
20 #ifdef GRUB_MACHINE_PCBIOS
21 #include <grub/machine/biosnum.h>
22 #include <grub/machine/apm.h>
23 #include <grub/machine/memory.h>
25 #include <grub/multiboot.h>
26 #include <grub/cpu/relocator.h>
27 #include <grub/disk.h>
28 #include <grub/device.h>
29 #include <grub/partition.h>
31 #include <grub/misc.h>
33 #include <grub/relocator.h>
34 #include <grub/video.h>
35 #include <grub/file.h>
37 #include <grub/i18n.h>
38 #include <grub/lib/cmdline.h>
40 #ifdef GRUB_MACHINE_EFI
41 #include <grub/efi/efi.h>
44 /* The bits in the required part of flags field we don't support. */
45 #define UNSUPPORTED_FLAGS 0x0000fff8
56 static struct module *modules, *modules_last;
57 static grub_size_t cmdline_size;
58 static grub_size_t total_modcmd;
59 static unsigned modcnt;
60 static char *cmdline = NULL;
61 static grub_uint32_t bootdev;
62 static int bootdev_set;
63 static grub_size_t elf_sec_num, elf_sec_entsize;
64 static unsigned elf_sec_shstrndx;
65 static void *elf_sections;
66 grub_multiboot_quirks_t grub_multiboot_quirks;
69 load_kernel (grub_file_t file, const char *filename,
70 char *buffer, struct multiboot_header *header)
76 mld.filename = filename;
80 mld.avoid_efi_boot_services = 0;
82 if (grub_multiboot_quirks & GRUB_MULTIBOOT_QUIRK_BAD_KLUDGE)
84 err = grub_multiboot_load_elf (&mld);
85 if (err == GRUB_ERR_NONE) {
88 if (err == GRUB_ERR_UNKNOWN_OS && (header->flags & MULTIBOOT_AOUT_KLUDGE))
89 grub_errno = err = GRUB_ERR_NONE;
91 if (header->flags & MULTIBOOT_AOUT_KLUDGE)
93 int offset = ((char *) header - buffer -
94 (header->header_addr - header->load_addr));
95 int load_size = ((header->load_end_addr == 0) ? file->size - offset :
96 header->load_end_addr - header->load_addr);
97 grub_size_t code_size;
99 grub_relocator_chunk_t ch;
101 if (header->bss_end_addr)
102 code_size = (header->bss_end_addr - header->load_addr);
104 code_size = load_size;
106 err = grub_relocator_alloc_chunk_addr (grub_multiboot_relocator,
107 &ch, header->load_addr,
111 grub_dprintf ("multiboot_loader", "Error loading aout kludge\n");
114 source = get_virtual_current_address (ch);
116 if ((grub_file_seek (file, offset)) == (grub_off_t) -1)
121 grub_file_read (file, source, load_size);
125 if (header->bss_end_addr)
126 grub_memset ((grub_uint8_t *) source + load_size, 0,
127 header->bss_end_addr - header->load_addr - load_size);
129 grub_multiboot_payload_eip = header->entry_addr;
130 return GRUB_ERR_NONE;
133 return grub_multiboot_load_elf (&mld);
136 static struct multiboot_header *
137 find_header (char *buffer, grub_ssize_t len)
139 struct multiboot_header *header;
141 /* Look for the multiboot header in the buffer. The header should
142 be at least 12 bytes and aligned on a 4-byte boundary. */
143 for (header = (struct multiboot_header *) buffer;
144 ((char *) header <= buffer + len - 12);
145 header = (struct multiboot_header *) ((char *) header + MULTIBOOT_HEADER_ALIGN))
147 if (header->magic == MULTIBOOT_HEADER_MAGIC
148 && !(header->magic + header->flags + header->checksum))
155 grub_multiboot_load (grub_file_t file, const char *filename)
159 struct multiboot_header *header;
162 buffer = grub_malloc (MULTIBOOT_SEARCH);
166 len = grub_file_read (file, buffer, MULTIBOOT_SEARCH);
171 grub_error (GRUB_ERR_BAD_OS, N_("premature end of file %s"),
176 header = find_header (buffer, len);
181 return grub_error (GRUB_ERR_BAD_ARGUMENT, "no multiboot header found");
184 if (header->flags & UNSUPPORTED_FLAGS)
187 return grub_error (GRUB_ERR_UNKNOWN_OS,
188 "unsupported flag: 0x%x", header->flags);
191 err = load_kernel (file, filename, buffer, header);
198 if (header->flags & MULTIBOOT_VIDEO_MODE)
200 switch (header->mode_type)
203 err = grub_multiboot_set_console (GRUB_MULTIBOOT_CONSOLE_EGA_TEXT,
204 GRUB_MULTIBOOT_CONSOLE_EGA_TEXT
205 | GRUB_MULTIBOOT_CONSOLE_FRAMEBUFFER,
209 err = grub_multiboot_set_console (GRUB_MULTIBOOT_CONSOLE_FRAMEBUFFER,
210 GRUB_MULTIBOOT_CONSOLE_EGA_TEXT
211 | GRUB_MULTIBOOT_CONSOLE_FRAMEBUFFER,
212 header->width, header->height,
216 err = grub_error (GRUB_ERR_BAD_OS,
217 "unsupported graphical mode type %d",
223 err = grub_multiboot_set_console (GRUB_MULTIBOOT_CONSOLE_EGA_TEXT,
224 GRUB_MULTIBOOT_CONSOLE_EGA_TEXT,
229 #if GRUB_MACHINE_HAS_VBE || GRUB_MACHINE_HAS_VGA_TEXT
230 #include <grub/i386/pc/vbe.h>
234 grub_multiboot_get_mbi_size (void)
237 struct grub_net_network_level_interface *net;
239 ret = sizeof (struct multiboot_info) + ALIGN_UP (cmdline_size, 4)
240 + modcnt * sizeof (struct multiboot_mod_list) + total_modcmd
241 + ALIGN_UP (sizeof(PACKAGE_STRING), 4)
242 + grub_multiboot_get_mmap_count () * sizeof (struct multiboot_mmap_entry)
243 + elf_sec_entsize * elf_sec_num
244 + 256 * sizeof (struct multiboot_color)
245 #if GRUB_MACHINE_HAS_VBE || GRUB_MACHINE_HAS_VGA_TEXT
246 + sizeof (struct grub_vbe_info_block)
247 + sizeof (struct grub_vbe_mode_info_block)
249 + ALIGN_UP (sizeof (struct multiboot_apm_info), 4);
251 FOR_NET_NETWORK_LEVEL_INTERFACES(net)
254 ret += net->dhcp_acklen;
261 /* Helper for grub_fill_multiboot_mmap. */
263 grub_fill_multiboot_mmap_iter (grub_uint64_t addr, grub_uint64_t size,
264 grub_memory_type_t type, void *data)
266 struct multiboot_mmap_entry **mmap_entry = data;
268 (*mmap_entry)->addr = addr;
269 (*mmap_entry)->len = size;
270 (*mmap_entry)->type = type;
271 (*mmap_entry)->size = sizeof (struct multiboot_mmap_entry) - sizeof ((*mmap_entry)->size);
277 /* Fill previously allocated Multiboot mmap. */
279 grub_fill_multiboot_mmap (struct multiboot_mmap_entry *first_entry)
281 struct multiboot_mmap_entry *mmap_entry = (struct multiboot_mmap_entry *) first_entry;
283 grub_mmap_iterate (grub_fill_multiboot_mmap_iter, &mmap_entry);
286 #if GRUB_MACHINE_HAS_VBE || GRUB_MACHINE_HAS_VGA_TEXT
289 fill_vbe_info (struct multiboot_info *mbi, grub_uint8_t *ptrorig,
290 grub_uint32_t ptrdest, int fill_generic)
292 grub_uint32_t vbe_mode;
293 struct grub_vbe_mode_info_block *mode_info;
294 #if GRUB_MACHINE_HAS_VBE
295 grub_vbe_status_t status;
296 void *scratch = (void *) GRUB_MEMORY_MACHINE_SCRATCH_ADDR;
298 status = grub_vbe_bios_get_controller_info (scratch);
299 if (status != GRUB_VBE_STATUS_OK)
300 return grub_error (GRUB_ERR_IO, "Can't get controller info.");
302 mbi->vbe_control_info = ptrdest;
303 grub_memcpy (ptrorig, scratch, sizeof (struct grub_vbe_info_block));
304 ptrorig += sizeof (struct grub_vbe_info_block);
305 ptrdest += sizeof (struct grub_vbe_info_block);
307 mbi->vbe_control_info = 0;
310 #if GRUB_MACHINE_HAS_VBE
311 status = grub_vbe_bios_get_mode (scratch);
312 vbe_mode = *(grub_uint32_t *) scratch;
313 if (status != GRUB_VBE_STATUS_OK)
314 return grub_error (GRUB_ERR_IO, "can't get VBE mode");
318 mbi->vbe_mode = vbe_mode;
320 mode_info = (struct grub_vbe_mode_info_block *) ptrorig;
321 mbi->vbe_mode_info = ptrdest;
322 /* get_mode_info isn't available for mode 3. */
325 grub_memset (mode_info, 0, sizeof (struct grub_vbe_mode_info_block));
326 mode_info->memory_model = GRUB_VBE_MEMORY_MODEL_TEXT;
327 mode_info->x_resolution = 80;
328 mode_info->y_resolution = 25;
332 #if GRUB_MACHINE_HAS_VBE
333 status = grub_vbe_bios_get_mode_info (vbe_mode, scratch);
334 if (status != GRUB_VBE_STATUS_OK)
335 return grub_error (GRUB_ERR_IO, "can't get mode info");
336 grub_memcpy (mode_info, scratch,
337 sizeof (struct grub_vbe_mode_info_block));
340 ptrorig += sizeof (struct grub_vbe_mode_info_block);
341 ptrdest += sizeof (struct grub_vbe_mode_info_block);
343 #if GRUB_MACHINE_HAS_VBE
344 grub_vbe_bios_get_pm_interface (&mbi->vbe_interface_seg,
345 &mbi->vbe_interface_off,
346 &mbi->vbe_interface_len);
349 mbi->flags |= MULTIBOOT_INFO_VBE_INFO;
351 if (fill_generic && mode_info->memory_model == GRUB_VBE_MEMORY_MODEL_TEXT)
353 mbi->framebuffer_addr = 0xb8000;
355 mbi->framebuffer_pitch = 2 * mode_info->x_resolution;
356 mbi->framebuffer_width = mode_info->x_resolution;
357 mbi->framebuffer_height = mode_info->y_resolution;
359 mbi->framebuffer_bpp = 16;
361 mbi->framebuffer_type = MULTIBOOT_FRAMEBUFFER_TYPE_EGA_TEXT;
363 mbi->flags |= MULTIBOOT_INFO_FRAMEBUFFER_INFO;
366 return GRUB_ERR_NONE;
371 retrieve_video_parameters (struct multiboot_info *mbi,
372 grub_uint8_t *ptrorig, grub_uint32_t ptrdest)
375 struct grub_video_mode_info mode_info;
377 grub_video_driver_id_t driv_id;
378 struct grub_video_palette_data palette[256];
380 err = grub_multiboot_set_video_mode ();
384 grub_errno = GRUB_ERR_NONE;
387 grub_video_get_palette (0, ARRAY_SIZE (palette), palette);
389 driv_id = grub_video_get_driver_id ();
390 #if GRUB_MACHINE_HAS_VGA_TEXT
391 if (driv_id == GRUB_VIDEO_DRIVER_NONE)
392 return fill_vbe_info (mbi, ptrorig, ptrdest, 1);
394 if (driv_id == GRUB_VIDEO_DRIVER_NONE)
395 return GRUB_ERR_NONE;
398 err = grub_video_get_info_and_fini (&mode_info, &framebuffer);
402 mbi->framebuffer_addr = (grub_addr_t) framebuffer;
403 mbi->framebuffer_pitch = mode_info.pitch;
405 mbi->framebuffer_width = mode_info.width;
406 mbi->framebuffer_height = mode_info.height;
408 mbi->framebuffer_bpp = mode_info.bpp;
410 if (mode_info.mode_type & GRUB_VIDEO_MODE_TYPE_INDEX_COLOR)
412 struct multiboot_color *mb_palette;
414 mbi->framebuffer_type = MULTIBOOT_FRAMEBUFFER_TYPE_INDEXED;
415 mbi->framebuffer_palette_addr = ptrdest;
416 mbi->framebuffer_palette_num_colors = mode_info.number_of_colors;
417 if (mbi->framebuffer_palette_num_colors > ARRAY_SIZE (palette))
418 mbi->framebuffer_palette_num_colors = ARRAY_SIZE (palette);
419 mb_palette = (struct multiboot_color *) ptrorig;
420 for (i = 0; i < mbi->framebuffer_palette_num_colors; i++)
422 mb_palette[i].red = palette[i].r;
423 mb_palette[i].green = palette[i].g;
424 mb_palette[i].blue = palette[i].b;
426 ptrorig += mbi->framebuffer_palette_num_colors
427 * sizeof (struct multiboot_color);
428 ptrdest += mbi->framebuffer_palette_num_colors
429 * sizeof (struct multiboot_color);
433 mbi->framebuffer_type = MULTIBOOT_FRAMEBUFFER_TYPE_RGB;
434 mbi->framebuffer_red_field_position = mode_info.red_field_pos;
435 mbi->framebuffer_red_mask_size = mode_info.red_mask_size;
436 mbi->framebuffer_green_field_position = mode_info.green_field_pos;
437 mbi->framebuffer_green_mask_size = mode_info.green_mask_size;
438 mbi->framebuffer_blue_field_position = mode_info.blue_field_pos;
439 mbi->framebuffer_blue_mask_size = mode_info.blue_mask_size;
442 mbi->flags |= MULTIBOOT_INFO_FRAMEBUFFER_INFO;
444 #if GRUB_MACHINE_HAS_VBE
445 if (driv_id == GRUB_VIDEO_DRIVER_VBE)
446 return fill_vbe_info (mbi, ptrorig, ptrdest, 0);
449 return GRUB_ERR_NONE;
453 grub_multiboot_make_mbi (grub_uint32_t *target)
455 struct multiboot_info *mbi;
456 struct multiboot_mod_list *modlist;
459 grub_size_t mmap_size;
460 grub_uint8_t *ptrorig;
465 grub_relocator_chunk_t ch;
467 bufsize = grub_multiboot_get_mbi_size ();
469 err = grub_relocator_alloc_chunk_align (grub_multiboot_relocator, &ch,
470 0x10000, 0xa0000 - bufsize,
472 GRUB_RELOCATOR_PREFERENCE_NONE, 0);
475 ptrorig = get_virtual_current_address (ch);
476 ptrdest = get_physical_target_address (ch);
480 mbi = (struct multiboot_info *) ptrorig;
481 ptrorig += sizeof (*mbi);
482 ptrdest += sizeof (*mbi);
483 grub_memset (mbi, 0, sizeof (*mbi));
485 grub_memcpy (ptrorig, cmdline, cmdline_size);
486 mbi->flags |= MULTIBOOT_INFO_CMDLINE;
487 mbi->cmdline = ptrdest;
488 ptrorig += ALIGN_UP (cmdline_size, 4);
489 ptrdest += ALIGN_UP (cmdline_size, 4);
491 grub_memcpy (ptrorig, PACKAGE_STRING, sizeof(PACKAGE_STRING));
492 mbi->flags |= MULTIBOOT_INFO_BOOT_LOADER_NAME;
493 mbi->boot_loader_name = ptrdest;
494 ptrorig += ALIGN_UP (sizeof(PACKAGE_STRING), 4);
495 ptrdest += ALIGN_UP (sizeof(PACKAGE_STRING), 4);
497 #ifdef GRUB_MACHINE_PCBIOS
499 struct grub_apm_info info;
500 if (grub_apm_get_info (&info))
502 struct multiboot_apm_info *mbinfo = (void *) ptrorig;
504 mbinfo->cseg = info.cseg;
505 mbinfo->offset = info.offset;
506 mbinfo->cseg_16 = info.cseg_16;
507 mbinfo->dseg = info.dseg;
508 mbinfo->flags = info.flags;
509 mbinfo->cseg_len = info.cseg_len;
510 mbinfo->dseg_len = info.dseg_len;
511 mbinfo->cseg_16_len = info.cseg_16_len;
512 mbinfo->version = info.version;
514 ptrorig += ALIGN_UP (sizeof (struct multiboot_apm_info), 4);
515 ptrdest += ALIGN_UP (sizeof (struct multiboot_apm_info), 4);
522 mbi->flags |= MULTIBOOT_INFO_MODS;
523 mbi->mods_addr = ptrdest;
524 mbi->mods_count = modcnt;
525 modlist = (struct multiboot_mod_list *) ptrorig;
526 ptrorig += modcnt * sizeof (struct multiboot_mod_list);
527 ptrdest += modcnt * sizeof (struct multiboot_mod_list);
529 for (i = 0, cur = modules; i < modcnt; i++, cur = cur->next)
531 modlist[i].mod_start = cur->start;
532 modlist[i].mod_end = modlist[i].mod_start + cur->size;
533 modlist[i].cmdline = ptrdest;
534 grub_memcpy (ptrorig, cur->cmdline, cur->cmdline_size);
535 ptrorig += ALIGN_UP (cur->cmdline_size, 4);
536 ptrdest += ALIGN_UP (cur->cmdline_size, 4);
545 mmap_size = grub_multiboot_get_mmap_count ()
546 * sizeof (struct multiboot_mmap_entry);
547 grub_fill_multiboot_mmap ((struct multiboot_mmap_entry *) ptrorig);
548 mbi->mmap_length = mmap_size;
549 mbi->mmap_addr = ptrdest;
550 mbi->flags |= MULTIBOOT_INFO_MEM_MAP;
551 ptrorig += mmap_size;
552 ptrdest += mmap_size;
554 /* Convert from bytes to kilobytes. */
555 mbi->mem_lower = grub_mmap_get_lower () / 1024;
556 mbi->mem_upper = grub_mmap_get_upper () / 1024;
557 mbi->flags |= MULTIBOOT_INFO_MEMORY;
561 mbi->boot_device = bootdev;
562 mbi->flags |= MULTIBOOT_INFO_BOOTDEV;
566 struct grub_net_network_level_interface *net;
567 FOR_NET_NETWORK_LEVEL_INTERFACES(net)
570 grub_memcpy (ptrorig, net->dhcp_ack, net->dhcp_acklen);
571 mbi->drives_addr = ptrdest;
572 mbi->drives_length = net->dhcp_acklen;
573 ptrorig += net->dhcp_acklen;
574 ptrdest += net->dhcp_acklen;
581 mbi->u.elf_sec.addr = ptrdest;
582 grub_memcpy (ptrorig, elf_sections, elf_sec_entsize * elf_sec_num);
583 mbi->u.elf_sec.num = elf_sec_num;
584 mbi->u.elf_sec.size = elf_sec_entsize;
585 mbi->u.elf_sec.shndx = elf_sec_shstrndx;
587 mbi->flags |= MULTIBOOT_INFO_ELF_SHDR;
589 ptrorig += elf_sec_entsize * elf_sec_num;
590 ptrdest += elf_sec_entsize * elf_sec_num;
593 err = retrieve_video_parameters (mbi, ptrorig, ptrdest);
597 grub_errno = GRUB_ERR_NONE;
600 if ((mbi->flags & MULTIBOOT_INFO_FRAMEBUFFER_INFO)
601 && mbi->framebuffer_type == MULTIBOOT_FRAMEBUFFER_TYPE_INDEXED)
603 ptrorig += mbi->framebuffer_palette_num_colors
604 * sizeof (struct multiboot_color);
605 ptrdest += mbi->framebuffer_palette_num_colors
606 * sizeof (struct multiboot_color);
609 #if GRUB_MACHINE_HAS_VBE
610 ptrorig += sizeof (struct grub_vbe_info_block);
611 ptrdest += sizeof (struct grub_vbe_info_block);
612 ptrorig += sizeof (struct grub_vbe_mode_info_block);
613 ptrdest += sizeof (struct grub_vbe_mode_info_block);
616 #ifdef GRUB_MACHINE_EFI
617 err = grub_efi_finish_boot_services (NULL, NULL, NULL, NULL, NULL);
622 return GRUB_ERR_NONE;
626 grub_multiboot_add_elfsyms (grub_size_t num, grub_size_t entsize,
627 unsigned shndx, void *data)
630 elf_sec_shstrndx = shndx;
631 elf_sec_entsize = entsize;
636 grub_multiboot_free_mbi (void)
638 struct module *cur, *next;
647 for (cur = modules; cur; cur = next)
650 grub_free (cur->cmdline);
656 grub_free (elf_sections);
663 grub_multiboot_init_mbi (int argc, char *argv[])
665 grub_ssize_t len = 0;
667 grub_multiboot_free_mbi ();
669 len = grub_loader_cmdline_size (argc, argv);
671 cmdline = grub_malloc (len);
676 grub_create_loader_cmdline (argc, argv, cmdline,
679 return GRUB_ERR_NONE;
683 grub_multiboot_add_module (grub_addr_t start, grub_size_t size,
684 int argc, char *argv[])
686 struct module *newmod;
689 newmod = grub_malloc (sizeof (*newmod));
692 newmod->start = start;
696 len = grub_loader_cmdline_size (argc, argv);
698 newmod->cmdline = grub_malloc (len);
699 if (! newmod->cmdline)
704 newmod->cmdline_size = len;
705 total_modcmd += ALIGN_UP (len, 4);
707 grub_create_loader_cmdline (argc, argv, newmod->cmdline,
708 newmod->cmdline_size);
711 modules_last->next = newmod;
714 modules_last = newmod;
718 return GRUB_ERR_NONE;
722 grub_multiboot_set_bootdev (void)
724 grub_uint32_t biosdev, slice = ~0, part = ~0;
727 #ifdef GRUB_MACHINE_PCBIOS
728 biosdev = grub_get_root_biosnumber ();
730 biosdev = 0xffffffff;
733 if (biosdev == 0xffffffff)
736 dev = grub_device_open (0);
737 if (dev && dev->disk && dev->disk->partition)
739 if (dev->disk->partition->parent)
741 part = dev->disk->partition->number;
742 slice = dev->disk->partition->parent->number;
745 slice = dev->disk->partition->number;
748 grub_device_close (dev);
750 bootdev = ((biosdev & 0xff) << 24) | ((slice & 0xff) << 16)
751 | ((part & 0xff) << 8) | 0xff;