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, 70 insertions, 17 deletions

diff --git a/MdePkg/Include/Protocol/ScsiIo.h b/MdePkg/Include/Protocol/ScsiIo.h
index cf37eba5e9..e0204cce22 100644
--- a/MdePkg/Include/Protocol/ScsiIo.h
+++ b/MdePkg/Include/Protocol/ScsiIo.h
@@ -39,16 +39,16 @@ typedef struct _EFI_SCSI_IO_PROTOCOL EFI_SCSI_IO_PROTOCOL;
 // SCSI Host Adapter Status definition

 //

 #define EFI_SCSI_IO_STATUS_HOST_ADAPTER_OK                     0x00

-#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_TIMEOUT_COMMAND        0x09    // timeout when processing the command

-#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_TIMEOUT                0x0b    // timeout when waiting for the command processing

-#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_MESSAGE_REJECT         0x0d    // a message reject was received when processing command

-#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_BUS_RESET              0x0e    // a bus reset was detected

+#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_TIMEOUT_COMMAND        0x09    ///< timeout when processing the command

+#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_TIMEOUT                0x0b    ///< timeout when waiting for the command processing

+#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_MESSAGE_REJECT         0x0d    ///< a message reject was received when processing command

+#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_BUS_RESET              0x0e    ///< a bus reset was detected

 #define EFI_SCSI_IO_STATUS_HOST_ADAPTER_PARITY_ERROR           0x0f

-#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_REQUEST_SENSE_FAILED   0x10    // the adapter failed in issuing request sense command

-#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_SELECTION_TIMEOUT      0x11    // selection timeout

-#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_DATA_OVERRUN_UNDERRUN  0x12    // data overrun or data underrun

-#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_BUS_FREE               0x13    // Unexepected bus free

-#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_PHASE_ERROR            0x14    // Target bus phase sequence failure

+#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_REQUEST_SENSE_FAILED   0x10    ///< the adapter failed in issuing request sense command

+#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_SELECTION_TIMEOUT      0x11    ///< selection timeout

+#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_DATA_OVERRUN_UNDERRUN  0x12    ///< data overrun or data underrun

+#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_BUS_FREE               0x13    ///< Unexepected bus free

+#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_PHASE_ERROR            0x14    ///< Target bus phase sequence failure

 #define EFI_SCSI_IO_STATUS_HOST_ADAPTER_OTHER                  0x7f

 

 

@@ -56,27 +56,80 @@ typedef struct _EFI_SCSI_IO_PROTOCOL EFI_SCSI_IO_PROTOCOL;
 // SCSI Target Status definition

 //

 #define EFI_SCSI_IO_STATUS_TARGET_GOOD                         0x00

-#define EFI_SCSI_IO_STATUS_TARGET_CHECK_CONDITION              0x02    // check condition

-#define EFI_SCSI_IO_STATUS_TARGET_CONDITION_MET                0x04    // condition met

-#define EFI_SCSI_IO_STATUS_TARGET_BUSY                         0x08    // busy

-#define EFI_SCSI_IO_STATUS_TARGET_INTERMEDIATE                 0x10    // intermediate

-#define EFI_SCSI_IO_STATUS_TARGET_INTERMEDIATE_CONDITION_MET   0x14    // intermediate-condition met

-#define EFI_SCSI_IO_STATUS_TARGET_RESERVATION_CONFLICT         0x18    // reservation conflict

-#define EFI_SCSI_IO_STATUS_TARGET_COMMOND_TERMINATED           0x22    // command terminated

-#define EFI_SCSI_IO_STATUS_TARGET_QUEUE_FULL                   0x28    // queue full

+#define EFI_SCSI_IO_STATUS_TARGET_CHECK_CONDITION              0x02    ///< check condition

+#define EFI_SCSI_IO_STATUS_TARGET_CONDITION_MET                0x04    ///< condition met

+#define EFI_SCSI_IO_STATUS_TARGET_BUSY                         0x08    ///< busy

+#define EFI_SCSI_IO_STATUS_TARGET_INTERMEDIATE                 0x10    ///< intermediate

+#define EFI_SCSI_IO_STATUS_TARGET_INTERMEDIATE_CONDITION_MET   0x14    ///< intermediate-condition met

+#define EFI_SCSI_IO_STATUS_TARGET_RESERVATION_CONFLICT         0x18    ///< reservation conflict

+#define EFI_SCSI_IO_STATUS_TARGET_COMMOND_TERMINATED           0x22    ///< command terminated

+#define EFI_SCSI_IO_STATUS_TARGET_QUEUE_FULL                   0x28    ///< queue full

 

 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 SCSI READ command

+  ///

   VOID                                *InDataBuffer;

+  ///

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

+  /// controller and the SCSI device for SCSI WRITE command.

+  ///

   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.

+  ///

   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 SCSI Host Controller that produces the SCSI

+  /// bus where the SCSI device attached when the SCSI Request

+  /// Packet was executed on the SCSI Controller.

+  ///

   UINT8                               HostAdapterStatus;

+  ///

+  /// The status returned by the SCSI device 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_SCSI_IO_SCSI_REQUEST_PACKET;