SdMmcPciHcDxe.h

Go to the documentation of this file.

 
#ifndef _SD_MMC_PCI_HC_DXE_H_
#define _SD_MMC_PCI_HC_DXE_H_
 
#include <Uefi.h>
 
#include <IndustryStandard/Pci.h>
#include <IndustryStandard/Emmc.h>
#include <IndustryStandard/Sd.h>
 
#include <Library/UefiDriverEntryPoint.h>
#include <Library/DebugLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UefiLib.h>
#include <Library/DevicePathLib.h>
#include <Library/PcdLib.h>
 
#include <Protocol/DevicePath.h>
#include <Protocol/PciIo.h>
#include <Protocol/DriverBinding.h>
#include <Protocol/ComponentName.h>
#include <Protocol/ComponentName2.h>
#include <Protocol/SdMmcOverride.h>
#include <Protocol/SdMmcPassThru.h>
 
#include "SdMmcPciHci.h"
 
extern EFI_COMPONENT_NAME_PROTOCOL   gSdMmcPciHcComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL  gSdMmcPciHcComponentName2;
extern EFI_DRIVER_BINDING_PROTOCOL   gSdMmcPciHcDriverBinding;
 
extern EDKII_SD_MMC_OVERRIDE  *mOverride;
 
#define SD_MMC_HC_PRIVATE_SIGNATURE  SIGNATURE_32 ('s', 'd', 't', 'f')
 
#define SD_MMC_HC_PRIVATE_FROM_THIS(a) \
    CR(a, SD_MMC_HC_PRIVATE_DATA, PassThru, SD_MMC_HC_PRIVATE_SIGNATURE)
 
//
// Generic time out value, 1 microsecond as unit.
//
#define SD_MMC_HC_GENERIC_TIMEOUT  (PcdGet32 (PcdSdMmcGenericTimeoutValue))
 
//
// SD/MMC async transfer timer interval, set by experience.
// The unit is 100us, takes 1ms as interval.
//
#define SD_MMC_HC_ASYNC_TIMER  EFI_TIMER_PERIOD_MILLISECONDS(1)
//
// SD/MMC removable device enumeration timer interval, set by experience.
// The unit is 100us, takes 100ms as interval.
//
#define SD_MMC_HC_ENUM_TIMER  EFI_TIMER_PERIOD_MILLISECONDS(100)
 
typedef enum {
  UnknownCardType,
  SdCardType,
  SdioCardType,
  MmcCardType,
  EmmcCardType
} SD_MMC_CARD_TYPE;
 
typedef enum {
  RemovableSlot,
  EmbeddedSlot,
  SharedBusSlot,
  UnknownSlot
} EFI_SD_MMC_SLOT_TYPE;
 
typedef struct {
  BOOLEAN                              Enable;
  EFI_SD_MMC_SLOT_TYPE                 SlotType;
  BOOLEAN                              MediaPresent;
  BOOLEAN                              Initialized;
  SD_MMC_CARD_TYPE                     CardType;
  UINT64                               CurrentFreq;
  EDKII_SD_MMC_OPERATING_PARAMETERS    OperatingParameters;
} SD_MMC_HC_SLOT;
 
typedef struct {
  UINTN                            Signature;
 
  EFI_HANDLE                       ControllerHandle;
  EFI_PCI_IO_PROTOCOL              *PciIo;
 
  EFI_SD_MMC_PASS_THRU_PROTOCOL    PassThru;
 
  UINT64                           PciAttributes;
  //
  // The field is used to record the previous slot in GetNextSlot().
  //
  UINT8                            PreviousSlot;
  //
  // For Non-blocking operation.
  //
  EFI_EVENT                        TimerEvent;
  //
  // For Sd removable device enumeration.
  //
  EFI_EVENT                        ConnectEvent;
  LIST_ENTRY                       Queue;
 
  SD_MMC_HC_SLOT                   Slot[SD_MMC_HC_MAX_SLOT];
  SD_MMC_HC_SLOT_CAP               Capability[SD_MMC_HC_MAX_SLOT];
  UINT64                           MaxCurrent[SD_MMC_HC_MAX_SLOT];
  UINT16                           ControllerVersion[SD_MMC_HC_MAX_SLOT];
 
  //
  // Some controllers may require to override base clock frequency
  // value stored in Capabilities Register 1.
  //
  UINT32                           BaseClkFreq[SD_MMC_HC_MAX_SLOT];
} SD_MMC_HC_PRIVATE_DATA;
 
typedef struct {
  SD_MMC_BUS_MODE                 BusTiming;
  UINT8                           BusWidth;
  UINT32                          ClockFreq;
  EDKII_SD_MMC_DRIVER_STRENGTH    DriverStrength;
} SD_MMC_BUS_SETTINGS;
 
#define SD_MMC_HC_TRB_SIG  SIGNATURE_32 ('T', 'R', 'B', 'T')
 
#define SD_MMC_TRB_RETRIES  5
 
//
// TRB (Transfer Request Block) contains information for the cmd request.
//
typedef struct {
  UINT32                                 Signature;
  LIST_ENTRY                             TrbList;
 
  UINT8                                  Slot;
  UINT16                                 BlockSize;
 
  EFI_SD_MMC_PASS_THRU_COMMAND_PACKET    *Packet;
  VOID                                   *Data;
  UINT32                                 DataLen;
  BOOLEAN                                Read;
  EFI_PHYSICAL_ADDRESS                   DataPhy;
  VOID                                   *DataMap;
  SD_MMC_HC_TRANSFER_MODE                Mode;
  SD_MMC_HC_ADMA_LENGTH_MODE             AdmaLengthMode;
 
  EFI_EVENT                              Event;
  BOOLEAN                                Started;
  BOOLEAN                                CommandComplete;
  UINT64                                 Timeout;
  UINT32                                 Retries;
 
  BOOLEAN                                PioModeTransferCompleted;
  UINT32                                 PioBlockIndex;
 
  SD_MMC_HC_ADMA_32_DESC_LINE            *Adma32Desc;
  SD_MMC_HC_ADMA_64_V3_DESC_LINE         *Adma64V3Desc;
  SD_MMC_HC_ADMA_64_V4_DESC_LINE         *Adma64V4Desc;
  EFI_PHYSICAL_ADDRESS                   AdmaDescPhy;
  VOID                                   *AdmaMap;
  UINT32                                 AdmaPages;
 
  SD_MMC_HC_PRIVATE_DATA                 *Private;
} SD_MMC_HC_TRB;
 
#define SD_MMC_HC_TRB_FROM_THIS(a) \
    CR(a, SD_MMC_HC_TRB, TrbList, SD_MMC_HC_TRB_SIG)
 
//
// Task for Non-blocking mode.
//
typedef struct {
  UINT32                                 Signature;
  LIST_ENTRY                             Link;
 
  UINT8                                  Slot;
  EFI_SD_MMC_PASS_THRU_COMMAND_PACKET    *Packet;
  BOOLEAN                                IsStart;
  EFI_EVENT                              Event;
  UINT64                                 RetryTimes;
  BOOLEAN                                InfiniteWait;
  VOID                                   *Map;
  VOID                                   *MapAddress;
} SD_MMC_HC_QUEUE;
 
//
// Prototypes
//
 
typedef
EFI_STATUS
(*CARD_TYPE_DETECT_ROUTINE) (
  IN SD_MMC_HC_PRIVATE_DATA  *Private,
  IN UINT8                   Slot
  );
 
EFI_STATUS
EFIAPI
SdMmcPassThruPassThru (
  IN     EFI_SD_MMC_PASS_THRU_PROTOCOL        *This,
  IN     UINT8                                Slot,
  IN OUT EFI_SD_MMC_PASS_THRU_COMMAND_PACKET  *Packet,
  IN     EFI_EVENT                            Event    OPTIONAL
  );
 
EFI_STATUS
EFIAPI
SdMmcPassThruGetNextSlot (
  IN     EFI_SD_MMC_PASS_THRU_PROTOCOL  *This,
  IN OUT UINT8                          *Slot
  );
 
EFI_STATUS
EFIAPI
SdMmcPassThruBuildDevicePath (
  IN     EFI_SD_MMC_PASS_THRU_PROTOCOL  *This,
  IN     UINT8                          Slot,
  IN OUT EFI_DEVICE_PATH_PROTOCOL       **DevicePath
  );
 
EFI_STATUS
EFIAPI
SdMmcPassThruGetSlotNumber (
  IN  EFI_SD_MMC_PASS_THRU_PROTOCOL  *This,
  IN  EFI_DEVICE_PATH_PROTOCOL       *DevicePath,
  OUT UINT8                          *Slot
  );
 
EFI_STATUS
EFIAPI
SdMmcPassThruResetDevice (
  IN EFI_SD_MMC_PASS_THRU_PROTOCOL  *This,
  IN UINT8                          Slot
  );
 
//
// Driver model protocol interfaces
//
 
EFI_STATUS
EFIAPI
SdMmcPciHcDriverBindingSupported (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   Controller,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
  );
 
EFI_STATUS
EFIAPI
SdMmcPciHcDriverBindingStart (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   Controller,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
  );
 
EFI_STATUS
EFIAPI
SdMmcPciHcDriverBindingStop (
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN  EFI_HANDLE                   Controller,
  IN  UINTN                        NumberOfChildren,
  IN  EFI_HANDLE                   *ChildHandleBuffer
  );
 
//
// EFI Component Name Functions
//
 
EFI_STATUS
EFIAPI
SdMmcPciHcComponentNameGetDriverName (
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  IN  CHAR8                        *Language,
  OUT CHAR16                       **DriverName
  );
 
EFI_STATUS
EFIAPI
SdMmcPciHcComponentNameGetControllerName (
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  IN  EFI_HANDLE                   ControllerHandle,
  IN  EFI_HANDLE                   ChildHandle  OPTIONAL,
  IN  CHAR8                        *Language,
  OUT CHAR16                       **ControllerName
  );
 
SD_MMC_HC_TRB *
SdMmcCreateTrb (
  IN SD_MMC_HC_PRIVATE_DATA               *Private,
  IN UINT8                                Slot,
  IN EFI_SD_MMC_PASS_THRU_COMMAND_PACKET  *Packet,
  IN EFI_EVENT                            Event
  );
 
VOID
SdMmcFreeTrb (
  IN SD_MMC_HC_TRB  *Trb
  );
 
EFI_STATUS
SdMmcCheckTrbEnv (
  IN SD_MMC_HC_PRIVATE_DATA  *Private,
  IN SD_MMC_HC_TRB           *Trb
  );
 
EFI_STATUS
SdMmcWaitTrbEnv (
  IN SD_MMC_HC_PRIVATE_DATA  *Private,
  IN SD_MMC_HC_TRB           *Trb
  );
 
EFI_STATUS
SdMmcExecTrb (
  IN SD_MMC_HC_PRIVATE_DATA  *Private,
  IN SD_MMC_HC_TRB           *Trb
  );
 
EFI_STATUS
SdMmcCheckTrbResult (
  IN SD_MMC_HC_PRIVATE_DATA  *Private,
  IN SD_MMC_HC_TRB           *Trb
  );
 
EFI_STATUS
SdMmcWaitTrbResult (
  IN SD_MMC_HC_PRIVATE_DATA  *Private,
  IN SD_MMC_HC_TRB           *Trb
  );
 
EFI_STATUS
EmmcIdentification (
  IN SD_MMC_HC_PRIVATE_DATA  *Private,
  IN UINT8                   Slot
  );
 
EFI_STATUS
SdCardIdentification (
  IN SD_MMC_HC_PRIVATE_DATA  *Private,
  IN UINT8                   Slot
  );
 
EFI_STATUS
SdMmcHcClockSupply (
  IN SD_MMC_HC_PRIVATE_DATA  *Private,
  IN UINT8                   Slot,
  IN SD_MMC_BUS_MODE         BusTiming,
  IN BOOLEAN                 FirstTimeSetup,
  IN UINT64                  ClockFreq
  );
 
EFI_STATUS
SdMmcHcReset (
  IN SD_MMC_HC_PRIVATE_DATA  *Private,
  IN UINT8                   Slot
  );
 
EFI_STATUS
SdMmcHcInitHost (
  IN SD_MMC_HC_PRIVATE_DATA  *Private,
  IN UINT8                   Slot
  );
 
#endif