/** @file\r
-\r
- This file defines capsule update guid, capsule variable name and \r
- capsule guid hob data strucutre, which are required by capsule update feature.\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
+ This file defines:\r
+ * the capsule vendor GUID for capsule variables and the HOB.\r
+ * the capsule variable name.\r
+ * the capsule GUID HOB data structure.\r
+ The capsule HOB and variable 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
+ @par Note: EDKII implementation of capsule updating has discarded this capsule GUID HOB data\r
+ structure and used one UEFI Capsule HOB (defined in PI Specification 1.2) instead.\r
+\r
+Copyright (c) 2006 - 2010, 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
#ifndef __EFI_CAPSULE_VENDOR_GUID_H__\r
#define __EFI_CAPSULE_VENDOR_GUID_H__\r
\r
-//\r
-// Note -- This guid is used as a variable GUID (depending on implementation)\r
-// for the capsule variable if the capsule pointer is passes through reset\r
-// via a variable.\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
+///\r
+/// Name of capsule variable.\r
+/// \r
#define EFI_CAPSULE_VARIABLE_NAME L"CapsuleUpdateData"\r
\r
-extern EFI_GUID gEfiCapsuleVendorGuid;\r
-\r
-//\r
-// Data structure of capsule guid hob \r
-//\r
+///\r
+/// The data structure of the capsule guid hob entry.\r
+/// Note: EDKII implementation has discarded this structure and used \r
+/// UEFI_CAPSULE_HOB instead.\r
+///\r
typedef struct {\r
- EFI_PHYSICAL_ADDRESS BaseAddress;\r
- UINT32 Length;\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