MmcIdentification.c 26 KB

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