2 This driver is used to manage SD/MMC PCI host controllers which are compliance
3 with SD Host Controller Simplified Specification version 3.00.
5 It would expose EFI_SD_MMC_PASS_THRU_PROTOCOL for upper layer use.
7 Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR>
8 This program and the accompanying materials
9 are licensed and made available under the terms and conditions of the BSD License
10 which accompanies this distribution. The full text of the license may be found at
11 http://opensource.org/licenses/bsd-license.php
13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 #include "SdMmcPciHcDxe.h"
21 Dump the content of SD/MMC host controller's Capability Register.
23 @param[in] Slot The slot number of the SD card to send the command to.
24 @param[in] Capability The buffer to store the capability data.
30 IN SD_MMC_HC_SLOT_CAP
*Capability
34 // Dump Capability Data
36 DEBUG ((DEBUG_INFO
, " == Slot [%d] Capability is 0x%x ==\n", Slot
, Capability
));
37 DEBUG ((DEBUG_INFO
, " Timeout Clk Freq %d%a\n", Capability
->TimeoutFreq
, (Capability
->TimeoutUnit
) ? "MHz" : "KHz"));
38 DEBUG ((DEBUG_INFO
, " Base Clk Freq %dMHz\n", Capability
->BaseClkFreq
));
39 DEBUG ((DEBUG_INFO
, " Max Blk Len %dbytes\n", 512 * (1 << Capability
->MaxBlkLen
)));
40 DEBUG ((DEBUG_INFO
, " 8-bit Support %a\n", Capability
->BusWidth8
? "TRUE" : "FALSE"));
41 DEBUG ((DEBUG_INFO
, " ADMA2 Support %a\n", Capability
->Adma2
? "TRUE" : "FALSE"));
42 DEBUG ((DEBUG_INFO
, " HighSpeed Support %a\n", Capability
->HighSpeed
? "TRUE" : "FALSE"));
43 DEBUG ((DEBUG_INFO
, " SDMA Support %a\n", Capability
->Sdma
? "TRUE" : "FALSE"));
44 DEBUG ((DEBUG_INFO
, " Suspend/Resume %a\n", Capability
->SuspRes
? "TRUE" : "FALSE"));
45 DEBUG ((DEBUG_INFO
, " Voltage 3.3 %a\n", Capability
->Voltage33
? "TRUE" : "FALSE"));
46 DEBUG ((DEBUG_INFO
, " Voltage 3.0 %a\n", Capability
->Voltage30
? "TRUE" : "FALSE"));
47 DEBUG ((DEBUG_INFO
, " Voltage 1.8 %a\n", Capability
->Voltage18
? "TRUE" : "FALSE"));
48 DEBUG ((DEBUG_INFO
, " 64-bit Sys Bus %a\n", Capability
->SysBus64
? "TRUE" : "FALSE"));
49 DEBUG ((DEBUG_INFO
, " Async Interrupt %a\n", Capability
->AsyncInt
? "TRUE" : "FALSE"));
50 DEBUG ((DEBUG_INFO
, " SlotType "));
51 if (Capability
->SlotType
== 0x00) {
52 DEBUG ((DEBUG_INFO
, "%a\n", "Removable Slot"));
53 } else if (Capability
->SlotType
== 0x01) {
54 DEBUG ((DEBUG_INFO
, "%a\n", "Embedded Slot"));
55 } else if (Capability
->SlotType
== 0x02) {
56 DEBUG ((DEBUG_INFO
, "%a\n", "Shared Bus Slot"));
58 DEBUG ((DEBUG_INFO
, "%a\n", "Reserved"));
60 DEBUG ((DEBUG_INFO
, " SDR50 Support %a\n", Capability
->Sdr50
? "TRUE" : "FALSE"));
61 DEBUG ((DEBUG_INFO
, " SDR104 Support %a\n", Capability
->Sdr104
? "TRUE" : "FALSE"));
62 DEBUG ((DEBUG_INFO
, " DDR50 Support %a\n", Capability
->Ddr50
? "TRUE" : "FALSE"));
63 DEBUG ((DEBUG_INFO
, " Driver Type A %a\n", Capability
->DriverTypeA
? "TRUE" : "FALSE"));
64 DEBUG ((DEBUG_INFO
, " Driver Type C %a\n", Capability
->DriverTypeC
? "TRUE" : "FALSE"));
65 DEBUG ((DEBUG_INFO
, " Driver Type D %a\n", Capability
->DriverTypeD
? "TRUE" : "FALSE"));
66 DEBUG ((DEBUG_INFO
, " Driver Type 4 %a\n", Capability
->DriverType4
? "TRUE" : "FALSE"));
67 if (Capability
->TimerCount
== 0) {
68 DEBUG ((DEBUG_INFO
, " Retuning TimerCnt Disabled\n", 2 * (Capability
->TimerCount
- 1)));
70 DEBUG ((DEBUG_INFO
, " Retuning TimerCnt %dseconds\n", 2 * (Capability
->TimerCount
- 1)));
72 DEBUG ((DEBUG_INFO
, " SDR50 Tuning %a\n", Capability
->TuningSDR50
? "TRUE" : "FALSE"));
73 DEBUG ((DEBUG_INFO
, " Retuning Mode Mode %d\n", Capability
->RetuningMod
+ 1));
74 DEBUG ((DEBUG_INFO
, " Clock Multiplier M = %d\n", Capability
->ClkMultiplier
+ 1));
75 DEBUG ((DEBUG_INFO
, " HS 400 %a\n", Capability
->Hs400
? "TRUE" : "FALSE"));
80 Read SlotInfo register from SD/MMC host controller pci config space.
82 @param[in] PciIo The PCI IO protocol instance.
83 @param[out] FirstBar The buffer to store the first BAR value.
84 @param[out] SlotNum The buffer to store the supported slot number.
86 @retval EFI_SUCCESS The operation succeeds.
87 @retval Others The operation fails.
93 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
99 SD_MMC_HC_SLOT_INFO SlotInfo
;
101 Status
= PciIo
->Pci
.Read (
104 SD_MMC_HC_SLOT_OFFSET
,
108 if (EFI_ERROR (Status
)) {
112 *FirstBar
= SlotInfo
.FirstBar
;
113 *SlotNum
= SlotInfo
.SlotNum
+ 1;
114 ASSERT ((*FirstBar
+ *SlotNum
) < SD_MMC_HC_MAX_SLOT
);
119 Read/Write specified SD/MMC host controller mmio register.
121 @param[in] PciIo The PCI IO protocol instance.
122 @param[in] BarIndex The BAR index of the standard PCI Configuration
123 header to use as the base address for the memory
124 operation to perform.
125 @param[in] Offset The offset within the selected BAR to start the
127 @param[in] Read A boolean to indicate it's read or write operation.
128 @param[in] Count The width of the mmio register in bytes.
129 Must be 1, 2 , 4 or 8 bytes.
130 @param[in, out] Data For read operations, the destination buffer to store
131 the results. For write operations, the source buffer
132 to write data from. The caller is responsible for
133 having ownership of the data buffer and ensuring its
134 size not less than Count bytes.
136 @retval EFI_INVALID_PARAMETER The PciIo or Data is NULL or the Count is not valid.
137 @retval EFI_SUCCESS The read/write operation succeeds.
138 @retval Others The read/write operation fails.
144 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
154 if ((PciIo
== NULL
) || (Data
== NULL
)) {
155 return EFI_INVALID_PARAMETER
;
158 if ((Count
!= 1) && (Count
!= 2) && (Count
!= 4) && (Count
!= 8)) {
159 return EFI_INVALID_PARAMETER
;
163 Status
= PciIo
->Mem
.Read (
172 Status
= PciIo
->Mem
.Write (
186 Do OR operation with the value of the specified SD/MMC host controller mmio register.
188 @param[in] PciIo The PCI IO protocol instance.
189 @param[in] BarIndex The BAR index of the standard PCI Configuration
190 header to use as the base address for the memory
191 operation to perform.
192 @param[in] Offset The offset within the selected BAR to start the
194 @param[in] Count The width of the mmio register in bytes.
195 Must be 1, 2 , 4 or 8 bytes.
196 @param[in] OrData The pointer to the data used to do OR operation.
197 The caller is responsible for having ownership of
198 the data buffer and ensuring its size not less than
201 @retval EFI_INVALID_PARAMETER The PciIo or OrData is NULL or the Count is not valid.
202 @retval EFI_SUCCESS The OR operation succeeds.
203 @retval Others The OR operation fails.
209 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
220 Status
= SdMmcHcRwMmio (PciIo
, BarIndex
, Offset
, TRUE
, Count
, &Data
);
221 if (EFI_ERROR (Status
)) {
226 Or
= *(UINT8
*) OrData
;
227 } else if (Count
== 2) {
228 Or
= *(UINT16
*) OrData
;
229 } else if (Count
== 4) {
230 Or
= *(UINT32
*) OrData
;
231 } else if (Count
== 8) {
232 Or
= *(UINT64
*) OrData
;
234 return EFI_INVALID_PARAMETER
;
238 Status
= SdMmcHcRwMmio (PciIo
, BarIndex
, Offset
, FALSE
, Count
, &Data
);
244 Do AND operation with the value of the specified SD/MMC host controller mmio register.
246 @param[in] PciIo The PCI IO protocol instance.
247 @param[in] BarIndex The BAR index of the standard PCI Configuration
248 header to use as the base address for the memory
249 operation to perform.
250 @param[in] Offset The offset within the selected BAR to start the
252 @param[in] Count The width of the mmio register in bytes.
253 Must be 1, 2 , 4 or 8 bytes.
254 @param[in] AndData The pointer to the data used to do AND operation.
255 The caller is responsible for having ownership of
256 the data buffer and ensuring its size not less than
259 @retval EFI_INVALID_PARAMETER The PciIo or AndData is NULL or the Count is not valid.
260 @retval EFI_SUCCESS The AND operation succeeds.
261 @retval Others The AND operation fails.
267 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
278 Status
= SdMmcHcRwMmio (PciIo
, BarIndex
, Offset
, TRUE
, Count
, &Data
);
279 if (EFI_ERROR (Status
)) {
284 And
= *(UINT8
*) AndData
;
285 } else if (Count
== 2) {
286 And
= *(UINT16
*) AndData
;
287 } else if (Count
== 4) {
288 And
= *(UINT32
*) AndData
;
289 } else if (Count
== 8) {
290 And
= *(UINT64
*) AndData
;
292 return EFI_INVALID_PARAMETER
;
296 Status
= SdMmcHcRwMmio (PciIo
, BarIndex
, Offset
, FALSE
, Count
, &Data
);
302 Wait for the value of the specified MMIO register set to the test value.
304 @param[in] PciIo The PCI IO protocol instance.
305 @param[in] BarIndex The BAR index of the standard PCI Configuration
306 header to use as the base address for the memory
307 operation to perform.
308 @param[in] Offset The offset within the selected BAR to start the
310 @param[in] Count The width of the mmio register in bytes.
311 Must be 1, 2, 4 or 8 bytes.
312 @param[in] MaskValue The mask value of memory.
313 @param[in] TestValue The test value of memory.
315 @retval EFI_NOT_READY The MMIO register hasn't set to the expected value.
316 @retval EFI_SUCCESS The MMIO register has expected value.
317 @retval Others The MMIO operation fails.
322 SdMmcHcCheckMmioSet (
323 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
335 // Access PCI MMIO space to see if the value is the tested one.
338 Status
= SdMmcHcRwMmio (PciIo
, BarIndex
, Offset
, TRUE
, Count
, &Value
);
339 if (EFI_ERROR (Status
)) {
345 if (Value
== TestValue
) {
349 return EFI_NOT_READY
;
353 Wait for the value of the specified MMIO register set to the test value.
355 @param[in] PciIo The PCI IO protocol instance.
356 @param[in] BarIndex The BAR index of the standard PCI Configuration
357 header to use as the base address for the memory
358 operation to perform.
359 @param[in] Offset The offset within the selected BAR to start the
361 @param[in] Count The width of the mmio register in bytes.
362 Must be 1, 2, 4 or 8 bytes.
363 @param[in] MaskValue The mask value of memory.
364 @param[in] TestValue The test value of memory.
365 @param[in] Timeout The time out value for wait memory set, uses 1
366 microsecond as a unit.
368 @retval EFI_TIMEOUT The MMIO register hasn't expected value in timeout
370 @retval EFI_SUCCESS The MMIO register has expected value.
371 @retval Others The MMIO operation fails.
377 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
387 BOOLEAN InfiniteWait
;
392 InfiniteWait
= FALSE
;
395 while (InfiniteWait
|| (Timeout
> 0)) {
396 Status
= SdMmcHcCheckMmioSet (
404 if (Status
!= EFI_NOT_READY
) {
409 // Stall for 1 microsecond.
420 Software reset the specified SD/MMC host controller and enable all interrupts.
422 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
423 @param[in] Slot The slot number of the SD card to send the command to.
425 @retval EFI_SUCCESS The software reset executes successfully.
426 @retval Others The software reset fails.
431 IN SD_MMC_HC_PRIVATE_DATA
*Private
,
437 EFI_PCI_IO_PROTOCOL
*PciIo
;
440 // Notify the SD/MMC override protocol that we are about to reset
441 // the SD/MMC host controller.
443 if (mOverride
!= NULL
&& mOverride
->NotifyPhase
!= NULL
) {
444 Status
= mOverride
->NotifyPhase (
445 Private
->ControllerHandle
,
449 if (EFI_ERROR (Status
)) {
451 "%a: SD/MMC pre reset notifier callback failed - %r\n",
452 __FUNCTION__
, Status
));
457 PciIo
= Private
->PciIo
;
459 Status
= SdMmcHcOrMmio (PciIo
, Slot
, SD_MMC_HC_SW_RST
, sizeof (SwReset
), &SwReset
);
461 if (EFI_ERROR (Status
)) {
462 DEBUG ((DEBUG_ERROR
, "SdMmcHcReset: write SW Reset for All fails: %r\n", Status
));
466 Status
= SdMmcHcWaitMmioSet (
473 SD_MMC_HC_GENERIC_TIMEOUT
475 if (EFI_ERROR (Status
)) {
476 DEBUG ((DEBUG_INFO
, "SdMmcHcReset: reset done with %r\n", Status
));
481 // Enable all interrupt after reset all.
483 Status
= SdMmcHcEnableInterrupt (PciIo
, Slot
);
484 if (EFI_ERROR (Status
)) {
485 DEBUG ((DEBUG_INFO
, "SdMmcHcReset: SdMmcHcEnableInterrupt done with %r\n",
491 // Notify the SD/MMC override protocol that we have just reset
492 // the SD/MMC host controller.
494 if (mOverride
!= NULL
&& mOverride
->NotifyPhase
!= NULL
) {
495 Status
= mOverride
->NotifyPhase (
496 Private
->ControllerHandle
,
500 if (EFI_ERROR (Status
)) {
502 "%a: SD/MMC post reset notifier callback failed - %r\n",
503 __FUNCTION__
, Status
));
511 Set all interrupt status bits in Normal and Error Interrupt Status Enable
514 @param[in] PciIo The PCI IO protocol instance.
515 @param[in] Slot The slot number of the SD card to send the command to.
517 @retval EFI_SUCCESS The operation executes successfully.
518 @retval Others The operation fails.
522 SdMmcHcEnableInterrupt (
523 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
531 // Enable all bits in Error Interrupt Status Enable Register
534 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_ERR_INT_STS_EN
, FALSE
, sizeof (IntStatus
), &IntStatus
);
535 if (EFI_ERROR (Status
)) {
539 // Enable all bits in Normal Interrupt Status Enable Register
542 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_NOR_INT_STS_EN
, FALSE
, sizeof (IntStatus
), &IntStatus
);
548 Get the capability data from the specified slot.
550 @param[in] PciIo The PCI IO protocol instance.
551 @param[in] Slot The slot number of the SD card to send the command to.
552 @param[out] Capability The buffer to store the capability data.
554 @retval EFI_SUCCESS The operation executes successfully.
555 @retval Others The operation fails.
559 SdMmcHcGetCapability (
560 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
562 OUT SD_MMC_HC_SLOT_CAP
*Capability
568 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_CAP
, TRUE
, sizeof (Cap
), &Cap
);
569 if (EFI_ERROR (Status
)) {
573 CopyMem (Capability
, &Cap
, sizeof (Cap
));
579 Get the maximum current capability data from the specified slot.
581 @param[in] PciIo The PCI IO protocol instance.
582 @param[in] Slot The slot number of the SD card to send the command to.
583 @param[out] MaxCurrent The buffer to store the maximum current capability data.
585 @retval EFI_SUCCESS The operation executes successfully.
586 @retval Others The operation fails.
590 SdMmcHcGetMaxCurrent (
591 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
593 OUT UINT64
*MaxCurrent
598 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_MAX_CURRENT_CAP
, TRUE
, sizeof (UINT64
), MaxCurrent
);
604 Detect whether there is a SD/MMC card attached at the specified SD/MMC host controller
607 Refer to SD Host Controller Simplified spec 3.0 Section 3.1 for details.
609 @param[in] PciIo The PCI IO protocol instance.
610 @param[in] Slot The slot number of the SD card to send the command to.
611 @param[out] MediaPresent The pointer to the media present boolean value.
613 @retval EFI_SUCCESS There is no media change happened.
614 @retval EFI_MEDIA_CHANGED There is media change happened.
615 @retval Others The detection fails.
620 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
622 OUT BOOLEAN
*MediaPresent
630 // Check Present State Register to see if there is a card presented.
632 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_PRESENT_STATE
, TRUE
, sizeof (PresentState
), &PresentState
);
633 if (EFI_ERROR (Status
)) {
637 if ((PresentState
& BIT16
) != 0) {
638 *MediaPresent
= TRUE
;
640 *MediaPresent
= FALSE
;
644 // Check Normal Interrupt Status Register
646 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_NOR_INT_STS
, TRUE
, sizeof (Data
), &Data
);
647 if (EFI_ERROR (Status
)) {
651 if ((Data
& (BIT6
| BIT7
)) != 0) {
653 // Clear BIT6 and BIT7 by writing 1 to these two bits if set.
656 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_NOR_INT_STS
, FALSE
, sizeof (Data
), &Data
);
657 if (EFI_ERROR (Status
)) {
661 return EFI_MEDIA_CHANGED
;
668 Stop SD/MMC card clock.
670 Refer to SD Host Controller Simplified spec 3.0 Section 3.2.2 for details.
672 @param[in] PciIo The PCI IO protocol instance.
673 @param[in] Slot The slot number of the SD card to send the command to.
675 @retval EFI_SUCCESS Succeed to stop SD/MMC clock.
676 @retval Others Fail to stop SD/MMC clock.
681 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
690 // Ensure no SD transactions are occurring on the SD Bus by
691 // waiting for Command Inhibit (DAT) and Command Inhibit (CMD)
692 // in the Present State register to be 0.
694 Status
= SdMmcHcWaitMmioSet (
697 SD_MMC_HC_PRESENT_STATE
,
698 sizeof (PresentState
),
701 SD_MMC_HC_GENERIC_TIMEOUT
703 if (EFI_ERROR (Status
)) {
708 // Set SD Clock Enable in the Clock Control register to 0
710 ClockCtrl
= (UINT16
)~BIT2
;
711 Status
= SdMmcHcAndMmio (PciIo
, Slot
, SD_MMC_HC_CLOCK_CTRL
, sizeof (ClockCtrl
), &ClockCtrl
);
717 SD/MMC card clock supply.
719 Refer to SD Host Controller Simplified spec 3.0 Section 3.2.1 for details.
721 @param[in] PciIo The PCI IO protocol instance.
722 @param[in] Slot The slot number of the SD card to send the command to.
723 @param[in] ClockFreq The max clock frequency to be set. The unit is KHz.
724 @param[in] BaseClkFreq The base clock frequency of host controller in MHz.
726 @retval EFI_SUCCESS The clock is supplied successfully.
727 @retval Others The clock isn't supplied successfully.
732 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
735 IN UINT32 BaseClkFreq
742 UINT16 ControllerVer
;
746 // Calculate a divisor for SD clock frequency
748 ASSERT (BaseClkFreq
!= 0);
750 if (ClockFreq
== 0) {
751 return EFI_INVALID_PARAMETER
;
754 if (ClockFreq
> (BaseClkFreq
* 1000)) {
755 ClockFreq
= BaseClkFreq
* 1000;
759 // Calculate the divisor of base frequency.
762 SettingFreq
= BaseClkFreq
* 1000;
763 while (ClockFreq
< SettingFreq
) {
766 SettingFreq
= (BaseClkFreq
* 1000) / (2 * Divisor
);
767 Remainder
= (BaseClkFreq
* 1000) % (2 * Divisor
);
768 if ((ClockFreq
== SettingFreq
) && (Remainder
== 0)) {
771 if ((ClockFreq
== SettingFreq
) && (Remainder
!= 0)) {
776 DEBUG ((DEBUG_INFO
, "BaseClkFreq %dMHz Divisor %d ClockFreq %dKhz\n", BaseClkFreq
, Divisor
, ClockFreq
));
778 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_CTRL_VER
, TRUE
, sizeof (ControllerVer
), &ControllerVer
);
779 if (EFI_ERROR (Status
)) {
783 // Set SDCLK Frequency Select and Internal Clock Enable fields in Clock Control register.
785 if (((ControllerVer
& 0xFF) >= SD_MMC_HC_CTRL_VER_300
) &&
786 ((ControllerVer
& 0xFF) <= SD_MMC_HC_CTRL_VER_420
)) {
787 ASSERT (Divisor
<= 0x3FF);
788 ClockCtrl
= ((Divisor
& 0xFF) << 8) | ((Divisor
& 0x300) >> 2);
789 } else if (((ControllerVer
& 0xFF) == 0) || ((ControllerVer
& 0xFF) == 1)) {
791 // Only the most significant bit can be used as divisor.
793 if (((Divisor
- 1) & Divisor
) != 0) {
794 Divisor
= 1 << (HighBitSet32 (Divisor
) + 1);
796 ASSERT (Divisor
<= 0x80);
797 ClockCtrl
= (Divisor
& 0xFF) << 8;
799 DEBUG ((DEBUG_ERROR
, "Unknown SD Host Controller Spec version [0x%x]!!!\n", ControllerVer
));
800 return EFI_UNSUPPORTED
;
804 // Stop bus clock at first
806 Status
= SdMmcHcStopClock (PciIo
, Slot
);
807 if (EFI_ERROR (Status
)) {
812 // Supply clock frequency with specified divisor
815 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_CLOCK_CTRL
, FALSE
, sizeof (ClockCtrl
), &ClockCtrl
);
816 if (EFI_ERROR (Status
)) {
817 DEBUG ((DEBUG_ERROR
, "Set SDCLK Frequency Select and Internal Clock Enable fields fails\n"));
822 // Wait Internal Clock Stable in the Clock Control register to be 1
824 Status
= SdMmcHcWaitMmioSet (
827 SD_MMC_HC_CLOCK_CTRL
,
831 SD_MMC_HC_GENERIC_TIMEOUT
833 if (EFI_ERROR (Status
)) {
838 // Set SD Clock Enable in the Clock Control register to 1
841 Status
= SdMmcHcOrMmio (PciIo
, Slot
, SD_MMC_HC_CLOCK_CTRL
, sizeof (ClockCtrl
), &ClockCtrl
);
847 SD/MMC bus power control.
849 Refer to SD Host Controller Simplified spec 3.0 Section 3.3 for details.
851 @param[in] PciIo The PCI IO protocol instance.
852 @param[in] Slot The slot number of the SD card to send the command to.
853 @param[in] PowerCtrl The value setting to the power control register.
855 @retval TRUE There is a SD/MMC card attached.
856 @retval FALSE There is no a SD/MMC card attached.
860 SdMmcHcPowerControl (
861 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
871 PowerCtrl
&= (UINT8
)~BIT0
;
872 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_POWER_CTRL
, FALSE
, sizeof (PowerCtrl
), &PowerCtrl
);
873 if (EFI_ERROR (Status
)) {
878 // Set SD Bus Voltage Select and SD Bus Power fields in Power Control Register
881 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_POWER_CTRL
, FALSE
, sizeof (PowerCtrl
), &PowerCtrl
);
887 Set the SD/MMC bus width.
889 Refer to SD Host Controller Simplified spec 3.0 Section 3.4 for details.
891 @param[in] PciIo The PCI IO protocol instance.
892 @param[in] Slot The slot number of the SD card to send the command to.
893 @param[in] BusWidth The bus width used by the SD/MMC device, it must be 1, 4 or 8.
895 @retval EFI_SUCCESS The bus width is set successfully.
896 @retval Others The bus width isn't set successfully.
901 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
910 HostCtrl1
= (UINT8
)~(BIT5
| BIT1
);
911 Status
= SdMmcHcAndMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL1
, sizeof (HostCtrl1
), &HostCtrl1
);
912 } else if (BusWidth
== 4) {
913 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL1
, TRUE
, sizeof (HostCtrl1
), &HostCtrl1
);
914 if (EFI_ERROR (Status
)) {
918 HostCtrl1
&= (UINT8
)~BIT5
;
919 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL1
, FALSE
, sizeof (HostCtrl1
), &HostCtrl1
);
920 } else if (BusWidth
== 8) {
921 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL1
, TRUE
, sizeof (HostCtrl1
), &HostCtrl1
);
922 if (EFI_ERROR (Status
)) {
925 HostCtrl1
&= (UINT8
)~BIT1
;
927 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL1
, FALSE
, sizeof (HostCtrl1
), &HostCtrl1
);
930 return EFI_INVALID_PARAMETER
;
937 Supply SD/MMC card with lowest clock frequency at initialization.
939 @param[in] PciIo The PCI IO protocol instance.
940 @param[in] Slot The slot number of the SD card to send the command to.
941 @param[in] BaseClkFreq The base clock frequency of host controller in MHz.
943 @retval EFI_SUCCESS The clock is supplied successfully.
944 @retval Others The clock isn't supplied successfully.
948 SdMmcHcInitClockFreq (
949 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
951 IN UINT32 BaseClkFreq
958 // According to SDHCI specification ver. 4.2, BaseClkFreq field value of
959 // the Capability Register 1 can be zero, which means a need for obtaining
960 // the clock frequency via another method. Fail in case it is not updated
961 // by SW at this point.
963 if (BaseClkFreq
== 0) {
965 // Don't support get Base Clock Frequency information via another method
967 return EFI_UNSUPPORTED
;
970 // Supply 400KHz clock frequency at initialization phase.
973 Status
= SdMmcHcClockSupply (PciIo
, Slot
, InitFreq
, BaseClkFreq
);
978 Supply SD/MMC card with maximum voltage at initialization.
980 Refer to SD Host Controller Simplified spec 3.0 Section 3.3 for details.
982 @param[in] PciIo The PCI IO protocol instance.
983 @param[in] Slot The slot number of the SD card to send the command to.
984 @param[in] Capability The capability of the slot.
986 @retval EFI_SUCCESS The voltage is supplied successfully.
987 @retval Others The voltage isn't supplied successfully.
991 SdMmcHcInitPowerVoltage (
992 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
994 IN SD_MMC_HC_SLOT_CAP Capability
1002 // Calculate supported maximum voltage according to SD Bus Voltage Select
1004 if (Capability
.Voltage33
!= 0) {
1009 } else if (Capability
.Voltage30
!= 0) {
1014 } else if (Capability
.Voltage18
!= 0) {
1020 Status
= SdMmcHcOrMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL2
, sizeof (HostCtrl2
), &HostCtrl2
);
1022 if (EFI_ERROR (Status
)) {
1027 return EFI_DEVICE_ERROR
;
1031 // Set SD Bus Voltage Select and SD Bus Power fields in Power Control Register
1033 Status
= SdMmcHcPowerControl (PciIo
, Slot
, MaxVoltage
);
1039 Initialize the Timeout Control register with most conservative value at initialization.
1041 Refer to SD Host Controller Simplified spec 3.0 Section 2.2.15 for details.
1043 @param[in] PciIo The PCI IO protocol instance.
1044 @param[in] Slot The slot number of the SD card to send the command to.
1046 @retval EFI_SUCCESS The timeout control register is configured successfully.
1047 @retval Others The timeout control register isn't configured successfully.
1051 SdMmcHcInitTimeoutCtrl (
1052 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
1060 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_TIMEOUT_CTRL
, FALSE
, sizeof (Timeout
), &Timeout
);
1066 Initial SD/MMC host controller with lowest clock frequency, max power and max timeout value
1069 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
1070 @param[in] Slot The slot number of the SD card to send the command to.
1072 @retval EFI_SUCCESS The host controller is initialized successfully.
1073 @retval Others The host controller isn't initialized successfully.
1078 IN SD_MMC_HC_PRIVATE_DATA
*Private
,
1083 EFI_PCI_IO_PROTOCOL
*PciIo
;
1084 SD_MMC_HC_SLOT_CAP Capability
;
1087 // Notify the SD/MMC override protocol that we are about to initialize
1088 // the SD/MMC host controller.
1090 if (mOverride
!= NULL
&& mOverride
->NotifyPhase
!= NULL
) {
1091 Status
= mOverride
->NotifyPhase (
1092 Private
->ControllerHandle
,
1094 EdkiiSdMmcInitHostPre
,
1096 if (EFI_ERROR (Status
)) {
1098 "%a: SD/MMC pre init notifier callback failed - %r\n",
1099 __FUNCTION__
, Status
));
1104 PciIo
= Private
->PciIo
;
1105 Capability
= Private
->Capability
[Slot
];
1107 Status
= SdMmcHcInitClockFreq (PciIo
, Slot
, Private
->BaseClkFreq
[Slot
]);
1108 if (EFI_ERROR (Status
)) {
1112 Status
= SdMmcHcInitPowerVoltage (PciIo
, Slot
, Capability
);
1113 if (EFI_ERROR (Status
)) {
1117 Status
= SdMmcHcInitTimeoutCtrl (PciIo
, Slot
);
1118 if (EFI_ERROR (Status
)) {
1123 // Notify the SD/MMC override protocol that we are have just initialized
1124 // the SD/MMC host controller.
1126 if (mOverride
!= NULL
&& mOverride
->NotifyPhase
!= NULL
) {
1127 Status
= mOverride
->NotifyPhase (
1128 Private
->ControllerHandle
,
1130 EdkiiSdMmcInitHostPost
,
1132 if (EFI_ERROR (Status
)) {
1134 "%a: SD/MMC post init notifier callback failed - %r\n",
1135 __FUNCTION__
, Status
));
1142 Set SD Host Controler control 2 registry according to selected speed.
1144 @param[in] ControllerHandle The handle of the controller.
1145 @param[in] PciIo The PCI IO protocol instance.
1146 @param[in] Slot The slot number of the SD card to send the command to.
1147 @param[in] Timing The timing to select.
1149 @retval EFI_SUCCESS The timing is set successfully.
1150 @retval Others The timing isn't set successfully.
1153 SdMmcHcUhsSignaling (
1154 IN EFI_HANDLE ControllerHandle
,
1155 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
1157 IN SD_MMC_BUS_MODE Timing
1163 HostCtrl2
= (UINT8
)~SD_MMC_HC_CTRL_UHS_MASK
;
1164 Status
= SdMmcHcAndMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL2
, sizeof (HostCtrl2
), &HostCtrl2
);
1165 if (EFI_ERROR (Status
)) {
1171 HostCtrl2
= SD_MMC_HC_CTRL_UHS_SDR12
;
1174 HostCtrl2
= SD_MMC_HC_CTRL_UHS_SDR25
;
1177 HostCtrl2
= SD_MMC_HC_CTRL_UHS_SDR50
;
1179 case SdMmcUhsSdr104
:
1180 HostCtrl2
= SD_MMC_HC_CTRL_UHS_SDR104
;
1183 HostCtrl2
= SD_MMC_HC_CTRL_UHS_DDR50
;
1185 case SdMmcMmcLegacy
:
1186 HostCtrl2
= SD_MMC_HC_CTRL_MMC_LEGACY
;
1189 HostCtrl2
= SD_MMC_HC_CTRL_MMC_HS_SDR
;
1192 HostCtrl2
= SD_MMC_HC_CTRL_MMC_HS_DDR
;
1195 HostCtrl2
= SD_MMC_HC_CTRL_MMC_HS200
;
1198 HostCtrl2
= SD_MMC_HC_CTRL_MMC_HS400
;
1204 Status
= SdMmcHcOrMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL2
, sizeof (HostCtrl2
), &HostCtrl2
);
1205 if (EFI_ERROR (Status
)) {
1209 if (mOverride
!= NULL
&& mOverride
->NotifyPhase
!= NULL
) {
1210 Status
= mOverride
->NotifyPhase (
1213 EdkiiSdMmcUhsSignaling
,
1216 if (EFI_ERROR (Status
)) {
1219 "%a: SD/MMC uhs signaling notifier callback failed - %r\n",
1233 @param[in] PciIo The PCI IO protocol instance.
1234 @param[in] Slot The slot number of the SD card to send the command to.
1235 @param[in] On The boolean to turn on/off LED.
1237 @retval EFI_SUCCESS The LED is turned on/off successfully.
1238 @retval Others The LED isn't turned on/off successfully.
1243 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
1253 Status
= SdMmcHcOrMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL1
, sizeof (HostCtrl1
), &HostCtrl1
);
1255 HostCtrl1
= (UINT8
)~BIT0
;
1256 Status
= SdMmcHcAndMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL1
, sizeof (HostCtrl1
), &HostCtrl1
);
1263 Build ADMA descriptor table for transfer.
1265 Refer to SD Host Controller Simplified spec 3.0 Section 1.13 for details.
1267 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.
1269 @retval EFI_SUCCESS The ADMA descriptor table is created successfully.
1270 @retval Others The ADMA descriptor table isn't created successfully.
1274 BuildAdmaDescTable (
1275 IN SD_MMC_HC_TRB
*Trb
1278 EFI_PHYSICAL_ADDRESS Data
;
1285 EFI_PCI_IO_PROTOCOL
*PciIo
;
1289 Data
= Trb
->DataPhy
;
1290 DataLen
= Trb
->DataLen
;
1291 PciIo
= Trb
->Private
->PciIo
;
1293 // Only support 32bit ADMA Descriptor Table
1295 if ((Data
>= 0x100000000ul
) || ((Data
+ DataLen
) > 0x100000000ul
)) {
1296 return EFI_INVALID_PARAMETER
;
1299 // Address field shall be set on 32-bit boundary (Lower 2-bit is always set to 0)
1300 // for 32-bit address descriptor table.
1302 if ((Data
& (BIT0
| BIT1
)) != 0) {
1303 DEBUG ((DEBUG_INFO
, "The buffer [0x%x] to construct ADMA desc is not aligned to 4 bytes boundary!\n", Data
));
1306 Entries
= DivU64x32 ((DataLen
+ ADMA_MAX_DATA_PER_LINE
- 1), ADMA_MAX_DATA_PER_LINE
);
1307 TableSize
= (UINTN
)MultU64x32 (Entries
, sizeof (SD_MMC_HC_ADMA_DESC_LINE
));
1308 Trb
->AdmaPages
= (UINT32
)EFI_SIZE_TO_PAGES (TableSize
);
1309 Status
= PciIo
->AllocateBuffer (
1312 EfiBootServicesData
,
1313 EFI_SIZE_TO_PAGES (TableSize
),
1314 (VOID
**)&Trb
->AdmaDesc
,
1317 if (EFI_ERROR (Status
)) {
1318 return EFI_OUT_OF_RESOURCES
;
1320 ZeroMem (Trb
->AdmaDesc
, TableSize
);
1322 Status
= PciIo
->Map (
1324 EfiPciIoOperationBusMasterCommonBuffer
,
1331 if (EFI_ERROR (Status
) || (Bytes
!= TableSize
)) {
1333 // Map error or unable to map the whole RFis buffer into a contiguous region.
1337 EFI_SIZE_TO_PAGES (TableSize
),
1340 return EFI_OUT_OF_RESOURCES
;
1343 if ((UINT64
)(UINTN
)Trb
->AdmaDescPhy
> 0x100000000ul
) {
1345 // The ADMA doesn't support 64bit addressing.
1353 EFI_SIZE_TO_PAGES (TableSize
),
1356 return EFI_DEVICE_ERROR
;
1359 Remaining
= DataLen
;
1360 Address
= (UINT32
)Data
;
1361 for (Index
= 0; Index
< Entries
; Index
++) {
1362 if (Remaining
<= ADMA_MAX_DATA_PER_LINE
) {
1363 Trb
->AdmaDesc
[Index
].Valid
= 1;
1364 Trb
->AdmaDesc
[Index
].Act
= 2;
1365 Trb
->AdmaDesc
[Index
].Length
= (UINT16
)Remaining
;
1366 Trb
->AdmaDesc
[Index
].Address
= Address
;
1369 Trb
->AdmaDesc
[Index
].Valid
= 1;
1370 Trb
->AdmaDesc
[Index
].Act
= 2;
1371 Trb
->AdmaDesc
[Index
].Length
= 0;
1372 Trb
->AdmaDesc
[Index
].Address
= Address
;
1375 Remaining
-= ADMA_MAX_DATA_PER_LINE
;
1376 Address
+= ADMA_MAX_DATA_PER_LINE
;
1380 // Set the last descriptor line as end of descriptor table
1382 Trb
->AdmaDesc
[Index
].End
= 1;
1387 Create a new TRB for the SD/MMC cmd request.
1389 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
1390 @param[in] Slot The slot number of the SD card to send the command to.
1391 @param[in] Packet A pointer to the SD command data structure.
1392 @param[in] Event If Event is NULL, blocking I/O is performed. If Event is
1393 not NULL, then nonblocking I/O is performed, and Event
1394 will be signaled when the Packet completes.
1396 @return Created Trb or NULL.
1401 IN SD_MMC_HC_PRIVATE_DATA
*Private
,
1403 IN EFI_SD_MMC_PASS_THRU_COMMAND_PACKET
*Packet
,
1410 EFI_PCI_IO_PROTOCOL_OPERATION Flag
;
1411 EFI_PCI_IO_PROTOCOL
*PciIo
;
1414 Trb
= AllocateZeroPool (sizeof (SD_MMC_HC_TRB
));
1419 Trb
->Signature
= SD_MMC_HC_TRB_SIG
;
1421 Trb
->BlockSize
= 0x200;
1422 Trb
->Packet
= Packet
;
1424 Trb
->Started
= FALSE
;
1425 Trb
->Timeout
= Packet
->Timeout
;
1426 Trb
->Private
= Private
;
1428 if ((Packet
->InTransferLength
!= 0) && (Packet
->InDataBuffer
!= NULL
)) {
1429 Trb
->Data
= Packet
->InDataBuffer
;
1430 Trb
->DataLen
= Packet
->InTransferLength
;
1432 } else if ((Packet
->OutTransferLength
!= 0) && (Packet
->OutDataBuffer
!= NULL
)) {
1433 Trb
->Data
= Packet
->OutDataBuffer
;
1434 Trb
->DataLen
= Packet
->OutTransferLength
;
1436 } else if ((Packet
->InTransferLength
== 0) && (Packet
->OutTransferLength
== 0)) {
1443 if ((Trb
->DataLen
!= 0) && (Trb
->DataLen
< Trb
->BlockSize
)) {
1444 Trb
->BlockSize
= (UINT16
)Trb
->DataLen
;
1447 if (((Private
->Slot
[Trb
->Slot
].CardType
== EmmcCardType
) &&
1448 (Packet
->SdMmcCmdBlk
->CommandIndex
== EMMC_SEND_TUNING_BLOCK
)) ||
1449 ((Private
->Slot
[Trb
->Slot
].CardType
== SdCardType
) &&
1450 (Packet
->SdMmcCmdBlk
->CommandIndex
== SD_SEND_TUNING_BLOCK
))) {
1451 Trb
->Mode
= SdMmcPioMode
;
1454 Flag
= EfiPciIoOperationBusMasterWrite
;
1456 Flag
= EfiPciIoOperationBusMasterRead
;
1459 PciIo
= Private
->PciIo
;
1460 if (Trb
->DataLen
!= 0) {
1461 MapLength
= Trb
->DataLen
;
1462 Status
= PciIo
->Map (
1470 if (EFI_ERROR (Status
) || (Trb
->DataLen
!= MapLength
)) {
1471 Status
= EFI_BAD_BUFFER_SIZE
;
1476 if (Trb
->DataLen
== 0) {
1477 Trb
->Mode
= SdMmcNoData
;
1478 } else if (Private
->Capability
[Slot
].Adma2
!= 0) {
1479 Trb
->Mode
= SdMmcAdmaMode
;
1480 Status
= BuildAdmaDescTable (Trb
);
1481 if (EFI_ERROR (Status
)) {
1482 PciIo
->Unmap (PciIo
, Trb
->DataMap
);
1485 } else if (Private
->Capability
[Slot
].Sdma
!= 0) {
1486 Trb
->Mode
= SdMmcSdmaMode
;
1488 Trb
->Mode
= SdMmcPioMode
;
1492 if (Event
!= NULL
) {
1493 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
1494 InsertTailList (&Private
->Queue
, &Trb
->TrbList
);
1495 gBS
->RestoreTPL (OldTpl
);
1506 Free the resource used by the TRB.
1508 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.
1513 IN SD_MMC_HC_TRB
*Trb
1516 EFI_PCI_IO_PROTOCOL
*PciIo
;
1518 PciIo
= Trb
->Private
->PciIo
;
1520 if (Trb
->AdmaMap
!= NULL
) {
1526 if (Trb
->AdmaDesc
!= NULL
) {
1533 if (Trb
->DataMap
!= NULL
) {
1544 Check if the env is ready for execute specified TRB.
1546 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
1547 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.
1549 @retval EFI_SUCCESS The env is ready for TRB execution.
1550 @retval EFI_NOT_READY The env is not ready for TRB execution.
1551 @retval Others Some erros happen.
1556 IN SD_MMC_HC_PRIVATE_DATA
*Private
,
1557 IN SD_MMC_HC_TRB
*Trb
1561 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET
*Packet
;
1562 EFI_PCI_IO_PROTOCOL
*PciIo
;
1563 UINT32 PresentState
;
1565 Packet
= Trb
->Packet
;
1567 if ((Packet
->SdMmcCmdBlk
->CommandType
== SdMmcCommandTypeAdtc
) ||
1568 (Packet
->SdMmcCmdBlk
->ResponseType
== SdMmcResponseTypeR1b
) ||
1569 (Packet
->SdMmcCmdBlk
->ResponseType
== SdMmcResponseTypeR5b
)) {
1571 // Wait Command Inhibit (CMD) and Command Inhibit (DAT) in
1572 // the Present State register to be 0
1574 PresentState
= BIT0
| BIT1
;
1577 // Wait Command Inhibit (CMD) in the Present State register
1580 PresentState
= BIT0
;
1583 PciIo
= Private
->PciIo
;
1584 Status
= SdMmcHcCheckMmioSet (
1587 SD_MMC_HC_PRESENT_STATE
,
1588 sizeof (PresentState
),
1597 Wait for the env to be ready for execute specified TRB.
1599 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
1600 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.
1602 @retval EFI_SUCCESS The env is ready for TRB execution.
1603 @retval EFI_TIMEOUT The env is not ready for TRB execution in time.
1604 @retval Others Some erros happen.
1609 IN SD_MMC_HC_PRIVATE_DATA
*Private
,
1610 IN SD_MMC_HC_TRB
*Trb
1614 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET
*Packet
;
1616 BOOLEAN InfiniteWait
;
1619 // Wait Command Complete Interrupt Status bit in Normal Interrupt Status Register
1621 Packet
= Trb
->Packet
;
1622 Timeout
= Packet
->Timeout
;
1624 InfiniteWait
= TRUE
;
1626 InfiniteWait
= FALSE
;
1629 while (InfiniteWait
|| (Timeout
> 0)) {
1631 // Check Trb execution result by reading Normal Interrupt Status register.
1633 Status
= SdMmcCheckTrbEnv (Private
, Trb
);
1634 if (Status
!= EFI_NOT_READY
) {
1638 // Stall for 1 microsecond.
1649 Execute the specified TRB.
1651 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
1652 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.
1654 @retval EFI_SUCCESS The TRB is sent to host controller successfully.
1655 @retval Others Some erros happen when sending this request to the host controller.
1660 IN SD_MMC_HC_PRIVATE_DATA
*Private
,
1661 IN SD_MMC_HC_TRB
*Trb
1665 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET
*Packet
;
1666 EFI_PCI_IO_PROTOCOL
*PciIo
;
1677 Packet
= Trb
->Packet
;
1678 PciIo
= Trb
->Private
->PciIo
;
1680 // Clear all bits in Error Interrupt Status Register
1683 Status
= SdMmcHcRwMmio (PciIo
, Trb
->Slot
, SD_MMC_HC_ERR_INT_STS
, FALSE
, sizeof (IntStatus
), &IntStatus
);
1684 if (EFI_ERROR (Status
)) {
1688 // Clear all bits in Normal Interrupt Status Register excepts for Card Removal & Card Insertion bits.
1691 Status
= SdMmcHcRwMmio (PciIo
, Trb
->Slot
, SD_MMC_HC_NOR_INT_STS
, FALSE
, sizeof (IntStatus
), &IntStatus
);
1692 if (EFI_ERROR (Status
)) {
1696 // Set Host Control 1 register DMA Select field
1698 if (Trb
->Mode
== SdMmcAdmaMode
) {
1700 Status
= SdMmcHcOrMmio (PciIo
, Trb
->Slot
, SD_MMC_HC_HOST_CTRL1
, sizeof (HostCtrl1
), &HostCtrl1
);
1701 if (EFI_ERROR (Status
)) {
1706 SdMmcHcLedOnOff (PciIo
, Trb
->Slot
, TRUE
);
1708 if (Trb
->Mode
== SdMmcSdmaMode
) {
1709 if ((UINT64
)(UINTN
)Trb
->DataPhy
>= 0x100000000ul
) {
1710 return EFI_INVALID_PARAMETER
;
1713 SdmaAddr
= (UINT32
)(UINTN
)Trb
->DataPhy
;
1714 Status
= SdMmcHcRwMmio (PciIo
, Trb
->Slot
, SD_MMC_HC_SDMA_ADDR
, FALSE
, sizeof (SdmaAddr
), &SdmaAddr
);
1715 if (EFI_ERROR (Status
)) {
1718 } else if (Trb
->Mode
== SdMmcAdmaMode
) {
1719 AdmaAddr
= (UINT64
)(UINTN
)Trb
->AdmaDescPhy
;
1720 Status
= SdMmcHcRwMmio (PciIo
, Trb
->Slot
, SD_MMC_HC_ADMA_SYS_ADDR
, FALSE
, sizeof (AdmaAddr
), &AdmaAddr
);
1721 if (EFI_ERROR (Status
)) {
1726 BlkSize
= Trb
->BlockSize
;
1727 if (Trb
->Mode
== SdMmcSdmaMode
) {
1729 // Set SDMA boundary to be 512K bytes.
1734 Status
= SdMmcHcRwMmio (PciIo
, Trb
->Slot
, SD_MMC_HC_BLK_SIZE
, FALSE
, sizeof (BlkSize
), &BlkSize
);
1735 if (EFI_ERROR (Status
)) {
1740 if (Trb
->Mode
!= SdMmcNoData
) {
1742 // Calcuate Block Count.
1744 BlkCount
= (UINT16
)(Trb
->DataLen
/ Trb
->BlockSize
);
1746 Status
= SdMmcHcRwMmio (PciIo
, Trb
->Slot
, SD_MMC_HC_BLK_COUNT
, FALSE
, sizeof (BlkCount
), &BlkCount
);
1747 if (EFI_ERROR (Status
)) {
1751 Argument
= Packet
->SdMmcCmdBlk
->CommandArgument
;
1752 Status
= SdMmcHcRwMmio (PciIo
, Trb
->Slot
, SD_MMC_HC_ARG1
, FALSE
, sizeof (Argument
), &Argument
);
1753 if (EFI_ERROR (Status
)) {
1758 if (Trb
->Mode
!= SdMmcNoData
) {
1759 if (Trb
->Mode
!= SdMmcPioMode
) {
1766 TransMode
|= BIT5
| BIT1
;
1769 // Only SD memory card needs to use AUTO CMD12 feature.
1771 if (Private
->Slot
[Trb
->Slot
].CardType
== SdCardType
) {
1778 Status
= SdMmcHcRwMmio (PciIo
, Trb
->Slot
, SD_MMC_HC_TRANS_MOD
, FALSE
, sizeof (TransMode
), &TransMode
);
1779 if (EFI_ERROR (Status
)) {
1783 Cmd
= (UINT16
)LShiftU64(Packet
->SdMmcCmdBlk
->CommandIndex
, 8);
1784 if (Packet
->SdMmcCmdBlk
->CommandType
== SdMmcCommandTypeAdtc
) {
1788 // Convert ResponseType to value
1790 if (Packet
->SdMmcCmdBlk
->CommandType
!= SdMmcCommandTypeBc
) {
1791 switch (Packet
->SdMmcCmdBlk
->ResponseType
) {
1792 case SdMmcResponseTypeR1
:
1793 case SdMmcResponseTypeR5
:
1794 case SdMmcResponseTypeR6
:
1795 case SdMmcResponseTypeR7
:
1796 Cmd
|= (BIT1
| BIT3
| BIT4
);
1798 case SdMmcResponseTypeR2
:
1799 Cmd
|= (BIT0
| BIT3
);
1801 case SdMmcResponseTypeR3
:
1802 case SdMmcResponseTypeR4
:
1805 case SdMmcResponseTypeR1b
:
1806 case SdMmcResponseTypeR5b
:
1807 Cmd
|= (BIT0
| BIT1
| BIT3
| BIT4
);
1817 Status
= SdMmcHcRwMmio (PciIo
, Trb
->Slot
, SD_MMC_HC_COMMAND
, FALSE
, sizeof (Cmd
), &Cmd
);
1822 Check the TRB execution result.
1824 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
1825 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.
1827 @retval EFI_SUCCESS The TRB is executed successfully.
1828 @retval EFI_NOT_READY The TRB is not completed for execution.
1829 @retval Others Some erros happen when executing this request.
1833 SdMmcCheckTrbResult (
1834 IN SD_MMC_HC_PRIVATE_DATA
*Private
,
1835 IN SD_MMC_HC_TRB
*Trb
1839 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET
*Packet
;
1848 Packet
= Trb
->Packet
;
1850 // Check Trb execution result by reading Normal Interrupt Status register.
1852 Status
= SdMmcHcRwMmio (
1855 SD_MMC_HC_NOR_INT_STS
,
1860 if (EFI_ERROR (Status
)) {
1864 // Check Transfer Complete bit is set or not.
1866 if ((IntStatus
& BIT1
) == BIT1
) {
1867 if ((IntStatus
& BIT15
) == BIT15
) {
1869 // Read Error Interrupt Status register to check if the error is
1870 // Data Timeout Error.
1871 // If yes, treat it as success as Transfer Complete has higher
1872 // priority than Data Timeout Error.
1874 Status
= SdMmcHcRwMmio (
1877 SD_MMC_HC_ERR_INT_STS
,
1882 if (!EFI_ERROR (Status
)) {
1883 if ((IntStatus
& BIT4
) == BIT4
) {
1884 Status
= EFI_SUCCESS
;
1886 Status
= EFI_DEVICE_ERROR
;
1894 // Check if there is a error happened during cmd execution.
1895 // If yes, then do error recovery procedure to follow SD Host Controller
1896 // Simplified Spec 3.0 section 3.10.1.
1898 if ((IntStatus
& BIT15
) == BIT15
) {
1899 Status
= SdMmcHcRwMmio (
1902 SD_MMC_HC_ERR_INT_STS
,
1907 if (EFI_ERROR (Status
)) {
1910 if ((IntStatus
& 0x0F) != 0) {
1913 if ((IntStatus
& 0xF0) != 0) {
1917 Status
= SdMmcHcRwMmio (
1925 if (EFI_ERROR (Status
)) {
1928 Status
= SdMmcHcWaitMmioSet (
1935 SD_MMC_HC_GENERIC_TIMEOUT
1937 if (EFI_ERROR (Status
)) {
1941 Status
= EFI_DEVICE_ERROR
;
1945 // Check if DMA interrupt is signalled for the SDMA transfer.
1947 if ((Trb
->Mode
== SdMmcSdmaMode
) && ((IntStatus
& BIT3
) == BIT3
)) {
1949 // Clear DMA interrupt bit.
1952 Status
= SdMmcHcRwMmio (
1955 SD_MMC_HC_NOR_INT_STS
,
1960 if (EFI_ERROR (Status
)) {
1964 // Update SDMA Address register.
1966 SdmaAddr
= SD_MMC_SDMA_ROUND_UP ((UINT32
)(UINTN
)Trb
->DataPhy
, SD_MMC_SDMA_BOUNDARY
);
1967 Status
= SdMmcHcRwMmio (
1970 SD_MMC_HC_SDMA_ADDR
,
1975 if (EFI_ERROR (Status
)) {
1978 Trb
->DataPhy
= (UINT32
)(UINTN
)SdmaAddr
;
1981 if ((Packet
->SdMmcCmdBlk
->CommandType
!= SdMmcCommandTypeAdtc
) &&
1982 (Packet
->SdMmcCmdBlk
->ResponseType
!= SdMmcResponseTypeR1b
) &&
1983 (Packet
->SdMmcCmdBlk
->ResponseType
!= SdMmcResponseTypeR5b
)) {
1984 if ((IntStatus
& BIT0
) == BIT0
) {
1985 Status
= EFI_SUCCESS
;
1990 if (((Private
->Slot
[Trb
->Slot
].CardType
== EmmcCardType
) &&
1991 (Packet
->SdMmcCmdBlk
->CommandIndex
== EMMC_SEND_TUNING_BLOCK
)) ||
1992 ((Private
->Slot
[Trb
->Slot
].CardType
== SdCardType
) &&
1993 (Packet
->SdMmcCmdBlk
->CommandIndex
== SD_SEND_TUNING_BLOCK
))) {
1995 // When performing tuning procedure (Execute Tuning is set to 1) through PIO mode,
1996 // wait Buffer Read Ready bit of Normal Interrupt Status Register to be 1.
1997 // Refer to SD Host Controller Simplified Specification 3.0 figure 2-29 for details.
1999 if ((IntStatus
& BIT5
) == BIT5
) {
2001 // Clear Buffer Read Ready interrupt at first.
2004 SdMmcHcRwMmio (Private
->PciIo
, Trb
->Slot
, SD_MMC_HC_NOR_INT_STS
, FALSE
, sizeof (IntStatus
), &IntStatus
);
2006 // Read data out from Buffer Port register
2008 for (PioLength
= 0; PioLength
< Trb
->DataLen
; PioLength
+= 4) {
2009 SdMmcHcRwMmio (Private
->PciIo
, Trb
->Slot
, SD_MMC_HC_BUF_DAT_PORT
, TRUE
, 4, (UINT8
*)Trb
->Data
+ PioLength
);
2011 Status
= EFI_SUCCESS
;
2016 Status
= EFI_NOT_READY
;
2019 // Get response data when the cmd is executed successfully.
2021 if (!EFI_ERROR (Status
)) {
2022 if (Packet
->SdMmcCmdBlk
->CommandType
!= SdMmcCommandTypeBc
) {
2023 for (Index
= 0; Index
< 4; Index
++) {
2024 Status
= SdMmcHcRwMmio (
2027 SD_MMC_HC_RESPONSE
+ Index
* 4,
2032 if (EFI_ERROR (Status
)) {
2033 SdMmcHcLedOnOff (Private
->PciIo
, Trb
->Slot
, FALSE
);
2037 CopyMem (Packet
->SdMmcStatusBlk
, Response
, sizeof (Response
));
2041 if (Status
!= EFI_NOT_READY
) {
2042 SdMmcHcLedOnOff (Private
->PciIo
, Trb
->Slot
, FALSE
);
2049 Wait for the TRB execution result.
2051 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
2052 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.
2054 @retval EFI_SUCCESS The TRB is executed successfully.
2055 @retval Others Some erros happen when executing this request.
2059 SdMmcWaitTrbResult (
2060 IN SD_MMC_HC_PRIVATE_DATA
*Private
,
2061 IN SD_MMC_HC_TRB
*Trb
2065 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET
*Packet
;
2067 BOOLEAN InfiniteWait
;
2069 Packet
= Trb
->Packet
;
2071 // Wait Command Complete Interrupt Status bit in Normal Interrupt Status Register
2073 Timeout
= Packet
->Timeout
;
2075 InfiniteWait
= TRUE
;
2077 InfiniteWait
= FALSE
;
2080 while (InfiniteWait
|| (Timeout
> 0)) {
2082 // Check Trb execution result by reading Normal Interrupt Status register.
2084 Status
= SdMmcCheckTrbResult (Private
, Trb
);
2085 if (Status
!= EFI_NOT_READY
) {
2089 // Stall for 1 microsecond.