Add comments and DoxyGen format for these files.

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

diff --git a/MdeModulePkg/Include/Guid/CapsuleVendor.h b/MdeModulePkg/Include/Guid/CapsuleVendor.h
index cd48c39dcf81ae6b6b42716b7e483a19540a0579..118e08b5b118f937323367aa9b4ae417fd66cfd6 100644 (file)
--- a/MdeModulePkg/Include/Guid/CapsuleVendor.h
+++ b/MdeModulePkg/Include/Guid/CapsuleVendor.h
@@ -1,6 +1,8 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+  Capsule update Guid definitions for capsule varialbe and capsule hob.\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
@@ -9,15 +11,7 @@ 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
@@ -30,6 +24,19 @@ Abstract:
 #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
 extern EFI_GUID gEfiCapsuleVendorGuid;\r
 \r
+//\r
+// Data structure of capsule guid hob \r
+//\r
+typedef struct {\r
+  EFI_PHYSICAL_ADDRESS BaseAddress;\r
+  UINT32 Length;\r
+} CAPSULE_HOB_INFO;\r
+\r
 #endif // #ifndef _EFI_CAPSULE_VENDOR_GUID_H_\r