[edk2-devel] [`edk2-devel][PATCH] UefiPayloadPkg: Fix ECC reported issues

Guo Dong posted 1 patch 2 years, 6 months ago
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/edk2 tags/patchew/20211015205139.304-1-guo.dong@intel.com
There is a newer version of this series
UefiPayloadPkg/Include/Library/BlParseLib.h                         |  8 ++++----
UefiPayloadPkg/Library/CbParseLib/CbParseLib.c                      | 22 +++++++++++-----------
UefiPayloadPkg/Library/DxeHobListLibNull/DxeHobListLibNull.c        |  6 ++++++
UefiPayloadPkg/Library/PayloadEntryHobLib/Hob.c                     | 28 ++--------------------------
UefiPayloadPkg/Library/PciHostBridgeLib/PciHostBridgeLib.c          |  4 ++--
UefiPayloadPkg/Library/PciHostBridgeLib/PciHostBridgeSupport.c      | 15 ++++++++++-----
UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManager.c |  4 ++++
UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManager.h |  2 +-
UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformData.c        |  2 +-
UefiPayloadPkg/Library/ResetSystemLib/ResetSystemLib.c              | 16 ----------------
UefiPayloadPkg/Library/SblParseLib/SblParseLib.c                    |  2 +-
UefiPayloadPkg/UefiPayloadEntry/LoadDxeCore.c                       |  2 +-
UefiPayloadPkg/UefiPayloadEntry/PrintHob.c                          | 17 ++++++++++++++++-
UefiPayloadPkg/UefiPayloadEntry/UefiPayloadEntry.c                  |  2 ++
UefiPayloadPkg/UefiPayloadEntry/UefiPayloadEntry.h                  | 10 +++++-----
UefiPayloadPkg/UefiPayloadEntry/UniversalPayloadEntry.c             | 20 +++++++++++++-------
16 files changed, 79 insertions(+), 81 deletions(-)
[edk2-devel] [`edk2-devel][PATCH] UefiPayloadPkg: Fix ECC reported issues
Posted by Guo Dong 2 years, 6 months ago
From: Guo Dong <guo.dong@intel.com>

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>
---
 UefiPayloadPkg/Include/Library/BlParseLib.h                         |  8 ++++----
 UefiPayloadPkg/Library/CbParseLib/CbParseLib.c                      | 22 +++++++++++-----------
 UefiPayloadPkg/Library/DxeHobListLibNull/DxeHobListLibNull.c        |  6 ++++++
 UefiPayloadPkg/Library/PayloadEntryHobLib/Hob.c                     | 28 ++--------------------------
 UefiPayloadPkg/Library/PciHostBridgeLib/PciHostBridgeLib.c          |  4 ++--
 UefiPayloadPkg/Library/PciHostBridgeLib/PciHostBridgeSupport.c      | 15 ++++++++++-----
 UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManager.c |  4 ++++
 UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManager.h |  2 +-
 UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformData.c        |  2 +-
 UefiPayloadPkg/Library/ResetSystemLib/ResetSystemLib.c              | 16 ----------------
 UefiPayloadPkg/Library/SblParseLib/SblParseLib.c                    |  2 +-
 UefiPayloadPkg/UefiPayloadEntry/LoadDxeCore.c                       |  2 +-
 UefiPayloadPkg/UefiPayloadEntry/PrintHob.c                          | 17 ++++++++++++++++-
 UefiPayloadPkg/UefiPayloadEntry/UefiPayloadEntry.c                  |  2 ++
 UefiPayloadPkg/UefiPayloadEntry/UefiPayloadEntry.h                  | 10 +++++-----
 UefiPayloadPkg/UefiPayloadEntry/UniversalPayloadEntry.c             | 20 +++++++++++++-------
 16 files changed, 79 insertions(+), 81 deletions(-)

diff --git a/UefiPayloadPkg/Include/Library/BlParseLib.h b/UefiPayloadPkg/Include/Library/BlParseLib.h
index 49eac31248..7aa6d626c7 100644
--- a/UefiPayloadPkg/Include/Library/BlParseLib.h
+++ b/UefiPayloadPkg/Include/Library/BlParseLib.h
@@ -6,6 +6,9 @@
   SPDX-License-Identifier: BSD-2-Clause-Patent
 
 **/
+#ifndef __BOOTLOADER_PARSE_LIB__
+#define __BOOTLOADER_PARSE_LIB__
+
 #include <PiPei.h>
 #include <Guid/GraphicsInfoHob.h>
 #include <Guid/MemoryMapInfoGuid.h>
@@ -13,9 +16,6 @@
 #include <Guid/SystemTableInfoGuid.h>
 #include <Guid/AcpiBoardInfoGuid.h>
 
-#ifndef __BOOTLOADER_PARSE_LIB__
-#define __BOOTLOADER_PARSE_LIB__
-
 #define GET_BOOTLOADER_PARAMETER()      PcdGet64 (PcdBootloaderParameter)
 
 typedef RETURN_STATUS \
@@ -73,7 +73,7 @@ ParseSystemTable (
 /**
   Find the serial port information
 
-  @param  SERIAL_PORT_INFO   Pointer to serial port info structure
+  @param  SerialPortInfo     Pointer to serial port info structure
 
   @retval RETURN_SUCCESS     Successfully find the serial port information.
   @retval RETURN_NOT_FOUND   Failed to find the serial port information .
diff --git a/UefiPayloadPkg/Library/CbParseLib/CbParseLib.c b/UefiPayloadPkg/Library/CbParseLib/CbParseLib.c
index 4be5d66ba5..7b7f39968e 100644
--- a/UefiPayloadPkg/Library/CbParseLib/CbParseLib.c
+++ b/UefiPayloadPkg/Library/CbParseLib/CbParseLib.c
@@ -322,7 +322,7 @@ ParseCbMemTable (
   )
 {
   EFI_STATUS               Status;
-  struct cb_memory         *rec;
+  struct cb_memory         *Rec;
   struct cb_memory_range   *Range;
   UINT64                   Start;
   UINT64                   Size;
@@ -339,13 +339,13 @@ ParseCbMemTable (
   //
   // Get the coreboot memory table
   //
-  rec = (struct cb_memory *)FindCbTag (CB_TAG_MEMORY);
-  if (rec == NULL) {
+  Rec = (struct cb_memory *)FindCbTag (CB_TAG_MEMORY);
+  if (Rec == NULL) {
     return Status;
   }
 
-  for (Index = 0; Index < MEM_RANGE_COUNT(rec); Index++) {
-    Range = MEM_RANGE_PTR(rec, Index);
+  for (Index = 0; Index < MEM_RANGE_COUNT(Rec); Index++) {
+    Range = MEM_RANGE_PTR(Rec, Index);
     Start = cb_unpack64(Range->start);
     Size = cb_unpack64(Range->size);
 
@@ -380,7 +380,7 @@ ParseMemoryInfo (
   IN  VOID                  *Params
   )
 {
-  struct cb_memory         *rec;
+  struct cb_memory         *Rec;
   struct cb_memory_range   *Range;
   UINTN                    Index;
   MEMROY_MAP_ENTRY         MemoryMap;
@@ -388,13 +388,13 @@ ParseMemoryInfo (
   //
   // Get the coreboot memory table
   //
-  rec = (struct cb_memory *)FindCbTag (CB_TAG_MEMORY);
-  if (rec == NULL) {
+  Rec = (struct cb_memory *)FindCbTag (CB_TAG_MEMORY);
+  if (Rec == NULL) {
     return RETURN_NOT_FOUND;
   }
 
-  for (Index = 0; Index < MEM_RANGE_COUNT(rec); Index++) {
-    Range = MEM_RANGE_PTR(rec, Index);
+  for (Index = 0; Index < MEM_RANGE_COUNT(Rec); Index++) {
+    Range = MEM_RANGE_PTR(Rec, Index);
     MemoryMap.Base = cb_unpack64(Range->start);
     MemoryMap.Size = cb_unpack64(Range->size);
     MemoryMap.Type = (UINT8)Range->type;
@@ -449,7 +449,7 @@ ParseSystemTable (
 /**
   Find the serial port information
 
-  @param  SERIAL_PORT_INFO   Pointer to serial port info structure
+  @param  SerialPortInfo     Pointer to serial port info structure
 
   @retval RETURN_SUCCESS     Successfully find the serial port information.
   @retval RETURN_NOT_FOUND   Failed to find the serial port information .
diff --git a/UefiPayloadPkg/Library/DxeHobListLibNull/DxeHobListLibNull.c b/UefiPayloadPkg/Library/DxeHobListLibNull/DxeHobListLibNull.c
index 92d3e17ef0..6c69f9879e 100644
--- a/UefiPayloadPkg/Library/DxeHobListLibNull/DxeHobListLibNull.c
+++ b/UefiPayloadPkg/Library/DxeHobListLibNull/DxeHobListLibNull.c
@@ -10,6 +10,12 @@
 
 #include <Uefi.h>
 
+/**
+  The dummy constructor for DxeHobListLib.
+
+  @retval  EFI_SUCCESS
+
+**/
 EFI_STATUS
 EFIAPI
 DxeHobListLibNullConstructor (
diff --git a/UefiPayloadPkg/Library/PayloadEntryHobLib/Hob.c b/UefiPayloadPkg/Library/PayloadEntryHobLib/Hob.c
index dd25ac2682..61cd11ba03 100644
--- a/UefiPayloadPkg/Library/PayloadEntryHobLib/Hob.c
+++ b/UefiPayloadPkg/Library/PayloadEntryHobLib/Hob.c
@@ -168,31 +168,6 @@ BuildResourceDescriptorHob (
   Hob->ResourceLength    = NumberOfBytes;
 }
 
-VOID
-EFIAPI
-BuildFvHobs (
-  IN EFI_PHYSICAL_ADDRESS         PhysicalStart,
-  IN UINT64                       NumberOfBytes,
-  IN EFI_RESOURCE_ATTRIBUTE_TYPE  *ResourceAttribute
-  )
-{
-
-  EFI_RESOURCE_ATTRIBUTE_TYPE Resource;
-
-  BuildFvHob (PhysicalStart, NumberOfBytes);
-
-  if (ResourceAttribute == NULL) {
-    Resource = (EFI_RESOURCE_ATTRIBUTE_PRESENT    |
-                EFI_RESOURCE_ATTRIBUTE_INITIALIZED |
-                EFI_RESOURCE_ATTRIBUTE_TESTED |
-                EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE);
-  } else {
-    Resource = *ResourceAttribute;
-  }
-
-  BuildResourceDescriptorHob (EFI_RESOURCE_FIRMWARE_DEVICE, Resource, PhysicalStart, NumberOfBytes);
-}
-
 /**
   Returns the next instance of a HOB type from the starting HOB.
 
@@ -283,7 +258,8 @@ EFIAPI
 GetNextGuidHob (
   IN CONST EFI_GUID         *Guid,
   IN CONST VOID             *HobStart
-  ){
+  )
+{
   EFI_PEI_HOB_POINTERS  GuidHob;
 
   GuidHob.Raw = (UINT8 *) HobStart;
diff --git a/UefiPayloadPkg/Library/PciHostBridgeLib/PciHostBridgeLib.c b/UefiPayloadPkg/Library/PciHostBridgeLib/PciHostBridgeLib.c
index a0d7cdc306..0eddebe229 100644
--- a/UefiPayloadPkg/Library/PciHostBridgeLib/PciHostBridgeLib.c
+++ b/UefiPayloadPkg/Library/PciHostBridgeLib/PciHostBridgeLib.c
@@ -210,8 +210,8 @@ PciHostBridgeGetRootBridges (
   Free the root bridge instances array returned from
   PciHostBridgeGetRootBridges().
 
-  @param  The root bridge instances array.
-  @param  The count of the array.
+  @param  Bridges    The root bridge instances array.
+  @param  Count      The count of the array.
 **/
 VOID
 EFIAPI
diff --git a/UefiPayloadPkg/Library/PciHostBridgeLib/PciHostBridgeSupport.c b/UefiPayloadPkg/Library/PciHostBridgeLib/PciHostBridgeSupport.c
index b0268f0506..eb28d48b3b 100644
--- a/UefiPayloadPkg/Library/PciHostBridgeLib/PciHostBridgeSupport.c
+++ b/UefiPayloadPkg/Library/PciHostBridgeLib/PciHostBridgeSupport.c
@@ -205,7 +205,7 @@ PcatPciRootBridgeParseBars (
       //
       // IO Bar
       //
-      if (Command & EFI_PCI_COMMAND_IO_SPACE) {
+      if ((Command & EFI_PCI_COMMAND_IO_SPACE) != 0) {
         Mask = 0xfffffffc;
         Base = OriginalValue & Mask;
         Length = ((~(Value & Mask)) & Mask) + 0x04;
@@ -227,7 +227,7 @@ PcatPciRootBridgeParseBars (
       //
       // Mem Bar
       //
-      if (Command & EFI_PCI_COMMAND_MEMORY_SPACE) {
+      if ((Command & EFI_PCI_COMMAND_MEMORY_SPACE) != 0) {
 
         Mask = 0xfffffff0;
         Base = OriginalValue & Mask;
@@ -306,9 +306,14 @@ ScanForRootBridges (
   UINT64     Base;
   UINT64     Limit;
   UINT64     Value;
-  PCI_ROOT_BRIDGE_APERTURE Io, Mem, MemAbove4G, PMem, PMemAbove4G, *MemAperture;
-  PCI_ROOT_BRIDGE *RootBridges;
-  UINTN      BarOffsetEnd;
+  PCI_ROOT_BRIDGE_APERTURE Io;
+  PCI_ROOT_BRIDGE_APERTURE Mem;
+  PCI_ROOT_BRIDGE_APERTURE MemAbove4G;
+  PCI_ROOT_BRIDGE_APERTURE PMem;
+  PCI_ROOT_BRIDGE_APERTURE PMemAbove4G;
+  PCI_ROOT_BRIDGE_APERTURE *MemAperture;
+  PCI_ROOT_BRIDGE          *RootBridges;
+  UINTN                    BarOffsetEnd;
 
 
   *NumberOfRootBridges = 0;
diff --git a/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManager.c b/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManager.c
index c4d317fa9e..dd91fcb29d 100644
--- a/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManager.c
+++ b/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManager.c
@@ -15,6 +15,10 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 
 UNIVERSAL_PAYLOAD_PLATFORM_BOOT_MANAGER_OVERRIDE_PROTOCOL  *mUniversalPayloadPlatformBootManagerOverrideInstance = NULL;
 
+/**
+  Signal EndOfDxe event and install SMM Ready to lock protocol.
+
+**/
 VOID
 InstallReadyToLock (
   VOID
diff --git a/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManager.h b/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManager.h
index 2f600c796f..cad7fe2b9d 100644
--- a/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManager.h
+++ b/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManager.h
@@ -1,4 +1,4 @@
-/**@file
+/** @file
    Head file for BDS Platform specific code
 
 Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>
diff --git a/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformData.c b/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformData.c
index d17e660e0f..892a7f01be 100644
--- a/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformData.c
+++ b/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformData.c
@@ -1,4 +1,4 @@
-/**@file
+/** @file
   Defined the platform specific device path which will be filled to
   ConIn/ConOut variables.
 
diff --git a/UefiPayloadPkg/Library/ResetSystemLib/ResetSystemLib.c b/UefiPayloadPkg/Library/ResetSystemLib/ResetSystemLib.c
index 2e4b7fe592..b35a4cc1d9 100644
--- a/UefiPayloadPkg/Library/ResetSystemLib/ResetSystemLib.c
+++ b/UefiPayloadPkg/Library/ResetSystemLib/ResetSystemLib.c
@@ -43,22 +43,6 @@ ResetSystemLibConstructor (
   return EFI_SUCCESS;
 }
 
-
-VOID
-AcpiPmControl (
-  UINTN   SuspendType
-  )
-{
-  UINTN              PmCtrlReg;
-
-  ASSERT (SuspendType <= 7);
-
-  PmCtrlReg = (UINTN)mAcpiBoardInfo.PmCtrlRegBase;
-  IoAndThenOr16 (PmCtrlReg, (UINT16) ~0x3c00, (UINT16) (SuspendType << 10));
-  IoOr16 (PmCtrlReg, BIT13);
-  CpuDeadLoop ();
-}
-
 /**
   Calling this function causes a system-wide reset. This sets
   all circuitry within the system to its initial state. This type of reset
diff --git a/UefiPayloadPkg/Library/SblParseLib/SblParseLib.c b/UefiPayloadPkg/Library/SblParseLib/SblParseLib.c
index ccdcbfc07d..fc6b1b9a16 100644
--- a/UefiPayloadPkg/Library/SblParseLib/SblParseLib.c
+++ b/UefiPayloadPkg/Library/SblParseLib/SblParseLib.c
@@ -141,7 +141,7 @@ ParseSystemTable (
 /**
   Find the serial port information
 
-  @param  SERIAL_PORT_INFO   Pointer to serial port info structure
+  @param[out]  SerialPortInfo     Pointer to serial port info structure
 
   @retval RETURN_SUCCESS     Successfully find the serial port information.
   @retval RETURN_NOT_FOUND   Failed to find the serial port information .
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 0e6dcf10f9..adc56dc15f 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
-- 
2.32.0.windows.2



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#82155): https://edk2.groups.io/g/devel/message/82155
Mute This Topic: https://groups.io/mt/86359287/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-