[mirror_edk2.git] / MdeModulePkg / Include / Guid / CapsuleVendor.h

/** @file\r
  This file defines capsule vendor guid for capsule variable and hob.\r
  It also defines capsule variable name and capsule guid hob data structure,\r
  which can be used to store the capsule image start address and length.\r
  They are used by EDKII implementation of capsule update across a system reset.\r
\r
Copyright (c) 2006 - 2008, 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_CAPSULE_VENDOR_GUID_H__\r
#define __EFI_CAPSULE_VENDOR_GUID_H__\r
\r
///\r
/// This guid is used as a variable GUID for the capsule variable \r
/// if the capsule pointer is passed through reset via a variable.\r
///\r
/// This guid is also used as a hob GUID for the capsule data \r
/// when the capsule pointer is passed from PEI phase to DXE phase.\r
///\r
#define EFI_CAPSULE_VENDOR_GUID  \\r
  { 0x711C703F, 0xC285, 0x4B10, { 0xA3, 0xB0, 0x36, 0xEC, 0xBD, 0x3C, 0x8B, 0xE2 } }\r
\r
///\r
/// Name of capsule variable\r
/// \r
#define EFI_CAPSULE_VARIABLE_NAME L"CapsuleUpdateData"\r
\r
///\r
/// Data structure of capsule guid hob entry\r
///\r
typedef struct {\r
  EFI_PHYSICAL_ADDRESS BaseAddress;  ///> Capsule data start address\r
  UINT32 Length;                     ///> Length of capsule data.\r
} CAPSULE_HOB_INFO;\r
\r
extern EFI_GUID gEfiCapsuleVendorGuid;\r
\r
#endif // #ifndef _EFI_CAPSULE_VENDOR_GUID_H_\r
Commit	Line	Data
	1	/** @file\r
	2	This file defines capsule vendor guid for capsule variable and hob.\r
	3	It also defines capsule variable name and capsule guid hob data structure,\r
	4	which can be used to store the capsule image start address and length.\r
	5	They are used by EDKII implementation of capsule update across a system reset.\r
	6	\r
	7	Copyright (c) 2006 - 2008, Intel Corporation\r
	8	All rights reserved. This program and the accompanying materials\r
	9	are licensed and made available under the terms and conditions of the BSD License\r
	10	which accompanies this distribution. The full text of the license may be found at\r
	11	http://opensource.org/licenses/bsd-license.php\r
	12	\r
	13	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	14	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	15	\r
	16	**/\r
	17	\r
	18	#ifndef __EFI_CAPSULE_VENDOR_GUID_H__\r
	19	#define __EFI_CAPSULE_VENDOR_GUID_H__\r
	20	\r
	21	///\r
	22	/// This guid is used as a variable GUID for the capsule variable \r
	23	/// if the capsule pointer is passed through reset via a variable.\r
	24	///\r
	25	/// This guid is also used as a hob GUID for the capsule data \r
	26	/// when the capsule pointer is passed from PEI phase to DXE phase.\r
	27	///\r
	28	#define EFI_CAPSULE_VENDOR_GUID \\r
	29	{ 0x711C703F, 0xC285, 0x4B10, { 0xA3, 0xB0, 0x36, 0xEC, 0xBD, 0x3C, 0x8B, 0xE2 } }\r
	30	\r
	31	///\r
	32	/// Name of capsule variable\r
	33	/// \r
	34	#define EFI_CAPSULE_VARIABLE_NAME L"CapsuleUpdateData"\r
	35	\r
	36	///\r
	37	/// Data structure of capsule guid hob entry\r
	38	///\r
	39	typedef struct {\r
	40	EFI_PHYSICAL_ADDRESS BaseAddress; ///> Capsule data start address\r
	41	UINT32 Length; ///> Length of capsule data.\r
	42	} CAPSULE_HOB_INFO;\r
	43	\r
	44	extern EFI_GUID gEfiCapsuleVendorGuid;\r
	45	\r
	46	#endif // #ifndef _EFI_CAPSULE_VENDOR_GUID_H_\r