/** @file\r
\r
-Copyright (c) 2007, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+ Usb bus enumeration support.\r
+\r
+Copyright (c) 2007 - 2008, Intel Corporation. All rights reserved.<BR>\r
+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
http://opensource.org/licenses/bsd-license.php\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
- UsbEnumer.c\r
-\r
- Abstract:\r
-\r
- Usb bus enumeration support\r
-\r
- Revision History\r
-\r
-\r
**/\r
\r
#include "UsbBus.h"\r
\r
\r
/**\r
- Return the endpoint descriptor in this interface\r
+ Return the endpoint descriptor in this interface.\r
\r
- @param UsbIf The interface to search in\r
- @param EpAddr The address of the endpoint to return\r
+ @param UsbIf The interface to search in.\r
+ @param EpAddr The address of the endpoint to return.\r
\r
- @return The endpoint descriptor or NULL\r
+ @return The endpoint descriptor or NULL.\r
\r
**/\r
USB_ENDPOINT_DESC *\r
)\r
{\r
USB_ENDPOINT_DESC *EpDesc;\r
- UINTN Index;\r
-\r
- for (Index = 0; Index < UsbIf->IfSetting->Desc.NumEndpoints; Index++) {\r
+ UINT8 Index;\r
+ UINT8 NumEndpoints;\r
+ \r
+ NumEndpoints = UsbIf->IfSetting->Desc.NumEndpoints;\r
+ \r
+ for (Index = 0; Index < NumEndpoints; Index++) {\r
EpDesc = UsbIf->IfSetting->Endpoints[Index];\r
\r
if (EpDesc->Desc.EndpointAddress == EpAddr) {\r
\r
\r
/**\r
- Free the resource used by USB interface\r
-\r
- @param UsbIf The USB interface to free\r
+ Free the resource used by USB interface.\r
\r
- @return None\r
+ @param UsbIf The USB interface to free.\r
\r
**/\r
-STATIC\r
VOID\r
UsbFreeInterface (\r
IN USB_INTERFACE *UsbIf\r
);\r
\r
if (UsbIf->DevicePath != NULL) {\r
- gBS->FreePool (UsbIf->DevicePath);\r
+ FreePool (UsbIf->DevicePath);\r
}\r
\r
- gBS->FreePool (UsbIf);\r
+ FreePool (UsbIf);\r
}\r
\r
\r
Create an interface for the descriptor IfDesc. Each\r
device's configuration can have several interfaces.\r
\r
- @param Device The device has the interface descriptor\r
- @param IfDesc The interface descriptor\r
+ @param Device The device has the interface descriptor.\r
+ @param IfDesc The interface descriptor.\r
\r
@return The created USB interface for the descriptor, or NULL.\r
\r
**/\r
-STATIC\r
USB_INTERFACE *\r
UsbCreateInterface (\r
IN USB_DEVICE *Device,\r
UsbIf->Signature = USB_INTERFACE_SIGNATURE;\r
UsbIf->Device = Device;\r
UsbIf->IfDesc = IfDesc;\r
+ ASSERT (IfDesc->ActiveIndex < USB_MAX_INTERFACE_SETTING);\r
UsbIf->IfSetting = IfDesc->Settings[IfDesc->ActiveIndex];\r
\r
CopyMem (\r
return UsbIf;\r
\r
ON_ERROR:\r
- if (UsbIf->DevicePath) {\r
- gBS->FreePool (UsbIf->DevicePath);\r
+ if (UsbIf->DevicePath != NULL) {\r
+ FreePool (UsbIf->DevicePath);\r
}\r
\r
- gBS->FreePool (UsbIf);\r
+ FreePool (UsbIf);\r
return NULL;\r
}\r
\r
\r
/**\r
- Free the resource used by this USB device\r
-\r
- @param Device The USB device to free\r
+ Free the resource used by this USB device.\r
\r
- @return None\r
+ @param Device The USB device to free.\r
\r
**/\r
-STATIC\r
VOID\r
UsbFreeDevice (\r
IN USB_DEVICE *Device\r
/**\r
Create a device which is on the parent's ParentPort port.\r
\r
- @param ParentIf The parent HUB interface\r
- @param ParentPort The port on the HUB this device is connected to\r
+ @param ParentIf The parent HUB interface.\r
+ @param ParentPort The port on the HUB this device is connected to.\r
\r
- @return Created USB device\r
+ @return Created USB device, Or NULL.\r
\r
**/\r
-STATIC\r
USB_DEVICE *\r
UsbCreateDevice (\r
IN USB_INTERFACE *ParentIf,\r
\r
/**\r
Connect the USB interface with its driver. EFI USB bus will\r
- create a USB interface for each seperate interface descriptor.\r
+ create a USB interface for each separate interface descriptor.\r
\r
- @param UsbIf The interface to connect driver to\r
+ @param UsbIf The interface to connect driver to.\r
\r
- @return EFI_SUCCESS : Interface is managed by some driver\r
- @return Others : Failed to locate a driver for this interface\r
+ @return EFI_SUCCESS Interface is managed by some driver.\r
+ @return Others Failed to locate a driver for this interface.\r
\r
**/\r
-STATIC\r
EFI_STATUS\r
UsbConnectDriver (\r
IN USB_INTERFACE *UsbIf\r
// twisted TPL used. It should be no problem for us to connect\r
// or disconnect at CALLBACK.\r
//\r
- OldTpl = UsbGetCurrentTpl ();\r
- DEBUG ((EFI_D_INFO, "UsbConnectDriver: TPL before connect is %d\n", OldTpl));\r
+ \r
+ //\r
+ // Only recursively wanted usb child device\r
+ //\r
+ if (UsbBusIsWantedUsbIO (UsbIf->Device->Bus, UsbIf)) {\r
+ OldTpl = UsbGetCurrentTpl ();\r
+ DEBUG ((EFI_D_INFO, "UsbConnectDriver: TPL before connect is %d, %p\n", (UINT32)OldTpl, UsbIf->Handle));\r
\r
- gBS->RestoreTPL (TPL_CALLBACK);\r
+ gBS->RestoreTPL (TPL_CALLBACK);\r
\r
- Status = gBS->ConnectController (UsbIf->Handle, NULL, NULL, TRUE);\r
- UsbIf->IsManaged = (BOOLEAN)!EFI_ERROR (Status);\r
+ Status = gBS->ConnectController (UsbIf->Handle, NULL, NULL, TRUE);\r
+ UsbIf->IsManaged = (BOOLEAN)!EFI_ERROR (Status);\r
\r
- DEBUG ((EFI_D_INFO, "UsbConnectDriver: TPL after connect is %d\n", UsbGetCurrentTpl()));\r
- ASSERT (UsbGetCurrentTpl () == TPL_CALLBACK);\r
+ DEBUG ((EFI_D_INFO, "UsbConnectDriver: TPL after connect is %d\n", (UINT32)UsbGetCurrentTpl()));\r
+ ASSERT (UsbGetCurrentTpl () == TPL_CALLBACK);\r
\r
- gBS->RaiseTPL (OldTpl);\r
+ gBS->RaiseTPL (OldTpl);\r
+ }\r
}\r
\r
return Status;\r
settings. Only one setting is active. It will\r
also reset its endpoints' toggle to zero.\r
\r
- @param IfDesc The interface descriptor to set\r
- @param Alternate The alternate setting number to locate\r
+ @param IfDesc The interface descriptor to set.\r
+ @param Alternate The alternate setting number to locate.\r
\r
- @retval EFI_NOT_FOUND There is no setting with this alternate index\r
+ @retval EFI_NOT_FOUND There is no setting with this alternate index.\r
@retval EFI_SUCCESS The interface is set to Alternate setting.\r
\r
**/\r
Setting = NULL;\r
\r
for (Index = 0; Index < IfDesc->NumOfSetting; Index++) {\r
+ ASSERT (Index < USB_MAX_INTERFACE_SETTING);\r
Setting = IfDesc->Settings[Index];\r
\r
if (Setting->Desc.AlternateSetting == Alternate) {\r
\r
IfDesc->ActiveIndex = Index;\r
\r
+ ASSERT (Setting != NULL);\r
DEBUG ((EFI_D_INFO, "UsbSelectSetting: setting %d selected for interface %d\n",\r
Alternate, Setting->Desc.InterfaceNumber));\r
\r
Select a new configuration for the device. Each\r
device may support several configurations.\r
\r
- @param Device The device to select configuration\r
- @param ConfigValue The index of the configuration ( != 0)\r
+ @param Device The device to select configuration.\r
+ @param ConfigValue The index of the configuration ( != 0).\r
\r
- @retval EFI_NOT_FOUND There is no configuration with the index\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate resource\r
+ @retval EFI_NOT_FOUND There is no configuration with the index.\r
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate resource.\r
@retval EFI_SUCCESS The configuration is selected.\r
\r
**/\r
return EFI_OUT_OF_RESOURCES;\r
}\r
\r
+ ASSERT (Index < USB_MAX_INTERFACE);\r
Device->Interfaces[Index] = UsbIf;\r
\r
//\r
}\r
\r
\r
-\r
/**\r
Disconnect the USB interface with its driver.\r
\r
- @param UsbIf The interface to disconnect driver from\r
-\r
- @return None\r
+ @param UsbIf The interface to disconnect driver from.\r
\r
**/\r
-STATIC\r
VOID\r
UsbDisconnectDriver (\r
IN USB_INTERFACE *UsbIf\r
)\r
{\r
EFI_TPL OldTpl;\r
+ EFI_STATUS Status;\r
\r
//\r
// Release the hub if it's a hub controller, otherwise\r
// or disconnect at CALLBACK.\r
//\r
OldTpl = UsbGetCurrentTpl ();\r
- DEBUG ((EFI_D_INFO, "UsbDisconnectDriver: old TPL is %d\n", OldTpl));\r
+ DEBUG ((EFI_D_INFO, "UsbDisconnectDriver: old TPL is %d, %p\n", (UINT32)OldTpl, UsbIf->Handle));\r
\r
gBS->RestoreTPL (TPL_CALLBACK);\r
\r
- gBS->DisconnectController (UsbIf->Handle, NULL, NULL);\r
+ Status = gBS->DisconnectController (UsbIf->Handle, NULL, NULL);\r
UsbIf->IsManaged = FALSE;\r
\r
- DEBUG (( EFI_D_INFO, "UsbDisconnectDriver: TPL after disconnect is %d\n", UsbGetCurrentTpl()));\r
+ DEBUG (( EFI_D_INFO, "UsbDisconnectDriver: TPL after disconnect is %d, %d\n", (UINT32)UsbGetCurrentTpl(), Status));\r
ASSERT (UsbGetCurrentTpl () == TPL_CALLBACK);\r
\r
gBS->RaiseTPL (OldTpl);\r
}\r
\r
\r
-\r
/**\r
- Remove the current device configuration\r
+ Remove the current device configuration.\r
\r
- @param Device The USB device to remove configuration from\r
-\r
- @return None\r
+ @param Device The USB device to remove configuration from.\r
\r
**/\r
VOID\r
//\r
// Remove each interface of the device\r
//\r
- for (Index = 0; Index < Device->NumOfInterface; Index++) {\r
+ for (Index = 0; Index < Device->NumOfInterface; Index++) { \r
+ ASSERT (Index < USB_MAX_INTERFACE);\r
UsbIf = Device->Interfaces[Index];\r
\r
if (UsbIf == NULL) {\r
}\r
\r
\r
-\r
/**\r
Remove the device and all its children from the bus.\r
\r
- @param Device The device to remove\r
+ @param Device The device to remove.\r
\r
- @retval EFI_SUCCESS The device is removed\r
+ @retval EFI_SUCCESS The device is removed.\r
\r
**/\r
EFI_STATUS\r
\r
DEBUG (( EFI_D_INFO, "UsbRemoveDevice: device %d removed\n", Device->Address));\r
\r
+ ASSERT (Device->Address < USB_MAX_DEVICES);\r
Bus->Devices[Device->Address] = NULL;\r
UsbFreeDevice (Device);\r
\r
\r
\r
/**\r
- Find the child device on the hub's port\r
+ Find the child device on the hub's port.\r
\r
- @param HubIf The hub interface\r
- @param Port The port of the hub this child is connected to\r
+ @param HubIf The hub interface.\r
+ @param Port The port of the hub this child is connected to.\r
\r
- @return The device on the hub's port, or NULL if there is none\r
+ @return The device on the hub's port, or NULL if there is none.\r
\r
**/\r
-STATIC\r
USB_DEVICE *\r
UsbFindChild (\r
IN USB_INTERFACE *HubIf,\r
}\r
\r
\r
-\r
/**\r
Enumerate and configure the new device on the port of this HUB interface.\r
\r
- @param HubIf The HUB that has the device connected\r
- @param Port The port index of the hub (started with zero)\r
+ @param HubIf The HUB that has the device connected.\r
+ @param Port The port index of the hub (started with zero).\r
\r
- @retval EFI_SUCCESS The device is enumerated (added or removed)\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate resource for the device\r
- @retval Others Failed to enumerate the device\r
+ @retval EFI_SUCCESS The device is enumerated (added or removed).\r
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate resource for the device.\r
+ @retval Others Failed to enumerate the device.\r
\r
**/\r
-STATIC\r
EFI_STATUS\r
UsbEnumerateNewDev (\r
IN USB_INTERFACE *HubIf,\r
Parent = HubIf->Device;\r
Bus = Parent->Bus;\r
HubApi = HubIf->HubApi;\r
-\r
-\r
- //\r
- // Wait at least 100 ms for the power on port to stable\r
- //\r
- gBS->Stall (100 * USB_STALL_1_MS);\r
-\r
+ \r
+ gBS->Stall (USB_WAIT_PORT_STABLE_STALL);\r
+ \r
//\r
// Hub resets the device for at least 10 milliseconds.\r
// Host learns device speed. If device is of low/full speed\r
if (Child->Speed != EFI_USB_SPEED_HIGH) {\r
//\r
// If the child isn't a high speed device, it is necessary to\r
- // set the transaction translator. This is quite simple:\r
+ // set the transaction translator. Port TT is 1-based.\r
+ // This is quite simple:\r
// 1. if parent is of high speed, then parent is our translator\r
// 2. otherwise use parent's translator.\r
//\r
if (Parent->Speed == EFI_USB_SPEED_HIGH) {\r
Child->Translator.TranslatorHubAddress = Parent->Address;\r
- Child->Translator.TranslatorPortNumber = Port;\r
+ Child->Translator.TranslatorPortNumber = (UINT8) (Port + 1);\r
\r
} else {\r
Child->Translator = Parent->Translator;\r
\r
//\r
// After port is reset, hub establishes a signal path between\r
- // the device and host (DEFALUT state). Device¡¯s registers are\r
+ // the device and host (DEFALUT state). Device's registers are\r
// reset, use default address 0 (host enumerates one device at\r
// a time) , and ready to respond to control transfer at EP 0.\r
//\r
\r
//\r
// Host sends a Get_Descriptor request to learn the max packet\r
- // size of default pipe (only part of the device¡¯s descriptor).\r
+ // size of default pipe (only part of the device's descriptor).\r
//\r
Status = UsbGetMaxPacketSize0 (Child);\r
\r
DEBUG ((EFI_D_ERROR, "UsbEnumerateNewDev: failed to set device address - %r\n", Status));\r
goto ON_ERROR;\r
}\r
-\r
- //\r
- // Wait 20ms for set address to complete\r
- //\r
- gBS->Stall (20 * USB_STALL_1_MS);\r
+ \r
+ gBS->Stall (USB_SET_DEVICE_ADDRESS_STALL);\r
\r
DEBUG ((EFI_D_INFO, "UsbEnumerateNewDev: device is now ADDRESSED at %d\n", Address));\r
\r
//\r
- // Host learns about the device¡¯s abilities by requesting device's\r
+ // Host learns about the device's abilities by requesting device's\r
// entire descriptions.\r
//\r
Status = UsbBuildDescTable (Child);\r
}\r
\r
\r
-\r
/**\r
Process the events on the port.\r
\r
- @param HubIf The HUB that has the device connected\r
- @param Port The port index of the hub (started with zero)\r
+ @param HubIf The HUB that has the device connected.\r
+ @param Port The port index of the hub (started with zero).\r
\r
- @retval EFI_SUCCESS The device is enumerated (added or removed)\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate resource for the device\r
- @retval Others Failed to enumerate the device\r
+ @retval EFI_SUCCESS The device is enumerated (added or removed).\r
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate resource for the device.\r
+ @retval Others Failed to enumerate the device.\r
\r
**/\r
-STATIC\r
EFI_STATUS\r
UsbEnumeratePort (\r
IN USB_INTERFACE *HubIf,\r
return EFI_SUCCESS;\r
}\r
\r
- DEBUG (( EFI_D_INFO, "UsbEnumeratePort: port %d state - %x, change - %x\n",\r
- Port, PortState.PortStatus, PortState.PortChangeStatus));\r
+ DEBUG (( EFI_D_INFO, "UsbEnumeratePort: port %d state - %x, change - %x on %p\n",\r
+ Port, PortState.PortStatus, PortState.PortChangeStatus, HubIf));\r
\r
//\r
// This driver only process two kinds of events now: over current and\r
\r
if (USB_BIT_IS_SET (PortState.PortStatus, USB_PORT_STAT_OVERCURRENT)) {\r
//\r
- // Both OverCurrent and OverCurrentChange set, means over current occurs, \r
- // which probably is caused by short circuit. It has to wait system hardware\r
- // to perform recovery.\r
+ // Case1:\r
+ // Both OverCurrent and OverCurrentChange set, means over current occurs, \r
+ // which probably is caused by short circuit. It has to wait system hardware\r
+ // to perform recovery.\r
//\r
DEBUG (( EFI_D_ERROR, "UsbEnumeratePort: Critical Over Current\n", Port));\r
return EFI_DEVICE_ERROR;\r
\r
- } else {\r
- //\r
- // Only OverCurrentChange set, means system has been recoveried from \r
- // over current. As a result, all ports are nearly power-off, so\r
- // it's necessary to detach and enumerate all ports again. \r
- //\r
- DEBUG (( EFI_D_ERROR, "UsbEnumeratePort: 2.0 device Recovery Over Current\n", Port)); \r
- goto ON_ENUMERATE;\r
- \r
- }\r
+ } \r
+ //\r
+ // Case2:\r
+ // Only OverCurrentChange set, means system has been recoveried from \r
+ // over current. As a result, all ports are nearly power-off, so\r
+ // it's necessary to detach and enumerate all ports again. \r
+ //\r
+ DEBUG (( EFI_D_ERROR, "UsbEnumeratePort: 2.0 device Recovery Over Current\n", Port)); \r
}\r
\r
if (USB_BIT_IS_SET (PortState.PortChangeStatus, USB_PORT_STAT_C_ENABLE)) { \r
//\r
- // 1.1 roothub port reg doesn't reflect over-current state, while its counterpart\r
- // on 2.0 roothub does. When over-current has influence on 1.1 device, the port \r
- // would be disabled, so it's also necessary to detach and enumerate again.\r
+ // Case3:\r
+ // 1.1 roothub port reg doesn't reflect over-current state, while its counterpart\r
+ // on 2.0 roothub does. When over-current has influence on 1.1 device, the port \r
+ // would be disabled, so it's also necessary to detach and enumerate again.\r
//\r
DEBUG (( EFI_D_ERROR, "UsbEnumeratePort: 1.1 device Recovery Over Current\n", Port));\r
- goto ON_ENUMERATE;\r
}\r
\r
if (USB_BIT_IS_SET (PortState.PortChangeStatus, USB_PORT_STAT_C_CONNECTION)) {\r
//\r
- // Device connected or disconnected normally. \r
+ // Case4:\r
+ // Device connected or disconnected normally. \r
//\r
- goto ON_ENUMERATE;\r
+ DEBUG ((EFI_D_ERROR, "UsbEnumeratePort: Device Connect/Discount Normally\n", Port));\r
}\r
\r
-ON_ENUMERATE:\r
-\r
// \r
- // In case there is already a device on this port logically, it's safety to remove\r
- // and enumerate again.\r
+ // Following as the above cases, it's safety to remove and create again.\r
//\r
Child = UsbFindChild (HubIf, Port);\r
\r
if (Child != NULL) {\r
- DEBUG (( EFI_D_INFO, "UsbEnumeratePort: device at port %d removed from system\n", Port));\r
+ DEBUG (( EFI_D_INFO, "UsbEnumeratePort: device at port %d removed from root hub %p\n", Port, HubIf));\r
UsbRemoveDevice (Child);\r
}\r
\r
\r
\r
/**\r
- Enumerate all the changed hub ports\r
-\r
- @param Event The event that is triggered\r
- @param Context The context to the event\r
+ Enumerate all the changed hub ports.\r
\r
- @return None\r
+ @param Event The event that is triggered.\r
+ @param Context The context to the event.\r
\r
**/\r
VOID\r
+EFIAPI\r
UsbHubEnumeration (\r
IN EFI_EVENT Event,\r
IN VOID *Context\r
UINT8 Bit;\r
UINT8 Index;\r
\r
- ASSERT (Context);\r
+ ASSERT (Context != NULL);\r
\r
HubIf = (USB_INTERFACE *) Context;\r
\r
\r
\r
/**\r
- Enumerate all the changed hub ports\r
-\r
- @param Event The event that is triggered\r
- @param Context The context to the event\r
+ Enumerate all the changed hub ports.\r
\r
- @return None\r
+ @param Event The event that is triggered.\r
+ @param Context The context to the event.\r
\r
**/\r
VOID\r
+EFIAPI\r
UsbRootHubEnumeration (\r
IN EFI_EVENT Event,\r
IN VOID *Context\r
projects / mirror_edk2.git / blobdiff