diff options
Diffstat (limited to 'MdeModulePkg/Include/Protocol/SwapAddressRange.h')
| -rw-r--r-- | MdeModulePkg/Include/Protocol/SwapAddressRange.h | 182 |
1 files changed, 182 insertions, 0 deletions
diff --git a/MdeModulePkg/Include/Protocol/SwapAddressRange.h b/MdeModulePkg/Include/Protocol/SwapAddressRange.h new file mode 100644 index 0000000000..0aff5835a4 --- /dev/null +++ b/MdeModulePkg/Include/Protocol/SwapAddressRange.h @@ -0,0 +1,182 @@ +/** @file
+The EFI_SWAP_ADDRESS_RANGE_PROTOCOL is used to abstract the swap operation of boot block
+and backup block of FV. This swap is especially needed when updating the boot block of FV. If any
+power failure happens during updating boot block, the swapped backup block (now is the boot block)
+can boot the machine with old boot block backuped in it. The swap operation is platform dependent, so
+other protocols such as FTW (Fault Tolerant Write) should use this protocol instead of handling hardward directly.
+
+Copyright (c) 2009, Intel Corporation
+All rights reserved. This program and the accompanying materials
+are licensed and made available under the terms and conditions of the BSD License
+which accompanies this distribution. The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php
+
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+**/
+
+#ifndef _EFI_SWAP_ADDRESS_RANGE_PROTOCOL_H_
+#define _EFI_SWAP_ADDRESS_RANGE_PROTOCOL_H_
+
+#define EFI_SWAP_ADDRESS_RANGE_PROTOCOL_GUID \
+ { \
+ 0x1259f60d, 0xb754, 0x468e, {0xa7, 0x89, 0x4d, 0xb8, 0x5d, 0x55, 0xe8, 0x7e } \
+ }
+
+//
+// Forward reference for pure ANSI compatability
+//
+typedef struct _EFI_SWAP_ADDRESS_RANGE_PROTOCOL EFI_SWAP_ADDRESS_RANGE_PROTOCOL;
+
+#define EFI_UNSUPPORT_LOCK 0
+#define EFI_SOFTWARE_LOCK 1
+#define EFI_HARDWARE_LOCK 2
+
+typedef UINT8 EFI_SWAP_LOCK_CAPABILITY;
+
+//
+// Protocl APIs
+//
+
+/**
+ This service gets the address range location of boot block and backup block.
+ The EFI_GET_RANGE_LOCATION service allows caller to get the range location of
+ boot block and backup block.
+
+ @param This Indicates the calling context.
+ @param BootBlockBase Base address of current boot block.
+ @param BootBlockSize Size (in bytes) of current boot block.
+ @param BackupBlockBase Base address of current backup block.
+ @param BackupBlockSize Size (in bytes) of current backup block.
+
+ @retval EFI_SUCCESS The call was successful.
+
+**/
+typedef
+EFI_STATUS
+(EFIAPI *EFI_GET_RANGE_LOCATION) (
+ IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL * This,
+ OUT EFI_PHYSICAL_ADDRESS * BootBlockBase,
+ OUT UINTN *BootBlockSize,
+ OUT EFI_PHYSICAL_ADDRESS * BackupBlockBase,
+ OUT UINTN *BackupBlockSize
+ );
+
+/**
+ This service checks if the boot block and backup block has been swapped.
+
+ The EFI_GET_SWAP_STATE service allows caller to get current swap state of boot block and backup block.
+
+ @param This Indicates the calling context.
+ @param SwapState True if the boot block and backup block has been swapped.
+ False if the boot block and backup block has not been swapped.
+
+ @retval EFI_SUCCESS The call was successful.
+
+**/
+typedef
+EFI_STATUS
+(EFIAPI *EFI_GET_SWAP_STATE) (
+ IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL * This,
+ OUT BOOLEAN *SwapState
+ );
+
+/**
+ This service swaps the boot block and backup block, or swaps them back.
+
+ The EFI_SET_SWAP_STATE service allows caller to set the swap state of boot block and backup block.
+ It also acquires and releases software swap lock during operation. Note the setting of new swap state
+ is not affected by the old swap state.
+
+ @param This Indicates the calling context.
+ @param NewSwapState True to swap real boot block and backup block , False to swap them back..
+
+ @retval EFI_SUCCESS The call was successful.
+ @retval EFI_ABORTED Set swap state error
+
+**/
+typedef
+EFI_STATUS
+(EFIAPI *EFI_SET_SWAP_STATE) (
+ IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL * This,
+ IN BOOLEAN NewSwapState
+ );
+
+
+
+/**
+ This service checks if a RTC (Real Time Clock) power failure happened.
+
+ The EFI_GET_RTC_POWER_STATUS service allows caller to get Real Time Clock power failure status.
+ If parameter RtcPowerFailed is true after function returns, the trickle current (from the main battery or trickle supply)
+ has been removed or failed, this means the swap status was lost in some platform (such as IA32).
+ So it is recommended to check RTC power status before calling GetSwapState().
+
+ @param This Indicates the calling context.
+ @param RtcPowerFailed True if a RTC (Real Time Clock) power failure has happened.
+
+ @retval EFI_SUCCESS The call was successful.
+
+**/
+typedef
+EFI_STATUS
+(EFIAPI *EFI_GET_RTC_POWER_STATUS) (
+ IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL * This,
+ OUT BOOLEAN *RtcPowerFailed
+ );
+
+/**
+ This service returns supported lock methods for swap operation in current platform. Could be software lock, hardware lock, or unsupport lock.
+
+ The EFI_GET_SWAP_LOCK_CAPABILITY service allows caller to get supported lock method for swap operation in current platform.
+ Note that software and hardware lock mothod can be used simultaneously.
+
+ @param This Indicates the calling context.
+ @param LockCapability Current lock method for swap operation.
+
+ @retval EFI_SUCCESS The call was successful.
+
+**/
+typedef
+EFI_STATUS
+(EFIAPI *EFI_GET_SWAP_LOCK_CAPABILITY) (
+ IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL * This,
+ OUT EFI_SWAP_LOCK_CAPABILITY * LockCapability
+ );
+
+
+
+/**
+ This service is used to acquire or release appointed kind of lock for Swap Address Range operation.
+
+ The EFI_GET_SWAP_LOCK_CAPABILITY service allows caller to get supported lock method for swap operation in current platform.
+ Note that software and hardware lock mothod can be used simultaneously.
+
+ @param This Indicates the calling context.
+ @param LockCapability Indicates which lock to acquire or release.
+ @param NewLockState True to acquire lock, False to release lock.
+
+ @retval EFI_SUCCESS The call was successful.
+
+**/
+typedef
+EFI_STATUS
+(EFIAPI *EFI_SET_SWAP_LOCK) (
+ IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL * This,
+ IN EFI_SWAP_LOCK_CAPABILITY LockCapability,
+ IN BOOLEAN NewLockState
+ );
+
+struct _EFI_SWAP_ADDRESS_RANGE_PROTOCOL {
+ EFI_GET_RANGE_LOCATION GetRangeLocation; // has output parameters for base and length
+ EFI_GET_SWAP_STATE GetSwapState; // are ranges swapped or not
+ EFI_SET_SWAP_STATE SetSwapState; // swap or unswap ranges
+ EFI_GET_RTC_POWER_STATUS GetRtcPowerStatus; // checks RTC battery, or whatever...
+ EFI_GET_SWAP_LOCK_CAPABILITY GetSwapLockCapability; // Get TOP_SWAP lock capability,
+ EFI_SET_SWAP_LOCK SetSwapLock; // Set TOP_SWAP lock state
+};
+
+extern EFI_GUID gEfiSwapAddressRangeProtocolGuid;
+
+#endif
|