1 // Code to load disk image and start system boot.
3 // Copyright (C) 2008-2010 Kevin O'Connor <kevin@koconnor.net>
4 // Copyright (C) 2002 MandrakeSoft S.A.
6 // This file may be distributed under the terms of the GNU LGPLv3 license.
8 #include "util.h" // dprintf
9 #include "biosvar.h" // GET_EBDA
10 #include "config.h" // CONFIG_*
11 #include "disk.h" // cdrom_boot
12 #include "bregs.h" // struct bregs
13 #include "boot.h" // func defs
14 #include "cmos.h" // inb_cmos
15 #include "paravirt.h" // romfile_loadfile
16 #include "pci.h" //pci_bdf_to_*
19 /****************************************************************
20 * Boot priority ordering
21 ****************************************************************/
23 static char **Bootorder;
24 static int BootorderCount;
29 if (!CONFIG_BOOTORDER)
32 char *f = romfile_loadfile("bootorder", NULL);
43 Bootorder = malloc_tmphigh(BootorderCount*sizeof(char*));
51 dprintf(3, "boot order:\n");
58 nullTrailingSpace(Bootorder[i]);
59 dprintf(3, "%d: %s\n", i+1, Bootorder[i]);
64 // See if 'str' starts with 'glob' - if glob contains an '*' character
65 // it will match any number of characters in str that aren't a '/' or
66 // the next glob character.
68 glob_prefix(const char *glob, const char *str)
71 if (!*glob && (!*str || *str == '/'))
74 if (!*str || *str == '/' || *str == glob[1])
87 // Search the bootorder list for the given glob pattern.
89 find_prio(const char *glob)
91 dprintf(1, "Searching bootorder for: %s\n", glob);
93 for (i = 0; i < BootorderCount; i++)
94 if (glob_prefix(glob, Bootorder[i]))
99 #define FW_PCI_DOMAIN "/pci@i0cf8"
101 static struct pci_device *
104 struct pci_device *pci;
113 build_pci_path(char *buf, int max, const char *devname, struct pci_device *pci)
117 // Build the string path of a bdf - for example: /pci@i0cf8/isa@1,2
120 p = build_pci_path(p, max, "pci-bridge", pci->parent);
123 p += snprintf(p, max, "/pci-root@%x", pci->rootbus);
124 p += snprintf(p, buf+max-p, "%s", FW_PCI_DOMAIN);
127 int dev = pci_bdf_to_dev(pci->bdf), fn = pci_bdf_to_fn(pci->bdf);
128 p += snprintf(p, buf+max-p, "/%s@%x", devname, dev);
130 p += snprintf(p, buf+max-p, ",%x", fn);
134 int bootprio_find_pci_device(struct pci_device *pci)
136 if (!CONFIG_BOOTORDER)
138 // Find pci device - for example: /pci@i0cf8/ethernet@5
140 build_pci_path(desc, sizeof(desc), "*", pci);
141 return find_prio(desc);
144 int bootprio_find_ata_device(int bdf, int chanid, int slave)
146 if (!CONFIG_BOOTORDER)
149 // support only pci machine for now
151 // Find ata drive - for example: /pci@i0cf8/ide@1,1/drive@1/disk@0
153 p = build_pci_path(desc, sizeof(desc), "*", find_pci(bdf));
154 snprintf(p, desc+sizeof(desc)-p, "/drive@%x/disk@%x", chanid, slave);
155 return find_prio(desc);
158 int bootprio_find_fdc_device(int bdf, int port, int fdid)
160 if (!CONFIG_BOOTORDER)
163 // support only pci machine for now
165 // Find floppy - for example: /pci@i0cf8/isa@1/fdc@03f1/floppy@0
167 p = build_pci_path(desc, sizeof(desc), "isa", find_pci(bdf));
168 snprintf(p, desc+sizeof(desc)-p, "/fdc@%04x/floppy@%x", port, fdid);
169 return find_prio(desc);
172 int bootprio_find_pci_rom(int bdf, int instance)
174 if (!CONFIG_BOOTORDER)
176 // Find pci rom - for example: /pci@i0cf8/scsi@3:rom2
178 p = build_pci_path(desc, sizeof(desc), "*", find_pci(bdf));
180 snprintf(p, desc+sizeof(desc)-p, ":rom%d", instance);
181 return find_prio(desc);
184 int bootprio_find_named_rom(const char *name, int instance)
186 if (!CONFIG_BOOTORDER)
188 // Find named rom - for example: /rom@genroms/linuxboot.bin
190 p = desc + snprintf(desc, sizeof(desc), "/rom@%s", name);
192 snprintf(p, desc+sizeof(desc)-p, ":rom%d", instance);
193 return find_prio(desc);
196 int bootprio_find_usb(struct pci_device *pci, u64 path)
198 if (!CONFIG_BOOTORDER)
200 // Find usb - for example: /pci@i0cf8/usb@1,2/hub@1/network@0/ethernet@0
203 p = build_pci_path(desc, sizeof(desc), "usb", pci);
204 for (i=56; i>0; i-=8) {
205 int port = (path >> i) & 0xff;
207 p += snprintf(p, desc+sizeof(desc)-p, "/hub@%x", port);
209 snprintf(p, desc+sizeof(desc)-p, "/*@%x", (u32)(path & 0xff));
210 return find_prio(desc);
214 /****************************************************************
216 ****************************************************************/
218 static int CheckFloppySig = 1;
220 #define DEFAULT_PRIO 9999
222 static int DefaultFloppyPrio = 101;
223 static int DefaultCDPrio = 102;
224 static int DefaultHDPrio = 103;
225 static int DefaultBEVPrio = 104;
233 SET_EBDA(boot_sequence, 0xffff);
235 if (!CONFIG_COREBOOT) {
236 // On emulators, get boot order from nvram.
237 if (inb_cmos(CMOS_BIOS_BOOTFLAG1) & 1)
239 u32 bootorder = (inb_cmos(CMOS_BIOS_BOOTFLAG2)
240 | ((inb_cmos(CMOS_BIOS_BOOTFLAG1) & 0xf0) << 4));
241 DefaultFloppyPrio = DefaultCDPrio = DefaultHDPrio
242 = DefaultBEVPrio = DEFAULT_PRIO;
244 for (i=101; i<104; i++) {
245 u32 val = bootorder & 0x0f;
248 case 1: DefaultFloppyPrio = i; break;
249 case 2: DefaultHDPrio = i; break;
250 case 3: DefaultCDPrio = i; break;
251 case 4: DefaultBEVPrio = i; break;
260 /****************************************************************
262 ****************************************************************/
268 struct segoff_s vector;
269 struct drive_s *drive;
272 const char *description;
273 struct bootentry_s *next;
275 static struct bootentry_s *BootList;
277 #define IPL_TYPE_FLOPPY 0x01
278 #define IPL_TYPE_HARDDISK 0x02
279 #define IPL_TYPE_CDROM 0x03
280 #define IPL_TYPE_CBFS 0x20
281 #define IPL_TYPE_BEV 0x80
282 #define IPL_TYPE_BCV 0x81
285 bootentry_add(int type, int prio, u32 data, const char *desc)
289 struct bootentry_s *be = malloc_tmp(sizeof(*be));
297 be->description = desc ?: "?";
298 dprintf(3, "Registering bootable: %s (type:%d prio:%d data:%x)\n"
299 , be->description, type, prio, data);
301 // Add entry in sorted order.
302 struct bootentry_s **pprev;
303 for (pprev = &BootList; *pprev; pprev = &(*pprev)->next) {
304 struct bootentry_s *pos = *pprev;
305 if (be->priority < pos->priority)
307 if (be->priority > pos->priority)
309 if (be->type < pos->type)
311 if (be->type > pos->type)
313 if (be->type <= IPL_TYPE_CDROM
314 && (be->drive->type < pos->drive->type
315 || (be->drive->type == pos->drive->type
316 && be->drive->cntl_id < pos->drive->cntl_id)))
323 // Return the given priority if it's set - defaultprio otherwise.
324 static inline int defPrio(int priority, int defaultprio) {
325 return (priority < 0) ? defaultprio : priority;
328 // Add a BEV vector for a given pnp compatible option rom.
330 boot_add_bev(u16 seg, u16 bev, u16 desc, int prio)
332 bootentry_add(IPL_TYPE_BEV, defPrio(prio, DefaultBEVPrio)
333 , SEGOFF(seg, bev).segoff
334 , desc ? MAKE_FLATPTR(seg, desc) : "Unknown");
335 DefaultBEVPrio = DEFAULT_PRIO;
338 // Add a bcv entry for an expansion card harddrive or legacy option rom
340 boot_add_bcv(u16 seg, u16 ip, u16 desc, int prio)
342 bootentry_add(IPL_TYPE_BCV, defPrio(prio, DEFAULT_PRIO)
343 , SEGOFF(seg, ip).segoff
344 , desc ? MAKE_FLATPTR(seg, desc) : "Legacy option rom");
348 boot_add_floppy(struct drive_s *drive_g, const char *desc, int prio)
350 bootentry_add(IPL_TYPE_FLOPPY, defPrio(prio, DefaultFloppyPrio)
351 , (u32)drive_g, desc);
355 boot_add_hd(struct drive_s *drive_g, const char *desc, int prio)
357 bootentry_add(IPL_TYPE_HARDDISK, defPrio(prio, DefaultHDPrio)
358 , (u32)drive_g, desc);
362 boot_add_cd(struct drive_s *drive_g, const char *desc, int prio)
364 bootentry_add(IPL_TYPE_CDROM, defPrio(prio, DefaultCDPrio)
365 , (u32)drive_g, desc);
368 // Add a CBFS payload entry
370 boot_add_cbfs(void *data, const char *desc, int prio)
372 bootentry_add(IPL_TYPE_CBFS, defPrio(prio, DEFAULT_PRIO), (u32)data, desc);
376 /****************************************************************
377 * Boot menu and BCV execution
378 ****************************************************************/
380 #define DEFAULT_BOOTMENU_WAIT 2500
382 // Show IPL option menu.
384 interactive_bootmenu(void)
386 if (! CONFIG_BOOTMENU || ! qemu_cfg_show_boot_menu())
389 while (get_keystroke(0) >= 0)
392 printf("Press F12 for boot menu.\n\n");
394 u32 menutime = romfile_loadint("etc/boot-menu-wait", DEFAULT_BOOTMENU_WAIT);
396 int scan_code = get_keystroke(menutime);
397 disable_bootsplash();
398 if (scan_code != 0x86)
402 while (get_keystroke(0) >= 0)
405 printf("Select boot device:\n\n");
409 struct bootentry_s *pos = BootList;
414 printf("%d. %s\n", maxmenu
415 , strtcpy(desc, pos->description, ARRAY_SIZE(desc)));
421 scan_code = get_keystroke(1000);
422 if (scan_code >= 1 && scan_code <= maxmenu+1)
426 if (scan_code == 0x01)
430 // Find entry and make top priority.
431 int choice = scan_code - 1;
432 struct bootentry_s **pprev = &BootList;
434 pprev = &(*pprev)->next;
437 pos->next = BootList;
442 // BEV (Boot Execution Vector) list
447 static struct bev_s BEV[20];
449 static int HaveHDBoot, HaveFDBoot;
452 add_bev(int type, u32 vector)
454 if (type == IPL_TYPE_HARDDISK && HaveHDBoot++)
456 if (type == IPL_TYPE_FLOPPY && HaveFDBoot++)
458 if (BEVCount >= ARRAY_SIZE(BEV))
460 struct bev_s *bev = &BEV[BEVCount++];
462 bev->vector = vector;
465 // Prepare for boot - show menu and run bcvs.
474 // XXX - show available drives?
476 // Allow user to modify BCV/IPL order.
477 interactive_bootmenu();
480 // Map drives and populate BEV list
481 struct bootentry_s *pos = BootList;
485 call_bcv(pos->vector.seg, pos->vector.offset);
486 add_bev(IPL_TYPE_HARDDISK, 0);
488 case IPL_TYPE_FLOPPY:
489 map_floppy_drive(pos->drive);
490 add_bev(IPL_TYPE_FLOPPY, 0);
492 case IPL_TYPE_HARDDISK:
493 map_hd_drive(pos->drive);
494 add_bev(IPL_TYPE_HARDDISK, 0);
497 map_cd_drive(pos->drive);
500 add_bev(pos->type, pos->data);
506 // If nothing added a floppy/hd boot - add it manually.
507 add_bev(IPL_TYPE_FLOPPY, 0);
508 add_bev(IPL_TYPE_HARDDISK, 0);
512 /****************************************************************
513 * Boot code (int 18/19)
514 ****************************************************************/
516 // Jump to a bootup entry point.
518 call_boot_entry(struct segoff_s bootsegip, u8 bootdrv)
520 dprintf(1, "Booting from %04x:%04x\n", bootsegip.seg, bootsegip.offset);
522 memset(&br, 0, sizeof(br));
525 // Set the magic number in ax and the boot drive in dl.
531 // Boot from a disk (either floppy or harddrive)
533 boot_disk(u8 bootdrv, int checksig)
535 u16 bootseg = 0x07c0;
539 memset(&br, 0, sizeof(br));
546 call16_int(0x13, &br);
548 if (br.flags & F_CF) {
549 printf("Boot failed: could not read the boot disk\n\n");
554 struct mbr_s *mbr = (void*)0;
555 if (GET_FARVAR(bootseg, mbr->signature) != MBR_SIGNATURE) {
556 printf("Boot failed: not a bootable disk\n\n");
561 /* Canonicalize bootseg:bootip */
562 u16 bootip = (bootseg & 0x0fff) << 4;
565 call_boot_entry(SEGOFF(bootseg, bootip), bootdrv);
568 // Boot from a CD-ROM
570 boot_cdrom(struct drive_s *drive_g)
572 if (! CONFIG_CDROM_BOOT)
574 printf("Booting from DVD/CD...\n");
576 int status = cdrom_boot(drive_g);
578 printf("Boot failed: Could not read from CDROM (code %04x)\n", status);
582 u16 ebda_seg = get_ebda_seg();
583 u8 bootdrv = GET_EBDA2(ebda_seg, cdemu.emulated_extdrive);
584 u16 bootseg = GET_EBDA2(ebda_seg, cdemu.load_segment);
585 /* Canonicalize bootseg:bootip */
586 u16 bootip = (bootseg & 0x0fff) << 4;
589 call_boot_entry(SEGOFF(bootseg, bootip), bootdrv);
592 // Boot from a CBFS payload
594 boot_cbfs(struct cbfs_file *file)
596 if (!CONFIG_COREBOOT || !CONFIG_COREBOOT_FLASH)
598 printf("Booting from CBFS...\n");
599 cbfs_run_payload(file);
602 // Boot from a BEV entry on an optionrom.
606 printf("Booting from ROM...\n");
609 call_boot_entry(so, 0);
612 // Determine next boot method and attempt a boot using it.
617 panic("Boot support not compiled in.\n");
619 if (seq_nr >= BEVCount) {
620 printf("No bootable device.\n");
621 // Loop with irqs enabled - this allows ctrl+alt+delete to work.
626 // Boot the given BEV type.
627 struct bev_s *ie = &BEV[seq_nr];
629 case IPL_TYPE_FLOPPY:
630 printf("Booting from Floppy...\n");
631 boot_disk(0x00, CheckFloppySig);
633 case IPL_TYPE_HARDDISK:
634 printf("Booting from Hard Disk...\n");
638 boot_cdrom((void*)ie->vector);
641 boot_cbfs((void*)ie->vector);
644 boot_rom(ie->vector);
648 // Boot failed: invoke the boot recovery function
650 memset(&br, 0, sizeof(br));
652 call16_int(0x18, &br);
655 // Boot Failure recovery: try the next device.
659 debug_serial_setup();
660 debug_enter(NULL, DEBUG_HDL_18);
661 u16 ebda_seg = get_ebda_seg();
662 u16 seq = GET_EBDA2(ebda_seg, boot_sequence) + 1;
663 SET_EBDA2(ebda_seg, boot_sequence, seq);
667 // INT 19h Boot Load Service Entry Point
671 debug_serial_setup();
672 debug_enter(NULL, DEBUG_HDL_19);
673 SET_EBDA(boot_sequence, 0);