Marvell/Drivers: XenonDxe: Allow overriding base clock frequency

Some SdMmc host controllers are run by clocks with different
frequency than it is reflected in Capabilities Register 1.
Because the bitfield is only 8 bits wide, a maximum value
that could be obtained from hardware is 255(MHz).

In case the actual frequency exceeds 255MHz, the 8-bit BaseClkFreq
member of SD_MMC_HC_SLOT_CAP structure occurs to be not sufficient
to be used for setting the clock speed in SdMmcHcClockSupply
function.

This patch adds new UINT32 array ('BaseClkFreq[]') to
SD_MMC_HC_PRIVATE_DATA structure for specifying
the input clock speed for each slot of the host controller.
All routines that are used for clock configuration are
updated accordingly.

Thanks to above the Xenon host controller driver
could be modified to configure clock speed relatively
to actual 400MHz input.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Marcin Wojtas <mw@semihalf.com>
Reviewed-by: Leif Lindholm <leif.lindholm@linaro.org>

6 files changed, 48 insertions, 28 deletions

diff --git a/Platform/Marvell/Drivers/SdMmc/XenonDxe/EmmcDevice.c b/Platform/Marvell/Drivers/SdMmc/XenonDxe/EmmcDevice.c
index 4d4833fb58..530a01ccdc 100755
--- a/Platform/Marvell/Drivers/SdMmc/XenonDxe/EmmcDevice.c
+++ b/Platform/Marvell/Drivers/SdMmc/XenonDxe/EmmcDevice.c
@@ -705,7 +705,7 @@ EmmcSwitchClockFreq (
   //

   // Convert the clock freq unit from MHz to KHz.

   //

-  Status = SdMmcHcClockSupply (PciIo, Slot, ClockFreq * 1000, Private->Capability[Slot]);

+  Status = SdMmcHcClockSupply (PciIo, Slot, ClockFreq * 1000, Private->BaseClkFreq[Slot]);

 

   return Status;

 }

@@ -1007,7 +1007,7 @@ EmmcSetBusMode (
     return Status;

   }

 

-  ASSERT (Private->Capability[Slot].BaseClkFreq != 0);

+  ASSERT (Private->BaseClkFreq[Slot] != 0);

   //

   // Check if the Host Controller support 8bits bus width.

   //

diff --git a/Platform/Marvell/Drivers/SdMmc/XenonDxe/SdDevice.c b/Platform/Marvell/Drivers/SdMmc/XenonDxe/SdDevice.c
index 9122848021..ea7eed717f 100644
--- a/Platform/Marvell/Drivers/SdMmc/XenonDxe/SdDevice.c
+++ b/Platform/Marvell/Drivers/SdMmc/XenonDxe/SdDevice.c
@@ -972,7 +972,7 @@ SdCardSetBusMode (
     return Status;

   }

 

-  Status = SdMmcHcClockSupply (PciIo, Slot, ClockFreq * 1000, *Capability);

+  Status = SdMmcHcClockSupply (PciIo, Slot, ClockFreq * 1000, Private->BaseClkFreq[Slot]);

   if (EFI_ERROR (Status)) {

     return Status;

   }

@@ -1144,7 +1144,7 @@ SdCardIdentification (
         goto Error;

       }

 

-      SdMmcHcInitClockFreq (PciIo, Slot, Private->Capability[Slot]);

+      SdMmcHcInitClockFreq (PciIo, Slot, Private->BaseClkFreq[Slot]);

 

       gBS->Stall (1000);

 

diff --git a/Platform/Marvell/Drivers/SdMmc/XenonDxe/SdMmcPciHcDxe.c b/Platform/Marvell/Drivers/SdMmc/XenonDxe/SdMmcPciHcDxe.c
index 981eab58ec..80159a4f5d 100644
--- a/Platform/Marvell/Drivers/SdMmc/XenonDxe/SdMmcPciHcDxe.c
+++ b/Platform/Marvell/Drivers/SdMmc/XenonDxe/SdMmcPciHcDxe.c
@@ -291,7 +291,10 @@ SdMmcPciHcEnumerateDevice (
         //

         // Reinitialize slot and restart identification process for the new attached device

         //

-        Status = SdMmcHcInitHost (Private->PciIo, Slot, Private->Capability[Slot]);

+        Status = SdMmcHcInitHost (Private->PciIo,

+                   Slot,

+                   Private->Capability[Slot],

+                   Private->BaseClkFreq[Slot]);

         if (EFI_ERROR (Status)) {

           continue;

         }

@@ -617,11 +620,13 @@ SdMmcPciHcDriverBindingStart (
   Private->Capability[Slot].Sdr50 = 0;

   Private->Capability[Slot].BusWidth8 = 0;

 

-  if (Private->Capability[Slot].BaseClkFreq == 0) {

-    Private->Capability[Slot].BaseClkFreq = 0xff;

-  }

+  //

+  // Override inappropriate base clock frequency from Capabilities Register 1.

+  // Actual clock speed of Xenon controller is 400MHz.

+  //

+  Private->BaseClkFreq[Slot] = XENON_MMC_MAX_CLK / 1000 / 1000;

 

-  DumpCapabilityReg (Slot, &Private->Capability[Slot]);

+  DumpCapabilityReg (Slot, &Private->Capability[Slot], Private->BaseClkFreq[Slot]);

 

   Status = SdMmcHcGetMaxCurrent (PciIo, Slot, &Private->MaxCurrent[Slot]);

   if (EFI_ERROR (Status)) {

diff --git a/Platform/Marvell/Drivers/SdMmc/XenonDxe/SdMmcPciHcDxe.h b/Platform/Marvell/Drivers/SdMmc/XenonDxe/SdMmcPciHcDxe.h
index 6a2a279699..067b9acf61 100644
--- a/Platform/Marvell/Drivers/SdMmc/XenonDxe/SdMmcPciHcDxe.h
+++ b/Platform/Marvell/Drivers/SdMmc/XenonDxe/SdMmcPciHcDxe.h
@@ -115,6 +115,12 @@ typedef struct {
   UINT64                              MaxCurrent[SD_MMC_HC_MAX_SLOT];

 

   UINT32                              ControllerVersion;

+

+  //

+  // Some controllers may require to override base clock frequency

+  // value stored in Capabilities Register 1.

+  //

+  UINT32                              BaseClkFreq[SD_MMC_HC_MAX_SLOT];

 } SD_MMC_HC_PRIVATE_DATA;

 

 #define SD_MMC_HC_TRB_SIG             SIGNATURE_32 ('T', 'R', 'B', 'T')

diff --git a/Platform/Marvell/Drivers/SdMmc/XenonDxe/SdMmcPciHci.c b/Platform/Marvell/Drivers/SdMmc/XenonDxe/SdMmcPciHci.c
index ccbf355016..1f4abd18a6 100644
--- a/Platform/Marvell/Drivers/SdMmc/XenonDxe/SdMmcPciHci.c
+++ b/Platform/Marvell/Drivers/SdMmc/XenonDxe/SdMmcPciHci.c
@@ -22,12 +22,14 @@
 

   @param[in]  Slot            The slot number of the SD card to send the command to.

   @param[in]  Capability      The buffer to store the capability data.

+  @param[in]  BaseClkFreq     The base clock frequency of host controller in MHz.

 

 **/

 VOID

 DumpCapabilityReg (

   IN UINT8                Slot,

-  IN SD_MMC_HC_SLOT_CAP   *Capability

+  IN SD_MMC_HC_SLOT_CAP   *Capability,

+  IN UINT32               BaseClkFreq

   )

 {

   //

@@ -35,7 +37,10 @@ DumpCapabilityReg (
   //

   DEBUG ((DEBUG_INFO, " == Slot [%d] Capability is 0x%x ==\n", Slot, Capability));

   DEBUG ((DEBUG_INFO, "   Timeout Clk Freq  %d%a\n", Capability->TimeoutFreq, (Capability->TimeoutUnit) ? "MHz" : "KHz"));

-  DEBUG ((DEBUG_INFO, "   Base Clk Freq     %dMHz\n", Capability->BaseClkFreq));

+  if (Capability->BaseClkFreq != BaseClkFreq) {

+    DEBUG ((DEBUG_INFO, "   Controller register value overriden:\n"));

+  }

+  DEBUG ((DEBUG_INFO, "   Base Clk Freq     %dMHz\n", BaseClkFreq));

   DEBUG ((DEBUG_INFO, "   Max Blk Len       %dbytes\n", 512 * (1 << Capability->MaxBlkLen)));

   DEBUG ((DEBUG_INFO, "   8-bit Support     %a\n", Capability->BusWidth8 ? "TRUE" : "FALSE"));

   DEBUG ((DEBUG_INFO, "   ADMA2 Support     %a\n", Capability->Adma2 ? "TRUE" : "FALSE"));

@@ -678,7 +683,7 @@ SdMmcHcStopClock (
   @param[in] PciIo          The PCI IO protocol instance.

   @param[in] Slot           The slot number of the SD card to send the command to.

   @param[in] ClockFreq      The max clock frequency to be set. The unit is KHz.

-  @param[in] Capability     The capability of the slot.

+  @param[in] BaseClkFreq    The base clock frequency of host controller in MHz.

 

   @retval EFI_SUCCESS       The clock is supplied successfully.

   @retval Others            The clock isn't supplied successfully.

@@ -689,11 +694,10 @@ SdMmcHcClockSupply (
   IN EFI_PCI_IO_PROTOCOL    *PciIo,

   IN UINT8                  Slot,

   IN UINT64                 ClockFreq,

-  IN SD_MMC_HC_SLOT_CAP     Capability

+  IN UINT32                 BaseClkFreq

   )

 {

   EFI_STATUS                Status;

-  UINT32                    BaseClkFreq;

   UINT32                    SettingFreq;

   UINT32                    Divisor;

   UINT32                    Remainder;

@@ -703,9 +707,8 @@ SdMmcHcClockSupply (
   //

   // Calculate a divisor for SD clock frequency

   //

-  ASSERT (Capability.BaseClkFreq != 0);

+  ASSERT (BaseClkFreq != 0);

 

-  BaseClkFreq = Capability.BaseClkFreq;

   if (ClockFreq == 0) {

     return EFI_INVALID_PARAMETER;

   }

@@ -896,7 +899,7 @@ SdMmcHcSetBusWidth (
 

   @param[in] PciIo          The PCI IO protocol instance.

   @param[in] Slot           The slot number of the SD card to send the command to.

-  @param[in] Capability     The capability of the slot.

+  @param[in] BaseClkFreq    The base clock frequency of host controller in MHz.

 

   @retval EFI_SUCCESS       The clock is supplied successfully.

   @retval Others            The clock isn't supplied successfully.

@@ -906,7 +909,7 @@ EFI_STATUS
 SdMmcHcInitClockFreq (

   IN EFI_PCI_IO_PROTOCOL    *PciIo,

   IN UINT8                  Slot,

-  IN SD_MMC_HC_SLOT_CAP     Capability

+  IN UINT32                 BaseClkFreq

   )

 {

   EFI_STATUS                Status;

@@ -915,7 +918,7 @@ SdMmcHcInitClockFreq (
   //

   // Calculate a divisor for SD clock frequency

   //

-  if (Capability.BaseClkFreq == 0) {

+  if (BaseClkFreq == 0) {

     //

     // Don't support get Base Clock Frequency information via another method

     //

@@ -925,7 +928,7 @@ SdMmcHcInitClockFreq (
   // Supply 400KHz clock frequency at initialization phase.

   //

   InitFreq = 400;

-  Status = SdMmcHcClockSupply (PciIo, Slot, InitFreq, Capability);

+  Status = SdMmcHcClockSupply (PciIo, Slot, InitFreq, BaseClkFreq);

   return Status;

 }

 

@@ -1024,6 +1027,7 @@ SdMmcHcInitTimeoutCtrl (
   @param[in] PciIo          The PCI IO protocol instance.

   @param[in] Slot           The slot number of the SD card to send the command to.

   @param[in] Capability     The capability of the slot.

+  @param[in] BaseClkFreq    The base clock frequency of host controller in MHz.

 

   @retval EFI_SUCCESS       The host controller is initialized successfully.

   @retval Others            The host controller isn't initialized successfully.

@@ -1033,12 +1037,13 @@ EFI_STATUS
 SdMmcHcInitHost (

   IN EFI_PCI_IO_PROTOCOL    *PciIo,

   IN UINT8                  Slot,

-  IN SD_MMC_HC_SLOT_CAP     Capability

+  IN SD_MMC_HC_SLOT_CAP     Capability,

+  IN UINT32                 BaseClkFreq

   )

 {

   EFI_STATUS       Status;

 

-  Status = SdMmcHcInitClockFreq (PciIo, Slot, Capability);

+  Status = SdMmcHcInitClockFreq (PciIo, Slot, BaseClkFreq);

   if (EFI_ERROR (Status)) {

     return Status;

   }

diff --git a/Platform/Marvell/Drivers/SdMmc/XenonDxe/SdMmcPciHci.h b/Platform/Marvell/Drivers/SdMmc/XenonDxe/SdMmcPciHci.h
index fb62758602..533f37c79f 100644
--- a/Platform/Marvell/Drivers/SdMmc/XenonDxe/SdMmcPciHci.h
+++ b/Platform/Marvell/Drivers/SdMmc/XenonDxe/SdMmcPciHci.h
@@ -140,12 +140,14 @@ typedef struct {
 

   @param[in]  Slot            The slot number of the SD card to send the command to.

   @param[in]  Capability      The buffer to store the capability data.

+  @param[in]  BaseClkFreq     The base clock frequency of host controller in MHz.

 

 **/

 VOID

 DumpCapabilityReg (

   IN UINT8                Slot,

-  IN SD_MMC_HC_SLOT_CAP   *Capability

+  IN SD_MMC_HC_SLOT_CAP   *Capability,

+  IN UINT32               BaseClkFreq

   );

 

 /**

@@ -414,7 +416,7 @@ SdMmcHcStopClock (
   @param[in] PciIo          The PCI IO protocol instance.

   @param[in] Slot           The slot number of the SD card to send the command to.

   @param[in] ClockFreq      The max clock frequency to be set. The unit is KHz.

-  @param[in] Capability     The capability of the slot.

+  @param[in] BaseClkFreq    The base clock frequency of host controller in MHz.

 

   @retval EFI_SUCCESS       The clock is supplied successfully.

   @retval Others            The clock isn't supplied successfully.

@@ -425,7 +427,7 @@ SdMmcHcClockSupply (
   IN EFI_PCI_IO_PROTOCOL    *PciIo,

   IN UINT8                  Slot,

   IN UINT64                 ClockFreq,

-  IN SD_MMC_HC_SLOT_CAP     Capability

+  IN UINT32                 BaseClkFreq

   );

 

 /**

@@ -473,7 +475,7 @@ SdMmcHcSetBusWidth (
 

   @param[in] PciIo          The PCI IO protocol instance.

   @param[in] Slot           The slot number of the SD card to send the command to.

-  @param[in] Capability     The capability of the slot.

+  @param[in] BaseClkFreq    The base clock frequency of host controller in MHz.

 

   @retval EFI_SUCCESS       The clock is supplied successfully.

   @retval Others            The clock isn't supplied successfully.

@@ -483,7 +485,7 @@ EFI_STATUS
 SdMmcHcInitClockFreq (

   IN EFI_PCI_IO_PROTOCOL    *PciIo,

   IN UINT8                  Slot,

-  IN SD_MMC_HC_SLOT_CAP     Capability

+  IN UINT32                 BaseClkFreq

   );

 

 /**

@@ -531,6 +533,7 @@ SdMmcHcInitTimeoutCtrl (
   @param[in] PciIo          The PCI IO protocol instance.

   @param[in] Slot           The slot number of the SD card to send the command to.

   @param[in] Capability     The capability of the slot.

+  @param[in] BaseClkFreq    The base clock frequency of host controller in MHz.

 

   @retval EFI_SUCCESS       The host controller is initialized successfully.

   @retval Others            The host controller isn't initialized successfully.

@@ -540,7 +543,8 @@ EFI_STATUS
 SdMmcHcInitHost (

   IN EFI_PCI_IO_PROTOCOL    *PciIo,

   IN UINT8                  Slot,

-  IN SD_MMC_HC_SLOT_CAP     Capability

+  IN SD_MMC_HC_SLOT_CAP     Capability,

+  IN UINT32                 BaseClkFreq

   );

 

 #endif