2 This file provides some helper functions which are specific for EMMC device.
4 Copyright (c) 2018, NVIDIA CORPORATION. All rights reserved.
5 Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>
6 SPDX-License-Identifier: BSD-2-Clause-Patent
10 #include "SdMmcPciHcDxe.h"
13 Send command GO_IDLE_STATE (CMD0 with argument of 0x00000000) to the device to
14 make it go to Idle State.
16 Refer to EMMC Electrical Standard Spec 5.1 Section 6.4 for details.
18 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
19 @param[in] Slot The slot number of the SD card to send the command to.
21 @retval EFI_SUCCESS The EMMC device is reset correctly.
22 @retval Others The device reset fails.
27 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
31 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
32 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
33 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
36 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
37 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
38 ZeroMem (&Packet
, sizeof (Packet
));
40 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
41 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
42 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
44 SdMmcCmdBlk
.CommandIndex
= EMMC_GO_IDLE_STATE
;
45 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeBc
;
46 SdMmcCmdBlk
.ResponseType
= 0;
47 SdMmcCmdBlk
.CommandArgument
= 0;
51 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
57 Send command SEND_OP_COND to the EMMC device to get the data of the OCR register.
59 Refer to EMMC Electrical Standard Spec 5.1 Section 6.4 for details.
61 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
62 @param[in] Slot The slot number of the SD card to send the command to.
63 @param[in, out] Argument On input, the argument of SEND_OP_COND is to send to the device.
64 On output, the argument is the value of OCR register.
66 @retval EFI_SUCCESS The operation is done correctly.
67 @retval Others The operation fails.
72 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
74 IN OUT UINT32
*Argument
77 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
78 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
79 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
82 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
83 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
84 ZeroMem (&Packet
, sizeof (Packet
));
86 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
87 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
88 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
90 SdMmcCmdBlk
.CommandIndex
= EMMC_SEND_OP_COND
;
91 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeBcr
;
92 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR3
;
93 SdMmcCmdBlk
.CommandArgument
= *Argument
;
95 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
96 if (!EFI_ERROR (Status
)) {
98 // For details, refer to SD Host Controller Simplified Spec 3.0 Table 2-12.
100 *Argument
= SdMmcStatusBlk
.Resp0
;
107 Broadcast command ALL_SEND_CID to the bus to ask all the EMMC devices to send the
108 data of their CID registers.
110 Refer to EMMC Electrical Standard Spec 5.1 Section 6.4 for details.
112 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
113 @param[in] Slot The slot number of the SD card to send the command to.
115 @retval EFI_SUCCESS The operation is done correctly.
116 @retval Others The operation fails.
121 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
125 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
126 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
127 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
130 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
131 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
132 ZeroMem (&Packet
, sizeof (Packet
));
134 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
135 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
136 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
138 SdMmcCmdBlk
.CommandIndex
= EMMC_ALL_SEND_CID
;
139 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeBcr
;
140 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR2
;
141 SdMmcCmdBlk
.CommandArgument
= 0;
143 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
149 Send command SET_RELATIVE_ADDR to the EMMC device to assign a Relative device
152 Refer to EMMC Electrical Standard Spec 5.1 Section 6.4 for details.
154 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
155 @param[in] Slot The slot number of the SD card to send the command to.
156 @param[in] Rca The relative device address to be assigned.
158 @retval EFI_SUCCESS The operation is done correctly.
159 @retval Others The operation fails.
164 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
169 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
170 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
171 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
174 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
175 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
176 ZeroMem (&Packet
, sizeof (Packet
));
178 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
179 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
180 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
182 SdMmcCmdBlk
.CommandIndex
= EMMC_SET_RELATIVE_ADDR
;
183 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeAc
;
184 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR1
;
185 SdMmcCmdBlk
.CommandArgument
= (UINT32
)Rca
<< 16;
187 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
193 Send command SEND_CSD to the EMMC device to get the data of the CSD register.
195 Refer to EMMC Electrical Standard Spec 5.1 Section 6.10.4 for details.
197 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
198 @param[in] Slot The slot number of the SD card to send the command to.
199 @param[in] Rca The relative device address of selected device.
200 @param[out] Csd The buffer to store the content of the CSD register.
201 Note the caller should ignore the lowest byte of this
202 buffer as the content of this byte is meaningless even
203 if the operation succeeds.
205 @retval EFI_SUCCESS The operation is done correctly.
206 @retval Others The operation fails.
211 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
217 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
218 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
219 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
222 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
223 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
224 ZeroMem (&Packet
, sizeof (Packet
));
226 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
227 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
228 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
230 SdMmcCmdBlk
.CommandIndex
= EMMC_SEND_CSD
;
231 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeAc
;
232 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR2
;
233 SdMmcCmdBlk
.CommandArgument
= (UINT32
)Rca
<< 16;
235 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
236 if (!EFI_ERROR (Status
)) {
238 // For details, refer to SD Host Controller Simplified Spec 3.0 Table 2-12.
240 CopyMem (((UINT8
*)Csd
) + 1, &SdMmcStatusBlk
.Resp0
, sizeof (EMMC_CSD
) - 1);
247 Send command SELECT_DESELECT_CARD to the EMMC device to select/deselect it.
249 Refer to EMMC Electrical Standard Spec 5.1 Section 6.10.4 for details.
251 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
252 @param[in] Slot The slot number of the SD card to send the command to.
253 @param[in] Rca The relative device address of selected device.
255 @retval EFI_SUCCESS The operation is done correctly.
256 @retval Others The operation fails.
261 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
266 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
267 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
268 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
271 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
272 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
273 ZeroMem (&Packet
, sizeof (Packet
));
275 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
276 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
277 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
279 SdMmcCmdBlk
.CommandIndex
= EMMC_SELECT_DESELECT_CARD
;
280 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeAc
;
281 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR1
;
282 SdMmcCmdBlk
.CommandArgument
= (UINT32
)Rca
<< 16;
284 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
290 Send command SEND_EXT_CSD to the EMMC device to get the data of the EXT_CSD register.
292 Refer to EMMC Electrical Standard Spec 5.1 Section 6.10.4 for details.
294 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
295 @param[in] Slot The slot number of the SD card to send the command to.
296 @param[out] ExtCsd The buffer to store the content of the EXT_CSD register.
298 @retval EFI_SUCCESS The operation is done correctly.
299 @retval Others The operation fails.
304 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
306 OUT EMMC_EXT_CSD
*ExtCsd
309 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
310 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
311 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
314 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
315 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
316 ZeroMem (&Packet
, sizeof (Packet
));
318 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
319 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
320 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
322 SdMmcCmdBlk
.CommandIndex
= EMMC_SEND_EXT_CSD
;
323 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeAdtc
;
324 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR1
;
325 SdMmcCmdBlk
.CommandArgument
= 0x00000000;
327 Packet
.InDataBuffer
= ExtCsd
;
328 Packet
.InTransferLength
= sizeof (EMMC_EXT_CSD
);
330 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
335 Send command SWITCH to the EMMC device to switch the mode of operation of the
336 selected Device or modifies the EXT_CSD registers.
338 Refer to EMMC Electrical Standard Spec 5.1 Section 6.10.4 for details.
340 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
341 @param[in] Slot The slot number of the SD card to send the command to.
342 @param[in] Access The access mode of SWTICH command.
343 @param[in] Index The offset of the field to be access.
344 @param[in] Value The value to be set to the specified field of EXT_CSD register.
345 @param[in] CmdSet The value of CmdSet field of EXT_CSD register.
347 @retval EFI_SUCCESS The operation is done correctly.
348 @retval Others The operation fails.
353 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
361 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
362 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
363 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
366 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
367 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
368 ZeroMem (&Packet
, sizeof (Packet
));
370 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
371 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
372 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
374 SdMmcCmdBlk
.CommandIndex
= EMMC_SWITCH
;
375 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeAc
;
376 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR1b
;
377 SdMmcCmdBlk
.CommandArgument
= (Access
<< 24) | (Index
<< 16) | (Value
<< 8) | CmdSet
;
379 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
385 Send command SEND_STATUS to the addressed EMMC device to get its status register.
387 Refer to EMMC Electrical Standard Spec 5.1 Section 6.10.4 for details.
389 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
390 @param[in] Slot The slot number of the SD card to send the command to.
391 @param[in] Rca The relative device address of addressed device.
392 @param[out] DevStatus The returned device status.
394 @retval EFI_SUCCESS The operation is done correctly.
395 @retval Others The operation fails.
400 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
403 OUT UINT32
*DevStatus
406 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
407 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
408 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
411 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
412 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
413 ZeroMem (&Packet
, sizeof (Packet
));
415 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
416 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
417 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
419 SdMmcCmdBlk
.CommandIndex
= EMMC_SEND_STATUS
;
420 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeAc
;
421 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR1
;
422 SdMmcCmdBlk
.CommandArgument
= (UINT32
)Rca
<< 16;
424 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
425 if (!EFI_ERROR (Status
)) {
426 *DevStatus
= SdMmcStatusBlk
.Resp0
;
433 Send command SEND_TUNING_BLOCK to the EMMC device for HS200 optimal sampling point
436 It may be sent up to 40 times until the host finishes the tuning procedure.
438 Refer to EMMC Electrical Standard Spec 5.1 Section 6.6.8 for details.
440 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
441 @param[in] Slot The slot number of the SD card to send the command to.
442 @param[in] BusWidth The bus width to work.
444 @retval EFI_SUCCESS The operation is done correctly.
445 @retval Others The operation fails.
450 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
455 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
456 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
457 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
459 UINT8 TuningBlock
[128];
461 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
462 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
463 ZeroMem (&Packet
, sizeof (Packet
));
465 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
466 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
467 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
469 SdMmcCmdBlk
.CommandIndex
= EMMC_SEND_TUNING_BLOCK
;
470 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeAdtc
;
471 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR1
;
472 SdMmcCmdBlk
.CommandArgument
= 0;
474 Packet
.InDataBuffer
= TuningBlock
;
476 Packet
.InTransferLength
= sizeof (TuningBlock
);
478 Packet
.InTransferLength
= 64;
481 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
487 Tunning the clock to get HS200 optimal sampling point.
489 Command SEND_TUNING_BLOCK may be sent up to 40 times until the host finishes the
492 Refer to EMMC Electrical Standard Spec 5.1 Section 6.6.8 and SD Host Controller
493 Simplified Spec 3.0 Figure 2-29 for details.
495 @param[in] PciIo A pointer to the EFI_PCI_IO_PROTOCOL instance.
496 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
497 @param[in] Slot The slot number of the SD card to send the command to.
498 @param[in] BusWidth The bus width to work.
500 @retval EFI_SUCCESS The operation is done correctly.
501 @retval Others The operation fails.
505 EmmcTuningClkForHs200 (
506 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
507 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
517 // Notify the host that the sampling clock tuning procedure starts.
520 Status
= SdMmcHcOrMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL2
, sizeof (HostCtrl2
), &HostCtrl2
);
521 if (EFI_ERROR (Status
)) {
525 // Ask the device to send a sequence of tuning blocks till the tuning procedure is done.
529 Status
= EmmcSendTuningBlk (PassThru
, Slot
, BusWidth
);
530 if (EFI_ERROR (Status
)) {
531 DEBUG ((DEBUG_ERROR
, "EmmcTuningClkForHs200: Send tuning block fails with %r\n", Status
));
535 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL2
, TRUE
, sizeof (HostCtrl2
), &HostCtrl2
);
536 if (EFI_ERROR (Status
)) {
540 if ((HostCtrl2
& (BIT6
| BIT7
)) == 0) {
544 if ((HostCtrl2
& (BIT6
| BIT7
)) == BIT7
) {
547 } while (++Retry
< 40);
549 DEBUG ((DEBUG_ERROR
, "EmmcTuningClkForHs200: Send tuning block fails at %d times with HostCtrl2 %02x\n", Retry
, HostCtrl2
));
551 // Abort the tuning procedure and reset the tuning circuit.
553 HostCtrl2
= (UINT8
)~(BIT6
| BIT7
);
554 Status
= SdMmcHcAndMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL2
, sizeof (HostCtrl2
), &HostCtrl2
);
555 if (EFI_ERROR (Status
)) {
558 return EFI_DEVICE_ERROR
;
562 Switch the bus width to specified width.
564 Refer to EMMC Electrical Standard Spec 5.1 Section 6.6.9 and SD Host Controller
565 Simplified Spec 3.0 Figure 3-7 for details.
567 @param[in] PciIo A pointer to the EFI_PCI_IO_PROTOCOL instance.
568 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
569 @param[in] Slot The slot number of the SD card to send the command to.
570 @param[in] Rca The relative device address to be assigned.
571 @param[in] IsDdr If TRUE, use dual data rate data simpling method. Otherwise
572 use single data rate data simpling method.
573 @param[in] BusWidth The bus width to be set, it could be 4 or 8.
575 @retval EFI_SUCCESS The operation is done correctly.
576 @retval Others The operation fails.
581 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
582 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
597 // Write Byte, the Value field is written into the byte pointed by Index.
600 Index
= OFFSET_OF (EMMC_EXT_CSD
, BusWidth
);
603 } else if (BusWidth
== 8) {
606 return EFI_INVALID_PARAMETER
;
614 Status
= EmmcSwitch (PassThru
, Slot
, Access
, Index
, Value
, CmdSet
);
615 if (EFI_ERROR (Status
)) {
616 DEBUG ((DEBUG_ERROR
, "EmmcSwitchBusWidth: Switch to bus width %d fails with %r\n", BusWidth
, Status
));
620 Status
= EmmcSendStatus (PassThru
, Slot
, Rca
, &DevStatus
);
621 if (EFI_ERROR (Status
)) {
622 DEBUG ((DEBUG_ERROR
, "EmmcSwitchBusWidth: Send status fails with %r\n", Status
));
626 // Check the switch operation is really successful or not.
628 if ((DevStatus
& BIT7
) != 0) {
629 DEBUG ((DEBUG_ERROR
, "EmmcSwitchBusWidth: The switch operation fails as DevStatus is 0x%08x\n", DevStatus
));
630 return EFI_DEVICE_ERROR
;
633 Status
= SdMmcHcSetBusWidth (PciIo
, Slot
, BusWidth
);
639 Switch the bus timing and clock frequency.
641 Refer to EMMC Electrical Standard Spec 5.1 Section 6.6 and SD Host Controller
642 Simplified Spec 3.0 Figure 3-3 for details.
644 @param[in] PciIo A pointer to the EFI_PCI_IO_PROTOCOL instance.
645 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
646 @param[in] Slot The slot number of the SD card to send the command to.
647 @param[in] Rca The relative device address to be assigned.
648 @param[in] HsTiming The value to be written to HS_TIMING field of EXT_CSD register.
649 @param[in] Timing The bus mode timing indicator.
650 @param[in] ClockFreq The max clock frequency to be set, the unit is MHz.
652 @retval EFI_SUCCESS The operation is done correctly.
653 @retval Others The operation fails.
657 EmmcSwitchBusTiming (
658 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
659 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
663 IN SD_MMC_BUS_MODE Timing
,
673 SD_MMC_HC_PRIVATE_DATA
*Private
;
675 Private
= SD_MMC_HC_PRIVATE_FROM_THIS (PassThru
);
677 // Write Byte, the Value field is written into the byte pointed by Index.
680 Index
= OFFSET_OF (EMMC_EXT_CSD
, HsTiming
);
684 Status
= EmmcSwitch (PassThru
, Slot
, Access
, Index
, Value
, CmdSet
);
685 if (EFI_ERROR (Status
)) {
686 DEBUG ((DEBUG_ERROR
, "EmmcSwitchBusTiming: Switch to hstiming %d fails with %r\n", HsTiming
, Status
));
691 // Convert the clock freq unit from MHz to KHz.
693 Status
= SdMmcHcClockSupply (PciIo
, Slot
, ClockFreq
* 1000, Private
->BaseClkFreq
[Slot
], Private
->ControllerVersion
[Slot
]);
694 if (EFI_ERROR (Status
)) {
698 Status
= EmmcSendStatus (PassThru
, Slot
, Rca
, &DevStatus
);
699 if (EFI_ERROR (Status
)) {
700 DEBUG ((DEBUG_ERROR
, "EmmcSwitchBusTiming: Send status fails with %r\n", Status
));
704 // Check the switch operation is really successful or not.
706 if ((DevStatus
& BIT7
) != 0) {
707 DEBUG ((DEBUG_ERROR
, "EmmcSwitchBusTiming: The switch operation fails as DevStatus is 0x%08x\n", DevStatus
));
708 return EFI_DEVICE_ERROR
;
711 if (mOverride
!= NULL
&& mOverride
->NotifyPhase
!= NULL
) {
712 Status
= mOverride
->NotifyPhase (
713 Private
->ControllerHandle
,
715 EdkiiSdMmcSwitchClockFreqPost
,
718 if (EFI_ERROR (Status
)) {
721 "%a: SD/MMC switch clock freq post notifier callback failed - %r\n",
733 Switch to the High Speed timing according to request.
735 Refer to EMMC Electrical Standard Spec 5.1 Section 6.6.8 and SD Host Controller
736 Simplified Spec 3.0 Figure 2-29 for details.
738 @param[in] PciIo A pointer to the EFI_PCI_IO_PROTOCOL instance.
739 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
740 @param[in] Slot The slot number of the SD card to send the command to.
741 @param[in] Rca The relative device address to be assigned.
742 @param[in] ClockFreq The max clock frequency to be set.
743 @param[in] IsDdr If TRUE, use dual data rate data simpling method. Otherwise
744 use single data rate data simpling method.
745 @param[in] BusWidth The bus width to be set, it could be 4 or 8.
747 @retval EFI_SUCCESS The operation is done correctly.
748 @retval Others The operation fails.
752 EmmcSwitchToHighSpeed (
753 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
754 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
765 SD_MMC_BUS_MODE Timing
;
766 SD_MMC_HC_PRIVATE_DATA
*Private
;
768 Private
= SD_MMC_HC_PRIVATE_FROM_THIS (PassThru
);
770 Status
= EmmcSwitchBusWidth (PciIo
, PassThru
, Slot
, Rca
, IsDdr
, BusWidth
);
771 if (EFI_ERROR (Status
)) {
775 // Set to Hight Speed timing
778 Status
= SdMmcHcOrMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL1
, sizeof (HostCtrl1
), &HostCtrl1
);
779 if (EFI_ERROR (Status
)) {
784 Timing
= SdMmcMmcHsDdr
;
785 } else if (ClockFreq
== 52) {
786 Timing
= SdMmcMmcHsSdr
;
788 Timing
= SdMmcMmcLegacy
;
791 Status
= SdMmcHcUhsSignaling (Private
->ControllerHandle
, PciIo
, Slot
, Timing
);
792 if (EFI_ERROR (Status
)) {
797 Status
= EmmcSwitchBusTiming (PciIo
, PassThru
, Slot
, Rca
, HsTiming
, Timing
, ClockFreq
);
803 Switch to the HS200 timing according to request.
805 Refer to EMMC Electrical Standard Spec 5.1 Section 6.6.8 and SD Host Controller
806 Simplified Spec 3.0 Figure 2-29 for details.
808 @param[in] PciIo A pointer to the EFI_PCI_IO_PROTOCOL instance.
809 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
810 @param[in] Slot The slot number of the SD card to send the command to.
811 @param[in] Rca The relative device address to be assigned.
812 @param[in] ClockFreq The max clock frequency to be set.
813 @param[in] BusWidth The bus width to be set, it could be 4 or 8.
815 @retval EFI_SUCCESS The operation is done correctly.
816 @retval Others The operation fails.
821 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
822 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
832 SD_MMC_BUS_MODE Timing
;
833 SD_MMC_HC_PRIVATE_DATA
*Private
;
835 Private
= SD_MMC_HC_PRIVATE_FROM_THIS (PassThru
);
837 if ((BusWidth
!= 4) && (BusWidth
!= 8)) {
838 return EFI_INVALID_PARAMETER
;
841 Status
= EmmcSwitchBusWidth (PciIo
, PassThru
, Slot
, Rca
, FALSE
, BusWidth
);
842 if (EFI_ERROR (Status
)) {
846 // Set to HS200/SDR104 timing
849 // Stop bus clock at first
851 Status
= SdMmcHcStopClock (PciIo
, Slot
);
852 if (EFI_ERROR (Status
)) {
856 Timing
= SdMmcMmcHs200
;
858 Status
= SdMmcHcUhsSignaling (Private
->ControllerHandle
, PciIo
, Slot
, Timing
);
859 if (EFI_ERROR (Status
)) {
864 // Wait Internal Clock Stable in the Clock Control register to be 1 before set SD Clock Enable bit
866 Status
= SdMmcHcWaitMmioSet (
869 SD_MMC_HC_CLOCK_CTRL
,
873 SD_MMC_HC_GENERIC_TIMEOUT
875 if (EFI_ERROR (Status
)) {
879 // Set SD Clock Enable in the Clock Control register to 1
882 Status
= SdMmcHcOrMmio (PciIo
, Slot
, SD_MMC_HC_CLOCK_CTRL
, sizeof (ClockCtrl
), &ClockCtrl
);
885 Status
= EmmcSwitchBusTiming (PciIo
, PassThru
, Slot
, Rca
, HsTiming
, Timing
, ClockFreq
);
886 if (EFI_ERROR (Status
)) {
890 Status
= EmmcTuningClkForHs200 (PciIo
, PassThru
, Slot
, BusWidth
);
896 Switch to the HS400 timing according to request.
898 Refer to EMMC Electrical Standard Spec 5.1 Section 6.6.8 and SD Host Controller
899 Simplified Spec 3.0 Figure 2-29 for details.
901 @param[in] PciIo A pointer to the EFI_PCI_IO_PROTOCOL instance.
902 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
903 @param[in] Slot The slot number of the SD card to send the command to.
904 @param[in] Rca The relative device address to be assigned.
905 @param[in] ClockFreq The max clock frequency to be set.
907 @retval EFI_SUCCESS The operation is done correctly.
908 @retval Others The operation fails.
913 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
914 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
922 SD_MMC_BUS_MODE Timing
;
923 SD_MMC_HC_PRIVATE_DATA
*Private
;
925 Private
= SD_MMC_HC_PRIVATE_FROM_THIS (PassThru
);
927 Status
= EmmcSwitchToHS200 (PciIo
, PassThru
, Slot
, Rca
, ClockFreq
, 8);
928 if (EFI_ERROR (Status
)) {
932 // Set to Hight Speed timing and set the clock frequency to a value less than 52MHz.
935 Status
= EmmcSwitchBusTiming (PciIo
, PassThru
, Slot
, Rca
, HsTiming
, SdMmcMmcHsSdr
, 52);
936 if (EFI_ERROR (Status
)) {
940 // HS400 mode must use 8 data lines.
942 Status
= EmmcSwitchBusWidth (PciIo
, PassThru
, Slot
, Rca
, TRUE
, 8);
943 if (EFI_ERROR (Status
)) {
947 Timing
= SdMmcMmcHs400
;
949 Status
= SdMmcHcUhsSignaling (Private
->ControllerHandle
, PciIo
, Slot
, Timing
);
950 if (EFI_ERROR (Status
)) {
955 Status
= EmmcSwitchBusTiming (PciIo
, PassThru
, Slot
, Rca
, HsTiming
, Timing
, ClockFreq
);
961 Switch the high speed timing according to request.
963 Refer to EMMC Electrical Standard Spec 5.1 Section 6.6.8 and SD Host Controller
964 Simplified Spec 3.0 Figure 2-29 for details.
966 @param[in] PciIo A pointer to the EFI_PCI_IO_PROTOCOL instance.
967 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
968 @param[in] Slot The slot number of the SD card to send the command to.
969 @param[in] Rca The relative device address to be assigned.
971 @retval EFI_SUCCESS The operation is done correctly.
972 @retval Others The operation fails.
977 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
978 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
990 SD_MMC_HC_PRIVATE_DATA
*Private
;
992 Private
= SD_MMC_HC_PRIVATE_FROM_THIS (PassThru
);
994 Status
= EmmcGetCsd (PassThru
, Slot
, Rca
, &Csd
);
995 if (EFI_ERROR (Status
)) {
996 DEBUG ((DEBUG_ERROR
, "EmmcSetBusMode: GetCsd fails with %r\n", Status
));
1000 Status
= EmmcSelect (PassThru
, Slot
, Rca
);
1001 if (EFI_ERROR (Status
)) {
1002 DEBUG ((DEBUG_ERROR
, "EmmcSetBusMode: Select fails with %r\n", Status
));
1006 ASSERT (Private
->BaseClkFreq
[Slot
] != 0);
1008 // Check if the Host Controller support 8bits bus width.
1010 if (Private
->Capability
[Slot
].BusWidth8
!= 0) {
1016 // Get Deivce_Type from EXT_CSD register.
1018 Status
= EmmcGetExtCsd (PassThru
, Slot
, &ExtCsd
);
1019 if (EFI_ERROR (Status
)) {
1020 DEBUG ((DEBUG_ERROR
, "EmmcSetBusMode: GetExtCsd fails with %r\n", Status
));
1024 // Calculate supported bus speed/bus width/clock frequency.
1029 if (((ExtCsd
.DeviceType
& (BIT4
| BIT5
)) != 0) && (Private
->Capability
[Slot
].Sdr104
!= 0)) {
1033 } else if (((ExtCsd
.DeviceType
& (BIT2
| BIT3
)) != 0) && (Private
->Capability
[Slot
].Ddr50
!= 0)) {
1037 } else if (((ExtCsd
.DeviceType
& BIT1
) != 0) && (Private
->Capability
[Slot
].HighSpeed
!= 0)) {
1041 } else if (((ExtCsd
.DeviceType
& BIT0
) != 0) && (Private
->Capability
[Slot
].HighSpeed
!= 0)) {
1047 // Check if both of the device and the host controller support HS400 DDR mode.
1049 if (((ExtCsd
.DeviceType
& (BIT6
| BIT7
)) != 0) && (Private
->Capability
[Slot
].Hs400
!= 0)) {
1051 // The host controller supports 8bits bus.
1053 ASSERT (BusWidth
== 8);
1059 if ((ClockFreq
== 0) || (HsTiming
== 0)) {
1061 // Continue using default setting.
1066 DEBUG ((DEBUG_INFO
, "EmmcSetBusMode: HsTiming %d ClockFreq %d BusWidth %d Ddr %a\n", HsTiming
, ClockFreq
, BusWidth
, IsDdr
? "TRUE":"FALSE"));
1068 if (HsTiming
== 3) {
1070 // Execute HS400 timing switch procedure
1072 Status
= EmmcSwitchToHS400 (PciIo
, PassThru
, Slot
, Rca
, ClockFreq
);
1073 } else if (HsTiming
== 2) {
1075 // Execute HS200 timing switch procedure
1077 Status
= EmmcSwitchToHS200 (PciIo
, PassThru
, Slot
, Rca
, ClockFreq
, BusWidth
);
1080 // Execute High Speed timing switch procedure
1082 Status
= EmmcSwitchToHighSpeed (PciIo
, PassThru
, Slot
, Rca
, ClockFreq
, IsDdr
, BusWidth
);
1085 DEBUG ((DEBUG_INFO
, "EmmcSetBusMode: Switch to %a %r\n", (HsTiming
== 3) ? "HS400" : ((HsTiming
== 2) ? "HS200" : "HighSpeed"), Status
));
1091 Execute EMMC device identification procedure.
1093 Refer to EMMC Electrical Standard Spec 5.1 Section 6.4 for details.
1095 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
1096 @param[in] Slot The slot number of the SD card to send the command to.
1098 @retval EFI_SUCCESS There is a EMMC card.
1099 @retval Others There is not a EMMC card.
1103 EmmcIdentification (
1104 IN SD_MMC_HC_PRIVATE_DATA
*Private
,
1109 EFI_PCI_IO_PROTOCOL
*PciIo
;
1110 EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
;
1115 PciIo
= Private
->PciIo
;
1116 PassThru
= &Private
->PassThru
;
1118 Status
= EmmcReset (PassThru
, Slot
);
1119 if (EFI_ERROR (Status
)) {
1120 DEBUG ((DEBUG_VERBOSE
, "EmmcIdentification: Executing Cmd0 fails with %r\n", Status
));
1127 Status
= EmmcGetOcr (PassThru
, Slot
, &Ocr
);
1128 if (EFI_ERROR (Status
)) {
1129 DEBUG ((DEBUG_VERBOSE
, "EmmcIdentification: Executing Cmd1 fails with %r\n", Status
));
1134 if (Retry
++ == 100) {
1135 DEBUG ((DEBUG_VERBOSE
, "EmmcIdentification: Executing Cmd1 fails too many times\n"));
1136 return EFI_DEVICE_ERROR
;
1138 gBS
->Stall(10 * 1000);
1139 } while ((Ocr
& BIT31
) == 0);
1141 Status
= EmmcGetAllCid (PassThru
, Slot
);
1142 if (EFI_ERROR (Status
)) {
1143 DEBUG ((DEBUG_VERBOSE
, "EmmcIdentification: Executing Cmd2 fails with %r\n", Status
));
1147 // Slot starts from 0 and valid RCA starts from 1.
1148 // Here we takes a simple formula to calculate the RCA.
1149 // Don't support multiple devices on the slot, that is
1150 // shared bus slot feature.
1153 Status
= EmmcSetRca (PassThru
, Slot
, Rca
);
1154 if (EFI_ERROR (Status
)) {
1155 DEBUG ((DEBUG_ERROR
, "EmmcIdentification: Executing Cmd3 fails with %r\n", Status
));
1159 // Enter Data Tranfer Mode.
1161 DEBUG ((DEBUG_INFO
, "EmmcIdentification: Found a EMMC device at slot [%d], RCA [%d]\n", Slot
, Rca
));
1162 Private
->Slot
[Slot
].CardType
= EmmcCardType
;
1164 Status
= EmmcSetBusMode (PciIo
, PassThru
, Slot
, Rca
);