3 Provides some data struct used by EHCI controller driver.
5 Copyright (c) 2006 - 2010, Intel Corporation
6 All rights reserved. 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
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.
22 #include <Protocol/Usb2HostController.h>
23 #include <Protocol/PciIo.h>
25 #include <Guid/EventGroup.h>
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>
36 #include <IndustryStandard/Pci.h>
38 typedef struct _USB2_HC_DEV USB2_HC_DEV
;
43 #include "EhciSched.h"
44 #include "EhciDebug.h"
45 #include "ComponentName.h"
48 // EHC timeout experience values
51 #define EHC_1_MICROSECOND 1
52 #define EHC_1_MILLISECOND (1000 * EHC_1_MICROSECOND)
53 #define EHC_1_SECOND (1000 * EHC_1_MILLISECOND)
56 // EHCI register operation timeout, set by experience
58 #define EHC_RESET_TIMEOUT (1 * EHC_1_SECOND)
59 #define EHC_GENERIC_TIMEOUT (10 * EHC_1_MILLISECOND)
62 // Wait for roothub port power stable, refers to Spec[EHCI1.0-2.3.9]
64 #define EHC_ROOT_PORT_RECOVERY_STALL (20 * EHC_1_MILLISECOND)
67 // Sync and Async transfer polling interval, set by experience,
68 // and the unit of Async is 100us, means 50ms as interval.
70 #define EHC_SYNC_POLL_INTERVAL (1 * EHC_1_MILLISECOND)
71 #define EHC_ASYNC_POLL_INTERVAL (50 * 10000U)
74 // EHC raises TPL to TPL_NOTIFY to serialize all its operations
75 // to protect shared data structures.
77 #define EHC_TPL TPL_NOTIFY
80 //Iterate through the doule linked list. NOT delete safe
82 #define EFI_LIST_FOR_EACH(Entry, ListHead) \
83 for(Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink)
86 //Iterate through the doule linked list. This is delete-safe.
87 //Don't touch NextEntry
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)
93 #define EFI_LIST_CONTAINER(Entry, Type, Field) BASE_CR(Entry, Type, Field)
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)))
100 #define EHC_REG_BIT_IS_SET(Ehc, Offset, Bit) \
101 (EHC_BIT_IS_SET(EhcReadOpReg ((Ehc), (Offset)), (Bit)))
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)
106 struct _USB2_HC_DEV
{
108 EFI_USB2_HC_PROTOCOL Usb2Hc
;
110 EFI_PCI_IO_PROTOCOL
*PciIo
;
111 UINT64 OriginalPciAttributes
;
112 USBHC_MEM_POOL
*MemPool
;
115 // Schedule data shared between asynchronous and periodic
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
123 EHC_QTD
*ShortReadStop
;
127 // ExitBootServicesEvent is used to stop the EHC DMA operation
128 // after exit boot service.
130 EFI_EVENT ExitBootServiceEvent
;
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.
140 // Peroidic (interrupt) transfer schedule data:
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
;
147 LIST_ENTRY AsyncIntTransfers
;
150 // EHCI configuration data
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
159 EFI_UNICODE_STRING_TABLE
*ControllerNameTable
;
163 extern EFI_DRIVER_BINDING_PROTOCOL gEhciDriverBinding
;
164 extern EFI_COMPONENT_NAME_PROTOCOL gEhciComponentName
;
165 extern EFI_COMPONENT_NAME2_PROTOCOL gEhciComponentName2
;
168 Test to see if this driver supports ControllerHandle. Any
169 ControllerHandle that has Usb2HcProtocol installed will
172 @param This Protocol instance pointer.
173 @param Controller Handle of device to test.
174 @param RemainingDevicePath Not used.
176 @return EFI_SUCCESS This driver supports this device.
177 @return EFI_UNSUPPORTED This driver does not support this device.
182 EhcDriverBindingSupported (
183 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
184 IN EFI_HANDLE Controller
,
185 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
189 Starting the Usb EHCI Driver.
191 @param This Protocol instance pointer.
192 @param Controller Handle of device to test.
193 @param RemainingDevicePath Not used.
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.
203 EhcDriverBindingStart (
204 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
205 IN EFI_HANDLE Controller
,
206 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
210 Stop this driver on ControllerHandle. Support stoping any child handles
211 created by this driver.
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.
218 @return EFI_SUCCESS Success.
219 @return EFI_DEVICE_ERROR Fail.
224 EhcDriverBindingStop (
225 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
226 IN EFI_HANDLE Controller
,
227 IN UINTN NumberOfChildren
,
228 IN EFI_HANDLE
*ChildHandleBuffer