/** @file\r
- This file defines capsule vendor guid for capsule variable and hob.\r
- It also defines capsule varialbe name and capsule guid hob data structure. \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 - 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
+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
+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
{ 0x711C703F, 0xC285, 0x4B10, { 0xA3, 0xB0, 0x36, 0xEC, 0xBD, 0x3C, 0x8B, 0xE2 } }\r
\r
///\r
-/// Name of capsule variable\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
+/// 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; ///> Capsule data start address\r
- UINT32 Length; ///> Length of capsule data.\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