From 33ac45661ada95134cc2fcd266f89da391c86b93 Mon Sep 17 00:00:00 2001
From: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Date: Tue, 12 Apr 2016 14:21:03 +0200
Subject: [PATCH] ArmVirtPkg: implement FdtPciPcdProducerLib

This implements a library FdtPciPcdProducerLib which is intended to
be incorporated into modules that consume the PCI related dynamic PCDs
PcdPciExpressBaseAddress and PcdPciDisableBusEnumeration, either via NULL
library class resolution or via a direct dependency (for other libraries
or modules in ArmVirtPkg). This allows us to make them depend on the FDT
client protocol, and populate these PCDs based on the presence and the
contents of a 'pci-host-ecam-generic' DT node.

This also overloads the meaning of PcdPciExpressBaseAddress, which we will
set to MAX_UINT64 to signify that the actual values of these two PCDs have
not been assigned yet.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
---
 .../FdtPciPcdProducerLib.c                    | 62 +++++++++++++++++++
 .../FdtPciPcdProducerLib.inf                  | 47 ++++++++++++++
 2 files changed, 109 insertions(+)
 create mode 100644 ArmVirtPkg/Library/FdtPciPcdProducerLib/FdtPciPcdProducerLib.c
 create mode 100644 ArmVirtPkg/Library/FdtPciPcdProducerLib/FdtPciPcdProducerLib.inf

diff --git a/ArmVirtPkg/Library/FdtPciPcdProducerLib/FdtPciPcdProducerLib.c b/ArmVirtPkg/Library/FdtPciPcdProducerLib/FdtPciPcdProducerLib.c
new file mode 100644
index 0000000000..cc60940d48
--- /dev/null
+++ b/ArmVirtPkg/Library/FdtPciPcdProducerLib/FdtPciPcdProducerLib.c
@@ -0,0 +1,62 @@
+/** @file
+  FDT client library for consumers of PCI related dynamic PCDs
+
+  Copyright (c) 2016, Linaro Ltd. All rights reserved.<BR>
+
+  This program and the accompanying materials
+  are licensed and made available under the terms and conditions of the BSD License
+  which accompanies this distribution.  The full text of the license may be found at
+  http://opensource.org/licenses/bsd-license.php
+
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+**/
+
+#include <Uefi.h>
+
+#include <Library/BaseLib.h>
+#include <Library/DebugLib.h>
+#include <Library/PcdLib.h>
+#include <Library/UefiBootServicesTableLib.h>
+
+#include <Protocol/FdtClient.h>
+
+RETURN_STATUS
+EFIAPI
+FdtPciPcdProducerLibConstructor (
+  VOID
+  )
+{
+  UINT64              PciExpressBaseAddress;
+  FDT_CLIENT_PROTOCOL *FdtClient;
+  CONST UINT64        *Reg;
+  UINT32              RegElemSize, RegSize;
+  EFI_STATUS          Status;
+
+  PciExpressBaseAddress = PcdGet64 (PcdPciExpressBaseAddress);
+  if (PciExpressBaseAddress != MAX_UINT64) {
+    return EFI_SUCCESS;
+  }
+
+  Status = gBS->LocateProtocol (&gFdtClientProtocolGuid, NULL,
+                  (VOID **)&FdtClient);
+  ASSERT_EFI_ERROR (Status);
+
+  Status = FdtClient->FindCompatibleNodeReg (FdtClient,
+                        "pci-host-ecam-generic", (CONST VOID **)&Reg,
+                        &RegElemSize, &RegSize);
+
+  if (EFI_ERROR (Status)) {
+    PciExpressBaseAddress = 0;
+  } else {
+    ASSERT (RegElemSize == sizeof (UINT64));
+    PciExpressBaseAddress = SwapBytes64 (*Reg);
+
+    PcdSetBool (PcdPciDisableBusEnumeration, FALSE);
+  }
+
+  PcdSet64 (PcdPciExpressBaseAddress, PciExpressBaseAddress);
+
+  return RETURN_SUCCESS;
+}
diff --git a/ArmVirtPkg/Library/FdtPciPcdProducerLib/FdtPciPcdProducerLib.inf b/ArmVirtPkg/Library/FdtPciPcdProducerLib/FdtPciPcdProducerLib.inf
new file mode 100644
index 0000000000..1ba71abea7
--- /dev/null
+++ b/ArmVirtPkg/Library/FdtPciPcdProducerLib/FdtPciPcdProducerLib.inf
@@ -0,0 +1,47 @@
+#/** @file
+#  FDT client library for consumers of PCI related dynamic PCDs
+#
+#  Copyright (c) 2016, Linaro Ltd. All rights reserved.
+#
+#  This program and the accompanying materials
+#  are licensed and made available under the terms and conditions of the BSD License
+#  which accompanies this distribution. The full text of the license may be found at
+#  http://opensource.org/licenses/bsd-license.php
+#
+#  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+#
+#**/
+
+[Defines]
+  INF_VERSION                    = 0x00010005
+  BASE_NAME                      = FdtPciPcdProducerLib
+  FILE_GUID                      = D584275B-BF1E-4DF8-A53D-980F5645C5E7
+  MODULE_TYPE                    = BASE
+  VERSION_STRING                 = 1.0
+  LIBRARY_CLASS                  = PciPcdProducerLib|DXE_DRIVER UEFI_DRIVER
+  CONSTRUCTOR                    = FdtPciPcdProducerLibConstructor
+
+[Sources]
+  FdtPciPcdProducerLib.c
+
+[Packages]
+  ArmVirtPkg/ArmVirtPkg.dec
+  MdeModulePkg/MdeModulePkg.dec
+  MdePkg/MdePkg.dec
+
+[LibraryClasses]
+  BaseLib
+  DebugLib
+  PcdLib
+  UefiBootServicesTableLib
+
+[Protocols]
+  gFdtClientProtocolGuid                                      ## CONSUMES
+
+[Pcd]
+  gEfiMdePkgTokenSpaceGuid.PcdPciExpressBaseAddress           ## PRODUCES
+  gEfiMdeModulePkgTokenSpaceGuid.PcdPciDisableBusEnumeration  ## PRODUCES
+
+[Depex]
+  gFdtClientProtocolGuid