]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/ScsiPassThruExt.h
Reviewed the code comments in the Include/Protocol directory for typos, grammar issue...
[mirror_edk2.git] / MdePkg / Include / Protocol / ScsiPassThruExt.h
index d63f056c5aa5f2d7048eebb0b928e8a095026067..176db59aee539745ecd21fb1897402b0be62fa1c 100644 (file)
@@ -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
@@ -92,9 +153,9 @@ typedef struct {
   nonblocking I/O functionality is optional.                                                             \r
 \r
   @param  This    A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.\r
-  @param  Target  The Target is an array of size TARGET_MAX_BYTES and it represents\r
-                  the id of the SCSI device to send the SCSI Request Packet. Each\r
-                  transport driver may chose to utilize a subset of this size to suit the needs\r
+  @param  Target  The Target is an array of size TARGET_MAX_BYTES. It represents\r
+                  the id of the SCSI device that will send the SCSI Request Packet. Each\r
+                  transport driver may choose to utilize a subset of this size to suit the needs\r
                   of transport target representation. For example, a Fibre Channel driver\r
                   may use only 8 bytes (WWN) to represent an FC target.\r
   @param  Lun     The LUN of the SCSI device to send the SCSI Request Packet.\r
@@ -140,7 +201,7 @@ EFI_STATUS
 /**\r
   Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on a SCSI channel. These       \r
   can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal\r
-  Target Ids and LUNs for the SCSI channel. Regardless, the caller of this function must probe the       \r
+  Target Ids and LUNs for the SCSI channel. Either way, the caller of this function must probe the       \r
   Target ID and LUN returned to see if a SCSI device is actually present at that location on the SCSI    \r
   channel.                                                                                               \r
 \r
@@ -256,7 +317,7 @@ EFI_STATUS
   Resets a SCSI logical unit that is connected to a SCSI channel.\r
 \r
   @param  This   A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.\r
-  @param  Target The Target is an array of size TARGET_MAX_BYTE and it represents the\r
+  @param  Target The Target is an array of size TARGET_MAX_BYTE. It represents the\r
                  target port ID of the SCSI device containing the SCSI logical unit to\r
                  reset. Transport drivers may chose to utilize a subset of this array to suit\r
                  the representation of their targets.\r
@@ -296,7 +357,7 @@ EFI_STATUS
   @retval EFI_SUCCESS           The Target ID of the next SCSI device on the SCSI\r
                                 channel was returned in Target.\r
   @retval EFI_INVALID_PARAMETER Target or Lun is NULL.\r
-  @retval EFI_TIMEOUT           Target array is not all 0xF, and Target were not\r
+  @retval EFI_TIMEOUT           Target array is not all 0xF, and Target was not\r
                                 returned on a previous call to GetNextTarget().\r
   @retval EFI_NOT_FOUND         There are no more SCSI devices on this SCSI channel.\r
 \r