/** @file\r
\r
-Copyright (c) 2004 - 2007, Intel Corporation\r
+ The definition for UHCI driver model and HC protocol routines.\r
+\r
+Copyright (c) 2004 - 2009, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\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
-Module Name:\r
-\r
- Uhci.h\r
-\r
-Abstract:\r
-\r
- The definition for UHCI driver model and HC protocol routines.\r
+**/\r
\r
-Revision History\r
+#ifndef _EFI_UHCI_H_\r
+#define _EFI_UHCI_H_\r
\r
\r
-**/\r
+#include <Uefi.h>\r
\r
-#ifndef _UHCI_H\r
-#define _UHCI_H\r
-\r
-//\r
-// The package level header files this module uses\r
-//\r
-#include <PiDxe.h>\r
-//\r
-// The protocols, PPI and GUID defintions for this module\r
-//\r
#include <Protocol/Usb2HostController.h>\r
#include <Protocol/UsbHostController.h>\r
#include <Protocol/PciIo.h>\r
-//\r
-// The Library classes this module consumes\r
-//\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/UefiLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
+#include <Library/PcdLib.h>\r
\r
#include <IndustryStandard/Pci22.h>\r
\r
#include "UhciReg.h"\r
#include "UhciSched.h"\r
#include "UhciDebug.h"\r
+#include "ComponentName.h"\r
+\r
+typedef enum {\r
+ UHC_1_MICROSECOND = 1,\r
+ UHC_1_MILLISECOND = 1000 * UHC_1_MICROSECOND,\r
+ UHC_1_SECOND = 1000 * UHC_1_MILLISECOND,\r
+\r
+ //\r
+ // UHCI register operation timeout, set by experience\r
+ //\r
+ UHC_GENERIC_TIMEOUT = UHC_1_SECOND,\r
\r
-enum {\r
//\r
- // Stall times\r
+ // Wait for force global resume(FGR) complete, refers to\r
+ // specification[UHCI11-2.1.1]\r
//\r
- STALL_1_MS = 1000,\r
- STALL_1_SECOND = 1000 *STALL_1_MS,\r
+ UHC_FORCE_GLOBAL_RESUME_STALL = 20 * UHC_1_MILLISECOND,\r
\r
- UHC_SYN_POLL = 50,\r
- FORCE_GLOBAL_RESUME_TIME = 20 *STALL_1_MS,\r
- ROOT_PORT_REST_TIME = 50 *STALL_1_MS,\r
- PORT_RESET_RECOVERY_TIME = 10 *STALL_1_MS,\r
- INTERRUPT_POLLING_TIME = 50 * 10000UL,\r
+ //\r
+ // Wait for roothub port reset and recovery, reset stall\r
+ // is set by experience, and recovery stall refers to\r
+ // specification[UHCI11-2.1.1]\r
+ //\r
+ UHC_ROOT_PORT_RESET_STALL = 50 * UHC_1_MILLISECOND,\r
+ UHC_ROOT_PORT_RECOVERY_STALL = 10 * UHC_1_MILLISECOND,\r
\r
//\r
- // UHC raises TPL to TPL_NOTIFY to serialize all its operations\r
- // to protect shared data structures.\r
+ // Sync and Async transfer polling interval, set by experience,\r
+ // and the unit of Async is 100us.\r
//\r
- UHCI_TPL = TPL_NOTIFY,\r
+ UHC_SYNC_POLL_INTERVAL = 50 * UHC_1_MICROSECOND,\r
+ UHC_ASYNC_POLL_INTERVAL = 50 * 10000UL\r
+}UHC_TIMEOUT_EXPERIENCE_VALUE;\r
\r
- USB_HC_DEV_SIGNATURE = EFI_SIGNATURE_32 ('u', 'h', 'c', 'i')\r
-};\r
+\r
+//\r
+// UHC raises TPL to TPL_NOTIFY to serialize all its operations\r
+// to protect shared data structures.\r
+//\r
+#define UHCI_TPL TPL_NOTIFY\r
+\r
+#define USB_HC_DEV_SIGNATURE SIGNATURE_32 ('u', 'h', 'c', 'i')\r
\r
#pragma pack(1)\r
typedef struct {\r
} USB_CLASSC;\r
#pragma pack()\r
\r
-#define UHC_FROM_USB_HC_PROTO(This) CR(This, USB_HC_DEV, UsbHc, USB_HC_DEV_SIGNATURE)\r
#define UHC_FROM_USB2_HC_PROTO(This) CR(This, USB_HC_DEV, Usb2Hc, USB_HC_DEV_SIGNATURE)\r
\r
//\r
//\r
struct _USB_HC_DEV {\r
UINT32 Signature;\r
- EFI_USB_HC_PROTOCOL UsbHc;\r
EFI_USB2_HC_PROTOCOL Usb2Hc;\r
EFI_PCI_IO_PROTOCOL *PciIo;\r
+ UINT64 OriginalPciAttributes;\r
\r
//\r
// Schedule data structures\r
USBHC_MEM_POOL *MemPool;\r
EFI_UNICODE_STRING_TABLE *CtrlNameTable;\r
VOID *FrameMapping;\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
-extern EFI_DRIVER_BINDING_PROTOCOL gUhciDriverBinding;\r
-extern EFI_COMPONENT_NAME_PROTOCOL gUhciComponentName;\r
+extern EFI_DRIVER_BINDING_PROTOCOL gUhciDriverBinding;\r
+extern EFI_COMPONENT_NAME_PROTOCOL gUhciComponentName;\r
+extern EFI_COMPONENT_NAME2_PROTOCOL gUhciComponentName2;\r
+\r
+/**\r
+ Test to see if this driver supports ControllerHandle. Any\r
+ ControllerHandle that has UsbHcProtocol installed will 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
+UhciDriverBindingSupported (\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 UHCI Driver.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param Controller Handle of device to test.\r
+ @param RemainingDevicePath Not used.\r
+\r
+ @retval EFI_SUCCESS This driver supports this device.\r
+ @retval EFI_UNSUPPORTED This driver does not support this device.\r
+ @retval EFI_DEVICE_ERROR This driver cannot be started due to device Error.\r
+ EFI_OUT_OF_RESOURCES- Failed due to resource shortage.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+UhciDriverBindingStart (\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 stoping 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\r
+ @return others\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+UhciDriverBindingStop (\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
projects / mirror_edk2.git / blobdiff