Grammatical and disclaimer changes (does not follow internal C coding stds.)

[mirror_edk2.git] / MdePkg / Include / Protocol / FirmwareVolumeBlock.h

diff --git a/MdePkg/Include/Protocol/FirmwareVolumeBlock.h b/MdePkg/Include/Protocol/FirmwareVolumeBlock.h
index 5045007599fd19ee650861689fdb27277d8ee90f..94fdddacc9361719563709555e6968ea0e1c120b 100644 (file)
--- a/MdePkg/Include/Protocol/FirmwareVolumeBlock.h
+++ b/MdePkg/Include/Protocol/FirmwareVolumeBlock.h
@@ -1,14 +1,14 @@
 /** @file\r
   This file provides control over block-oriented firmware devices.\r
 \r
-  Copyright (c) 2006 - 2009, Intel Corporation                                                         \r
-  All rights reserved. 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
+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
+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
   @par Revision Reference: PI\r
   Version 1.0 and 1.2.\r
@@ -98,7 +98,7 @@ EFI_STATUS
                   return from GetPhysicalAddress(), contains the\r
                   base address of the firmware volume.\r
   \r
-  @retval EFI_SUCCESS       The firmware volume base address is returned.\r
+  @retval EFI_SUCCESS       The firmware volume base address was returned.\r
   \r
   @retval EFI_NOT_SUPPORTED The firmware volume is not memory mapped.\r
 \r
@@ -131,7 +131,7 @@ EFI_STATUS
                         BlockSize.\r
 \r
   \r
-  @retval EFI_SUCCESS             The firmware volume base address is returned.\r
+  @retval EFI_SUCCESS             The firmware volume base address was returned.\r
   \r
   @retval EFI_INVALID_PARAMETER   The requested LBA is out of range.\r
 \r
@@ -177,7 +177,7 @@ EFI_STATUS
   @param Buffer   Pointer to a caller-allocated buffer that will\r
                   be used to hold the data that is read.\r
 \r
-  @retval EFI_SUCCESS         The firmware volume was read successfully\r
+  @retval EFI_SUCCESS         The firmware volume was read successfully,\r
                               and contents are in Buffer.\r
   \r
   @retval EFI_BAD_BUFFER_SIZE Read attempted across an LBA\r
@@ -214,9 +214,9 @@ EFI_STATUS
   function, or else the result will be unpredictable. This\r
   unpredictability arises because, for a sticky-write firmware\r
   volume, a write may negate a bit in the EFI_FVB_ERASE_POLARITY\r
-  state but cannot flip it back again. In general, before\r
-  calling the Write() function, the caller should call the\r
-  EraseBlocks() function first to erase the specified block to\r
+  state but cannot flip it back again.  Before calling the\r
+  Write() function,  it is recommended for the caller to first call \r
+  the EraseBlocks() function 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. Implementations should be\r
@@ -239,12 +239,12 @@ EFI_STATUS
   \r
   @param Offset   Offset into the block at which to begin writing.\r
   \r
-  @param NumBytes Pointer to a UINTN. At entry, *NumBytes\r
+  @param NumBytes The pointer to a UINTN. At entry, *NumBytes\r
                   contains the total size of the buffer. At\r
                   exit, *NumBytes contains the total number of\r
                   bytes actually written.\r
   \r
-  @param Buffer   Pointer to a caller-allocated buffer that\r
+  @param Buffer   The pointer to a caller-allocated buffer that\r
                   contains the source for the write.\r
   \r
   @retval EFI_SUCCESS         The firmware volume was written successfully.\r
@@ -307,7 +307,7 @@ EFI_STATUS
                 and consists of the following:\r
                 - An EFI_LBA that indicates the starting LBA\r
                 - A UINTN that indicates the number of blocks to\r
-                  erase\r
+                  erase.\r
 \r
                 The list is terminated with an\r
                 EFI_LBA_LIST_TERMINATOR. For example, the\r
@@ -315,7 +315,7 @@ EFI_STATUS
                 (5-7 and 10-11) are to be erased: EraseBlocks\r
                 (This, 5, 3, 10, 2, EFI_LBA_LIST_TERMINATOR);\r
 \r
-  @retval EFI_SUCCESS The erase request was successfully\r
+  @retval EFI_SUCCESS The erase request successfully\r
                       completed.\r
   \r
   @retval EFI_ACCESS_DENIED   The firmware volume is in the\r
@@ -354,7 +354,7 @@ struct _EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL{
   EFI_FVB_WRITE                 Write;\r
   EFI_FVB_ERASE_BLOCKS          EraseBlocks;\r
   ///\r
-  /// Handle of the parent firmware volume.\r
+  /// The handle of the parent firmware volume.\r
   ///  \r
   EFI_HANDLE                    ParentHandle;\r
 };\r