describe the difference with Spec to fix the bug #202465

[mirror_edk2.git] / IntelFrameworkPkg / Include / Framework / Hob.h

diff --git a/IntelFrameworkPkg/Include/Framework/Hob.h b/IntelFrameworkPkg/Include/Framework/Hob.h
index cdc419d0ea6bef4549a272ee6479d354e9ec9f11..c8e9914a7eb5f2b8e9b3d245f5ae5a2dc0b946be 100644 (file)
--- a/IntelFrameworkPkg/Include/Framework/Hob.h
+++ b/IntelFrameworkPkg/Include/Framework/Hob.h
@@ -1,7 +1,7 @@
 /** @file\r
   This file defines the data structures per HOB specification v0.9.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 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
@@ -22,15 +22,17 @@
 \r
 #include <PiPei.h>\r
 \r
-//\r
-// Capsule volume HOB -- identical to a firmware volume\r
-//\r
-#define EFI_HOB_TYPE_CV 0x0008\r
+///\r
+/// Capsule volume HOB -- identical to a firmware volume\r
+/// This macro is defined  to comply with hob Framework Spec. And the marco has been\r
+/// retired in PI1.0 spec.  \r
+///\r
+#define EFI_HOB_TYPE_CV           0x0008\r
 \r
 typedef struct {\r
-  EFI_HOB_GENERIC_HEADER  Header;\r
-  EFI_PHYSICAL_ADDRESS    BaseAddress;\r
-  UINT64                  Length;\r
+  EFI_HOB_GENERIC_HEADER            Header;\r
+  EFI_PHYSICAL_ADDRESS              BaseAddress;\r
+  UINT64                            Length;\r
 } EFI_HOB_CAPSULE_VOLUME;\r
 \r
 #endif\r