[platforms: PATCH v3 21/25] Marvell/Drivers: MvMdioDxe: Switch driver to use MARVELL_BOARD_DESC

[Marcin Wojtas <mw@semihalf.com>]

MvMdioDxe driver used to get Armada7k8k controller description
from hardcoded values stored in the header file MvHwDescLib.h.
As a result it is very hard to support other
Armada SoC families with this driver.

This patch updates the driver, so that it can obtain the
description from newly introduced MARVELL_BOARD_DESC protocol,
and removes the dependency on the hardcoded 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/Net/MvMdioDxe/MvMdioDxe.inf |  1 +
 Silicon/Marvell/Include/Library/MvHwDescLib.h       | 23 -------------
 Silicon/Marvell/Include/Protocol/Mdio.h             |  4 +--
 Silicon/Marvell/Drivers/Net/MvMdioDxe/MvMdioDxe.c   | 35 ++++++++++++++++----
 4 files changed, 31 insertions(+), 32 deletions(-)

diff --git a/Silicon/Marvell/Drivers/Net/MvMdioDxe/MvMdioDxe.inf b/Silicon/Marvell/Drivers/Net/MvMdioDxe/MvMdioDxe.inf
index c070785..739576f 100644
--- a/Silicon/Marvell/Drivers/Net/MvMdioDxe/MvMdioDxe.inf
+++ b/Silicon/Marvell/Drivers/Net/MvMdioDxe/MvMdioDxe.inf
@@ -60,6 +60,7 @@
   UefiLib
 
 [Protocols]
+  gMarvellBoardDescProtocolGuid
   gMarvellMdioProtocolGuid
 
 [Depex]
diff --git a/Silicon/Marvell/Include/Library/MvHwDescLib.h b/Silicon/Marvell/Include/Library/MvHwDescLib.h
index 423ca17..0de435d 100644
--- a/Silicon/Marvell/Include/Library/MvHwDescLib.h
+++ b/Silicon/Marvell/Include/Library/MvHwDescLib.h
@@ -53,16 +53,6 @@ typedef struct {
 } MVHW_I2C_DESC;
 
 //
-// MDIO devices description template definition
-//
-#define MVHW_MAX_MDIO_DEVS         2
-
-typedef struct {
-  UINT8 MdioDevCount;
-  UINTN MdioBaseAddresses[MVHW_MAX_MDIO_DEVS];
-} MVHW_MDIO_DESC;
-
-//
 // Platform description of I2C devices
 //
 #define MVHW_CP0_I2C0_BASE       0xF2701000
@@ -77,17 +67,4 @@ MVHW_I2C_DESC mA7k8kI2cDescTemplate = {\
   { MVHW_CP0_I2C0_BASE, MVHW_CP0_I2C1_BASE, MVHW_CP1_I2C0_BASE, MVHW_CP1_I2C1_BASE }\
 }
 
-//
-// Platform description of MDIO devices
-//
-#define MVHW_CP0_MDIO_BASE       0xF212A200
-#define MVHW_CP1_MDIO_BASE       0xF412A200
-
-#define DECLARE_A7K8K_MDIO_TEMPLATE \
-STATIC \
-MVHW_MDIO_DESC mA7k8kMdioDescTemplate = {\
-  2,\
-  { MVHW_CP0_MDIO_BASE, MVHW_CP1_MDIO_BASE }\
-}
-
 #endif /* __MVHWDESCLIB_H__ */
diff --git a/Silicon/Marvell/Include/Protocol/Mdio.h b/Silicon/Marvell/Include/Protocol/Mdio.h
index d077a8f..076ea26 100644
--- a/Silicon/Marvell/Include/Protocol/Mdio.h
+++ b/Silicon/Marvell/Include/Protocol/Mdio.h
@@ -35,8 +35,6 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #ifndef __MDIO_H__
 #define __MDIO_H__
 
-#include <Library/MvHwDescLib.h>
-
 #define MARVELL_MDIO_PROTOCOL_GUID { 0x40010b03, 0x5f08, 0x496a, { 0xa2, 0x64, 0x10, 0x5e, 0x72, 0xd3, 0x71, 0xaa }}
 
 typedef struct _MARVELL_MDIO_PROTOCOL MARVELL_MDIO_PROTOCOL;
@@ -64,7 +62,7 @@ EFI_STATUS
 struct _MARVELL_MDIO_PROTOCOL {
   MARVELL_MDIO_READ Read;
   MARVELL_MDIO_WRITE Write;
-  UINTN BaseAddresses[MVHW_MAX_MDIO_DEVS];
+  UINTN *BaseAddresses;
   UINTN ControllerCount;
 };
 
diff --git a/Silicon/Marvell/Drivers/Net/MvMdioDxe/MvMdioDxe.c b/Silicon/Marvell/Drivers/Net/MvMdioDxe/MvMdioDxe.c
index 6c0a129..72e88bd 100644
--- a/Silicon/Marvell/Drivers/Net/MvMdioDxe/MvMdioDxe.c
+++ b/Silicon/Marvell/Drivers/Net/MvMdioDxe/MvMdioDxe.c
@@ -32,6 +32,7 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 *******************************************************************************/
 
+#include <Protocol/BoardDesc.h>
 #include <Protocol/DriverBinding.h>
 #include <Protocol/Mdio.h>
 
@@ -46,8 +47,6 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 #include "MvMdioDxe.h"
 
-DECLARE_A7K8K_MDIO_TEMPLATE;
-
 STATIC
 EFI_STATUS
 MdioCheckParam (
@@ -216,24 +215,46 @@ MvMdioDxeInitialise (
   IN EFI_SYSTEM_TABLE  *SystemTable
   )
 {
-  MVHW_MDIO_DESC *Desc = &mA7k8kMdioDescTemplate;
+  MARVELL_BOARD_DESC_PROTOCOL *BoardDescProtocol;
+  MV_BOARD_MDIO_DESC *MdioBoardDesc;
   UINT8 Index;
   MARVELL_MDIO_PROTOCOL *Mdio;
   EFI_STATUS Status;
   EFI_HANDLE Handle = NULL;
 
+  /* Obtain list of available controllers */
+  Status = gBS->LocateProtocol (&gMarvellBoardDescProtocolGuid,
+                  NULL,
+                  (VOID **)&BoardDescProtocol);
+  if (EFI_ERROR (Status)) {
+    return Status;
+  }
+
+  Status = BoardDescProtocol->BoardDescMdioGet (BoardDescProtocol,
+                                &MdioBoardDesc);
+  if (EFI_ERROR (Status)) {
+    return Status;
+  }
+
   Mdio = AllocateZeroPool (sizeof (MARVELL_MDIO_PROTOCOL));
   if (Mdio == NULL) {
     DEBUG ((DEBUG_ERROR, "MdioDxe: Protocol allocation failed\n"));
     return EFI_OUT_OF_RESOURCES;
   }
 
+  Mdio->BaseAddresses = AllocateZeroPool (MdioBoardDesc->MdioDevCount *
+                                          sizeof (UINTN));
+  if (Mdio->BaseAddresses == NULL) {
+    DEBUG ((DEBUG_ERROR, "MdioDxe: Protocol allocation failed\n"));
+    return EFI_OUT_OF_RESOURCES;
+  }
+
   /* Obtain base addresses of all possible controllers */
-  for (Index = 0; Index < Desc->MdioDevCount; Index++) {
-    Mdio->BaseAddresses[Index] = Desc->MdioBaseAddresses[Index];
+  for (Index = 0; Index < MdioBoardDesc->MdioDevCount; Index++) {
+    Mdio->BaseAddresses[Index] = MdioBoardDesc[Index].SoC->MdioBaseAddress;
   }
 
-  Mdio->ControllerCount = Desc->MdioDevCount;
+  Mdio->ControllerCount = MdioBoardDesc->MdioDevCount;
   Mdio->Read = MvMdioRead;
   Mdio->Write = MvMdioWrite;
 
@@ -248,5 +269,7 @@ MvMdioDxeInitialise (
     return Status;
   }
 
+  BoardDescProtocol->BoardDescFree (MdioBoardDesc);
+
   return EFI_SUCCESS;
 }
-- 
2.7.4