3 Copyright (c) 2004 - 2007, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 Usb Bus Driver Binding and Bus IO Protocol
28 // USB_BUS_PROTOCOL is only used to locate USB_BUS
30 EFI_GUID mUsbBusProtocolGuid
= EFI_USB_BUS_PROTOCOL_GUID
;
34 USB_IO function to execute a control transfer. This
35 function will execute the USB transfer. If transfer
36 successes, it will sync the internal state of USB bus
39 @param This The USB_IO instance
40 @param Request The control transfer request
41 @param Direction Direction for data stage
42 @param Timeout The time to wait before timeout
43 @param Data The buffer holding the data
44 @param DataLength Then length of the data
45 @param UsbStatus USB result
47 @retval EFI_INVALID_PARAMETER The parameters are invalid
48 @retval EFI_SUCCESS The control transfer succeded.
49 @retval Others Failed to execute the transfer
55 UsbIoControlTransfer (
56 IN EFI_USB_IO_PROTOCOL
*This
,
57 IN EFI_USB_DEVICE_REQUEST
*Request
,
58 IN EFI_USB_DATA_DIRECTION Direction
,
60 IN OUT VOID
*Data
, OPTIONAL
61 IN UINTN DataLength
, OPTIONAL
67 USB_ENDPOINT_DESC
*EpDesc
;
71 if (UsbStatus
== NULL
) {
72 return EFI_INVALID_PARAMETER
;
75 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
77 UsbIf
= USB_INTERFACE_FROM_USBIO (This
);
80 Status
= UsbHcControlTransfer (
94 if (EFI_ERROR (Status
) || (*UsbStatus
!= EFI_USB_NOERROR
)) {
96 // Clear TT buffer when CTRL/BULK split transaction failes
97 // Clear the TRANSLATOR TT buffer, not parent's buffer
99 if (Dev
->Translator
.TranslatorHubAddress
!= 0) {
100 UsbHubCtrlClearTTBuffer (
101 Dev
->Bus
->Devices
[Dev
->Translator
.TranslatorHubAddress
],
102 Dev
->Translator
.TranslatorPortNumber
,
113 // Some control transfer will change the device's internal
114 // status, such as Set_Configuration and Set_Interface.
115 // We must synchronize the bus driver's status with that in
116 // device. We ignore the Set_Descriptor request because it's
117 // hardly used by any device, especially in pre-boot environment
121 // Reset the endpoint toggle when endpoint stall is cleared
123 if ((Request
->Request
== USB_REQ_CLEAR_FEATURE
) &&
124 (Request
->RequestType
== USB_REQUEST_TYPE (EfiUsbNoData
, USB_REQ_TYPE_STANDARD
,
125 USB_TARGET_ENDPOINT
)) &&
126 (Request
->Value
== USB_FEATURE_ENDPOINT_HALT
)) {
128 EpDesc
= UsbGetEndpointDesc (UsbIf
, (UINT8
) Request
->Index
);
130 if (EpDesc
!= NULL
) {
136 // Select a new configuration. This is a dangerous action. Upper driver
137 // should stop use its current UsbIo after calling this driver. The old
138 // UsbIo will be uninstalled and new UsbIo be installed. We can't use
139 // ReinstallProtocol since interfaces in different configuration may be
140 // completely irrellvant.
142 if ((Request
->Request
== USB_REQ_SET_CONFIG
) &&
143 (Request
->RequestType
== USB_REQUEST_TYPE (EfiUsbNoData
, USB_REQ_TYPE_STANDARD
,
144 USB_TARGET_DEVICE
))) {
146 // Don't re-create the USB interfaces if configuration isn't changed.
148 if ((Dev
->ActiveConfig
!= NULL
) &&
149 (Request
->Value
== Dev
->ActiveConfig
->Desc
.ConfigurationValue
)) {
153 DEBUG ((EFI_D_INFO
, "UsbIoControlTransfer: configure changed!!! Do NOT use old UsbIo!!!\n"));
155 if (Dev
->ActiveConfig
!= NULL
) {
156 UsbRemoveConfig (Dev
);
159 if (Request
->Value
!= 0) {
160 Status
= UsbSelectConfig (Dev
, (UINT8
) Request
->Value
);
164 // Exit now, Old USB_IO is invalid now
170 // A new alternative setting is selected for the interface.
171 // No need to reinstall UsbIo in this case because only
172 // underlying communication endpoints are changed. Functionality
173 // should remains the same.
175 if ((Request
->Request
== USB_REQ_SET_INTERFACE
) &&
176 (Request
->RequestType
== USB_REQUEST_TYPE (EfiUsbNoData
, USB_REQ_TYPE_STANDARD
,
177 USB_TARGET_INTERFACE
)) &&
178 (Request
->Index
== UsbIf
->IfSetting
->Desc
.InterfaceNumber
)) {
180 Status
= UsbSelectSetting (UsbIf
->IfDesc
, (UINT8
) Request
->Value
);
182 if (!EFI_ERROR (Status
)) {
183 UsbIf
->IfSetting
= UsbIf
->IfDesc
->Settings
[UsbIf
->IfDesc
->ActiveIndex
];
188 gBS
->RestoreTPL (OldTpl
);
194 Execute a bulk transfer to the device endpoint
196 @param This The USB IO instance
197 @param Endpoint The device endpoint
198 @param Data The data to transfer
199 @param DataLength The length of the data to transfer
200 @param Timeout Time to wait before timeout
201 @param UsbStatus The result of USB transfer
203 @retval EFI_SUCCESS The bulk transfer is OK
204 @retval EFI_INVALID_PARAMETER Some parameters are invalid
205 @retval Others Failed to execute transfer, reason returned in
213 IN EFI_USB_IO_PROTOCOL
*This
,
216 IN OUT UINTN
*DataLength
,
218 OUT UINT32
*UsbStatus
222 USB_INTERFACE
*UsbIf
;
223 USB_ENDPOINT_DESC
*EpDesc
;
229 if ((USB_ENDPOINT_ADDR (Endpoint
) == 0) || (USB_ENDPOINT_ADDR(Endpoint
) > 15) ||
230 (UsbStatus
== NULL
)) {
232 return EFI_INVALID_PARAMETER
;
235 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
237 UsbIf
= USB_INTERFACE_FROM_USBIO (This
);
240 EpDesc
= UsbGetEndpointDesc (UsbIf
, Endpoint
);
242 if ((EpDesc
== NULL
) || (USB_ENDPOINT_TYPE (&EpDesc
->Desc
) != USB_ENDPOINT_BULK
)) {
243 Status
= EFI_INVALID_PARAMETER
;
248 Toggle
= EpDesc
->Toggle
;
249 Status
= UsbHcBulkTransfer (
254 EpDesc
->Desc
.MaxPacketSize
,
264 EpDesc
->Toggle
= Toggle
;
266 if (EFI_ERROR (Status
) || (*UsbStatus
!= EFI_USB_NOERROR
)) {
268 // Clear TT buffer when CTRL/BULK split transaction failes.
269 // Clear the TRANSLATOR TT buffer, not parent's buffer
271 if (Dev
->Translator
.TranslatorHubAddress
!= 0) {
272 UsbHubCtrlClearTTBuffer (
273 Dev
->Bus
->Devices
[Dev
->Translator
.TranslatorHubAddress
],
274 Dev
->Translator
.TranslatorPortNumber
,
283 gBS
->RestoreTPL (OldTpl
);
289 Execute a synchronous interrupt transfer
291 @param This The USB IO instance
292 @param Endpoint The device endpoint
293 @param Data The data to transfer
294 @param DataLength The length of the data to transfer
295 @param Timeout Time to wait before timeout
296 @param UsbStatus The result of USB transfer
298 @retval EFI_SUCCESS The synchronous interrupt transfer is OK
299 @retval EFI_INVALID_PARAMETER Some parameters are invalid
300 @retval Others Failed to execute transfer, reason returned in
307 UsbIoSyncInterruptTransfer (
308 IN EFI_USB_IO_PROTOCOL
*This
,
311 IN OUT UINTN
*DataLength
,
313 OUT UINT32
*UsbStatus
317 USB_INTERFACE
*UsbIf
;
318 USB_ENDPOINT_DESC
*EpDesc
;
323 if ((USB_ENDPOINT_ADDR (Endpoint
) == 0) || (USB_ENDPOINT_ADDR(Endpoint
) > 15) ||
324 (UsbStatus
== NULL
)) {
326 return EFI_INVALID_PARAMETER
;
329 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
331 UsbIf
= USB_INTERFACE_FROM_USBIO (This
);
334 EpDesc
= UsbGetEndpointDesc (UsbIf
, Endpoint
);
336 if ((EpDesc
== NULL
) || (USB_ENDPOINT_TYPE (&EpDesc
->Desc
) != USB_ENDPOINT_INTERRUPT
)) {
337 Status
= EFI_INVALID_PARAMETER
;
341 Toggle
= EpDesc
->Toggle
;
342 Status
= UsbHcSyncInterruptTransfer (
347 EpDesc
->Desc
.MaxPacketSize
,
356 EpDesc
->Toggle
= Toggle
;
359 gBS
->RestoreTPL (OldTpl
);
365 Queue a new asynchronous interrupt transfer, or remove the old
366 request if (IsNewTransfer == FALSE)
368 @param This The USB_IO instance
369 @param Endpoint The device endpoint
370 @param IsNewTransfer Whether this is a new request, if it's old, remove
372 @param PollInterval The interval to poll the transfer result, (in ms)
373 @param DataLength The length of perodic data transfer
374 @param Callback The function to call periodicaly when transfer is
376 @param Context The context to the callback
378 @retval EFI_SUCCESS New transfer is queued or old request is removed
379 @retval EFI_INVALID_PARAMETER Some parameters are invalid
380 @retval Others Failed to queue the new request or remove the old
387 UsbIoAsyncInterruptTransfer (
388 IN EFI_USB_IO_PROTOCOL
*This
,
390 IN BOOLEAN IsNewTransfer
,
391 IN UINTN PollInterval
, OPTIONAL
392 IN UINTN DataLength
, OPTIONAL
393 IN EFI_ASYNC_USB_TRANSFER_CALLBACK Callback
, OPTIONAL
394 IN VOID
*Context OPTIONAL
398 USB_INTERFACE
*UsbIf
;
399 USB_ENDPOINT_DESC
*EpDesc
;
404 if ((USB_ENDPOINT_ADDR (Endpoint
) == 0) || (USB_ENDPOINT_ADDR (Endpoint
) > 15)) {
405 return EFI_INVALID_PARAMETER
;
408 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
409 UsbIf
= USB_INTERFACE_FROM_USBIO (This
);
412 EpDesc
= UsbGetEndpointDesc (UsbIf
, Endpoint
);
414 if ((EpDesc
== NULL
) || (USB_ENDPOINT_TYPE (&EpDesc
->Desc
) != USB_ENDPOINT_INTERRUPT
)) {
415 Status
= EFI_INVALID_PARAMETER
;
419 Toggle
= EpDesc
->Toggle
;
420 Status
= UsbHcAsyncInterruptTransfer (
425 EpDesc
->Desc
.MaxPacketSize
,
435 EpDesc
->Toggle
= Toggle
;
438 gBS
->RestoreTPL (OldTpl
);
444 Execute a synchronous isochronous transfer
446 @param This The USB IO instance
447 @param DeviceEndpoint The device endpoint
448 @param Data The data to transfer
449 @param DataLength The length of the data to transfer
450 @param UsbStatus The result of USB transfer
452 @retval EFI_UNSUPPORTED Currently isochronous transfer isn't supported
458 UsbIoIsochronousTransfer (
459 IN EFI_USB_IO_PROTOCOL
*This
,
460 IN UINT8 DeviceEndpoint
,
466 return EFI_UNSUPPORTED
;
471 Queue an asynchronous isochronous transfer
473 @param This The USB_IO instance
474 @param DeviceEndpoint The device endpoint
475 @param DataLength The length of perodic data transfer
476 @param IsochronousCallBack The function to call periodicaly when transfer is
478 @param Context The context to the callback
480 @retval EFI_UNSUPPORTED Currently isochronous transfer isn't supported
486 UsbIoAsyncIsochronousTransfer (
487 IN EFI_USB_IO_PROTOCOL
*This
,
488 IN UINT8 DeviceEndpoint
,
491 IN EFI_ASYNC_USB_TRANSFER_CALLBACK IsochronousCallBack
,
492 IN VOID
*Context OPTIONAL
495 return EFI_UNSUPPORTED
;
500 Retrieve the device descriptor of the device
502 @param This The USB IO instance
503 @param Descriptor The variable to receive the device descriptor
505 @retval EFI_SUCCESS The device descriptor is returned
506 @retval EFI_INVALID_PARAMETER The parameter is invalid
512 UsbIoGetDeviceDescriptor (
513 IN EFI_USB_IO_PROTOCOL
*This
,
514 OUT EFI_USB_DEVICE_DESCRIPTOR
*Descriptor
518 USB_INTERFACE
*UsbIf
;
521 if (Descriptor
== NULL
) {
522 return EFI_INVALID_PARAMETER
;
525 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
527 UsbIf
= USB_INTERFACE_FROM_USBIO (This
);
530 CopyMem (Descriptor
, &Dev
->DevDesc
->Desc
, sizeof (EFI_USB_DEVICE_DESCRIPTOR
));
532 gBS
->RestoreTPL (OldTpl
);
538 Return the configuration descriptor of the current active configuration
540 @param This The USB IO instance
541 @param Descriptor The USB configuration descriptor
543 @retval EFI_SUCCESS The active configuration descriptor is returned
544 @retval EFI_INVALID_PARAMETER Some parameter is invalid
545 @retval EFI_NOT_FOUND Currently no active configuration is selected.
551 UsbIoGetActiveConfigDescriptor (
552 IN EFI_USB_IO_PROTOCOL
*This
,
553 OUT EFI_USB_CONFIG_DESCRIPTOR
*Descriptor
557 USB_INTERFACE
*UsbIf
;
561 if (Descriptor
== NULL
) {
562 return EFI_INVALID_PARAMETER
;
565 Status
= EFI_SUCCESS
;
566 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
568 UsbIf
= USB_INTERFACE_FROM_USBIO (This
);
571 if (Dev
->ActiveConfig
== NULL
) {
572 Status
= EFI_NOT_FOUND
;
576 CopyMem (Descriptor
, &(Dev
->ActiveConfig
->Desc
), sizeof (EFI_USB_CONFIG_DESCRIPTOR
));
579 gBS
->RestoreTPL (OldTpl
);
585 Retrieve the active interface setting descriptor for this USB IO instance
587 @param This The USB IO instance
588 @param Descriptor The variable to receive active interface setting
590 @retval EFI_SUCCESS The active interface setting is returned
591 @retval EFI_INVALID_PARAMETER Some parameter is invalid
597 UsbIoGetInterfaceDescriptor (
598 IN EFI_USB_IO_PROTOCOL
*This
,
599 OUT EFI_USB_INTERFACE_DESCRIPTOR
*Descriptor
602 USB_INTERFACE
*UsbIf
;
605 if (Descriptor
== NULL
) {
606 return EFI_INVALID_PARAMETER
;
609 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
611 UsbIf
= USB_INTERFACE_FROM_USBIO (This
);
612 CopyMem (Descriptor
, &(UsbIf
->IfSetting
->Desc
), sizeof (EFI_USB_INTERFACE_DESCRIPTOR
));
614 gBS
->RestoreTPL (OldTpl
);
620 Retrieve the endpoint descriptor from this interface setting
622 @param This The USB IO instance
623 @param Index The index (start from zero) of the endpoint to
625 @param Descriptor The variable to receive the descriptor
627 @retval EFI_SUCCESS The endpoint descriptor is returned
628 @retval EFI_INVALID_PARAMETER Some parameter is invalid
634 UsbIoGetEndpointDescriptor (
635 IN EFI_USB_IO_PROTOCOL
*This
,
637 OUT EFI_USB_ENDPOINT_DESCRIPTOR
*Descriptor
640 USB_INTERFACE
*UsbIf
;
643 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
645 UsbIf
= USB_INTERFACE_FROM_USBIO (This
);
647 if ((Descriptor
== NULL
) || (Index
> 15)) {
648 gBS
->RestoreTPL (OldTpl
);
649 return EFI_INVALID_PARAMETER
;
652 if (Index
>= UsbIf
->IfSetting
->Desc
.NumEndpoints
) {
653 gBS
->RestoreTPL (OldTpl
);
654 return EFI_NOT_FOUND
;
659 &(UsbIf
->IfSetting
->Endpoints
[Index
]->Desc
),
660 sizeof (EFI_USB_ENDPOINT_DESCRIPTOR
)
663 gBS
->RestoreTPL (OldTpl
);
669 Retrieve the supported language ID table from the device
671 @param This The USB IO instance
672 @param LangIDTable The table to return the language IDs
673 @param TableSize The number of supported languanges
675 @retval EFI_SUCCESS The language ID is return
681 UsbIoGetSupportedLanguages (
682 IN EFI_USB_IO_PROTOCOL
*This
,
683 OUT UINT16
**LangIDTable
,
684 OUT UINT16
*TableSize
688 USB_INTERFACE
*UsbIf
;
691 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
693 UsbIf
= USB_INTERFACE_FROM_USBIO (This
);
696 *LangIDTable
= Dev
->LangId
;
697 *TableSize
= Dev
->TotalLangId
;
699 gBS
->RestoreTPL (OldTpl
);
705 Retrieve an indexed string in the language of LangID
707 @param This The USB IO instance
708 @param LangID The language ID of the string to retrieve
709 @param StringIndex The index of the string
710 @param String The variable to receive the string
712 @retval EFI_SUCCESS The string is returned
713 @retval EFI_NOT_FOUND No such string existed
719 UsbIoGetStringDescriptor (
720 IN EFI_USB_IO_PROTOCOL
*This
,
722 IN UINT8 StringIndex
,
727 USB_INTERFACE
*UsbIf
;
728 EFI_USB_STRING_DESCRIPTOR
*StrDesc
;
734 if ((StringIndex
== 0) || (LangID
== 0)) {
735 return EFI_NOT_FOUND
;
738 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
740 UsbIf
= USB_INTERFACE_FROM_USBIO (This
);
744 // Check whether language ID is supported
746 Status
= EFI_NOT_FOUND
;
748 for (Index
= 0; Index
< Dev
->TotalLangId
; Index
++) {
749 if (Dev
->LangId
[Index
] == LangID
) {
754 if (Index
== Dev
->TotalLangId
) {
759 // Retrieve the string descriptor then allocate a buffer
760 // to hold the string itself.
762 StrDesc
= UsbGetOneString (Dev
, StringIndex
, LangID
);
764 if (StrDesc
== NULL
) {
768 if (StrDesc
->Length
<= 2) {
772 Buf
= AllocateZeroPool (StrDesc
->Length
);
775 Status
= EFI_OUT_OF_RESOURCES
;
779 CopyMem (Buf
, StrDesc
->String
, StrDesc
->Length
- 2);
780 *String
= (CHAR16
*) Buf
;
781 Status
= EFI_SUCCESS
;
784 gBS
->FreePool (StrDesc
);
787 gBS
->RestoreTPL (OldTpl
);
793 Reset the device, then if that succeeds, reconfigure the
794 device with its address and current active configuration.
796 @param This The USB IO instance
798 @retval EFI_SUCCESS The device is reset and configured
799 @retval Others Failed to reset the device
805 IN EFI_USB_IO_PROTOCOL
*This
808 USB_INTERFACE
*UsbIf
;
809 USB_INTERFACE
*HubIf
;
815 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
817 UsbIf
= USB_INTERFACE_FROM_USBIO (This
);
820 if (UsbIf
->IsHub
== TRUE
) {
821 Status
= EFI_INVALID_PARAMETER
;
825 HubIf
= Dev
->ParentIf
;
826 Status
= HubIf
->HubApi
->ResetPort (HubIf
, Dev
->ParentPort
);
828 if (EFI_ERROR (Status
)) {
829 DEBUG (( EFI_D_ERROR
, "UsbIoPortReset: failed to reset hub port %d@hub %d, %r \n",
830 Dev
->ParentPort
, Dev
->ParentAddr
, Status
));
836 // Reset the device to its current address. The device now has a
837 // address of ZERO, so need to set Dev->Address to zero first for
838 // host to communicate with the device
840 Address
= Dev
->Address
;
842 Status
= UsbSetAddress (Dev
, Address
);
844 if (EFI_ERROR (Status
)) {
845 DEBUG (( EFI_D_ERROR
, "UsbIoPortReset: failed to set address for device %d - %r\n",
851 Dev
->Address
= Address
;
854 // Reset the current active configure, after this device
855 // is in CONFIGURED state.
857 if (Dev
->ActiveConfig
!= NULL
) {
858 Status
= UsbSetConfig (Dev
, Dev
->ActiveConfig
->Desc
.ConfigurationValue
);
860 if (EFI_ERROR (Status
)) {
861 DEBUG (( EFI_D_ERROR
, "UsbIoPortReset: failed to set configure for device %d - %r\n",
867 gBS
->RestoreTPL (OldTpl
);
871 EFI_USB_IO_PROTOCOL mUsbIoProtocol
= {
872 UsbIoControlTransfer
,
874 UsbIoAsyncInterruptTransfer
,
875 UsbIoSyncInterruptTransfer
,
876 UsbIoIsochronousTransfer
,
877 UsbIoAsyncIsochronousTransfer
,
878 UsbIoGetDeviceDescriptor
,
879 UsbIoGetActiveConfigDescriptor
,
880 UsbIoGetInterfaceDescriptor
,
881 UsbIoGetEndpointDescriptor
,
882 UsbIoGetStringDescriptor
,
883 UsbIoGetSupportedLanguages
,
890 UsbBusDriverEntryPoint (
891 IN EFI_HANDLE ImageHandle
,
892 IN EFI_SYSTEM_TABLE
*SystemTable
898 The USB bus driver entry pointer
902 ImageHandle - The driver image handle
903 SystemTable - The system table
907 EFI_SUCCESS - The component name protocol is installed
908 Others - Failed to init the usb driver
912 return EfiLibInstallAllDriverProtocols (
915 &mUsbBusDriverBinding
,
917 &mUsbBusComponentName
,
925 Check whether USB bus driver support this device
927 @param This The USB bus driver binding protocol
928 @param Controller The controller handle to test againist
929 @param RemainingDevicePath The remaining device path
931 @retval EFI_SUCCESS The bus supports this controller.
932 @retval EFI_UNSUPPORTED This device isn't supported
937 UsbBusControllerDriverSupported (
938 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
939 IN EFI_HANDLE Controller
,
940 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
943 EFI_DEV_PATH_PTR DevicePathNode
;
944 EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
;
945 EFI_USB2_HC_PROTOCOL
*Usb2Hc
;
946 EFI_USB_HC_PROTOCOL
*UsbHc
;
950 // Check whether device path is valid
952 if (RemainingDevicePath
!= NULL
) {
953 DevicePathNode
.DevPath
= RemainingDevicePath
;
955 if ((DevicePathNode
.DevPath
->Type
!= MESSAGING_DEVICE_PATH
) ||
956 (DevicePathNode
.DevPath
->SubType
!= MSG_USB_DP
) ||
957 (DevicePathNodeLength (DevicePathNode
.DevPath
) != sizeof (USB_DEVICE_PATH
))) {
959 return EFI_UNSUPPORTED
;
963 Status
= gBS
->OpenProtocol (
965 &gEfiDevicePathProtocolGuid
,
966 (VOID
**) &ParentDevicePath
,
967 This
->DriverBindingHandle
,
969 EFI_OPEN_PROTOCOL_BY_DRIVER
972 if (Status
== EFI_ALREADY_STARTED
) {
976 if (EFI_ERROR (Status
)) {
982 &gEfiDevicePathProtocolGuid
,
983 This
->DriverBindingHandle
,
988 // Check whether USB_HC2 protocol is installed
990 Status
= gBS
->OpenProtocol (
992 &gEfiUsb2HcProtocolGuid
,
994 This
->DriverBindingHandle
,
996 EFI_OPEN_PROTOCOL_BY_DRIVER
999 if (Status
== EFI_ALREADY_STARTED
) {
1003 if (!EFI_ERROR (Status
)) {
1004 gBS
->CloseProtocol (
1006 &gEfiUsb2HcProtocolGuid
,
1007 This
->DriverBindingHandle
,
1015 // If failed to open USB_HC2, fall back to USB_HC
1017 Status
= gBS
->OpenProtocol (
1019 &gEfiUsbHcProtocolGuid
,
1021 This
->DriverBindingHandle
,
1023 EFI_OPEN_PROTOCOL_BY_DRIVER
1026 if (Status
== EFI_ALREADY_STARTED
) {
1030 if (!EFI_ERROR (Status
)) {
1031 gBS
->CloseProtocol (
1033 &gEfiUsbHcProtocolGuid
,
1034 This
->DriverBindingHandle
,
1044 Start to process the controller
1046 @param This The USB bus driver binding instance
1047 @param Controller The controller to check
1048 @param RemainingDevicePath The remaining device patch
1050 @retval EFI_SUCCESS The controller is controlled by the usb bus
1051 @retval EFI_ALREADY_STARTED The controller is already controlled by the usb
1053 @retval EFI_OUT_OF_RESOURCES Failed to allocate resources
1058 UsbBusControllerDriverStart (
1059 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1060 IN EFI_HANDLE Controller
,
1061 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
1065 USB_DEVICE
*RootHub
;
1066 USB_INTERFACE
*RootIf
;
1067 EFI_USB_BUS_PROTOCOL
*UsbBusId
;
1072 // Locate the USB bus protocol, if it is found, USB bus
1073 // is already started on this controller.
1075 Status
= gBS
->OpenProtocol (
1077 &mUsbBusProtocolGuid
,
1078 (VOID
**) &UsbBusId
,
1079 This
->DriverBindingHandle
,
1081 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1084 if (!EFI_ERROR (Status
)) {
1085 return EFI_ALREADY_STARTED
;
1088 UsbBus
= AllocateZeroPool (sizeof (USB_BUS
));
1090 if (UsbBus
== NULL
) {
1091 return EFI_OUT_OF_RESOURCES
;
1094 UsbBus
->Signature
= USB_BUS_SIGNATURE
;
1095 UsbBus
->HostHandle
= Controller
;
1097 Status
= gBS
->OpenProtocol (
1099 &gEfiDevicePathProtocolGuid
,
1100 (VOID
**) &UsbBus
->DevicePath
,
1101 This
->DriverBindingHandle
,
1103 EFI_OPEN_PROTOCOL_BY_DRIVER
1106 if (EFI_ERROR (Status
)) {
1107 DEBUG (( EFI_D_ERROR
, "UsbBusStart: Failed to open device path %r\n", Status
));
1109 gBS
->FreePool (UsbBus
);
1114 // Get USB_HC2/USB_HC host controller protocol (EHCI/UHCI).
1115 // This is for backward compatbility with EFI 1.x. In UEFI
1116 // 2.x, USB_HC2 replaces USB_HC. We will open both USB_HC2
1117 // and USB_HC because EHCI driver will install both protocols
1118 // (for the same reason). If we don't consume both of them,
1119 // the unconsumed one may be opened by others.
1121 Status
= gBS
->OpenProtocol (
1123 &gEfiUsb2HcProtocolGuid
,
1124 (VOID
**) &(UsbBus
->Usb2Hc
),
1125 This
->DriverBindingHandle
,
1127 EFI_OPEN_PROTOCOL_BY_DRIVER
1130 Status2
= gBS
->OpenProtocol (
1132 &gEfiUsbHcProtocolGuid
,
1133 (VOID
**) &(UsbBus
->UsbHc
),
1134 This
->DriverBindingHandle
,
1136 EFI_OPEN_PROTOCOL_BY_DRIVER
1139 if (EFI_ERROR (Status
) && EFI_ERROR (Status2
)) {
1140 DEBUG (( EFI_D_ERROR
, "UsbBusStart: Failed to open USB_HC/USB2_HC %r\n", Status
));
1142 Status
= EFI_DEVICE_ERROR
;
1147 // Create a fake usb device for root hub
1149 RootHub
= AllocateZeroPool (sizeof (USB_DEVICE
));
1151 if (RootHub
== NULL
) {
1152 Status
= EFI_OUT_OF_RESOURCES
;
1156 RootIf
= AllocateZeroPool (sizeof (USB_INTERFACE
));
1158 if (RootIf
== NULL
) {
1159 gBS
->FreePool (RootHub
);
1160 Status
= EFI_OUT_OF_RESOURCES
;
1164 RootHub
->Bus
= UsbBus
;
1165 RootHub
->NumOfInterface
= 1;
1166 RootHub
->Interfaces
[0] = RootIf
;
1167 RootIf
->Signature
= USB_INTERFACE_SIGNATURE
;
1168 RootIf
->Device
= RootHub
;
1169 RootIf
->DevicePath
= UsbBus
->DevicePath
;
1172 UsbHcReset (UsbBus
, EFI_USB_HC_RESET_GLOBAL
);
1173 UsbHcSetState (UsbBus
, EfiUsbHcStateOperational
);
1175 Status
= mUsbRootHubApi
.Init (RootIf
);
1177 if (EFI_ERROR (Status
)) {
1178 DEBUG (( EFI_D_ERROR
, "UsbBusStart: Failed to init root hub %r\n", Status
));
1182 UsbBus
->Devices
[0] = RootHub
;
1185 // Install an EFI_USB_BUS_PROTOCOL to host controler to identify it.
1187 Status
= gBS
->InstallProtocolInterface (
1189 &mUsbBusProtocolGuid
,
1190 EFI_NATIVE_INTERFACE
,
1194 if (EFI_ERROR (Status
)) {
1195 DEBUG (( EFI_D_ERROR
, "UsbBusStart: Failed to install bus protocol %r\n", Status
));
1197 mUsbRootHubApi
.Release (RootIf
);
1202 DEBUG (( EFI_D_INFO
, "UsbBusStart: usb bus started on %x, root hub %x\n", Controller
, RootIf
));
1206 gBS
->FreePool (RootIf
);
1207 gBS
->FreePool (RootHub
);
1210 if (UsbBus
->Usb2Hc
!= NULL
) {
1211 gBS
->CloseProtocol (
1213 &gEfiUsb2HcProtocolGuid
,
1214 This
->DriverBindingHandle
,
1219 if (UsbBus
->UsbHc
!= NULL
) {
1220 gBS
->CloseProtocol (
1222 &gEfiUsbHcProtocolGuid
,
1223 This
->DriverBindingHandle
,
1228 gBS
->CloseProtocol (
1230 &gEfiDevicePathProtocolGuid
,
1231 This
->DriverBindingHandle
,
1235 gBS
->FreePool (UsbBus
);
1237 DEBUG (( EFI_D_ERROR
, "UsbBusStart: Failed to start bus driver %r\n", Status
));
1243 Stop handle the controller by this USB bus driver
1245 @param This The USB bus driver binding protocol
1246 @param Controller The controller to release
1247 @param NumberOfChildren The child of USB bus that opened controller
1249 @param ChildHandleBuffer The array of child handle
1251 @retval EFI_SUCCESS The controller or children are stopped
1252 @retval EFI_DEVICE_ERROR Failed to stop the driver
1257 UsbBusControllerDriverStop (
1258 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1259 IN EFI_HANDLE Controller
,
1260 IN UINTN NumberOfChildren
,
1261 IN EFI_HANDLE
*ChildHandleBuffer
1265 USB_DEVICE
*RootHub
;
1267 USB_INTERFACE
*RootIf
;
1268 USB_INTERFACE
*UsbIf
;
1269 EFI_USB_BUS_PROTOCOL
*BusId
;
1270 EFI_USB_IO_PROTOCOL
*UsbIo
;
1275 Status
= EFI_SUCCESS
;
1277 if (NumberOfChildren
> 0) {
1278 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
1280 for (Index
= 0; Index
< NumberOfChildren
; Index
++) {
1281 Status
= gBS
->OpenProtocol (
1282 ChildHandleBuffer
[Index
],
1283 &gEfiUsbIoProtocolGuid
,
1285 This
->DriverBindingHandle
,
1287 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1290 if (EFI_ERROR (Status
)) {
1292 // It is possible that the child has already been released:
1293 // 1. For combo device, free one device will release others.
1294 // 2. If a hub is released, all devices on its down facing
1295 // ports are released also.
1300 UsbIf
= USB_INTERFACE_FROM_USBIO (UsbIo
);
1301 UsbDev
= UsbIf
->Device
;
1303 UsbRemoveDevice (UsbDev
);
1306 gBS
->RestoreTPL (OldTpl
);
1310 DEBUG (( EFI_D_INFO
, "UsbBusStop: usb bus stopped on %x\n", Controller
));
1313 // Locate USB_BUS for the current host controller
1315 Status
= gBS
->OpenProtocol (
1317 &mUsbBusProtocolGuid
,
1319 This
->DriverBindingHandle
,
1321 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1324 if (EFI_ERROR (Status
)) {
1328 Bus
= USB_BUS_FROM_THIS (BusId
);
1331 // Stop the root hub, then free all the devices
1333 OldTpl
= gBS
->RaiseTPL (USB_BUS_TPL
);
1334 UsbHcSetState (Bus
, EfiUsbHcStateHalt
);
1336 RootHub
= Bus
->Devices
[0];
1337 RootIf
= RootHub
->Interfaces
[0];
1339 mUsbRootHubApi
.Release (RootIf
);
1341 for (Index
= 1; Index
< USB_MAX_DEVICES
; Index
++) {
1342 if (Bus
->Devices
[Index
] != NULL
) {
1343 UsbRemoveDevice (Bus
->Devices
[Index
]);
1347 gBS
->RestoreTPL (OldTpl
);
1349 gBS
->FreePool (RootIf
);
1350 gBS
->FreePool (RootHub
);
1353 // Uninstall the bus identifier and close USB_HC/USB2_HC protocols
1355 gBS
->UninstallProtocolInterface (Controller
, &mUsbBusProtocolGuid
, &Bus
->BusId
);
1357 if (Bus
->Usb2Hc
!= NULL
) {
1358 gBS
->CloseProtocol (
1360 &gEfiUsb2HcProtocolGuid
,
1361 This
->DriverBindingHandle
,
1366 if (Bus
->UsbHc
!= NULL
) {
1367 gBS
->CloseProtocol (
1369 &gEfiUsbHcProtocolGuid
,
1370 This
->DriverBindingHandle
,
1375 gBS
->CloseProtocol (
1377 &gEfiDevicePathProtocolGuid
,
1378 This
->DriverBindingHandle
,
1382 gBS
->FreePool (Bus
);
1387 EFI_DRIVER_BINDING_PROTOCOL mUsbBusDriverBinding
= {
1388 UsbBusControllerDriverSupported
,
1389 UsbBusControllerDriverStart
,
1390 UsbBusControllerDriverStop
,