[mirror_edk2.git] / MdeModulePkg / Bus / Sd / SdDxe / SdDxe.c

/** @file\r
  The SdDxe driver is used to manage the SD memory card device.\r
\r
  It produces BlockIo and BlockIo2 protocols to allow upper layer\r
  access the SD memory card device.\r
\r
  Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "SdDxe.h"\r
\r
//\r
// SdDxe Driver Binding Protocol Instance\r
//\r
EFI_DRIVER_BINDING_PROTOCOL  gSdDxeDriverBinding = {\r
  SdDxeDriverBindingSupported,\r
  SdDxeDriverBindingStart,\r
  SdDxeDriverBindingStop,\r
  0x10,\r
  NULL,\r
  NULL\r
};\r
\r
//\r
// Template for SD_DEVICE data structure.\r
//\r
SD_DEVICE  mSdDeviceTemplate = {\r
  SD_DEVICE_SIGNATURE,         // Signature\r
  NULL,                        // Handle\r
  NULL,                        // DevicePath\r
  0xFF,                        // Slot\r
  FALSE,                       // SectorAddressing\r
  {                            // BlockIo\r
    EFI_BLOCK_IO_PROTOCOL_REVISION,\r
    NULL,\r
    SdReset,\r
    SdReadBlocks,\r
    SdWriteBlocks,\r
    SdFlushBlocks\r
  },\r
  {                            // BlockIo2\r
    NULL,\r
    SdResetEx,\r
    SdReadBlocksEx,\r
    SdWriteBlocksEx,\r
    SdFlushBlocksEx\r
  },\r
  {                            // BlockMedia\r
    0,                         // MediaId\r
    FALSE,                     // RemovableMedia\r
    TRUE,                      // MediaPresent\r
    FALSE,                     // LogicPartition\r
    FALSE,                     // ReadOnly\r
    FALSE,                     // WritingCache\r
    0x200,                     // BlockSize\r
    0,                         // IoAlign\r
    0                          // LastBlock\r
  },\r
  {                            // EraseBlock\r
    EFI_ERASE_BLOCK_PROTOCOL_REVISION,\r
    1,\r
    SdEraseBlocks\r
  },\r
  {                            // DiskInfo\r
    EFI_DISK_INFO_SD_MMC_INTERFACE_GUID,\r
    SdDiskInfoInquiry,\r
    SdDiskInfoIdentify,\r
    SdDiskInfoSenseData,\r
    SdDiskInfoWhichIde\r
  },\r
  {                            // Queue\r
    NULL,\r
    NULL\r
  },\r
  {                            // Csd\r
    0,\r
  },\r
  {                            // Cid\r
    0,\r
  },\r
  NULL,                        // ControllerNameTable\r
  {                            // ModelName\r
    0,\r
  },\r
  NULL                         // Private\r
};\r
\r
/**\r
  Decode and print SD CSD Register content.\r
\r
  @param[in] Csd           Pointer to SD_CSD data structure.\r
\r
  @retval EFI_SUCCESS      The function completed successfully\r
**/\r
EFI_STATUS\r
DumpCsd (\r
  IN SD_CSD  *Csd\r
  )\r
{\r
  SD_CSD2  *Csd2;\r
\r
  DEBUG ((DEBUG_INFO, "== Dump Sd Csd Register==\n"));\r
  DEBUG ((DEBUG_INFO, "  CSD structure                    0x%x\n", Csd->CsdStructure));\r
  DEBUG ((DEBUG_INFO, "  Data read access-time 1          0x%x\n", Csd->Taac));\r
  DEBUG ((DEBUG_INFO, "  Data read access-time 2          0x%x\n", Csd->Nsac));\r
  DEBUG ((DEBUG_INFO, "  Max. bus clock frequency         0x%x\n", Csd->TranSpeed));\r
  DEBUG ((DEBUG_INFO, "  Device command classes           0x%x\n", Csd->Ccc));\r
  DEBUG ((DEBUG_INFO, "  Max. read data block length      0x%x\n", Csd->ReadBlLen));\r
  DEBUG ((DEBUG_INFO, "  Partial blocks for read allowed  0x%x\n", Csd->ReadBlPartial));\r
  DEBUG ((DEBUG_INFO, "  Write block misalignment         0x%x\n", Csd->WriteBlkMisalign));\r
  DEBUG ((DEBUG_INFO, "  Read block misalignment          0x%x\n", Csd->ReadBlkMisalign));\r
  DEBUG ((DEBUG_INFO, "  DSR implemented                  0x%x\n", Csd->DsrImp));\r
  if (Csd->CsdStructure == 0) {\r
    DEBUG ((DEBUG_INFO, "  Device size                      0x%x\n", Csd->CSizeLow | (Csd->CSizeHigh << 2)));\r
    DEBUG ((DEBUG_INFO, "  Max. read current @ VDD min      0x%x\n", Csd->VddRCurrMin));\r
    DEBUG ((DEBUG_INFO, "  Max. read current @ VDD max      0x%x\n", Csd->VddRCurrMax));\r
    DEBUG ((DEBUG_INFO, "  Max. write current @ VDD min     0x%x\n", Csd->VddWCurrMin));\r
    DEBUG ((DEBUG_INFO, "  Max. write current @ VDD max     0x%x\n", Csd->VddWCurrMax));\r
  } else {\r
    Csd2 = (SD_CSD2 *)(VOID *)Csd;\r
    DEBUG ((DEBUG_INFO, "  Device size                      0x%x\n", Csd2->CSizeLow | (Csd->CSizeHigh << 16)));\r
  }\r
\r
  DEBUG ((DEBUG_INFO, "  Erase sector size                0x%x\n", Csd->SectorSize));\r
  DEBUG ((DEBUG_INFO, "  Erase single block enable        0x%x\n", Csd->EraseBlkEn));\r
  DEBUG ((DEBUG_INFO, "  Write protect group size         0x%x\n", Csd->WpGrpSize));\r
  DEBUG ((DEBUG_INFO, "  Write protect group enable       0x%x\n", Csd->WpGrpEnable));\r
  DEBUG ((DEBUG_INFO, "  Write speed factor               0x%x\n", Csd->R2WFactor));\r
  DEBUG ((DEBUG_INFO, "  Max. write data block length     0x%x\n", Csd->WriteBlLen));\r
  DEBUG ((DEBUG_INFO, "  Partial blocks for write allowed 0x%x\n", Csd->WriteBlPartial));\r
  DEBUG ((DEBUG_INFO, "  File format group                0x%x\n", Csd->FileFormatGrp));\r
  DEBUG ((DEBUG_INFO, "  Copy flag (OTP)                  0x%x\n", Csd->Copy));\r
  DEBUG ((DEBUG_INFO, "  Permanent write protection       0x%x\n", Csd->PermWriteProtect));\r
  DEBUG ((DEBUG_INFO, "  Temporary write protection       0x%x\n", Csd->TmpWriteProtect));\r
  DEBUG ((DEBUG_INFO, "  File format                      0x%x\n", Csd->FileFormat));\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Get SD device model name.\r
\r
  @param[in, out] Device   The pointer to the SD_DEVICE data structure.\r
  @param[in]      Cid      Pointer to SD_CID data structure.\r
\r
  @retval EFI_SUCCESS      The function completed successfully\r
\r
**/\r
EFI_STATUS\r
GetSdModelName (\r
  IN OUT SD_DEVICE  *Device,\r
  IN     SD_CID     *Cid\r
  )\r
{\r
  CHAR8  String[SD_MODEL_NAME_MAX_LEN];\r
\r
  ZeroMem (String, sizeof (String));\r
  CopyMem (String, Cid->OemId, sizeof (Cid->OemId));\r
  String[sizeof (Cid->OemId)] = ' ';\r
  CopyMem (String + sizeof (Cid->OemId) + 1, Cid->ProductName, sizeof (Cid->ProductName));\r
  String[sizeof (Cid->OemId) + sizeof (Cid->ProductName)] = ' ';\r
  CopyMem (String + sizeof (Cid->OemId) + sizeof (Cid->ProductName) + 1, Cid->ProductSerialNumber, sizeof (Cid->ProductSerialNumber));\r
\r
  AsciiStrToUnicodeStrS (String, Device->ModelName, sizeof (Device->ModelName) / sizeof (Device->ModelName[0]));\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Discover user area partition in the SD device.\r
\r
  @param[in] Device          The pointer to the SD_DEVICE data structure.\r
\r
  @retval EFI_SUCCESS        The user area partition in the SD device is successfully identified.\r
  @return Others             Some error occurs when identifying the user area.\r
\r
**/\r
EFI_STATUS\r
DiscoverUserArea (\r
  IN SD_DEVICE  *Device\r
  )\r
{\r
  EFI_STATUS  Status;\r
  SD_CSD      *Csd;\r
  SD_CSD2     *Csd2;\r
  SD_CID      *Cid;\r
  UINT64      Capacity;\r
  UINT32      DevStatus;\r
  UINT16      Rca;\r
  UINT32      CSize;\r
  UINT32      CSizeMul;\r
  UINT32      ReadBlLen;\r
\r
  //\r
  // Deselect the device to force it enter stby mode.\r
  // Note here we don't judge return status as some SD devices return\r
  // error but the state has been stby.\r
  //\r
  SdSelect (Device, 0);\r
\r
  Status = SdSetRca (Device, &Rca);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "DiscoverUserArea(): Assign new Rca = 0x%x fails with %r\n", Rca, Status));\r
    return Status;\r
  }\r
\r
  Csd    = &Device->Csd;\r
  Status = SdGetCsd (Device, Rca, Csd);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  DumpCsd (Csd);\r
\r
  Cid    = &Device->Cid;\r
  Status = SdGetCid (Device, Rca, Cid);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  GetSdModelName (Device, Cid);\r
\r
  Status = SdSelect (Device, Rca);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "DiscoverUserArea(): Reselect the device 0x%x fails with %r\n", Rca, Status));\r
    return Status;\r
  }\r
\r
  Status = SdSendStatus (Device, Rca, &DevStatus);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if (Csd->CsdStructure == 0) {\r
    Device->SectorAddressing = FALSE;\r
    CSize                    = (Csd->CSizeHigh << 2 | Csd->CSizeLow) + 1;\r
    CSizeMul                 = (1 << (Csd->CSizeMul + 2));\r
    ReadBlLen                = (1 << (Csd->ReadBlLen));\r
    Capacity                 = MultU64x32 (MultU64x32 ((UINT64)CSize, CSizeMul), ReadBlLen);\r
  } else {\r
    Device->SectorAddressing = TRUE;\r
    Csd2                     = (SD_CSD2 *)(VOID *)Csd;\r
    CSize                    = (Csd2->CSizeHigh << 16 | Csd2->CSizeLow) + 1;\r
    Capacity                 = MultU64x32 ((UINT64)CSize, SIZE_512KB);\r
  }\r
\r
  Device->BlockIo.Media               = &Device->BlockMedia;\r
  Device->BlockIo2.Media              = &Device->BlockMedia;\r
  Device->BlockMedia.IoAlign          = Device->Private->PassThru->IoAlign;\r
  Device->BlockMedia.BlockSize        = 0x200;\r
  Device->BlockMedia.LastBlock        = 0x00;\r
  Device->BlockMedia.RemovableMedia   = TRUE;\r
  Device->BlockMedia.MediaPresent     = TRUE;\r
  Device->BlockMedia.LogicalPartition = FALSE;\r
  Device->BlockMedia.LastBlock        = DivU64x32 (Capacity, Device->BlockMedia.BlockSize) - 1;\r
\r
  if (Csd->EraseBlkEn) {\r
    Device->EraseBlock.EraseLengthGranularity = 1;\r
  } else {\r
    Device->EraseBlock.EraseLengthGranularity = (Csd->SectorSize + 1) * (1 << (Csd->WriteBlLen - 9));\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Scan SD Bus to discover the device.\r
\r
  @param[in]  Private             The SD driver private data structure.\r
  @param[in]  Slot                The slot number to check device present.\r
\r
  @retval EFI_SUCCESS             Successfully to discover the device and attach\r
                                  SdMmcIoProtocol to it.\r
  @retval EFI_OUT_OF_RESOURCES    The request could not be completed due to a lack\r
                                  of resources.\r
  @retval EFI_ALREADY_STARTED     The device was discovered before.\r
  @retval Others                  Fail to discover the device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
DiscoverSdDevice (\r
  IN  SD_DRIVER_PRIVATE_DATA  *Private,\r
  IN  UINT8                   Slot\r
  )\r
{\r
  EFI_STATUS                     Status;\r
  SD_DEVICE                      *Device;\r
  EFI_DEVICE_PATH_PROTOCOL       *DevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL       *NewDevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath;\r
  EFI_HANDLE                     DeviceHandle;\r
  EFI_SD_MMC_PASS_THRU_PROTOCOL  *PassThru;\r
\r
  Device              = NULL;\r
  DevicePath          = NULL;\r
  NewDevicePath       = NULL;\r
  RemainingDevicePath = NULL;\r
  PassThru            = Private->PassThru;\r
\r
  //\r
  // Build Device Path\r
  //\r
  Status = PassThru->BuildDevicePath (\r
                       PassThru,\r
                       Slot,\r
                       &DevicePath\r
                       );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if (DevicePath->SubType != MSG_SD_DP) {\r
    Status = EFI_UNSUPPORTED;\r
    goto Error;\r
  }\r
\r
  NewDevicePath = AppendDevicePathNode (\r
                    Private->ParentDevicePath,\r
                    DevicePath\r
                    );\r
\r
  if (NewDevicePath == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Error;\r
  }\r
\r
  DeviceHandle        = NULL;\r
  RemainingDevicePath = NewDevicePath;\r
  Status              = gBS->LocateDevicePath (&gEfiDevicePathProtocolGuid, &RemainingDevicePath, &DeviceHandle);\r
  if (!EFI_ERROR (Status) && (DeviceHandle != NULL) && IsDevicePathEnd (RemainingDevicePath)) {\r
    //\r
    // The device has been started, directly return to fast boot.\r
    //\r
    Status = EFI_ALREADY_STARTED;\r
    goto Error;\r
  }\r
\r
  //\r
  // Allocate buffer to store SD_DEVICE private data.\r
  //\r
  Device = AllocateCopyPool (sizeof (SD_DEVICE), &mSdDeviceTemplate);\r
  if (Device == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Error;\r
  }\r
\r
  Device->DevicePath = NewDevicePath;\r
  Device->Slot       = Slot;\r
  Device->Private    = Private;\r
  InitializeListHead (&Device->Queue);\r
\r
  //\r
  // Expose user area in the Sd memory card to upper layer.\r
  //\r
  Status = DiscoverUserArea (Device);\r
  if (EFI_ERROR (Status)) {\r
    goto Error;\r
  }\r
\r
  Device->ControllerNameTable = NULL;\r
  AddUnicodeString2 (\r
    "eng",\r
    gSdDxeComponentName.SupportedLanguages,\r
    &Device->ControllerNameTable,\r
    Device->ModelName,\r
    TRUE\r
    );\r
  AddUnicodeString2 (\r
    "en",\r
    gSdDxeComponentName2.SupportedLanguages,\r
    &Device->ControllerNameTable,\r
    Device->ModelName,\r
    FALSE\r
    );\r
\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &Device->Handle,\r
                  &gEfiDevicePathProtocolGuid,\r
                  Device->DevicePath,\r
                  &gEfiBlockIoProtocolGuid,\r
                  &Device->BlockIo,\r
                  &gEfiBlockIo2ProtocolGuid,\r
                  &Device->BlockIo2,\r
                  &gEfiEraseBlockProtocolGuid,\r
                  &Device->EraseBlock,\r
                  &gEfiDiskInfoProtocolGuid,\r
                  &Device->DiskInfo,\r
                  NULL\r
                  );\r
\r
  if (!EFI_ERROR (Status)) {\r
    gBS->OpenProtocol (\r
           Private->Controller,\r
           &gEfiSdMmcPassThruProtocolGuid,\r
           (VOID **)&(Private->PassThru),\r
           Private->DriverBindingHandle,\r
           Device->Handle,\r
           EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
           );\r
  }\r
\r
Error:\r
  FreePool (DevicePath);\r
\r
  if (EFI_ERROR (Status) && (NewDevicePath != NULL)) {\r
    FreePool (NewDevicePath);\r
  }\r
\r
  if (EFI_ERROR (Status) && (Device != NULL)) {\r
    FreePool (Device);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Tests to see if this driver supports a given controller. If a child device is provided,\r
  it further tests to see if this driver supports creating a handle for the specified child device.\r
\r
  This function checks to see if the driver specified by This supports the device specified by\r
  ControllerHandle. Drivers will typically use the device path attached to\r
  ControllerHandle and/or the services from the bus I/O abstraction attached to\r
  ControllerHandle to determine if the driver supports ControllerHandle. This function\r
  may be called many times during platform initialization. In order to reduce boot times, the tests\r
  performed by this function must be very small, and take as little time as possible to execute. This\r
  function must not change the state of any hardware devices, and this function must be aware that the\r
  device specified by ControllerHandle may already be managed by the same driver or a\r
  different driver. This function must match its calls to AllocatePages() with FreePages(),\r
  AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().\r
  Since ControllerHandle may have been previously started by the same driver, if a protocol is\r
  already in the opened state, then it must not be closed with CloseProtocol(). This is required\r
  to guarantee the state of ControllerHandle is not modified by this function.\r
\r
  @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle     The handle of the controller to test. This handle\r
                                   must support a protocol interface that supplies\r
                                   an I/O abstraction to the driver.\r
  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This\r
                                   parameter is ignored by device drivers, and is optional for bus\r
                                   drivers. For bus drivers, if this parameter is not NULL, then\r
                                   the bus driver must determine if the bus controller specified\r
                                   by ControllerHandle and the child controller specified\r
                                   by RemainingDevicePath are both supported by this\r
                                   bus driver.\r
\r
  @retval EFI_SUCCESS              The device specified by ControllerHandle and\r
                                   RemainingDevicePath is supported by the driver specified by This.\r
  @retval EFI_ALREADY_STARTED      The device specified by ControllerHandle and\r
                                   RemainingDevicePath is already being managed by the driver\r
                                   specified by This.\r
  @retval EFI_ACCESS_DENIED        The device specified by ControllerHandle and\r
                                   RemainingDevicePath is already being managed by a different\r
                                   driver or an application that requires exclusive access.\r
                                   Currently not implemented.\r
  @retval EFI_UNSUPPORTED          The device specified by ControllerHandle and\r
                                   RemainingDevicePath is not supported by the driver specified by This.\r
**/\r
EFI_STATUS\r
EFIAPI\r
SdDxeDriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  )\r
{\r
  EFI_STATUS                     Status;\r
  EFI_DEVICE_PATH_PROTOCOL       *ParentDevicePath;\r
  EFI_SD_MMC_PASS_THRU_PROTOCOL  *PassThru;\r
  UINT8                          Slot;\r
\r
  //\r
  // Test EFI_SD_MMC_PASS_THRU_PROTOCOL on the controller handle.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiSdMmcPassThruProtocolGuid,\r
                  (VOID **)&PassThru,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
\r
  if (Status == EFI_ALREADY_STARTED) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Test RemainingDevicePath is valid or not.\r
  //\r
  if ((RemainingDevicePath != NULL) && !IsDevicePathEnd (RemainingDevicePath)) {\r
    Status = PassThru->GetSlotNumber (PassThru, RemainingDevicePath, &Slot);\r
    if (EFI_ERROR (Status)) {\r
      //\r
      // Close the I/O Abstraction(s) used to perform the supported test\r
      //\r
      gBS->CloseProtocol (\r
             Controller,\r
             &gEfiSdMmcPassThruProtocolGuid,\r
             This->DriverBindingHandle,\r
             Controller\r
             );\r
      return Status;\r
    }\r
  }\r
\r
  //\r
  // Close the I/O Abstraction(s) used to perform the supported test\r
  //\r
  gBS->CloseProtocol (\r
         Controller,\r
         &gEfiSdMmcPassThruProtocolGuid,\r
         This->DriverBindingHandle,\r
         Controller\r
         );\r
\r
  //\r
  // Open the EFI Device Path protocol needed to perform the supported test\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiDevicePathProtocolGuid,\r
                  (VOID **)&ParentDevicePath,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  return Status;\r
}\r
\r
/**\r
  Starts a device controller or a bus controller.\r
\r
  The Start() function is designed to be invoked from the EFI boot service ConnectController().\r
  As a result, much of the error checking on the parameters to Start() has been moved into this\r
  common boot service. It is legal to call Start() from other locations,\r
  but the following calling restrictions must be followed or the system behavior will not be deterministic.\r
  1. ControllerHandle must be a valid EFI_HANDLE.\r
  2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned\r
     EFI_DEVICE_PATH_PROTOCOL.\r
  3. Prior to calling Start(), the Supported() function for the driver specified by This must\r
     have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.\r
\r
  @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle     The handle of the controller to start. This handle\r
                                   must support a protocol interface that supplies\r
                                   an I/O abstraction to the driver.\r
  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This\r
                                   parameter is ignored by device drivers, and is optional for bus\r
                                   drivers. For a bus driver, if this parameter is NULL, then handles\r
                                   for all the children of Controller are created by this driver.\r
                                   If this parameter is not NULL and the first Device Path Node is\r
                                   not the End of Device Path Node, then only the handle for the\r
                                   child device specified by the first Device Path Node of\r
                                   RemainingDevicePath is created by this driver.\r
                                   If the first Device Path Node of RemainingDevicePath is\r
                                   the End of Device Path Node, no child handle is created by this\r
                                   driver.\r
\r
  @retval EFI_SUCCESS              The device was started.\r
  @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.\r
  @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.\r
  @retval Others                   The driver failed to start the device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SdDxeDriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  )\r
{\r
  EFI_STATUS                     Status;\r
  EFI_SD_MMC_PASS_THRU_PROTOCOL  *PassThru;\r
  EFI_DEVICE_PATH_PROTOCOL       *ParentDevicePath;\r
  SD_DRIVER_PRIVATE_DATA         *Private;\r
  UINT8                          Slot;\r
\r
  Private  = NULL;\r
  PassThru = NULL;\r
  Status   = gBS->OpenProtocol (\r
                    Controller,\r
                    &gEfiSdMmcPassThruProtocolGuid,\r
                    (VOID **)&PassThru,\r
                    This->DriverBindingHandle,\r
                    Controller,\r
                    EFI_OPEN_PROTOCOL_BY_DRIVER\r
                    );\r
  if ((EFI_ERROR (Status)) && (Status != EFI_ALREADY_STARTED)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Check EFI_ALREADY_STARTED to reuse the original SD_DRIVER_PRIVATE_DATA.\r
  //\r
  if (Status != EFI_ALREADY_STARTED) {\r
    Private = AllocateZeroPool (sizeof (SD_DRIVER_PRIVATE_DATA));\r
    if (Private == NULL) {\r
      Status = EFI_OUT_OF_RESOURCES;\r
      goto Error;\r
    }\r
\r
    Status = gBS->OpenProtocol (\r
                    Controller,\r
                    &gEfiDevicePathProtocolGuid,\r
                    (VOID **)&ParentDevicePath,\r
                    This->DriverBindingHandle,\r
                    Controller,\r
                    EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                    );\r
    ASSERT_EFI_ERROR (Status);\r
    Private->PassThru            = PassThru;\r
    Private->Controller          = Controller;\r
    Private->ParentDevicePath    = ParentDevicePath;\r
    Private->DriverBindingHandle = This->DriverBindingHandle;\r
\r
    Status = gBS->InstallProtocolInterface (\r
                    &Controller,\r
                    &gEfiCallerIdGuid,\r
                    EFI_NATIVE_INTERFACE,\r
                    Private\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      goto Error;\r
    }\r
  } else {\r
    Status = gBS->OpenProtocol (\r
                    Controller,\r
                    &gEfiCallerIdGuid,\r
                    (VOID **)&Private,\r
                    This->DriverBindingHandle,\r
                    Controller,\r
                    EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      goto Error;\r
    }\r
  }\r
\r
  if (RemainingDevicePath == NULL) {\r
    Slot = 0xFF;\r
    while (TRUE) {\r
      Status = PassThru->GetNextSlot (PassThru, &Slot);\r
      if (EFI_ERROR (Status)) {\r
        //\r
        // Cannot find more legal slots.\r
        //\r
        Status = EFI_SUCCESS;\r
        break;\r
      }\r
\r
      Status = DiscoverSdDevice (Private, Slot);\r
      if (EFI_ERROR (Status) && (Status != EFI_ALREADY_STARTED)) {\r
        break;\r
      }\r
    }\r
  } else if (!IsDevicePathEnd (RemainingDevicePath)) {\r
    Status = PassThru->GetSlotNumber (PassThru, RemainingDevicePath, &Slot);\r
    if (!EFI_ERROR (Status)) {\r
      Status = DiscoverSdDevice (Private, Slot);\r
    }\r
  }\r
\r
Error:\r
  if (EFI_ERROR (Status) && (Status != EFI_ALREADY_STARTED)) {\r
    gBS->CloseProtocol (\r
           Controller,\r
           &gEfiSdMmcPassThruProtocolGuid,\r
           This->DriverBindingHandle,\r
           Controller\r
           );\r
\r
    if (Private != NULL) {\r
      gBS->UninstallMultipleProtocolInterfaces (\r
             Controller,\r
             &gEfiCallerIdGuid,\r
             Private,\r
             NULL\r
             );\r
      FreePool (Private);\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Stops a device controller or a bus controller.\r
\r
  The Stop() function is designed to be invoked from the EFI boot service DisconnectController().\r
  As a result, much of the error checking on the parameters to Stop() has been moved\r
  into this common boot service. It is legal to call Stop() from other locations,\r
  but the following calling restrictions must be followed or the system behavior will not be deterministic.\r
  1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this\r
     same driver's Start() function.\r
  2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid\r
     EFI_HANDLE. In addition, all of these handles must have been created in this driver's\r
     Start() function, and the Start() function must have called OpenProtocol() on\r
     ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.\r
\r
  @param[in]  This              A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle  A handle to the device being stopped. The handle must\r
                                support a bus specific I/O protocol for the driver\r
                                to use to stop the device.\r
  @param[in]  NumberOfChildren  The number of child device handles in ChildHandleBuffer.\r
  @param[in]  ChildHandleBuffer An array of child handles to be freed. May be NULL\r
                                if NumberOfChildren is 0.\r
\r
  @retval EFI_SUCCESS           The device was stopped.\r
  @retval EFI_DEVICE_ERROR      The device could not be stopped due to a device error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SdDxeDriverBindingStop (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN  EFI_HANDLE                   Controller,\r
  IN  UINTN                        NumberOfChildren,\r
  IN  EFI_HANDLE                   *ChildHandleBuffer\r
  )\r
{\r
  EFI_STATUS                     Status;\r
  BOOLEAN                        AllChildrenStopped;\r
  UINTN                          Index;\r
  SD_DRIVER_PRIVATE_DATA         *Private;\r
  SD_DEVICE                      *Device;\r
  EFI_SD_MMC_PASS_THRU_PROTOCOL  *PassThru;\r
  EFI_BLOCK_IO2_PROTOCOL         *BlockIo2;\r
  EFI_BLOCK_IO_PROTOCOL          *BlockIo;\r
  LIST_ENTRY                     *Link;\r
  LIST_ENTRY                     *NextLink;\r
  SD_REQUEST                     *Request;\r
  EFI_TPL                        OldTpl;\r
\r
  if (NumberOfChildren == 0) {\r
    Status = gBS->OpenProtocol (\r
                    Controller,\r
                    &gEfiCallerIdGuid,\r
                    (VOID **)&Private,\r
                    This->DriverBindingHandle,\r
                    Controller,\r
                    EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      return EFI_DEVICE_ERROR;\r
    }\r
\r
    gBS->UninstallProtocolInterface (\r
           Controller,\r
           &gEfiCallerIdGuid,\r
           Private\r
           );\r
    gBS->CloseProtocol (\r
           Controller,\r
           &gEfiSdMmcPassThruProtocolGuid,\r
           This->DriverBindingHandle,\r
           Controller\r
           );\r
\r
    FreePool (Private);\r
\r
    return EFI_SUCCESS;\r
  }\r
\r
  AllChildrenStopped = TRUE;\r
\r
  for (Index = 0; Index < NumberOfChildren; Index++) {\r
    BlockIo  = NULL;\r
    BlockIo2 = NULL;\r
    Status   = gBS->OpenProtocol (\r
                      ChildHandleBuffer[Index],\r
                      &gEfiBlockIoProtocolGuid,\r
                      (VOID **)&BlockIo,\r
                      This->DriverBindingHandle,\r
                      Controller,\r
                      EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                      );\r
    if (EFI_ERROR (Status)) {\r
      Status = gBS->OpenProtocol (\r
                      ChildHandleBuffer[Index],\r
                      &gEfiBlockIo2ProtocolGuid,\r
                      (VOID **)&BlockIo2,\r
                      This->DriverBindingHandle,\r
                      Controller,\r
                      EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                      );\r
      if (EFI_ERROR (Status)) {\r
        AllChildrenStopped = FALSE;\r
        continue;\r
      }\r
    }\r
\r
    if (BlockIo != NULL) {\r
      Device = SD_DEVICE_DATA_FROM_BLKIO (BlockIo);\r
    } else {\r
      ASSERT (BlockIo2 != NULL);\r
      Device = SD_DEVICE_DATA_FROM_BLKIO2 (BlockIo2);\r
    }\r
\r
    //\r
    // Free all on-going async tasks.\r
    //\r
    OldTpl = gBS->RaiseTPL (TPL_NOTIFY);\r
    for (Link = GetFirstNode (&Device->Queue);\r
         !IsNull (&Device->Queue, Link);\r
         Link = NextLink)\r
    {\r
      NextLink = GetNextNode (&Device->Queue, Link);\r
      RemoveEntryList (Link);\r
\r
      Request = SD_REQUEST_FROM_LINK (Link);\r
\r
      gBS->CloseEvent (Request->Event);\r
      Request->Token->TransactionStatus = EFI_ABORTED;\r
\r
      if (Request->IsEnd) {\r
        gBS->SignalEvent (Request->Token->Event);\r
      }\r
\r
      FreePool (Request);\r
    }\r
\r
    gBS->RestoreTPL (OldTpl);\r
\r
    //\r
    // Close the child handle\r
    //\r
    Status = gBS->CloseProtocol (\r
                    Controller,\r
                    &gEfiSdMmcPassThruProtocolGuid,\r
                    This->DriverBindingHandle,\r
                    ChildHandleBuffer[Index]\r
                    );\r
\r
    Status = gBS->UninstallMultipleProtocolInterfaces (\r
                    ChildHandleBuffer[Index],\r
                    &gEfiDevicePathProtocolGuid,\r
                    Device->DevicePath,\r
                    &gEfiBlockIoProtocolGuid,\r
                    &Device->BlockIo,\r
                    &gEfiBlockIo2ProtocolGuid,\r
                    &Device->BlockIo2,\r
                    &gEfiEraseBlockProtocolGuid,\r
                    &Device->EraseBlock,\r
                    &gEfiDiskInfoProtocolGuid,\r
                    &Device->DiskInfo,\r
                    NULL\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      AllChildrenStopped = FALSE;\r
      gBS->OpenProtocol (\r
             Controller,\r
             &gEfiSdMmcPassThruProtocolGuid,\r
             (VOID **)&PassThru,\r
             This->DriverBindingHandle,\r
             ChildHandleBuffer[Index],\r
             EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
             );\r
    } else {\r
      FreePool (Device->DevicePath);\r
      FreeUnicodeStringTable (Device->ControllerNameTable);\r
      FreePool (Device);\r
    }\r
  }\r
\r
  if (!AllChildrenStopped) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  The user Entry Point for module SdDxe. The user code starts with this function.\r
\r
  @param[in] ImageHandle    The firmware allocated handle for the EFI image.\r
  @param[in] SystemTable    A pointer to the EFI System Table.\r
\r
  @retval EFI_SUCCESS       The entry point is executed successfully.\r
  @retval other             Some errors occur when executing this entry point.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
InitializeSdDxe (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Install driver model protocol(s).\r
  //\r
  Status = EfiLibInstallDriverBindingComponentName2 (\r
             ImageHandle,\r
             SystemTable,\r
             &gSdDxeDriverBinding,\r
             ImageHandle,\r
             &gSdDxeComponentName,\r
             &gSdDxeComponentName2\r
             );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return Status;\r
}\r