]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Bus/Pci/SdMmcPciHcDxe/SdMmcPciHci.c
IntelFsp2WrapperPkg: Support FSP Dispatch mode
[mirror_edk2.git] / MdeModulePkg / Bus / Pci / SdMmcPciHcDxe / SdMmcPciHci.c
CommitLineData
48555339
FT
1/** @file\r
2 This driver is used to manage SD/MMC PCI host controllers which are compliance\r
3 with SD Host Controller Simplified Specification version 3.00.\r
4\r
5 It would expose EFI_SD_MMC_PASS_THRU_PROTOCOL for upper layer use.\r
6\r
54228046 7 Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR>\r
48555339
FT
8 This program and the accompanying materials\r
9 are licensed and made available under the terms and conditions of the BSD License\r
10 which accompanies this distribution. The full text of the license may be found at\r
11 http://opensource.org/licenses/bsd-license.php\r
12\r
13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
15\r
16**/\r
17\r
18#include "SdMmcPciHcDxe.h"\r
19\r
20/**\r
21 Dump the content of SD/MMC host controller's Capability Register.\r
22\r
23 @param[in] Slot The slot number of the SD card to send the command to.\r
24 @param[in] Capability The buffer to store the capability data.\r
25\r
26**/\r
27VOID\r
28DumpCapabilityReg (\r
29 IN UINT8 Slot,\r
30 IN SD_MMC_HC_SLOT_CAP *Capability\r
31 )\r
32{\r
33 //\r
34 // Dump Capability Data\r
35 //\r
e27ccaba
FT
36 DEBUG ((DEBUG_INFO, " == Slot [%d] Capability is 0x%x ==\n", Slot, Capability));\r
37 DEBUG ((DEBUG_INFO, " Timeout Clk Freq %d%a\n", Capability->TimeoutFreq, (Capability->TimeoutUnit) ? "MHz" : "KHz"));\r
38 DEBUG ((DEBUG_INFO, " Base Clk Freq %dMHz\n", Capability->BaseClkFreq));\r
39 DEBUG ((DEBUG_INFO, " Max Blk Len %dbytes\n", 512 * (1 << Capability->MaxBlkLen)));\r
40 DEBUG ((DEBUG_INFO, " 8-bit Support %a\n", Capability->BusWidth8 ? "TRUE" : "FALSE"));\r
41 DEBUG ((DEBUG_INFO, " ADMA2 Support %a\n", Capability->Adma2 ? "TRUE" : "FALSE"));\r
42 DEBUG ((DEBUG_INFO, " HighSpeed Support %a\n", Capability->HighSpeed ? "TRUE" : "FALSE"));\r
43 DEBUG ((DEBUG_INFO, " SDMA Support %a\n", Capability->Sdma ? "TRUE" : "FALSE"));\r
44 DEBUG ((DEBUG_INFO, " Suspend/Resume %a\n", Capability->SuspRes ? "TRUE" : "FALSE"));\r
45 DEBUG ((DEBUG_INFO, " Voltage 3.3 %a\n", Capability->Voltage33 ? "TRUE" : "FALSE"));\r
46 DEBUG ((DEBUG_INFO, " Voltage 3.0 %a\n", Capability->Voltage30 ? "TRUE" : "FALSE"));\r
47 DEBUG ((DEBUG_INFO, " Voltage 1.8 %a\n", Capability->Voltage18 ? "TRUE" : "FALSE"));\r
48 DEBUG ((DEBUG_INFO, " 64-bit Sys Bus %a\n", Capability->SysBus64 ? "TRUE" : "FALSE"));\r
49 DEBUG ((DEBUG_INFO, " Async Interrupt %a\n", Capability->AsyncInt ? "TRUE" : "FALSE"));\r
50 DEBUG ((DEBUG_INFO, " SlotType "));\r
48555339 51 if (Capability->SlotType == 0x00) {\r
e27ccaba 52 DEBUG ((DEBUG_INFO, "%a\n", "Removable Slot"));\r
48555339 53 } else if (Capability->SlotType == 0x01) {\r
e27ccaba 54 DEBUG ((DEBUG_INFO, "%a\n", "Embedded Slot"));\r
48555339 55 } else if (Capability->SlotType == 0x02) {\r
e27ccaba 56 DEBUG ((DEBUG_INFO, "%a\n", "Shared Bus Slot"));\r
48555339 57 } else {\r
e27ccaba 58 DEBUG ((DEBUG_INFO, "%a\n", "Reserved"));\r
48555339 59 }\r
e27ccaba
FT
60 DEBUG ((DEBUG_INFO, " SDR50 Support %a\n", Capability->Sdr50 ? "TRUE" : "FALSE"));\r
61 DEBUG ((DEBUG_INFO, " SDR104 Support %a\n", Capability->Sdr104 ? "TRUE" : "FALSE"));\r
62 DEBUG ((DEBUG_INFO, " DDR50 Support %a\n", Capability->Ddr50 ? "TRUE" : "FALSE"));\r
63 DEBUG ((DEBUG_INFO, " Driver Type A %a\n", Capability->DriverTypeA ? "TRUE" : "FALSE"));\r
64 DEBUG ((DEBUG_INFO, " Driver Type C %a\n", Capability->DriverTypeC ? "TRUE" : "FALSE"));\r
65 DEBUG ((DEBUG_INFO, " Driver Type D %a\n", Capability->DriverTypeD ? "TRUE" : "FALSE"));\r
66 DEBUG ((DEBUG_INFO, " Driver Type 4 %a\n", Capability->DriverType4 ? "TRUE" : "FALSE"));\r
48555339 67 if (Capability->TimerCount == 0) {\r
e27ccaba 68 DEBUG ((DEBUG_INFO, " Retuning TimerCnt Disabled\n", 2 * (Capability->TimerCount - 1)));\r
48555339 69 } else {\r
e27ccaba 70 DEBUG ((DEBUG_INFO, " Retuning TimerCnt %dseconds\n", 2 * (Capability->TimerCount - 1)));\r
48555339 71 }\r
e27ccaba
FT
72 DEBUG ((DEBUG_INFO, " SDR50 Tuning %a\n", Capability->TuningSDR50 ? "TRUE" : "FALSE"));\r
73 DEBUG ((DEBUG_INFO, " Retuning Mode Mode %d\n", Capability->RetuningMod + 1));\r
74 DEBUG ((DEBUG_INFO, " Clock Multiplier M = %d\n", Capability->ClkMultiplier + 1));\r
75 DEBUG ((DEBUG_INFO, " HS 400 %a\n", Capability->Hs400 ? "TRUE" : "FALSE"));\r
48555339
FT
76 return;\r
77}\r
78\r
79/**\r
80 Read SlotInfo register from SD/MMC host controller pci config space.\r
81\r
82 @param[in] PciIo The PCI IO protocol instance.\r
83 @param[out] FirstBar The buffer to store the first BAR value.\r
84 @param[out] SlotNum The buffer to store the supported slot number.\r
85\r
86 @retval EFI_SUCCESS The operation succeeds.\r
87 @retval Others The operation fails.\r
88\r
89**/\r
90EFI_STATUS\r
91EFIAPI\r
92SdMmcHcGetSlotInfo (\r
93 IN EFI_PCI_IO_PROTOCOL *PciIo,\r
94 OUT UINT8 *FirstBar,\r
95 OUT UINT8 *SlotNum\r
96 )\r
97{\r
98 EFI_STATUS Status;\r
99 SD_MMC_HC_SLOT_INFO SlotInfo;\r
100\r
101 Status = PciIo->Pci.Read (\r
102 PciIo,\r
103 EfiPciIoWidthUint8,\r
104 SD_MMC_HC_SLOT_OFFSET,\r
105 sizeof (SlotInfo),\r
106 &SlotInfo\r
107 );\r
108 if (EFI_ERROR (Status)) {\r
109 return Status;\r
110 }\r
111\r
112 *FirstBar = SlotInfo.FirstBar;\r
113 *SlotNum = SlotInfo.SlotNum + 1;\r
114 ASSERT ((*FirstBar + *SlotNum) < SD_MMC_HC_MAX_SLOT);\r
115 return EFI_SUCCESS;\r
116}\r
117\r
118/**\r
119 Read/Write specified SD/MMC host controller mmio register.\r
120\r
121 @param[in] PciIo The PCI IO protocol instance.\r
122 @param[in] BarIndex The BAR index of the standard PCI Configuration\r
123 header to use as the base address for the memory\r
124 operation to perform.\r
125 @param[in] Offset The offset within the selected BAR to start the\r
126 memory operation.\r
127 @param[in] Read A boolean to indicate it's read or write operation.\r
128 @param[in] Count The width of the mmio register in bytes.\r
129 Must be 1, 2 , 4 or 8 bytes.\r
130 @param[in, out] Data For read operations, the destination buffer to store\r
131 the results. For write operations, the source buffer\r
132 to write data from. The caller is responsible for\r
133 having ownership of the data buffer and ensuring its\r
134 size not less than Count bytes.\r
135\r
136 @retval EFI_INVALID_PARAMETER The PciIo or Data is NULL or the Count is not valid.\r
137 @retval EFI_SUCCESS The read/write operation succeeds.\r
138 @retval Others The read/write operation fails.\r
139\r
140**/\r
141EFI_STATUS\r
142EFIAPI\r
143SdMmcHcRwMmio (\r
144 IN EFI_PCI_IO_PROTOCOL *PciIo,\r
145 IN UINT8 BarIndex,\r
146 IN UINT32 Offset,\r
147 IN BOOLEAN Read,\r
148 IN UINT8 Count,\r
149 IN OUT VOID *Data\r
150 )\r
151{\r
152 EFI_STATUS Status;\r
153\r
154 if ((PciIo == NULL) || (Data == NULL)) {\r
155 return EFI_INVALID_PARAMETER;\r
156 }\r
157\r
158 if ((Count != 1) && (Count != 2) && (Count != 4) && (Count != 8)) {\r
159 return EFI_INVALID_PARAMETER;\r
160 }\r
161\r
162 if (Read) {\r
163 Status = PciIo->Mem.Read (\r
164 PciIo,\r
165 EfiPciIoWidthUint8,\r
166 BarIndex,\r
167 (UINT64) Offset,\r
168 Count,\r
169 Data\r
170 );\r
171 } else {\r
172 Status = PciIo->Mem.Write (\r
173 PciIo,\r
174 EfiPciIoWidthUint8,\r
175 BarIndex,\r
176 (UINT64) Offset,\r
177 Count,\r
178 Data\r
179 );\r
180 }\r
181\r
182 return Status;\r
183}\r
184\r
185/**\r
186 Do OR operation with the value of the specified SD/MMC host controller mmio register.\r
187\r
188 @param[in] PciIo The PCI IO protocol instance.\r
189 @param[in] BarIndex The BAR index of the standard PCI Configuration\r
190 header to use as the base address for the memory\r
191 operation to perform.\r
192 @param[in] Offset The offset within the selected BAR to start the\r
193 memory operation.\r
194 @param[in] Count The width of the mmio register in bytes.\r
195 Must be 1, 2 , 4 or 8 bytes.\r
196 @param[in] OrData The pointer to the data used to do OR operation.\r
197 The caller is responsible for having ownership of\r
198 the data buffer and ensuring its size not less than\r
199 Count bytes.\r
200\r
201 @retval EFI_INVALID_PARAMETER The PciIo or OrData is NULL or the Count is not valid.\r
202 @retval EFI_SUCCESS The OR operation succeeds.\r
203 @retval Others The OR operation fails.\r
204\r
205**/\r
206EFI_STATUS\r
207EFIAPI\r
208SdMmcHcOrMmio (\r
209 IN EFI_PCI_IO_PROTOCOL *PciIo,\r
210 IN UINT8 BarIndex,\r
211 IN UINT32 Offset,\r
212 IN UINT8 Count,\r
213 IN VOID *OrData\r
214 )\r
215{\r
216 EFI_STATUS Status;\r
217 UINT64 Data;\r
218 UINT64 Or;\r
219\r
220 Status = SdMmcHcRwMmio (PciIo, BarIndex, Offset, TRUE, Count, &Data);\r
221 if (EFI_ERROR (Status)) {\r
222 return Status;\r
223 }\r
224\r
225 if (Count == 1) {\r
226 Or = *(UINT8*) OrData;\r
227 } else if (Count == 2) {\r
228 Or = *(UINT16*) OrData;\r
229 } else if (Count == 4) {\r
230 Or = *(UINT32*) OrData;\r
231 } else if (Count == 8) {\r
232 Or = *(UINT64*) OrData;\r
233 } else {\r
234 return EFI_INVALID_PARAMETER;\r
235 }\r
236\r
237 Data |= Or;\r
238 Status = SdMmcHcRwMmio (PciIo, BarIndex, Offset, FALSE, Count, &Data);\r
239\r
240 return Status;\r
241}\r
242\r
243/**\r
244 Do AND operation with the value of the specified SD/MMC host controller mmio register.\r
245\r
246 @param[in] PciIo The PCI IO protocol instance.\r
247 @param[in] BarIndex The BAR index of the standard PCI Configuration\r
248 header to use as the base address for the memory\r
249 operation to perform.\r
250 @param[in] Offset The offset within the selected BAR to start the\r
251 memory operation.\r
252 @param[in] Count The width of the mmio register in bytes.\r
253 Must be 1, 2 , 4 or 8 bytes.\r
254 @param[in] AndData The pointer to the data used to do AND operation.\r
255 The caller is responsible for having ownership of\r
256 the data buffer and ensuring its size not less than\r
257 Count bytes.\r
258\r
259 @retval EFI_INVALID_PARAMETER The PciIo or AndData is NULL or the Count is not valid.\r
260 @retval EFI_SUCCESS The AND operation succeeds.\r
261 @retval Others The AND operation fails.\r
262\r
263**/\r
264EFI_STATUS\r
265EFIAPI\r
266SdMmcHcAndMmio (\r
267 IN EFI_PCI_IO_PROTOCOL *PciIo,\r
268 IN UINT8 BarIndex,\r
269 IN UINT32 Offset,\r
270 IN UINT8 Count,\r
271 IN VOID *AndData\r
272 )\r
273{\r
274 EFI_STATUS Status;\r
275 UINT64 Data;\r
276 UINT64 And;\r
277\r
278 Status = SdMmcHcRwMmio (PciIo, BarIndex, Offset, TRUE, Count, &Data);\r
279 if (EFI_ERROR (Status)) {\r
280 return Status;\r
281 }\r
282\r
283 if (Count == 1) {\r
284 And = *(UINT8*) AndData;\r
285 } else if (Count == 2) {\r
286 And = *(UINT16*) AndData;\r
287 } else if (Count == 4) {\r
288 And = *(UINT32*) AndData;\r
289 } else if (Count == 8) {\r
290 And = *(UINT64*) AndData;\r
291 } else {\r
292 return EFI_INVALID_PARAMETER;\r
293 }\r
294\r
295 Data &= And;\r
296 Status = SdMmcHcRwMmio (PciIo, BarIndex, Offset, FALSE, Count, &Data);\r
297\r
298 return Status;\r
299}\r
300\r
301/**\r
302 Wait for the value of the specified MMIO register set to the test value.\r
303\r
304 @param[in] PciIo The PCI IO protocol instance.\r
305 @param[in] BarIndex The BAR index of the standard PCI Configuration\r
306 header to use as the base address for the memory\r
307 operation to perform.\r
308 @param[in] Offset The offset within the selected BAR to start the\r
309 memory operation.\r
310 @param[in] Count The width of the mmio register in bytes.\r
311 Must be 1, 2, 4 or 8 bytes.\r
312 @param[in] MaskValue The mask value of memory.\r
313 @param[in] TestValue The test value of memory.\r
314\r
315 @retval EFI_NOT_READY The MMIO register hasn't set to the expected value.\r
316 @retval EFI_SUCCESS The MMIO register has expected value.\r
317 @retval Others The MMIO operation fails.\r
318\r
319**/\r
320EFI_STATUS\r
321EFIAPI\r
322SdMmcHcCheckMmioSet (\r
323 IN EFI_PCI_IO_PROTOCOL *PciIo,\r
324 IN UINT8 BarIndex,\r
325 IN UINT32 Offset,\r
326 IN UINT8 Count,\r
327 IN UINT64 MaskValue,\r
328 IN UINT64 TestValue\r
329 )\r
330{\r
331 EFI_STATUS Status;\r
332 UINT64 Value;\r
333\r
334 //\r
335 // Access PCI MMIO space to see if the value is the tested one.\r
336 //\r
337 Value = 0;\r
338 Status = SdMmcHcRwMmio (PciIo, BarIndex, Offset, TRUE, Count, &Value);\r
339 if (EFI_ERROR (Status)) {\r
340 return Status;\r
341 }\r
342\r
343 Value &= MaskValue;\r
344\r
345 if (Value == TestValue) {\r
346 return EFI_SUCCESS;\r
347 }\r
348\r
349 return EFI_NOT_READY;\r
350}\r
351\r
352/**\r
353 Wait for the value of the specified MMIO register set to the test value.\r
354\r
355 @param[in] PciIo The PCI IO protocol instance.\r
356 @param[in] BarIndex The BAR index of the standard PCI Configuration\r
357 header to use as the base address for the memory\r
358 operation to perform.\r
359 @param[in] Offset The offset within the selected BAR to start the\r
360 memory operation.\r
361 @param[in] Count The width of the mmio register in bytes.\r
362 Must be 1, 2, 4 or 8 bytes.\r
363 @param[in] MaskValue The mask value of memory.\r
364 @param[in] TestValue The test value of memory.\r
365 @param[in] Timeout The time out value for wait memory set, uses 1\r
366 microsecond as a unit.\r
367\r
368 @retval EFI_TIMEOUT The MMIO register hasn't expected value in timeout\r
369 range.\r
370 @retval EFI_SUCCESS The MMIO register has expected value.\r
371 @retval Others The MMIO operation fails.\r
372\r
373**/\r
374EFI_STATUS\r
375EFIAPI\r
376SdMmcHcWaitMmioSet (\r
377 IN EFI_PCI_IO_PROTOCOL *PciIo,\r
378 IN UINT8 BarIndex,\r
379 IN UINT32 Offset,\r
380 IN UINT8 Count,\r
381 IN UINT64 MaskValue,\r
382 IN UINT64 TestValue,\r
383 IN UINT64 Timeout\r
384 )\r
385{\r
386 EFI_STATUS Status;\r
387 BOOLEAN InfiniteWait;\r
388\r
389 if (Timeout == 0) {\r
390 InfiniteWait = TRUE;\r
391 } else {\r
392 InfiniteWait = FALSE;\r
393 }\r
394\r
395 while (InfiniteWait || (Timeout > 0)) {\r
396 Status = SdMmcHcCheckMmioSet (\r
397 PciIo,\r
398 BarIndex,\r
399 Offset,\r
400 Count,\r
401 MaskValue,\r
402 TestValue\r
403 );\r
404 if (Status != EFI_NOT_READY) {\r
405 return Status;\r
406 }\r
407\r
408 //\r
409 // Stall for 1 microsecond.\r
410 //\r
411 gBS->Stall (1);\r
412\r
413 Timeout--;\r
414 }\r
415\r
416 return EFI_TIMEOUT;\r
417}\r
418\r
419/**\r
420 Software reset the specified SD/MMC host controller and enable all interrupts.\r
421\r
b23fc39c 422 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.\r
48555339
FT
423 @param[in] Slot The slot number of the SD card to send the command to.\r
424\r
425 @retval EFI_SUCCESS The software reset executes successfully.\r
426 @retval Others The software reset fails.\r
427\r
428**/\r
429EFI_STATUS\r
430SdMmcHcReset (\r
b23fc39c 431 IN SD_MMC_HC_PRIVATE_DATA *Private,\r
48555339
FT
432 IN UINT8 Slot\r
433 )\r
434{\r
435 EFI_STATUS Status;\r
436 UINT8 SwReset;\r
b23fc39c 437 EFI_PCI_IO_PROTOCOL *PciIo;\r
48555339 438\r
b23fc39c
AB
439 //\r
440 // Notify the SD/MMC override protocol that we are about to reset\r
441 // the SD/MMC host controller.\r
442 //\r
443 if (mOverride != NULL && mOverride->NotifyPhase != NULL) {\r
444 Status = mOverride->NotifyPhase (\r
445 Private->ControllerHandle,\r
446 Slot,\r
447 EdkiiSdMmcResetPre);\r
448 if (EFI_ERROR (Status)) {\r
449 DEBUG ((DEBUG_WARN,\r
450 "%a: SD/MMC pre reset notifier callback failed - %r\n",\r
451 __FUNCTION__, Status));\r
452 return Status;\r
453 }\r
454 }\r
455\r
456 PciIo = Private->PciIo;\r
064d301f
TM
457 SwReset = BIT0;\r
458 Status = SdMmcHcOrMmio (PciIo, Slot, SD_MMC_HC_SW_RST, sizeof (SwReset), &SwReset);\r
48555339
FT
459\r
460 if (EFI_ERROR (Status)) {\r
064d301f 461 DEBUG ((DEBUG_ERROR, "SdMmcHcReset: write SW Reset for All fails: %r\n", Status));\r
48555339
FT
462 return Status;\r
463 }\r
464\r
465 Status = SdMmcHcWaitMmioSet (\r
466 PciIo,\r
467 Slot,\r
468 SD_MMC_HC_SW_RST,\r
469 sizeof (SwReset),\r
064d301f 470 BIT0,\r
48555339
FT
471 0x00,\r
472 SD_MMC_HC_GENERIC_TIMEOUT\r
473 );\r
474 if (EFI_ERROR (Status)) {\r
e27ccaba 475 DEBUG ((DEBUG_INFO, "SdMmcHcReset: reset done with %r\n", Status));\r
48555339
FT
476 return Status;\r
477 }\r
b23fc39c 478\r
48555339
FT
479 //\r
480 // Enable all interrupt after reset all.\r
481 //\r
482 Status = SdMmcHcEnableInterrupt (PciIo, Slot);\r
b23fc39c
AB
483 if (EFI_ERROR (Status)) {\r
484 DEBUG ((DEBUG_INFO, "SdMmcHcReset: SdMmcHcEnableInterrupt done with %r\n",\r
485 Status));\r
486 return Status;\r
487 }\r
488\r
489 //\r
490 // Notify the SD/MMC override protocol that we have just reset\r
491 // the SD/MMC host controller.\r
492 //\r
493 if (mOverride != NULL && mOverride->NotifyPhase != NULL) {\r
494 Status = mOverride->NotifyPhase (\r
495 Private->ControllerHandle,\r
496 Slot,\r
497 EdkiiSdMmcResetPost);\r
498 if (EFI_ERROR (Status)) {\r
499 DEBUG ((DEBUG_WARN,\r
500 "%a: SD/MMC post reset notifier callback failed - %r\n",\r
501 __FUNCTION__, Status));\r
502 }\r
503 }\r
48555339
FT
504\r
505 return Status;\r
506}\r
507\r
508/**\r
509 Set all interrupt status bits in Normal and Error Interrupt Status Enable\r
510 register.\r
511\r
512 @param[in] PciIo The PCI IO protocol instance.\r
513 @param[in] Slot The slot number of the SD card to send the command to.\r
514\r
515 @retval EFI_SUCCESS The operation executes successfully.\r
516 @retval Others The operation fails.\r
517\r
518**/\r
519EFI_STATUS\r
520SdMmcHcEnableInterrupt (\r
521 IN EFI_PCI_IO_PROTOCOL *PciIo,\r
522 IN UINT8 Slot\r
523 )\r
524{\r
525 EFI_STATUS Status;\r
526 UINT16 IntStatus;\r
527\r
528 //\r
529 // Enable all bits in Error Interrupt Status Enable Register\r
530 //\r
531 IntStatus = 0xFFFF;\r
532 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_ERR_INT_STS_EN, FALSE, sizeof (IntStatus), &IntStatus);\r
533 if (EFI_ERROR (Status)) {\r
534 return Status;\r
535 }\r
536 //\r
537 // Enable all bits in Normal Interrupt Status Enable Register\r
538 //\r
539 IntStatus = 0xFFFF;\r
540 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_NOR_INT_STS_EN, FALSE, sizeof (IntStatus), &IntStatus);\r
541\r
542 return Status;\r
543}\r
544\r
545/**\r
546 Get the capability data from the specified slot.\r
547\r
548 @param[in] PciIo The PCI IO protocol instance.\r
549 @param[in] Slot The slot number of the SD card to send the command to.\r
550 @param[out] Capability The buffer to store the capability data.\r
551\r
552 @retval EFI_SUCCESS The operation executes successfully.\r
553 @retval Others The operation fails.\r
554\r
555**/\r
556EFI_STATUS\r
557SdMmcHcGetCapability (\r
558 IN EFI_PCI_IO_PROTOCOL *PciIo,\r
559 IN UINT8 Slot,\r
560 OUT SD_MMC_HC_SLOT_CAP *Capability\r
561 )\r
562{\r
563 EFI_STATUS Status;\r
564 UINT64 Cap;\r
565\r
566 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_CAP, TRUE, sizeof (Cap), &Cap);\r
567 if (EFI_ERROR (Status)) {\r
568 return Status;\r
569 }\r
570\r
571 CopyMem (Capability, &Cap, sizeof (Cap));\r
572\r
573 return EFI_SUCCESS;\r
574}\r
575\r
576/**\r
577 Get the maximum current capability data from the specified slot.\r
578\r
579 @param[in] PciIo The PCI IO protocol instance.\r
580 @param[in] Slot The slot number of the SD card to send the command to.\r
581 @param[out] MaxCurrent The buffer to store the maximum current capability data.\r
582\r
583 @retval EFI_SUCCESS The operation executes successfully.\r
584 @retval Others The operation fails.\r
585\r
586**/\r
587EFI_STATUS\r
588SdMmcHcGetMaxCurrent (\r
589 IN EFI_PCI_IO_PROTOCOL *PciIo,\r
590 IN UINT8 Slot,\r
591 OUT UINT64 *MaxCurrent\r
592 )\r
593{\r
594 EFI_STATUS Status;\r
595\r
596 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_MAX_CURRENT_CAP, TRUE, sizeof (UINT64), MaxCurrent);\r
597\r
598 return Status;\r
599}\r
600\r
601/**\r
602 Detect whether there is a SD/MMC card attached at the specified SD/MMC host controller\r
603 slot.\r
604\r
605 Refer to SD Host Controller Simplified spec 3.0 Section 3.1 for details.\r
606\r
607 @param[in] PciIo The PCI IO protocol instance.\r
608 @param[in] Slot The slot number of the SD card to send the command to.\r
609 @param[out] MediaPresent The pointer to the media present boolean value.\r
610\r
611 @retval EFI_SUCCESS There is no media change happened.\r
612 @retval EFI_MEDIA_CHANGED There is media change happened.\r
613 @retval Others The detection fails.\r
614\r
615**/\r
616EFI_STATUS\r
617SdMmcHcCardDetect (\r
618 IN EFI_PCI_IO_PROTOCOL *PciIo,\r
619 IN UINT8 Slot,\r
620 OUT BOOLEAN *MediaPresent\r
621 )\r
622{\r
623 EFI_STATUS Status;\r
624 UINT16 Data;\r
625 UINT32 PresentState;\r
626\r
2e9107b8
FT
627 //\r
628 // Check Present State Register to see if there is a card presented.\r
629 //\r
630 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_PRESENT_STATE, TRUE, sizeof (PresentState), &PresentState);\r
631 if (EFI_ERROR (Status)) {\r
632 return Status;\r
633 }\r
634\r
635 if ((PresentState & BIT16) != 0) {\r
636 *MediaPresent = TRUE;\r
637 } else {\r
638 *MediaPresent = FALSE;\r
639 }\r
640\r
48555339
FT
641 //\r
642 // Check Normal Interrupt Status Register\r
643 //\r
644 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_NOR_INT_STS, TRUE, sizeof (Data), &Data);\r
645 if (EFI_ERROR (Status)) {\r
646 return Status;\r
647 }\r
648\r
649 if ((Data & (BIT6 | BIT7)) != 0) {\r
650 //\r
651 // Clear BIT6 and BIT7 by writing 1 to these two bits if set.\r
652 //\r
653 Data &= BIT6 | BIT7;\r
654 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_NOR_INT_STS, FALSE, sizeof (Data), &Data);\r
655 if (EFI_ERROR (Status)) {\r
656 return Status;\r
657 }\r
658\r
48555339
FT
659 return EFI_MEDIA_CHANGED;\r
660 }\r
661\r
662 return EFI_SUCCESS;\r
663}\r
664\r
665/**\r
666 Stop SD/MMC card clock.\r
667\r
668 Refer to SD Host Controller Simplified spec 3.0 Section 3.2.2 for details.\r
669\r
670 @param[in] PciIo The PCI IO protocol instance.\r
671 @param[in] Slot The slot number of the SD card to send the command to.\r
672\r
673 @retval EFI_SUCCESS Succeed to stop SD/MMC clock.\r
674 @retval Others Fail to stop SD/MMC clock.\r
675\r
676**/\r
677EFI_STATUS\r
678SdMmcHcStopClock (\r
679 IN EFI_PCI_IO_PROTOCOL *PciIo,\r
680 IN UINT8 Slot\r
681 )\r
682{\r
683 EFI_STATUS Status;\r
684 UINT32 PresentState;\r
685 UINT16 ClockCtrl;\r
686\r
687 //\r
688 // Ensure no SD transactions are occurring on the SD Bus by\r
689 // waiting for Command Inhibit (DAT) and Command Inhibit (CMD)\r
690 // in the Present State register to be 0.\r
691 //\r
692 Status = SdMmcHcWaitMmioSet (\r
693 PciIo,\r
694 Slot,\r
695 SD_MMC_HC_PRESENT_STATE,\r
696 sizeof (PresentState),\r
697 BIT0 | BIT1,\r
698 0,\r
699 SD_MMC_HC_GENERIC_TIMEOUT\r
700 );\r
701 if (EFI_ERROR (Status)) {\r
702 return Status;\r
703 }\r
704\r
705 //\r
706 // Set SD Clock Enable in the Clock Control register to 0\r
707 //\r
708 ClockCtrl = (UINT16)~BIT2;\r
709 Status = SdMmcHcAndMmio (PciIo, Slot, SD_MMC_HC_CLOCK_CTRL, sizeof (ClockCtrl), &ClockCtrl);\r
710\r
711 return Status;\r
712}\r
713\r
714/**\r
715 SD/MMC card clock supply.\r
716\r
717 Refer to SD Host Controller Simplified spec 3.0 Section 3.2.1 for details.\r
718\r
719 @param[in] PciIo The PCI IO protocol instance.\r
720 @param[in] Slot The slot number of the SD card to send the command to.\r
721 @param[in] ClockFreq The max clock frequency to be set. The unit is KHz.\r
722 @param[in] Capability The capability of the slot.\r
723\r
724 @retval EFI_SUCCESS The clock is supplied successfully.\r
725 @retval Others The clock isn't supplied successfully.\r
726\r
727**/\r
728EFI_STATUS\r
729SdMmcHcClockSupply (\r
730 IN EFI_PCI_IO_PROTOCOL *PciIo,\r
731 IN UINT8 Slot,\r
732 IN UINT64 ClockFreq,\r
733 IN SD_MMC_HC_SLOT_CAP Capability\r
734 )\r
735{\r
736 EFI_STATUS Status;\r
737 UINT32 BaseClkFreq;\r
738 UINT32 SettingFreq;\r
739 UINT32 Divisor;\r
740 UINT32 Remainder;\r
741 UINT16 ControllerVer;\r
742 UINT16 ClockCtrl;\r
743\r
744 //\r
745 // Calculate a divisor for SD clock frequency\r
746 //\r
747 ASSERT (Capability.BaseClkFreq != 0);\r
748\r
749 BaseClkFreq = Capability.BaseClkFreq;\r
cb9cb9e2 750 if (ClockFreq == 0) {\r
48555339
FT
751 return EFI_INVALID_PARAMETER;\r
752 }\r
cb9cb9e2
FT
753\r
754 if (ClockFreq > (BaseClkFreq * 1000)) {\r
755 ClockFreq = BaseClkFreq * 1000;\r
756 }\r
757\r
48555339
FT
758 //\r
759 // Calculate the divisor of base frequency.\r
760 //\r
761 Divisor = 0;\r
762 SettingFreq = BaseClkFreq * 1000;\r
763 while (ClockFreq < SettingFreq) {\r
764 Divisor++;\r
765\r
766 SettingFreq = (BaseClkFreq * 1000) / (2 * Divisor);\r
767 Remainder = (BaseClkFreq * 1000) % (2 * Divisor);\r
768 if ((ClockFreq == SettingFreq) && (Remainder == 0)) {\r
769 break;\r
770 }\r
771 if ((ClockFreq == SettingFreq) && (Remainder != 0)) {\r
772 SettingFreq ++;\r
773 }\r
774 }\r
775\r
e27ccaba 776 DEBUG ((DEBUG_INFO, "BaseClkFreq %dMHz Divisor %d ClockFreq %dKhz\n", BaseClkFreq, Divisor, ClockFreq));\r
48555339
FT
777\r
778 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_CTRL_VER, TRUE, sizeof (ControllerVer), &ControllerVer);\r
779 if (EFI_ERROR (Status)) {\r
780 return Status;\r
781 }\r
782 //\r
783 // Set SDCLK Frequency Select and Internal Clock Enable fields in Clock Control register.\r
784 //\r
bbce0015
JB
785 if (((ControllerVer & 0xFF) >= SD_MMC_HC_CTRL_VER_300) &&\r
786 ((ControllerVer & 0xFF) <= SD_MMC_HC_CTRL_VER_420)) {\r
48555339
FT
787 ASSERT (Divisor <= 0x3FF);\r
788 ClockCtrl = ((Divisor & 0xFF) << 8) | ((Divisor & 0x300) >> 2);\r
789 } else if (((ControllerVer & 0xFF) == 0) || ((ControllerVer & 0xFF) == 1)) {\r
790 //\r
791 // Only the most significant bit can be used as divisor.\r
792 //\r
793 if (((Divisor - 1) & Divisor) != 0) {\r
794 Divisor = 1 << (HighBitSet32 (Divisor) + 1);\r
795 }\r
796 ASSERT (Divisor <= 0x80);\r
797 ClockCtrl = (Divisor & 0xFF) << 8;\r
798 } else {\r
e27ccaba 799 DEBUG ((DEBUG_ERROR, "Unknown SD Host Controller Spec version [0x%x]!!!\n", ControllerVer));\r
48555339
FT
800 return EFI_UNSUPPORTED;\r
801 }\r
802\r
803 //\r
804 // Stop bus clock at first\r
805 //\r
806 Status = SdMmcHcStopClock (PciIo, Slot);\r
807 if (EFI_ERROR (Status)) {\r
808 return Status;\r
809 }\r
810\r
811 //\r
812 // Supply clock frequency with specified divisor\r
813 //\r
814 ClockCtrl |= BIT0;\r
815 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_CLOCK_CTRL, FALSE, sizeof (ClockCtrl), &ClockCtrl);\r
816 if (EFI_ERROR (Status)) {\r
e27ccaba 817 DEBUG ((DEBUG_ERROR, "Set SDCLK Frequency Select and Internal Clock Enable fields fails\n"));\r
48555339
FT
818 return Status;\r
819 }\r
820\r
821 //\r
822 // Wait Internal Clock Stable in the Clock Control register to be 1\r
823 //\r
824 Status = SdMmcHcWaitMmioSet (\r
825 PciIo,\r
826 Slot,\r
827 SD_MMC_HC_CLOCK_CTRL,\r
828 sizeof (ClockCtrl),\r
829 BIT1,\r
830 BIT1,\r
831 SD_MMC_HC_GENERIC_TIMEOUT\r
832 );\r
833 if (EFI_ERROR (Status)) {\r
834 return Status;\r
835 }\r
836\r
837 //\r
838 // Set SD Clock Enable in the Clock Control register to 1\r
839 //\r
840 ClockCtrl = BIT2;\r
841 Status = SdMmcHcOrMmio (PciIo, Slot, SD_MMC_HC_CLOCK_CTRL, sizeof (ClockCtrl), &ClockCtrl);\r
842\r
843 return Status;\r
844}\r
845\r
846/**\r
847 SD/MMC bus power control.\r
848\r
849 Refer to SD Host Controller Simplified spec 3.0 Section 3.3 for details.\r
850\r
851 @param[in] PciIo The PCI IO protocol instance.\r
852 @param[in] Slot The slot number of the SD card to send the command to.\r
853 @param[in] PowerCtrl The value setting to the power control register.\r
854\r
855 @retval TRUE There is a SD/MMC card attached.\r
856 @retval FALSE There is no a SD/MMC card attached.\r
857\r
858**/\r
859EFI_STATUS\r
860SdMmcHcPowerControl (\r
861 IN EFI_PCI_IO_PROTOCOL *PciIo,\r
862 IN UINT8 Slot,\r
863 IN UINT8 PowerCtrl\r
864 )\r
865{\r
866 EFI_STATUS Status;\r
867\r
868 //\r
869 // Clr SD Bus Power\r
870 //\r
871 PowerCtrl &= (UINT8)~BIT0;\r
872 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_POWER_CTRL, FALSE, sizeof (PowerCtrl), &PowerCtrl);\r
873 if (EFI_ERROR (Status)) {\r
874 return Status;\r
875 }\r
876\r
877 //\r
878 // Set SD Bus Voltage Select and SD Bus Power fields in Power Control Register\r
879 //\r
880 PowerCtrl |= BIT0;\r
881 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_POWER_CTRL, FALSE, sizeof (PowerCtrl), &PowerCtrl);\r
882\r
883 return Status;\r
884}\r
885\r
886/**\r
887 Set the SD/MMC bus width.\r
888\r
889 Refer to SD Host Controller Simplified spec 3.0 Section 3.4 for details.\r
890\r
891 @param[in] PciIo The PCI IO protocol instance.\r
892 @param[in] Slot The slot number of the SD card to send the command to.\r
893 @param[in] BusWidth The bus width used by the SD/MMC device, it must be 1, 4 or 8.\r
894\r
895 @retval EFI_SUCCESS The bus width is set successfully.\r
896 @retval Others The bus width isn't set successfully.\r
897\r
898**/\r
899EFI_STATUS\r
900SdMmcHcSetBusWidth (\r
901 IN EFI_PCI_IO_PROTOCOL *PciIo,\r
902 IN UINT8 Slot,\r
903 IN UINT16 BusWidth\r
904 )\r
905{\r
906 EFI_STATUS Status;\r
907 UINT8 HostCtrl1;\r
908\r
909 if (BusWidth == 1) {\r
910 HostCtrl1 = (UINT8)~(BIT5 | BIT1);\r
911 Status = SdMmcHcAndMmio (PciIo, Slot, SD_MMC_HC_HOST_CTRL1, sizeof (HostCtrl1), &HostCtrl1);\r
912 } else if (BusWidth == 4) {\r
913 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_HOST_CTRL1, TRUE, sizeof (HostCtrl1), &HostCtrl1);\r
914 if (EFI_ERROR (Status)) {\r
915 return Status;\r
916 }\r
917 HostCtrl1 |= BIT1;\r
918 HostCtrl1 &= (UINT8)~BIT5;\r
919 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_HOST_CTRL1, FALSE, sizeof (HostCtrl1), &HostCtrl1);\r
920 } else if (BusWidth == 8) {\r
921 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_HOST_CTRL1, TRUE, sizeof (HostCtrl1), &HostCtrl1);\r
922 if (EFI_ERROR (Status)) {\r
923 return Status;\r
924 }\r
925 HostCtrl1 &= (UINT8)~BIT1;\r
926 HostCtrl1 |= BIT5;\r
927 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_HOST_CTRL1, FALSE, sizeof (HostCtrl1), &HostCtrl1);\r
928 } else {\r
929 ASSERT (FALSE);\r
930 return EFI_INVALID_PARAMETER;\r
931 }\r
932\r
933 return Status;\r
934}\r
935\r
936/**\r
937 Supply SD/MMC card with lowest clock frequency at initialization.\r
938\r
939 @param[in] PciIo The PCI IO protocol instance.\r
940 @param[in] Slot The slot number of the SD card to send the command to.\r
941 @param[in] Capability The capability of the slot.\r
942\r
943 @retval EFI_SUCCESS The clock is supplied successfully.\r
944 @retval Others The clock isn't supplied successfully.\r
945\r
946**/\r
947EFI_STATUS\r
948SdMmcHcInitClockFreq (\r
949 IN EFI_PCI_IO_PROTOCOL *PciIo,\r
950 IN UINT8 Slot,\r
951 IN SD_MMC_HC_SLOT_CAP Capability\r
952 )\r
953{\r
954 EFI_STATUS Status;\r
955 UINT32 InitFreq;\r
956\r
957 //\r
958 // Calculate a divisor for SD clock frequency\r
959 //\r
960 if (Capability.BaseClkFreq == 0) {\r
961 //\r
962 // Don't support get Base Clock Frequency information via another method\r
963 //\r
964 return EFI_UNSUPPORTED;\r
965 }\r
966 //\r
967 // Supply 400KHz clock frequency at initialization phase.\r
968 //\r
969 InitFreq = 400;\r
970 Status = SdMmcHcClockSupply (PciIo, Slot, InitFreq, Capability);\r
971 return Status;\r
972}\r
973\r
974/**\r
975 Supply SD/MMC card with maximum voltage at initialization.\r
976\r
977 Refer to SD Host Controller Simplified spec 3.0 Section 3.3 for details.\r
978\r
979 @param[in] PciIo The PCI IO protocol instance.\r
980 @param[in] Slot The slot number of the SD card to send the command to.\r
981 @param[in] Capability The capability of the slot.\r
982\r
983 @retval EFI_SUCCESS The voltage is supplied successfully.\r
984 @retval Others The voltage isn't supplied successfully.\r
985\r
986**/\r
987EFI_STATUS\r
988SdMmcHcInitPowerVoltage (\r
989 IN EFI_PCI_IO_PROTOCOL *PciIo,\r
990 IN UINT8 Slot,\r
991 IN SD_MMC_HC_SLOT_CAP Capability\r
992 )\r
993{\r
994 EFI_STATUS Status;\r
995 UINT8 MaxVoltage;\r
996 UINT8 HostCtrl2;\r
997\r
998 //\r
999 // Calculate supported maximum voltage according to SD Bus Voltage Select\r
1000 //\r
1001 if (Capability.Voltage33 != 0) {\r
1002 //\r
1003 // Support 3.3V\r
1004 //\r
1005 MaxVoltage = 0x0E;\r
1006 } else if (Capability.Voltage30 != 0) {\r
1007 //\r
1008 // Support 3.0V\r
1009 //\r
1010 MaxVoltage = 0x0C;\r
1011 } else if (Capability.Voltage18 != 0) {\r
1012 //\r
1013 // Support 1.8V\r
1014 //\r
1015 MaxVoltage = 0x0A;\r
1016 HostCtrl2 = BIT3;\r
1017 Status = SdMmcHcOrMmio (PciIo, Slot, SD_MMC_HC_HOST_CTRL2, sizeof (HostCtrl2), &HostCtrl2);\r
1018 gBS->Stall (5000);\r
1019 if (EFI_ERROR (Status)) {\r
1020 return Status;\r
1021 }\r
1022 } else {\r
1023 ASSERT (FALSE);\r
1024 return EFI_DEVICE_ERROR;\r
1025 }\r
1026\r
1027 //\r
1028 // Set SD Bus Voltage Select and SD Bus Power fields in Power Control Register\r
1029 //\r
1030 Status = SdMmcHcPowerControl (PciIo, Slot, MaxVoltage);\r
1031\r
1032 return Status;\r
1033}\r
1034\r
1035/**\r
1036 Initialize the Timeout Control register with most conservative value at initialization.\r
1037\r
1038 Refer to SD Host Controller Simplified spec 3.0 Section 2.2.15 for details.\r
1039\r
1040 @param[in] PciIo The PCI IO protocol instance.\r
1041 @param[in] Slot The slot number of the SD card to send the command to.\r
1042\r
1043 @retval EFI_SUCCESS The timeout control register is configured successfully.\r
1044 @retval Others The timeout control register isn't configured successfully.\r
1045\r
1046**/\r
1047EFI_STATUS\r
1048SdMmcHcInitTimeoutCtrl (\r
1049 IN EFI_PCI_IO_PROTOCOL *PciIo,\r
1050 IN UINT8 Slot\r
1051 )\r
1052{\r
1053 EFI_STATUS Status;\r
1054 UINT8 Timeout;\r
1055\r
1056 Timeout = 0x0E;\r
1057 Status = SdMmcHcRwMmio (PciIo, Slot, SD_MMC_HC_TIMEOUT_CTRL, FALSE, sizeof (Timeout), &Timeout);\r
1058\r
1059 return Status;\r
1060}\r
1061\r
1062/**\r
1063 Initial SD/MMC host controller with lowest clock frequency, max power and max timeout value\r
1064 at initialization.\r
1065\r
b23fc39c 1066 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.\r
48555339 1067 @param[in] Slot The slot number of the SD card to send the command to.\r
48555339
FT
1068\r
1069 @retval EFI_SUCCESS The host controller is initialized successfully.\r
1070 @retval Others The host controller isn't initialized successfully.\r
1071\r
1072**/\r
1073EFI_STATUS\r
1074SdMmcHcInitHost (\r
b23fc39c
AB
1075 IN SD_MMC_HC_PRIVATE_DATA *Private,\r
1076 IN UINT8 Slot\r
48555339
FT
1077 )\r
1078{\r
b23fc39c
AB
1079 EFI_STATUS Status;\r
1080 EFI_PCI_IO_PROTOCOL *PciIo;\r
1081 SD_MMC_HC_SLOT_CAP Capability;\r
1082\r
1083 //\r
1084 // Notify the SD/MMC override protocol that we are about to initialize\r
1085 // the SD/MMC host controller.\r
1086 //\r
1087 if (mOverride != NULL && mOverride->NotifyPhase != NULL) {\r
1088 Status = mOverride->NotifyPhase (\r
1089 Private->ControllerHandle,\r
1090 Slot,\r
1091 EdkiiSdMmcInitHostPre);\r
1092 if (EFI_ERROR (Status)) {\r
1093 DEBUG ((DEBUG_WARN,\r
1094 "%a: SD/MMC pre init notifier callback failed - %r\n",\r
1095 __FUNCTION__, Status));\r
1096 return Status;\r
1097 }\r
1098 }\r
1099\r
1100 PciIo = Private->PciIo;\r
1101 Capability = Private->Capability[Slot];\r
48555339
FT
1102\r
1103 Status = SdMmcHcInitClockFreq (PciIo, Slot, Capability);\r
1104 if (EFI_ERROR (Status)) {\r
1105 return Status;\r
1106 }\r
1107\r
1108 Status = SdMmcHcInitPowerVoltage (PciIo, Slot, Capability);\r
1109 if (EFI_ERROR (Status)) {\r
1110 return Status;\r
1111 }\r
1112\r
1113 Status = SdMmcHcInitTimeoutCtrl (PciIo, Slot);\r
b23fc39c
AB
1114 if (EFI_ERROR (Status)) {\r
1115 return Status;\r
1116 }\r
1117\r
1118 //\r
1119 // Notify the SD/MMC override protocol that we are have just initialized\r
1120 // the SD/MMC host controller.\r
1121 //\r
1122 if (mOverride != NULL && mOverride->NotifyPhase != NULL) {\r
1123 Status = mOverride->NotifyPhase (\r
1124 Private->ControllerHandle,\r
1125 Slot,\r
1126 EdkiiSdMmcInitHostPost);\r
1127 if (EFI_ERROR (Status)) {\r
1128 DEBUG ((DEBUG_WARN,\r
1129 "%a: SD/MMC post init notifier callback failed - %r\n",\r
1130 __FUNCTION__, Status));\r
1131 }\r
1132 }\r
48555339
FT
1133 return Status;\r
1134}\r
1135\r
1136/**\r
1137 Turn on/off LED.\r
1138\r
1139 @param[in] PciIo The PCI IO protocol instance.\r
1140 @param[in] Slot The slot number of the SD card to send the command to.\r
1141 @param[in] On The boolean to turn on/off LED.\r
1142\r
1143 @retval EFI_SUCCESS The LED is turned on/off successfully.\r
1144 @retval Others The LED isn't turned on/off successfully.\r
1145\r
1146**/\r
1147EFI_STATUS\r
1148SdMmcHcLedOnOff (\r
1149 IN EFI_PCI_IO_PROTOCOL *PciIo,\r
1150 IN UINT8 Slot,\r
1151 IN BOOLEAN On\r
1152 )\r
1153{\r
1154 EFI_STATUS Status;\r
1155 UINT8 HostCtrl1;\r
1156\r
1157 if (On) {\r
1158 HostCtrl1 = BIT0;\r
1159 Status = SdMmcHcOrMmio (PciIo, Slot, SD_MMC_HC_HOST_CTRL1, sizeof (HostCtrl1), &HostCtrl1);\r
1160 } else {\r
1161 HostCtrl1 = (UINT8)~BIT0;\r
1162 Status = SdMmcHcAndMmio (PciIo, Slot, SD_MMC_HC_HOST_CTRL1, sizeof (HostCtrl1), &HostCtrl1);\r
1163 }\r
1164\r
1165 return Status;\r
1166}\r
1167\r
1168/**\r
1169 Build ADMA descriptor table for transfer.\r
1170\r
1171 Refer to SD Host Controller Simplified spec 3.0 Section 1.13 for details.\r
1172\r
1173 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.\r
1174\r
1175 @retval EFI_SUCCESS The ADMA descriptor table is created successfully.\r
1176 @retval Others The ADMA descriptor table isn't created successfully.\r
1177\r
1178**/\r
1179EFI_STATUS\r
1180BuildAdmaDescTable (\r
1181 IN SD_MMC_HC_TRB *Trb\r
1182 )\r
1183{\r
1184 EFI_PHYSICAL_ADDRESS Data;\r
1185 UINT64 DataLen;\r
1186 UINT64 Entries;\r
1187 UINT32 Index;\r
1188 UINT64 Remaining;\r
1189 UINT32 Address;\r
1190 UINTN TableSize;\r
1191 EFI_PCI_IO_PROTOCOL *PciIo;\r
1192 EFI_STATUS Status;\r
1193 UINTN Bytes;\r
1194\r
1195 Data = Trb->DataPhy;\r
1196 DataLen = Trb->DataLen;\r
1197 PciIo = Trb->Private->PciIo;\r
1198 //\r
1199 // Only support 32bit ADMA Descriptor Table\r
1200 //\r
1201 if ((Data >= 0x100000000ul) || ((Data + DataLen) > 0x100000000ul)) {\r
1202 return EFI_INVALID_PARAMETER;\r
1203 }\r
1204 //\r
1205 // Address field shall be set on 32-bit boundary (Lower 2-bit is always set to 0)\r
1206 // for 32-bit address descriptor table.\r
1207 //\r
1208 if ((Data & (BIT0 | BIT1)) != 0) {\r
e27ccaba 1209 DEBUG ((DEBUG_INFO, "The buffer [0x%x] to construct ADMA desc is not aligned to 4 bytes boundary!\n", Data));\r
48555339
FT
1210 }\r
1211\r
1212 Entries = DivU64x32 ((DataLen + ADMA_MAX_DATA_PER_LINE - 1), ADMA_MAX_DATA_PER_LINE);\r
1213 TableSize = (UINTN)MultU64x32 (Entries, sizeof (SD_MMC_HC_ADMA_DESC_LINE));\r
1214 Trb->AdmaPages = (UINT32)EFI_SIZE_TO_PAGES (TableSize);\r
1215 Status = PciIo->AllocateBuffer (\r
1216 PciIo,\r
1217 AllocateAnyPages,\r
1218 EfiBootServicesData,\r
1219 EFI_SIZE_TO_PAGES (TableSize),\r
1220 (VOID **)&Trb->AdmaDesc,\r
1221 0\r
1222 );\r
1223 if (EFI_ERROR (Status)) {\r
1224 return EFI_OUT_OF_RESOURCES;\r
1225 }\r
1226 ZeroMem (Trb->AdmaDesc, TableSize);\r
1227 Bytes = TableSize;\r
1228 Status = PciIo->Map (\r
1229 PciIo,\r
1230 EfiPciIoOperationBusMasterCommonBuffer,\r
1231 Trb->AdmaDesc,\r
1232 &Bytes,\r
1233 &Trb->AdmaDescPhy,\r
1234 &Trb->AdmaMap\r
1235 );\r
1236\r
1237 if (EFI_ERROR (Status) || (Bytes != TableSize)) {\r
1238 //\r
1239 // Map error or unable to map the whole RFis buffer into a contiguous region.\r
1240 //\r
1241 PciIo->FreeBuffer (\r
1242 PciIo,\r
1243 EFI_SIZE_TO_PAGES (TableSize),\r
1244 Trb->AdmaDesc\r
1245 );\r
1246 return EFI_OUT_OF_RESOURCES;\r
1247 }\r
1248\r
1249 if ((UINT64)(UINTN)Trb->AdmaDescPhy > 0x100000000ul) {\r
1250 //\r
1251 // The ADMA doesn't support 64bit addressing.\r
1252 //\r
1253 PciIo->Unmap (\r
1254 PciIo,\r
1255 Trb->AdmaMap\r
1256 );\r
1257 PciIo->FreeBuffer (\r
1258 PciIo,\r
1259 EFI_SIZE_TO_PAGES (TableSize),\r
1260 Trb->AdmaDesc\r
1261 );\r
1262 return EFI_DEVICE_ERROR;\r
1263 }\r
1264\r
1265 Remaining = DataLen;\r
1266 Address = (UINT32)Data;\r
1267 for (Index = 0; Index < Entries; Index++) {\r
1268 if (Remaining <= ADMA_MAX_DATA_PER_LINE) {\r
1269 Trb->AdmaDesc[Index].Valid = 1;\r
1270 Trb->AdmaDesc[Index].Act = 2;\r
1271 Trb->AdmaDesc[Index].Length = (UINT16)Remaining;\r
1272 Trb->AdmaDesc[Index].Address = Address;\r
1273 break;\r
1274 } else {\r
1275 Trb->AdmaDesc[Index].Valid = 1;\r
1276 Trb->AdmaDesc[Index].Act = 2;\r
1277 Trb->AdmaDesc[Index].Length = 0;\r
1278 Trb->AdmaDesc[Index].Address = Address;\r
1279 }\r
1280\r
1281 Remaining -= ADMA_MAX_DATA_PER_LINE;\r
1282 Address += ADMA_MAX_DATA_PER_LINE;\r
1283 }\r
1284\r
1285 //\r
1286 // Set the last descriptor line as end of descriptor table\r
1287 //\r
1288 Trb->AdmaDesc[Index].End = 1;\r
1289 return EFI_SUCCESS;\r
1290}\r
1291\r
1292/**\r
1293 Create a new TRB for the SD/MMC cmd request.\r
1294\r
1295 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.\r
1296 @param[in] Slot The slot number of the SD card to send the command to.\r
1297 @param[in] Packet A pointer to the SD command data structure.\r
1298 @param[in] Event If Event is NULL, blocking I/O is performed. If Event is\r
1299 not NULL, then nonblocking I/O is performed, and Event\r
1300 will be signaled when the Packet completes.\r
1301\r
1302 @return Created Trb or NULL.\r
1303\r
1304**/\r
1305SD_MMC_HC_TRB *\r
1306SdMmcCreateTrb (\r
1307 IN SD_MMC_HC_PRIVATE_DATA *Private,\r
1308 IN UINT8 Slot,\r
1309 IN EFI_SD_MMC_PASS_THRU_COMMAND_PACKET *Packet,\r
1310 IN EFI_EVENT Event\r
1311 )\r
1312{\r
1313 SD_MMC_HC_TRB *Trb;\r
1314 EFI_STATUS Status;\r
1315 EFI_TPL OldTpl;\r
1316 EFI_PCI_IO_PROTOCOL_OPERATION Flag;\r
1317 EFI_PCI_IO_PROTOCOL *PciIo;\r
1318 UINTN MapLength;\r
1319\r
1320 Trb = AllocateZeroPool (sizeof (SD_MMC_HC_TRB));\r
1321 if (Trb == NULL) {\r
1322 return NULL;\r
1323 }\r
1324\r
1325 Trb->Signature = SD_MMC_HC_TRB_SIG;\r
1326 Trb->Slot = Slot;\r
1327 Trb->BlockSize = 0x200;\r
1328 Trb->Packet = Packet;\r
1329 Trb->Event = Event;\r
1330 Trb->Started = FALSE;\r
1331 Trb->Timeout = Packet->Timeout;\r
1332 Trb->Private = Private;\r
1333\r
1334 if ((Packet->InTransferLength != 0) && (Packet->InDataBuffer != NULL)) {\r
1335 Trb->Data = Packet->InDataBuffer;\r
1336 Trb->DataLen = Packet->InTransferLength;\r
1337 Trb->Read = TRUE;\r
1338 } else if ((Packet->OutTransferLength != 0) && (Packet->OutDataBuffer != NULL)) {\r
1339 Trb->Data = Packet->OutDataBuffer;\r
1340 Trb->DataLen = Packet->OutTransferLength;\r
1341 Trb->Read = FALSE;\r
1342 } else if ((Packet->InTransferLength == 0) && (Packet->OutTransferLength == 0)) {\r
1343 Trb->Data = NULL;\r
1344 Trb->DataLen = 0;\r
1345 } else {\r
1346 goto Error;\r
1347 }\r
1348\r
54228046 1349 if ((Trb->DataLen != 0) && (Trb->DataLen < Trb->BlockSize)) {\r
e7e89b08
FT
1350 Trb->BlockSize = (UINT16)Trb->DataLen;\r
1351 }\r
1352\r
1353 if (((Private->Slot[Trb->Slot].CardType == EmmcCardType) &&\r
1354 (Packet->SdMmcCmdBlk->CommandIndex == EMMC_SEND_TUNING_BLOCK)) ||\r
1355 ((Private->Slot[Trb->Slot].CardType == SdCardType) &&\r
1356 (Packet->SdMmcCmdBlk->CommandIndex == SD_SEND_TUNING_BLOCK))) {\r
1357 Trb->Mode = SdMmcPioMode;\r
48555339 1358 } else {\r
e7e89b08
FT
1359 if (Trb->Read) {\r
1360 Flag = EfiPciIoOperationBusMasterWrite;\r
1361 } else {\r
1362 Flag = EfiPciIoOperationBusMasterRead;\r
48555339 1363 }\r
48555339 1364\r
e7e89b08
FT
1365 PciIo = Private->PciIo;\r
1366 if (Trb->DataLen != 0) {\r
1367 MapLength = Trb->DataLen;\r
1368 Status = PciIo->Map (\r
1369 PciIo,\r
1370 Flag,\r
1371 Trb->Data,\r
1372 &MapLength,\r
1373 &Trb->DataPhy,\r
1374 &Trb->DataMap\r
1375 );\r
1376 if (EFI_ERROR (Status) || (Trb->DataLen != MapLength)) {\r
1377 Status = EFI_BAD_BUFFER_SIZE;\r
1378 goto Error;\r
1379 }\r
48555339 1380 }\r
48555339 1381\r
e7e89b08
FT
1382 if (Trb->DataLen == 0) {\r
1383 Trb->Mode = SdMmcNoData;\r
1384 } else if (Private->Capability[Slot].Adma2 != 0) {\r
1385 Trb->Mode = SdMmcAdmaMode;\r
1386 Status = BuildAdmaDescTable (Trb);\r
1387 if (EFI_ERROR (Status)) {\r
1388 PciIo->Unmap (PciIo, Trb->DataMap);\r
1389 goto Error;\r
1390 }\r
1391 } else if (Private->Capability[Slot].Sdma != 0) {\r
1392 Trb->Mode = SdMmcSdmaMode;\r
1393 } else {\r
1394 Trb->Mode = SdMmcPioMode;\r
48555339 1395 }\r
48555339
FT
1396 }\r
1397\r
1398 if (Event != NULL) {\r
3b1d8241 1399 OldTpl = gBS->RaiseTPL (TPL_NOTIFY);\r
48555339
FT
1400 InsertTailList (&Private->Queue, &Trb->TrbList);\r
1401 gBS->RestoreTPL (OldTpl);\r
1402 }\r
1403\r
1404 return Trb;\r
1405\r
1406Error:\r
1407 SdMmcFreeTrb (Trb);\r
1408 return NULL;\r
1409}\r
1410\r
1411/**\r
1412 Free the resource used by the TRB.\r
1413\r
1414 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.\r
1415\r
1416**/\r
1417VOID\r
1418SdMmcFreeTrb (\r
1419 IN SD_MMC_HC_TRB *Trb\r
1420 )\r
1421{\r
1422 EFI_PCI_IO_PROTOCOL *PciIo;\r
1423\r
1424 PciIo = Trb->Private->PciIo;\r
1425\r
1426 if (Trb->AdmaMap != NULL) {\r
1427 PciIo->Unmap (\r
1428 PciIo,\r
1429 Trb->AdmaMap\r
1430 );\r
1431 }\r
1432 if (Trb->AdmaDesc != NULL) {\r
1433 PciIo->FreeBuffer (\r
1434 PciIo,\r
1435 Trb->AdmaPages,\r
1436 Trb->AdmaDesc\r
1437 );\r
1438 }\r
1439 if (Trb->DataMap != NULL) {\r
1440 PciIo->Unmap (\r
1441 PciIo,\r
1442 Trb->DataMap\r
1443 );\r
1444 }\r
1445 FreePool (Trb);\r
1446 return;\r
1447}\r
1448\r
1449/**\r
1450 Check if the env is ready for execute specified TRB.\r
1451\r
1452 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.\r
1453 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.\r
1454\r
1455 @retval EFI_SUCCESS The env is ready for TRB execution.\r
1456 @retval EFI_NOT_READY The env is not ready for TRB execution.\r
1457 @retval Others Some erros happen.\r
1458\r
1459**/\r
1460EFI_STATUS\r
1461SdMmcCheckTrbEnv (\r
1462 IN SD_MMC_HC_PRIVATE_DATA *Private,\r
1463 IN SD_MMC_HC_TRB *Trb\r
1464 )\r
1465{\r
1466 EFI_STATUS Status;\r
1467 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET *Packet;\r
1468 EFI_PCI_IO_PROTOCOL *PciIo;\r
1469 UINT32 PresentState;\r
1470\r
1471 Packet = Trb->Packet;\r
1472\r
1473 if ((Packet->SdMmcCmdBlk->CommandType == SdMmcCommandTypeAdtc) ||\r
1474 (Packet->SdMmcCmdBlk->ResponseType == SdMmcResponseTypeR1b) ||\r
1475 (Packet->SdMmcCmdBlk->ResponseType == SdMmcResponseTypeR5b)) {\r
1476 //\r
1477 // Wait Command Inhibit (CMD) and Command Inhibit (DAT) in\r
1478 // the Present State register to be 0\r
1479 //\r
1480 PresentState = BIT0 | BIT1;\r
48555339
FT
1481 } else {\r
1482 //\r
1483 // Wait Command Inhibit (CMD) in the Present State register\r
1484 // to be 0\r
1485 //\r
1486 PresentState = BIT0;\r
1487 }\r
1488\r
1489 PciIo = Private->PciIo;\r
1490 Status = SdMmcHcCheckMmioSet (\r
1491 PciIo,\r
1492 Trb->Slot,\r
1493 SD_MMC_HC_PRESENT_STATE,\r
1494 sizeof (PresentState),\r
1495 PresentState,\r
1496 0\r
1497 );\r
1498\r
1499 return Status;\r
1500}\r
1501\r
1502/**\r
1503 Wait for the env to be ready for execute specified TRB.\r
1504\r
1505 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.\r
1506 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.\r
1507\r
1508 @retval EFI_SUCCESS The env is ready for TRB execution.\r
1509 @retval EFI_TIMEOUT The env is not ready for TRB execution in time.\r
1510 @retval Others Some erros happen.\r
1511\r
1512**/\r
1513EFI_STATUS\r
1514SdMmcWaitTrbEnv (\r
1515 IN SD_MMC_HC_PRIVATE_DATA *Private,\r
1516 IN SD_MMC_HC_TRB *Trb\r
1517 )\r
1518{\r
1519 EFI_STATUS Status;\r
1520 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET *Packet;\r
1521 UINT64 Timeout;\r
1522 BOOLEAN InfiniteWait;\r
1523\r
1524 //\r
1525 // Wait Command Complete Interrupt Status bit in Normal Interrupt Status Register\r
1526 //\r
1527 Packet = Trb->Packet;\r
1528 Timeout = Packet->Timeout;\r
1529 if (Timeout == 0) {\r
1530 InfiniteWait = TRUE;\r
1531 } else {\r
1532 InfiniteWait = FALSE;\r
1533 }\r
1534\r
1535 while (InfiniteWait || (Timeout > 0)) {\r
1536 //\r
1537 // Check Trb execution result by reading Normal Interrupt Status register.\r
1538 //\r
1539 Status = SdMmcCheckTrbEnv (Private, Trb);\r
1540 if (Status != EFI_NOT_READY) {\r
1541 return Status;\r
1542 }\r
1543 //\r
1544 // Stall for 1 microsecond.\r
1545 //\r
1546 gBS->Stall (1);\r
1547\r
1548 Timeout--;\r
1549 }\r
1550\r
1551 return EFI_TIMEOUT;\r
1552}\r
1553\r
1554/**\r
1555 Execute the specified TRB.\r
1556\r
1557 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.\r
1558 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.\r
1559\r
1560 @retval EFI_SUCCESS The TRB is sent to host controller successfully.\r
1561 @retval Others Some erros happen when sending this request to the host controller.\r
1562\r
1563**/\r
1564EFI_STATUS\r
1565SdMmcExecTrb (\r
1566 IN SD_MMC_HC_PRIVATE_DATA *Private,\r
1567 IN SD_MMC_HC_TRB *Trb\r
1568 )\r
1569{\r
1570 EFI_STATUS Status;\r
1571 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET *Packet;\r
1572 EFI_PCI_IO_PROTOCOL *PciIo;\r
1573 UINT16 Cmd;\r
1574 UINT16 IntStatus;\r
1575 UINT32 Argument;\r
1576 UINT16 BlkCount;\r
1577 UINT16 BlkSize;\r
1578 UINT16 TransMode;\r
1579 UINT8 HostCtrl1;\r
1580 UINT32 SdmaAddr;\r
1581 UINT64 AdmaAddr;\r
1582\r
1583 Packet = Trb->Packet;\r
1584 PciIo = Trb->Private->PciIo;\r
1585 //\r
1586 // Clear all bits in Error Interrupt Status Register\r
1587 //\r
1588 IntStatus = 0xFFFF;\r
1589 Status = SdMmcHcRwMmio (PciIo, Trb->Slot, SD_MMC_HC_ERR_INT_STS, FALSE, sizeof (IntStatus), &IntStatus);\r
1590 if (EFI_ERROR (Status)) {\r
1591 return Status;\r
1592 }\r
1593 //\r
1594 // Clear all bits in Normal Interrupt Status Register excepts for Card Removal & Card Insertion bits.\r
1595 //\r
1596 IntStatus = 0xFF3F;\r
1597 Status = SdMmcHcRwMmio (PciIo, Trb->Slot, SD_MMC_HC_NOR_INT_STS, FALSE, sizeof (IntStatus), &IntStatus);\r
1598 if (EFI_ERROR (Status)) {\r
1599 return Status;\r
1600 }\r
1601 //\r
1602 // Set Host Control 1 register DMA Select field\r
1603 //\r
1604 if (Trb->Mode == SdMmcAdmaMode) {\r
1605 HostCtrl1 = BIT4;\r
1606 Status = SdMmcHcOrMmio (PciIo, Trb->Slot, SD_MMC_HC_HOST_CTRL1, sizeof (HostCtrl1), &HostCtrl1);\r
1607 if (EFI_ERROR (Status)) {\r
1608 return Status;\r
1609 }\r
1610 }\r
1611\r
1612 SdMmcHcLedOnOff (PciIo, Trb->Slot, TRUE);\r
1613\r
1614 if (Trb->Mode == SdMmcSdmaMode) {\r
1615 if ((UINT64)(UINTN)Trb->DataPhy >= 0x100000000ul) {\r
1616 return EFI_INVALID_PARAMETER;\r
1617 }\r
1618\r
1619 SdmaAddr = (UINT32)(UINTN)Trb->DataPhy;\r
1620 Status = SdMmcHcRwMmio (PciIo, Trb->Slot, SD_MMC_HC_SDMA_ADDR, FALSE, sizeof (SdmaAddr), &SdmaAddr);\r
1621 if (EFI_ERROR (Status)) {\r
1622 return Status;\r
1623 }\r
1624 } else if (Trb->Mode == SdMmcAdmaMode) {\r
1625 AdmaAddr = (UINT64)(UINTN)Trb->AdmaDescPhy;\r
1626 Status = SdMmcHcRwMmio (PciIo, Trb->Slot, SD_MMC_HC_ADMA_SYS_ADDR, FALSE, sizeof (AdmaAddr), &AdmaAddr);\r
1627 if (EFI_ERROR (Status)) {\r
1628 return Status;\r
1629 }\r
1630 }\r
1631\r
1632 BlkSize = Trb->BlockSize;\r
1633 if (Trb->Mode == SdMmcSdmaMode) {\r
1634 //\r
1635 // Set SDMA boundary to be 512K bytes.\r
1636 //\r
1637 BlkSize |= 0x7000;\r
1638 }\r
1639\r
1640 Status = SdMmcHcRwMmio (PciIo, Trb->Slot, SD_MMC_HC_BLK_SIZE, FALSE, sizeof (BlkSize), &BlkSize);\r
1641 if (EFI_ERROR (Status)) {\r
1642 return Status;\r
1643 }\r
1644\r
e7e89b08
FT
1645 BlkCount = 0;\r
1646 if (Trb->Mode != SdMmcNoData) {\r
1647 //\r
1648 // Calcuate Block Count.\r
1649 //\r
1650 BlkCount = (UINT16)(Trb->DataLen / Trb->BlockSize);\r
1651 }\r
48555339
FT
1652 Status = SdMmcHcRwMmio (PciIo, Trb->Slot, SD_MMC_HC_BLK_COUNT, FALSE, sizeof (BlkCount), &BlkCount);\r
1653 if (EFI_ERROR (Status)) {\r
1654 return Status;\r
1655 }\r
1656\r
1657 Argument = Packet->SdMmcCmdBlk->CommandArgument;\r
1658 Status = SdMmcHcRwMmio (PciIo, Trb->Slot, SD_MMC_HC_ARG1, FALSE, sizeof (Argument), &Argument);\r
1659 if (EFI_ERROR (Status)) {\r
1660 return Status;\r
1661 }\r
1662\r
1663 TransMode = 0;\r
1664 if (Trb->Mode != SdMmcNoData) {\r
1665 if (Trb->Mode != SdMmcPioMode) {\r
1666 TransMode |= BIT0;\r
1667 }\r
1668 if (Trb->Read) {\r
1669 TransMode |= BIT4;\r
1670 }\r
e7e89b08 1671 if (BlkCount > 1) {\r
48555339
FT
1672 TransMode |= BIT5 | BIT1;\r
1673 }\r
1674 //\r
1675 // Only SD memory card needs to use AUTO CMD12 feature.\r
1676 //\r
1677 if (Private->Slot[Trb->Slot].CardType == SdCardType) {\r
1678 if (BlkCount > 1) {\r
1679 TransMode |= BIT2;\r
1680 }\r
1681 }\r
1682 }\r
1683\r
1684 Status = SdMmcHcRwMmio (PciIo, Trb->Slot, SD_MMC_HC_TRANS_MOD, FALSE, sizeof (TransMode), &TransMode);\r
1685 if (EFI_ERROR (Status)) {\r
1686 return Status;\r
1687 }\r
1688\r
1689 Cmd = (UINT16)LShiftU64(Packet->SdMmcCmdBlk->CommandIndex, 8);\r
1690 if (Packet->SdMmcCmdBlk->CommandType == SdMmcCommandTypeAdtc) {\r
1691 Cmd |= BIT5;\r
1692 }\r
1693 //\r
1694 // Convert ResponseType to value\r
1695 //\r
1696 if (Packet->SdMmcCmdBlk->CommandType != SdMmcCommandTypeBc) {\r
1697 switch (Packet->SdMmcCmdBlk->ResponseType) {\r
1698 case SdMmcResponseTypeR1:\r
1699 case SdMmcResponseTypeR5:\r
1700 case SdMmcResponseTypeR6:\r
1701 case SdMmcResponseTypeR7:\r
1702 Cmd |= (BIT1 | BIT3 | BIT4);\r
1703 break;\r
1704 case SdMmcResponseTypeR2:\r
1705 Cmd |= (BIT0 | BIT3);\r
1706 break;\r
1707 case SdMmcResponseTypeR3:\r
1708 case SdMmcResponseTypeR4:\r
1709 Cmd |= BIT1;\r
1710 break;\r
1711 case SdMmcResponseTypeR1b:\r
1712 case SdMmcResponseTypeR5b:\r
1713 Cmd |= (BIT0 | BIT1 | BIT3 | BIT4);\r
1714 break;\r
1715 default:\r
1716 ASSERT (FALSE);\r
1717 break;\r
1718 }\r
1719 }\r
1720 //\r
1721 // Execute cmd\r
1722 //\r
1723 Status = SdMmcHcRwMmio (PciIo, Trb->Slot, SD_MMC_HC_COMMAND, FALSE, sizeof (Cmd), &Cmd);\r
1724 return Status;\r
1725}\r
1726\r
1727/**\r
1728 Check the TRB execution result.\r
1729\r
1730 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.\r
1731 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.\r
1732\r
1733 @retval EFI_SUCCESS The TRB is executed successfully.\r
1734 @retval EFI_NOT_READY The TRB is not completed for execution.\r
1735 @retval Others Some erros happen when executing this request.\r
1736\r
1737**/\r
1738EFI_STATUS\r
1739SdMmcCheckTrbResult (\r
1740 IN SD_MMC_HC_PRIVATE_DATA *Private,\r
1741 IN SD_MMC_HC_TRB *Trb\r
1742 )\r
1743{\r
1744 EFI_STATUS Status;\r
1745 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET *Packet;\r
1746 UINT16 IntStatus;\r
1747 UINT32 Response[4];\r
1748 UINT32 SdmaAddr;\r
1749 UINT8 Index;\r
1750 UINT8 SwReset;\r
e7e89b08 1751 UINT32 PioLength;\r
48555339
FT
1752\r
1753 SwReset = 0;\r
1754 Packet = Trb->Packet;\r
1755 //\r
1756 // Check Trb execution result by reading Normal Interrupt Status register.\r
1757 //\r
1758 Status = SdMmcHcRwMmio (\r
1759 Private->PciIo,\r
1760 Trb->Slot,\r
1761 SD_MMC_HC_NOR_INT_STS,\r
1762 TRUE,\r
1763 sizeof (IntStatus),\r
1764 &IntStatus\r
1765 );\r
1766 if (EFI_ERROR (Status)) {\r
1767 goto Done;\r
1768 }\r
1769 //\r
1770 // Check Transfer Complete bit is set or not.\r
1771 //\r
1772 if ((IntStatus & BIT1) == BIT1) {\r
1773 if ((IntStatus & BIT15) == BIT15) {\r
1774 //\r
1775 // Read Error Interrupt Status register to check if the error is\r
1776 // Data Timeout Error.\r
1777 // If yes, treat it as success as Transfer Complete has higher\r
1778 // priority than Data Timeout Error.\r
1779 //\r
1780 Status = SdMmcHcRwMmio (\r
1781 Private->PciIo,\r
1782 Trb->Slot,\r
1783 SD_MMC_HC_ERR_INT_STS,\r
1784 TRUE,\r
1785 sizeof (IntStatus),\r
1786 &IntStatus\r
1787 );\r
1788 if (!EFI_ERROR (Status)) {\r
1789 if ((IntStatus & BIT4) == BIT4) {\r
1790 Status = EFI_SUCCESS;\r
1791 } else {\r
1792 Status = EFI_DEVICE_ERROR;\r
1793 }\r
1794 }\r
1795 }\r
1796\r
1797 goto Done;\r
1798 }\r
1799 //\r
1800 // Check if there is a error happened during cmd execution.\r
1801 // If yes, then do error recovery procedure to follow SD Host Controller\r
1802 // Simplified Spec 3.0 section 3.10.1.\r
1803 //\r
1804 if ((IntStatus & BIT15) == BIT15) {\r
1805 Status = SdMmcHcRwMmio (\r
1806 Private->PciIo,\r
1807 Trb->Slot,\r
1808 SD_MMC_HC_ERR_INT_STS,\r
1809 TRUE,\r
1810 sizeof (IntStatus),\r
1811 &IntStatus\r
1812 );\r
1813 if (EFI_ERROR (Status)) {\r
1814 goto Done;\r
1815 }\r
1816 if ((IntStatus & 0x0F) != 0) {\r
1817 SwReset |= BIT1;\r
1818 }\r
1819 if ((IntStatus & 0xF0) != 0) {\r
1820 SwReset |= BIT2;\r
1821 }\r
1822\r
1823 Status = SdMmcHcRwMmio (\r
1824 Private->PciIo,\r
1825 Trb->Slot,\r
1826 SD_MMC_HC_SW_RST,\r
1827 FALSE,\r
1828 sizeof (SwReset),\r
1829 &SwReset\r
1830 );\r
1831 if (EFI_ERROR (Status)) {\r
1832 goto Done;\r
1833 }\r
1834 Status = SdMmcHcWaitMmioSet (\r
1835 Private->PciIo,\r
1836 Trb->Slot,\r
1837 SD_MMC_HC_SW_RST,\r
1838 sizeof (SwReset),\r
1839 0xFF,\r
1840 0,\r
1841 SD_MMC_HC_GENERIC_TIMEOUT\r
1842 );\r
1843 if (EFI_ERROR (Status)) {\r
1844 goto Done;\r
1845 }\r
1846\r
1847 Status = EFI_DEVICE_ERROR;\r
1848 goto Done;\r
1849 }\r
1850 //\r
1851 // Check if DMA interrupt is signalled for the SDMA transfer.\r
1852 //\r
1853 if ((Trb->Mode == SdMmcSdmaMode) && ((IntStatus & BIT3) == BIT3)) {\r
1854 //\r
1855 // Clear DMA interrupt bit.\r
1856 //\r
1857 IntStatus = BIT3;\r
1858 Status = SdMmcHcRwMmio (\r
1859 Private->PciIo,\r
1860 Trb->Slot,\r
1861 SD_MMC_HC_NOR_INT_STS,\r
1862 FALSE,\r
1863 sizeof (IntStatus),\r
1864 &IntStatus\r
1865 );\r
1866 if (EFI_ERROR (Status)) {\r
1867 goto Done;\r
1868 }\r
1869 //\r
1870 // Update SDMA Address register.\r
1871 //\r
1872 SdmaAddr = SD_MMC_SDMA_ROUND_UP ((UINT32)(UINTN)Trb->DataPhy, SD_MMC_SDMA_BOUNDARY);\r
1873 Status = SdMmcHcRwMmio (\r
1874 Private->PciIo,\r
1875 Trb->Slot,\r
1876 SD_MMC_HC_SDMA_ADDR,\r
1877 FALSE,\r
1878 sizeof (UINT32),\r
1879 &SdmaAddr\r
1880 );\r
1881 if (EFI_ERROR (Status)) {\r
1882 goto Done;\r
1883 }\r
1884 Trb->DataPhy = (UINT32)(UINTN)SdmaAddr;\r
1885 }\r
1886\r
1887 if ((Packet->SdMmcCmdBlk->CommandType != SdMmcCommandTypeAdtc) &&\r
1888 (Packet->SdMmcCmdBlk->ResponseType != SdMmcResponseTypeR1b) &&\r
1889 (Packet->SdMmcCmdBlk->ResponseType != SdMmcResponseTypeR5b)) {\r
1890 if ((IntStatus & BIT0) == BIT0) {\r
1891 Status = EFI_SUCCESS;\r
1892 goto Done;\r
1893 }\r
1894 }\r
1895\r
1896 if (((Private->Slot[Trb->Slot].CardType == EmmcCardType) &&\r
1897 (Packet->SdMmcCmdBlk->CommandIndex == EMMC_SEND_TUNING_BLOCK)) ||\r
1898 ((Private->Slot[Trb->Slot].CardType == SdCardType) &&\r
1899 (Packet->SdMmcCmdBlk->CommandIndex == SD_SEND_TUNING_BLOCK))) {\r
1900 //\r
e7e89b08
FT
1901 // When performing tuning procedure (Execute Tuning is set to 1) through PIO mode,\r
1902 // wait Buffer Read Ready bit of Normal Interrupt Status Register to be 1.\r
1903 // Refer to SD Host Controller Simplified Specification 3.0 figure 2-29 for details.\r
48555339 1904 //\r
e7e89b08
FT
1905 if ((IntStatus & BIT5) == BIT5) {\r
1906 //\r
1907 // Clear Buffer Read Ready interrupt at first.\r
1908 //\r
1909 IntStatus = BIT5;\r
1910 SdMmcHcRwMmio (Private->PciIo, Trb->Slot, SD_MMC_HC_NOR_INT_STS, FALSE, sizeof (IntStatus), &IntStatus);\r
1911 //\r
1912 // Read data out from Buffer Port register\r
1913 //\r
1914 for (PioLength = 0; PioLength < Trb->DataLen; PioLength += 4) {\r
1915 SdMmcHcRwMmio (Private->PciIo, Trb->Slot, SD_MMC_HC_BUF_DAT_PORT, TRUE, 4, (UINT8*)Trb->Data + PioLength);\r
1916 }\r
1917 Status = EFI_SUCCESS;\r
1918 goto Done;\r
1919 }\r
48555339
FT
1920 }\r
1921\r
1922 Status = EFI_NOT_READY;\r
1923Done:\r
1924 //\r
1925 // Get response data when the cmd is executed successfully.\r
1926 //\r
1927 if (!EFI_ERROR (Status)) {\r
1928 if (Packet->SdMmcCmdBlk->CommandType != SdMmcCommandTypeBc) {\r
1929 for (Index = 0; Index < 4; Index++) {\r
1930 Status = SdMmcHcRwMmio (\r
1931 Private->PciIo,\r
1932 Trb->Slot,\r
1933 SD_MMC_HC_RESPONSE + Index * 4,\r
1934 TRUE,\r
1935 sizeof (UINT32),\r
1936 &Response[Index]\r
1937 );\r
1938 if (EFI_ERROR (Status)) {\r
1939 SdMmcHcLedOnOff (Private->PciIo, Trb->Slot, FALSE);\r
1940 return Status;\r
1941 }\r
1942 }\r
1943 CopyMem (Packet->SdMmcStatusBlk, Response, sizeof (Response));\r
1944 }\r
1945 }\r
1946\r
1947 if (Status != EFI_NOT_READY) {\r
1948 SdMmcHcLedOnOff (Private->PciIo, Trb->Slot, FALSE);\r
1949 }\r
1950\r
1951 return Status;\r
1952}\r
1953\r
1954/**\r
1955 Wait for the TRB execution result.\r
1956\r
1957 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.\r
1958 @param[in] Trb The pointer to the SD_MMC_HC_TRB instance.\r
1959\r
1960 @retval EFI_SUCCESS The TRB is executed successfully.\r
1961 @retval Others Some erros happen when executing this request.\r
1962\r
1963**/\r
1964EFI_STATUS\r
1965SdMmcWaitTrbResult (\r
1966 IN SD_MMC_HC_PRIVATE_DATA *Private,\r
1967 IN SD_MMC_HC_TRB *Trb\r
1968 )\r
1969{\r
1970 EFI_STATUS Status;\r
1971 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET *Packet;\r
1972 UINT64 Timeout;\r
1973 BOOLEAN InfiniteWait;\r
1974\r
1975 Packet = Trb->Packet;\r
1976 //\r
1977 // Wait Command Complete Interrupt Status bit in Normal Interrupt Status Register\r
1978 //\r
1979 Timeout = Packet->Timeout;\r
1980 if (Timeout == 0) {\r
1981 InfiniteWait = TRUE;\r
1982 } else {\r
1983 InfiniteWait = FALSE;\r
1984 }\r
1985\r
1986 while (InfiniteWait || (Timeout > 0)) {\r
1987 //\r
1988 // Check Trb execution result by reading Normal Interrupt Status register.\r
1989 //\r
1990 Status = SdMmcCheckTrbResult (Private, Trb);\r
1991 if (Status != EFI_NOT_READY) {\r
1992 return Status;\r
1993 }\r
1994 //\r
1995 // Stall for 1 microsecond.\r
1996 //\r
1997 gBS->Stall (1);\r
1998\r
1999 Timeout--;\r
2000 }\r
2001\r
2002 return EFI_TIMEOUT;\r
2003}\r
2004\r