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.
595 @retval EFI_SUCCESS The operation is done correctly.
596 @retval Others The operation fails.
601 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
604 IN UINT8 CommandSystem
,
605 IN UINT8 DriveStrength
,
610 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
611 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
612 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
617 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
618 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
619 ZeroMem (&Packet
, sizeof (Packet
));
621 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
622 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
623 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
625 SdMmcCmdBlk
.CommandIndex
= SD_SWITCH_FUNC
;
626 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeAdtc
;
627 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR1
;
629 ModeValue
= Mode
? BIT31
: 0;
630 SdMmcCmdBlk
.CommandArgument
= (AccessMode
& 0xF) | ((PowerLimit
& 0xF) << 4) | \
631 ((DriveStrength
& 0xF) << 8) | ((DriveStrength
& 0xF) << 12) | \
634 Packet
.InDataBuffer
= Data
;
635 Packet
.InTransferLength
= sizeof (Data
);
637 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
643 Send command SEND_STATUS to the addressed SD device to get its status register.
645 Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.
647 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
648 @param[in] Slot The slot number of the SD card to send the command to.
649 @param[in] Rca The relative device address of addressed device.
650 @param[out] DevStatus The returned device status.
652 @retval EFI_SUCCESS The operation is done correctly.
653 @retval Others The operation fails.
658 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
661 OUT UINT32
*DevStatus
664 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
665 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
666 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
669 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
670 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
671 ZeroMem (&Packet
, sizeof (Packet
));
673 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
674 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
675 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
677 SdMmcCmdBlk
.CommandIndex
= SD_SEND_STATUS
;
678 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeAc
;
679 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR1
;
680 SdMmcCmdBlk
.CommandArgument
= (UINT32
)Rca
<< 16;
682 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
683 if (!EFI_ERROR (Status
)) {
684 *DevStatus
= SdMmcStatusBlk
.Resp0
;
691 Send command SEND_TUNING_BLOCK to the SD device for HS200 optimal sampling point
694 It may be sent up to 40 times until the host finishes the tuning procedure.
696 Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.
698 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
699 @param[in] Slot The slot number of the SD card to send the command to.
701 @retval EFI_SUCCESS The operation is done correctly.
702 @retval Others The operation fails.
706 SdCardSendTuningBlk (
707 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
711 EFI_SD_MMC_COMMAND_BLOCK SdMmcCmdBlk
;
712 EFI_SD_MMC_STATUS_BLOCK SdMmcStatusBlk
;
713 EFI_SD_MMC_PASS_THRU_COMMAND_PACKET Packet
;
715 UINT8 TuningBlock
[64];
717 ZeroMem (&SdMmcCmdBlk
, sizeof (SdMmcCmdBlk
));
718 ZeroMem (&SdMmcStatusBlk
, sizeof (SdMmcStatusBlk
));
719 ZeroMem (&Packet
, sizeof (Packet
));
721 Packet
.SdMmcCmdBlk
= &SdMmcCmdBlk
;
722 Packet
.SdMmcStatusBlk
= &SdMmcStatusBlk
;
723 Packet
.Timeout
= SD_MMC_HC_GENERIC_TIMEOUT
;
725 SdMmcCmdBlk
.CommandIndex
= SD_SEND_TUNING_BLOCK
;
726 SdMmcCmdBlk
.CommandType
= SdMmcCommandTypeAdtc
;
727 SdMmcCmdBlk
.ResponseType
= SdMmcResponseTypeR1
;
728 SdMmcCmdBlk
.CommandArgument
= 0;
730 Packet
.InDataBuffer
= TuningBlock
;
731 Packet
.InTransferLength
= sizeof (TuningBlock
);
733 Status
= SdMmcPassThruPassThru (PassThru
, Slot
, &Packet
, NULL
);
739 Tunning the sampling point of SDR104 or SDR50 bus speed mode.
741 Command SD_SEND_TUNING_BLOCK may be sent up to 40 times until the host finishes the
744 Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 and
745 SD Host Controller Simplified Spec 3.0 section Figure 3-7 for details.
747 @param[in] PciIo A pointer to the EFI_PCI_IO_PROTOCOL instance.
748 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
749 @param[in] Slot The slot number of the SD card to send the command to.
751 @retval EFI_SUCCESS The operation is done correctly.
752 @retval Others The operation fails.
757 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
758 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
767 // Notify the host that the sampling clock tuning procedure starts.
770 Status
= SdMmcHcOrMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL2
, sizeof (HostCtrl2
), &HostCtrl2
);
771 if (EFI_ERROR (Status
)) {
775 // Ask the device to send a sequence of tuning blocks till the tuning procedure is done.
779 Status
= SdCardSendTuningBlk (PassThru
, Slot
);
780 if (EFI_ERROR (Status
)) {
781 DEBUG ((EFI_D_ERROR
, "SdCardSendTuningBlk: Send tuning block fails with %r\n", Status
));
785 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL2
, TRUE
, sizeof (HostCtrl2
), &HostCtrl2
);
786 if (EFI_ERROR (Status
)) {
790 if ((HostCtrl2
& (BIT6
| BIT7
)) == BIT7
) {
793 } while (++Retry
< 40);
796 Status
= EFI_TIMEOUT
;
797 DEBUG ((EFI_D_ERROR
, "SdCardTuningClock: Send tuning block exceeds 40 times\n"));
804 Switch the bus width to specified width.
806 Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 and
807 SD Host Controller Simplified Spec 3.0 section Figure 3-7 for details.
809 @param[in] PciIo A pointer to the EFI_PCI_IO_PROTOCOL instance.
810 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
811 @param[in] Slot The slot number of the SD card to send the command to.
812 @param[in] Rca The relative device address to be assigned.
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.
820 SdCardSwitchBusWidth (
821 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
822 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
831 Status
= SdCardSetBusWidth (PassThru
, Slot
, Rca
, BusWidth
);
832 if (EFI_ERROR (Status
)) {
833 DEBUG ((EFI_D_ERROR
, "SdCardSwitchBusWidth: Switch to bus width %d fails with %r\n", BusWidth
, Status
));
837 Status
= SdCardSendStatus (PassThru
, Slot
, Rca
, &DevStatus
);
838 if (EFI_ERROR (Status
)) {
839 DEBUG ((EFI_D_ERROR
, "SdCardSwitchBusWidth: Send status fails with %r\n", Status
));
843 // Check the switch operation is really successful or not.
845 if ((DevStatus
>> 16) != 0) {
846 DEBUG ((EFI_D_ERROR
, "SdCardSwitchBusWidth: The switch operation fails as DevStatus is 0x%08x\n", DevStatus
));
847 return EFI_DEVICE_ERROR
;
850 Status
= SdMmcHcSetBusWidth (PciIo
, Slot
, BusWidth
);
856 Switch the high speed timing according to request.
858 Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 and
859 SD Host Controller Simplified Spec 3.0 section Figure 2-29 for details.
861 @param[in] PciIo A pointer to the EFI_PCI_IO_PROTOCOL instance.
862 @param[in] PassThru A pointer to the EFI_SD_MMC_PASS_THRU_PROTOCOL instance.
863 @param[in] Slot The slot number of the SD card to send the command to.
864 @param[in] Rca The relative device address to be assigned.
865 @param[in] S18A The boolean to show if it's a UHS-I SD card.
867 @retval EFI_SUCCESS The operation is done correctly.
868 @retval Others The operation fails.
873 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
874 IN EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
,
881 SD_MMC_HC_SLOT_CAP
*Capability
;
887 SD_MMC_HC_PRIVATE_DATA
*Private
;
889 Private
= SD_MMC_HC_PRIVATE_FROM_THIS (PassThru
);
891 Capability
= &Private
->Capability
[Slot
];
893 Status
= SdCardSelect (PassThru
, Slot
, Rca
);
894 if (EFI_ERROR (Status
)) {
900 Status
= SdCardSwitchBusWidth (PciIo
, PassThru
, Slot
, Rca
, BusWidth
);
901 if (EFI_ERROR (Status
)) {
906 // Calculate supported bus speed/bus width/clock frequency.
909 if (S18A
&& (Capability
->Sdr104
!= 0)) {
912 } else if (S18A
&& (Capability
->Sdr50
!= 0)) {
915 } else if (S18A
&& (Capability
->Ddr50
!= 0)) {
923 DEBUG ((EFI_D_INFO
, "SdCardSetBusMode: AccessMode %d ClockFreq %d BusWidth %d\n", AccessMode
, ClockFreq
, BusWidth
));
925 Status
= SdCardSwitch (PassThru
, Slot
, AccessMode
, 0, 0, 0, TRUE
);
926 if (EFI_ERROR (Status
)) {
931 // Set to Hight Speed timing
933 if (AccessMode
== 1) {
935 Status
= SdMmcHcOrMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL1
, sizeof (HostCtrl1
), &HostCtrl1
);
936 if (EFI_ERROR (Status
)) {
941 HostCtrl2
= (UINT8
)~0x7;
942 Status
= SdMmcHcAndMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL2
, sizeof (HostCtrl2
), &HostCtrl2
);
943 if (EFI_ERROR (Status
)) {
946 HostCtrl2
= AccessMode
;
947 Status
= SdMmcHcOrMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL2
, sizeof (HostCtrl2
), &HostCtrl2
);
948 if (EFI_ERROR (Status
)) {
952 Status
= SdMmcHcClockSupply (PciIo
, Slot
, ClockFreq
* 1000, *Capability
);
953 if (EFI_ERROR (Status
)) {
957 if ((AccessMode
== 3) || ((AccessMode
== 2) && (Capability
->TuningSDR50
!= 0))) {
958 Status
= SdCardTuningClock (PciIo
, PassThru
, Slot
);
959 if (EFI_ERROR (Status
)) {
968 Execute SD device identification procedure.
970 Refer to SD Physical Layer Simplified Spec 4.1 Section 3.6 for details.
972 @param[in] Private A pointer to the SD_MMC_HC_PRIVATE_DATA instance.
973 @param[in] Slot The slot number of the SD card to send the command to.
975 @retval EFI_SUCCESS There is a SD card.
976 @retval Others There is not a SD card.
980 SdCardIdentification (
981 IN SD_MMC_HC_PRIVATE_DATA
*Private
,
986 EFI_PCI_IO_PROTOCOL
*PciIo
;
987 EFI_SD_MMC_PASS_THRU_PROTOCOL
*PassThru
;
993 UINT16 ControllerVer
;
998 PciIo
= Private
->PciIo
;
999 PassThru
= &Private
->PassThru
;
1001 // 1. Send Cmd0 to the device
1003 Status
= SdCardReset (PassThru
, Slot
);
1004 if (EFI_ERROR (Status
)) {
1005 DEBUG ((EFI_D_INFO
, "SdCardIdentification: Executing Cmd0 fails with %r\n", Status
));
1009 // 2. Send Cmd8 to the device
1011 Status
= SdCardVoltageCheck (PassThru
, Slot
, 0x1, 0xFF);
1012 if (EFI_ERROR (Status
)) {
1013 DEBUG ((EFI_D_INFO
, "SdCardIdentification: Executing Cmd8 fails with %r\n", Status
));
1017 // 3. Send SDIO Cmd5 to the device to the SDIO device OCR register.
1019 Status
= SdioSendOpCond (PassThru
, Slot
, 0, FALSE
);
1020 if (!EFI_ERROR (Status
)) {
1021 DEBUG ((EFI_D_INFO
, "SdCardIdentification: Found SDIO device, ignore it as we don't support\n"));
1022 return EFI_DEVICE_ERROR
;
1025 // 4. Send Acmd41 with voltage window 0 to the device
1027 Status
= SdCardSendOpCond (PassThru
, Slot
, 0, 0, FALSE
, FALSE
, FALSE
, &Ocr
);
1028 if (EFI_ERROR (Status
)) {
1029 DEBUG ((EFI_D_INFO
, "SdCardIdentification: Executing SdCardSendOpCond fails with %r\n", Status
));
1030 return EFI_DEVICE_ERROR
;
1033 if (Private
->Capability
[Slot
].Voltage33
!= 0) {
1037 MaxCurrent
= ((UINT32
)Private
->MaxCurrent
[Slot
] & 0xFF) * 4;
1038 } else if (Private
->Capability
[Slot
].Voltage30
!= 0) {
1042 MaxCurrent
= (((UINT32
)Private
->MaxCurrent
[Slot
] >> 8) & 0xFF) * 4;
1043 } else if (Private
->Capability
[Slot
].Voltage18
!= 0) {
1047 MaxCurrent
= (((UINT32
)Private
->MaxCurrent
[Slot
] >> 16) & 0xFF) * 4;
1050 return EFI_DEVICE_ERROR
;
1053 if (MaxCurrent
>= 150) {
1059 Status
= SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_CTRL_VER
, TRUE
, sizeof (ControllerVer
), &ControllerVer
);
1060 if (EFI_ERROR (Status
)) {
1064 if ((ControllerVer
& 0xFF) == 2) {
1066 } else if (((ControllerVer
& 0xFF) == 0) || ((ControllerVer
& 0xFF) == 1)) {
1070 return EFI_UNSUPPORTED
;
1073 // 5. Repeatly send Acmd41 with supply voltage window to the device.
1074 // Note here we only support the cards complied with SD physical
1075 // layer simplified spec version 2.0 and version 3.0 and above.
1078 Status
= SdCardSendOpCond (PassThru
, Slot
, 0, Ocr
, S18r
, Xpc
, TRUE
, &Ocr
);
1079 if (EFI_ERROR (Status
)) {
1080 DEBUG ((EFI_D_ERROR
, "SdCardIdentification: SdCardSendOpCond fails with %r Ocr %x, S18r %x, Xpc %x\n", Status
, Ocr
, S18r
, Xpc
));
1081 return EFI_DEVICE_ERROR
;
1083 } while ((Ocr
& BIT31
) == 0);
1086 // 6. If the S18A bit is set and the Host Controller supports 1.8V signaling
1087 // (One of support bits is set to 1: SDR50, SDR104 or DDR50 in the
1088 // Capabilities register), switch its voltage to 1.8V.
1090 if ((Private
->Capability
[Slot
].Sdr50
!= 0 ||
1091 Private
->Capability
[Slot
].Sdr104
!= 0 ||
1092 Private
->Capability
[Slot
].Ddr50
!= 0) &&
1093 ((Ocr
& BIT24
) != 0)) {
1094 Status
= SdCardVoltageSwitch (PassThru
, Slot
);
1095 if (EFI_ERROR (Status
)) {
1096 DEBUG ((EFI_D_ERROR
, "SdCardIdentification: Executing SdCardVoltageSwitch fails with %r\n", Status
));
1097 Status
= EFI_DEVICE_ERROR
;
1100 Status
= SdMmcHcStopClock (PciIo
, Slot
);
1101 if (EFI_ERROR (Status
)) {
1102 Status
= EFI_DEVICE_ERROR
;
1106 SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_PRESENT_STATE
, TRUE
, sizeof (PresentState
), &PresentState
);
1107 if (((PresentState
>> 20) & 0xF) != 0) {
1108 DEBUG ((EFI_D_ERROR
, "SdCardIdentification: SwitchVoltage fails with PresentState = 0x%x\n", PresentState
));
1109 Status
= EFI_DEVICE_ERROR
;
1113 SdMmcHcOrMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL2
, sizeof (HostCtrl2
), &HostCtrl2
);
1117 SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_HOST_CTRL2
, TRUE
, sizeof (HostCtrl2
), &HostCtrl2
);
1118 if ((HostCtrl2
& BIT3
) == 0) {
1119 DEBUG ((EFI_D_ERROR
, "SdCardIdentification: SwitchVoltage fails with HostCtrl2 = 0x%x\n", HostCtrl2
));
1120 Status
= EFI_DEVICE_ERROR
;
1124 SdMmcHcInitClockFreq (PciIo
, Slot
, Private
->Capability
[Slot
]);
1128 SdMmcHcRwMmio (PciIo
, Slot
, SD_MMC_HC_PRESENT_STATE
, TRUE
, sizeof (PresentState
), &PresentState
);
1129 if (((PresentState
>> 20) & 0xF) != 0xF) {
1130 DEBUG ((EFI_D_ERROR
, "SdCardIdentification: SwitchVoltage fails with PresentState = 0x%x, It should be 0xF\n", PresentState
));
1131 Status
= EFI_DEVICE_ERROR
;
1135 DEBUG ((EFI_D_INFO
, "SdCardIdentification: Switch to 1.8v signal voltage success\n"));
1138 Status
= SdCardAllSendCid (PassThru
, Slot
);
1139 if (EFI_ERROR (Status
)) {
1140 DEBUG ((EFI_D_ERROR
, "SdCardIdentification: Executing SdCardAllSendCid fails with %r\n", Status
));
1144 Status
= SdCardSetRca (PassThru
, Slot
, &Rca
);
1145 if (EFI_ERROR (Status
)) {
1146 DEBUG ((EFI_D_ERROR
, "SdCardIdentification: Executing SdCardSetRca fails with %r\n", Status
));
1150 // Enter Data Tranfer Mode.
1152 DEBUG ((EFI_D_INFO
, "SdCardIdentification: Found a SD device at slot [%d]\n", Slot
));
1153 Private
->Slot
[Slot
].CardType
= SdCardType
;
1155 Status
= SdCardSetBusMode (PciIo
, PassThru
, Slot
, Rca
, ((Ocr
& BIT24
) != 0));
1161 // Set SD Bus Power = 0
1163 PowerCtrl
= (UINT8
)~BIT0
;
1164 Status
= SdMmcHcAndMmio (PciIo
, Slot
, SD_MMC_HC_POWER_CTRL
, sizeof (PowerCtrl
), &PowerCtrl
);
1165 return EFI_DEVICE_ERROR
;