Add the detailed descriptions for the structure data member in these protocol.

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

1 files changed, 61 insertions, 0 deletions

diff --git a/MdePkg/Include/Protocol/ScsiPassThruExt.h b/MdePkg/Include/Protocol/ScsiPassThruExt.h
index d63f056c5a..7ec0dd9737 100644
--- a/MdePkg/Include/Protocol/ScsiPassThruExt.h
+++ b/MdePkg/Include/Protocol/ScsiPassThruExt.h
@@ -66,23 +66,84 @@ typedef struct _EFI_EXT_SCSI_PASS_THRU_PROTOCOL EFI_EXT_SCSI_PASS_THRU_PROTOCOL;
 #define EFI_EXT_SCSI_STATUS_TARGET_TASK_ABORTED                0x40

 

 typedef struct {

+  ///

+  /// The Target ID of the host adapter on the SCSI channel.

+  ///

   UINT32 AdapterId;

+  ///

+  /// Additional information on the attributes of the SCSI channel.

+  ///

   UINT32 Attributes;

+  ///

+  /// Supplies the alignment requirement for any buffer used in a data transfer.

+  ///

   UINT32 IoAlign;

 } EFI_EXT_SCSI_PASS_THRU_MODE;

 

 typedef struct {

+  ///

+  /// The timeout, in 100 ns units, to use for the execution of this SCSI

+  /// Request Packet. A Timeout value of 0 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.

+  ///

   UINT64 Timeout;

+  ///

+  /// A pointer to the data buffer to transfer between the SCSI

+  /// controller and the SCSI device for read and bidirectional commands.

+  ///

   VOID   *InDataBuffer;

+  ///

+  /// A pointer to the data buffer to transfer between the SCSI

+  /// controller and the SCSI device for write or bidirectional commands.

+  ///

   VOID   *OutDataBuffer;

+  ///

+  /// A pointer to the sense data that was generated by the execution of

+  /// the SCSI Request Packet.

+  ///

   VOID   *SenseData;

+  ///

+  /// A pointer to buffer that contains the Command Data Block to

+  /// send to the SCSI device specified by Target and Lun.

+  ///

   VOID   *Cdb;

+  ///

+  /// On Input, the size, in bytes, of InDataBuffer. On output, the

+  /// number of bytes transferred between the SCSI controller and the SCSI device.

+  ///

   UINT32 InTransferLength;

+  ///

+  /// On Input, the size, in bytes of OutDataBuffer. On Output, the

+  /// Number of bytes transferred between SCSI Controller and the SCSI device.

+  ///

   UINT32 OutTransferLength;

+  ///

+  /// The length, in bytes, of the buffer Cdb. The standard values are 6,

+  /// 10, 12, and 16, but other values are possible if a variable length CDB is used.

+  ///

   UINT8  CdbLength;

+  ///

+  /// The direction of the data transfer. 0 for reads, 1 for writes. A

+  /// value of 2 is Reserved for Bi-Directional SCSI commands.

+  ///

   UINT8  DataDirection;

+  ///

+  /// The status of the host adapter specified by This when the SCSI

+  /// Request Packet was executed on the target device.

+  ///

   UINT8  HostAdapterStatus;

+  ///

+  /// The status returned by the device specified by Target and Lun

+  /// when the SCSI Request Packet was executed.

+  ///

   UINT8  TargetStatus;

+  ///

+  /// On input, the length in bytes of the SenseData buffer. On

+  /// output, the number of bytes written to the SenseData buffer.

+  ///

   UINT8  SenseDataLength;

 } EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET;