IntelFrameworkPkg: Clean up source files

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / FrameworkFirmwareVolumeBlock.h

diff --git a/IntelFrameworkPkg/Include/Protocol/FrameworkFirmwareVolumeBlock.h b/IntelFrameworkPkg/Include/Protocol/FrameworkFirmwareVolumeBlock.h
index 3468ceb3889b8c3370e82b3025c565e37a47e749..cfdbc1c7dff521383d0e4a8e9ed067fb3308b54d 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/FrameworkFirmwareVolumeBlock.h
+++ b/IntelFrameworkPkg/Include/Protocol/FrameworkFirmwareVolumeBlock.h
@@ -1,16 +1,16 @@
 /** @file\r
   This file provides control over block-oriented firmware devices.\r
 \r
 /** @file\r
   This file provides control over block-oriented firmware devices.\r
 \r

-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution.  \r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r

 The full text of the license may be found at\r
 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
+http://opensource.org/licenses/bsd-license.php.\r

 \r
 \r

-  @par Revision Reference: \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
+  @par Revision Reference:\r

   This protocol is defined in framework spec: Firmware Volume Block Specification.\r
 \r
 **/\r
   This protocol is defined in framework spec: Firmware Volume Block Specification.\r
 \r
 **/\r


@@ -24,18 +24,18 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 typedef struct _FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL;\r
 ///\r
 /// The type of EFI FVB attribute per the Framework specification.\r
 typedef struct _FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL;\r
 ///\r
 /// The type of EFI FVB attribute per the Framework specification.\r

-/// \r
+///\r

 typedef UINT32  EFI_FVB_ATTRIBUTES;\r
 \r
 /**\r
   The GetAttributes() function retrieves the attributes and\r
 typedef UINT32  EFI_FVB_ATTRIBUTES;\r
 \r
 /**\r
   The GetAttributes() function retrieves the attributes and\r

-  current settings of the block. \r
+  current settings of the block.\r

 \r
   @param This       Indicates the FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.\r
 \r
   @param Attributes Pointer to EFI_FVB_ATTRIBUTES in which the\r
                     attributes and current settings are\r
 \r
   @param This       Indicates the FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.\r
 \r
   @param Attributes Pointer to EFI_FVB_ATTRIBUTES in which the\r
                     attributes and current settings are\r

-                    returned. \r
+                    returned.\r

 \r
   @retval EFI_SUCCESS The firmware volume attributes were\r
                       returned.\r
 \r
   @retval EFI_SUCCESS The firmware volume attributes were\r
                       returned.\r


@@ -59,8 +59,8 @@ EFI_STATUS
                       EFI_FVB_ATTRIBUTES that contains the\r
                       desired firmware volume settings. On\r
                       successful return, it contains the new\r
                       EFI_FVB_ATTRIBUTES that contains the\r
                       desired firmware volume settings. On\r
                       successful return, it contains the new\r

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

   @retval EFI_SUCCESS           The firmware volume attributes were returned.\r
 \r
   @retval EFI_INVALID_PARAMETER The attributes requested are in\r
   @retval EFI_SUCCESS           The firmware volume attributes were returned.\r
 \r
   @retval EFI_INVALID_PARAMETER The attributes requested are in\r


@@ -83,14 +83,14 @@ EFI_STATUS
   only for memory-mapped firmware volumes.\r
 \r
   @param This     Indicates the FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.\r
   only for memory-mapped firmware volumes.\r
 \r
   @param This     Indicates the FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.\r

-  \r
+\r

   @param Address  Pointer to a caller-allocated\r
                   EFI_PHYSICAL_ADDRESS that, on successful\r
                   return from GetPhysicalAddress(), contains the\r
                   base address of the firmware volume.\r
   @param Address  Pointer to a caller-allocated\r
                   EFI_PHYSICAL_ADDRESS that, on successful\r
                   return from GetPhysicalAddress(), contains the\r
                   base address of the firmware volume.\r

-  \r
+\r

   @retval EFI_SUCCESS       The firmware volume base address is returned.\r
   @retval EFI_SUCCESS       The firmware volume base address is returned.\r

-  \r
+\r

   @retval EFI_NOT_SUPPORTED The firmware volume is not memory mapped.\r
 \r
 **/\r
   @retval EFI_NOT_SUPPORTED The firmware volume is not memory mapped.\r
 \r
 **/\r


@@ -121,9 +121,9 @@ EFI_STATUS
                         blocks in this range have a size of\r
                         BlockSize.\r
 \r
                         blocks in this range have a size of\r
                         BlockSize.\r
 \r

-  \r
+\r

   @retval EFI_SUCCESS             The firmware volume base address was returned.\r
   @retval EFI_SUCCESS             The firmware volume base address was returned.\r

-  \r
+\r

   @retval EFI_INVALID_PARAMETER   The requested LBA is out of range.\r
 \r
 **/\r
   @retval EFI_INVALID_PARAMETER   The requested LBA is out of range.\r
 \r
 **/\r


@@ -154,7 +154,7 @@ EFI_STATUS
   aware that a read may be partially completed.\r
 \r
   @param This     Indicates the FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.\r
   aware that a read may be partially completed.\r
 \r
   @param This     Indicates the FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.\r

-  \r
+\r

   @param Lba      The starting logical block index\r
                   from which to read.\r
 \r
   @param Lba      The starting logical block index\r
                   from which to read.\r
 \r


@@ -170,15 +170,15 @@ EFI_STATUS
 \r
   @retval EFI_SUCCESS         The firmware volume was read successfully\r
                               and contents are in Buffer.\r
 \r
   @retval EFI_SUCCESS         The firmware volume was read successfully\r
                               and contents are in Buffer.\r

-  \r
+\r

   @retval EFI_BAD_BUFFER_SIZE A read was attempted across an LBA\r
                               boundary. On output, NumBytes\r
                               contains the total number of bytes\r
                               returned in Buffer.\r
   @retval EFI_BAD_BUFFER_SIZE A read was attempted across an LBA\r
                               boundary. On output, NumBytes\r
                               contains the total number of bytes\r
                               returned in Buffer.\r

-  \r
+\r

   @retval EFI_ACCESS_DENIED   The firmware volume is in the\r
                               ReadDisabled state.\r
   @retval EFI_ACCESS_DENIED   The firmware volume is in the\r
                               ReadDisabled state.\r

-  \r
+\r

   @retval EFI_DEVICE_ERROR    The block device is not\r
                               functioning correctly and could\r
                               not be read.\r
   @retval EFI_DEVICE_ERROR    The block device is not\r
                               functioning correctly and could\r
                               not be read.\r


@@ -210,7 +210,7 @@ EFI_STATUS
   EraseBlocks() function first to erase the specified block to\r
   write. A block erase cycle will transition bits from the\r
   (NOT)EFI_FVB_ERASE_POLARITY state back to the\r
   EraseBlocks() function first to erase the specified block to\r
   write. A block erase cycle will transition bits from the\r
   (NOT)EFI_FVB_ERASE_POLARITY state back to the\r

-  EFI_FVB_ERASE_POLARITY state. Implementors should note \r
+  EFI_FVB_ERASE_POLARITY state. Implementors should note\r

   that the firmware volume might be in the WriteDisabled\r
   state. If it is in this state, the Write() function must\r
   return the status code EFI_ACCESS_DENIED without modifying the\r
   that the firmware volume might be in the WriteDisabled\r
   state. If it is in this state, the Write() function must\r
   return the status code EFI_ACCESS_DENIED without modifying the\r


@@ -225,27 +225,27 @@ EFI_STATUS
   returns.\r
 \r
   @param This     Indicates the FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.\r
   returns.\r
 \r
   @param This     Indicates the FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.\r

-  \r
+\r

   @param Lba      The starting logical block index to write to.\r
   @param Lba      The starting logical block index to write to.\r

-  \r
+\r

   @param Offset   Offset into the block at which to begin writing.\r
   @param Offset   Offset into the block at which to begin writing.\r

-  \r
+\r

   @param NumBytes The pointer to a UINTN. Input: the total size of the buffer.\r
                   Output: the total number of bytes actually written.\r
   @param NumBytes The pointer to a UINTN. Input: the total size of the buffer.\r
                   Output: the total number of bytes actually written.\r

-  \r
+\r

   @param Buffer   The pointer to a caller-allocated buffer that\r
                   contains the source for the write.\r
   @param Buffer   The pointer to a caller-allocated buffer that\r
                   contains the source for the write.\r

-  \r
+\r

   @retval EFI_SUCCESS         The firmware volume was written successfully.\r
   @retval EFI_SUCCESS         The firmware volume was written successfully.\r

-  \r
+\r

   @retval EFI_BAD_BUFFER_SIZE The write was attempted across an\r
                               LBA boundary. On output, NumBytes\r
                               contains the total number of bytes\r
                               actually written.\r
   @retval EFI_BAD_BUFFER_SIZE The write was attempted across an\r
                               LBA boundary. On output, NumBytes\r
                               contains the total number of bytes\r
                               actually written.\r

-  \r
+\r

   @retval EFI_ACCESS_DENIED   The firmware volume is in the\r
                               WriteDisabled state.\r
   @retval EFI_ACCESS_DENIED   The firmware volume is in the\r
                               WriteDisabled state.\r

-  \r
+\r

   @retval EFI_DEVICE_ERROR    The block device is malfunctioning\r
                               and could not be written.\r
 \r
   @retval EFI_DEVICE_ERROR    The block device is malfunctioning\r
                               and could not be written.\r
 \r


@@ -306,7 +306,7 @@ EFI_STATUS
 \r
   @retval EFI_SUCCESS The erase request successfully\r
                       completed.\r
 \r
   @retval EFI_SUCCESS The erase request successfully\r
                       completed.\r

-  \r
+\r

   @retval EFI_ACCESS_DENIED   The firmware volume is in the\r
                               WriteDisabled state.\r
   @retval EFI_DEVICE_ERROR  The block device is not functioning\r
   @retval EFI_ACCESS_DENIED   The firmware volume is in the\r
                               WriteDisabled state.\r
   @retval EFI_DEVICE_ERROR  The block device is not functioning\r


@@ -315,7 +315,7 @@ EFI_STATUS
                             partially erased.\r
   @retval EFI_INVALID_PARAMETER One or more of the LBAs listed\r
                                 in the variable argument list do\r
                             partially erased.\r
   @retval EFI_INVALID_PARAMETER One or more of the LBAs listed\r
                                 in the variable argument list do\r

-                                not exist in the firmware volume.  \r
+                                not exist in the firmware volume.\r

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


@@ -344,7 +344,7 @@ struct _FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL {
   FRAMEWORK_EFI_FVB_ERASE_BLOCKS          EraseBlocks;\r
   ///\r
   /// The handle of the parent firmware volume.\r
   FRAMEWORK_EFI_FVB_ERASE_BLOCKS          EraseBlocks;\r
   ///\r
   /// The handle of the parent firmware volume.\r

-  ///  \r
+  ///\r

   EFI_HANDLE                    ParentHandle;\r
 };\r
 \r
   EFI_HANDLE                    ParentHandle;\r
 };\r
 \r