QuarkSocPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / QuarkSocPkg / QuarkSouthCluster / Sdio / Dxe / SDMediaDeviceDxe / SDMediaDevice.c

/** @file\r
\r
The definition for SD media device driver model and blkio protocol routines.\r
\r
Copyright (c) 2013-2016 Intel Corporation.\r
\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
\r
#include "SDMediaDevice.h"\r
\r
\r
EFI_DRIVER_BINDING_PROTOCOL gSDMediaDeviceDriverBinding = {\r
  SDMediaDeviceSupported,\r
  SDMediaDeviceStart,\r
  SDMediaDeviceStop,\r
  0x20,\r
  NULL,\r
  NULL\r
};\r
\r
/**\r
  Entry point for EFI drivers.\r
\r
  @param  ImageHandle      EFI_HANDLE.\r
  @param  SystemTable      EFI_SYSTEM_TABLE.\r
\r
  @retval EFI_SUCCESS      Driver is successfully loaded.\r
  @return Others           Failed.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
InitializeSDMediaDevice (\r
  IN EFI_HANDLE           ImageHandle,\r
  IN EFI_SYSTEM_TABLE     *SystemTable\r
  )\r
{\r
  return EfiLibInstallDriverBindingComponentName2 (\r
           ImageHandle,\r
           SystemTable,\r
           &gSDMediaDeviceDriverBinding,\r
           ImageHandle,\r
           &gSDMediaDeviceName,\r
           &gSDMediaDeviceName2\r
           );\r
}\r
\r
\r
/**\r
  Test to see if this driver supports ControllerHandle. Any\r
  ControllerHandle that has BlockIoProtocol installed will be supported.\r
\r
  @param  This                 Protocol instance pointer.\r
  @param  Controller           Handle of device to test.\r
  @param  RemainingDevicePath  Not used.\r
\r
  @return EFI_SUCCESS          This driver supports this device.\r
  @return EFI_UNSUPPORTED      This driver does not support this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SDMediaDeviceSupported (\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_HOST_IO_PROTOCOL   *SDHostIo;\r
\r
  //\r
  // Test whether there is PCI IO Protocol attached on the controller handle.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiSDHostIoProtocolGuid,\r
                  (VOID **)&SDHostIo,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto Exit;\r
  }\r
\r
  gBS->CloseProtocol (\r
         Controller,\r
         &gEfiSDHostIoProtocolGuid,\r
         This->DriverBindingHandle,\r
         Controller\r
         );\r
\r
Exit:\r
  return Status;\r
}\r
\r
/**\r
  Starting the SD Media Device Driver.\r
\r
  @param  This                 Protocol instance pointer.\r
  @param  Controller           Handle of device to test.\r
  @param  RemainingDevicePath  Not used.\r
\r
  @retval EFI_SUCCESS          This driver supports this device.\r
  @retval EFI_UNSUPPORTED      This driver does not support this device.\r
  @retval EFI_DEVICE_ERROR     This driver cannot be started due to device Error.\r
                               EFI_OUT_OF_RESOURCES- Failed due to resource shortage.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SDMediaDeviceStart (\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_HOST_IO_PROTOCOL   *SDHostIo;\r
  CARD_DATA                 *CardData;\r
\r
  CardData = NULL;\r
\r
  //\r
  // Open PCI I/O Protocol and save pointer to open protocol\r
  // in private data area.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiSDHostIoProtocolGuid,\r
                  (VOID **) &SDHostIo,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((EFI_D_ERROR, "SDMediaDeviceStart: Fail to open gEfiSDHostIoProtocolGuid \r\n"));\r
    goto Exit;\r
  }\r
\r
  Status = SDHostIo->DetectCardAndInitHost (SDHostIo);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((EFI_D_INFO, "SDMediaDeviceStart: Fail to DetectCardAndInitHost \r\n"));\r
    goto Exit;\r
  }\r
\r
  CardData = (CARD_DATA*)AllocateZeroPool(sizeof (CARD_DATA));\r
  if (CardData == NULL) {\r
    Status =  EFI_OUT_OF_RESOURCES;\r
    DEBUG ((EFI_D_ERROR, "SDMediaDeviceStart: Fail to AllocateZeroPool(CARD_DATA) \r\n"));\r
    goto Exit;\r
  }\r
\r
  ASSERT (SDHostIo->HostCapability.BoundarySize >= 4 * 1024);\r
  CardData->RawBufferPointer = (UINT8*)((UINTN)DMA_MEMORY_TOP);\r
  Status = gBS->AllocatePages (\r
                  AllocateMaxAddress,\r
                  EfiBootServicesData,\r
                  EFI_SIZE_TO_PAGES (2 * SDHostIo->HostCapability.BoundarySize),\r
                  (EFI_PHYSICAL_ADDRESS *)(&CardData->RawBufferPointer)\r
                  );\r
\r
  if (CardData->RawBufferPointer == NULL) {\r
    DEBUG ((EFI_D_ERROR, "SDMediaDeviceStart: Fail to AllocateZeroPool(2*x) \r\n"));\r
    Status =  EFI_OUT_OF_RESOURCES;\r
    goto Exit;\r
  }\r
  CardData->AlignedBuffer = CardData->RawBufferPointer - ((UINTN)(CardData->RawBufferPointer) & (SDHostIo->HostCapability.BoundarySize - 1)) + SDHostIo->HostCapability.BoundarySize;\r
\r
  CardData->Signature = CARD_DATA_SIGNATURE;\r
  CardData->SDHostIo  = SDHostIo;\r
\r
  Status = MMCSDCardInit (CardData);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((EFI_D_ERROR, "SDMediaDeviceStart: Fail to MMCSDCardInit \r\n"));\r
    goto Exit;\r
  }\r
  DEBUG ((EFI_D_INFO, "SDMediaDeviceStart: MMCSDCardInit SuccessFul\n"));\r
\r
  if (CardData->CardType == CEATACard) {\r
    Status = CEATABlockIoInit (CardData);\r
  } else {\r
    Status = MMCSDBlockIoInit (CardData);\r
  }\r
\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((EFI_D_ERROR, "SDMediaDeviceStart: Fail to BlockIoInit \r\n"));\r
    goto Exit;\r
  }\r
  DEBUG ((EFI_D_INFO, "SDMediaDeviceStart: BlockIo is successfully installed\n"));\r
\r
\r
  Status = gBS->InstallProtocolInterface (\r
                  &Controller,\r
                  &gEfiBlockIoProtocolGuid,\r
                  EFI_NATIVE_INTERFACE,\r
                  &CardData->BlockIo\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((EFI_D_ERROR, "SDMediaDeviceStart: Fail to install gEfiBlockIoProtocolGuid \r\n"));\r
    goto Exit;\r
  }\r
\r
  //\r
  // Install the component name protocol\r
  //\r
  CardData->ControllerNameTable = NULL;\r
\r
  AddUnicodeString2 (\r
    "eng",\r
    gSDMediaDeviceName.SupportedLanguages,\r
    &CardData->ControllerNameTable,\r
    L"MMC/SD Media Device",\r
    TRUE\r
    );\r
  AddUnicodeString2 (\r
    "en",\r
    gSDMediaDeviceName2.SupportedLanguages,\r
    &CardData->ControllerNameTable,\r
    L"MMC/SD Media Device",\r
    FALSE\r
    );\r
\r
Exit:\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((EFI_D_INFO, "SDMediaDeviceStart: End with failure\r\n"));\r
    if (CardData != NULL) {\r
      if (CardData->RawBufferPointer != NULL) {\r
        gBS->FreePages ((EFI_PHYSICAL_ADDRESS) (UINTN) CardData->RawBufferPointer, EFI_SIZE_TO_PAGES (2 * SDHostIo->HostCapability.BoundarySize));\r
      }\r
      FreePool (CardData);\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Stop this driver on ControllerHandle. Support stopping any child handles\r
  created by this driver.\r
\r
  @param  This                 Protocol instance pointer.\r
  @param  Controller           Handle of device to stop driver on.\r
  @param  NumberOfChildren     Number of Children in the ChildHandleBuffer.\r
  @param  ChildHandleBuffer    List of handles for the children we need to stop.\r
\r
  @return EFI_SUCCESS\r
  @return others\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SDMediaDeviceStop (\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
  CARD_DATA                 *CardData;\r
  EFI_BLOCK_IO_PROTOCOL     *BlockIo;\r
\r
  //\r
  // First find BlockIo Protocol\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiBlockIoProtocolGuid,\r
                  (VOID **)&BlockIo,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  CardData  = CARD_DATA_FROM_THIS(BlockIo);\r
\r
  //\r
  // Uninstall Block I/O protocol from the device handle\r
  //\r
  Status = gBS->UninstallProtocolInterface (\r
                  Controller,\r
                  &gEfiBlockIoProtocolGuid,\r
                  BlockIo\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if (CardData != NULL) {\r
    if (CardData->RawBufferPointer != NULL) {\r
      gBS->FreePages ((EFI_PHYSICAL_ADDRESS) (UINTN) CardData->RawBufferPointer, EFI_SIZE_TO_PAGES (2 * CardData->SDHostIo->HostCapability.BoundarySize));\r
    }\r
    FreeUnicodeStringTable (CardData->ControllerNameTable);\r
    FreePool (CardData);\r
  }\r
\r
  gBS->CloseProtocol (\r
         Controller,\r
         &gEfiSDHostIoProtocolGuid,\r
         This->DriverBindingHandle,\r
         Controller\r
         );\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
\r