MdeModulePkg/Bus/Pci/EhciDxe/Ehci.h

   1 /** @file
   2
   3   Provides some data struct used by EHCI controller driver.
   4
   5 Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>
   6 This program and the accompanying materials
   7 are licensed and made available under the terms and conditions of the BSD License
   8 which accompanies this distribution.  The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef _EFI_EHCI_H_
  17 #define _EFI_EHCI_H_
  18
  19
  20 #include <Uefi.h>
  21
  22 #include <Protocol/Usb2HostController.h>
  23 #include <Protocol/PciIo.h>
  24
  25 #include <Guid/EventGroup.h>
  26
  27 #include <Library/DebugLib.h>
  28 #include <Library/BaseMemoryLib.h>
  29 #include <Library/UefiDriverEntryPoint.h>
  30 #include <Library/UefiBootServicesTableLib.h>
  31 #include <Library/UefiLib.h>
  32 #include <Library/BaseLib.h>
  33 #include <Library/MemoryAllocationLib.h>
  34 #include <Library/PcdLib.h>
  35
  36 #include <IndustryStandard/Pci.h>
  37
  38 typedef struct _USB2_HC_DEV  USB2_HC_DEV;
  39
  40 #include "UsbHcMem.h"
  41 #include "EhciReg.h"
  42 #include "EhciUrb.h"
  43 #include "EhciSched.h"
  44 #include "EhciDebug.h"
  45 #include "ComponentName.h"
  46
  47 //
  48 // EHC timeout experience values
  49 //
  50
  51 #define EHC_1_MICROSECOND            1
  52 #define EHC_1_MILLISECOND            (1000 * EHC_1_MICROSECOND)
  53 #define EHC_1_SECOND                 (1000 * EHC_1_MILLISECOND)
  54
  55 //
  56 // EHCI register operation timeout, set by experience
  57 //
  58 #define EHC_RESET_TIMEOUT            (1 * EHC_1_SECOND)
  59 #define EHC_GENERIC_TIMEOUT          (10 * EHC_1_MILLISECOND)
  60
  61 //
  62 // Wait for roothub port power stable, refers to Spec[EHCI1.0-2.3.9]
  63 //
  64 #define EHC_ROOT_PORT_RECOVERY_STALL (20 * EHC_1_MILLISECOND)
  65
  66 //
  67 // Sync and Async transfer polling interval, set by experience,
  68 // and the unit of Async is 100us, means 50ms as interval.
  69 //
  70 #define EHC_SYNC_POLL_INTERVAL       (1 * EHC_1_MILLISECOND)
  71 #define EHC_ASYNC_POLL_INTERVAL      (50 * 10000U)
  72
  73 //
  74 // EHCI debug port control status register bit definition
  75 //
  76 #define USB_DEBUG_PORT_IN_USE        BIT10
  77 #define USB_DEBUG_PORT_ENABLE        BIT28
  78 #define USB_DEBUG_PORT_OWNER         BIT30
  79
  80 //
  81 // EHC raises TPL to TPL_NOTIFY to serialize all its operations
  82 // to protect shared data structures.
  83 //
  84 #define  EHC_TPL                     TPL_NOTIFY
  85
  86 //
  87 //Iterate through the doule linked list. NOT delete safe
  88 //
  89 #define EFI_LIST_FOR_EACH(Entry, ListHead)    \
  90   for(Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink)
  91
  92 //
  93 //Iterate through the doule linked list. This is delete-safe.
  94 //Don't touch NextEntry
  95 //
  96 #define EFI_LIST_FOR_EACH_SAFE(Entry, NextEntry, ListHead)            \
  97   for(Entry = (ListHead)->ForwardLink, NextEntry = Entry->ForwardLink;\
  98       Entry != (ListHead); Entry = NextEntry, NextEntry = Entry->ForwardLink)
  99
 100 #define EFI_LIST_CONTAINER(Entry, Type, Field) BASE_CR(Entry, Type, Field)
 101
 102
 103 #define EHC_LOW_32BIT(Addr64)     ((UINT32)(((UINTN)(Addr64)) & 0XFFFFFFFF))
 104 #define EHC_HIGH_32BIT(Addr64)    ((UINT32)(RShiftU64((UINTN)(Addr64), 32) & 0XFFFFFFFF))
 105 #define EHC_BIT_IS_SET(Data, Bit) ((BOOLEAN)(((Data) & (Bit)) == (Bit)))
 106
 107 #define EHC_REG_BIT_IS_SET(Ehc, Offset, Bit) \
 108           (EHC_BIT_IS_SET(EhcReadOpReg ((Ehc), (Offset)), (Bit)))
 109
 110 #define USB2_HC_DEV_SIGNATURE  SIGNATURE_32 ('e', 'h', 'c', 'i')
 111 #define EHC_FROM_THIS(a)       CR(a, USB2_HC_DEV, Usb2Hc, USB2_HC_DEV_SIGNATURE)
 112
 113 struct _USB2_HC_DEV {
 114   UINTN                     Signature;
 115   EFI_USB2_HC_PROTOCOL      Usb2Hc;
 116
 117   EFI_PCI_IO_PROTOCOL       *PciIo;
 118   UINT64                    OriginalPciAttributes;
 119   USBHC_MEM_POOL            *MemPool;
 120
 121   //
 122   // Schedule data shared between asynchronous and periodic
 123   // transfers:
 124   // ShortReadStop, as its name indicates, is used to terminate
 125   // the short read except the control transfer. EHCI follows
 126   // the alternative next QTD point when a short read happens.
 127   // For control transfer, even the short read happens, try the
 128   // status stage.
 129   //
 130   EHC_QTD                  *ShortReadStop;
 131   EFI_EVENT                 PollTimer;
 132
 133   //
 134   // ExitBootServicesEvent is used to stop the EHC DMA operation
 135   // after exit boot service.
 136   //
 137   EFI_EVENT                 ExitBootServiceEvent;
 138
 139   //
 140   // Asynchronous(bulk and control) transfer schedule data:
 141   // ReclaimHead is used as the head of the asynchronous transfer
 142   // list. It acts as the reclamation header.
 143   //
 144   EHC_QH                   *ReclaimHead;
 145
 146   //
 147   // Peroidic (interrupt) transfer schedule data:
 148   //
 149   VOID                      *PeriodFrame;     // the buffer pointed by this pointer is used to store pci bus address of the QH descriptor.
 150   VOID                      *PeriodFrameHost; // the buffer pointed by this pointer is used to store host memory address of the QH descriptor.
 151   VOID                      *PeriodFrameMap;
 152
 153   EHC_QH                    *PeriodOne;
 154   LIST_ENTRY                AsyncIntTransfers;
 155
 156   //
 157   // EHCI configuration data
 158   //
 159   UINT32                    HcStructParams; // Cache of HC structure parameter, EHC_HCSPARAMS_OFFSET
 160   UINT32                    HcCapParams;    // Cache of HC capability parameter, HCCPARAMS
 161   UINT32                    CapLen;         // Capability length
 162
 163   //
 164   // Misc
 165   //
 166   EFI_UNICODE_STRING_TABLE  *ControllerNameTable;
 167
 168   //
 169   // EHCI debug port info
 170   //
 171   UINT16                    DebugPortOffset; // The offset of debug port mmio register
 172   UINT8                     DebugPortBarNum; // The bar number of debug port mmio register
 173   UINT8                     DebugPortNum;    // The port number of usb debug port
 174 };
 175
 176
 177 extern EFI_DRIVER_BINDING_PROTOCOL      gEhciDriverBinding;
 178 extern EFI_COMPONENT_NAME_PROTOCOL      gEhciComponentName;
 179 extern EFI_COMPONENT_NAME2_PROTOCOL     gEhciComponentName2;
 180
 181 /**
 182   Test to see if this driver supports ControllerHandle. Any
 183   ControllerHandle that has Usb2HcProtocol installed will
 184   be supported.
 185
 186   @param  This                 Protocol instance pointer.
 187   @param  Controller           Handle of device to test.
 188   @param  RemainingDevicePath  Not used.
 189
 190   @return EFI_SUCCESS          This driver supports this device.
 191   @return EFI_UNSUPPORTED      This driver does not support this device.
 192
 193 **/
 194 EFI_STATUS
 195 EFIAPI
 196 EhcDriverBindingSupported (
 197   IN EFI_DRIVER_BINDING_PROTOCOL *This,
 198   IN EFI_HANDLE                  Controller,
 199   IN EFI_DEVICE_PATH_PROTOCOL    *RemainingDevicePath
 200   );
 201
 202 /**
 203   Starting the Usb EHCI Driver.
 204
 205   @param  This                 Protocol instance pointer.
 206   @param  Controller           Handle of device to test.
 207   @param  RemainingDevicePath  Not used.
 208
 209   @return EFI_SUCCESS          supports this device.
 210   @return EFI_UNSUPPORTED      do not support this device.
 211   @return EFI_DEVICE_ERROR     cannot be started due to device Error.
 212   @return EFI_OUT_OF_RESOURCES cannot allocate resources.
 213
 214 **/
 215 EFI_STATUS
 216 EFIAPI
 217 EhcDriverBindingStart (
 218   IN EFI_DRIVER_BINDING_PROTOCOL *This,
 219   IN EFI_HANDLE                  Controller,
 220   IN EFI_DEVICE_PATH_PROTOCOL    *RemainingDevicePath
 221   );
 222
 223 /**
 224   Stop this driver on ControllerHandle. Support stoping any child handles
 225   created by this driver.
 226
 227   @param  This                 Protocol instance pointer.
 228   @param  Controller           Handle of device to stop driver on.
 229   @param  NumberOfChildren     Number of Children in the ChildHandleBuffer.
 230   @param  ChildHandleBuffer    List of handles for the children we need to stop.
 231
 232   @return EFI_SUCCESS          Success.
 233   @return EFI_DEVICE_ERROR     Fail.
 234
 235 **/
 236 EFI_STATUS
 237 EFIAPI
 238 EhcDriverBindingStop (
 239   IN EFI_DRIVER_BINDING_PROTOCOL *This,
 240   IN EFI_HANDLE                  Controller,
 241   IN UINTN                       NumberOfChildren,
 242   IN EFI_HANDLE                  *ChildHandleBuffer
 243   );
 244
 245 #endif
 246