UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

[mirror_edk2.git] / MdeModulePkg / Bus / Pci / EhciDxe / EhciSched.h

/** @file\r
\r
  This file contains the definination for host controller schedule routines.\r
\r
Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _EFI_EHCI_SCHED_H_\r
#define _EFI_EHCI_SCHED_H_\r
\r
/**\r
  Initialize the schedule data structure such as frame list.\r
\r
  @param Ehc                    The EHCI device to init schedule data for.\r
\r
  @retval EFI_OUT_OF_RESOURCES  Failed to allocate resource to init schedule data.\r
  @retval EFI_SUCCESS           The schedule data is initialized.\r
\r
**/\r
EFI_STATUS\r
EhcInitSched (\r
  IN USB2_HC_DEV  *Ehc\r
  );\r
\r
/**\r
  Free the schedule data. It may be partially initialized.\r
\r
  @param  Ehc            The EHCI device.\r
\r
**/\r
VOID\r
EhcFreeSched (\r
  IN USB2_HC_DEV  *Ehc\r
  );\r
\r
/**\r
  Link the queue head to the asynchronous schedule list.\r
  UEFI only supports one CTRL/BULK transfer at a time\r
  due to its interfaces. This simplifies the AsynList\r
  management: A reclamation header is always linked to\r
  the AsyncListAddr, the only active QH is appended to it.\r
\r
  @param  Ehc            The EHCI device.\r
  @param  Qh             The queue head to link.\r
\r
**/\r
VOID\r
EhcLinkQhToAsync (\r
  IN USB2_HC_DEV  *Ehc,\r
  IN EHC_QH       *Qh\r
  );\r
\r
/**\r
  Unlink a queue head from the asynchronous schedule list.\r
  Need to synchronize with hardware.\r
\r
  @param  Ehc            The EHCI device.\r
  @param  Qh             The queue head to unlink.\r
\r
**/\r
VOID\r
EhcUnlinkQhFromAsync (\r
  IN USB2_HC_DEV  *Ehc,\r
  IN EHC_QH       *Qh\r
  );\r
\r
/**\r
  Link a queue head for interrupt transfer to the periodic\r
  schedule frame list. This code is very much the same as\r
  that in UHCI.\r
\r
  @param  Ehc            The EHCI device.\r
  @param  Qh             The queue head to link.\r
\r
**/\r
VOID\r
EhcLinkQhToPeriod (\r
  IN USB2_HC_DEV  *Ehc,\r
  IN EHC_QH       *Qh\r
  );\r
\r
/**\r
  Unlink an interrupt queue head from the periodic\r
  schedule frame list.\r
\r
  @param  Ehc            The EHCI device.\r
  @param  Qh             The queue head to unlink.\r
\r
**/\r
VOID\r
EhcUnlinkQhFromPeriod (\r
  IN USB2_HC_DEV  *Ehc,\r
  IN EHC_QH       *Qh\r
  );\r
\r
/**\r
  Execute the transfer by polling the URB. This is a synchronous operation.\r
\r
  @param  Ehc               The EHCI device.\r
  @param  Urb               The URB to execute.\r
  @param  TimeOut           The time to wait before abort, in millisecond.\r
\r
  @retval EFI_DEVICE_ERROR  The transfer failed due to transfer error.\r
  @retval EFI_TIMEOUT       The transfer failed due to time out.\r
  @retval EFI_SUCCESS       The transfer finished OK.\r
\r
**/\r
EFI_STATUS\r
EhcExecTransfer (\r
  IN  USB2_HC_DEV  *Ehc,\r
  IN  URB          *Urb,\r
  IN  UINTN        TimeOut\r
  );\r
\r
/**\r
  Delete a single asynchronous interrupt transfer for\r
  the device and endpoint.\r
\r
  @param  Ehc            The EHCI device.\r
  @param  DevAddr        The address of the target device.\r
  @param  EpNum          The endpoint of the target.\r
  @param  DataToggle     Return the next data toggle to use.\r
\r
  @retval EFI_SUCCESS    An asynchronous transfer is removed.\r
  @retval EFI_NOT_FOUND  No transfer for the device is found.\r
\r
**/\r
EFI_STATUS\r
EhciDelAsyncIntTransfer (\r
  IN  USB2_HC_DEV  *Ehc,\r
  IN  UINT8        DevAddr,\r
  IN  UINT8        EpNum,\r
  OUT UINT8        *DataToggle\r
  );\r
\r
/**\r
  Remove all the asynchronous interrutp transfers.\r
\r
  @param  Ehc            The EHCI device.\r
\r
**/\r
VOID\r
EhciDelAllAsyncIntTransfers (\r
  IN USB2_HC_DEV  *Ehc\r
  );\r
\r
/**\r
  Insert a single asynchronous interrupt transfer for\r
  the device and endpoint.\r
\r
  @param  Ehc               The EHCI device.\r
  @param  DevAddr           The device address.\r
  @param  EpAddr            Endpoint addrress & its direction.\r
  @param  DevSpeed          The device speed.\r
  @param  Toggle            Initial data toggle to use.\r
  @param  MaxPacket         The max packet length of the endpoint.\r
  @param  Hub               The transaction translator to use.\r
  @param  DataLen           The length of data buffer.\r
  @param  Callback          The function to call when data is transferred.\r
  @param  Context           The context to the callback.\r
  @param  Interval          The interval for interrupt transfer.\r
\r
  @return Created URB or NULL.\r
\r
**/\r
URB *\r
EhciInsertAsyncIntTransfer (\r
  IN USB2_HC_DEV                         *Ehc,\r
  IN UINT8                               DevAddr,\r
  IN UINT8                               EpAddr,\r
  IN UINT8                               DevSpeed,\r
  IN UINT8                               Toggle,\r
  IN UINTN                               MaxPacket,\r
  IN EFI_USB2_HC_TRANSACTION_TRANSLATOR  *Hub,\r
  IN UINTN                               DataLen,\r
  IN EFI_ASYNC_USB_TRANSFER_CALLBACK     Callback,\r
  IN VOID                                *Context,\r
  IN UINTN                               Interval\r
  );\r
\r
/**\r
  Interrupt transfer periodic check handler.\r
\r
  @param  Event          Interrupt event.\r
  @param  Context        Pointer to USB2_HC_DEV.\r
\r
**/\r
VOID\r
EFIAPI\r
EhcMonitorAsyncRequests (\r
  IN EFI_EVENT  Event,\r
  IN VOID       *Context\r
  );\r
\r
#endif\r