#include <Uefi.h>
#include <Protocol/Usb2HostController.h>
#include <Protocol/UsbHostController.h>
#include <Protocol/UsbIo.h>
#include <Protocol/DevicePath.h>
#include <Library/BaseLib.h>
#include <Library/DebugLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiLib.h>
#include <Library/DevicePathLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/ReportStatusCodeLib.h>
#include <IndustryStandard/Usb.h>
#include "UsbUtility.h"
#include "UsbDesc.h"
#include "UsbHub.h"
#include "UsbEnumer.h"

Data Structures
struct	_EFI_USB_BUS_PROTOCOL

struct	_USB_DEVICE

struct	_USB_INTERFACE

struct	_USB_BUS

struct	_USB_HUB_API

struct	_DEVICE_PATH_LIST_ITEM

struct	USB_CLASS_FORMAT_DEVICE_PATH

Macros
#define	USB_MAX_LANG_ID 16

#define	USB_MAX_INTERFACE 16

#define	USB_MAX_DEVICES 128

#define	USB_BUS_1_MILLISECOND 1000

#define	USB_ROOTHUB_POLL_INTERVAL (100 * 10000U)

#define	USB_HUB_POLL_INTERVAL 64

#define	USB_WAIT_PORT_STABLE_STALL (100 * USB_BUS_1_MILLISECOND)

#define	USB_WAIT_PORT_STS_CHANGE_STALL (100)

#define	USB_SET_DEVICE_ADDRESS_STALL (2 * USB_BUS_1_MILLISECOND)

#define	USB_RETRY_MAX_PACK_SIZE_STALL (100 * USB_BUS_1_MILLISECOND)

#define	USB_SET_PORT_POWER_STALL (2 * USB_BUS_1_MILLISECOND)

#define	USB_SET_PORT_RESET_STALL (20 * USB_BUS_1_MILLISECOND)

#define	USB_SET_ROOT_PORT_RESET_STALL (50 * USB_BUS_1_MILLISECOND)

#define	USB_SET_PORT_RECOVERY_STALL (10 * USB_BUS_1_MILLISECOND)

#define	USB_CLR_ROOT_PORT_RESET_STALL (20 * USB_BUS_1_MILLISECOND)

#define	USB_SET_ROOT_PORT_ENABLE_STALL (20 * USB_BUS_1_MILLISECOND)

#define	USB_GENERAL_DEVICE_REQUEST_TIMEOUT 500

#define	USB_CLEAR_FEATURE_REQUEST_TIMEOUT 10

#define	USB_BUS_TPL TPL_NOTIFY

#define	USB_INTERFACE_SIGNATURE SIGNATURE_32 ('U', 'S', 'B', 'I')

#define	USB_BUS_SIGNATURE SIGNATURE_32 ('U', 'S', 'B', 'B')

#define	USB_BIT(a) ((UINTN)(1 << (a)))

#define	USB_BIT_IS_SET(Data, Bit) ((BOOLEAN)(((Data) & (Bit)) == (Bit)))

#define	USB_INTERFACE_FROM_USBIO(a) CR(a, USB_INTERFACE, UsbIo, USB_INTERFACE_SIGNATURE)

#define	USB_BUS_FROM_THIS(a) CR(a, USB_BUS, BusId, USB_BUS_SIGNATURE)

#define	USB_US_LAND_ID 0x0409

#define	DEVICE_PATH_LIST_ITEM_SIGNATURE SIGNATURE_32('d','p','l','i')

Typedefs
typedef struct _USB_DEVICE	USB_DEVICE

typedef struct _USB_INTERFACE	USB_INTERFACE

typedef struct _USB_BUS	USB_BUS

typedef struct _USB_HUB_API	USB_HUB_API

typedef struct _EFI_USB_BUS_PROTOCOL	EFI_USB_BUS_PROTOCOL

typedef struct _DEVICE_PATH_LIST_ITEM	DEVICE_PATH_LIST_ITEM

Functions
EFI_STATUS EFIAPI	UsbBusFreeUsbDPList (IN LIST_ENTRY *UsbIoDPList)

EFI_STATUS EFIAPI	UsbBusAddWantedUsbIoDP (IN EFI_USB_BUS_PROTOCOL UsbBusId, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath)

BOOLEAN EFIAPI	UsbBusIsWantedUsbIO (IN USB_BUS Bus, IN USB_INTERFACE UsbIf)

EFI_STATUS EFIAPI	UsbBusRecursivelyConnectWantedUsbIo (IN EFI_USB_BUS_PROTOCOL *UsbBusId)

EFI_STATUS EFIAPI	UsbIoControlTransfer (IN EFI_USB_IO_PROTOCOL This, IN EFI_USB_DEVICE_REQUEST Request, IN EFI_USB_DATA_DIRECTION Direction, IN UINT32 Timeout, IN OUT VOID Data OPTIONAL, IN UINTN DataLength OPTIONAL, OUT UINT32 UsbStatus)

EFI_STATUS EFIAPI	UsbIoBulkTransfer (IN EFI_USB_IO_PROTOCOL This, IN UINT8 Endpoint, IN OUT VOID Data, IN OUT UINTN DataLength, IN UINTN Timeout, OUT UINT32 UsbStatus)

EFI_STATUS EFIAPI	UsbIoSyncInterruptTransfer (IN EFI_USB_IO_PROTOCOL This, IN UINT8 Endpoint, IN OUT VOID Data, IN OUT UINTN DataLength, IN UINTN Timeout, OUT UINT32 UsbStatus)

EFI_STATUS EFIAPI	UsbIoAsyncInterruptTransfer (IN EFI_USB_IO_PROTOCOL This, IN UINT8 Endpoint, IN BOOLEAN IsNewTransfer, IN UINTN PollInterval OPTIONAL, IN UINTN DataLength OPTIONAL, IN EFI_ASYNC_USB_TRANSFER_CALLBACK Callback OPTIONAL, IN VOID Context OPTIONAL)

EFI_STATUS EFIAPI	UsbIoIsochronousTransfer (IN EFI_USB_IO_PROTOCOL This, IN UINT8 DeviceEndpoint, IN OUT VOID Data, IN UINTN DataLength, OUT UINT32 *Status)

EFI_STATUS EFIAPI	UsbIoAsyncIsochronousTransfer (IN EFI_USB_IO_PROTOCOL This, IN UINT8 DeviceEndpoint, IN OUT VOID Data, IN UINTN DataLength, IN EFI_ASYNC_USB_TRANSFER_CALLBACK IsochronousCallBack, IN VOID *Context OPTIONAL)

EFI_STATUS EFIAPI	UsbIoGetDeviceDescriptor (IN EFI_USB_IO_PROTOCOL This, OUT EFI_USB_DEVICE_DESCRIPTOR Descriptor)

EFI_STATUS EFIAPI	UsbIoGetActiveConfigDescriptor (IN EFI_USB_IO_PROTOCOL This, OUT EFI_USB_CONFIG_DESCRIPTOR Descriptor)

EFI_STATUS EFIAPI	UsbIoGetInterfaceDescriptor (IN EFI_USB_IO_PROTOCOL This, OUT EFI_USB_INTERFACE_DESCRIPTOR Descriptor)

EFI_STATUS EFIAPI	UsbIoGetEndpointDescriptor (IN EFI_USB_IO_PROTOCOL This, IN UINT8 Index, OUT EFI_USB_ENDPOINT_DESCRIPTOR Descriptor)

EFI_STATUS EFIAPI	UsbIoGetSupportedLanguages (IN EFI_USB_IO_PROTOCOL This, OUT UINT16 LangIDTable, OUT UINT16 TableSize)

EFI_STATUS EFIAPI	UsbIoGetStringDescriptor (IN EFI_USB_IO_PROTOCOL This, IN UINT16 LangID, IN UINT8 StringIndex, OUT CHAR16 *String)

EFI_STATUS EFIAPI	UsbIoPortReset (IN EFI_USB_IO_PROTOCOL *This)

EFI_STATUS EFIAPI	UsbBusBuildProtocol (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath)

EFI_STATUS EFIAPI	UsbBusDriverEntryPoint (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

EFI_STATUS EFIAPI	UsbBusControllerDriverSupported (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath)

EFI_STATUS EFIAPI	UsbBusControllerDriverStart (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath)

EFI_STATUS EFIAPI	UsbBusControllerDriverStop (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE Controller, IN UINTN NumberOfChildren, IN EFI_HANDLE ChildHandleBuffer)

Variables
EFI_USB_IO_PROTOCOL	mUsbIoProtocol

EFI_DRIVER_BINDING_PROTOCOL	mUsbBusDriverBinding

EFI_COMPONENT_NAME_PROTOCOL	mUsbBusComponentName

EFI_COMPONENT_NAME2_PROTOCOL	mUsbBusComponentName2

Detailed Description

Usb Bus Driver Binding and Bus IO Protocol.

Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file UsbBus.h.

Macro Definition Documentation

◆ DEVICE_PATH_LIST_ITEM_SIGNATURE

#define DEVICE_PATH_LIST_ITEM_SIGNATURE SIGNATURE_32('d','p','l','i')

Definition at line 286 of file UsbBus.h.

◆ USB_BIT

#define USB_BIT ( a ) ((UINTN)(1 << (a)))

Definition at line 138 of file UsbBus.h.

◆ USB_BIT_IS_SET

#define USB_BIT_IS_SET	(	Data,
		Bit
	)	((BOOLEAN)(((Data) & (Bit)) == (Bit)))

Definition at line 139 of file UsbBus.h.

◆ USB_BUS_1_MILLISECOND

#define USB_BUS_1_MILLISECOND 1000

Definition at line 50 of file UsbBus.h.

◆ USB_BUS_FROM_THIS

#define USB_BUS_FROM_THIS ( a ) CR(a, USB_BUS, BusId, USB_BUS_SIGNATURE)

Definition at line 144 of file UsbBus.h.

◆ USB_BUS_SIGNATURE

#define USB_BUS_SIGNATURE SIGNATURE_32 ('U', 'S', 'B', 'B')

Definition at line 136 of file UsbBus.h.

◆ USB_BUS_TPL

#define USB_BUS_TPL TPL_NOTIFY

Definition at line 133 of file UsbBus.h.

◆ USB_CLEAR_FEATURE_REQUEST_TIMEOUT

#define USB_CLEAR_FEATURE_REQUEST_TIMEOUT 10

Definition at line 127 of file UsbBus.h.

◆ USB_CLR_ROOT_PORT_RESET_STALL

#define USB_CLR_ROOT_PORT_RESET_STALL (20 * USB_BUS_1_MILLISECOND)

Definition at line 108 of file UsbBus.h.

◆ USB_GENERAL_DEVICE_REQUEST_TIMEOUT

#define USB_GENERAL_DEVICE_REQUEST_TIMEOUT 500

Definition at line 122 of file UsbBus.h.

◆ USB_HUB_POLL_INTERVAL

#define USB_HUB_POLL_INTERVAL 64

Definition at line 58 of file UsbBus.h.

◆ USB_INTERFACE_FROM_USBIO

#define USB_INTERFACE_FROM_USBIO ( a ) CR(a, USB_INTERFACE, UsbIo, USB_INTERFACE_SIGNATURE)

Definition at line 141 of file UsbBus.h.

◆ USB_INTERFACE_SIGNATURE

#define USB_INTERFACE_SIGNATURE SIGNATURE_32 ('U', 'S', 'B', 'I')

Definition at line 135 of file UsbBus.h.

◆ USB_MAX_DEVICES

#define USB_MAX_DEVICES 128

Definition at line 48 of file UsbBus.h.

◆ USB_MAX_INTERFACE

#define USB_MAX_INTERFACE 16

Definition at line 47 of file UsbBus.h.

◆ USB_MAX_LANG_ID

#define USB_MAX_LANG_ID 16

Definition at line 46 of file UsbBus.h.

◆ USB_RETRY_MAX_PACK_SIZE_STALL

#define USB_RETRY_MAX_PACK_SIZE_STALL (100 * USB_BUS_1_MILLISECOND)

Definition at line 80 of file UsbBus.h.

◆ USB_ROOTHUB_POLL_INTERVAL

#define USB_ROOTHUB_POLL_INTERVAL (100 * 10000U)

Definition at line 57 of file UsbBus.h.

◆ USB_SET_DEVICE_ADDRESS_STALL

#define USB_SET_DEVICE_ADDRESS_STALL (2 * USB_BUS_1_MILLISECOND)

Definition at line 75 of file UsbBus.h.

◆ USB_SET_PORT_POWER_STALL

#define USB_SET_PORT_POWER_STALL (2 * USB_BUS_1_MILLISECOND)

Definition at line 86 of file UsbBus.h.

◆ USB_SET_PORT_RECOVERY_STALL

#define USB_SET_PORT_RECOVERY_STALL (10 * USB_BUS_1_MILLISECOND)

Definition at line 103 of file UsbBus.h.

◆ USB_SET_PORT_RESET_STALL

#define USB_SET_PORT_RESET_STALL (20 * USB_BUS_1_MILLISECOND)

Definition at line 96 of file UsbBus.h.

◆ USB_SET_ROOT_PORT_ENABLE_STALL

#define USB_SET_ROOT_PORT_ENABLE_STALL (20 * USB_BUS_1_MILLISECOND)

Definition at line 113 of file UsbBus.h.

◆ USB_SET_ROOT_PORT_RESET_STALL

#define USB_SET_ROOT_PORT_RESET_STALL (50 * USB_BUS_1_MILLISECOND)

Definition at line 97 of file UsbBus.h.

◆ USB_US_LAND_ID

#define USB_US_LAND_ID 0x0409

Definition at line 284 of file UsbBus.h.

◆ USB_WAIT_PORT_STABLE_STALL

#define USB_WAIT_PORT_STABLE_STALL (100 * USB_BUS_1_MILLISECOND)

Definition at line 64 of file UsbBus.h.

◆ USB_WAIT_PORT_STS_CHANGE_STALL

#define USB_WAIT_PORT_STS_CHANGE_STALL (100)

Definition at line 69 of file UsbBus.h.

Typedef Documentation

◆ USB_BUS

typedef struct _USB_BUS USB_BUS

Definition at line 34 of file UsbBus.h.

◆ USB_DEVICE

typedef struct _USB_DEVICE USB_DEVICE

Definition at line 32 of file UsbBus.h.

◆ USB_HUB_API

typedef struct _USB_HUB_API USB_HUB_API

Definition at line 35 of file UsbBus.h.

◆ USB_INTERFACE

typedef struct _USB_INTERFACE USB_INTERFACE

Definition at line 33 of file UsbBus.h.

Function Documentation

◆ UsbBusAddWantedUsbIoDP()

EFI_STATUS EFIAPI UsbBusAddWantedUsbIoDP	(	IN EFI_USB_BUS_PROTOCOL *	UsbBusId,
		IN EFI_DEVICE_PATH_PROTOCOL *	RemainingDevicePath
	)

Store a wanted usb child device info (its Usb part of device path) which is indicated by RemainingDevicePath in a Usb bus which is indicated by UsbBusId.

Parameters

UsbBusId	Point to EFI_USB_BUS_PROTOCOL interface.
RemainingDevicePath	The remaining device patch.

Return values

EFI_SUCCESS	Add operation is successful.
EFI_INVALID_PARAMETER	The parameters are invalid.

Definition at line 951 of file UsbUtility.c.

◆ UsbBusBuildProtocol()

EFI_STATUS EFIAPI UsbBusBuildProtocol	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN EFI_DEVICE_PATH_PROTOCOL *	RemainingDevicePath
	)

Install Usb Bus Protocol on host controller, and start the Usb bus.

Parameters

This	The USB bus driver binding instance.
Controller	The controller to check.
RemainingDevicePath	The remaining device patch.

Return values

EFI_SUCCESS	The controller is controlled by the usb bus.
EFI_ALREADY_STARTED	The controller is already controlled by the usb bus.
EFI_OUT_OF_RESOURCES	Failed to allocate resources.

Definition at line 941 of file UsbBus.c.

◆ UsbBusControllerDriverStart()

EFI_STATUS EFIAPI UsbBusControllerDriverStart	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN EFI_DEVICE_PATH_PROTOCOL *	RemainingDevicePath
	)

Start to process the controller.

Parameters

This	The USB bus driver binding instance.
Controller	The controller to check.
RemainingDevicePath	The remaining device patch.

Return values

EFI_SUCCESS	The controller is controlled by the usb bus.
EFI_ALREADY_STARTED	The controller is already controlled by the usb bus.
EFI_OUT_OF_RESOURCES	Failed to allocate resources.

Definition at line 1315 of file UsbBus.c.

◆ UsbBusControllerDriverStop()

EFI_STATUS EFIAPI UsbBusControllerDriverStop	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN UINTN	NumberOfChildren,
		IN EFI_HANDLE *	ChildHandleBuffer
	)

Stop handle the controller by this USB bus driver.

Parameters

This	The USB bus driver binding protocol.
Controller	The controller to release.
NumberOfChildren	The child of USB bus that opened controller BY_CHILD.
ChildHandleBuffer	The array of child handle.

Return values

EFI_SUCCESS	The controller or children are stopped.
EFI_DEVICE_ERROR	Failed to stop the driver.

Definition at line 1426 of file UsbBus.c.

◆ UsbBusControllerDriverSupported()

EFI_STATUS EFIAPI UsbBusControllerDriverSupported	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN EFI_DEVICE_PATH_PROTOCOL *	RemainingDevicePath
	)

Check whether USB bus driver support this device.

Parameters

This	The USB bus driver binding protocol.
Controller	The controller handle to check.
RemainingDevicePath	The remaining device path.

Return values

EFI_SUCCESS	The bus supports this controller.
EFI_UNSUPPORTED	This device isn't supported.

Definition at line 1174 of file UsbBus.c.

◆ UsbBusDriverEntryPoint()

EFI_STATUS EFIAPI UsbBusDriverEntryPoint	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

The USB bus driver entry pointer.

Parameters

ImageHandle	The driver image handle.
SystemTable	The system table.

Returns: EFI_SUCCESS The component name protocol is installed.; Others Failed to init the usb driver.

Definition at line 1146 of file UsbBus.c.

◆ UsbBusFreeUsbDPList()

EFI_STATUS EFIAPI UsbBusFreeUsbDPList ( IN LIST_ENTRY * UsbIoDPList )

Free a DEVICE_PATH_LIST_ITEM list.

Parameters

UsbIoDPList a DEVICE_PATH_LIST_ITEM list pointer.

Return values

EFI_INVALID_PARAMETER	If parameters are invalid, return this value.
EFI_SUCCESS	If free operation is successful, return this value.

Definition at line 902 of file UsbUtility.c.

◆ UsbBusIsWantedUsbIO()

BOOLEAN EFIAPI UsbBusIsWantedUsbIO	(	IN USB_BUS *	Bus,
		IN USB_INTERFACE *	UsbIf
	)

Check whether a usb child device is the wanted device in a bus.

Parameters

Bus	The Usb bus's private data pointer.
UsbIf	The usb child device interface.

Return values

True	If a usb child device is the wanted device in a bus.
False	If a usb child device is NOT the wanted device in a bus.

Definition at line 1022 of file UsbUtility.c.

◆ UsbBusRecursivelyConnectWantedUsbIo()

EFI_STATUS EFIAPI UsbBusRecursivelyConnectWantedUsbIo ( IN EFI_USB_BUS_PROTOCOL * UsbBusId )

Recursively connect every wanted usb child device to ensure they all fully connected. Check all the child Usb IO handles in this bus, recursively connecte if it is wanted usb child device.

Parameters

UsbBusId Point to EFI_USB_BUS_PROTOCOL interface.

Return values

EFI_SUCCESS	Connect is done successfully.
EFI_INVALID_PARAMETER	The parameter is invalid.

Definition at line 1134 of file UsbUtility.c.

◆ UsbIoAsyncInterruptTransfer()

EFI_STATUS EFIAPI UsbIoAsyncInterruptTransfer	(	IN EFI_USB_IO_PROTOCOL *	This,
		IN UINT8	Endpoint,
		IN BOOLEAN	IsNewTransfer,
		IN UINTN PollInterval	OPTIONAL,
		IN UINTN DataLength	OPTIONAL,
		IN EFI_ASYNC_USB_TRANSFER_CALLBACK Callback	OPTIONAL,
		IN VOID *Context	OPTIONAL
	)

Queue a new asynchronous interrupt transfer, or remove the old request if (IsNewTransfer == FALSE).

Parameters

This	The USB_IO instance.
Endpoint	The device endpoint.
IsNewTransfer	Whether this is a new request, if it's old, remove the request.
PollInterval	The interval to poll the transfer result, (in ms).
DataLength	The length of perodic data transfer.
Callback	The function to call periodically when transfer is ready.
Context	The context to the callback.

Return values

EFI_SUCCESS	New transfer is queued or old request is removed.
EFI_INVALID_PARAMETER	Some parameters are invalid.
Others	Failed to queue the new request or remove the old request.

Definition at line 413 of file UsbBus.c.

◆ UsbIoAsyncIsochronousTransfer()

EFI_STATUS EFIAPI UsbIoAsyncIsochronousTransfer	(	IN EFI_USB_IO_PROTOCOL *	This,
		IN UINT8	DeviceEndpoint,
		IN OUT VOID *	Data,
		IN UINTN	DataLength,
		IN EFI_ASYNC_USB_TRANSFER_CALLBACK	IsochronousCallBack,
		IN VOID *Context	OPTIONAL
	)

Queue an asynchronous isochronous transfer.

Parameters

This	The USB_IO instance.
DeviceEndpoint	The device endpoint.
Data	The data to transfer.
DataLength	The length of perodic data transfer.
IsochronousCallBack	The function to call periodically when transfer is ready.
Context	The context to the callback.

Return values

EFI_UNSUPPORTED Currently isochronous transfer isn't supported.

Definition at line 509 of file UsbBus.c.

◆ UsbIoBulkTransfer()

EFI_STATUS EFIAPI UsbIoBulkTransfer	(	IN EFI_USB_IO_PROTOCOL *	This,
		IN UINT8	Endpoint,
		IN OUT VOID *	Data,
		IN OUT UINTN *	DataLength,
		IN UINTN	Timeout,
		OUT UINT32 *	UsbStatus
	)

Execute a bulk transfer to the device endpoint.

Parameters

This	The USB IO instance.
Endpoint	The device endpoint.
Data	The data to transfer.
DataLength	The length of the data to transfer.
Timeout	Time to wait before timeout.
UsbStatus	The result of USB transfer.

Return values

EFI_SUCCESS	The bulk transfer is OK.
EFI_INVALID_PARAMETER	Some parameters are invalid.
Others	Failed to execute transfer, reason returned in UsbStatus.

Definition at line 241 of file UsbBus.c.

◆ UsbIoControlTransfer()

EFI_STATUS EFIAPI UsbIoControlTransfer	(	IN EFI_USB_IO_PROTOCOL *	This,
		IN EFI_USB_DEVICE_REQUEST *	Request,
		IN EFI_USB_DATA_DIRECTION	Direction,
		IN UINT32	Timeout,
		IN OUT VOID *Data	OPTIONAL,
		IN UINTN DataLength	OPTIONAL,
		OUT UINT32 *	UsbStatus
	)

USB_IO function to execute a control transfer. This function will execute the USB transfer. If transfer successes, it will sync the internal state of USB bus with device state.

Parameters

This	The USB_IO instance
Request	The control transfer request
Direction	Direction for data stage
Timeout	The time to wait before timeout
Data	The buffer holding the data
DataLength	Then length of the data
UsbStatus	USB result

Return values

EFI_INVALID_PARAMETER	The parameters are invalid
EFI_SUCCESS	The control transfer succeded.
Others	Failed to execute the transfer

USB_IO function to execute a control transfer. This function will execute the USB transfer. If transfer successes, it will sync the internal state of USB bus with device state.

Parameters

This	The USB_IO instance
Request	The control transfer request
Direction	Direction for data stage
Timeout	The time to wait before timeout
Data	The buffer holding the data
DataLength	Then length of the data
UsbStatus	USB result

Return values

EFI_INVALID_PARAMETER	The parameters are invalid
EFI_SUCCESS	The control transfer succeeded.
Others	Failed to execute the transfer

Definition at line 59 of file UsbBus.c.

◆ UsbIoGetActiveConfigDescriptor()

EFI_STATUS EFIAPI UsbIoGetActiveConfigDescriptor	(	IN EFI_USB_IO_PROTOCOL *	This,
		OUT EFI_USB_CONFIG_DESCRIPTOR *	Descriptor
	)

Return the configuration descriptor of the current active configuration.

Parameters

This	The USB IO instance.
Descriptor	The USB configuration descriptor.

Return values

EFI_SUCCESS	The active configuration descriptor is returned.
EFI_INVALID_PARAMETER	Some parameter is invalid.
EFI_NOT_FOUND	Currently no active configuration is selected.

Definition at line 570 of file UsbBus.c.

◆ UsbIoGetDeviceDescriptor()

EFI_STATUS EFIAPI UsbIoGetDeviceDescriptor	(	IN EFI_USB_IO_PROTOCOL *	This,
		OUT EFI_USB_DEVICE_DESCRIPTOR *	Descriptor
	)

Retrieve the device descriptor of the device.

Parameters

This	The USB IO instance.
Descriptor	The variable to receive the device descriptor.

Return values

EFI_SUCCESS	The device descriptor is returned.
EFI_INVALID_PARAMETER	The parameter is invalid.

Definition at line 533 of file UsbBus.c.

◆ UsbIoGetEndpointDescriptor()

EFI_STATUS EFIAPI UsbIoGetEndpointDescriptor	(	IN EFI_USB_IO_PROTOCOL *	This,
		IN UINT8	Index,
		OUT EFI_USB_ENDPOINT_DESCRIPTOR *	Descriptor
	)

Retrieve the endpoint descriptor from this interface setting.

Parameters

This	The USB IO instance.
Index	The index (start from zero) of the endpoint to retrieve.
Descriptor	The variable to receive the descriptor.

Return values

EFI_SUCCESS	The endpoint descriptor is returned.
EFI_INVALID_PARAMETER	Some parameter is invalid.

Definition at line 649 of file UsbBus.c.

◆ UsbIoGetInterfaceDescriptor()

EFI_STATUS EFIAPI UsbIoGetInterfaceDescriptor	(	IN EFI_USB_IO_PROTOCOL *	This,
		OUT EFI_USB_INTERFACE_DESCRIPTOR *	Descriptor
	)

Retrieve the active interface setting descriptor for this USB IO instance.

Parameters

This	The USB IO instance.
Descriptor	The variable to receive active interface setting.

Return values

EFI_SUCCESS	The active interface setting is returned.
EFI_INVALID_PARAMETER	Some parameter is invalid.

Definition at line 614 of file UsbBus.c.

◆ UsbIoGetStringDescriptor()

EFI_STATUS EFIAPI UsbIoGetStringDescriptor	(	IN EFI_USB_IO_PROTOCOL *	This,
		IN UINT16	LangID,
		IN UINT8	StringIndex,
		OUT CHAR16 **	String
	)

Retrieve an indexed string in the language of LangID.

Parameters

This	The USB IO instance.
LangID	The language ID of the string to retrieve.
StringIndex	The index of the string.
String	The variable to receive the string.

Return values

EFI_SUCCESS	The string is returned.
EFI_NOT_FOUND	No such string existed.

Definition at line 730 of file UsbBus.c.

◆ UsbIoGetSupportedLanguages()

EFI_STATUS EFIAPI UsbIoGetSupportedLanguages	(	IN EFI_USB_IO_PROTOCOL *	This,
		OUT UINT16 **	LangIDTable,
		OUT UINT16 *	TableSize
	)

Retrieve the supported language ID table from the device.

Parameters

This	The USB IO instance.
LangIDTable	The table to return the language IDs.
TableSize	The size, in bytes, of the table LangIDTable.

Return values

EFI_SUCCESS The language ID is return.

Definition at line 694 of file UsbBus.c.

◆ UsbIoIsochronousTransfer()

EFI_STATUS EFIAPI UsbIoIsochronousTransfer	(	IN EFI_USB_IO_PROTOCOL *	This,
		IN UINT8	DeviceEndpoint,
		IN OUT VOID *	Data,
		IN UINTN	DataLength,
		OUT UINT32 *	Status
	)

Execute a synchronous isochronous transfer.

Parameters

This	The USB IO instance.
DeviceEndpoint	The device endpoint.
Data	The data to transfer.
DataLength	The length of the data to transfer.
UsbStatus	The result of USB transfer.

Return values

EFI_UNSUPPORTED Currently isochronous transfer isn't supported.

Definition at line 482 of file UsbBus.c.

◆ UsbIoPortReset()

EFI_STATUS EFIAPI UsbIoPortReset ( IN EFI_USB_IO_PROTOCOL * This )

Reset the device, then if that succeeds, reconfigure the device with its address and current active configuration.

Parameters

This	The USB IO instance.

Return values

EFI_SUCCESS	The device is reset and configured.
Others	Failed to reset the device.

Definition at line 815 of file UsbBus.c.

◆ UsbIoSyncInterruptTransfer()

EFI_STATUS EFIAPI UsbIoSyncInterruptTransfer	(	IN EFI_USB_IO_PROTOCOL *	This,
		IN UINT8	Endpoint,
		IN OUT VOID *	Data,
		IN OUT UINTN *	DataLength,
		IN UINTN	Timeout,
		OUT UINT32 *	UsbStatus
	)

Execute a synchronous interrupt transfer.

Parameters

This	The USB IO instance.
Endpoint	The device endpoint.
Data	The data to transfer.
DataLength	The length of the data to transfer.
Timeout	Time to wait before timeout.
UsbStatus	The result of USB transfer.

Return values

EFI_SUCCESS	The synchronous interrupt transfer is OK.
EFI_INVALID_PARAMETER	Some parameters are invalid.
Others	Failed to execute transfer, reason returned in UsbStatus.

Definition at line 335 of file UsbBus.c.

Variable Documentation

◆ mUsbBusComponentName

EFI_COMPONENT_NAME_PROTOCOL mUsbBusComponentName

extern

Definition at line 142 of file ComponentName.c.

◆ mUsbBusComponentName2

EFI_COMPONENT_NAME2_PROTOCOL mUsbBusComponentName2

extern

Definition at line 151 of file ComponentName.c.

◆ mUsbBusDriverBinding

EFI_DRIVER_BINDING_PROTOCOL mUsbBusDriverBinding

extern

Definition at line 29 of file UsbBus.c.

◆ mUsbIoProtocol

EFI_USB_IO_PROTOCOL mUsbIoProtocol

extern

Definition at line 13 of file UsbBus.c.

Data Structures

Macros

Typedefs

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ DEVICE_PATH_LIST_ITEM_SIGNATURE

◆ USB_BIT

◆ USB_BIT_IS_SET

◆ USB_BUS_1_MILLISECOND

◆ USB_BUS_FROM_THIS

◆ USB_BUS_SIGNATURE

◆ USB_BUS_TPL

◆ USB_CLEAR_FEATURE_REQUEST_TIMEOUT

◆ USB_CLR_ROOT_PORT_RESET_STALL

◆ USB_GENERAL_DEVICE_REQUEST_TIMEOUT

◆ USB_HUB_POLL_INTERVAL

◆ USB_INTERFACE_FROM_USBIO

◆ USB_INTERFACE_SIGNATURE

◆ USB_MAX_DEVICES

◆ USB_MAX_INTERFACE

◆ USB_MAX_LANG_ID

◆ USB_RETRY_MAX_PACK_SIZE_STALL

◆ USB_ROOTHUB_POLL_INTERVAL

◆ USB_SET_DEVICE_ADDRESS_STALL

◆ USB_SET_PORT_POWER_STALL

◆ USB_SET_PORT_RECOVERY_STALL

◆ USB_SET_PORT_RESET_STALL

◆ USB_SET_ROOT_PORT_ENABLE_STALL

◆ USB_SET_ROOT_PORT_RESET_STALL

◆ USB_US_LAND_ID

◆ USB_WAIT_PORT_STABLE_STALL

◆ USB_WAIT_PORT_STS_CHANGE_STALL

Typedef Documentation

◆ USB_BUS

◆ USB_DEVICE

◆ USB_HUB_API

◆ USB_INTERFACE

Function Documentation

◆ UsbBusAddWantedUsbIoDP()

◆ UsbBusBuildProtocol()

◆ UsbBusControllerDriverStart()

◆ UsbBusControllerDriverStop()

◆ UsbBusControllerDriverSupported()

◆ UsbBusDriverEntryPoint()

◆ UsbBusFreeUsbDPList()

◆ UsbBusIsWantedUsbIO()

◆ UsbBusRecursivelyConnectWantedUsbIo()

◆ UsbIoAsyncInterruptTransfer()

◆ UsbIoAsyncIsochronousTransfer()

◆ UsbIoBulkTransfer()

◆ UsbIoControlTransfer()

◆ UsbIoGetActiveConfigDescriptor()

◆ UsbIoGetDeviceDescriptor()

◆ UsbIoGetEndpointDescriptor()

◆ UsbIoGetInterfaceDescriptor()

◆ UsbIoGetStringDescriptor()

◆ UsbIoGetSupportedLanguages()

◆ UsbIoIsochronousTransfer()

◆ UsbIoPortReset()

◆ UsbIoSyncInterruptTransfer()

Variable Documentation

◆ mUsbBusComponentName

◆ mUsbBusComponentName2

◆ mUsbBusDriverBinding

◆ mUsbIoProtocol