UefiPayloadPkg: Fix ECC reported issues

V2: Fix more header files on #ifdef variable

ECC reported some issues on UefiPayloadPkg, this patch fixed
most of them except several files including ElfLib\Elf32.h,
coreboot.h, CbParseLib.c, etc.
It also removed unused functions in ResetSystemLib and Hob.c.

Signed-off-by: Guo Dong <guo.dong@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Cc: Maurice Ma <maurice.ma@intel.com>
Cc: Benjamin You <benjamin.you@intel.com>
Reviewed-by: Maurice Ma <maurice.ma@intel.com>

5 files changed, 37 insertions, 14 deletions

diff --git a/UefiPayloadPkg/UefiPayloadEntry/LoadDxeCore.c b/UefiPayloadPkg/UefiPayloadEntry/LoadDxeCore.c
index 0b6cb47cd0..67eed179f0 100644
--- a/UefiPayloadPkg/UefiPayloadEntry/LoadDxeCore.c
+++ b/UefiPayloadPkg/UefiPayloadEntry/LoadDxeCore.c
@@ -190,7 +190,7 @@ FvFindFileByTypeGuid (
 

   @param  FileHeader            A pointer to the file header that contains the set of sections to

                                 be searched.

-  @param  SearchType            The value of the section type to search.

+  @param  SectionType            The value of the section type to search.

   @param  SectionData           A pointer to the discovered section, if successful.

 

   @retval EFI_SUCCESS           The section was found.

diff --git a/UefiPayloadPkg/UefiPayloadEntry/PrintHob.c b/UefiPayloadPkg/UefiPayloadEntry/PrintHob.c
index 265d47ca9d..d7f3af1304 100644
--- a/UefiPayloadPkg/UefiPayloadEntry/PrintHob.c
+++ b/UefiPayloadPkg/UefiPayloadEntry/PrintHob.c
@@ -196,7 +196,10 @@ PrintResourceDiscriptorHob (
 

 /**

   Print the information in Acpi Guid Hob.

+

   @param[in] HobRaw          A pointer to the start of gUniversalPayloadAcpiTableGuid HOB.

+  @param[in] HobLength       The size of the HOB data buffer.

+

   @retval EFI_SUCCESS        If it completed successfully.

 **/

 EFI_STATUS

@@ -217,6 +220,8 @@ PrintAcpiGuidHob (
 /**

   Print the information in Serial Guid Hob.

   @param[in] HobRaw          A pointer to the start of gUniversalPayloadSerialPortInfoGuid HOB.

+  @param[in] HobLength       The size of the HOB data buffer.

+

   @retval EFI_SUCCESS        If it completed successfully.

 **/

 EFI_STATUS

@@ -240,6 +245,7 @@ PrintSerialGuidHob (
 /**

   Print the information in Smbios Guid Hob.

   @param[in] HobRaw          A pointer to the start of gUniversalPayloadSmbios3TableGuid HOB.

+  @param[in] HobLength       The size of the HOB data buffer.

   @retval EFI_SUCCESS        If it completed successfully.

 **/

 EFI_STATUS

@@ -260,6 +266,8 @@ PrintSmbios3GuidHob (
 /**

   Print the information in Smbios Guid Hob.

   @param[in] HobRaw          A pointer to the start of gUniversalPayloadSmbiosTableGuid HOB.

+  @param[in] HobLength       The size of the HOB data buffer.

+

   @retval EFI_SUCCESS        If it completed successfully.

 **/

 EFI_STATUS

@@ -280,6 +288,8 @@ PrintSmbiosTablGuidHob (
 /**

   Print the information in Acpi BoardInfo Guid Hob.

   @param[in] HobRaw          A pointer to the start of gUefiAcpiBoardInfoGuid HOB.

+  @param[in] HobLength       The size of the HOB data buffer.

+

   @retval EFI_SUCCESS        If it completed successfully.

 **/

 EFI_STATUS

@@ -307,6 +317,7 @@ PrintAcpiBoardInfoGuidHob (
 /**

   Print the information in Pci RootBridge Info Guid Hob.

   @param[in] HobRaw          A pointer to the start of gUniversalPayloadPciRootBridgeInfoGuid HOB.

+  @param[in] HobLength       The size of the HOB data buffer.

 

   @retval EFI_SUCCESS        If it completed successfully.

 **/

@@ -362,6 +373,8 @@ PrintPciRootBridgeInfoGuidHob (
 /**

   Print the information in Extra Data Guid Hob.

   @param[in]  HobRaw         A pointer to the start of gUniversalPayloadExtraDataGuid HOB.

+  @param[in] HobLength       The size of the HOB data buffer.

+

   @retval EFI_SUCCESS        If it completed successfully.

 **/

 EFI_STATUS

@@ -394,6 +407,8 @@ PrintExtraDataGuidHob (
 /**

   Print the information in MemoryTypeInfoGuidHob.

   @param[in] HobRaw          A pointer to the start of gEfiMemoryTypeInformationGuid HOB.

+  @param[in] HobLength       The size of the HOB data buffer.

+

   @retval EFI_SUCCESS        If it completed successfully.

 **/

 EFI_STATUS

@@ -414,7 +429,7 @@ PrintMemoryTypeInfoGuidHob (
 /**

   Print the information in EdkiiBootManagerMenuFileGuid.

   @param[in] HobRaw          A pointer to the start of gEdkiiBootManagerMenuFileGuid HOB.

-  @param[in] HobLength       The size of the data buffer.

+  @param[in] HobLength       The size of the HOB data buffer.

   @retval EFI_SUCCESS        If it completed successfully.

 **/

 EFI_STATUS

diff --git a/UefiPayloadPkg/UefiPayloadEntry/UefiPayloadEntry.c b/UefiPayloadPkg/UefiPayloadEntry/UefiPayloadEntry.c
index 3646da2ba5..00db65c2f0 100644
--- a/UefiPayloadPkg/UefiPayloadEntry/UefiPayloadEntry.c
+++ b/UefiPayloadPkg/UefiPayloadEntry/UefiPayloadEntry.c
@@ -389,6 +389,8 @@ BuildGenericHob (
 /**

   Entry point to the C language phase of UEFI payload.

 

+  @param[in]   BootloaderParameter    The starting address of bootloader parameter block.

+

   @retval      It will not return if SUCCESS, and return error when passing bootloader parameter.

 **/

 EFI_STATUS

diff --git a/UefiPayloadPkg/UefiPayloadEntry/UefiPayloadEntry.h b/UefiPayloadPkg/UefiPayloadEntry/UefiPayloadEntry.h
index de51c2fba9..637ed9c20b 100644
--- a/UefiPayloadPkg/UefiPayloadEntry/UefiPayloadEntry.h
+++ b/UefiPayloadPkg/UefiPayloadEntry/UefiPayloadEntry.h
@@ -1,9 +1,9 @@
 /** @file

-*

-* Copyright (c) 2021, Intel Corporation. All rights reserved.<BR>

-*

-*  SPDX-License-Identifier: BSD-2-Clause-Patent

-*

+

+  Copyright (c) 2021, Intel Corporation. All rights reserved.<BR>

+

+  SPDX-License-Identifier: BSD-2-Clause-Patent

+

 **/

 

 #ifndef __UEFI_PAYLOAD_ENTRY_H__

diff --git a/UefiPayloadPkg/UefiPayloadEntry/UniversalPayloadEntry.c b/UefiPayloadPkg/UefiPayloadEntry/UniversalPayloadEntry.c
index 7e67cf0f04..4d1096b323 100644
--- a/UefiPayloadPkg/UefiPayloadEntry/UniversalPayloadEntry.c
+++ b/UefiPayloadPkg/UefiPayloadEntry/UniversalPayloadEntry.c
@@ -114,18 +114,19 @@ AddNewHob (
 }

 

 /**

-  Found the Resource Descriptor HOB that contains a range

+  Found the Resource Descriptor HOB that contains a range (Base, Top)

 

+  @param[in] HobList    Hob start address

   @param[in] Base       Memory start address

-  @param[in] Top        Memory Top.

+  @param[in] Top        Memory end address.

 

-  @return     The pointer to the Resource Descriptor HOB.

+  @retval     The pointer to the Resource Descriptor HOB.

 **/

 EFI_HOB_RESOURCE_DESCRIPTOR *

 FindResourceDescriptorByRange (

-  VOID                      *HobList,

-  EFI_PHYSICAL_ADDRESS      Base,

-  EFI_PHYSICAL_ADDRESS      Top

+  IN VOID                      *HobList,

+  IN EFI_PHYSICAL_ADDRESS      Base,

+  IN EFI_PHYSICAL_ADDRESS      Top

   )

 {

   EFI_PEI_HOB_POINTERS             Hob;

@@ -171,7 +172,7 @@ FindResourceDescriptorByRange (
   @param[in] MinimalNeededSize       Minimal needed size.

   @param[in] ExceptResourceHob       Ignore this Resource Descriptor.

 

-  @return     The pointer to the Resource Descriptor HOB.

+  @retval     The pointer to the Resource Descriptor HOB.

 **/

 EFI_HOB_RESOURCE_DESCRIPTOR *

 FindAnotherHighestBelow4GResourceDescriptor (

@@ -240,6 +241,9 @@ FindAnotherHighestBelow4GResourceDescriptor (
 /**

   It will build HOBs based on information from bootloaders.

 

+  @param[in]  BootloaderParameter   The starting memory address of bootloader parameter block.

+  @param[out] DxeFv                 The pointer to the DXE FV in memory.

+

   @retval EFI_SUCCESS        If it completed successfully.

   @retval Others             If it failed to build required HOBs.

 **/

@@ -376,6 +380,8 @@ BuildHobs (
 /**

   Entry point to the C language phase of UEFI payload.

 

+  @param[in]   BootloaderParameter    The starting address of bootloader parameter block.

+

   @retval      It will not return if SUCCESS, and return error when passing bootloader parameter.

 **/

 EFI_STATUS