Fix various 'EFIAPI' inconsistencies found while building MdeModulePkg.

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

diff --git a/MdePkg/Include/Protocol/ScsiPassThruExt.h b/MdePkg/Include/Protocol/ScsiPassThruExt.h
index d63f056c5aa5f2d7048eebb0b928e8a095026067..7ec0dd9737d6c9f9014b5c9f7d66073f91a0287b 100644 (file)
--- 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\r
 \r
 typedef struct {\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_EXT_SCSI_PASS_THRU_MODE;\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\r
+  /// Request 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 for read and bidirectional commands.\r
+  ///\r
   VOID   *InDataBuffer;\r
+  ///\r
+  /// A pointer to the data buffer to transfer between the SCSI\r
+  /// controller and the SCSI device for write or bidirectional commands.\r
+  ///\r
   VOID   *OutDataBuffer;\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 specified by Target and Lun.\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 InTransferLength;\r
+  ///\r
+  /// On Input, the size, in bytes of OutDataBuffer. On Output, the\r
+  /// Number of bytes transferred between SCSI Controller and the SCSI device.\r
+  ///\r
   UINT32 OutTransferLength;\r
+  ///\r
+  /// The length, in bytes, of the buffer Cdb. The standard values are 6,\r
+  /// 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 host adapter specified by This when the SCSI\r
+  /// Request Packet was executed on the target device.\r
+  ///\r
   UINT8  HostAdapterStatus;\r
+  ///\r
+  /// The status returned by the device specified by Target and Lun\r
+  /// when the SCSI Request 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_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET;\r
 \r