sync the comments of scsilib library class with Mde Library Spec.

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

diff --git a/MdePkg/Include/Library/ScsiLib.h b/MdePkg/Include/Library/ScsiLib.h
index e8b33a08ef745159b8730d505227c34cb3993749..ea671bcc9893de1cd74d8f2943153627cea4fca0 100644 (file)
--- a/MdePkg/Include/Library/ScsiLib.h
+++ b/MdePkg/Include/Library/ScsiLib.h
@@ -35,6 +35,15 @@
 /**\r
   Function test the ready status of the SCSI unit.\r
 \r
+  Submit SCSI test unit ready command with SCSI request packet specified by this scsi command, TimeOut\r
+  and SenseData, then get the status of the target Scsi unit.\r
+\r
+  If SenseDataLength is NULL, then ASSERT().\r
+\r
+  If HostAdapterStatus is NULL, then ASSERT().\r
+\r
+  If TargetStatus is NULL, then ASSERT().\r
+\r
   @param[in]     ScsiIo             A pointer to SCSI IO protocol.\r
   @param[in]     Timeout            The length of timeout period.\r
   @param[out]    SenseData          A pointer to output sense data.\r
@@ -52,7 +61,7 @@
                                 queued.\r
   @retval EFI_DEVICE_ERROR      A device error occurred while attempting to send \r
                                 the SCSI Request Packet.\r
-  @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid.  \r
+  @retval EFI_INVALID_PARAMETER ScsiIo is NULL.\r
   @retval EFI_UNSUPPORTED       The command described by the SCSI Request Packet\r
                                 is not supported by the SCSI initiator(i.e., SCSI \r
                                 Host Controller).\r
@@ -75,6 +84,17 @@ ScsiTestUnitReadyCommand (
 /**\r
   Function to submit SCSI inquiry command.\r
 \r
+  Submit SCSI inquiry command with the SCSI request packet specified by this SCSI command and input\r
+  parameters, then return the status of Scsi unit execution.\r
+\r
+  If SenseDataLength is NULL, then ASSERT().\r
+\r
+  If HostAdapterStatus is NULL, then ASSERT().\r
+\r
+  If TargetStatus is NULL, then ASSERT().\r
+\r
+  If InquiryDataLength is NULL, then ASSERT().\r
+\r
   @param[in]     ScsiIo             SCSI IO Protocol to use\r
   @param[in]     Timeout            The length of timeout period.\r
   @param[in]     SenseData          A pointer to output sense data.\r
@@ -85,22 +105,22 @@ ScsiTestUnitReadyCommand (
   @param[in out] InquiryDataLength  The length of inquiry data buffer.\r
   @param[in]     EnableVitalProductData  Boolean to enable Vital Product Data.\r
 \r
-  @retval EFI_SUCCESS         The status of the unit is tested successfully.\r
-  @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, \r
-                              but the entire DataBuffer could not be transferred.\r
-                              The actual number of bytes transferred is returned\r
-                              in TransferLength.\r
-  @retval EFI_NOT_READY   The SCSI Request Packet could not be sent because \r
-                          there are too many SCSI Command Packets already \r
-                          queued.\r
-  @retval EFI_DEVICE_ERROR  A device error occurred while attempting to send \r
-                            the SCSI Request Packet.\r
-  @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid.  \r
-  @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet\r
-                          is not supported by the SCSI initiator(i.e., SCSI \r
-                          Host Controller).\r
-  @retval EFI_TIMEOUT     A timeout occurred while waiting for the SCSI \r
-                          Request Packet to execute.\r
+  @retval EFI_SUCCESS                Command is executed successfully.\r
+  @retval EFI_BAD_BUFFER_SIZE        The SCSI Request Packet was executed, \r
+                                     but the entire DataBuffer could not be transferred.\r
+                                     The actual number of bytes transferred is returned\r
+                                     in TransferLength.\r
+  @retval EFI_NOT_READY              The SCSI Request Packet could not be sent because \r
+                                     there are too many SCSI Command Packets already \r
+                                     queued.\r
+  @retval EFI_DEVICE_ERROR           A device error occurred while attempting to send \r
+                                     the SCSI Request Packet.\r
+  @retval EFI_INVALID_PARAMETER      ScsiIo is NULL.\r
+  @retval EFI_UNSUPPORTED            The command described by the SCSI Request Packet\r
+                                     is not supported by the SCSI initiator(i.e., SCSI \r
+                                     Host Controller).\r
+  @retval EFI_TIMEOUT                A timeout occurred while waiting for the SCSI \r
+                                     Request Packet to execute.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -121,9 +141,20 @@ ScsiInquiryCommand (
 /**\r
   Function to submit SCSI mode sense 10 command.\r
 \r
+  Submit SCSI Mode Sense (10) command with the SCSI request packet specified by this SCSI command and\r
+  the input parameters, then return the status of Scsi unit execution.\r
+\r
+  If SenseDataLength is NULL, then ASSERT().\r
+\r
+  If HostAdapterStatus is NULL, then ASSERT().\r
+\r
+  If TargetStatus is NULL, then ASSERT().\r
+\r
+  If DataLength is NULL, then ASSERT().\r
+\r
   @param[in]     ScsiIo             A pointer to SCSI IO protocol.\r
   @param[in]     Timeout            The length of timeout period.\r
-  @param[in]    SenseData          A pointer to output sense data.\r
+  @param[in]     SenseData          A pointer to output sense data.\r
   @param[in out] SenseDataLength    The length of output sense data.\r
   @param[out]    HostAdapterStatus  The status of Host Adapter.\r
   @param[out]    TargetStatus       The status of the target.\r
@@ -143,7 +174,7 @@ ScsiInquiryCommand (
                                     queued.\r
   @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send \r
                                     the SCSI Request Packet.\r
-  @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid.  \r
+  @retval EFI_INVALID_PARAMETER     ScsiIo is NULL. \r
   @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet\r
                                     is not supported by the SCSI initiator(i.e., SCSI \r
                                     Host Controller).\r
@@ -171,37 +202,31 @@ ScsiModeSense10Command (
 \r
 /**\r
   Function to submit SCSI request sense command.\r
-  ScsiIo               - A pointer to SCSI IO protocol.\r
-  Timeout              - The length of timeout period.\r
-  SenseData            - A pointer to output sense data.\r
-  SenseDataLength      - The length of output sense data.\r
-  HostAdapterStatus    - The status of Host Adapter.\r
-  TargetStatus         - The status of the target.\r
 \r
-  @param[in]     ScsiIo             SCSI IO Protocol to use\r
-  @param[in]     Timeout            TODO:\r
-  @param[in]     SenseData          TODO:\r
-  @param[in out] SenseDataLength    TODO:\r
-  @param[out]    HostAdapterStatus  TODO:\r
-  @param[out]    TargetStatus       TODO:\r
-\r
-  @retval EFI_SUCCESS        Valid data returned\r
-  @retval EFI_SUCCESS        The status of the unit is tested successfully.\r
-  @retval EFI_BAD_BUFFER_SIZE       The SCSI Request Packet was executed, \r
-                                    but the entire DataBuffer could not be transferred.\r
-                                    The actual number of bytes transferred is returned\r
-                                    in TransferLength.\r
-  @retval EFI_NOT_READY             The SCSI Request Packet could not be sent because \r
-                                    there are too many SCSI Command Packets already \r
-                                    queued.\r
-  @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send \r
-                                    the SCSI Request Packet.\r
-  @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid.  \r
-  @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet\r
-                                    is not supported by the SCSI initiator(i.e., SCSI \r
-                                    Host Controller).\r
-  @retval EFI_TIMEOUT               A timeout occurred while waiting for the SCSI \r
-                                    Request Packet to execute.\r
+  Submit SCSI request sense command with the SCSI requested packet specified by this\r
+  SCSI command, TimeOut and SenseData, and then return the status of scsi unit execution.\r
+\r
+  If SenseDataLength is NULL, then ASSERT().\r
+  \r
+  If HostAdapterStatus is NULL, then ASSERT().\r
+  \r
+  If TargetStatus is NULL, then ASSERT().\r
+\r
+  @param[in]       ScsiIo               A pointer to SCSI IO protocol.\r
+  @param[in]       Timeout              The length of timeout period.\r
+  @param[in]       SenseData            A pointer to output sense data.\r
+  @param[in out]   SenseDataLength      The length of output sense data.\r
+  @param[out]      HostAdapterStatus    The status of Host Adapter.\r
+  @param[out]      TargetStatus         The status of the target.\r
+\r
+  @retval EFI_SUCCESS                   Command is executed successfully.\r
+  @retval EFI_NOT_READY                 The SCSI Request Packet could not be sent because there are\r
+                                        too many SCSI Command Packets already queued.\r
+  @retval EFI_DEVICE_ERROR              A device error occurred while attempting to send SCSI Request Packet.\r
+  @retval EFI_UNSUPPORTED               The command described by the SCSI Request Packet is not supported by\r
+                                        the SCSI initiator(i.e., SCSI  Host Controller)\r
+  @retval EFI_TIMEOUT                   A timeout occurred while waiting for the SCSI Request Packet to execute.\r
+  @retval EFI_INVALID_PARAMETER         ScsiIo is NULL.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -219,32 +244,37 @@ ScsiRequestSenseCommand (
 /**\r
   Function to submit read capacity command.\r
 \r
-  @param[in]     ScsiIo             A pointer to SCSI IO protocol.\r
-  @param[in]     Timeout            The length of timeout period.\r
-  @param[in]    SenseData          A pointer to output sense data.\r
-  @param[in out] SenseDataLength    The length of output sense data.\r
-  @param[out]    HostAdapterStatus  The status of Host Adapter.\r
-  @param[out]    TargetStatus       The status of the target.\r
-  @param[out]    DataBuffer         A pointer to a data buffer.\r
-  @param[in out] DataLength         The length of data buffer.\r
-  @param[in]     PMI                Partial medium indicator.\r
-\r
-  @retval  EFI_SUCCESS                The status of the unit is tested successfully.\r
-  @retval  EFI_BAD_BUFFER_SIZE        The SCSI Request Packet was executed, \r
-                                      but the entire DataBuffer could not be transferred.\r
-                                      The actual number of bytes transferred is returned\r
-                                      in TransferLength.\r
-  @retval  EFI_NOT_READY              The SCSI Request Packet could not be sent because \r
-                                      there are too many SCSI Command Packets already \r
-                                      queued.\r
-  @retval  EFI_DEVICE_ERROR           A device error occurred while attempting to send \r
-                                      the SCSI Request Packet.\r
-  @retval  EFI_INVALID_PARAMETER      The contents of CommandPacket are invalid.  \r
-  @retval  EFI_UNSUPPORTED            The command described by the SCSI Request Packet\r
-                                      is not supported by the SCSI initiator(i.e., SCSI \r
-                                      Host Controller).\r
-  @retval  EFI_TIMEOUT                A timeout occurred while waiting for the SCSI \r
-                                      Request Packet to execute.\r
+  Submit SCSI read capacity command with the SCSI request packet specified by this SCSI \r
+  command and the input parameters, and then return the status of Scsi unit execution.\r
+\r
+  If SenseDataLength is NULL, then ASSERT().\r
+\r
+  If HostAdapterStatus is NULL, then ASSERT().\r
+\r
+  If TargetStatus is NULL, then ASSERT().\r
+\r
+  If DataLength is NULL, then ASSERT().\r
+\r
+  @param[in]     ScsiIo               A pointer to SCSI IO protocol.\r
+  @param[in]     Timeout              The length of timeout period.\r
+  @param[in]     SenseData            A pointer to output sense data.\r
+  @param[in out] SenseDataLength      The length of output sense data.\r
+  @param[out]    HostAdapterStatus    The status of Host Adapter.\r
+  @param[out]    TargetStatus         The status of the target.\r
+  @param[out]    DataBuffer           A pointer to a data buffer.\r
+  @param[in out] DataLength           The length of data buffer.\r
+  @param[in]     PMI                  Partial medium indicator.\r
+\r
+  @retval  EFI_SUCCESS                Command is executed successfully.\r
+  @retval  EFI_WARN_BUFFER_TOO_SMALL  The SCSI Request Packet was executed, but the entire DataBuffer could\r
+                                      not be transferred. The actual number of bytes transferred is returned in DataLength.\r
+  @retval  EFI_NOT_READY              The SCSI Request Packet could not be sent because there are too many \r
+                                      SCSI Command Packets already queued.\r
+  @retval  EFI_DEVICE_ERROR           A device error occurred while attempting to send SCSI Request Packet.\r
+  @retval  EFI_UNSUPPORTED            The command described by the SCSI Request Packet is not supported by \r
+                                      the SCSI initiator(i.e., SCSI  Host Controller)\r
+  @retval  EFI_TIMEOUT                A timeout occurred while waiting for the SCSI Request Packet to execute.\r
+  @retval  EFI_INVALID_PARAMETER      ScsiIo is NULL.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -265,33 +295,38 @@ ScsiReadCapacityCommand (
 /**\r
   Function to submit read 10 command.\r
 \r
-  @param[in]     ScsiIo             A pointer to SCSI IO protocol.\r
-  @param[in]     Timeout            The length of timeout period.\r
-  @param[in]    SenseData          A pointer to output sense data.\r
-  @param[in out] SenseDataLength    The length of output sense data.\r
-  @param[out]    HostAdapterStatus  The status of Host Adapter.\r
-  @param[out]    TargetStatus       The status of the target.\r
-  @param[out]    DataBuffer         Read 10 command data.\r
-  @param[in out] DataLength         The length of data buffer.\r
-  @param[in]     StartLba           The start address of LBA.\r
-  @param[in]     SectorSize         The sector size.\r
+  Submit SCSI read (10) command with the SCSI request packet specified by this SCSI command \r
+  and the input parameters, and then return the status of Scsi unit execution.\r
 \r
-  @retval EFI_SUCCESS               The status of the unit is tested successfully.\r
-  @retval EFI_BAD_BUFFER_SIZE       The SCSI Request Packet was executed, \r
-                                    but the entire DataBuffer could not be transferred.\r
-                                    The actual number of bytes transferred is returned\r
-                                    in TransferLength.\r
-  @retval EFI_NOT_READY             The SCSI Request Packet could not be sent because \r
-                                    there are too many SCSI Command Packets already \r
-                                    queued.\r
-  @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send \r
-                                    the SCSI Request Packet.\r
-  @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid.  \r
-  @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet\r
-                                    is not supported by the SCSI initiator(i.e., SCSI \r
-                                    Host Controller).\r
-  @retval EFI_TIMEOUT               A timeout occurred while waiting for the SCSI \r
-                                    Request Packet to execute.\r
+  If SenseDataLength is NULL, then ASSERT().\r
+\r
+  If HostAdapterStatus is NULL, then ASSERT().\r
+\r
+  If TargetStatus is NULL, then ASSERT().\r
+\r
+  If DataLength is NULL, then ASSERT().\r
+\r
+  @param[in]     ScsiIo               A pointer to SCSI IO protocol.\r
+  @param[in]     Timeout              The length of timeout period.\r
+  @param[in]     SenseData            A pointer to output sense data.\r
+  @param[in out] SenseDataLength      The length of output sense data.\r
+  @param[out]    HostAdapterStatus    The status of Host Adapter.\r
+  @param[out]    TargetStatus         The status of the target.\r
+  @param[out]    DataBuffer           Read 10 command data.\r
+  @param[in out] DataLength           The length of data buffer.\r
+  @param[in]     StartLba             The start address of LBA.\r
+  @param[in]     SectorSize           The sector size.\r
+\r
+  @retval  EFI_SUCCESS                Command is executed successfully.\r
+  @retval  EFI_WARN_BUFFER_TOO_SMALL  The SCSI Request Packet was executed, but the entire DataBuffer could\r
+                                      not be transferred. The actual number of bytes transferred is returned in DataLength.\r
+  @retval  EFI_NOT_READY              The SCSI Request Packet could not be sent because there are too many \r
+                                      SCSI Command Packets already queued.\r
+  @retval  EFI_DEVICE_ERROR           A device error occurred while attempting to send SCSI Request Packet.\r
+  @retval  EFI_UNSUPPORTED            The command described by the SCSI Request Packet is not supported by \r
+                                      the SCSI initiator(i.e., SCSI  Host Controller)\r
+  @retval  EFI_TIMEOUT                A timeout occurred while waiting for the SCSI Request Packet to execute.\r
+  @retval  EFI_INVALID_PARAMETER      ScsiIo is NULL.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -313,33 +348,38 @@ ScsiRead10Command (
 /**\r
   Function to submit SCSI write 10 command.\r
 \r
-  @param[in]     ScsiIo             SCSI IO Protocol to use\r
-  @param[in]     Timeout            The length of timeout period.\r
-  @param[in]    SenseData          A pointer to output sense data.\r
-  @param[in out] SenseDataLength    The length of output sense data.\r
-  @param[out]    HostAdapterStatus  The status of Host Adapter.\r
-  @param[out]    TargetStatus       The status of the target.\r
-  @param[out]    DataBuffer         A pointer to a data buffer.\r
-  @param[in out] DataLength         The length of data buffer.\r
-  @param[in]     StartLba           The start address of LBA.\r
-  @param[in]     SectorSize         The sector size.\r
-\r
-  @retval EFI_SUCCESS               The status of the unit is tested successfully.\r
-  @retval EFI_BAD_BUFFER_SIZE       The SCSI Request Packet was executed, \r
-                                    but the entire DataBuffer could not be transferred.\r
-                                    The actual number of bytes transferred is returned\r
-                                    in InTransferLength.\r
-  @retval EFI_NOT_READY             The SCSI Request Packet could not be sent because \r
-                                    there are too many SCSI Command Packets already \r
-                                    queued.\r
-  @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send \r
-                                    the SCSI Request Packet.\r
-  @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid.  \r
-  @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet\r
-                                    is not supported by the SCSI initiator(i.e., SCSI \r
-                                    Host Controller).\r
-  @retval EFI_TIMEOUT               A timeout occurred while waiting for the SCSI \r
-                                    Request Packet to execute.\r
+  Submit SCSI write (10) command with the SCSI request packet specified by this SCSI command and the\r
+  input parameters, and then return the status of Scsi unit execution.\r
+\r
+  If SenseDataLength is NULL, then ASSERT().\r
+\r
+  If HostAdapterStatus is NULL, then ASSERT().\r
+\r
+  If TargetStatus is NULL, then ASSERT().\r
+\r
+  If DataLength is NULL, then ASSERT().\r
+\r
+  @param[in]     ScsiIo               SCSI IO Protocol to use\r
+  @param[in]     Timeout              The length of timeout period.\r
+  @param[in]     SenseData            A pointer to output sense data.\r
+  @param[in out] SenseDataLength      The length of output sense data.\r
+  @param[out]    HostAdapterStatus    The status of Host Adapter.\r
+  @param[out]    TargetStatus         The status of the target.\r
+  @param[out]    DataBuffer           A pointer to a data buffer.\r
+  @param[in out] DataLength           The length of data buffer.\r
+  @param[in]     StartLba             The start address of LBA.\r
+  @param[in]     SectorSize           The sector size.\r
+\r
+  @retval  EFI_SUCCESS                Command is executed successfully.\r
+  @retval  EFI_WARN_BUFFER_TOO_SMALL  The SCSI Request Packet was executed, but the entire DataBuffer could\r
+                                      not be transferred. The actual number of bytes transferred is returned in DataLength.\r
+  @retval  EFI_NOT_READY              The SCSI Request Packet could not be sent because there are too many \r
+                                      SCSI Command Packets already queued.\r
+  @retval  EFI_DEVICE_ERROR           A device error occurred while attempting to send SCSI Request Packet.\r
+  @retval  EFI_UNSUPPORTED            The command described by the SCSI Request Packet is not supported by \r
+                                      the SCSI initiator(i.e., SCSI  Host Controller)\r
+  @retval  EFI_TIMEOUT                A timeout occurred while waiting for the SCSI Request Packet to execute.\r
+  @retval  EFI_INVALID_PARAMETER      ScsiIo is NULL.\r
 \r
 **/\r
 EFI_STATUS\r

diff --git a/MdePkg/Library/UefiScsiLib/UefiScsiLib.c b/MdePkg/Library/UefiScsiLib/UefiScsiLib.c
index f5054de14f70fb554ee954b97186a99ebe88a8de..380d195d7e80cd29844213f07e0a647b24b2fcab 100644 (file)
--- a/MdePkg/Library/UefiScsiLib/UefiScsiLib.c
+++ b/MdePkg/Library/UefiScsiLib/UefiScsiLib.c
@@ -34,16 +34,20 @@
 \r
 /**\r
   Function test the ready status of the SCSI unit.\r
+\r
+  Submit SCSI test unit ready command with SCSI request packet specified by this scsi command, TimeOut\r
+  and SenseData, then get the status of the target Scsi unit.\r
+\r
   If SenseDataLength is NULL, then ASSERT().\r
+\r
   If HostAdapterStatus is NULL, then ASSERT().\r
+\r
   If TargetStatus is NULL, then ASSERT().\r
 \r
   @param[in]     ScsiIo             A pointer to SCSI IO protocol.\r
   @param[in]     Timeout            The length of timeout period.\r
-  @param[in out] SenseData          A pointer to the sense data that \r
-                                    was generated by the execution of the SCSI Request Packet.\r
-  @param[in out] SenseDataLength    On input, the length in bytes of the SenseData buffer. On\r
-                                    output, the number of bytes written to the SenseData buffer.\r
+  @param[out]    SenseData          A pointer to output sense data.\r
+  @param[out]    SenseDataLength    The length of output sense data.\r
   @param[out]    HostAdapterStatus  The status of Host Adapter.\r
   @param[out]    TargetStatus       The status of the target.\r
 \r
@@ -57,7 +61,7 @@
                                 queued.\r
   @retval EFI_DEVICE_ERROR      A device error occurred while attempting to send \r
                                 the SCSI Request Packet.\r
-  @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid, or ScsiIo is NULL.  \r
+  @retval EFI_INVALID_PARAMETER ScsiIo is NULL.\r
   @retval EFI_UNSUPPORTED       The command described by the SCSI Request Packet\r
                                 is not supported by the SCSI initiator(i.e., SCSI \r
                                 Host Controller).\r
@@ -124,38 +128,44 @@ ScsiTestUnitReadyCommand (
 \r
 /**\r
   Function to submit SCSI inquiry command.\r
+\r
+  Submit SCSI inquiry command with the SCSI request packet specified by this SCSI command and input\r
+  parameters, then return the status of Scsi unit execution.\r
+\r
   If SenseDataLength is NULL, then ASSERT().\r
+\r
   If HostAdapterStatus is NULL, then ASSERT().\r
+\r
   If TargetStatus is NULL, then ASSERT().\r
+\r
   If InquiryDataLength is NULL, then ASSERT().\r
 \r
   @param[in]     ScsiIo             SCSI IO Protocol to use\r
   @param[in]     Timeout            The length of timeout period.\r
-  @param[in]    SenseData          A pointer to output sense data.\r
-  @param[in out] SenseDataLength    On input, the length in bytes of the SenseData buffer. On\r
-                                    output, the number of bytes written to the SenseData buffer.\r
+  @param[in]     SenseData          A pointer to output sense data.\r
+  @param[in out] SenseDataLength    The length of output sense data.\r
   @param[out]    HostAdapterStatus  The status of Host Adapter.\r
   @param[out]    TargetStatus       The status of the target.\r
-  @param[in]     InquirydDtaBuffer  A pointer to inquiry data buffer.\r
+  @param[in out] InquirydataBuffer  A pointer to inquiry data buffer.\r
   @param[in out] InquiryDataLength  The length of inquiry data buffer.\r
   @param[in]     EnableVitalProductData  Boolean to enable Vital Product Data.\r
 \r
-  @retval EFI_SUCCESS         The status of the unit is tested successfully.\r
-  @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, \r
-                              but the entire DataBuffer could not be transferred.\r
-                              The actual number of bytes transferred is returned\r
-                              in TransferLength.\r
-  @retval EFI_NOT_READY   The SCSI Request Packet could not be sent because \r
-                          there are too many SCSI Command Packets already \r
-                          queued.\r
-  @retval EFI_DEVICE_ERROR  A device error occurred while attempting to send \r
-                            the SCSI Request Packet.\r
-  @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid, or ScsiIo is NULL.\r
-  @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet\r
-                          is not supported by the SCSI initiator(i.e., SCSI \r
-                          Host Controller).\r
-  @retval EFI_TIMEOUT     A timeout occurred while waiting for the SCSI \r
-                          Request Packet to execute.\r
+  @retval EFI_SUCCESS                Command is executed successfully.\r
+  @retval EFI_BAD_BUFFER_SIZE        The SCSI Request Packet was executed, \r
+                                     but the entire DataBuffer could not be transferred.\r
+                                     The actual number of bytes transferred is returned\r
+                                     in TransferLength.\r
+  @retval EFI_NOT_READY              The SCSI Request Packet could not be sent because \r
+                                     there are too many SCSI Command Packets already \r
+                                     queued.\r
+  @retval EFI_DEVICE_ERROR           A device error occurred while attempting to send \r
+                                     the SCSI Request Packet.\r
+  @retval EFI_INVALID_PARAMETER      ScsiIo is NULL.\r
+  @retval EFI_UNSUPPORTED            The command described by the SCSI Request Packet\r
+                                     is not supported by the SCSI initiator(i.e., SCSI \r
+                                     Host Controller).\r
+  @retval EFI_TIMEOUT                A timeout occurred while waiting for the SCSI \r
+                                     Request Packet to execute.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -228,16 +238,22 @@ ScsiInquiryCommand (
 \r
 /**\r
   Function to submit SCSI mode sense 10 command.\r
+\r
+  Submit SCSI Mode Sense (10) command with the SCSI request packet specified by this SCSI command and\r
+  the input parameters, then return the status of Scsi unit execution.\r
+\r
   If SenseDataLength is NULL, then ASSERT().\r
+\r
   If HostAdapterStatus is NULL, then ASSERT().\r
+\r
   If TargetStatus is NULL, then ASSERT().\r
+\r
   If DataLength is NULL, then ASSERT().\r
 \r
   @param[in]     ScsiIo             A pointer to SCSI IO protocol.\r
   @param[in]     Timeout            The length of timeout period.\r
-  @param[in]    SenseData          A pointer to output sense data.\r
-  @param[in out] SenseDataLength    On input, the length in bytes of the SenseData buffer. On\r
-                                    output, the number of bytes written to the SenseData buffer.\r
+  @param[in]     SenseData          A pointer to output sense data.\r
+  @param[in out] SenseDataLength    The length of output sense data.\r
   @param[out]    HostAdapterStatus  The status of Host Adapter.\r
   @param[out]    TargetStatus       The status of the target.\r
   @param[in]     DataBuffer         A pointer to input data buffer.\r
@@ -256,7 +272,7 @@ ScsiInquiryCommand (
                                     queued.\r
   @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send \r
                                     the SCSI Request Packet.\r
-  @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid, or ScsiIo is NULL.  \r
+  @retval EFI_INVALID_PARAMETER     ScsiIo is NULL. \r
   @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet\r
                                     is not supported by the SCSI initiator(i.e., SCSI \r
                                     Host Controller).\r
@@ -339,35 +355,31 @@ ScsiModeSense10Command (
 \r
 /**\r
   Function to submit SCSI request sense command.\r
+\r
+  Submit SCSI request sense command with the SCSI requested packet specified by this\r
+  SCSI command, TimeOut and SenseData, and then return the status of scsi unit execution.\r
+\r
   If SenseDataLength is NULL, then ASSERT().\r
+  \r
   If HostAdapterStatus is NULL, then ASSERT().\r
+  \r
   If TargetStatus is NULL, then ASSERT().\r
 \r
-  @param[in]     ScsiIo             A pointer to SCSI IO protocol.\r
-  @param[in]     Timeout            The length of timeout period.\r
-  @param[in]     SenseData          A pointer to output sense data.\r
-  @param[in out] SenseDataLength    On input, the length in bytes of the SenseData buffer. On\r
-                                    output, the number of bytes written to the SenseData buffer.\r
-  @param[out]    HostAdapterStatus  The status of Host Adapter.\r
-  @param[out]    TargetStatus       The status of the target.\r
-\r
-  @retval EFI_SUCCESS        Valid data returned\r
-  @retval EFI_SUCCESS        The status of the unit is tested successfully.\r
-  @retval EFI_BAD_BUFFER_SIZE       The SCSI Request Packet was executed, \r
-                                    but the entire DataBuffer could not be transferred.\r
-                                    The actual number of bytes transferred is returned\r
-                                    in TransferLength.\r
-  @retval EFI_NOT_READY             The SCSI Request Packet could not be sent because \r
-                                    there are too many SCSI Command Packets already \r
-                                    queued.\r
-  @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send \r
-                                    the SCSI Request Packet.\r
-  @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid, or ScsiIo is NULL.\r
-  @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet\r
-                                    is not supported by the SCSI initiator(i.e., SCSI \r
-                                    Host Controller).\r
-  @retval EFI_TIMEOUT               A timeout occurred while waiting for the SCSI \r
-                                    Request Packet to execute.\r
+  @param[in]       ScsiIo               A pointer to SCSI IO protocol.\r
+  @param[in]       Timeout              The length of timeout period.\r
+  @param[in]       SenseData            A pointer to output sense data.\r
+  @param[in out]   SenseDataLength      The length of output sense data.\r
+  @param[out]      HostAdapterStatus    The status of Host Adapter.\r
+  @param[out]      TargetStatus         The status of the target.\r
+\r
+  @retval EFI_SUCCESS                   Command is executed successfully.\r
+  @retval EFI_NOT_READY                 The SCSI Request Packet could not be sent because there are\r
+                                        too many SCSI Command Packets already queued.\r
+  @retval EFI_DEVICE_ERROR              A device error occurred while attempting to send SCSI Request Packet.\r
+  @retval EFI_UNSUPPORTED               The command described by the SCSI Request Packet is not supported by\r
+                                        the SCSI initiator(i.e., SCSI  Host Controller)\r
+  @retval EFI_TIMEOUT                   A timeout occurred while waiting for the SCSI Request Packet to execute.\r
+  @retval EFI_INVALID_PARAMETER         ScsiIo is NULL.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -430,38 +442,38 @@ ScsiRequestSenseCommand (
 \r
 /**\r
   Function to submit read capacity command.\r
+\r
+  Submit SCSI read capacity command with the SCSI request packet specified by this SCSI \r
+  command and the input parameters, and then return the status of Scsi unit execution.\r
+\r
   If SenseDataLength is NULL, then ASSERT().\r
+\r
   If HostAdapterStatus is NULL, then ASSERT().\r
+\r
   If TargetStatus is NULL, then ASSERT().\r
+\r
   If DataLength is NULL, then ASSERT().\r
 \r
-  @param[in]     ScsiIo             A pointer to SCSI IO protocol.\r
-  @param[in]     Timeout            The length of timeout period.\r
-  @param[in]    SenseData          A pointer to output sense data.\r
-  @param[in out] SenseDataLength    On input, the length in bytes of the SenseData buffer. On\r
-                                    output, the number of bytes written to the SenseData buffer.\r
-  @param[out]    HostAdapterStatus  The status of Host Adapter.\r
-  @param[out]    TargetStatus       The status of the target.\r
-  @param[out]    DataBuffer         A pointer to a data buffer.\r
-  @param[in out] DataLength         The length of data buffer.\r
-  @param[in]     PMI                Partial medium indicator.\r
-\r
-  @retval  EFI_SUCCESS                The status of the unit is tested successfully.\r
-  @retval  EFI_BAD_BUFFER_SIZE        The SCSI Request Packet was executed, \r
-                                      but the entire DataBuffer could not be transferred.\r
-                                      The actual number of bytes transferred is returned\r
-                                      in TransferLength.\r
-  @retval  EFI_NOT_READY              The SCSI Request Packet could not be sent because \r
-                                      there are too many SCSI Command Packets already \r
-                                      queued.\r
-  @retval  EFI_DEVICE_ERROR           A device error occurred while attempting to send \r
-                                      the SCSI Request Packet.\r
-  @retval  EFI_INVALID_PARAMETER      The contents of CommandPacket are invalid, or ScsiIo is NULL.\r
-  @retval  EFI_UNSUPPORTED            The command described by the SCSI Request Packet\r
-                                      is not supported by the SCSI initiator(i.e., SCSI \r
-                                      Host Controller).\r
-  @retval  EFI_TIMEOUT                A timeout occurred while waiting for the SCSI \r
-                                      Request Packet to execute.\r
+  @param[in]     ScsiIo               A pointer to SCSI IO protocol.\r
+  @param[in]     Timeout              The length of timeout period.\r
+  @param[in]     SenseData            A pointer to output sense data.\r
+  @param[in out] SenseDataLength      The length of output sense data.\r
+  @param[out]    HostAdapterStatus    The status of Host Adapter.\r
+  @param[out]    TargetStatus         The status of the target.\r
+  @param[out]    DataBuffer           A pointer to a data buffer.\r
+  @param[in out] DataLength           The length of data buffer.\r
+  @param[in]     PMI                  Partial medium indicator.\r
+\r
+  @retval  EFI_SUCCESS                Command is executed successfully.\r
+  @retval  EFI_WARN_BUFFER_TOO_SMALL  The SCSI Request Packet was executed, but the entire DataBuffer could\r
+                                      not be transferred. The actual number of bytes transferred is returned in DataLength.\r
+  @retval  EFI_NOT_READY              The SCSI Request Packet could not be sent because there are too many \r
+                                      SCSI Command Packets already queued.\r
+  @retval  EFI_DEVICE_ERROR           A device error occurred while attempting to send SCSI Request Packet.\r
+  @retval  EFI_UNSUPPORTED            The command described by the SCSI Request Packet is not supported by \r
+                                      the SCSI initiator(i.e., SCSI  Host Controller)\r
+  @retval  EFI_TIMEOUT                A timeout occurred while waiting for the SCSI Request Packet to execute.\r
+  @retval  EFI_INVALID_PARAMETER      ScsiIo is NULL.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -536,39 +548,39 @@ ScsiReadCapacityCommand (
 \r
 /**\r
   Function to submit read 10 command.\r
+\r
+  Submit SCSI read (10) command with the SCSI request packet specified by this SCSI command \r
+  and the input parameters, and then return the status of Scsi unit execution.\r
+\r
   If SenseDataLength is NULL, then ASSERT().\r
+\r
   If HostAdapterStatus is NULL, then ASSERT().\r
+\r
   If TargetStatus is NULL, then ASSERT().\r
-  If DataLength is NULL, then ASSERT().\r
 \r
-  @param[in]     ScsiIo             A pointer to SCSI IO protocol.\r
-  @param[in]     Timeout            The length of timeout period.\r
-  @param[in]     SenseData          A pointer to output sense data.\r
-  @param[in out] SenseDataLength    On input, the length in bytes of the SenseData buffer. On\r
-                                    output, the number of bytes written to the SenseData buffer.\r
-  @param[out]    HostAdapterStatus  The status of Host Adapter.\r
-  @param[out]    TargetStatus       The status of the target.\r
-  @param[out]    DataBuffer         Read 10 command data.\r
-  @param[in out] DataLength         The length of data buffer.\r
-  @param[in]     StartLba           The start address of LBA.\r
-  @param[in]     SectorSize         The sector size.\r
+  If DataLength is NULL, then ASSERT().\r
 \r
-  @retval EFI_SUCCESS               The status of the unit is tested successfully.\r
-  @retval EFI_BAD_BUFFER_SIZE       The SCSI Request Packet was executed, \r
-                                    but the entire DataBuffer could not be transferred.\r
-                                    The actual number of bytes transferred is returned\r
-                                    in TransferLength.\r
-  @retval EFI_NOT_READY             The SCSI Request Packet could not be sent because \r
-                                    there are too many SCSI Command Packets already \r
-                                    queued.\r
-  @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send \r
-                                    the SCSI Request Packet.\r
-  @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid, or ScsiIo is NULL.\r
-  @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet\r
-                                    is not supported by the SCSI initiator(i.e., SCSI \r
-                                    Host Controller).\r
-  @retval EFI_TIMEOUT               A timeout occurred while waiting for the SCSI \r
-                                    Request Packet to execute.\r
+  @param[in]     ScsiIo               A pointer to SCSI IO protocol.\r
+  @param[in]     Timeout              The length of timeout period.\r
+  @param[in]     SenseData            A pointer to output sense data.\r
+  @param[in out] SenseDataLength      The length of output sense data.\r
+  @param[out]    HostAdapterStatus    The status of Host Adapter.\r
+  @param[out]    TargetStatus         The status of the target.\r
+  @param[out]    DataBuffer           Read 10 command data.\r
+  @param[in out] DataLength           The length of data buffer.\r
+  @param[in]     StartLba             The start address of LBA.\r
+  @param[in]     SectorSize           The sector size.\r
+\r
+  @retval  EFI_SUCCESS                Command is executed successfully.\r
+  @retval  EFI_WARN_BUFFER_TOO_SMALL  The SCSI Request Packet was executed, but the entire DataBuffer could\r
+                                      not be transferred. The actual number of bytes transferred is returned in DataLength.\r
+  @retval  EFI_NOT_READY              The SCSI Request Packet could not be sent because there are too many \r
+                                      SCSI Command Packets already queued.\r
+  @retval  EFI_DEVICE_ERROR           A device error occurred while attempting to send SCSI Request Packet.\r
+  @retval  EFI_UNSUPPORTED            The command described by the SCSI Request Packet is not supported by \r
+                                      the SCSI initiator(i.e., SCSI  Host Controller)\r
+  @retval  EFI_TIMEOUT                A timeout occurred while waiting for the SCSI Request Packet to execute.\r
+  @retval  EFI_INVALID_PARAMETER      ScsiIo is NULL.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -642,39 +654,39 @@ ScsiRead10Command (
 \r
 /**\r
   Function to submit SCSI write 10 command.\r
+\r
+  Submit SCSI write (10) command with the SCSI request packet specified by this SCSI command and the\r
+  input parameters, and then return the status of Scsi unit execution.\r
+\r
   If SenseDataLength is NULL, then ASSERT().\r
+\r
   If HostAdapterStatus is NULL, then ASSERT().\r
+\r
   If TargetStatus is NULL, then ASSERT().\r
-  If DataLength is NULL, then ASSERT().\r
 \r
-  @param[in]     ScsiIo             SCSI IO Protocol to use\r
-  @param[in]     Timeout            The length of timeout period.\r
-  @param[in]    SenseData          A pointer to output sense data.\r
-  @param[in out]  SenseDataLength   On input, the length in bytes of the SenseData buffer. On\r
-                                    output, the number of bytes written to the SenseData buffer.\r
-  @param[out]    HostAdapterStatus  The status of Host Adapter.\r
-  @param[out]    TargetStatus       The status of the target.\r
-  @param[out]    DataBuffer         A pointer to a data buffer.\r
-  @param[in out] DataLength         The length of data buffer.\r
-  @param[in]     StartLba           The start address of LBA.\r
-  @param[in]     SectorSize         The sector size.\r
+  If DataLength is NULL, then ASSERT().\r
 \r
-  @retval EFI_SUCCESS               The status of the unit is tested successfully.\r
-  @retval EFI_BAD_BUFFER_SIZE       The SCSI Request Packet was executed, \r
-                                    but the entire DataBuffer could not be transferred.\r
-                                    The actual number of bytes transferred is returned\r
-                                    in InTransferLength.\r
-  @retval EFI_NOT_READY             The SCSI Request Packet could not be sent because \r
-                                    there are too many SCSI Command Packets already \r
-                                    queued.\r
-  @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send \r
-                                    the SCSI Request Packet.\r
-  @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid, or ScsiIo is NULL.\r
-  @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet\r
-                                    is not supported by the SCSI initiator(i.e., SCSI \r
-                                    Host Controller).\r
-  @retval EFI_TIMEOUT               A timeout occurred while waiting for the SCSI \r
-                                    Request Packet to execute.\r
+  @param[in]     ScsiIo               SCSI IO Protocol to use\r
+  @param[in]     Timeout              The length of timeout period.\r
+  @param[in]     SenseData            A pointer to output sense data.\r
+  @param[in out] SenseDataLength      The length of output sense data.\r
+  @param[out]    HostAdapterStatus    The status of Host Adapter.\r
+  @param[out]    TargetStatus         The status of the target.\r
+  @param[out]    DataBuffer           A pointer to a data buffer.\r
+  @param[in out] DataLength           The length of data buffer.\r
+  @param[in]     StartLba             The start address of LBA.\r
+  @param[in]     SectorSize           The sector size.\r
+\r
+  @retval  EFI_SUCCESS                Command is executed successfully.\r
+  @retval  EFI_WARN_BUFFER_TOO_SMALL  The SCSI Request Packet was executed, but the entire DataBuffer could\r
+                                      not be transferred. The actual number of bytes transferred is returned in DataLength.\r
+  @retval  EFI_NOT_READY              The SCSI Request Packet could not be sent because there are too many \r
+                                      SCSI Command Packets already queued.\r
+  @retval  EFI_DEVICE_ERROR           A device error occurred while attempting to send SCSI Request Packet.\r
+  @retval  EFI_UNSUPPORTED            The command described by the SCSI Request Packet is not supported by \r
+                                      the SCSI initiator(i.e., SCSI  Host Controller)\r
+  @retval  EFI_TIMEOUT                A timeout occurred while waiting for the SCSI Request Packet to execute.\r
+  @retval  EFI_INVALID_PARAMETER      ScsiIo is NULL.\r
 \r
 **/\r
 EFI_STATUS\r