// Ext SCSI Pass Thru utilities\r
//\r
\r
+/**\r
+ Reads a 32-bit value into BAR0 using MMIO\r
+**/\r
+STATIC\r
+EFI_STATUS\r
+PvScsiMmioRead32 (\r
+ IN CONST PVSCSI_DEV *Dev,\r
+ IN UINT64 Offset,\r
+ OUT UINT32 *Value\r
+ )\r
+{\r
+ return Dev->PciIo->Mem.Read (\r
+ Dev->PciIo,\r
+ EfiPciIoWidthUint32,\r
+ PCI_BAR_IDX0,\r
+ Offset,\r
+ 1, // Count\r
+ Value\r
+ );\r
+}\r
+\r
/**\r
Writes a 32-bit value into BAR0 using MMIO\r
**/\r
return PvScsiWriteCmdDesc (Dev, PvScsiCmdAdapterReset, NULL, 0);\r
}\r
\r
+/**\r
+ Returns if PVSCSI request ring is full\r
+**/\r
+STATIC\r
+BOOLEAN\r
+PvScsiIsReqRingFull (\r
+ IN CONST PVSCSI_DEV *Dev\r
+ )\r
+{\r
+ PVSCSI_RINGS_STATE *RingsState;\r
+ UINT32 ReqNumEntries;\r
+\r
+ RingsState = Dev->RingDesc.RingState;\r
+ ReqNumEntries = 1U << RingsState->ReqNumEntriesLog2;\r
+ return (RingsState->ReqProdIdx - RingsState->CmpConsIdx) >= ReqNumEntries;\r
+}\r
+\r
+/**\r
+ Returns pointer to current request descriptor to produce\r
+**/\r
+STATIC\r
+PVSCSI_RING_REQ_DESC *\r
+PvScsiGetCurrentRequest (\r
+ IN CONST PVSCSI_DEV *Dev\r
+ )\r
+{\r
+ PVSCSI_RINGS_STATE *RingState;\r
+ UINT32 ReqNumEntries;\r
+\r
+ RingState = Dev->RingDesc.RingState;\r
+ ReqNumEntries = 1U << RingState->ReqNumEntriesLog2;\r
+ return Dev->RingDesc.RingReqs +\r
+ (RingState->ReqProdIdx & (ReqNumEntries - 1));\r
+}\r
+\r
+/**\r
+ Returns pointer to current completion descriptor to consume\r
+**/\r
+STATIC\r
+PVSCSI_RING_CMP_DESC *\r
+PvScsiGetCurrentResponse (\r
+ IN CONST PVSCSI_DEV *Dev\r
+ )\r
+{\r
+ PVSCSI_RINGS_STATE *RingState;\r
+ UINT32 CmpNumEntries;\r
+\r
+ RingState = Dev->RingDesc.RingState;\r
+ CmpNumEntries = 1U << RingState->CmpNumEntriesLog2;\r
+ return Dev->RingDesc.RingCmps +\r
+ (RingState->CmpConsIdx & (CmpNumEntries - 1));\r
+}\r
+\r
+/**\r
+ Wait for device to signal completion of submitted requests\r
+**/\r
+STATIC\r
+EFI_STATUS\r
+PvScsiWaitForRequestCompletion (\r
+ IN CONST PVSCSI_DEV *Dev\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ UINT32 IntrStatus;\r
+\r
+ //\r
+ // Note: We don't yet support Timeout according to\r
+ // EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET.Timeout.\r
+ //\r
+ // This is consistent with some other Scsi PassThru drivers\r
+ // such as VirtioScsi.\r
+ //\r
+ for (;;) {\r
+ Status = PvScsiMmioRead32 (Dev, PvScsiRegOffsetIntrStatus, &IntrStatus);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // PVSCSI_INTR_CMPL_MASK is set if device completed submitted requests\r
+ //\r
+ if ((IntrStatus & PVSCSI_INTR_CMPL_MASK) != 0) {\r
+ break;\r
+ }\r
+\r
+ gBS->Stall (Dev->WaitForCmpStallInUsecs);\r
+ }\r
+\r
+ //\r
+ // Acknowledge PVSCSI_INTR_CMPL_MASK in device interrupt-status register\r
+ //\r
+ return PvScsiMmioWrite32 (\r
+ Dev,\r
+ PvScsiRegOffsetIntrStatus,\r
+ PVSCSI_INTR_CMPL_MASK\r
+ );\r
+}\r
+\r
+/**\r
+ Create a fake host adapter error\r
+**/\r
+STATIC\r
+EFI_STATUS\r
+ReportHostAdapterError (\r
+ OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet\r
+ )\r
+{\r
+ Packet->InTransferLength = 0;\r
+ Packet->OutTransferLength = 0;\r
+ Packet->SenseDataLength = 0;\r
+ Packet->HostAdapterStatus = EFI_EXT_SCSI_STATUS_HOST_ADAPTER_OTHER;\r
+ Packet->TargetStatus = EFI_EXT_SCSI_STATUS_TARGET_GOOD;\r
+ return EFI_DEVICE_ERROR;\r
+}\r
+\r
+/**\r
+ Create a fake host adapter overrun error\r
+**/\r
+STATIC\r
+EFI_STATUS\r
+ReportHostAdapterOverrunError (\r
+ OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet\r
+ )\r
+{\r
+ Packet->SenseDataLength = 0;\r
+ Packet->HostAdapterStatus =\r
+ EFI_EXT_SCSI_STATUS_HOST_ADAPTER_DATA_OVERRUN_UNDERRUN;\r
+ Packet->TargetStatus = EFI_EXT_SCSI_STATUS_TARGET_GOOD;\r
+ return EFI_BAD_BUFFER_SIZE;\r
+}\r
+\r
+/**\r
+ Populate a PVSCSI request descriptor from the Extended SCSI Pass Thru\r
+ Protocol packet.\r
+**/\r
+STATIC\r
+EFI_STATUS\r
+PopulateRequest (\r
+ IN CONST PVSCSI_DEV *Dev,\r
+ IN UINT8 *Target,\r
+ IN UINT64 Lun,\r
+ IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,\r
+ OUT PVSCSI_RING_REQ_DESC *Request\r
+ )\r
+{\r
+ UINT8 TargetValue;\r
+\r
+ //\r
+ // We only use first byte of target identifer\r
+ //\r
+ TargetValue = *Target;\r
+\r
+ //\r
+ // Check for unsupported requests\r
+ //\r
+ if (\r
+ //\r
+ // Bidirectional transfer was requested\r
+ //\r
+ (Packet->InTransferLength > 0 && Packet->OutTransferLength > 0) ||\r
+ (Packet->DataDirection == EFI_EXT_SCSI_DATA_DIRECTION_BIDIRECTIONAL) ||\r
+ //\r
+ // Command Descriptor Block bigger than this constant should be considered\r
+ // out-of-band. We currently don't support these CDBs.\r
+ //\r
+ (Packet->CdbLength > PVSCSI_CDB_MAX_SIZE)\r
+ ) {\r
+\r
+ //\r
+ // This error code doesn't require updates to the Packet output fields\r
+ //\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+\r
+ //\r
+ // Check for invalid parameters\r
+ //\r
+ if (\r
+ //\r
+ // Addressed invalid device\r
+ //\r
+ (TargetValue > Dev->MaxTarget) || (Lun > Dev->MaxLun) ||\r
+ //\r
+ // Invalid direction (there doesn't seem to be a macro for the "no data\r
+ // transferred" "direction", eg. for TEST UNIT READY)\r
+ //\r
+ (Packet->DataDirection > EFI_EXT_SCSI_DATA_DIRECTION_BIDIRECTIONAL) ||\r
+ //\r
+ // Trying to receive, but destination pointer is NULL, or contradicting\r
+ // transfer direction\r
+ //\r
+ ((Packet->InTransferLength > 0) &&\r
+ ((Packet->InDataBuffer == NULL) ||\r
+ (Packet->DataDirection == EFI_EXT_SCSI_DATA_DIRECTION_WRITE)\r
+ )\r
+ ) ||\r
+ //\r
+ // Trying to send, but source pointer is NULL, or contradicting\r
+ // transfer direction\r
+ //\r
+ ((Packet->OutTransferLength > 0) &&\r
+ ((Packet->OutDataBuffer == NULL) ||\r
+ (Packet->DataDirection == EFI_EXT_SCSI_DATA_DIRECTION_READ)\r
+ )\r
+ )\r
+ ) {\r
+\r
+ //\r
+ // This error code doesn't require updates to the Packet output fields\r
+ //\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ //\r
+ // Check for input/output buffer too large for DMA communication buffer\r
+ //\r
+ if (Packet->InTransferLength > sizeof (Dev->DmaBuf->Data)) {\r
+ Packet->InTransferLength = sizeof (Dev->DmaBuf->Data);\r
+ return ReportHostAdapterOverrunError (Packet);\r
+ }\r
+ if (Packet->OutTransferLength > sizeof (Dev->DmaBuf->Data)) {\r
+ Packet->OutTransferLength = sizeof (Dev->DmaBuf->Data);\r
+ return ReportHostAdapterOverrunError (Packet);\r
+ }\r
+\r
+ //\r
+ // Encode PVSCSI request\r
+ //\r
+ ZeroMem (Request, sizeof (*Request));\r
+\r
+ Request->Bus = 0;\r
+ Request->Target = TargetValue;\r
+ //\r
+ // This cast is safe as PVSCSI_DEV.MaxLun is defined as UINT8\r
+ //\r
+ Request->Lun[1] = (UINT8)Lun;\r
+ Request->SenseLen = Packet->SenseDataLength;\r
+ //\r
+ // DMA communication buffer SenseData overflow is not possible\r
+ // due to Packet->SenseDataLength defined as UINT8\r
+ //\r
+ Request->SenseAddr = PVSCSI_DMA_BUF_DEV_ADDR (Dev, SenseData);\r
+ Request->CdbLen = Packet->CdbLength;\r
+ CopyMem (Request->Cdb, Packet->Cdb, Packet->CdbLength);\r
+ Request->VcpuHint = 0;\r
+ Request->Tag = PVSCSI_SIMPLE_QUEUE_TAG;\r
+ if (Packet->DataDirection == EFI_EXT_SCSI_DATA_DIRECTION_READ) {\r
+ Request->Flags = PVSCSI_FLAG_CMD_DIR_TOHOST;\r
+ Request->DataLen = Packet->InTransferLength;\r
+ } else {\r
+ Request->Flags = PVSCSI_FLAG_CMD_DIR_TODEVICE;\r
+ Request->DataLen = Packet->OutTransferLength;\r
+ CopyMem (\r
+ Dev->DmaBuf->Data,\r
+ Packet->OutDataBuffer,\r
+ Packet->OutTransferLength\r
+ );\r
+ }\r
+ Request->DataAddr = PVSCSI_DMA_BUF_DEV_ADDR (Dev, Data);\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ Handle the PVSCSI device response:\r
+ - Copy returned data from DMA communication buffer.\r
+ - Update fields in Extended SCSI Pass Thru Protocol packet as required.\r
+ - Translate response code to EFI status code and host adapter status.\r
+**/\r
+STATIC\r
+EFI_STATUS\r
+HandleResponse (\r
+ IN PVSCSI_DEV *Dev,\r
+ IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,\r
+ IN CONST PVSCSI_RING_CMP_DESC *Response\r
+ )\r
+{\r
+ //\r
+ // Fix SenseDataLength to amount of data returned\r
+ //\r
+ if (Packet->SenseDataLength > Response->SenseLen) {\r
+ Packet->SenseDataLength = (UINT8)Response->SenseLen;\r
+ }\r
+ //\r
+ // Copy sense data from DMA communication buffer\r
+ //\r
+ CopyMem (\r
+ Packet->SenseData,\r
+ Dev->DmaBuf->SenseData,\r
+ Packet->SenseDataLength\r
+ );\r
+\r
+ //\r
+ // Copy device output from DMA communication buffer\r
+ //\r
+ if (Packet->DataDirection == EFI_EXT_SCSI_DATA_DIRECTION_READ) {\r
+ CopyMem (Packet->InDataBuffer, Dev->DmaBuf->Data, Packet->InTransferLength);\r
+ }\r
+\r
+ //\r
+ // Report target status\r
+ //\r
+ Packet->TargetStatus = Response->ScsiStatus;\r
+\r
+ //\r
+ // Host adapter status and function return value depend on\r
+ // device response's host status\r
+ //\r
+ switch (Response->HostStatus) {\r
+ case PvScsiBtStatSuccess:\r
+ case PvScsiBtStatLinkedCommandCompleted:\r
+ case PvScsiBtStatLinkedCommandCompletedWithFlag:\r
+ Packet->HostAdapterStatus = EFI_EXT_SCSI_STATUS_HOST_ADAPTER_OK;\r
+ return EFI_SUCCESS;\r
+\r
+ case PvScsiBtStatDataUnderrun:\r
+ //\r
+ // Report transferred amount in underrun\r
+ //\r
+ if (Packet->DataDirection == EFI_EXT_SCSI_DATA_DIRECTION_READ) {\r
+ Packet->InTransferLength = (UINT32)Response->DataLen;\r
+ } else {\r
+ Packet->OutTransferLength = (UINT32)Response->DataLen;\r
+ }\r
+ Packet->HostAdapterStatus =\r
+ EFI_EXT_SCSI_STATUS_HOST_ADAPTER_DATA_OVERRUN_UNDERRUN;\r
+ return EFI_SUCCESS;\r
+\r
+ case PvScsiBtStatDatarun:\r
+ Packet->HostAdapterStatus =\r
+ EFI_EXT_SCSI_STATUS_HOST_ADAPTER_DATA_OVERRUN_UNDERRUN;\r
+ return EFI_SUCCESS;\r
+\r
+ case PvScsiBtStatSelTimeout:\r
+ Packet->HostAdapterStatus =\r
+ EFI_EXT_SCSI_STATUS_HOST_ADAPTER_SELECTION_TIMEOUT;\r
+ return EFI_TIMEOUT;\r
+\r
+ case PvScsiBtStatBusFree:\r
+ Packet->HostAdapterStatus = EFI_EXT_SCSI_STATUS_HOST_ADAPTER_BUS_FREE;\r
+ break;\r
+\r
+ case PvScsiBtStatInvPhase:\r
+ Packet->HostAdapterStatus = EFI_EXT_SCSI_STATUS_HOST_ADAPTER_PHASE_ERROR;\r
+ break;\r
+\r
+ case PvScsiBtStatSensFailed:\r
+ Packet->HostAdapterStatus =\r
+ EFI_EXT_SCSI_STATUS_HOST_ADAPTER_REQUEST_SENSE_FAILED;\r
+ break;\r
+\r
+ case PvScsiBtStatTagReject:\r
+ case PvScsiBtStatBadMsg:\r
+ Packet->HostAdapterStatus =\r
+ EFI_EXT_SCSI_STATUS_HOST_ADAPTER_MESSAGE_REJECT;\r
+ break;\r
+\r
+ case PvScsiBtStatBusReset:\r
+ Packet->HostAdapterStatus = EFI_EXT_SCSI_STATUS_HOST_ADAPTER_BUS_RESET;\r
+ break;\r
+\r
+ case PvScsiBtStatHaTimeout:\r
+ Packet->HostAdapterStatus = EFI_EXT_SCSI_STATUS_HOST_ADAPTER_TIMEOUT;\r
+ return EFI_TIMEOUT;\r
+\r
+ case PvScsiBtStatScsiParity:\r
+ Packet->HostAdapterStatus = EFI_EXT_SCSI_STATUS_HOST_ADAPTER_PARITY_ERROR;\r
+ break;\r
+\r
+ default:\r
+ Packet->HostAdapterStatus = EFI_EXT_SCSI_STATUS_HOST_ADAPTER_OTHER;\r
+ break;\r
+ }\r
+\r
+ return EFI_DEVICE_ERROR;\r
+}\r
+\r
/**\r
Check if Target argument to EXT_SCSI_PASS_THRU.GetNextTarget() and\r
EXT_SCSI_PASS_THRU.GetNextTargetLun() is initialized\r
IN EFI_EVENT Event OPTIONAL\r
)\r
{\r
- return EFI_UNSUPPORTED;\r
+ PVSCSI_DEV *Dev;\r
+ EFI_STATUS Status;\r
+ PVSCSI_RING_REQ_DESC *Request;\r
+ PVSCSI_RING_CMP_DESC *Response;\r
+\r
+ Dev = PVSCSI_FROM_PASS_THRU (This);\r
+\r
+ if (PvScsiIsReqRingFull (Dev)) {\r
+ return EFI_NOT_READY;\r
+ }\r
+\r
+ Request = PvScsiGetCurrentRequest (Dev);\r
+\r
+ Status = PopulateRequest (Dev, Target, Lun, Packet, Request);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // Writes to Request must be globally visible before making request\r
+ // available to device\r
+ //\r
+ MemoryFence ();\r
+ Dev->RingDesc.RingState->ReqProdIdx++;\r
+\r
+ Status = PvScsiMmioWrite32 (Dev, PvScsiRegOffsetKickRwIo, 0);\r
+ if (EFI_ERROR (Status)) {\r
+ //\r
+ // If kicking the host fails, we must fake a host adapter error.\r
+ // EFI_NOT_READY would save us the effort, but it would also suggest that\r
+ // the caller retry.\r
+ //\r
+ return ReportHostAdapterError (Packet);\r
+ }\r
+\r
+ Status = PvScsiWaitForRequestCompletion (Dev);\r
+ if (EFI_ERROR (Status)) {\r
+ //\r
+ // If waiting for request completion fails, we must fake a host adapter\r
+ // error. EFI_NOT_READY would save us the effort, but it would also suggest\r
+ // that the caller retry.\r
+ //\r
+ return ReportHostAdapterError (Packet);\r
+ }\r
+\r
+ Response = PvScsiGetCurrentResponse (Dev);\r
+ Status = HandleResponse (Dev, Packet, Response);\r
+\r
+ //\r
+ // Reads from response must complete before releasing completion entry\r
+ // to device\r
+ //\r
+ MemoryFence ();\r
+ Dev->RingDesc.RingState->CmpConsIdx++;\r
+\r
+ return Status;\r
}\r
\r
STATIC\r
//\r
Dev->MaxTarget = PcdGet8 (PcdPvScsiMaxTargetLimit);\r
Dev->MaxLun = PcdGet8 (PcdPvScsiMaxLunLimit);\r
+ Dev->WaitForCmpStallInUsecs = PcdGet32 (PcdPvScsiWaitForCmpStallInUsecs);\r
\r
//\r
// Set PCI Attributes\r
goto RestorePciAttributes;\r
}\r
\r
+ //\r
+ // Allocate DMA communication buffer\r
+ //\r
+ Status = PvScsiAllocateSharedPages (\r
+ Dev,\r
+ EFI_SIZE_TO_PAGES (sizeof (*Dev->DmaBuf)),\r
+ (VOID **)&Dev->DmaBuf,\r
+ &Dev->DmaBufDmaDesc\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ goto FreeRings;\r
+ }\r
+\r
//\r
// Populate the exported interface's attributes\r
//\r
\r
return EFI_SUCCESS;\r
\r
+FreeRings:\r
+ //\r
+ // Reset device to stop device usage of the rings.\r
+ // This is required to safely free the rings.\r
+ //\r
+ PvScsiResetAdapter (Dev);\r
+\r
+ PvScsiFreeRings (Dev);\r
+\r
RestorePciAttributes:\r
PvScsiRestorePciAttributes (Dev);\r
\r
)\r
{\r
//\r
- // Reset device to stop device usage of the rings.\r
- // This is required to safely free the rings.\r
+ // Reset device to:\r
+ // - Make device stop processing all requests.\r
+ // - Stop device usage of the rings.\r
+ //\r
+ // This is required to safely free the DMA communication buffer\r
+ // and the rings.\r
//\r
PvScsiResetAdapter (Dev);\r
\r
+ //\r
+ // Free DMA communication buffer\r
+ //\r
+ PvScsiFreeSharedPages (\r
+ Dev,\r
+ EFI_SIZE_TO_PAGES (sizeof (*Dev->DmaBuf)),\r
+ Dev->DmaBuf,\r
+ &Dev->DmaBufDmaDesc\r
+ );\r
+\r
PvScsiFreeRings (Dev);\r
\r
PvScsiRestorePciAttributes (Dev);\r
}\r
\r
+/**\r
+ Event notification called by ExitBootServices()\r
+**/\r
+STATIC\r
+VOID\r
+EFIAPI\r
+PvScsiExitBoot (\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
+ )\r
+{\r
+ PVSCSI_DEV *Dev;\r
+\r
+ Dev = Context;\r
+ DEBUG ((DEBUG_VERBOSE, "%a: Context=0x%p\n", __FUNCTION__, Context));\r
+\r
+ //\r
+ // Reset the device to stop device usage of the rings.\r
+ //\r
+ // We allocated said rings in EfiBootServicesData type memory, and code\r
+ // executing after ExitBootServices() is permitted to overwrite it.\r
+ //\r
+ PvScsiResetAdapter (Dev);\r
+}\r
+\r
//\r
// Driver Binding\r
//\r
goto ClosePciIo;\r
}\r
\r
+ Status = gBS->CreateEvent (\r
+ EVT_SIGNAL_EXIT_BOOT_SERVICES,\r
+ TPL_CALLBACK,\r
+ &PvScsiExitBoot,\r
+ Dev,\r
+ &Dev->ExitBoot\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ goto UninitDev;\r
+ }\r
+\r
//\r
// Setup complete, attempt to export the driver instance's PassThru interface\r
//\r
&Dev->PassThru\r
);\r
if (EFI_ERROR (Status)) {\r
- goto UninitDev;\r
+ goto CloseExitBoot;\r
}\r
\r
return EFI_SUCCESS;\r
\r
+CloseExitBoot:\r
+ gBS->CloseEvent (Dev->ExitBoot);\r
+\r
UninitDev:\r
PvScsiUninit (Dev);\r
\r
return Status;\r
}\r
\r
+ gBS->CloseEvent (Dev->ExitBoot);\r
+\r
PvScsiUninit (Dev);\r
\r
gBS->CloseProtocol (\r
projects / mirror_edk2.git / blobdiff