MdeModulePkg/SmmEndOfS3Resume.h: Add new protocol definition.

[mirror_edk2.git] / MdeModulePkg / Include / Protocol / SwapAddressRange.h

diff --git a/MdeModulePkg/Include/Protocol/SwapAddressRange.h b/MdeModulePkg/Include/Protocol/SwapAddressRange.h
index 7e536c58736d537eb5b386f09297cba675198ecb..3ca87a0e6e55efedb877f7c5adf39fafb3663570 100644 (file)
--- a/MdeModulePkg/Include/Protocol/SwapAddressRange.h
+++ b/MdeModulePkg/Include/Protocol/SwapAddressRange.h
@@ -1,16 +1,16 @@
 /** @file\r
 The EFI_SWAP_ADDRESS_RANGE_PROTOCOL is used to abstract the swap operation of boot block \r
-and backup block of FV. This swap is especially needed when updating the boot block of FV. If any \r
+and backup block of FV. This swap is especially needed when updating the boot block of FV. If a \r
 power failure happens during the boot block update, the swapped backup block (now the boot block) \r
 can boot the machine with the old boot block backed up in it. The swap operation is platform dependent, so \r
 other protocols such as FTW (Fault Tolerant Write) should use this protocol instead of handling hardware directly.\r
 \r
-Copyright (c) 2009 - 2010, 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
+Copyright (c) 2009 - 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
@@ -44,10 +44,10 @@ typedef UINT8 EFI_SWAP_LOCK_CAPABILITY;
   boot block and backup block. \r
 \r
   @param This             Indicates the calling context.  \r
-  @param BootBlockBase    Base address of current boot block.\r
-  @param BootBlockSize    Size (in bytes) of current boot block.\r
-  @param BackupBlockBase  Base address of current backup block.\r
-  @param BackupBlockSize  Size (in bytes) of current backup block.\r
+  @param BootBlockBase    The base address of current boot block.\r
+  @param BootBlockSize    The size (in bytes) of current boot block.\r
+  @param BackupBlockBase  The base address of current backup block.\r
+  @param BackupBlockSize  The size (in bytes) of current backup block.\r
 \r
   @retval EFI_SUCCESS  The call was successful.\r
     \r
@@ -89,7 +89,7 @@ EFI_STATUS
   @param NewSwapState    True to swap real boot block and backup block, False to swap them back.\r
 \r
   @retval EFI_SUCCESS  The call was successful.\r
-  @retval EFI_ABORTED  Set swap state error\r
+  @retval EFI_ABORTED  Set swap state error.\r
     \r
 **/\r
 typedef\r
@@ -121,11 +121,12 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  This service returns all lock methods for swap operations that the current platform supports. Could be software lock, hardware lock, or unsupport lock.\r
+  This service returns all lock methods for swap operations that the current platform \r
+  supports. Could be software lock, hardware lock, or unsupport lock.\r
   Note that software and hardware lock methods can be used simultaneously.\r
 \r
   @param This             Indicates the calling context.\r
-  @param LockCapability   Current lock method for swap operation. \r
+  @param LockCapability   The current lock method for swap operations. \r
 \r
   @retval EFI_SUCCESS The call was successful.\r
     \r
@@ -140,13 +141,13 @@ EFI_STATUS
 \r
 \r
 /**\r
-  This service is used to acquire or release appointed kind of lock for Swap Address Range operation.\r
+  This service is used to acquire or release appointed kind of lock for Swap Address Range operations.\r
 \r
   Note that software and hardware lock mothod can be used simultaneously.\r
 \r
   @param This              Indicates the calling context.\r
   @param LockCapability    Indicates which lock to acquire or release.\r
-  @param NewLockState      True to acquire lock, False to release lock.\r
+  @param NewLockState      True to acquire lock; False to release lock.\r
 \r
   @retval EFI_SUCCESS The call was successful.\r
     \r