EmmcBlockIoPei.h

Go to the documentation of this file.

 
#ifndef _EMMC_BLOCK_IO_PEI_H_
#define _EMMC_BLOCK_IO_PEI_H_
 
#include <PiPei.h>
 
#include <Ppi/SdMmcHostController.h>
#include <Ppi/BlockIo.h>
#include <Ppi/BlockIo2.h>
#include <Ppi/IoMmu.h>
#include <Ppi/EndOfPeiPhase.h>
 
#include <Library/DebugLib.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/IoLib.h>
#include <Library/TimerLib.h>
#include <Library/PeiServicesLib.h>
 
#include <IndustryStandard/Emmc.h>
 
typedef struct _EMMC_PEIM_HC_PRIVATE_DATA  EMMC_PEIM_HC_PRIVATE_DATA;
typedef struct _EMMC_PEIM_HC_SLOT          EMMC_PEIM_HC_SLOT;
typedef struct _EMMC_TRB                   EMMC_TRB;
 
#include "EmmcHci.h"
#include "EmmcHcMem.h"
 
#define EMMC_PEIM_SIG       SIGNATURE_32 ('E', 'M', 'C', 'P')
#define EMMC_PEIM_SLOT_SIG  SIGNATURE_32 ('E', 'M', 'C', 'S')
 
#define EMMC_PEIM_MAX_SLOTS       6
#define EMMC_PEIM_MAX_PARTITIONS  8
 
struct _EMMC_PEIM_HC_SLOT {
  UINT32                       Signature;
  EFI_PEI_BLOCK_IO2_MEDIA      Media[EMMC_PEIM_MAX_PARTITIONS];
  UINT8                        MediaNum;
  EMMC_PARTITION_TYPE          PartitionType[EMMC_PEIM_MAX_PARTITIONS];
 
  UINTN                        EmmcHcBase;
  EMMC_HC_SLOT_CAP             Capability;
  EMMC_CSD                     Csd;
  EMMC_EXT_CSD                 ExtCsd;
  BOOLEAN                      SectorAddressing;
  EMMC_PEIM_HC_PRIVATE_DATA    *Private;
};
 
struct _EMMC_PEIM_HC_PRIVATE_DATA {
  UINT32                            Signature;
  EMMC_PEIM_MEM_POOL                *Pool;
  EFI_PEI_RECOVERY_BLOCK_IO_PPI     BlkIoPpi;
  EFI_PEI_RECOVERY_BLOCK_IO2_PPI    BlkIo2Ppi;
  EFI_PEI_PPI_DESCRIPTOR            BlkIoPpiList;
  EFI_PEI_PPI_DESCRIPTOR            BlkIo2PpiList;
 
  //
  // EndOfPei callback is used to do the cleanups before exit of PEI phase.
  //
  EFI_PEI_NOTIFY_DESCRIPTOR         EndOfPeiNotifyList;
 
  EMMC_PEIM_HC_SLOT                 Slot[EMMC_PEIM_MAX_SLOTS];
  UINT8                             SlotNum;
  UINT8                             TotalBlkIoDevices;
};
 
#define EMMC_TIMEOUT  MultU64x32((UINT64)(3), 1000000)
#define GET_EMMC_PEIM_HC_PRIVATE_DATA_FROM_THIS(a)         CR (a, EMMC_PEIM_HC_PRIVATE_DATA, BlkIoPpi, EMMC_PEIM_SIG)
#define GET_EMMC_PEIM_HC_PRIVATE_DATA_FROM_THIS2(a)        CR (a, EMMC_PEIM_HC_PRIVATE_DATA, BlkIo2Ppi, EMMC_PEIM_SIG)
#define GET_EMMC_PEIM_HC_PRIVATE_DATA_FROM_THIS_NOTIFY(a)  CR (a, EMMC_PEIM_HC_PRIVATE_DATA, EndOfPeiNotifyList, EMMC_PEIM_SIG)
 
struct _EMMC_TRB {
  EMMC_PEIM_HC_SLOT         *Slot;
  UINT16                    BlockSize;
 
  EMMC_COMMAND_PACKET       *Packet;
  VOID                      *Data;
  UINT32                    DataLen;
  BOOLEAN                   Read;
  EFI_PHYSICAL_ADDRESS      DataPhy;
  VOID                      *DataMap;
  EMMC_HC_TRANSFER_MODE     Mode;
 
  UINT64                    Timeout;
 
  EMMC_HC_ADMA_DESC_LINE    *AdmaDesc;
  UINTN                     AdmaDescSize;
};
 
EFI_STATUS
EFIAPI
EmmcBlockIoPeimGetDeviceNo (
  IN  EFI_PEI_SERVICES               **PeiServices,
  IN  EFI_PEI_RECOVERY_BLOCK_IO_PPI  *This,
  OUT UINTN                          *NumberBlockDevices
  );
 
EFI_STATUS
EFIAPI
EmmcBlockIoPeimGetMediaInfo (
  IN  EFI_PEI_SERVICES               **PeiServices,
  IN  EFI_PEI_RECOVERY_BLOCK_IO_PPI  *This,
  IN  UINTN                          DeviceIndex,
  OUT EFI_PEI_BLOCK_IO_MEDIA         *MediaInfo
  );
 
EFI_STATUS
EFIAPI
EmmcBlockIoPeimReadBlocks (
  IN  EFI_PEI_SERVICES               **PeiServices,
  IN  EFI_PEI_RECOVERY_BLOCK_IO_PPI  *This,
  IN  UINTN                          DeviceIndex,
  IN  EFI_PEI_LBA                    StartLBA,
  IN  UINTN                          BufferSize,
  OUT VOID                           *Buffer
  );
 
EFI_STATUS
EFIAPI
EmmcBlockIoPeimGetDeviceNo2 (
  IN  EFI_PEI_SERVICES                **PeiServices,
  IN  EFI_PEI_RECOVERY_BLOCK_IO2_PPI  *This,
  OUT UINTN                           *NumberBlockDevices
  );
 
EFI_STATUS
EFIAPI
EmmcBlockIoPeimGetMediaInfo2 (
  IN  EFI_PEI_SERVICES                **PeiServices,
  IN  EFI_PEI_RECOVERY_BLOCK_IO2_PPI  *This,
  IN  UINTN                           DeviceIndex,
  OUT EFI_PEI_BLOCK_IO2_MEDIA         *MediaInfo
  );
 
EFI_STATUS
EFIAPI
EmmcBlockIoPeimReadBlocks2 (
  IN  EFI_PEI_SERVICES                **PeiServices,
  IN  EFI_PEI_RECOVERY_BLOCK_IO2_PPI  *This,
  IN  UINTN                           DeviceIndex,
  IN  EFI_PEI_LBA                     StartLBA,
  IN  UINTN                           BufferSize,
  OUT VOID                            *Buffer
  );
 
EFI_STATUS
EmmcPeimInitMemPool (
  IN  EMMC_PEIM_HC_PRIVATE_DATA  *Private
  );
 
EFI_STATUS
EmmcPeimFreeMemPool (
  IN EMMC_PEIM_MEM_POOL  *Pool
  );
 
VOID *
EmmcPeimAllocateMem (
  IN  EMMC_PEIM_MEM_POOL  *Pool,
  IN  UINTN               Size
  );
 
VOID
EmmcPeimFreeMem (
  IN EMMC_PEIM_MEM_POOL  *Pool,
  IN VOID                *Mem,
  IN UINTN               Size
  );
 
VOID
IoMmuInit (
  VOID
  );
 
EFI_STATUS
IoMmuMap (
  IN  EDKII_IOMMU_OPERATION  Operation,
  IN  VOID                   *HostAddress,
  IN  OUT UINTN              *NumberOfBytes,
  OUT EFI_PHYSICAL_ADDRESS   *DeviceAddress,
  OUT VOID                   **Mapping
  );
 
EFI_STATUS
IoMmuUnmap (
  IN VOID  *Mapping
  );
 
EFI_STATUS
IoMmuAllocateBuffer (
  IN UINTN                  Pages,
  OUT VOID                  **HostAddress,
  OUT EFI_PHYSICAL_ADDRESS  *DeviceAddress,
  OUT VOID                  **Mapping
  );
 
EFI_STATUS
IoMmuFreeBuffer (
  IN UINTN  Pages,
  IN VOID   *HostAddress,
  IN VOID   *Mapping
  );
 
EFI_STATUS
EFIAPI
EmmcBlockIoPeimEndOfPei (
  IN EFI_PEI_SERVICES           **PeiServices,
  IN EFI_PEI_NOTIFY_DESCRIPTOR  *NotifyDescriptor,
  IN VOID                       *Ppi
  );
 
#endif