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

/** @file\r
  The EFI_SMM_SWAP_ADDRESS_RANGE_PROTOCOL is related to EDK II-specific implementation\r
  and used to abstract the swap operation of boot block and backup block of FV in EFI\r
  SMM environment. This swap is especially needed when updating the boot block of FV.\r
  If a power failure happens during the boot block update, the swapped backup block\r
  (now the boot block) can boot the machine with the old boot block backed up in it.\r
  The swap operation is platform dependent, so other protocols such as SMM FTW (Fault\r
  Tolerant Write) should use this protocol instead of handling hardware directly.\r
\r
Copyright (c) 2010 - 2018, 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
**/\r
\r
#ifndef __SMM_SWAP_ADDRESS_RANGE_H__\r
#define __SMM_SWAP_ADDRESS_RANGE_H__\r
\r
#include <Protocol/SwapAddressRange.h>\r
\r
#define EFI_SMM_SWAP_ADDRESS_RANGE_PROTOCOL_GUID \\r
  { \\r
    0x67c4f112, 0x3385, 0x4e55, { 0x9c, 0x5b, 0xc0, 0x5b, 0x71, 0x7c, 0x42, 0x28 } \\r
  }\r
\r
//\r
// SMM Swap Address Range protocol structure is the same as Swap Address Range protocol.\r
// The SMM one is intend to run in SMM environment, which means it can be used by\r
// SMM drivers after ExitPmAuth.\r
//\r
typedef EFI_SWAP_ADDRESS_RANGE_PROTOCOL EFI_SMM_SWAP_ADDRESS_RANGE_PROTOCOL;\r
\r
extern EFI_GUID gEfiSmmSwapAddressRangeProtocolGuid;\r
\r
#endif\r
Commit	Line	Data
8a2d4996	1	/** @file\r
d1102dba LG	2	The EFI_SMM_SWAP_ADDRESS_RANGE_PROTOCOL is related to EDK II-specific implementation\r
	3	and used to abstract the swap operation of boot block and backup block of FV in EFI\r
	4	SMM environment. This swap is especially needed when updating the boot block of FV.\r
	5	If a power failure happens during the boot block update, the swapped backup block\r
	6	(now the boot block) can boot the machine with the old boot block backed up in it.\r
	7	The swap operation is platform dependent, so other protocols such as SMM FTW (Fault\r
8a2d4996	8	Tolerant Write) should use this protocol instead of handling hardware directly.\r
8a2d4996	9	\r
d1102dba LG	10	Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r
	11	This program and the accompanying materials are licensed and made available under\r
	12	the terms and conditions of the BSD License that accompanies this distribution.\r
8a2d4996	13	The full text of the license may be found at\r
d1102dba	14	http://opensource.org/licenses/bsd-license.php.\r
8a2d4996	15	\r
d1102dba LG	16	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
d1102dba LG	17	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
8a2d4996	18	\r
	19	**/\r
	20	\r
	21	#ifndef __SMM_SWAP_ADDRESS_RANGE_H__\r
	22	#define __SMM_SWAP_ADDRESS_RANGE_H__\r
	23	\r
	24	#include <Protocol/SwapAddressRange.h>\r
	25	\r
	26	#define EFI_SMM_SWAP_ADDRESS_RANGE_PROTOCOL_GUID \\r
	27	{ \\r
	28	0x67c4f112, 0x3385, 0x4e55, { 0x9c, 0x5b, 0xc0, 0x5b, 0x71, 0x7c, 0x42, 0x28 } \\r
	29	}\r
	30	\r
	31	//\r
d1102dba LG	32	// SMM Swap Address Range protocol structure is the same as Swap Address Range protocol.\r
	33	// The SMM one is intend to run in SMM environment, which means it can be used by\r
	34	// SMM drivers after ExitPmAuth.\r
	35	//\r
8a2d4996	36	typedef EFI_SWAP_ADDRESS_RANGE_PROTOCOL EFI_SMM_SWAP_ADDRESS_RANGE_PROTOCOL;\r
	37	\r
	38	extern EFI_GUID gEfiSmmSwapAddressRangeProtocolGuid;\r
	39	\r
	40	#endif\r