X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdeModulePkg%2FBus%2FPci%2FEhciDxe%2FEhci.c;h=700e69e495679a16dfefd6525df7944ad3035384;hb=0f58371b5df22ca7894b0febd09d0c95b02da1f0;hp=9d181351a2fedd37a8020d74fe965ff04ea9f0bf;hpb=cc582cffd10ab8240070d2fe475c7a115bc99912;p=mirror_edk2.git diff --git a/MdeModulePkg/Bus/Pci/EhciDxe/Ehci.c b/MdeModulePkg/Bus/Pci/EhciDxe/Ehci.c index 9d181351a2..700e69e495 100644 --- a/MdeModulePkg/Bus/Pci/EhciDxe/Ehci.c +++ b/MdeModulePkg/Bus/Pci/EhciDxe/Ehci.c @@ -1,7 +1,18 @@ -/** @file +/** @file + The Ehci controller driver. -Copyright (c) 2006 - 2007, Intel Corporation -All rights reserved. This program and the accompanying materials + EhciDxe driver is responsible for managing the behavior of EHCI controller. + It implements the interfaces of monitoring the status of all ports and transferring + Control, Bulk, Interrupt and Isochronous requests to Usb2.0 device. + + Note that EhciDxe driver is enhanced to guarantee that the EHCI controller get attached + to the EHCI controller before a UHCI or OHCI driver attaches to the companion UHCI or + OHCI controller. This way avoids the control transfer on a shared port between EHCI + and companion host controller when UHCI or OHCI gets attached earlier than EHCI and a + USB 2.0 device inserts. + +Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.
+This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php @@ -9,15 +20,6 @@ http://opensource.org/licenses/bsd-license.php THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. -Module Name: - - Ehci.c - -Abstract: - - -Revision History - **/ @@ -43,21 +45,29 @@ USB_PORT_STATE_MAP mUsbPortChangeMap[] = { {PORTSC_OVERCUR_CHANGE, USB_PORT_STAT_C_OVERCURRENT} }; +EFI_DRIVER_BINDING_PROTOCOL +gEhciDriverBinding = { + EhcDriverBindingSupported, + EhcDriverBindingStart, + EhcDriverBindingStop, + 0x30, + NULL, + NULL +}; /** - Retrieves the capablility of root hub ports. + Retrieves the capability of root hub ports. - @param This This EFI_USB_HC_PROTOCOL instance. - @param MaxSpeed Max speed supported by the controller - @param PortNumber Number of the root hub ports. - @param Is64BitCapable Whether the controller supports 64-bit memory - addressing. + @param This This EFI_USB_HC_PROTOCOL instance. + @param MaxSpeed Max speed supported by the controller. + @param PortNumber Number of the root hub ports. + @param Is64BitCapable Whether the controller supports 64-bit memory + addressing. - @return EFI_SUCCESS : host controller capability were retrieved successfully. - @return EFI_INVALID_PARAMETER : Either of the three capability pointer is NULL + @retval EFI_SUCCESS Host controller capability were retrieved successfully. + @retval EFI_INVALID_PARAMETER Either of the three capability pointer is NULL. **/ -STATIC EFI_STATUS EFIAPI EhcGetCapability ( @@ -91,17 +101,16 @@ EhcGetCapability ( /** Provides software reset for the USB host controller. - @param This This EFI_USB2_HC_PROTOCOL instance. - @param Attributes A bit mask of the reset operation to perform. + @param This This EFI_USB2_HC_PROTOCOL instance. + @param Attributes A bit mask of the reset operation to perform. - @return EFI_SUCCESS : The reset operation succeeded. - @return EFI_INVALID_PARAMETER : Attributes is not valid. - @return EFI_UNSUPPOURTED : The type of reset specified by Attributes is - @return not currently supported by the host controller. - @return EFI_DEVICE_ERROR : Host controller isn't halted to reset. + @retval EFI_SUCCESS The reset operation succeeded. + @retval EFI_INVALID_PARAMETER Attributes is not valid. + @retval EFI_UNSUPPOURTED The type of reset specified by Attributes is + not currently supported by the host controller. + @retval EFI_DEVICE_ERROR Host controller isn't halted to reset. **/ -STATIC EFI_STATUS EFIAPI EhcReset ( @@ -112,9 +121,22 @@ EhcReset ( USB2_HC_DEV *Ehc; EFI_TPL OldTpl; EFI_STATUS Status; + UINT32 DbgCtrlStatus; + + Ehc = EHC_FROM_THIS (This); + + if (Ehc->DevicePath != NULL) { + // + // Report Status Code to indicate reset happens + // + REPORT_STATUS_CODE_WITH_DEVICE_PATH ( + EFI_PROGRESS_CODE, + (EFI_IO_BUS_USB | EFI_IOB_PC_RESET), + Ehc->DevicePath + ); + } OldTpl = gBS->RaiseTPL (EHC_TPL); - Ehc = EHC_FROM_THIS (This); switch (Attributes) { case EFI_USB_HC_RESET_GLOBAL: @@ -125,6 +147,14 @@ EhcReset ( // // Host Controller must be Halt when Reset it // + if (Ehc->DebugPortNum != 0) { + DbgCtrlStatus = EhcReadDbgRegister(Ehc, 0); + if ((DbgCtrlStatus & (USB_DEBUG_PORT_IN_USE | USB_DEBUG_PORT_OWNER)) == (USB_DEBUG_PORT_IN_USE | USB_DEBUG_PORT_OWNER)) { + Status = EFI_SUCCESS; + goto ON_EXIT; + } + } + if (!EhcIsHalt (Ehc)) { Status = EhcHaltHC (Ehc, EHC_GENERIC_TIMEOUT); @@ -170,22 +200,21 @@ ON_EXIT: /** Retrieve the current state of the USB host controller. - @param This This EFI_USB2_HC_PROTOCOL instance. - @param State Variable to return the current host controller - state. + @param This This EFI_USB2_HC_PROTOCOL instance. + @param State Variable to return the current host controller + state. - @return EFI_SUCCESS : Host controller state was returned in State. - @return EFI_INVALID_PARAMETER : State is NULL. - @return EFI_DEVICE_ERROR : An error was encountered while attempting to - @return retrieve the host controller's current state. + @retval EFI_SUCCESS Host controller state was returned in State. + @retval EFI_INVALID_PARAMETER State is NULL. + @retval EFI_DEVICE_ERROR An error was encountered while attempting to + retrieve the host controller's current state. **/ -STATIC EFI_STATUS EFIAPI EhcGetState ( - IN CONST EFI_USB2_HC_PROTOCOL *This, - OUT EFI_USB_HC_STATE *State + IN EFI_USB2_HC_PROTOCOL *This, + OUT EFI_USB_HC_STATE *State ) { EFI_TPL OldTpl; @@ -214,16 +243,15 @@ EhcGetState ( /** Sets the USB host controller to a specific state. - @param This This EFI_USB2_HC_PROTOCOL instance. - @param State The state of the host controller that will be set. + @param This This EFI_USB2_HC_PROTOCOL instance. + @param State The state of the host controller that will be set. - @return EFI_SUCCESS : The USB host controller was successfully placed - @return in the state specified by State. - @return EFI_INVALID_PARAMETER : State is invalid. - @return EFI_DEVICE_ERROR : Failed to set the state due to device error. + @retval EFI_SUCCESS The USB host controller was successfully placed + in the state specified by State. + @retval EFI_INVALID_PARAMETER State is invalid. + @retval EFI_DEVICE_ERROR Failed to set the state due to device error. **/ -STATIC EFI_STATUS EFIAPI EhcSetState ( @@ -290,24 +318,23 @@ EhcSetState ( /** Retrieves the current status of a USB root hub port. - @param This This EFI_USB2_HC_PROTOCOL instance. - @param PortNumber The root hub port to retrieve the state from. This - value is zero-based. - @param PortStatus Variable to receive the port state + @param This This EFI_USB2_HC_PROTOCOL instance. + @param PortNumber The root hub port to retrieve the state from. + This value is zero-based. + @param PortStatus Variable to receive the port state. - @return EFI_SUCCESS : The status of the USB root hub port specified - @return by PortNumber was returned in PortStatus. - @return EFI_INVALID_PARAMETER : PortNumber is invalid. - @return EFI_DEVICE_ERROR : Can't read register + @retval EFI_SUCCESS The status of the USB root hub port specified. + by PortNumber was returned in PortStatus. + @retval EFI_INVALID_PARAMETER PortNumber is invalid. + @retval EFI_DEVICE_ERROR Can't read register. **/ -STATIC EFI_STATUS EFIAPI EhcGetRootHubPortStatus ( - IN CONST EFI_USB2_HC_PROTOCOL *This, - IN CONST UINT8 PortNumber, - OUT EFI_USB_PORT_STATUS *PortStatus + IN EFI_USB2_HC_PROTOCOL *This, + IN UINT8 PortNumber, + OUT EFI_USB_PORT_STATUS *PortStatus ) { USB2_HC_DEV *Ehc; @@ -318,6 +345,7 @@ EhcGetRootHubPortStatus ( UINTN Index; UINTN MapSize; EFI_STATUS Status; + UINT32 DbgCtrlStatus; if (PortStatus == NULL) { return EFI_INVALID_PARAMETER; @@ -339,6 +367,13 @@ EhcGetRootHubPortStatus ( PortStatus->PortStatus = 0; PortStatus->PortChangeStatus = 0; + if ((Ehc->DebugPortNum != 0) && (PortNumber == (Ehc->DebugPortNum - 1))) { + DbgCtrlStatus = EhcReadDbgRegister(Ehc, 0); + if ((DbgCtrlStatus & (USB_DEBUG_PORT_IN_USE | USB_DEBUG_PORT_OWNER)) == (USB_DEBUG_PORT_IN_USE | USB_DEBUG_PORT_OWNER)) { + goto ON_EXIT; + } + } + State = EhcReadOpReg (Ehc, Offset); // @@ -382,16 +417,15 @@ ON_EXIT: /** Sets a feature for the specified root hub port. - @param This This EFI_USB2_HC_PROTOCOL instance. - @param PortNumber Root hub port to set. - @param PortFeature Feature to set + @param This This EFI_USB2_HC_PROTOCOL instance. + @param PortNumber Root hub port to set. + @param PortFeature Feature to set. - @return EFI_SUCCESS : The feature specified by PortFeature was set - @return EFI_INVALID_PARAMETER : PortNumber is invalid or PortFeature is invalid. - @return EFI_DEVICE_ERROR : Can't read register + @retval EFI_SUCCESS The feature specified by PortFeature was set. + @retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid. + @retval EFI_DEVICE_ERROR Can't read register. **/ -STATIC EFI_STATUS EFIAPI EhcSetRootHubPortFeature ( @@ -465,9 +499,12 @@ EhcSetRootHubPortFeature ( case EfiUsbPortPower: // - // Not supported, ignore the operation + // Set port power bit when PPC is 1 // - Status = EFI_SUCCESS; + if ((Ehc->HcCapParams & HCSP_PPC) == HCSP_PPC) { + State |= PORTSC_POWER; + EhcWriteOpReg (Ehc, Offset, State); + } break; case EfiUsbPortOwner: @@ -490,19 +527,18 @@ ON_EXIT: /** Clears a feature for the specified root hub port. - @param This A pointer to the EFI_USB2_HC_PROTOCOL instance. - @param PortNumber Specifies the root hub port whose feature is - requested to be cleared. - @param PortFeature Indicates the feature selector associated with the - feature clear request. + @param This A pointer to the EFI_USB2_HC_PROTOCOL instance. + @param PortNumber Specifies the root hub port whose feature is + requested to be cleared. + @param PortFeature Indicates the feature selector associated with the + feature clear request. - @return EFI_SUCCESS : The feature specified by PortFeature was cleared - @return for the USB root hub port specified by PortNumber. - @return EFI_INVALID_PARAMETER : PortNumber is invalid or PortFeature is invalid. - @return EFI_DEVICE_ERROR : Can't read register + @retval EFI_SUCCESS The feature specified by PortFeature was cleared + for the USB root hub port specified by PortNumber. + @retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid. + @retval EFI_DEVICE_ERROR Can't read register. **/ -STATIC EFI_STATUS EFIAPI EhcClearRootHubPortFeature ( @@ -595,6 +631,14 @@ EhcClearRootHubPortFeature ( break; case EfiUsbPortPower: + // + // Clear port power bit when PPC is 1 + // + if ((Ehc->HcCapParams & HCSP_PPC) == HCSP_PPC) { + State &= ~PORTSC_POWER; + EhcWriteOpReg (Ehc, Offset, State); + } + break; case EfiUsbPortSuspendChange: case EfiUsbPortResetChange: // @@ -617,28 +661,27 @@ ON_EXIT: /** Submits control transfer to a target USB device. - @param This This EFI_USB2_HC_PROTOCOL instance. - @param DeviceAddress The target device address - @param DeviceSpeed Target device speed. - @param MaximumPacketLength Maximum packet size the default control transfer - endpoint is capable of sending or receiving. - @param Request USB device request to send - @param TransferDirection Specifies the data direction for the data stage - @param Data Data buffer to be transmitted or received from USB - device. - @param DataLength The size (in bytes) of the data buffer - @param TimeOut Indicates the maximum timeout, in millisecond, - @param Translator Transaction translator to be used by this device. - @param TransferResult Return the result of this control transfer. - - @return EFI_SUCCESS : Transfer was completed successfully. - @return EFI_OUT_OF_RESOURCES : The transfer failed due to lack of resources. - @return EFI_INVALID_PARAMETER : Some parameters are invalid. - @return EFI_TIMEOUT : Transfer failed due to timeout. - @return EFI_DEVICE_ERROR : Transfer failed due to host controller or device error. + @param This This EFI_USB2_HC_PROTOCOL instance. + @param DeviceAddress The target device address. + @param DeviceSpeed Target device speed. + @param MaximumPacketLength Maximum packet size the default control transfer + endpoint is capable of sending or receiving. + @param Request USB device request to send. + @param TransferDirection Specifies the data direction for the data stage + @param Data Data buffer to be transmitted or received from USB + device. + @param DataLength The size (in bytes) of the data buffer. + @param TimeOut Indicates the maximum timeout, in millisecond. + @param Translator Transaction translator to be used by this device. + @param TransferResult Return the result of this control transfer. + + @retval EFI_SUCCESS Transfer was completed successfully. + @retval EFI_OUT_OF_RESOURCES The transfer failed due to lack of resources. + @retval EFI_INVALID_PARAMETER Some parameters are invalid. + @retval EFI_TIMEOUT Transfer failed due to timeout. + @retval EFI_DEVICE_ERROR Transfer failed due to host controller or device error. **/ -STATIC EFI_STATUS EFIAPI EhcControlTransfer ( @@ -775,35 +818,33 @@ ON_EXIT: /** Submits bulk transfer to a bulk endpoint of a USB device. - @param This This EFI_USB2_HC_PROTOCOL instance. - @param DeviceAddress Target device address - @param EndPointAddress Endpoint number and its direction in bit 7. . - @param DeviceSpeed Device speed, Low speed device doesn't support bulk - transfer. - @param MaximumPacketLength Maximum packet size the endpoint is capable of - sending or receiving. - @param DataBuffersNumber Number of data buffers prepared for the transfer. - @param Data Array of pointers to the buffers of data to transmit + @param This This EFI_USB2_HC_PROTOCOL instance. + @param DeviceAddress Target device address. + @param EndPointAddress Endpoint number and its direction in bit 7. + @param DeviceSpeed Device speed, Low speed device doesn't support bulk + transfer. + @param MaximumPacketLength Maximum packet size the endpoint is capable of + sending or receiving. + @param DataBuffersNumber Number of data buffers prepared for the transfer. + @param Data Array of pointers to the buffers of data to transmit from or receive into. - @param DataLength The lenght of the data buffer - @param DataToggle On input, the initial data toggle for the transfer; - On output, it is updated to to next data toggle to - use of the subsequent bulk - transfer. - @param Translator A pointr to the transaction translator data. - @param TimeOut Indicates the maximum time, in millisecond, which - the transfer is allowed to complete. - @param TransferResult A pointer to the detailed result information of the - bulk transfer. - - @return EFI_SUCCESS : The transfer was completed successfully. - @return EFI_OUT_OF_RESOURCES : The transfer failed due to lack of resource. - @return EFI_INVALID_PARAMETER : Some parameters are invalid. - @return EFI_TIMEOUT : The transfer failed due to timeout. - @return EFI_DEVICE_ERROR : The transfer failed due to host controller error. + @param DataLength The lenght of the data buffer. + @param DataToggle On input, the initial data toggle for the transfer; + On output, it is updated to to next data toggle to + use of the subsequent bulk transfer. + @param TimeOut Indicates the maximum time, in millisecond, which + the transfer is allowed to complete. + @param Translator A pointr to the transaction translator data. + @param TransferResult A pointer to the detailed result information of the + bulk transfer. + + @retval EFI_SUCCESS The transfer was completed successfully. + @retval EFI_OUT_OF_RESOURCES The transfer failed due to lack of resource. + @retval EFI_INVALID_PARAMETER Some parameters are invalid. + @retval EFI_TIMEOUT The transfer failed due to timeout. + @retval EFI_DEVICE_ERROR The transfer failed due to host controller error. **/ -STATIC EFI_STATUS EFIAPI EhcBulkTransfer ( @@ -918,32 +959,31 @@ ON_EXIT: Submits an asynchronous interrupt transfer to an interrupt endpoint of a USB device. - @param This This EFI_USB2_HC_PROTOCOL instance. - @param DeviceAddress Target device address - @param EndPointAddress Endpoint number and its direction encoded in bit 7 - @param DeviceSpeed Indicates device speed. - @param MaximumPacketLength Maximum packet size the target endpoint is capable - @param IsNewTransfer If TRUE, to submit an new asynchronous interrupt - transfer If FALSE, to remove the specified - asynchronous interrupt - @param DataToggle On input, the initial data toggle to use; on output, - it is updated to indicate the next data toggle - @param PollingInterval The he interval, in milliseconds, that the transfer - is polled. - @param DataLength The length of data to receive at the rate specified - by PollingInterval. - @param Translator Transaction translator to use. - @param CallBackFunction Function to call at the rate specified by - PollingInterval - @param Context Context to CallBackFunction. - - @return EFI_SUCCESS : The request has been successfully submitted or canceled. - @return EFI_INVALID_PARAMETER : Some parameters are invalid. - @return EFI_OUT_OF_RESOURCES : The request failed due to a lack of resources. - @return EFI_DEVICE_ERROR : The transfer failed due to host controller error. + @param This This EFI_USB2_HC_PROTOCOL instance. + @param DeviceAddress Target device address. + @param EndPointAddress Endpoint number and its direction encoded in bit 7 + @param DeviceSpeed Indicates device speed. + @param MaximumPacketLength Maximum packet size the target endpoint is capable + @param IsNewTransfer If TRUE, to submit an new asynchronous interrupt + transfer If FALSE, to remove the specified + asynchronous interrupt. + @param DataToggle On input, the initial data toggle to use; on output, + it is updated to indicate the next data toggle. + @param PollingInterval The he interval, in milliseconds, that the transfer + is polled. + @param DataLength The length of data to receive at the rate specified + by PollingInterval. + @param Translator Transaction translator to use. + @param CallBackFunction Function to call at the rate specified by + PollingInterval. + @param Context Context to CallBackFunction. + + @retval EFI_SUCCESS The request has been successfully submitted or canceled. + @retval EFI_INVALID_PARAMETER Some parameters are invalid. + @retval EFI_OUT_OF_RESOURCES The request failed due to a lack of resources. + @retval EFI_DEVICE_ERROR The transfer failed due to host controller error. **/ -STATIC EFI_STATUS EFIAPI EhcAsyncInterruptTransfer ( @@ -1067,30 +1107,29 @@ ON_EXIT: Submits synchronous interrupt transfer to an interrupt endpoint of a USB device. - @param This This EFI_USB2_HC_PROTOCOL instance. - @param DeviceAddress Target device address - @param EndPointAddress Endpoint number and its direction encoded in bit 7 - @param DeviceSpeed Indicates device speed. - @param MaximumPacketLength Maximum packet size the target endpoint is capable - of sending or receiving. - @param Data Buffer of data that will be transmitted to USB - device or received from USB device. - @param DataLength On input, the size, in bytes, of the data buffer; On - output, the number of bytes transferred. - @param DataToggle On input, the initial data toggle to use; on output, - it is updated to indicate the next data toggle - @param TimeOut Maximum time, in second, to complete - @param Translator Transaction translator to use. - @param TransferResult Variable to receive the transfer result - - @return EFI_SUCCESS : The transfer was completed successfully. - @return EFI_OUT_OF_RESOURCES : The transfer failed due to lack of resource. - @return EFI_INVALID_PARAMETER : Some parameters are invalid. - @return EFI_TIMEOUT : The transfer failed due to timeout. - @return EFI_DEVICE_ERROR : The failed due to host controller or device error + @param This This EFI_USB2_HC_PROTOCOL instance. + @param DeviceAddress Target device address. + @param EndPointAddress Endpoint number and its direction encoded in bit 7 + @param DeviceSpeed Indicates device speed. + @param MaximumPacketLength Maximum packet size the target endpoint is capable + of sending or receiving. + @param Data Buffer of data that will be transmitted to USB + device or received from USB device. + @param DataLength On input, the size, in bytes, of the data buffer; On + output, the number of bytes transferred. + @param DataToggle On input, the initial data toggle to use; on output, + it is updated to indicate the next data toggle. + @param TimeOut Maximum time, in second, to complete. + @param Translator Transaction translator to use. + @param TransferResult Variable to receive the transfer result. + + @return EFI_SUCCESS The transfer was completed successfully. + @return EFI_OUT_OF_RESOURCES The transfer failed due to lack of resource. + @return EFI_INVALID_PARAMETER Some parameters are invalid. + @return EFI_TIMEOUT The transfer failed due to timeout. + @return EFI_DEVICE_ERROR The failed due to host controller or device error **/ -STATIC EFI_STATUS EFIAPI EhcSyncInterruptTransfer ( @@ -1201,8 +1240,8 @@ ON_EXIT: Submits isochronous transfer to a target USB device. @param This This EFI_USB2_HC_PROTOCOL instance. - @param DeviceAddress Target device address - @param EndPointAddress End point address with its direction + @param DeviceAddress Target device address. + @param EndPointAddress End point address with its direction. @param DeviceSpeed Device speed, Low speed device doesn't support this type. @param MaximumPacketLength Maximum packet size that the endpoint is capable of @@ -1211,14 +1250,13 @@ ON_EXIT: @param Data Array of pointers to the buffers of data that will be transmitted to USB device or received from USB device. - @param DataLength The size, in bytes, of the data buffer + @param DataLength The size, in bytes, of the data buffer. @param Translator Transaction translator to use. - @param TransferResult Variable to receive the transfer result + @param TransferResult Variable to receive the transfer result. - @return EFI_UNSUPPORTED : Isochronous transfer is unsupported. + @return EFI_UNSUPPORTED Isochronous transfer is unsupported. **/ -STATIC EFI_STATUS EFIAPI EhcIsochronousTransfer ( @@ -1242,8 +1280,8 @@ EhcIsochronousTransfer ( Submits Async isochronous transfer to a target USB device. @param This This EFI_USB2_HC_PROTOCOL instance. - @param DeviceAddress Target device address - @param EndPointAddress End point address with its direction + @param DeviceAddress Target device address. + @param EndPointAddress End point address with its direction. @param DeviceSpeed Device speed, Low speed device doesn't support this type. @param MaximumPacketLength Maximum packet size that the endpoint is capable of @@ -1252,16 +1290,15 @@ EhcIsochronousTransfer ( @param Data Array of pointers to the buffers of data that will be transmitted to USB device or received from USB device. - @param DataLength The size, in bytes, of the data buffer + @param DataLength The size, in bytes, of the data buffer. @param Translator Transaction translator to use. - @param IsochronousCallBack Function to be called when the transfer complete + @param IsochronousCallBack Function to be called when the transfer complete. @param Context Context passed to the call back function as - parameter + parameter. - @return EFI_UNSUPPORTED : Isochronous transfer isn't supported + @return EFI_UNSUPPORTED Isochronous transfer isn't supported. **/ -STATIC EFI_STATUS EFIAPI EhcAsyncIsochronousTransfer ( @@ -1281,29 +1318,22 @@ EhcAsyncIsochronousTransfer ( return EFI_UNSUPPORTED; } +/** + Entry point for EFI drivers. + + @param ImageHandle EFI_HANDLE. + @param SystemTable EFI_SYSTEM_TABLE. + + @return EFI_SUCCESS Success. + EFI_DEVICE_ERROR Fail. + +**/ EFI_STATUS EFIAPI EhcDriverEntryPoint ( IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable ) -/*++ - -Routine Description: - - Entry point for EFI drivers. - -Arguments: - - ImageHandle - EFI_HANDLE - SystemTable - EFI_SYSTEM_TABLE - -Returns: - - EFI_SUCCESS Success - EFI_DEVICE_ERROR Fail - ---*/ { return EfiLibInstallDriverBindingComponentName2 ( ImageHandle, @@ -1322,11 +1352,11 @@ Returns: be supported. @param This Protocol instance pointer. - @param Controlle Handle of device to test - @param RemainingDevicePath Not used + @param Controller Handle of device to test. + @param RemainingDevicePath Not used. - @return EFI_SUCCESS : This driver supports this device. - @return EFI_UNSUPPORTED : This driver does not support this device. + @return EFI_SUCCESS This driver supports this device. + @return EFI_UNSUPPORTED This driver does not support this device. **/ EFI_STATUS @@ -1360,7 +1390,7 @@ EhcDriverBindingSupported ( Status = PciIo->Pci.Read ( PciIo, EfiPciIoWidthUint8, - EHC_PCI_CLASSC, + PCI_CLASSCODE_OFFSET, sizeof (USB_CLASSC) / sizeof (UINT8), &UsbClassCReg ); @@ -1373,9 +1403,8 @@ EhcDriverBindingSupported ( // // Test whether the controller belongs to Ehci type // - if ((UsbClassCReg.BaseCode != PCI_CLASS_SERIAL) || - (UsbClassCReg.SubClassCode != PCI_CLASS_SERIAL_USB) || - (UsbClassCReg.PI != EHC_PCI_CLASSC_PI)) { + if ((UsbClassCReg.BaseCode != PCI_CLASS_SERIAL) || (UsbClassCReg.SubClassCode != PCI_CLASS_SERIAL_USB) + || ((UsbClassCReg.ProgInterface != PCI_IF_EHCI) && (UsbClassCReg.ProgInterface != PCI_IF_UHCI) && (UsbClassCReg.ProgInterface != PCI_IF_OHCI))) { Status = EFI_UNSUPPORTED; } @@ -1391,22 +1420,146 @@ ON_EXIT: return Status; } +/** + Get the usb debug port related information. + + @param Ehc The EHCI device. + + @retval RETURN_SUCCESS Get debug port number, bar and offset successfully. + @retval Others The usb host controller does not supported usb debug port capability. + +**/ +EFI_STATUS +EhcGetUsbDebugPortInfo ( + IN USB2_HC_DEV *Ehc + ) +{ + EFI_PCI_IO_PROTOCOL *PciIo; + UINT16 PciStatus; + UINT8 CapabilityPtr; + UINT8 CapabilityId; + UINT16 DebugPort; + EFI_STATUS Status; + + ASSERT (Ehc->PciIo != NULL); + PciIo = Ehc->PciIo; + + // + // Detect if the EHCI host controller support Capaility Pointer. + // + Status = PciIo->Pci.Read ( + PciIo, + EfiPciIoWidthUint8, + PCI_PRIMARY_STATUS_OFFSET, + sizeof (UINT16), + &PciStatus + ); + + if (EFI_ERROR (Status)) { + return Status; + } + + if ((PciStatus & EFI_PCI_STATUS_CAPABILITY) == 0) { + // + // The Pci Device Doesn't Support Capability Pointer. + // + return EFI_UNSUPPORTED; + } + + // + // Get Pointer To Capability List + // + Status = PciIo->Pci.Read ( + PciIo, + EfiPciIoWidthUint8, + PCI_CAPBILITY_POINTER_OFFSET, + 1, + &CapabilityPtr + ); + + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Find Capability ID 0xA, Which Is For Debug Port + // + while (CapabilityPtr != 0) { + Status = PciIo->Pci.Read ( + PciIo, + EfiPciIoWidthUint8, + CapabilityPtr, + 1, + &CapabilityId + ); + + if (EFI_ERROR (Status)) { + return Status; + } + + if (CapabilityId == EHC_DEBUG_PORT_CAP_ID) { + break; + } + + Status = PciIo->Pci.Read ( + PciIo, + EfiPciIoWidthUint8, + CapabilityPtr + 1, + 1, + &CapabilityPtr + ); + + if (EFI_ERROR (Status)) { + return Status; + } + } + + // + // No Debug Port Capability Found + // + if (CapabilityPtr == 0) { + return EFI_UNSUPPORTED; + } + + // + // Get The Base Address Of Debug Port Register In Debug Port Capability Register + // + Status = PciIo->Pci.Read ( + Ehc->PciIo, + EfiPciIoWidthUint8, + CapabilityPtr + 2, + sizeof (UINT16), + &DebugPort + ); + + if (EFI_ERROR (Status)) { + return Status; + } + + Ehc->DebugPortOffset = DebugPort & 0x1FFF; + Ehc->DebugPortBarNum = (UINT8)((DebugPort >> 13) - 1); + Ehc->DebugPortNum = (UINT8)((Ehc->HcStructParams & 0x00F00000) >> 20); + + return EFI_SUCCESS; +} + /** - Create and initialize a USB2_HC_DEV + Create and initialize a USB2_HC_DEV. - @param PciIo The PciIo on this device - @param OriginalPciAttributes Original PCI attributes + @param PciIo The PciIo on this device. + @param DevicePath The device path of host controller. + @param OriginalPciAttributes Original PCI attributes. - @return The allocated and initialized USB2_HC_DEV structure - @return if created, otherwise NULL. + @return The allocated and initialized USB2_HC_DEV structure if created, + otherwise NULL. **/ -STATIC USB2_HC_DEV * EhcCreateUsb2Hc ( - IN EFI_PCI_IO_PROTOCOL *PciIo, - IN UINT64 OriginalPciAttributes + IN EFI_PCI_IO_PROTOCOL *PciIo, + IN EFI_DEVICE_PATH_PROTOCOL *DevicePath, + IN UINT64 OriginalPciAttributes ) { USB2_HC_DEV *Ehc; @@ -1436,10 +1589,11 @@ EhcCreateUsb2Hc ( Ehc->Usb2Hc.GetRootHubPortStatus = EhcGetRootHubPortStatus; Ehc->Usb2Hc.SetRootHubPortFeature = EhcSetRootHubPortFeature; Ehc->Usb2Hc.ClearRootHubPortFeature = EhcClearRootHubPortFeature; - Ehc->Usb2Hc.MajorRevision = 0x1; - Ehc->Usb2Hc.MinorRevision = 0x1; + Ehc->Usb2Hc.MajorRevision = 0x2; + Ehc->Usb2Hc.MinorRevision = 0x0; Ehc->PciIo = PciIo; + Ehc->DevicePath = DevicePath; Ehc->OriginalPciAttributes = OriginalPciAttributes; InitializeListHead (&Ehc->AsyncIntTransfers); @@ -1450,13 +1604,23 @@ EhcCreateUsb2Hc ( DEBUG ((EFI_D_INFO, "EhcCreateUsb2Hc: capability length %d\n", Ehc->CapLen)); + // + // EHCI Controllers with a CapLen of 0 are ignored. + // + if (Ehc->CapLen == 0) { + gBS->FreePool (Ehc); + return NULL; + } + + EhcGetUsbDebugPortInfo (Ehc); + // // Create AsyncRequest Polling Timer // Status = gBS->CreateEvent ( EVT_TIMER | EVT_NOTIFY_SIGNAL, TPL_CALLBACK, - EhcMoniteAsyncRequests, + EhcMonitorAsyncRequests, Ehc, &Ehc->PollTimer ); @@ -1469,18 +1633,43 @@ EhcCreateUsb2Hc ( return Ehc; } +/** + One notified function to stop the Host Controller when gBS->ExitBootServices() called. + + @param Event Pointer to this event + @param Context Event hanlder private data + +**/ +VOID +EFIAPI +EhcExitBootService ( + EFI_EVENT Event, + VOID *Context + ) + +{ + USB2_HC_DEV *Ehc; + + Ehc = (USB2_HC_DEV *) Context; + + // + // Reset the Host Controller + // + EhcResetHC (Ehc, EHC_RESET_TIMEOUT); +} + /** - Starting the Usb EHCI Driver + Starting the Usb EHCI Driver. @param This Protocol instance pointer. - @param Controller Handle of device to test - @param RemainingDevicePath Not used + @param Controller Handle of device to test. + @param RemainingDevicePath Not used. - @return EFI_SUCCESS : supports this device. - @return EFI_UNSUPPORTED : do not support this device. - @return EFI_DEVICE_ERROR : cannot be started due to device Error - @return EFI_OUT_OF_RESOURCES : cannot allocate resources + @return EFI_SUCCESS supports this device. + @return EFI_UNSUPPORTED do not support this device. + @return EFI_DEVICE_ERROR cannot be started due to device Error. + @return EFI_OUT_OF_RESOURCES cannot allocate resources. **/ EFI_STATUS @@ -1494,9 +1683,24 @@ EhcDriverBindingStart ( EFI_STATUS Status; USB2_HC_DEV *Ehc; EFI_PCI_IO_PROTOCOL *PciIo; + EFI_PCI_IO_PROTOCOL *Instance; UINT64 Supports; UINT64 OriginalPciAttributes; BOOLEAN PciAttributesSaved; + USB_CLASSC UsbClassCReg; + EFI_HANDLE *HandleBuffer; + UINTN NumberOfHandles; + UINTN Index; + UINTN CompanionSegmentNumber; + UINTN CompanionBusNumber; + UINTN CompanionDeviceNumber; + UINTN CompanionFunctionNumber; + UINTN EhciSegmentNumber; + UINTN EhciBusNumber; + UINTN EhciDeviceNumber; + UINTN EhciFunctionNumber; + UINT32 State; + EFI_DEVICE_PATH_PROTOCOL *HcDevicePath; // // Open the PciIo Protocol, then enable the USB host controller @@ -1511,10 +1715,22 @@ EhcDriverBindingStart ( ); if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_ERROR, "EhcDriverBindingStart: failed to open PCI_IO\n")); - return EFI_DEVICE_ERROR; + return Status; } + // + // Open Device Path Protocol for on USB host controller + // + HcDevicePath = NULL; + Status = gBS->OpenProtocol ( + Controller, + &gEfiDevicePathProtocolGuid, + (VOID **) &HcDevicePath, + This->DriverBindingHandle, + Controller, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + PciAttributesSaved = FALSE; // // Save original PCI attributes @@ -1552,10 +1768,111 @@ EhcDriverBindingStart ( goto CLOSE_PCIIO; } + // + // Get the Pci device class code. + // + Status = PciIo->Pci.Read ( + PciIo, + EfiPciIoWidthUint8, + PCI_CLASSCODE_OFFSET, + sizeof (USB_CLASSC) / sizeof (UINT8), + &UsbClassCReg + ); + + if (EFI_ERROR (Status)) { + Status = EFI_UNSUPPORTED; + goto CLOSE_PCIIO; + } + // + // Determine if the device is UHCI or OHCI host controller or not. If yes, then find out the + // companion usb ehci host controller and force EHCI driver get attached to it before + // UHCI or OHCI driver attaches to UHCI or OHCI host controller. + // + if ((UsbClassCReg.ProgInterface == PCI_IF_UHCI || UsbClassCReg.ProgInterface == PCI_IF_OHCI) && + (UsbClassCReg.BaseCode == PCI_CLASS_SERIAL) && + (UsbClassCReg.SubClassCode == PCI_CLASS_SERIAL_USB)) { + Status = PciIo->GetLocation ( + PciIo, + &CompanionSegmentNumber, + &CompanionBusNumber, + &CompanionDeviceNumber, + &CompanionFunctionNumber + ); + if (EFI_ERROR (Status)) { + goto CLOSE_PCIIO; + } + + Status = gBS->LocateHandleBuffer ( + ByProtocol, + &gEfiPciIoProtocolGuid, + NULL, + &NumberOfHandles, + &HandleBuffer + ); + if (EFI_ERROR (Status)) { + goto CLOSE_PCIIO; + } + + for (Index = 0; Index < NumberOfHandles; Index++) { + // + // Get the device path on this handle + // + Status = gBS->HandleProtocol ( + HandleBuffer[Index], + &gEfiPciIoProtocolGuid, + (VOID **)&Instance + ); + ASSERT_EFI_ERROR (Status); + + Status = Instance->Pci.Read ( + Instance, + EfiPciIoWidthUint8, + PCI_CLASSCODE_OFFSET, + sizeof (USB_CLASSC) / sizeof (UINT8), + &UsbClassCReg + ); + + if (EFI_ERROR (Status)) { + Status = EFI_UNSUPPORTED; + goto CLOSE_PCIIO; + } + + if ((UsbClassCReg.ProgInterface == PCI_IF_EHCI) && + (UsbClassCReg.BaseCode == PCI_CLASS_SERIAL) && + (UsbClassCReg.SubClassCode == PCI_CLASS_SERIAL_USB)) { + Status = Instance->GetLocation ( + Instance, + &EhciSegmentNumber, + &EhciBusNumber, + &EhciDeviceNumber, + &EhciFunctionNumber + ); + if (EFI_ERROR (Status)) { + goto CLOSE_PCIIO; + } + // + // Currently, the judgment on the companion usb host controller is through the + // same bus number, which may vary on different platform. + // + if (EhciBusNumber == CompanionBusNumber) { + gBS->CloseProtocol ( + Controller, + &gEfiPciIoProtocolGuid, + This->DriverBindingHandle, + Controller + ); + EhcDriverBindingStart(This, HandleBuffer[Index], NULL); + } + } + } + Status = EFI_NOT_FOUND; + goto CLOSE_PCIIO; + } + // // Create then install USB2_HC_PROTOCOL // - Ehc = EhcCreateUsb2Hc (PciIo, OriginalPciAttributes); + Ehc = EhcCreateUsb2Hc (PciIo, HcDevicePath, OriginalPciAttributes); if (Ehc == NULL) { DEBUG ((EFI_D_ERROR, "EhcDriverBindingStart: failed to create USB2_HC\n")); @@ -1577,13 +1894,19 @@ EhcDriverBindingStart ( } // - // Robustnesss improvement such as for UoL + // Robustnesss improvement such as for Duet platform // Default is not required. // if (FeaturePcdGet (PcdTurnOffUsbLegacySupport)) { EhcClearLegacySupport (Ehc); } - EhcResetHC (Ehc, EHC_RESET_TIMEOUT); + + if (Ehc->DebugPortNum != 0) { + State = EhcReadDbgRegister(Ehc, 0); + if ((State & (USB_DEBUG_PORT_IN_USE | USB_DEBUG_PORT_OWNER)) != (USB_DEBUG_PORT_IN_USE | USB_DEBUG_PORT_OWNER)) { + EhcResetHC (Ehc, EHC_RESET_TIMEOUT); + } + } Status = EhcInitHC (Ehc); @@ -1604,6 +1927,21 @@ EhcDriverBindingStart ( goto UNINSTALL_USBHC; } + // + // Create event to stop the HC when exit boot service. + // + Status = gBS->CreateEventEx ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + EhcExitBootService, + Ehc, + &gEfiEventExitBootServicesGuid, + &Ehc->ExitBootServiceEvent + ); + if (EFI_ERROR (Status)) { + goto UNINSTALL_USBHC; + } + // // Install the component name protocol, don't fail the start // because of something for display. @@ -1624,7 +1962,7 @@ EhcDriverBindingStart ( ); - DEBUG ((EFI_D_INFO, "EhcDriverBindingStart: EHCI started for controller @ %x\n", Controller)); + DEBUG ((EFI_D_INFO, "EhcDriverBindingStart: EHCI started for controller @ %p\n", Controller)); return EFI_SUCCESS; UNINSTALL_USBHC: @@ -1640,7 +1978,7 @@ FREE_POOL: gBS->FreePool (Ehc); CLOSE_PCIIO: - if (PciAttributesSaved == TRUE) { + if (PciAttributesSaved) { // // Restore original PCI attributes // @@ -1668,12 +2006,12 @@ CLOSE_PCIIO: created by this driver. @param This Protocol instance pointer. - @param Controller Handle of device to stop driver on - @param NumberOfChildren Number of Children in the ChildHandleBuffer + @param Controller Handle of device to stop driver on. + @param NumberOfChildren Number of Children in the ChildHandleBuffer. @param ChildHandleBuffer List of handles for the children we need to stop. - @return EFI_SUCCESS Success - @return EFI_DEVICE_ERROR Fail + @return EFI_SUCCESS Success. + @return EFI_DEVICE_ERROR Fail. **/ EFI_STATUS @@ -1711,13 +2049,6 @@ EhcDriverBindingStop ( Ehc = EHC_FROM_THIS (Usb2Hc); PciIo = Ehc->PciIo; - // - // Stop AsyncRequest Polling timer then stop the EHCI driver - // and uninstall the EHCI protocl. - // - gBS->SetTimer (Ehc->PollTimer, TimerCancel, EHC_ASYNC_POLL_INTERVAL); - EhcHaltHC (Ehc, EHC_GENERIC_TIMEOUT); - Status = gBS->UninstallProtocolInterface ( Controller, &gEfiUsb2HcProtocolGuid, @@ -1728,16 +2059,33 @@ EhcDriverBindingStop ( return Status; } + // + // Stop AsyncRequest Polling timer then stop the EHCI driver + // and uninstall the EHCI protocl. + // + gBS->SetTimer (Ehc->PollTimer, TimerCancel, EHC_ASYNC_POLL_INTERVAL); + EhcHaltHC (Ehc, EHC_GENERIC_TIMEOUT); + if (Ehc->PollTimer != NULL) { gBS->CloseEvent (Ehc->PollTimer); } + if (Ehc->ExitBootServiceEvent != NULL) { + gBS->CloseEvent (Ehc->ExitBootServiceEvent); + } + EhcFreeSched (Ehc); - if (Ehc->ControllerNameTable) { + if (Ehc->ControllerNameTable != NULL) { FreeUnicodeStringTable (Ehc->ControllerNameTable); } + // + // Disable routing of all ports to EHCI controller, so all ports are + // routed back to the UHCI or OHCI controller. + // + EhcClearOpRegBit (Ehc, EHC_CONFIG_FLAG_OFFSET, CONFIGFLAG_ROUTE_EHC); + // // Restore original PCI attributes // @@ -1760,12 +2108,3 @@ EhcDriverBindingStop ( return EFI_SUCCESS; } -EFI_DRIVER_BINDING_PROTOCOL -gEhciDriverBinding = { - EhcDriverBindingSupported, - EhcDriverBindingStart, - EhcDriverBindingStop, - 0x10, - NULL, - NULL -};