dingusppc/devices/common/scsi/scsihd.cpp

393 lines
12 KiB
C++
Raw Normal View History

/*
DingusPPC - The Experimental PowerPC Macintosh emulator
Copyright (C) 2018-23 divingkatae and maximum
(theweirdo) spatium
(Contact divingkatae#1017 or powermax#2286 on Discord for more info)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
/** @file Generic SCSI Hard Disk emulation. */
2023-11-09 11:30:07 +00:00
#include <core/timermanager.h>
2022-10-25 00:10:54 +00:00
#include <devices/common/scsi/scsi.h>
#include <devices/common/scsi/scsihd.h>
2022-11-10 17:22:44 +00:00
#include <devices/deviceregistry.h>
#include <loguru.hpp>
#include <machines/machineproperties.h>
#include <memaccess.h>
#include <fstream>
2022-10-27 12:19:58 +00:00
#include <cstring>
2022-11-10 17:22:44 +00:00
#define HDD_SECTOR_SIZE 512
using namespace std;
ScsiHardDisk::ScsiHardDisk(std::string name, int my_id) : ScsiDevice(name, my_id) {
2022-10-30 22:38:09 +00:00
}
void ScsiHardDisk::insert_image(std::string filename) {
//We don't want to store everything in memory, but
//we want to keep the hard disk available.
if (!this->hdd_img.open(filename))
2023-12-04 21:41:01 +00:00
ABORT_F("%s: could not open image file %s", this->name.c_str(), filename.c_str());
this->img_size = this->hdd_img.size();
uint64_t tb = (this->img_size + HDD_SECTOR_SIZE - 1) / HDD_SECTOR_SIZE;
this->total_blocks = static_cast<int>(tb);
if (this->total_blocks < 0 || tb != this->total_blocks) {
ABORT_F("ScsiHardDisk: file size is too large");
}
}
void ScsiHardDisk::process_command() {
2022-10-26 16:18:32 +00:00
uint32_t lba = 0;
uint16_t transfer_len = 0;
uint16_t alloc_len = 0;
uint8_t page_code = 0;
uint8_t subpage_code = 0;
2022-11-07 20:56:01 +00:00
this->pre_xfer_action = nullptr;
this->post_xfer_action = nullptr;
2022-11-07 11:24:02 +00:00
// assume successful command execution
this->status = ScsiStatus::GOOD;
this->msg_buf[0] = ScsiMessage::COMMAND_COMPLETE;
2022-11-07 11:24:02 +00:00
uint8_t* cmd = this->cmd_buf;
switch (cmd[0]) {
2022-10-27 12:19:58 +00:00
case ScsiCommand::TEST_UNIT_READY:
test_unit_ready();
break;
case ScsiCommand::REWIND:
rewind();
break;
case ScsiCommand::REQ_SENSE:
alloc_len = cmd[4];
req_sense(alloc_len);
break;
2023-11-09 11:30:07 +00:00
case ScsiCommand::FORMAT_UNIT:
this->format();
break;
2022-10-27 12:19:58 +00:00
case ScsiCommand::INQUIRY:
2023-08-02 14:53:19 +00:00
this->inquiry();
2022-10-27 12:19:58 +00:00
break;
case ScsiCommand::READ_6:
lba = ((cmd[1] & 0x1F) << 16) + (cmd[2] << 8) + cmd[3];
transfer_len = cmd[4];
read(lba, transfer_len, 6);
break;
case ScsiCommand::READ_10:
lba = (cmd[2] << 24) + (cmd[3] << 16) + (cmd[4] << 8) + cmd[5];
transfer_len = (cmd[7] << 8) + cmd[8];
read(lba, transfer_len, 10);
break;
case ScsiCommand::WRITE_6:
lba = ((cmd[1] & 0x1F) << 16) + (cmd[2] << 8) + cmd[3];
transfer_len = cmd[4];
write(lba, transfer_len, 6);
break;
case ScsiCommand::WRITE_10:
lba = (cmd[2] << 24) + (cmd[3] << 16) + (cmd[4] << 8) + cmd[5];
transfer_len = (cmd[7] << 8) + cmd[8];
write(lba, transfer_len, 10);
2022-11-07 20:56:01 +00:00
this->switch_phase(ScsiPhase::DATA_OUT);
2022-10-27 12:19:58 +00:00
break;
case ScsiCommand::SEEK_6:
lba = ((cmd[1] & 0x1F) << 16) + (cmd[2] << 8) + cmd[3];
seek(lba);
break;
case ScsiCommand::MODE_SELECT_6:
2023-11-09 11:30:07 +00:00
mode_select_6(cmd[4]);
2022-10-27 12:19:58 +00:00
break;
case ScsiCommand::MODE_SENSE_6:
2023-08-02 14:53:19 +00:00
this->mode_sense_6();
2022-10-27 12:19:58 +00:00
break;
2022-11-13 23:52:53 +00:00
case ScsiCommand::READ_CAPACITY_10:
2023-08-02 14:53:19 +00:00
this->read_capacity_10();
2022-10-27 12:19:58 +00:00
break;
case ScsiCommand::READ_BUFFER:
read_buffer();
break;
2022-10-27 12:19:58 +00:00
default:
2023-12-04 21:41:01 +00:00
LOG_F(WARNING, "%s: unrecognized command: %x", this->name.c_str(), cmd[0]);
2022-10-26 16:18:32 +00:00
}
}
bool ScsiHardDisk::prepare_data() {
switch (this->cur_phase) {
case ScsiPhase::DATA_IN:
2022-11-07 11:24:02 +00:00
this->data_ptr = (uint8_t*)this->img_buffer;
this->data_size = this->bytes_out;
break;
2022-11-07 20:56:01 +00:00
case ScsiPhase::DATA_OUT:
this->data_ptr = (uint8_t*)this->img_buffer;
this->data_size = 0;
break;
case ScsiPhase::STATUS:
if (!error) {
this->img_buffer[0] = ScsiStatus::GOOD;
} else {
this->img_buffer[0] = ScsiStatus::CHECK_CONDITION;
}
this->data_size = 1;
break;
case ScsiPhase::MESSAGE_IN:
this->img_buffer[0] = this->msg_code;
this->data_size = 1;
break;
default:
2023-12-04 21:41:01 +00:00
LOG_F(WARNING, "%s: unexpected phase in prepare_data", this->name.c_str());
return false;
}
return true;
}
int ScsiHardDisk::test_unit_ready() {
this->switch_phase(ScsiPhase::STATUS);
return ScsiError::NO_ERROR;
}
2022-10-26 16:18:32 +00:00
int ScsiHardDisk::req_sense(uint16_t alloc_len) {
if (alloc_len != 252) {
2023-12-04 21:41:01 +00:00
LOG_F(WARNING, "%s: inappropriate Allocation Length: %d", this->name.c_str(),
alloc_len);
}
return ScsiError::NO_ERROR; // placeholder - no sense
}
2023-08-02 14:53:19 +00:00
void ScsiHardDisk::inquiry() {
int page_num = cmd_buf[2];
int alloc_len = cmd_buf[4];
if (page_num) {
2023-12-04 21:41:01 +00:00
ABORT_F("%s: invalid page number in INQUIRY", this->name.c_str());
2023-08-02 14:53:19 +00:00
}
if (alloc_len >= 36) {
this->img_buffer[0] = 0; // device type: Direct-access block device
this->img_buffer[1] = 0; // non-removable media
this->img_buffer[2] = 2; // ANSI version: SCSI-2
this->img_buffer[3] = 1; // response data format
this->img_buffer[4] = 0; // additional length
2023-08-02 14:53:19 +00:00
this->img_buffer[5] = 0;
this->img_buffer[6] = 0;
this->img_buffer[7] = 0x18; // supports synchronous xfers and linked commands
2022-10-27 12:19:58 +00:00
std::memcpy(img_buffer + 8, vendor_info, 8);
std::memcpy(img_buffer + 16, prod_info, 16);
2023-08-02 14:53:19 +00:00
std::memcpy(img_buffer + 32, rev_info, 4);
this->bytes_out = 36;
this->switch_phase(ScsiPhase::DATA_IN);
}
2022-10-26 16:30:05 +00:00
else {
2023-12-04 21:41:01 +00:00
LOG_F(WARNING, "%s: allocation length too small: %d", this->name.c_str(),
alloc_len);
2022-10-26 16:30:05 +00:00
}
}
int ScsiHardDisk::send_diagnostic() {
return 0x0;
}
2023-11-09 11:30:07 +00:00
void ScsiHardDisk::mode_select_6(uint8_t param_len) {
if (!param_len) {
this->switch_phase(ScsiPhase::STATUS);
return;
2022-10-26 16:18:32 +00:00
}
2023-11-09 11:30:07 +00:00
this->incoming_size = param_len;
std::memset(&this->img_buffer[0], 0xDD, HDD_SECTOR_SIZE);
this->post_xfer_action = [this]() {
// TODO: parse the received mode parameter list here
};
this->switch_phase(ScsiPhase::DATA_OUT);
2022-10-26 16:18:32 +00:00
}
static char Apple_Copyright_Page_Data[] = "APPLE COMPUTER, INC ";
2023-08-02 14:53:19 +00:00
void ScsiHardDisk::mode_sense_6() {
uint8_t page_code = this->cmd_buf[2] & 0x3F;
uint8_t page_ctrl = this->cmd_buf[2] >> 6;
2023-08-02 14:53:19 +00:00
uint8_t alloc_len = this->cmd_buf[4];
this->img_buffer[ 0] = 13; // initial data size
this->img_buffer[ 1] = 0; // medium type
this->img_buffer[ 2] = 0; // medium is write enabled
this->img_buffer[ 3] = 8; // block description length
this->img_buffer[ 4] = 0; // density code
this->img_buffer[ 5] = (this->total_blocks >> 16) & 0xFFU;
this->img_buffer[ 6] = (this->total_blocks >> 8) & 0xFFU;
this->img_buffer[ 7] = (this->total_blocks ) & 0xFFU;
this->img_buffer[ 8] = 0;
this->img_buffer[ 9] = 0; // sector size MSB
this->img_buffer[10] = 2; // sector size
this->img_buffer[11] = 0; // sector size LSB
this->img_buffer[12] = page_code;
switch(page_code) {
2023-11-09 11:30:07 +00:00
case 1: // read-write error recovery page
this->img_buffer[13] = 6; // data size - 1
std::memset(&this->img_buffer[14], 0, 6);
break;
case 3: // Format device page
this->img_buffer[13] = 22; // data size - 1
std::memset(&this->img_buffer[14], 0, 22);
// default values taken from Empire 540/1080S manual
this->img_buffer[15] = 6; // tracks per defect zone
this->img_buffer[17] = 1; // alternate sectors per zone
this->img_buffer[23] = 92; // sectors per track in the outermost zone
this->img_buffer[27] = 1; // interleave factor
this->img_buffer[29] = 19; // track skew factor
this->img_buffer[31] = 25; // cylinder skew factor
this->img_buffer[32] = 0x80; // SSEC=1, HSEC=0, RMB=0, SURF=0, INS=0
WRITE_WORD_BE_U(&this->img_buffer[24], 512); // bytes per sector
break;
case 0x30: // Copyright page for Apple certified drives
this->img_buffer[13] = 22; // data size - 1
std::memcpy(&this->img_buffer[14], Apple_Copyright_Page_Data, 22);
break;
default:
2023-12-04 21:41:01 +00:00
ABORT_F("%s: unsupported page %d in MODE_SENSE_6", this->name.c_str(), page_code);
};
// adjust for overall mode sense data length
this->img_buffer[0] += this->img_buffer[13] + 1;
this->bytes_out = std::min(alloc_len, (uint8_t)this->img_buffer[0]);
this->switch_phase(ScsiPhase::DATA_IN);
}
2022-10-23 23:45:58 +00:00
void ScsiHardDisk::read_capacity_10() {
uint32_t lba = READ_DWORD_BE_U(&this->cmd_buf[2]);
2022-10-27 12:19:58 +00:00
if (this->cmd_buf[1] & 1) {
2023-12-04 21:41:01 +00:00
ABORT_F("%s: RelAdr bit set in READ_CAPACITY_10", this->name.c_str());
}
if (!(this->cmd_buf[8] & 1) && lba) {
2023-12-04 21:41:01 +00:00
LOG_F(ERROR, "%s: non-zero LBA for PMI=0", this->name.c_str());
this->status = ScsiStatus::CHECK_CONDITION;
this->sense = ScsiSense::ILLEGAL_REQ;
this->switch_phase(ScsiPhase::STATUS);
return;
}
uint32_t last_lba = this->total_blocks - 1;
uint32_t blk_len = HDD_SECTOR_SIZE;
2022-10-23 23:45:58 +00:00
WRITE_DWORD_BE_A(&img_buffer[0], last_lba);
WRITE_DWORD_BE_A(&img_buffer[4], blk_len);
2022-10-23 23:45:58 +00:00
this->bytes_out = 8;
this->switch_phase(ScsiPhase::DATA_IN);
}
2022-10-23 23:45:58 +00:00
void ScsiHardDisk::format() {
2023-12-04 21:41:01 +00:00
LOG_F(WARNING, "%s: attempt to format the disk!", this->name.c_str());
2023-11-09 11:30:07 +00:00
if (this->cmd_buf[1] & 0x10)
2023-12-04 21:41:01 +00:00
ABORT_F("%s: defect list isn't supported yet", this->name.c_str());
2023-11-09 11:30:07 +00:00
TimerManager::get_instance()->add_oneshot_timer(NS_PER_SEC, [this]() {
this->switch_phase(ScsiPhase::STATUS);
});
}
2022-10-26 16:18:32 +00:00
void ScsiHardDisk::read(uint32_t lba, uint16_t transfer_len, uint8_t cmd_len) {
uint32_t transfer_size = transfer_len;
2022-10-27 12:19:58 +00:00
std::memset(img_buffer, 0, sizeof(img_buffer));
2022-11-10 17:22:44 +00:00
if (cmd_len == 6 && transfer_len == 0) {
transfer_size = 256;
}
2022-10-26 16:18:32 +00:00
2022-11-10 17:22:44 +00:00
transfer_size *= HDD_SECTOR_SIZE;
uint64_t device_offset = lba * HDD_SECTOR_SIZE;
this->hdd_img.read(img_buffer, device_offset, transfer_size);
2022-10-31 22:17:08 +00:00
this->bytes_out = transfer_size;
2022-11-07 20:56:01 +00:00
this->switch_phase(ScsiPhase::DATA_IN);
}
2022-10-26 16:18:32 +00:00
void ScsiHardDisk::write(uint32_t lba, uint16_t transfer_len, uint8_t cmd_len) {
uint32_t transfer_size = transfer_len;
2022-11-10 17:22:44 +00:00
if (cmd_len == 6 && transfer_len == 0) {
transfer_size = 256;
}
2022-10-26 16:18:32 +00:00
2022-11-10 17:22:44 +00:00
transfer_size *= HDD_SECTOR_SIZE;
uint64_t device_offset = lba * HDD_SECTOR_SIZE;
2022-11-07 20:56:01 +00:00
this->incoming_size = transfer_size;
this->post_xfer_action = [this, device_offset]() {
this->hdd_img.write(this->img_buffer, device_offset, this->incoming_size);
2022-11-07 20:56:01 +00:00
};
}
void ScsiHardDisk::seek(uint32_t lba) {
// No-op
}
void ScsiHardDisk::rewind() {
// No-op
}
void ScsiHardDisk::read_buffer() {
uint8_t mode = this->cmd_buf[1];
uint32_t alloc_len = (this->cmd_buf[6] << 24) | (this->cmd_buf[7] << 16) |
this->cmd_buf[8];
switch(mode) {
case 0: // Combined header and data mode
WRITE_DWORD_BE_A(&this->img_buffer[0], 0x10000); // report buffer size of 64K
break;
default:
2023-12-04 21:41:01 +00:00
ABORT_F("%s: unsupported mode %d in READ_BUFFER", this->name.c_str(), mode);
}
this->bytes_out = alloc_len;
this->switch_phase(ScsiPhase::DATA_IN);
}
static const PropMap SCSI_HD_Properties = {
{"hdd_img", new StrProperty("")},
{"hdd_wr_prot", new BinProperty(0)},
2022-10-25 00:41:58 +00:00
};
2022-10-30 22:38:09 +00:00
static const DeviceDescription SCSI_HD_Descriptor =
2022-10-30 22:38:09 +00:00
{ScsiHardDisk::create, {}, SCSI_HD_Properties};
REGISTER_DEVICE(ScsiHD, SCSI_HD_Descriptor);