3 Usb bus enumeration support.
5 Copyright (c) 2007 - 2012, 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
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.
19 Return the endpoint descriptor in this interface.
21 @param UsbIf The interface to search in.
22 @param EpAddr The address of the endpoint to return.
24 @return The endpoint descriptor or NULL.
29 IN USB_INTERFACE
*UsbIf
,
33 USB_ENDPOINT_DESC
*EpDesc
;
37 NumEndpoints
= UsbIf
->IfSetting
->Desc
.NumEndpoints
;
39 for (Index
= 0; Index
< NumEndpoints
; Index
++) {
40 EpDesc
= UsbIf
->IfSetting
->Endpoints
[Index
];
42 if (EpDesc
->Desc
.EndpointAddress
== EpAddr
) {
52 Free the resource used by USB interface.
54 @param UsbIf The USB interface to free.
59 IN USB_INTERFACE
*UsbIf
62 UsbCloseHostProtoByChild (UsbIf
->Device
->Bus
, UsbIf
->Handle
);
64 gBS
->UninstallMultipleProtocolInterfaces (
66 &gEfiDevicePathProtocolGuid
,
68 &gEfiUsbIoProtocolGuid
,
73 if (UsbIf
->DevicePath
!= NULL
) {
74 FreePool (UsbIf
->DevicePath
);
82 Create an interface for the descriptor IfDesc. Each
83 device's configuration can have several interfaces.
85 @param Device The device has the interface descriptor.
86 @param IfDesc The interface descriptor.
88 @return The created USB interface for the descriptor, or NULL.
93 IN USB_DEVICE
*Device
,
94 IN USB_INTERFACE_DESC
*IfDesc
97 USB_DEVICE_PATH UsbNode
;
102 UsbIf
= AllocateZeroPool (sizeof (USB_INTERFACE
));
108 UsbIf
->Signature
= USB_INTERFACE_SIGNATURE
;
109 UsbIf
->Device
= Device
;
110 UsbIf
->IfDesc
= IfDesc
;
111 ASSERT (IfDesc
->ActiveIndex
< USB_MAX_INTERFACE_SETTING
);
112 UsbIf
->IfSetting
= IfDesc
->Settings
[IfDesc
->ActiveIndex
];
117 sizeof (EFI_USB_IO_PROTOCOL
)
121 // Install protocols for USBIO and device path
123 UsbNode
.Header
.Type
= MESSAGING_DEVICE_PATH
;
124 UsbNode
.Header
.SubType
= MSG_USB_DP
;
125 UsbNode
.ParentPortNumber
= Device
->ParentPort
;
126 UsbNode
.InterfaceNumber
= UsbIf
->IfSetting
->Desc
.InterfaceNumber
;
128 SetDevicePathNodeLength (&UsbNode
.Header
, sizeof (UsbNode
));
130 HubIf
= Device
->ParentIf
;
131 ASSERT (HubIf
!= NULL
);
133 UsbIf
->DevicePath
= AppendDevicePathNode (HubIf
->DevicePath
, &UsbNode
.Header
);
135 if (UsbIf
->DevicePath
== NULL
) {
136 DEBUG ((EFI_D_ERROR
, "UsbCreateInterface: failed to create device path\n"));
138 Status
= EFI_OUT_OF_RESOURCES
;
142 Status
= gBS
->InstallMultipleProtocolInterfaces (
144 &gEfiDevicePathProtocolGuid
,
146 &gEfiUsbIoProtocolGuid
,
151 if (EFI_ERROR (Status
)) {
152 DEBUG ((EFI_D_ERROR
, "UsbCreateInterface: failed to install UsbIo - %r\n", Status
));
157 // Open USB Host Controller Protocol by Child
159 Status
= UsbOpenHostProtoByChild (Device
->Bus
, UsbIf
->Handle
);
161 if (EFI_ERROR (Status
)) {
162 gBS
->UninstallMultipleProtocolInterfaces (
164 &gEfiDevicePathProtocolGuid
,
166 &gEfiUsbIoProtocolGuid
,
171 DEBUG ((EFI_D_ERROR
, "UsbCreateInterface: failed to open host for child - %r\n", Status
));
178 if (UsbIf
->DevicePath
!= NULL
) {
179 FreePool (UsbIf
->DevicePath
);
188 Free the resource used by this USB device.
190 @param Device The USB device to free.
195 IN USB_DEVICE
*Device
198 if (Device
->DevDesc
!= NULL
) {
199 UsbFreeDevDesc (Device
->DevDesc
);
202 gBS
->FreePool (Device
);
207 Create a device which is on the parent's ParentPort port.
209 @param ParentIf The parent HUB interface.
210 @param ParentPort The port on the HUB this device is connected to.
212 @return Created USB device, Or NULL.
217 IN USB_INTERFACE
*ParentIf
,
223 ASSERT (ParentIf
!= NULL
);
225 Device
= AllocateZeroPool (sizeof (USB_DEVICE
));
227 if (Device
== NULL
) {
231 Device
->Bus
= ParentIf
->Device
->Bus
;
232 Device
->MaxPacket0
= 8;
233 Device
->ParentAddr
= ParentIf
->Device
->Address
;
234 Device
->ParentIf
= ParentIf
;
235 Device
->ParentPort
= ParentPort
;
236 Device
->Tier
= (UINT8
)(ParentIf
->Device
->Tier
+ 1);
242 Connect the USB interface with its driver. EFI USB bus will
243 create a USB interface for each separate interface descriptor.
245 @param UsbIf The interface to connect driver to.
247 @return EFI_SUCCESS Interface is managed by some driver.
248 @return Others Failed to locate a driver for this interface.
253 IN USB_INTERFACE
*UsbIf
259 Status
= EFI_SUCCESS
;
262 // Hub is maintained by the USB bus driver. Otherwise try to
263 // connect drivers with this interface
265 if (UsbIsHubInterface (UsbIf
)) {
266 DEBUG ((EFI_D_INFO
, "UsbConnectDriver: found a hub device\n"));
267 Status
= mUsbHubApi
.Init (UsbIf
);
271 // This function is called in both UsbIoControlTransfer and
272 // the timer callback in hub enumeration. So, at least it is
273 // called at TPL_CALLBACK. Some driver sitting on USB has
274 // twisted TPL used. It should be no problem for us to connect
275 // or disconnect at CALLBACK.
279 // Only recursively wanted usb child device
281 if (UsbBusIsWantedUsbIO (UsbIf
->Device
->Bus
, UsbIf
)) {
282 OldTpl
= UsbGetCurrentTpl ();
283 DEBUG ((EFI_D_INFO
, "UsbConnectDriver: TPL before connect is %d, %p\n", (UINT32
)OldTpl
, UsbIf
->Handle
));
285 gBS
->RestoreTPL (TPL_CALLBACK
);
287 Status
= gBS
->ConnectController (UsbIf
->Handle
, NULL
, NULL
, TRUE
);
288 UsbIf
->IsManaged
= (BOOLEAN
)!EFI_ERROR (Status
);
290 DEBUG ((EFI_D_INFO
, "UsbConnectDriver: TPL after connect is %d\n", (UINT32
)UsbGetCurrentTpl()));
291 ASSERT (UsbGetCurrentTpl () == TPL_CALLBACK
);
293 gBS
->RaiseTPL (OldTpl
);
302 Select an alternate setting for the interface.
303 Each interface can have several mutually exclusive
304 settings. Only one setting is active. It will
305 also reset its endpoints' toggle to zero.
307 @param IfDesc The interface descriptor to set.
308 @param Alternate The alternate setting number to locate.
310 @retval EFI_NOT_FOUND There is no setting with this alternate index.
311 @retval EFI_SUCCESS The interface is set to Alternate setting.
316 IN USB_INTERFACE_DESC
*IfDesc
,
320 USB_INTERFACE_SETTING
*Setting
;
324 // Locate the active alternate setting
328 for (Index
= 0; Index
< IfDesc
->NumOfSetting
; Index
++) {
329 ASSERT (Index
< USB_MAX_INTERFACE_SETTING
);
330 Setting
= IfDesc
->Settings
[Index
];
332 if (Setting
->Desc
.AlternateSetting
== Alternate
) {
337 if (Index
== IfDesc
->NumOfSetting
) {
338 return EFI_NOT_FOUND
;
341 IfDesc
->ActiveIndex
= Index
;
343 ASSERT (Setting
!= NULL
);
344 DEBUG ((EFI_D_INFO
, "UsbSelectSetting: setting %d selected for interface %d\n",
345 Alternate
, Setting
->Desc
.InterfaceNumber
));
348 // Reset the endpoint toggle to zero
350 for (Index
= 0; Index
< Setting
->Desc
.NumEndpoints
; Index
++) {
351 Setting
->Endpoints
[Index
]->Toggle
= 0;
359 Select a new configuration for the device. Each
360 device may support several configurations.
362 @param Device The device to select configuration.
363 @param ConfigValue The index of the configuration ( != 0).
365 @retval EFI_NOT_FOUND There is no configuration with the index.
366 @retval EFI_OUT_OF_RESOURCES Failed to allocate resource.
367 @retval EFI_SUCCESS The configuration is selected.
372 IN USB_DEVICE
*Device
,
376 USB_DEVICE_DESC
*DevDesc
;
377 USB_CONFIG_DESC
*ConfigDesc
;
378 USB_INTERFACE_DESC
*IfDesc
;
379 USB_INTERFACE
*UsbIf
;
384 // Locate the active config, then set the device's pointer
386 DevDesc
= Device
->DevDesc
;
389 for (Index
= 0; Index
< DevDesc
->Desc
.NumConfigurations
; Index
++) {
390 ConfigDesc
= DevDesc
->Configs
[Index
];
392 if (ConfigDesc
->Desc
.ConfigurationValue
== ConfigValue
) {
397 if (Index
== DevDesc
->Desc
.NumConfigurations
) {
398 return EFI_NOT_FOUND
;
401 Device
->ActiveConfig
= ConfigDesc
;
403 DEBUG ((EFI_D_INFO
, "UsbSelectConfig: config %d selected for device %d\n",
404 ConfigValue
, Device
->Address
));
407 // Create interfaces for each USB interface descriptor.
409 for (Index
= 0; Index
< ConfigDesc
->Desc
.NumInterfaces
; Index
++) {
411 // First select the default interface setting, and reset
412 // the endpoint toggles to zero for its endpoints.
414 IfDesc
= ConfigDesc
->Interfaces
[Index
];
415 UsbSelectSetting (IfDesc
, IfDesc
->Settings
[0]->Desc
.AlternateSetting
);
418 // Create a USB_INTERFACE and install USB_IO and other protocols
420 UsbIf
= UsbCreateInterface (Device
, ConfigDesc
->Interfaces
[Index
]);
423 return EFI_OUT_OF_RESOURCES
;
426 ASSERT (Index
< USB_MAX_INTERFACE
);
427 Device
->Interfaces
[Index
] = UsbIf
;
430 // Connect the device to drivers, if it failed, ignore
431 // the error. Don't let the unsupported interfaces to block
432 // the supported interfaces.
434 Status
= UsbConnectDriver (UsbIf
);
436 if (EFI_ERROR (Status
)) {
437 DEBUG ((EFI_D_ERROR
, "UsbSelectConfig: failed to connect driver %r, ignored\n", Status
));
441 Device
->NumOfInterface
= Index
;
448 Disconnect the USB interface with its driver.
450 @param UsbIf The interface to disconnect driver from.
454 UsbDisconnectDriver (
455 IN USB_INTERFACE
*UsbIf
462 // Release the hub if it's a hub controller, otherwise
463 // disconnect the driver if it is managed by other drivers.
466 UsbIf
->HubApi
->Release (UsbIf
);
468 } else if (UsbIf
->IsManaged
) {
470 // This function is called in both UsbIoControlTransfer and
471 // the timer callback in hub enumeration. So, at least it is
472 // called at TPL_CALLBACK. Some driver sitting on USB has
473 // twisted TPL used. It should be no problem for us to connect
474 // or disconnect at CALLBACK.
476 OldTpl
= UsbGetCurrentTpl ();
477 DEBUG ((EFI_D_INFO
, "UsbDisconnectDriver: old TPL is %d, %p\n", (UINT32
)OldTpl
, UsbIf
->Handle
));
479 gBS
->RestoreTPL (TPL_CALLBACK
);
481 Status
= gBS
->DisconnectController (UsbIf
->Handle
, NULL
, NULL
);
482 UsbIf
->IsManaged
= FALSE
;
484 DEBUG (( EFI_D_INFO
, "UsbDisconnectDriver: TPL after disconnect is %d, %d\n", (UINT32
)UsbGetCurrentTpl(), Status
));
485 ASSERT (UsbGetCurrentTpl () == TPL_CALLBACK
);
487 gBS
->RaiseTPL (OldTpl
);
493 Remove the current device configuration.
495 @param Device The USB device to remove configuration from.
500 IN USB_DEVICE
*Device
503 USB_INTERFACE
*UsbIf
;
507 // Remove each interface of the device
509 for (Index
= 0; Index
< Device
->NumOfInterface
; Index
++) {
510 ASSERT (Index
< USB_MAX_INTERFACE
);
511 UsbIf
= Device
->Interfaces
[Index
];
517 UsbDisconnectDriver (UsbIf
);
518 UsbFreeInterface (UsbIf
);
519 Device
->Interfaces
[Index
] = NULL
;
522 Device
->ActiveConfig
= NULL
;
523 Device
->NumOfInterface
= 0;
528 Remove the device and all its children from the bus.
530 @param Device The device to remove.
532 @retval EFI_SUCCESS The device is removed.
537 IN USB_DEVICE
*Device
548 // Remove all the devices on its downstream ports. Search from devices[1].
549 // Devices[0] is the root hub.
551 for (Index
= 1; Index
< Bus
->MaxDevices
; Index
++) {
552 Child
= Bus
->Devices
[Index
];
554 if ((Child
== NULL
) || (Child
->ParentAddr
!= Device
->Address
)) {
558 Status
= UsbRemoveDevice (Child
);
560 if (EFI_ERROR (Status
)) {
561 DEBUG ((EFI_D_ERROR
, "UsbRemoveDevice: failed to remove child, ignore error\n"));
562 Bus
->Devices
[Index
] = NULL
;
566 UsbRemoveConfig (Device
);
568 DEBUG (( EFI_D_INFO
, "UsbRemoveDevice: device %d removed\n", Device
->Address
));
570 ASSERT (Device
->Address
< Bus
->MaxDevices
);
571 Bus
->Devices
[Device
->Address
] = NULL
;
572 UsbFreeDevice (Device
);
579 Find the child device on the hub's port.
581 @param HubIf The hub interface.
582 @param Port The port of the hub this child is connected to.
584 @return The device on the hub's port, or NULL if there is none.
589 IN USB_INTERFACE
*HubIf
,
597 Bus
= HubIf
->Device
->Bus
;
600 // Start checking from device 1, device 0 is the root hub
602 for (Index
= 1; Index
< Bus
->MaxDevices
; Index
++) {
603 Device
= Bus
->Devices
[Index
];
605 if ((Device
!= NULL
) && (Device
->ParentAddr
== HubIf
->Device
->Address
) &&
606 (Device
->ParentPort
== Port
)) {
617 Enumerate and configure the new device on the port of this HUB interface.
619 @param HubIf The HUB that has the device connected.
620 @param Port The port index of the hub (started with zero).
622 @retval EFI_SUCCESS The device is enumerated (added or removed).
623 @retval EFI_OUT_OF_RESOURCES Failed to allocate resource for the device.
624 @retval Others Failed to enumerate the device.
629 IN USB_INTERFACE
*HubIf
,
637 EFI_USB_PORT_STATUS PortState
;
642 Parent
= HubIf
->Device
;
644 HubApi
= HubIf
->HubApi
;
645 Address
= Bus
->MaxDevices
;
647 gBS
->Stall (USB_WAIT_PORT_STABLE_STALL
);
650 // Hub resets the device for at least 10 milliseconds.
651 // Host learns device speed. If device is of low/full speed
652 // and the hub is a EHCI root hub, ResetPort will release
653 // the device to its companion UHCI and return an error.
655 Status
= HubApi
->ResetPort (HubIf
, Port
);
657 if (EFI_ERROR (Status
)) {
658 DEBUG ((EFI_D_ERROR
, "UsbEnumerateNewDev: failed to reset port %d - %r\n", Port
, Status
));
663 DEBUG (( EFI_D_INFO
, "UsbEnumerateNewDev: hub port %d is reset\n", Port
));
665 Child
= UsbCreateDevice (HubIf
, Port
);
668 return EFI_OUT_OF_RESOURCES
;
672 // OK, now identify the device speed. After reset, hub
673 // fully knows the actual device speed.
675 Status
= HubApi
->GetPortStatus (HubIf
, Port
, &PortState
);
677 if (EFI_ERROR (Status
)) {
678 DEBUG ((EFI_D_ERROR
, "UsbEnumerateNewDev: failed to get speed of port %d\n", Port
));
682 if (!USB_BIT_IS_SET (PortState
.PortStatus
, USB_PORT_STAT_CONNECTION
)) {
683 DEBUG ((EFI_D_ERROR
, "UsbEnumerateNewDev: No device presented at port %d\n", Port
));
685 } else if (USB_BIT_IS_SET (PortState
.PortStatus
, USB_PORT_STAT_SUPER_SPEED
)){
686 Child
->Speed
= EFI_USB_SPEED_SUPER
;
687 Child
->MaxPacket0
= 512;
688 } else if (USB_BIT_IS_SET (PortState
.PortStatus
, USB_PORT_STAT_HIGH_SPEED
)) {
689 Child
->Speed
= EFI_USB_SPEED_HIGH
;
690 Child
->MaxPacket0
= 64;
691 } else if (USB_BIT_IS_SET (PortState
.PortStatus
, USB_PORT_STAT_LOW_SPEED
)) {
692 Child
->Speed
= EFI_USB_SPEED_LOW
;
693 Child
->MaxPacket0
= 8;
695 Child
->Speed
= EFI_USB_SPEED_FULL
;
696 Child
->MaxPacket0
= 8;
699 DEBUG (( EFI_D_INFO
, "UsbEnumerateNewDev: device is of %d speed\n", Child
->Speed
));
701 if (((Child
->Speed
== EFI_USB_SPEED_LOW
) || (Child
->Speed
== EFI_USB_SPEED_FULL
)) &&
702 (Parent
->Speed
== EFI_USB_SPEED_HIGH
)) {
704 // If the child is a low or full speed device, it is necessary to
705 // set the transaction translator. Port TT is 1-based.
706 // This is quite simple:
707 // 1. if parent is of high speed, then parent is our translator
708 // 2. otherwise use parent's translator.
710 Child
->Translator
.TranslatorHubAddress
= Parent
->Address
;
711 Child
->Translator
.TranslatorPortNumber
= (UINT8
) (Port
+ 1);
713 Child
->Translator
= Parent
->Translator
;
715 DEBUG (( EFI_D_INFO
, "UsbEnumerateNewDev: device uses translator (%d, %d)\n",
716 Child
->Translator
.TranslatorHubAddress
,
717 Child
->Translator
.TranslatorPortNumber
));
720 // After port is reset, hub establishes a signal path between
721 // the device and host (DEFALUT state). Device's registers are
722 // reset, use default address 0 (host enumerates one device at
723 // a time) , and ready to respond to control transfer at EP 0.
727 // Host assigns an address to the device. Device completes the
728 // status stage with default address, then switches to new address.
729 // ADDRESS state. Address zero is reserved for root hub.
731 ASSERT (Bus
->MaxDevices
<= 256);
732 for (Address
= 1; Address
< Bus
->MaxDevices
; Address
++) {
733 if (Bus
->Devices
[Address
] == NULL
) {
738 if (Address
>= Bus
->MaxDevices
) {
739 DEBUG ((EFI_D_ERROR
, "UsbEnumerateNewDev: address pool is full for port %d\n", Port
));
741 Status
= EFI_ACCESS_DENIED
;
745 Status
= UsbSetAddress (Child
, (UINT8
)Address
);
746 Child
->Address
= (UINT8
)Address
;
747 Bus
->Devices
[Address
] = Child
;
749 if (EFI_ERROR (Status
)) {
750 DEBUG ((EFI_D_ERROR
, "UsbEnumerateNewDev: failed to set device address - %r\n", Status
));
754 gBS
->Stall (USB_SET_DEVICE_ADDRESS_STALL
);
756 DEBUG ((EFI_D_INFO
, "UsbEnumerateNewDev: device is now ADDRESSED at %d\n", Address
));
759 // Host sends a Get_Descriptor request to learn the max packet
760 // size of default pipe (only part of the device's descriptor).
762 Status
= UsbGetMaxPacketSize0 (Child
);
764 if (EFI_ERROR (Status
)) {
765 DEBUG ((EFI_D_ERROR
, "UsbEnumerateNewDev: failed to get max packet for EP 0 - %r\n", Status
));
769 DEBUG (( EFI_D_INFO
, "UsbEnumerateNewDev: max packet size for EP 0 is %d\n", Child
->MaxPacket0
));
772 // Host learns about the device's abilities by requesting device's
773 // entire descriptions.
775 Status
= UsbBuildDescTable (Child
);
777 if (EFI_ERROR (Status
)) {
778 DEBUG ((EFI_D_ERROR
, "UsbEnumerateNewDev: failed to build descriptor table - %r\n", Status
));
783 // Select a default configuration: UEFI must set the configuration
784 // before the driver can connect to the device.
786 Config
= Child
->DevDesc
->Configs
[0]->Desc
.ConfigurationValue
;
787 Status
= UsbSetConfig (Child
, Config
);
789 if (EFI_ERROR (Status
)) {
790 DEBUG ((EFI_D_ERROR
, "UsbEnumerateNewDev: failed to set configure %d - %r\n", Config
, Status
));
794 DEBUG (( EFI_D_INFO
, "UsbEnumerateNewDev: device %d is now in CONFIGED state\n", Address
));
797 // Host assigns and loads a device driver.
799 Status
= UsbSelectConfig (Child
, Config
);
801 if (EFI_ERROR (Status
)) {
802 DEBUG ((EFI_D_ERROR
, "UsbEnumerateNewDev: failed to create interfaces - %r\n", Status
));
809 if (Address
!= Bus
->MaxDevices
) {
810 Bus
->Devices
[Address
] = NULL
;
814 UsbFreeDevice (Child
);
822 Process the events on the port.
824 @param HubIf The HUB that has the device connected.
825 @param Port The port index of the hub (started with zero).
827 @retval EFI_SUCCESS The device is enumerated (added or removed).
828 @retval EFI_OUT_OF_RESOURCES Failed to allocate resource for the device.
829 @retval Others Failed to enumerate the device.
834 IN USB_INTERFACE
*HubIf
,
840 EFI_USB_PORT_STATUS PortState
;
844 HubApi
= HubIf
->HubApi
;
847 // Host learns of the new device by polling the hub for port changes.
849 Status
= HubApi
->GetPortStatus (HubIf
, Port
, &PortState
);
851 if (EFI_ERROR (Status
)) {
852 DEBUG ((EFI_D_ERROR
, "UsbEnumeratePort: failed to get state of port %d\n", Port
));
857 // Only handle connection/enable/overcurrent/reset change.
858 // Usb super speed hub may report other changes, such as warm reset change. Ignore them.
860 if ((PortState
.PortChangeStatus
& (USB_PORT_STAT_C_CONNECTION
| USB_PORT_STAT_C_ENABLE
| USB_PORT_STAT_C_OVERCURRENT
| USB_PORT_STAT_C_RESET
)) == 0) {
864 DEBUG (( EFI_D_INFO
, "UsbEnumeratePort: port %d state - %02x, change - %02x on %p\n",
865 Port
, PortState
.PortStatus
, PortState
.PortChangeStatus
, HubIf
));
868 // This driver only process two kinds of events now: over current and
869 // connect/disconnect. Other three events are: ENABLE, SUSPEND, RESET.
870 // ENABLE/RESET is used to reset port. SUSPEND isn't supported.
873 if (USB_BIT_IS_SET (PortState
.PortChangeStatus
, USB_PORT_STAT_C_OVERCURRENT
)) {
875 if (USB_BIT_IS_SET (PortState
.PortStatus
, USB_PORT_STAT_OVERCURRENT
)) {
878 // Both OverCurrent and OverCurrentChange set, means over current occurs,
879 // which probably is caused by short circuit. It has to wait system hardware
880 // to perform recovery.
882 DEBUG (( EFI_D_ERROR
, "UsbEnumeratePort: Critical Over Current\n", Port
));
883 return EFI_DEVICE_ERROR
;
888 // Only OverCurrentChange set, means system has been recoveried from
889 // over current. As a result, all ports are nearly power-off, so
890 // it's necessary to detach and enumerate all ports again.
892 DEBUG (( EFI_D_ERROR
, "UsbEnumeratePort: 2.0 device Recovery Over Current\n", Port
));
895 if (USB_BIT_IS_SET (PortState
.PortChangeStatus
, USB_PORT_STAT_C_ENABLE
)) {
898 // 1.1 roothub port reg doesn't reflect over-current state, while its counterpart
899 // on 2.0 roothub does. When over-current has influence on 1.1 device, the port
900 // would be disabled, so it's also necessary to detach and enumerate again.
902 DEBUG (( EFI_D_ERROR
, "UsbEnumeratePort: 1.1 device Recovery Over Current\n", Port
));
905 if (USB_BIT_IS_SET (PortState
.PortChangeStatus
, USB_PORT_STAT_C_CONNECTION
)) {
908 // Device connected or disconnected normally.
910 DEBUG ((EFI_D_ERROR
, "UsbEnumeratePort: Device Connect/Discount Normally\n", Port
));
914 // Following as the above cases, it's safety to remove and create again.
916 Child
= UsbFindChild (HubIf
, Port
);
919 DEBUG (( EFI_D_INFO
, "UsbEnumeratePort: device at port %d removed from root hub %p\n", Port
, HubIf
));
920 UsbRemoveDevice (Child
);
923 if (USB_BIT_IS_SET (PortState
.PortStatus
, USB_PORT_STAT_CONNECTION
)) {
925 // Now, new device connected, enumerate and configure the device
927 DEBUG (( EFI_D_INFO
, "UsbEnumeratePort: new device connected at port %d\n", Port
));
928 Status
= UsbEnumerateNewDev (HubIf
, Port
);
931 DEBUG (( EFI_D_INFO
, "UsbEnumeratePort: device disconnected event on port %d\n", Port
));
934 HubApi
->ClearPortChange (HubIf
, Port
);
940 Enumerate all the changed hub ports.
942 @param Event The event that is triggered.
943 @param Context The context to the event.
953 USB_INTERFACE
*HubIf
;
958 ASSERT (Context
!= NULL
);
960 HubIf
= (USB_INTERFACE
*) Context
;
962 if (HubIf
->ChangeMap
== NULL
) {
967 // HUB starts its port index with 1.
972 for (Index
= 0; Index
< HubIf
->NumOfPort
; Index
++) {
973 if (USB_BIT_IS_SET (HubIf
->ChangeMap
[Byte
], USB_BIT (Bit
))) {
974 UsbEnumeratePort (HubIf
, Index
);
977 USB_NEXT_BIT (Byte
, Bit
);
980 UsbHubAckHubStatus (HubIf
->Device
);
982 gBS
->FreePool (HubIf
->ChangeMap
);
983 HubIf
->ChangeMap
= NULL
;
989 Enumerate all the changed hub ports.
991 @param Event The event that is triggered.
992 @param Context The context to the event.
997 UsbRootHubEnumeration (
1002 USB_INTERFACE
*RootHub
;
1005 RootHub
= (USB_INTERFACE
*) Context
;
1007 for (Index
= 0; Index
< RootHub
->NumOfPort
; Index
++) {
1008 UsbEnumeratePort (RootHub
, Index
);