src/boot.c

   1 // Code to load disk image and start system boot.
   2 //
   3 // Copyright (C) 2008  Kevin O'Connor <kevin@koconnor.net>
   4 // Copyright (C) 2002  MandrakeSoft S.A.
   5 //
   6 // This file may be distributed under the terms of the GNU LGPLv3 license.
   7
   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" // struct ipl_s
  14 #include "cmos.h" // inb_cmos
  15 #include "paravirt.h"
  16
  17 struct ipl_s IPL;
  18
  19
  20 /****************************************************************
  21  * IPL and BCV handlers
  22  ****************************************************************/
  23
  24 void
  25 boot_setup(void)
  26 {
  27     if (! CONFIG_BOOT)
  28         return;
  29     dprintf(3, "init boot device ordering\n");
  30
  31     memset(&IPL, 0, sizeof(IPL));
  32
  33     // Floppy drive
  34     struct ipl_entry_s *ie = &IPL.bev[0];
  35     ie->type = IPL_TYPE_FLOPPY;
  36     ie->description = "Floppy";
  37     ie++;
  38
  39     // First HDD
  40     ie->type = IPL_TYPE_HARDDISK;
  41     ie->description = "Hard Disk";
  42     ie++;
  43
  44     // CDROM
  45     if (CONFIG_CDROM_BOOT) {
  46         ie->type = IPL_TYPE_CDROM;
  47         ie->description = "CD-Rom";
  48         ie++;
  49     }
  50
  51     if (CONFIG_COREBOOT && CONFIG_COREBOOT_FLASH) {
  52         ie->type = IPL_TYPE_CBFS;
  53         ie->description = "CBFS";
  54         ie++;
  55     }
  56
  57     IPL.bevcount = ie - IPL.bev;
  58     SET_EBDA(boot_sequence, 0xffff);
  59     if (CONFIG_COREBOOT) {
  60         // XXX - hardcode defaults for coreboot.
  61         IPL.bootorder = 0x87654231;
  62         IPL.checkfloppysig = 1;
  63     } else {
  64         // On emulators, get boot order from nvram.
  65         IPL.bootorder = (inb_cmos(CMOS_BIOS_BOOTFLAG2)
  66                          | ((inb_cmos(CMOS_BIOS_BOOTFLAG1) & 0xf0) << 4));
  67         if (!(inb_cmos(CMOS_BIOS_BOOTFLAG1) & 1))
  68             IPL.checkfloppysig = 1;
  69     }
  70 }
  71
  72 // Add a BEV vector for a given pnp compatible option rom.
  73 void
  74 add_bev(u16 seg, u16 bev, u16 desc)
  75 {
  76     if (! CONFIG_BOOT)
  77         return;
  78     if (IPL.bevcount >= ARRAY_SIZE(IPL.bev))
  79         return;
  80
  81     struct ipl_entry_s *ie = &IPL.bev[IPL.bevcount++];
  82     ie->type = IPL_TYPE_BEV;
  83     ie->vector = (seg << 16) | bev;
  84     const char *d = "Unknown";
  85     if (desc)
  86         d = MAKE_FLATPTR(seg, desc);
  87     ie->description = d;
  88 }
  89
  90 // Add a bcv entry for an expansion card harddrive or legacy option rom
  91 void
  92 add_bcv(u16 seg, u16 ip, u16 desc)
  93 {
  94     if (! CONFIG_BOOT)
  95         return;
  96     if (IPL.bcvcount >= ARRAY_SIZE(IPL.bcv))
  97         return;
  98
  99     struct ipl_entry_s *ie = &IPL.bcv[IPL.bcvcount++];
 100     ie->type = BCV_TYPE_EXTERNAL;
 101     ie->vector = (seg << 16) | ip;
 102     const char *d = "Legacy option rom";
 103     if (desc)
 104         d = MAKE_FLATPTR(seg, desc);
 105     ie->description = d;
 106 }
 107
 108 // Add a bcv entry for an internal harddrive
 109 void
 110 add_bcv_internal(struct drive_s *drive_g)
 111 {
 112     if (! CONFIG_BOOT)
 113         return;
 114     if (IPL.bcvcount >= ARRAY_SIZE(IPL.bcv))
 115         return;
 116
 117     struct ipl_entry_s *ie = &IPL.bcv[IPL.bcvcount++];
 118     if (CONFIG_THREADS) {
 119         // Add to bcv list with assured drive order.
 120         struct ipl_entry_s *end = ie;
 121         for (;;) {
 122             struct ipl_entry_s *prev = ie - 1;
 123             if (prev < IPL.bcv || prev->type != BCV_TYPE_INTERNAL)
 124                 break;
 125             struct drive_s *prevdrive = (void*)prev->vector;
 126             if (prevdrive->type < drive_g->type
 127                 || (prevdrive->type == drive_g->type
 128                     && prevdrive->cntl_id < drive_g->cntl_id))
 129                 break;
 130             ie--;
 131         }
 132         if (ie != end)
 133             memmove(ie+1, ie, (void*)end-(void*)ie);
 134     }
 135     ie->type = BCV_TYPE_INTERNAL;
 136     ie->vector = (u32)drive_g;
 137     ie->description = "";
 138 }
 139
 140
 141 /****************************************************************
 142  * Boot menu and BCV execution
 143  ****************************************************************/
 144
 145 // Show a generic menu item
 146 static int
 147 menu_show_default(struct ipl_entry_s *ie, int menupos)
 148 {
 149     char desc[33];
 150     printf("%d. %s\n", menupos
 151            , strtcpy(desc, ie->description, ARRAY_SIZE(desc)));
 152     return 1;
 153 }
 154
 155 // Show floppy menu item - but only if there exists a floppy drive.
 156 static int
 157 menu_show_floppy(struct ipl_entry_s *ie, int menupos)
 158 {
 159     int i;
 160     for (i = 0; i < Drives.floppycount; i++) {
 161         struct drive_s *drive_g = getDrive(EXTTYPE_FLOPPY, i);
 162         printf("%d. Floppy [%s]\n", menupos + i, drive_g->desc);
 163     }
 164     return Drives.floppycount;
 165 }
 166
 167 // Show menu items from BCV list.
 168 static int
 169 menu_show_harddisk(struct ipl_entry_s *ie, int menupos)
 170 {
 171     int i;
 172     for (i = 0; i < IPL.bcvcount; i++) {
 173         struct ipl_entry_s *ie = &IPL.bcv[i];
 174         struct drive_s *drive_g = (void*)ie->vector;
 175         switch (ie->type) {
 176         case BCV_TYPE_INTERNAL:
 177             printf("%d. %s\n", menupos + i, drive_g->desc);
 178             break;
 179         default:
 180             menu_show_default(ie, menupos+i);
 181             break;
 182         }
 183     }
 184     return IPL.bcvcount;
 185 }
 186
 187 // Show cdrom menu item - but only if there exists a cdrom drive.
 188 static int
 189 menu_show_cdrom(struct ipl_entry_s *ie, int menupos)
 190 {
 191     int i;
 192     for (i = 0; i < Drives.cdcount; i++) {
 193         struct drive_s *drive_g = getDrive(EXTTYPE_CD, i);
 194         printf("%d. CD-Rom [%s]\n", menupos + i, drive_g->desc);
 195     }
 196     return Drives.cdcount;
 197 }
 198
 199 // Show coreboot-fs menu item.
 200 static int
 201 menu_show_cbfs(struct ipl_entry_s *ie, int menupos)
 202 {
 203     int count = 0;
 204     struct cbfs_file *file = NULL;
 205     for (;;) {
 206         file = cbfs_findprefix("img/", file);
 207         if (!file)
 208             break;
 209         const char *filename = cbfs_filename(file);
 210         printf("%d. Payload [%s]\n", menupos + count, &filename[4]);
 211         count++;
 212         if (count > 8)
 213             break;
 214     }
 215     return count;
 216 }
 217
 218 // Show IPL option menu.
 219 static void
 220 interactive_bootmenu(void)
 221 {
 222     if (! CONFIG_BOOTMENU || ! qemu_cfg_show_boot_menu())
 223         return;
 224
 225     while (get_keystroke(0) >= 0)
 226         ;
 227
 228     printf("Press F12 for boot menu.\n\n");
 229
 230     int scan_code = get_keystroke(CONFIG_BOOTMENU_WAIT);
 231     if (scan_code != 0x86)
 232         /* not F12 */
 233         return;
 234
 235     while (get_keystroke(0) >= 0)
 236         ;
 237
 238     printf("Select boot device:\n\n");
 239
 240     int subcount[ARRAY_SIZE(IPL.bev)];
 241     int menupos = 1;
 242     int i;
 243     for (i = 0; i < IPL.bevcount; i++) {
 244         struct ipl_entry_s *ie = &IPL.bev[i];
 245         int sc;
 246         switch (ie->type) {
 247         case IPL_TYPE_FLOPPY:
 248             sc = menu_show_floppy(ie, menupos);
 249             break;
 250         case IPL_TYPE_HARDDISK:
 251             sc = menu_show_harddisk(ie, menupos);
 252             break;
 253         case IPL_TYPE_CDROM:
 254             sc = menu_show_cdrom(ie, menupos);
 255             break;
 256         case IPL_TYPE_CBFS:
 257             sc = menu_show_cbfs(ie, menupos);
 258             break;
 259         default:
 260             sc = menu_show_default(ie, menupos);
 261             break;
 262         }
 263         subcount[i] = sc;
 264         menupos += sc;
 265     }
 266
 267     for (;;) {
 268         scan_code = get_keystroke(1000);
 269         if (scan_code == 0x01)
 270             // ESC
 271             break;
 272         if (scan_code < 1 || scan_code > menupos)
 273             continue;
 274         int choice = scan_code - 1;
 275
 276         // Find out which IPL this was for.
 277         int bev = 0;
 278         while (choice > subcount[bev]) {
 279             choice -= subcount[bev];
 280             bev++;
 281         }
 282         IPL.bev[bev].subchoice = choice-1;
 283
 284         // Add user choice to the boot order.
 285         IPL.bootorder = (IPL.bootorder << 4) | (bev+1);
 286         break;
 287     }
 288     printf("\n");
 289 }
 290
 291 // Run the specified bcv.
 292 static void
 293 run_bcv(struct ipl_entry_s *ie)
 294 {
 295     switch (ie->type) {
 296     case BCV_TYPE_INTERNAL:
 297         map_hd_drive((void*)ie->vector);
 298         break;
 299     case BCV_TYPE_EXTERNAL:
 300         call_bcv(ie->vector >> 16, ie->vector & 0xffff);
 301         break;
 302     }
 303 }
 304
 305 // Prepare for boot - show menu and run bcvs.
 306 void
 307 boot_prep(void)
 308 {
 309     if (! CONFIG_BOOT)
 310         return;
 311
 312     // XXX - show available drives?
 313
 314     // Allow user to modify BCV/IPL order.
 315     interactive_bootmenu();
 316
 317     // Setup floppy boot order
 318     int override = IPL.bev[0].subchoice;
 319     struct drive_s *tmp = Drives.idmap[EXTTYPE_FLOPPY][0];
 320     Drives.idmap[EXTTYPE_FLOPPY][0] = Drives.idmap[EXTTYPE_FLOPPY][override];
 321     Drives.idmap[EXTTYPE_FLOPPY][override] = tmp;
 322
 323     // Run BCVs
 324     override = IPL.bev[1].subchoice;
 325     if (override < IPL.bcvcount)
 326         run_bcv(&IPL.bcv[override]);
 327     int i;
 328     for (i=0; i<IPL.bcvcount; i++)
 329         if (i != override)
 330             run_bcv(&IPL.bcv[i]);
 331 }
 332
 333
 334 /****************************************************************
 335  * Boot code (int 18/19)
 336  ****************************************************************/
 337
 338 // Jump to a bootup entry point.
 339 static void
 340 call_boot_entry(u16 bootseg, u16 bootip, u8 bootdrv)
 341 {
 342     dprintf(1, "Booting from %04x:%04x\n", bootseg, bootip);
 343
 344     struct bregs br;
 345     memset(&br, 0, sizeof(br));
 346     br.flags = F_IF;
 347     br.code = SEGOFF(bootseg, bootip);
 348     // Set the magic number in ax and the boot drive in dl.
 349     br.dl = bootdrv;
 350     br.ax = 0xaa55;
 351     call16(&br);
 352 }
 353
 354 // Boot from a disk (either floppy or harddrive)
 355 static void
 356 boot_disk(u8 bootdrv, int checksig)
 357 {
 358     u16 bootseg = 0x07c0;
 359
 360     // Read sector
 361     struct bregs br;
 362     memset(&br, 0, sizeof(br));
 363     br.flags = F_IF;
 364     br.dl = bootdrv;
 365     br.es = bootseg;
 366     br.ah = 2;
 367     br.al = 1;
 368     br.cl = 1;
 369     call16_int(0x13, &br);
 370
 371     if (br.flags & F_CF) {
 372         printf("Boot failed: could not read the boot disk\n\n");
 373         return;
 374     }
 375
 376     if (checksig) {
 377         struct mbr_s *mbr = (void*)0;
 378         if (GET_FARVAR(bootseg, mbr->signature) != MBR_SIGNATURE) {
 379             printf("Boot failed: not a bootable disk\n\n");
 380             return;
 381         }
 382     }
 383
 384     /* Canonicalize bootseg:bootip */
 385     u16 bootip = (bootseg & 0x0fff) << 4;
 386     bootseg &= 0xf000;
 387
 388     call_boot_entry(bootseg, bootip, bootdrv);
 389 }
 390
 391 // Boot from a CD-ROM
 392 static void
 393 boot_cdrom(struct ipl_entry_s *ie)
 394 {
 395     if (! CONFIG_CDROM_BOOT)
 396         return;
 397     int status = cdrom_boot(ie->subchoice);
 398     if (status) {
 399         printf("Boot failed: Could not read from CDROM (code %04x)\n", status);
 400         return;
 401     }
 402
 403     u16 ebda_seg = get_ebda_seg();
 404     u8 bootdrv = GET_EBDA2(ebda_seg, cdemu.emulated_extdrive);
 405     u16 bootseg = GET_EBDA2(ebda_seg, cdemu.load_segment);
 406     /* Canonicalize bootseg:bootip */
 407     u16 bootip = (bootseg & 0x0fff) << 4;
 408     bootseg &= 0xf000;
 409
 410     call_boot_entry(bootseg, bootip, bootdrv);
 411 }
 412
 413 // Boot from a CBFS payload
 414 static void
 415 boot_cbfs(struct ipl_entry_s *ie)
 416 {
 417     if (!CONFIG_COREBOOT || !CONFIG_COREBOOT_FLASH)
 418         return;
 419     int count = ie->subchoice;
 420     struct cbfs_file *file = NULL;
 421     for (;;) {
 422         file = cbfs_findprefix("img/", file);
 423         if (!file)
 424             return;
 425         if (count--)
 426             continue;
 427         cbfs_run_payload(file);
 428     }
 429 }
 430
 431 static void
 432 do_boot(u16 seq_nr)
 433 {
 434     if (! CONFIG_BOOT)
 435         panic("Boot support not compiled in.\n");
 436
 437     u32 bootdev = IPL.bootorder;
 438     bootdev >>= 4 * seq_nr;
 439     bootdev &= 0xf;
 440
 441     /* Translate bootdev to an IPL table offset by subtracting 1 */
 442     bootdev -= 1;
 443
 444     if (bootdev >= IPL.bevcount) {
 445         printf("No bootable device.\n");
 446         // Loop with irqs enabled - this allows ctrl+alt+delete to work.
 447         for (;;)
 448             biosusleep(1000000);
 449     }
 450
 451     /* Do the loading, and set up vector as a far pointer to the boot
 452      * address, and bootdrv as the boot drive */
 453     struct ipl_entry_s *ie = &IPL.bev[bootdev];
 454     char desc[33];
 455     printf("Booting from %s...\n"
 456            , strtcpy(desc, ie->description, ARRAY_SIZE(desc)));
 457
 458     switch(ie->type) {
 459     case IPL_TYPE_FLOPPY:
 460         boot_disk(0x00, IPL.checkfloppysig);
 461         break;
 462     case IPL_TYPE_HARDDISK:
 463         boot_disk(0x80, 1);
 464         break;
 465     case IPL_TYPE_CDROM:
 466         boot_cdrom(ie);
 467         break;
 468     case IPL_TYPE_CBFS:
 469         boot_cbfs(ie);
 470         break;
 471     case IPL_TYPE_BEV:
 472         call_boot_entry(ie->vector >> 16, ie->vector & 0xffff, 0);
 473         break;
 474     }
 475
 476     // Boot failed: invoke the boot recovery function
 477     struct bregs br;
 478     memset(&br, 0, sizeof(br));
 479     br.flags = F_IF;
 480     call16_int(0x18, &br);
 481 }
 482
 483 // Boot Failure recovery: try the next device.
 484 void VISIBLE32FLAT
 485 handle_18(void)
 486 {
 487     debug_serial_setup();
 488     debug_enter(NULL, DEBUG_HDL_18);
 489     u16 ebda_seg = get_ebda_seg();
 490     u16 seq = GET_EBDA2(ebda_seg, boot_sequence) + 1;
 491     SET_EBDA2(ebda_seg, boot_sequence, seq);
 492     do_boot(seq);
 493 }
 494
 495 // INT 19h Boot Load Service Entry Point
 496 void VISIBLE32FLAT
 497 handle_19(void)
 498 {
 499     debug_serial_setup();
 500     debug_enter(NULL, DEBUG_HDL_19);
 501     SET_EBDA(boot_sequence, 0);
 502     do_boot(0);
 503 }