Add BlockIO revision 3 definition. Add new API ScsiInquiryCommandEx to UefiScsiLib.

Signed-off-by: niruiyu
Reviewed-by: erictian

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11691 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 97 insertions, 1 deletions

diff --git a/MdePkg/Include/Library/UefiScsiLib.h b/MdePkg/Include/Library/UefiScsiLib.h
index c947c6b9e7..d6907c4060 100644
--- a/MdePkg/Include/Library/UefiScsiLib.h
+++ b/MdePkg/Include/Library/UefiScsiLib.h
@@ -5,7 +5,7 @@
   for hard drive, CD and DVD devices that are the most common SCSI boot targets used by UEFI platforms.

   This library class depends on SCSI I/O Protocol defined in UEFI Specification and SCSI-2 industry standard.

 

-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials                          

 are licensed and made available under the terms and conditions of the BSD License         

 which accompanies this distribution.  The full text of the license may be found at        

@@ -190,6 +190,102 @@ ScsiInquiryCommand (
 

 

 /**

+  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                 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 Packet 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 for the PageCode is returned in InquiryDataBuffer.

+                                         If FALSE, then the standard inquiry data is

+                                         returned in InquiryDataBuffer and PageCode is ignored.

+  @param[in]      PageCode               The page code of the vital product data.

+                                         It's ignored if EnableVitalProductData is FALSE.

+

+  @retval EFI_SUCCESS          The command 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

+ScsiInquiryCommandEx (

+  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,

+  IN     UINT8                 PageCode

+  );

+

+

+/**

   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.