- @param[in] ScsiIo SCSI IO Protocol to use\r
- @param[in] Timeout The length of timeout period.\r
- @param[in] SenseData A pointer to output sense data.\r
- @param[in, out] SenseDataLength The length of output sense data.\r
- @param[out] HostAdapterStatus The status of Host Adapter.\r
- @param[out] TargetStatus The status of the target.\r
- @param[in, out] 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 Command is executed successfully.\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
- @retval EFI_NOT_READY The SCSI Request Packet could not be sent because \r
- there are too many SCSI Command Packets already \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 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
+ @param[in] ScsiIo A pointer to the SCSI I/O Protocol instance\r
+ for the specific SCSI target.\r
+ @param[in] Timeout The timeout in 100 ns units to use for the\r
+ execution of this SCSI Request Packet. A Timeout\r
+ value of zero means that this function will wait\r
+ indefinitely for the SCSI Request Packet to execute.\r
+ If Timeout is greater than zero, then this function\r
+ will return EFI_TIMEOUT if the time required to\r
+ execute the SCSI Request Packet is greater than Timeout.\r
+ @param[in, out] SenseData A pointer to sense data that was generated\r
+ by the execution of the SCSI Request Packet.\r
+ This buffer must be allocated by the caller.\r
+ If SenseDataLength is 0, then this parameter\r
+ is optional and may be NULL.\r
+ @param[in, out] SenseDataLength On input, the length in bytes of the SenseData buffer.\r
+ On output, the number of bytes written to the SenseData buffer. \r
+ @param[out] HostAdapterStatus The status of the SCSI Host Controller that\r
+ produces the SCSI bus containing the SCSI\r
+ target specified by ScsiIo when the SCSI\r
+ Request Packet was executed. See the EFI\r
+ SCSI I/O Protocol in the UEFI Specification\r
+ for details on the possible return values.\r
+ @param[out] TargetStatus The status returned by the SCSI target specified\r
+ by ScsiIo when the SCSI Request Packat was\r
+ executed on the SCSI Host Controller.\r
+ See the EFI SCSI I/O Protocol in the UEFI\r
+ Specification for details on the possible\r
+ return values. \r
+ @param[in, out] InquiryDataBuffer A pointer to inquiry data that was generated\r
+ by the execution of the SCSI Request Packet.\r
+ This buffer must be allocated by the caller.\r
+ If InquiryDataLength is 0, then this parameter\r
+ is optional and may be NULL. \r
+ @param[in, out] InquiryDataLength On input, a pointer to the length in bytes\r
+ of the InquiryDataBuffer buffer.\r
+ On output, a pointer to the number of bytes\r
+ written to the InquiryDataBuffer buffer.\r
+ @param[in] EnableVitalProductData If TRUE, then the supported vital product\r
+ data is returned in InquiryDataBuffer.\r
+ If FALSE, then the standard inquiry data is\r
+ returned in InquiryDataBuffer. \r
+\r
+ @retval EFI_SUCCESS The command was executed successfully. See HostAdapterStatus,\r
+ TargetStatus, SenseDataLength, and SenseData in that order\r
+ for additional status information.\r
+ @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire\r
+ InquiryDataBuffer could not be transferred. The actual\r
+ number of bytes transferred is returned in InquiryDataLength.\r
+ @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there\r
+ are too many SCSI Command Packets already queued.\r
+ The SCSI Request Packet was not sent, so no additional\r
+ status information is available. The caller may retry again later.\r
+ @retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI\r
+ Request Packet. See HostAdapterStatus, TargetStatus,\r
+ SenseDataLength, and SenseData in that order for additional\r
+ status information.\r
+ @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not\r
+ supported by the SCSI initiator(i.e., SCSI Host Controller).\r
+ The SCSI Request Packet was not sent, so no additional\r
+ status information is available.\r
+ @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request\r
+ Packet to execute. See HostAdapterStatus, TargetStatus,\r
+ SenseDataLength, and SenseData in that order for\r
+ additional status information.\r