remove CAPSULE_HOB_INFO definition from MdeModulePkg.

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

diff --git a/MdeModulePkg/Include/Guid/CapsuleVendor.h b/MdeModulePkg/Include/Guid/CapsuleVendor.h
index cd48c39dcf81ae6b6b42716b7e483a19540a0579..910f634286e3eb86bc2bd1003a731e2638520806 100644 (file)
--- a/MdeModulePkg/Include/Guid/CapsuleVendor.h
+++ b/MdeModulePkg/Include/Guid/CapsuleVendor.h
@@ -1,6 +1,9 @@
-/*++\r
+/** @file\r
+  This file defines:\r
+  * the capsule vendor GUID for capsule variables and the HOB\r
+  * the capsule variable name\r
 \r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+Copyright (c) 2006 - 2009, 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
@@ -9,27 +12,27 @@ http://opensource.org/licenses/bsd-license.php
 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
-Module Name:\r
-\r
-  CapsuleVendor.h\r
-\r
-Abstract:\r
-\r
-  Capsule update Guid definitions\r
-\r
---*/\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 vendor 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
+#define EFI_CAPSULE_VARIABLE_NAME L"CapsuleUpdateData"\r
+\r
+\r
 extern EFI_GUID gEfiCapsuleVendorGuid;\r
 \r
 #endif // #ifndef _EFI_CAPSULE_VENDOR_GUID_H_\r