\r
\r
#include <PiDxe.h>\r
+#include <Library/DebugLib.h>\r
#include <Library/ScsiLib.h>\r
#include <Library/BaseMemoryLib.h>\r
\r
-#include <IndustryStandard/scsi.h>\r
+#include <IndustryStandard/Scsi.h>\r
\r
\r
-/**
+/**\r
Function test the ready status of the SCSI unit.\r
-
- @param[in] ScsiIo A pointer to SCSI IO protocol.
- @param[in] Timeout The length of timeout period.
- @param[out] SenseData A pointer to output sense data.
- @param[out] SenseDataLength The length of output sense data.
- @param[out] HostAdapterStatus The status of Host Adapter.
- @param[out] TargetStatus The status of the target.
-
+\r
+ @param[in] ScsiIo A pointer to SCSI IO protocol.\r
+ @param[in] Timeout The length of timeout period.\r
+ @param[in out] SenseData A pointer to the sense data that \r
+ was generated by the execution of the SCSI Request Packet.\r
+ @param[in out] SenseDataLength On input, the length in bytes of the SenseData buffer. On\r
+ output, the number of bytes written to the SenseData buffer.\r
+ @param[out] HostAdapterStatus The status of Host Adapter.\r
+ @param[out] TargetStatus The status of the target.\r
+\r
@retval EFI_SUCCESS The status of the unit is tested successfully.\r
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, \r
but the entire DataBuffer could not be transferred.\r
queued.\r
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send \r
the SCSI Request Packet.\r
- @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid. \r
+ @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid, or ScsiIo is NULL. \r
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet\r
is not supported by the SCSI initiator(i.e., SCSI \r
Host Controller).\r
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI \r
Request Packet to execute.\r
-
+\r
**/\r
EFI_STATUS\r
+EFIAPI\r
ScsiTestUnitReadyCommand (\r
IN EFI_SCSI_IO_PROTOCOL *ScsiIo,\r
IN UINT64 Timeout,\r
- OUT VOID *SenseData,\r
- OUT UINT8 *SenseDataLength,\r
+ IN OUT VOID *SenseData,\r
+ IN OUT UINT8 *SenseDataLength,\r
OUT UINT8 *HostAdapterStatus,\r
OUT UINT8 *TargetStatus\r
)\r
EFI_STATUS Status;\r
UINT8 Cdb[6];\r
\r
+ ASSERT (SenseDataLength != NULL);\r
+ ASSERT (HostAdapterStatus != NULL);\r
+ ASSERT (TargetStatus != NULL);\r
+ \r
+ if (ScsiIo == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
\r
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));\r
ZeroMem (Cdb, 6);\r
}\r
\r
\r
-/**
+/**\r
Function to submit SCSI inquiry command.\r
-
- @param[in] ScsiIo SCSI IO Protocol to use
- @param[in] Timeout The length of timeout period.
- @param[out] SenseData A pointer to output sense data.
- @param[in,out] SenseDataLength The length of output sense data.
- @param[out] HostAdapterStatus The status of Host Adapter.
- @param[out] TargetStatus The status of the target.
- @param[in,out] InquirydataBuffer A pointer to inquiry data buffer.
- @param[in,out] InquiryDataLength The length of inquiry data buffer.
- @param[in] EnableVitalProductData Boolean to enable Vital Product Data.
-
+\r
+ @param[in] ScsiIo SCSI IO Protocol to use\r
+ @param[in] Timeout The length of timeout period.\r
+ @param[out] SenseData A pointer to output sense data.\r
+ @param[in out] SenseDataLength On input, the length in bytes of the SenseData buffer. On\r
+ output, the number of bytes written to the SenseData buffer.\r
+ @param[out] HostAdapterStatus The status of Host Adapter.\r
+ @param[out] TargetStatus The status of the target.\r
+ @param[in] InquirydataBuffer A pointer to inquiry data buffer.\r
+ @param[in,out] InquiryDataLength The length of inquiry data buffer.\r
+ @param[in] EnableVitalProductData Boolean to enable Vital Product Data.\r
+\r
@retval EFI_SUCCESS The status of the unit is tested successfully.\r
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, \r
but the entire DataBuffer could not be transferred.\r
queued.\r
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send \r
the SCSI Request Packet.\r
- @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid. \r
+ @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid, or ScsiIo is NULL.\r
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet\r
is not supported by the SCSI initiator(i.e., SCSI \r
Host Controller).\r
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI \r
Request Packet to execute.\r
-
+\r
**/\r
EFI_STATUS\r
+EFIAPI\r
ScsiInquiryCommand (\r
IN EFI_SCSI_IO_PROTOCOL *ScsiIo,\r
IN UINT64 Timeout,\r
IN OUT UINT8 *SenseDataLength,\r
OUT UINT8 *HostAdapterStatus,\r
OUT UINT8 *TargetStatus,\r
- IN OUT VOID *InquiryDataBuffer,\r
+ IN VOID *InquiryDataBuffer,\r
IN OUT UINT32 *InquiryDataLength,\r
IN BOOLEAN EnableVitalProductData\r
)\r
EFI_STATUS Status;\r
UINT8 Cdb[6];\r
\r
+ ASSERT (SenseDataLength != NULL);\r
+ ASSERT (HostAdapterStatus != NULL);\r
+ ASSERT (TargetStatus != NULL);\r
+ ASSERT (InquiryDataLength != NULL);\r
+ \r
+ if (ScsiIo == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));\r
ZeroMem (Cdb, 6);\r
\r
}\r
\r
\r
-/**
+/**\r
Function to submit SCSI mode sense 10 command.\r
-
- @param[in] ScsiIo A pointer to SCSI IO protocol.
- @param[in] Timeout The length of timeout period.
- @param[out] SenseData A pointer to output sense data.
- @param[in,out] SenseDataLength The length of output sense data.
- @param[out] HostAdapterStatus The status of Host Adapter.
- @param[out] TargetStatus The status of the target.
- @param[in] DataBuffer A pointer to input data buffer.
- @param[in,out] DataLength The length of input data buffer.
- @param[in] DBDField The DBD Field (Optional).
- @param[in] PageControl Page Control.
- @param[in] PageCode Page code.
-
+\r
+ @param[in] ScsiIo A pointer to SCSI IO protocol.\r
+ @param[in] Timeout The length of timeout period.\r
+ @param[out] SenseData A pointer to output sense data.\r
+ @param[in out] SenseDataLength On input, the length in bytes of the SenseData buffer. On\r
+ output, the number of bytes written to the SenseData buffer.\r
+ @param[out] HostAdapterStatus The status of Host Adapter.\r
+ @param[out] TargetStatus The status of the target.\r
+ @param[in] DataBuffer A pointer to input data buffer.\r
+ @param[in,out] DataLength The length of input data buffer.\r
+ @param[in] DBDField The DBD Field (Optional).\r
+ @param[in] PageControl Page Control.\r
+ @param[in] PageCode Page code.\r
+\r
@retval EFI_SUCCESS The status of the unit is tested successfully.\r
- @retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, \r
+ @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, \r
but the entire DataBuffer could not be transferred.\r
The actual number of bytes transferred is returned\r
in TransferLength.\r
queued.\r
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send \r
the SCSI Request Packet.\r
- @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid. \r
+ @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid, or ScsiIo is NULL. \r
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet\r
is not supported by the SCSI initiator(i.e., SCSI \r
Host Controller).\r
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI \r
Request Packet to execute.\r
-
+\r
**/\r
EFI_STATUS\r
+EFIAPI\r
ScsiModeSense10Command (\r
IN EFI_SCSI_IO_PROTOCOL *ScsiIo,\r
IN UINT64 Timeout,\r
EFI_STATUS Status;\r
UINT8 Cdb[10];\r
\r
+ ASSERT (SenseDataLength != NULL);\r
+ ASSERT (HostAdapterStatus != NULL);\r
+ ASSERT (TargetStatus != NULL);\r
+ ASSERT (DataLength != NULL);\r
+ \r
+ if (ScsiIo == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));\r
ZeroMem (Cdb, 10);\r
\r
}\r
\r
\r
-/**
+/**\r
Function to submit SCSI request sense command.\r
- ScsiIo - A pointer to SCSI IO protocol.\r
- Timeout - The length of timeout period.\r
- SenseData - A pointer to output sense data.\r
- SenseDataLength - The length of output sense data.\r
- HostAdapterStatus - The status of Host Adapter.\r
- TargetStatus - The status of the target.\r
-
- @param[in] ScsiIo SCSI IO Protocol to use
- @param[in] Timeout TODO:
- @param[out] SenseData TODO:
- @param[in,out] SenseDataLength TODO:
- @param[out] HostAdapterStatus TODO:
- @param[out] TargetStatus TODO:
-
- @retval EFI_SUCCESS Valid data returned
+\r
+ @param[in] ScsiIo A pointer to SCSI IO protocol.\r
+ @param[in] Timeout The length of timeout period.\r
+ @param[in] SenseData A pointer to output sense data.\r
+ @param[in out] SenseDataLength On input, the length in bytes of the SenseData buffer. On\r
+ output, the number of bytes written to the SenseData buffer.\r
+ @param[out] HostAdapterStatus The status of Host Adapter.\r
+ @param[out] TargetStatus The status of the target.\r
+\r
+ @retval EFI_SUCCESS Valid data returned\r
@retval EFI_SUCCESS The status of the unit is tested successfully.\r
- @retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, \r
+ @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, \r
but the entire DataBuffer could not be transferred.\r
The actual number of bytes transferred is returned\r
in TransferLength.\r
queued.\r
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send \r
the SCSI Request Packet.\r
- @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid. \r
+ @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid, or ScsiIo is NULL.\r
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet\r
is not supported by the SCSI initiator(i.e., SCSI \r
Host Controller).\r
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI \r
Request Packet to execute.\r
-
+\r
**/\r
EFI_STATUS\r
+EFIAPI\r
ScsiRequestSenseCommand (\r
IN EFI_SCSI_IO_PROTOCOL *ScsiIo,\r
IN UINT64 Timeout,\r
EFI_STATUS Status;\r
UINT8 Cdb[6];\r
\r
+ ASSERT (SenseDataLength != NULL);\r
+ ASSERT (HostAdapterStatus != NULL);\r
+ ASSERT (TargetStatus != NULL);\r
+ \r
+ if (ScsiIo == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));\r
ZeroMem (Cdb, 6);\r
\r
}\r
\r
\r
-/**
+/**\r
Function to submit read capacity command.\r
\r
- @param[in] ScsiIo A pointer to SCSI IO protocol.
- @param[in] Timeout The length of timeout period.
- @param[out] SenseData A pointer to output sense data.
- @param[in,out] SenseDataLength The length of output sense data.
- @param[out] HostAdapterStatus The status of Host Adapter.
- @param[out] TargetStatus The status of the target.
- @param[out] DataBuffer A pointer to a data buffer.
- @param[in,out] DataLength The length of data buffer.
- @param[in] PMI Partial medium indicator.
-
+ @param[in] ScsiIo A pointer to SCSI IO protocol.\r
+ @param[in] Timeout The length of timeout period.\r
+ @param[out] SenseData A pointer to output sense data.\r
+ @param[in out] SenseDataLength On input, the length in bytes of the SenseData buffer. On\r
+ output, the number of bytes written to the SenseData buffer.\r
+ @param[out] HostAdapterStatus The status of Host Adapter.\r
+ @param[out] TargetStatus The status of the target.\r
+ @param[out] DataBuffer A pointer to a data buffer.\r
+ @param[in,out] DataLength The length of data buffer.\r
+ @param[in] PMI Partial medium indicator.\r
+\r
@retval EFI_SUCCESS The status of the unit is tested successfully.\r
- @retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, \r
+ @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, \r
but the entire DataBuffer could not be transferred.\r
The actual number of bytes transferred is returned\r
in TransferLength.\r
queued.\r
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send \r
the SCSI Request Packet.\r
- @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid. \r
+ @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid, or ScsiIo is NULL.\r
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet\r
is not supported by the SCSI initiator(i.e., SCSI \r
Host Controller).\r
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI \r
Request Packet to execute.\r
-
+\r
**/\r
EFI_STATUS\r
+EFIAPI\r
ScsiReadCapacityCommand (\r
IN EFI_SCSI_IO_PROTOCOL *ScsiIo,\r
IN UINT64 Timeout,\r
EFI_STATUS Status;\r
UINT8 Cdb[10];\r
\r
+ ASSERT (SenseDataLength != NULL);\r
+ ASSERT (HostAdapterStatus != NULL);\r
+ ASSERT (TargetStatus != NULL);\r
+ ASSERT (DataLength != NULL);\r
+ \r
+ if (ScsiIo == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));\r
ZeroMem (Cdb, 10);\r
\r
}\r
\r
\r
-/**
+/**\r
Function to submit read 10 command.\r
-
- @param[in] ScsiIo A pointer to SCSI IO protocol.
- @param[in] Timeout The length of timeout period.
- @param[out] SenseData A pointer to output sense data.
- @param[in,out] SenseDataLength The length of output sense data.
- @param[out] HostAdapterStatus The status of Host Adapter.
- @param[out] TargetStatus The status of the target.
- @param[out] DataBuffer Read 10 command data.
- @param[in,out] DataLength The length of data buffer.
- @param[in] StartLba The start address of LBA.
- @param[in] SectorSize The sector size.
-
+\r
+ @param[in] ScsiIo A pointer to SCSI IO protocol.\r
+ @param[in] Timeout The length of timeout period.\r
+ @param[out] SenseData A pointer to output sense data.\r
+ @param[in out] SenseDataLength On input, the length in bytes of the SenseData buffer. On\r
+ output, the number of bytes written to the SenseData buffer.\r
+ @param[out] HostAdapterStatus The status of Host Adapter.\r
+ @param[out] TargetStatus The status of the target.\r
+ @param[out] DataBuffer Read 10 command data.\r
+ @param[in,out] DataLength The length of data buffer.\r
+ @param[in] StartLba The start address of LBA.\r
+ @param[in] SectorSize The sector size.\r
+\r
@retval EFI_SUCCESS The status of the unit is tested successfully.\r
- @retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, \r
+ @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, \r
but the entire DataBuffer could not be transferred.\r
The actual number of bytes transferred is returned\r
in TransferLength.\r
queued.\r
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send \r
the SCSI Request Packet.\r
- @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid. \r
+ @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid, or ScsiIo is NULL.\r
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet\r
is not supported by the SCSI initiator(i.e., SCSI \r
Host Controller).\r
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI \r
Request Packet to execute.\r
-
+\r
**/\r
EFI_STATUS\r
+EFIAPI\r
ScsiRead10Command (\r
IN EFI_SCSI_IO_PROTOCOL *ScsiIo,\r
IN UINT64 Timeout,\r
EFI_STATUS Status;\r
UINT8 Cdb[10];\r
\r
+ ASSERT (SenseDataLength != NULL);\r
+ ASSERT (HostAdapterStatus != NULL);\r
+ ASSERT (TargetStatus != NULL);\r
+ ASSERT (DataLength != NULL);\r
+ \r
+ if (ScsiIo == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));\r
ZeroMem (Cdb, 10);\r
\r
}\r
\r
\r
-/**
+/**\r
Function to submit SCSI write 10 command.\r
-
- @param[in] ScsiIo SCSI IO Protocol to use
- @param[in] Timeout The length of timeout period.
- @param[out] SenseData A pointer to output sense data.
- @param[in,out] SenseDataLength The length of output sense data.
- @param[out] HostAdapterStatus The status of Host Adapter.
- @param[out] TargetStatus The status of the target.
- @param[out] DataBuffer A pointer to a data buffer.
- @param[in,out] DataLength The length of data buffer.
- @param[in] StartLba The start address of LBA.
- @param[in] SectorSize The sector size.
-
+\r
+ @param[in] ScsiIo SCSI IO Protocol to use\r
+ @param[in] Timeout The length of timeout period.\r
+ @param[out] SenseData A pointer to output sense data.\r
+ @param[in out] SenseDataLength On input, the length in bytes of the SenseData buffer. On\r
+ output, the number of bytes written to the SenseData buffer.\r
+ @param[out] HostAdapterStatus The status of Host Adapter.\r
+ @param[out] TargetStatus The status of the target.\r
+ @param[out] DataBuffer A pointer to a data buffer.\r
+ @param[in,out] DataLength The length of data buffer.\r
+ @param[in] StartLba The start address of LBA.\r
+ @param[in] SectorSize The sector size.\r
+\r
@retval EFI_SUCCESS The status of the unit is tested successfully.\r
- @retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, \r
+ @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, \r
but the entire DataBuffer could not be transferred.\r
The actual number of bytes transferred is returned\r
in InTransferLength.\r
queued.\r
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send \r
the SCSI Request Packet.\r
- @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid. \r
+ @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid, or ScsiIo is NULL.\r
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet\r
is not supported by the SCSI initiator(i.e., SCSI \r
Host Controller).\r
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI \r
Request Packet to execute.\r
-
+\r
**/\r
EFI_STATUS\r
+EFIAPI\r
ScsiWrite10Command (\r
IN EFI_SCSI_IO_PROTOCOL *ScsiIo,\r
IN UINT64 Timeout,\r
EFI_STATUS Status;\r
UINT8 Cdb[10];\r
\r
+ ASSERT (SenseDataLength != NULL);\r
+ ASSERT (HostAdapterStatus != NULL);\r
+ ASSERT (TargetStatus != NULL);\r
+ ASSERT (DataLength != NULL);\r
+ \r
+ if (ScsiIo == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));\r
ZeroMem (Cdb, 10);\r
\r
*HostAdapterStatus = CommandPacket.HostAdapterStatus;\r
*TargetStatus = CommandPacket.TargetStatus;\r
*SenseDataLength = CommandPacket.SenseDataLength;\r
- *DataLength = CommandPacket.InTransferLength;\r
+ *DataLength = CommandPacket.OutTransferLength;\r
\r
return Status;\r
}\r
+\r
projects / mirror_edk2.git / blobdiff