UhcPeim.h

Go to the documentation of this file.

 
#ifndef _RECOVERY_UHC_H_
#define _RECOVERY_UHC_H_
 
#include <PiPei.h>
 
#include <Ppi/UsbController.h>
#include <Ppi/UsbHostController.h>
#include <Ppi/IoMmu.h>
#include <Ppi/EndOfPeiPhase.h>
 
#include <Library/DebugLib.h>
#include <Library/PeimEntryPoint.h>
#include <Library/PeiServicesLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/TimerLib.h>
#include <Library/IoLib.h>
#include <Library/PeiServicesLib.h>
 
#define USB_SLOW_SPEED_DEVICE  0x01
#define USB_FULL_SPEED_DEVICE  0x02
 
//
// One memory block uses 16 page
//
#define NORMAL_MEMORY_BLOCK_UNIT_IN_PAGES  16
 
#define USBCMD          0                         /* Command Register Offset 00-01h */
#define USBCMD_RS       BIT0                      /* Run/Stop */
#define USBCMD_HCRESET  BIT1                      /* Host reset */
#define USBCMD_GRESET   BIT2                      /* Global reset */
#define USBCMD_EGSM     BIT3                      /* Global Suspend Mode */
#define USBCMD_FGR      BIT4                      /* Force Global Resume */
#define USBCMD_SWDBG    BIT5                      /* SW Debug mode */
#define USBCMD_CF       BIT6                      /* Config Flag (sw only) */
#define USBCMD_MAXP     BIT7                      /* Max Packet (0 = 32, 1 = 64) */
 
/* Status register */
#define USBSTS         2      /* Status Register Offset 02-03h */
#define USBSTS_USBINT  BIT0   /* Interrupt due to IOC */
#define USBSTS_ERROR   BIT1   /* Interrupt due to error */
#define USBSTS_RD      BIT2   /* Resume Detect */
#define USBSTS_HSE     BIT3   /* Host System Error - basically PCI problems */
#define USBSTS_HCPE    BIT4   /* Host Controller Process Error - the scripts were buggy */
#define USBSTS_HCH     BIT5   /* HC Halted */
 
/* Interrupt enable register */
#define USBINTR          4      /* Interrupt Enable Register 04-05h */
#define USBINTR_TIMEOUT  BIT0   /* Timeout/CRC error enable */
#define USBINTR_RESUME   BIT1   /* Resume interrupt enable */
#define USBINTR_IOC      BIT2   /* Interrupt On Complete enable */
#define USBINTR_SP       BIT3   /* Short packet interrupt enable */
 
/* Frame Number Register Offset 06-08h */
#define USBFRNUM  6
 
/* Frame List Base Address Register Offset 08-0Bh */
#define USBFLBASEADD  8
 
/* Start of Frame Modify Register Offset 0Ch */
#define USBSOF  0x0c
 
/* USB port status and control registers */
#define USBPORTSC1  0x10                /*Port 1 offset 10-11h */
#define USBPORTSC2  0x12                /*Port 2 offset 12-13h */
 
#define USBPORTSC_CCS   BIT0            /* Current Connect Status ("device present") */
#define USBPORTSC_CSC   BIT1            /* Connect Status Change */
#define USBPORTSC_PED   BIT2            /* Port Enable / Disable */
#define USBPORTSC_PEDC  BIT3            /* Port Enable / Disable Change */
#define USBPORTSC_LSL   BIT4            /* Line Status Low bit*/
#define USBPORTSC_LSH   BIT5            /* Line Status High bit*/
#define USBPORTSC_RD    BIT6            /* Resume Detect */
#define USBPORTSC_LSDA  BIT8            /* Low Speed Device Attached */
#define USBPORTSC_PR    BIT9            /* Port Reset */
#define USBPORTSC_SUSP  BIT12           /* Suspend */
 
#define SETUP_PACKET_ID   0x2D
#define INPUT_PACKET_ID   0x69
#define OUTPUT_PACKET_ID  0xE1
#define ERROR_PACKET_ID   0x55
 
#define STALL_1_MICRO_SECOND  1
#define STALL_1_MILLI_SECOND  1000
 
#pragma pack(1)
 
typedef struct {
  UINT32    FrameListPtrTerminate : 1;
  UINT32    FrameListPtrQSelect   : 1;
  UINT32    FrameListRsvd         : 2;
  UINT32    FrameListPtr          : 28;
} FRAMELIST_ENTRY;
 
typedef struct {
  UINT32    QHHorizontalTerminate : 1;
  UINT32    QHHorizontalQSelect   : 1;
  UINT32    QHHorizontalRsvd      : 2;
  UINT32    QHHorizontalPtr       : 28;
  UINT32    QHVerticalTerminate   : 1;
  UINT32    QHVerticalQSelect     : 1;
  UINT32    QHVerticalRsvd        : 2;
  UINT32    QHVerticalPtr         : 28;
} QUEUE_HEAD;
 
typedef struct {
  QUEUE_HEAD    QueueHead;
  UINT32        Reserved1;
  UINT32        Reserved2;
  VOID          *PtrNext;
  VOID          *PtrDown;
  VOID          *Reserved3;
  UINT32        Reserved4;
} QH_STRUCT;
 
typedef struct {
  UINT32    TDLinkPtrTerminate   : 1;
  UINT32    TDLinkPtrQSelect     : 1;
  UINT32    TDLinkPtrDepthSelect : 1;
  UINT32    TDLinkPtrRsvd        : 1;
  UINT32    TDLinkPtr            : 28;
  UINT32    TDStatusActualLength : 11;
  UINT32    TDStatusRsvd         : 5;
  UINT32    TDStatus             : 8;
  UINT32    TDStatusIOC          : 1;
  UINT32    TDStatusIOS          : 1;
  UINT32    TDStatusLS           : 1;
  UINT32    TDStatusErr          : 2;
  UINT32    TDStatusSPD          : 1;
  UINT32    TDStatusRsvd2        : 2;
  UINT32    TDTokenPID           : 8;
  UINT32    TDTokenDevAddr       : 7;
  UINT32    TDTokenEndPt         : 4;
  UINT32    TDTokenDataToggle    : 1;
  UINT32    TDTokenRsvd          : 1;
  UINT32    TDTokenMaxLen        : 11;
  UINT32    TDBufferPtr;
} TD;
 
typedef struct {
  TD        TDData;
  UINT8     *PtrTDBuffer;
  VOID      *PtrNextTD;
  VOID      *PtrNextQH;
  UINT16    TDBufferLength;
  UINT16    Reserved;
} TD_STRUCT;
 
#pragma pack()
 
typedef struct _MEMORY_MANAGE_HEADER MEMORY_MANAGE_HEADER;
 
struct _MEMORY_MANAGE_HEADER {
  UINT8                   *BitArrayPtr;
  UINTN                   BitArraySizeInBytes;
  UINT8                   *MemoryBlockPtr;
  UINTN                   MemoryBlockSizeInBytes;
  MEMORY_MANAGE_HEADER    *Next;
};
 
#define USB_UHC_DEV_SIGNATURE  SIGNATURE_32 ('p', 'u', 'h', 'c')
typedef struct {
  UINTN                          Signature;
  PEI_USB_HOST_CONTROLLER_PPI    UsbHostControllerPpi;
  EDKII_IOMMU_PPI                *IoMmu;
  EFI_PEI_PPI_DESCRIPTOR         PpiDescriptor;
  //
  // EndOfPei callback is used to stop the UHC DMA operation
  // after exit PEI phase.
  //
  EFI_PEI_NOTIFY_DESCRIPTOR      EndOfPeiNotifyList;
 
  UINT32                         UsbHostControllerBaseAddress;
  FRAMELIST_ENTRY                *FrameListEntry;
  QH_STRUCT                      *ConfigQH;
  QH_STRUCT                      *BulkQH;
  //
  // Header1 used for QH,TD memory blocks management
  //
  MEMORY_MANAGE_HEADER           *Header1;
} USB_UHC_DEV;
 
#define PEI_RECOVERY_USB_UHC_DEV_FROM_UHCI_THIS(a)    CR (a, USB_UHC_DEV, UsbHostControllerPpi, USB_UHC_DEV_SIGNATURE)
#define PEI_RECOVERY_USB_UHC_DEV_FROM_THIS_NOTIFY(a)  CR (a, USB_UHC_DEV, EndOfPeiNotifyList, USB_UHC_DEV_SIGNATURE)
 
EFI_STATUS
EFIAPI
UhcControlTransfer (
  IN EFI_PEI_SERVICES             **PeiServices,
  IN PEI_USB_HOST_CONTROLLER_PPI  *This,
  IN     UINT8                    DeviceAddress,
  IN     UINT8                    DeviceSpeed,
  IN     UINT8                    MaximumPacketLength,
  IN     EFI_USB_DEVICE_REQUEST   *Request,
  IN     EFI_USB_DATA_DIRECTION   TransferDirection,
  IN OUT VOID                     *Data OPTIONAL,
  IN OUT UINTN                    *DataLength OPTIONAL,
  IN     UINTN                    TimeOut,
  OUT    UINT32                   *TransferResult
  );
 
EFI_STATUS
EFIAPI
UhcBulkTransfer (
  IN EFI_PEI_SERVICES             **PeiServices,
  IN PEI_USB_HOST_CONTROLLER_PPI  *This,
  IN  UINT8                       DeviceAddress,
  IN  UINT8                       EndPointAddress,
  IN  UINT8                       MaximumPacketLength,
  IN OUT VOID                     *Data,
  IN OUT UINTN                    *DataLength,
  IN OUT UINT8                    *DataToggle,
  IN  UINTN                       TimeOut,
  OUT UINT32                      *TransferResult
  );
 
EFI_STATUS
EFIAPI
UhcGetRootHubPortNumber (
  IN EFI_PEI_SERVICES             **PeiServices,
  IN PEI_USB_HOST_CONTROLLER_PPI  *This,
  OUT UINT8                       *PortNumber
  );
 
EFI_STATUS
EFIAPI
UhcGetRootHubPortStatus (
  IN EFI_PEI_SERVICES             **PeiServices,
  IN PEI_USB_HOST_CONTROLLER_PPI  *This,
  IN  UINT8                       PortNumber,
  OUT EFI_USB_PORT_STATUS         *PortStatus
  );
 
EFI_STATUS
EFIAPI
UhcSetRootHubPortFeature (
  IN EFI_PEI_SERVICES             **PeiServices,
  IN PEI_USB_HOST_CONTROLLER_PPI  *This,
  IN UINT8                        PortNumber,
  IN EFI_USB_PORT_FEATURE         PortFeature
  );
 
EFI_STATUS
EFIAPI
UhcClearRootHubPortFeature (
  IN EFI_PEI_SERVICES             **PeiServices,
  IN PEI_USB_HOST_CONTROLLER_PPI  *This,
  IN UINT8                        PortNumber,
  IN EFI_USB_PORT_FEATURE         PortFeature
  );
 
EFI_STATUS
InitializeUsbHC (
  IN USB_UHC_DEV  *UhcDev
  );
 
EFI_STATUS
CreateFrameList (
  USB_UHC_DEV  *UhcDev
  );
 
UINT16
USBReadPortW (
  IN  USB_UHC_DEV  *UhcDev,
  IN  UINT32       Port
  );
 
VOID
USBWritePortW (
  IN  USB_UHC_DEV  *UhcDev,
  IN  UINT32       Port,
  IN  UINT16       Data
  );
 
VOID
USBWritePortDW (
  IN  USB_UHC_DEV  *UhcDev,
  IN  UINT32       Port,
  IN  UINT32       Data
  );
 
VOID
ClearStatusReg (
  IN  USB_UHC_DEV  *UhcDev,
  IN  UINT32       StatusAddr
  );
 
BOOLEAN
IsStatusOK (
  IN USB_UHC_DEV  *UhcDev,
  IN UINT32       StatusRegAddr
  );
 
VOID
SetFrameListBaseAddress (
  IN USB_UHC_DEV  *UhcDev,
  IN UINT32       FrameListRegAddr,
  IN UINT32       Addr
  );
 
EFI_STATUS
CreateQH (
  IN  USB_UHC_DEV  *UhcDev,
  OUT QH_STRUCT    **PtrQH
  );
 
VOID
SetQHHorizontalLinkPtr (
  IN QH_STRUCT  *PtrQH,
  IN VOID       *PtrNext
  );
 
VOID
SetQHHorizontalQHorTDSelect (
  IN QH_STRUCT  *PtrQH,
  IN BOOLEAN    IsQH
  );
 
VOID
SetQHHorizontalValidorInvalid (
  IN QH_STRUCT  *PtrQH,
  IN BOOLEAN    IsValid
  );
 
VOID
SetQHVerticalLinkPtr (
  IN QH_STRUCT  *PtrQH,
  IN VOID       *PtrNext
  );
 
VOID
SetQHVerticalQHorTDSelect (
  IN QH_STRUCT  *PtrQH,
  IN BOOLEAN    IsQH
  );
 
VOID
SetQHVerticalValidorInvalid (
  IN QH_STRUCT  *PtrQH,
  IN BOOLEAN    IsValid
  );
 
EFI_STATUS
AllocateTDorQHStruct (
  IN  USB_UHC_DEV  *UhcDev,
  IN  UINT32       Size,
  OUT VOID         **PtrStruct
  );
 
EFI_STATUS
CreateTD (
  IN  USB_UHC_DEV  *UhcDev,
  OUT TD_STRUCT    **PtrTD
  );
 
EFI_STATUS
GenSetupStageTD (
  IN  USB_UHC_DEV  *UhcDev,
  IN  UINT8        DevAddr,
  IN  UINT8        Endpoint,
  IN  UINT8        DeviceSpeed,
  IN  UINT8        *DevRequest,
  IN  UINT8        *RequestPhy,
  IN  UINT8        RequestLen,
  OUT TD_STRUCT    **PtrTD
  );
 
EFI_STATUS
GenDataTD (
  IN  USB_UHC_DEV  *UhcDev,
  IN  UINT8        DevAddr,
  IN  UINT8        Endpoint,
  IN  UINT8        *PtrData,
  IN  UINT8        *DataPhy,
  IN  UINT8        Len,
  IN  UINT8        PktID,
  IN  UINT8        Toggle,
  IN  UINT8        DeviceSpeed,
  OUT TD_STRUCT    **PtrTD
  );
 
EFI_STATUS
CreateStatusTD (
  IN  USB_UHC_DEV  *UhcDev,
  IN  UINT8        DevAddr,
  IN  UINT8        Endpoint,
  IN  UINT8        PktID,
  IN  UINT8        DeviceSpeed,
  OUT TD_STRUCT    **PtrTD
  );
 
VOID
SetTDLinkPtrValidorInvalid (
  IN  TD_STRUCT  *PtrTDStruct,
  IN  BOOLEAN    IsValid
  );
 
VOID
SetTDLinkPtrQHorTDSelect (
  IN  TD_STRUCT  *PtrTDStruct,
  IN  BOOLEAN    IsQH
  );
 
VOID
SetTDLinkPtrDepthorBreadth (
  IN  TD_STRUCT  *PtrTDStruct,
  IN  BOOLEAN    IsDepth
  );
 
VOID
SetTDLinkPtr (
  IN  TD_STRUCT  *PtrTDStruct,
  IN  VOID       *PtrNext
  );
 
VOID *
GetTDLinkPtr (
  IN  TD_STRUCT  *PtrTDStruct
  );
 
VOID
EnableorDisableTDShortPacket (
  IN  TD_STRUCT  *PtrTDStruct,
  IN  BOOLEAN    IsEnable
  );
 
VOID
SetTDControlErrorCounter (
  IN  TD_STRUCT  *PtrTDStruct,
  IN  UINT8      MaxErrors
  );
 
VOID
SetTDLoworFullSpeedDevice (
  IN  TD_STRUCT  *PtrTDStruct,
  IN  BOOLEAN    IsLowSpeedDevice
  );
 
VOID
SetTDControlIsochronousorNot (
  IN  TD_STRUCT  *PtrTDStruct,
  IN  BOOLEAN    IsIsochronous
  );
 
VOID
SetorClearTDControlIOC (
  IN  TD_STRUCT  *PtrTDStruct,
  IN  BOOLEAN    IsSet
  );
 
VOID
SetTDStatusActiveorInactive (
  IN  TD_STRUCT  *PtrTDStruct,
  IN  BOOLEAN    IsActive
  );
 
UINT16
SetTDTokenMaxLength (
  IN  TD_STRUCT  *PtrTDStruct,
  IN  UINT16     MaxLen
  );
 
VOID
SetTDTokenDataToggle1 (
  IN  TD_STRUCT  *PtrTDStruct
  );
 
VOID
SetTDTokenDataToggle0 (
  IN  TD_STRUCT  *PtrTDStruct
  );
 
VOID
SetTDTokenEndPoint (
  IN  TD_STRUCT  *PtrTDStruct,
  IN  UINTN      EndPoint
  );
 
VOID
SetTDTokenDeviceAddress (
  IN  TD_STRUCT  *PtrTDStruct,
  IN  UINTN      DevAddr
  );
 
VOID
SetTDTokenPacketID (
  IN  TD_STRUCT  *PtrTDStruct,
  IN  UINT8      PacketID
  );
 
VOID
SetTDDataBuffer (
  IN  TD_STRUCT  *PtrTDStruct
  );
 
BOOLEAN
IsTDStatusActive (
  IN  TD_STRUCT  *PtrTDStruct
  );
 
BOOLEAN
IsTDStatusStalled (
  IN  TD_STRUCT  *PtrTDStruct
  );
 
BOOLEAN
IsTDStatusBufferError (
  IN  TD_STRUCT  *PtrTDStruct
  );
 
BOOLEAN
IsTDStatusBabbleError (
  IN  TD_STRUCT  *PtrTDStruct
  );
 
BOOLEAN
IsTDStatusNAKReceived (
  IN  TD_STRUCT  *PtrTDStruct
  );
 
BOOLEAN
IsTDStatusCRCTimeOutError (
  IN  TD_STRUCT  *PtrTDStruct
  );
 
BOOLEAN
IsTDStatusBitStuffError (
  IN  TD_STRUCT  *PtrTDStruct
  );
 
UINT16
GetTDStatusActualLength (
  IN  TD_STRUCT  *PtrTDStruct
  );
 
BOOLEAN
GetTDLinkPtrValidorInvalid (
  IN  TD_STRUCT  *PtrTDStruct
  );
 
UINTN
CountTDsNumber (
  IN  TD_STRUCT  *PtrFirstTD
  );
 
VOID
LinkTDToQH (
  IN  QH_STRUCT  *PtrQH,
  IN  TD_STRUCT  *PtrTD
  );
 
VOID
LinkTDToTD (
  IN  TD_STRUCT  *PtrPreTD,
  IN  TD_STRUCT  *PtrTD
  );
 
EFI_STATUS
ExecuteControlTransfer (
  IN  USB_UHC_DEV  *UhcDev,
  IN  TD_STRUCT    *PtrTD,
  OUT UINTN        *ActualLen,
  IN  UINTN        TimeOut,
  OUT UINT32       *TransferResult
  );
 
EFI_STATUS
ExecBulkTransfer (
  IN     USB_UHC_DEV  *UhcDev,
  IN     TD_STRUCT    *PtrTD,
  IN OUT UINTN        *ActualLen,
  IN     UINT8        *DataToggle,
  IN     UINTN        TimeOut,
  OUT    UINT32       *TransferResult
  );
 
VOID
DeleteQueuedTDs (
  IN USB_UHC_DEV  *UhcDev,
  IN TD_STRUCT    *PtrFirstTD
  );
 
BOOLEAN
CheckTDsResults (
  IN  TD_STRUCT  *PtrTD,
  OUT UINT32     *Result,
  OUT UINTN      *ErrTDPos,
  OUT UINTN      *ActualTransferSize
  );
 
EFI_STATUS
CreateMemoryBlock (
  IN  USB_UHC_DEV           *UhcDev,
  OUT MEMORY_MANAGE_HEADER  **MemoryHeader,
  IN  UINTN                 MemoryBlockSizeInPages
  );
 
EFI_STATUS
InitializeMemoryManagement (
  IN USB_UHC_DEV  *UhcDev
  );
 
EFI_STATUS
UhcAllocatePool (
  IN  USB_UHC_DEV  *UhcDev,
  OUT UINT8        **Pool,
  IN  UINTN        AllocSize
  );
 
EFI_STATUS
AllocMemInMemoryBlock (
  IN  MEMORY_MANAGE_HEADER  *MemoryHeader,
  OUT VOID                  **Pool,
  IN  UINTN                 NumberOfMemoryUnit
  );
 
VOID
UhcFreePool (
  IN USB_UHC_DEV  *UhcDev,
  IN UINT8        *Pool,
  IN UINTN        AllocSize
  );
 
VOID
InsertMemoryHeaderToList (
  IN MEMORY_MANAGE_HEADER  *MemoryHeader,
  IN MEMORY_MANAGE_HEADER  *NewMemoryHeader
  );
 
EFI_STATUS
UhciMapUserRequest (
  IN  USB_UHC_DEV  *Uhc,
  IN  OUT VOID     *Request,
  OUT UINT8        **MappedAddr,
  OUT VOID         **Map
  );
 
EFI_STATUS
UhciMapUserData (
  IN  USB_UHC_DEV             *Uhc,
  IN  EFI_USB_DATA_DIRECTION  Direction,
  IN  VOID                    *Data,
  IN  OUT UINTN               *Len,
  OUT UINT8                   *PktId,
  OUT UINT8                   **MappedAddr,
  OUT VOID                    **Map
  );
 
EFI_STATUS
IoMmuMap (
  IN EDKII_IOMMU_PPI        *IoMmu,
  IN EDKII_IOMMU_OPERATION  Operation,
  IN VOID                   *HostAddress,
  IN OUT UINTN              *NumberOfBytes,
  OUT EFI_PHYSICAL_ADDRESS  *DeviceAddress,
  OUT VOID                  **Mapping
  );
 
VOID
IoMmuUnmap (
  IN EDKII_IOMMU_PPI  *IoMmu,
  IN VOID             *Mapping
  );
 
EFI_STATUS
IoMmuAllocateBuffer (
  IN EDKII_IOMMU_PPI        *IoMmu,
  IN UINTN                  Pages,
  OUT VOID                  **HostAddress,
  OUT EFI_PHYSICAL_ADDRESS  *DeviceAddress,
  OUT VOID                  **Mapping
  );
 
VOID
IoMmuInit (
  OUT EDKII_IOMMU_PPI  **IoMmu
  );
 
#endif