MdeModulePkg/Bus/Pci/EhciDxe/Ehci.h

   1 /** @file
   2
   3   Provides some data struct used by EHCI controller driver.
   4
   5 Copyright (c) 2006 - 2010, 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 // EHC raises TPL to TPL_NOTIFY to serialize all its operations
  75 // to protect shared data structures.
  76 //
  77 #define  EHC_TPL                TPL_NOTIFY
  78
  79 //
  80 //Iterate through the doule linked list. NOT delete safe
  81 //
  82 #define EFI_LIST_FOR_EACH(Entry, ListHead)    \
  83   for(Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink)
  84
  85 //
  86 //Iterate through the doule linked list. This is delete-safe.
  87 //Don't touch NextEntry
  88 //
  89 #define EFI_LIST_FOR_EACH_SAFE(Entry, NextEntry, ListHead)            \
  90   for(Entry = (ListHead)->ForwardLink, NextEntry = Entry->ForwardLink;\
  91       Entry != (ListHead); Entry = NextEntry, NextEntry = Entry->ForwardLink)
  92
  93 #define EFI_LIST_CONTAINER(Entry, Type, Field) BASE_CR(Entry, Type, Field)
  94
  95
  96 #define EHC_LOW_32BIT(Addr64)     ((UINT32)(((UINTN)(Addr64)) & 0XFFFFFFFF))
  97 #define EHC_HIGH_32BIT(Addr64)    ((UINT32)(RShiftU64((UINTN)(Addr64), 32) & 0XFFFFFFFF))
  98 #define EHC_BIT_IS_SET(Data, Bit) ((BOOLEAN)(((Data) & (Bit)) == (Bit)))
  99
 100 #define EHC_REG_BIT_IS_SET(Ehc, Offset, Bit) \
 101           (EHC_BIT_IS_SET(EhcReadOpReg ((Ehc), (Offset)), (Bit)))
 102
 103 #define USB2_HC_DEV_SIGNATURE  SIGNATURE_32 ('e', 'h', 'c', 'i')
 104 #define EHC_FROM_THIS(a)       CR(a, USB2_HC_DEV, Usb2Hc, USB2_HC_DEV_SIGNATURE)
 105
 106 struct _USB2_HC_DEV {
 107   UINTN                     Signature;
 108   EFI_USB2_HC_PROTOCOL      Usb2Hc;
 109
 110   EFI_PCI_IO_PROTOCOL       *PciIo;
 111   UINT64                    OriginalPciAttributes;
 112   USBHC_MEM_POOL            *MemPool;
 113
 114   //
 115   // Schedule data shared between asynchronous and periodic
 116   // transfers:
 117   // ShortReadStop, as its name indicates, is used to terminate
 118   // the short read except the control transfer. EHCI follows
 119   // the alternative next QTD point when a short read happens.
 120   // For control transfer, even the short read happens, try the
 121   // status stage.
 122   //
 123   EHC_QTD                  *ShortReadStop;
 124   EFI_EVENT                 PollTimer;
 125
 126   //
 127   // ExitBootServicesEvent is used to stop the EHC DMA operation
 128   // after exit boot service.
 129   //
 130   EFI_EVENT                 ExitBootServiceEvent;
 131
 132   //
 133   // Asynchronous(bulk and control) transfer schedule data:
 134   // ReclaimHead is used as the head of the asynchronous transfer
 135   // list. It acts as the reclamation header.
 136   //
 137   EHC_QH                   *ReclaimHead;
 138
 139   //
 140   // Peroidic (interrupt) transfer schedule data:
 141   //
 142   VOID                      *PeriodFrame;     // the buffer pointed by this pointer is used to store pci bus address of the QH descriptor.
 143   VOID                      *PeriodFrameHost; // the buffer pointed by this pointer is used to store host memory address of the QH descriptor.
 144   VOID                      *PeriodFrameMap;
 145
 146   EHC_QH                    *PeriodOne;
 147   LIST_ENTRY                AsyncIntTransfers;
 148
 149   //
 150   // EHCI configuration data
 151   //
 152   UINT32                    HcStructParams; // Cache of HC structure parameter, EHC_HCSPARAMS_OFFSET
 153   UINT32                    HcCapParams;    // Cache of HC capability parameter, HCCPARAMS
 154   UINT32                    CapLen;         // Capability length
 155
 156   //
 157   // Misc
 158   //
 159   EFI_UNICODE_STRING_TABLE  *ControllerNameTable;
 160 };
 161
 162
 163 extern EFI_DRIVER_BINDING_PROTOCOL      gEhciDriverBinding;
 164 extern EFI_COMPONENT_NAME_PROTOCOL      gEhciComponentName;
 165 extern EFI_COMPONENT_NAME2_PROTOCOL     gEhciComponentName2;
 166
 167 /**
 168   Test to see if this driver supports ControllerHandle. Any
 169   ControllerHandle that has Usb2HcProtocol installed will
 170   be supported.
 171
 172   @param  This                 Protocol instance pointer.
 173   @param  Controller           Handle of device to test.
 174   @param  RemainingDevicePath  Not used.
 175
 176   @return EFI_SUCCESS          This driver supports this device.
 177   @return EFI_UNSUPPORTED      This driver does not support this device.
 178
 179 **/
 180 EFI_STATUS
 181 EFIAPI
 182 EhcDriverBindingSupported (
 183   IN EFI_DRIVER_BINDING_PROTOCOL *This,
 184   IN EFI_HANDLE                  Controller,
 185   IN EFI_DEVICE_PATH_PROTOCOL    *RemainingDevicePath
 186   );
 187
 188 /**
 189   Starting the Usb EHCI Driver.
 190
 191   @param  This                 Protocol instance pointer.
 192   @param  Controller           Handle of device to test.
 193   @param  RemainingDevicePath  Not used.
 194
 195   @return EFI_SUCCESS          supports this device.
 196   @return EFI_UNSUPPORTED      do not support this device.
 197   @return EFI_DEVICE_ERROR     cannot be started due to device Error.
 198   @return EFI_OUT_OF_RESOURCES cannot allocate resources.
 199
 200 **/
 201 EFI_STATUS
 202 EFIAPI
 203 EhcDriverBindingStart (
 204   IN EFI_DRIVER_BINDING_PROTOCOL *This,
 205   IN EFI_HANDLE                  Controller,
 206   IN EFI_DEVICE_PATH_PROTOCOL    *RemainingDevicePath
 207   );
 208
 209 /**
 210   Stop this driver on ControllerHandle. Support stoping any child handles
 211   created by this driver.
 212
 213   @param  This                 Protocol instance pointer.
 214   @param  Controller           Handle of device to stop driver on.
 215   @param  NumberOfChildren     Number of Children in the ChildHandleBuffer.
 216   @param  ChildHandleBuffer    List of handles for the children we need to stop.
 217
 218   @return EFI_SUCCESS          Success.
 219   @return EFI_DEVICE_ERROR     Fail.
 220
 221 **/
 222 EFI_STATUS
 223 EFIAPI
 224 EhcDriverBindingStop (
 225   IN EFI_DRIVER_BINDING_PROTOCOL *This,
 226   IN EFI_HANDLE                  Controller,
 227   IN UINTN                       NumberOfChildren,
 228   IN EFI_HANDLE                  *ChildHandleBuffer
 229   );
 230
 231 #endif
 232