Update function header description of ScsiReadCapacity16Command() in the UEFI Scsi...

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

diff --git a/MdePkg/Include/Library/UefiScsiLib.h b/MdePkg/Include/Library/UefiScsiLib.h
index a1e716384609d864c71381df87ae811e72acd852..072a35d63a6ccee815f6e88d5cc4e465b9491ed5 100644 (file)
--- a/MdePkg/Include/Library/UefiScsiLib.h
+++ b/MdePkg/Include/Library/UefiScsiLib.h
@@ -378,34 +378,38 @@ ScsiReadCapacityCommand (
 \r
 \r
 /**\r
-  Function to submit read capacity16 command.\r
-\r
-  @param  ScsiIo            A pointer to SCSI IO protocol.\r
-  @param  Timeout           The length of timeout period.\r
-  @param  SenseData         A pointer to output sense data.\r
-  @param  SenseDataLength   The length of output sense data.\r
-  @param  HostAdapterStatus The status of Host Adapter.\r
-  @param  TargetStatus      The status of the target.\r
-  @param  DataBuffer        A pointer to a data buffer.\r
-  @param  DataLength        The length of data buffer.\r
-  @param  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
+  Execute Read Capacity SCSI 16 command on a specific SCSI target.\r
+\r
+  Executes the SCSI Read Capacity 16 command on the SCSI target specified by ScsiIo.\r
+  If Timeout is zero, then this function waits indefinitely for the command to complete.\r
+  If Timeout is greater than zero, then the command is executed and will timeout after\r
+  Timeout 100 ns units.  The Pmi parameter is used to construct the CDB for this SCSI command.\r
+  If ScsiIo is NULL, then ASSERT().\r
+  If SenseDataLength is NULL, then ASSERT().\r
+  If HostAdapterStatus is NULL, then ASSERT().\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, out] 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, 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_BAD_BUFFER_SIZE   The SCSI Request Packet was executed, but the entire\r
+                                 DataBuffer could not be transferred. The actual\r
+                                 number of bytes transferred is returned in DataLength.\r
+  @retval  EFI_NOT_READY         The SCSI Request Packet could not be sent because\r
+                                 there are 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\r
+                                 is not supported by 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
 \r
 **/\r
 EFI_STATUS\r

diff --git a/MdePkg/Library/UefiScsiLib/UefiScsiLib.c b/MdePkg/Library/UefiScsiLib/UefiScsiLib.c
index 2b770b58e3fb656825ea8153eddc64f53ac413c0..b75badf4e63009531e2e300a256d4ae215499033 100644 (file)
--- a/MdePkg/Library/UefiScsiLib/UefiScsiLib.c
+++ b/MdePkg/Library/UefiScsiLib/UefiScsiLib.c
@@ -636,34 +636,38 @@ ScsiReadCapacityCommand (
 \r
 \r
 /**\r
-  Function to submit read capacity16 command.\r
-\r
-  @param  ScsiIo            A pointer to SCSI IO protocol.\r
-  @param  Timeout           The length of timeout period.\r
-  @param  SenseData         A pointer to output sense data.\r
-  @param  SenseDataLength   The length of output sense data.\r
-  @param  HostAdapterStatus The status of Host Adapter.\r
-  @param  TargetStatus      The status of the target.\r
-  @param  DataBuffer        A pointer to a data buffer.\r
-  @param  DataLength        The length of data buffer.\r
-  @param  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
+  Execute Read Capacity SCSI 16 command on a specific SCSI target.\r
+\r
+  Executes the SCSI Read Capacity 16 command on the SCSI target specified by ScsiIo.\r
+  If Timeout is zero, then this function waits indefinitely for the command to complete.\r
+  If Timeout is greater than zero, then the command is executed and will timeout after\r
+  Timeout 100 ns units.  The Pmi parameter is used to construct the CDB for this SCSI command.\r
+  If ScsiIo is NULL, then ASSERT().\r
+  If SenseDataLength is NULL, then ASSERT().\r
+  If HostAdapterStatus is NULL, then ASSERT().\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, out] 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, 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_BAD_BUFFER_SIZE   The SCSI Request Packet was executed, but the entire\r
+                                 DataBuffer could not be transferred. The actual\r
+                                 number of bytes transferred is returned in DataLength.\r
+  @retval  EFI_NOT_READY         The SCSI Request Packet could not be sent because\r
+                                 there are 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\r
+                                 is not supported by 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
 \r
 **/\r
 EFI_STATUS\r