iPXE
Data Structures | Defines | Typedefs | Enumerations | Functions | Variables
Usb2HostController.h File Reference

EFI_USB2_HC_PROTOCOL as defined in UEFI 2.0. More...

#include <ipxe/efi/Protocol/UsbIo.h>

Go to the source code of this file.

Data Structures

struct  EFI_USB_PORT_STATUS
struct  EFI_USB2_HC_TRANSACTION_TRANSLATOR
struct  _EFI_USB2_HC_PROTOCOL
 The EFI_USB2_HC_PROTOCOL provides USB host controller management, basic data transactions over a USB bus, and USB root hub access. More...

Defines

#define EFI_USB2_HC_PROTOCOL_GUID
#define USB_PORT_STAT_CONNECTION   0x0001
 EFI_USB_PORT_STATUS.PortStatus bit definition.
#define USB_PORT_STAT_ENABLE   0x0002
#define USB_PORT_STAT_SUSPEND   0x0004
#define USB_PORT_STAT_OVERCURRENT   0x0008
#define USB_PORT_STAT_RESET   0x0010
#define USB_PORT_STAT_POWER   0x0100
#define USB_PORT_STAT_LOW_SPEED   0x0200
#define USB_PORT_STAT_HIGH_SPEED   0x0400
#define USB_PORT_STAT_SUPER_SPEED   0x0800
#define USB_PORT_STAT_OWNER   0x2000
#define USB_PORT_STAT_C_CONNECTION   0x0001
 EFI_USB_PORT_STATUS.PortChangeStatus bit definition.
#define USB_PORT_STAT_C_ENABLE   0x0002
#define USB_PORT_STAT_C_SUSPEND   0x0004
#define USB_PORT_STAT_C_OVERCURRENT   0x0008
#define USB_PORT_STAT_C_RESET   0x0010
#define EFI_USB_SPEED_FULL   0x0000
 12 Mb/s, USB 1.1 OHCI and UHCI HC.
#define EFI_USB_SPEED_LOW   0x0001
 1 Mb/s, USB 1.1 OHCI and UHCI HC.
#define EFI_USB_SPEED_HIGH   0x0002
 480 Mb/s, USB 2.0 EHCI HC.
#define EFI_USB_SPEED_SUPER   0x0003
 4.8 Gb/s, USB 3.0 XHCI HC.
#define EFI_USB_HC_RESET_GLOBAL   0x0001
#define EFI_USB_HC_RESET_HOST_CONTROLLER   0x0002
#define EFI_USB_HC_RESET_GLOBAL_WITH_DEBUG   0x0004
#define EFI_USB_HC_RESET_HOST_WITH_DEBUG   0x0008
#define EFI_USB_MAX_BULK_BUFFER_NUM   10
#define EFI_USB_MAX_ISO_BUFFER_NUM   7
#define EFI_USB_MAX_ISO_BUFFER_NUM1   2

Typedefs

typedef struct
_EFI_USB2_HC_PROTOCOL 
EFI_USB2_HC_PROTOCOL
 Forward reference for pure ANSI compatability.
typedef EFI_STATUS(EFIAPIEFI_USB2_HC_PROTOCOL_GET_CAPABILITY )(IN EFI_USB2_HC_PROTOCOL *This, OUT UINT8 *MaxSpeed, OUT UINT8 *PortNumber, OUT UINT8 *Is64BitCapable)
 Retrieves the Host Controller capabilities.
typedef EFI_STATUS(EFIAPIEFI_USB2_HC_PROTOCOL_RESET )(IN EFI_USB2_HC_PROTOCOL *This, IN UINT16 Attributes)
 Provides software reset for the USB host controller.
typedef EFI_STATUS(EFIAPIEFI_USB2_HC_PROTOCOL_GET_STATE )(IN EFI_USB2_HC_PROTOCOL *This, OUT EFI_USB_HC_STATE *State)
 Retrieves current state of the USB host controller.
typedef EFI_STATUS(EFIAPIEFI_USB2_HC_PROTOCOL_SET_STATE )(IN EFI_USB2_HC_PROTOCOL *This, IN EFI_USB_HC_STATE State)
 Sets the USB host controller to a specific state.
typedef EFI_STATUS(EFIAPIEFI_USB2_HC_PROTOCOL_CONTROL_TRANSFER )(IN EFI_USB2_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 DeviceSpeed, IN UINTN MaximumPacketLength, IN EFI_USB_DEVICE_REQUEST *Request, IN EFI_USB_DATA_DIRECTION TransferDirection, IN OUT VOID *Data OPTIONAL, IN OUT UINTN *DataLength OPTIONAL, IN UINTN TimeOut, IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator, OUT UINT32 *TransferResult)
 Submits control transfer to a target USB device.
typedef EFI_STATUS(EFIAPIEFI_USB2_HC_PROTOCOL_BULK_TRANSFER )(IN EFI_USB2_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN UINT8 DeviceSpeed, IN UINTN MaximumPacketLength, IN UINT8 DataBuffersNumber, IN OUT VOID *Data[EFI_USB_MAX_BULK_BUFFER_NUM], IN OUT UINTN *DataLength, IN OUT UINT8 *DataToggle, IN UINTN TimeOut, IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator, OUT UINT32 *TransferResult)
 Submits bulk transfer to a bulk endpoint of a USB device.
typedef EFI_STATUS(EFIAPIEFI_USB2_HC_PROTOCOL_ASYNC_INTERRUPT_TRANSFER )(IN EFI_USB2_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN UINT8 DeviceSpeed, IN UINTN MaxiumPacketLength, IN BOOLEAN IsNewTransfer, IN OUT UINT8 *DataToggle, IN UINTN PollingInterval OPTIONAL, IN UINTN DataLength OPTIONAL, IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator OPTIONAL, IN EFI_ASYNC_USB_TRANSFER_CALLBACK CallBackFunction OPTIONAL, IN VOID *Context OPTIONAL)
 Submits an asynchronous interrupt transfer to an interrupt endpoint of a USB device.
typedef EFI_STATUS(EFIAPIEFI_USB2_HC_PROTOCOL_SYNC_INTERRUPT_TRANSFER )(IN EFI_USB2_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN UINT8 DeviceSpeed, IN UINTN MaximumPacketLength, IN OUT VOID *Data, IN OUT UINTN *DataLength, IN OUT UINT8 *DataToggle, IN UINTN TimeOut, IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator, OUT UINT32 *TransferResult)
 Submits synchronous interrupt transfer to an interrupt endpoint of a USB device.
typedef EFI_STATUS(EFIAPIEFI_USB2_HC_PROTOCOL_ISOCHRONOUS_TRANSFER )(IN EFI_USB2_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN UINT8 DeviceSpeed, IN UINTN MaximumPacketLength, IN UINT8 DataBuffersNumber, IN OUT VOID *Data[EFI_USB_MAX_ISO_BUFFER_NUM], IN UINTN DataLength, IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator, OUT UINT32 *TransferResult)
 Submits isochronous transfer to an isochronous endpoint of a USB device.
typedef EFI_STATUS(EFIAPIEFI_USB2_HC_PROTOCOL_ASYNC_ISOCHRONOUS_TRANSFER )(IN EFI_USB2_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN UINT8 DeviceSpeed, IN UINTN MaximumPacketLength, IN UINT8 DataBuffersNumber, IN OUT VOID *Data[EFI_USB_MAX_ISO_BUFFER_NUM], IN UINTN DataLength, IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator, IN EFI_ASYNC_USB_TRANSFER_CALLBACK IsochronousCallBack, IN VOID *Context OPTIONAL)
 Submits nonblocking isochronous transfer to an isochronous endpoint of a USB device.
typedef EFI_STATUS(EFIAPIEFI_USB2_HC_PROTOCOL_GET_ROOTHUB_PORT_STATUS )(IN EFI_USB2_HC_PROTOCOL *This, IN UINT8 PortNumber, OUT EFI_USB_PORT_STATUS *PortStatus)
 Retrieves the current status of a USB root hub port.
typedef EFI_STATUS(EFIAPIEFI_USB2_HC_PROTOCOL_SET_ROOTHUB_PORT_FEATURE )(IN EFI_USB2_HC_PROTOCOL *This, IN UINT8 PortNumber, IN EFI_USB_PORT_FEATURE PortFeature)
 Sets a feature for the specified root hub port.
typedef EFI_STATUS(EFIAPIEFI_USB2_HC_PROTOCOL_CLEAR_ROOTHUB_PORT_FEATURE )(IN EFI_USB2_HC_PROTOCOL *This, IN UINT8 PortNumber, IN EFI_USB_PORT_FEATURE PortFeature)
 Clears a feature for the specified root hub port.

Enumerations

enum  EFI_USB_PORT_FEATURE {
  EfiUsbPortEnable = 1, EfiUsbPortSuspend = 2, EfiUsbPortReset = 4, EfiUsbPortPower = 8,
  EfiUsbPortOwner = 13, EfiUsbPortConnectChange = 16, EfiUsbPortEnableChange = 17, EfiUsbPortSuspendChange = 18,
  EfiUsbPortOverCurrentChange = 19, EfiUsbPortResetChange = 20
}
 Usb port features value Each value indicates its bit index in the port status and status change bitmaps, if combines these two bitmaps into a 32-bit bitmap. More...
enum  EFI_USB_HC_STATE { EfiUsbHcStateHalt, EfiUsbHcStateOperational, EfiUsbHcStateSuspend, EfiUsbHcStateMaximum }
 Enumration value for status of USB HC. More...

Functions

 FILE_LICENCE (BSD3)

Variables

EFI_GUID gEfiUsb2HcProtocolGuid

Detailed Description

EFI_USB2_HC_PROTOCOL as defined in UEFI 2.0.

The USB Host Controller Protocol is used by code, typically USB bus drivers, running in the EFI boot services environment, to perform data transactions over a USB bus. In addition, it provides an abstraction for the root hub of the USB bus.

Copyright (c) 2006 - 2015, 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.

Definition in file Usb2HostController.h.


Define Documentation

Value:
{ \
    0x3e745226, 0x9818, 0x45b6, {0xa2, 0xac, 0xd7, 0xcd, 0xe, 0x8b, 0xa2, 0xbc } \
  }

Definition at line 25 of file Usb2HostController.h.

#define USB_PORT_STAT_CONNECTION   0x0001

EFI_USB_PORT_STATUS.PortStatus bit definition.

Definition at line 44 of file Usb2HostController.h.

#define USB_PORT_STAT_ENABLE   0x0002

Definition at line 45 of file Usb2HostController.h.

#define USB_PORT_STAT_SUSPEND   0x0004

Definition at line 46 of file Usb2HostController.h.

#define USB_PORT_STAT_OVERCURRENT   0x0008

Definition at line 47 of file Usb2HostController.h.

#define USB_PORT_STAT_RESET   0x0010

Definition at line 48 of file Usb2HostController.h.

#define USB_PORT_STAT_POWER   0x0100

Definition at line 49 of file Usb2HostController.h.

#define USB_PORT_STAT_LOW_SPEED   0x0200

Definition at line 50 of file Usb2HostController.h.

#define USB_PORT_STAT_HIGH_SPEED   0x0400

Definition at line 51 of file Usb2HostController.h.

#define USB_PORT_STAT_SUPER_SPEED   0x0800

Definition at line 52 of file Usb2HostController.h.

#define USB_PORT_STAT_OWNER   0x2000

Definition at line 53 of file Usb2HostController.h.

#define USB_PORT_STAT_C_CONNECTION   0x0001

EFI_USB_PORT_STATUS.PortChangeStatus bit definition.

Definition at line 58 of file Usb2HostController.h.

#define USB_PORT_STAT_C_ENABLE   0x0002

Definition at line 59 of file Usb2HostController.h.

#define USB_PORT_STAT_C_SUSPEND   0x0004

Definition at line 60 of file Usb2HostController.h.

#define USB_PORT_STAT_C_OVERCURRENT   0x0008

Definition at line 61 of file Usb2HostController.h.

#define USB_PORT_STAT_C_RESET   0x0010

Definition at line 62 of file Usb2HostController.h.

#define EFI_USB_SPEED_FULL   0x0000

12 Mb/s, USB 1.1 OHCI and UHCI HC.

Definition at line 83 of file Usb2HostController.h.

#define EFI_USB_SPEED_LOW   0x0001

1 Mb/s, USB 1.1 OHCI and UHCI HC.

Definition at line 84 of file Usb2HostController.h.

#define EFI_USB_SPEED_HIGH   0x0002

480 Mb/s, USB 2.0 EHCI HC.

Definition at line 85 of file Usb2HostController.h.

#define EFI_USB_SPEED_SUPER   0x0003

4.8 Gb/s, USB 3.0 XHCI HC.

Definition at line 86 of file Usb2HostController.h.

#define EFI_USB_HC_RESET_GLOBAL   0x0001

Definition at line 121 of file Usb2HostController.h.

#define EFI_USB_HC_RESET_HOST_CONTROLLER   0x0002

Definition at line 122 of file Usb2HostController.h.

Definition at line 123 of file Usb2HostController.h.

#define EFI_USB_HC_RESET_HOST_WITH_DEBUG   0x0008

Definition at line 124 of file Usb2HostController.h.

#define EFI_USB_MAX_BULK_BUFFER_NUM   10

Definition at line 269 of file Usb2HostController.h.

Definition at line 412 of file Usb2HostController.h.

Definition at line 413 of file Usb2HostController.h.


Typedef Documentation

Forward reference for pure ANSI compatability.

Definition at line 33 of file Usb2HostController.h.

typedef EFI_STATUS(EFIAPI * EFI_USB2_HC_PROTOCOL_GET_CAPABILITY)(IN EFI_USB2_HC_PROTOCOL *This, OUT UINT8 *MaxSpeed, OUT UINT8 *PortNumber, OUT UINT8 *Is64BitCapable)

Retrieves the Host Controller capabilities.

Parameters:
ThisA pointer to the EFI_USB2_HC_PROTOCOL instance.
MaxSpeedHost controller data transfer speed.
PortNumberNumber of the root hub ports.
Is64BitCapableTRUE if controller supports 64-bit memory addressing, FALSE otherwise.
Return values:
EFI_SUCCESSThe host controller capabilities were retrieved successfully.
EFI_INVALID_PARAMETEROne of the input args was NULL.
EFI_DEVICE_ERRORAn error was encountered while attempting to retrieve the capabilities.

Definition at line 114 of file Usb2HostController.h.

Provides software reset for the USB host controller.

Parameters:
ThisA pointer to the EFI_USB2_HC_PROTOCOL instance.
AttributesA bit mask of the reset operation to perform.
Return values:
EFI_SUCCESSThe reset operation succeeded.
EFI_INVALID_PARAMETERAttributes is not valid.
EFI_UNSUPPORTEDThe type of reset specified by Attributes is not currently supported by the host controller hardware.
EFI_ACCESS_DENIEDReset operation is rejected due to the debug port being configured and active; only EFI_USB_HC_RESET_GLOBAL_WITH_DEBUG or EFI_USB_HC_RESET_HOST_WITH_DEBUG reset Attributes can be used to perform reset operation for this host controller.
EFI_DEVICE_ERRORAn error was encountered while attempting to retrieve the capabilities.

Definition at line 145 of file Usb2HostController.h.

Retrieves current state of the USB host controller.

Parameters:
ThisA pointer to the EFI_USB2_HC_PROTOCOL instance.
StateA pointer to the EFI_USB_HC_STATE data structure that indicates current state of the USB host controller.
Return values:
EFI_SUCCESSThe state information of the host controller was returned in State.
EFI_INVALID_PARAMETERState is NULL.
EFI_DEVICE_ERRORAn error was encountered while attempting to retrieve the host controller's current state.

Definition at line 200 of file Usb2HostController.h.

Sets the USB host controller to a specific state.

Parameters:
ThisA pointer to the EFI_USB2_HC_PROTOCOL instance.
StateIndicates the state of the host controller that will be set.
Return values:
EFI_SUCCESSThe USB host controller was successfully placed in the state specified by State.
EFI_INVALID_PARAMETERState is not valid.
EFI_DEVICE_ERRORFailed to set the state specified by State due to device error.

Definition at line 219 of file Usb2HostController.h.

typedef EFI_STATUS(EFIAPI * EFI_USB2_HC_PROTOCOL_CONTROL_TRANSFER)(IN EFI_USB2_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 DeviceSpeed, IN UINTN MaximumPacketLength, IN EFI_USB_DEVICE_REQUEST *Request, IN EFI_USB_DATA_DIRECTION TransferDirection, IN OUT VOID *Data OPTIONAL, IN OUT UINTN *DataLength OPTIONAL, IN UINTN TimeOut, IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator, OUT UINT32 *TransferResult)

Submits control transfer to a target USB device.

Parameters:
ThisA pointer to the EFI_USB2_HC_PROTOCOL instance.
DeviceAddressRepresents the address of the target device on the USB.
DeviceSpeedIndicates device speed.
MaximumPacketLengthIndicates the maximum packet size that the default control transfer endpoint is capable of sending or receiving.
RequestA pointer to the USB device request that will be sent to the USB device.
TransferDirectionSpecifies the data direction for the transfer. There are three values available, EfiUsbDataIn, EfiUsbDataOut and EfiUsbNoData.
DataA pointer to the buffer of data that will be transmitted to USB device or received from USB device.
DataLengthOn input, indicates the size, in bytes, of the data buffer specified by Data. On output, indicates the amount of data actually transferred.
TimeOutIndicates the maximum time, in milliseconds, which the transfer is allowed to complete.
TranslatorA pointer to the transaction translator data.
TransferResultA pointer to the detailed result information generated by this control transfer.
Return values:
EFI_SUCCESSThe control transfer was completed successfully.
EFI_INVALID_PARAMETERSome parameters are invalid.
EFI_OUT_OF_RESOURCESThe control transfer could not be completed due to a lack of resources.
EFI_TIMEOUTThe control transfer failed due to timeout.
EFI_DEVICE_ERRORThe control transfer failed due to host controller or device error. Caller should check TransferResult for detailed error information.

Definition at line 255 of file Usb2HostController.h.

typedef EFI_STATUS(EFIAPI * EFI_USB2_HC_PROTOCOL_BULK_TRANSFER)(IN EFI_USB2_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN UINT8 DeviceSpeed, IN UINTN MaximumPacketLength, IN UINT8 DataBuffersNumber, IN OUT VOID *Data[EFI_USB_MAX_BULK_BUFFER_NUM], IN OUT UINTN *DataLength, IN OUT UINT8 *DataToggle, IN UINTN TimeOut, IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator, OUT UINT32 *TransferResult)

Submits bulk transfer to a bulk endpoint of a USB device.

Parameters:
ThisA pointer to the EFI_USB2_HC_PROTOCOL instance.
DeviceAddressRepresents the address of the target device on the USB.
EndPointAddressThe combination of an endpoint number and an endpoint direction of the target USB device.
DeviceSpeedIndicates device speed.
MaximumPacketLengthIndicates the maximum packet size the target endpoint is capable of sending or receiving.
DataBuffersNumberNumber of data buffers prepared for the transfer.
DataArray of pointers to the buffers of data that will be transmitted to USB device or received from USB device.
DataLengthWhen input, indicates the size, in bytes, of the data buffers specified by Data. When output, indicates the actually transferred data size.
DataToggleA pointer to the data toggle value.
TimeOutIndicates the maximum time, in milliseconds, which the transfer is allowed to complete.
TranslatorA pointer to the transaction translator data.
TransferResultA pointer to the detailed result information of the bulk transfer.
Return values:
EFI_SUCCESSThe bulk transfer was completed successfully.
EFI_INVALID_PARAMETERSome parameters are invalid.
EFI_OUT_OF_RESOURCESThe bulk transfer could not be submitted due to a lack of resources.
EFI_TIMEOUTThe bulk transfer failed due to timeout.
EFI_DEVICE_ERRORThe bulk transfer failed due to host controller or device error. Caller should check TransferResult for detailed error information.

Definition at line 302 of file Usb2HostController.h.

typedef EFI_STATUS(EFIAPI * EFI_USB2_HC_PROTOCOL_ASYNC_INTERRUPT_TRANSFER)(IN EFI_USB2_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN UINT8 DeviceSpeed, IN UINTN MaxiumPacketLength, IN BOOLEAN IsNewTransfer, IN OUT UINT8 *DataToggle, IN UINTN PollingInterval OPTIONAL, IN UINTN DataLength OPTIONAL, IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator OPTIONAL, IN EFI_ASYNC_USB_TRANSFER_CALLBACK CallBackFunction OPTIONAL, IN VOID *Context OPTIONAL)

Submits an asynchronous interrupt transfer to an interrupt endpoint of a USB device.

Translator parameter doesn't exist in UEFI2.0 spec, but it will be updated in the following specification version.

Parameters:
ThisA pointer to the EFI_USB2_HC_PROTOCOL instance.
DeviceAddressRepresents the address of the target device on the USB.
EndPointAddressThe combination of an endpoint number and an endpoint direction of the target USB device.
DeviceSpeedIndicates device speed.
MaximumPacketLengthIndicates the maximum packet size the target endpoint is capable of sending or receiving.
IsNewTransferIf TRUE, an asynchronous interrupt pipe is built between the host and the target interrupt endpoint. If FALSE, the specified asynchronous interrupt pipe is canceled. If TRUE, and an interrupt transfer exists for the target end point, then EFI_INVALID_PARAMETER is returned.
DataToggleA pointer to the data toggle value.
PollingIntervalIndicates the interval, in milliseconds, that the asynchronous interrupt transfer is polled.
DataLengthIndicates the length of data to be received at the rate specified by PollingInterval from the target asynchronous interrupt endpoint.
TranslatorA pointr to the transaction translator data.
CallBackFunctionThe Callback function. This function is called at the rate specified by PollingInterval.
ContextThe context that is passed to the CallBackFunction. This is an optional parameter and may be NULL.
Return values:
EFI_SUCCESSThe asynchronous interrupt transfer request has been successfully submitted or canceled.
EFI_INVALID_PARAMETERSome parameters are invalid.
EFI_OUT_OF_RESOURCESThe request could not be completed due to a lack of resources.

Definition at line 351 of file Usb2HostController.h.

typedef EFI_STATUS(EFIAPI * EFI_USB2_HC_PROTOCOL_SYNC_INTERRUPT_TRANSFER)(IN EFI_USB2_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN UINT8 DeviceSpeed, IN UINTN MaximumPacketLength, IN OUT VOID *Data, IN OUT UINTN *DataLength, IN OUT UINT8 *DataToggle, IN UINTN TimeOut, IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator, OUT UINT32 *TransferResult)

Submits synchronous interrupt transfer to an interrupt endpoint of a USB device.

Translator parameter doesn't exist in UEFI2.0 spec, but it will be updated in the following specification version.

Parameters:
ThisA pointer to the EFI_USB2_HC_PROTOCOL instance.
DeviceAddressRepresents the address of the target device on the USB.
EndPointAddressThe combination of an endpoint number and an endpoint direction of the target USB device.
DeviceSpeedIndicates device speed.
MaximumPacketLengthIndicates the maximum packet size the target endpoint is capable of sending or receiving.
DataA pointer to the buffer of data that will be transmitted to USB device or received from USB device.
DataLengthOn input, the size, in bytes, of the data buffer specified by Data. On output, the number of bytes transferred.
DataToggleA pointer to the data toggle value.
TimeOutIndicates the maximum time, in milliseconds, which the transfer is allowed to complete.
TranslatorA pointr to the transaction translator data.
TransferResultA pointer to the detailed result information from the synchronous interrupt transfer.
Return values:
EFI_SUCCESSThe synchronous interrupt transfer was completed successfully.
EFI_INVALID_PARAMETERSome parameters are invalid.
EFI_OUT_OF_RESOURCESThe synchronous interrupt transfer could not be submitted due to a lack of resources.
EFI_TIMEOUTThe synchronous interrupt transfer failed due to timeout.
EFI_DEVICE_ERRORThe synchronous interrupt transfer failed due to host controller or device error. Caller should check TransferResult for detailed error information.

Definition at line 398 of file Usb2HostController.h.

typedef EFI_STATUS(EFIAPI * EFI_USB2_HC_PROTOCOL_ISOCHRONOUS_TRANSFER)(IN EFI_USB2_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN UINT8 DeviceSpeed, IN UINTN MaximumPacketLength, IN UINT8 DataBuffersNumber, IN OUT VOID *Data[EFI_USB_MAX_ISO_BUFFER_NUM], IN UINTN DataLength, IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator, OUT UINT32 *TransferResult)

Submits isochronous transfer to an isochronous endpoint of a USB device.

This function is used to submit isochronous transfer to a target endpoint of a USB device. The target endpoint is specified by DeviceAddressand EndpointAddress. Isochronous transfers are used when working with isochronous date. It provides periodic, continuous communication between the host and a device. Isochronous transfers can beused only by full-speed, high-speed, and super-speed devices.

High-speed isochronous transfers can be performed using multiple data buffers. The number of buffers that are actually prepared for the transfer is specified by DataBuffersNumber. For full-speed isochronous transfers this value is ignored.

Data represents a list of pointers to the data buffers. For full-speed isochronous transfers only the data pointed by Data[0]shall be used. For high-speed isochronous transfers and for the split transactions depending on DataLengththere several data buffers canbe used. For the high-speed isochronous transfers the total number of buffers must not exceed EFI_USB_MAX_ISO_BUFFER_NUM.

For split transactions performed on full-speed device by high-speed host controller the total number of buffers is limited to EFI_USB_MAX_ISO_BUFFER_NUM1. If the isochronous transfer is successful, then EFI_SUCCESSis returned. The isochronous transfer is designed to be completed within one USB frame time, if it cannot be completed, EFI_TIMEOUT is returned. If an error other than timeout occurs during the USB transfer, then EFI_DEVICE_ERROR is returned and the detailed status code will be returned in TransferResult.

EFI_INVALID_PARAMETERis returned if one of the following conditionsis satisfied:

  • Data is NULL.
  • DataLength is 0.
  • DeviceSpeed is not one of the supported values listed above.
  • MaximumPacketLength is invalid. MaximumPacketLength must be 1023 or less for full-speed devices, and 1024 or less for high-speed and super-speed devices.
  • TransferResult is NULL.
Parameters:
ThisA pointer to the EFI_USB2_HC_PROTOCOL instance.
DeviceAddressRepresents the address of the target device on the USB.
EndPointAddressThe combination of an endpoint number and an endpoint direction of the target USB device.
DeviceSpeedIndicates device speed. The supported values are EFI_USB_SPEED_FULL, EFI_USB_SPEED_HIGH, or EFI_USB_SPEED_SUPER.
MaximumPacketLengthIndicates the maximum packet size the target endpoint is capable of sending or receiving.
DataBuffersNumberNumber of data buffers prepared for the transfer.
DataArray of pointers to the buffers of data that will be transmitted to USB device or received from USB device.
DataLengthSpecifies the length, in bytes, of the data to be sent to or received from the USB device.
TranslatorA pointer to the transaction translator data.
TransferResultA pointer to the detailed result information of the isochronous transfer.
Return values:
EFI_SUCCESSThe isochronous transfer was completed successfully.
EFI_INVALID_PARAMETERSome parameters are invalid.
EFI_OUT_OF_RESOURCESThe isochronous transfer could not be submitted due to a lack of resources.
EFI_TIMEOUTThe isochronous transfer cannot be completed within the one USB frame time.
EFI_DEVICE_ERRORThe isochronous transfer failed due to host controller or device error. Caller should check TransferResult for detailed error information.

Definition at line 474 of file Usb2HostController.h.

typedef EFI_STATUS(EFIAPI * EFI_USB2_HC_PROTOCOL_ASYNC_ISOCHRONOUS_TRANSFER)(IN EFI_USB2_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN UINT8 DeviceSpeed, IN UINTN MaximumPacketLength, IN UINT8 DataBuffersNumber, IN OUT VOID *Data[EFI_USB_MAX_ISO_BUFFER_NUM], IN UINTN DataLength, IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator, IN EFI_ASYNC_USB_TRANSFER_CALLBACK IsochronousCallBack, IN VOID *Context OPTIONAL)

Submits nonblocking isochronous transfer to an isochronous endpoint of a USB device.

This is an asynchronous type of USB isochronous transfer. If the caller submits a USB isochronous transfer request through this function, this function will return immediately.

When the isochronous transfer completes, the IsochronousCallbackfunction will be triggered, the caller can know the transfer results. If the transfer is successful, the caller can get the data received or sent in this callback function.

The target endpoint is specified by DeviceAddressand EndpointAddress. Isochronous transfers are used when working with isochronous date. It provides periodic, continuous communication between the host and a device. Isochronous transfers can be used only by full-speed, high-speed, and super-speed devices.

High-speed isochronous transfers can be performed using multiple data buffers. The number of buffers that are actually prepared for the transfer is specified by DataBuffersNumber. For full-speed isochronous transfers this value is ignored.

Data represents a list of pointers to the data buffers. For full-speed isochronous transfers only the data pointed by Data[0] shall be used. For high-speed isochronous transfers and for the split transactions depending on DataLength there several data buffers can be used. For the high-speed isochronous transfers the total number of buffers must not exceed EFI_USB_MAX_ISO_BUFFER_NUM.

For split transactions performed on full-speed device by high-speed host controller the total number of buffers is limited to EFI_USB_MAX_ISO_BUFFER_NUM1.

EFI_INVALID_PARAMETER is returned if one of the following conditionsis satisfied:

  • Data is NULL.
  • DataLength is 0.
  • DeviceSpeed is not one of the supported values listed above.
  • MaximumPacketLength is invalid. MaximumPacketLength must be 1023 or less for full-speed devices and 1024 or less for high-speed and super-speed devices.
Parameters:
ThisA pointer to the EFI_USB2_HC_PROTOCOL instance.
DeviceAddressRepresents the address of the target device on the USB.
EndPointAddressThe combination of an endpoint number and an endpoint direction of the target USB device.
DeviceSpeedIndicates device speed. The supported values are EFI_USB_SPEED_FULL, EFI_USB_SPEED_HIGH, or EFI_USB_SPEED_SUPER.
MaximumPacketLengthIndicates the maximum packet size the target endpoint is capable of sending or receiving.
DataBuffersNumberNumber of data buffers prepared for the transfer.
DataArray of pointers to the buffers of data that will be transmitted to USB device or received from USB device.
DataLengthSpecifies the length, in bytes, of the data to be sent to or received from the USB device.
TranslatorA pointer to the transaction translator data.
IsochronousCallbackThe Callback function. This function is called if the requested isochronous transfer is completed.
ContextData passed to the IsochronousCallback function. This is an optional parameter and may be NULL.
Return values:
EFI_SUCCESSThe asynchronous isochronous transfer request has been successfully submitted or canceled.
EFI_INVALID_PARAMETERSome parameters are invalid.
EFI_OUT_OF_RESOURCESThe asynchronous isochronous transfer could not be submitted due to a lack of resources.

Definition at line 549 of file Usb2HostController.h.

Retrieves the current status of a USB root hub port.

Parameters:
ThisA pointer to the EFI_USB2_HC_PROTOCOL instance.
PortNumberSpecifies the root hub port from which the status is to be retrieved. This value is zero based.
PortStatusA pointer to the current port status bits and port status change bits.
Return values:
EFI_SUCCESSThe status of the USB root hub port specified by PortNumber was returned in PortStatus.
EFI_INVALID_PARAMETERPortNumber is invalid.

Definition at line 578 of file Usb2HostController.h.

Sets a feature for the specified root hub port.

Parameters:
ThisA pointer to the EFI_USB2_HC_PROTOCOL instance.
PortNumberSpecifies the root hub port whose feature is requested to be set. This value is zero based.
PortFeatureIndicates the feature selector associated with the feature set request.
Return values:
EFI_SUCCESSThe feature specified by PortFeature was set for the USB root hub port specified by PortNumber.
EFI_INVALID_PARAMETERPortNumber is invalid or PortFeature is invalid for this function.

Definition at line 599 of file Usb2HostController.h.

Clears a feature for the specified root hub port.

Parameters:
ThisA pointer to the EFI_USB2_HC_PROTOCOL instance.
PortNumberSpecifies the root hub port whose feature is requested to be cleared. This value is zero based.
PortFeatureIndicates the feature selector associated with the feature clear request.
Return values:
EFI_SUCCESSThe feature specified by PortFeature was cleared for the USB root hub port specified by PortNumber.
EFI_INVALID_PARAMETERPortNumber is invalid or PortFeature is invalid for this function.

Definition at line 620 of file Usb2HostController.h.


Enumeration Type Documentation

Usb port features value Each value indicates its bit index in the port status and status change bitmaps, if combines these two bitmaps into a 32-bit bitmap.

Enumerator:
EfiUsbPortEnable 
EfiUsbPortSuspend 
EfiUsbPortReset 
EfiUsbPortPower 
EfiUsbPortOwner 
EfiUsbPortConnectChange 
EfiUsbPortEnableChange 
EfiUsbPortSuspendChange 
EfiUsbPortOverCurrentChange 
EfiUsbPortResetChange 

Definition at line 70 of file Usb2HostController.h.

Enumration value for status of USB HC.

Enumerator:
EfiUsbHcStateHalt 

The host controller is in halt state.

No USB transactions can occur while in this state. The host controller can enter this state for three reasons: 1) After host controller hardware reset. 2) Explicitly set by software. 3) Triggered by a fatal error such as consistency check failure.

EfiUsbHcStateOperational 

The host controller is in an operational state.

When in this state, the host controller can execute bus traffic. This state must be explicitly set to enable the USB bus traffic.

EfiUsbHcStateSuspend 

The host controller is in the suspend state.

No USB transactions can occur while in this state. The host controller enters this state for the following reasons: 1) Explicitly set by software. 2) Triggered when there is no bus traffic for 3 microseconds.

EfiUsbHcStateMaximum 

Maximum value for enumration value of HC status.

Definition at line 153 of file Usb2HostController.h.

             {
  EfiUsbHcStateHalt,                ///< The host controller is in halt
                                    ///< state. No USB transactions can occur
                                    ///< while in this state. The host
                                    ///< controller can enter this state for
                                    ///< three reasons: 1) After host
                                    ///< controller hardware reset. 2)
                                    ///< Explicitly set by software. 3)
                                    ///< Triggered by a fatal error such as
                                    ///< consistency check failure.

  EfiUsbHcStateOperational,         ///< The host controller is in an
                                    ///< operational state. When in
                                    ///< this state, the host
                                    ///< controller can execute bus
                                    ///< traffic. This state must be
                                    ///< explicitly set to enable the
                                    ///< USB bus traffic.

  EfiUsbHcStateSuspend,             ///< The host controller is in the
                                    ///< suspend state. No USB
                                    ///< transactions can occur while in
                                    ///< this state. The host controller
                                    ///< enters this state for the
                                    ///< following reasons: 1) Explicitly
                                    ///< set by software. 2) Triggered
                                    ///< when there is no bus traffic for
                                    ///< 3 microseconds.

  EfiUsbHcStateMaximum              ///< Maximum value for enumration value of HC status.
} EFI_USB_HC_STATE;

Function Documentation

FILE_LICENCE ( BSD3  )

Variable Documentation