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

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

/** @file\r
\r
  Provides some data struct used by EHCI controller driver.\r
\r
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
Copyright (c) Microsoft Corporation.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _EFI_EHCI_H_\r
#define _EFI_EHCI_H_\r
\r
#include <Uefi.h>\r
\r
#include <Protocol/Usb2HostController.h>\r
#include <Protocol/PciIo.h>\r
\r
#include <Guid/EventGroup.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/ReportStatusCodeLib.h>\r
\r
#include <IndustryStandard/Pci.h>\r
\r
typedef struct _USB2_HC_DEV USB2_HC_DEV;\r
\r
#include "UsbHcMem.h"\r
#include "EhciReg.h"\r
#include "EhciUrb.h"\r
#include "EhciSched.h"\r
#include "EhciDebug.h"\r
#include "ComponentName.h"\r
\r
//\r
// EHC timeout experience values\r
//\r
\r
#define EHC_1_MICROSECOND  1\r
#define EHC_1_MILLISECOND  (1000 * EHC_1_MICROSECOND)\r
#define EHC_1_SECOND       (1000 * EHC_1_MILLISECOND)\r
\r
//\r
// EHCI register operation timeout, set by experience\r
//\r
#define EHC_RESET_TIMEOUT    (1 * EHC_1_SECOND)\r
#define EHC_GENERIC_TIMEOUT  (10 * EHC_1_MILLISECOND)\r
\r
//\r
// Wait for roothub port power stable, refers to Spec[EHCI1.0-2.3.9]\r
//\r
#define EHC_ROOT_PORT_RECOVERY_STALL  (20 * EHC_1_MILLISECOND)\r
\r
//\r
// Sync and Async transfer polling interval, set by experience,\r
// and the unit of Async is 100us, means 1ms as interval.\r
//\r
#define EHC_SYNC_POLL_INTERVAL   (1 * EHC_1_MILLISECOND)\r
#define EHC_ASYNC_POLL_INTERVAL  EFI_TIMER_PERIOD_MILLISECONDS(1)\r
\r
//\r
// EHCI debug port control status register bit definition\r
//\r
#define USB_DEBUG_PORT_IN_USE       BIT10\r
#define USB_DEBUG_PORT_ENABLE       BIT28\r
#define USB_DEBUG_PORT_OWNER        BIT30\r
#define USB_DEBUG_PORT_IN_USE_MASK  (USB_DEBUG_PORT_IN_USE |  \\r
                                      USB_DEBUG_PORT_OWNER)\r
\r
//\r
// EHC raises TPL to TPL_NOTIFY to serialize all its operations\r
// to protect shared data structures.\r
//\r
#define  EHC_TPL  TPL_NOTIFY\r
\r
#define EFI_LIST_CONTAINER(Entry, Type, Field)  BASE_CR(Entry, Type, Field)\r
\r
#define EHC_LOW_32BIT(Addr64)      ((UINT32)(((UINTN)(Addr64)) & 0XFFFFFFFF))\r
#define EHC_HIGH_32BIT(Addr64)     ((UINT32)(RShiftU64((UINTN)(Addr64), 32) & 0XFFFFFFFF))\r
#define EHC_BIT_IS_SET(Data, Bit)  ((BOOLEAN)(((Data) & (Bit)) == (Bit)))\r
\r
#define EHC_REG_BIT_IS_SET(Ehc, Offset, Bit) \\r
          (EHC_BIT_IS_SET(EhcReadOpReg ((Ehc), (Offset)), (Bit)))\r
\r
#define USB2_HC_DEV_SIGNATURE  SIGNATURE_32 ('e', 'h', 'c', 'i')\r
#define EHC_FROM_THIS(a)  CR(a, USB2_HC_DEV, Usb2Hc, USB2_HC_DEV_SIGNATURE)\r
\r
struct _USB2_HC_DEV {\r
  UINTN                       Signature;\r
  EFI_USB2_HC_PROTOCOL        Usb2Hc;\r
\r
  EFI_PCI_IO_PROTOCOL         *PciIo;\r
  EFI_DEVICE_PATH_PROTOCOL    *DevicePath;\r
  UINT64                      OriginalPciAttributes;\r
  USBHC_MEM_POOL              *MemPool;\r
\r
  //\r
  // Schedule data shared between asynchronous and periodic\r
  // transfers:\r
  // ShortReadStop, as its name indicates, is used to terminate\r
  // the short read except the control transfer. EHCI follows\r
  // the alternative next QTD point when a short read happens.\r
  // For control transfer, even the short read happens, try the\r
  // status stage.\r
  //\r
  EHC_QTD                     *ShortReadStop;\r
  EFI_EVENT                   PollTimer;\r
\r
  //\r
  // ExitBootServicesEvent is used to stop the EHC DMA operation\r
  // after exit boot service.\r
  //\r
  EFI_EVENT                   ExitBootServiceEvent;\r
\r
  //\r
  // Asynchronous(bulk and control) transfer schedule data:\r
  // ReclaimHead is used as the head of the asynchronous transfer\r
  // list. It acts as the reclamation header.\r
  //\r
  EHC_QH                      *ReclaimHead;\r
\r
  //\r
  // Periodic (interrupt) transfer schedule data:\r
  //\r
  VOID                        *PeriodFrame;     // the buffer pointed by this pointer is used to store pci bus address of the QH descriptor.\r
  VOID                        *PeriodFrameHost; // the buffer pointed by this pointer is used to store host memory address of the QH descriptor.\r
  VOID                        *PeriodFrameMap;\r
\r
  EHC_QH                      *PeriodOne;\r
  LIST_ENTRY                  AsyncIntTransfers;\r
\r
  //\r
  // EHCI configuration data\r
  //\r
  UINT32                      HcStructParams; // Cache of HC structure parameter, EHC_HCSPARAMS_OFFSET\r
  UINT32                      HcCapParams;    // Cache of HC capability parameter, HCCPARAMS\r
  UINT32                      CapLen;         // Capability length\r
\r
  //\r
  // Misc\r
  //\r
  EFI_UNICODE_STRING_TABLE    *ControllerNameTable;\r
\r
  //\r
  // EHCI debug port info\r
  //\r
  UINT16                      DebugPortOffset; // The offset of debug port mmio register\r
  UINT8                       DebugPortBarNum; // The bar number of debug port mmio register\r
  UINT8                       DebugPortNum;    // The port number of usb debug port\r
\r
  BOOLEAN                     Support64BitDma; // Whether 64 bit DMA may be used with this device\r
};\r
\r
extern EFI_DRIVER_BINDING_PROTOCOL   gEhciDriverBinding;\r
extern EFI_COMPONENT_NAME_PROTOCOL   gEhciComponentName;\r
extern EFI_COMPONENT_NAME2_PROTOCOL  gEhciComponentName2;\r
\r
/**\r
  Test to see if this driver supports ControllerHandle. Any\r
  ControllerHandle that has Usb2HcProtocol installed will\r
  be supported.\r
\r
  @param  This                 Protocol instance pointer.\r
  @param  Controller           Handle of device to test.\r
  @param  RemainingDevicePath  Not used.\r
\r
  @return EFI_SUCCESS          This driver supports this device.\r
  @return EFI_UNSUPPORTED      This driver does not support this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EhcDriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  );\r
\r
/**\r
  Starting the Usb EHCI Driver.\r
\r
  @param  This                 Protocol instance pointer.\r
  @param  Controller           Handle of device to test.\r
  @param  RemainingDevicePath  Not used.\r
\r
  @return EFI_SUCCESS          supports this device.\r
  @return EFI_UNSUPPORTED      do not support this device.\r
  @return EFI_DEVICE_ERROR     cannot be started due to device Error.\r
  @return EFI_OUT_OF_RESOURCES cannot allocate resources.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EhcDriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  );\r
\r
/**\r
  Stop this driver on ControllerHandle. Support stopping any child handles\r
  created by this driver.\r
\r
  @param  This                 Protocol instance pointer.\r
  @param  Controller           Handle of device to stop driver on.\r
  @param  NumberOfChildren     Number of Children in the ChildHandleBuffer.\r
  @param  ChildHandleBuffer    List of handles for the children we need to stop.\r
\r
  @return EFI_SUCCESS          Success.\r
  @return EFI_DEVICE_ERROR     Fail.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EhcDriverBindingStop (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   Controller,\r
  IN UINTN                        NumberOfChildren,\r
  IN EFI_HANDLE                   *ChildHandleBuffer\r
  );\r
\r
#endif\r