MdeModulePkg: Clean up source files

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

/** @file\r
Private Header file for Usb Host Controller PEIM\r
\r
Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions\r
of the BSD License which accompanies this distribution.  The\r
full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\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 PEI_USB2_HC_DEV          *Ehc\r
  )\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 PEI_USB2_HC_DEV          *Ehc\r
  )\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 PEI_USB2_HC_DEV      *Ehc,\r
  IN PEI_EHC_QH           *Qh\r
  )\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 PEI_USB2_HC_DEV      *Ehc,\r
  IN PEI_EHC_QH           *Qh\r
  )\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  PEI_USB2_HC_DEV     *Ehc,\r
  IN  PEI_URB             *Urb,\r
  IN  UINTN               TimeOut\r
  )\r
;\r
\r
#endif\r