Add INF extension Information

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

diff --git a/MdeModulePkg/Include/Guid/CapsuleVendor.h b/MdeModulePkg/Include/Guid/CapsuleVendor.h
index 8ac5d0cf46558d609187d91e66142c557d0035f1..58ac355bd4190ab161950b4f6d2a01bba127426f 100644 (file)
--- a/MdeModulePkg/Include/Guid/CapsuleVendor.h
+++ b/MdeModulePkg/Include/Guid/CapsuleVendor.h
@@ -1,6 +1,9 @@
-/*++\r
+/** @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
+  They are used by EDKII implementation of capsule update across a system reset.\r
 \r
-Copyright (c) 2006 - 2007, Intel Corporation\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
@@ -9,40 +12,34 @@ 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
+///\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
+/// Data structure of capsule guid hob entry\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