MdeModulePkg/Include/Protocol/SmmSwapAddressRange.h

   1 /** @file
   2   The EFI_SMM_SWAP_ADDRESS_RANGE_PROTOCOL is related to EDK II-specific implementation
   3   and used to abstract the swap operation of boot block and backup block of FV in EFI
   4   SMM environment. This swap is especially needed when updating the boot block of FV.
   5   If a power failure happens during the boot block update, the swapped backup block
   6   (now the boot block) can boot the machine with the old boot block backed up in it.
   7   The swap operation is platform dependent, so other protocols such as SMM FTW (Fault
   8   Tolerant Write) should use this protocol instead of handling hardware directly.
   9
  10 Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>
  11 SPDX-License-Identifier: BSD-2-Clause-Patent
  12
  13 **/
  14
  15 #ifndef __SMM_SWAP_ADDRESS_RANGE_H__
  16 #define __SMM_SWAP_ADDRESS_RANGE_H__
  17
  18 #include <Protocol/SwapAddressRange.h>
  19
  20 #define EFI_SMM_SWAP_ADDRESS_RANGE_PROTOCOL_GUID \
  21   { \
  22     0x67c4f112, 0x3385, 0x4e55, { 0x9c, 0x5b, 0xc0, 0x5b, 0x71, 0x7c, 0x42, 0x28 } \
  23   }
  24
  25 //
  26 // SMM Swap Address Range protocol structure is the same as Swap Address Range protocol.
  27 // The SMM one is intend to run in SMM environment, which means it can be used by
  28 // SMM drivers after ExitPmAuth.
  29 //
  30 typedef EFI_SWAP_ADDRESS_RANGE_PROTOCOL EFI_SMM_SWAP_ADDRESS_RANGE_PROTOCOL;
  31
  32 extern EFI_GUID  gEfiSmmSwapAddressRangeProtocolGuid;
  33
  34 #endif