#include "UsbBus.h"

Functions
EFI_STATUS	UsbHcGetCapability (IN USB_BUS UsbBus, OUT UINT8 MaxSpeed, OUT UINT8 NumOfPort, OUT UINT8 Is64BitCapable)

EFI_STATUS	UsbHcGetRootHubPortStatus (IN USB_BUS UsbBus, IN UINT8 PortIndex, OUT EFI_USB_PORT_STATUS PortStatus)

EFI_STATUS	UsbHcSetRootHubPortFeature (IN USB_BUS *UsbBus, IN UINT8 PortIndex, IN EFI_USB_PORT_FEATURE Feature)

EFI_STATUS	UsbHcClearRootHubPortFeature (IN USB_BUS *UsbBus, IN UINT8 PortIndex, IN EFI_USB_PORT_FEATURE Feature)

EFI_STATUS	UsbHcControlTransfer (IN USB_BUS UsbBus, IN UINT8 DevAddr, IN UINT8 DevSpeed, IN UINTN MaxPacket, IN EFI_USB_DEVICE_REQUEST Request, IN EFI_USB_DATA_DIRECTION Direction, IN OUT VOID Data, IN OUT UINTN DataLength, IN UINTN TimeOut, IN EFI_USB2_HC_TRANSACTION_TRANSLATOR Translator, OUT UINT32 UsbResult)

EFI_STATUS	UsbHcBulkTransfer (IN USB_BUS UsbBus, IN UINT8 DevAddr, IN UINT8 EpAddr, IN UINT8 DevSpeed, IN UINTN MaxPacket, IN UINT8 BufferNum, IN OUT VOID Data[], IN OUT UINTN DataLength, IN OUT UINT8 DataToggle, IN UINTN TimeOut, IN EFI_USB2_HC_TRANSACTION_TRANSLATOR Translator, OUT UINT32 UsbResult)

EFI_STATUS	UsbHcAsyncInterruptTransfer (IN USB_BUS UsbBus, IN UINT8 DevAddr, IN UINT8 EpAddr, IN UINT8 DevSpeed, IN UINTN MaxPacket, IN BOOLEAN IsNewTransfer, IN OUT UINT8 DataToggle, IN UINTN PollingInterval, IN UINTN DataLength, IN EFI_USB2_HC_TRANSACTION_TRANSLATOR Translator, IN EFI_ASYNC_USB_TRANSFER_CALLBACK Callback, IN VOID Context OPTIONAL)

EFI_STATUS	UsbHcSyncInterruptTransfer (IN USB_BUS UsbBus, IN UINT8 DevAddr, IN UINT8 EpAddr, IN UINT8 DevSpeed, IN UINTN MaxPacket, IN OUT VOID Data, IN OUT UINTN DataLength, IN OUT UINT8 DataToggle, IN UINTN TimeOut, IN EFI_USB2_HC_TRANSACTION_TRANSLATOR Translator, OUT UINT32 UsbResult)

EFI_STATUS	UsbOpenHostProtoByChild (IN USB_BUS *Bus, IN EFI_HANDLE Child)

VOID	UsbCloseHostProtoByChild (IN USB_BUS *Bus, IN EFI_HANDLE Child)

EFI_TPL	UsbGetCurrentTpl (VOID)

EFI_DEVICE_PATH_PROTOCOL *EFIAPI	GetUsbDPFromFullDP (IN EFI_DEVICE_PATH_PROTOCOL *DevicePath)

BOOLEAN EFIAPI	SearchUsbDPInList (IN EFI_DEVICE_PATH_PROTOCOL UsbDP, IN LIST_ENTRY UsbIoDPList)

EFI_STATUS EFIAPI	AddUsbDPToList (IN EFI_DEVICE_PATH_PROTOCOL UsbDP, IN LIST_ENTRY UsbIoDPList)

BOOLEAN EFIAPI	MatchUsbClass (IN USB_CLASS_DEVICE_PATH UsbClassDevicePathPtr, IN USB_INTERFACE UsbIf)

BOOLEAN	MatchUsbWwid (IN USB_WWID_DEVICE_PATH UsbWWIDDevicePathPtr, IN USB_INTERFACE UsbIf)

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)

Variables
USB_CLASS_FORMAT_DEVICE_PATH	mAllUsbClassDevicePath

Detailed Description

Wrapper function for usb host controller interface.

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

Definition in file UsbUtility.c.

Function Documentation

◆ AddUsbDPToList()

EFI_STATUS EFIAPI AddUsbDPToList	(	IN EFI_DEVICE_PATH_PROTOCOL *	UsbDP,
		IN LIST_ENTRY *	UsbIoDPList
	)

Add a usb device path into the DEVICE_PATH_LIST_ITEM list.

Parameters

UsbDP	a usb device path of DEVICE_PATH_LIST_ITEM.
UsbIoDPList	a DEVICE_PATH_LIST_ITEM list.

Return values

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

Definition at line 688 of file UsbUtility.c.

◆ GetUsbDPFromFullDP()

EFI_DEVICE_PATH_PROTOCOL *EFIAPI GetUsbDPFromFullDP ( IN EFI_DEVICE_PATH_PROTOCOL * DevicePath )

Create a new device path which only contain the first Usb part of the DevicePath.

Parameters

DevicePath A full device path which contain the usb nodes.

Returns: A new device path which only contain the Usb part of the DevicePath.

Definition at line 564 of file UsbUtility.c.

◆ MatchUsbClass()

BOOLEAN EFIAPI MatchUsbClass	(	IN USB_CLASS_DEVICE_PATH *	UsbClassDevicePathPtr,
		IN USB_INTERFACE *	UsbIf
	)

Check whether usb device, whose interface is UsbIf, matches the usb class which indicated by UsbClassDevicePathPtr whose is a short form usb class device path.

Parameters

UsbClassDevicePathPtr	a short form usb class device path.
UsbIf	a usb device interface.

Return values

TRUE	the usb device match the usb class.
FALSE	the usb device does not match the usb class.

Definition at line 732 of file UsbUtility.c.

◆ MatchUsbWwid()

BOOLEAN MatchUsbWwid	(	IN USB_WWID_DEVICE_PATH *	UsbWWIDDevicePathPtr,
		IN USB_INTERFACE *	UsbIf
	)

Check whether usb device, whose interface is UsbIf, matches the usb WWID requirement which indicated by UsbWWIDDevicePathPtr whose is a short form usb WWID device path.

Parameters

UsbWWIDDevicePathPtr	a short form usb WWID device path.
UsbIf	a usb device interface.

Return values

TRUE	the usb device match the usb WWID requirement.
FALSE	the usb device does not match the usb WWID requirement.

Definition at line 810 of file UsbUtility.c.

◆ SearchUsbDPInList()

BOOLEAN EFIAPI SearchUsbDPInList	(	IN EFI_DEVICE_PATH_PROTOCOL *	UsbDP,
		IN LIST_ENTRY *	UsbIoDPList
	)

Check whether a usb device path is in a DEVICE_PATH_LIST_ITEM list.

Parameters

UsbDP	a usb device path of DEVICE_PATH_LIST_ITEM.
UsbIoDPList	a DEVICE_PATH_LIST_ITEM list.

Return values

TRUE	there is a DEVICE_PATH_LIST_ITEM in UsbIoDPList which contains the passed in UsbDP.
FALSE	there is no DEVICE_PATH_LIST_ITEM in UsbIoDPList which contains the passed in UsbDP.

Definition at line 636 of file UsbUtility.c.

◆ 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.

◆ 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.

◆ UsbCloseHostProtoByChild()

VOID UsbCloseHostProtoByChild	(	IN USB_BUS *	Bus,
		IN EFI_HANDLE	Child
	)

Close the USB host controller protocol BY_CHILD.

Parameters

Bus	The USB bus driver.
Child	The child handle.

Definition at line 511 of file UsbUtility.c.

◆ UsbGetCurrentTpl()

EFI_TPL UsbGetCurrentTpl ( VOID )

return the current TPL, copied from the EDKII glue lib.

Parameters

VOID.

Returns: Current TPL.

Definition at line 542 of file UsbUtility.c.

◆ UsbHcAsyncInterruptTransfer()

EFI_STATUS UsbHcAsyncInterruptTransfer	(	IN USB_BUS *	UsbBus,
		IN UINT8	DevAddr,
		IN UINT8	EpAddr,
		IN UINT8	DevSpeed,
		IN UINTN	MaxPacket,
		IN BOOLEAN	IsNewTransfer,
		IN OUT UINT8 *	DataToggle,
		IN UINTN	PollingInterval,
		IN UINTN	DataLength,
		IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *	Translator,
		IN EFI_ASYNC_USB_TRANSFER_CALLBACK	Callback,
		IN VOID *Context	OPTIONAL
	)

Queue or cancel an asynchronous interrupt transfer.

Parameters

UsbBus	The USB bus driver.
DevAddr	The target device address.
EpAddr	The target endpoint address, with direction encoded in bit 7.
DevSpeed	The device's speed.
MaxPacket	The endpoint's max packet size.
IsNewTransfer	Whether this is a new request. If not, cancel the old request.
DataToggle	Data toggle to use on input, next toggle on output.
PollingInterval	The interval to poll the interrupt transfer (in ms).
DataLength	The length of periodical data receive.
Translator	The transaction translator for low/full speed device.
Callback	Function to call when data is received.
Context	The context to the callback.

Return values

EFI_SUCCESS	The asynchronous transfer is queued.
Others	Failed to queue the transfer.

Definition at line 335 of file UsbUtility.c.

◆ UsbHcBulkTransfer()

EFI_STATUS UsbHcBulkTransfer	(	IN USB_BUS *	UsbBus,
		IN UINT8	DevAddr,
		IN UINT8	EpAddr,
		IN UINT8	DevSpeed,
		IN UINTN	MaxPacket,
		IN UINT8	BufferNum,
		IN OUT VOID *	Data[],
		IN OUT UINTN *	DataLength,
		IN OUT UINT8 *	DataToggle,
		IN UINTN	TimeOut,
		IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *	Translator,
		OUT UINT32 *	UsbResult
	)

Execute a bulk transfer to the device's endpoint.

Parameters

UsbBus	The USB bus driver.
DevAddr	The target device address.
EpAddr	The target endpoint address, with direction encoded in bit 7.
DevSpeed	The device's speed.
MaxPacket	The endpoint's max packet size.
BufferNum	The number of data buffer.
Data	Array of pointers to data buffer.
DataLength	The length of data buffer.
DataToggle	On input, the initial data toggle to use, also return the next toggle on output.
TimeOut	The time to wait until timeout.
Translator	The transaction translator for low/full speed device.
UsbResult	The result of USB execution.

Return values

EFI_SUCCESS	The bulk transfer is finished without error.
Others	Failed to execute bulk transfer, result in UsbResult.

Definition at line 263 of file UsbUtility.c.

◆ UsbHcClearRootHubPortFeature()

EFI_STATUS UsbHcClearRootHubPortFeature	(	IN USB_BUS *	UsbBus,
		IN UINT8	PortIndex,
		IN EFI_USB_PORT_FEATURE	Feature
	)

Clear the root hub port feature.

Parameters

UsbBus	The USB bus driver.
PortIndex	The port index.
Feature	The port feature to clear.

Return values

EFI_SUCCESS	The port feature is clear.
Others	Failed to clear port feature.

Definition at line 153 of file UsbUtility.c.

◆ UsbHcControlTransfer()

EFI_STATUS UsbHcControlTransfer	(	IN USB_BUS *	UsbBus,
		IN UINT8	DevAddr,
		IN UINT8	DevSpeed,
		IN UINTN	MaxPacket,
		IN EFI_USB_DEVICE_REQUEST *	Request,
		IN EFI_USB_DATA_DIRECTION	Direction,
		IN OUT VOID *	Data,
		IN OUT UINTN *	DataLength,
		IN UINTN	TimeOut,
		IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *	Translator,
		OUT UINT32 *	UsbResult
	)

Execute a control transfer to the device.

Parameters

UsbBus	The USB bus driver.
DevAddr	The device address.
DevSpeed	The device speed.
MaxPacket	Maximum packet size of endpoint 0.
Request	The control transfer request.
Direction	The direction of data stage.
Data	The buffer holding data.
DataLength	The length of the data.
TimeOut	Timeout (in ms) to wait until timeout.
Translator	The transaction translator for low/full speed device.
UsbResult	The result of transfer.

Return values

EFI_SUCCESS	The control transfer finished without error.
Others	The control transfer failed, reason returned in UsbReslt.

Definition at line 190 of file UsbUtility.c.

◆ UsbHcGetCapability()

EFI_STATUS UsbHcGetCapability	(	IN USB_BUS *	UsbBus,
		OUT UINT8 *	MaxSpeed,
		OUT UINT8 *	NumOfPort,
		OUT UINT8 *	Is64BitCapable
	)

Get the capability of the host controller.

Parameters

UsbBus	The usb driver.
MaxSpeed	The maximum speed this host controller supports.
NumOfPort	The number of the root hub port.
Is64BitCapable	Whether this controller support 64 bit addressing.

Return values

EFI_SUCCESS	The host controller capability is returned.
Others	Failed to retrieve the host controller capability.

Definition at line 57 of file UsbUtility.c.

◆ UsbHcGetRootHubPortStatus()

EFI_STATUS UsbHcGetRootHubPortStatus	(	IN USB_BUS *	UsbBus,
		IN UINT8	PortIndex,
		OUT EFI_USB_PORT_STATUS *	PortStatus
	)

Get the root hub port state.

Parameters

UsbBus	The USB bus driver.
PortIndex	The index of port.
PortStatus	The variable to save port state.

Return values

EFI_SUCCESS	The root port state is returned in.
Others	Failed to get the root hub port state.

Definition at line 95 of file UsbUtility.c.

◆ UsbHcSetRootHubPortFeature()

EFI_STATUS UsbHcSetRootHubPortFeature	(	IN USB_BUS *	UsbBus,
		IN UINT8	PortIndex,
		IN EFI_USB_PORT_FEATURE	Feature
	)

Set the root hub port feature.

Parameters

UsbBus	The USB bus driver.
PortIndex	The port index.
Feature	The port feature to set.

Return values

EFI_SUCCESS	The port feature is set.
Others	Failed to set port feature.

Definition at line 124 of file UsbUtility.c.

◆ UsbHcSyncInterruptTransfer()

EFI_STATUS UsbHcSyncInterruptTransfer	(	IN USB_BUS *	UsbBus,
		IN UINT8	DevAddr,
		IN UINT8	EpAddr,
		IN UINT8	DevSpeed,
		IN UINTN	MaxPacket,
		IN OUT VOID *	Data,
		IN OUT UINTN *	DataLength,
		IN OUT UINT8 *	DataToggle,
		IN UINTN	TimeOut,
		IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *	Translator,
		OUT UINT32 *	UsbResult
	)

Execute a synchronous interrupt transfer to the target endpoint.

Parameters

UsbBus	The USB bus driver.
DevAddr	The target device address.
EpAddr	The target endpoint address, with direction encoded in bit 7.
DevSpeed	The device's speed.
MaxPacket	The endpoint's max packet size.
Data	Pointer to data buffer.
DataLength	The length of data buffer.
DataToggle	On input, the initial data toggle to use, also return the next toggle on output.
TimeOut	The time to wait until timeout.
Translator	The transaction translator for low/full speed device.
UsbResult	The result of USB execution.

Return values

EFI_SUCCESS	The synchronous interrupt transfer is OK.
Others	Failed to execute the synchronous interrupt transfer.

Definition at line 411 of file UsbUtility.c.

◆ UsbOpenHostProtoByChild()

EFI_STATUS UsbOpenHostProtoByChild	(	IN USB_BUS *	Bus,
		IN EFI_HANDLE	Child
	)

Open the USB host controller protocol BY_CHILD.

Parameters

Bus	The USB bus driver.
Child	The child handle.

Returns: The open protocol return.

Definition at line 471 of file UsbUtility.c.

Variable Documentation

◆ mAllUsbClassDevicePath

USB_CLASS_FORMAT_DEVICE_PATH mAllUsbClassDevicePath

Initial value:

= {
  {
    {
      MESSAGING_DEVICE_PATH,
      MSG_USB_CLASS_DP,
      {
        (UINT8)(sizeof (USB_CLASS_DEVICE_PATH)),
        (UINT8)((sizeof (USB_CLASS_DEVICE_PATH)) >> 8)
      }
    },
    0xffff, 
    0xffff, 
    0xff,   
    0xff,   
    0xff    
  },
 
  {
    END_DEVICE_PATH_TYPE,
    END_ENTIRE_DEVICE_PATH_SUBTYPE,
    {
      END_DEVICE_PATH_LENGTH,
      0
    }
  }
}

Definition at line 17 of file UsbUtility.c.

Functions

Variables

Detailed Description

Function Documentation

◆ AddUsbDPToList()

◆ GetUsbDPFromFullDP()

◆ MatchUsbClass()

◆ MatchUsbWwid()

◆ SearchUsbDPInList()

◆ UsbBusAddWantedUsbIoDP()

◆ UsbBusFreeUsbDPList()

◆ UsbBusIsWantedUsbIO()

◆ UsbBusRecursivelyConnectWantedUsbIo()

◆ UsbCloseHostProtoByChild()

◆ UsbGetCurrentTpl()

◆ UsbHcAsyncInterruptTransfer()

◆ UsbHcBulkTransfer()

◆ UsbHcClearRootHubPortFeature()

◆ UsbHcControlTransfer()

◆ UsbHcGetCapability()

◆ UsbHcGetRootHubPortStatus()

◆ UsbHcSetRootHubPortFeature()

◆ UsbHcSyncInterruptTransfer()

◆ UsbOpenHostProtoByChild()

Variable Documentation

◆ mAllUsbClassDevicePath