[edk2-devel] [PATCH 1/3] UefiPayloadPkg: Simplify code logic

Zhiguang Liu posted 3 patches 3 years, 9 months ago
There is a newer version of this series
[edk2-devel] [PATCH 1/3] UefiPayloadPkg: Simplify code logic
Posted by Zhiguang Liu 3 years, 9 months ago
A little overdesign about VisitAllPciInstances function, since there are
two call back functions. Simplify the code logic by combining the two call
back functions.

Cc: 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>
Cc: Sean Rhodes <sean@starlabs.systems>
Signed-off-by: Zhiguang Liu <zhiguang.liu@intel.com>
---
 .../PlatformBootManagerLib/PlatformConsole.c  | 83 +++++--------------
 1 file changed, 21 insertions(+), 62 deletions(-)

diff --git a/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformConsole.c b/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformConsole.c
index bfaf89e74c..9887183624 100644
--- a/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformConsole.c
+++ b/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformConsole.c
@@ -387,18 +387,20 @@ VisitAllInstancesOfProtocol (
 }
 
 /**
-  For every PCI instance execute a callback function.
+  Do platform specific PCI Device check and add them to
+  ConOut, ConIn, ErrOut.
 
-  @param[in]  Handle     - The PCI device handle
-  @param[in]  Instance   - The instance of the PciIo protocol
-  @param[in]  Context    - The context of the callback
+  @param[in]  Handle    - Handle of PCI device instance
+  @param[in]  Instance  - The instance of PCI device
+  @param[in]  Context   - The context of the callback
 
-  @retval EFI_STATUS - Callback function failed.
+  @retval EFI_SUCCESS - PCI Device check and Console variable update successfully.
+  @retval EFI_STATUS - PCI Device check or Console variable update fail.
 
 **/
 EFI_STATUS
 EFIAPI
-VisitingAPciInstance (
+DetectAndPreparePlatformPciDevicePath (
   IN EFI_HANDLE  Handle,
   IN VOID        *Instance,
   IN VOID        *Context
@@ -424,56 +426,6 @@ VisitingAPciInstance (
     return Status;
   }
 
-  return (*(VISIT_PCI_INSTANCE_CALLBACK)(UINTN)Context)(
-  Handle,
-  PciIo,
-  &Pci
-  );
-}
-
-/**
-  For every PCI instance execute a callback function.
-
-  @param[in]  CallBackFunction - Callback function pointer
-
-  @retval EFI_STATUS - Callback function failed.
-
-**/
-EFI_STATUS
-EFIAPI
-VisitAllPciInstances (
-  IN VISIT_PCI_INSTANCE_CALLBACK  CallBackFunction
-  )
-{
-  return VisitAllInstancesOfProtocol (
-           &gEfiPciIoProtocolGuid,
-           VisitingAPciInstance,
-           (VOID *)(UINTN)CallBackFunction
-           );
-}
-
-/**
-  Do platform specific PCI Device check and add them to
-  ConOut, ConIn, ErrOut.
-
-  @param[in]  Handle - Handle of PCI device instance
-  @param[in]  PciIo - PCI IO protocol instance
-  @param[in]  Pci - PCI Header register block
-
-  @retval EFI_SUCCESS - PCI Device check and Console variable update successfully.
-  @retval EFI_STATUS - PCI Device check or Console variable update fail.
-
-**/
-EFI_STATUS
-EFIAPI
-DetectAndPreparePlatformPciDevicePath (
-  IN EFI_HANDLE           Handle,
-  IN EFI_PCI_IO_PROTOCOL  *PciIo,
-  IN PCI_TYPE00           *Pci
-  )
-{
-  EFI_STATUS  Status;
-
   Status = PciIo->Attributes (
                     PciIo,
                     EfiPciIoAttributeOperationEnable,
@@ -486,9 +438,9 @@ DetectAndPreparePlatformPciDevicePath (
     //
     // Here we decide whether it is LPC Bridge
     //
-    if ((IS_PCI_LPC (Pci)) ||
-        ((IS_PCI_ISA_PDECODE (Pci)) &&
-         (Pci->Hdr.VendorId == 0x8086)
+    if ((IS_PCI_LPC (&Pci)) ||
+        ((IS_PCI_ISA_PDECODE (&Pci)) &&
+         (Pci.Hdr.VendorId == 0x8086)
         )
         )
     {
@@ -504,7 +456,7 @@ DetectAndPreparePlatformPciDevicePath (
     //
     // Here we decide which Serial device to enable in PCI bus
     //
-    if (IS_PCI_16550SERIAL (Pci)) {
+    if (IS_PCI_16550SERIAL (&Pci)) {
       //
       // Add them to ConOut, ConIn, ErrOut.
       //
@@ -517,7 +469,7 @@ DetectAndPreparePlatformPciDevicePath (
   //
   // Enable all display devices
   //
-  if (IS_PCI_DISPLAY (Pci)) {
+  if (IS_PCI_DISPLAY (&Pci)) {
     //
     // Add them to ConOut.
     //
@@ -543,6 +495,8 @@ DetectAndPreparePlatformPciDevicePaths (
   BOOLEAN  DetectDisplayOnly
   )
 {
+  EFI_STATUS  Status;
+
   mDetectDisplayOnly = DetectDisplayOnly;
 
   EfiBootManagerUpdateConsoleVariable (
@@ -551,7 +505,12 @@ DetectAndPreparePlatformPciDevicePaths (
     NULL
     );
 
-  return VisitAllPciInstances (DetectAndPreparePlatformPciDevicePath);
+  Status = VisitAllInstancesOfProtocol (
+             &gEfiPciIoProtocolGuid,
+             DetectAndPreparePlatformPciDevicePath,
+             NULL
+             );
+  return Status;
 }
 
 /**
-- 
2.32.0.windows.2



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#89637): https://edk2.groups.io/g/devel/message/89637
Mute This Topic: https://groups.io/mt/91007797/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] [PATCH 1/3] UefiPayloadPkg: Simplify code logic
Posted by Ni, Ray 3 years, 9 months ago
> 
> +DetectAndPreparePlatformPciDevicePath (
> 
>    IN EFI_HANDLE  Handle,
> 
>    IN VOID        *Instance,
> 
>    IN VOID        *Context

Is "Context" needed? Can you please remove it?



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#89646): https://edk2.groups.io/g/devel/message/89646
Mute This Topic: https://groups.io/mt/91007797/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] [PATCH 1/3] UefiPayloadPkg: Simplify code logic
Posted by Zhiguang Liu 3 years, 9 months ago
Hi Ray,
The function DetectAndPreparePlatformPciDevicePath is the second parameter of VisitAllInstancesOfProtocol.
It follows the below type:
typedef
EFI_STATUS
(EFIAPI *PROTOCOL_INSTANCE_CALLBACK)(
  IN EFI_HANDLE            Handle,
  IN VOID                 *Instance,
  IN VOID                 *Context
  );

The same function pointer type is also defined in OvmfPkg.
I didn't change the function pointer type to avoid same type having different definition in edk2 repo.
Do I need to consider that? What's your suggestion?

Thanks
Zhiguang


-----Original Message-----
From: Ni, Ray <ray.ni@intel.com> 
Sent: Tuesday, May 10, 2022 3:39 PM
To: Liu, Zhiguang <zhiguang.liu@intel.com>; devel@edk2.groups.io
Cc: Dong, Guo <guo.dong@intel.com>; Maurice Ma <maurice.ma@intel.com>; You, Benjamin <benjamin.you@intel.com>; Rhodes, Sean <sean@starlabs.systems>
Subject: RE: [PATCH 1/3] UefiPayloadPkg: Simplify code logic

> 
> +DetectAndPreparePlatformPciDevicePath (
> 
>    IN EFI_HANDLE  Handle,
> 
>    IN VOID        *Instance,
> 
>    IN VOID        *Context

Is "Context" needed? Can you please remove it?



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