diff options
| author | jji4 <jji4@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-11-17 11:24:14 +0000 |
|---|---|---|
| committer | jji4 <jji4@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-11-17 11:24:14 +0000 |
| commit | d5954c618f10c9f75a4d125985550e694c7a3f22 (patch) | |
| tree | 7e214f4bdcbac1a2ce030189f783339f5c42294b /MdePkg/Library/UefiScsiLib | |
| parent | 17f695ed2b6749fa09e9c86b9784c99d3c08e547 (diff) | |
| download | edk2-d5954c618f10c9f75a4d125985550e694c7a3f22.tar.gz edk2-d5954c618f10c9f75a4d125985550e694c7a3f22.tar.bz2 edk2-d5954c618f10c9f75a4d125985550e694c7a3f22.zip | |
Code Scrub:
The code of MdePkg\Library\UefiScsiLib\ and MdePkg\Library\UefiUsbLib has been checked and modified according to MDE_Library_Spec_0.61h-4.doc.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6561 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Library/UefiScsiLib')
| -rw-r--r-- | MdePkg/Library/UefiScsiLib/UefiScsiLib.c | 598 |
1 files changed, 339 insertions, 259 deletions
diff --git a/MdePkg/Library/UefiScsiLib/UefiScsiLib.c b/MdePkg/Library/UefiScsiLib/UefiScsiLib.c index a90a37b74d..3b4da1fb0e 100644 --- a/MdePkg/Library/UefiScsiLib/UefiScsiLib.c +++ b/MdePkg/Library/UefiScsiLib/UefiScsiLib.c @@ -17,72 +17,105 @@ #include <Library/DebugLib.h>
#include <Library/UefiScsiLib.h>
#include <Library/BaseMemoryLib.h>
-
+
#include <IndustryStandard/Scsi.h>
-
-//
-// Max bytes needed to represent ID of a SCSI device
-//
+
+
+ //
+ // Max bytes needed to represent ID of a SCSI device
+ //
#define EFI_SCSI_TARGET_MAX_BYTES (0x10)
-
-//
-// bit5..7 are for Logical unit number
-// 11100000b (0xe0)
-//
+
+ //
+ // bit5..7 are for Logical unit number
+ // 11100000b (0xe0)
+ //
#define EFI_SCSI_LOGICAL_UNIT_NUMBER_MASK 0xe0
-
-//
-// Scsi Command Length six or ten
-//
+
+ //
+ // Scsi Command Length six or ten
+ //
#define EFI_SCSI_OP_LENGTH_SIX 0x6
#define EFI_SCSI_OP_LENGTH_TEN 0xa
-/**
- Function test the ready status of the SCSI unit.
- Submit SCSI test unit ready command with SCSI request packet specified by this scsi command, TimeOut
- and SenseData, then get the status of the target Scsi unit.
- If SenseDataLength is NULL, then ASSERT().
+/**
+ Execute Test Unit Ready SCSI command on a specific SCSI target.
+ Executes the Test Unit Ready command on the SCSI target specified by ScsiIo.
+ If Timeout is zero, then this function waits indefinitely for the command to complete.
+ If Timeout is greater than zero, then the command is executed and will timeout after Timeout 100 ns units.
+ If ScsiIo is NULL, then ASSERT().
+ If SenseDataLength is NULL, then ASSERT().
If HostAdapterStatus is NULL, then ASSERT().
-
If TargetStatus is NULL, then ASSERT().
- @param[in] ScsiIo A pointer to SCSI IO protocol.
- @param[in] Timeout The length of timeout period.
- @param[in] 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.
-
- @retval EFI_SUCCESS The status of the unit is tested successfully.
- @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
- but the entire DataBuffer could not be transferred.
- The actual number of bytes transferred is returned
- in InTransferLength.
- @retval EFI_NOT_READY The SCSI Request Packet could not be sent because
- there are too many SCSI Command Packets already
- queued.
- @retval EFI_DEVICE_ERROR A device error occurred while attempting to send
- the SCSI Request Packet.
- @retval EFI_INVALID_PARAMETER ScsiIo is NULL.
- @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
- is not supported by the SCSI initiator(i.e., SCSI
- Host Controller).
- @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
- Request Packet to execute.
+
+ @param[in] ScsiIo A pointer to the SCSI I/O Protocol instance
+ for the specific SCSI target.
+ @param[in] Timeout The timeout in 100 ns units to use for the execution
+ of this SCSI Request Packet. A Timeout value of
+ zero means that this function will wait indefinitely
+ for the SCSI Request Packet to execute. If Timeout
+ is greater than zero, then this function will return
+ EFI_TIMEOUT if the time required to execute the SCSI
+ Request Packet is greater than Timeout.
+ @param[in, out] SenseData A pointer to sense data that was generated by
+ the execution of the SCSI Request Packet. This
+ buffer must be allocated by the caller.
+ If SenseDataLength is 0, then this parameter is
+ optional and may be NULL.
+ @param[in, out] SenseDataLength On input, a pointer to the length in bytes of
+ the SenseData buffer. On output, a poiinter to
+ the number of bytes written to the SenseData buffer.
+ @param[out] HostAdapterStatus The status of the SCSI Host Controller that produces
+ the SCSI bus containing the SCSI target specified by
+ ScsiIo when the SCSI Request Packet was executed.
+ See the EFI SCSI I/O Protocol in the UEFI Specification
+ for details on the possible return values.
+ @param[out] TargetStatus The status returned by the SCSI target specified
+ by ScsiIo when the SCSI Request Packat was executed
+ on the SCSI Host Controller. See the EFI SCSI I/O
+ Protocol in the UEFI Specification for details on
+ the possible return values.
+
+ @retval EFI_SUCCESS The command was executed successfully.
+ See HostAdapterStatus, TargetStatus, SenseDataLength,
+ and SenseData in that order for additional status
+ information.
+ @retval EFI_NOT_READY The SCSI Request Packet could not be sent because
+ there are too many SCSI Command Packets already
+ queued. The SCSI Request Packet was not sent, so
+ no additional status information is available.
+ The caller may retry again later.
+ @retval EFI_DEVICE_ERROR A device error occurred while attempting to send
+ SCSI Request Packet. See HostAdapterStatus,
+ TargetStatus, SenseDataLength, and SenseData in that
+ order for additional status information.
+ @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
+ is not supported by the SCSI initiator(i.e., SCSI
+ Host Controller). The SCSI Request Packet was not
+ sent, so no additional status information is available.
+ @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request
+ Packet to execute. See HostAdapterStatus, TargetStatus,
+ SenseDataLength, and SenseData in that order for
+ additional status information.
+ @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
+ but the entire DataBuffer could not be transferred.
+ The actual number of bytes transferred is returned
+ in InTransferLength.
**/
EFI_STATUS
EFIAPI
ScsiTestUnitReadyCommand (
- IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
- IN UINT64 Timeout,
- IN VOID *SenseData,
- OUT UINT8 *SenseDataLength,
- OUT UINT8 *HostAdapterStatus,
- OUT UINT8 *TargetStatus
+ IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
+ IN UINT64 Timeout,
+ IN OUT VOID *SenseData, OPTIONAL
+ IN OUT UINT8 *SenseDataLength,
+ OUT UINT8 *HostAdapterStatus,
+ OUT UINT8 *TargetStatus
)
{
EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket;
@@ -95,10 +128,7 @@ ScsiTestUnitReadyCommand ( ASSERT (SenseDataLength != NULL);
ASSERT (HostAdapterStatus != NULL);
ASSERT (TargetStatus != NULL);
-
- if (ScsiIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (ScsiIo != NULL);
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));
ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_SIX);
@@ -132,59 +162,95 @@ ScsiTestUnitReadyCommand ( /**
- Function to submit SCSI inquiry command.
-
- Submit SCSI inquiry command with the SCSI request packet specified by this SCSI command and input
- parameters, then return the status of Scsi unit execution.
+ Execute Inquiry SCSI command on a specific SCSI target.
+ Executes the Inquiry command on the SCSI target specified by ScsiIo.
+ If Timeout is zero, then this function waits indefinitely for the command to complete.
+ If Timeout is greater than zero, then the command is executed and will timeout after Timeout 100 ns units.
+ If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT().
-
If HostAdapterStatus is NULL, then ASSERT().
-
If TargetStatus is NULL, then ASSERT().
-
If InquiryDataLength is NULL, then ASSERT().
- @param[in] ScsiIo SCSI IO Protocol to use
- @param[in] Timeout The length of timeout period.
- @param[in] 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.
-
- @retval EFI_SUCCESS Command is executed successfully.
- @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
- but the entire DataBuffer could not be transferred.
- The actual number of bytes transferred is returned
- in TransferLength.
- @retval EFI_NOT_READY The SCSI Request Packet could not be sent because
- there are too many SCSI Command Packets already
- queued.
- @retval EFI_DEVICE_ERROR A device error occurred while attempting to send
- the SCSI Request Packet.
- @retval EFI_INVALID_PARAMETER ScsiIo is NULL.
- @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
- is not supported by the SCSI initiator(i.e., SCSI
- Host Controller).
- @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
- Request Packet to execute.
+ @param[in] ScsiIo A pointer to the SCSI I/O Protocol instance
+ for the specific SCSI target.
+ @param[in] Timeout The timeout in 100 ns units to use for the
+ execution of this SCSI Request Packet. A Timeout
+ value of zero means that this function will wait
+ indefinitely for the SCSI Request Packet to execute.
+ If Timeout is greater than zero, then this function
+ will return EFI_TIMEOUT if the time required to
+ execute the SCSI Request Packet is greater than Timeout.
+ @param[in, out] SenseData A pointer to sense data that was generated
+ by the execution of the SCSI Request Packet.
+ This buffer must be allocated by the caller.
+ If SenseDataLength is 0, then this parameter
+ is optional and may be NULL.
+ @param[in, out] SenseDataLength On input, the length in bytes of the SenseData buffer.
+ On output, the number of bytes written to the SenseData buffer.
+ @param[out] HostAdapterStatus The status of the SCSI Host Controller that
+ produces the SCSI bus containing the SCSI
+ target specified by ScsiIo when the SCSI
+ Request Packet was executed. See the EFI
+ SCSI I/O Protocol in the UEFI Specification
+ for details on the possible return values.
+ @param[out] TargetStatus The status returned by the SCSI target specified
+ by ScsiIo when the SCSI Request Packat was
+ executed on the SCSI Host Controller.
+ See the EFI SCSI I/O Protocol in the UEFI
+ Specification for details on the possible
+ return values.
+ @param[in, out] InquiryDataBuffer A pointer to inquiry data that was generated
+ by the execution of the SCSI Request Packet.
+ This buffer must be allocated by the caller.
+ If InquiryDataLength is 0, then this parameter
+ is optional and may be NULL.
+ @param[in, out] InquiryDataLength On input, a pointer to the length in bytes
+ of the InquiryDataBuffer buffer.
+ On output, a pointer to the number of bytes
+ written to the InquiryDataBuffer buffer.
+ @param[in] EnableVitalProductData If TRUE, then the supported vital product
+ data is returned in InquiryDataBuffer.
+ If FALSE, then the standard inquiry data is
+ returned in InquiryDataBuffer.
+
+ @retval EFI_SUCCESS The command was executed successfully. See HostAdapterStatus,
+ TargetStatus, SenseDataLength, and SenseData in that order
+ for additional status information.
+ @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire
+ InquiryDataBuffer could not be transferred. The actual
+ number of bytes transferred is returned in InquiryDataLength.
+ @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there
+ are too many SCSI Command Packets already queued.
+ The SCSI Request Packet was not sent, so no additional
+ status information is available. The caller may retry again later.
+ @retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI
+ Request Packet. See HostAdapterStatus, TargetStatus,
+ SenseDataLength, and SenseData in that order for additional
+ status information.
+ @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not
+ supported by the SCSI initiator(i.e., SCSI Host Controller).
+ The SCSI Request Packet was not sent, so no additional
+ status information is available.
+ @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request
+ Packet to execute. See HostAdapterStatus, TargetStatus,
+ SenseDataLength, and SenseData in that order for
+ additional status information.
**/
EFI_STATUS
EFIAPI
ScsiInquiryCommand (
- IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
- IN UINT64 Timeout,
- IN VOID *SenseData,
- IN OUT UINT8 *SenseDataLength,
- OUT UINT8 *HostAdapterStatus,
- OUT UINT8 *TargetStatus,
- IN OUT VOID *InquiryDataBuffer,
- IN OUT UINT32 *InquiryDataLength,
- IN BOOLEAN EnableVitalProductData
+ IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
+ IN UINT64 Timeout,
+ IN OUT VOID *SenseData, OPTIONAL
+ IN OUT UINT8 *SenseDataLength,
+ OUT UINT8 *HostAdapterStatus,
+ OUT UINT8 *TargetStatus,
+ IN OUT VOID *InquiryDataBuffer, OPTIONAL
+ IN OUT UINT32 *InquiryDataLength,
+ IN BOOLEAN EnableVitalProductData
)
{
EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket;
@@ -198,10 +264,7 @@ ScsiInquiryCommand ( ASSERT (HostAdapterStatus != NULL);
ASSERT (TargetStatus != NULL);
ASSERT (InquiryDataLength != NULL);
-
- if (ScsiIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (ScsiIo != NULL);
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));
ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_SIX);
@@ -242,63 +305,100 @@ ScsiInquiryCommand ( /**
- Function to submit SCSI mode sense 10 command.
-
- Submit SCSI Mode Sense (10) command with the SCSI request packet specified by this SCSI command and
- the input parameters, then return the status of Scsi unit execution.
-
+ Execute Mode Sense(10) SCSI command on a specific SCSI target.
+
+ Executes the SCSI Mode Sense(10) command on the SCSI target specified by ScsiIo.
+ If Timeout is zero, then this function waits indefinitely for the command to complete.
+ If Timeout is greater than zero, then the command is executed and will timeout
+ after Timeout 100 ns units. The DBDField, PageControl, and PageCode parameters
+ are used to construct the CDB for this SCSI command.
+ If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT().
-
If HostAdapterStatus is NULL, then ASSERT().
-
If TargetStatus is NULL, then ASSERT().
-
If DataLength is NULL, then ASSERT().
- @param[in] ScsiIo A pointer to SCSI IO protocol.
- @param[in] Timeout The length of timeout period.
- @param[in] 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.
-
- @retval EFI_SUCCESS The status of the unit is tested successfully.
- @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
- but the entire DataBuffer could not be transferred.
+
+ @param[in] ScsiIo A pointer to the SCSI I/O Protocol instance
+ for the specific SCSI target.
+ @param[in] Timeout The timeout in 100 ns units to use for the
+ execution of this SCSI Request Packet. A Timeout
+ value of zero means that this function will wait
+ indefinitely for the SCSI Request Packet to execute.
+ If Timeout is greater than zero, then this function
+ will return EFI_TIMEOUT if the time required to
+ execute the SCSI Request Packet is greater than Timeout.
+ @param[in, out] SenseData A pointer to sense data that was generated
+ by the execution of the SCSI Request Packet.
+ This buffer must be allocated by the caller.
+ If SenseDataLength is 0, then this parameter
+ is optional and may be NULL.
+ @param[in, out] SenseDataLength On input, the length in bytes of the SenseData buffer.
+ On output, the number of bytes written to the SenseData buffer.
+ @param[out] HostAdapterStatus The status of the SCSI Host Controller that
+ produces the SCSI bus containing the SCSI target
+ specified by ScsiIo when the SCSI Request Packet
+ was executed. See the EFI SCSI I/O Protocol in the
+ UEFI Specification for details on the possible
+ return values.
+ @param[out] TargetStatus The status returned by the SCSI target specified
+ by ScsiIo when the SCSI Request Packat was executed
+ on the SCSI Host Controller. See the EFI SCSI
+ I/O Protocol in the UEFI Specification for details
+ on the possible return values.
+ @param[in, out] DataBuffer A pointer to data that was generated by the
+ execution of the SCSI Request Packet. This
+ buffer must be allocated by the caller. If
+ DataLength is 0, then this parameter is optional
+ and may be NULL.
+ @param[in, out] DataLength On input, a pointer to the length in bytes of
+ the DataBuffer buffer. On output, a pointer
+ to the number of bytes written to the DataBuffer
+ buffer.
+ @param[in] DBDField Specifies the DBD field of the CDB for this SCSI Command.
+ @param[in] PageControl Specifies the PC field of the CDB for this SCSI Command.
+ @param[in] PageCode Specifies the Page Control field of the CDB for this SCSI Command.
+
+ @retval EFI_SUCCESS The command was executed successfully.
+ See HostAdapterStatus, TargetStatus, SenseDataLength,
+ and SenseData in that order for additional status information.
+ @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the
+ entire DataBuffer could not be transferred.
The actual number of bytes transferred is returned
- in TransferLength.
- @retval EFI_NOT_READY The SCSI Request Packet could not be sent because
- there are too many SCSI Command Packets already
- queued.
- @retval EFI_DEVICE_ERROR A device error occurred while attempting to send
- the SCSI Request Packet.
- @retval EFI_INVALID_PARAMETER ScsiIo is NULL.
+ in DataLength.
+ @retval EFI_NOT_READY The SCSI Request Packet could not be sent because
+ there are too many SCSI Command Packets already queued.
+ The SCSI Request Packet was not sent, so no additional
+ status information is available. The caller may retry
+ again later.
+ @retval EFI_DEVICE_ERROR A device error occurred while attempting to send
+ SCSI Request Packet. See HostAdapterStatus, TargetStatus,
+ SenseDataLength, and SenseData in that order for
+ additional status information.
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
- is not supported by the SCSI initiator(i.e., SCSI
- Host Controller).
- @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
- Request Packet to execute.
+ is not supported by the SCSI initiator(i.e., SCSI
+ Host Controller). The SCSI Request Packet was not
+ sent, so no additional status information is available.
+ @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
+ Request Packet to execute. See HostAdapterStatus,
+ TargetStatus, SenseDataLength, and SenseData in that
+ order for additional status information.
**/
EFI_STATUS
EFIAPI
ScsiModeSense10Command (
- IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
- IN UINT64 Timeout,
- IN VOID *SenseData,
- IN OUT UINT8 *SenseDataLength,
- OUT UINT8 *HostAdapterStatus,
- OUT UINT8 *TargetStatus,
- IN VOID *DataBuffer,
- IN OUT UINT32 *DataLength,
- IN UINT8 DBDField, OPTIONAL
- IN UINT8 PageControl,
- IN UINT8 PageCode
+ IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
+ IN UINT64 Timeout,
+ IN OUT VOID *SenseData, OPTIONAL
+ IN OUT UINT8 *SenseDataLength,
+ OUT UINT8 *HostAdapterStatus,
+ OUT UINT8 *TargetStatus,
+ IN OUT VOID *DataBuffer, OPTIONAL
+ IN OUT UINT32 *DataLength,
+ IN UINT8 DBDField, OPTIONAL
+ IN UINT8 PageControl,
+ IN UINT8 PageCode
)
{
EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket;
@@ -312,10 +412,7 @@ ScsiModeSense10Command ( ASSERT (HostAdapterStatus != NULL);
ASSERT (TargetStatus != NULL);
ASSERT (DataLength != NULL);
-
- if (ScsiIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (ScsiIo != NULL);
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));
ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_TEN);
@@ -359,21 +456,20 @@ ScsiModeSense10Command ( /**
- Function to submit SCSI request sense command.
-
- Submit SCSI request sense command with the SCSI requested packet specified by this
- SCSI command, TimeOut and SenseData, and then return the status of scsi unit execution.
+ Execute Request Sense SCSI command on a specific SCSI target.
+ Executes the Request Sense command on the SCSI target specified by ScsiIo.
+ If Timeout is zero, then this function waits indefinitely for the command to complete.
+ If Timeout is greater than zero, then the command is executed and will timeout after Timeout 100 ns units.
+ If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT().
-
If HostAdapterStatus is NULL, then ASSERT().
-
If TargetStatus is NULL, then ASSERT().
@param[in] ScsiIo A pointer to SCSI IO protocol.
@param[in] Timeout The length of timeout period.
- @param[in] SenseData A pointer to output sense data.
- @param[in, out] SenseDataLength The length of output sense data.
+ @param[in, 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.
@@ -384,18 +480,17 @@ ScsiModeSense10Command ( @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by
the SCSI initiator(i.e., SCSI Host Controller)
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
- @retval EFI_INVALID_PARAMETER ScsiIo is NULL.
**/
EFI_STATUS
EFIAPI
ScsiRequestSenseCommand (
- IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
- IN UINT64 Timeout,
- IN VOID *SenseData,
- IN OUT UINT8 *SenseDataLength,
- OUT UINT8 *HostAdapterStatus,
- OUT UINT8 *TargetStatus
+ IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
+ IN UINT64 Timeout,
+ IN OUT VOID *SenseData, OPTIONAL
+ IN OUT UINT8 *SenseDataLength,
+ OUT UINT8 *HostAdapterStatus,
+ OUT UINT8 *TargetStatus
)
{
EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket;
@@ -408,10 +503,7 @@ ScsiRequestSenseCommand ( ASSERT (SenseDataLength != NULL);
ASSERT (HostAdapterStatus != NULL);
ASSERT (TargetStatus != NULL);
-
- if (ScsiIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (ScsiIo != NULL);
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));
ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_SIX);
@@ -446,28 +538,27 @@ ScsiRequestSenseCommand ( /**
- Function to submit read capacity command.
-
- Submit SCSI read capacity command with the SCSI request packet specified by this SCSI
- command and the input parameters, and then return the status of Scsi unit execution.
+ Execute Read Capacity SCSI command on a specific SCSI target.
+ Executes the SCSI Read Capacity command on the SCSI target specified by ScsiIo.
+ If Timeout is zero, then this function waits indefinitely for the command to complete.
+ If Timeout is greater than zero, then the command is executed and will timeout after
+ Timeout 100 ns units. The PMI parameter is used to construct the CDB for this SCSI command.
+ If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT().
-
If HostAdapterStatus is NULL, then ASSERT().
-
If TargetStatus is NULL, then ASSERT().
-
If DataLength is NULL, then ASSERT().
- @param[in] ScsiIo A pointer to SCSI IO protocol.
- @param[in] Timeout The length of timeout period.
- @param[in] SenseData A pointer to output sense data.
+ @param[in] ScsiIo A pointer to SCSI IO protocol.
+ @param[in] Timeout The length of timeout period.
+ @param[in, 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[out] HostAdapterStatus The status of Host Adapter.
+ @param[out] TargetStatus The status of the target.
+ @param[in, 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] PMI Partial medium indicator.
@retval EFI_SUCCESS Command is executed successfully.
@retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, but the entire DataBuffer could
@@ -478,21 +569,20 @@ ScsiRequestSenseCommand ( @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by
the SCSI initiator(i.e., SCSI Host Controller)
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
- @retval EFI_INVALID_PARAMETER ScsiIo is NULL.
**/
EFI_STATUS
EFIAPI
ScsiReadCapacityCommand (
- IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
- IN UINT64 Timeout,
- IN VOID *SenseData,
- IN OUT UINT8 *SenseDataLength,
- OUT UINT8 *HostAdapterStatus,
- OUT UINT8 *TargetStatus,
- OUT VOID *DataBuffer,
- IN OUT UINT32 *DataLength,
- IN BOOLEAN PMI
+ IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
+ IN UINT64 Timeout,
+ IN OUT VOID *SenseData, OPTIONAL
+ IN OUT UINT8 *SenseDataLength,
+ OUT UINT8 *HostAdapterStatus,
+ OUT UINT8 *TargetStatus,
+ IN OUT VOID *DataBuffer, OPTIONAL
+ IN OUT UINT32 *DataLength,
+ IN BOOLEAN PMI
)
{
EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket;
@@ -506,10 +596,7 @@ ScsiReadCapacityCommand ( ASSERT (HostAdapterStatus != NULL);
ASSERT (TargetStatus != NULL);
ASSERT (DataLength != NULL);
-
- if (ScsiIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (ScsiIo != NULL);
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));
ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_TEN);
@@ -552,29 +639,30 @@ ScsiReadCapacityCommand ( /**
- Function to submit read 10 command.
-
- Submit SCSI read (10) command with the SCSI request packet specified by this SCSI command
- and the input parameters, and then return the status of Scsi unit execution.
-
+ Execute Read(10) SCSI command on a specific SCSI target.
+
+ Executes the SCSI Read(10) command on the SCSI target specified by ScsiIo.
+ If Timeout is zero, then this function waits indefinitely for the command to complete.
+ If Timeout is greater than zero, then the command is executed and will timeout
+ after Timeout 100 ns units. The StartLba and SectorSize parameters are used to
+ construct the CDB for this SCSI command.
+ If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT().
-
If HostAdapterStatus is NULL, then ASSERT().
-
If TargetStatus is NULL, then ASSERT().
-
If DataLength is NULL, then ASSERT().
- @param[in] ScsiIo A pointer to SCSI IO protocol.
- @param[in] Timeout The length of timeout period.
- @param[in] SenseData A pointer to output sense data.
+
+ @param[in] ScsiIo A pointer to SCSI IO protocol.
+ @param[in] Timeout The length of timeout period.
+ @param[in, 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[out] HostAdapterStatus The status of Host Adapter.
+ @param[out] TargetStatus The status of the target.
+ @param[in, 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.
+ @param[in] StartLba The start address of LBA.
+ @param[in] SectorSize The sector size.
@retval EFI_SUCCESS Command is executed successfully.
@retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, but the entire DataBuffer could
@@ -585,22 +673,21 @@ ScsiReadCapacityCommand ( @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by
the SCSI initiator(i.e., SCSI Host Controller)
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
- @retval EFI_INVALID_PARAMETER ScsiIo is NULL.
**/
EFI_STATUS
EFIAPI
ScsiRead10Command (
- IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
- IN UINT64 Timeout,
- IN VOID *SenseData,
- IN OUT UINT8 *SenseDataLength,
- OUT UINT8 *HostAdapterStatus,
- OUT UINT8 *TargetStatus,
- OUT VOID *DataBuffer,
- IN OUT UINT32 *DataLength,
- IN UINT32 StartLba,
- IN UINT32 SectorSize
+ IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
+ IN UINT64 Timeout,
+ IN OUT VOID *SenseData, OPTIONAL
+ IN OUT UINT8 *SenseDataLength,
+ OUT UINT8 *HostAdapterStatus,
+ OUT UINT8 *TargetStatus,
+ IN OUT VOID *DataBuffer, OPTIONAL
+ IN OUT UINT32 *DataLength,
+ IN UINT32 StartLba,
+ IN UINT32 SectorSize
)
{
EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket;
@@ -614,10 +701,7 @@ ScsiRead10Command ( ASSERT (HostAdapterStatus != NULL);
ASSERT (TargetStatus != NULL);
ASSERT (DataLength != NULL);
-
- if (ScsiIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (ScsiIo != NULL);
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));
ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_TEN);
@@ -658,29 +742,29 @@ ScsiRead10Command ( /**
- Function to submit SCSI write 10 command.
-
- Submit SCSI write (10) command with the SCSI request packet specified by this SCSI command and the
- input parameters, and then return the status of Scsi unit execution.
-
+ Execute Write(10) SCSI command on a specific SCSI target.
+
+ Executes the SCSI Write(10) command on the SCSI target specified by ScsiIo.
+ If Timeout is zero, then this function waits indefinitely for the command to complete.
+ If Timeout is greater than zero, then the command is executed and will timeout after
+ Timeout 100 ns units. The StartLba and SectorSize parameters are used to construct
+ the CDB for this SCSI command.
+ If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT().
-
If HostAdapterStatus is NULL, then ASSERT().
-
If TargetStatus is NULL, then ASSERT().
-
If DataLength is NULL, then ASSERT().
- @param[in] ScsiIo SCSI IO Protocol to use
- @param[in] Timeout The length of timeout period.
- @param[in] 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.
+ @param[in] ScsiIo SCSI IO Protocol to use
+ @param[in] Timeout The length of timeout period.
+ @param[in, 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] 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.
@retval EFI_SUCCESS Command is executed successfully.
@retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, but the entire DataBuffer could
@@ -691,22 +775,21 @@ ScsiRead10Command ( @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by
the SCSI initiator(i.e., SCSI Host Controller)
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
- @retval EFI_INVALID_PARAMETER ScsiIo is NULL.
**/
EFI_STATUS
EFIAPI
ScsiWrite10Command (
- IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
- IN UINT64 Timeout,
- IN VOID *SenseData,
- IN OUT UINT8 *SenseDataLength,
- OUT UINT8 *HostAdapterStatus,
- OUT UINT8 *TargetStatus,
- OUT VOID *DataBuffer,
- IN OUT UINT32 *DataLength,
- IN UINT32 StartLba,
- IN UINT32 SectorSize
+ IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
+ IN UINT64 Timeout,
+ IN OUT VOID *SenseData, OPTIONAL
+ IN OUT UINT8 *SenseDataLength,
+ OUT UINT8 *HostAdapterStatus,
+ OUT UINT8 *TargetStatus,
+ IN OUT VOID *DataBuffer, OPTIONAL
+ IN OUT UINT32 *DataLength,
+ IN UINT32 StartLba,
+ IN UINT32 SectorSize
)
{
EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket;
@@ -720,10 +803,7 @@ ScsiWrite10Command ( ASSERT (HostAdapterStatus != NULL);
ASSERT (TargetStatus != NULL);
ASSERT (DataLength != NULL);
-
- if (ScsiIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (ScsiIo != NULL);
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));
ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_TEN);
|