EmulatorPkg: Remove all trailing whitespace

[mirror_edk2.git] / EmulatorPkg / FvbServicesRuntimeDxe / FWBlockService.c

diff --git a/EmulatorPkg/FvbServicesRuntimeDxe/FWBlockService.c b/EmulatorPkg/FvbServicesRuntimeDxe/FWBlockService.c
index a95b180adb068a5c96f6d8ead0ac85595b4d6553..9513d05bed594774c9c89948efc5999e6b19460e 100644 (file)
--- a/EmulatorPkg/FvbServicesRuntimeDxe/FWBlockService.c
+++ b/EmulatorPkg/FvbServicesRuntimeDxe/FWBlockService.c
@@ -2,13 +2,13 @@
 \r
 Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>\r
 Portions copyright (c) 2011, Apple Inc. All rights reserved.\r
 \r
 Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>\r
 Portions copyright (c) 2011, Apple Inc. All rights reserved.\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
-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
+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
+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


@@ -90,14 +90,14 @@ Routine Description:
   date items to there virtual address.\r
 \r
   mFvbModuleGlobal->FvInstance[FVB_PHYSICAL]  - Physical copy of instance data\r
   date items to there virtual address.\r
 \r
   mFvbModuleGlobal->FvInstance[FVB_PHYSICAL]  - Physical copy of instance data\r

-  mFvbModuleGlobal->FvInstance[FVB_VIRTUAL]   - Virtual pointer to common \r
+  mFvbModuleGlobal->FvInstance[FVB_VIRTUAL]   - Virtual pointer to common\r

                                                 instance data.\r
 \r
 Arguments:\r
 \r
   (Standard EFI notify event - EFI_EVENT_NOTIFY)\r
 \r
                                                 instance data.\r
 \r
 Arguments:\r
 \r
   (Standard EFI notify event - EFI_EVENT_NOTIFY)\r
 \r

-Returns: \r
+Returns:\r

 \r
   None\r
 \r
 \r
   None\r
 \r


@@ -146,7 +146,7 @@ Arguments:
   FwhInstance           - The EFI_FW_VOL_INSTANCE fimrware instance structure\r
   Virtual               - Whether CPU is in virtual or physical mode\r
 \r
   FwhInstance           - The EFI_FW_VOL_INSTANCE fimrware instance structure\r
   Virtual               - Whether CPU is in virtual or physical mode\r
 \r

-Returns: \r
+Returns:\r

   EFI_SUCCESS           - Successfully returns\r
   EFI_INVALID_PARAMETER - Instance not found\r
 \r
   EFI_SUCCESS           - Successfully returns\r
   EFI_INVALID_PARAMETER - Instance not found\r
 \r


@@ -190,14 +190,14 @@ Routine Description:
 Arguments:\r
   Instance              - The FV instance whose base address is going to be\r
                           returned\r
 Arguments:\r
   Instance              - The FV instance whose base address is going to be\r
                           returned\r

-  Address               - Pointer to a caller allocated EFI_PHYSICAL_ADDRESS \r
+  Address               - Pointer to a caller allocated EFI_PHYSICAL_ADDRESS\r

                           that on successful return, contains the base address\r
                           that on successful return, contains the base address\r

-                          of the firmware volume. \r
+                          of the firmware volume.\r

   Global                - Pointer to ESAL_FWB_GLOBAL that contains all\r
                           instance data\r
   Virtual               - Whether CPU is in virtual or physical mode\r
 \r
   Global                - Pointer to ESAL_FWB_GLOBAL that contains all\r
                           instance data\r
   Virtual               - Whether CPU is in virtual or physical mode\r
 \r

-Returns: \r
+Returns:\r

   EFI_SUCCESS           - Successfully returns\r
   EFI_INVALID_PARAMETER - Instance not found\r
 \r
   EFI_SUCCESS           - Successfully returns\r
   EFI_INVALID_PARAMETER - Instance not found\r
 \r


@@ -230,14 +230,14 @@ Routine Description:
   resulting attributes in output parameter\r
 \r
 Arguments:\r
   resulting attributes in output parameter\r
 \r
 Arguments:\r

-  Instance              - The FV instance whose attributes is going to be \r
+  Instance              - The FV instance whose attributes is going to be\r

                           returned\r
   Attributes            - Output buffer which contains attributes\r
   Global                - Pointer to ESAL_FWB_GLOBAL that contains all\r
                           instance data\r
   Virtual               - Whether CPU is in virtual or physical mode\r
 \r
                           returned\r
   Attributes            - Output buffer which contains attributes\r
   Global                - Pointer to ESAL_FWB_GLOBAL that contains all\r
                           instance data\r
   Virtual               - Whether CPU is in virtual or physical mode\r
 \r

-Returns: \r
+Returns:\r

   EFI_SUCCESS           - Successfully returns\r
   EFI_INVALID_PARAMETER - Instance not found\r
 \r
   EFI_SUCCESS           - Successfully returns\r
   EFI_INVALID_PARAMETER - Instance not found\r
 \r


@@ -274,7 +274,7 @@ Routine Description:
 Arguments:\r
   Instance              - The FV instance which the Lba belongs to\r
   Lba                   - The logical block address\r
 Arguments:\r
   Instance              - The FV instance which the Lba belongs to\r
   Lba                   - The logical block address\r

-  LbaAddress            - On output, contains the physical starting address \r
+  LbaAddress            - On output, contains the physical starting address\r

                           of the Lba\r
   LbaLength             - On output, contains the length of the block\r
   NumOfBlocks           - A pointer to a caller allocated UINTN in which the\r
                           of the Lba\r
   LbaLength             - On output, contains the length of the block\r
   NumOfBlocks           - A pointer to a caller allocated UINTN in which the\r


@@ -285,7 +285,7 @@ Arguments:
                           instance data\r
   Virtual               - Whether CPU is in virtual or physical mode\r
 \r
                           instance data\r
   Virtual               - Whether CPU is in virtual or physical mode\r
 \r

-Returns: \r
+Returns:\r

   EFI_SUCCESS           - Successfully returns\r
   EFI_INVALID_PARAMETER - Instance not found\r
 \r
   EFI_SUCCESS           - Successfully returns\r
   EFI_INVALID_PARAMETER - Instance not found\r
 \r


@@ -377,14 +377,14 @@ Arguments:
                           instance data\r
   Virtual               - Whether CPU is in virtual or physical mode\r
 \r
                           instance data\r
   Virtual               - Whether CPU is in virtual or physical mode\r
 \r

-Returns: \r
-  EFI_SUCCESS           - The firmware volume was read successfully and \r
+Returns:\r
+  EFI_SUCCESS           - The firmware volume was read successfully and\r

                           contents are in Buffer\r
   EFI_BAD_BUFFER_SIZE   - Read attempted across a LBA boundary. On output,\r
                           NumBytes contains the total number of bytes returned\r
                           in Buffer\r
   EFI_ACCESS_DENIED     - The firmware volume is in the ReadDisabled state\r
                           contents are in Buffer\r
   EFI_BAD_BUFFER_SIZE   - Read attempted across a LBA boundary. On output,\r
                           NumBytes contains the total number of bytes returned\r
                           in Buffer\r
   EFI_ACCESS_DENIED     - The firmware volume is in the ReadDisabled state\r

-  EFI_DEVICE_ERROR      - The block device is not functioning correctly and \r
+  EFI_DEVICE_ERROR      - The block device is not functioning correctly and\r

                           could not be read\r
   EFI_INVALID_PARAMETER - Instance not found, or NumBytes, Buffer are NULL\r
 \r
                           could not be read\r
   EFI_INVALID_PARAMETER - Instance not found, or NumBytes, Buffer are NULL\r
 \r


@@ -463,13 +463,13 @@ Arguments:
                           instance data\r
   Virtual               - Whether CPU is in virtual or physical mode\r
 \r
                           instance data\r
   Virtual               - Whether CPU is in virtual or physical mode\r
 \r

-Returns: \r
+Returns:\r

   EFI_SUCCESS           - The firmware volume was written successfully\r
   EFI_BAD_BUFFER_SIZE   - Write attempted across a LBA boundary. On output,\r
                           NumBytes contains the total number of bytes\r
                           actually written\r
   EFI_ACCESS_DENIED     - The firmware volume is in the WriteDisabled state\r
   EFI_SUCCESS           - The firmware volume was written successfully\r
   EFI_BAD_BUFFER_SIZE   - Write attempted across a LBA boundary. On output,\r
                           NumBytes contains the total number of bytes\r
                           actually written\r
   EFI_ACCESS_DENIED     - The firmware volume is in the WriteDisabled state\r

-  EFI_DEVICE_ERROR      - The block device is not functioning correctly and \r
+  EFI_DEVICE_ERROR      - The block device is not functioning correctly and\r

                           could not be written\r
   EFI_INVALID_PARAMETER - Instance not found, or NumBytes, Buffer are NULL\r
 \r
                           could not be written\r
   EFI_INVALID_PARAMETER - Instance not found, or NumBytes, Buffer are NULL\r
 \r


@@ -541,10 +541,10 @@ Arguments:
                           instance data\r
   Virtual               - Whether CPU is in virtual or physical mode\r
 \r
                           instance data\r
   Virtual               - Whether CPU is in virtual or physical mode\r
 \r

-Returns: \r
+Returns:\r

   EFI_SUCCESS           - The erase request was successfully completed\r
   EFI_ACCESS_DENIED     - The firmware volume is in the WriteDisabled state\r
   EFI_SUCCESS           - The erase request was successfully completed\r
   EFI_ACCESS_DENIED     - The firmware volume is in the WriteDisabled state\r

-  EFI_DEVICE_ERROR      - The block device is not functioning correctly and \r
+  EFI_DEVICE_ERROR      - The block device is not functioning correctly and\r

                           could not be written. Firmware device may have been\r
                           partially erased\r
   EFI_INVALID_PARAMETER - Instance not found\r
                           could not be written. Firmware device may have been\r
                           partially erased\r
   EFI_INVALID_PARAMETER - Instance not found\r


@@ -596,13 +596,13 @@ FvbSetVolumeAttributes (
 /*++\r
 \r
 Routine Description:\r
 /*++\r
 \r
 Routine Description:\r

-  Modifies the current settings of the firmware volume according to the \r
+  Modifies the current settings of the firmware volume according to the\r

   input parameter, and returns the new setting of the volume\r
 \r
 Arguments:\r
   input parameter, and returns the new setting of the volume\r
 \r
 Arguments:\r

-  Instance              - The FV instance whose attributes is going to be \r
+  Instance              - The FV instance whose attributes is going to be\r

                           modified\r
                           modified\r

-  Attributes            - On input, it is a pointer to EFI_FVB_ATTRIBUTES_2 \r
+  Attributes            - On input, it is a pointer to EFI_FVB_ATTRIBUTES_2\r

                           containing the desired firmware volume settings.\r
                           On successful return, it contains the new settings\r
                           of the firmware volume\r
                           containing the desired firmware volume settings.\r
                           On successful return, it contains the new settings\r
                           of the firmware volume\r


@@ -610,7 +610,7 @@ Arguments:
                           instance data\r
   Virtual               - Whether CPU is in virtual or physical mode\r
 \r
                           instance data\r
   Virtual               - Whether CPU is in virtual or physical mode\r
 \r

-Returns: \r
+Returns:\r

   EFI_SUCCESS           - Successfully returns\r
   EFI_ACCESS_DENIED     - The volume setting is locked and cannot be modified\r
   EFI_INVALID_PARAMETER - Instance not found, or The attributes requested are\r
   EFI_SUCCESS           - Successfully returns\r
   EFI_ACCESS_DENIED     - The volume setting is locked and cannot be modified\r
   EFI_INVALID_PARAMETER - Instance not found, or The attributes requested are\r


@@ -742,7 +742,7 @@ Arguments:
 \r
 Returns:\r
 \r
 \r
 Returns:\r
 \r

-Returns: \r
+Returns:\r

   EFI_SUCCESS           - Successfully returns\r
 \r
 **/\r
   EFI_SUCCESS           - Successfully returns\r
 \r
 **/\r


@@ -777,8 +777,8 @@ Arguments:
                           returned. All blocks in this range have a size of\r
                           BlockSize\r
 \r
                           returned. All blocks in this range have a size of\r
                           BlockSize\r
 \r

-Returns: \r
-  EFI_SUCCESS           - The firmware volume was read successfully and \r
+Returns:\r
+  EFI_SUCCESS           - The firmware volume was read successfully and\r

                           contents are in Buffer\r
 \r
 **/\r
                           contents are in Buffer\r
 \r
 **/\r


@@ -813,7 +813,7 @@ Arguments:
     This                - Calling context\r
     Attributes          - output buffer which contains attributes\r
 \r
     This                - Calling context\r
     Attributes          - output buffer which contains attributes\r
 \r

-Returns: \r
+Returns:\r

   EFI_SUCCESS           - Successfully returns\r
 \r
 **/\r
   EFI_SUCCESS           - Successfully returns\r
 \r
 **/\r


@@ -840,7 +840,7 @@ Arguments:
   This                  - Calling context\r
   Attributes            - output buffer which contains attributes\r
 \r
   This                  - Calling context\r
   Attributes            - output buffer which contains attributes\r
 \r

-Returns: \r
+Returns:\r

   EFI_SUCCESS           - Successfully returns\r
 \r
 **/\r
   EFI_SUCCESS           - Successfully returns\r
 \r
 **/\r


@@ -856,28 +856,28 @@ EFI_STATUS
 EFIAPI\r
 FvbProtocolEraseBlocks (\r
   IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL    *This,\r
 EFIAPI\r
 FvbProtocolEraseBlocks (\r
   IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL    *This,\r

-  ...  \r
+  ...\r

   )\r
 /*++\r
 \r
 Routine Description:\r
 \r
   )\r
 /*++\r
 \r
 Routine Description:\r
 \r

-  The EraseBlock() function erases one or more blocks as denoted by the \r
+  The EraseBlock() function erases one or more blocks as denoted by the\r

   variable argument list. The entire parameter list of blocks must be verified\r
   variable argument list. The entire parameter list of blocks must be verified\r

-  prior to erasing any blocks.  If a block is requested that does not exist \r
-  within the associated firmware volume (it has a larger index than the last \r
+  prior to erasing any blocks.  If a block is requested that does not exist\r
+  within the associated firmware volume (it has a larger index than the last\r

   block of the firmware volume), the EraseBlock() function must return\r
   EFI_INVALID_PARAMETER without modifying the contents of the firmware volume.\r
 \r
 Arguments:\r
   This                  - Calling context\r
   block of the firmware volume), the EraseBlock() function must return\r
   EFI_INVALID_PARAMETER without modifying the contents of the firmware volume.\r
 \r
 Arguments:\r
   This                  - Calling context\r

-  ...                   - Starting LBA followed by Number of Lba to erase. \r
+  ...                   - Starting LBA followed by Number of Lba to erase.\r

                           a -1 to terminate the list.\r
 \r
                           a -1 to terminate the list.\r
 \r

-Returns: \r
+Returns:\r

   EFI_SUCCESS           - The erase request was successfully completed\r
   EFI_ACCESS_DENIED     - The firmware volume is in the WriteDisabled state\r
   EFI_SUCCESS           - The erase request was successfully completed\r
   EFI_ACCESS_DENIED     - The firmware volume is in the WriteDisabled state\r

-  EFI_DEVICE_ERROR      - The block device is not functioning correctly and \r
+  EFI_DEVICE_ERROR      - The block device is not functioning correctly and\r

                           could not be written. Firmware device may have been\r
                           partially erased\r
 \r
                           could not be written. Firmware device may have been\r
                           partially erased\r
 \r


@@ -978,13 +978,13 @@ Arguments:
                           output, indicates the actual number of bytes written\r
   Buffer                - Buffer containing source data for the write.\r
 \r
                           output, indicates the actual number of bytes written\r
   Buffer                - Buffer containing source data for the write.\r
 \r

-Returns: \r
+Returns:\r

   EFI_SUCCESS           - The firmware volume was written successfully\r
   EFI_BAD_BUFFER_SIZE   - Write attempted across a LBA boundary. On output,\r
                           NumBytes contains the total number of bytes\r
                           actually written\r
   EFI_ACCESS_DENIED     - The firmware volume is in the WriteDisabled state\r
   EFI_SUCCESS           - The firmware volume was written successfully\r
   EFI_BAD_BUFFER_SIZE   - Write attempted across a LBA boundary. On output,\r
                           NumBytes contains the total number of bytes\r
                           actually written\r
   EFI_ACCESS_DENIED     - The firmware volume is in the WriteDisabled state\r

-  EFI_DEVICE_ERROR      - The block device is not functioning correctly and \r
+  EFI_DEVICE_ERROR      - The block device is not functioning correctly and\r

                           could not be written\r
   EFI_INVALID_PARAMETER - NumBytes or Buffer are NULL\r
 \r
                           could not be written\r
   EFI_INVALID_PARAMETER - NumBytes or Buffer are NULL\r
 \r


@@ -1026,14 +1026,14 @@ Arguments:
                           output, indicates the actual number of bytes Read\r
   Buffer                - Buffer containing source data for the Read.\r
 \r
                           output, indicates the actual number of bytes Read\r
   Buffer                - Buffer containing source data for the Read.\r
 \r

-Returns: \r
-  EFI_SUCCESS           - The firmware volume was read successfully and \r
+Returns:\r
+  EFI_SUCCESS           - The firmware volume was read successfully and\r

                           contents are in Buffer\r
   EFI_BAD_BUFFER_SIZE   - Read attempted across a LBA boundary. On output,\r
                           NumBytes contains the total number of bytes returned\r
                           in Buffer\r
   EFI_ACCESS_DENIED     - The firmware volume is in the ReadDisabled state\r
                           contents are in Buffer\r
   EFI_BAD_BUFFER_SIZE   - Read attempted across a LBA boundary. On output,\r
                           NumBytes contains the total number of bytes returned\r
                           in Buffer\r
   EFI_ACCESS_DENIED     - The firmware volume is in the ReadDisabled state\r

-  EFI_DEVICE_ERROR      - The block device is not functioning correctly and \r
+  EFI_DEVICE_ERROR      - The block device is not functioning correctly and\r

                           could not be read\r
   EFI_INVALID_PARAMETER - NumBytes or Buffer are NULL\r
 \r
                           could not be read\r
   EFI_INVALID_PARAMETER - NumBytes or Buffer are NULL\r
 \r


@@ -1058,7 +1058,7 @@ Routine Description:
 Arguments:\r
   FwVolHeader           - A pointer to a firmware volume header\r
 \r
 Arguments:\r
   FwVolHeader           - A pointer to a firmware volume header\r
 \r

-Returns: \r
+Returns:\r

   EFI_SUCCESS           - The firmware volume is consistent\r
   EFI_NOT_FOUND         - The firmware volume has corrupted. So it is not an FV\r
 \r
   EFI_SUCCESS           - The firmware volume is consistent\r
   EFI_NOT_FOUND         - The firmware volume has corrupted. So it is not an FV\r
 \r