[edk2-platforms][PATCH 1/1] Platform/RaspberryPi/Drivers: Add SD card detection

Pete Batard
 

The Raspberry Pi 3 and Pi 4 platforms (with latest EEPROM) can boot
straight from USB, without the need for an SD card being present.
However, the IsCardPresent () calls from the ArasanMmcHost and SdHost
drivers are currently hardwired to return TRUE, which results in
straight to USB boot failing due to the SD drivers looping on
errors while trying to poke at a non-existent card...

Ideally, we would use the Card Detect signal from the uSD slot, to
report on the presence or absence of a card, but the Raspberry Pi
Foundation did not wire those signals in the Pi 2 and subsequent
models, leaving us with only potentially interfering SD commands
as means to perform card detection.

As a result of this, we are left with no other choice but limit
detection to occurring only once, prior to formal SD card init,
and then return the detected value for subsequent calls. This,
however, is more than good enough for the intended purpose, which
is to allow straight to USB boot.

Tested on Raspberry Pi 3 and 4, and for both SD controllers.

Addresses pftf/RPi3#13, pftf/RPi3#14, pftf/RPi4#37.

Signed-off-by: Pete Batard <@pbatard>
---
Platform/RaspberryPi/Drivers/ArasanMmcHostDxe/ArasanMmcHostDxe.c | 66 ++++++++++++++++---
Platform/RaspberryPi/Drivers/SdHostDxe/SdHostDxe.c | 69 +++++++++++++++++---
Platform/RaspberryPi/Include/Protocol/RpiMmcHost.h | 6 ++
3 files changed, 122 insertions(+), 19 deletions(-)

diff --git a/Platform/RaspberryPi/Drivers/ArasanMmcHostDxe/ArasanMmcHostDxe.c b/Platform/RaspberryPi/Drivers/ArasanMmcHostDxe/ArasanMmcHostDxe.c
index 6d706af6f276..08e5be1f015f 100644
--- a/Platform/RaspberryPi/Drivers/ArasanMmcHostDxe/ArasanMmcHostDxe.c
+++ b/Platform/RaspberryPi/Drivers/ArasanMmcHostDxe/ArasanMmcHostDxe.c
@@ -11,7 +11,8 @@

#define DEBUG_MMCHOST_SD DEBUG_VERBOSE

-BOOLEAN PreviousIsCardPresent = FALSE;
+BOOLEAN CardIsPresent = FALSE;
+CARD_DETECT_STATE CardDetectState = CardDetectRequired;
UINT32 LastExecutedCommand = (UINT32) -1;

STATIC RASPBERRY_PI_FIRMWARE_PROTOCOL *mFwProtocol;
@@ -239,14 +240,6 @@ CalculateClockFrequencyDivisor (
return EFI_SUCCESS;
}

-BOOLEAN
-MMCIsCardPresent (
- IN EFI_MMC_HOST_PROTOCOL *This
-)
-{
- return TRUE;
-}
-
BOOLEAN
MMCIsReadOnly (
IN EFI_MMC_HOST_PROTOCOL *This
@@ -418,6 +411,10 @@ MMCNotifyState (

DEBUG ((DEBUG_MMCHOST_SD, "ArasanMMCHost: MMCNotifyState(State: %d)\n", State));

+ // Stall all operations except init until card detection has occurred.
+ if (State != MmcHwInitializationState && CardDetectState != CardDetectCompleted)
+ return EFI_NOT_READY;
+
switch (State) {
case MmcHwInitializationState:
{
@@ -489,6 +486,57 @@ MMCNotifyState (
return EFI_SUCCESS;
}

+BOOLEAN
+MMCIsCardPresent (
+ IN EFI_MMC_HOST_PROTOCOL *This
+)
+{
+ EFI_STATUS Status;
+
+ //
+ // If we are already in progress (we may get concurrent calls)
+ // or completed the detection, just return the current value.
+ //
+ if (CardDetectState != CardDetectRequired)
+ return CardIsPresent;
+
+ CardDetectState = CardDetectInProgress;
+ CardIsPresent = FALSE;
+
+ //
+ // The two following commands should succeed even if no card is present.
+ //
+ Status = MMCNotifyState (This, MmcHwInitializationState);
+ if (EFI_ERROR (Status)) {
+ DEBUG ((DEBUG_ERROR, "MMCIsCardPresent: Error MmcHwInitializationState, Status=%r.\n", Status));
+ // If we failed init, go back to requiring card detection
+ CardDetectState = CardDetectRequired;
+ return FALSE;
+ }
+
+ Status = MMCSendCommand (This, MMC_CMD0, 0);
+ if (EFI_ERROR (Status)) {
+ DEBUG ((DEBUG_ERROR, "MMCIsCardPresent: CMD0 Error, Status=%r.\n", Status));
+ goto out;
+ }
+
+ //
+ // CMD8 should tell us if a card is present.
+ //
+ Status = MMCSendCommand (This, MMC_CMD8, CMD8_SD_ARG);
+ if (EFI_ERROR (Status)) {
+ DEBUG ((DEBUG_INFO, "MMCIsCardPresent: No card detected, Status=%r.\n", Status));
+ goto out;
+ }
+
+ DEBUG ((DEBUG_INFO, "MMCIsCardPresent: Card detected.\n"));
+ CardIsPresent = TRUE;
+
+out:
+ CardDetectState = CardDetectCompleted;
+ return CardIsPresent;
+}
+
EFI_STATUS
MMCReceiveResponse (
IN EFI_MMC_HOST_PROTOCOL *This,
diff --git a/Platform/RaspberryPi/Drivers/SdHostDxe/SdHostDxe.c b/Platform/RaspberryPi/Drivers/SdHostDxe/SdHostDxe.c
index 2f31c5eb8c46..d96344fd0f8e 100644
--- a/Platform/RaspberryPi/Drivers/SdHostDxe/SdHostDxe.c
+++ b/Platform/RaspberryPi/Drivers/SdHostDxe/SdHostDxe.c
@@ -64,7 +64,9 @@ STATIC CONST CHAR8 *mFsmState[] = { "identmode", "datamode", "readdata",
"genpulses", "writewait2", "?",
"startpowdown" };
#endif /* NDEBUG */
-STATIC UINT32 mLastGoodCmd = MMC_GET_INDX (MMC_CMD0);
+STATIC BOOLEAN CardIsPresent = FALSE;
+STATIC CARD_DETECT_STATE CardDetectState = CardDetectRequired;
+static UINT32 mLastGoodCmd = MMC_GET_INDX (MMC_CMD0);

STATIC inline BOOLEAN
IsAppCmd (
@@ -264,15 +266,7 @@ SdHostSetClockFrequency (
return Status;
}

-STATIC BOOLEAN
-SdIsCardPresent (
- IN EFI_MMC_HOST_PROTOCOL *This
- )
-{
- return TRUE;
-}
-
-STATIC BOOLEAN
+static BOOLEAN
SdIsReadOnly (
IN EFI_MMC_HOST_PROTOCOL *This
)
@@ -639,6 +633,10 @@ SdNotifyState (
{
DEBUG ((DEBUG_MMCHOST_SD, "SdHost: SdNotifyState(State: %d) ", State));

+ // Stall all operations except init until card detection has occurred.
+ if (State != MmcHwInitializationState && CardDetectState != CardDetectCompleted)
+ return EFI_NOT_READY;
+
switch (State) {
case MmcHwInitializationState:
DEBUG ((DEBUG_MMCHOST_SD, "MmcHwInitializationState\n", State));
@@ -718,6 +716,57 @@ SdNotifyState (
return EFI_SUCCESS;
}

+STATIC BOOLEAN
+SdIsCardPresent (
+ IN EFI_MMC_HOST_PROTOCOL *This
+ )
+{
+ EFI_STATUS Status;
+
+ //
+ // If we are already in progress (we may get concurrent calls)
+ // or completed the detection, just return the current value.
+ //
+ if (CardDetectState != CardDetectRequired)
+ return CardIsPresent;
+
+ CardDetectState = CardDetectInProgress;
+ CardIsPresent = FALSE;
+
+ //
+ // The two following commands should succeed even if no card is present.
+ //
+ Status = SdNotifyState (This, MmcHwInitializationState);
+ if (EFI_ERROR (Status)) {
+ DEBUG ((DEBUG_ERROR, "SdIsCardPresent: Error MmcHwInitializationState, Status=%r.\n", Status));
+ // If we failed init, go back to requiring card detection
+ CardDetectState = CardDetectRequired;
+ return FALSE;
+ }
+
+ Status = SdSendCommand (This, MMC_CMD0, 0);
+ if (EFI_ERROR (Status)) {
+ DEBUG ((DEBUG_ERROR, "SdIsCardPresent: CMD0 Error, Status=%r.\n", Status));
+ goto out;
+ }
+
+ //
+ // CMD8 should tell us if a card is present.
+ //
+ Status = SdSendCommand (This, MMC_CMD8, CMD8_SD_ARG);
+ if (EFI_ERROR (Status)) {
+ DEBUG ((DEBUG_INFO, "SdIsCardPresent: No card detected, Status=%r.\n", Status));
+ goto out;
+ }
+
+ DEBUG ((DEBUG_INFO, "SdIsCardPresent: Card detected.\n"));
+ CardIsPresent = TRUE;
+
+out:
+ CardDetectState = CardDetectCompleted;
+ return CardIsPresent;
+}
+
BOOLEAN
SdIsMultiBlock (
IN EFI_MMC_HOST_PROTOCOL *This
diff --git a/Platform/RaspberryPi/Include/Protocol/RpiMmcHost.h b/Platform/RaspberryPi/Include/Protocol/RpiMmcHost.h
index c558e00bf500..78514a31bc4e 100644
--- a/Platform/RaspberryPi/Include/Protocol/RpiMmcHost.h
+++ b/Platform/RaspberryPi/Include/Protocol/RpiMmcHost.h
@@ -82,6 +82,12 @@ typedef enum _MMC_STATE {
MmcDisconnectState,
} MMC_STATE;

+typedef enum _CARD_DETECT_STATE {
+ CardDetectRequired = 0,
+ CardDetectInProgress,
+ CardDetectCompleted
+} CARD_DETECT_STATE;
+
#define EMMCBACKWARD (0)
#define EMMCHS26 (1 << 0) // High-Speed @26MHz at rated device voltages
#define EMMCHS52 (1 << 1) // High-Speed @52MHz at rated device voltages
--
2.21.0.windows.1

Join devel@edk2.groups.io to automatically receive all group messages.