From: mdkinney <mdkinney@6f19259b-4bc3-4df7-8a09-765794883524>
Date: Sat, 9 May 2009 01:47:49 +0000 (+0000)
Subject: Clarify BuildCvHob() API in HobLib to state that this function will ASSERT() if the... 
X-Git-Tag: edk2-stable201903~17992
X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=c85cea804611f6cad04faf2c3908618e321c2710

Clarify BuildCvHob() API in HobLib to state that this function will ASSERT() if the platform does not support Capsule Volume HOBs.  This allows PI implementations to ASSERT() and Framework implementations to provide a full implementation of this API.


git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8278 6f19259b-4bc3-4df7-8a09-765794883524
---

diff --git a/MdePkg/Include/Library/HobLib.h b/MdePkg/Include/Library/HobLib.h
index 08cb63e936..1590524493 100644
--- a/MdePkg/Include/Library/HobLib.h
+++ b/MdePkg/Include/Library/HobLib.h
@@ -317,6 +317,7 @@ BuildFv2Hob (
   It can only be invoked during PEI phase;
   for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
   
+  If the platform does not support Capsule Volume HOBs, then ASSERT().
   If there is no additional space for HOB creation, then ASSERT().
 
   @param  BaseAddress   The base address of the Capsule Volume.
diff --git a/MdePkg/Library/DxeCoreHobLib/HobLib.c b/MdePkg/Library/DxeCoreHobLib/HobLib.c
index e238aa35db..8bc346e620 100644
--- a/MdePkg/Library/DxeCoreHobLib/HobLib.c
+++ b/MdePkg/Library/DxeCoreHobLib/HobLib.c
@@ -401,6 +401,7 @@ BuildFv2Hob (
   It can only be invoked during PEI phase;
   for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
   
+  If the platform does not support Capsule Volume HOBs, then ASSERT().
   If there is no additional space for HOB creation, then ASSERT().
 
   @param  BaseAddress   The base address of the Capsule Volume.
diff --git a/MdePkg/Library/DxeHobLib/HobLib.c b/MdePkg/Library/DxeHobLib/HobLib.c
index 9d226fa5ee..677f91d06d 100644
--- a/MdePkg/Library/DxeHobLib/HobLib.c
+++ b/MdePkg/Library/DxeHobLib/HobLib.c
@@ -435,6 +435,7 @@ BuildFv2Hob (
   It can only be invoked during PEI phase;
   for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
   
+  If the platform does not support Capsule Volume HOBs, then ASSERT().
   If there is no additional space for HOB creation, then ASSERT().
 
   @param  BaseAddress   The base address of the Capsule Volume.
diff --git a/MdePkg/Library/PeiHobLib/HobLib.c b/MdePkg/Library/PeiHobLib/HobLib.c
index 476ea06dbc..5ffc8549b4 100644
--- a/MdePkg/Library/PeiHobLib/HobLib.c
+++ b/MdePkg/Library/PeiHobLib/HobLib.c
@@ -475,6 +475,7 @@ BuildFv2Hob (
   It can only be invoked during PEI phase;
   for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
   
+  If the platform does not support Capsule Volume HOBs, then ASSERT().
   If there is no additional space for HOB creation, then ASSERT().
 
   @param  BaseAddress   The base address of the Capsule Volume.