[platforms: PATCH v3 09/25] Marvell/Drivers: MvBoardDesc: Extend protocol with PP2 support

[Marcin Wojtas <mw@semihalf.com>]

Introduce new callback that can provide information
about PP2 NICs to the Pp2Dxe driver.

Extend ArmadaBoardDescLib with new structure MV_BOARD_PP2_DESC,
for holding board specific data. In further steps it should
be extended and replace PCD port's representation with the
appropriate structures.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Marcin Wojtas <mw@semihalf.com>
Reviewed-by: Leif Lindholm <leif.lindholm@linaro.org>
---
 Silicon/Marvell/Drivers/BoardDesc/MvBoardDescDxe.inf |  1 +
 Silicon/Marvell/Include/Library/ArmadaBoardDescLib.h |  8 +++
 Silicon/Marvell/Include/Protocol/BoardDesc.h         |  8 +++
 Silicon/Marvell/Drivers/BoardDesc/MvBoardDescDxe.c   | 63 ++++++++++++++++++++
 4 files changed, 80 insertions(+)

diff --git a/Silicon/Marvell/Drivers/BoardDesc/MvBoardDescDxe.inf b/Silicon/Marvell/Drivers/BoardDesc/MvBoardDescDxe.inf
index 5da5f21..6f57f06 100644
--- a/Silicon/Marvell/Drivers/BoardDesc/MvBoardDescDxe.inf
+++ b/Silicon/Marvell/Drivers/BoardDesc/MvBoardDescDxe.inf
@@ -58,6 +58,7 @@
 
 [Pcd]
   gMarvellTokenSpaceGuid.PcdPciEXhci
+  gMarvellTokenSpaceGuid.PcdPp2Controllers
   gMarvellTokenSpaceGuid.PcdUtmiControllersEnabled
   gMarvellTokenSpaceGuid.PcdUtmiPortType
 
diff --git a/Silicon/Marvell/Include/Library/ArmadaBoardDescLib.h b/Silicon/Marvell/Include/Library/ArmadaBoardDescLib.h
index 068535a..ab94877 100644
--- a/Silicon/Marvell/Include/Library/ArmadaBoardDescLib.h
+++ b/Silicon/Marvell/Include/Library/ArmadaBoardDescLib.h
@@ -17,6 +17,14 @@
 #include <Library/ArmadaSoCDescLib.h>
 
 //
+// PP2 NIC devices per-board description
+//
+typedef struct {
+  MV_SOC_PP2_DESC *SoC;
+  UINT8            Pp2DevCount;
+} MV_BOARD_PP2_DESC;
+
+//
 // UTMI PHY devices per-board description
 //
 typedef struct {
diff --git a/Silicon/Marvell/Include/Protocol/BoardDesc.h b/Silicon/Marvell/Include/Protocol/BoardDesc.h
index f8a2902..114a0ec 100644
--- a/Silicon/Marvell/Include/Protocol/BoardDesc.h
+++ b/Silicon/Marvell/Include/Protocol/BoardDesc.h
@@ -43,6 +43,13 @@ typedef struct _MARVELL_BOARD_DESC_PROTOCOL MARVELL_BOARD_DESC_PROTOCOL;
 
 typedef
 EFI_STATUS
+(EFIAPI *MV_BOARD_DESC_PP2_GET) (
+  IN MARVELL_BOARD_DESC_PROTOCOL  *This,
+  IN OUT MV_BOARD_PP2_DESC       **Pp2Desc
+  );
+
+typedef
+EFI_STATUS
 (EFIAPI *MV_BOARD_DESC_UTMI_GET) (
   IN MARVELL_BOARD_DESC_PROTOCOL  *This,
   IN OUT MV_BOARD_UTMI_DESC      **UtmiDesc
@@ -55,6 +62,7 @@ VOID
   );
 
 struct _MARVELL_BOARD_DESC_PROTOCOL {
+  MV_BOARD_DESC_PP2_GET          BoardDescPp2Get;
   MV_BOARD_DESC_UTMI_GET         BoardDescUtmiGet;
   MV_BOARD_DESC_FREE             BoardDescFree;
 };
diff --git a/Silicon/Marvell/Drivers/BoardDesc/MvBoardDescDxe.c b/Silicon/Marvell/Drivers/BoardDesc/MvBoardDescDxe.c
index 0232a21..7c0bc39 100644
--- a/Silicon/Marvell/Drivers/BoardDesc/MvBoardDescDxe.c
+++ b/Silicon/Marvell/Drivers/BoardDesc/MvBoardDescDxe.c
@@ -37,6 +37,68 @@ MV_BOARD_DESC *mBoardDescInstance;
 
 STATIC
 EFI_STATUS
+MvBoardDescPp2Get (
+  IN MARVELL_BOARD_DESC_PROTOCOL  *This,
+  IN OUT MV_BOARD_PP2_DESC       **Pp2Desc
+  )
+{
+  UINT8 *Pp2DeviceEnabled;
+  UINTN Pp2Count, Pp2DeviceTableSize, Pp2Index, Index;
+  MV_BOARD_PP2_DESC *BoardDesc;
+  MV_SOC_PP2_DESC *SoCDesc;
+  EFI_STATUS Status;
+
+  /* Get SoC data about all available PP2 controllers */
+  Status = ArmadaSoCDescPp2Get (&SoCDesc, &Pp2Count);
+  if (EFI_ERROR (Status)) {
+    return Status;
+  }
+
+  /*
+   * Obtain table with enabled Pp2 controllers,
+   * which is represented as an array of UINT8 values
+   * (0x0 - disabled, 0x1 enabled).
+   */
+  Pp2DeviceEnabled = PcdGetPtr (PcdPp2Controllers);
+  if (Pp2DeviceEnabled == NULL) {
+    /* No PP2 NIC on platform */
+    return EFI_SUCCESS;
+  }
+
+  Pp2DeviceTableSize = PcdGetSize (PcdPp2Controllers);
+
+  /* Check if PCD with PP2 NICs is correctly defined */
+  if (Pp2DeviceTableSize > Pp2Count) {
+    DEBUG ((DEBUG_ERROR, "%a: Wrong PcdPp2Controllers format\n", __FUNCTION__));
+    return EFI_INVALID_PARAMETER;
+  }
+
+  /* Allocate and fill board description */
+  BoardDesc = AllocateZeroPool (Pp2DeviceTableSize * sizeof (MV_BOARD_PP2_DESC));
+  if (BoardDesc == NULL) {
+    DEBUG ((DEBUG_ERROR, "%a: Cannot allocate memory\n", __FUNCTION__));
+    return EFI_OUT_OF_RESOURCES;
+  }
+
+  Pp2Index = 0;
+  for (Index = 0; Index < Pp2DeviceTableSize; Index++) {
+    if (!Pp2DeviceEnabled[Index]) {
+      continue;
+    }
+
+    BoardDesc[Pp2Index].SoC = &SoCDesc[Index];
+    Pp2Index++;
+  }
+
+  BoardDesc->Pp2DevCount = Pp2Index;
+
+  *Pp2Desc = BoardDesc;
+
+  return EFI_SUCCESS;
+}
+
+STATIC
+EFI_STATUS
 MvBoardDescUtmiGet (
   IN MARVELL_BOARD_DESC_PROTOCOL  *This,
   IN OUT MV_BOARD_UTMI_DESC      **UtmiDesc
@@ -140,6 +202,7 @@ MvBoardDescInitProtocol (
   IN MARVELL_BOARD_DESC_PROTOCOL *BoardDescProtocol
   )
 {
+  BoardDescProtocol->BoardDescPp2Get = MvBoardDescPp2Get;
   BoardDescProtocol->BoardDescUtmiGet = MvBoardDescUtmiGet;
   BoardDescProtocol->BoardDescFree = MvBoardDescFree;
 
-- 
2.7.4