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

[mirror_edk2.git] / MdePkg / Include / Protocol / ScsiPassThru.h

diff --git a/MdePkg/Include/Protocol/ScsiPassThru.h b/MdePkg/Include/Protocol/ScsiPassThru.h
index ee498e0ec32e35b9a788d691a94e6aba1de455c2..1790c1af43db50c33a2a580331182a9919f802ea 100644 (file)
--- a/MdePkg/Include/Protocol/ScsiPassThru.h
+++ b/MdePkg/Include/Protocol/ScsiPassThru.h
@@ -66,23 +66,85 @@ typedef struct _EFI_SCSI_PASS_THRU_PROTOCOL  EFI_SCSI_PASS_THRU_PROTOCOL;
 #define EFI_SCSI_STATUS_TARGET_QUEUE_FULL                 0x28  // queue full\r
 \r
 typedef struct {\r
+  ///\r
+  /// The timeout, in 100 ns units, to use for the execution of this SCSI\r
+  /// Request Packet. A Timeout value of 0 means that this function\r
+  /// will wait indefinitely for the SCSI Request Packet to execute. If\r
+  /// Timeout is greater than zero, then this function will return\r
+  /// EFI_TIMEOUT if the time required to execute the SCSI Request\r
+  /// Packet is greater than Timeout.\r
+  ///\r
   UINT64  Timeout;\r
+  ///\r
+  /// A pointer to the data buffer to transfer between the SCSI\r
+  /// controller and the SCSI device. Must be aligned to the boundary\r
+  /// specified in the IoAlign field of the\r
+  /// EFI_SCSI_PASS_THRU_MODE structure.\r
+  ///\r
   VOID    *DataBuffer;\r
+  ///\r
+  /// A pointer to the sense data that was generated by the execution of\r
+  /// the SCSI Request Packet.\r
+  ///\r
   VOID    *SenseData;\r
+  ///\r
+  /// A pointer to buffer that contains the Command Data Block to\r
+  /// send to the SCSI device.\r
+  ///\r
   VOID    *Cdb;\r
+  ///\r
+  /// On Input, the size, in bytes, of InDataBuffer. On output, the\r
+  /// number of bytes transferred between the SCSI controller and the SCSI device.\r
+  ///\r
   UINT32  TransferLength;\r
+  ///\r
+  /// The length, in bytes, of the buffer Cdb. The standard values are\r
+  /// 6, 10, 12, and 16, but other values are possible if a variable length CDB is used.\r
+  ///\r
   UINT8   CdbLength;\r
+  ///\r
+  /// The direction of the data transfer. 0 for reads, 1 for writes. A\r
+  /// value of 2 is Reserved for Bi-Directional SCSI commands.\r
+  ///\r
   UINT8   DataDirection;\r
+  ///\r
+  /// The status of the SCSI Host Controller that produces the SCSI\r
+  /// bus where the SCSI device attached when the SCSI Request\r
+  /// Packet was executed on the SCSI Controller.\r
+  ///\r
   UINT8   HostAdapterStatus;\r
+  ///\r
+  /// The status returned by the SCSI device when the SCSI Request\r
+  /// Packet was executed.\r
+  ///\r
   UINT8   TargetStatus;\r
+  ///\r
+  /// On input, the length in bytes of the SenseData buffer. On\r
+  /// output, the number of bytes written to the SenseData buffer.\r
+  ///\r
   UINT8   SenseDataLength;\r
 } EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET;\r
 \r
 typedef struct {\r
+  ///\r
+  /// A Null-terminated Unicode string that represents the printable name of the SCSI controller.\r
+  ///\r
   CHAR16  *ControllerName;\r
+  ///\r
+  /// A Null-terminated Unicode string that represents the printable name of the SCSI channel.\r
+  ///\r
   CHAR16  *ChannelName;\r
+  ///\r
+  /// The Target ID of the host adapter on the SCSI channel.\r
+  ///\r
   UINT32  AdapterId;\r
+  ///\r
+  /// Additional information on the attributes of the SCSI channel.\r
+  ///\r
   UINT32  Attributes;\r
+  ///\r
+  /// Supplies the alignment requirement for any buffer used in a data transfer.\r
+  ///\r
   UINT32  IoAlign;\r
 } EFI_SCSI_PASS_THRU_MODE;\r
 \r