]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Bus/Pci/SdMmcPciHcDxe/SdMmcPciHci.c
projects / mirror_edk2.git / blob
? search:


7971196a253a84339798ec9480166edd8dcd884f
[mirror_edk2.git] / MdeModulePkg / Bus / Pci / SdMmcPciHcDxe / SdMmcPciHci.c
1 /** @file
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 plus the 64-bit
4 System Addressing support in SD Host Controller Simplified Specification version
5 4.20.
6
7 It would expose EFI_SD_MMC_PASS_THRU_PROTOCOL for upper layer use.
8
9 Copyright (c) 2018-2019, NVIDIA CORPORATION. All rights reserved.
10 Copyright (c) 2015 - 2020, Intel Corporation. All rights reserved.<BR>
11 SPDX-License-Identifier: BSD-2-Clause-Patent
12
13 **/
14
15 #include "SdMmcPciHcDxe.h"
16
17 /**
18 Dump the content of SD/MMC host controller's Capability Register.
19
20 @param[in] Slot The slot number of the SD card to send the command to.
21 @param[in] Capability The buffer to store the capability data.
22
23 **/
24 VOID
25 DumpCapabilityReg (
26 IN UINT8 Slot,
27 IN SD_MMC_HC_SLOT_CAP *Capability
28 )
29 {
30 //
31 // Dump Capability Data
32 //
33 DEBUG ((DEBUG_INFO, " == Slot [%d] Capability is 0x%x ==\n", Slot, Capability));
34 DEBUG ((DEBUG_INFO, " Timeout Clk Freq %d%a\n", Capability->TimeoutFreq, (Capability->TimeoutUnit) ? "MHz" : "KHz"));
35 DEBUG ((DEBUG_INFO, " Base Clk Freq %dMHz\n", Capability->BaseClkFreq));
36 DEBUG ((DEBUG_INFO, " Max Blk Len %dbytes\n", 512 * (1 << Capability->MaxBlkLen)));
37 DEBUG ((DEBUG_INFO, " 8-bit Support %a\n", Capability->BusWidth8 ? "TRUE" : "FALSE"));
38 DEBUG ((DEBUG_INFO, " ADMA2 Support %a\n", Capability->Adma2 ? "TRUE" : "FALSE"));
39 DEBUG ((DEBUG_INFO, " HighSpeed Support %a\n", Capability->HighSpeed ? "TRUE" : "FALSE"));
40 DEBUG ((DEBUG_INFO, " SDMA Support %a\n", Capability->Sdma ? "TRUE" : "FALSE"));
41 DEBUG ((DEBUG_INFO, " Suspend/Resume %a\n", Capability->SuspRes ? "TRUE" : "FALSE"));
42 DEBUG ((DEBUG_INFO, " Voltage 3.3 %a\n", Capability->Voltage33 ? "TRUE" : "FALSE"));
43 DEBUG ((DEBUG_INFO, " Voltage 3.0 %a\n", Capability->Voltage30 ? "TRUE" : "FALSE"));
44 DEBUG ((DEBUG_INFO, " Voltage 1.8 %a\n", Capability->Voltage18 ? "TRUE" : "FALSE"));
45 DEBUG ((DEBUG_INFO, " V4 64-bit Sys Bus %a\n", Capability->SysBus64V4 ? "TRUE" : "FALSE"));
46 DEBUG ((DEBUG_INFO, " V3 64-bit Sys Bus %a\n", Capability->SysBus64V3 ? "TRUE" : "FALSE"));
47 DEBUG ((DEBUG_INFO, " Async Interrupt %a\n", Capability->AsyncInt ? "TRUE" : "FALSE"));
48 DEBUG ((DEBUG_INFO, " SlotType "));
49 if (Capability->SlotType == 0x00) {
50 DEBUG ((DEBUG_INFO, "%a\n", "Removable Slot"));
51 } else if (Capability->SlotType == 0x01) {
52 DEBUG ((DEBUG_INFO, "%a\n", "Embedded Slot"));
53 } else if (Capability->SlotType == 0x02) {
54 DEBUG ((DEBUG_INFO, "%a\n", "Shared Bus Slot"));
55 } else {
56 DEBUG ((DEBUG_INFO, "%a\n", "Reserved"));
57 }
58 DEBUG ((DEBUG_INFO, " SDR50 Support %a\n", Capability->Sdr50 ? "TRUE" : "FALSE"));
59 DEBUG ((DEBUG_INFO, " SDR104 Support %a\n", Capability->Sdr104 ? "TRUE" : "FALSE"));
60 DEBUG ((DEBUG_INFO, " DDR50 Support %a\n", Capability->Ddr50 ? "TRUE" : "FALSE"));
61 DEBUG ((DEBUG_INFO, " Driver Type A %a\n", Capability->DriverTypeA ? "TRUE" : "FALSE"));
62 DEBUG ((DEBUG_INFO, " Driver Type C %a\n", Capability->DriverTypeC ? "TRUE" : "FALSE"));
63 DEBUG ((DEBUG_INFO, " Driver Type D %a\n", Capability->DriverTypeD ? "TRUE" : "FALSE"));
64 DEBUG ((DEBUG_INFO, " Driver Type 4 %a\n", Capability->DriverType4 ? "TRUE" : "FALSE"));
65 if (Capability->TimerCount == 0) {
66 DEBUG ((DEBUG_INFO, " Retuning TimerCnt Disabled\n", 2 * (Capability->TimerCount - 1)));
67 } else {
68 DEBUG ((DEBUG_INFO, " Retuning TimerCnt %dseconds\n", 2 * (Capability->TimerCount - 1)));
69 }
70 DEBUG ((DEBUG_INFO, " SDR50 Tuning %a\n", Capability->TuningSDR50 ? "TRUE" : "FALSE"));
71 DEBUG ((DEBUG_INFO, " Retuning Mode Mode %d\n", Capability->RetuningMod + 1));
72 DEBUG ((DEBUG_INFO, " Clock Multiplier M = %d\n", Capability->ClkMultiplier + 1));
73 DEBUG ((DEBUG_INFO, " HS 400 %a\n", Capability->Hs400 ? "TRUE" : "FALSE"));
74 return;
75 }
76
77 /**
78 Read SlotInfo register from SD/MMC host controller pci config space.
79
80 @param[in] PciIo The PCI IO protocol instance.
81 @param[out] FirstBar The buffer to store the first BAR value.
82 @param[out] SlotNum The buffer to store the supported slot number.
83
84 @retval EFI_SUCCESS The operation succeeds.
85 @retval Others The operation fails.
86
87 **/
88 EFI_STATUS
89 EFIAPI
90 SdMmcHcGetSlotInfo (
91 IN EFI_PCI_IO_PROTOCOL *PciIo,
92 OUT UINT8 *FirstBar,
93 OUT UINT8 *SlotNum
94 )
95 {
96 EFI_STATUS Status;
97 SD_MMC_HC_SLOT_INFO SlotInfo;
98
99 Status = PciIo->Pci.Read (
100 PciIo,
101 EfiPciIoWidthUint8,
102 SD_MMC_HC_SLOT_OFFSET,
103 sizeof (SlotInfo),
104 &SlotInfo
105 );
106 if (EFI_ERROR (Status)) {
107 return Status;
108 }
109
110 *FirstBar = SlotInfo.FirstBar;
111 *SlotNum = SlotInfo.SlotNum + 1;
112 ASSERT ((*FirstBar + *SlotNum) < SD_MMC_HC_MAX_SLOT);
113 return EFI_SUCCESS;
114 }
115
116 /**
117 Read/Write specified SD/MMC host controller mmio register.
118
119 @param[in] PciIo The PCI IO protocol instance.
120 @param[in] BarIndex The BAR index of the standard PCI Configuration
121 header to use as the base address for the memory
122 operation to perform.
123 @param[in] Offset The offset within the selected BAR to start the
124 memory operation.
125 @param[in] Read A boolean to indicate it's read or write operation.
126 @param[in] Count The width of the mmio register in bytes.
127 Must be 1, 2 , 4 or 8 bytes.
128 @param[in, out] Data For read operations, the destination buffer to store
129 the results. For write operations, the source buffer
130 to write data from. The caller is responsible for
131 having ownership of the data buffer and ensuring its
132 size not less than Count bytes.
133
134 @retval EFI_INVALID_PARAMETER The PciIo or Data is NULL or the Count is not valid.
135 @retval EFI_SUCCESS The read/write operation succeeds.
136 @retval Others The read/write operation fails.
137
138 **/
139 EFI_STATUS
140 EFIAPI
141 SdMmcHcRwMmio (
142 IN EFI_PCI_IO_PROTOCOL *PciIo,
143 IN UINT8 BarIndex,
144 IN UINT32 Offset,
145 IN BOOLEAN Read,
146 IN UINT8 Count,
147 IN OUT VOID *Data
148 )
149 {
150 EFI_STATUS Status;
151 EFI_PCI_IO_PROTOCOL_WIDTH Width;
152
153 if ((PciIo == NULL) || (Data == NULL)) {
154 return EFI_INVALID_PARAMETER;
155 }
156
157 switch (Count) {
158 case 1:
159 Width = EfiPciIoWidthUint8;
160 break;
161 case 2:
162 Width = EfiPciIoWidthUint16;
163 Count = 1;
164 break;
165 case 4:
166 Width = EfiPciIoWidthUint32;
167 Count = 1;
168 break;
169 case 8:
170 Width = EfiPciIoWidthUint32;
171 Count = 2;
172 break;
173 default:
174 return EFI_INVALID_PARAMETER;
175 }
176
177 if (Read) {
178 Status = PciIo->Mem.Read (
179 PciIo,
180 Width,
181 BarIndex,
182 (UINT64) Offset,
183 Count,
184 Data
185 );
186 } else {
187 Status = PciIo->Mem.Write (
188 PciIo,
189 Width,
190 BarIndex,
191 (UINT64) Offset,
192 Count,
193 Data
194 );
195 }
196
197 return Status;
198 }
199
200 /**
201 Do OR operation with the value of the specified SD/MMC host controller mmio register.
202
203 @param[in] PciIo The PCI IO protocol instance.
204 @param[in] BarIndex The BAR index of the standard PCI Configuration
205 header to use as the base address for the memory
206 operation to perform.
207 @param[in] Offset The offset within the selected BAR to start the
208 memory operation.
209 @param[in] Count The width of the mmio register in bytes.
210 Must be 1, 2 , 4 or 8 bytes.
211 @param[in] OrData The pointer to the data used to do OR operation.
212 The caller is responsible for having ownership of
213 the data buffer and ensuring its size not less than
214 Count bytes.
215
216 @retval EFI_INVALID_PARAMETER The PciIo or OrData is NULL or the Count is not valid.
217 @retval EFI_SUCCESS The OR operation succeeds.
218 @retval Others The OR operation fails.
219
220 **/
221 EFI_STATUS
222 EFIAPI
223 SdMmcHcOrMmio (
224 IN EFI_PCI_IO_PROTOCOL *PciIo,
225 IN UINT8 BarIndex,
226 IN UINT32 Offset,
227 IN UINT8 Count,
228 IN VOID *OrData
229 )
230 {
231 EFI_STATUS Status;
232 UINT64 Data;
233 UINT64 Or;
234
235 Status = SdMmcHcRwMmio (PciIo, BarIndex, Offset, TRUE, Count, &Data);
236 if (EFI_ERROR (Status)) {
237 return Status;
238 }
239
240 if (Count == 1) {
241 Or = *(UINT8*) OrData;
242 } else if (Count == 2) {
243 Or = *(UINT16*) OrData;
244 } else if (Count == 4) {
245 Or = *(UINT32*) OrData;
246 } else if (Count == 8) {
247 Or = *(UINT64*) OrData;
248 } else {
249 return EFI_INVALID_PARAMETER;
250 }
251
252 Data |= Or;
253 Status = SdMmcHcRwMmio (PciIo, BarIndex, Offset, FALSE, Count, &Data);
254
255 return Status;
256 }
257
258 /**
259 Do AND operation with the value of the specified SD/MMC host controller mmio register.
260
261 @param[in] PciIo The PCI IO protocol instance.
262 @param[in] BarIndex The BAR index of the standard PCI Configuration
263 header to use as the base address for the memory
264 operation to perform.
265 @param[in] Offset The offset within the selected BAR to start the
266 memory operation.
267 @param[in] Count The width of the mmio register in bytes.
268 Must be 1, 2 , 4 or 8 bytes.
269 @param[in] AndData The pointer to the data used to do AND operation.
270 The caller is responsible for having ownership of
271 the data buffer and ensuring its size not less than
272 Count bytes.
273
274 @retval EFI_INVALID_PARAMETER The PciIo or AndData is NULL or the Count is not valid.
275 @retval EFI_SUCCESS The AND operation succeeds.
276 @retval Others The AND operation fails.
277
278 **/
279 EFI_STATUS
280 EFIAPI
281 SdMmcHcAndMmio (
282 IN EFI_PCI_IO_PROTOCOL *PciIo,
283 IN UINT8 BarIndex,
284 IN UINT32 Offset,
285 IN UINT8 Count,
286 IN VOID *AndData
287 )
288 {
289 EFI_STATUS Status;
290 UINT64 Data;
291 UINT64 And;
292
293 Status = SdMmcHcRwMmio (PciIo, BarIndex, Offset, TRUE, Count, &Data);
294 if (EFI_ERROR (Status)) {
295 return Status;
296 }
297
298 if (Count == 1) {
299 And = *(UINT8*) AndData;
300 } else if (Count == 2) {
301 And = *(UINT16*) AndData;
302 } else if (Count == 4) {
303 And = *(UINT32*) AndData;
304 } else if (Count == 8) {
305 And = *(UINT64*) AndData;
306 } else {
307 return EFI_INVALID_PARAMETER;
308 }
309
310 Data &= And;
311 Status = SdMmcHcRwMmio (PciIo, BarIndex, Offset, FALSE, Count, &Data);
312
313 return Status;
314 }
315
316 /**
317 Wait for the value of the specified MMIO register set to the test value.
318
319 @param[in] PciIo The PCI IO protocol instance.
320 @param[in] BarIndex The BAR index of the standard PCI Configuration
321 header to use as the base address for the memory
322 operation to perform.
323 @param[in] Offset The offset within the selected BAR to start the
324 memory operation.
325 @param[in] Count The width of the mmio register in bytes.
326 Must be 1, 2, 4 or 8 bytes.
327 @param[in] MaskValue The mask value of memory.
328 @param[in] TestValue The test value of memory.
329
330 @retval EFI_NOT_READY The MMIO register hasn't set to the expected value.
331 @retval EFI_SUCCESS The MMIO register has expected value.
332 @retval Others The MMIO operation fails.
333
334 **/
335 EFI_STATUS
336 EFIAPI
337 SdMmcHcCheckMmioSet (
338 IN EFI_PCI_IO_PROTOCOL *PciIo,
339 IN UINT8 BarIndex,
340 IN UINT32 Offset,
341 IN UINT8 Count,
342 IN UINT64 MaskValue,
343 IN UINT64 TestValue
344 )
345 {
346 EFI_STATUS Status;
347 UINT64 Value;
348
349 //
350 // Access PCI MMIO space to see if the value is the tested one.
351 //
352 Value = 0;
353 Status = SdMmcHcRwMmio (PciIo, BarIndex, Offset, TRUE, Count, &Value);
354 if (EFI_ERROR (Status)) {
355 return Status;
356 }
357
358 Value &= MaskValue;
359
360 if (Value == TestValue) {
361 return EFI_SUCCESS;
362 }
363
364 return EFI_NOT_READY;
365 }
366
367 /**
368 Wait for the value of the specified MMIO register set to the test value.
369
370 @param[in] PciIo The PCI IO protocol instance.
371 @param[in] BarIndex The BAR index of the standard PCI Configuration
372 header to use as the base address for the memory
373 operation to perform.
374 @param[in] Offset The offset within the selected BAR to start the
375 memory operation.
376 @param[in] Count The width of the mmio register in bytes.
377 Must be 1, 2, 4 or 8 bytes.
378 @param[in] MaskValue The mask value of memory.
379 @param[in] TestValue The test value of memory.
380 @param[in] Timeout The time out value for wait memory set, uses 1
381 microsecond as a unit.
382
383 @retval EFI_TIMEOUT The MMIO register hasn't expected value in timeout
384 range.
385 @retval EFI_SUCCESS The MMIO register has expected value.
386 @retval Others The MMIO operation fails.
387
388 **/
389 EFI_STATUS
390 EFIAPI
391 SdMmcHcWaitMmioSet (
392 IN EFI_PCI_IO_PROTOCOL *PciIo,
393 IN UINT8 BarIndex,
394 IN UINT32 Offset,
395 IN UINT8 Count,
396 IN UINT64 MaskValue,
397 IN UINT64 TestValue,
398 IN UINT64 Timeout
399 )
400 {
401 EFI_STATUS Status;
402 BOOLEAN InfiniteWait;
403
404 if (Timeout == 0) {
405 InfiniteWait = TRUE;
406 } else {
407 InfiniteWait = FALSE;
408 }
409
410 while (InfiniteWait || (Timeout > 0)) {
411 Status = SdMmcHcCheckMmioSet (
412 PciIo,
413 BarIndex,
414 Offset,
415 Count,
416 MaskValue,
417 TestValue
418 );
419 if (Status != EFI_NOT_READY) {
420 return Status;
421 }
422
423 //
424 // Stall for 1 microsecond.
425 //
426 gBS->Stall (1);
427
428 Timeout--;
429 }
430
431 return EFI_TIMEOUT;
432 }
433
434 /**
435 Get the controller version information from the specified slot.
436
437 @param[in] PciIo The PCI IO protocol instance.
438 @param[in] Slot The slot number of the SD card to send the command to.
439 @param[out] Version The buffer to store the version information.
440
441 @retval EFI_SUCCESS The operation executes successfully.
442 @retval Others The operation fails.
443
444 **/
445 EFI_STATUS
446 SdMmcHcGetControllerVersion (
447 IN EFI_PCI_IO_PROTOCOL *PciIo,
448 IN UINT8 Slot,
449 OUT UINT16 *Version
450 )
451 {
452 EFI_STATUS Status;
453
454 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_CTRL_VER, TRUE, sizeof (UINT16), Version);
455 if (EFI_ERROR (Status)) {
456 return Status;
457 }
458
459 *Version &= 0xFF;
460
461 return EFI_SUCCESS;
462 }
463
464 /**
465 Software reset the specified SD/MMC host controller and enable all interrupts.
466
467 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
468 @param[in] Slot The slot number of the SD card to send the command to.
469
470 @retval EFI_SUCCESS The software reset executes successfully.
471 @retval Others The software reset fails.
472
473 **/
474 EFI_STATUS
475 SdMmcHcReset (
476 IN SD_MMC_HC_PRIVATE_DATA *Private,
477 IN UINT8 Slot
478 )
479 {
480 EFI_STATUS Status;
481 UINT8 SwReset;
482 EFI_PCI_IO_PROTOCOL *PciIo;
483
484 //
485 // Notify the SD/MMC override protocol that we are about to reset
486 // the SD/MMC host controller.
487 //
488 if (mOverride != NULL && mOverride->NotifyPhase != NULL) {
489 Status = mOverride->NotifyPhase (
490 Private->ControllerHandle,
491 Slot,
492 EdkiiSdMmcResetPre,
493 NULL);
494 if (EFI_ERROR (Status)) {
495 DEBUG ((DEBUG_WARN,
496 "%a: SD/MMC pre reset notifier callback failed - %r\n",
497 __FUNCTION__, Status));
498 return Status;
499 }
500 }
501
502 PciIo = Private->PciIo;
503 SwReset = BIT0;
504 Status = SdMmcHcOrMmio (PciIo, Slot, SD_MMC_HC_SW_RST, sizeof (SwReset), &SwReset);
505
506 if (EFI_ERROR (Status)) {
507 DEBUG ((DEBUG_ERROR, "SdMmcHcReset: write SW Reset for All fails: %r\n", Status));
508 return Status;
509 }
510
511 Status = SdMmcHcWaitMmioSet (
512 PciIo,
513 Slot,
514 SD_MMC_HC_SW_RST,
515 sizeof (SwReset),
516 BIT0,
517 0x00,
518 SD_MMC_HC_GENERIC_TIMEOUT
519 );
520 if (EFI_ERROR (Status)) {
521 DEBUG ((DEBUG_INFO, "SdMmcHcReset: reset done with %r\n", Status));
522 return Status;
523 }
524
525 //
526 // Enable all interrupt after reset all.
527 //
528 Status = SdMmcHcEnableInterrupt (PciIo, Slot);
529 if (EFI_ERROR (Status)) {
530 DEBUG ((DEBUG_INFO, "SdMmcHcReset: SdMmcHcEnableInterrupt done with %r\n",
531 Status));
532 return Status;
533 }
534
535 //
536 // Notify the SD/MMC override protocol that we have just reset
537 // the SD/MMC host controller.
538 //
539 if (mOverride != NULL && mOverride->NotifyPhase != NULL) {
540 Status = mOverride->NotifyPhase (
541 Private->ControllerHandle,
542 Slot,
543 EdkiiSdMmcResetPost,
544 NULL);
545 if (EFI_ERROR (Status)) {
546 DEBUG ((DEBUG_WARN,
547 "%a: SD/MMC post reset notifier callback failed - %r\n",
548 __FUNCTION__, Status));
549 }
550 }
551
552 return Status;
553 }
554
555 /**
556 Set all interrupt status bits in Normal and Error Interrupt Status Enable
557 register.
558
559 @param[in] PciIo The PCI IO protocol instance.
560 @param[in] Slot The slot number of the SD card to send the command to.
561
562 @retval EFI_SUCCESS The operation executes successfully.
563 @retval Others The operation fails.
564
565 **/
566 EFI_STATUS
567 SdMmcHcEnableInterrupt (
568 IN EFI_PCI_IO_PROTOCOL *PciIo,
569 IN UINT8 Slot
570 )
571 {
572 EFI_STATUS Status;
573 UINT16 IntStatus;
574
575 //
576 // Enable all bits in Error Interrupt Status Enable Register
577 //
578 IntStatus = 0xFFFF;
579 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_ERR_INT_STS_EN, FALSE, sizeof (IntStatus), &IntStatus);
580 if (EFI_ERROR (Status)) {
581 return Status;
582 }
583 //
584 // Enable all bits in Normal Interrupt Status Enable Register
585 //
586 IntStatus = 0xFFFF;
587 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_NOR_INT_STS_EN, FALSE, sizeof (IntStatus), &IntStatus);
588
589 return Status;
590 }
591
592 /**
593 Get the capability data from the specified slot.
594
595 @param[in] PciIo The PCI IO protocol instance.
596 @param[in] Slot The slot number of the SD card to send the command to.
597 @param[out] Capability The buffer to store the capability data.
598
599 @retval EFI_SUCCESS The operation executes successfully.
600 @retval Others The operation fails.
601
602 **/
603 EFI_STATUS
604 SdMmcHcGetCapability (
605 IN EFI_PCI_IO_PROTOCOL *PciIo,
606 IN UINT8 Slot,
607 OUT SD_MMC_HC_SLOT_CAP *Capability
608 )
609 {
610 EFI_STATUS Status;
611 UINT64 Cap;
612
613 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_CAP, TRUE, sizeof (Cap), &Cap);
614 if (EFI_ERROR (Status)) {
615 return Status;
616 }
617
618 CopyMem (Capability, &Cap, sizeof (Cap));
619
620 return EFI_SUCCESS;
621 }
622
623 /**
624 Get the maximum current capability data from the specified slot.
625
626 @param[in] PciIo The PCI IO protocol instance.
627 @param[in] Slot The slot number of the SD card to send the command to.
628 @param[out] MaxCurrent The buffer to store the maximum current capability data.
629
630 @retval EFI_SUCCESS The operation executes successfully.
631 @retval Others The operation fails.
632
633 **/
634 EFI_STATUS
635 SdMmcHcGetMaxCurrent (
636 IN EFI_PCI_IO_PROTOCOL *PciIo,
637 IN UINT8 Slot,
638 OUT UINT64 *MaxCurrent
639 )
640 {
641 EFI_STATUS Status;
642
643 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_MAX_CURRENT_CAP, TRUE, sizeof (UINT64), MaxCurrent);
644
645 return Status;
646 }
647
648 /**
649 Detect whether there is a SD/MMC card attached at the specified SD/MMC host controller
650 slot.
651
652 Refer to SD Host Controller Simplified spec 3.0 Section 3.1 for details.
653
654 @param[in] PciIo The PCI IO protocol instance.
655 @param[in] Slot The slot number of the SD card to send the command to.
656 @param[out] MediaPresent The pointer to the media present boolean value.
657
658 @retval EFI_SUCCESS There is no media change happened.
659 @retval EFI_MEDIA_CHANGED There is media change happened.
660 @retval Others The detection fails.
661
662 **/
663 EFI_STATUS
664 SdMmcHcCardDetect (
665 IN EFI_PCI_IO_PROTOCOL *PciIo,
666 IN UINT8 Slot,
667 OUT BOOLEAN *MediaPresent
668 )
669 {
670 EFI_STATUS Status;
671 UINT16 Data;
672 UINT32 PresentState;
673
674 //
675 // Check Present State Register to see if there is a card presented.
676 //
677 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_PRESENT_STATE, TRUE, sizeof (PresentState), &PresentState);
678 if (EFI_ERROR (Status)) {
679 return Status;
680 }
681
682 if ((PresentState & BIT16) != 0) {
683 *MediaPresent = TRUE;
684 } else {
685 *MediaPresent = FALSE;
686 }
687
688 //
689 // Check Normal Interrupt Status Register
690 //
691 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_NOR_INT_STS, TRUE, sizeof (Data), &Data);
692 if (EFI_ERROR (Status)) {
693 return Status;
694 }
695
696 if ((Data & (BIT6 | BIT7)) != 0) {
697 //
698 // Clear BIT6 and BIT7 by writing 1 to these two bits if set.
699 //
700 Data &= BIT6 | BIT7;
701 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_NOR_INT_STS, FALSE, sizeof (Data), &Data);
702 if (EFI_ERROR (Status)) {
703 return Status;
704 }
705
706 return EFI_MEDIA_CHANGED;
707 }
708
709 return EFI_SUCCESS;
710 }
711
712 /**
713 Stop SD/MMC card clock.
714
715 Refer to SD Host Controller Simplified spec 3.0 Section 3.2.2 for details.
716
717 @param[in] PciIo The PCI IO protocol instance.
718 @param[in] Slot The slot number of the SD card to send the command to.
719
720 @retval EFI_SUCCESS Succeed to stop SD/MMC clock.
721 @retval Others Fail to stop SD/MMC clock.
722
723 **/
724 EFI_STATUS
725 SdMmcHcStopClock (
726 IN EFI_PCI_IO_PROTOCOL *PciIo,
727 IN UINT8 Slot
728 )
729 {
730 EFI_STATUS Status;
731 UINT32 PresentState;
732 UINT16 ClockCtrl;
733
734 //
735 // Ensure no SD transactions are occurring on the SD Bus by
736 // waiting for Command Inhibit (DAT) and Command Inhibit (CMD)
737 // in the Present State register to be 0.
738 //
739 Status = SdMmcHcWaitMmioSet (
740 PciIo,
741 Slot,
742 SD_MMC_HC_PRESENT_STATE,
743 sizeof (PresentState),
744 BIT0 | BIT1,
745 0,
746 SD_MMC_HC_GENERIC_TIMEOUT
747 );
748 if (EFI_ERROR (Status)) {
749 return Status;
750 }
751
752 //
753 // Set SD Clock Enable in the Clock Control register to 0
754 //
755 ClockCtrl = (UINT16)~BIT2;
756 Status = SdMmcHcAndMmio (PciIo, Slot, SD_MMC_HC_CLOCK_CTRL, sizeof (ClockCtrl), &ClockCtrl);
757
758 return Status;
759 }
760
761 /**
762 Start the SD clock.
763
764 @param[in] PciIo The PCI IO protocol instance.
765 @param[in] Slot The slot number.
766
767 @retval EFI_SUCCESS Succeeded to start the SD clock.
768 @retval Others Failed to start the SD clock.
769 **/
770 EFI_STATUS
771 SdMmcHcStartSdClock (
772 IN EFI_PCI_IO_PROTOCOL *PciIo,
773 IN UINT8 Slot
774 )
775 {
776 UINT16 ClockCtrl;
777
778 //
779 // Set SD Clock Enable in the Clock Control register to 1
780 //
781 ClockCtrl = BIT2;
782 return SdMmcHcOrMmio (PciIo, Slot, SD_MMC_HC_CLOCK_CTRL, sizeof (ClockCtrl), &ClockCtrl);
783 }
784
785 /**
786 SD/MMC card clock supply.
787
788 Refer to SD Host Controller Simplified spec 3.0 Section 3.2.1 for details.
789
790 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
791 @param[in] Slot The slot number of the SD card to send the command to.
792 @param[in] BusTiming BusTiming at which the frequency change is done.
793 @param[in] FirstTimeSetup Flag to indicate whether the clock is being setup for the first time.
794 @param[in] ClockFreq The max clock frequency to be set. The unit is KHz.
795
796 @retval EFI_SUCCESS The clock is supplied successfully.
797 @retval Others The clock isn't supplied successfully.
798
799 **/
800 EFI_STATUS
801 SdMmcHcClockSupply (
802 IN SD_MMC_HC_PRIVATE_DATA *Private,
803 IN UINT8 Slot,
804 IN SD_MMC_BUS_MODE BusTiming,
805 IN BOOLEAN FirstTimeSetup,
806 IN UINT64 ClockFreq
807 )
808 {
809 EFI_STATUS Status;
810 UINT32 SettingFreq;
811 UINT32 Divisor;
812 UINT32 Remainder;
813 UINT16 ClockCtrl;
814 UINT32 BaseClkFreq;
815 UINT16 ControllerVer;
816 EFI_PCI_IO_PROTOCOL *PciIo;
817
818 PciIo = Private->PciIo;
819 BaseClkFreq = Private->BaseClkFreq[Slot];
820 ControllerVer = Private->ControllerVersion[Slot];
821
822 if (BaseClkFreq == 0 || ClockFreq == 0) {
823 return EFI_INVALID_PARAMETER;
824 }
825
826 if (ClockFreq > (BaseClkFreq * 1000)) {
827 ClockFreq = BaseClkFreq * 1000;
828 }
829
830 //
831 // Calculate the divisor of base frequency.
832 //
833 Divisor = 0;
834 SettingFreq = BaseClkFreq * 1000;
835 while (ClockFreq < SettingFreq) {
836 Divisor++;
837
838 SettingFreq = (BaseClkFreq * 1000) / (2 * Divisor);
839 Remainder = (BaseClkFreq * 1000) % (2 * Divisor);
840 if ((ClockFreq == SettingFreq) && (Remainder == 0)) {
841 break;
842 }
843 if ((ClockFreq == SettingFreq) && (Remainder != 0)) {
844 SettingFreq ++;
845 }
846 }
847
848 DEBUG ((DEBUG_INFO, "BaseClkFreq %dMHz Divisor %d ClockFreq %dKhz\n", BaseClkFreq, Divisor, ClockFreq));
849
850 //
851 // Set SDCLK Frequency Select and Internal Clock Enable fields in Clock Control register.
852 //
853 if ((ControllerVer >= SD_MMC_HC_CTRL_VER_300) &&
854 (ControllerVer <= SD_MMC_HC_CTRL_VER_420)) {
855 ASSERT (Divisor <= 0x3FF);
856 ClockCtrl = ((Divisor & 0xFF) << 8) | ((Divisor & 0x300) >> 2);
857 } else if ((ControllerVer == SD_MMC_HC_CTRL_VER_100) ||
858 (ControllerVer == SD_MMC_HC_CTRL_VER_200)) {
859 //
860 // Only the most significant bit can be used as divisor.
861 //
862 if (((Divisor - 1) & Divisor) != 0) {
863 Divisor = 1 << (HighBitSet32 (Divisor) + 1);
864 }
865 ASSERT (Divisor <= 0x80);
866 ClockCtrl = (Divisor & 0xFF) << 8;
867 } else {
868 DEBUG ((DEBUG_ERROR, "Unknown SD Host Controller Spec version [0x%x]!!!\n", ControllerVer));
869 return EFI_UNSUPPORTED;
870 }
871
872 //
873 // Stop bus clock at first
874 //
875 Status = SdMmcHcStopClock (PciIo, Slot);
876 if (EFI_ERROR (Status)) {
877 return Status;
878 }
879
880 //
881 // Supply clock frequency with specified divisor
882 //
883 ClockCtrl |= BIT0;
884 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_CLOCK_CTRL, FALSE, sizeof (ClockCtrl), &ClockCtrl);
885 if (EFI_ERROR (Status)) {
886 DEBUG ((DEBUG_ERROR, "Set SDCLK Frequency Select and Internal Clock Enable fields fails\n"));
887 return Status;
888 }
889
890 //
891 // Wait Internal Clock Stable in the Clock Control register to be 1
892 //
893 Status = SdMmcHcWaitMmioSet (
894 PciIo,
895 Slot,
896 SD_MMC_HC_CLOCK_CTRL,
897 sizeof (ClockCtrl),
898 BIT1,
899 BIT1,
900 SD_MMC_HC_GENERIC_TIMEOUT
901 );
902 if (EFI_ERROR (Status)) {
903 return Status;
904 }
905
906 Status = SdMmcHcStartSdClock (PciIo, Slot);
907 if (EFI_ERROR (Status)) {
908 return Status;
909 }
910
911 //
912 // We don't notify the platform on first time setup to avoid changing
913 // legacy behavior. During first time setup we also don't know what type
914 // of the card slot it is and which enum value of BusTiming applies.
915 //
916 if (!FirstTimeSetup && mOverride != NULL && mOverride->NotifyPhase != NULL) {
917 Status = mOverride->NotifyPhase (
918 Private->ControllerHandle,
919 Slot,
920 EdkiiSdMmcSwitchClockFreqPost,
921 &BusTiming
922 );
923 if (EFI_ERROR (Status)) {
924 DEBUG ((
925 DEBUG_ERROR,
926 "%a: SD/MMC switch clock freq post notifier callback failed - %r\n",
927 __FUNCTION__,
928 Status
929 ));
930 return Status;
931 }
932 }
933
934 Private->Slot[Slot].CurrentFreq = ClockFreq;
935
936 return Status;
937 }
938
939 /**
940 SD/MMC bus power control.
941
942 Refer to SD Host Controller Simplified spec 3.0 Section 3.3 for details.
943
944 @param[in] PciIo The PCI IO protocol instance.
945 @param[in] Slot The slot number of the SD card to send the command to.
946 @param[in] PowerCtrl The value setting to the power control register.
947
948 @retval TRUE There is a SD/MMC card attached.
949 @retval FALSE There is no a SD/MMC card attached.
950
951 **/
952 EFI_STATUS
953 SdMmcHcPowerControl (
954 IN EFI_PCI_IO_PROTOCOL *PciIo,
955 IN UINT8 Slot,
956 IN UINT8 PowerCtrl
957 )
958 {
959 EFI_STATUS Status;
960
961 //
962 // Clr SD Bus Power
963 //
964 PowerCtrl &= (UINT8)~BIT0;
965 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_POWER_CTRL, FALSE, sizeof (PowerCtrl), &PowerCtrl);
966 if (EFI_ERROR (Status)) {
967 return Status;
968 }
969
970 //
971 // Set SD Bus Voltage Select and SD Bus Power fields in Power Control Register
972 //
973 PowerCtrl |= BIT0;
974 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_POWER_CTRL, FALSE, sizeof (PowerCtrl), &PowerCtrl);
975
976 return Status;
977 }
978
979 /**
980 Set the SD/MMC bus width.
981
982 Refer to SD Host Controller Simplified spec 3.0 Section 3.4 for details.
983
984 @param[in] PciIo The PCI IO protocol instance.
985 @param[in] Slot The slot number of the SD card to send the command to.
986 @param[in] BusWidth The bus width used by the SD/MMC device, it must be 1, 4 or 8.
987
988 @retval EFI_SUCCESS The bus width is set successfully.
989 @retval Others The bus width isn't set successfully.
990
991 **/
992 EFI_STATUS
993 SdMmcHcSetBusWidth (
994 IN EFI_PCI_IO_PROTOCOL *PciIo,
995 IN UINT8 Slot,
996 IN UINT16 BusWidth
997 )
998 {
999 EFI_STATUS Status;
1000 UINT8 HostCtrl1;
1001
1002 if (BusWidth == 1) {
1003 HostCtrl1 = (UINT8)~(BIT5 | BIT1);
1004 Status = SdMmcHcAndMmio (PciIo, Slot, SD_MMC_HC_HOST_CTRL1, sizeof (HostCtrl1), &HostCtrl1);
1005 } else if (BusWidth == 4) {
1006 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_HOST_CTRL1, TRUE, sizeof (HostCtrl1), &HostCtrl1);
1007 if (EFI_ERROR (Status)) {
1008 return Status;
1009 }
1010 HostCtrl1 |= BIT1;
1011 HostCtrl1 &= (UINT8)~BIT5;
1012 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_HOST_CTRL1, FALSE, sizeof (HostCtrl1), &HostCtrl1);
1013 } else if (BusWidth == 8) {
1014 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_HOST_CTRL1, TRUE, sizeof (HostCtrl1), &HostCtrl1);
1015 if (EFI_ERROR (Status)) {
1016 return Status;
1017 }
1018 HostCtrl1 &= (UINT8)~BIT1;
1019 HostCtrl1 |= BIT5;
1020 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_HOST_CTRL1, FALSE, sizeof (HostCtrl1), &HostCtrl1);
1021 } else {
1022 ASSERT (FALSE);
1023 return EFI_INVALID_PARAMETER;
1024 }
1025
1026 return Status;
1027 }
1028
1029 /**
1030 Configure V4 controller enhancements at initialization.
1031
1032 @param[in] PciIo The PCI IO protocol instance.
1033 @param[in] Slot The slot number of the SD card to send the command to.
1034 @param[in] Capability The capability of the slot.
1035 @param[in] ControllerVer The version of host controller.
1036
1037 @retval EFI_SUCCESS The clock is supplied successfully.
1038
1039 **/
1040 EFI_STATUS
1041 SdMmcHcInitV4Enhancements (
1042 IN EFI_PCI_IO_PROTOCOL *PciIo,
1043 IN UINT8 Slot,
1044 IN SD_MMC_HC_SLOT_CAP Capability,
1045 IN UINT16 ControllerVer
1046 )
1047 {
1048 EFI_STATUS Status;
1049 UINT16 HostCtrl2;
1050
1051 //
1052 // Check if controller version V4 or higher
1053 //
1054 if (ControllerVer >= SD_MMC_HC_CTRL_VER_400) {
1055 HostCtrl2 = SD_MMC_HC_V4_EN;
1056 //
1057 // Check if controller version V4.0
1058 //
1059 if (ControllerVer == SD_MMC_HC_CTRL_VER_400) {
1060 //
1061 // Check if 64bit support is available
1062 //
1063 if (Capability.SysBus64V3 != 0) {
1064 HostCtrl2 |= SD_MMC_HC_64_ADDR_EN;
1065 DEBUG ((DEBUG_INFO, "Enabled V4 64 bit system bus support\n"));
1066 }
1067 }
1068 //
1069 // Check if controller version V4.10 or higher
1070 //
1071 else if (ControllerVer >= SD_MMC_HC_CTRL_VER_410) {
1072 //
1073 // Check if 64bit support is available
1074 //
1075 if (Capability.SysBus64V4 != 0) {
1076 HostCtrl2 |= SD_MMC_HC_64_ADDR_EN;
1077 DEBUG ((DEBUG_INFO, "Enabled V4 64 bit system bus support\n"));
1078 }
1079 HostCtrl2 |= SD_MMC_HC_26_DATA_LEN_ADMA_EN;
1080 DEBUG ((DEBUG_INFO, "Enabled V4 26 bit data length ADMA support\n"));
1081 }
1082 Status = SdMmcHcOrMmio (PciIo, Slot, SD_MMC_HC_HOST_CTRL2, sizeof (HostCtrl2), &HostCtrl2);
1083 if (EFI_ERROR (Status)) {
1084 return Status;
1085 }
1086 }
1087
1088 return EFI_SUCCESS;
1089 }
1090
1091 /**
1092 Supply SD/MMC card with maximum voltage at initialization.
1093
1094 Refer to SD Host Controller Simplified spec 3.0 Section 3.3 for details.
1095
1096 @param[in] PciIo The PCI IO protocol instance.
1097 @param[in] Slot The slot number of the SD card to send the command to.
1098 @param[in] Capability The capability of the slot.
1099
1100 @retval EFI_SUCCESS The voltage is supplied successfully.
1101 @retval Others The voltage isn't supplied successfully.
1102
1103 **/
1104 EFI_STATUS
1105 SdMmcHcInitPowerVoltage (
1106 IN EFI_PCI_IO_PROTOCOL *PciIo,
1107 IN UINT8 Slot,
1108 IN SD_MMC_HC_SLOT_CAP Capability
1109 )
1110 {
1111 EFI_STATUS Status;
1112 UINT8 MaxVoltage;
1113 UINT8 HostCtrl2;
1114
1115 //
1116 // Calculate supported maximum voltage according to SD Bus Voltage Select
1117 //
1118 if (Capability.Voltage33 != 0) {
1119 //
1120 // Support 3.3V
1121 //
1122 MaxVoltage = 0x0E;
1123 } else if (Capability.Voltage30 != 0) {
1124 //
1125 // Support 3.0V
1126 //
1127 MaxVoltage = 0x0C;
1128 } else if (Capability.Voltage18 != 0) {
1129 //
1130 // Support 1.8V
1131 //
1132 MaxVoltage = 0x0A;
1133 HostCtrl2 = BIT3;
1134 Status = SdMmcHcOrMmio (PciIo, Slot, SD_MMC_HC_HOST_CTRL2, sizeof (HostCtrl2), &HostCtrl2);
1135 gBS->Stall (5000);
1136 if (EFI_ERROR (Status)) {
1137 return Status;
1138 }
1139 } else {
1140 ASSERT (FALSE);
1141 return EFI_DEVICE_ERROR;
1142 }
1143
1144 //
1145 // Set SD Bus Voltage Select and SD Bus Power fields in Power Control Register
1146 //
1147 Status = SdMmcHcPowerControl (PciIo, Slot, MaxVoltage);
1148
1149 return Status;
1150 }
1151
1152 /**
1153 Initialize the Timeout Control register with most conservative value at initialization.
1154
1155 Refer to SD Host Controller Simplified spec 3.0 Section 2.2.15 for details.
1156
1157 @param[in] PciIo The PCI IO protocol instance.
1158 @param[in] Slot The slot number of the SD card to send the command to.
1159
1160 @retval EFI_SUCCESS The timeout control register is configured successfully.
1161 @retval Others The timeout control register isn't configured successfully.
1162
1163 **/
1164 EFI_STATUS
1165 SdMmcHcInitTimeoutCtrl (
1166 IN EFI_PCI_IO_PROTOCOL *PciIo,
1167 IN UINT8 Slot
1168 )
1169 {
1170 EFI_STATUS Status;
1171 UINT8 Timeout;
1172
1173 Timeout = 0x0E;
1174 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_TIMEOUT_CTRL, FALSE, sizeof (Timeout), &Timeout);
1175
1176 return Status;
1177 }
1178
1179 /**
1180 Initial SD/MMC host controller with lowest clock frequency, max power and max timeout value
1181 at initialization.
1182
1183 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
1184 @param[in] Slot The slot number of the SD card to send the command to.
1185
1186 @retval EFI_SUCCESS The host controller is initialized successfully.
1187 @retval Others The host controller isn't initialized successfully.
1188
1189 **/
1190 EFI_STATUS
1191 SdMmcHcInitHost (
1192 IN SD_MMC_HC_PRIVATE_DATA *Private,
1193 IN UINT8 Slot
1194 )
1195 {
1196 EFI_STATUS Status;
1197 EFI_PCI_IO_PROTOCOL *PciIo;
1198 SD_MMC_HC_SLOT_CAP Capability;
1199
1200 //
1201 // Notify the SD/MMC override protocol that we are about to initialize
1202 // the SD/MMC host controller.
1203 //
1204 if (mOverride != NULL && mOverride->NotifyPhase != NULL) {
1205 Status = mOverride->NotifyPhase (
1206 Private->ControllerHandle,
1207 Slot,
1208 EdkiiSdMmcInitHostPre,
1209 NULL);
1210 if (EFI_ERROR (Status)) {
1211 DEBUG ((DEBUG_WARN,
1212 "%a: SD/MMC pre init notifier callback failed - %r\n",
1213 __FUNCTION__, Status));
1214 return Status;
1215 }
1216 }
1217
1218 PciIo = Private->PciIo;
1219 Capability = Private->Capability[Slot];
1220
1221 Status = SdMmcHcInitV4Enhancements (PciIo, Slot, Capability, Private->ControllerVersion[Slot]);
1222 if (EFI_ERROR (Status)) {
1223 return Status;
1224 }
1225
1226 //
1227 // Perform first time clock setup with 400 KHz frequency.
1228 // We send the 0 as the BusTiming value because at this time
1229 // we still do not know the slot type and which enum value will apply.
1230 // Since it is a first time setup SdMmcHcClockSupply won't notify
1231 // the platofrm driver anyway so it doesn't matter.
1232 //
1233 Status = SdMmcHcClockSupply (Private, Slot, 0, TRUE, 400);
1234 if (EFI_ERROR (Status)) {
1235 return Status;
1236 }
1237
1238 Status = SdMmcHcInitPowerVoltage (PciIo, Slot, Capability);
1239 if (EFI_ERROR (Status)) {
1240 return Status;
1241 }
1242
1243 Status = SdMmcHcInitTimeoutCtrl (PciIo, Slot);
1244 if (EFI_ERROR (Status)) {
1245 return Status;
1246 }
1247
1248 //
1249 // Notify the SD/MMC override protocol that we are have just initialized
1250 // the SD/MMC host controller.
1251 //
1252 if (mOverride != NULL && mOverride->NotifyPhase != NULL) {
1253 Status = mOverride->NotifyPhase (
1254 Private->ControllerHandle,
1255 Slot,
1256 EdkiiSdMmcInitHostPost,
1257 NULL);
1258 if (EFI_ERROR (Status)) {
1259 DEBUG ((DEBUG_WARN,
1260 "%a: SD/MMC post init notifier callback failed - %r\n",
1261 __FUNCTION__, Status));
1262 }
1263 }
1264 return Status;
1265 }
1266
1267 /**
1268 Set SD Host Controler control 2 registry according to selected speed.
1269
1270 @param[in] ControllerHandle The handle of the controller.
1271 @param[in] PciIo The PCI IO protocol instance.
1272 @param[in] Slot The slot number of the SD card to send the command to.
1273 @param[in] Timing The timing to select.
1274
1275 @retval EFI_SUCCESS The timing is set successfully.
1276 @retval Others The timing isn't set successfully.
1277 **/
1278 EFI_STATUS
1279 SdMmcHcUhsSignaling (
1280 IN EFI_HANDLE ControllerHandle,
1281 IN EFI_PCI_IO_PROTOCOL *PciIo,
1282 IN UINT8 Slot,
1283 IN SD_MMC_BUS_MODE Timing
1284 )
1285 {
1286 EFI_STATUS Status;
1287 UINT8 HostCtrl2;
1288
1289 HostCtrl2 = (UINT8)~SD_MMC_HC_CTRL_UHS_MASK;
1290 Status = SdMmcHcAndMmio (PciIo, Slot, SD_MMC_HC_HOST_CTRL2, sizeof (HostCtrl2), &HostCtrl2);
1291 if (EFI_ERROR (Status)) {
1292 return Status;
1293 }
1294
1295 switch (Timing) {
1296 case SdMmcUhsSdr12:
1297 HostCtrl2 = SD_MMC_HC_CTRL_UHS_SDR12;
1298 break;
1299 case SdMmcUhsSdr25:
1300 HostCtrl2 = SD_MMC_HC_CTRL_UHS_SDR25;
1301 break;
1302 case SdMmcUhsSdr50:
1303 HostCtrl2 = SD_MMC_HC_CTRL_UHS_SDR50;
1304 break;
1305 case SdMmcUhsSdr104:
1306 HostCtrl2 = SD_MMC_HC_CTRL_UHS_SDR104;
1307 break;
1308 case SdMmcUhsDdr50:
1309 HostCtrl2 = SD_MMC_HC_CTRL_UHS_DDR50;
1310 break;
1311 case SdMmcMmcLegacy:
1312 HostCtrl2 = SD_MMC_HC_CTRL_MMC_LEGACY;
1313 break;
1314 case SdMmcMmcHsSdr:
1315 HostCtrl2 = SD_MMC_HC_CTRL_MMC_HS_SDR;
1316 break;
1317 case SdMmcMmcHsDdr:
1318 HostCtrl2 = SD_MMC_HC_CTRL_MMC_HS_DDR;
1319 break;
1320 case SdMmcMmcHs200:
1321 HostCtrl2 = SD_MMC_HC_CTRL_MMC_HS200;
1322 break;
1323 case SdMmcMmcHs400:
1324 HostCtrl2 = SD_MMC_HC_CTRL_MMC_HS400;
1325 break;
1326 default:
1327 HostCtrl2 = 0;
1328 break;
1329 }
1330 Status = SdMmcHcOrMmio (PciIo, Slot, SD_MMC_HC_HOST_CTRL2, sizeof (HostCtrl2), &HostCtrl2);
1331 if (EFI_ERROR (Status)) {
1332 return Status;
1333 }
1334
1335 if (mOverride != NULL && mOverride->NotifyPhase != NULL) {
1336 Status = mOverride->NotifyPhase (
1337 ControllerHandle,
1338 Slot,
1339 EdkiiSdMmcUhsSignaling,
1340 &Timing
1341 );
1342 if (EFI_ERROR (Status)) {
1343 DEBUG ((
1344 DEBUG_ERROR,
1345 "%a: SD/MMC uhs signaling notifier callback failed - %r\n",
1346 __FUNCTION__,
1347 Status
1348 ));
1349 return Status;
1350 }
1351 }
1352
1353 return EFI_SUCCESS;
1354 }
1355
1356 /**
1357 Set driver strength in host controller.
1358
1359 @param[in] PciIo The PCI IO protocol instance.
1360 @param[in] SlotIndex The slot index of the card.
1361 @param[in] DriverStrength DriverStrength to set in the controller.
1362
1363 @retval EFI_SUCCESS Driver strength programmed successfully.
1364 @retval Others Failed to set driver strength.
1365 **/
1366 EFI_STATUS
1367 SdMmcSetDriverStrength (
1368 IN EFI_PCI_IO_PROTOCOL *PciIo,
1369 IN UINT8 SlotIndex,
1370 IN SD_DRIVER_STRENGTH_TYPE DriverStrength
1371 )
1372 {
1373 EFI_STATUS Status;
1374 UINT16 HostCtrl2;
1375
1376 if (DriverStrength == SdDriverStrengthIgnore) {
1377 return EFI_SUCCESS;
1378 }
1379
1380 HostCtrl2 = (UINT16)~SD_MMC_HC_CTRL_DRIVER_STRENGTH_MASK;
1381 Status = SdMmcHcAndMmio (PciIo, SlotIndex, SD_MMC_HC_HOST_CTRL2, sizeof (HostCtrl2), &HostCtrl2);
1382 if (EFI_ERROR (Status)) {
1383 return Status;
1384 }
1385
1386 HostCtrl2 = (DriverStrength << 4) & SD_MMC_HC_CTRL_DRIVER_STRENGTH_MASK;
1387 return SdMmcHcOrMmio (PciIo, SlotIndex, SD_MMC_HC_HOST_CTRL2, sizeof (HostCtrl2), &HostCtrl2);
1388 }
1389
1390 /**
1391 Turn on/off LED.
1392
1393 @param[in] PciIo The PCI IO protocol instance.
1394 @param[in] Slot The slot number of the SD card to send the command to.
1395 @param[in] On The boolean to turn on/off LED.
1396
1397 @retval EFI_SUCCESS The LED is turned on/off successfully.
1398 @retval Others The LED isn't turned on/off successfully.
1399
1400 **/
1401 EFI_STATUS
1402 SdMmcHcLedOnOff (
1403 IN EFI_PCI_IO_PROTOCOL *PciIo,
1404 IN UINT8 Slot,
1405 IN BOOLEAN On
1406 )
1407 {
1408 EFI_STATUS Status;
1409 UINT8 HostCtrl1;
1410
1411 if (On) {
1412 HostCtrl1 = BIT0;
1413 Status = SdMmcHcOrMmio (PciIo, Slot, SD_MMC_HC_HOST_CTRL1, sizeof (HostCtrl1), &HostCtrl1);
1414 } else {
1415 HostCtrl1 = (UINT8)~BIT0;
1416 Status = SdMmcHcAndMmio (PciIo, Slot, SD_MMC_HC_HOST_CTRL1, sizeof (HostCtrl1), &HostCtrl1);
1417 }
1418
1419 return Status;
1420 }
1421
1422 /**
1423 Build ADMA descriptor table for transfer.
1424
1425 Refer to SD Host Controller Simplified spec 4.2 Section 1.13 for details.
1426
1427 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.
1428 @param[in] ControllerVer The version of host controller.
1429
1430 @retval EFI_SUCCESS The ADMA descriptor table is created successfully.
1431 @retval Others The ADMA descriptor table isn't created successfully.
1432
1433 **/
1434 EFI_STATUS
1435 BuildAdmaDescTable (
1436 IN SD_MMC_HC_TRB *Trb,
1437 IN UINT16 ControllerVer
1438 )
1439 {
1440 EFI_PHYSICAL_ADDRESS Data;
1441 UINT64 DataLen;
1442 UINT64 Entries;
1443 UINT32 Index;
1444 UINT64 Remaining;
1445 UINT64 Address;
1446 UINTN TableSize;
1447 EFI_PCI_IO_PROTOCOL *PciIo;
1448 EFI_STATUS Status;
1449 UINTN Bytes;
1450 UINT32 AdmaMaxDataPerLine;
1451 UINT32 DescSize;
1452 VOID *AdmaDesc;
1453
1454 AdmaMaxDataPerLine = ADMA_MAX_DATA_PER_LINE_16B;
1455 DescSize = sizeof (SD_MMC_HC_ADMA_32_DESC_LINE);
1456 AdmaDesc = NULL;
1457
1458 Data = Trb->DataPhy;
1459 DataLen = Trb->DataLen;
1460 PciIo = Trb->Private->PciIo;
1461
1462 //
1463 // Check for valid ranges in 32bit ADMA Descriptor Table
1464 //
1465 if ((Trb->Mode == SdMmcAdma32bMode) &&
1466 ((Data >= 0x100000000ul) || ((Data + DataLen) > 0x100000000ul))) {
1467 return EFI_INVALID_PARAMETER;
1468 }
1469 //
1470 // Check address field alignment
1471 //
1472 if (Trb->Mode != SdMmcAdma32bMode) {
1473 //
1474 // Address field shall be set on 64-bit boundary (Lower 3-bit is always set to 0)
1475 //
1476 if ((Data & (BIT0 | BIT1 | BIT2)) != 0) {
1477 DEBUG ((DEBUG_INFO, "The buffer [0x%x] to construct ADMA desc is not aligned to 8 bytes boundary!\n", Data));
1478 }
1479 } else {
1480 //
1481 // Address field shall be set on 32-bit boundary (Lower 2-bit is always set to 0)
1482 //
1483 if ((Data & (BIT0 | BIT1)) != 0) {
1484 DEBUG ((DEBUG_INFO, "The buffer [0x%x] to construct ADMA desc is not aligned to 4 bytes boundary!\n", Data));
1485 }
1486 }
1487
1488 //
1489 // Configure 64b ADMA.
1490 //
1491 if (Trb->Mode == SdMmcAdma64bV3Mode) {
1492 DescSize = sizeof (SD_MMC_HC_ADMA_64_V3_DESC_LINE);
1493 }else if (Trb->Mode == SdMmcAdma64bV4Mode) {
1494 DescSize = sizeof (SD_MMC_HC_ADMA_64_V4_DESC_LINE);
1495 }
1496 //
1497 // Configure 26b data length.
1498 //
1499 if (Trb->AdmaLengthMode == SdMmcAdmaLen26b) {
1500 AdmaMaxDataPerLine = ADMA_MAX_DATA_PER_LINE_26B;
1501 }
1502
1503 Entries = DivU64x32 ((DataLen + AdmaMaxDataPerLine - 1), AdmaMaxDataPerLine);
1504 TableSize = (UINTN)MultU64x32 (Entries, DescSize);
1505 Trb->AdmaPages = (UINT32)EFI_SIZE_TO_PAGES (TableSize);
1506 Status = PciIo->AllocateBuffer (
1507 PciIo,
1508 AllocateAnyPages,
1509 EfiBootServicesData,
1510 EFI_SIZE_TO_PAGES (TableSize),
1511 (VOID **)&AdmaDesc,
1512 0
1513 );
1514 if (EFI_ERROR (Status)) {
1515 return EFI_OUT_OF_RESOURCES;
1516 }
1517 ZeroMem (AdmaDesc, TableSize);
1518 Bytes = TableSize;
1519 Status = PciIo->Map (
1520 PciIo,
1521 EfiPciIoOperationBusMasterCommonBuffer,
1522 AdmaDesc,
1523 &Bytes,
1524 &Trb->AdmaDescPhy,
1525 &Trb->AdmaMap
1526 );
1527
1528 if (EFI_ERROR (Status) || (Bytes != TableSize)) {
1529 //
1530 // Map error or unable to map the whole RFis buffer into a contiguous region.
1531 //
1532 PciIo->FreeBuffer (
1533 PciIo,
1534 EFI_SIZE_TO_PAGES (TableSize),
1535 AdmaDesc
1536 );
1537 return EFI_OUT_OF_RESOURCES;
1538 }
1539
1540 if ((Trb->Mode == SdMmcAdma32bMode) &&
1541 (UINT64)(UINTN)Trb->AdmaDescPhy > 0x100000000ul) {
1542 //
1543 // The ADMA doesn't support 64bit addressing.
1544 //
1545 PciIo->Unmap (
1546 PciIo,
1547 Trb->AdmaMap
1548 );
1549 Trb->AdmaMap = NULL;
1550
1551 PciIo->FreeBuffer (
1552 PciIo,
1553 EFI_SIZE_TO_PAGES (TableSize),
1554 AdmaDesc
1555 );
1556 return EFI_DEVICE_ERROR;
1557 }
1558
1559 Remaining = DataLen;
1560 Address = Data;
1561 if (Trb->Mode == SdMmcAdma32bMode) {
1562 Trb->Adma32Desc = AdmaDesc;
1563 } else if (Trb->Mode == SdMmcAdma64bV3Mode) {
1564 Trb->Adma64V3Desc = AdmaDesc;
1565 } else {
1566 Trb->Adma64V4Desc = AdmaDesc;
1567 }
1568
1569 for (Index = 0; Index < Entries; Index++) {
1570 if (Trb->Mode == SdMmcAdma32bMode) {
1571 if (Remaining <= AdmaMaxDataPerLine) {
1572 Trb->Adma32Desc[Index].Valid = 1;
1573 Trb->Adma32Desc[Index].Act = 2;
1574 if (Trb->AdmaLengthMode == SdMmcAdmaLen26b) {
1575 Trb->Adma32Desc[Index].UpperLength = (UINT16)RShiftU64 (Remaining, 16);
1576 }
1577 Trb->Adma32Desc[Index].LowerLength = (UINT16)(Remaining & MAX_UINT16);
1578 Trb->Adma32Desc[Index].Address = (UINT32)Address;
1579 break;
1580 } else {
1581 Trb->Adma32Desc[Index].Valid = 1;
1582 Trb->Adma32Desc[Index].Act = 2;
1583 if (Trb->AdmaLengthMode == SdMmcAdmaLen26b) {
1584 Trb->Adma32Desc[Index].UpperLength = 0;
1585 }
1586 Trb->Adma32Desc[Index].LowerLength = 0;
1587 Trb->Adma32Desc[Index].Address = (UINT32)Address;
1588 }
1589 } else if (Trb->Mode == SdMmcAdma64bV3Mode) {
1590 if (Remaining <= AdmaMaxDataPerLine) {
1591 Trb->Adma64V3Desc[Index].Valid = 1;
1592 Trb->Adma64V3Desc[Index].Act = 2;
1593 if (Trb->AdmaLengthMode == SdMmcAdmaLen26b) {
1594 Trb->Adma64V3Desc[Index].UpperLength = (UINT16)RShiftU64 (Remaining, 16);
1595 }
1596 Trb->Adma64V3Desc[Index].LowerLength = (UINT16)(Remaining & MAX_UINT16);
1597 Trb->Adma64V3Desc[Index].LowerAddress = (UINT32)Address;
1598 Trb->Adma64V3Desc[Index].UpperAddress = (UINT32)RShiftU64 (Address, 32);
1599 break;
1600 } else {
1601 Trb->Adma64V3Desc[Index].Valid = 1;
1602 Trb->Adma64V3Desc[Index].Act = 2;
1603 if (Trb->AdmaLengthMode == SdMmcAdmaLen26b) {
1604 Trb->Adma64V3Desc[Index].UpperLength = 0;
1605 }
1606 Trb->Adma64V3Desc[Index].LowerLength = 0;
1607 Trb->Adma64V3Desc[Index].LowerAddress = (UINT32)Address;
1608 Trb->Adma64V3Desc[Index].UpperAddress = (UINT32)RShiftU64 (Address, 32);
1609 }
1610 } else {
1611 if (Remaining <= AdmaMaxDataPerLine) {
1612 Trb->Adma64V4Desc[Index].Valid = 1;
1613 Trb->Adma64V4Desc[Index].Act = 2;
1614 if (Trb->AdmaLengthMode == SdMmcAdmaLen26b) {
1615 Trb->Adma64V4Desc[Index].UpperLength = (UINT16)RShiftU64 (Remaining, 16);
1616 }
1617 Trb->Adma64V4Desc[Index].LowerLength = (UINT16)(Remaining & MAX_UINT16);
1618 Trb->Adma64V4Desc[Index].LowerAddress = (UINT32)Address;
1619 Trb->Adma64V4Desc[Index].UpperAddress = (UINT32)RShiftU64 (Address, 32);
1620 break;
1621 } else {
1622 Trb->Adma64V4Desc[Index].Valid = 1;
1623 Trb->Adma64V4Desc[Index].Act = 2;
1624 if (Trb->AdmaLengthMode == SdMmcAdmaLen26b) {
1625 Trb->Adma64V4Desc[Index].UpperLength = 0;
1626 }
1627 Trb->Adma64V4Desc[Index].LowerLength = 0;
1628 Trb->Adma64V4Desc[Index].LowerAddress = (UINT32)Address;
1629 Trb->Adma64V4Desc[Index].UpperAddress = (UINT32)RShiftU64 (Address, 32);
1630 }
1631 }
1632
1633 Remaining -= AdmaMaxDataPerLine;
1634 Address += AdmaMaxDataPerLine;
1635 }
1636
1637 //
1638 // Set the last descriptor line as end of descriptor table
1639 //
1640 if (Trb->Mode == SdMmcAdma32bMode) {
1641 Trb->Adma32Desc[Index].End = 1;
1642 } else if (Trb->Mode == SdMmcAdma64bV3Mode) {
1643 Trb->Adma64V3Desc[Index].End = 1;
1644 } else {
1645 Trb->Adma64V4Desc[Index].End = 1;
1646 }
1647 return EFI_SUCCESS;
1648 }
1649
1650 /**
1651 Create a new TRB for the SD/MMC cmd request.
1652
1653 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
1654 @param[in] Slot The slot number of the SD card to send the command to.
1655 @param[in] Packet A pointer to the SD command data structure.
1656 @param[in] Event If Event is NULL, blocking I/O is performed. If Event is
1657 not NULL, then nonblocking I/O is performed, and Event
1658 will be signaled when the Packet completes.
1659
1660 @return Created Trb or NULL.
1661
1662 **/
1663 SD_MMC_HC_TRB *
1664 SdMmcCreateTrb (
1665 IN SD_MMC_HC_PRIVATE_DATA *Private,
1666 IN UINT8 Slot,
1667 IN EFI_SD_MMC_PASS_THRU_COMMAND_PACKET *Packet,
1668 IN EFI_EVENT Event
1669 )
1670 {
1671 SD_MMC_HC_TRB *Trb;
1672 EFI_STATUS Status;
1673 EFI_TPL OldTpl;
1674 EFI_PCI_IO_PROTOCOL_OPERATION Flag;
1675 EFI_PCI_IO_PROTOCOL *PciIo;
1676 UINTN MapLength;
1677
1678 Trb = AllocateZeroPool (sizeof (SD_MMC_HC_TRB));
1679 if (Trb == NULL) {
1680 return NULL;
1681 }
1682
1683 Trb->Signature = SD_MMC_HC_TRB_SIG;
1684 Trb->Slot = Slot;
1685 Trb->BlockSize = 0x200;
1686 Trb->Packet = Packet;
1687 Trb->Event = Event;
1688 Trb->Started = FALSE;
1689 Trb->Timeout = Packet->Timeout;
1690 Trb->Retries = SD_MMC_TRB_RETRIES;
1691 Trb->Private = Private;
1692
1693 if ((Packet->InTransferLength != 0) && (Packet->InDataBuffer != NULL)) {
1694 Trb->Data = Packet->InDataBuffer;
1695 Trb->DataLen = Packet->InTransferLength;
1696 Trb->Read = TRUE;
1697 } else if ((Packet->OutTransferLength != 0) && (Packet->OutDataBuffer != NULL)) {
1698 Trb->Data = Packet->OutDataBuffer;
1699 Trb->DataLen = Packet->OutTransferLength;
1700 Trb->Read = FALSE;
1701 } else if ((Packet->InTransferLength == 0) && (Packet->OutTransferLength == 0)) {
1702 Trb->Data = NULL;
1703 Trb->DataLen = 0;
1704 } else {
1705 goto Error;
1706 }
1707
1708 if ((Trb->DataLen != 0) && (Trb->DataLen < Trb->BlockSize)) {
1709 Trb->BlockSize = (UINT16)Trb->DataLen;
1710 }
1711
1712 if (((Private->Slot[Trb->Slot].CardType == EmmcCardType) &&
1713 (Packet->SdMmcCmdBlk->CommandIndex == EMMC_SEND_TUNING_BLOCK)) ||
1714 ((Private->Slot[Trb->Slot].CardType == SdCardType) &&
1715 (Packet->SdMmcCmdBlk->CommandIndex == SD_SEND_TUNING_BLOCK))) {
1716 Trb->Mode = SdMmcPioMode;
1717 } else {
1718 if (Trb->Read) {
1719 Flag = EfiPciIoOperationBusMasterWrite;
1720 } else {
1721 Flag = EfiPciIoOperationBusMasterRead;
1722 }
1723
1724 PciIo = Private->PciIo;
1725 if (Trb->DataLen != 0) {
1726 MapLength = Trb->DataLen;
1727 Status = PciIo->Map (
1728 PciIo,
1729 Flag,
1730 Trb->Data,
1731 &MapLength,
1732 &Trb->DataPhy,
1733 &Trb->DataMap
1734 );
1735 if (EFI_ERROR (Status) || (Trb->DataLen != MapLength)) {
1736 Status = EFI_BAD_BUFFER_SIZE;
1737 goto Error;
1738 }
1739 }
1740
1741 if (Trb->DataLen == 0) {
1742 Trb->Mode = SdMmcNoData;
1743 } else if (Private->Capability[Slot].Adma2 != 0) {
1744 Trb->Mode = SdMmcAdma32bMode;
1745 Trb->AdmaLengthMode = SdMmcAdmaLen16b;
1746 if ((Private->ControllerVersion[Slot] == SD_MMC_HC_CTRL_VER_300) &&
1747 (Private->Capability[Slot].SysBus64V3 == 1)) {
1748 Trb->Mode = SdMmcAdma64bV3Mode;
1749 } else if (((Private->ControllerVersion[Slot] == SD_MMC_HC_CTRL_VER_400) &&
1750 (Private->Capability[Slot].SysBus64V3 == 1)) ||
1751 ((Private->ControllerVersion[Slot] >= SD_MMC_HC_CTRL_VER_410) &&
1752 (Private->Capability[Slot].SysBus64V4 == 1))) {
1753 Trb->Mode = SdMmcAdma64bV4Mode;
1754 }
1755 if (Private->ControllerVersion[Slot] >= SD_MMC_HC_CTRL_VER_410) {
1756 Trb->AdmaLengthMode = SdMmcAdmaLen26b;
1757 }
1758 Status = BuildAdmaDescTable (Trb, Private->ControllerVersion[Slot]);
1759 if (EFI_ERROR (Status)) {
1760 goto Error;
1761 }
1762 } else if (Private->Capability[Slot].Sdma != 0) {
1763 Trb->Mode = SdMmcSdmaMode;
1764 } else {
1765 Trb->Mode = SdMmcPioMode;
1766 }
1767 }
1768
1769 if (Event != NULL) {
1770 OldTpl = gBS->RaiseTPL (TPL_NOTIFY);
1771 InsertTailList (&Private->Queue, &Trb->TrbList);
1772 gBS->RestoreTPL (OldTpl);
1773 }
1774
1775 return Trb;
1776
1777 Error:
1778 SdMmcFreeTrb (Trb);
1779 return NULL;
1780 }
1781
1782 /**
1783 Free the resource used by the TRB.
1784
1785 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.
1786
1787 **/
1788 VOID
1789 SdMmcFreeTrb (
1790 IN SD_MMC_HC_TRB *Trb
1791 )
1792 {
1793 EFI_PCI_IO_PROTOCOL *PciIo;
1794
1795 PciIo = Trb->Private->PciIo;
1796
1797 if (Trb->AdmaMap != NULL) {
1798 PciIo->Unmap (
1799 PciIo,
1800 Trb->AdmaMap
1801 );
1802 }
1803 if (Trb->Adma32Desc != NULL) {
1804 PciIo->FreeBuffer (
1805 PciIo,
1806 Trb->AdmaPages,
1807 Trb->Adma32Desc
1808 );
1809 }
1810 if (Trb->Adma64V3Desc != NULL) {
1811 PciIo->FreeBuffer (
1812 PciIo,
1813 Trb->AdmaPages,
1814 Trb->Adma64V3Desc
1815 );
1816 }
1817 if (Trb->Adma64V4Desc != NULL) {
1818 PciIo->FreeBuffer (
1819 PciIo,
1820 Trb->AdmaPages,
1821 Trb->Adma64V4Desc
1822 );
1823 }
1824 if (Trb->DataMap != NULL) {
1825 PciIo->Unmap (
1826 PciIo,
1827 Trb->DataMap
1828 );
1829 }
1830 FreePool (Trb);
1831 return;
1832 }
1833
1834 /**
1835 Check if the env is ready for execute specified TRB.
1836
1837 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
1838 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.
1839
1840 @retval EFI_SUCCESS The env is ready for TRB execution.
1841 @retval EFI_NOT_READY The env is not ready for TRB execution.
1842 @retval Others Some erros happen.
1843
1844 **/
1845 EFI_STATUS
1846 SdMmcCheckTrbEnv (
1847 IN SD_MMC_HC_PRIVATE_DATA *Private,
1848 IN SD_MMC_HC_TRB *Trb
1849 )
1850 {
1851 EFI_STATUS Status;
1852 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET *Packet;
1853 EFI_PCI_IO_PROTOCOL *PciIo;
1854 UINT32 PresentState;
1855
1856 Packet = Trb->Packet;
1857
1858 if ((Packet->SdMmcCmdBlk->CommandType == SdMmcCommandTypeAdtc) ||
1859 (Packet->SdMmcCmdBlk->ResponseType == SdMmcResponseTypeR1b) ||
1860 (Packet->SdMmcCmdBlk->ResponseType == SdMmcResponseTypeR5b)) {
1861 //
1862 // Wait Command Inhibit (CMD) and Command Inhibit (DAT) in
1863 // the Present State register to be 0
1864 //
1865 PresentState = BIT0 | BIT1;
1866 } else {
1867 //
1868 // Wait Command Inhibit (CMD) in the Present State register
1869 // to be 0
1870 //
1871 PresentState = BIT0;
1872 }
1873
1874 PciIo = Private->PciIo;
1875 Status = SdMmcHcCheckMmioSet (
1876 PciIo,
1877 Trb->Slot,
1878 SD_MMC_HC_PRESENT_STATE,
1879 sizeof (PresentState),
1880 PresentState,
1881 0
1882 );
1883
1884 return Status;
1885 }
1886
1887 /**
1888 Wait for the env to be ready for execute specified TRB.
1889
1890 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
1891 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.
1892
1893 @retval EFI_SUCCESS The env is ready for TRB execution.
1894 @retval EFI_TIMEOUT The env is not ready for TRB execution in time.
1895 @retval Others Some erros happen.
1896
1897 **/
1898 EFI_STATUS
1899 SdMmcWaitTrbEnv (
1900 IN SD_MMC_HC_PRIVATE_DATA *Private,
1901 IN SD_MMC_HC_TRB *Trb
1902 )
1903 {
1904 EFI_STATUS Status;
1905 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET *Packet;
1906 UINT64 Timeout;
1907 BOOLEAN InfiniteWait;
1908
1909 //
1910 // Wait Command Complete Interrupt Status bit in Normal Interrupt Status Register
1911 //
1912 Packet = Trb->Packet;
1913 Timeout = Packet->Timeout;
1914 if (Timeout == 0) {
1915 InfiniteWait = TRUE;
1916 } else {
1917 InfiniteWait = FALSE;
1918 }
1919
1920 while (InfiniteWait || (Timeout > 0)) {
1921 //
1922 // Check Trb execution result by reading Normal Interrupt Status register.
1923 //
1924 Status = SdMmcCheckTrbEnv (Private, Trb);
1925 if (Status != EFI_NOT_READY) {
1926 return Status;
1927 }
1928 //
1929 // Stall for 1 microsecond.
1930 //
1931 gBS->Stall (1);
1932
1933 Timeout--;
1934 }
1935
1936 return EFI_TIMEOUT;
1937 }
1938
1939 /**
1940 Execute the specified TRB.
1941
1942 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
1943 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.
1944
1945 @retval EFI_SUCCESS The TRB is sent to host controller successfully.
1946 @retval Others Some erros happen when sending this request to the host controller.
1947
1948 **/
1949 EFI_STATUS
1950 SdMmcExecTrb (
1951 IN SD_MMC_HC_PRIVATE_DATA *Private,
1952 IN SD_MMC_HC_TRB *Trb
1953 )
1954 {
1955 EFI_STATUS Status;
1956 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET *Packet;
1957 EFI_PCI_IO_PROTOCOL *PciIo;
1958 UINT16 Cmd;
1959 UINT16 IntStatus;
1960 UINT32 Argument;
1961 UINT32 BlkCount;
1962 UINT16 BlkSize;
1963 UINT16 TransMode;
1964 UINT8 HostCtrl1;
1965 UINT64 SdmaAddr;
1966 UINT64 AdmaAddr;
1967 BOOLEAN AddressingMode64;
1968
1969 AddressingMode64 = FALSE;
1970
1971 Packet = Trb->Packet;
1972 PciIo = Trb->Private->PciIo;
1973 //
1974 // Clear all bits in Error Interrupt Status Register
1975 //
1976 IntStatus = 0xFFFF;
1977 Status = SdMmcHcRwMmio (PciIo, Trb->Slot, SD_MMC_HC_ERR_INT_STS, FALSE, sizeof (IntStatus), &IntStatus);
1978 if (EFI_ERROR (Status)) {
1979 return Status;
1980 }
1981 //
1982 // Clear all bits in Normal Interrupt Status Register excepts for Card Removal & Card Insertion bits.
1983 //
1984 IntStatus = 0xFF3F;
1985 Status = SdMmcHcRwMmio (PciIo, Trb->Slot, SD_MMC_HC_NOR_INT_STS, FALSE, sizeof (IntStatus), &IntStatus);
1986 if (EFI_ERROR (Status)) {
1987 return Status;
1988 }
1989
1990 if (Private->ControllerVersion[Trb->Slot] >= SD_MMC_HC_CTRL_VER_400) {
1991 Status = SdMmcHcCheckMmioSet(PciIo, Trb->Slot, SD_MMC_HC_HOST_CTRL2, sizeof(UINT16),
1992 SD_MMC_HC_64_ADDR_EN, SD_MMC_HC_64_ADDR_EN);
1993 if (!EFI_ERROR (Status)) {
1994 AddressingMode64 = TRUE;
1995 }
1996 }
1997
1998 //
1999 // Set Host Control 1 register DMA Select field
2000 //
2001 if ((Trb->Mode == SdMmcAdma32bMode) ||
2002 (Trb->Mode == SdMmcAdma64bV4Mode)) {
2003 HostCtrl1 = BIT4;
2004 Status = SdMmcHcOrMmio (PciIo, Trb->Slot, SD_MMC_HC_HOST_CTRL1, sizeof (HostCtrl1), &HostCtrl1);
2005 if (EFI_ERROR (Status)) {
2006 return Status;
2007 }
2008 } else if (Trb->Mode == SdMmcAdma64bV3Mode) {
2009 HostCtrl1 = BIT4|BIT3;
2010 Status = SdMmcHcOrMmio (PciIo, Trb->Slot, SD_MMC_HC_HOST_CTRL1, sizeof (HostCtrl1), &HostCtrl1);
2011 if (EFI_ERROR (Status)) {
2012 return Status;
2013 }
2014 }
2015
2016 SdMmcHcLedOnOff (PciIo, Trb->Slot, TRUE);
2017
2018 if (Trb->Mode == SdMmcSdmaMode) {
2019 if ((!AddressingMode64) &&
2020 ((UINT64)(UINTN)Trb->DataPhy >= 0x100000000ul)) {
2021 return EFI_INVALID_PARAMETER;
2022 }
2023
2024 SdmaAddr = (UINT64)(UINTN)Trb->DataPhy;
2025
2026 if (Private->ControllerVersion[Trb->Slot] >= SD_MMC_HC_CTRL_VER_400) {
2027 Status = SdMmcHcRwMmio (PciIo, Trb->Slot, SD_MMC_HC_ADMA_SYS_ADDR, FALSE, sizeof (UINT64), &SdmaAddr);
2028 } else {
2029 Status = SdMmcHcRwMmio (PciIo, Trb->Slot, SD_MMC_HC_SDMA_ADDR, FALSE, sizeof (UINT32), &SdmaAddr);
2030 }
2031
2032 if (EFI_ERROR (Status)) {
2033 return Status;
2034 }
2035 } else if ((Trb->Mode == SdMmcAdma32bMode) ||
2036 (Trb->Mode == SdMmcAdma64bV3Mode) ||
2037 (Trb->Mode == SdMmcAdma64bV4Mode)) {
2038 AdmaAddr = (UINT64)(UINTN)Trb->AdmaDescPhy;
2039 Status = SdMmcHcRwMmio (PciIo, Trb->Slot, SD_MMC_HC_ADMA_SYS_ADDR, FALSE, sizeof (AdmaAddr), &AdmaAddr);
2040 if (EFI_ERROR (Status)) {
2041 return Status;
2042 }
2043 }
2044
2045 BlkSize = Trb->BlockSize;
2046 if (Trb->Mode == SdMmcSdmaMode) {
2047 //
2048 // Set SDMA boundary to be 512K bytes.
2049 //
2050 BlkSize |= 0x7000;
2051 }
2052
2053 Status = SdMmcHcRwMmio (PciIo, Trb->Slot, SD_MMC_HC_BLK_SIZE, FALSE, sizeof (BlkSize), &BlkSize);
2054 if (EFI_ERROR (Status)) {
2055 return Status;
2056 }
2057
2058 BlkCount = 0;
2059 if (Trb->Mode != SdMmcNoData) {
2060 //
2061 // Calcuate Block Count.
2062 //
2063 BlkCount = (Trb->DataLen / Trb->BlockSize);
2064 }
2065 if (Private->ControllerVersion[Trb->Slot] >= SD_MMC_HC_CTRL_VER_410) {
2066 Status = SdMmcHcRwMmio (PciIo, Trb->Slot, SD_MMC_HC_SDMA_ADDR, FALSE, sizeof (UINT32), &BlkCount);
2067 } else {
2068 Status = SdMmcHcRwMmio (PciIo, Trb->Slot, SD_MMC_HC_BLK_COUNT, FALSE, sizeof (UINT16), &BlkCount);
2069 }
2070 if (EFI_ERROR (Status)) {
2071 return Status;
2072 }
2073
2074 Argument = Packet->SdMmcCmdBlk->CommandArgument;
2075 Status = SdMmcHcRwMmio (PciIo, Trb->Slot, SD_MMC_HC_ARG1, FALSE, sizeof (Argument), &Argument);
2076 if (EFI_ERROR (Status)) {
2077 return Status;
2078 }
2079
2080 TransMode = 0;
2081 if (Trb->Mode != SdMmcNoData) {
2082 if (Trb->Mode != SdMmcPioMode) {
2083 TransMode |= BIT0;
2084 }
2085 if (Trb->Read) {
2086 TransMode |= BIT4;
2087 }
2088 if (BlkCount > 1) {
2089 TransMode |= BIT5 | BIT1;
2090 }
2091 //
2092 // Only SD memory card needs to use AUTO CMD12 feature.
2093 //
2094 if (Private->Slot[Trb->Slot].CardType == SdCardType) {
2095 if (BlkCount > 1) {
2096 TransMode |= BIT2;
2097 }
2098 }
2099 }
2100
2101 Status = SdMmcHcRwMmio (PciIo, Trb->Slot, SD_MMC_HC_TRANS_MOD, FALSE, sizeof (TransMode), &TransMode);
2102 if (EFI_ERROR (Status)) {
2103 return Status;
2104 }
2105
2106 Cmd = (UINT16)LShiftU64(Packet->SdMmcCmdBlk->CommandIndex, 8);
2107 if (Packet->SdMmcCmdBlk->CommandType == SdMmcCommandTypeAdtc) {
2108 Cmd |= BIT5;
2109 }
2110 //
2111 // Convert ResponseType to value
2112 //
2113 if (Packet->SdMmcCmdBlk->CommandType != SdMmcCommandTypeBc) {
2114 switch (Packet->SdMmcCmdBlk->ResponseType) {
2115 case SdMmcResponseTypeR1:
2116 case SdMmcResponseTypeR5:
2117 case SdMmcResponseTypeR6:
2118 case SdMmcResponseTypeR7:
2119 Cmd |= (BIT1 | BIT3 | BIT4);
2120 break;
2121 case SdMmcResponseTypeR2:
2122 Cmd |= (BIT0 | BIT3);
2123 break;
2124 case SdMmcResponseTypeR3:
2125 case SdMmcResponseTypeR4:
2126 Cmd |= BIT1;
2127 break;
2128 case SdMmcResponseTypeR1b:
2129 case SdMmcResponseTypeR5b:
2130 Cmd |= (BIT0 | BIT1 | BIT3 | BIT4);
2131 break;
2132 default:
2133 ASSERT (FALSE);
2134 break;
2135 }
2136 }
2137 //
2138 // Execute cmd
2139 //
2140 Status = SdMmcHcRwMmio (PciIo, Trb->Slot, SD_MMC_HC_COMMAND, FALSE, sizeof (Cmd), &Cmd);
2141 return Status;
2142 }
2143
2144 /**
2145 Performs SW reset based on passed error status mask.
2146
2147 @param[in] Private Pointer to driver private data.
2148 @param[in] Slot Index of the slot to reset.
2149 @param[in] ErrIntStatus Error interrupt status mask.
2150
2151 @retval EFI_SUCCESS Software reset performed successfully.
2152 @retval Other Software reset failed.
2153 **/
2154 EFI_STATUS
2155 SdMmcSoftwareReset (
2156 IN SD_MMC_HC_PRIVATE_DATA *Private,
2157 IN UINT8 Slot,
2158 IN UINT16 ErrIntStatus
2159 )
2160 {
2161 UINT8 SwReset;
2162 EFI_STATUS Status;
2163
2164 SwReset = 0;
2165 if ((ErrIntStatus & 0x0F) != 0) {
2166 SwReset |= BIT1;
2167 }
2168 if ((ErrIntStatus & 0x70) != 0) {
2169 SwReset |= BIT2;
2170 }
2171
2172 Status = SdMmcHcRwMmio (
2173 Private->PciIo,
2174 Slot,
2175 SD_MMC_HC_SW_RST,
2176 FALSE,
2177 sizeof (SwReset),
2178 &SwReset
2179 );
2180 if (EFI_ERROR (Status)) {
2181 return Status;
2182 }
2183
2184 Status = SdMmcHcWaitMmioSet (
2185 Private->PciIo,
2186 Slot,
2187 SD_MMC_HC_SW_RST,
2188 sizeof (SwReset),
2189 0xFF,
2190 0,
2191 SD_MMC_HC_GENERIC_TIMEOUT
2192 );
2193 if (EFI_ERROR (Status)) {
2194 return Status;
2195 }
2196
2197 return EFI_SUCCESS;
2198 }
2199
2200 /**
2201 Checks the error status in error status register
2202 and issues appropriate software reset as described in
2203 SD specification section 3.10.
2204
2205 @param[in] Private Pointer to driver private data.
2206 @param[in] Slot Index of the slot for device.
2207 @param[in] IntStatus Normal interrupt status mask.
2208
2209 @retval EFI_CRC_ERROR CRC error happened during CMD execution.
2210 @retval EFI_SUCCESS No error reported.
2211 @retval Others Some other error happened.
2212
2213 **/
2214 EFI_STATUS
2215 SdMmcCheckAndRecoverErrors (
2216 IN SD_MMC_HC_PRIVATE_DATA *Private,
2217 IN UINT8 Slot,
2218 IN UINT16 IntStatus
2219 )
2220 {
2221 UINT16 ErrIntStatus;
2222 EFI_STATUS Status;
2223 EFI_STATUS ErrorStatus;
2224
2225 if ((IntStatus & BIT15) == 0) {
2226 return EFI_SUCCESS;
2227 }
2228
2229 Status = SdMmcHcRwMmio (
2230 Private->PciIo,
2231 Slot,
2232 SD_MMC_HC_ERR_INT_STS,
2233 TRUE,
2234 sizeof (ErrIntStatus),
2235 &ErrIntStatus
2236 );
2237 if (EFI_ERROR (Status)) {
2238 return Status;
2239 }
2240
2241 //
2242 // If the data timeout error is reported
2243 // but data transfer is signaled as completed we
2244 // have to ignore data timeout. We also assume that no
2245 // other error is present on the link since data transfer
2246 // completed successfully. Error interrupt status
2247 // register is going to be reset when the next command
2248 // is started.
2249 //
2250 if (((ErrIntStatus & BIT4) != 0) && ((IntStatus & BIT1) != 0)) {
2251 return EFI_SUCCESS;
2252 }
2253
2254 //
2255 // We treat both CMD and DAT CRC errors and
2256 // end bits errors as EFI_CRC_ERROR. This will
2257 // let higher layer know that the error possibly
2258 // happened due to random bus condition and the
2259 // command can be retried.
2260 //
2261 if ((ErrIntStatus & (BIT1 | BIT2 | BIT5 | BIT6)) != 0) {
2262 ErrorStatus = EFI_CRC_ERROR;
2263 } else {
2264 ErrorStatus = EFI_DEVICE_ERROR;
2265 }
2266
2267 Status = SdMmcSoftwareReset (Private, Slot, ErrIntStatus);
2268 if (EFI_ERROR (Status)) {
2269 return Status;
2270 }
2271
2272 return ErrorStatus;
2273 }
2274
2275 /**
2276 Check the TRB execution result.
2277
2278 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
2279 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.
2280
2281 @retval EFI_SUCCESS The TRB is executed successfully.
2282 @retval EFI_NOT_READY The TRB is not completed for execution.
2283 @retval Others Some erros happen when executing this request.
2284
2285 **/
2286 EFI_STATUS
2287 SdMmcCheckTrbResult (
2288 IN SD_MMC_HC_PRIVATE_DATA *Private,
2289 IN SD_MMC_HC_TRB *Trb
2290 )
2291 {
2292 EFI_STATUS Status;
2293 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET *Packet;
2294 UINT16 IntStatus;
2295 UINT32 Response[4];
2296 UINT64 SdmaAddr;
2297 UINT8 Index;
2298 UINT32 PioLength;
2299
2300 Packet = Trb->Packet;
2301 //
2302 // Check Trb execution result by reading Normal Interrupt Status register.
2303 //
2304 Status = SdMmcHcRwMmio (
2305 Private->PciIo,
2306 Trb->Slot,
2307 SD_MMC_HC_NOR_INT_STS,
2308 TRUE,
2309 sizeof (IntStatus),
2310 &IntStatus
2311 );
2312 if (EFI_ERROR (Status)) {
2313 goto Done;
2314 }
2315
2316 //
2317 // Check if there are any errors reported by host controller
2318 // and if neccessary recover the controller before next command is executed.
2319 //
2320 Status = SdMmcCheckAndRecoverErrors (Private, Trb->Slot, IntStatus);
2321 if (EFI_ERROR (Status)) {
2322 goto Done;
2323 }
2324
2325 //
2326 // Check Transfer Complete bit is set or not.
2327 //
2328 if ((IntStatus & BIT1) == BIT1) {
2329 goto Done;
2330 }
2331
2332 //
2333 // Check if DMA interrupt is signalled for the SDMA transfer.
2334 //
2335 if ((Trb->Mode == SdMmcSdmaMode) && ((IntStatus & BIT3) == BIT3)) {
2336 //
2337 // Clear DMA interrupt bit.
2338 //
2339 IntStatus = BIT3;
2340 Status = SdMmcHcRwMmio (
2341 Private->PciIo,
2342 Trb->Slot,
2343 SD_MMC_HC_NOR_INT_STS,
2344 FALSE,
2345 sizeof (IntStatus),
2346 &IntStatus
2347 );
2348 if (EFI_ERROR (Status)) {
2349 goto Done;
2350 }
2351 //
2352 // Update SDMA Address register.
2353 //
2354 SdmaAddr = SD_MMC_SDMA_ROUND_UP ((UINTN)Trb->DataPhy, SD_MMC_SDMA_BOUNDARY);
2355
2356 if (Private->ControllerVersion[Trb->Slot] >= SD_MMC_HC_CTRL_VER_400) {
2357 Status = SdMmcHcRwMmio (
2358 Private->PciIo,
2359 Trb->Slot,
2360 SD_MMC_HC_ADMA_SYS_ADDR,
2361 FALSE,
2362 sizeof (UINT64),
2363 &SdmaAddr
2364 );
2365 } else {
2366 Status = SdMmcHcRwMmio (
2367 Private->PciIo,
2368 Trb->Slot,
2369 SD_MMC_HC_SDMA_ADDR,
2370 FALSE,
2371 sizeof (UINT32),
2372 &SdmaAddr
2373 );
2374 }
2375
2376 if (EFI_ERROR (Status)) {
2377 goto Done;
2378 }
2379 Trb->DataPhy = (UINT64)(UINTN)SdmaAddr;
2380 }
2381
2382 if ((Packet->SdMmcCmdBlk->CommandType != SdMmcCommandTypeAdtc) &&
2383 (Packet->SdMmcCmdBlk->ResponseType != SdMmcResponseTypeR1b) &&
2384 (Packet->SdMmcCmdBlk->ResponseType != SdMmcResponseTypeR5b)) {
2385 if ((IntStatus & BIT0) == BIT0) {
2386 Status = EFI_SUCCESS;
2387 goto Done;
2388 }
2389 }
2390
2391 if (((Private->Slot[Trb->Slot].CardType == EmmcCardType) &&
2392 (Packet->SdMmcCmdBlk->CommandIndex == EMMC_SEND_TUNING_BLOCK)) ||
2393 ((Private->Slot[Trb->Slot].CardType == SdCardType) &&
2394 (Packet->SdMmcCmdBlk->CommandIndex == SD_SEND_TUNING_BLOCK))) {
2395 //
2396 // When performing tuning procedure (Execute Tuning is set to 1) through PIO mode,
2397 // wait Buffer Read Ready bit of Normal Interrupt Status Register to be 1.
2398 // Refer to SD Host Controller Simplified Specification 3.0 figure 2-29 for details.
2399 //
2400 if ((IntStatus & BIT5) == BIT5) {
2401 //
2402 // Clear Buffer Read Ready interrupt at first.
2403 //
2404 IntStatus = BIT5;
2405 SdMmcHcRwMmio (Private->PciIo, Trb->Slot, SD_MMC_HC_NOR_INT_STS, FALSE, sizeof (IntStatus), &IntStatus);
2406 //
2407 // Read data out from Buffer Port register
2408 //
2409 for (PioLength = 0; PioLength < Trb->DataLen; PioLength += 4) {
2410 SdMmcHcRwMmio (Private->PciIo, Trb->Slot, SD_MMC_HC_BUF_DAT_PORT, TRUE, 4, (UINT8*)Trb->Data + PioLength);
2411 }
2412 Status = EFI_SUCCESS;
2413 goto Done;
2414 }
2415 }
2416
2417 Status = EFI_NOT_READY;
2418 Done:
2419 //
2420 // Get response data when the cmd is executed successfully.
2421 //
2422 if (!EFI_ERROR (Status)) {
2423 if (Packet->SdMmcCmdBlk->CommandType != SdMmcCommandTypeBc) {
2424 for (Index = 0; Index < 4; Index++) {
2425 Status = SdMmcHcRwMmio (
2426 Private->PciIo,
2427 Trb->Slot,
2428 SD_MMC_HC_RESPONSE + Index * 4,
2429 TRUE,
2430 sizeof (UINT32),
2431 &Response[Index]
2432 );
2433 if (EFI_ERROR (Status)) {
2434 SdMmcHcLedOnOff (Private->PciIo, Trb->Slot, FALSE);
2435 return Status;
2436 }
2437 }
2438 CopyMem (Packet->SdMmcStatusBlk, Response, sizeof (Response));
2439 }
2440 }
2441
2442 if (Status != EFI_NOT_READY) {
2443 SdMmcHcLedOnOff (Private->PciIo, Trb->Slot, FALSE);
2444 }
2445
2446 return Status;
2447 }
2448
2449 /**
2450 Wait for the TRB execution result.
2451
2452 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
2453 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.
2454
2455 @retval EFI_SUCCESS The TRB is executed successfully.
2456 @retval Others Some erros happen when executing this request.
2457
2458 **/
2459 EFI_STATUS
2460 SdMmcWaitTrbResult (
2461 IN SD_MMC_HC_PRIVATE_DATA *Private,
2462 IN SD_MMC_HC_TRB *Trb
2463 )
2464 {
2465 EFI_STATUS Status;
2466 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET *Packet;
2467 UINT64 Timeout;
2468 BOOLEAN InfiniteWait;
2469
2470 Packet = Trb->Packet;
2471 //
2472 // Wait Command Complete Interrupt Status bit in Normal Interrupt Status Register
2473 //
2474 Timeout = Packet->Timeout;
2475 if (Timeout == 0) {
2476 InfiniteWait = TRUE;
2477 } else {
2478 InfiniteWait = FALSE;
2479 }
2480
2481 while (InfiniteWait || (Timeout > 0)) {
2482 //
2483 // Check Trb execution result by reading Normal Interrupt Status register.
2484 //
2485 Status = SdMmcCheckTrbResult (Private, Trb);
2486 if (Status != EFI_NOT_READY) {
2487 return Status;
2488 }
2489 //
2490 // Stall for 1 microsecond.
2491 //
2492 gBS->Stall (1);
2493
2494 Timeout--;
2495 }
2496
2497 return EFI_TIMEOUT;
2498 }
2499
EFI Development Kit II mirror for PVE