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
,
448 if (EFI_ERROR (Status
)) {
450 "%a: SD/MMC pre reset notifier callback failed - %r\n",
451 __FUNCTION__
, Status
));
456 PciIo
= Private
->PciIo
;
458 Status
= SdMmcHcOrMmio (PciIo
, Slot
, SD_MMC_HC_SW_RST
, sizeof (SwReset
), &SwReset
);
460 if (EFI_ERROR (Status
)) {
461 DEBUG ((DEBUG_ERROR
, "SdMmcHcReset: write SW Reset for All fails: %r\n", Status
));
465 Status
= SdMmcHcWaitMmioSet (
472 SD_MMC_HC_GENERIC_TIMEOUT
474 if (EFI_ERROR (Status
)) {
475 DEBUG ((DEBUG_INFO
, "SdMmcHcReset: reset done with %r\n", Status
));
480 // Enable all interrupt after reset all.
482 Status
= SdMmcHcEnableInterrupt (PciIo
, Slot
);
483 if (EFI_ERROR (Status
)) {
484 DEBUG ((DEBUG_INFO
, "SdMmcHcReset: SdMmcHcEnableInterrupt done with %r\n",
490 // Notify the SD/MMC override protocol that we have just reset
491 // the SD/MMC host controller.
493 if (mOverride
!= NULL
&& mOverride
->NotifyPhase
!= NULL
) {
494 Status
= mOverride
->NotifyPhase (
495 Private
->ControllerHandle
,
497 EdkiiSdMmcResetPost
);
498 if (EFI_ERROR (Status
)) {
500 "%a: SD/MMC post reset notifier callback failed - %r\n",
501 __FUNCTION__
, Status
));
509 Set all interrupt status bits in Normal and Error Interrupt Status Enable
512 @param[in] PciIo The PCI IO protocol instance.
513 @param[in] Slot The slot number of the SD card to send the command to.
515 @retval EFI_SUCCESS The operation executes successfully.
516 @retval Others The operation fails.
520 SdMmcHcEnableInterrupt (
521 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
529 // Enable all bits in Error Interrupt Status Enable Register
532 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_ERR_INT_STS_EN
, FALSE
, sizeof (IntStatus
), &IntStatus
);
533 if (EFI_ERROR (Status
)) {
537 // Enable all bits in Normal Interrupt Status Enable Register
540 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_NOR_INT_STS_EN
, FALSE
, sizeof (IntStatus
), &IntStatus
);
546 Get the capability data from the specified slot.
548 @param[in] PciIo The PCI IO protocol instance.
549 @param[in] Slot The slot number of the SD card to send the command to.
550 @param[out] Capability The buffer to store the capability data.
552 @retval EFI_SUCCESS The operation executes successfully.
553 @retval Others The operation fails.
557 SdMmcHcGetCapability (
558 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
560 OUT SD_MMC_HC_SLOT_CAP
*Capability
566 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_CAP
, TRUE
, sizeof (Cap
), &Cap
);
567 if (EFI_ERROR (Status
)) {
571 CopyMem (Capability
, &Cap
, sizeof (Cap
));
577 Get the maximum current capability data from the specified slot.
579 @param[in] PciIo The PCI IO protocol instance.
580 @param[in] Slot The slot number of the SD card to send the command to.
581 @param[out] MaxCurrent The buffer to store the maximum current capability data.
583 @retval EFI_SUCCESS The operation executes successfully.
584 @retval Others The operation fails.
588 SdMmcHcGetMaxCurrent (
589 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
591 OUT UINT64
*MaxCurrent
596 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_MAX_CURRENT_CAP
, TRUE
, sizeof (UINT64
), MaxCurrent
);
602 Detect whether there is a SD/MMC card attached at the specified SD/MMC host controller
605 Refer to SD Host Controller Simplified spec 3.0 Section 3.1 for details.
607 @param[in] PciIo The PCI IO protocol instance.
608 @param[in] Slot The slot number of the SD card to send the command to.
609 @param[out] MediaPresent The pointer to the media present boolean value.
611 @retval EFI_SUCCESS There is no media change happened.
612 @retval EFI_MEDIA_CHANGED There is media change happened.
613 @retval Others The detection fails.
618 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
620 OUT BOOLEAN
*MediaPresent
628 // Check Present State Register to see if there is a card presented.
630 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_PRESENT_STATE
, TRUE
, sizeof (PresentState
), &PresentState
);
631 if (EFI_ERROR (Status
)) {
635 if ((PresentState
& BIT16
) != 0) {
636 *MediaPresent
= TRUE
;
638 *MediaPresent
= FALSE
;
642 // Check Normal Interrupt Status Register
644 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_NOR_INT_STS
, TRUE
, sizeof (Data
), &Data
);
645 if (EFI_ERROR (Status
)) {
649 if ((Data
& (BIT6
| BIT7
)) != 0) {
651 // Clear BIT6 and BIT7 by writing 1 to these two bits if set.
654 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_NOR_INT_STS
, FALSE
, sizeof (Data
), &Data
);
655 if (EFI_ERROR (Status
)) {
659 return EFI_MEDIA_CHANGED
;
666 Stop SD/MMC card clock.
668 Refer to SD Host Controller Simplified spec 3.0 Section 3.2.2 for details.
670 @param[in] PciIo The PCI IO protocol instance.
671 @param[in] Slot The slot number of the SD card to send the command to.
673 @retval EFI_SUCCESS Succeed to stop SD/MMC clock.
674 @retval Others Fail to stop SD/MMC clock.
679 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
688 // Ensure no SD transactions are occurring on the SD Bus by
689 // waiting for Command Inhibit (DAT) and Command Inhibit (CMD)
690 // in the Present State register to be 0.
692 Status
= SdMmcHcWaitMmioSet (
695 SD_MMC_HC_PRESENT_STATE
,
696 sizeof (PresentState
),
699 SD_MMC_HC_GENERIC_TIMEOUT
701 if (EFI_ERROR (Status
)) {
706 // Set SD Clock Enable in the Clock Control register to 0
708 ClockCtrl
= (UINT16
)~BIT2
;
709 Status
= SdMmcHcAndMmio (PciIo
, Slot
, SD_MMC_HC_CLOCK_CTRL
, sizeof (ClockCtrl
), &ClockCtrl
);
715 SD/MMC card clock supply.
717 Refer to SD Host Controller Simplified spec 3.0 Section 3.2.1 for details.
719 @param[in] PciIo The PCI IO protocol instance.
720 @param[in] Slot The slot number of the SD card to send the command to.
721 @param[in] ClockFreq The max clock frequency to be set. The unit is KHz.
722 @param[in] Capability The capability of the slot.
724 @retval EFI_SUCCESS The clock is supplied successfully.
725 @retval Others The clock isn't supplied successfully.
730 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
733 IN SD_MMC_HC_SLOT_CAP Capability
741 UINT16 ControllerVer
;
745 // Calculate a divisor for SD clock frequency
747 ASSERT (Capability
.BaseClkFreq
!= 0);
749 BaseClkFreq
= Capability
.BaseClkFreq
;
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] Capability The capability of the slot.
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 SD_MMC_HC_SLOT_CAP Capability
958 // Calculate a divisor for SD clock frequency
960 if (Capability
.BaseClkFreq
== 0) {
962 // Don't support get Base Clock Frequency information via another method
964 return EFI_UNSUPPORTED
;
967 // Supply 400KHz clock frequency at initialization phase.
970 Status
= SdMmcHcClockSupply (PciIo
, Slot
, InitFreq
, Capability
);
975 Supply SD/MMC card with maximum voltage at initialization.
977 Refer to SD Host Controller Simplified spec 3.0 Section 3.3 for details.
979 @param[in] PciIo The PCI IO protocol instance.
980 @param[in] Slot The slot number of the SD card to send the command to.
981 @param[in] Capability The capability of the slot.
983 @retval EFI_SUCCESS The voltage is supplied successfully.
984 @retval Others The voltage isn't supplied successfully.
988 SdMmcHcInitPowerVoltage (
989 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
991 IN SD_MMC_HC_SLOT_CAP Capability
999 // Calculate supported maximum voltage according to SD Bus Voltage Select
1001 if (Capability
.Voltage33
!= 0) {
1006 } else if (Capability
.Voltage30
!= 0) {
1011 } else if (Capability
.Voltage18
!= 0) {
1017 Status
= SdMmcHcOrMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL2
, sizeof (HostCtrl2
), &HostCtrl2
);
1019 if (EFI_ERROR (Status
)) {
1024 return EFI_DEVICE_ERROR
;
1028 // Set SD Bus Voltage Select and SD Bus Power fields in Power Control Register
1030 Status
= SdMmcHcPowerControl (PciIo
, Slot
, MaxVoltage
);
1036 Initialize the Timeout Control register with most conservative value at initialization.
1038 Refer to SD Host Controller Simplified spec 3.0 Section 2.2.15 for details.
1040 @param[in] PciIo The PCI IO protocol instance.
1041 @param[in] Slot The slot number of the SD card to send the command to.
1043 @retval EFI_SUCCESS The timeout control register is configured successfully.
1044 @retval Others The timeout control register isn't configured successfully.
1048 SdMmcHcInitTimeoutCtrl (
1049 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
1057 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_TIMEOUT_CTRL
, FALSE
, sizeof (Timeout
), &Timeout
);
1063 Initial SD/MMC host controller with lowest clock frequency, max power and max timeout value
1066 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
1067 @param[in] Slot The slot number of the SD card to send the command to.
1069 @retval EFI_SUCCESS The host controller is initialized successfully.
1070 @retval Others The host controller isn't initialized successfully.
1075 IN SD_MMC_HC_PRIVATE_DATA
*Private
,
1080 EFI_PCI_IO_PROTOCOL
*PciIo
;
1081 SD_MMC_HC_SLOT_CAP Capability
;
1084 // Notify the SD/MMC override protocol that we are about to initialize
1085 // the SD/MMC host controller.
1087 if (mOverride
!= NULL
&& mOverride
->NotifyPhase
!= NULL
) {
1088 Status
= mOverride
->NotifyPhase (
1089 Private
->ControllerHandle
,
1091 EdkiiSdMmcInitHostPre
);
1092 if (EFI_ERROR (Status
)) {
1094 "%a: SD/MMC pre init notifier callback failed - %r\n",
1095 __FUNCTION__
, Status
));
1100 PciIo
= Private
->PciIo
;
1101 Capability
= Private
->Capability
[Slot
];
1103 Status
= SdMmcHcInitClockFreq (PciIo
, Slot
, Capability
);
1104 if (EFI_ERROR (Status
)) {
1108 Status
= SdMmcHcInitPowerVoltage (PciIo
, Slot
, Capability
);
1109 if (EFI_ERROR (Status
)) {
1113 Status
= SdMmcHcInitTimeoutCtrl (PciIo
, Slot
);
1114 if (EFI_ERROR (Status
)) {
1119 // Notify the SD/MMC override protocol that we are have just initialized
1120 // the SD/MMC host controller.
1122 if (mOverride
!= NULL
&& mOverride
->NotifyPhase
!= NULL
) {
1123 Status
= mOverride
->NotifyPhase (
1124 Private
->ControllerHandle
,
1126 EdkiiSdMmcInitHostPost
);
1127 if (EFI_ERROR (Status
)) {
1129 "%a: SD/MMC post init notifier callback failed - %r\n",
1130 __FUNCTION__
, Status
));
1139 @param[in] PciIo The PCI IO protocol instance.
1140 @param[in] Slot The slot number of the SD card to send the command to.
1141 @param[in] On The boolean to turn on/off LED.
1143 @retval EFI_SUCCESS The LED is turned on/off successfully.
1144 @retval Others The LED isn't turned on/off successfully.
1149 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
1159 Status
= SdMmcHcOrMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL1
, sizeof (HostCtrl1
), &HostCtrl1
);
1161 HostCtrl1
= (UINT8
)~BIT0
;
1162 Status
= SdMmcHcAndMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL1
, sizeof (HostCtrl1
), &HostCtrl1
);
1169 Build ADMA descriptor table for transfer.
1171 Refer to SD Host Controller Simplified spec 3.0 Section 1.13 for details.
1173 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.
1175 @retval EFI_SUCCESS The ADMA descriptor table is created successfully.
1176 @retval Others The ADMA descriptor table isn't created successfully.
1180 BuildAdmaDescTable (
1181 IN SD_MMC_HC_TRB
*Trb
1184 EFI_PHYSICAL_ADDRESS Data
;
1191 EFI_PCI_IO_PROTOCOL
*PciIo
;
1195 Data
= Trb
->DataPhy
;
1196 DataLen
= Trb
->DataLen
;
1197 PciIo
= Trb
->Private
->PciIo
;
1199 // Only support 32bit ADMA Descriptor Table
1201 if ((Data
>= 0x100000000ul
) || ((Data
+ DataLen
) > 0x100000000ul
)) {
1202 return EFI_INVALID_PARAMETER
;
1205 // Address field shall be set on 32-bit boundary (Lower 2-bit is always set to 0)
1206 // for 32-bit address descriptor table.
1208 if ((Data
& (BIT0
| BIT1
)) != 0) {
1209 DEBUG ((DEBUG_INFO
, "The buffer [0x%x] to construct ADMA desc is not aligned to 4 bytes boundary!\n", Data
));
1212 Entries
= DivU64x32 ((DataLen
+ ADMA_MAX_DATA_PER_LINE
- 1), ADMA_MAX_DATA_PER_LINE
);
1213 TableSize
= (UINTN
)MultU64x32 (Entries
, sizeof (SD_MMC_HC_ADMA_DESC_LINE
));
1214 Trb
->AdmaPages
= (UINT32
)EFI_SIZE_TO_PAGES (TableSize
);
1215 Status
= PciIo
->AllocateBuffer (
1218 EfiBootServicesData
,
1219 EFI_SIZE_TO_PAGES (TableSize
),
1220 (VOID
**)&Trb
->AdmaDesc
,
1223 if (EFI_ERROR (Status
)) {
1224 return EFI_OUT_OF_RESOURCES
;
1226 ZeroMem (Trb
->AdmaDesc
, TableSize
);
1228 Status
= PciIo
->Map (
1230 EfiPciIoOperationBusMasterCommonBuffer
,
1237 if (EFI_ERROR (Status
) || (Bytes
!= TableSize
)) {
1239 // Map error or unable to map the whole RFis buffer into a contiguous region.
1243 EFI_SIZE_TO_PAGES (TableSize
),
1246 return EFI_OUT_OF_RESOURCES
;
1249 if ((UINT64
)(UINTN
)Trb
->AdmaDescPhy
> 0x100000000ul
) {
1251 // The ADMA doesn't support 64bit addressing.
1259 EFI_SIZE_TO_PAGES (TableSize
),
1262 return EFI_DEVICE_ERROR
;
1265 Remaining
= DataLen
;
1266 Address
= (UINT32
)Data
;
1267 for (Index
= 0; Index
< Entries
; Index
++) {
1268 if (Remaining
<= ADMA_MAX_DATA_PER_LINE
) {
1269 Trb
->AdmaDesc
[Index
].Valid
= 1;
1270 Trb
->AdmaDesc
[Index
].Act
= 2;
1271 Trb
->AdmaDesc
[Index
].Length
= (UINT16
)Remaining
;
1272 Trb
->AdmaDesc
[Index
].Address
= Address
;
1275 Trb
->AdmaDesc
[Index
].Valid
= 1;
1276 Trb
->AdmaDesc
[Index
].Act
= 2;
1277 Trb
->AdmaDesc
[Index
].Length
= 0;
1278 Trb
->AdmaDesc
[Index
].Address
= Address
;
1281 Remaining
-= ADMA_MAX_DATA_PER_LINE
;
1282 Address
+= ADMA_MAX_DATA_PER_LINE
;
1286 // Set the last descriptor line as end of descriptor table
1288 Trb
->AdmaDesc
[Index
].End
= 1;
1293 Create a new TRB for the SD/MMC cmd request.
1295 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
1296 @param[in] Slot The slot number of the SD card to send the command to.
1297 @param[in] Packet A pointer to the SD command data structure.
1298 @param[in] Event If Event is NULL, blocking I/O is performed. If Event is
1299 not NULL, then nonblocking I/O is performed, and Event
1300 will be signaled when the Packet completes.
1302 @return Created Trb or NULL.
1307 IN SD_MMC_HC_PRIVATE_DATA
*Private
,
1309 IN EFI_SD_MMC_PASS_THRU_COMMAND_PACKET
*Packet
,
1316 EFI_PCI_IO_PROTOCOL_OPERATION Flag
;
1317 EFI_PCI_IO_PROTOCOL
*PciIo
;
1320 Trb
= AllocateZeroPool (sizeof (SD_MMC_HC_TRB
));
1325 Trb
->Signature
= SD_MMC_HC_TRB_SIG
;
1327 Trb
->BlockSize
= 0x200;
1328 Trb
->Packet
= Packet
;
1330 Trb
->Started
= FALSE
;
1331 Trb
->Timeout
= Packet
->Timeout
;
1332 Trb
->Private
= Private
;
1334 if ((Packet
->InTransferLength
!= 0) && (Packet
->InDataBuffer
!= NULL
)) {
1335 Trb
->Data
= Packet
->InDataBuffer
;
1336 Trb
->DataLen
= Packet
->InTransferLength
;
1338 } else if ((Packet
->OutTransferLength
!= 0) && (Packet
->OutDataBuffer
!= NULL
)) {
1339 Trb
->Data
= Packet
->OutDataBuffer
;
1340 Trb
->DataLen
= Packet
->OutTransferLength
;
1342 } else if ((Packet
->InTransferLength
== 0) && (Packet
->OutTransferLength
== 0)) {
1349 if ((Trb
->DataLen
!= 0) && (Trb
->DataLen
< Trb
->BlockSize
)) {
1350 Trb
->BlockSize
= (UINT16
)Trb
->DataLen
;
1353 if (((Private
->Slot
[Trb
->Slot
].CardType
== EmmcCardType
) &&
1354 (Packet
->SdMmcCmdBlk
->CommandIndex
== EMMC_SEND_TUNING_BLOCK
)) ||
1355 ((Private
->Slot
[Trb
->Slot
].CardType
== SdCardType
) &&
1356 (Packet
->SdMmcCmdBlk
->CommandIndex
== SD_SEND_TUNING_BLOCK
))) {
1357 Trb
->Mode
= SdMmcPioMode
;
1360 Flag
= EfiPciIoOperationBusMasterWrite
;
1362 Flag
= EfiPciIoOperationBusMasterRead
;
1365 PciIo
= Private
->PciIo
;
1366 if (Trb
->DataLen
!= 0) {
1367 MapLength
= Trb
->DataLen
;
1368 Status
= PciIo
->Map (
1376 if (EFI_ERROR (Status
) || (Trb
->DataLen
!= MapLength
)) {
1377 Status
= EFI_BAD_BUFFER_SIZE
;
1382 if (Trb
->DataLen
== 0) {
1383 Trb
->Mode
= SdMmcNoData
;
1384 } else if (Private
->Capability
[Slot
].Adma2
!= 0) {
1385 Trb
->Mode
= SdMmcAdmaMode
;
1386 Status
= BuildAdmaDescTable (Trb
);
1387 if (EFI_ERROR (Status
)) {
1388 PciIo
->Unmap (PciIo
, Trb
->DataMap
);
1391 } else if (Private
->Capability
[Slot
].Sdma
!= 0) {
1392 Trb
->Mode
= SdMmcSdmaMode
;
1394 Trb
->Mode
= SdMmcPioMode
;
1398 if (Event
!= NULL
) {
1399 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
1400 InsertTailList (&Private
->Queue
, &Trb
->TrbList
);
1401 gBS
->RestoreTPL (OldTpl
);
1412 Free the resource used by the TRB.
1414 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.
1419 IN SD_MMC_HC_TRB
*Trb
1422 EFI_PCI_IO_PROTOCOL
*PciIo
;
1424 PciIo
= Trb
->Private
->PciIo
;
1426 if (Trb
->AdmaMap
!= NULL
) {
1432 if (Trb
->AdmaDesc
!= NULL
) {
1439 if (Trb
->DataMap
!= NULL
) {
1450 Check if the env is ready for execute specified TRB.
1452 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
1453 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.
1455 @retval EFI_SUCCESS The env is ready for TRB execution.
1456 @retval EFI_NOT_READY The env is not ready for TRB execution.
1457 @retval Others Some erros happen.
1462 IN SD_MMC_HC_PRIVATE_DATA
*Private
,
1463 IN SD_MMC_HC_TRB
*Trb
1467 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET
*Packet
;
1468 EFI_PCI_IO_PROTOCOL
*PciIo
;
1469 UINT32 PresentState
;
1471 Packet
= Trb
->Packet
;
1473 if ((Packet
->SdMmcCmdBlk
->CommandType
== SdMmcCommandTypeAdtc
) ||
1474 (Packet
->SdMmcCmdBlk
->ResponseType
== SdMmcResponseTypeR1b
) ||
1475 (Packet
->SdMmcCmdBlk
->ResponseType
== SdMmcResponseTypeR5b
)) {
1477 // Wait Command Inhibit (CMD) and Command Inhibit (DAT) in
1478 // the Present State register to be 0
1480 PresentState
= BIT0
| BIT1
;
1483 // Wait Command Inhibit (CMD) in the Present State register
1486 PresentState
= BIT0
;
1489 PciIo
= Private
->PciIo
;
1490 Status
= SdMmcHcCheckMmioSet (
1493 SD_MMC_HC_PRESENT_STATE
,
1494 sizeof (PresentState
),
1503 Wait for the env to be ready for execute specified TRB.
1505 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
1506 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.
1508 @retval EFI_SUCCESS The env is ready for TRB execution.
1509 @retval EFI_TIMEOUT The env is not ready for TRB execution in time.
1510 @retval Others Some erros happen.
1515 IN SD_MMC_HC_PRIVATE_DATA
*Private
,
1516 IN SD_MMC_HC_TRB
*Trb
1520 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET
*Packet
;
1522 BOOLEAN InfiniteWait
;
1525 // Wait Command Complete Interrupt Status bit in Normal Interrupt Status Register
1527 Packet
= Trb
->Packet
;
1528 Timeout
= Packet
->Timeout
;
1530 InfiniteWait
= TRUE
;
1532 InfiniteWait
= FALSE
;
1535 while (InfiniteWait
|| (Timeout
> 0)) {
1537 // Check Trb execution result by reading Normal Interrupt Status register.
1539 Status
= SdMmcCheckTrbEnv (Private
, Trb
);
1540 if (Status
!= EFI_NOT_READY
) {
1544 // Stall for 1 microsecond.
1555 Execute the specified TRB.
1557 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
1558 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.
1560 @retval EFI_SUCCESS The TRB is sent to host controller successfully.
1561 @retval Others Some erros happen when sending this request to the host controller.
1566 IN SD_MMC_HC_PRIVATE_DATA
*Private
,
1567 IN SD_MMC_HC_TRB
*Trb
1571 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET
*Packet
;
1572 EFI_PCI_IO_PROTOCOL
*PciIo
;
1583 Packet
= Trb
->Packet
;
1584 PciIo
= Trb
->Private
->PciIo
;
1586 // Clear all bits in Error Interrupt Status Register
1589 Status
= SdMmcHcRwMmio (PciIo
, Trb
->Slot
, SD_MMC_HC_ERR_INT_STS
, FALSE
, sizeof (IntStatus
), &IntStatus
);
1590 if (EFI_ERROR (Status
)) {
1594 // Clear all bits in Normal Interrupt Status Register excepts for Card Removal & Card Insertion bits.
1597 Status
= SdMmcHcRwMmio (PciIo
, Trb
->Slot
, SD_MMC_HC_NOR_INT_STS
, FALSE
, sizeof (IntStatus
), &IntStatus
);
1598 if (EFI_ERROR (Status
)) {
1602 // Set Host Control 1 register DMA Select field
1604 if (Trb
->Mode
== SdMmcAdmaMode
) {
1606 Status
= SdMmcHcOrMmio (PciIo
, Trb
->Slot
, SD_MMC_HC_HOST_CTRL1
, sizeof (HostCtrl1
), &HostCtrl1
);
1607 if (EFI_ERROR (Status
)) {
1612 SdMmcHcLedOnOff (PciIo
, Trb
->Slot
, TRUE
);
1614 if (Trb
->Mode
== SdMmcSdmaMode
) {
1615 if ((UINT64
)(UINTN
)Trb
->DataPhy
>= 0x100000000ul
) {
1616 return EFI_INVALID_PARAMETER
;
1619 SdmaAddr
= (UINT32
)(UINTN
)Trb
->DataPhy
;
1620 Status
= SdMmcHcRwMmio (PciIo
, Trb
->Slot
, SD_MMC_HC_SDMA_ADDR
, FALSE
, sizeof (SdmaAddr
), &SdmaAddr
);
1621 if (EFI_ERROR (Status
)) {
1624 } else if (Trb
->Mode
== SdMmcAdmaMode
) {
1625 AdmaAddr
= (UINT64
)(UINTN
)Trb
->AdmaDescPhy
;
1626 Status
= SdMmcHcRwMmio (PciIo
, Trb
->Slot
, SD_MMC_HC_ADMA_SYS_ADDR
, FALSE
, sizeof (AdmaAddr
), &AdmaAddr
);
1627 if (EFI_ERROR (Status
)) {
1632 BlkSize
= Trb
->BlockSize
;
1633 if (Trb
->Mode
== SdMmcSdmaMode
) {
1635 // Set SDMA boundary to be 512K bytes.
1640 Status
= SdMmcHcRwMmio (PciIo
, Trb
->Slot
, SD_MMC_HC_BLK_SIZE
, FALSE
, sizeof (BlkSize
), &BlkSize
);
1641 if (EFI_ERROR (Status
)) {
1646 if (Trb
->Mode
!= SdMmcNoData
) {
1648 // Calcuate Block Count.
1650 BlkCount
= (UINT16
)(Trb
->DataLen
/ Trb
->BlockSize
);
1652 Status
= SdMmcHcRwMmio (PciIo
, Trb
->Slot
, SD_MMC_HC_BLK_COUNT
, FALSE
, sizeof (BlkCount
), &BlkCount
);
1653 if (EFI_ERROR (Status
)) {
1657 Argument
= Packet
->SdMmcCmdBlk
->CommandArgument
;
1658 Status
= SdMmcHcRwMmio (PciIo
, Trb
->Slot
, SD_MMC_HC_ARG1
, FALSE
, sizeof (Argument
), &Argument
);
1659 if (EFI_ERROR (Status
)) {
1664 if (Trb
->Mode
!= SdMmcNoData
) {
1665 if (Trb
->Mode
!= SdMmcPioMode
) {
1672 TransMode
|= BIT5
| BIT1
;
1675 // Only SD memory card needs to use AUTO CMD12 feature.
1677 if (Private
->Slot
[Trb
->Slot
].CardType
== SdCardType
) {
1684 Status
= SdMmcHcRwMmio (PciIo
, Trb
->Slot
, SD_MMC_HC_TRANS_MOD
, FALSE
, sizeof (TransMode
), &TransMode
);
1685 if (EFI_ERROR (Status
)) {
1689 Cmd
= (UINT16
)LShiftU64(Packet
->SdMmcCmdBlk
->CommandIndex
, 8);
1690 if (Packet
->SdMmcCmdBlk
->CommandType
== SdMmcCommandTypeAdtc
) {
1694 // Convert ResponseType to value
1696 if (Packet
->SdMmcCmdBlk
->CommandType
!= SdMmcCommandTypeBc
) {
1697 switch (Packet
->SdMmcCmdBlk
->ResponseType
) {
1698 case SdMmcResponseTypeR1
:
1699 case SdMmcResponseTypeR5
:
1700 case SdMmcResponseTypeR6
:
1701 case SdMmcResponseTypeR7
:
1702 Cmd
|= (BIT1
| BIT3
| BIT4
);
1704 case SdMmcResponseTypeR2
:
1705 Cmd
|= (BIT0
| BIT3
);
1707 case SdMmcResponseTypeR3
:
1708 case SdMmcResponseTypeR4
:
1711 case SdMmcResponseTypeR1b
:
1712 case SdMmcResponseTypeR5b
:
1713 Cmd
|= (BIT0
| BIT1
| BIT3
| BIT4
);
1723 Status
= SdMmcHcRwMmio (PciIo
, Trb
->Slot
, SD_MMC_HC_COMMAND
, FALSE
, sizeof (Cmd
), &Cmd
);
1728 Check the TRB execution result.
1730 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
1731 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.
1733 @retval EFI_SUCCESS The TRB is executed successfully.
1734 @retval EFI_NOT_READY The TRB is not completed for execution.
1735 @retval Others Some erros happen when executing this request.
1739 SdMmcCheckTrbResult (
1740 IN SD_MMC_HC_PRIVATE_DATA
*Private
,
1741 IN SD_MMC_HC_TRB
*Trb
1745 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET
*Packet
;
1754 Packet
= Trb
->Packet
;
1756 // Check Trb execution result by reading Normal Interrupt Status register.
1758 Status
= SdMmcHcRwMmio (
1761 SD_MMC_HC_NOR_INT_STS
,
1766 if (EFI_ERROR (Status
)) {
1770 // Check Transfer Complete bit is set or not.
1772 if ((IntStatus
& BIT1
) == BIT1
) {
1773 if ((IntStatus
& BIT15
) == BIT15
) {
1775 // Read Error Interrupt Status register to check if the error is
1776 // Data Timeout Error.
1777 // If yes, treat it as success as Transfer Complete has higher
1778 // priority than Data Timeout Error.
1780 Status
= SdMmcHcRwMmio (
1783 SD_MMC_HC_ERR_INT_STS
,
1788 if (!EFI_ERROR (Status
)) {
1789 if ((IntStatus
& BIT4
) == BIT4
) {
1790 Status
= EFI_SUCCESS
;
1792 Status
= EFI_DEVICE_ERROR
;
1800 // Check if there is a error happened during cmd execution.
1801 // If yes, then do error recovery procedure to follow SD Host Controller
1802 // Simplified Spec 3.0 section 3.10.1.
1804 if ((IntStatus
& BIT15
) == BIT15
) {
1805 Status
= SdMmcHcRwMmio (
1808 SD_MMC_HC_ERR_INT_STS
,
1813 if (EFI_ERROR (Status
)) {
1816 if ((IntStatus
& 0x0F) != 0) {
1819 if ((IntStatus
& 0xF0) != 0) {
1823 Status
= SdMmcHcRwMmio (
1831 if (EFI_ERROR (Status
)) {
1834 Status
= SdMmcHcWaitMmioSet (
1841 SD_MMC_HC_GENERIC_TIMEOUT
1843 if (EFI_ERROR (Status
)) {
1847 Status
= EFI_DEVICE_ERROR
;
1851 // Check if DMA interrupt is signalled for the SDMA transfer.
1853 if ((Trb
->Mode
== SdMmcSdmaMode
) && ((IntStatus
& BIT3
) == BIT3
)) {
1855 // Clear DMA interrupt bit.
1858 Status
= SdMmcHcRwMmio (
1861 SD_MMC_HC_NOR_INT_STS
,
1866 if (EFI_ERROR (Status
)) {
1870 // Update SDMA Address register.
1872 SdmaAddr
= SD_MMC_SDMA_ROUND_UP ((UINT32
)(UINTN
)Trb
->DataPhy
, SD_MMC_SDMA_BOUNDARY
);
1873 Status
= SdMmcHcRwMmio (
1876 SD_MMC_HC_SDMA_ADDR
,
1881 if (EFI_ERROR (Status
)) {
1884 Trb
->DataPhy
= (UINT32
)(UINTN
)SdmaAddr
;
1887 if ((Packet
->SdMmcCmdBlk
->CommandType
!= SdMmcCommandTypeAdtc
) &&
1888 (Packet
->SdMmcCmdBlk
->ResponseType
!= SdMmcResponseTypeR1b
) &&
1889 (Packet
->SdMmcCmdBlk
->ResponseType
!= SdMmcResponseTypeR5b
)) {
1890 if ((IntStatus
& BIT0
) == BIT0
) {
1891 Status
= EFI_SUCCESS
;
1896 if (((Private
->Slot
[Trb
->Slot
].CardType
== EmmcCardType
) &&
1897 (Packet
->SdMmcCmdBlk
->CommandIndex
== EMMC_SEND_TUNING_BLOCK
)) ||
1898 ((Private
->Slot
[Trb
->Slot
].CardType
== SdCardType
) &&
1899 (Packet
->SdMmcCmdBlk
->CommandIndex
== SD_SEND_TUNING_BLOCK
))) {
1901 // When performing tuning procedure (Execute Tuning is set to 1) through PIO mode,
1902 // wait Buffer Read Ready bit of Normal Interrupt Status Register to be 1.
1903 // Refer to SD Host Controller Simplified Specification 3.0 figure 2-29 for details.
1905 if ((IntStatus
& BIT5
) == BIT5
) {
1907 // Clear Buffer Read Ready interrupt at first.
1910 SdMmcHcRwMmio (Private
->PciIo
, Trb
->Slot
, SD_MMC_HC_NOR_INT_STS
, FALSE
, sizeof (IntStatus
), &IntStatus
);
1912 // Read data out from Buffer Port register
1914 for (PioLength
= 0; PioLength
< Trb
->DataLen
; PioLength
+= 4) {
1915 SdMmcHcRwMmio (Private
->PciIo
, Trb
->Slot
, SD_MMC_HC_BUF_DAT_PORT
, TRUE
, 4, (UINT8
*)Trb
->Data
+ PioLength
);
1917 Status
= EFI_SUCCESS
;
1922 Status
= EFI_NOT_READY
;
1925 // Get response data when the cmd is executed successfully.
1927 if (!EFI_ERROR (Status
)) {
1928 if (Packet
->SdMmcCmdBlk
->CommandType
!= SdMmcCommandTypeBc
) {
1929 for (Index
= 0; Index
< 4; Index
++) {
1930 Status
= SdMmcHcRwMmio (
1933 SD_MMC_HC_RESPONSE
+ Index
* 4,
1938 if (EFI_ERROR (Status
)) {
1939 SdMmcHcLedOnOff (Private
->PciIo
, Trb
->Slot
, FALSE
);
1943 CopyMem (Packet
->SdMmcStatusBlk
, Response
, sizeof (Response
));
1947 if (Status
!= EFI_NOT_READY
) {
1948 SdMmcHcLedOnOff (Private
->PciIo
, Trb
->Slot
, FALSE
);
1955 Wait for the TRB execution result.
1957 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
1958 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.
1960 @retval EFI_SUCCESS The TRB is executed successfully.
1961 @retval Others Some erros happen when executing this request.
1965 SdMmcWaitTrbResult (
1966 IN SD_MMC_HC_PRIVATE_DATA
*Private
,
1967 IN SD_MMC_HC_TRB
*Trb
1971 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET
*Packet
;
1973 BOOLEAN InfiniteWait
;
1975 Packet
= Trb
->Packet
;
1977 // Wait Command Complete Interrupt Status bit in Normal Interrupt Status Register
1979 Timeout
= Packet
->Timeout
;
1981 InfiniteWait
= TRUE
;
1983 InfiniteWait
= FALSE
;
1986 while (InfiniteWait
|| (Timeout
> 0)) {
1988 // Check Trb execution result by reading Normal Interrupt Status register.
1990 Status
= SdMmcCheckTrbResult (Private
, Trb
);
1991 if (Status
!= EFI_NOT_READY
) {
1995 // Stall for 1 microsecond.