MdeModulePkg/Bus/Pci/EhciPei/EhciSched.h

   1 /** @file
   2 Private Header file for Usb Host Controller PEIM
   3
   4 Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>
   5
   6 This program and the accompanying materials
   7 are licensed and made available under the terms and conditions
   8 of the BSD License which accompanies this distribution.  The
   9 full text of the license may be found at
  10 http://opensource.org/licenses/bsd-license.php
  11
  12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15 **/
  16
  17 #ifndef _EFI_EHCI_SCHED_H_
  18 #define _EFI_EHCI_SCHED_H_
  19
  20 /**
  21   Initialize the schedule data structure such as frame list.
  22
  23   @param  Ehc   The EHCI device to init schedule data for.
  24
  25   @retval EFI_OUT_OF_RESOURCES  Failed to allocate resource to init schedule data.
  26   @retval EFI_SUCCESS           The schedule data is initialized.
  27
  28 **/
  29 EFI_STATUS
  30 EhcInitSched (
  31   IN PEI_USB2_HC_DEV          *Ehc
  32   )
  33 ;
  34
  35 /**
  36   Free the schedule data. It may be partially initialized.
  37
  38   @param  Ehc   The EHCI device.
  39
  40 **/
  41 VOID
  42 EhcFreeSched (
  43   IN PEI_USB2_HC_DEV          *Ehc
  44   )
  45 ;
  46
  47 /**
  48   Link the queue head to the asynchronous schedule list.
  49   UEFI only supports one CTRL/BULK transfer at a time
  50   due to its interfaces. This simplifies the AsynList
  51   management: A reclamation header is always linked to
  52   the AsyncListAddr, the only active QH is appended to it.
  53
  54   @param  Ehc   The EHCI device.
  55   @param  Qh    The queue head to link.
  56
  57 **/
  58 VOID
  59 EhcLinkQhToAsync (
  60   IN PEI_USB2_HC_DEV      *Ehc,
  61   IN PEI_EHC_QH           *Qh
  62   )
  63 ;
  64
  65 /**
  66   Unlink a queue head from the asynchronous schedule list.
  67   Need to synchronize with hardware.
  68
  69   @param  Ehc   The EHCI device.
  70   @param  Qh    The queue head to unlink.
  71
  72 **/
  73 VOID
  74 EhcUnlinkQhFromAsync (
  75   IN PEI_USB2_HC_DEV      *Ehc,
  76   IN PEI_EHC_QH           *Qh
  77   )
  78 ;
  79
  80 /**
  81   Link a queue head for interrupt transfer to the periodic
  82   schedule frame list. This code is very much the same as
  83   that in UHCI.
  84
  85   @param  Ehc   The EHCI device.
  86   @param  Qh    The queue head to link.
  87
  88 **/
  89 VOID
  90 EhcLinkQhToPeriod (
  91   IN PEI_USB2_HC_DEV      *Ehc,
  92   IN PEI_EHC_QH           *Qh
  93   )
  94 ;
  95
  96 /**
  97   Unlink an interrupt queue head from the periodic
  98   schedule frame list.
  99
 100   @param  Ehc   The EHCI device.
 101   @param  Qh    The queue head to unlink.
 102
 103 **/
 104 VOID
 105 EhcUnlinkQhFromPeriod (
 106   IN PEI_USB2_HC_DEV      *Ehc,
 107   IN PEI_EHC_QH           *Qh
 108   )
 109 ;
 110
 111 /**
 112   Execute the transfer by polling the URB. This is a synchronous operation.
 113
 114   @param  Ehc               The EHCI device.
 115   @param  Urb               The URB to execute.
 116   @param  TimeOut           The time to wait before abort, in millisecond.
 117
 118   @retval EFI_DEVICE_ERROR  The transfer failed due to transfer error.
 119   @retval EFI_TIMEOUT       The transfer failed due to time out.
 120   @retval EFI_SUCCESS       The transfer finished OK.
 121
 122 **/
 123 EFI_STATUS
 124 EhcExecTransfer (
 125   IN  PEI_USB2_HC_DEV     *Ehc,
 126   IN  PEI_URB             *Urb,
 127   IN  UINTN               TimeOut
 128   )
 129 ;
 130
 131 /**
 132   Delete a single asynchronous interrupt transfer for
 133   the device and endpoint.
 134
 135   @param  Ehc               The EHCI device.
 136   @param  DevAddr           The address of the target device.
 137   @param  EpNum             The endpoint of the target.
 138   @param  DataToggle        Return the next data toggle to use.
 139
 140   @retval EFI_NOT_FOUND     No transfer for the device is found.
 141   @retval EFI_SUCCESS       An asynchronous transfer is removed.
 142
 143 **/
 144 EFI_STATUS
 145 EhciDelAsyncIntTransfer (
 146   IN  PEI_USB2_HC_DEV     *Ehc,
 147   IN  UINT8               DevAddr,
 148   IN  UINT8               EpNum,
 149   OUT UINT8               *DataToggle
 150   )
 151 ;
 152
 153 /**
 154   Remove all the asynchronous interrutp transfers.
 155
 156   @param  Ehc         The EHCI device.
 157
 158 **/
 159 VOID
 160 EhciDelAllAsyncIntTransfers (
 161   IN PEI_USB2_HC_DEV          *Ehc
 162   )
 163 ;
 164
 165 /**
 166   Remove all the asynchronous interrutp transfers.
 167
 168   @param  Event         Interrupt event.
 169   @param  Context       Pointer to PEI_USB2_HC_DEV.
 170
 171 **/
 172 VOID
 173 EFIAPI
 174 EhcMoniteAsyncRequests (
 175   IN EFI_EVENT            Event,
 176   IN VOID                 *Context
 177   )
 178 ;
 179
 180 #endif