2 This file implement the MMC Host Protocol for the ARM PrimeCell PL180.
4 Copyright (c) 2011-2012, ARM Limited. All rights reserved.
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 #include <Library/DevicePathLib.h>
19 #include <Library/BaseMemoryLib.h>
21 EFI_MMC_HOST_PROTOCOL
*gpMmcHost
;
26 #define MMCI0_BLOCKLEN 512
27 #define MMCI0_POW2_BLOCKLEN 9
28 #define MMCI0_TIMEOUT 1000
30 #define SYS_MCI_CARDIN BIT0
31 #define SYS_MCI_WPROT BIT1
38 return ((MmioRead32 (MCI_POWER_CONTROL_REG
) & MCI_POWER_ON
) == MCI_POWER_ON
);
46 MCI_TRACE ("MciInitialize()");
52 IN EFI_MMC_HOST_PROTOCOL
*This
55 return (MmioRead32 (FixedPcdGet32 (PcdPL180SysMciRegAddress
)) & SYS_MCI_CARDIN
);
60 IN EFI_MMC_HOST_PROTOCOL
*This
63 return (MmioRead32 (FixedPcdGet32 (PcdPL180SysMciRegAddress
)) & SYS_MCI_WPROT
);
67 //Note: This function has been commented out because it is not used yet.
68 // This function could be used to remove the hardcoded BlockLen used
69 // in MciPrepareDataPath
71 // Convert block size to 2^n
84 Loop
= (Loop
>> 1) & 0xFFFF;
86 } while (Pow2BlockLen
&& (!(Loop
& BlockLen
)));
94 IN UINTN TransferDirection
97 // Set Data Length & Data Timer
98 MmioWrite32 (MCI_DATA_TIMER_REG
, 0xFFFFFFF);
99 MmioWrite32 (MCI_DATA_LENGTH_REG
, MMCI0_BLOCKLEN
);
102 //Note: we are using a hardcoded BlockLen (==512). If we decide to use a variable size, we could
103 // compute the pow2 of BlockLen with the above function GetPow2BlockLen ()
104 MmioWrite32 (MCI_DATA_CTL_REG
, MCI_DATACTL_ENABLE
| MCI_DATACTL_DMA_ENABLE
| TransferDirection
| (MMCI0_POW2_BLOCKLEN
<< 4));
106 MmioWrite32 (MCI_DATA_CTL_REG
, MCI_DATACTL_ENABLE
| MCI_DATACTL_DMA_ENABLE
| TransferDirection
| MCI_DATACTL_STREAM_TRANS
);
112 IN EFI_MMC_HOST_PROTOCOL
*This
,
122 RetVal
= EFI_SUCCESS
;
124 if ((MmcCmd
== MMC_CMD17
) || (MmcCmd
== MMC_CMD11
)) {
125 MciPrepareDataPath (MCI_DATACTL_CARD_TO_CONT
);
126 } else if ((MmcCmd
== MMC_CMD24
) || (MmcCmd
== MMC_CMD20
)) {
127 MciPrepareDataPath (MCI_DATACTL_CONT_TO_CARD
);
130 // Create Command for PL180
131 Cmd
= (MMC_GET_INDX (MmcCmd
) & INDX_MASK
) | MCI_CPSM_ENABLE
;
132 if (MmcCmd
& MMC_CMD_WAIT_RESPONSE
) {
133 Cmd
|= MCI_CPSM_WAIT_RESPONSE
;
136 if (MmcCmd
& MMC_CMD_LONG_RESPONSE
) {
137 Cmd
|= MCI_CPSM_LONG_RESPONSE
;
140 // Clear Status register static flags
141 MmioWrite32 (MCI_CLEAR_STATUS_REG
, MCI_CLR_ALL_STATUS
);
143 // Write to command argument register
144 MmioWrite32 (MCI_ARGUMENT_REG
, Argument
);
146 // Write to command register
147 MmioWrite32 (MCI_COMMAND_REG
, Cmd
);
149 if (Cmd
& MCI_CPSM_WAIT_RESPONSE
) {
150 Status
= MmioRead32 (MCI_STATUS_REG
);
151 while (!(Status
& (MCI_STATUS_CMD_RESPEND
| MCI_STATUS_CMD_CMDCRCFAIL
| MCI_STATUS_CMD_CMDTIMEOUT
| MCI_STATUS_CMD_START_BIT_ERROR
))) {
152 Status
= MmioRead32(MCI_STATUS_REG
);
155 if ((Status
& MCI_STATUS_CMD_START_BIT_ERROR
)) {
156 DEBUG ((EFI_D_ERROR
, "MciSendCommand(CmdIndex:%d) Start bit Error! Response:0x%X Status:0x%x\n", (Cmd
& 0x3F), MmioRead32 (MCI_RESPONSE0_REG
), Status
));
157 RetVal
= EFI_NO_RESPONSE
;
159 } else if ((Status
& MCI_STATUS_CMD_CMDTIMEOUT
)) {
160 //DEBUG ((EFI_D_ERROR, "MciSendCommand(CmdIndex:%d) TIMEOUT! Response:0x%X Status:0x%x\n", (Cmd & 0x3F), MmioRead32 (MCI_RESPONSE0_REG), Status));
161 RetVal
= EFI_TIMEOUT
;
163 } else if ((! (MmcCmd
& MMC_CMD_NO_CRC_RESPONSE
)) && (Status
& MCI_STATUS_CMD_CMDCRCFAIL
)) {
164 // The CMD1 and response type R3 do not contain CRC. We should ignore the CRC failed Status.
165 RetVal
= EFI_CRC_ERROR
;
168 RetVal
= EFI_SUCCESS
;
172 Status
= MmioRead32(MCI_STATUS_REG
);
173 while (!(Status
& (MCI_STATUS_CMD_SENT
| MCI_STATUS_CMD_CMDCRCFAIL
| MCI_STATUS_CMD_CMDTIMEOUT
| MCI_STATUS_CMD_START_BIT_ERROR
))) {
174 Status
= MmioRead32(MCI_STATUS_REG
);
177 if ((Status
& MCI_STATUS_CMD_START_BIT_ERROR
)) {
178 DEBUG ((EFI_D_ERROR
, "MciSendCommand(CmdIndex:%d) Start bit Error! Response:0x%X Status:0x%x\n",(Cmd
& 0x3F),MmioRead32(MCI_RESPONSE0_REG
),Status
));
179 RetVal
= EFI_NO_RESPONSE
;
181 } else if ((Status
& MCI_STATUS_CMD_CMDTIMEOUT
)) {
182 //DEBUG ((EFI_D_ERROR, "MciSendCommand(CmdIndex:%d) TIMEOUT! Response:0x%X Status:0x%x\n",(Cmd & 0x3F),MmioRead32(MCI_RESPONSE0_REG),Status));
183 RetVal
= EFI_TIMEOUT
;
186 if ((!(MmcCmd
& MMC_CMD_NO_CRC_RESPONSE
)) && (Status
& MCI_STATUS_CMD_CMDCRCFAIL
)) {
187 // The CMD1 does not contain CRC. We should ignore the CRC failed Status.
188 RetVal
= EFI_CRC_ERROR
;
191 RetVal
= EFI_SUCCESS
;
197 // Disable Command Path
198 CmdCtrlReg
= MmioRead32 (MCI_COMMAND_REG
);
199 MmioWrite32 (MCI_COMMAND_REG
, (CmdCtrlReg
& ~MCI_CPSM_ENABLE
));
205 IN EFI_MMC_HOST_PROTOCOL
*This
,
206 IN MMC_RESPONSE_TYPE Type
,
210 if (Buffer
== NULL
) {
211 return EFI_INVALID_PARAMETER
;
214 if ( (Type
== MMC_RESPONSE_TYPE_R1
)
215 || (Type
== MMC_RESPONSE_TYPE_R1b
)
216 || (Type
== MMC_RESPONSE_TYPE_R3
)
217 || (Type
== MMC_RESPONSE_TYPE_R6
)
218 || (Type
== MMC_RESPONSE_TYPE_R7
))
220 Buffer
[0] = MmioRead32 (MCI_RESPONSE3_REG
);
221 } else if (Type
== MMC_RESPONSE_TYPE_R2
) {
222 Buffer
[0] = MmioRead32 (MCI_RESPONSE0_REG
);
223 Buffer
[1] = MmioRead32 (MCI_RESPONSE1_REG
);
224 Buffer
[2] = MmioRead32 (MCI_RESPONSE2_REG
);
225 Buffer
[3] = MmioRead32 (MCI_RESPONSE3_REG
);
233 IN EFI_MMC_HOST_PROTOCOL
*This
,
245 RetVal
= EFI_SUCCESS
;
247 // Read data from the RX FIFO
249 Finish
= MMCI0_BLOCKLEN
/ 4;
251 // Read the Status flags
252 Status
= MmioRead32 (MCI_STATUS_REG
);
254 // Do eight reads if possible else a single read
255 if (Status
& MCI_STATUS_CMD_RXFIFOHALFFULL
) {
256 Buffer
[Loop
] = MmioRead32(MCI_FIFO_REG
);
258 Buffer
[Loop
] = MmioRead32(MCI_FIFO_REG
);
260 Buffer
[Loop
] = MmioRead32(MCI_FIFO_REG
);
262 Buffer
[Loop
] = MmioRead32(MCI_FIFO_REG
);
264 Buffer
[Loop
] = MmioRead32(MCI_FIFO_REG
);
266 Buffer
[Loop
] = MmioRead32(MCI_FIFO_REG
);
268 Buffer
[Loop
] = MmioRead32(MCI_FIFO_REG
);
270 Buffer
[Loop
] = MmioRead32(MCI_FIFO_REG
);
272 } else if (Status
& MCI_STATUS_CMD_RXDATAAVAILBL
) {
273 Buffer
[Loop
] = MmioRead32(MCI_FIFO_REG
);
276 //Check for error conditions and timeouts
277 if (Status
& MCI_STATUS_CMD_DATATIMEOUT
) {
278 DEBUG ((EFI_D_ERROR
, "MciReadBlockData(): TIMEOUT! Response:0x%X Status:0x%x\n", MmioRead32 (MCI_RESPONSE0_REG
), Status
));
279 RetVal
= EFI_TIMEOUT
;
281 } else if (Status
& MCI_STATUS_CMD_DATACRCFAIL
) {
282 DEBUG ((EFI_D_ERROR
, "MciReadBlockData(): CRC Error! Response:0x%X Status:0x%x\n", MmioRead32 (MCI_RESPONSE0_REG
), Status
));
283 RetVal
= EFI_CRC_ERROR
;
285 } else if (Status
& MCI_STATUS_CMD_START_BIT_ERROR
) {
286 DEBUG ((EFI_D_ERROR
, "MciReadBlockData(): Start-bit Error! Response:0x%X Status:0x%x\n", MmioRead32 (MCI_RESPONSE0_REG
), Status
));
287 RetVal
= EFI_NO_RESPONSE
;
291 //clear RX over run flag
292 if(Status
& MCI_STATUS_CMD_RXOVERRUN
) {
293 MmioWrite32(MCI_CLEAR_STATUS_REG
, MCI_STATUS_CMD_RXOVERRUN
);
295 } while ((Loop
< Finish
));
297 // Clear Status flags
298 MmioWrite32 (MCI_CLEAR_STATUS_REG
, MCI_CLR_ALL_STATUS
);
301 DataCtrlReg
= MmioRead32 (MCI_DATA_CTL_REG
);
302 MmioWrite32 (MCI_DATA_CTL_REG
, (DataCtrlReg
& MCI_DATACTL_DISABLE_MASK
));
309 IN EFI_MMC_HOST_PROTOCOL
*This
,
322 RetVal
= EFI_SUCCESS
;
324 // Write the data to the TX FIFO
326 Finish
= MMCI0_BLOCKLEN
/ 4;
327 Timer
= MMCI0_TIMEOUT
* 100;
329 // Read the Status flags
330 Status
= MmioRead32 (MCI_STATUS_REG
);
332 // Do eight writes if possible else a single write
333 if (Status
& MCI_STATUS_CMD_TXFIFOHALFEMPTY
) {
334 MmioWrite32(MCI_FIFO_REG
, Buffer
[Loop
]);
336 MmioWrite32(MCI_FIFO_REG
, Buffer
[Loop
]);
338 MmioWrite32(MCI_FIFO_REG
, Buffer
[Loop
]);
340 MmioWrite32(MCI_FIFO_REG
, Buffer
[Loop
]);
342 MmioWrite32(MCI_FIFO_REG
, Buffer
[Loop
]);
344 MmioWrite32(MCI_FIFO_REG
, Buffer
[Loop
]);
346 MmioWrite32(MCI_FIFO_REG
, Buffer
[Loop
]);
348 MmioWrite32(MCI_FIFO_REG
, Buffer
[Loop
]);
350 } else if ((Status
& MCI_STATUS_CMD_TXFIFOEMPTY
)) {
351 MmioWrite32(MCI_FIFO_REG
, Buffer
[Loop
]);
354 // Check for error conditions and timeouts
355 if (Status
& MCI_STATUS_CMD_DATATIMEOUT
) {
356 DEBUG ((EFI_D_ERROR
, "MciWriteBlockData(): TIMEOUT! Response:0x%X Status:0x%x\n", MmioRead32 (MCI_RESPONSE0_REG
), Status
));
357 RetVal
= EFI_TIMEOUT
;
359 } else if (Status
& MCI_STATUS_CMD_DATACRCFAIL
) {
360 DEBUG ((EFI_D_ERROR
, "MciWriteBlockData(): CRC Error! Response:0x%X Status:0x%x\n", MmioRead32 (MCI_RESPONSE0_REG
), Status
));
361 RetVal
= EFI_CRC_ERROR
;
363 } else if (Status
& MCI_STATUS_CMD_TX_UNDERRUN
) {
364 DEBUG ((EFI_D_ERROR
, "MciWriteBlockData(): TX buffer Underrun! Response:0x%X Status:0x%x, Number of bytes written 0x%x\n",MmioRead32(MCI_RESPONSE0_REG
),Status
, Loop
));
365 RetVal
= EFI_BUFFER_TOO_SMALL
;
370 } while (Loop
< Finish
);
372 // Wait for FIFO to drain
373 Timer
= MMCI0_TIMEOUT
* 60;
374 Status
= MmioRead32 (MCI_STATUS_REG
);
377 while (((Status
& MCI_STATUS_TXDONE
) != MCI_STATUS_TXDONE
) && Timer
) {
380 while (((Status
& MCI_STATUS_CMD_DATAEND
) != MCI_STATUS_CMD_DATAEND
) && Timer
) {
383 Status
= MmioRead32 (MCI_STATUS_REG
);
388 DEBUG ((EFI_D_ERROR
, "MciWriteBlockData(): Data End timeout Number of bytes written 0x%x\n",Loop
));
393 // Clear Status flags
394 MmioWrite32 (MCI_CLEAR_STATUS_REG
, MCI_CLR_ALL_STATUS
);
396 RetVal
= EFI_TIMEOUT
;
401 DataCtrlReg
= MmioRead32 (MCI_DATA_CTL_REG
);
402 MmioWrite32 (MCI_DATA_CTL_REG
, (DataCtrlReg
& MCI_DATACTL_DISABLE_MASK
));
408 IN EFI_MMC_HOST_PROTOCOL
*This
,
415 case MmcInvalidState
:
418 case MmcHwInitializationState
:
419 // If device already turn on then restart it
420 Data32
= MmioRead32 (MCI_POWER_CONTROL_REG
);
421 if ((Data32
& 0x2) == MCI_POWER_UP
) {
422 MCI_TRACE ("MciNotifyState(MmcHwInitializationState): TurnOff MCI");
425 MmioWrite32 (MCI_CLOCK_CONTROL_REG
, 0);
426 MmioWrite32 (MCI_POWER_CONTROL_REG
, 0);
427 MicroSecondDelay (100);
430 MCI_TRACE ("MciNotifyState(MmcHwInitializationState): TurnOn MCI");
432 // - 0x1D = 29 => should be the clock divider to be less than 400kHz at MCLK = 24Mhz
433 MmioWrite32 (MCI_CLOCK_CONTROL_REG
, 0x1D | MCI_CLOCK_ENABLE
| MCI_CLOCK_POWERSAVE
);
434 //MmioWrite32(MCI_CLOCK_CONTROL_REG,0x1D | MCI_CLOCK_ENABLE);
437 MmioWrite32 (MCI_POWER_CONTROL_REG
, MCI_POWER_OPENDRAIN
| (15<<2));
438 MmioWrite32 (MCI_POWER_CONTROL_REG
, MCI_POWER_ROD
| MCI_POWER_OPENDRAIN
| (15<<2) | MCI_POWER_UP
);
439 MicroSecondDelay (10);
440 MmioWrite32 (MCI_POWER_CONTROL_REG
, MCI_POWER_ROD
| MCI_POWER_OPENDRAIN
| (15<<2) | MCI_POWER_ON
);
441 MicroSecondDelay (100);
443 // Set Data Length & Data Timer
444 MmioWrite32 (MCI_DATA_TIMER_REG
, 0xFFFFF);
445 MmioWrite32 (MCI_DATA_LENGTH_REG
, 8);
447 ASSERT ((MmioRead32 (MCI_POWER_CONTROL_REG
) & 0x3) == MCI_POWER_ON
);
450 MCI_TRACE ("MciNotifyState(MmcIdleState)");
453 MCI_TRACE ("MciNotifyState(MmcReadyState)");
455 case MmcIdentificationState
:
456 MCI_TRACE ("MciNotifyState (MmcIdentificationState)");
458 case MmcStandByState
:{
459 volatile UINT32 PwrCtrlReg
;
460 MCI_TRACE ("MciNotifyState (MmcStandByState)");
462 // Enable MCICMD push-pull drive
463 PwrCtrlReg
= MmioRead32 (MCI_POWER_CONTROL_REG
);
464 //Disable Open Drain output
465 PwrCtrlReg
&= ~ (MCI_POWER_OPENDRAIN
);
466 MmioWrite32 (MCI_POWER_CONTROL_REG
, PwrCtrlReg
);
468 // Set MMCI0 clock to 4MHz (24MHz may be possible with cache enabled)
470 // Note: Increasing clock speed causes TX FIFO under-run errors.
471 // So careful when optimising this driver for higher performance.
473 MmioWrite32(MCI_CLOCK_CONTROL_REG
,0x02 | MCI_CLOCK_ENABLE
| MCI_CLOCK_POWERSAVE
);
474 // Set MMCI0 clock to 24MHz (by bypassing the divider)
475 //MmioWrite32(MCI_CLOCK_CONTROL_REG,MCI_CLOCK_BYPASS | MCI_CLOCK_ENABLE);
478 case MmcTransferState
:
479 //MCI_TRACE ("MciNotifyState(MmcTransferState)");
481 case MmcSendingDataState
:
482 MCI_TRACE ("MciNotifyState(MmcSendingDataState)");
484 case MmcReceiveDataState
:
485 MCI_TRACE ("MciNotifyState(MmcReceiveDataState)");
487 case MmcProgrammingState
:
488 MCI_TRACE ("MciNotifyState(MmcProgrammingState)");
490 case MmcDisconnectState
:
491 MCI_TRACE ("MciNotifyState(MmcDisconnectState)");
499 EFI_GUID mPL180MciDevicePathGuid
= EFI_CALLER_ID_GUID
;
503 IN EFI_MMC_HOST_PROTOCOL
*This
,
504 IN EFI_DEVICE_PATH_PROTOCOL
**DevicePath
507 EFI_DEVICE_PATH_PROTOCOL
*NewDevicePathNode
;
509 NewDevicePathNode
= CreateDeviceNode (HARDWARE_DEVICE_PATH
, HW_VENDOR_DP
, sizeof (VENDOR_DEVICE_PATH
));
510 CopyGuid (& ((VENDOR_DEVICE_PATH
*)NewDevicePathNode
)->Guid
, &mPL180MciDevicePathGuid
);
512 *DevicePath
= NewDevicePathNode
;
516 EFI_MMC_HOST_PROTOCOL gMciHost
= {
517 MMC_HOST_PROTOCOL_REVISION
,
529 PL180MciDxeInitialize (
530 IN EFI_HANDLE ImageHandle
,
531 IN EFI_SYSTEM_TABLE
*SystemTable
539 MCI_TRACE ("PL180MciDxeInitialize()");
541 //Publish Component Name, BlockIO protocol interfaces
542 Status
= gBS
->InstallMultipleProtocolInterfaces (
544 &gEfiMmcHostProtocolGuid
, &gMciHost
,
547 ASSERT_EFI_ERROR (Status
);