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
This commit is contained in:
mdkinney 2009-05-09 01:47:49 +00:00
parent 5e11e7c691
commit c85cea8046
4 changed files with 4 additions and 0 deletions

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.