MmcIdentification.c 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840
  1. /** @file
  2. *
  3. * Copyright (c) 2011-2015, ARM Limited. All rights reserved.
  4. *
  5. * SPDX-License-Identifier: BSD-2-Clause-Patent
  6. *
  7. **/
  8. #include <Library/BaseMemoryLib.h>
  9. #include <Library/MemoryAllocationLib.h>
  10. #include <Library/TimerLib.h>
  11. #include "Mmc.h"
  12. typedef union {
  13. UINT32 Raw;
  14. OCR Ocr;
  15. } OCR_RESPONSE;
  16. #define MAX_RETRY_COUNT 1000
  17. #define CMD_RETRY_COUNT 20
  18. #define RCA_SHIFT_OFFSET 16
  19. #define EMMC_CARD_SIZE 512
  20. #define EMMC_ECSD_SIZE_OFFSET 53
  21. #define EXTCSD_BUS_WIDTH 183
  22. #define EXTCSD_HS_TIMING 185
  23. #define EMMC_TIMING_BACKWARD 0
  24. #define EMMC_TIMING_HS 1
  25. #define EMMC_TIMING_HS200 2
  26. #define EMMC_TIMING_HS400 3
  27. #define EMMC_BUS_WIDTH_1BIT 0
  28. #define EMMC_BUS_WIDTH_4BIT 1
  29. #define EMMC_BUS_WIDTH_8BIT 2
  30. #define EMMC_BUS_WIDTH_DDR_4BIT 5
  31. #define EMMC_BUS_WIDTH_DDR_8BIT 6
  32. #define EMMC_SWITCH_ERROR (1 << 7)
  33. #define SD_BUS_WIDTH_1BIT (1 << 0)
  34. #define SD_BUS_WIDTH_4BIT (1 << 2)
  35. #define SD_CCC_SWITCH (1 << 10)
  36. #define DEVICE_STATE(x) (((x) >> 9) & 0xf)
  37. typedef enum _EMMC_DEVICE_STATE {
  38. EMMC_IDLE_STATE = 0,
  39. EMMC_READY_STATE,
  40. EMMC_IDENT_STATE,
  41. EMMC_STBY_STATE,
  42. EMMC_TRAN_STATE,
  43. EMMC_DATA_STATE,
  44. EMMC_RCV_STATE,
  45. EMMC_PRG_STATE,
  46. EMMC_DIS_STATE,
  47. EMMC_BTST_STATE,
  48. EMMC_SLP_STATE
  49. } EMMC_DEVICE_STATE;
  50. UINT32 mEmmcRcaCount = 0;
  51. STATIC
  52. EFI_STATUS
  53. EFIAPI
  54. EmmcGetDeviceState (
  55. IN MMC_HOST_INSTANCE *MmcHostInstance,
  56. OUT EMMC_DEVICE_STATE *State
  57. )
  58. {
  59. EFI_MMC_HOST_PROTOCOL *Host;
  60. EFI_STATUS Status;
  61. UINT32 Data, RCA;
  62. if (State == NULL) {
  63. return EFI_INVALID_PARAMETER;
  64. }
  65. Host = MmcHostInstance->MmcHost;
  66. RCA = MmcHostInstance->CardInfo.RCA << RCA_SHIFT_OFFSET;
  67. Status = Host->SendCommand (Host, MMC_CMD13, RCA);
  68. if (EFI_ERROR (Status)) {
  69. DEBUG ((DEBUG_ERROR, "EmmcGetDeviceState(): Failed to get card status, Status=%r.\n", Status));
  70. return Status;
  71. }
  72. Status = Host->ReceiveResponse (Host, MMC_RESPONSE_TYPE_R1, &Data);
  73. if (EFI_ERROR (Status)) {
  74. DEBUG ((DEBUG_ERROR, "EmmcGetDeviceState(): Failed to get response of CMD13, Status=%r.\n", Status));
  75. return Status;
  76. }
  77. if (Data & EMMC_SWITCH_ERROR) {
  78. DEBUG ((DEBUG_ERROR, "EmmcGetDeviceState(): Failed to switch expected mode, Status=%r.\n", Status));
  79. return EFI_DEVICE_ERROR;
  80. }
  81. *State = DEVICE_STATE (Data);
  82. return EFI_SUCCESS;
  83. }
  84. STATIC
  85. EFI_STATUS
  86. EFIAPI
  87. EmmcSetEXTCSD (
  88. IN MMC_HOST_INSTANCE *MmcHostInstance,
  89. UINT32 ExtCmdIndex,
  90. UINT32 Value
  91. )
  92. {
  93. EFI_MMC_HOST_PROTOCOL *Host;
  94. EMMC_DEVICE_STATE State;
  95. EFI_STATUS Status;
  96. UINT32 Argument;
  97. Host = MmcHostInstance->MmcHost;
  98. Argument = EMMC_CMD6_ARG_ACCESS (3) | EMMC_CMD6_ARG_INDEX (ExtCmdIndex) |
  99. EMMC_CMD6_ARG_VALUE (Value) | EMMC_CMD6_ARG_CMD_SET (1);
  100. Status = Host->SendCommand (Host, MMC_CMD6, Argument);
  101. if (EFI_ERROR (Status)) {
  102. DEBUG ((DEBUG_ERROR, "EmmcSetEXTCSD(): Failed to send CMD6, Status=%r.\n", Status));
  103. return Status;
  104. }
  105. // Make sure device exiting prog mode
  106. do {
  107. Status = EmmcGetDeviceState (MmcHostInstance, &State);
  108. if (EFI_ERROR (Status)) {
  109. DEBUG ((DEBUG_ERROR, "EmmcSetEXTCSD(): Failed to get device state, Status=%r.\n", Status));
  110. return Status;
  111. }
  112. } while (State == EMMC_PRG_STATE);
  113. return EFI_SUCCESS;
  114. }
  115. STATIC
  116. EFI_STATUS
  117. EFIAPI
  118. EmmcIdentificationMode (
  119. IN MMC_HOST_INSTANCE *MmcHostInstance,
  120. IN OCR_RESPONSE Response
  121. )
  122. {
  123. EFI_MMC_HOST_PROTOCOL *Host;
  124. EFI_BLOCK_IO_MEDIA *Media;
  125. EFI_STATUS Status;
  126. EMMC_DEVICE_STATE State;
  127. UINT32 RCA;
  128. Host = MmcHostInstance->MmcHost;
  129. Media = MmcHostInstance->BlockIo.Media;
  130. // Fetch card identity register
  131. Status = Host->SendCommand (Host, MMC_CMD2, 0);
  132. if (EFI_ERROR (Status)) {
  133. DEBUG ((DEBUG_ERROR, "EmmcIdentificationMode(): Failed to send CMD2, Status=%r.\n", Status));
  134. return Status;
  135. }
  136. Status = Host->ReceiveResponse (Host, MMC_RESPONSE_TYPE_R2, (UINT32 *)&(MmcHostInstance->CardInfo.CIDData));
  137. if (EFI_ERROR (Status)) {
  138. DEBUG ((DEBUG_ERROR, "EmmcIdentificationMode(): CID retrieval error, Status=%r.\n", Status));
  139. return Status;
  140. }
  141. // Assign a relative address value to the card
  142. MmcHostInstance->CardInfo.RCA = ++mEmmcRcaCount; // TODO: might need a more sophisticated way of doing this
  143. RCA = MmcHostInstance->CardInfo.RCA << RCA_SHIFT_OFFSET;
  144. Status = Host->SendCommand (Host, MMC_CMD3, RCA);
  145. if (EFI_ERROR (Status)) {
  146. DEBUG ((DEBUG_ERROR, "EmmcIdentificationMode(): RCA set error, Status=%r.\n", Status));
  147. return Status;
  148. }
  149. // Fetch card specific data
  150. Status = Host->SendCommand (Host, MMC_CMD9, RCA);
  151. if (EFI_ERROR (Status)) {
  152. DEBUG ((DEBUG_ERROR, "EmmcIdentificationMode(): Failed to send CMD9, Status=%r.\n", Status));
  153. return Status;
  154. }
  155. Status = Host->ReceiveResponse (Host, MMC_RESPONSE_TYPE_R2, (UINT32 *)&(MmcHostInstance->CardInfo.CSDData));
  156. if (EFI_ERROR (Status)) {
  157. DEBUG ((DEBUG_ERROR, "EmmcIdentificationMode(): CSD retrieval error, Status=%r.\n", Status));
  158. return Status;
  159. }
  160. // Select the card
  161. Status = Host->SendCommand (Host, MMC_CMD7, RCA);
  162. if (EFI_ERROR (Status)) {
  163. DEBUG ((DEBUG_ERROR, "EmmcIdentificationMode(): Card selection error, Status=%r.\n", Status));
  164. }
  165. if (MMC_HOST_HAS_SETIOS (Host)) {
  166. // Set 1-bit bus width
  167. Status = Host->SetIos (Host, 0, 1, EMMCBACKWARD);
  168. if (EFI_ERROR (Status)) {
  169. DEBUG ((DEBUG_ERROR, "EmmcIdentificationMode(): Set 1-bit bus width error, Status=%r.\n", Status));
  170. return Status;
  171. }
  172. // Set 1-bit bus width for EXTCSD
  173. Status = EmmcSetEXTCSD (MmcHostInstance, EXTCSD_BUS_WIDTH, EMMC_BUS_WIDTH_1BIT);
  174. if (EFI_ERROR (Status)) {
  175. DEBUG ((DEBUG_ERROR, "EmmcIdentificationMode(): Set extcsd bus width error, Status=%r.\n", Status));
  176. return Status;
  177. }
  178. }
  179. // Fetch ECSD
  180. MmcHostInstance->CardInfo.ECSDData = AllocatePages (EFI_SIZE_TO_PAGES (sizeof (ECSD)));
  181. if (MmcHostInstance->CardInfo.ECSDData == NULL) {
  182. return EFI_OUT_OF_RESOURCES;
  183. }
  184. Status = Host->SendCommand (Host, MMC_CMD8, 0);
  185. if (EFI_ERROR (Status)) {
  186. DEBUG ((DEBUG_ERROR, "EmmcIdentificationMode(): ECSD fetch error, Status=%r.\n", Status));
  187. }
  188. Status = Host->ReadBlockData (Host, 0, 512, (UINT32 *)MmcHostInstance->CardInfo.ECSDData);
  189. if (EFI_ERROR (Status)) {
  190. DEBUG ((DEBUG_ERROR, "EmmcIdentificationMode(): ECSD read error, Status=%r.\n", Status));
  191. goto FreePageExit;
  192. }
  193. // Make sure device exiting data mode
  194. do {
  195. Status = EmmcGetDeviceState (MmcHostInstance, &State);
  196. if (EFI_ERROR (Status)) {
  197. DEBUG ((DEBUG_ERROR, "EmmcIdentificationMode(): Failed to get device state, Status=%r.\n", Status));
  198. goto FreePageExit;
  199. }
  200. } while (State == EMMC_DATA_STATE);
  201. // Set up media
  202. Media->BlockSize = EMMC_CARD_SIZE; // 512-byte support is mandatory for eMMC cards
  203. Media->MediaId = MmcHostInstance->CardInfo.CIDData.PSN;
  204. Media->ReadOnly = MmcHostInstance->CardInfo.CSDData.PERM_WRITE_PROTECT;
  205. Media->LogicalBlocksPerPhysicalBlock = 1;
  206. Media->IoAlign = 4;
  207. // Compute last block using bits [215:212] of the ECSD
  208. Media->LastBlock = MmcHostInstance->CardInfo.ECSDData->SECTOR_COUNT - 1; // eMMC isn't supposed to report this for
  209. // Cards <2GB in size, but the model does.
  210. // Setup card type
  211. MmcHostInstance->CardInfo.CardType = EMMC_CARD;
  212. return EFI_SUCCESS;
  213. FreePageExit:
  214. FreePages (MmcHostInstance->CardInfo.ECSDData, EFI_SIZE_TO_PAGES (sizeof (ECSD)));
  215. return Status;
  216. }
  217. STATIC
  218. EFI_STATUS
  219. InitializeEmmcDevice (
  220. IN MMC_HOST_INSTANCE *MmcHostInstance
  221. )
  222. {
  223. EFI_MMC_HOST_PROTOCOL *Host;
  224. EFI_STATUS Status = EFI_SUCCESS;
  225. ECSD *ECSDData;
  226. UINT32 BusClockFreq, Idx, BusMode;
  227. UINT32 TimingMode[4] = { EMMCHS52DDR1V2, EMMCHS52DDR1V8, EMMCHS52, EMMCHS26 };
  228. Host = MmcHostInstance->MmcHost;
  229. ECSDData = MmcHostInstance->CardInfo.ECSDData;
  230. if (ECSDData->DEVICE_TYPE == EMMCBACKWARD) {
  231. return EFI_SUCCESS;
  232. }
  233. if (!MMC_HOST_HAS_SETIOS (Host)) {
  234. return EFI_SUCCESS;
  235. }
  236. Status = EmmcSetEXTCSD (MmcHostInstance, EXTCSD_HS_TIMING, EMMC_TIMING_HS);
  237. if (EFI_ERROR (Status)) {
  238. DEBUG ((DEBUG_ERROR, "InitializeEmmcDevice(): Failed to switch high speed mode, Status:%r.\n", Status));
  239. return Status;
  240. }
  241. for (Idx = 0; Idx < 4; Idx++) {
  242. switch (TimingMode[Idx]) {
  243. case EMMCHS52DDR1V2:
  244. case EMMCHS52DDR1V8:
  245. case EMMCHS52:
  246. BusClockFreq = 52000000;
  247. break;
  248. case EMMCHS26:
  249. BusClockFreq = 26000000;
  250. break;
  251. default:
  252. return EFI_UNSUPPORTED;
  253. }
  254. Status = Host->SetIos (Host, BusClockFreq, 8, TimingMode[Idx]);
  255. if (!EFI_ERROR (Status)) {
  256. switch (TimingMode[Idx]) {
  257. case EMMCHS52DDR1V2:
  258. case EMMCHS52DDR1V8:
  259. BusMode = EMMC_BUS_WIDTH_DDR_8BIT;
  260. break;
  261. case EMMCHS52:
  262. case EMMCHS26:
  263. BusMode = EMMC_BUS_WIDTH_8BIT;
  264. break;
  265. default:
  266. return EFI_UNSUPPORTED;
  267. }
  268. Status = EmmcSetEXTCSD (MmcHostInstance, EXTCSD_BUS_WIDTH, BusMode);
  269. if (EFI_ERROR (Status)) {
  270. DEBUG ((DEBUG_ERROR, "InitializeEmmcDevice(): Failed to set EXTCSD bus width, Status:%r\n", Status));
  271. }
  272. return Status;
  273. }
  274. }
  275. return Status;
  276. }
  277. STATIC
  278. UINT32
  279. CreateSwitchCmdArgument (
  280. IN UINT32 Mode,
  281. IN UINT8 Group,
  282. IN UINT8 Value
  283. )
  284. {
  285. UINT32 Argument;
  286. Argument = Mode << 31 | 0x00FFFFFF;
  287. Argument &= ~(0xF << (Group * 4));
  288. Argument |= Value << (Group * 4);
  289. return Argument;
  290. }
  291. STATIC
  292. EFI_STATUS
  293. InitializeSdMmcDevice (
  294. IN MMC_HOST_INSTANCE *MmcHostInstance
  295. )
  296. {
  297. UINT32 CmdArg;
  298. UINT32 Response[4];
  299. UINT32 Buffer[128];
  300. UINT32 Speed;
  301. UINTN BlockSize;
  302. UINTN CardSize;
  303. UINTN NumBlocks;
  304. BOOLEAN CccSwitch;
  305. SCR Scr;
  306. EFI_STATUS Status;
  307. EFI_MMC_HOST_PROTOCOL *MmcHost;
  308. Speed = SD_DEFAULT_SPEED;
  309. MmcHost = MmcHostInstance->MmcHost;
  310. // Send a command to get Card specific data
  311. CmdArg = MmcHostInstance->CardInfo.RCA << 16;
  312. Status = MmcHost->SendCommand (MmcHost, MMC_CMD9, CmdArg);
  313. if (EFI_ERROR (Status)) {
  314. DEBUG ((DEBUG_ERROR, "InitializeSdMmcDevice(MMC_CMD9): Error, Status=%r\n", Status));
  315. return Status;
  316. }
  317. // Read Response
  318. Status = MmcHost->ReceiveResponse (MmcHost, MMC_RESPONSE_TYPE_CSD, Response);
  319. if (EFI_ERROR (Status)) {
  320. DEBUG ((DEBUG_ERROR, "InitializeSdMmcDevice(): Failed to receive CSD, Status=%r\n", Status));
  321. return Status;
  322. }
  323. PrintCSD (Response);
  324. if (MMC_CSD_GET_CCC (Response) & SD_CCC_SWITCH) {
  325. CccSwitch = TRUE;
  326. } else {
  327. CccSwitch = FALSE;
  328. }
  329. if (MmcHostInstance->CardInfo.CardType == SD_CARD_2_HIGH) {
  330. CardSize = HC_MMC_CSD_GET_DEVICESIZE (Response);
  331. NumBlocks = ((CardSize + 1) * 1024);
  332. BlockSize = 1 << MMC_CSD_GET_READBLLEN (Response);
  333. } else {
  334. CardSize = MMC_CSD_GET_DEVICESIZE (Response);
  335. NumBlocks = (CardSize + 1) * (1 << (MMC_CSD_GET_DEVICESIZEMULT (Response) + 2));
  336. BlockSize = 1 << MMC_CSD_GET_READBLLEN (Response);
  337. }
  338. // For >=2G card, BlockSize may be 1K, but the transfer size is 512 bytes.
  339. if (BlockSize > 512) {
  340. NumBlocks = MultU64x32 (NumBlocks, BlockSize / 512);
  341. BlockSize = 512;
  342. }
  343. MmcHostInstance->BlockIo.Media->LastBlock = (NumBlocks - 1);
  344. MmcHostInstance->BlockIo.Media->BlockSize = BlockSize;
  345. MmcHostInstance->BlockIo.Media->ReadOnly = MmcHost->IsReadOnly (MmcHost);
  346. MmcHostInstance->BlockIo.Media->MediaPresent = TRUE;
  347. MmcHostInstance->BlockIo.Media->MediaId++;
  348. CmdArg = MmcHostInstance->CardInfo.RCA << 16;
  349. Status = MmcHost->SendCommand (MmcHost, MMC_CMD7, CmdArg);
  350. if (EFI_ERROR (Status)) {
  351. DEBUG ((DEBUG_ERROR, "InitializeSdMmcDevice(MMC_CMD7): Error and Status = %r\n", Status));
  352. return Status;
  353. }
  354. Status = MmcHost->SendCommand (MmcHost, MMC_CMD55, CmdArg);
  355. if (EFI_ERROR (Status)) {
  356. DEBUG ((DEBUG_ERROR, "%a (MMC_CMD55): Error and Status = %r\n", __FUNCTION__, Status));
  357. return Status;
  358. }
  359. Status = MmcHost->ReceiveResponse (MmcHost, MMC_RESPONSE_TYPE_R1, Response);
  360. if (EFI_ERROR (Status)) {
  361. DEBUG ((DEBUG_ERROR, "%a (MMC_CMD55): Error and Status = %r\n", __FUNCTION__, Status));
  362. return Status;
  363. }
  364. if ((Response[0] & MMC_STATUS_APP_CMD) == 0) {
  365. return EFI_SUCCESS;
  366. }
  367. /* SCR */
  368. Status = MmcHost->SendCommand (MmcHost, MMC_ACMD51, 0);
  369. if (EFI_ERROR (Status)) {
  370. DEBUG ((DEBUG_ERROR, "%a(MMC_ACMD51): Error and Status = %r\n", __func__, Status));
  371. return Status;
  372. } else {
  373. Status = MmcHost->ReadBlockData (MmcHost, 0, 8, Buffer);
  374. if (EFI_ERROR (Status)) {
  375. DEBUG ((DEBUG_ERROR, "%a(MMC_ACMD51): ReadBlockData Error and Status = %r\n", __func__, Status));
  376. return Status;
  377. }
  378. CopyMem (&Scr, Buffer, 8);
  379. if (Scr.SD_SPEC == 2) {
  380. if (Scr.SD_SPEC3 == 1) {
  381. if (Scr.SD_SPEC4 == 1) {
  382. DEBUG ((DEBUG_INFO, "Found SD Card for Spec Version 4.xx\n"));
  383. } else {
  384. DEBUG ((DEBUG_INFO, "Found SD Card for Spec Version 3.0x\n"));
  385. }
  386. } else {
  387. if (Scr.SD_SPEC4 == 0) {
  388. DEBUG ((DEBUG_INFO, "Found SD Card for Spec Version 2.0\n"));
  389. } else {
  390. DEBUG ((DEBUG_ERROR, "Found invalid SD Card\n"));
  391. }
  392. }
  393. } else {
  394. if ((Scr.SD_SPEC3 == 0) && (Scr.SD_SPEC4 == 0)) {
  395. if (Scr.SD_SPEC == 1) {
  396. DEBUG ((DEBUG_INFO, "Found SD Card for Spec Version 1.10\n"));
  397. } else {
  398. DEBUG ((DEBUG_INFO, "Found SD Card for Spec Version 1.0\n"));
  399. }
  400. } else {
  401. DEBUG ((DEBUG_ERROR, "Found invalid SD Card\n"));
  402. }
  403. }
  404. }
  405. if (CccSwitch) {
  406. /* SD Switch, Mode:0, Group:0, Value:0 */
  407. CmdArg = CreateSwitchCmdArgument (0, 0, 0);
  408. Status = MmcHost->SendCommand (MmcHost, SD_CMD6, CmdArg);
  409. if (EFI_ERROR (Status)) {
  410. DEBUG ((DEBUG_ERROR, "%a (MMC_CMD6): Error and Status = %r\n", __FUNCTION__, Status));
  411. return Status;
  412. } else {
  413. Status = MmcHost->ReadBlockData (MmcHost, 0, SWITCH_CMD_DATA_LENGTH, Buffer);
  414. if (EFI_ERROR (Status)) {
  415. DEBUG ((DEBUG_ERROR, "%a (SD_CMD6): ReadBlockData Error and Status = %r\n", __FUNCTION__, Status));
  416. return Status;
  417. }
  418. }
  419. if (!(__be32_to_cpu(Buffer[3]) & SD_HIGH_SPEED_SUPPORTED)) { /* todo fixme bigendian cpu is no op */
  420. DEBUG ((DEBUG_INFO, "%a : High Speed not supported by Card %x\n", __FUNCTION__, Buffer[3]));
  421. } else {
  422. Speed = SD_HIGH_SPEED;
  423. /* SD Switch, Mode:1, Group:0, Value:1 */
  424. CmdArg = CreateSwitchCmdArgument (1, 0, 1);
  425. Status = MmcHost->SendCommand (MmcHost, SD_CMD6, CmdArg);
  426. if (EFI_ERROR (Status)) {
  427. DEBUG ((DEBUG_ERROR, "%a (SD_CMD6): Error and Status = %r\n", __FUNCTION__, Status));
  428. return Status;
  429. } else {
  430. Status = MmcHost->ReadBlockData (MmcHost, 0, SWITCH_CMD_DATA_LENGTH, Buffer);
  431. if (EFI_ERROR (Status)) {
  432. DEBUG ((DEBUG_ERROR, "%a (SD_CMD6): ReadBlockData Error and Status = %r\n", __FUNCTION__, Status));
  433. return Status;
  434. }
  435. if ((__be32_to_cpu(Buffer[4]) & SWITCH_CMD_SUCCESS_MASK) != 0x01000000) {
  436. DEBUG ((DEBUG_ERROR, "Problem switching SD card into high-speed mode\n"));
  437. return Status;
  438. }
  439. }
  440. }
  441. }
  442. if (Scr.SD_BUS_WIDTHS & SD_BUS_WIDTH_4BIT) {
  443. CmdArg = MmcHostInstance->CardInfo.RCA << 16;
  444. Status = MmcHost->SendCommand (MmcHost, MMC_CMD55, CmdArg);
  445. if (EFI_ERROR (Status)) {
  446. DEBUG ((DEBUG_ERROR, "%a (MMC_CMD55): Error and Status = %r\n", __FUNCTION__, Status));
  447. return Status;
  448. }
  449. /* Width: 4 */
  450. Status = MmcHost->SendCommand (MmcHost, MMC_CMD6, 2);
  451. if (EFI_ERROR (Status)) {
  452. DEBUG ((DEBUG_ERROR, "%a (MMC_CMD6): Error and Status = %r\n", __FUNCTION__, Status));
  453. return Status;
  454. }
  455. }
  456. if (MMC_HOST_HAS_SETIOS (MmcHost)) {
  457. Status = MmcHost->SetIos (MmcHost, Speed, BUSWIDTH_4, EMMCBACKWARD);
  458. if (EFI_ERROR (Status)) {
  459. DEBUG ((DEBUG_ERROR, "%a (SetIos): Error and Status = %r\n", __FUNCTION__, Status));
  460. return Status;
  461. }
  462. }
  463. return EFI_SUCCESS;
  464. }
  465. STATIC
  466. EFI_STATUS
  467. EFIAPI
  468. MmcIdentificationMode (
  469. IN MMC_HOST_INSTANCE *MmcHostInstance
  470. )
  471. {
  472. EFI_STATUS Status;
  473. UINT32 Response[4];
  474. UINTN Timeout;
  475. UINTN CmdArg;
  476. BOOLEAN IsHCS;
  477. EFI_MMC_HOST_PROTOCOL *MmcHost;
  478. OCR_RESPONSE OcrResponse;
  479. MmcHost = MmcHostInstance->MmcHost;
  480. CmdArg = 0;
  481. IsHCS = FALSE;
  482. if (MmcHost == NULL) {
  483. return EFI_INVALID_PARAMETER;
  484. }
  485. // We can get into this function if we restart the identification mode
  486. if (MmcHostInstance->State == MmcHwInitializationState) {
  487. // Initialize the MMC Host HW
  488. Status = MmcNotifyState (MmcHostInstance, MmcHwInitializationState);
  489. if (EFI_ERROR (Status)) {
  490. DEBUG ((DEBUG_ERROR, "MmcIdentificationMode() : Error MmcHwInitializationState, Status=%r.\n", Status));
  491. return Status;
  492. }
  493. }
  494. Status = MmcHost->SendCommand (MmcHost, MMC_CMD0, 0);
  495. if (EFI_ERROR (Status)) {
  496. DEBUG ((DEBUG_ERROR, "MmcIdentificationMode(MMC_CMD0): Error, Status=%r.\n", Status));
  497. return Status;
  498. }
  499. Status = MmcNotifyState (MmcHostInstance, MmcIdleState);
  500. if (EFI_ERROR (Status)) {
  501. DEBUG ((DEBUG_ERROR, "MmcIdentificationMode() : Error MmcIdleState, Status=%r.\n", Status));
  502. return Status;
  503. }
  504. // Send CMD1 to get OCR (MMC)
  505. // This command only valid for MMC and eMMC
  506. Timeout = MAX_RETRY_COUNT;
  507. do {
  508. Status = MmcHost->SendCommand (MmcHost, MMC_CMD1, EMMC_CMD1_CAPACITY_GREATER_THAN_2GB);
  509. if (EFI_ERROR (Status)) {
  510. break;
  511. }
  512. Status = MmcHost->ReceiveResponse (MmcHost, MMC_RESPONSE_TYPE_OCR, (UINT32 *)&OcrResponse);
  513. if (EFI_ERROR (Status)) {
  514. DEBUG ((DEBUG_ERROR, "MmcIdentificationMode() : Failed to receive OCR, Status=%r.\n", Status));
  515. return Status;
  516. }
  517. Timeout--;
  518. } while (!OcrResponse.Ocr.PowerUp && (Timeout > 0));
  519. if (Status == EFI_SUCCESS) {
  520. if (!OcrResponse.Ocr.PowerUp) {
  521. DEBUG ((DEBUG_ERROR, "MmcIdentificationMode(MMC_CMD1): Card initialisation failure, Status=%r.\n", Status));
  522. return EFI_DEVICE_ERROR;
  523. }
  524. OcrResponse.Ocr.PowerUp = 0;
  525. if (OcrResponse.Raw == EMMC_CMD1_CAPACITY_GREATER_THAN_2GB) {
  526. MmcHostInstance->CardInfo.OCRData.AccessMode = BIT1;
  527. } else {
  528. MmcHostInstance->CardInfo.OCRData.AccessMode = 0x0;
  529. }
  530. // Check whether MMC or eMMC
  531. if ((OcrResponse.Raw == EMMC_CMD1_CAPACITY_GREATER_THAN_2GB) ||
  532. (OcrResponse.Raw == EMMC_CMD1_CAPACITY_LESS_THAN_2GB))
  533. {
  534. return EmmcIdentificationMode (MmcHostInstance, OcrResponse);
  535. }
  536. }
  537. // Are we using SDIO ?
  538. Status = MmcHost->SendCommand (MmcHost, MMC_CMD5, 0);
  539. if (Status == EFI_SUCCESS) {
  540. DEBUG ((DEBUG_ERROR, "MmcIdentificationMode(MMC_CMD5): Error - SDIO not supported, Status=%r.\n", Status));
  541. return EFI_UNSUPPORTED;
  542. }
  543. // Check which kind of card we are using. Ver2.00 or later SD Memory Card (PL180 is SD v1.1)
  544. CmdArg = (0x0UL << 12 | BIT8 | 0xCEUL << 0);
  545. Status = MmcHost->SendCommand (MmcHost, MMC_CMD8, CmdArg);
  546. if (Status == EFI_SUCCESS) {
  547. DEBUG ((DEBUG_ERROR, "Card is SD2.0 => Supports high capacity\n"));
  548. IsHCS = TRUE;
  549. Status = MmcHost->ReceiveResponse (MmcHost, MMC_RESPONSE_TYPE_R7, Response);
  550. if (EFI_ERROR (Status)) {
  551. DEBUG ((DEBUG_ERROR, "MmcIdentificationMode() : Failed to receive response to CMD8, Status=%r.\n", Status));
  552. return Status;
  553. }
  554. PrintResponseR1 (Response[0]);
  555. // Check if it is valid response
  556. if (Response[0] != CmdArg) {
  557. DEBUG ((DEBUG_ERROR, "The Card is not usable\n"));
  558. return EFI_UNSUPPORTED;
  559. }
  560. } else {
  561. DEBUG ((DEBUG_ERROR, "Not a SD2.0 Card\n"));
  562. }
  563. // We need to wait for the MMC or SD card is ready => (gCardInfo.OCRData.PowerUp == 1)
  564. Timeout = MAX_RETRY_COUNT;
  565. while (Timeout > 0) {
  566. // SD Card or MMC Card ? CMD55 indicates to the card that the next command is an application specific command
  567. Status = MmcHost->SendCommand (MmcHost, MMC_CMD55, 0);
  568. if (Status == EFI_SUCCESS) {
  569. DEBUG ((DEBUG_INFO, "Card should be SD\n"));
  570. if (IsHCS) {
  571. MmcHostInstance->CardInfo.CardType = SD_CARD_2;
  572. } else {
  573. MmcHostInstance->CardInfo.CardType = SD_CARD;
  574. }
  575. // Note: The first time CmdArg will be zero
  576. CmdArg = ((UINTN *)&(MmcHostInstance->CardInfo.OCRData))[0];
  577. if (IsHCS) {
  578. CmdArg |= BIT30;
  579. }
  580. Status = MmcHost->SendCommand (MmcHost, MMC_ACMD41, CmdArg);
  581. if (!EFI_ERROR (Status)) {
  582. Status = MmcHost->ReceiveResponse (MmcHost, MMC_RESPONSE_TYPE_OCR, Response);
  583. if (EFI_ERROR (Status)) {
  584. DEBUG ((DEBUG_ERROR, "MmcIdentificationMode() : Failed to receive OCR, Status=%r.\n", Status));
  585. return Status;
  586. }
  587. ((UINT32 *)&(MmcHostInstance->CardInfo.OCRData))[0] = Response[0];
  588. }
  589. } else {
  590. DEBUG ((DEBUG_INFO, "Card should be MMC\n"));
  591. MmcHostInstance->CardInfo.CardType = MMC_CARD;
  592. Status = MmcHost->SendCommand (MmcHost, MMC_CMD1, 0x800000);
  593. if (!EFI_ERROR (Status)) {
  594. Status = MmcHost->ReceiveResponse (MmcHost, MMC_RESPONSE_TYPE_OCR, Response);
  595. if (EFI_ERROR (Status)) {
  596. DEBUG ((DEBUG_ERROR, "MmcIdentificationMode() : Failed to receive OCR, Status=%r.\n", Status));
  597. return Status;
  598. }
  599. ((UINT32 *)&(MmcHostInstance->CardInfo.OCRData))[0] = Response[0];
  600. }
  601. }
  602. if (!EFI_ERROR (Status)) {
  603. if (!MmcHostInstance->CardInfo.OCRData.PowerUp) {
  604. gBS->Stall (1);
  605. Timeout--;
  606. } else {
  607. if ((MmcHostInstance->CardInfo.CardType == SD_CARD_2) && (MmcHostInstance->CardInfo.OCRData.AccessMode & BIT1)) {
  608. MmcHostInstance->CardInfo.CardType = SD_CARD_2_HIGH;
  609. DEBUG ((DEBUG_ERROR, "High capacity card.\n"));
  610. }
  611. break; // The MMC/SD card is ready. Continue the Identification Mode
  612. }
  613. } else {
  614. gBS->Stall (1);
  615. Timeout--;
  616. }
  617. }
  618. if (Timeout == 0) {
  619. DEBUG ((DEBUG_ERROR, "MmcIdentificationMode(): No Card\n"));
  620. return EFI_NO_MEDIA;
  621. } else {
  622. PrintOCR (Response[0]);
  623. }
  624. Status = MmcNotifyState (MmcHostInstance, MmcReadyState);
  625. if (EFI_ERROR (Status)) {
  626. DEBUG ((DEBUG_ERROR, "MmcIdentificationMode() : Error MmcReadyState\n"));
  627. return Status;
  628. }
  629. Status = MmcHost->SendCommand (MmcHost, MMC_CMD2, 0);
  630. if (EFI_ERROR (Status)) {
  631. DEBUG ((DEBUG_ERROR, "MmcIdentificationMode(MMC_CMD2): Error\n"));
  632. return Status;
  633. }
  634. Status = MmcHost->ReceiveResponse (MmcHost, MMC_RESPONSE_TYPE_CID, Response);
  635. if (EFI_ERROR (Status)) {
  636. DEBUG ((DEBUG_ERROR, "MmcIdentificationMode() : Failed to receive CID, Status=%r.\n", Status));
  637. return Status;
  638. }
  639. PrintCID (Response);
  640. Status = MmcHost->NotifyState (MmcHost, MmcIdentificationState);
  641. if (EFI_ERROR (Status)) {
  642. DEBUG ((DEBUG_ERROR, "MmcIdentificationMode() : Error MmcIdentificationState\n"));
  643. return Status;
  644. }
  645. //
  646. // Note, SD specifications say that "if the command execution causes a state change, it
  647. // will be visible to the host in the response to the next command"
  648. // The status returned for this CMD3 will be 2 - identification
  649. //
  650. CmdArg = 1;
  651. Status = MmcHost->SendCommand (MmcHost, MMC_CMD3, CmdArg);
  652. if (EFI_ERROR (Status)) {
  653. DEBUG ((DEBUG_ERROR, "MmcIdentificationMode(MMC_CMD3): Error\n"));
  654. return Status;
  655. }
  656. Status = MmcHost->ReceiveResponse (MmcHost, MMC_RESPONSE_TYPE_RCA, Response);
  657. if (EFI_ERROR (Status)) {
  658. DEBUG ((DEBUG_ERROR, "MmcIdentificationMode() : Failed to receive RCA, Status=%r.\n", Status));
  659. return Status;
  660. }
  661. PrintRCA (Response[0]);
  662. // For MMC card, RCA is assigned by CMD3 while CMD3 dumps the RCA for SD card
  663. if (MmcHostInstance->CardInfo.CardType != MMC_CARD) {
  664. MmcHostInstance->CardInfo.RCA = Response[0] >> 16;
  665. } else {
  666. MmcHostInstance->CardInfo.RCA = CmdArg;
  667. }
  668. Status = MmcNotifyState (MmcHostInstance, MmcStandByState);
  669. if (EFI_ERROR (Status)) {
  670. DEBUG ((DEBUG_ERROR, "MmcIdentificationMode() : Error MmcStandByState\n"));
  671. return Status;
  672. }
  673. return EFI_SUCCESS;
  674. }
  675. EFI_STATUS
  676. InitializeMmcDevice (
  677. IN MMC_HOST_INSTANCE *MmcHostInstance
  678. )
  679. {
  680. EFI_STATUS Status;
  681. EFI_MMC_HOST_PROTOCOL *MmcHost;
  682. UINTN BlockCount;
  683. BlockCount = 1;
  684. MmcHost = MmcHostInstance->MmcHost;
  685. Status = MmcIdentificationMode (MmcHostInstance);
  686. if (EFI_ERROR (Status)) {
  687. DEBUG ((DEBUG_ERROR, "InitializeMmcDevice(): Error in Identification Mode, Status=%r\n", Status));
  688. return Status;
  689. }
  690. Status = MmcNotifyState (MmcHostInstance, MmcTransferState);
  691. if (EFI_ERROR (Status)) {
  692. DEBUG ((DEBUG_ERROR, "InitializeMmcDevice(): Error MmcTransferState, Status=%r\n", Status));
  693. return Status;
  694. }
  695. if (MmcHostInstance->CardInfo.CardType != EMMC_CARD) {
  696. Status = InitializeSdMmcDevice (MmcHostInstance);
  697. } else {
  698. Status = InitializeEmmcDevice (MmcHostInstance);
  699. }
  700. if (EFI_ERROR (Status)) {
  701. return Status;
  702. }
  703. // Set Block Length
  704. Status = MmcHost->SendCommand (MmcHost, MMC_CMD16, MmcHostInstance->BlockIo.Media->BlockSize);
  705. if (EFI_ERROR (Status)) {
  706. DEBUG ((
  707. DEBUG_ERROR,
  708. "InitializeMmcDevice(MMC_CMD16): Error MmcHostInstance->BlockIo.Media->BlockSize: %d and Error = %r\n",
  709. MmcHostInstance->BlockIo.Media->BlockSize,
  710. Status
  711. ));
  712. return Status;
  713. }
  714. // Block Count (not used). Could return an error for SD card
  715. if (MmcHostInstance->CardInfo.CardType == MMC_CARD) {
  716. Status = MmcHost->SendCommand (MmcHost, MMC_CMD23, BlockCount);
  717. if (EFI_ERROR (Status)) {
  718. DEBUG ((DEBUG_ERROR, "InitializeMmcDevice(MMC_CMD23): Error, Status=%r\n", Status));
  719. return Status;
  720. }
  721. }
  722. return EFI_SUCCESS;
  723. }