fix the ecc issue.

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

/** @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
\r
**/\r
\r
#ifndef _EFI_SWAP_ADDRESS_RANGE_PROTOCOL_H_\r
#define _EFI_SWAP_ADDRESS_RANGE_PROTOCOL_H_\r
\r
#define EFI_SWAP_ADDRESS_RANGE_PROTOCOL_GUID \\r
  { \\r
    0x1259f60d, 0xb754, 0x468e, {0xa7, 0x89, 0x4d, 0xb8, 0x5d, 0x55, 0xe8, 0x7e } \\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
\r
#define EFI_UNSUPPORT_LOCK  0\r
#define EFI_SOFTWARE_LOCK   1\r
#define EFI_HARDWARE_LOCK   2\r
\r
typedef UINT8 EFI_SWAP_LOCK_CAPABILITY;\r
\r
//\r
// Protocl 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
**/\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
  OUT UINTN                                     *BootBlockSize,\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
\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
  @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
  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
  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
\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
  IN BOOLEAN                                    NewSwapState\r
  );\r
\r
\r
\r
/**\r
  This service checks if a RTC (Real Time Clock) 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
\r
  @param This   Indicates the calling context.  \r
  @param RtcPowerFailed   True if a RTC (Real Time Clock) power failure has happened.\r
\r
  @retval EFI_SUCCESS The call was successful.\r
    \r
**/\r
typedef\r
EFI_STATUS\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
\r
  @param This   Indicates the calling context.\r
  @param LockCapability	 	Current lock method for swap operation. \r
\r
  @retval EFI_SUCCESS The call was successful.\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
  );\r
\r
\r
\r
/**\r
  This service is used to acquire or release appointed kind of lock for Swap Address Range operation.\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 LockCapability    Indicates which lock to acquire or release.\r
  @param NewLockState            True to acquire lock, False to release lock.\r
\r
  @retval EFI_SUCCESS The call was successful.\r
    \r
**/\r
typedef\r
EFI_STATUS\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
};\r
\r
extern EFI_GUID gEfiSwapAddressRangeProtocolGuid;\r
\r
#endif\r