ArmVirtPkg DxeHobLib: Update func header description of BuildFv(2)Hob()

Update the function header description of BuildFv(2)Hob() to match
with HobLib.h in MdePkg.

Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=205

Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Jiewen Yao <jiewen.yao@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
Reviewed-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Regression-tested-by: Laszlo Ersek <lersek@redhat.com>
This commit is contained in:
Star Zeng 2016-11-16 10:07:42 +08:00
parent 368871a352
commit a0426207c1

View File

@ -1,7 +1,7 @@
/** @file /** @file
HOB Library implemenation for Dxe Phase with DebugLib dependency removed HOB Library implemenation for Dxe Phase with DebugLib dependency removed
Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR> Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2014, Linaro Ltd. All rights reserved.<BR> Copyright (c) 2014, Linaro Ltd. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
@ -395,6 +395,7 @@ BuildGuidDataHob (
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
If there is no additional space for HOB creation, then ASSERT(). If there is no additional space for HOB creation, then ASSERT().
If the FvImage buffer is not at its required alignment, then ASSERT().
@param BaseAddress The base address of the Firmware Volume. @param BaseAddress The base address of the Firmware Volume.
@param Length The size of the Firmware Volume in bytes. @param Length The size of the Firmware Volume in bytes.
@ -421,6 +422,7 @@ BuildFvHob (
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
If there is no additional space for HOB creation, then ASSERT(). If there is no additional space for HOB creation, then ASSERT().
If the FvImage buffer is not at its required alignment, then ASSERT().
@param BaseAddress The base address of the Firmware Volume. @param BaseAddress The base address of the Firmware Volume.
@param Length The size of the Firmware Volume in bytes. @param Length The size of the Firmware Volume in bytes.