#include <Protocol/UsbIo.h>
Go to the source code of this file.
Classes | |
| struct | EFI_USB_INTERFACE_INFO |
| struct | EFI_USB_CONFIG_INFO |
| struct | EFI_USB_DEVICE_INFO |
| struct | _EFI_USBFN_TRANSFER_RESULT |
| union | _EFI_USBFN_MESSAGE_PAYLOAD |
| struct | _EFI_USBFN_IO_PROTOCOL |
Macros | |
| #define | EFI_USBFN_IO_PROTOCOL_GUID |
| #define | EFI_USBFN_IO_PROTOCOL_REVISION 0x00010001 |
Variables | |
| EFI_GUID | gEfiUsbFunctionIoProtocolGuid |
Detailed Description
The USB Function Protocol provides an I/O abstraction for a USB Controller operating in Function mode (also commonly referred to as Device, Peripheral, or Target mode) and the mechanisms by which the USB Function can communicate with the USB Host. It is used by other UEFI drivers or applications to perform data transactions and basic USB controller management over a USB Function port.
This simple protocol only supports USB 2.0 bulk transfers on systems with a single configuration and a single interface. It does not support isochronous or interrupt transfers, alternate interfaces, or USB 3.0 functionality. Future revisions of this protocol may support these or additional features.
Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
- Revision Reference:
- This Protocol was introduced in UEFI Specification 2.5.
Macro Definition Documentation
◆ EFI_USBFN_IO_PROTOCOL_GUID
| #define EFI_USBFN_IO_PROTOCOL_GUID |
◆ EFI_USBFN_IO_PROTOCOL_REVISION
| #define EFI_USBFN_IO_PROTOCOL_REVISION 0x00010001 |
Typedef Documentation
◆ EFI_USB_BUS_SPEED
| typedef enum _EFI_USB_BUS_SPEED EFI_USB_BUS_SPEED |
◆ EFI_USB_ENDPOINT_TYPE
| typedef enum _EFI_USB_ENDPOINT_TYPE EFI_USB_ENDPOINT_TYPE |
◆ EFI_USBFN_DEVICE_INFO_ID
| typedef enum _EFI_USBFN_DEVICE_INFO_ID EFI_USBFN_DEVICE_INFO_ID |
◆ EFI_USBFN_ENDPOINT_DIRECTION
◆ EFI_USBFN_IO_ABORT_TRANSFER
| typedef EFI_STATUS(EFIAPI * EFI_USBFN_IO_ABORT_TRANSFER) (IN EFI_USBFN_IO_PROTOCOL *This, IN UINT8 EndpointIndex, IN EFI_USBFN_ENDPOINT_DIRECTION Direction) |
Aborts the transfer on the specified endpoint.
This function should fail with EFI_INVALID_PARAMETER if the specified direction is incorrect for the endpoint.
- Parameters
-
[in] This A pointer to the EFI_USBFN_IO_PROTOCOL instance. [in] EndpointIndex Indicates the endpoint on which the ongoing transfer needs to be canceled. [in] Direction Direction of the endpoint.
- Return values
-
EFI_SUCCESS The function returned successfully. EFI_INVALID_PARAMETER A parameter is invalid. EFI_DEVICE_ERROR The physical device reported an error. EFI_NOT_READY The physical device is busy or not ready to process this request.
◆ EFI_USBFN_IO_ALLOCATE_TRANSFER_BUFFER
| typedef EFI_STATUS(EFIAPI * EFI_USBFN_IO_ALLOCATE_TRANSFER_BUFFER) (IN EFI_USBFN_IO_PROTOCOL *This, IN UINTN Size, OUT VOID **Buffer) |
Allocates a transfer buffer of the specified sizethat satisfies the controller requirements.
The AllocateTransferBuffer() function allocates a memory region of Size bytes and returns the address of the allocated memory that satisfies the underlying controller requirements in the location referenced by Buffer.
The allocated transfer buffer must be freed using a matching call to EFI_USBFN_IO_PROTOCOL.FreeTransferBuffer()function.
- Parameters
-
[in] This A pointer to the EFI_USBFN_IO_PROTOCOL instance. [in] Size The number of bytes to allocate for the transfer buffer. [out] Buffer A pointer to a pointer to the allocated buffer if the call succeeds; undefined otherwise.
- Return values
-
EFI_SUCCESS The function returned successfully. EFI_INVALID_PARAMETER A parameter is invalid. EFI_OUT_OF_RESOURCES The requested transfer buffer could not be allocated.
◆ EFI_USBFN_IO_CONFIGURE_ENABLE_ENDPOINTS
| typedef EFI_STATUS(EFIAPI * EFI_USBFN_IO_CONFIGURE_ENABLE_ENDPOINTS) (IN EFI_USBFN_IO_PROTOCOL *This, OUT EFI_USB_DEVICE_INFO *DeviceInfo) |
Configures endpoints based on supplied device and configuration descriptors.
Assuming that the hardware has already been initialized, this function configures the endpoints using the device information supplied by DeviceInfo, activates the port, and starts receiving USB events.
This function must ignore the bMaxPacketSize0field of the Standard Device Descriptor and the wMaxPacketSize field of the Standard Endpoint Descriptor that are made available through DeviceInfo.
- Parameters
-
[in] This A pointer to the EFI_USBFN_IO_PROTOCOL instance. [out] DeviceInfo A pointer to EFI_USBFN_DEVICE_INFO instance.
- Return values
-
EFI_SUCCESS The function returned successfully. EFI_INVALID_PARAMETER A parameter is invalid. EFI_DEVICE_ERROR The physical device reported an error. EFI_NOT_READY The physical device is busy or not ready to process this request. EFI_OUT_OF_RESOURCES The request could not be completed due to lack of resources.
◆ EFI_USBFN_IO_DETECT_PORT
| typedef EFI_STATUS(EFIAPI * EFI_USBFN_IO_DETECT_PORT) (IN EFI_USBFN_IO_PROTOCOL *This, OUT EFI_USBFN_PORT_TYPE *PortType) |
Returns information about what USB port type was attached.
- Parameters
-
[in] This A pointer to the EFI_USBFN_IO_PROTOCOL instance. [out] PortType Returns the USB port type.
- Return values
-
EFI_SUCCESS The function returned successfully. EFI_INVALID_PARAMETER A parameter is invalid. EFI_DEVICE_ERROR The physical device reported an error. EFI_NOT_READY The physical device is busy or not ready to process this request or there is no USB port attached to the device.
◆ EFI_USBFN_IO_EVENTHANDLER
| typedef EFI_STATUS(EFIAPI * EFI_USBFN_IO_EVENTHANDLER) (IN EFI_USBFN_IO_PROTOCOL *This, OUT EFI_USBFN_MESSAGE *Message, IN OUT UINTN *PayloadSize, OUT EFI_USBFN_MESSAGE_PAYLOAD *Payload) |
This function is called repeatedly to get information on USB bus states, receive-completion and transmit-completion events on the endpoints, and notification on setup packet on endpoint 0.
A class driver must call EFI_USBFN_IO_PROTOCOL.EventHandler()repeatedly to receive updates on the transfer status and number of bytes transferred on various endpoints.
- Parameters
-
[in] This A pointer to the EFI_USBFN_IO_PROTOCOL instance. [out] Message Indicates the event that initiated this notification. [in,out] PayloadSize On input, the size of the memory pointed by Payload. On output, the amount ofdata returned in Payload. [out] Payload A pointer to EFI_USBFN_MESSAGE_PAYLOAD instance to return additional payload for current message.
- Return values
-
EFI_SUCCESS The function returned successfully. EFI_INVALID_PARAMETER A parameter is invalid. EFI_DEVICE_ERROR The physical device reported an error. EFI_NOT_READY The physical device is busy or not ready to process this request. EFI_BUFFER_TOO_SMALL The Supplied buffer is not large enough to hold the message payload.
◆ EFI_USBFN_IO_FREE_TRANSFER_BUFFER
| typedef EFI_STATUS(EFIAPI * EFI_USBFN_IO_FREE_TRANSFER_BUFFER) (IN EFI_USBFN_IO_PROTOCOL *This, IN VOID *Buffer) |
Deallocates the memory allocated for the transfer buffer by the EFI_USBFN_IO_PROTOCOL.AllocateTransferBuffer() function.
The EFI_USBFN_IO_PROTOCOL.FreeTransferBuffer() function deallocates the memory specified by Buffer. The Buffer that is freed must have been allocated by EFI_USBFN_IO_PROTOCOL.AllocateTransferBuffer().
- Parameters
-
[in] This A pointer to the EFI_USBFN_IO_PROTOCOL instance. [in] Buffer A pointer to the transfer buffer to deallocate.
- Return values
-
EFI_SUCCESS The function returned successfully. EFI_INVALID_PARAMETER A parameter is invalid.
◆ EFI_USBFN_IO_GET_DEVICE_INFO
| typedef EFI_STATUS(EFIAPI * EFI_USBFN_IO_GET_DEVICE_INFO) (IN EFI_USBFN_IO_PROTOCOL *This, IN EFI_USBFN_DEVICE_INFO_ID Id, IN OUT UINTN *BufferSize, OUT VOID *Buffer OPTIONAL) |
Returns device specific information based on the supplied identifier as a Unicode string.
If the supplied Buffer isn't large enough, or is NULL, the method fails with EFI_BUFFER_TOO_SMALL and the required size is returned through BufferSize. All returned strings are in Unicode format.
An Id of EfiUsbDeviceInfoUnknown is treated as an invalid parameter.
- Parameters
-
[in] This A pointer to the EFI_USBFN_IO_PROTOCOLinstance. [in] Id The requested information id. [in] BufferSize On input, the size of the Buffer in bytes. On output, the amount of data returned in Buffer in bytes. [out] Buffer A pointer to a buffer to returnthe requested information as a Unicode string.
- Return values
-
EFI_SUCCESS The function returned successfully. EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: BufferSize is NULL. BufferSize is not 0 and Buffer is NULL. Id in invalid. EFI_DEVICE_ERROR The physical device reported an error. EFI_BUFFER_TOO_SMALL The buffer is too small to hold the buffer. BufferSize has been updated with the size needed to hold the request string.
◆ EFI_USBFN_IO_GET_ENDPOINT_MAXPACKET_SIZE
| typedef EFI_STATUS(EFIAPI * EFI_USBFN_IO_GET_ENDPOINT_MAXPACKET_SIZE) (IN EFI_USBFN_IO_PROTOCOL *This, IN EFI_USB_ENDPOINT_TYPE EndpointType, IN EFI_USB_BUS_SPEED BusSpeed, OUT UINT16 *MaxPacketSize) |
Returns the maximum packet size of the specified endpoint type for the supplied bus speed.
If the BusSpeed is UsbBusSpeedUnknown, the maximum speed the underlying controller supports is assumed.
This protocol currently does not support isochronous or interrupt transfers. Future revisions of this protocol may eventually support it.
- Parameters
-
[in] This A pointer to the EFI_USBFN_IO_PROTOCOLinstance. [in] EndpointType Endpoint type as defined as EFI_USB_ENDPOINT_TYPE. [in] BusSpeed Bus speed as defined as EFI_USB_BUS_SPEED. [out] MaxPacketSize The maximum packet size, in bytes, of the specified endpoint type.
- Return values
-
EFI_SUCCESS The function returned successfully. EFI_INVALID_PARAMETER A parameter is invalid. EFI_DEVICE_ERROR The physical device reported an error. EFI_NOT_READY The physical device is busy or not ready to process this request.
◆ EFI_USBFN_IO_GET_ENDPOINT_POLICY
| typedef EFI_STATUS(EFIAPI * EFI_USBFN_IO_GET_ENDPOINT_POLICY) (IN EFI_USBFN_IO_PROTOCOL *This, IN UINT8 EndpointIndex, IN EFI_USBFN_ENDPOINT_DIRECTION Direction, IN EFI_USBFN_POLICY_TYPE PolicyType, IN OUT UINTN *BufferSize, IN OUT VOID *Buffer) |
This function sets the configuration policy for the specified non-control endpoint.
This function can only be called before EFI_USBFN_IO_PROTOCOL.StartController() or after EFI_USBFN_IO_PROTOCOL.StopController() has been called.
- Parameters
-
[in] This A pointer to the EFI_USBFN_IO_PROTOCOL instance. [in] EndpointIndex Indicates the non-control endpoint for which the policy needs to be set. [in] Direction Direction of the endpoint. [in] PolicyType Policy type the user is trying to retrieve for the specified non-control endpoint. [in,out] BufferSize On input, the size of Bufferin bytes. On output, the amount of data returned in Bufferin bytes. [in,out] Buffer A pointer to a buffer to return requested endpoint policy value.
- Return values
-
EFI_SUCCESS The function returned successfully. EFI_INVALID_PARAMETER A parameter is invalid. EFI_DEVICE_ERROR The specified policy value is not supported. EFI_BUFFER_TOO_SMALL Supplied buffer is not large enough to hold requested policy value.
◆ EFI_USBFN_IO_GET_ENDPOINT_STALL_STATE
| typedef EFI_STATUS(EFIAPI * EFI_USBFN_IO_GET_ENDPOINT_STALL_STATE) (IN EFI_USBFN_IO_PROTOCOL *This, IN UINT8 EndpointIndex, IN EFI_USBFN_ENDPOINT_DIRECTION Direction, IN OUT BOOLEAN *State) |
Returns the stall state on the specified endpoint.
This function should fail with EFI_INVALID_PARAMETER if the specified direction is incorrect for the endpoint.
- Parameters
-
[in] This A pointer to the EFI_USBFN_IO_PROTOCOL instance. [in] EndpointIndex Indicates the endpoint. [in] Direction Direction of the endpoint. [in,out] State Boolean, true value indicates that the endpoint is in a stalled state, false otherwise.
- Return values
-
EFI_SUCCESS The function returned successfully. EFI_INVALID_PARAMETER A parameter is invalid. EFI_DEVICE_ERROR The physical device reported an error. EFI_NOT_READY The physical device is busy or not ready to process this request.
◆ EFI_USBFN_IO_GET_MAXTRANSFER_SIZE
| typedef EFI_STATUS(EFIAPI * EFI_USBFN_IO_GET_MAXTRANSFER_SIZE) (IN EFI_USBFN_IO_PROTOCOL *This, OUT UINTN *MaxTransferSize) |
Returns the maximum supported transfer size.
Returns the maximum number of bytes that the underlying controller can accommodate in a single transfer.
- Parameters
-
[in] This A pointer to the EFI_USBFN_IO_PROTOCOL instance. [out] MaxTransferSize The maximum supported transfer size, in bytes.
- Return values
-
EFI_SUCCESS The function returned successfully. EFI_INVALID_PARAMETER A parameter is invalid. EFI_DEVICE_ERROR The physical device reported an error. EFI_NOT_READY The physical device is busy or not ready to process this request.
◆ EFI_USBFN_IO_GET_VENDOR_ID_PRODUCT_ID
| typedef EFI_STATUS(EFIAPI * EFI_USBFN_IO_GET_VENDOR_ID_PRODUCT_ID) (IN EFI_USBFN_IO_PROTOCOL *This, OUT UINT16 *Vid, OUT UINT16 *Pid) |
Returns the vendor-id and product-id of the device.
- Parameters
-
[in] This A pointer to the EFI_USBFN_IO_PROTOCOL instance. [out] Vid Returned vendor-id of the device. [out] Pid Returned product-id of the device.
- Return values
-
EFI_SUCCESS The function returned successfully. EFI_INVALID_PARAMETER A parameter is invalid. EFI_NOT_FOUND Unable to return the vendor-id or the product-id.
◆ EFI_USBFN_IO_PROTOCOL
| typedef struct _EFI_USBFN_IO_PROTOCOL EFI_USBFN_IO_PROTOCOL |
◆ EFI_USBFN_IO_SET_ENDPOINT_POLICY
| typedef EFI_STATUS(EFIAPI * EFI_USBFN_IO_SET_ENDPOINT_POLICY) (IN EFI_USBFN_IO_PROTOCOL *This, IN UINT8 EndpointIndex, IN EFI_USBFN_ENDPOINT_DIRECTION Direction, IN EFI_USBFN_POLICY_TYPE PolicyType, IN UINTN BufferSize, IN VOID *Buffer) |
This function sets the configuration policy for the specified non-control endpoint.
This function can only be called before EFI_USBFN_IO_PROTOCOL.StartController() or after EFI_USBFN_IO_PROTOCOL.StopController() has been called.
- Parameters
-
[in] This A pointer to the EFI_USBFN_IO_PROTOCOL instance. [in] EndpointIndex Indicates the non-control endpoint for which the policy needs to be set. [in] Direction Direction of the endpoint. [in] PolicyType Policy type the user is trying to set for the specified non-control endpoint. [in] BufferSize The size of the Bufferin bytes. [in] Buffer The new value for the policy parameter that PolicyType specifies.
- Return values
-
EFI_SUCCESS The function returned successfully. EFI_INVALID_PARAMETER A parameter is invalid. EFI_DEVICE_ERROR The physical device reported an error. EFI_UNSUPPORTED Changing this policy value is not supported.
◆ EFI_USBFN_IO_SET_ENDPOINT_STALL_STATE
| typedef EFI_STATUS(EFIAPI * EFI_USBFN_IO_SET_ENDPOINT_STALL_STATE) (IN EFI_USBFN_IO_PROTOCOL *This, IN UINT8 EndpointIndex, IN EFI_USBFN_ENDPOINT_DIRECTION Direction, IN OUT BOOLEAN *State) |
Sets or clears the stall state on the specified endpoint.
This function should fail with EFI_INVALID_PARAMETER if the specified direction is incorrect for the endpoint.
- Parameters
-
[in] This A pointer to the EFI_USBFN_IO_PROTOCOL instance. [in] EndpointIndex Indicates the endpoint. [in] Direction Direction of the endpoint. [in] State Requested stall state on the specified endpoint. True value causes the endpoint to stall; false value clears an existing stall.
- Return values
-
EFI_SUCCESS The function returned successfully. EFI_INVALID_PARAMETER A parameter is invalid. EFI_DEVICE_ERROR The physical device reported an error. EFI_NOT_READY The physical device is busy or not ready to process this request.
◆ EFI_USBFN_IO_START_CONTROLLER
| typedef EFI_STATUS(EFIAPI * EFI_USBFN_IO_START_CONTROLLER) (IN EFI_USBFN_IO_PROTOCOL *This) |
This function supplies power to the USB controller if needed and initializes the hardware and the internal data structures. The port must not be activated by this function.
- Parameters
-
[in] This A pointer to the EFI_USBFN_IO_PROTOCOL instance.
- Return values
-
EFI_SUCCESS The function returned successfully. EFI_INVALID_PARAMETER A parameter is invalid. EFI_DEVICE_ERROR The physical device reported an error.
◆ EFI_USBFN_IO_STOP_CONTROLLER
| typedef EFI_STATUS(EFIAPI * EFI_USBFN_IO_STOP_CONTROLLER) (IN EFI_USBFN_IO_PROTOCOL *This) |
This function stops the USB hardware device.
- Parameters
-
[in] This A pointer to the EFI_USBFN_IO_PROTOCOL instance.
- Return values
-
EFI_SUCCESS The function returned successfully. EFI_INVALID_PARAMETER A parameter is invalid. EFI_DEVICE_ERROR The physical device reported an error.
◆ EFI_USBFN_IO_TRANSFER
| typedef EFI_STATUS(EFIAPI * EFI_USBFN_IO_TRANSFER) (IN EFI_USBFN_IO_PROTOCOL *This, IN UINT8 EndpointIndex, IN EFI_USBFN_ENDPOINT_DIRECTION Direction, IN OUT UINTN *BufferSize, IN OUT VOID *Buffer) |
This function handles transferring data to or from the host on the specified endpoint, depending on the direction specified.
A class driver must call EFI_USBFN_IO_PROTOCOL.EventHandler() repeatedly to receive updates on the transfer status and the number of bytes transferred on various endpoints. Upon an update of the transfer status, the Buffer field of the EFI_USBFN_TRANSFER_RESULT structure (as described in the function description for EFI_USBFN_IO_PROTOCOL.EventHandler()) must be initialized with the Buffer pointer that was supplied to this method.
The overview of the call sequence is illustrated in the Figure 54.
This function should fail with EFI_INVALID_PARAMETER if the specified direction is incorrect for the endpoint.
- Parameters
-
[in] This A pointer to the EFI_USBFN_IO_PROTOCOL instance. [in] EndpointIndex Indicates the endpoint on which TX or RX transfer needs to take place. [in] Direction Direction of the endpoint. [in,out] BufferSize If Direction is EfiUsbEndpointDirectionDeviceRx: On input, the size of the Bufferin bytes. On output, the amount of data returned in Buffer in bytes. If Direction is EfiUsbEndpointDirectionDeviceTx: On input, the size of the Bufferin bytes. On output, the amount of data transmitted in bytes. [in,out] Buffer If Direction is EfiUsbEndpointDirectionDeviceRx: The Buffer to return the received data. If Directionis EfiUsbEndpointDirectionDeviceTx: The Buffer that contains the data to be transmitted.
- Return values
-
EFI_SUCCESS The function returned successfully. EFI_INVALID_PARAMETER A parameter is invalid. EFI_DEVICE_ERROR The physical device reported an error. EFI_NOT_READY The physical device is busy or not ready to process this request.
◆ EFI_USBFN_MESSAGE
| typedef enum _EFI_USBFN_MESSAGE EFI_USBFN_MESSAGE |
◆ EFI_USBFN_MESSAGE_PAYLOAD
| typedef union _EFI_USBFN_MESSAGE_PAYLOAD EFI_USBFN_MESSAGE_PAYLOAD |
◆ EFI_USBFN_POLICY_TYPE
| typedef enum _EFI_USBFN_POLICY_TYPE EFI_USBFN_POLICY_TYPE |
◆ EFI_USBFN_PORT_TYPE
| typedef enum _EFI_USBFN_PORT_TYPE EFI_USBFN_PORT_TYPE |
◆ EFI_USBFN_TRANSFER_RESULT
| typedef struct _EFI_USBFN_TRANSFER_RESULT EFI_USBFN_TRANSFER_RESULT |
◆ EFI_USBFN_TRANSFER_STATUS
| typedef enum _EFI_USBFN_TRANSFER_STATUS EFI_USBFN_TRANSFER_STATUS |
Enumeration Type Documentation
◆ _EFI_USB_BUS_SPEED
| enum _EFI_USB_BUS_SPEED |
◆ _EFI_USB_ENDPOINT_TYPE
◆ _EFI_USBFN_DEVICE_INFO_ID
◆ _EFI_USBFN_ENDPOINT_DIRECTION
◆ _EFI_USBFN_MESSAGE
| enum _EFI_USBFN_MESSAGE |
◆ _EFI_USBFN_POLICY_TYPE
◆ _EFI_USBFN_PORT_TYPE
| enum _EFI_USBFN_PORT_TYPE |
◆ _EFI_USBFN_TRANSFER_STATUS
Variable Documentation
◆ gEfiUsbFunctionIoProtocolGuid
|
extern |
