///////////////////////////////////////////////////////////////////////// // $Id$ ///////////////////////////////////////////////////////////////////////// // // SCSI emulation layer (ported from QEMU) // // Copyright (C) 2006 CodeSourcery. // Based on code by Fabrice Bellard // // Written by Paul Brook // // Copyright (C) 2007-2014 The Bochs Project // // This library is free software; you can redistribute it and/or // modify it under the terms of the GNU Lesser General Public // License as published by the Free Software Foundation; either // version 2 of the License, or (at your option) any later version. // // This library is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU // Lesser General Public License for more details. // // You should have received a copy of the GNU Lesser General Public // License along with this library; if not, write to the Free Software // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA ///////////////////////////////////////////////////////////////////////// // Define BX_PLUGGABLE in files that can be compiled into plugins. For // platforms that require a special tag on exported symbols, BX_PLUGGABLE // is used to know when we are exporting symbols and when we are importing. #define BX_PLUGGABLE #include "iodev.h" #if BX_SUPPORT_PCI && BX_SUPPORT_PCIUSB #include "hdimage/hdimage.h" #include "hdimage/cdrom.h" #include "scsi_device.h" #define LOG_THIS #define DEVICE_NAME "SCSI drive" static SCSIRequest *free_requests = NULL; static Bit32u serial_number = 12345678; scsi_device_t::scsi_device_t(device_image_t *_hdimage, int _tcq, scsi_completionfn _completion, void *_dev) { type = SCSIDEV_TYPE_DISK; cdrom = NULL; hdimage = _hdimage; requests = NULL; sense = 0; tcq = _tcq; completion = _completion; dev = _dev; cluster_size = 1; locked = 0; inserted = 1; max_lba = (hdimage->hd_size / 512) - 1; sprintf(drive_serial_str, "%d", serial_number++); put("SCSIHD"); } scsi_device_t::scsi_device_t(cdrom_base_c *_cdrom, int _tcq, scsi_completionfn _completion, void *_dev) { type = SCSIDEV_TYPE_CDROM; cdrom = _cdrom; hdimage = NULL; requests = NULL; sense = 0; tcq = _tcq; completion = _completion; dev = _dev; cluster_size = 4; locked = 0; inserted = 0; max_lba = 0; sprintf(drive_serial_str, "%d", serial_number++); put("SCSICD"); } scsi_device_t::~scsi_device_t(void) { SCSIRequest *r, *next; if (requests) { r = requests; while (r != NULL) { next = r->next; delete r; r = next; } } if (free_requests) { r = free_requests; while (r != NULL) { next = r->next; delete r; r = next; } free_requests = NULL; } } void scsi_device_t::register_state(bx_list_c *parent, const char *name) { bx_list_c *list = new bx_list_c(parent, name, ""); new bx_shadow_num_c(list, "sense", &sense); // TODO: save/restore for SCSI requests } SCSIRequest* scsi_device_t::scsi_new_request(Bit32u tag) { SCSIRequest *r; if (free_requests) { r = free_requests; free_requests = r->next; } else { r = new SCSIRequest; } r->dev = this; r->tag = tag; r->sector_count = 0; r->buf_len = 0; r->status = 0; r->next = requests; requests = r; return r; } void scsi_device_t::scsi_remove_request(SCSIRequest *r) { SCSIRequest *last; if (requests == r) { requests = r->next; } else { last = requests; while (last != NULL) { if (last->next != r) last = last->next; else break; } if (last) { last->next = r->next; } else { BX_ERROR(("orphaned request")); } } r->next = free_requests; free_requests = r; } SCSIRequest* scsi_device_t::scsi_find_request(Bit32u tag) { SCSIRequest *r = requests; while (r != NULL) { if (r->tag != tag) r = r->next; else break; } return r; } void scsi_device_t::scsi_command_complete(SCSIRequest *r, int status, int _sense) { Bit32u tag; BX_DEBUG(("command complete tag=0x%x status=%d sense=%d", r->tag, status, sense)); sense = _sense; tag = r->tag; scsi_remove_request(r); completion(dev, SCSI_REASON_DONE, tag, status); } void scsi_device_t::scsi_cancel_io(Bit32u tag) { BX_DEBUG(("cancel tag=0x%x", tag)); SCSIRequest *r = scsi_find_request(tag); if (r) { scsi_remove_request(r); } } void scsi_device_t::scsi_read_complete(void *req, int ret) { SCSIRequest *r = (SCSIRequest *)req; if (ret) { BX_ERROR(("IO error")); completion(r, SCSI_REASON_DATA, r->tag, 0); scsi_command_complete(r, STATUS_CHECK_CONDITION, SENSE_NO_SENSE); return; } BX_DEBUG(("data ready tag=0x%x len=%d", r->tag, r->buf_len)); completion(dev, SCSI_REASON_DATA, r->tag, r->buf_len); } void scsi_device_t::scsi_read_data(Bit32u tag) { Bit32u n; int ret; SCSIRequest *r = scsi_find_request(tag); if (!r) { BX_ERROR(("bad read tag 0x%x", tag)); // ??? This is the wrong error. scsi_command_complete(r, STATUS_CHECK_CONDITION, SENSE_HARDWARE_ERROR); return; } if (r->sector_count == (Bit32u)-1) { BX_DEBUG(("read buf_len=%d", r->buf_len)); r->sector_count = 0; completion(dev, SCSI_REASON_DATA, r->tag, r->buf_len); return; } BX_DEBUG(("read sector_count=%d", r->sector_count)); if (r->sector_count == 0) { scsi_command_complete(r, STATUS_GOOD, SENSE_NO_SENSE); return; } n = r->sector_count; if (n > (Bit32u)(SCSI_DMA_BUF_SIZE / (512 * cluster_size))) n = SCSI_DMA_BUF_SIZE / (512 * cluster_size); r->buf_len = n * 512 * cluster_size; if (type == SCSIDEV_TYPE_CDROM) { if (!cdrom->read_block(r->dma_buf, (Bit32u)r->sector, 2048)) { scsi_command_complete(r, STATUS_CHECK_CONDITION, SENSE_HARDWARE_ERROR); } else { scsi_read_complete((void*)r, 0); } } else { ret = (int)hdimage->lseek(r->sector * 512, SEEK_SET); if (ret < 0) { BX_ERROR(("could not lseek() hard drive image file")); scsi_command_complete(r, STATUS_CHECK_CONDITION, SENSE_HARDWARE_ERROR); } ret = hdimage->read((bx_ptr_t)r->dma_buf, r->buf_len); if (ret < r->buf_len) { BX_ERROR(("could not read() hard drive image file")); scsi_command_complete(r, STATUS_CHECK_CONDITION, SENSE_HARDWARE_ERROR); } else { scsi_read_complete((void*)r, 0); } } r->sector += n; r->sector_count -= n; } void scsi_device_t::scsi_write_complete(void *req, int ret) { SCSIRequest *r = (SCSIRequest *)req; Bit32u len; if (ret) { BX_ERROR(("IO error")); scsi_command_complete(r, STATUS_CHECK_CONDITION, SENSE_HARDWARE_ERROR); return; } if (r->sector_count == 0) { scsi_command_complete(r, STATUS_GOOD, SENSE_NO_SENSE); } else { len = r->sector_count * 512; if (len > SCSI_DMA_BUF_SIZE) { len = SCSI_DMA_BUF_SIZE; } r->buf_len = len; BX_DEBUG(("write complete tag=0x%x more=%d", r->tag, len)); completion(dev, SCSI_REASON_DATA, r->tag, len); } } int scsi_device_t::scsi_write_data(Bit32u tag) { SCSIRequest *r; Bit32u n; int ret; BX_DEBUG(("write data tag=0x%x", tag)); r = scsi_find_request(tag); if (!r) { BX_ERROR(("bad write tag 0x%x", tag)); scsi_command_complete(r, STATUS_CHECK_CONDITION, SENSE_HARDWARE_ERROR); return 1; } if (type == SCSIDEV_TYPE_DISK) { n = r->buf_len / 512; if (n) { ret = (int)hdimage->lseek(r->sector * 512, SEEK_SET); if (ret < 0) { BX_ERROR(("could not lseek() hard drive image file")); scsi_command_complete(r, STATUS_CHECK_CONDITION, SENSE_HARDWARE_ERROR); } ret = hdimage->write((bx_ptr_t)r->dma_buf, r->buf_len); r->sector += n; r->sector_count -= n; if (ret < r->buf_len) { BX_ERROR(("could not write() hard drive image file")); scsi_command_complete(r, STATUS_CHECK_CONDITION, SENSE_HARDWARE_ERROR); } else { scsi_write_complete((void*)r, 0); } } else { scsi_write_complete(r, 0); } } else { BX_ERROR(("CD-ROM: write not supported")); scsi_command_complete(r, STATUS_CHECK_CONDITION, SENSE_HARDWARE_ERROR); } return 0; } Bit8u* scsi_device_t::scsi_get_buf(Bit32u tag) { SCSIRequest *r = scsi_find_request(tag); if (!r) { BX_ERROR(("bad buffer tag 0x%x", tag)); return NULL; } return r->dma_buf; } Bit32s scsi_device_t::scsi_send_command(Bit32u tag, Bit8u *buf, int lun) { Bit64u nb_sectors; Bit64u lba; Bit32s len; //int cmdlen; int is_write; Bit8u command; Bit8u *outbuf; SCSIRequest *r; command = buf[0]; r = scsi_find_request(tag); if (r) { BX_ERROR(("tag 0x%x already in use", tag)); scsi_cancel_io(tag); } r = scsi_new_request(tag); outbuf = r->dma_buf; is_write = 0; BX_DEBUG(("command: lun=%d tag=0x%x data=0x%02x", lun, tag, buf[0])); switch (command >> 5) { case 0: lba = buf[3] | (buf[2] << 8) | ((buf[1] & 0x1f) << 16); len = buf[4]; // cmdlen = 6; break; case 1: case 2: lba = buf[5] | (buf[4] << 8) | (buf[3] << 16) | (buf[2] << 24); len = buf[8] | (buf[7] << 8); // cmdlen = 10; break; case 4: lba = buf[9] | (buf[8] << 8) | (buf[7] << 16) | (buf[6] << 24) | ((Bit64u)buf[5] << 32) | ((Bit64u)buf[4] << 40) | ((Bit64u)buf[3] << 48) | ((Bit64u)buf[2] << 56); len = buf[13] | (buf[12] << 8) | (buf[11] << 16) | (buf[10] << 24); // cmdlen = 16; break; case 5: lba = buf[5] | (buf[4] << 8) | (buf[3] << 16) | (buf[2] << 24); len = buf[9] | (buf[8] << 8) | (buf[7] << 16) | (buf[6] << 24); // cmdlen = 12; break; default: BX_ERROR(("Unsupported command length, command %x", command)); goto fail; } if (lun || buf[1] >> 5) { BX_ERROR(("unimplemented LUN %d", lun ? lun : buf[1] >> 5)); if ((command != 0x03) && (command != 0x12)) // REQUEST SENSE and INQUIRY goto fail; } switch (command) { case 0x0: BX_DEBUG(("Test Unit Ready")); if (!inserted) goto notready; break; case 0x03: BX_DEBUG(("request Sense (len %d)", len)); if (len < 4) goto fail; memset(outbuf, 0, 4); r->buf_len = 4; if ((sense == SENSE_NOT_READY) && (len >= 18)) { memset(outbuf, 0, 18); r->buf_len = 18; outbuf[7] = 10; /* asc 0x3a, ascq 0: Medium not present */ outbuf[12] = 0x3a; outbuf[13] = 0; } outbuf[0] = 0xf0; outbuf[1] = 0; outbuf[2] = sense; break; case 0x12: BX_DEBUG(("inquiry (len %d)", len)); if (buf[1] & 0x2) { // Command support data - optional, not implemented BX_ERROR(("optional INQUIRY command support request not implemented")); goto fail; } else if (buf[1] & 0x1) { // Vital product data Bit8u page_code = buf[2]; if (len < 4) { BX_ERROR(("Error: Inquiry (EVPD[%02X]) buffer size %d is less than 4", page_code, len)); goto fail; } switch (page_code) { case 0x00: // Supported page codes, mandatory BX_DEBUG(("Inquiry EVPD[Supported pages] buffer size %d", len)); r->buf_len = 0; if (type == SCSIDEV_TYPE_CDROM) { outbuf[r->buf_len++] = 5; } else { outbuf[r->buf_len++] = 0; } outbuf[r->buf_len++] = 0x00; // this page outbuf[r->buf_len++] = 0x00; outbuf[r->buf_len++] = 3; // number of pages outbuf[r->buf_len++] = 0x00; // list of supported pages (this page) outbuf[r->buf_len++] = 0x80; // unit serial number outbuf[r->buf_len++] = 0x83; // device identification break; case 0x80: { int l; // Device serial number, optional if (len < 4) { BX_ERROR(("Error: EVPD[Serial number] Inquiry buffer size %d too small, %d needed", len, 4)); goto fail; } BX_DEBUG(("Inquiry EVPD[Serial number] buffer size %d\n", len)); l = BX_MIN(len, (int)strlen(drive_serial_str)); r->buf_len = 0; // Supported page codes if (type == SCSIDEV_TYPE_CDROM) { outbuf[r->buf_len++] = 5; } else { outbuf[r->buf_len++] = 0; } outbuf[r->buf_len++] = 0x80; // this page outbuf[r->buf_len++] = 0x00; outbuf[r->buf_len++] = l; memcpy(&outbuf[r->buf_len], drive_serial_str, l); r->buf_len += l; } break; case 0x83: { // Device identification page, mandatory int max_len = 255 - 8; int id_len = strlen(DEVICE_NAME); if (id_len > max_len) id_len = max_len; BX_DEBUG(("Inquiry EVPD[Device identification] buffer size %d", len)); r->buf_len = 0; if (type == SCSIDEV_TYPE_CDROM) { outbuf[r->buf_len++] = 5; } else { outbuf[r->buf_len++] = 0; } outbuf[r->buf_len++] = 0x83; // this page outbuf[r->buf_len++] = 0x00; outbuf[r->buf_len++] = 3 + id_len; outbuf[r->buf_len++] = 0x2; // ASCII outbuf[r->buf_len++] = 0; // not officially assigned outbuf[r->buf_len++] = 0; // reserved outbuf[r->buf_len++] = id_len; // length of data following memcpy(&outbuf[r->buf_len], DEVICE_NAME, id_len); r->buf_len += id_len; } break; default: BX_ERROR(("Error: unsupported Inquiry (EVPD[%02X]) buffer size %d", page_code, len)); goto fail; } // done with EVPD break; } else { // Standard INQUIRY data if (buf[2] != 0) { BX_ERROR(("Error: Inquiry (STANDARD) page or code is non-zero [%02X]", buf[2])); goto fail; } // PAGE CODE == 0 if (len < 5) { BX_ERROR(("Error: Inquiry (STANDARD) buffer size %d is less than 5", len)); goto fail; } if (len < 36) { BX_ERROR(("Error: Inquiry (STANDARD) buffer size %d is less than 36 (TODO: only 5 required)", len)); } } if(len > SCSI_MAX_INQUIRY_LEN) len = SCSI_MAX_INQUIRY_LEN; memset(outbuf, 0, len); if (lun || buf[1] >> 5) { outbuf[0] = 0x7f; // LUN not supported } else if (type == SCSIDEV_TYPE_CDROM) { outbuf[0] = 5; outbuf[1] = 0x80; memcpy(&outbuf[16], "BOCHS CD-ROM ", 16); } else { outbuf[0] = 0; memcpy(&outbuf[16], "BOCHS HARDDISK ", 16); } memcpy(&outbuf[8], "BOCHS ", 8); memcpy(&outbuf[32], "1.0", 4); // Identify device as SCSI-3 rev 1. // Some later commands are also implemented. outbuf[2] = 3; outbuf[3] = 2; // Format 2 outbuf[4] = len - 5; // Additional Length = (Len - 1) - 4 // Sync data transfer and TCQ. outbuf[7] = 0x10 | (tcq ? 0x02 : 0); r->buf_len = len; break; case 0x16: BX_INFO(("Reserve(6)")); if (buf[1] & 1) goto fail; break; case 0x17: BX_INFO(("Release(6)")); if (buf[1] & 1) goto fail; break; case 0x1a: case 0x5a: { Bit8u *p; int page; page = buf[2] & 0x3f; BX_DEBUG(("mode sense (page %d, len %d)", page, len)); p = outbuf; memset(p, 0, 4); outbuf[1] = 0; /* Default media type. */ outbuf[3] = 0; /* Block descriptor length. */ if (type == SCSIDEV_TYPE_CDROM) { outbuf[2] = 0x80; /* Readonly. */ } p += 4; if ((page == 4) || (page == 5)) { BX_ERROR(("mode sense: page %d not implemented", page)); } if ((page == 8 || page == 0x3f)) { /* Caching page. */ memset(p, 0, 20); p[0] = 8; p[1] = 0x12; p[2] = 4; /* WCE */ p += 20; } if ((page == 0x3f || page == 0x2a) && (type == SCSIDEV_TYPE_CDROM)) { /* CD Capabilities and Mechanical Status page. */ p[0] = 0x2a; p[1] = 0x14; p[2] = 3; // CD-R & CD-RW read p[3] = 0; // Writing not supported p[4] = 0x7f; /* Audio, composite, digital out, mode 2 form 1&2, multi session */ p[5] = 0xff; /* CD DA, DA accurate, RW supported, RW corrected, C2 errors, ISRC, UPC, Bar code */ p[6] = 0x2d | (locked ? 2 : 0); /* Locking supported, jumper present, eject, tray */ p[7] = 0; /* no volume & mute control, no changer */ p[8] = (50 * 176) >> 8; // 50x read speed p[9] = (50 * 176) & 0xff; p[10] = 0 >> 8; // No volume p[11] = 0 & 0xff; p[12] = 2048 >> 8; // 2M buffer p[13] = 2048 & 0xff; p[14] = (16 * 176) >> 8; // 16x read speed current p[15] = (16 * 176) & 0xff; p[18] = (16 * 176) >> 8; // 16x write speed p[19] = (16 * 176) & 0xff; p[20] = (16 * 176) >> 8; // 16x write speed current p[21] = (16 * 176) & 0xff; p += 22; } r->buf_len = p - outbuf; outbuf[0] = r->buf_len - 4; if (r->buf_len > (int)len) r->buf_len = len; } break; case 0x1b: BX_INFO(("Start Stop Unit")); if (type == SCSIDEV_TYPE_CDROM && (buf[4] & 2)) { if (!(buf[4] & 1)) { // eject medium cdrom->eject_cdrom(); inserted = 0; } } break; case 0x1e: BX_INFO(("Prevent Allow Medium Removal (prevent = %d)", buf[4] & 3)); locked = buf[4] & 1; break; case 0x25: BX_DEBUG(("Read Capacity")); // The normal LEN field for this command is zero memset(outbuf, 0, 8); if (type == SCSIDEV_TYPE_CDROM) { nb_sectors = max_lba; } else { nb_sectors = hdimage->hd_size / 512; nb_sectors--; } /* Returned value is the address of the last sector. */ if (nb_sectors) { outbuf[0] = (Bit8u)((nb_sectors >> 24) & 0xff); outbuf[1] = (Bit8u)((nb_sectors >> 16) & 0xff); outbuf[2] = (Bit8u)((nb_sectors >> 8) & 0xff); outbuf[3] = (Bit8u)(nb_sectors & 0xff); outbuf[4] = 0; outbuf[5] = 0; outbuf[6] = cluster_size * 2; outbuf[7] = 0; r->buf_len = 8; } else { notready: scsi_command_complete(r, STATUS_CHECK_CONDITION, SENSE_NOT_READY); return 0; } break; case 0x08: case 0x28: case 0x88: BX_DEBUG(("Read (sector "FMT_LL"d, count %d)", lba, len)); if (lba > max_lba) goto illegal_lba; r->sector = lba; r->sector_count = len; break; case 0x0a: case 0x2a: case 0x8a: BX_DEBUG(("Write (sector "FMT_LL"d, count %d)", lba, len)); if (lba > max_lba) goto illegal_lba; r->sector = lba; r->sector_count = len; is_write = 1; break; case 0x35: BX_DEBUG(("Syncronise cache (sector "FMT_LL"d, count %d)", lba, len)); // TODO: flush cache break; case 0x43: { int start_track, format, msf, toclen = 0; if (type == SCSIDEV_TYPE_CDROM) { if (!inserted) goto notready; msf = buf[1] & 2; format = buf[2] & 0xf; start_track = buf[6]; BX_DEBUG(("Read TOC (track %d format %d msf %d)", start_track, format, msf >> 1)); cdrom->read_toc(outbuf, &toclen, msf, start_track, format); if (toclen > 0) { if (len > toclen) len = toclen; r->buf_len = len; break; } BX_ERROR(("Read TOC error")); goto fail; } else { goto fail; } } case 0x46: BX_DEBUG(("Get Configuration (rt %d, maxlen %d)", buf[1] & 3, len)); memset(outbuf, 0, 8); /* ??? This shoud probably return much more information. For now just return the basic header indicating the CD-ROM profile. */ outbuf[7] = 8; // CD-ROM r->buf_len = 8; break; case 0x56: BX_INFO(("Reserve(10)")); if (buf[1] & 3) goto fail; break; case 0x57: BX_INFO(("Release(10)")); if (buf[1] & 3) goto fail; break; case 0xa0: BX_INFO(("Report LUNs (len %d)", len)); if (len < 16) goto fail; memset(outbuf, 0, 16); outbuf[3] = 8; r->buf_len = 16; break; case 0x2f: BX_INFO(("Verify")); break; case 0x23: { // USBMASS-UFI10.pdf  rev 1.0  Section 4.10 BX_INFO(("READ FORMAT CAPACITIES (MMC)")); unsigned len = (buf[7]<<8) | buf[8]; #define OUR_LEN 12 // Cap List Header outbuf[0] = 0; outbuf[1] = 0; outbuf[2] = 0; outbuf[3] = OUR_LEN; // Current/Max Cap Header if (type == SCSIDEV_TYPE_CDROM) { nb_sectors = max_lba; } else { nb_sectors = (hdimage->hd_size / 512); nb_sectors--; } /* Returned value is the address of the last sector.  */ outbuf[4] = (Bit8u)((nb_sectors >> 24) & 0xff); outbuf[5] = (Bit8u)((nb_sectors >> 16) & 0xff); outbuf[6] = (Bit8u)((nb_sectors >> 8) & 0xff); outbuf[7] = (Bit8u)(nb_sectors & 0xff); outbuf[8] = 2; // formatted (1 = unformatted) outbuf[9] = 0; outbuf[10] = cluster_size * 2; outbuf[11] = 0; r->buf_len = (len < OUR_LEN) ? len : OUR_LEN; } break; default: BX_ERROR(("Unknown SCSI command (%2.2x)", buf[0])); fail: scsi_command_complete(r, STATUS_CHECK_CONDITION, SENSE_ILLEGAL_REQUEST); return 0; illegal_lba: scsi_command_complete(r, STATUS_CHECK_CONDITION, SENSE_HARDWARE_ERROR); return 0; } if (r->sector_count == 0 && r->buf_len == 0) { scsi_command_complete(r, STATUS_GOOD, SENSE_NO_SENSE); } len = r->sector_count * 512 * cluster_size + r->buf_len; if (is_write) { return -len; } else { if (!r->sector_count) r->sector_count = (Bit32u) -1; return len; } } void scsi_device_t::set_inserted(bx_bool value) { inserted = value; if (inserted) { max_lba = cdrom->capacity() - 1; } else { max_lba = 0; } } #endif // BX_SUPPORT_PCI && BX_SUPPORT_PCIUSB