SdDxe.h

Go to the documentation of this file.

 
#ifndef _SD_DXE_H_
#define _SD_DXE_H_
 
#include <Uefi.h>
#include <IndustryStandard/Sd.h>
 
#include <Protocol/SdMmcPassThru.h>
#include <Protocol/BlockIo.h>
#include <Protocol/BlockIo2.h>
#include <Protocol/EraseBlock.h>
#include <Protocol/DiskInfo.h>
 
#include <Protocol/DevicePath.h>
 
#include <Library/DebugLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/BaseLib.h>
#include <Library/UefiLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/DevicePathLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
 
#include "SdBlockIo.h"
#include "SdDiskInfo.h"
 
//
// Global Variables
//
extern EFI_DRIVER_BINDING_PROTOCOL   gSdDxeDriverBinding;
extern EFI_COMPONENT_NAME_PROTOCOL   gSdDxeComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL  gSdDxeComponentName2;
 
#define SD_DEVICE_SIGNATURE  SIGNATURE_32 ('S', 'D', 't', 'f')
 
#define SD_DEVICE_DATA_FROM_BLKIO(a) \
    CR(a, SD_DEVICE, BlockIo, SD_DEVICE_SIGNATURE)
 
#define SD_DEVICE_DATA_FROM_BLKIO2(a) \
    CR(a, SD_DEVICE, BlockIo2, SD_DEVICE_SIGNATURE)
 
#define SD_DEVICE_DATA_FROM_ERASEBLK(a) \
    CR(a, SD_DEVICE, EraseBlock, SD_DEVICE_SIGNATURE)
 
#define SD_DEVICE_DATA_FROM_DISKINFO(a) \
    CR(a, SD_DEVICE, DiskInfo, SD_DEVICE_SIGNATURE)
 
//
// Take 2.5 seconds as generic time out value, 1 microsecond as unit.
//
#define SD_GENERIC_TIMEOUT  2500 * 1000
 
#define SD_REQUEST_SIGNATURE  SIGNATURE_32 ('S', 'D', 'R', 'E')
 
#define SD_MODEL_NAME_MAX_LEN  32
 
typedef struct _SD_DEVICE               SD_DEVICE;
typedef struct _SD_DRIVER_PRIVATE_DATA  SD_DRIVER_PRIVATE_DATA;
 
//
// Asynchronous I/O request.
//
typedef struct {
  UINT32                                 Signature;
  LIST_ENTRY                             Link;
 
  EFI_SD_MMC_COMMAND_BLOCK               SdMmcCmdBlk;
  EFI_SD_MMC_STATUS_BLOCK                SdMmcStatusBlk;
  EFI_SD_MMC_PASS_THRU_COMMAND_PACKET    Packet;
 
  BOOLEAN                                IsEnd;
 
  EFI_BLOCK_IO2_TOKEN                    *Token;
 
  EFI_EVENT                              Event;
} SD_REQUEST;
 
#define SD_REQUEST_FROM_LINK(a) \
    CR(a, SD_REQUEST, Link, SD_REQUEST_SIGNATURE)
 
struct _SD_DEVICE {
  UINT32                      Signature;
  EFI_HANDLE                  Handle;
  EFI_DEVICE_PATH_PROTOCOL    *DevicePath;
  UINT8                       Slot;
  BOOLEAN                     SectorAddressing;
  EFI_BLOCK_IO_PROTOCOL       BlockIo;
  EFI_BLOCK_IO2_PROTOCOL      BlockIo2;
  EFI_BLOCK_IO_MEDIA          BlockMedia;
  EFI_ERASE_BLOCK_PROTOCOL    EraseBlock;
  EFI_DISK_INFO_PROTOCOL      DiskInfo;
 
  LIST_ENTRY                  Queue;
 
  SD_CSD                      Csd;
  SD_CID                      Cid;
  EFI_UNICODE_STRING_TABLE    *ControllerNameTable;
  //
  // The model name consists of three fields in CID register
  // 1) OEM/Application ID (2 bytes)
  // 2) Product Name       (5 bytes)
  // 3) Product Serial Number (4 bytes)
  // The delimiters of these fields are whitespace.
  //
  CHAR16                      ModelName[SD_MODEL_NAME_MAX_LEN];
  SD_DRIVER_PRIVATE_DATA      *Private;
};
 
//
// SD DXE driver private data structure
//
struct _SD_DRIVER_PRIVATE_DATA {
  EFI_SD_MMC_PASS_THRU_PROTOCOL    *PassThru;
  EFI_HANDLE                       Controller;
  EFI_DEVICE_PATH_PROTOCOL         *ParentDevicePath;
  EFI_HANDLE                       DriverBindingHandle;
};
 
EFI_STATUS
EFIAPI
SdDxeDriverBindingSupported (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   Controller,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
  );
 
EFI_STATUS
EFIAPI
SdDxeDriverBindingStart (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   Controller,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
  );
 
EFI_STATUS
EFIAPI
SdDxeDriverBindingStop (
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN  EFI_HANDLE                   Controller,
  IN  UINTN                        NumberOfChildren,
  IN  EFI_HANDLE                   *ChildHandleBuffer
  );
 
EFI_STATUS
EFIAPI
SdDxeComponentNameGetDriverName (
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  IN  CHAR8                        *Language,
  OUT CHAR16                       **DriverName
  );
 
EFI_STATUS
EFIAPI
SdDxeComponentNameGetControllerName (
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  IN  EFI_HANDLE                   ControllerHandle,
  IN  EFI_HANDLE                   ChildHandle        OPTIONAL,
  IN  CHAR8                        *Language,
  OUT CHAR16                       **ControllerName
  );
 
EFI_STATUS
SdSetRca (
  IN     SD_DEVICE  *Device,
  OUT UINT16        *Rca
  );
 
EFI_STATUS
SdSelect (
  IN     SD_DEVICE  *Device,
  IN     UINT16     Rca
  );
 
EFI_STATUS
SdSendStatus (
  IN     SD_DEVICE  *Device,
  IN     UINT16     Rca,
  OUT UINT32        *DevStatus
  );
 
EFI_STATUS
SdGetCsd (
  IN     SD_DEVICE  *Device,
  IN     UINT16     Rca,
  OUT SD_CSD        *Csd
  );
 
EFI_STATUS
SdGetCid (
  IN     SD_DEVICE  *Device,
  IN     UINT16     Rca,
  OUT SD_CID        *Cid
  );
 
#endif