UhciSched.h

Go to the documentation of this file.

 
#ifndef _EFI_UHCI_SCHED_H_
#define _EFI_UHCI_SCHED_H_
 
#define UHCI_ASYNC_INT_SIGNATURE  SIGNATURE_32 ('u', 'h', 'c', 'a')
//
// The failure mask for USB transfer return status. If any of
// these bit is set, the transfer failed. EFI_USB_ERR_NOEXECUTE
// and EFI_USB_ERR_NAK are not considered as error condition:
// the transfer is still going on.
//
#define USB_ERR_FAIL_MASK  (EFI_USB_ERR_STALL   | EFI_USB_ERR_BUFFER | \
                            EFI_USB_ERR_BABBLE  | EFI_USB_ERR_CRC    | \
                            EFI_USB_ERR_TIMEOUT | EFI_USB_ERR_BITSTUFF | \
                            EFI_USB_ERR_SYSTEM)
 
//
// Structure to return the result of UHCI QH execution.
// Result is the final result of the QH's QTD. NextToggle
// is the next data toggle to use. Complete is the actual
// length of data transferred.
//
typedef struct {
  UINT32    Result;
  UINT8     NextToggle;
  UINTN     Complete;
} UHCI_QH_RESULT;
 
typedef struct _UHCI_ASYNC_REQUEST UHCI_ASYNC_REQUEST;
 
//
// Structure used to manager the asynchronous interrupt transfers.
//
struct _UHCI_ASYNC_REQUEST {
  UINTN                              Signature;
  LIST_ENTRY                         Link;
  UHCI_ASYNC_REQUEST                 *Recycle;
 
  //
  // Endpoint attributes
  //
  UINT8                              DevAddr;
  UINT8                              EndPoint;
  BOOLEAN                            IsLow;
  UINTN                              Interval;
 
  //
  // Data and UHC structures
  //
  UHCI_QH_SW                         *QhSw;
  UHCI_TD_SW                         *FirstTd;
  UINT8                              *Data;   // Allocated host memory, not mapped memory
  UINTN                              DataLen;
  VOID                               *Mapping;
 
  //
  // User callback and its context
  //
  EFI_ASYNC_USB_TRANSFER_CALLBACK    Callback;
  VOID                               *Context;
};
 
#define UHCI_ASYNC_INT_FROM_LINK(a) \
          CR (a, UHCI_ASYNC_REQUEST, Link, UHCI_ASYNC_INT_SIGNATURE)
 
EFI_STATUS
UhciInitFrameList (
  IN USB_HC_DEV  *Uhc
  );
 
VOID
UhciDestoryFrameList (
  IN USB_HC_DEV  *Uhc
  );
 
UINTN
UhciConvertPollRate (
  IN  UINTN  Interval
  );
 
VOID
UhciLinkQhToFrameList (
  USB_HC_DEV  *Uhc,
  UHCI_QH_SW  *Qh
  );
 
VOID
UhciUnlinkQhFromFrameList (
  USB_HC_DEV  *Uhc,
  UHCI_QH_SW  *Qh
  );
 
EFI_STATUS
UhciExecuteTransfer (
  IN  USB_HC_DEV      *Uhc,
  IN  UHCI_QH_SW      *Qh,
  IN  UHCI_TD_SW      *Td,
  IN  UINTN           TimeOut,
  IN  BOOLEAN         IsLow,
  OUT UHCI_QH_RESULT  *QhResult
  );
 
EFI_STATUS
UhciCreateAsyncReq (
  IN USB_HC_DEV                       *Uhc,
  IN UHCI_QH_SW                       *Qh,
  IN UHCI_TD_SW                       *FirstTd,
  IN UINT8                            DevAddr,
  IN UINT8                            EndPoint,
  IN UINTN                            DataLen,
  IN UINTN                            Interval,
  IN UINT8                            *Data,
  IN EFI_ASYNC_USB_TRANSFER_CALLBACK  Callback,
  IN VOID                             *Context,
  IN BOOLEAN                          IsLow
  );
 
EFI_STATUS
UhciRemoveAsyncReq (
  IN  USB_HC_DEV  *Uhc,
  IN  UINT8       DevAddr,
  IN  UINT8       EndPoint,
  OUT UINT8       *Toggle
  );
 
VOID
UhciFreeAllAsyncReq (
  IN USB_HC_DEV  *Uhc
  );
 
VOID
EFIAPI
UhciMonitorAsyncReqList (
  IN EFI_EVENT  Event,
  IN VOID       *Context
  );
 
#endif