2 This file provides some helper functions which are specific for SD card device.
4 Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "SdMmcPciHcDxe.h"
18 Send command GO_IDLE_STATE to the device to make it go to Idle State.
20 Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.
22 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
23 @param[in] Slot The slot number of the SD card to send the command to.
25 @retval EFI_SUCCESS The SD device is reset correctly.
26 @retval Others The device reset fails.
31 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
35 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
36 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
37 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
40 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
41 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
42 ZeroMem (&Packet
, sizeof (Packet
));
44 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
45 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
46 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
48 SdMmcCmdBlk
.CommandIndex
= SD_GO_IDLE_STATE
;
49 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeBc
;
51 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
57 Send command SEND_IF_COND to the device to inquiry the SD Memory Card interface
60 Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.
62 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
63 @param[in] Slot The slot number of the SD card to send the command to.
64 @param[in] SupplyVoltage The supplied voltage by the host.
65 @param[in] CheckPattern The check pattern to be sent to the device.
67 @retval EFI_SUCCESS The operation is done correctly.
68 @retval Others The operation fails.
73 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
75 IN UINT8 SupplyVoltage
,
79 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
80 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
81 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
84 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
85 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
86 ZeroMem (&Packet
, sizeof (Packet
));
88 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
89 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
90 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
92 SdMmcCmdBlk
.CommandIndex
= SD_SEND_IF_COND
;
93 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeBcr
;
94 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR7
;
95 SdMmcCmdBlk
.CommandArgument
= (SupplyVoltage
<< 8) | CheckPattern
;
97 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
99 if (!EFI_ERROR (Status
)) {
100 if (SdMmcStatusBlk
.Resp0
!= SdMmcCmdBlk
.CommandArgument
) {
101 return EFI_DEVICE_ERROR
;
109 Send command SDIO_SEND_OP_COND to the device to see whether it is SDIO device.
111 Refer to SDIO Simplified Spec 3 Section 3.2 for details.
113 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
114 @param[in] Slot The slot number of the SD card to send the command to.
115 @param[in] VoltageWindow The supply voltage window.
116 @param[in] S18R The boolean to show if it should switch to 1.8v.
118 @retval EFI_SUCCESS The operation is done correctly.
119 @retval Others The operation fails.
124 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
126 IN UINT32 VoltageWindow
,
130 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
131 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
132 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
136 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
137 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
138 ZeroMem (&Packet
, sizeof (Packet
));
140 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
141 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
142 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
144 SdMmcCmdBlk
.CommandIndex
= SDIO_SEND_OP_COND
;
145 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeBcr
;
146 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR4
;
148 Switch
= S18R
? BIT24
: 0;
150 SdMmcCmdBlk
.CommandArgument
= (VoltageWindow
& 0xFFFFFF) | Switch
;
152 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
158 Send command SD_SEND_OP_COND to the device to see whether it is SDIO device.
160 Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.
162 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
163 @param[in] Slot The slot number of the SD card to send the command to.
164 @param[in] Rca The relative device address of addressed device.
165 @param[in] VoltageWindow The supply voltage window.
166 @param[in] S18R The boolean to show if it should switch to 1.8v.
167 @param[in] Xpc The boolean to show if it should provide 0.36w power control.
168 @param[in] Hcs The boolean to show if it support host capacity info.
169 @param[out] Ocr The buffer to store returned OCR register value.
171 @retval EFI_SUCCESS The operation is done correctly.
172 @retval Others The operation fails.
177 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
180 IN UINT32 VoltageWindow
,
187 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
188 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
189 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
195 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
196 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
197 ZeroMem (&Packet
, sizeof (Packet
));
199 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
200 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
201 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
203 SdMmcCmdBlk
.CommandIndex
= SD_APP_CMD
;
204 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeAc
;
205 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR1
;
206 SdMmcCmdBlk
.CommandArgument
= (UINT32
)Rca
<< 16;
208 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
209 if (EFI_ERROR (Status
)) {
213 SdMmcCmdBlk
.CommandIndex
= SD_SEND_OP_COND
;
214 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeBcr
;
215 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR3
;
217 Switch
= S18R
? BIT24
: 0;
218 MaxPower
= Xpc
? BIT28
: 0;
219 HostCapacity
= Hcs
? BIT30
: 0;
221 SdMmcCmdBlk
.CommandArgument
= (VoltageWindow
& 0xFFFFFF) | Switch
| MaxPower
| HostCapacity
;
223 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
224 if (!EFI_ERROR (Status
)) {
226 // For details, refer to SD Host Controller Simplified Spec 3.0 Table 2-12.
228 *Ocr
= SdMmcStatusBlk
.Resp0
;
235 Broadcast command ALL_SEND_CID to the bus to ask all the SD devices to send the
236 data of their CID registers.
238 Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.
240 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
241 @param[in] Slot The slot number of the SD card to send the command to.
243 @retval EFI_SUCCESS The operation is done correctly.
244 @retval Others The operation fails.
249 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
253 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
254 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
255 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
258 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
259 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
260 ZeroMem (&Packet
, sizeof (Packet
));
262 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
263 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
264 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
266 SdMmcCmdBlk
.CommandIndex
= SD_ALL_SEND_CID
;
267 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeBcr
;
268 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR2
;
270 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
276 Send command SET_RELATIVE_ADDR to the SD device to assign a Relative device
279 Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.
281 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
282 @param[in] Slot The slot number of the SD card to send the command to.
283 @param[out] Rca The relative device address to assign.
285 @retval EFI_SUCCESS The operation is done correctly.
286 @retval Others The operation fails.
291 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
296 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
297 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
298 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
301 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
302 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
303 ZeroMem (&Packet
, sizeof (Packet
));
305 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
306 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
307 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
309 SdMmcCmdBlk
.CommandIndex
= SD_SET_RELATIVE_ADDR
;
310 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeBcr
;
311 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR6
;
313 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
314 if (!EFI_ERROR (Status
)) {
315 *Rca
= (UINT16
)(SdMmcStatusBlk
.Resp0
>> 16);
322 Send command SEND_CSD to the SD device to get the data of the CSD register.
324 Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.
326 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
327 @param[in] Slot The slot number of the SD card to send the command to.
328 @param[in] Rca The relative device address of selected device.
329 @param[out] Csd The buffer to store the content of the CSD register.
330 Note the caller should ignore the lowest byte of this
331 buffer as the content of this byte is meaningless even
332 if the operation succeeds.
334 @retval EFI_SUCCESS The operation is done correctly.
335 @retval Others The operation fails.
340 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
346 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
347 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
348 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
351 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
352 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
353 ZeroMem (&Packet
, sizeof (Packet
));
355 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
356 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
357 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
359 SdMmcCmdBlk
.CommandIndex
= SD_SEND_CSD
;
360 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeAc
;
361 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR2
;
362 SdMmcCmdBlk
.CommandArgument
= (UINT32
)Rca
<< 16;
364 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
365 if (!EFI_ERROR (Status
)) {
367 // For details, refer to SD Host Controller Simplified Spec 3.0 Table 2-12.
369 CopyMem (((UINT8
*)Csd
) + 1, &SdMmcStatusBlk
.Resp0
, sizeof (SD_CSD
) - 1);
376 Send command SEND_CSD to the SD device to get the data of the CSD register.
378 Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.
380 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
381 @param[in] Slot The slot number of the SD card to send the command to.
382 @param[in] Rca The relative device address of selected device.
383 @param[out] Scr The buffer to store the content of the SCR register.
385 @retval EFI_SUCCESS The operation is done correctly.
386 @retval Others The operation fails.
391 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
397 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
398 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
399 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
402 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
403 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
404 ZeroMem (&Packet
, sizeof (Packet
));
406 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
407 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
408 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
410 SdMmcCmdBlk
.CommandIndex
= SD_APP_CMD
;
411 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeAc
;
412 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR1
;
413 SdMmcCmdBlk
.CommandArgument
= (UINT32
)Rca
<< 16;
415 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
416 if (EFI_ERROR (Status
)) {
420 SdMmcCmdBlk
.CommandIndex
= SD_SEND_SCR
;
421 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeAdtc
;
422 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR1
;
424 Packet
.InDataBuffer
= Scr
;
425 Packet
.InTransferLength
= sizeof (SD_SCR
);
427 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
433 Send command SELECT_DESELECT_CARD to the SD device to select/deselect it.
435 Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.
437 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
438 @param[in] Slot The slot number of the SD card to send the command to.
439 @param[in] Rca The relative device address of selected device.
441 @retval EFI_SUCCESS The operation is done correctly.
442 @retval Others The operation fails.
447 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
452 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
453 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
454 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
457 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
458 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
459 ZeroMem (&Packet
, sizeof (Packet
));
461 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
462 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
463 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
465 SdMmcCmdBlk
.CommandIndex
= SD_SELECT_DESELECT_CARD
;
466 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeAc
;
468 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR1b
;
470 SdMmcCmdBlk
.CommandArgument
= (UINT32
)Rca
<< 16;
472 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
478 Send command VOLTAGE_SWITCH to the SD device to switch the voltage of the device.
480 Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.
482 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
483 @param[in] Slot The slot number of the SD card to send the command to.
485 @retval EFI_SUCCESS The operation is done correctly.
486 @retval Others The operation fails.
490 SdCardVoltageSwitch (
491 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
495 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
496 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
497 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
500 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
501 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
502 ZeroMem (&Packet
, sizeof (Packet
));
504 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
505 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
506 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
508 SdMmcCmdBlk
.CommandIndex
= SD_VOLTAGE_SWITCH
;
509 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeAc
;
510 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR1
;
511 SdMmcCmdBlk
.CommandArgument
= 0;
513 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
519 Send command SET_BUS_WIDTH to the SD device to set the bus width.
521 Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.
523 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
524 @param[in] Slot The slot number of the SD card to send the command to.
525 @param[in] Rca The relative device address of addressed device.
526 @param[in] BusWidth The bus width to be set, it could be 1 or 4.
528 @retval EFI_SUCCESS The operation is done correctly.
529 @retval Others The operation fails.
534 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
540 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
541 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
542 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
546 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
547 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
548 ZeroMem (&Packet
, sizeof (Packet
));
550 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
551 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
552 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
554 SdMmcCmdBlk
.CommandIndex
= SD_APP_CMD
;
555 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeAc
;
556 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR1
;
557 SdMmcCmdBlk
.CommandArgument
= (UINT32
)Rca
<< 16;
559 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
560 if (EFI_ERROR (Status
)) {
564 SdMmcCmdBlk
.CommandIndex
= SD_SET_BUS_WIDTH
;
565 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeAc
;
566 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR1
;
570 } else if (BusWidth
== 4) {
573 return EFI_INVALID_PARAMETER
;
576 SdMmcCmdBlk
.CommandArgument
= Value
& 0x3;
578 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
583 Send command SWITCH_FUNC to the SD device to check switchable function or switch card function.
585 Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.
587 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
588 @param[in] Slot The slot number of the SD card to send the command to.
589 @param[in] AccessMode The value for access mode group.
590 @param[in] CommandSystem The value for command set group.
591 @param[in] DriveStrength The value for drive length group.
592 @param[in] PowerLimit The value for power limit group.
593 @param[in] Mode Switch or check function.
594 @param[out] SwitchResp The return switch function status.
596 @retval EFI_SUCCESS The operation is done correctly.
597 @retval Others The operation fails.
602 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
605 IN UINT8 CommandSystem
,
606 IN UINT8 DriveStrength
,
609 OUT UINT8
*SwitchResp
612 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
613 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
614 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
618 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
619 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
620 ZeroMem (&Packet
, sizeof (Packet
));
622 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
623 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
624 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
626 SdMmcCmdBlk
.CommandIndex
= SD_SWITCH_FUNC
;
627 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeAdtc
;
628 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR1
;
630 ModeValue
= Mode
? BIT31
: 0;
631 SdMmcCmdBlk
.CommandArgument
= (AccessMode
& 0xF) | ((PowerLimit
& 0xF) << 4) | \
632 ((DriveStrength
& 0xF) << 8) | ((DriveStrength
& 0xF) << 12) | \
635 Packet
.InDataBuffer
= SwitchResp
;
636 Packet
.InTransferLength
= 64;
638 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
644 Send command SEND_STATUS to the addressed SD device to get its status register.
646 Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.
648 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
649 @param[in] Slot The slot number of the SD card to send the command to.
650 @param[in] Rca The relative device address of addressed device.
651 @param[out] DevStatus The returned device status.
653 @retval EFI_SUCCESS The operation is done correctly.
654 @retval Others The operation fails.
659 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
662 OUT UINT32
*DevStatus
665 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
666 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
667 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
670 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
671 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
672 ZeroMem (&Packet
, sizeof (Packet
));
674 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
675 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
676 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
678 SdMmcCmdBlk
.CommandIndex
= SD_SEND_STATUS
;
679 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeAc
;
680 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR1
;
681 SdMmcCmdBlk
.CommandArgument
= (UINT32
)Rca
<< 16;
683 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
684 if (!EFI_ERROR (Status
)) {
685 *DevStatus
= SdMmcStatusBlk
.Resp0
;
692 Send command SEND_TUNING_BLOCK to the SD device for HS200 optimal sampling point
695 It may be sent up to 40 times until the host finishes the tuning procedure.
697 Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.
699 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
700 @param[in] Slot The slot number of the SD card to send the command to.
702 @retval EFI_SUCCESS The operation is done correctly.
703 @retval Others The operation fails.
707 SdCardSendTuningBlk (
708 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
712 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
713 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
714 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
716 UINT8 TuningBlock
[64];
718 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
719 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
720 ZeroMem (&Packet
, sizeof (Packet
));
722 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
723 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
724 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
726 SdMmcCmdBlk
.CommandIndex
= SD_SEND_TUNING_BLOCK
;
727 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeAdtc
;
728 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR1
;
729 SdMmcCmdBlk
.CommandArgument
= 0;
731 Packet
.InDataBuffer
= TuningBlock
;
732 Packet
.InTransferLength
= sizeof (TuningBlock
);
734 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
740 Tunning the sampling point of SDR104 or SDR50 bus speed mode.
742 Command SD_SEND_TUNING_BLOCK may be sent up to 40 times until the host finishes the
745 Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 and
746 SD Host Controller Simplified Spec 3.0 section Figure 3-7 for details.
748 @param[in] PciIo A pointer to the EFI_PCI_IO_PROTOCOL instance.
749 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
750 @param[in] Slot The slot number of the SD card to send the command to.
752 @retval EFI_SUCCESS The operation is done correctly.
753 @retval Others The operation fails.
758 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
759 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
768 // Notify the host that the sampling clock tuning procedure starts.
771 Status
= SdMmcHcOrMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL2
, sizeof (HostCtrl2
), &HostCtrl2
);
772 if (EFI_ERROR (Status
)) {
776 // Ask the device to send a sequence of tuning blocks till the tuning procedure is done.
780 Status
= SdCardSendTuningBlk (PassThru
, Slot
);
781 if (EFI_ERROR (Status
)) {
782 DEBUG ((EFI_D_ERROR
, "SdCardSendTuningBlk: Send tuning block fails with %r\n", Status
));
786 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL2
, TRUE
, sizeof (HostCtrl2
), &HostCtrl2
);
787 if (EFI_ERROR (Status
)) {
791 if ((HostCtrl2
& (BIT6
| BIT7
)) == 0) {
794 if ((HostCtrl2
& (BIT6
| BIT7
)) == BIT7
) {
797 } while (++Retry
< 40);
799 DEBUG ((EFI_D_ERROR
, "SdCardTuningClock: Send tuning block fails at %d times with HostCtrl2 %02x\n", Retry
, HostCtrl2
));
801 // Abort the tuning procedure and reset the tuning circuit.
803 HostCtrl2
= (UINT8
)~(BIT6
| BIT7
);
804 Status
= SdMmcHcAndMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL2
, sizeof (HostCtrl2
), &HostCtrl2
);
805 if (EFI_ERROR (Status
)) {
808 return EFI_DEVICE_ERROR
;
812 Switch the bus width to specified width.
814 Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 and
815 SD Host Controller Simplified Spec 3.0 section Figure 3-7 for details.
817 @param[in] PciIo A pointer to the EFI_PCI_IO_PROTOCOL instance.
818 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
819 @param[in] Slot The slot number of the SD card to send the command to.
820 @param[in] Rca The relative device address to be assigned.
821 @param[in] BusWidth The bus width to be set, it could be 4 or 8.
823 @retval EFI_SUCCESS The operation is done correctly.
824 @retval Others The operation fails.
828 SdCardSwitchBusWidth (
829 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
830 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
839 Status
= SdCardSetBusWidth (PassThru
, Slot
, Rca
, BusWidth
);
840 if (EFI_ERROR (Status
)) {
841 DEBUG ((EFI_D_ERROR
, "SdCardSwitchBusWidth: Switch to bus width %d fails with %r\n", BusWidth
, Status
));
845 Status
= SdCardSendStatus (PassThru
, Slot
, Rca
, &DevStatus
);
846 if (EFI_ERROR (Status
)) {
847 DEBUG ((EFI_D_ERROR
, "SdCardSwitchBusWidth: Send status fails with %r\n", Status
));
851 // Check the switch operation is really successful or not.
853 if ((DevStatus
>> 16) != 0) {
854 DEBUG ((EFI_D_ERROR
, "SdCardSwitchBusWidth: The switch operation fails as DevStatus is 0x%08x\n", DevStatus
));
855 return EFI_DEVICE_ERROR
;
858 Status
= SdMmcHcSetBusWidth (PciIo
, Slot
, BusWidth
);
864 Switch the high speed timing according to request.
866 Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 and
867 SD Host Controller Simplified Spec 3.0 section Figure 2-29 for details.
869 @param[in] PciIo A pointer to the EFI_PCI_IO_PROTOCOL instance.
870 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
871 @param[in] Slot The slot number of the SD card to send the command to.
872 @param[in] Rca The relative device address to be assigned.
873 @param[in] S18A The boolean to show if it's a UHS-I SD card.
875 @retval EFI_SUCCESS The operation is done correctly.
876 @retval Others The operation fails.
881 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
882 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
889 SD_MMC_HC_SLOT_CAP
*Capability
;
895 UINT8 SwitchResp
[64];
896 SD_MMC_HC_PRIVATE_DATA
*Private
;
898 Private
= SD_MMC_HC_PRIVATE_FROM_THIS (PassThru
);
900 Capability
= &Private
->Capability
[Slot
];
902 Status
= SdCardSelect (PassThru
, Slot
, Rca
);
903 if (EFI_ERROR (Status
)) {
909 Status
= SdCardSwitchBusWidth (PciIo
, PassThru
, Slot
, Rca
, BusWidth
);
910 if (EFI_ERROR (Status
)) {
914 // Get the supported bus speed from SWITCH cmd return data group #1.
916 Status
= SdCardSwitch (PassThru
, Slot
, 0xF, 0xF, 0xF, 0xF, FALSE
, SwitchResp
);
917 if (EFI_ERROR (Status
)) {
921 // Calculate supported bus speed/bus width/clock frequency by host and device capability.
924 if (S18A
&& (Capability
->Sdr104
!= 0) && ((SwitchResp
[13] & BIT3
) != 0)) {
927 } else if (S18A
&& (Capability
->Sdr50
!= 0) && ((SwitchResp
[13] & BIT2
) != 0)) {
930 } else if (S18A
&& (Capability
->Ddr50
!= 0) && ((SwitchResp
[13] & BIT4
) != 0)) {
933 } else if ((SwitchResp
[13] & BIT1
) != 0) {
941 Status
= SdCardSwitch (PassThru
, Slot
, AccessMode
, 0xF, 0xF, 0xF, TRUE
, SwitchResp
);
942 if (EFI_ERROR (Status
)) {
946 if ((SwitchResp
[16] & 0xF) != AccessMode
) {
947 DEBUG ((EFI_D_ERROR
, "SdCardSetBusMode: Switch to AccessMode %d ClockFreq %d BusWidth %d fails! The Switch response is 0x%1x\n", AccessMode
, ClockFreq
, BusWidth
, SwitchResp
[16] & 0xF));
948 return EFI_DEVICE_ERROR
;
951 DEBUG ((EFI_D_INFO
, "SdCardSetBusMode: Switch to AccessMode %d ClockFreq %d BusWidth %d\n", AccessMode
, ClockFreq
, BusWidth
));
954 // Set to Hight Speed timing
956 if (AccessMode
== 1) {
958 Status
= SdMmcHcOrMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL1
, sizeof (HostCtrl1
), &HostCtrl1
);
959 if (EFI_ERROR (Status
)) {
964 HostCtrl2
= (UINT8
)~0x7;
965 Status
= SdMmcHcAndMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL2
, sizeof (HostCtrl2
), &HostCtrl2
);
966 if (EFI_ERROR (Status
)) {
969 HostCtrl2
= AccessMode
;
970 Status
= SdMmcHcOrMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL2
, sizeof (HostCtrl2
), &HostCtrl2
);
971 if (EFI_ERROR (Status
)) {
975 Status
= SdMmcHcClockSupply (PciIo
, Slot
, ClockFreq
* 1000, *Capability
);
976 if (EFI_ERROR (Status
)) {
980 if ((AccessMode
== 3) || ((AccessMode
== 2) && (Capability
->TuningSDR50
!= 0))) {
981 Status
= SdCardTuningClock (PciIo
, PassThru
, Slot
);
982 if (EFI_ERROR (Status
)) {
991 Execute SD device identification procedure.
993 Refer to SD Physical Layer Simplified Spec 4.1 Section 3.6 for details.
995 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
996 @param[in] Slot The slot number of the SD card to send the command to.
998 @retval EFI_SUCCESS There is a SD card.
999 @retval Others There is not a SD card.
1003 SdCardIdentification (
1004 IN SD_MMC_HC_PRIVATE_DATA
*Private
,
1009 EFI_PCI_IO_PROTOCOL
*PciIo
;
1010 EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
;
1016 UINT16 ControllerVer
;
1018 UINT32 PresentState
;
1021 PciIo
= Private
->PciIo
;
1022 PassThru
= &Private
->PassThru
;
1024 // 1. Send Cmd0 to the device
1026 Status
= SdCardReset (PassThru
, Slot
);
1027 if (EFI_ERROR (Status
)) {
1028 DEBUG ((EFI_D_INFO
, "SdCardIdentification: Executing Cmd0 fails with %r\n", Status
));
1032 // 2. Send Cmd8 to the device
1034 Status
= SdCardVoltageCheck (PassThru
, Slot
, 0x1, 0xFF);
1035 if (EFI_ERROR (Status
)) {
1036 DEBUG ((EFI_D_INFO
, "SdCardIdentification: Executing Cmd8 fails with %r\n", Status
));
1040 // 3. Send SDIO Cmd5 to the device to the SDIO device OCR register.
1042 Status
= SdioSendOpCond (PassThru
, Slot
, 0, FALSE
);
1043 if (!EFI_ERROR (Status
)) {
1044 DEBUG ((EFI_D_INFO
, "SdCardIdentification: Found SDIO device, ignore it as we don't support\n"));
1045 return EFI_DEVICE_ERROR
;
1048 // 4. Send Acmd41 with voltage window 0 to the device
1050 Status
= SdCardSendOpCond (PassThru
, Slot
, 0, 0, FALSE
, FALSE
, FALSE
, &Ocr
);
1051 if (EFI_ERROR (Status
)) {
1052 DEBUG ((EFI_D_INFO
, "SdCardIdentification: Executing SdCardSendOpCond fails with %r\n", Status
));
1053 return EFI_DEVICE_ERROR
;
1056 if (Private
->Capability
[Slot
].Voltage33
!= 0) {
1060 MaxCurrent
= ((UINT32
)Private
->MaxCurrent
[Slot
] & 0xFF) * 4;
1061 } else if (Private
->Capability
[Slot
].Voltage30
!= 0) {
1065 MaxCurrent
= (((UINT32
)Private
->MaxCurrent
[Slot
] >> 8) & 0xFF) * 4;
1066 } else if (Private
->Capability
[Slot
].Voltage18
!= 0) {
1070 MaxCurrent
= (((UINT32
)Private
->MaxCurrent
[Slot
] >> 16) & 0xFF) * 4;
1073 return EFI_DEVICE_ERROR
;
1076 if (MaxCurrent
>= 150) {
1082 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_CTRL_VER
, TRUE
, sizeof (ControllerVer
), &ControllerVer
);
1083 if (EFI_ERROR (Status
)) {
1087 if ((ControllerVer
& 0xFF) == 2) {
1089 } else if (((ControllerVer
& 0xFF) == 0) || ((ControllerVer
& 0xFF) == 1)) {
1093 return EFI_UNSUPPORTED
;
1096 // 5. Repeatly send Acmd41 with supply voltage window to the device.
1097 // Note here we only support the cards complied with SD physical
1098 // layer simplified spec version 2.0 and version 3.0 and above.
1101 Status
= SdCardSendOpCond (PassThru
, Slot
, 0, Ocr
, S18r
, Xpc
, TRUE
, &Ocr
);
1102 if (EFI_ERROR (Status
)) {
1103 DEBUG ((EFI_D_ERROR
, "SdCardIdentification: SdCardSendOpCond fails with %r Ocr %x, S18r %x, Xpc %x\n", Status
, Ocr
, S18r
, Xpc
));
1104 return EFI_DEVICE_ERROR
;
1106 } while ((Ocr
& BIT31
) == 0);
1109 // 6. If the S18A bit is set and the Host Controller supports 1.8V signaling
1110 // (One of support bits is set to 1: SDR50, SDR104 or DDR50 in the
1111 // Capabilities register), switch its voltage to 1.8V.
1113 if ((Private
->Capability
[Slot
].Sdr50
!= 0 ||
1114 Private
->Capability
[Slot
].Sdr104
!= 0 ||
1115 Private
->Capability
[Slot
].Ddr50
!= 0) &&
1116 ((Ocr
& BIT24
) != 0)) {
1117 Status
= SdCardVoltageSwitch (PassThru
, Slot
);
1118 if (EFI_ERROR (Status
)) {
1119 DEBUG ((EFI_D_ERROR
, "SdCardIdentification: Executing SdCardVoltageSwitch fails with %r\n", Status
));
1120 Status
= EFI_DEVICE_ERROR
;
1123 Status
= SdMmcHcStopClock (PciIo
, Slot
);
1124 if (EFI_ERROR (Status
)) {
1125 Status
= EFI_DEVICE_ERROR
;
1129 SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_PRESENT_STATE
, TRUE
, sizeof (PresentState
), &PresentState
);
1130 if (((PresentState
>> 20) & 0xF) != 0) {
1131 DEBUG ((EFI_D_ERROR
, "SdCardIdentification: SwitchVoltage fails with PresentState = 0x%x\n", PresentState
));
1132 Status
= EFI_DEVICE_ERROR
;
1136 SdMmcHcOrMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL2
, sizeof (HostCtrl2
), &HostCtrl2
);
1140 SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL2
, TRUE
, sizeof (HostCtrl2
), &HostCtrl2
);
1141 if ((HostCtrl2
& BIT3
) == 0) {
1142 DEBUG ((EFI_D_ERROR
, "SdCardIdentification: SwitchVoltage fails with HostCtrl2 = 0x%x\n", HostCtrl2
));
1143 Status
= EFI_DEVICE_ERROR
;
1147 SdMmcHcInitClockFreq (PciIo
, Slot
, Private
->Capability
[Slot
]);
1151 SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_PRESENT_STATE
, TRUE
, sizeof (PresentState
), &PresentState
);
1152 if (((PresentState
>> 20) & 0xF) != 0xF) {
1153 DEBUG ((EFI_D_ERROR
, "SdCardIdentification: SwitchVoltage fails with PresentState = 0x%x, It should be 0xF\n", PresentState
));
1154 Status
= EFI_DEVICE_ERROR
;
1158 DEBUG ((EFI_D_INFO
, "SdCardIdentification: Switch to 1.8v signal voltage success\n"));
1161 Status
= SdCardAllSendCid (PassThru
, Slot
);
1162 if (EFI_ERROR (Status
)) {
1163 DEBUG ((EFI_D_ERROR
, "SdCardIdentification: Executing SdCardAllSendCid fails with %r\n", Status
));
1167 Status
= SdCardSetRca (PassThru
, Slot
, &Rca
);
1168 if (EFI_ERROR (Status
)) {
1169 DEBUG ((EFI_D_ERROR
, "SdCardIdentification: Executing SdCardSetRca fails with %r\n", Status
));
1173 // Enter Data Tranfer Mode.
1175 DEBUG ((EFI_D_INFO
, "SdCardIdentification: Found a SD device at slot [%d]\n", Slot
));
1176 Private
->Slot
[Slot
].CardType
= SdCardType
;
1178 Status
= SdCardSetBusMode (PciIo
, PassThru
, Slot
, Rca
, ((Ocr
& BIT24
) != 0));
1184 // Set SD Bus Power = 0
1186 PowerCtrl
= (UINT8
)~BIT0
;
1187 Status
= SdMmcHcAndMmio (PciIo
, Slot
, SD_MMC_HC_POWER_CTRL
, sizeof (PowerCtrl
), &PowerCtrl
);
1188 return EFI_DEVICE_ERROR
;