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

/** @file\r
\r
  Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "EmmcBlockIoPei.h"\r
\r
//\r
// Template for EMMC HC Slot Data.\r
//\r
EMMC_PEIM_HC_SLOT  gEmmcHcSlotTemplate = {\r
  EMMC_PEIM_SLOT_SIG,             // Signature\r
  {                               // Media\r
    {\r
      MSG_EMMC_DP,\r
      FALSE,\r
      TRUE,\r
      FALSE,\r
      0x200,\r
      0\r
    },\r
    {\r
      MSG_EMMC_DP,\r
      FALSE,\r
      TRUE,\r
      FALSE,\r
      0x200,\r
      0\r
    },\r
    {\r
      MSG_EMMC_DP,\r
      FALSE,\r
      TRUE,\r
      FALSE,\r
      0x200,\r
      0\r
    },\r
    {\r
      MSG_EMMC_DP,\r
      FALSE,\r
      TRUE,\r
      FALSE,\r
      0x200,\r
      0\r
    },\r
    {\r
      MSG_EMMC_DP,\r
      FALSE,\r
      TRUE,\r
      FALSE,\r
      0x200,\r
      0\r
    },\r
    {\r
      MSG_EMMC_DP,\r
      FALSE,\r
      TRUE,\r
      FALSE,\r
      0x200,\r
      0\r
    },\r
    {\r
      MSG_EMMC_DP,\r
      FALSE,\r
      TRUE,\r
      FALSE,\r
      0x200,\r
      0\r
    },\r
    {\r
      MSG_EMMC_DP,\r
      FALSE,\r
      TRUE,\r
      FALSE,\r
      0x200,\r
      0\r
    }\r
  },\r
  0,                              // MediaNum\r
  {                               // PartitionType\r
    EmmcPartitionUnknown,\r
    EmmcPartitionUnknown,\r
    EmmcPartitionUnknown,\r
    EmmcPartitionUnknown,\r
    EmmcPartitionUnknown,\r
    EmmcPartitionUnknown,\r
    EmmcPartitionUnknown,\r
    EmmcPartitionUnknown\r
  },\r
  0,                              // EmmcHcBase\r
  {                               // Capability\r
    0,\r
  },\r
  {                               // Csd\r
    0,\r
  },\r
  {                               // ExtCsd\r
    { 0 },\r
  },\r
  TRUE,                           // SectorAddressing\r
  NULL                            // Private\r
};\r
\r
//\r
// Template for EMMC HC Private Data.\r
//\r
EMMC_PEIM_HC_PRIVATE_DATA  gEmmcHcPrivateTemplate = {\r
  EMMC_PEIM_SIG,                  // Signature\r
  NULL,                           // Pool\r
  {                               // BlkIoPpi\r
    EmmcBlockIoPeimGetDeviceNo,\r
    EmmcBlockIoPeimGetMediaInfo,\r
    EmmcBlockIoPeimReadBlocks\r
  },\r
  {                               // BlkIo2Ppi\r
    EFI_PEI_RECOVERY_BLOCK_IO2_PPI_REVISION,\r
    EmmcBlockIoPeimGetDeviceNo2,\r
    EmmcBlockIoPeimGetMediaInfo2,\r
    EmmcBlockIoPeimReadBlocks2\r
  },\r
  {                               // BlkIoPpiList\r
    EFI_PEI_PPI_DESCRIPTOR_PPI,\r
    &gEfiPeiVirtualBlockIoPpiGuid,\r
    NULL\r
  },\r
  {                               // BlkIo2PpiList\r
    EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,\r
    &gEfiPeiVirtualBlockIo2PpiGuid,\r
    NULL\r
  },\r
  {                               // EndOfPeiNotifyList\r
    (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
    &gEfiEndOfPeiSignalPpiGuid,\r
    EmmcBlockIoPeimEndOfPei\r
  },\r
  {                               // Slot\r
    {\r
      0,\r
    },\r
    {\r
      0,\r
    },\r
    {\r
      0,\r
    },\r
    {\r
      0,\r
    },\r
    {\r
      0,\r
    },\r
    {\r
      0,\r
    }\r
  },\r
  0,                              // SlotNum\r
  0                               // TotalBlkIoDevices\r
};\r
\r
/**\r
  Gets the count of block I/O devices that one specific block driver detects.\r
\r
  This function is used for getting the count of block I/O devices that one\r
  specific block driver detects.  To the PEI ATAPI driver, it returns the number\r
  of all the detected ATAPI devices it detects during the enumeration process.\r
  To the PEI legacy floppy driver, it returns the number of all the legacy\r
  devices it finds during its enumeration process. If no device is detected,\r
  then the function will return zero.\r
\r
  @param[in]  PeiServices          General-purpose services that are available\r
                                   to every PEIM.\r
  @param[in]  This                 Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI\r
                                   instance.\r
  @param[out] NumberBlockDevices   The number of block I/O devices discovered.\r
\r
  @retval     EFI_SUCCESS          The operation performed successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EmmcBlockIoPeimGetDeviceNo (\r
  IN  EFI_PEI_SERVICES               **PeiServices,\r
  IN  EFI_PEI_RECOVERY_BLOCK_IO_PPI  *This,\r
  OUT UINTN                          *NumberBlockDevices\r
  )\r
{\r
  EMMC_PEIM_HC_PRIVATE_DATA  *Private;\r
\r
  Private             = GET_EMMC_PEIM_HC_PRIVATE_DATA_FROM_THIS (This);\r
  *NumberBlockDevices = Private->TotalBlkIoDevices;\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Gets a block device's media information.\r
\r
  This function will provide the caller with the specified block device's media\r
  information. If the media changes, calling this function will update the media\r
  information accordingly.\r
\r
  @param[in]  PeiServices   General-purpose services that are available to every\r
                            PEIM\r
  @param[in]  This          Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r
  @param[in]  DeviceIndex   Specifies the block device to which the function wants\r
                            to talk. Because the driver that implements Block I/O\r
                            PPIs will manage multiple block devices, the PPIs that\r
                            want to talk to a single device must specify the\r
                            device index that was assigned during the enumeration\r
                            process. This index is a number from one to\r
                            NumberBlockDevices.\r
  @param[out] MediaInfo     The media information of the specified block media.\r
                            The caller is responsible for the ownership of this\r
                            data structure.\r
\r
  @par Note:\r
      The MediaInfo structure describes an enumeration of possible block device\r
      types.  This enumeration exists because no device paths are actually passed\r
      across interfaces that describe the type or class of hardware that is publishing\r
      the block I/O interface. This enumeration will allow for policy decisions\r
      in the Recovery PEIM, such as "Try to recover from legacy floppy first,\r
      LS-120 second, CD-ROM third." If there are multiple partitions abstracted\r
      by a given device type, they should be reported in ascending order; this\r
      order also applies to nested partitions, such as legacy MBR, where the\r
      outermost partitions would have precedence in the reporting order. The\r
      same logic applies to systems such as IDE that have precedence relationships\r
      like "Master/Slave" or "Primary/Secondary". The master device should be\r
      reported first, the slave second.\r
\r
  @retval EFI_SUCCESS        Media information about the specified block device\r
                             was obtained successfully.\r
  @retval EFI_DEVICE_ERROR   Cannot get the media information due to a hardware\r
                             error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EmmcBlockIoPeimGetMediaInfo (\r
  IN  EFI_PEI_SERVICES               **PeiServices,\r
  IN  EFI_PEI_RECOVERY_BLOCK_IO_PPI  *This,\r
  IN  UINTN                          DeviceIndex,\r
  OUT EFI_PEI_BLOCK_IO_MEDIA         *MediaInfo\r
  )\r
{\r
  EMMC_PEIM_HC_PRIVATE_DATA  *Private;\r
  UINT8                      SlotNum;\r
  UINT8                      MediaNum;\r
  UINT8                      Location;\r
  BOOLEAN                    Found;\r
\r
  Found   = FALSE;\r
  Private = GET_EMMC_PEIM_HC_PRIVATE_DATA_FROM_THIS (This);\r
\r
  if ((DeviceIndex == 0) || (DeviceIndex > Private->TotalBlkIoDevices)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Location = 0;\r
  MediaNum = 0;\r
  for (SlotNum = 0; SlotNum < Private->SlotNum; SlotNum++) {\r
    for (MediaNum = 0; MediaNum < Private->Slot[SlotNum].MediaNum; MediaNum++) {\r
      Location++;\r
      if (Location == DeviceIndex) {\r
        Found = TRUE;\r
        break;\r
      }\r
    }\r
\r
    if (Found) {\r
      break;\r
    }\r
  }\r
\r
  MediaInfo->DeviceType   = EMMC;\r
  MediaInfo->MediaPresent = TRUE;\r
  MediaInfo->LastBlock    = (UINTN)Private->Slot[SlotNum].Media[MediaNum].LastBlock;\r
  MediaInfo->BlockSize    = Private->Slot[SlotNum].Media[MediaNum].BlockSize;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Reads the requested number of blocks from the specified block device.\r
\r
  The function reads the requested number of blocks from the device. All the\r
  blocks are read, or an error is returned. If there is no media in the device,\r
  the function returns EFI_NO_MEDIA.\r
\r
  @param[in]  PeiServices   General-purpose services that are available to\r
                            every PEIM.\r
  @param[in]  This          Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r
  @param[in]  DeviceIndex   Specifies the block device to which the function wants\r
                            to talk. Because the driver that implements Block I/O\r
                            PPIs will manage multiple block devices, PPIs that\r
                            want to talk to a single device must specify the device\r
                            index that was assigned during the enumeration process.\r
                            This index is a number from one to NumberBlockDevices.\r
  @param[in]  StartLBA      The starting logical block address (LBA) to read from\r
                            on the device\r
  @param[in]  BufferSize    The size of the Buffer in bytes. This number must be\r
                            a multiple of the intrinsic block size of the device.\r
  @param[out] Buffer        A pointer to the destination buffer for the data.\r
                            The caller is responsible for the ownership of the\r
                            buffer.\r
\r
  @retval EFI_SUCCESS             The data was read correctly from the device.\r
  @retval EFI_DEVICE_ERROR        The device reported an error while attempting\r
                                  to perform the read operation.\r
  @retval EFI_INVALID_PARAMETER   The read request contains LBAs that are not\r
                                  valid, or the buffer is not properly aligned.\r
  @retval EFI_NO_MEDIA            There is no media in the device.\r
  @retval EFI_BAD_BUFFER_SIZE     The BufferSize parameter is not a multiple of\r
                                  the intrinsic block size of the device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EmmcBlockIoPeimReadBlocks (\r
  IN  EFI_PEI_SERVICES               **PeiServices,\r
  IN  EFI_PEI_RECOVERY_BLOCK_IO_PPI  *This,\r
  IN  UINTN                          DeviceIndex,\r
  IN  EFI_PEI_LBA                    StartLBA,\r
  IN  UINTN                          BufferSize,\r
  OUT VOID                           *Buffer\r
  )\r
{\r
  EFI_STATUS                 Status;\r
  UINT32                     BlockSize;\r
  UINTN                      NumberOfBlocks;\r
  EMMC_PEIM_HC_PRIVATE_DATA  *Private;\r
  UINT8                      SlotNum;\r
  UINT8                      MediaNum;\r
  UINT8                      Location;\r
  UINT8                      PartitionConfig;\r
  UINTN                      Remaining;\r
  UINT32                     MaxBlock;\r
  BOOLEAN                    Found;\r
\r
  Status  = EFI_SUCCESS;\r
  Found   = FALSE;\r
  Private = GET_EMMC_PEIM_HC_PRIVATE_DATA_FROM_THIS (This);\r
\r
  //\r
  // Check parameters\r
  //\r
  if (Buffer == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (BufferSize == 0) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  if ((DeviceIndex == 0) || (DeviceIndex > Private->TotalBlkIoDevices)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Location = 0;\r
  MediaNum = 0;\r
  for (SlotNum = 0; SlotNum < Private->SlotNum; SlotNum++) {\r
    for (MediaNum = 0; MediaNum < Private->Slot[SlotNum].MediaNum; MediaNum++) {\r
      Location++;\r
      if (Location == DeviceIndex) {\r
        Found = TRUE;\r
        break;\r
      }\r
    }\r
\r
    if (Found) {\r
      break;\r
    }\r
  }\r
\r
  BlockSize = Private->Slot[SlotNum].Media[MediaNum].BlockSize;\r
  if (BufferSize % BlockSize != 0) {\r
    return EFI_BAD_BUFFER_SIZE;\r
  }\r
\r
  if (StartLBA > Private->Slot[SlotNum].Media[MediaNum].LastBlock) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  NumberOfBlocks = BufferSize / BlockSize;\r
\r
  //\r
  // Check if needs to switch partition access.\r
  //\r
  PartitionConfig = Private->Slot[SlotNum].ExtCsd.PartitionConfig;\r
  if ((PartitionConfig & 0x7) != Private->Slot[SlotNum].PartitionType[MediaNum]) {\r
    PartitionConfig &= (UINT8) ~0x7;\r
    PartitionConfig |= Private->Slot[SlotNum].PartitionType[MediaNum];\r
    Status           = EmmcPeimSwitch (\r
                         &Private->Slot[SlotNum],\r
                         0x3,\r
                         OFFSET_OF (EMMC_EXT_CSD, PartitionConfig),\r
                         PartitionConfig,\r
                         0x0\r
                         );\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    Private->Slot[SlotNum].ExtCsd.PartitionConfig = PartitionConfig;\r
  }\r
\r
  //\r
  // Start to execute data transfer. The max block number in single cmd is 65535 blocks.\r
  //\r
  Remaining = NumberOfBlocks;\r
  MaxBlock  = 0xFFFF;\r
\r
  while (Remaining > 0) {\r
    if (Remaining <= MaxBlock) {\r
      NumberOfBlocks = Remaining;\r
    } else {\r
      NumberOfBlocks = MaxBlock;\r
    }\r
\r
    Status = EmmcPeimSetBlkCount (&Private->Slot[SlotNum], (UINT16)NumberOfBlocks);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    BufferSize = NumberOfBlocks * BlockSize;\r
    Status     = EmmcPeimRwMultiBlocks (&Private->Slot[SlotNum], StartLBA, BlockSize, Buffer, BufferSize, TRUE);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    StartLBA  += NumberOfBlocks;\r
    Buffer     = (UINT8 *)Buffer + BufferSize;\r
    Remaining -= NumberOfBlocks;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Gets the count of block I/O devices that one specific block driver detects.\r
\r
  This function is used for getting the count of block I/O devices that one\r
  specific block driver detects.  To the PEI ATAPI driver, it returns the number\r
  of all the detected ATAPI devices it detects during the enumeration process.\r
  To the PEI legacy floppy driver, it returns the number of all the legacy\r
  devices it finds during its enumeration process. If no device is detected,\r
  then the function will return zero.\r
\r
  @param[in]  PeiServices          General-purpose services that are available\r
                                   to every PEIM.\r
  @param[in]  This                 Indicates the EFI_PEI_RECOVERY_BLOCK_IO2_PPI\r
                                   instance.\r
  @param[out] NumberBlockDevices   The number of block I/O devices discovered.\r
\r
  @retval     EFI_SUCCESS          The operation performed successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EmmcBlockIoPeimGetDeviceNo2 (\r
  IN  EFI_PEI_SERVICES                **PeiServices,\r
  IN  EFI_PEI_RECOVERY_BLOCK_IO2_PPI  *This,\r
  OUT UINTN                           *NumberBlockDevices\r
  )\r
{\r
  EMMC_PEIM_HC_PRIVATE_DATA  *Private;\r
\r
  Private             = GET_EMMC_PEIM_HC_PRIVATE_DATA_FROM_THIS2 (This);\r
  *NumberBlockDevices = Private->TotalBlkIoDevices;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Gets a block device's media information.\r
\r
  This function will provide the caller with the specified block device's media\r
  information. If the media changes, calling this function will update the media\r
  information accordingly.\r
\r
  @param[in]  PeiServices   General-purpose services that are available to every\r
                            PEIM\r
  @param[in]  This          Indicates the EFI_PEI_RECOVERY_BLOCK_IO2_PPI instance.\r
  @param[in]  DeviceIndex   Specifies the block device to which the function wants\r
                            to talk. Because the driver that implements Block I/O\r
                            PPIs will manage multiple block devices, the PPIs that\r
                            want to talk to a single device must specify the\r
                            device index that was assigned during the enumeration\r
                            process. This index is a number from one to\r
                            NumberBlockDevices.\r
  @param[out] MediaInfo     The media information of the specified block media.\r
                            The caller is responsible for the ownership of this\r
                            data structure.\r
\r
  @par Note:\r
      The MediaInfo structure describes an enumeration of possible block device\r
      types.  This enumeration exists because no device paths are actually passed\r
      across interfaces that describe the type or class of hardware that is publishing\r
      the block I/O interface. This enumeration will allow for policy decisions\r
      in the Recovery PEIM, such as "Try to recover from legacy floppy first,\r
      LS-120 second, CD-ROM third." If there are multiple partitions abstracted\r
      by a given device type, they should be reported in ascending order; this\r
      order also applies to nested partitions, such as legacy MBR, where the\r
      outermost partitions would have precedence in the reporting order. The\r
      same logic applies to systems such as IDE that have precedence relationships\r
      like "Master/Slave" or "Primary/Secondary". The master device should be\r
      reported first, the slave second.\r
\r
  @retval EFI_SUCCESS        Media information about the specified block device\r
                             was obtained successfully.\r
  @retval EFI_DEVICE_ERROR   Cannot get the media information due to a hardware\r
                             error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EmmcBlockIoPeimGetMediaInfo2 (\r
  IN  EFI_PEI_SERVICES                **PeiServices,\r
  IN  EFI_PEI_RECOVERY_BLOCK_IO2_PPI  *This,\r
  IN  UINTN                           DeviceIndex,\r
  OUT EFI_PEI_BLOCK_IO2_MEDIA         *MediaInfo\r
  )\r
{\r
  EFI_STATUS                 Status;\r
  EMMC_PEIM_HC_PRIVATE_DATA  *Private;\r
  EFI_PEI_BLOCK_IO_MEDIA     Media;\r
  UINT8                      SlotNum;\r
  UINT8                      MediaNum;\r
  UINT8                      Location;\r
  BOOLEAN                    Found;\r
\r
  Found   = FALSE;\r
  Private = GET_EMMC_PEIM_HC_PRIVATE_DATA_FROM_THIS2 (This);\r
\r
  Status = EmmcBlockIoPeimGetMediaInfo (\r
             PeiServices,\r
             &Private->BlkIoPpi,\r
             DeviceIndex,\r
             &Media\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Location = 0;\r
  MediaNum = 0;\r
  for (SlotNum = 0; SlotNum < Private->SlotNum; SlotNum++) {\r
    for (MediaNum = 0; MediaNum < Private->Slot[SlotNum].MediaNum; MediaNum++) {\r
      Location++;\r
      if (Location == DeviceIndex) {\r
        Found = TRUE;\r
        break;\r
      }\r
    }\r
\r
    if (Found) {\r
      break;\r
    }\r
  }\r
\r
  CopyMem (MediaInfo, &(Private->Slot[SlotNum].Media[MediaNum]), sizeof (EFI_PEI_BLOCK_IO2_MEDIA));\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Reads the requested number of blocks from the specified block device.\r
\r
  The function reads the requested number of blocks from the device. All the\r
  blocks are read, or an error is returned. If there is no media in the device,\r
  the function returns EFI_NO_MEDIA.\r
\r
  @param[in]  PeiServices   General-purpose services that are available to\r
                            every PEIM.\r
  @param[in]  This          Indicates the EFI_PEI_RECOVERY_BLOCK_IO2_PPI instance.\r
  @param[in]  DeviceIndex   Specifies the block device to which the function wants\r
                            to talk. Because the driver that implements Block I/O\r
                            PPIs will manage multiple block devices, PPIs that\r
                            want to talk to a single device must specify the device\r
                            index that was assigned during the enumeration process.\r
                            This index is a number from one to NumberBlockDevices.\r
  @param[in]  StartLBA      The starting logical block address (LBA) to read from\r
                            on the device\r
  @param[in]  BufferSize    The size of the Buffer in bytes. This number must be\r
                            a multiple of the intrinsic block size of the device.\r
  @param[out] Buffer        A pointer to the destination buffer for the data.\r
                            The caller is responsible for the ownership of the\r
                            buffer.\r
\r
  @retval EFI_SUCCESS             The data was read correctly from the device.\r
  @retval EFI_DEVICE_ERROR        The device reported an error while attempting\r
                                  to perform the read operation.\r
  @retval EFI_INVALID_PARAMETER   The read request contains LBAs that are not\r
                                  valid, or the buffer is not properly aligned.\r
  @retval EFI_NO_MEDIA            There is no media in the device.\r
  @retval EFI_BAD_BUFFER_SIZE     The BufferSize parameter is not a multiple of\r
                                  the intrinsic block size of the device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EmmcBlockIoPeimReadBlocks2 (\r
  IN  EFI_PEI_SERVICES                **PeiServices,\r
  IN  EFI_PEI_RECOVERY_BLOCK_IO2_PPI  *This,\r
  IN  UINTN                           DeviceIndex,\r
  IN  EFI_PEI_LBA                     StartLBA,\r
  IN  UINTN                           BufferSize,\r
  OUT VOID                            *Buffer\r
  )\r
{\r
  EFI_STATUS                 Status;\r
  EMMC_PEIM_HC_PRIVATE_DATA  *Private;\r
\r
  Status  = EFI_SUCCESS;\r
  Private = GET_EMMC_PEIM_HC_PRIVATE_DATA_FROM_THIS2 (This);\r
\r
  Status = EmmcBlockIoPeimReadBlocks (\r
             PeiServices,\r
             &Private->BlkIoPpi,\r
             DeviceIndex,\r
             StartLBA,\r
             BufferSize,\r
             Buffer\r
             );\r
  return Status;\r
}\r
\r
/**\r
  One notified function to cleanup the allocated DMA buffers at the end of PEI.\r
\r
  @param[in]  PeiServices        Pointer to PEI Services Table.\r
  @param[in]  NotifyDescriptor   Pointer to the descriptor for the Notification\r
                                 event that caused this function to execute.\r
  @param[in]  Ppi                Pointer to the PPI data associated with this function.\r
\r
  @retval     EFI_SUCCESS  The function completes successfully\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EmmcBlockIoPeimEndOfPei (\r
  IN EFI_PEI_SERVICES           **PeiServices,\r
  IN EFI_PEI_NOTIFY_DESCRIPTOR  *NotifyDescriptor,\r
  IN VOID                       *Ppi\r
  )\r
{\r
  EMMC_PEIM_HC_PRIVATE_DATA  *Private;\r
\r
  Private = GET_EMMC_PEIM_HC_PRIVATE_DATA_FROM_THIS_NOTIFY (NotifyDescriptor);\r
\r
  if ((Private->Pool != NULL) && (Private->Pool->Head != NULL)) {\r
    EmmcPeimFreeMemPool (Private->Pool);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  The user code starts with this function.\r
\r
  @param  FileHandle             Handle of the file being invoked.\r
  @param  PeiServices            Describes the list of possible PEI Services.\r
\r
  @retval EFI_SUCCESS            The driver is successfully initialized.\r
  @retval Others                 Can't initialize the driver.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
InitializeEmmcBlockIoPeim (\r
  IN EFI_PEI_FILE_HANDLE     FileHandle,\r
  IN CONST EFI_PEI_SERVICES  **PeiServices\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  EMMC_PEIM_HC_PRIVATE_DATA         *Private;\r
  EDKII_SD_MMC_HOST_CONTROLLER_PPI  *SdMmcHcPpi;\r
  UINT32                            Index;\r
  UINT32                            PartitionIndex;\r
  UINTN                             *MmioBase;\r
  UINT8                             BarNum;\r
  UINT8                             SlotNum;\r
  UINT8                             MediaNum;\r
  UINT8                             Controller;\r
  UINT64                            Capacity;\r
  EMMC_EXT_CSD                      *ExtCsd;\r
  EMMC_HC_SLOT_CAP                  Capability;\r
  EMMC_PEIM_HC_SLOT                 *Slot;\r
  UINT32                            SecCount;\r
  UINT32                            GpSizeMult;\r
\r
  //\r
  // Shadow this PEIM to run from memory\r
  //\r
  if (!EFI_ERROR (PeiServicesRegisterForShadow (FileHandle))) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // locate Emmc host controller PPI\r
  //\r
  Status = PeiServicesLocatePpi (\r
             &gEdkiiPeiSdMmcHostControllerPpiGuid,\r
             0,\r
             NULL,\r
             (VOID **)&SdMmcHcPpi\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  IoMmuInit ();\r
\r
  Controller = 0;\r
  MmioBase   = NULL;\r
  while (TRUE) {\r
    Status = SdMmcHcPpi->GetSdMmcHcMmioBar (SdMmcHcPpi, Controller, &MmioBase, &BarNum);\r
    //\r
    // When status is error, meant no controller is found\r
    //\r
    if (EFI_ERROR (Status)) {\r
      break;\r
    }\r
\r
    if (BarNum == 0) {\r
      Controller++;\r
      continue;\r
    }\r
\r
    Private = AllocateCopyPool (sizeof (EMMC_PEIM_HC_PRIVATE_DATA), &gEmmcHcPrivateTemplate);\r
    if (Private == NULL) {\r
      Status = EFI_OUT_OF_RESOURCES;\r
      break;\r
    }\r
\r
    Private->BlkIoPpiList.Ppi  = (VOID *)&Private->BlkIoPpi;\r
    Private->BlkIo2PpiList.Ppi = (VOID *)&Private->BlkIo2Ppi;\r
    //\r
    // Initialize the memory pool which will be used in all transactions.\r
    //\r
    Status = EmmcPeimInitMemPool (Private);\r
    if (EFI_ERROR (Status)) {\r
      Status = EFI_OUT_OF_RESOURCES;\r
      break;\r
    }\r
\r
    for (Index = 0; Index < BarNum; Index++) {\r
      Status = EmmcPeimHcGetCapability (MmioBase[Index], &Capability);\r
      if (EFI_ERROR (Status)) {\r
        continue;\r
      }\r
\r
      if (Capability.SlotType != 0x1) {\r
        DEBUG ((DEBUG_INFO, "The slot at 0x%x is not embedded slot type\n", MmioBase[Index]));\r
        Status = EFI_UNSUPPORTED;\r
        continue;\r
      }\r
\r
      Status = EmmcPeimHcReset (MmioBase[Index]);\r
      if (EFI_ERROR (Status)) {\r
        continue;\r
      }\r
\r
      Status = EmmcPeimHcCardDetect (MmioBase[Index]);\r
      if (EFI_ERROR (Status)) {\r
        continue;\r
      }\r
\r
      Status = EmmcPeimHcInitHost (MmioBase[Index]);\r
      if (EFI_ERROR (Status)) {\r
        continue;\r
      }\r
\r
      SlotNum = Private->SlotNum;\r
      Slot    = &Private->Slot[SlotNum];\r
      CopyMem (Slot, &gEmmcHcSlotTemplate, sizeof (EMMC_PEIM_HC_SLOT));\r
      Slot->Private    = Private;\r
      Slot->EmmcHcBase = MmioBase[Index];\r
      CopyMem (&Slot->Capability, &Capability, sizeof (Capability));\r
\r
      Status = EmmcPeimIdentification (Slot);\r
      if (EFI_ERROR (Status)) {\r
        continue;\r
      }\r
\r
      ExtCsd = &Slot->ExtCsd;\r
      if (ExtCsd->ExtCsdRev < 5) {\r
        DEBUG ((DEBUG_ERROR, "The EMMC device version is too low, we don't support!!!\n"));\r
        Status = EFI_UNSUPPORTED;\r
        continue;\r
      }\r
\r
      if ((ExtCsd->PartitioningSupport & BIT0) != BIT0) {\r
        DEBUG ((DEBUG_ERROR, "The EMMC device doesn't support Partition Feature!!!\n"));\r
        Status = EFI_UNSUPPORTED;\r
        continue;\r
      }\r
\r
      for (PartitionIndex = 0; PartitionIndex < EMMC_PEIM_MAX_PARTITIONS; PartitionIndex++) {\r
        switch (PartitionIndex) {\r
          case EmmcPartitionUserData:\r
            SecCount = *(UINT32 *)&ExtCsd->SecCount;\r
            Capacity = MultU64x32 ((UINT64)SecCount, 0x200);\r
            break;\r
          case EmmcPartitionBoot1:\r
          case EmmcPartitionBoot2:\r
            Capacity = ExtCsd->BootSizeMult * SIZE_128KB;\r
            break;\r
          case EmmcPartitionRPMB:\r
            Capacity = ExtCsd->RpmbSizeMult * SIZE_128KB;\r
            break;\r
          case EmmcPartitionGP1:\r
            GpSizeMult = (ExtCsd->GpSizeMult[0] | (ExtCsd->GpSizeMult[1] << 8) | (ExtCsd->GpSizeMult[2] << 16));\r
            Capacity   = MultU64x32 (MultU64x32 (MultU64x32 ((UINT64)GpSizeMult, ExtCsd->HcWpGrpSize), ExtCsd->HcEraseGrpSize), SIZE_512KB);\r
            break;\r
          case EmmcPartitionGP2:\r
            GpSizeMult = (ExtCsd->GpSizeMult[3] | (ExtCsd->GpSizeMult[4] << 8) | (ExtCsd->GpSizeMult[5] << 16));\r
            Capacity   = MultU64x32 (MultU64x32 (MultU64x32 ((UINT64)GpSizeMult, ExtCsd->HcWpGrpSize), ExtCsd->HcEraseGrpSize), SIZE_512KB);\r
            break;\r
          case EmmcPartitionGP3:\r
            GpSizeMult = (ExtCsd->GpSizeMult[6] | (ExtCsd->GpSizeMult[7] << 8) | (ExtCsd->GpSizeMult[8] << 16));\r
            Capacity   = MultU64x32 (MultU64x32 (MultU64x32 ((UINT64)GpSizeMult, ExtCsd->HcWpGrpSize), ExtCsd->HcEraseGrpSize), SIZE_512KB);\r
            break;\r
          case EmmcPartitionGP4:\r
            GpSizeMult = (ExtCsd->GpSizeMult[9] | (ExtCsd->GpSizeMult[10] << 8) | (ExtCsd->GpSizeMult[11] << 16));\r
            Capacity   = MultU64x32 (MultU64x32 (MultU64x32 ((UINT64)GpSizeMult, ExtCsd->HcWpGrpSize), ExtCsd->HcEraseGrpSize), SIZE_512KB);\r
            break;\r
          default:\r
            ASSERT (FALSE);\r
            continue;\r
        }\r
\r
        MediaNum = Slot->MediaNum;\r
        if (Capacity != 0) {\r
          Slot->Media[MediaNum].LastBlock = DivU64x32 (Capacity, Slot->Media[MediaNum].BlockSize) - 1;\r
          Slot->PartitionType[MediaNum]   = PartitionIndex;\r
          Private->TotalBlkIoDevices++;\r
          Slot->MediaNum++;\r
        }\r
      }\r
\r
      Private->SlotNum++;\r
    }\r
\r
    Controller++;\r
\r
    if (!EFI_ERROR (Status)) {\r
      PeiServicesInstallPpi (&Private->BlkIoPpiList);\r
      PeiServicesNotifyPpi (&Private->EndOfPeiNotifyList);\r
    } else {\r
      if (Private->Pool->Head != NULL) {\r
        EmmcPeimFreeMemPool (Private->Pool);\r
      }\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r