3 Usb Bus Driver Binding and Bus IO Protocol.
5 Copyright (c) 2004 - 2016, 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.
18 EFI_USB_IO_PROTOCOL mUsbIoProtocol
= {
21 UsbIoAsyncInterruptTransfer
,
22 UsbIoSyncInterruptTransfer
,
23 UsbIoIsochronousTransfer
,
24 UsbIoAsyncIsochronousTransfer
,
25 UsbIoGetDeviceDescriptor
,
26 UsbIoGetActiveConfigDescriptor
,
27 UsbIoGetInterfaceDescriptor
,
28 UsbIoGetEndpointDescriptor
,
29 UsbIoGetStringDescriptor
,
30 UsbIoGetSupportedLanguages
,
34 EFI_DRIVER_BINDING_PROTOCOL mUsbBusDriverBinding
= {
35 UsbBusControllerDriverSupported
,
36 UsbBusControllerDriverStart
,
37 UsbBusControllerDriverStop
,
44 USB_IO function to execute a control transfer. This
45 function will execute the USB transfer. If transfer
46 successes, it will sync the internal state of USB bus
49 @param This The USB_IO instance
50 @param Request The control transfer request
51 @param Direction Direction for data stage
52 @param Timeout The time to wait before timeout
53 @param Data The buffer holding the data
54 @param DataLength Then length of the data
55 @param UsbStatus USB result
57 @retval EFI_INVALID_PARAMETER The parameters are invalid
58 @retval EFI_SUCCESS The control transfer succeeded.
59 @retval Others Failed to execute the transfer
64 UsbIoControlTransfer (
65 IN EFI_USB_IO_PROTOCOL
*This
,
66 IN EFI_USB_DEVICE_REQUEST
*Request
,
67 IN EFI_USB_DATA_DIRECTION Direction
,
69 IN OUT VOID
*Data
, OPTIONAL
70 IN UINTN DataLength
, OPTIONAL
76 USB_ENDPOINT_DESC
*EpDesc
;
80 if (UsbStatus
== NULL
) {
81 return EFI_INVALID_PARAMETER
;
84 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
86 UsbIf
= USB_INTERFACE_FROM_USBIO (This
);
89 Status
= UsbHcControlTransfer (
103 if (EFI_ERROR (Status
) || (*UsbStatus
!= EFI_USB_NOERROR
)) {
105 // Clear TT buffer when CTRL/BULK split transaction failes
106 // Clear the TRANSLATOR TT buffer, not parent's buffer
108 ASSERT (Dev
->Translator
.TranslatorHubAddress
< Dev
->Bus
->MaxDevices
);
109 if (Dev
->Translator
.TranslatorHubAddress
!= 0) {
110 UsbHubCtrlClearTTBuffer (
111 Dev
->Bus
->Devices
[Dev
->Translator
.TranslatorHubAddress
],
112 Dev
->Translator
.TranslatorPortNumber
,
123 // Some control transfer will change the device's internal
124 // status, such as Set_Configuration and Set_Interface.
125 // We must synchronize the bus driver's status with that in
126 // device. We ignore the Set_Descriptor request because it's
127 // hardly used by any device, especially in pre-boot environment
131 // Reset the endpoint toggle when endpoint stall is cleared
133 if ((Request
->Request
== USB_REQ_CLEAR_FEATURE
) &&
134 (Request
->RequestType
== USB_REQUEST_TYPE (EfiUsbNoData
, USB_REQ_TYPE_STANDARD
,
135 USB_TARGET_ENDPOINT
)) &&
136 (Request
->Value
== USB_FEATURE_ENDPOINT_HALT
)) {
138 EpDesc
= UsbGetEndpointDesc (UsbIf
, (UINT8
) Request
->Index
);
140 if (EpDesc
!= NULL
) {
146 // Select a new configuration. This is a dangerous action. Upper driver
147 // should stop use its current UsbIo after calling this driver. The old
148 // UsbIo will be uninstalled and new UsbIo be installed. We can't use
149 // ReinstallProtocol since interfaces in different configuration may be
150 // completely irrelevant.
152 if ((Request
->Request
== USB_REQ_SET_CONFIG
) &&
153 (Request
->RequestType
== USB_REQUEST_TYPE (EfiUsbNoData
, USB_REQ_TYPE_STANDARD
,
154 USB_TARGET_DEVICE
))) {
156 // Don't re-create the USB interfaces if configuration isn't changed.
158 if ((Dev
->ActiveConfig
!= NULL
) &&
159 (Request
->Value
== Dev
->ActiveConfig
->Desc
.ConfigurationValue
)) {
163 DEBUG ((EFI_D_INFO
, "UsbIoControlTransfer: configure changed!!! Do NOT use old UsbIo!!!\n"));
165 if (Dev
->ActiveConfig
!= NULL
) {
166 UsbRemoveConfig (Dev
);
169 if (Request
->Value
!= 0) {
170 Status
= UsbSelectConfig (Dev
, (UINT8
) Request
->Value
);
174 // Exit now, Old USB_IO is invalid now
180 // A new alternative setting is selected for the interface.
181 // No need to reinstall UsbIo in this case because only
182 // underlying communication endpoints are changed. Functionality
183 // should remains the same.
185 if ((Request
->Request
== USB_REQ_SET_INTERFACE
) &&
186 (Request
->RequestType
== USB_REQUEST_TYPE (EfiUsbNoData
, USB_REQ_TYPE_STANDARD
,
187 USB_TARGET_INTERFACE
)) &&
188 (Request
->Index
== UsbIf
->IfSetting
->Desc
.InterfaceNumber
)) {
190 Status
= UsbSelectSetting (UsbIf
->IfDesc
, (UINT8
) Request
->Value
);
192 if (!EFI_ERROR (Status
)) {
193 ASSERT (UsbIf
->IfDesc
->ActiveIndex
< USB_MAX_INTERFACE_SETTING
);
194 UsbIf
->IfSetting
= UsbIf
->IfDesc
->Settings
[UsbIf
->IfDesc
->ActiveIndex
];
199 gBS
->RestoreTPL (OldTpl
);
205 Execute a bulk transfer to the device endpoint.
207 @param This The USB IO instance.
208 @param Endpoint The device endpoint.
209 @param Data The data to transfer.
210 @param DataLength The length of the data to transfer.
211 @param Timeout Time to wait before timeout.
212 @param UsbStatus The result of USB transfer.
214 @retval EFI_SUCCESS The bulk transfer is OK.
215 @retval EFI_INVALID_PARAMETER Some parameters are invalid.
216 @retval Others Failed to execute transfer, reason returned in
223 IN EFI_USB_IO_PROTOCOL
*This
,
226 IN OUT UINTN
*DataLength
,
228 OUT UINT32
*UsbStatus
232 USB_INTERFACE
*UsbIf
;
233 USB_ENDPOINT_DESC
*EpDesc
;
239 if ((USB_ENDPOINT_ADDR (Endpoint
) == 0) || (USB_ENDPOINT_ADDR(Endpoint
) > 15) ||
240 (UsbStatus
== NULL
)) {
242 return EFI_INVALID_PARAMETER
;
245 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
247 UsbIf
= USB_INTERFACE_FROM_USBIO (This
);
250 EpDesc
= UsbGetEndpointDesc (UsbIf
, Endpoint
);
252 if ((EpDesc
== NULL
) || (USB_ENDPOINT_TYPE (&EpDesc
->Desc
) != USB_ENDPOINT_BULK
)) {
253 Status
= EFI_INVALID_PARAMETER
;
258 Toggle
= EpDesc
->Toggle
;
259 Status
= UsbHcBulkTransfer (
264 EpDesc
->Desc
.MaxPacketSize
,
274 EpDesc
->Toggle
= Toggle
;
276 if (EFI_ERROR (Status
) || (*UsbStatus
!= EFI_USB_NOERROR
)) {
278 // Clear TT buffer when CTRL/BULK split transaction failes.
279 // Clear the TRANSLATOR TT buffer, not parent's buffer
281 ASSERT (Dev
->Translator
.TranslatorHubAddress
< Dev
->Bus
->MaxDevices
);
282 if (Dev
->Translator
.TranslatorHubAddress
!= 0) {
283 UsbHubCtrlClearTTBuffer (
284 Dev
->Bus
->Devices
[Dev
->Translator
.TranslatorHubAddress
],
285 Dev
->Translator
.TranslatorPortNumber
,
294 gBS
->RestoreTPL (OldTpl
);
300 Execute a synchronous interrupt transfer.
302 @param This The USB IO instance.
303 @param Endpoint The device endpoint.
304 @param Data The data to transfer.
305 @param DataLength The length of the data to transfer.
306 @param Timeout Time to wait before timeout.
307 @param UsbStatus The result of USB transfer.
309 @retval EFI_SUCCESS The synchronous interrupt transfer is OK.
310 @retval EFI_INVALID_PARAMETER Some parameters are invalid.
311 @retval Others Failed to execute transfer, reason returned in
317 UsbIoSyncInterruptTransfer (
318 IN EFI_USB_IO_PROTOCOL
*This
,
321 IN OUT UINTN
*DataLength
,
323 OUT UINT32
*UsbStatus
327 USB_INTERFACE
*UsbIf
;
328 USB_ENDPOINT_DESC
*EpDesc
;
333 if ((USB_ENDPOINT_ADDR (Endpoint
) == 0) || (USB_ENDPOINT_ADDR(Endpoint
) > 15) ||
334 (UsbStatus
== NULL
)) {
336 return EFI_INVALID_PARAMETER
;
339 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
341 UsbIf
= USB_INTERFACE_FROM_USBIO (This
);
344 EpDesc
= UsbGetEndpointDesc (UsbIf
, Endpoint
);
346 if ((EpDesc
== NULL
) || (USB_ENDPOINT_TYPE (&EpDesc
->Desc
) != USB_ENDPOINT_INTERRUPT
)) {
347 Status
= EFI_INVALID_PARAMETER
;
351 Toggle
= EpDesc
->Toggle
;
352 Status
= UsbHcSyncInterruptTransfer (
357 EpDesc
->Desc
.MaxPacketSize
,
366 EpDesc
->Toggle
= Toggle
;
369 gBS
->RestoreTPL (OldTpl
);
375 Queue a new asynchronous interrupt transfer, or remove the old
376 request if (IsNewTransfer == FALSE).
378 @param This The USB_IO instance.
379 @param Endpoint The device endpoint.
380 @param IsNewTransfer Whether this is a new request, if it's old, remove
382 @param PollInterval The interval to poll the transfer result, (in ms).
383 @param DataLength The length of perodic data transfer.
384 @param Callback The function to call periodicaly when transfer is
386 @param Context The context to the callback.
388 @retval EFI_SUCCESS New transfer is queued or old request is removed.
389 @retval EFI_INVALID_PARAMETER Some parameters are invalid.
390 @retval Others Failed to queue the new request or remove the old
396 UsbIoAsyncInterruptTransfer (
397 IN EFI_USB_IO_PROTOCOL
*This
,
399 IN BOOLEAN IsNewTransfer
,
400 IN UINTN PollInterval
, OPTIONAL
401 IN UINTN DataLength
, OPTIONAL
402 IN EFI_ASYNC_USB_TRANSFER_CALLBACK Callback
, OPTIONAL
403 IN VOID
*Context OPTIONAL
407 USB_INTERFACE
*UsbIf
;
408 USB_ENDPOINT_DESC
*EpDesc
;
413 if ((USB_ENDPOINT_ADDR (Endpoint
) == 0) || (USB_ENDPOINT_ADDR (Endpoint
) > 15)) {
414 return EFI_INVALID_PARAMETER
;
417 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
418 UsbIf
= USB_INTERFACE_FROM_USBIO (This
);
421 EpDesc
= UsbGetEndpointDesc (UsbIf
, Endpoint
);
423 if ((EpDesc
== NULL
) || (USB_ENDPOINT_TYPE (&EpDesc
->Desc
) != USB_ENDPOINT_INTERRUPT
)) {
424 Status
= EFI_INVALID_PARAMETER
;
428 Toggle
= EpDesc
->Toggle
;
429 Status
= UsbHcAsyncInterruptTransfer (
434 EpDesc
->Desc
.MaxPacketSize
,
444 EpDesc
->Toggle
= Toggle
;
447 gBS
->RestoreTPL (OldTpl
);
453 Execute a synchronous isochronous transfer.
455 @param This The USB IO instance.
456 @param DeviceEndpoint The device endpoint.
457 @param Data The data to transfer.
458 @param DataLength The length of the data to transfer.
459 @param UsbStatus The result of USB transfer.
461 @retval EFI_UNSUPPORTED Currently isochronous transfer isn't supported.
466 UsbIoIsochronousTransfer (
467 IN EFI_USB_IO_PROTOCOL
*This
,
468 IN UINT8 DeviceEndpoint
,
474 return EFI_UNSUPPORTED
;
479 Queue an asynchronous isochronous transfer.
481 @param This The USB_IO instance.
482 @param DeviceEndpoint The device endpoint.
483 @param Data The data to transfer.
484 @param DataLength The length of perodic data transfer.
485 @param IsochronousCallBack The function to call periodicaly when transfer is
487 @param Context The context to the callback.
489 @retval EFI_UNSUPPORTED Currently isochronous transfer isn't supported.
494 UsbIoAsyncIsochronousTransfer (
495 IN EFI_USB_IO_PROTOCOL
*This
,
496 IN UINT8 DeviceEndpoint
,
499 IN EFI_ASYNC_USB_TRANSFER_CALLBACK IsochronousCallBack
,
500 IN VOID
*Context OPTIONAL
503 return EFI_UNSUPPORTED
;
508 Retrieve the device descriptor of the device.
510 @param This The USB IO instance.
511 @param Descriptor The variable to receive the device descriptor.
513 @retval EFI_SUCCESS The device descriptor is returned.
514 @retval EFI_INVALID_PARAMETER The parameter is invalid.
519 UsbIoGetDeviceDescriptor (
520 IN EFI_USB_IO_PROTOCOL
*This
,
521 OUT EFI_USB_DEVICE_DESCRIPTOR
*Descriptor
525 USB_INTERFACE
*UsbIf
;
528 if (Descriptor
== NULL
) {
529 return EFI_INVALID_PARAMETER
;
532 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
534 UsbIf
= USB_INTERFACE_FROM_USBIO (This
);
537 CopyMem (Descriptor
, &Dev
->DevDesc
->Desc
, sizeof (EFI_USB_DEVICE_DESCRIPTOR
));
539 gBS
->RestoreTPL (OldTpl
);
545 Return the configuration descriptor of the current active configuration.
547 @param This The USB IO instance.
548 @param Descriptor The USB configuration descriptor.
550 @retval EFI_SUCCESS The active configuration descriptor is returned.
551 @retval EFI_INVALID_PARAMETER Some parameter is invalid.
552 @retval EFI_NOT_FOUND Currently no active configuration is selected.
557 UsbIoGetActiveConfigDescriptor (
558 IN EFI_USB_IO_PROTOCOL
*This
,
559 OUT EFI_USB_CONFIG_DESCRIPTOR
*Descriptor
563 USB_INTERFACE
*UsbIf
;
567 if (Descriptor
== NULL
) {
568 return EFI_INVALID_PARAMETER
;
571 Status
= EFI_SUCCESS
;
572 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
574 UsbIf
= USB_INTERFACE_FROM_USBIO (This
);
577 if (Dev
->ActiveConfig
== NULL
) {
578 Status
= EFI_NOT_FOUND
;
582 CopyMem (Descriptor
, &(Dev
->ActiveConfig
->Desc
), sizeof (EFI_USB_CONFIG_DESCRIPTOR
));
585 gBS
->RestoreTPL (OldTpl
);
591 Retrieve the active interface setting descriptor for this USB IO instance.
593 @param This The USB IO instance.
594 @param Descriptor The variable to receive active interface setting.
596 @retval EFI_SUCCESS The active interface setting is returned.
597 @retval EFI_INVALID_PARAMETER Some parameter is invalid.
602 UsbIoGetInterfaceDescriptor (
603 IN EFI_USB_IO_PROTOCOL
*This
,
604 OUT EFI_USB_INTERFACE_DESCRIPTOR
*Descriptor
607 USB_INTERFACE
*UsbIf
;
610 if (Descriptor
== NULL
) {
611 return EFI_INVALID_PARAMETER
;
614 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
616 UsbIf
= USB_INTERFACE_FROM_USBIO (This
);
617 CopyMem (Descriptor
, &(UsbIf
->IfSetting
->Desc
), sizeof (EFI_USB_INTERFACE_DESCRIPTOR
));
619 gBS
->RestoreTPL (OldTpl
);
625 Retrieve the endpoint descriptor from this interface setting.
627 @param This The USB IO instance.
628 @param Index The index (start from zero) of the endpoint to
630 @param Descriptor The variable to receive the descriptor.
632 @retval EFI_SUCCESS The endpoint descriptor is returned.
633 @retval EFI_INVALID_PARAMETER Some parameter is invalid.
638 UsbIoGetEndpointDescriptor (
639 IN EFI_USB_IO_PROTOCOL
*This
,
641 OUT EFI_USB_ENDPOINT_DESCRIPTOR
*Descriptor
644 USB_INTERFACE
*UsbIf
;
647 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
649 UsbIf
= USB_INTERFACE_FROM_USBIO (This
);
651 if ((Descriptor
== NULL
) || (Index
> 15)) {
652 gBS
->RestoreTPL (OldTpl
);
653 return EFI_INVALID_PARAMETER
;
656 if (Index
>= UsbIf
->IfSetting
->Desc
.NumEndpoints
) {
657 gBS
->RestoreTPL (OldTpl
);
658 return EFI_NOT_FOUND
;
663 &(UsbIf
->IfSetting
->Endpoints
[Index
]->Desc
),
664 sizeof (EFI_USB_ENDPOINT_DESCRIPTOR
)
667 gBS
->RestoreTPL (OldTpl
);
673 Retrieve the supported language ID table from the device.
675 @param This The USB IO instance.
676 @param LangIDTable The table to return the language IDs.
677 @param TableSize The size, in bytes, of the table LangIDTable.
679 @retval EFI_SUCCESS The language ID is return.
684 UsbIoGetSupportedLanguages (
685 IN EFI_USB_IO_PROTOCOL
*This
,
686 OUT UINT16
**LangIDTable
,
687 OUT UINT16
*TableSize
691 USB_INTERFACE
*UsbIf
;
694 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
696 UsbIf
= USB_INTERFACE_FROM_USBIO (This
);
699 *LangIDTable
= Dev
->LangId
;
700 *TableSize
= (UINT16
) (Dev
->TotalLangId
* sizeof (UINT16
));
702 gBS
->RestoreTPL (OldTpl
);
708 Retrieve an indexed string in the language of LangID.
710 @param This The USB IO instance.
711 @param LangID The language ID of the string to retrieve.
712 @param StringIndex The index of the string.
713 @param String The variable to receive the string.
715 @retval EFI_SUCCESS The string is returned.
716 @retval EFI_NOT_FOUND No such string existed.
721 UsbIoGetStringDescriptor (
722 IN EFI_USB_IO_PROTOCOL
*This
,
724 IN UINT8 StringIndex
,
729 USB_INTERFACE
*UsbIf
;
730 EFI_USB_STRING_DESCRIPTOR
*StrDesc
;
736 if ((StringIndex
== 0) || (LangID
== 0)) {
737 return EFI_NOT_FOUND
;
740 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
742 UsbIf
= USB_INTERFACE_FROM_USBIO (This
);
746 // Check whether language ID is supported
748 Status
= EFI_NOT_FOUND
;
750 for (Index
= 0; Index
< Dev
->TotalLangId
; Index
++) {
751 ASSERT (Index
< USB_MAX_LANG_ID
);
752 if (Dev
->LangId
[Index
] == LangID
) {
757 if (Index
== Dev
->TotalLangId
) {
762 // Retrieve the string descriptor then allocate a buffer
763 // to hold the string itself.
765 StrDesc
= UsbGetOneString (Dev
, StringIndex
, LangID
);
767 if (StrDesc
== NULL
) {
771 if (StrDesc
->Length
<= 2) {
775 Buf
= AllocateZeroPool (StrDesc
->Length
);
778 Status
= EFI_OUT_OF_RESOURCES
;
782 CopyMem (Buf
, StrDesc
->String
, StrDesc
->Length
- 2);
783 *String
= (CHAR16
*) Buf
;
784 Status
= EFI_SUCCESS
;
787 gBS
->FreePool (StrDesc
);
790 gBS
->RestoreTPL (OldTpl
);
796 Reset the device, then if that succeeds, reconfigure the
797 device with its address and current active configuration.
799 @param This The USB IO instance.
801 @retval EFI_SUCCESS The device is reset and configured.
802 @retval Others Failed to reset the device.
808 IN EFI_USB_IO_PROTOCOL
*This
811 USB_INTERFACE
*UsbIf
;
812 USB_INTERFACE
*HubIf
;
818 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
820 UsbIf
= USB_INTERFACE_FROM_USBIO (This
);
824 Status
= EFI_INVALID_PARAMETER
;
828 HubIf
= Dev
->ParentIf
;
829 Status
= HubIf
->HubApi
->ResetPort (HubIf
, Dev
->ParentPort
);
831 if (EFI_ERROR (Status
)) {
832 DEBUG (( EFI_D_ERROR
, "UsbIoPortReset: failed to reset hub port %d@hub %d, %r \n",
833 Dev
->ParentPort
, Dev
->ParentAddr
, Status
));
838 HubIf
->HubApi
->ClearPortChange (HubIf
, Dev
->ParentPort
);
841 // Reset the device to its current address. The device now has an address
842 // of ZERO after port reset, so need to set Dev->Address to the device again for
843 // host to communicate with it.
845 DevAddress
= Dev
->Address
;
847 Status
= UsbSetAddress (Dev
, DevAddress
);
848 Dev
->Address
= DevAddress
;
850 gBS
->Stall (USB_SET_DEVICE_ADDRESS_STALL
);
852 if (EFI_ERROR (Status
)) {
854 // It may fail due to device disconnection or other reasons.
856 DEBUG (( EFI_D_ERROR
, "UsbIoPortReset: failed to set address for device %d - %r\n",
857 Dev
->Address
, Status
));
862 DEBUG (( EFI_D_INFO
, "UsbIoPortReset: device is now ADDRESSED at %d\n", Dev
->Address
));
865 // Reset the current active configure, after this device
866 // is in CONFIGURED state.
868 if (Dev
->ActiveConfig
!= NULL
) {
869 Status
= UsbSetConfig (Dev
, Dev
->ActiveConfig
->Desc
.ConfigurationValue
);
871 if (EFI_ERROR (Status
)) {
872 DEBUG (( EFI_D_ERROR
, "UsbIoPortReset: failed to set configure for device %d - %r\n",
873 Dev
->Address
, Status
));
878 gBS
->RestoreTPL (OldTpl
);
884 Install Usb Bus Protocol on host controller, and start the Usb bus.
886 @param This The USB bus driver binding instance.
887 @param Controller The controller to check.
888 @param RemainingDevicePath The remaining device patch.
890 @retval EFI_SUCCESS The controller is controlled by the usb bus.
891 @retval EFI_ALREADY_STARTED The controller is already controlled by the usb bus.
892 @retval EFI_OUT_OF_RESOURCES Failed to allocate resources.
897 UsbBusBuildProtocol (
898 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
899 IN EFI_HANDLE Controller
,
900 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
905 USB_INTERFACE
*RootIf
;
909 UsbBus
= AllocateZeroPool (sizeof (USB_BUS
));
911 if (UsbBus
== NULL
) {
912 return EFI_OUT_OF_RESOURCES
;
915 UsbBus
->Signature
= USB_BUS_SIGNATURE
;
916 UsbBus
->HostHandle
= Controller
;
917 UsbBus
->MaxDevices
= USB_MAX_DEVICES
;
919 Status
= gBS
->OpenProtocol (
921 &gEfiDevicePathProtocolGuid
,
922 (VOID
**) &UsbBus
->DevicePath
,
923 This
->DriverBindingHandle
,
925 EFI_OPEN_PROTOCOL_BY_DRIVER
928 if (EFI_ERROR (Status
)) {
929 DEBUG ((EFI_D_ERROR
, "UsbBusStart: Failed to open device path %r\n", Status
));
936 // Get USB_HC2/USB_HC host controller protocol (EHCI/UHCI).
937 // This is for backward compatibility with EFI 1.x. In UEFI
938 // 2.x, USB_HC2 replaces USB_HC. We will open both USB_HC2
939 // and USB_HC because EHCI driver will install both protocols
940 // (for the same reason). If we don't consume both of them,
941 // the unconsumed one may be opened by others.
943 Status
= gBS
->OpenProtocol (
945 &gEfiUsb2HcProtocolGuid
,
946 (VOID
**) &(UsbBus
->Usb2Hc
),
947 This
->DriverBindingHandle
,
949 EFI_OPEN_PROTOCOL_BY_DRIVER
952 Status2
= gBS
->OpenProtocol (
954 &gEfiUsbHcProtocolGuid
,
955 (VOID
**) &(UsbBus
->UsbHc
),
956 This
->DriverBindingHandle
,
958 EFI_OPEN_PROTOCOL_BY_DRIVER
961 if (EFI_ERROR (Status
) && EFI_ERROR (Status2
)) {
962 DEBUG ((EFI_D_ERROR
, "UsbBusStart: Failed to open USB_HC/USB2_HC %r\n", Status
));
964 Status
= EFI_DEVICE_ERROR
;
968 if (!EFI_ERROR (Status
)) {
970 // The EFI_USB2_HC_PROTOCOL is produced for XHCI support.
971 // Then its max supported devices are 256. Otherwise it's 128.
973 ASSERT (UsbBus
->Usb2Hc
!= NULL
);
974 if (UsbBus
->Usb2Hc
->MajorRevision
== 0x3) {
975 UsbBus
->MaxDevices
= 256;
980 // Install an EFI_USB_BUS_PROTOCOL to host controller to identify it.
982 Status
= gBS
->InstallProtocolInterface (
985 EFI_NATIVE_INTERFACE
,
989 if (EFI_ERROR (Status
)) {
990 DEBUG ((EFI_D_ERROR
, "UsbBusStart: Failed to install bus protocol %r\n", Status
));
995 // Initial the wanted child device path list, and add first RemainingDevicePath
997 InitializeListHead (&UsbBus
->WantedUsbIoDPList
);
998 Status
= UsbBusAddWantedUsbIoDP (&UsbBus
->BusId
, RemainingDevicePath
);
999 ASSERT (!EFI_ERROR (Status
));
1001 // Create a fake usb device for root hub
1003 RootHub
= AllocateZeroPool (sizeof (USB_DEVICE
));
1005 if (RootHub
== NULL
) {
1006 Status
= EFI_OUT_OF_RESOURCES
;
1007 goto UNINSTALL_USBBUS
;
1010 RootIf
= AllocateZeroPool (sizeof (USB_INTERFACE
));
1012 if (RootIf
== NULL
) {
1014 Status
= EFI_OUT_OF_RESOURCES
;
1018 RootHub
->Bus
= UsbBus
;
1019 RootHub
->NumOfInterface
= 1;
1020 RootHub
->Interfaces
[0] = RootIf
;
1022 RootIf
->Signature
= USB_INTERFACE_SIGNATURE
;
1023 RootIf
->Device
= RootHub
;
1024 RootIf
->DevicePath
= UsbBus
->DevicePath
;
1027 // Report Status Code here since we will enumerate the USB devices
1029 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
1031 (EFI_IO_BUS_USB
| EFI_IOB_PC_DETECT
),
1035 Status
= mUsbRootHubApi
.Init (RootIf
);
1037 if (EFI_ERROR (Status
)) {
1038 DEBUG ((EFI_D_ERROR
, "UsbBusStart: Failed to init root hub %r\n", Status
));
1042 UsbBus
->Devices
[0] = RootHub
;
1044 DEBUG ((EFI_D_INFO
, "UsbBusStart: usb bus started on %p, root hub %p\n", Controller
, RootIf
));
1048 if (RootIf
!= NULL
) {
1051 if (RootHub
!= NULL
) {
1056 gBS
->UninstallProtocolInterface (Controller
, &gEfiCallerIdGuid
, &UsbBus
->BusId
);
1059 if (UsbBus
->Usb2Hc
!= NULL
) {
1060 gBS
->CloseProtocol (
1062 &gEfiUsb2HcProtocolGuid
,
1063 This
->DriverBindingHandle
,
1067 if (UsbBus
->UsbHc
!= NULL
) {
1068 gBS
->CloseProtocol (
1070 &gEfiUsbHcProtocolGuid
,
1071 This
->DriverBindingHandle
,
1075 gBS
->CloseProtocol (
1077 &gEfiDevicePathProtocolGuid
,
1078 This
->DriverBindingHandle
,
1083 DEBUG ((EFI_D_ERROR
, "UsbBusStart: Failed to start bus driver %r\n", Status
));
1089 The USB bus driver entry pointer.
1091 @param ImageHandle The driver image handle.
1092 @param SystemTable The system table.
1094 @return EFI_SUCCESS The component name protocol is installed.
1095 @return Others Failed to init the usb driver.
1100 UsbBusDriverEntryPoint (
1101 IN EFI_HANDLE ImageHandle
,
1102 IN EFI_SYSTEM_TABLE
*SystemTable
1105 return EfiLibInstallDriverBindingComponentName2 (
1108 &mUsbBusDriverBinding
,
1110 &mUsbBusComponentName
,
1111 &mUsbBusComponentName2
1117 Check whether USB bus driver support this device.
1119 @param This The USB bus driver binding protocol.
1120 @param Controller The controller handle to check.
1121 @param RemainingDevicePath The remaining device path.
1123 @retval EFI_SUCCESS The bus supports this controller.
1124 @retval EFI_UNSUPPORTED This device isn't supported.
1129 UsbBusControllerDriverSupported (
1130 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1131 IN EFI_HANDLE Controller
,
1132 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
1135 EFI_DEV_PATH_PTR DevicePathNode
;
1136 EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
;
1137 EFI_USB2_HC_PROTOCOL
*Usb2Hc
;
1138 EFI_USB_HC_PROTOCOL
*UsbHc
;
1142 // Check whether device path is valid
1144 if (RemainingDevicePath
!= NULL
) {
1146 // Check if RemainingDevicePath is the End of Device Path Node,
1147 // if yes, go on checking other conditions
1149 if (!IsDevicePathEnd (RemainingDevicePath
)) {
1151 // If RemainingDevicePath isn't the End of Device Path Node,
1152 // check its validation
1154 DevicePathNode
.DevPath
= RemainingDevicePath
;
1156 if ((DevicePathNode
.DevPath
->Type
!= MESSAGING_DEVICE_PATH
) ||
1157 (DevicePathNode
.DevPath
->SubType
!= MSG_USB_DP
&&
1158 DevicePathNode
.DevPath
->SubType
!= MSG_USB_CLASS_DP
1159 && DevicePathNode
.DevPath
->SubType
!= MSG_USB_WWID_DP
1162 return EFI_UNSUPPORTED
;
1168 // Check whether USB_HC2 protocol is installed
1170 Status
= gBS
->OpenProtocol (
1172 &gEfiUsb2HcProtocolGuid
,
1174 This
->DriverBindingHandle
,
1176 EFI_OPEN_PROTOCOL_BY_DRIVER
1178 if (Status
== EFI_ALREADY_STARTED
) {
1182 if (EFI_ERROR (Status
)) {
1184 // If failed to open USB_HC2, fall back to USB_HC
1186 Status
= gBS
->OpenProtocol (
1188 &gEfiUsbHcProtocolGuid
,
1190 This
->DriverBindingHandle
,
1192 EFI_OPEN_PROTOCOL_BY_DRIVER
1194 if (Status
== EFI_ALREADY_STARTED
) {
1198 if (EFI_ERROR (Status
)) {
1203 // Close the USB_HC used to perform the supported test
1205 gBS
->CloseProtocol (
1207 &gEfiUsbHcProtocolGuid
,
1208 This
->DriverBindingHandle
,
1215 // Close the USB_HC2 used to perform the supported test
1217 gBS
->CloseProtocol (
1219 &gEfiUsb2HcProtocolGuid
,
1220 This
->DriverBindingHandle
,
1226 // Open the EFI Device Path protocol needed to perform the supported test
1228 Status
= gBS
->OpenProtocol (
1230 &gEfiDevicePathProtocolGuid
,
1231 (VOID
**) &ParentDevicePath
,
1232 This
->DriverBindingHandle
,
1234 EFI_OPEN_PROTOCOL_BY_DRIVER
1236 if (Status
== EFI_ALREADY_STARTED
) {
1240 if (!EFI_ERROR (Status
)) {
1242 // Close protocol, don't use device path protocol in the Support() function
1244 gBS
->CloseProtocol (
1246 &gEfiDevicePathProtocolGuid
,
1247 This
->DriverBindingHandle
,
1259 Start to process the controller.
1261 @param This The USB bus driver binding instance.
1262 @param Controller The controller to check.
1263 @param RemainingDevicePath The remaining device patch.
1265 @retval EFI_SUCCESS The controller is controlled by the usb bus.
1266 @retval EFI_ALREADY_STARTED The controller is already controlled by the usb
1268 @retval EFI_OUT_OF_RESOURCES Failed to allocate resources.
1273 UsbBusControllerDriverStart (
1274 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1275 IN EFI_HANDLE Controller
,
1276 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
1279 EFI_USB_BUS_PROTOCOL
*UsbBusId
;
1281 EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
;
1283 Status
= gBS
->OpenProtocol (
1285 &gEfiDevicePathProtocolGuid
,
1286 (VOID
**) &ParentDevicePath
,
1287 This
->DriverBindingHandle
,
1289 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1291 ASSERT_EFI_ERROR (Status
);
1294 // Report Status Code here since we will initialize the host controller
1296 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
1298 (EFI_IO_BUS_USB
| EFI_IOB_PC_INIT
),
1303 // Locate the USB bus protocol, if it is found, USB bus
1304 // is already started on this controller.
1306 Status
= gBS
->OpenProtocol (
1309 (VOID
**) &UsbBusId
,
1310 This
->DriverBindingHandle
,
1312 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1315 if (EFI_ERROR (Status
)) {
1317 // If first start, build the bus execute environment and install bus protocol
1319 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, (EFI_IO_BUS_USB
| EFI_P_PC_ENABLE
));
1320 Status
= UsbBusBuildProtocol (This
, Controller
, RemainingDevicePath
);
1321 if (EFI_ERROR (Status
)) {
1325 // Try get the Usb Bus protocol interface again
1327 Status
= gBS
->OpenProtocol (
1330 (VOID
**) &UsbBusId
,
1331 This
->DriverBindingHandle
,
1333 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1335 ASSERT (!EFI_ERROR (Status
));
1338 // USB Bus driver need to control the recursive connect policy of the bus, only those wanted
1339 // usb child device will be recursively connected.
1340 // The RemainingDevicePath indicate the child usb device which user want to fully recursively connecte this time.
1341 // All wanted usb child devices will be remembered by the usb bus driver itself.
1342 // If RemainingDevicePath == NULL, all the usb child devices in the usb bus are wanted devices.
1344 // Save the passed in RemainingDevicePath this time
1346 if (RemainingDevicePath
!= NULL
) {
1347 if (IsDevicePathEnd (RemainingDevicePath
)) {
1349 // If RemainingDevicePath is the End of Device Path Node,
1350 // skip enumerate any device and return EFI_SUCESSS
1356 Status
= UsbBusAddWantedUsbIoDP (UsbBusId
, RemainingDevicePath
);
1357 ASSERT (!EFI_ERROR (Status
));
1359 // Ensure all wanted child usb devices are fully recursively connected
1361 Status
= UsbBusRecursivelyConnectWantedUsbIo (UsbBusId
);
1362 ASSERT (!EFI_ERROR (Status
));
1371 Stop handle the controller by this USB bus driver.
1373 @param This The USB bus driver binding protocol.
1374 @param Controller The controller to release.
1375 @param NumberOfChildren The child of USB bus that opened controller
1377 @param ChildHandleBuffer The array of child handle.
1379 @retval EFI_SUCCESS The controller or children are stopped.
1380 @retval EFI_DEVICE_ERROR Failed to stop the driver.
1385 UsbBusControllerDriverStop (
1386 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1387 IN EFI_HANDLE Controller
,
1388 IN UINTN NumberOfChildren
,
1389 IN EFI_HANDLE
*ChildHandleBuffer
1393 USB_DEVICE
*RootHub
;
1395 USB_INTERFACE
*RootIf
;
1396 USB_INTERFACE
*UsbIf
;
1397 EFI_USB_BUS_PROTOCOL
*BusId
;
1398 EFI_USB_IO_PROTOCOL
*UsbIo
;
1402 EFI_STATUS ReturnStatus
;
1404 Status
= EFI_SUCCESS
;
1406 if (NumberOfChildren
> 0) {
1408 // BugBug: Raise TPL to callback level instead of USB_BUS_TPL to avoid TPL conflict
1410 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1412 ReturnStatus
= EFI_SUCCESS
;
1413 for (Index
= 0; Index
< NumberOfChildren
; Index
++) {
1414 Status
= gBS
->OpenProtocol (
1415 ChildHandleBuffer
[Index
],
1416 &gEfiUsbIoProtocolGuid
,
1418 This
->DriverBindingHandle
,
1420 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1423 if (EFI_ERROR (Status
)) {
1425 // It is possible that the child has already been released:
1426 // 1. For combo device, free one device will release others.
1427 // 2. If a hub is released, all devices on its down facing
1428 // ports are released also.
1433 UsbIf
= USB_INTERFACE_FROM_USBIO (UsbIo
);
1434 UsbDev
= UsbIf
->Device
;
1436 ReturnStatus
= UsbRemoveDevice (UsbDev
);
1439 gBS
->RestoreTPL (OldTpl
);
1440 return ReturnStatus
;
1443 DEBUG (( EFI_D_INFO
, "UsbBusStop: usb bus stopped on %p\n", Controller
));
1446 // Locate USB_BUS for the current host controller
1448 Status
= gBS
->OpenProtocol (
1452 This
->DriverBindingHandle
,
1454 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1457 if (EFI_ERROR (Status
)) {
1461 Bus
= USB_BUS_FROM_THIS (BusId
);
1464 // Stop the root hub, then free all the devices
1466 // BugBug: Raise TPL to callback level instead of USB_BUS_TPL to avoid TPL conflict
1468 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1470 RootHub
= Bus
->Devices
[0];
1471 RootIf
= RootHub
->Interfaces
[0];
1473 ASSERT (Bus
->MaxDevices
<= 256);
1474 ReturnStatus
= EFI_SUCCESS
;
1475 for (Index
= 1; Index
< Bus
->MaxDevices
; Index
++) {
1476 if (Bus
->Devices
[Index
] != NULL
) {
1477 Status
= UsbRemoveDevice (Bus
->Devices
[Index
]);
1478 if (EFI_ERROR (Status
)) {
1479 ReturnStatus
= Status
;
1484 gBS
->RestoreTPL (OldTpl
);
1486 if (!EFI_ERROR (ReturnStatus
)) {
1487 mUsbRootHubApi
.Release (RootIf
);
1488 gBS
->FreePool (RootIf
);
1489 gBS
->FreePool (RootHub
);
1491 Status
= UsbBusFreeUsbDPList (&Bus
->WantedUsbIoDPList
);
1492 ASSERT (!EFI_ERROR (Status
));
1495 // Uninstall the bus identifier and close USB_HC/USB2_HC protocols
1497 gBS
->UninstallProtocolInterface (Controller
, &gEfiCallerIdGuid
, &Bus
->BusId
);
1499 if (Bus
->Usb2Hc
!= NULL
) {
1500 Status
= gBS
->CloseProtocol (
1502 &gEfiUsb2HcProtocolGuid
,
1503 This
->DriverBindingHandle
,
1508 if (Bus
->UsbHc
!= NULL
) {
1509 Status
= gBS
->CloseProtocol (
1511 &gEfiUsbHcProtocolGuid
,
1512 This
->DriverBindingHandle
,
1517 if (!EFI_ERROR (Status
)) {
1518 gBS
->CloseProtocol (
1520 &gEfiDevicePathProtocolGuid
,
1521 This
->DriverBindingHandle
,
1525 gBS
->FreePool (Bus
);