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(u16 device, u8 *asc, u8 *ascq)
 303 {
 304     u8 buffer[18];
 305     u8 atacmd[12];
 306     memset(atacmd, 0, sizeof(atacmd));
 307     atacmd[0] = ATA_CMD_REQUEST_SENSE;
 308     atacmd[4] = sizeof(buffer);
 309     int ret = ata_cmd_packet(device, atacmd, sizeof(atacmd), sizeof(buffer)
 310                              , MAKE_FARPTR(GET_SEG(SS), (u32)buffer));
 311     if (ret != 0)
 312         return ret;
 313
 314     *asc = buffer[12];
 315     *ascq = buffer[13];
 316
 317     return 0;
 318 }
 319
 320 static int
 321 atapi_is_ready(u16 device)
 322 {
 323     if (GET_GLOBAL(ATA.devices[device].type) != ATA_TYPE_ATAPI) {
 324         printf("not implemented for non-ATAPI device\n");
 325         return -1;
 326     }
 327
 328     dprintf(6, "ata_detect_medium: begin\n");
 329     u8 packet[12];
 330     memset(packet, 0, sizeof(packet));
 331     packet[0] = 0x25; /* READ CAPACITY */
 332
 333     /* Retry READ CAPACITY 50 times unless MEDIUM NOT PRESENT
 334      * is reported by the device. If the device reports "IN PROGRESS",
 335      * 30 seconds is added. */
 336     u8 buf[8];
 337     u32 timeout = 5000;
 338     u32 time = 0;
 339     u8 in_progress = 0;
 340     for (;; time+=100) {
 341         if (time >= timeout) {
 342             dprintf(1, "read capacity failed\n");
 343             return -1;
 344         }
 345         int ret = ata_cmd_packet(device, packet, sizeof(packet), sizeof(buf)
 346                                  , MAKE_FARPTR(GET_SEG(SS), (u32)buf));
 347         if (ret == 0)
 348             break;
 349
 350         u8 asc=0, ascq=0;
 351         ret = atapi_get_sense(device, &asc, &ascq);
 352         if (!ret)
 353             continue;
 354
 355         if (asc == 0x3a) { /* MEDIUM NOT PRESENT */
 356             dprintf(1, "Device reports MEDIUM NOT PRESENT\n");
 357             return -1;
 358         }
 359
 360         if (asc == 0x04 && ascq == 0x01 && !in_progress) {
 361             /* IN PROGRESS OF BECOMING READY */
 362             printf("Waiting for device to detect medium... ");
 363             /* Allow 30 seconds more */
 364             timeout = 30000;
 365             in_progress = 1;
 366         }
 367     }
 368
 369     u32 block_len = (u32) buf[4] << 24
 370         | (u32) buf[5] << 16
 371         | (u32) buf[6] << 8
 372         | (u32) buf[7] << 0;
 373
 374     if (block_len != GET_GLOBAL(ATA.devices[device].blksize)) {
 375         printf("Unsupported sector size %u\n", block_len);
 376         return -1;
 377     }
 378
 379     u32 sectors = (u32) buf[0] << 24
 380         | (u32) buf[1] << 16
 381         | (u32) buf[2] << 8
 382         | (u32) buf[3] << 0;
 383
 384     dprintf(6, "sectors=%u\n", sectors);
 385     printf("%dMB medium detected\n", sectors>>(20-11));
 386     return 0;
 387 }
 388
 389 static int
 390 atapi_is_cdrom(u8 device)
 391 {
 392     if (device >= CONFIG_MAX_ATA_DEVICES)
 393         return 0;
 394
 395     if (GET_GLOBAL(ATA.devices[device].type) != ATA_TYPE_ATAPI)
 396         return 0;
 397
 398     if (GET_GLOBAL(ATA.devices[device].device) != ATA_DEVICE_CDROM)
 399         return 0;
 400
 401     return 1;
 402 }
 403
 404 // Compare a string on the stack to one in the code segment.
 405 static int
 406 streq_cs(u8 *s1, char *cs_s2)
 407 {
 408     u8 *s2 = (u8*)cs_s2;
 409     for (;;) {
 410         if (*s1 != GET_GLOBAL(*s2))
 411             return 0;
 412         if (! *s1)
 413             return 1;
 414         s1++;
 415         s2++;
 416     }
 417 }
 418
 419 int
 420 cdrom_boot()
 421 {
 422     // Find out the first cdrom
 423     u8 device;
 424     for (device=0; device<CONFIG_MAX_ATA_DEVICES; device++)
 425         if (atapi_is_cdrom(device))
 426             break;
 427     if (device >= CONFIG_MAX_ATA_DEVICES)
 428         // cdrom not found
 429         return 2;
 430
 431     int ret = atapi_is_ready(device);
 432     if (ret)
 433         dprintf(1, "atapi_is_ready returned %d\n", ret);
 434
 435     // Read the Boot Record Volume Descriptor
 436     u8 buffer[2048];
 437     struct disk_op_s dop;
 438     dop.driveid = device;
 439     dop.lba = 0x11;
 440     dop.count = 1;
 441     dop.far_buffer = MAKE_FARPTR(GET_SEG(SS), (u32)buffer);
 442     ret = cdrom_read(&dop);
 443     if (ret)
 444         return 3;
 445
 446     // Validity checks
 447     if (buffer[0])
 448         return 4;
 449     if (!streq_cs(&buffer[1], "CD001\001EL TORITO SPECIFICATION"))
 450         return 5;
 451
 452     // ok, now we calculate the Boot catalog address
 453     u32 lba = *(u32*)&buffer[0x47];
 454
 455     // And we read the Boot Catalog
 456     dop.lba = lba;
 457     ret = cdrom_read(&dop);
 458     if (ret)
 459         return 7;
 460
 461     // Validation entry
 462     if (buffer[0x00] != 0x01)
 463         return 8;   // Header
 464     if (buffer[0x01] != 0x00)
 465         return 9;   // Platform
 466     if (buffer[0x1E] != 0x55)
 467         return 10;  // key 1
 468     if (buffer[0x1F] != 0xAA)
 469         return 10;  // key 2
 470
 471     // Initial/Default Entry
 472     if (buffer[0x20] != 0x88)
 473         return 11; // Bootable
 474
 475     u16 ebda_seg = get_ebda_seg();
 476     u8 media = buffer[0x21];
 477     SET_EBDA2(ebda_seg, cdemu.media, media);
 478
 479     SET_EBDA2(ebda_seg, cdemu.controller_index, device/2);
 480     SET_EBDA2(ebda_seg, cdemu.device_spec, device%2);
 481
 482     u16 boot_segment = *(u16*)&buffer[0x22];
 483     if (!boot_segment)
 484         boot_segment = 0x07C0;
 485     SET_EBDA2(ebda_seg, cdemu.load_segment, boot_segment);
 486     SET_EBDA2(ebda_seg, cdemu.buffer_segment, 0x0000);
 487
 488     u16 nbsectors = *(u16*)&buffer[0x26];
 489     SET_EBDA2(ebda_seg, cdemu.sector_count, nbsectors);
 490
 491     lba = *(u32*)&buffer[0x28];
 492     SET_EBDA2(ebda_seg, cdemu.ilba, lba);
 493
 494     // And we read the image in memory
 495     dop.lba = lba * 4;
 496     dop.count = nbsectors;
 497     dop.far_buffer = MAKE_FARPTR(boot_segment, 0);
 498     ret = cdrom_read_512(&dop);
 499     if (ret)
 500         return 12;
 501
 502     if (media == 0) {
 503         // No emulation requested - return success.
 504
 505         // FIXME ElTorito Hardcoded. cdrom is hardcoded as device 0xE0.
 506         // Win2000 cd boot needs to know it booted from cd
 507         SET_EBDA2(ebda_seg, cdemu.emulated_drive, 0xE0);
 508
 509         return 0;
 510     }
 511
 512     // Emulation of a floppy/harddisk requested
 513     if (! CONFIG_CDROM_EMU)
 514         return 13;
 515
 516     // Set emulated drive id and increase bios installed hardware
 517     // number of devices
 518     if (media < 4) {
 519         // Floppy emulation
 520         SET_EBDA2(ebda_seg, cdemu.emulated_drive, 0x00);
 521         SETBITS_BDA(equipment_list_flags, 0x41);
 522     } else {
 523         // Harddrive emulation
 524         SET_EBDA2(ebda_seg, cdemu.emulated_drive, 0x80);
 525         SET_BDA(hdcount, GET_BDA(hdcount) + 1);
 526     }
 527
 528     // Remember the media type
 529     switch (media) {
 530     case 0x01:  // 1.2M floppy
 531         SET_EBDA2(ebda_seg, cdemu.spt, 15);
 532         SET_EBDA2(ebda_seg, cdemu.cylinders, 80);
 533         SET_EBDA2(ebda_seg, cdemu.heads, 2);
 534         break;
 535     case 0x02:  // 1.44M floppy
 536         SET_EBDA2(ebda_seg, cdemu.spt, 18);
 537         SET_EBDA2(ebda_seg, cdemu.cylinders, 80);
 538         SET_EBDA2(ebda_seg, cdemu.heads, 2);
 539         break;
 540     case 0x03:  // 2.88M floppy
 541         SET_EBDA2(ebda_seg, cdemu.spt, 36);
 542         SET_EBDA2(ebda_seg, cdemu.cylinders, 80);
 543         SET_EBDA2(ebda_seg, cdemu.heads, 2);
 544         break;
 545     case 0x04: { // Harddrive
 546         u16 spt = GET_FARVAR(boot_segment,*(u8*)(446+6));
 547         u16 cyl = (spt << 2) + GET_FARVAR(boot_segment,*(u8*)(446+7)) + 1;
 548         u16 heads = GET_FARVAR(boot_segment,*(u8*)(446+5)) + 1;
 549         SET_EBDA2(ebda_seg, cdemu.spt, spt & 0x3f);
 550         SET_EBDA2(ebda_seg, cdemu.cylinders, cyl);
 551         SET_EBDA2(ebda_seg, cdemu.heads, heads);
 552         break;
 553     }
 554     }
 555
 556     // everything is ok, so from now on, the emulation is active
 557     SET_EBDA2(ebda_seg, cdemu.active, 0x01);
 558     dprintf(6, "cdemu media=%d\n", media);
 559
 560     return 0;
 561 }