#include "UefiUsbLibInternal.h"

Functions
EFI_STATUS EFIAPI	UsbGetDescriptor (IN EFI_USB_IO_PROTOCOL UsbIo, IN UINT16 Value, IN UINT16 Index, IN UINT16 DescriptorLength, OUT VOID Descriptor, OUT UINT32 *Status)

EFI_STATUS EFIAPI	UsbSetDescriptor (IN EFI_USB_IO_PROTOCOL UsbIo, IN UINT16 Value, IN UINT16 Index, IN UINT16 DescriptorLength, IN VOID Descriptor, OUT UINT32 *Status)

EFI_STATUS EFIAPI	UsbGetInterface (IN EFI_USB_IO_PROTOCOL UsbIo, IN UINT16 Interface, OUT UINT16 AlternateSetting, OUT UINT32 *Status)

EFI_STATUS EFIAPI	UsbSetInterface (IN EFI_USB_IO_PROTOCOL UsbIo, IN UINT16 Interface, IN UINT16 AlternateSetting, OUT UINT32 Status)

EFI_STATUS EFIAPI	UsbGetConfiguration (IN EFI_USB_IO_PROTOCOL UsbIo, OUT UINT16 ConfigurationValue, OUT UINT32 *Status)

EFI_STATUS EFIAPI	UsbSetConfiguration (IN EFI_USB_IO_PROTOCOL UsbIo, IN UINT16 ConfigurationValue, OUT UINT32 Status)

EFI_STATUS EFIAPI	UsbSetFeature (IN EFI_USB_IO_PROTOCOL UsbIo, IN USB_TYPES_DEFINITION Recipient, IN UINT16 Value, IN UINT16 Target, OUT UINT32 Status)

EFI_STATUS EFIAPI	UsbClearFeature (IN EFI_USB_IO_PROTOCOL UsbIo, IN USB_TYPES_DEFINITION Recipient, IN UINT16 Value, IN UINT16 Target, OUT UINT32 Status)

EFI_STATUS EFIAPI	UsbGetStatus (IN EFI_USB_IO_PROTOCOL UsbIo, IN USB_TYPES_DEFINITION Recipient, IN UINT16 Target, OUT UINT16 DeviceStatus, OUT UINT32 *Status)

EFI_STATUS EFIAPI	UsbClearEndpointHalt (IN EFI_USB_IO_PROTOCOL UsbIo, IN UINT8 Endpoint, OUT UINT32 Status)

Detailed Description

The library provides the USB Standard Device Requests defined in Usb specification 9.4 section.

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

Definition in file UsbDxeLib.c.

Function Documentation

◆ UsbClearEndpointHalt()

EFI_STATUS EFIAPI UsbClearEndpointHalt	(	IN EFI_USB_IO_PROTOCOL *	UsbIo,
		IN UINT8	Endpoint,
		OUT UINT32 *	Status
	)

Clear halt feature of the specified usb endpoint.

Retrieve the USB endpoint descriptor specified by UsbIo and EndPoint. If the USB endpoint descriptor can not be retrieved, then return EFI_NOT_FOUND. If the endpoint descriptor is found, then clear the halt feature of this USB endpoint. The status of the transfer is returned in Status. If UsbIo is NULL, then ASSERT(). If Status is NULL, then ASSERT().

Parameters

UsbIo	A pointer to the USB I/O Protocol instance for the specific USB target.
Endpoint	The endpoint address.
Status	A pointer to the status of the transfer.

Return values

EFI_SUCCESS	The request executed successfully.
EFI_TIMEOUT	A timeout occurred executing the request.
EFI_DEVICE_ERROR	The request failed due to a device error. The transfer status is returned in Status.
EFI_NOT_FOUND	The specified USB endpoint descriptor can not be found

Definition at line 595 of file UsbDxeLib.c.

◆ UsbClearFeature()

EFI_STATUS EFIAPI UsbClearFeature	(	IN EFI_USB_IO_PROTOCOL *	UsbIo,
		IN USB_TYPES_DEFINITION	Recipient,
		IN UINT16	Value,
		IN UINT16	Target,
		OUT UINT32 *	Status
	)

Clear the specified feature of the specified device.

Submit a USB clear device feature request for the USB device specified by UsbIo, Recipient, and Target to the value specified by Value. The status of the transfer is returned in Status. If UsbIo is NULL, then ASSERT(). If Status is NULL, then ASSERT().

Parameters

UsbIo	A pointer to the USB I/O Protocol instance for the specific USB target.
Recipient	The USB data recipient type (i.e. Device, Interface, Endpoint). Type USB_TYPES_DEFINITION is defined in the MDE Package Industry Standard include file Usb.h.
Value	The value of the feature to be cleared.
Target	The index of the device to be cleared.
Status	A pointer to the status of the transfer.

Return values

EFI_SUCCESS	The request executed successfully.
EFI_TIMEOUT	A timeout occurred executing the request.
EFI_DEVICE_ERROR	The request failed due to a device error. The transfer status is returned in Status.

Definition at line 444 of file UsbDxeLib.c.

◆ UsbGetConfiguration()

EFI_STATUS EFIAPI UsbGetConfiguration	(	IN EFI_USB_IO_PROTOCOL *	UsbIo,
		OUT UINT16 *	ConfigurationValue,
		OUT UINT32 *	Status
	)

Get the device configuration.

Submit a USB get configuration request for the USB device specified by UsbIo and place the result in the buffer specified by ConfigurationValue. The status of the transfer is returned in Status. If UsbIo is NULL, then ASSERT(). If ConfigurationValue is NULL, then ASSERT(). If Status is NULL, then ASSERT().

Parameters

UsbIo	A pointer to the USB I/O Protocol instance for the specific USB target.
ConfigurationValue	A pointer to the device configuration to be retrieved.
Status	A pointer to the status of the transfer.

Return values

EFI_SUCCESS	The request executed successfully.
EFI_TIMEOUT	A timeout occurred executing the request.
EFI_DEVICE_ERROR	The request failed due to a device error. The transfer status is returned in Status.

Definition at line 264 of file UsbDxeLib.c.

◆ UsbGetDescriptor()

EFI_STATUS EFIAPI UsbGetDescriptor	(	IN EFI_USB_IO_PROTOCOL *	UsbIo,
		IN UINT16	Value,
		IN UINT16	Index,
		IN UINT16	DescriptorLength,
		OUT VOID *	Descriptor,
		OUT UINT32 *	Status
	)

Get the descriptor of the specified USB device.

Submit a USB get descriptor request for the USB device specified by UsbIo, Value, and Index, and return the descriptor in the buffer specified by Descriptor. The status of the transfer is returned in Status. If UsbIo is NULL, then ASSERT(). If Descriptor is NULL, then ASSERT(). If Status is NULL, then ASSERT().

Parameters

UsbIo	A pointer to the USB I/O Protocol instance for the specific USB target.
Value	The device request value.
Index	The device request index.
DescriptorLength	The size, in bytes, of Descriptor.
Descriptor	A pointer to the descriptor buffer to get.
Status	A pointer to the status of the transfer.

Return values

EFI_SUCCESS	The request executed successfully.
EFI_OUT_OF_RESOURCES	The request could not be completed because the buffer specified by DescriptorLength and Descriptor is not large enough to hold the result of the request.
EFI_TIMEOUT	A timeout occurred executing the request.
EFI_DEVICE_ERROR	The request failed due to a device error. The transfer status is returned in Status.

Definition at line 41 of file UsbDxeLib.c.

◆ UsbGetInterface()

EFI_STATUS EFIAPI UsbGetInterface	(	IN EFI_USB_IO_PROTOCOL *	UsbIo,
		IN UINT16	Interface,
		OUT UINT16 *	AlternateSetting,
		OUT UINT32 *	Status
	)

Get the interface setting of the specified USB device.

Submit a USB get interface request for the USB device specified by UsbIo, and Interface, and place the result in the buffer specified by AlternateSetting. The status of the transfer is returned in Status. If UsbIo is NULL, then ASSERT(). If AlternateSetting is NULL, then ASSERT(). If Status is NULL, then ASSERT().

Parameters

UsbIo	A pointer to the USB I/O Protocol instance for the specific USB target.
Interface	The interface index value.
AlternateSetting	A pointer to the alternate setting to be retrieved.
Status	A pointer to the status of the transfer.

Return values

EFI_SUCCESS	The request executed successfully.
EFI_TIMEOUT	A timeout occurred executing the request.
EFI_DEVICE_ERROR	The request failed due to a device error. The transfer status is returned in Status.

Definition at line 157 of file UsbDxeLib.c.

◆ UsbGetStatus()

EFI_STATUS EFIAPI UsbGetStatus	(	IN EFI_USB_IO_PROTOCOL *	UsbIo,
		IN USB_TYPES_DEFINITION	Recipient,
		IN UINT16	Target,
		OUT UINT16 *	DeviceStatus,
		OUT UINT32 *	Status
	)

Get the status of the specified device.

Submit a USB device get status request for the USB device specified by UsbIo, Recipient, and Target and place the result in the buffer specified by DeviceStatus. The status of the transfer is returned in Status. If UsbIo is NULL, then ASSERT(). If DeviceStatus is NULL, then ASSERT(). If Status is NULL, then ASSERT().

Parameters

UsbIo	A pointer to the USB I/O Protocol instance for the specific USB target.
Recipient	The USB data recipient type (i.e. Device, Interface, Endpoint). Type USB_TYPES_DEFINITION is defined in the MDE Package Industry Standard include file Usb.h.
Target	The index of the device to be get the status of.
DeviceStatus	A pointer to the device status to be retrieved.
Status	A pointer to the status of the transfer.

Return values

EFI_SUCCESS	The request executed successfully.
EFI_TIMEOUT	A timeout occurred executing the request.
EFI_DEVICE_ERROR	The request failed due to a device error. The transfer status is returned in Status.

Definition at line 520 of file UsbDxeLib.c.

◆ UsbSetConfiguration()

EFI_STATUS EFIAPI UsbSetConfiguration	(	IN EFI_USB_IO_PROTOCOL *	UsbIo,
		IN UINT16	ConfigurationValue,
		OUT UINT32 *	Status
	)

Set the device configuration.

Submit a USB set configuration request for the USB device specified by UsbIo and set the device configuration to the value specified by ConfigurationValue. The status of the transfer is returned in Status. If UsbIo is NULL, then ASSERT(). If Status is NULL, then ASSERT().

Parameters

UsbIo	A pointer to the USB I/O Protocol instance for the specific USB target.
ConfigurationValue	The device configuration value to be set.
Status	A pointer to the status of the transfer.

Return values

EFI_SUCCESS	The request executed successfully.
EFI_TIMEOUT	A timeout occurred executing the request.
EFI_DEVICE_ERROR	The request failed due to a device error. The transfer status is returned in Status.

Definition at line 316 of file UsbDxeLib.c.

◆ UsbSetDescriptor()

EFI_STATUS EFIAPI UsbSetDescriptor	(	IN EFI_USB_IO_PROTOCOL *	UsbIo,
		IN UINT16	Value,
		IN UINT16	Index,
		IN UINT16	DescriptorLength,
		IN VOID *	Descriptor,
		OUT UINT32 *	Status
	)

Set the descriptor of the specified USB device.

Submit a USB set descriptor request for the USB device specified by UsbIo, Value, and Index, and set the descriptor using the buffer specified by DesriptorLength and Descriptor. The status of the transfer is returned in Status. If UsbIo is NULL, then ASSERT(). If Descriptor is NULL, then ASSERT(). If Status is NULL, then ASSERT().

Parameters

UsbIo	A pointer to the USB I/O Protocol instance for the specific USB target.
Value	The device request value.
Index	The device request index.
DescriptorLength	The size, in bytes, of Descriptor.
Descriptor	A pointer to the descriptor buffer to set.
Status	A pointer to the status of the transfer.

Return values

EFI_SUCCESS	The request executed successfully.
EFI_TIMEOUT	A timeout occurred executing the request.
EFI_DEVICE_ERROR	The request failed due to a device error. The transfer status is returned in Status.

Definition at line 100 of file UsbDxeLib.c.

◆ UsbSetFeature()

EFI_STATUS EFIAPI UsbSetFeature	(	IN EFI_USB_IO_PROTOCOL *	UsbIo,
		IN USB_TYPES_DEFINITION	Recipient,
		IN UINT16	Value,
		IN UINT16	Target,
		OUT UINT32 *	Status
	)

Set the specified feature of the specified device.

Submit a USB set device feature request for the USB device specified by UsbIo, Recipient, and Target to the value specified by Value. The status of the transfer is returned in Status. If UsbIo is NULL, then ASSERT(). If Status is NULL, then ASSERT().

Parameters

UsbIo	A pointer to the USB I/O Protocol instance for the specific USB target.
Recipient	The USB data recipient type (i.e. Device, Interface, Endpoint). Type USB_TYPES_DEFINITION is defined in the MDE Package Industry Standard include file Usb.h.
Value	The value of the feature to be set.
Target	The index of the device to be set.
Status	A pointer to the status of the transfer.

Return values

EFI_SUCCESS	The request executed successfully.
EFI_TIMEOUT	A timeout occurred executing the request.
EFI_DEVICE_ERROR	The request failed due to a device error. The transfer status is returned in Status.

Definition at line 369 of file UsbDxeLib.c.

◆ UsbSetInterface()

EFI_STATUS EFIAPI UsbSetInterface	(	IN EFI_USB_IO_PROTOCOL *	UsbIo,
		IN UINT16	Interface,
		IN UINT16	AlternateSetting,
		OUT UINT32 *	Status
	)

Set the interface setting of the specified USB device.

Submit a USB set interface request for the USB device specified by UsbIo, and Interface, and set the alternate setting to the value specified by AlternateSetting. The status of the transfer is returned in Status. If UsbIo is NULL, then ASSERT(). If Status is NULL, then ASSERT().

Parameters

UsbIo	A pointer to the USB I/O Protocol instance for the specific USB target.
Interface	The interface index value.
AlternateSetting	The alternate setting to be set.
Status	A pointer to the status of the transfer.

Return values

EFI_SUCCESS	The request executed successfully.
EFI_TIMEOUT	A timeout occurred executing the request.
EFI_SUCCESS	The request failed due to a device error. The transfer status is returned in Status.

Definition at line 212 of file UsbDxeLib.c.

Functions

Detailed Description

Function Documentation

◆ UsbClearEndpointHalt()

◆ UsbClearFeature()

◆ UsbGetConfiguration()

◆ UsbGetDescriptor()

◆ UsbGetInterface()

◆ UsbGetStatus()

◆ UsbSetConfiguration()

◆ UsbSetDescriptor()

◆ UsbSetFeature()

◆ UsbSetInterface()