MdePkg: Clean up source files

[mirror_edk2.git] / MdePkg / Include / Library / UefiScsiLib.h

diff --git a/MdePkg/Include/Library/UefiScsiLib.h b/MdePkg/Include/Library/UefiScsiLib.h
index 067acfdb43478898dbd1c6c833093157c2c7dc7e..dbb248972ba0e46a73a2daa37d9d0f73d29e7c75 100644 (file)
--- a/MdePkg/Include/Library/UefiScsiLib.h
+++ b/MdePkg/Include/Library/UefiScsiLib.h
@@ -5,14 +5,14 @@
   for hard drive, CD and DVD devices that are the most common SCSI boot targets used by UEFI platforms.\r
   This library class depends on SCSI I/O Protocol defined in UEFI Specification and SCSI-2 industry standard.\r
 \r
   for hard drive, CD and DVD devices that are the most common SCSI boot targets used by UEFI platforms.\r
   This library class depends on SCSI I/O Protocol defined in UEFI Specification and SCSI-2 industry standard.\r
 \r

-Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials                          \r
-are licensed and made available under the terms and conditions of the BSD License         \r
-which accompanies this distribution.  The full text of the license may be found at        \r
-http://opensource.org/licenses/bsd-license.php                                            \r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution.  The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r

 \r
 \r

-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r

 \r
 **/\r
 \r
 \r
 **/\r
 \r


@@ -52,7 +52,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
                                     optional and may be NULL.\r
   @param[in, out] SenseDataLength   On input, a pointer to the length in bytes of\r
                                     the SenseData buffer. On output, a pointer to\r
                                     optional and may be NULL.\r
   @param[in, out] SenseDataLength   On input, a pointer to the length in bytes of\r
                                     the SenseData buffer. On output, a pointer to\r

-                                    the number of bytes written to the SenseData buffer. \r
+                                    the number of bytes written to the SenseData buffer.\r

   @param[out]     HostAdapterStatus The status of the SCSI Host Controller that produces\r
                                     the SCSI bus containing the SCSI target specified by\r
                                     ScsiIo when the SCSI Request Packet was executed.\r
   @param[out]     HostAdapterStatus The status of the SCSI Host Controller that produces\r
                                     the SCSI bus containing the SCSI target specified by\r
                                     ScsiIo when the SCSI Request Packet was executed.\r


@@ -62,7 +62,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
                                     by ScsiIo when the SCSI Request Packet was executed\r
                                     on the SCSI Host Controller. See the EFI SCSI I/O\r
                                     Protocol in the UEFI Specification for details on\r
                                     by ScsiIo when the SCSI Request Packet was executed\r
                                     on the SCSI Host Controller. See the EFI SCSI I/O\r
                                     Protocol in the UEFI Specification for details on\r

-                                    the possible return values. \r
+                                    the possible return values.\r

 \r
   @retval EFI_SUCCESS               The command was executed successfully.\r
                                     See HostAdapterStatus, TargetStatus, SenseDataLength,\r
 \r
   @retval EFI_SUCCESS               The command was executed successfully.\r
                                     See HostAdapterStatus, TargetStatus, SenseDataLength,\r


@@ -135,7 +135,7 @@ ScsiTestUnitReadyCommand (
                                          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
                                          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

-                                         On output, the number of bytes written to 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\r
                                          target specified by ScsiIo when the SCSI\r
   @param[out]     HostAdapterStatus      The status of the SCSI Host Controller that\r
                                          produces the SCSI bus containing the SCSI\r
                                          target specified by ScsiIo when the SCSI\r


@@ -147,12 +147,12 @@ ScsiTestUnitReadyCommand (
                                          executed on the SCSI Host Controller.\r
                                          See the EFI SCSI I/O Protocol in the UEFI\r
                                          Specification for details on the possible\r
                                          executed on the SCSI Host Controller.\r
                                          See the EFI SCSI I/O Protocol in the UEFI\r
                                          Specification for details on the possible\r

-                                         return values. \r
+                                         return values.\r

   @param[in, out] InquiryDataBuffer      A pointer to inquiry data that was generated\r
                                          by the execution of the SCSI Request Packet.\r
                                          This buffer must be allocated by the caller.\r
                                          If InquiryDataLength is 0, then this parameter\r
   @param[in, out] InquiryDataBuffer      A pointer to inquiry data that was generated\r
                                          by the execution of the SCSI Request Packet.\r
                                          This buffer must be allocated by the caller.\r
                                          If InquiryDataLength is 0, then this parameter\r

-                                         is optional and may be NULL. \r
+                                         is optional and may be NULL.\r

   @param[in, out] InquiryDataLength      On input, a pointer to the length in bytes\r
                                          of the InquiryDataBuffer buffer.\r
                                          On output, a pointer to the number of bytes\r
   @param[in, out] InquiryDataLength      On input, a pointer to the length in bytes\r
                                          of the InquiryDataBuffer buffer.\r
                                          On output, a pointer to the number of bytes\r


@@ -160,7 +160,7 @@ ScsiTestUnitReadyCommand (
   @param[in]      EnableVitalProductData If TRUE, then the supported vital product\r
                                          data is returned in InquiryDataBuffer.\r
                                          If FALSE, then the standard inquiry data is\r
   @param[in]      EnableVitalProductData If TRUE, then the supported vital product\r
                                          data is returned in InquiryDataBuffer.\r
                                          If FALSE, then the standard inquiry data is\r

-                                         returned in InquiryDataBuffer. \r
+                                         returned in InquiryDataBuffer.\r

 \r
   @retval EFI_SUCCESS                    The command was executed successfully. See HostAdapterStatus,\r
                                          TargetStatus, SenseDataLength, and SenseData in that order\r
 \r
   @retval EFI_SUCCESS                    The command was executed successfully. See HostAdapterStatus,\r
                                          TargetStatus, SenseDataLength, and SenseData in that order\r


@@ -237,7 +237,7 @@ ScsiInquiryCommand (
                                          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
                                          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

-                                         On output, the number of bytes written to 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\r
                                          target specified by ScsiIo when the SCSI\r
   @param[out]     HostAdapterStatus      The status of the SCSI Host Controller that\r
                                          produces the SCSI bus containing the SCSI\r
                                          target specified by ScsiIo when the SCSI\r


@@ -249,12 +249,12 @@ ScsiInquiryCommand (
                                          executed on the SCSI Host Controller.\r
                                          See the EFI SCSI I/O Protocol in the UEFI\r
                                          Specification for details on the possible\r
                                          executed on the SCSI Host Controller.\r
                                          See the EFI SCSI I/O Protocol in the UEFI\r
                                          Specification for details on the possible\r

-                                         return values. \r
+                                         return values.\r

   @param[in, out] InquiryDataBuffer      A pointer to inquiry data that was generated\r
                                          by the execution of the SCSI Request Packet.\r
                                          This buffer must be allocated by the caller.\r
                                          If InquiryDataLength is 0, then this parameter\r
   @param[in, out] InquiryDataBuffer      A pointer to inquiry data that was generated\r
                                          by the execution of the SCSI Request Packet.\r
                                          This buffer must be allocated by the caller.\r
                                          If InquiryDataLength is 0, then this parameter\r

-                                         is optional and may be NULL. \r
+                                         is optional and may be NULL.\r

   @param[in, out] InquiryDataLength      On input, a pointer to the length in bytes\r
                                          of the InquiryDataBuffer buffer.\r
                                          On output, a pointer to the number of bytes\r
   @param[in, out] InquiryDataLength      On input, a pointer to the length in bytes\r
                                          of the InquiryDataBuffer buffer.\r
                                          On output, a pointer to the number of bytes\r


@@ -344,7 +344,7 @@ ScsiInquiryCommandEx (
                                      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
                                      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

-                                     On output, the number of bytes written to 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
                                      specified by ScsiIo when the SCSI Request Packet\r
   @param[out]     HostAdapterStatus  The status of the SCSI Host Controller that\r
                                      produces the SCSI bus containing the SCSI target\r
                                      specified by ScsiIo when the SCSI Request Packet\r


@@ -360,14 +360,14 @@ ScsiInquiryCommandEx (
                                      execution of the SCSI Request Packet.  This\r
                                      buffer must be allocated by the caller. If\r
                                      DataLength is 0, then this parameter is optional\r
                                      execution of the SCSI Request Packet.  This\r
                                      buffer must be allocated by the caller. If\r
                                      DataLength is 0, then this parameter is optional\r

-                                     and may be NULL. \r
+                                     and may be NULL.\r

   @param[in, out]  DataLength        On input, a pointer to the length in bytes of\r
                                      the DataBuffer buffer.  On output, a pointer\r
                                      to the number of bytes written to the DataBuffer\r
   @param[in, out]  DataLength        On input, a pointer to the length in bytes of\r
                                      the DataBuffer buffer.  On output, a pointer\r
                                      to the number of bytes written to the DataBuffer\r

-                                     buffer. \r
+                                     buffer.\r

   @param[in]      DBDField           Specifies the DBD field of the CDB for this SCSI Command.\r
   @param[in]      DBDField           Specifies the DBD field of the CDB for this SCSI Command.\r

-  @param[in]      PageControl        Specifies the PC field of the CDB for this SCSI Command. \r
-  @param[in]      PageCode           Specifies the Page Control field of the CDB for this SCSI Command. \r
+  @param[in]      PageControl        Specifies the PC field of the CDB for this SCSI Command.\r
+  @param[in]      PageCode           Specifies the Page Control field of the CDB for this SCSI Command.\r

 \r
   @retval EFI_SUCCESS                The command was executed successfully.\r
                                      See HostAdapterStatus, TargetStatus, SenseDataLength,\r
 \r
   @retval EFI_SUCCESS                The command was executed successfully.\r
                                      See HostAdapterStatus, TargetStatus, SenseDataLength,\r