Function headers checked with spec

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

diff --git a/MdePkg/Library/UefiScsiLib/UefiScsiLib.c b/MdePkg/Library/UefiScsiLib/UefiScsiLib.c
index 3b4da1fb0e17aaeace1054a867fa843284147a30..d2ad70b380438796c85059f14efa3d5e112ea0dc 100644 (file)
--- a/MdePkg/Library/UefiScsiLib/UefiScsiLib.c
+++ b/MdePkg/Library/UefiScsiLib/UefiScsiLib.c
@@ -328,12 +328,12 @@ ScsiInquiryCommand (
                                      If Timeout is greater than zero, then this function\r
                                      will return EFI_TIMEOUT if the time required to\r
                                      execute the SCSI Request Packet is greater than Timeout.\r
-  @param[in, out] SenseData          A pointer to sense data that was generated\r
+  @param[in, out]  SenseData         A pointer to sense data that was generated\r
                                      by the execution of the SCSI Request Packet.\r
                                      This buffer must be allocated by the caller.\r
                                      If SenseDataLength is 0, then this parameter\r
                                      is optional and may be NULL.\r
-  @param[in, out] SenseDataLength    On input, the length in bytes of the SenseData buffer.\r
+  @param[in, out]  SenseDataLength   On input, the length in bytes of the SenseData buffer.\r
                                      On output, the number of bytes written to the SenseData buffer. \r
   @param[out]     HostAdapterStatus  The status of the SCSI Host Controller that\r
                                      produces the SCSI bus containing the SCSI target\r
@@ -560,15 +560,16 @@ ScsiRequestSenseCommand (
   @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_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
@@ -664,15 +665,15 @@ ScsiReadCapacityCommand (
   @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_SUCCESS          Command is executed successfully.\r
+  @retval  EFI_BAD_BUFFER_SIZE  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
 \r
 **/\r
 EFI_STATUS\r
@@ -758,23 +759,23 @@ ScsiRead10Command (
   @param[in]      ScsiIo               SCSI IO Protocol to use\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[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, 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_SUCCESS          Command is executed successfully.\r
+  @retval  EFI_BAD_BUFFER_SIZE  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
 \r
 **/\r
 EFI_STATUS\r