src/cdrom.c

   1 // 16bit code to access cdrom drives.
   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 "disk.h" // cdrom_13
   9 #include "util.h" // memset
  10 #include "bregs.h" // struct bregs
  11 #include "biosvar.h" // GET_EBDA
  12 #include "atabits.h" // ATA_TYPE_ATAPI
  13
  14
  15 /****************************************************************
  16  * CDROM functions
  17  ****************************************************************/
  18
  19 // read disk drive size
  20 static void
  21 cdrom_1315(struct bregs *regs, u8 device)
  22 {
  23     disk_ret(regs, DISK_RET_EADDRNOTFOUND);
  24 }
  25
  26 // lock
  27 static void
  28 cdrom_134500(struct bregs *regs, u8 device)
  29 {
  30     u16 ebda_seg = get_ebda_seg();
  31     u8 locks = GET_EBDA2(ebda_seg, cdrom_locks[device]);
  32     if (locks == 0xff) {
  33         regs->al = 1;
  34         disk_ret(regs, DISK_RET_ETOOMANYLOCKS);
  35         return;
  36     }
  37     SET_EBDA2(ebda_seg, cdrom_locks[device], locks + 1);
  38     regs->al = 1;
  39     disk_ret(regs, DISK_RET_SUCCESS);
  40 }
  41
  42 // unlock
  43 static void
  44 cdrom_134501(struct bregs *regs, u8 device)
  45 {
  46     u16 ebda_seg = get_ebda_seg();
  47     u8 locks = GET_EBDA2(ebda_seg, cdrom_locks[device]);
  48     if (locks == 0x00) {
  49         regs->al = 0;
  50         disk_ret(regs, DISK_RET_ENOTLOCKED);
  51         return;
  52     }
  53     locks--;
  54     SET_EBDA2(ebda_seg, cdrom_locks[device], locks);
  55     regs->al = (locks ? 1 : 0);
  56     disk_ret(regs, DISK_RET_SUCCESS);
  57 }
  58
  59 // status
  60 static void
  61 cdrom_134502(struct bregs *regs, u8 device)
  62 {
  63     u8 locks = GET_EBDA(cdrom_locks[device]);
  64     regs->al = (locks ? 1 : 0);
  65     disk_ret(regs, DISK_RET_SUCCESS);
  66 }
  67
  68 static void
  69 cdrom_1345XX(struct bregs *regs, u8 device)
  70 {
  71     disk_ret(regs, DISK_RET_EPARAM);
  72 }
  73
  74 // IBM/MS lock/unlock drive
  75 static void
  76 cdrom_1345(struct bregs *regs, u8 device)
  77 {
  78     switch (regs->al) {
  79     case 0x00: cdrom_134500(regs, device); break;
  80     case 0x01: cdrom_134501(regs, device); break;
  81     case 0x02: cdrom_134502(regs, device); break;
  82     default:   cdrom_1345XX(regs, device); break;
  83     }
  84 }
  85
  86 // IBM/MS eject media
  87 static void
  88 cdrom_1346(struct bregs *regs, u8 device)
  89 {
  90     u8 locks = GET_EBDA(cdrom_locks[device]);
  91     if (locks != 0) {
  92         disk_ret(regs, DISK_RET_ELOCKED);
  93         return;
  94     }
  95
  96     // FIXME should handle 0x31 no media in device
  97     // FIXME should handle 0xb5 valid request failed
  98
  99     // Call removable media eject
 100     struct bregs br;
 101     memset(&br, 0, sizeof(br));
 102     br.ah = 0x52;
 103     call16_int(0x15, &br);
 104
 105     if (br.ah || br.flags & F_CF) {
 106         disk_ret(regs, DISK_RET_ELOCKED);
 107         return;
 108     }
 109     disk_ret(regs, DISK_RET_SUCCESS);
 110 }
 111
 112 // IBM/MS extended media change
 113 static void
 114 cdrom_1349(struct bregs *regs, u8 device)
 115 {
 116     set_fail(regs);
 117     // always send changed ??
 118     regs->ah = DISK_RET_ECHANGED;
 119 }
 120
 121 static void
 122 cdrom_ok(struct bregs *regs, u8 device)
 123 {
 124     disk_ret(regs, DISK_RET_SUCCESS);
 125 }
 126
 127 static void
 128 cdrom_wp(struct bregs *regs, u8 device)
 129 {
 130     disk_ret(regs, DISK_RET_EWRITEPROTECT);
 131 }
 132
 133 void
 134 cdrom_13(struct bregs *regs, u8 device)
 135 {
 136     //debug_stub(regs);
 137
 138     switch (regs->ah) {
 139     case 0x15: cdrom_1315(regs, device); break;
 140     case 0x45: cdrom_1345(regs, device); break;
 141     case 0x46: cdrom_1346(regs, device); break;
 142     case 0x49: cdrom_1349(regs, device); break;
 143
 144     // These functions are the same as for hard disks
 145     case 0x01:
 146     case 0x41:
 147     case 0x42:
 148     case 0x44:
 149     case 0x47:
 150     case 0x48:
 151     case 0x4e:
 152         disk_13(regs, device);
 153         break;
 154
 155     // all these functions return SUCCESS
 156     case 0x00: // disk controller reset
 157     case 0x09: // initialize drive parameters
 158     case 0x0c: // seek to specified cylinder
 159     case 0x0d: // alternate disk reset
 160     case 0x10: // check drive ready
 161     case 0x11: // recalibrate
 162     case 0x14: // controller internal diagnostic
 163     case 0x16: // detect disk change
 164         cdrom_ok(regs, device);
 165         break;
 166
 167     // all these functions return disk write-protected
 168     case 0x03: // write disk sectors
 169     case 0x05: // format disk track
 170     case 0x43: // IBM/MS extended write
 171         cdrom_wp(regs, device);
 172         break;
 173
 174     default:   disk_13XX(regs, device); break;
 175     }
 176 }
 177
 178
 179 /****************************************************************
 180  * CD emulation
 181  ****************************************************************/
 182
 183 // read disk drive parameters
 184 static void
 185 cdemu_1308(struct bregs *regs, u8 device)
 186 {
 187     u16 ebda_seg = get_ebda_seg();
 188     u16 nlc   = GET_EBDA2(ebda_seg, cdemu.cylinders) - 1;
 189     u16 nlh   = GET_EBDA2(ebda_seg, cdemu.heads) - 1;
 190     u16 nlspt = GET_EBDA2(ebda_seg, cdemu.spt);
 191
 192     regs->al = 0x00;
 193     regs->bl = 0x00;
 194     regs->ch = nlc & 0xff;
 195     regs->cl = ((nlc >> 2) & 0xc0) | (nlspt  & 0x3f);
 196     regs->dh = nlh;
 197     // FIXME ElTorito Various. should send the real count of drives 1 or 2
 198     // FIXME ElTorito Harddisk. should send the HD count
 199     regs->dl = 0x02;
 200     u8 media = GET_EBDA2(ebda_seg, cdemu.media);
 201     if (media <= 3)
 202         regs->bl = media * 2;
 203
 204     regs->es = SEG_BIOS;
 205     regs->di = (u32)&diskette_param_table2;
 206
 207     disk_ret(regs, DISK_RET_SUCCESS);
 208 }
 209
 210 void
 211 cdemu_13(struct bregs *regs)
 212 {
 213     //debug_stub(regs);
 214
 215     u16 ebda_seg = get_ebda_seg();
 216     u8 device  = GET_EBDA2(ebda_seg, cdemu.controller_index) * 2;
 217     device += GET_EBDA2(ebda_seg, cdemu.device_spec);
 218
 219     switch (regs->ah) {
 220     // These functions are the same as for hard disks
 221     case 0x02:
 222     case 0x04:
 223         disk_13(regs, device);
 224         break;
 225
 226     // These functions are the same as standard CDROM.
 227     case 0x00:
 228     case 0x01:
 229     case 0x03:
 230     case 0x05:
 231     case 0x09:
 232     case 0x0c:
 233     case 0x0d:
 234     case 0x10:
 235     case 0x11:
 236     case 0x14:
 237     case 0x15:
 238     case 0x16:
 239         cdrom_13(regs, device);
 240         break;
 241
 242     case 0x08: cdemu_1308(regs, device); break;
 243
 244     default:   disk_13XX(regs, device); break;
 245     }
 246 }
 247
 248 struct eltorito_s {
 249     u8 size;
 250     u8 media;
 251     u8 emulated_drive;
 252     u8 controller_index;
 253     u32 ilba;
 254     u16 device_spec;
 255     u16 buffer_segment;
 256     u16 load_segment;
 257     u16 sector_count;
 258     u8 cylinders;
 259     u8 sectors;
 260     u8 heads;
 261 };
 262
 263 #define SET_INT13ET(regs,var,val)                                      \
 264     SET_FARVAR((regs)->ds, ((struct eltorito_s*)((regs)->si+0))->var, (val))
 265
 266 // ElTorito - Terminate disk emu
 267 void
 268 cdemu_134b(struct bregs *regs)
 269 {
 270     // FIXME ElTorito Hardcoded
 271     u16 ebda_seg = get_ebda_seg();
 272     SET_INT13ET(regs, size, 0x13);
 273     SET_INT13ET(regs, media, GET_EBDA2(ebda_seg, cdemu.media));
 274     SET_INT13ET(regs, emulated_drive, GET_EBDA2(ebda_seg, cdemu.emulated_drive));
 275     SET_INT13ET(regs, controller_index
 276                 , GET_EBDA2(ebda_seg, cdemu.controller_index));
 277     SET_INT13ET(regs, ilba, GET_EBDA2(ebda_seg, cdemu.ilba));
 278     SET_INT13ET(regs, device_spec, GET_EBDA2(ebda_seg, cdemu.device_spec));
 279     SET_INT13ET(regs, buffer_segment, GET_EBDA2(ebda_seg, cdemu.buffer_segment));
 280     SET_INT13ET(regs, load_segment, GET_EBDA2(ebda_seg, cdemu.load_segment));
 281     SET_INT13ET(regs, sector_count, GET_EBDA2(ebda_seg, cdemu.sector_count));
 282     SET_INT13ET(regs, cylinders, GET_EBDA2(ebda_seg, cdemu.cylinders));
 283     SET_INT13ET(regs, sectors, GET_EBDA2(ebda_seg, cdemu.spt));
 284     SET_INT13ET(regs, heads, GET_EBDA2(ebda_seg, cdemu.heads));
 285
 286     // If we have to terminate emulation
 287     if (regs->al == 0x00) {
 288         // FIXME ElTorito Various. Should be handled accordingly to spec
 289         SET_EBDA2(ebda_seg, cdemu.active, 0x00); // bye bye
 290     }
 291
 292     disk_ret(regs, DISK_RET_SUCCESS);
 293 }
 294
 295
 296 /****************************************************************
 297  * CD booting
 298  ****************************************************************/
 299
 300 // Request SENSE
 301 static int
 302 atapi_get_sense(int device, u8 *asc, u8 *ascq)
 303 {
 304     u8 atacmd[12], buffer[18];
 305     memset(atacmd, 0, sizeof(atacmd));
 306     atacmd[0] = ATA_CMD_REQUEST_SENSE;
 307     atacmd[4] = sizeof(buffer);
 308     int ret = ata_cmd_packet(device, atacmd, sizeof(atacmd), sizeof(buffer)
 309                              , MAKE_FLATPTR(GET_SEG(SS), buffer));
 310     if (ret)
 311         return ret;
 312
 313     *asc = buffer[12];
 314     *ascq = buffer[13];
 315
 316     return 0;
 317 }
 318
 319 // Request capacity
 320 static int
 321 atapi_read_capacity(int device, u32 *blksize, u32 *sectors)
 322 {
 323     u8 packet[12], buf[8];
 324     memset(packet, 0, sizeof(packet));
 325     packet[0] = 0x25; /* READ CAPACITY */
 326     int ret = ata_cmd_packet(device, packet, sizeof(packet), sizeof(buf)
 327                              , MAKE_FLATPTR(GET_SEG(SS), buf));
 328     if (ret)
 329         return ret;
 330
 331     *blksize = (((u32)buf[4] << 24) | ((u32)buf[5] << 16)
 332                 | ((u32)buf[6] << 8) | ((u32)buf[7] << 0));
 333     *sectors = (((u32)buf[0] << 24) | ((u32)buf[1] << 16)
 334                 | ((u32)buf[2] << 8) | ((u32)buf[3] << 0));
 335
 336     return 0;
 337 }
 338
 339 static int
 340 atapi_is_ready(u16 device)
 341 {
 342     dprintf(6, "atapi_is_ready (device=%d)\n", device);
 343
 344     /* Retry READ CAPACITY for 5 seconds unless MEDIUM NOT PRESENT is
 345      * reported by the device.  If the device reports "IN PROGRESS",
 346      * 30 seconds is added. */
 347     u32 blksize, sectors;
 348     int in_progress = 0;
 349     u64 end = calc_future_tsc(5000);
 350     for (;;) {
 351         if (rdtscll() > end) {
 352             dprintf(1, "read capacity failed\n");
 353             return -1;
 354         }
 355
 356         int ret = atapi_read_capacity(device, &blksize, &sectors);
 357         if (!ret)
 358             // Success
 359             break;
 360
 361         u8 asc, ascq;
 362         ret = atapi_get_sense(device, &asc, &ascq);
 363         if (ret)
 364             // Error - retry.
 365             continue;
 366
 367         // Sense succeeded.
 368         if (asc == 0x3a) { /* MEDIUM NOT PRESENT */
 369             dprintf(1, "Device reports MEDIUM NOT PRESENT\n");
 370             return -1;
 371         }
 372
 373         if (asc == 0x04 && ascq == 0x01 && !in_progress) {
 374             /* IN PROGRESS OF BECOMING READY */
 375             printf("Waiting for device to detect medium... ");
 376             /* Allow 30 seconds more */
 377             end = calc_future_tsc(30000);
 378             in_progress = 1;
 379         }
 380     }
 381
 382     if (blksize != GET_GLOBAL(ATA.devices[device].blksize)) {
 383         printf("Unsupported sector size %u\n", blksize);
 384         return -1;
 385     }
 386
 387     dprintf(6, "sectors=%u\n", sectors);
 388     printf("%dMB medium detected\n", sectors>>(20-11));
 389     return 0;
 390 }
 391
 392 // Compare a string on the stack to one in the code segment.
 393 static int
 394 streq_cs(u8 *s1, char *cs_s2)
 395 {
 396     u8 *s2 = (u8*)cs_s2;
 397     for (;;) {
 398         if (*s1 != GET_GLOBAL(*s2))
 399             return 0;
 400         if (! *s1)
 401             return 1;
 402         s1++;
 403         s2++;
 404     }
 405 }
 406
 407 int
 408 cdrom_boot(int cdid)
 409 {
 410     // Verify device is a cdrom.
 411     if (cdid >= ATA.cdcount)
 412         return 1;
 413     int driveid = GET_GLOBAL(ATA.idmap[1][cdid]);
 414     if (GET_GLOBAL(ATA.devices[driveid].device) != ATA_DEVICE_CDROM)
 415         return 2;
 416
 417     int ret = atapi_is_ready(driveid);
 418     if (ret)
 419         dprintf(1, "atapi_is_ready returned %d\n", ret);
 420
 421     // Read the Boot Record Volume Descriptor
 422     u8 buffer[2048];
 423     struct disk_op_s dop;
 424     dop.driveid = driveid;
 425     dop.lba = 0x11;
 426     dop.count = 1;
 427     dop.buf_fl = MAKE_FLATPTR(GET_SEG(SS), buffer);
 428     ret = cdrom_read(&dop);
 429     if (ret)
 430         return 3;
 431
 432     // Validity checks
 433     if (buffer[0])
 434         return 4;
 435     if (!streq_cs(&buffer[1], "CD001\001EL TORITO SPECIFICATION"))
 436         return 5;
 437
 438     // ok, now we calculate the Boot catalog address
 439     u32 lba = *(u32*)&buffer[0x47];
 440
 441     // And we read the Boot Catalog
 442     dop.lba = lba;
 443     ret = cdrom_read(&dop);
 444     if (ret)
 445         return 7;
 446
 447     // Validation entry
 448     if (buffer[0x00] != 0x01)
 449         return 8;   // Header
 450     if (buffer[0x01] != 0x00)
 451         return 9;   // Platform
 452     if (buffer[0x1E] != 0x55)
 453         return 10;  // key 1
 454     if (buffer[0x1F] != 0xAA)
 455         return 10;  // key 2
 456
 457     // Initial/Default Entry
 458     if (buffer[0x20] != 0x88)
 459         return 11; // Bootable
 460
 461     u16 ebda_seg = get_ebda_seg();
 462     u8 media = buffer[0x21];
 463     SET_EBDA2(ebda_seg, cdemu.media, media);
 464
 465     SET_EBDA2(ebda_seg, cdemu.controller_index, driveid/2);
 466     SET_EBDA2(ebda_seg, cdemu.device_spec, driveid%2);
 467
 468     u16 boot_segment = *(u16*)&buffer[0x22];
 469     if (!boot_segment)
 470         boot_segment = 0x07C0;
 471     SET_EBDA2(ebda_seg, cdemu.load_segment, boot_segment);
 472     SET_EBDA2(ebda_seg, cdemu.buffer_segment, 0x0000);
 473
 474     u16 nbsectors = *(u16*)&buffer[0x26];
 475     SET_EBDA2(ebda_seg, cdemu.sector_count, nbsectors);
 476
 477     lba = *(u32*)&buffer[0x28];
 478     SET_EBDA2(ebda_seg, cdemu.ilba, lba);
 479
 480     // And we read the image in memory
 481     dop.lba = lba * 4;
 482     dop.count = nbsectors;
 483     dop.buf_fl = MAKE_FLATPTR(boot_segment, 0);
 484     ret = cdrom_read_512(&dop);
 485     if (ret)
 486         return 12;
 487
 488     if (media == 0) {
 489         // No emulation requested - return success.
 490         SET_EBDA2(ebda_seg, cdemu.emulated_drive, 0xE0 + cdid);
 491         return 0;
 492     }
 493
 494     // Emulation of a floppy/harddisk requested
 495     if (! CONFIG_CDROM_EMU)
 496         return 13;
 497
 498     // Set emulated drive id and increase bios installed hardware
 499     // number of devices
 500     if (media < 4) {
 501         // Floppy emulation
 502         SET_EBDA2(ebda_seg, cdemu.emulated_drive, 0x00);
 503         SETBITS_BDA(equipment_list_flags, 0x41);
 504
 505         switch (media) {
 506         case 0x01:  // 1.2M floppy
 507             SET_EBDA2(ebda_seg, cdemu.spt, 15);
 508             SET_EBDA2(ebda_seg, cdemu.cylinders, 80);
 509             SET_EBDA2(ebda_seg, cdemu.heads, 2);
 510             break;
 511         case 0x02:  // 1.44M floppy
 512             SET_EBDA2(ebda_seg, cdemu.spt, 18);
 513             SET_EBDA2(ebda_seg, cdemu.cylinders, 80);
 514             SET_EBDA2(ebda_seg, cdemu.heads, 2);
 515             break;
 516         case 0x03:  // 2.88M floppy
 517             SET_EBDA2(ebda_seg, cdemu.spt, 36);
 518             SET_EBDA2(ebda_seg, cdemu.cylinders, 80);
 519             SET_EBDA2(ebda_seg, cdemu.heads, 2);
 520             break;
 521         }
 522     } else {
 523         // Harddrive emulation
 524         SET_EBDA2(ebda_seg, cdemu.emulated_drive, 0x80);
 525         SET_BDA(hdcount, GET_BDA(hdcount) + 1);
 526
 527         // Peak at partition table to get chs.
 528         struct mbr_s *mbr = (void*)0;
 529         u8 sptcyl = GET_FARVAR(boot_segment, mbr->partitions[0].last.sptcyl);
 530         u8 cyllow = GET_FARVAR(boot_segment, mbr->partitions[0].last.cyllow);
 531         u8 heads = GET_FARVAR(boot_segment, mbr->partitions[0].last.heads);
 532
 533         SET_EBDA2(ebda_seg, cdemu.spt, sptcyl & 0x3f);
 534         SET_EBDA2(ebda_seg, cdemu.cylinders, ((sptcyl<<2)&0x300) + cyllow + 1);
 535         SET_EBDA2(ebda_seg, cdemu.heads, heads + 1);
 536     }
 537
 538     // everything is ok, so from now on, the emulation is active
 539     SET_EBDA2(ebda_seg, cdemu.active, 0x01);
 540     dprintf(6, "cdemu media=%d\n", media);
 541
 542     return 0;
 543 }