EmbeddedPkg/Universal/MmcDxe/MmcIdentification.c

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