UfsPassThru.h

Go to the documentation of this file.

 
#ifndef _UFS_PASS_THRU_H_
#define _UFS_PASS_THRU_H_
 
#include <Uefi.h>
 
#include <Protocol/ScsiPassThruExt.h>
#include <Protocol/UfsDeviceConfig.h>
#include <Protocol/UfsHostController.h>
#include <Protocol/UfsHostControllerPlatform.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/PcdLib.h>
#include <Library/TimerLib.h>
 
#include "UfsPassThruHci.h"
 
#define UFS_PASS_THRU_SIG  SIGNATURE_32 ('U', 'F', 'S', 'P')
 
//
// Lun 0~7 is for 8 common luns.
// Lun 8~11 is for those 4 well known luns (Refer to UFS 2.0 spec Table 10.58 for details):
//  Lun 8:  REPORT LUNS
//  Lun 9:  UFS DEVICE
//  Lun 10: BOOT
//  Lun 11: RPMB
//
#define UFS_MAX_LUNS     12
#define UFS_WLUN_PREFIX  0xC1
 
typedef struct {
  UINT8     Lun[UFS_MAX_LUNS];
  UINT16    BitMask : 12;           // Bit 0~7 is 1/1 mapping to common luns. Bit 8~11 is 1/1 mapping to well-known luns.
  UINT16    Rsvd    : 4;
} UFS_EXPOSED_LUNS;
 
typedef struct _UFS_PASS_THRU_PRIVATE_DATA {
  UINT32                                Signature;
  EFI_HANDLE                            Handle;
  EFI_EXT_SCSI_PASS_THRU_MODE           ExtScsiPassThruMode;
  EFI_EXT_SCSI_PASS_THRU_PROTOCOL       ExtScsiPassThru;
  EFI_UFS_DEVICE_CONFIG_PROTOCOL        UfsDevConfig;
  EDKII_UFS_HOST_CONTROLLER_PROTOCOL    *UfsHostController;
  UINTN                                 UfsHcBase;
  EDKII_UFS_HC_INFO                     UfsHcInfo;
  EDKII_UFS_HC_DRIVER_INTERFACE         UfsHcDriverInterface;
 
  UINT8                                 TaskTag;
 
  VOID                                  *UtpTrlBase;
  UINT8                                 Nutrs;
  VOID                                  *TrlMapping;
  VOID                                  *UtpTmrlBase;
  UINT8                                 Nutmrs;
  VOID                                  *TmrlMapping;
 
  UFS_EXPOSED_LUNS                      Luns;
 
  //
  // For Non-blocking operation.
  //
  EFI_EVENT                             TimerEvent;
  LIST_ENTRY                            Queue;
} UFS_PASS_THRU_PRIVATE_DATA;
 
#define UFS_PASS_THRU_TRANS_REQ_SIG  SIGNATURE_32 ('U', 'F', 'S', 'T')
 
typedef struct {
  UINT32                                        Signature;
  LIST_ENTRY                                    TransferList;
 
  UINT8                                         Slot;
  UTP_TRD                                       *Trd;
  UINT32                                        CmdDescSize;
  VOID                                          *CmdDescHost;
  VOID                                          *CmdDescMapping;
  VOID                                          *AlignedDataBuf;
  UINTN                                         AlignedDataBufSize;
  VOID                                          *DataBufMapping;
 
  EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET    *Packet;
  UINT64                                        TimeoutRemain;
  EFI_EVENT                                     CallerEvent;
} UFS_PASS_THRU_TRANS_REQ;
 
#define UFS_PASS_THRU_TRANS_REQ_FROM_THIS(a) \
    CR(a, UFS_PASS_THRU_TRANS_REQ, TransferList, UFS_PASS_THRU_TRANS_REQ_SIG)
 
#define UFS_TIMEOUT         EFI_TIMER_PERIOD_SECONDS(3)
#define UFS_HC_ASYNC_TIMER  EFI_TIMER_PERIOD_MILLISECONDS(1)
 
#define ROUNDUP8(x)  (((x) % 8 == 0) ? (x) : ((x) / 8 + 1) * 8)
 
#define UFS_PASS_THRU_PRIVATE_DATA_FROM_THIS(a) \
  CR (a, \
      UFS_PASS_THRU_PRIVATE_DATA, \
      ExtScsiPassThru, \
      UFS_PASS_THRU_SIG \
      )
 
#define UFS_PASS_THRU_PRIVATE_DATA_FROM_DEV_CONFIG(a) \
  CR (a, \
      UFS_PASS_THRU_PRIVATE_DATA, \
      UfsDevConfig, \
      UFS_PASS_THRU_SIG \
      )
 
#define UFS_PASS_THRU_PRIVATE_DATA_FROM_DRIVER_INTF(a) \
  CR (a, \
      UFS_PASS_THRU_PRIVATE_DATA, \
      UfsHcDriverInterface, \
      UFS_PASS_THRU_SIG \
      )
 
typedef struct _UFS_DEVICE_MANAGEMENT_REQUEST_PACKET {
  UINT64    Timeout;
  VOID      *DataBuffer;
  UINT8     Opcode;
  UINT8     DescId;
  UINT8     Index;
  UINT8     Selector;
  UINT32    TransferLength;
  UINT8     DataDirection;
} UFS_DEVICE_MANAGEMENT_REQUEST_PACKET;
 
//
// function prototype
//
 
EFI_STATUS
EFIAPI
UfsPassThruDriverBindingSupported (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   Controller,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
  );
 
EFI_STATUS
EFIAPI
UfsPassThruDriverBindingStart (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   Controller,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
  );
 
EFI_STATUS
EFIAPI
UfsPassThruDriverBindingStop (
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN  EFI_HANDLE                   Controller,
  IN  UINTN                        NumberOfChildren,
  IN  EFI_HANDLE                   *ChildHandleBuffer
  );
 
//
// EFI Component Name Functions
//
 
EFI_STATUS
EFIAPI
UfsPassThruComponentNameGetDriverName (
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  IN  CHAR8                        *Language,
  OUT CHAR16                       **DriverName
  );
 
EFI_STATUS
EFIAPI
UfsPassThruComponentNameGetControllerName (
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  IN  EFI_HANDLE                   ControllerHandle,
  IN  EFI_HANDLE                   ChildHandle        OPTIONAL,
  IN  CHAR8                        *Language,
  OUT CHAR16                       **ControllerName
  );
 
EFI_STATUS
EFIAPI
UfsPassThruPassThru (
  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL                 *This,
  IN UINT8                                           *Target,
  IN UINT64                                          Lun,
  IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET  *Packet,
  IN EFI_EVENT                                       Event OPTIONAL
  );
 
EFI_STATUS
EFIAPI
UfsPassThruGetNextTargetLun (
  IN  EFI_EXT_SCSI_PASS_THRU_PROTOCOL  *This,
  IN OUT UINT8                         **Target,
  IN OUT UINT64                        *Lun
  );
 
EFI_STATUS
EFIAPI
UfsPassThruBuildDevicePath (
  IN     EFI_EXT_SCSI_PASS_THRU_PROTOCOL  *This,
  IN     UINT8                            *Target,
  IN     UINT64                           Lun,
  IN OUT EFI_DEVICE_PATH_PROTOCOL         **DevicePath
  );
 
EFI_STATUS
EFIAPI
UfsPassThruGetTargetLun (
  IN  EFI_EXT_SCSI_PASS_THRU_PROTOCOL  *This,
  IN  EFI_DEVICE_PATH_PROTOCOL         *DevicePath,
  OUT UINT8                            **Target,
  OUT UINT64                           *Lun
  );
 
EFI_STATUS
EFIAPI
UfsPassThruResetChannel (
  IN  EFI_EXT_SCSI_PASS_THRU_PROTOCOL  *This
  );
 
EFI_STATUS
EFIAPI
UfsPassThruResetTargetLun (
  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL  *This,
  IN UINT8                            *Target,
  IN UINT64                           Lun
  );
 
EFI_STATUS
EFIAPI
UfsPassThruGetNextTarget (
  IN  EFI_EXT_SCSI_PASS_THRU_PROTOCOL  *This,
  IN OUT UINT8                         **Target
  );
 
EFI_STATUS
UfsExecScsiCmds (
  IN     UFS_PASS_THRU_PRIVATE_DATA                  *Private,
  IN     UINT8                                       Lun,
  IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET  *Packet,
  IN     EFI_EVENT                                   Event    OPTIONAL
  );
 
EFI_STATUS
UfsControllerInit (
  IN  UFS_PASS_THRU_PRIVATE_DATA  *Private
  );
 
EFI_STATUS
UfsControllerStop (
  IN  UFS_PASS_THRU_PRIVATE_DATA  *Private
  );
 
EFI_STATUS
UfsAllocateAlignCommonBuffer (
  IN     UFS_PASS_THRU_PRIVATE_DATA  *Private,
  IN     UINTN                       Size,
  OUT VOID                           **CmdDescHost,
  OUT EFI_PHYSICAL_ADDRESS           *CmdDescPhyAddr,
  OUT VOID                           **CmdDescMapping
  );
 
EFI_STATUS
UfsSetFlag (
  IN  UFS_PASS_THRU_PRIVATE_DATA  *Private,
  IN  UINT8                       FlagId
  );
 
EFI_STATUS
UfsReadFlag (
  IN     UFS_PASS_THRU_PRIVATE_DATA  *Private,
  IN     UINT8                       FlagId,
  OUT UINT8                          *Value
  );
 
EFI_STATUS
UfsRwFlags (
  IN     UFS_PASS_THRU_PRIVATE_DATA  *Private,
  IN     BOOLEAN                     Read,
  IN     UINT8                       FlagId,
  IN OUT UINT8                       *Value
  );
 
EFI_STATUS
UfsRwDeviceDesc (
  IN     UFS_PASS_THRU_PRIVATE_DATA  *Private,
  IN     BOOLEAN                     Read,
  IN     UINT8                       DescId,
  IN     UINT8                       Index,
  IN     UINT8                       Selector,
  IN OUT VOID                        *Descriptor,
  IN OUT UINT32                      *DescSize
  );
 
EFI_STATUS
UfsRwAttributes (
  IN     UFS_PASS_THRU_PRIVATE_DATA  *Private,
  IN     BOOLEAN                     Read,
  IN     UINT8                       AttrId,
  IN     UINT8                       Index,
  IN     UINT8                       Selector,
  IN OUT UINT32                      *Attributes
  );
 
EFI_STATUS
UfsExecNopCmds (
  IN  UFS_PASS_THRU_PRIVATE_DATA  *Private
  );
 
VOID
EFIAPI
ProcessAsyncTaskList (
  IN EFI_EVENT  Event,
  IN VOID       *Context
  );
 
VOID
EFIAPI
SignalCallerEvent (
  IN UFS_PASS_THRU_PRIVATE_DATA  *Private,
  IN UFS_PASS_THRU_TRANS_REQ     *TransReq
  );
 
EFI_STATUS
EFIAPI
UfsRwUfsDescriptor (
  IN EFI_UFS_DEVICE_CONFIG_PROTOCOL  *This,
  IN BOOLEAN                         Read,
  IN UINT8                           DescId,
  IN UINT8                           Index,
  IN UINT8                           Selector,
  IN OUT UINT8                       *Descriptor,
  IN OUT UINT32                      *DescSize
  );
 
EFI_STATUS
EFIAPI
UfsRwUfsFlag (
  IN EFI_UFS_DEVICE_CONFIG_PROTOCOL  *This,
  IN BOOLEAN                         Read,
  IN UINT8                           FlagId,
  IN OUT UINT8                       *Flag
  );
 
EFI_STATUS
EFIAPI
UfsRwUfsAttribute (
  IN EFI_UFS_DEVICE_CONFIG_PROTOCOL  *This,
  IN BOOLEAN                         Read,
  IN UINT8                           AttrId,
  IN UINT8                           Index,
  IN UINT8                           Selector,
  IN OUT UINT8                       *Attribute,
  IN OUT UINT32                      *AttrSize
  );
 
EFI_STATUS
EFIAPI
UfsHcDriverInterfaceExecUicCommand (
  IN     EDKII_UFS_HC_DRIVER_INTERFACE  *This,
  IN OUT EDKII_UIC_COMMAND              *UicCommand
  );
 
EFI_STATUS
GetUfsHcInfo (
  IN UFS_PASS_THRU_PRIVATE_DATA  *Private
  );
 
extern EFI_COMPONENT_NAME_PROTOCOL     gUfsPassThruComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL    gUfsPassThruComponentName2;
extern EFI_DRIVER_BINDING_PROTOCOL     gUfsPassThruDriverBinding;
extern EDKII_UFS_HC_PLATFORM_PROTOCOL  *mUfsHcPlatform;
 
#endif