add note for EFI_SW_PEI_EC_INVALID_CAPSULE_DESCRIPTOR and EFI_SW_PEI_PC_RECOVERY_BEGI...

[mirror_edk2.git] / MdePkg / Include / Library / HobLib.h

diff --git a/MdePkg/Include/Library/HobLib.h b/MdePkg/Include/Library/HobLib.h
index 08cb63e936a541381aa7044582d4b16c2a4f82c7..a7bc26a742544fe5f28efb8672ea50036b6293e2 100644 (file)
--- a/MdePkg/Include/Library/HobLib.h
+++ b/MdePkg/Include/Library/HobLib.h
@@ -8,8 +8,8 @@
   allows the PEI phase to pass information to the DXE phase. HOBs are position \r
   independent and can be relocated easily to different memory memory locations.\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>\r
+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
@@ -317,6 +317,7 @@ BuildFv2Hob (
   It can only be invoked during PEI phase;\r
   for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.\r
   \r
+  If the platform does not support Capsule Volume HOBs, then ASSERT().\r
   If there is no additional space for HOB creation, then ASSERT().\r
 \r
   @param  BaseAddress   The base address of the Capsule Volume.\r
@@ -418,9 +419,9 @@ BuildMemoryAllocationHob (
   Returns the type of a HOB.\r
 \r
   This macro returns the HobType field from the HOB header for the \r
-  HOB specified by Hob.\r
+  HOB specified by HobStart.\r
 \r
-  @param  Hob   A pointer to a HOB.\r
+  @param  HobStart   A pointer to a HOB.\r
   \r
   @return HobType.\r
   \r
@@ -432,9 +433,9 @@ BuildMemoryAllocationHob (
   Returns the length, in bytes, of a HOB.\r
 \r
   This macro returns the HobLength field from the HOB header for the \r
-  HOB specified by Hob.\r
+  HOB specified by HobStart.\r
 \r
-  @param  Hob   A pointer to a HOB.\r
+  @param  HobStart   A pointer to a HOB.\r
 \r
   @return HobLength.\r
 \r
@@ -446,9 +447,9 @@ BuildMemoryAllocationHob (
   Returns a pointer to the next HOB in the HOB list.\r
 \r
   This macro returns a pointer to HOB that follows the \r
-  HOB specified by Hob in the HOB List.\r
+  HOB specified by HobStart in the HOB List.\r
 \r
-  @param  Hob   A pointer to a HOB.\r
+  @param  HobStart   A pointer to a HOB.\r
 \r
   @return A pointer to the next HOB in the HOB list.\r
 \r
@@ -459,23 +460,23 @@ BuildMemoryAllocationHob (
 /**\r
   Determines if a HOB is the last HOB in the HOB list.\r
   \r
-  This macro determine if the HOB specified by Hob is the \r
-  last HOB in the HOB list.  If Hob is last HOB in the HOB list, \r
+  This macro determine if the HOB specified by HobStart is the \r
+  last HOB in the HOB list.  If HobStart is last HOB in the HOB list, \r
   then TRUE is returned.  Otherwise, FALSE is returned.\r
 \r
-  @param  Hob   A pointer to a HOB.\r
+  @param  HobStart   A pointer to a HOB.\r
 \r
-  @retval TRUE       The HOB specified by Hob is the last HOB in the HOB list.\r
-  @retval FALSE      The HOB specified by Hob is not the last HOB in the HOB list.\r
+  @retval TRUE       The HOB specified by HobStart is the last HOB in the HOB list.\r
+  @retval FALSE      The HOB specified by HobStart is not the last HOB in the HOB list.\r
 \r
 **/\r
-#define END_OF_HOB_LIST(Hob)  (GET_HOB_TYPE (Hob) == (UINT16)EFI_HOB_TYPE_END_OF_HOB_LIST)\r
+#define END_OF_HOB_LIST(HobStart)  (GET_HOB_TYPE (HobStart) == (UINT16)EFI_HOB_TYPE_END_OF_HOB_LIST)\r
 \r
 /**\r
   Returns a pointer to data buffer from a HOB of type EFI_HOB_TYPE_GUID_EXTENSION.\r
 \r
-  This macro returns a pointer to the data buffer in a HOB specified by Hob.\r
-  Hob is assumed to be a HOB of type EFI_HOB_TYPE_GUID_EXTENSION.   \r
+  This macro returns a pointer to the data buffer in a HOB specified by HobStart.\r
+  HobStart is assumed to be a HOB of type EFI_HOB_TYPE_GUID_EXTENSION.   \r
 \r
   @param   GuidHob   A pointer to a HOB.\r
 \r
@@ -488,8 +489,8 @@ BuildMemoryAllocationHob (
 /**\r
   Returns the size of the data buffer from a HOB of type EFI_HOB_TYPE_GUID_EXTENSION.\r
 \r
-  This macro returns the size, in bytes, of the data buffer in a HOB specified by Hob.\r
-  Hob is assumed to be a HOB of type EFI_HOB_TYPE_GUID_EXTENSION.\r
+  This macro returns the size, in bytes, of the data buffer in a HOB specified by HobStart.\r
+  HobStart is assumed to be a HOB of type EFI_HOB_TYPE_GUID_EXTENSION.\r
 \r
   @param   GuidHob   A pointer to a HOB.\r
 \r