Storage: Add support for synthetic IDE controller on Gen1 VMs

Author: Goldfish64

Changelog.md

@@ -2,6 +2,8 @@ MacHyperVSupport Changelog
 ============================
 #### v0.9.8
 - Added constants for macOS 15 support
+- Fixed completion flag not being added for storage commands
+- Added support for the synthetic IDE controller on Gen1 VMs
 
 #### v0.9.7
 - Fixed disks on a passed-in PCI device not being usable

MacHyperVSupport/Info.plist

@@ -195,7 +195,25 @@
 			<key>IOUserClientClass</key>
 			<string>HyperVShutdownUserClient</string>
 		</dict>
-		<key>HyperVStorage</key>
+		<key>HyperVStorageIDE</key>
+		<dict>
+			<key>CFBundleIdentifier</key>
+			<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+			<key>HVType</key>
+			<string>32412632-86cb-44a2-9b5c-50d1417354f5</string>
+			<key>IOClass</key>
+			<string>HyperVStorage</string>
+			<key>IOProviderClass</key>
+			<string>HyperVVMBusDevice</string>
+			<key>Protocol Characteristics</key>
+			<dict>
+				<key>Physical Interconnect</key>
+				<string>ATA</string>
+				<key>Physical Interconnect Location</key>
+				<string>Internal</string>
+			</dict>
+		</dict>
+		<key>HyperVStorageSCSI</key>
 		<dict>
 			<key>CFBundleIdentifier</key>
 			<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>

MacHyperVSupport/Storage/HyperVStorage.cpp

@@ -145,9 +145,9 @@ bool HyperVStorage::DoesHBASupportSCSIParallelFeature(SCSIParallelFeature theFea
 
 bool HyperVStorage::InitializeTargetForID(SCSITargetIdentifier targetID) {
   //
-  // Ensure target ID is under maximum.
+  // Ensure target ID is under maximum LUN count.
   //
-  return (targetID < kHyperVStorageMaxTargets);
+  return (targetID < _maxLuns);
 }
 
 void HyperVStorage::HandleInterruptRequest() {
@@ -161,11 +161,12 @@ void HyperVStorage::HandleInterruptRequest() {
 }
 
 SCSIInitiatorIdentifier HyperVStorage::ReportInitiatorIdentifier() {
-  return kHyperVStorageMaxTargets;
+  return _maxLuns;
 }
 
 SCSIDeviceIdentifier HyperVStorage::ReportHighestSupportedDeviceID() {
-  return kHyperVStorageMaxTargets - 1;
+  // Each Hyper-V LUN is treated as a separate target under macOS.
+  return _maxLuns - 1;
 }
 
 UInt32 HyperVStorage::ReportMaximumTaskCount() {
@@ -202,7 +203,8 @@ bool HyperVStorage::InitializeDMASpecification(IODMACommand *command) {
 }
 
 SCSILogicalUnitNumber HyperVStorage::ReportHBAHighestLogicalUnitNumber() {
-  return kHyperVStorageMaxLuns - 1;
+  // Report max LUN of 0 to macOS.
+  return 0;
 }
 
 SCSIServiceResponse HyperVStorage::AbortTaskRequest(SCSITargetIdentifier theT, SCSILogicalUnitNumber theL, SCSITaggedTaskIdentifier theQ) {
@@ -249,21 +251,22 @@ SCSIServiceResponse HyperVStorage::ProcessParallelTask(SCSIParallelTaskIdentifie
   }
 
   if (GetLogicalUnitNumber(parallelRequest) != 0) {
-    HVDBGLOG("LUN is non-zero");
+    HVSYSLOG("LUN is non-zero");
     return kSCSIServiceResponse_FUNCTION_REJECTED;
   }
 
   //
   // Create SCSI command execution packet.
+  // Each LUN is represented in macOS as a separate target, use that target ID for the LUN here.
   //
   packet.operation = kHyperVStoragePacketOperationExecuteSRB;
   packet.flags     = kHyperVStoragePacketFlagRequestCompletion;
 
-  packet.scsiRequest.targetID        = 0;
-  packet.scsiRequest.lun             = GetTargetIdentifier(parallelRequest);
-  packet.scsiRequest.senseInfoLength = _senseBufferSize;
+  packet.scsiRequest.targetID                = _targetId;
+  packet.scsiRequest.lun                     = GetTargetIdentifier(parallelRequest);
   packet.scsiRequest.win8Extension.srbFlags |= 0x00000008;
-  packet.scsiRequest.length = sizeof (packet.scsiRequest); // TODO
+  packet.scsiRequest.length                  = sizeof (packet.scsiRequest) - _packetSizeDelta;
+  packet.scsiRequest.senseInfoLength         = _senseBufferSize;
 
   //
   // Determine data direction flags.
@@ -285,7 +288,7 @@ SCSIServiceResponse HyperVStorage::ProcessParallelTask(SCSIParallelTaskIdentifie
       break;
 
     default:
-      HVDBGLOG("Bad data direction 0x%X", dataDirection);
+      HVSYSLOG("Bad data direction 0x%X", dataDirection);
       return kSCSIServiceResponse_FUNCTION_REJECTED;
   }
   HVDATADBGLOG("Sending command to LUN %u (direction %X) with request %p", packet.scsiRequest.lun,
@@ -309,7 +312,7 @@ SCSIServiceResponse HyperVStorage::ProcessParallelTask(SCSIParallelTaskIdentifie
   if (dataDirection != kSCSIDataTransfer_NoDataTransfer) {
     status = prepareDataTransfer(parallelRequest, &pagePacket, &pagePacketLength);
     if (status != kIOReturnSuccess) {
-      HVDBGLOG("Failed to prepare data transfer with status 0x%X", status);
+      HVSYSLOG("Failed to prepare data transfer with status 0x%X", status);
       return kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
     }
 
@@ -318,13 +321,13 @@ SCSIServiceResponse HyperVStorage::ProcessParallelTask(SCSIParallelTaskIdentifie
                                                       pagePacket, pagePacketLength, nullptr, 0,
                                                       (UInt64)parallelRequest);
     if (status != kIOReturnSuccess) {
-      HVDBGLOG("Failed to send data SCSI packet with status 0x%X", status);
+      HVSYSLOG("Failed to send data SCSI packet with status 0x%X", status);
       return kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
     }
   } else {
     status = _hvDevice->writeInbandPacketWithTransactionId(&packet, sizeof (packet) - _packetSizeDelta, (UInt64)parallelRequest, true);
     if (status != kIOReturnSuccess) {
-      HVDBGLOG("Failed to send non-data SCSI packet with status 0x%X", status);
+      HVSYSLOG("Failed to send non-data SCSI packet with status 0x%X", status);
       return kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
     }
   }

MacHyperVSupport/Storage/HyperVStorage.hpp

@@ -35,6 +35,9 @@ class HyperVStorage : public IOSCSIParallelInterfaceController {
   UInt32 _protocolVersion = 0;
   UInt32 _senseBufferSize = 0;
   UInt32 _packetSizeDelta = 0;
+  bool   _isIDE           = false;
+  UInt32 _maxLuns         = kHyperVStorageMaxLunsSCSI;
+  UInt8  _targetId        = 0;
 
   bool   _subChannelsSupported = false;
   UInt16 _maxSubChannels       = 0;

MacHyperVSupport/Storage/HyperVStoragePrivate.cpp

@@ -186,7 +186,7 @@ void HyperVStorage::setHBAInfo() {
     propString->release();
   }
 
-  propString = OSString::withCString(kHyperVStorageProduct);
+  propString = OSString::withCString(_isIDE ? kHyperVStorageProductIDE : kHyperVStorageProductSCSI);
   if (propString != nullptr) {
     SetHBAProperty(kIOPropertyProductNameKey, propString);
     propString->release();
@@ -208,6 +208,18 @@ void HyperVStorage::setHBAInfo() {
 IOReturn HyperVStorage::connectStorage() {
   IOReturn            status;
   HyperVStoragePacket storPkt;
+  
+  //
+  // Check if we are actually an IDE controller.
+  // IDE supports one device only, and requires the target to be non-zero when communicating with Hyper-V.
+  //
+  _isIDE = (strcmp(_hvDevice->getTypeIdString(), kHyperVStorageGuidIDE)) == 0;
+  if (_isIDE) {
+    UInt8 *instanceId = (UInt8*)_hvDevice->getInstanceId();
+    _maxLuns = kHyperVStorageMaxLunsIDE;
+    _targetId = (instanceId[5] << 8) | instanceId[4];
+    HVDBGLOG("Storage controller is IDE, using target ID %u", _targetId);
+  }
 
   //
   // Begin controller initialization.
@@ -285,43 +297,42 @@ IOReturn HyperVStorage::connectStorage() {
 
 bool HyperVStorage::checkSCSIDiskPresent(UInt8 diskId) {
   IOReturn            status;
-  HyperVStoragePacket packet = { };
+  HyperVStoragePacket storPkt = { };
 
   //
   // Prepare SCSI request packet and flags.
   //
-  packet.operation = kHyperVStoragePacketOperationExecuteSRB;
-  packet.flags     = kHyperVStoragePacketFlagRequestCompletion;
+  storPkt.operation = kHyperVStoragePacketOperationExecuteSRB;
 
-  packet.scsiRequest.targetID                = 0;
-  packet.scsiRequest.lun                     = diskId;
-  packet.scsiRequest.win8Extension.srbFlags |= 0x00000008;
-  packet.scsiRequest.length                  = sizeof (packet.scsiRequest);
-  packet.scsiRequest.senseInfoLength         = _senseBufferSize;
-  packet.scsiRequest.dataIn                  = kHyperVStorageSCSIRequestTypeUnknown;
+  storPkt.scsiRequest.targetID                = _targetId;
+  storPkt.scsiRequest.lun                     = diskId;
+  storPkt.scsiRequest.win8Extension.srbFlags |= 0x00000008;
+  storPkt.scsiRequest.length                  = sizeof (storPkt.scsiRequest) - _packetSizeDelta;
+  storPkt.scsiRequest.senseInfoLength         = _senseBufferSize;
+  storPkt.scsiRequest.dataIn                  = kHyperVStorageSCSIRequestTypeUnknown;
 
   //
   // Set CDB to TEST UNIT READY command.
   //
-  packet.scsiRequest.cdb[0]    = kSCSICmd_TEST_UNIT_READY;
-  packet.scsiRequest.cdb[1]    = 0x00;
-  packet.scsiRequest.cdb[2]    = 0x00;
-  packet.scsiRequest.cdb[3]    = 0x00;
-  packet.scsiRequest.cdb[4]    = 0x00;
-  packet.scsiRequest.cdb[5]    = 0x00;
-  packet.scsiRequest.cdbLength = 6;
+  storPkt.scsiRequest.cdb[0]    = kSCSICmd_TEST_UNIT_READY;
+  storPkt.scsiRequest.cdb[1]    = 0x00;
+  storPkt.scsiRequest.cdb[2]    = 0x00;
+  storPkt.scsiRequest.cdb[3]    = 0x00;
+  storPkt.scsiRequest.cdb[4]    = 0x00;
+  storPkt.scsiRequest.cdb[5]    = 0x00;
+  storPkt.scsiRequest.cdbLength = 6;
 
   //
   // Send SCSI packet and check result to see if disk is present.
   //
-  status = _hvDevice->writeInbandPacket(&packet, sizeof (packet) - _packetSizeDelta, true, &packet, sizeof (packet));
+  status = sendStorageCommand(&storPkt, false);
   if (status != kIOReturnSuccess) {
     HVDBGLOG("Failed to send TEST UNIT READY SCSI packet with status 0x%X", status);
     return false;
   }
 
-  HVDBGLOG("Disk %u status: 0x%X SRB status: 0x%X", diskId, packet.scsiRequest.scsiStatus, packet.scsiRequest.srbStatus);
-  return packet.scsiRequest.srbStatus == kHyperVSRBStatusSuccess;
+  HVDBGLOG("Disk %u status: 0x%X SRB status: 0x%X", diskId, storPkt.scsiRequest.scsiStatus, storPkt.scsiRequest.srbStatus);
+  return storPkt.scsiRequest.srbStatus == kHyperVSRBStatusSuccess;
 }
 
 void HyperVStorage::startDiskEnumeration() {
@@ -333,9 +344,9 @@ void HyperVStorage::startDiskEnumeration() {
 }
 
 void HyperVStorage::scanSCSIDisks() {
-  HVDBGLOG("Starting disk scan of %u disks", kHyperVStorageMaxTargets);
+  HVDBGLOG("Starting disk scan of %u disks", _maxLuns);
 
-  for (UInt32 lun = 0; lun < kHyperVStorageMaxTargets; lun++) {
+  for (UInt32 lun = 0; lun < _maxLuns; lun++) {
     if (checkSCSIDiskPresent(lun)) {
       if (GetTargetForID(lun) == nullptr) {
         HVDBGLOG("Disk %u is newly added", lun);

MacHyperVSupport/Storage/HyperVStorageRegs.hpp

@@ -18,10 +18,13 @@
 #define kHyperVStorageMaxBufferLengthPadding  0x14
 
 #define kHyperVStorageVendor                  "Microsoft"
-#define kHyperVStorageProduct                 "Hyper-V SCSI Controller"
+#define kHyperVStorageProductSCSI             "Hyper-V SCSI Controller"
+#define kHyperVStorageProductIDE              "Hyper-V IDE Controller"
+#define kHyperVStorageGuidSCSI                "ba6163d9-04a1-4d29-b605-72e2ffb1dc7f"
+#define kHyperVStorageGuidIDE                 "32412632-86cb-44a2-9b5c-50d1417354f5"
 
-#define kHyperVStorageMaxTargets              64
-#define kHyperVStorageMaxLuns                 1
+#define kHyperVStorageMaxLunsSCSI             64
+#define kHyperVStorageMaxLunsIDE              1
 
 #define kHyperVStorageSegmentSize             PAGE_SIZE
 #define kHyperVStorageSegmentAlignment        0xFFFFFFFFFFFFF000ULL

MacHyperVSupport/VMBusDevice/HyperVVMBusDevice.hpp

@@ -168,6 +168,7 @@ class HyperVVMBusDevice : public IOService {
   IOReturn freeGPADLBuffer(UInt32 gpadlHandle);
   UInt32 getChannelId() { return _channelId; }
   uuid_t* getInstanceId() { return &_instanceId; }
+  char* getTypeIdString() { return _typeId; }
 
   //
   // Ring buffer.