Platform/SynQuacerEvalBoard: add eMMC driver stack

Add the drivers required to use the onboard eMMC on the SynQuacer
Evaluation Board.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

7 files changed, 266 insertions, 8 deletions

diff --git a/Platform/Socionext/DeveloperBox/DeveloperBox.dsc b/Platform/Socionext/DeveloperBox/DeveloperBox.dsc
index cd4eb79..1a09f72 100644
--- a/Platform/Socionext/DeveloperBox/DeveloperBox.dsc
+++ b/Platform/Socionext/DeveloperBox/DeveloperBox.dsc
@@ -177,6 +177,7 @@
   #

   PciSegmentLib|Silicon/Socionext/SynQuacer/Library/SynQuacerPciSegmentLib/SynQuacerPciSegmentLib.inf

   PciHostBridgeLib|Silicon/Socionext/SynQuacer/Library/SynQuacerPciHostBridgeLib/SynQuacerPciHostBridgeLib.inf

+  NonDiscoverableDeviceRegistrationLib|MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.inf

 

 [LibraryClasses.common.UEFI_APPLICATION]

   PerformanceLib|MdeModulePkg/Library/DxePerformanceLib/DxePerformanceLib.inf

diff --git a/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc b/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc
index 4034bcf..20b7197 100644
--- a/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc
+++ b/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc
@@ -176,6 +176,7 @@
   #

   PciSegmentLib|Silicon/Socionext/SynQuacer/Library/SynQuacerPciSegmentLib/SynQuacerPciSegmentLib.inf

   PciHostBridgeLib|Silicon/Socionext/SynQuacer/Library/SynQuacerPciHostBridgeLib/SynQuacerPciHostBridgeLib.inf

+  NonDiscoverableDeviceRegistrationLib|MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.inf

 

 [LibraryClasses.common.UEFI_APPLICATION]

   PerformanceLib|MdeModulePkg/Library/DxePerformanceLib/DxePerformanceLib.inf

@@ -529,6 +530,13 @@
   MdeModulePkg/Universal/EbcDxe/EbcDxe.inf

 

   #

+  # eMMC support

+  #

+  MdeModulePkg/Bus/Pci/NonDiscoverablePciDeviceDxe/NonDiscoverablePciDeviceDxe.inf

+  MdeModulePkg/Bus/Pci/SdMmcPciHcDxe/SdMmcPciHcDxe.inf

+  MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDxe.inf

+

+  #

   # AHCI Support

   #

   MdeModulePkg/Bus/Pci/SataControllerDxe/SataControllerDxe.inf

diff --git a/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.fdf b/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.fdf
index 4577bd3..1599f89 100644
--- a/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.fdf
+++ b/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.fdf
@@ -149,6 +149,13 @@ READ_LOCK_STATUS   = TRUE
   INF MdeModulePkg/Universal/EbcDxe/EbcDxe.inf

 

   #

+  # eMMC support

+  #

+  INF MdeModulePkg/Bus/Pci/NonDiscoverablePciDeviceDxe/NonDiscoverablePciDeviceDxe.inf

+  INF MdeModulePkg/Bus/Pci/SdMmcPciHcDxe/SdMmcPciHcDxe.inf

+  INF MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDxe.inf

+

+  #

   # AHCI Support

   #

   INF MdeModulePkg/Bus/Pci/SataControllerDxe/SataControllerDxe.inf

diff --git a/Silicon/Socionext/SynQuacer/Drivers/PlatformDxe/Emmc.c b/Silicon/Socionext/SynQuacer/Drivers/PlatformDxe/Emmc.c
new file mode 100644
index 0000000..4c7713d
--- /dev/null
+++ b/Silicon/Socionext/SynQuacer/Drivers/PlatformDxe/Emmc.c
@@ -0,0 +1,204 @@
+ /** @file

+  SynQuacer DXE platform driver - eMMC support

+

+  Copyright (c) 2017, 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 "PlatformDxe.h"

+

+// F_SDH30 extended Controller registers

+#define F_SDH30_AHB_CONFIG        0x100

+#define  F_SDH30_AHB_BIGED        BIT6

+#define  F_SDH30_BUSLOCK_DMA      BIT5

+#define  F_SDH30_BUSLOCK_EN       BIT4

+#define  F_SDH30_SIN              BIT3

+#define  F_SDH30_AHB_INCR_16      BIT2

+#define  F_SDH30_AHB_INCR_8       BIT1

+#define  F_SDH30_AHB_INCR_4       BIT0

+

+#define F_SDH30_TUNING_SETTING    0x108

+#define  F_SDH30_CMD_CHK_DIS      BIT16

+

+#define F_SDH30_IO_CONTROL2       0x114

+#define  F_SDH30_MSEL_O_1_8       BIT18

+#define  F_SDH30_CRES_O_DN        BIT19

+

+#define F_SDH30_ESD_CONTROL       0x124

+#define  F_SDH30_EMMC_RST         BIT1

+#define  F_SDH30_EMMC_HS200       BIT24

+#define  F_SDH30_CMD_DAT_DELAY    BIT9

+

+#define F_SDH30_TUNING_SETTING    0x108

+#define  F_SDH30_CMD_CHK_DIS      BIT16

+

+#define F_SDH30_IO_CONTROL2       0x114

+#define  F_SDH30_MSEL_O_1_8       BIT18

+#define  F_SDH30_CRES_O_DN        BIT19

+

+#define F_SDH30_ESD_CONTROL       0x124

+#define  F_SDH30_EMMC_RST         BIT1

+#define  F_SDH30_EMMC_HS200       BIT24

+#define  F_SDH30_CMD_DAT_DELAY    BIT9

+

+#define SD_HC_CLOCK_CTRL          0x2C

+#define SYNQUACER_CLOCK_CTRL_VAL  0xBC01

+

+#define SD_HC_CAP_SDR104          BIT33

+

+#define ESD_CONTROL_RESET_DELAY   (20 * 1000)

+#define IO_CONTROL2_SETTLE_US     3000

+

+STATIC EFI_HANDLE mSdMmcControllerHandle;

+

+/**

+

+  Override function for SDHCI capability bits

+

+  @param[in]      ControllerHandle          The EFI_HANDLE of the controller.

+  @param[in]      Slot                      The 0 based slot index.

+  @param[in,out]  SdMmcHcSlotCapability     The SDHCI capability structure.

+

+  @retval EFI_SUCCESS           The override function completed successfully.

+  @retval EFI_NOT_FOUND         The specified controller or slot does not exist.

+  @retval EFI_INVALID_PARAMETER SdMmcHcSlotCapability is NULL

+

+**/

+STATIC

+EFI_STATUS

+EFIAPI

+SynQuacerSdMmcOverrideCapability (

+  IN      EFI_HANDLE              ControllerHandle,

+  IN      UINT8                   Slot,

+  IN  OUT VOID                    *SdMmcHcSlotCapability

+  )

+{

+  UINT64    *Caps;

+

+  ASSERT (ControllerHandle == mSdMmcControllerHandle);

+  ASSERT (Slot == 0);

+

+  if (ControllerHandle != mSdMmcControllerHandle || Slot != 0) {

+    return EFI_NOT_FOUND;

+  }

+

+  //

+  // Clear the SDR104 capability bit. This avoids the need for a HS200 tuning

+  // quirk that is difficult to support using the generic driver.

+  //

+  Caps = SdMmcHcSlotCapability;

+  *Caps &= ~(UINT64)SD_HC_CAP_SDR104;

+

+  return EFI_SUCCESS;

+}

+

+/**

+

+  Override function for SDHCI controller operations

+

+  @param[in]      ControllerHandle    The EFI_HANDLE of the controller.

+  @param[in]      Slot                The 0 based slot index.

+  @param[in,out]  HookType            The type of operation and whether the

+                                      hook is invoked right before (pre) or

+                                      right after (post)

+

+  @retval EFI_SUCCESS           The override function completed successfully.

+  @retval EFI_NOT_FOUND         The specified controller or slot does not exist.

+  @retval EFI_INVALID_PARAMETER HookType is invalid

+

+**/

+STATIC

+EFI_STATUS

+EFIAPI

+SynQuacerSdMmcInvokeHook (

+  IN      EFI_HANDLE              ControllerHandle,

+  IN      UINT8                   Slot,

+  IN      SD_MMC_OVERRIDE_HOOK    HookType

+  )

+{

+  ASSERT (ControllerHandle == mSdMmcControllerHandle);

+  ASSERT (Slot == 0);

+

+  if (ControllerHandle != mSdMmcControllerHandle || Slot != 0) {

+    return EFI_NOT_FOUND;

+  }

+

+  switch (HookType) {

+  case SD_MMC_OVERRIDE_RESET_PRE_HOOK:

+    // Soft reset does not complete unless the clock is already enabled.

+    MmioWrite16 (SYNQUACER_EMMC_BASE + SD_HC_CLOCK_CTRL,

+                 SYNQUACER_CLOCK_CTRL_VAL);

+    break;

+

+  case SD_MMC_OVERRIDE_INIT_HOST_PRE_HOOK:

+    // init vendor specific regs

+    MmioAnd16 (SYNQUACER_EMMC_BASE + F_SDH30_AHB_CONFIG,

+      ~(F_SDH30_AHB_BIGED | F_SDH30_BUSLOCK_EN));

+

+    MmioOr16 (SYNQUACER_EMMC_BASE + F_SDH30_AHB_CONFIG,

+      F_SDH30_SIN | F_SDH30_AHB_INCR_16 | F_SDH30_AHB_INCR_8 |

+      F_SDH30_AHB_INCR_4);

+

+    MmioAnd32 (SYNQUACER_EMMC_BASE + F_SDH30_ESD_CONTROL, ~F_SDH30_EMMC_RST);

+    MemoryFence ();

+    gBS->Stall (ESD_CONTROL_RESET_DELAY);

+

+    MmioOr32 (SYNQUACER_EMMC_BASE + F_SDH30_ESD_CONTROL,

+      F_SDH30_EMMC_RST | F_SDH30_CMD_DAT_DELAY | F_SDH30_EMMC_HS200);

+

+    gBS->Stall (IO_CONTROL2_SETTLE_US);

+    MmioOr32 (SYNQUACER_EMMC_BASE + F_SDH30_IO_CONTROL2, F_SDH30_CRES_O_DN);

+    MemoryFence ();

+    MmioOr32 (SYNQUACER_EMMC_BASE + F_SDH30_IO_CONTROL2, F_SDH30_MSEL_O_1_8);

+    MemoryFence ();

+    MmioAnd32 (SYNQUACER_EMMC_BASE + F_SDH30_IO_CONTROL2, ~F_SDH30_CRES_O_DN);

+    MemoryFence ();

+    gBS->Stall (IO_CONTROL2_SETTLE_US);

+

+    MmioOr32 (SYNQUACER_EMMC_BASE + F_SDH30_TUNING_SETTING,

+      F_SDH30_CMD_CHK_DIS);

+    break;

+

+  default:

+    break;

+  }

+  return EFI_SUCCESS;

+}

+

+STATIC SD_MMC_OVERRIDE mSdMmcOverride = {

+  EDKII_SD_MMC_OVERRIDE_PROTOCOL_VERSION,

+  SynQuacerSdMmcOverrideCapability,

+  SynQuacerSdMmcInvokeHook,

+};

+

+EFI_STATUS

+EFIAPI

+RegisterEmmc (

+  VOID

+  )

+{

+  EFI_STATUS                      Status;

+

+  Status = RegisterNonDiscoverableMmioDevice (

+             NonDiscoverableDeviceTypeSdhci,

+             NonDiscoverableDeviceDmaTypeNonCoherent,

+             NULL,

+             &mSdMmcControllerHandle,

+             1,

+             SYNQUACER_EMMC_BASE, SYNQUACER_EMMC_BASE_SZ);

+  ASSERT_EFI_ERROR (Status);

+

+  Status = gBS->InstallProtocolInterface (&mSdMmcControllerHandle,

+                  &gEdkiiSdMmcOverrideProtocolGuid,

+                  EFI_NATIVE_INTERFACE, (VOID **)&mSdMmcOverride);

+  ASSERT_EFI_ERROR (Status);

+

+  return EFI_SUCCESS;

+}

diff --git a/Silicon/Socionext/SynQuacer/Drivers/PlatformDxe/PlatformDxe.c b/Silicon/Socionext/SynQuacer/Drivers/PlatformDxe/PlatformDxe.c
index 070e6be..c64ccf3 100644
--- a/Silicon/Socionext/SynQuacer/Drivers/PlatformDxe/PlatformDxe.c
+++ b/Silicon/Socionext/SynQuacer/Drivers/PlatformDxe/PlatformDxe.c
@@ -12,14 +12,7 @@
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 **/

 

-#include <PiDxe.h>

-#include <Library/BaseMemoryLib.h>

-#include <Library/DebugLib.h>

-#include <Library/DtPlatformDtbLoaderLib.h>

-#include <Library/MemoryAllocationLib.h>

-#include <Library/UefiBootServicesTableLib.h>

-#include <Platform/MemoryMap.h>

-#include <Protocol/NonDiscoverableDevice.h>

+#include "PlatformDxe.h"

 

 STATIC EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR mNetsecDesc[] = {

   {

@@ -178,5 +171,8 @@ PlatformDxeEntryPoint (
              &Handle);

   ASSERT_EFI_ERROR (Status);

 

+  Status = RegisterEmmc ();

+  ASSERT_EFI_ERROR (Status);

+

   return EFI_SUCCESS;

 }

diff --git a/Silicon/Socionext/SynQuacer/Drivers/PlatformDxe/PlatformDxe.h b/Silicon/Socionext/SynQuacer/Drivers/PlatformDxe/PlatformDxe.h
new file mode 100644
index 0000000..e653d72
--- /dev/null
+++ b/Silicon/Socionext/SynQuacer/Drivers/PlatformDxe/PlatformDxe.h
@@ -0,0 +1,37 @@
+/** @file

+  SynQuacer DXE platform driver.

+

+  Copyright (c) 2017, 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.

+**/

+

+#ifndef __PLATFORM_DXE_H__

+#define __PLATFORM_DXE_H__

+

+#include <PiDxe.h>

+#include <Library/BaseLib.h>

+#include <Library/BaseMemoryLib.h>

+#include <Library/DebugLib.h>

+#include <Library/DtPlatformDtbLoaderLib.h>

+#include <Library/IoLib.h>

+#include <Library/MemoryAllocationLib.h>

+#include <Library/NonDiscoverableDeviceRegistrationLib.h>

+#include <Library/UefiBootServicesTableLib.h>

+#include <Platform/MemoryMap.h>

+#include <Protocol/NonDiscoverableDevice.h>

+#include <Protocol/SdMmcOverride.h>

+

+EFI_STATUS

+EFIAPI

+RegisterEmmc (

+  VOID

+  );

+

+#endif

diff --git a/Silicon/Socionext/SynQuacer/Drivers/PlatformDxe/PlatformDxe.inf b/Silicon/Socionext/SynQuacer/Drivers/PlatformDxe/PlatformDxe.inf
index 478e0c7..8af79ee 100644
--- a/Silicon/Socionext/SynQuacer/Drivers/PlatformDxe/PlatformDxe.inf
+++ b/Silicon/Socionext/SynQuacer/Drivers/PlatformDxe/PlatformDxe.inf
@@ -23,6 +23,7 @@
   ENTRY_POINT                    = PlatformDxeEntryPoint

 

 [Sources]

+  Emmc.c

   PlatformDxe.c

 

 [Packages]

@@ -34,10 +35,13 @@
   Silicon/Socionext/SynQuacer/SynQuacer.dec

 

 [LibraryClasses]

+  BaseLib

   BaseMemoryLib

   DebugLib

   DtPlatformDtbLoaderLib

+  IoLib

   MemoryAllocationLib

+  NonDiscoverableDeviceRegistrationLib

   UefiBootServicesTableLib

   UefiDriverEntryPoint

 

@@ -49,6 +53,7 @@
 

 [Protocols]

   gEdkiiNonDiscoverableDeviceProtocolGuid         ## PRODUCES

+  gEdkiiSdMmcOverrideProtocolGuid                 ## PRODUCES

   gPcf8563RealTimeClockLibI2cMasterProtolGuid     ## PRODUCES

 

 [FixedPcd]