/** @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
-power failure happens during updating boot block, the swapped backup block (now is the boot block) \r
-can boot the machine with old boot block backuped 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 hardward directly.\r
-\r
-Copyright (c) 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
+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 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 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
//\r
// Forward reference for pure ANSI compatability\r
//\r
-typedef struct _EFI_SWAP_ADDRESS_RANGE_PROTOCOL EFI_SWAP_ADDRESS_RANGE_PROTOCOL;\r
+typedef struct _EFI_SWAP_ADDRESS_RANGE_PROTOCOL EFI_SWAP_ADDRESS_RANGE_PROTOCOL;\r
\r
#define EFI_UNSUPPORT_LOCK 0\r
#define EFI_SOFTWARE_LOCK 1\r
typedef UINT8 EFI_SWAP_LOCK_CAPABILITY;\r
\r
//\r
-// Protocl APIs\r
+// Protocol APIs\r
//\r
\r
/**\r
- This service gets the address range location of boot block and backup block.\r
- The EFI_GET_RANGE_LOCATION service allows caller to get the range location of \r
- 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
-\r
- @retval EFI_SUCCESS The call was successful.\r
- \r
+ This function gets the address range location of\r
+ boot block and backup block.\r
+\r
+ @param This Indicates the calling context.\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
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_GET_RANGE_LOCATION) (\r
- IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL * This,\r
- OUT EFI_PHYSICAL_ADDRESS * BootBlockBase,\r
+(EFIAPI *EFI_GET_RANGE_LOCATION)(\r
+ IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This,\r
+ OUT EFI_PHYSICAL_ADDRESS *BootBlockBase,\r
OUT UINTN *BootBlockSize,\r
- OUT EFI_PHYSICAL_ADDRESS * BackupBlockBase,\r
+ OUT EFI_PHYSICAL_ADDRESS *BackupBlockBase,\r
OUT UINTN *BackupBlockSize\r
);\r
\r
/**\r
This service checks if the boot block and backup block has been swapped.\r
\r
- The EFI_GET_SWAP_STATE service allows caller to get current swap state of boot block and backup block.\r
+ @param This Indicates the calling context.\r
+ @param SwapState True if the boot block and backup block has been swapped.\r
+ False if the boot block and backup block has not been swapped.\r
\r
- @param This Indicates the calling context. \r
- @param SwapState True if the boot block and backup block has been swapped. \r
- False if the boot block and backup block has not been swapped.\r
+ @retval EFI_SUCCESS The call was successful.\r
\r
- @retval EFI_SUCCESS The call was successful.\r
- \r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_GET_SWAP_STATE) (\r
- IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL * This,\r
+(EFIAPI *EFI_GET_SWAP_STATE)(\r
+ IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This,\r
OUT BOOLEAN *SwapState\r
);\r
\r
/**\r
This service swaps the boot block and backup block, or swaps them back.\r
\r
- The EFI_SET_SWAP_STATE service allows caller to set the swap state of boot block and backup block. \r
- It also acquires and releases software swap lock during operation. Note the setting of new swap state \r
+ It also acquires and releases software swap lock during operation. The setting of the new swap state\r
is not affected by the old swap state.\r
\r
- @param This Indicates the calling context. \r
- @param NewSwapState True to swap real boot block and backup block , False to swap them back..\r
+ @param This Indicates the calling context.\r
+ @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
\r
- @retval EFI_SUCCESS The call was successful.\r
- @retval EFI_ABORTED Set swap state error\r
- \r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SET_SWAP_STATE) (\r
- IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL * This,\r
+(EFIAPI *EFI_SET_SWAP_STATE)(\r
+ IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This,\r
IN BOOLEAN NewSwapState\r
);\r
\r
-\r
-\r
/**\r
- This service checks if a RTC (Real Time Clock) power failure happened.\r
+ This service checks if a Real Time Clock (RTC) power failure happened.\r
\r
- The EFI_GET_RTC_POWER_STATUS service allows caller to get Real Time Clock power failure status. \r
- If parameter RtcPowerFailed is true after function returns, the trickle current (from the main battery or trickle supply) \r
- has been removed or failed, this means the swap status was lost in some platform (such as IA32). \r
- So it is recommended to check RTC power status before calling GetSwapState().\r
+ If parameter RtcPowerFailed is true after the function returns, RTC power supply failed or was removed.\r
+ It is recommended to check RTC power status before calling GetSwapState().\r
\r
- @param This Indicates the calling context. \r
- @param RtcPowerFailed True if a RTC (Real Time Clock) power failure has happened.\r
+ @param This Indicates the calling context.\r
+ @param RtcPowerFailed True if the RTC (Real Time Clock) power failed or was removed.\r
\r
@retval EFI_SUCCESS The call was successful.\r
- \r
+\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_GET_RTC_POWER_STATUS) (\r
- IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL * This,\r
+(EFIAPI *EFI_GET_RTC_POWER_STATUS)(\r
+ IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This,\r
OUT BOOLEAN *RtcPowerFailed\r
);\r
\r
/**\r
- This service returns supported lock methods for swap operation in current platform. Could be software lock, hardware lock, or unsupport lock.\r
-\r
- The EFI_GET_SWAP_LOCK_CAPABILITY service allows caller to get supported lock method for swap operation in current platform. \r
- Note that software and hardware lock mothod can be used simultaneously.\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 This Indicates the calling context.\r
+ @param LockCapability The current lock method for swap operations.\r
\r
@retval EFI_SUCCESS The call was successful.\r
- \r
+\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_GET_SWAP_LOCK_CAPABILITY) (\r
- IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL * This,\r
- OUT EFI_SWAP_LOCK_CAPABILITY * LockCapability\r
+(EFIAPI *EFI_GET_SWAP_LOCK_CAPABILITY)(\r
+ IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This,\r
+ OUT EFI_SWAP_LOCK_CAPABILITY *LockCapability\r
);\r
\r
-\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
- The EFI_GET_SWAP_LOCK_CAPABILITY service allows caller to get supported lock method for swap operation in current platform. \r
Note that software and hardware lock mothod can be used simultaneously.\r
\r
- @param This Indicates the calling context.\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
+\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SET_SWAP_LOCK) (\r
- IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL * This,\r
+(EFIAPI *EFI_SET_SWAP_LOCK)(\r
+ IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This,\r
IN EFI_SWAP_LOCK_CAPABILITY LockCapability,\r
IN BOOLEAN NewLockState\r
);\r
\r
struct _EFI_SWAP_ADDRESS_RANGE_PROTOCOL {\r
- EFI_GET_RANGE_LOCATION GetRangeLocation; // has output parameters for base and length\r
- EFI_GET_SWAP_STATE GetSwapState; // are ranges swapped or not\r
- EFI_SET_SWAP_STATE SetSwapState; // swap or unswap ranges\r
- EFI_GET_RTC_POWER_STATUS GetRtcPowerStatus; // checks RTC battery, or whatever...\r
- EFI_GET_SWAP_LOCK_CAPABILITY GetSwapLockCapability; // Get TOP_SWAP lock capability,\r
- EFI_SET_SWAP_LOCK SetSwapLock; // Set TOP_SWAP lock state\r
+ EFI_GET_RANGE_LOCATION GetRangeLocation; // has output parameters for base and length\r
+ EFI_GET_SWAP_STATE GetSwapState; // are ranges swapped or not\r
+ EFI_SET_SWAP_STATE SetSwapState; // swap or unswap ranges\r
+ EFI_GET_RTC_POWER_STATUS GetRtcPowerStatus; // checks RTC battery, or whatever...\r
+ EFI_GET_SWAP_LOCK_CAPABILITY GetSwapLockCapability; // Get TOP_SWAP lock capability,\r
+ EFI_SET_SWAP_LOCK SetSwapLock; // Set TOP_SWAP lock state\r
};\r
\r
-extern EFI_GUID gEfiSwapAddressRangeProtocolGuid;\r
+extern EFI_GUID gEfiSwapAddressRangeProtocolGuid;\r
\r
#endif\r
projects / mirror_edk2.git / blobdiff