roms/seabios/src/cdrom.c

   1 // Support for booting from cdroms (the "El Torito" spec).
   2 //
   3 // Copyright (C) 2008,2009  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 "ata.h" // ATA_CMD_REQUEST_SENSE
  13 #include "blockcmd.h" // CDB_CMD_REQUEST_SENSE
  14
  15
  16 /****************************************************************
  17  * CD emulation
  18  ****************************************************************/
  19
  20 struct drive_s *cdemu_drive_gf VAR16VISIBLE;
  21 u8 *cdemu_buf_fl VAR16VISIBLE;
  22
  23 static int
  24 cdemu_read(struct disk_op_s *op)
  25 {
  26     u16 ebda_seg = get_ebda_seg();
  27     struct drive_s *drive_g;
  28     drive_g = GLOBALFLAT2GLOBAL(GET_EBDA2(ebda_seg, cdemu.emulated_drive_gf));
  29     struct disk_op_s dop;
  30     dop.drive_g = drive_g;
  31     dop.command = op->command;
  32     dop.lba = GET_EBDA2(ebda_seg, cdemu.ilba) + op->lba / 4;
  33
  34     int count = op->count;
  35     op->count = 0;
  36     u8 *cdbuf_fl = GET_GLOBAL(cdemu_buf_fl);
  37
  38     if (op->lba & 3) {
  39         // Partial read of first block.
  40         dop.count = 1;
  41         dop.buf_fl = cdbuf_fl;
  42         int ret = process_op(&dop);
  43         if (ret)
  44             return ret;
  45         u8 thiscount = 4 - (op->lba & 3);
  46         if (thiscount > count)
  47             thiscount = count;
  48         count -= thiscount;
  49         memcpy_fl(op->buf_fl, cdbuf_fl + (op->lba & 3) * 512, thiscount * 512);
  50         op->buf_fl += thiscount * 512;
  51         op->count += thiscount;
  52         dop.lba++;
  53     }
  54
  55     if (count > 3) {
  56         // Read n number of regular blocks.
  57         dop.count = count / 4;
  58         dop.buf_fl = op->buf_fl;
  59         int ret = process_op(&dop);
  60         op->count += dop.count * 4;
  61         if (ret)
  62             return ret;
  63         u8 thiscount = count & ~3;
  64         count &= 3;
  65         op->buf_fl += thiscount * 512;
  66         dop.lba += thiscount / 4;
  67     }
  68
  69     if (count) {
  70         // Partial read on last block.
  71         dop.count = 1;
  72         dop.buf_fl = cdbuf_fl;
  73         int ret = process_op(&dop);
  74         if (ret)
  75             return ret;
  76         u8 thiscount = count;
  77         memcpy_fl(op->buf_fl, cdbuf_fl, thiscount * 512);
  78         op->count += thiscount;
  79     }
  80
  81     return DISK_RET_SUCCESS;
  82 }
  83
  84 int
  85 process_cdemu_op(struct disk_op_s *op)
  86 {
  87     if (!CONFIG_CDROM_EMU)
  88         return 0;
  89
  90     switch (op->command) {
  91     case CMD_READ:
  92         return cdemu_read(op);
  93     case CMD_WRITE:
  94     case CMD_FORMAT:
  95         return DISK_RET_EWRITEPROTECT;
  96     case CMD_VERIFY:
  97     case CMD_RESET:
  98     case CMD_SEEK:
  99     case CMD_ISREADY:
 100         return DISK_RET_SUCCESS;
 101     default:
 102         op->count = 0;
 103         return DISK_RET_EPARAM;
 104     }
 105 }
 106
 107 void
 108 cdemu_setup(void)
 109 {
 110     if (!CONFIG_CDROM_EMU)
 111         return;
 112     cdemu_drive_gf = NULL;
 113     cdemu_buf_fl = NULL;
 114     if (!Drives.cdcount)
 115         return;
 116
 117     struct drive_s *drive_g = malloc_fseg(sizeof(*drive_g));
 118     u8 *buf = malloc_low(CDROM_SECTOR_SIZE);
 119     if (!drive_g || !buf) {
 120         warn_noalloc();
 121         free(drive_g);
 122         free(buf);
 123         return;
 124     }
 125     cdemu_drive_gf = drive_g;
 126     cdemu_buf_fl = buf;
 127     memset(drive_g, 0, sizeof(*drive_g));
 128     drive_g->type = DTYPE_CDEMU;
 129     drive_g->blksize = DISK_SECTOR_SIZE;
 130     drive_g->sectors = (u64)-1;
 131 }
 132
 133 struct eltorito_s {
 134     u8 size;
 135     u8 media;
 136     u8 emulated_drive;
 137     u8 controller_index;
 138     u32 ilba;
 139     u16 device_spec;
 140     u16 buffer_segment;
 141     u16 load_segment;
 142     u16 sector_count;
 143     u8 cylinders;
 144     u8 sectors;
 145     u8 heads;
 146 };
 147
 148 #define SET_INT13ET(regs,var,val)                                      \
 149     SET_FARVAR((regs)->ds, ((struct eltorito_s*)((regs)->si+0))->var, (val))
 150
 151 // ElTorito - Terminate disk emu
 152 void
 153 cdemu_134b(struct bregs *regs)
 154 {
 155     // FIXME ElTorito Hardcoded
 156     u16 ebda_seg = get_ebda_seg();
 157     SET_INT13ET(regs, size, 0x13);
 158     SET_INT13ET(regs, media, GET_EBDA2(ebda_seg, cdemu.media));
 159     SET_INT13ET(regs, emulated_drive
 160                 , GET_EBDA2(ebda_seg, cdemu.emulated_extdrive));
 161     struct drive_s *drive_gf = GET_EBDA2(ebda_seg, cdemu.emulated_drive_gf);
 162     u8 cntl_id = 0;
 163     if (drive_gf)
 164         cntl_id = GET_GLOBALFLAT(drive_gf->cntl_id);
 165     SET_INT13ET(regs, controller_index, cntl_id / 2);
 166     SET_INT13ET(regs, device_spec, cntl_id % 2);
 167     SET_INT13ET(regs, ilba, GET_EBDA2(ebda_seg, cdemu.ilba));
 168     SET_INT13ET(regs, buffer_segment, GET_EBDA2(ebda_seg, cdemu.buffer_segment));
 169     SET_INT13ET(regs, load_segment, GET_EBDA2(ebda_seg, cdemu.load_segment));
 170     SET_INT13ET(regs, sector_count, GET_EBDA2(ebda_seg, cdemu.sector_count));
 171     SET_INT13ET(regs, cylinders, GET_EBDA2(ebda_seg, cdemu.lchs.cylinders));
 172     SET_INT13ET(regs, sectors, GET_EBDA2(ebda_seg, cdemu.lchs.spt));
 173     SET_INT13ET(regs, heads, GET_EBDA2(ebda_seg, cdemu.lchs.heads));
 174
 175     // If we have to terminate emulation
 176     if (regs->al == 0x00) {
 177         // FIXME ElTorito Various. Should be handled accordingly to spec
 178         SET_EBDA2(ebda_seg, cdemu.active, 0x00); // bye bye
 179
 180         // XXX - update floppy/hd count.
 181     }
 182
 183     disk_ret(regs, DISK_RET_SUCCESS);
 184 }
 185
 186
 187 /****************************************************************
 188  * CD booting
 189  ****************************************************************/
 190
 191 static int
 192 atapi_is_ready(struct disk_op_s *op)
 193 {
 194     dprintf(6, "atapi_is_ready (drive=%p)\n", op->drive_g);
 195
 196     /* Retry READ CAPACITY for 5 seconds unless MEDIUM NOT PRESENT is
 197      * reported by the device.  If the device reports "IN PROGRESS",
 198      * 30 seconds is added. */
 199     struct cdbres_read_capacity info;
 200     int in_progress = 0;
 201     u64 end = calc_future_tsc(5000);
 202     for (;;) {
 203         if (check_tsc(end)) {
 204             dprintf(1, "read capacity failed\n");
 205             return -1;
 206         }
 207
 208         int ret = cdb_read_capacity(op, &info);
 209         if (!ret)
 210             // Success
 211             break;
 212
 213         struct cdbres_request_sense sense;
 214         ret = cdb_get_sense(op, &sense);
 215         if (ret)
 216             // Error - retry.
 217             continue;
 218
 219         // Sense succeeded.
 220         if (sense.asc == 0x3a) { /* MEDIUM NOT PRESENT */
 221             dprintf(1, "Device reports MEDIUM NOT PRESENT\n");
 222             return -1;
 223         }
 224
 225         if (sense.asc == 0x04 && sense.ascq == 0x01 && !in_progress) {
 226             /* IN PROGRESS OF BECOMING READY */
 227             printf("Waiting for device to detect medium... ");
 228             /* Allow 30 seconds more */
 229             end = calc_future_tsc(30000);
 230             in_progress = 1;
 231         }
 232     }
 233
 234     u32 blksize = ntohl(info.blksize), sectors = ntohl(info.sectors);
 235     if (blksize != GET_GLOBAL(op->drive_g->blksize)) {
 236         printf("Unsupported sector size %u\n", blksize);
 237         return -1;
 238     }
 239
 240     dprintf(6, "sectors=%u\n", sectors);
 241     printf("%dMB medium detected\n", sectors>>(20-11));
 242     return 0;
 243 }
 244
 245 int
 246 cdrom_boot(int cdid)
 247 {
 248     struct disk_op_s dop;
 249     memset(&dop, 0, sizeof(dop));
 250     dop.drive_g = getDrive(EXTTYPE_CD, cdid);
 251     if (!dop.drive_g)
 252         return 1;
 253
 254     int ret = atapi_is_ready(&dop);
 255     if (ret)
 256         dprintf(1, "atapi_is_ready returned %d\n", ret);
 257
 258     // Read the Boot Record Volume Descriptor
 259     u8 buffer[2048];
 260     dop.lba = 0x11;
 261     dop.count = 1;
 262     dop.buf_fl = MAKE_FLATPTR(GET_SEG(SS), buffer);
 263     ret = cdb_read(&dop);
 264     if (ret)
 265         return 3;
 266
 267     // Validity checks
 268     if (buffer[0])
 269         return 4;
 270     if (strcmp((char*)&buffer[1], "CD001\001EL TORITO SPECIFICATION") != 0)
 271         return 5;
 272
 273     // ok, now we calculate the Boot catalog address
 274     u32 lba = *(u32*)&buffer[0x47];
 275
 276     // And we read the Boot Catalog
 277     dop.lba = lba;
 278     dop.count = 1;
 279     ret = cdb_read(&dop);
 280     if (ret)
 281         return 7;
 282
 283     // Validation entry
 284     if (buffer[0x00] != 0x01)
 285         return 8;   // Header
 286     if (buffer[0x01] != 0x00)
 287         return 9;   // Platform
 288     if (buffer[0x1E] != 0x55)
 289         return 10;  // key 1
 290     if (buffer[0x1F] != 0xAA)
 291         return 10;  // key 2
 292
 293     // Initial/Default Entry
 294     if (buffer[0x20] != 0x88)
 295         return 11; // Bootable
 296
 297     u16 ebda_seg = get_ebda_seg();
 298     u8 media = buffer[0x21];
 299     SET_EBDA2(ebda_seg, cdemu.media, media);
 300
 301     SET_EBDA2(ebda_seg, cdemu.emulated_drive_gf, dop.drive_g);
 302
 303     u16 boot_segment = *(u16*)&buffer[0x22];
 304     if (!boot_segment)
 305         boot_segment = 0x07C0;
 306     SET_EBDA2(ebda_seg, cdemu.load_segment, boot_segment);
 307     SET_EBDA2(ebda_seg, cdemu.buffer_segment, 0x0000);
 308
 309     u16 nbsectors = *(u16*)&buffer[0x26];
 310     SET_EBDA2(ebda_seg, cdemu.sector_count, nbsectors);
 311
 312     lba = *(u32*)&buffer[0x28];
 313     SET_EBDA2(ebda_seg, cdemu.ilba, lba);
 314
 315     // And we read the image in memory
 316     dop.lba = lba;
 317     dop.count = DIV_ROUND_UP(nbsectors, 4);
 318     dop.buf_fl = MAKE_FLATPTR(boot_segment, 0);
 319     ret = cdb_read(&dop);
 320     if (ret)
 321         return 12;
 322
 323     if (media == 0) {
 324         // No emulation requested - return success.
 325         SET_EBDA2(ebda_seg, cdemu.emulated_extdrive, EXTSTART_CD + cdid);
 326         return 0;
 327     }
 328
 329     // Emulation of a floppy/harddisk requested
 330     if (! CONFIG_CDROM_EMU || !cdemu_drive_gf)
 331         return 13;
 332
 333     // Set emulated drive id and increase bios installed hardware
 334     // number of devices
 335     if (media < 4) {
 336         // Floppy emulation
 337         SET_EBDA2(ebda_seg, cdemu.emulated_extdrive, 0x00);
 338         // XXX - get and set actual floppy count.
 339         SETBITS_BDA(equipment_list_flags, 0x41);
 340
 341         switch (media) {
 342         case 0x01:  // 1.2M floppy
 343             SET_EBDA2(ebda_seg, cdemu.lchs.spt, 15);
 344             SET_EBDA2(ebda_seg, cdemu.lchs.cylinders, 80);
 345             SET_EBDA2(ebda_seg, cdemu.lchs.heads, 2);
 346             break;
 347         case 0x02:  // 1.44M floppy
 348             SET_EBDA2(ebda_seg, cdemu.lchs.spt, 18);
 349             SET_EBDA2(ebda_seg, cdemu.lchs.cylinders, 80);
 350             SET_EBDA2(ebda_seg, cdemu.lchs.heads, 2);
 351             break;
 352         case 0x03:  // 2.88M floppy
 353             SET_EBDA2(ebda_seg, cdemu.lchs.spt, 36);
 354             SET_EBDA2(ebda_seg, cdemu.lchs.cylinders, 80);
 355             SET_EBDA2(ebda_seg, cdemu.lchs.heads, 2);
 356             break;
 357         }
 358     } else {
 359         // Harddrive emulation
 360         SET_EBDA2(ebda_seg, cdemu.emulated_extdrive, 0x80);
 361         SET_BDA(hdcount, GET_BDA(hdcount) + 1);
 362
 363         // Peak at partition table to get chs.
 364         struct mbr_s *mbr = (void*)0;
 365         u8 sptcyl = GET_FARVAR(boot_segment, mbr->partitions[0].last.sptcyl);
 366         u8 cyllow = GET_FARVAR(boot_segment, mbr->partitions[0].last.cyllow);
 367         u8 heads = GET_FARVAR(boot_segment, mbr->partitions[0].last.heads);
 368
 369         SET_EBDA2(ebda_seg, cdemu.lchs.spt, sptcyl & 0x3f);
 370         SET_EBDA2(ebda_seg, cdemu.lchs.cylinders
 371                   , ((sptcyl<<2)&0x300) + cyllow + 1);
 372         SET_EBDA2(ebda_seg, cdemu.lchs.heads, heads + 1);
 373     }
 374
 375     // everything is ok, so from now on, the emulation is active
 376     SET_EBDA2(ebda_seg, cdemu.active, 0x01);
 377     dprintf(6, "cdemu media=%d\n", media);
 378
 379     return 0;
 380 }