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

EFI_USB_HC_PROTOCOL as defined in EFI 1.10. More...

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

Go to the source code of this file.

Data Structures

struct  _EFI_USB_HC_PROTOCOL
 The EFI_USB_HC_PROTOCOL provides USB host controller management, basic data transactions over a USB bus, and USB root hub access. More...

Defines

#define EFI_USB_HC_PROTOCOL_GUID

Typedefs

typedef struct _EFI_USB_HC_PROTOCOL EFI_USB_HC_PROTOCOL
 Forward reference for pure ANSI compatability.
typedef EFI_STATUS(EFIAPIEFI_USB_HC_PROTOCOL_RESET )(IN EFI_USB_HC_PROTOCOL *This, IN UINT16 Attributes)
 Provides software reset for the USB host controller.
typedef EFI_STATUS(EFIAPIEFI_USB_HC_PROTOCOL_GET_STATE )(IN EFI_USB_HC_PROTOCOL *This, OUT EFI_USB_HC_STATE *State)
 Retrieves current state of the USB host controller.
typedef EFI_STATUS(EFIAPIEFI_USB_HC_PROTOCOL_SET_STATE )(IN EFI_USB_HC_PROTOCOL *This, IN EFI_USB_HC_STATE State)
 Sets the USB host controller to a specific state.
typedef EFI_STATUS(EFIAPIEFI_USB_HC_PROTOCOL_CONTROL_TRANSFER )(IN EFI_USB_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN BOOLEAN IsSlowDevice, IN UINT8 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, OUT UINT32 *TransferResult)
 Submits control transfer to a target USB device.
typedef EFI_STATUS(EFIAPIEFI_USB_HC_PROTOCOL_BULK_TRANSFER )(IN EFI_USB_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN UINT8 MaximumPacketLength, IN OUT VOID *Data, IN OUT UINTN *DataLength, IN OUT UINT8 *DataToggle, IN UINTN TimeOut, OUT UINT32 *TransferResult)
 Submits bulk transfer to a bulk endpoint of a USB device.
typedef EFI_STATUS(EFIAPIEFI_USB_HC_PROTOCOL_ASYNC_INTERRUPT_TRANSFER )(IN EFI_USB_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN BOOLEAN IsSlowDevice, IN UINT8 MaxiumPacketLength, IN BOOLEAN IsNewTransfer, IN OUT UINT8 *DataToggle, IN UINTN PollingInterval OPTIONAL, IN UINTN DataLength 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_USB_HC_PROTOCOL_SYNC_INTERRUPT_TRANSFER )(IN EFI_USB_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN BOOLEAN IsSlowDevice, IN UINT8 MaximumPacketLength, IN OUT VOID *Data, IN OUT UINTN *DataLength, IN OUT UINT8 *DataToggle, IN UINTN TimeOut, OUT UINT32 *TransferResult)
 Submits synchronous interrupt transfer to an interrupt endpoint of a USB device.
typedef EFI_STATUS(EFIAPIEFI_USB_HC_PROTOCOL_ISOCHRONOUS_TRANSFER )(IN EFI_USB_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN UINT8 MaximumPacketLength, IN OUT VOID *Data, IN UINTN DataLength, OUT UINT32 *TransferResult)
 Submits isochronous transfer to an isochronous endpoint of a USB device.
typedef EFI_STATUS(EFIAPIEFI_USB_HC_PROTOCOL_ASYNC_ISOCHRONOUS_TRANSFER )(IN EFI_USB_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN UINT8 MaximumPacketLength, IN OUT VOID *Data, IN UINTN DataLength, 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_USB_HC_PROTOCOL_GET_ROOTHUB_PORT_NUMBER )(IN EFI_USB_HC_PROTOCOL *This, OUT UINT8 *PortNumber)
 Retrieves the number of root hub ports.
typedef EFI_STATUS(EFIAPIEFI_USB_HC_PROTOCOL_GET_ROOTHUB_PORT_STATUS )(IN EFI_USB_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_USB_HC_PROTOCOL_SET_ROOTHUB_PORT_FEATURE )(IN EFI_USB_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_USB_HC_PROTOCOL_CLEAR_ROOTHUB_PORT_FEATURE )(IN EFI_USB_HC_PROTOCOL *This, IN UINT8 PortNumber, IN EFI_USB_PORT_FEATURE PortFeature)
 Clears a feature for the specified root hub port.

Functions

 FILE_LICENCE (BSD3)

Variables

EFI_GUID gEfiUsbHcProtocolGuid

Detailed Description

EFI_USB_HC_PROTOCOL as defined in EFI 1.10.

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 - 2008, 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 UsbHostController.h.


Define Documentation

Value:
{ \
    0xf5089266, 0x1aa0, 0x4953, {0x97, 0xd8, 0x56, 0x2f, 0x8a, 0x73, 0xb5, 0x19 } \
  }

Definition at line 26 of file UsbHostController.h.


Typedef Documentation

Forward reference for pure ANSI compatability.

Definition at line 34 of file UsbHostController.h.

Provides software reset for the USB host controller.

Parameters:
ThisA pointer to the EFI_USB_HC_PROTOCOL instance.
AttributesA bit mask of the reset operation to perform.
Return values:
EFI_SUCCESSThe reset operation succeeded.
EFI_UNSUPPORTEDThe type of reset specified by Attributes is not currently supported by the host controller hardware.
EFI_INVALID_PARAMETERAttributes is not valid.
EFI_DEVICE_ERRORAn error was encountered while attempting to perform the reset operation.

Definition at line 55 of file UsbHostController.h.

Retrieves current state of the USB host controller.

Parameters:
ThisA pointer to the EFI_USB_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 75 of file UsbHostController.h.

Sets the USB host controller to a specific state.

Parameters:
ThisA pointer to the EFI_USB_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 NULL.
EFI_DEVICE_ERRORFailed to set the state specified by State due to device error.

Definition at line 94 of file UsbHostController.h.

typedef EFI_STATUS(EFIAPI * EFI_USB_HC_PROTOCOL_CONTROL_TRANSFER)(IN EFI_USB_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN BOOLEAN IsSlowDevice, IN UINT8 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, OUT UINT32 *TransferResult)

Submits control transfer to a target USB device.

Parameters:
ThisA pointer to the EFI_USB_HC_PROTOCOL instance.
DeviceAddressRepresents the address of the target device on the USB, which is assigned during USB enumeration.
IsSlowDeviceIndicates whether the target device is slow device or full-speed device.
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.
TransferResultA pointer to the detailed result information generated by this control transfer.
Return values:
EFI_SUCCESSThe control transfer was completed successfully.
EFI_OUT_OF_RESOURCESThe control transfer could not be completed due to a lack of resources.
EFI_INVALID_PARAMETERSome parameters are invalid.
EFI_TIMEOUTThe control transfer failed due to timeout.
EFI_DEVICE_ERRORThe control transfer failed due to host controller or device error.

Definition at line 132 of file UsbHostController.h.

typedef EFI_STATUS(EFIAPI * EFI_USB_HC_PROTOCOL_BULK_TRANSFER)(IN EFI_USB_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN UINT8 MaximumPacketLength, IN OUT VOID *Data, IN OUT UINTN *DataLength, IN OUT UINT8 *DataToggle, IN UINTN TimeOut, OUT UINT32 *TransferResult)

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

Parameters:
ThisA pointer to the EFI_USB_HC_PROTOCOL instance.
DeviceAddressRepresents the address of the target device on the USB, which is assigned during USB enumeration.
EndPointAddressThe combination of an endpoint number and an endpoint direction of the target USB device. Each endpoint address supports data transfer in one direction except the control endpoint (whose default endpoint address is 0). It is the caller's responsibility to make sure that the EndPointAddress represents a bulk endpoint.
MaximumPacketLengthIndicates the maximum packet size that the default control transfer 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, indicates the size, in bytes, of the data buffer specified by Data. On output, indicates the amount of data actually transferred.
DataToggleA pointer to the data toggle value.
TimeOutIndicates the maximum time, in milliseconds, which the transfer is allowed to complete.
TransferResultA pointer to the detailed result information of the bulk transfer.
Return values:
EFI_SUCCESSThe bulk transfer was completed successfully.
EFI_OUT_OF_RESOURCESThe bulk transfer could not be completed due to a lack of resources.
EFI_INVALID_PARAMETERSome parameters are invalid.
EFI_TIMEOUTThe bulk transfer failed due to timeout.
EFI_DEVICE_ERRORThe bulk transfer failed due to host controller or device error.

Definition at line 178 of file UsbHostController.h.

typedef EFI_STATUS(EFIAPI * EFI_USB_HC_PROTOCOL_ASYNC_INTERRUPT_TRANSFER)(IN EFI_USB_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN BOOLEAN IsSlowDevice, IN UINT8 MaxiumPacketLength, IN BOOLEAN IsNewTransfer, IN OUT UINT8 *DataToggle, IN UINTN PollingInterval OPTIONAL, IN UINTN DataLength 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.

Parameters:
ThisA pointer to the EFI_USB_HC_PROTOCOL instance.
DeviceAddressRepresents the address of the target device on the USB, which is assigned during USB enumeration.
EndPointAddressThe combination of an endpoint number and an endpoint direction of the target USB device. Each endpoint address supports data transfer in one direction except the control endpoint (whose default endpoint address is zero). It is the caller's responsibility to make sure that the EndPointAddress represents an interrupt endpoint.
IsSlowDeviceIndicates whether the target device is slow device or full-speed device.
MaximumPacketLengthIndicates the maximum packet size that the default control transfer 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. On input, it is valid when IsNewTransfer is TRUE, and it indicates the initial data toggle value the asynchronous interrupt transfer should adopt. On output, it is valid when IsNewTransfer is FALSE, and it is updated to indicate the data toggle value of the subsequent asynchronous interrupt transfer.
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. This parameter is only required when IsNewTransfer is TRUE.
CallBackFunctionThe Callback function. This function is called at the rate specified by PollingInterval. This parameter is only required when IsNewTransfer is TRUE.
ContextThe context that is passed to the CallBackFunction.
Return values:
EFI_SUCCESSThe asynchronous interrupt transfer request has been successfully submitted or canceled.
EFI_OUT_OF_RESOURCESThe request could not be completed due to a lack of resources.
EFI_INVALID_PARAMETERSome parameters are invalid.
EFI_TIMEOUTThe bulk transfer failed due to timeout.
EFI_DEVICE_ERRORThe bulk transfer failed due to host controller or device error.

Definition at line 234 of file UsbHostController.h.

typedef EFI_STATUS(EFIAPI * EFI_USB_HC_PROTOCOL_SYNC_INTERRUPT_TRANSFER)(IN EFI_USB_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN BOOLEAN IsSlowDevice, IN UINT8 MaximumPacketLength, IN OUT VOID *Data, IN OUT UINTN *DataLength, IN OUT UINT8 *DataToggle, IN UINTN TimeOut, OUT UINT32 *TransferResult)

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

Parameters:
ThisA pointer to the EFI_USB_HC_PROTOCOL instance.
DeviceAddressRepresents the address of the target device on the USB, which is assigned during USB enumeration.
EndPointAddressThe combination of an endpoint number and an endpoint direction of the target USB device. Each endpoint address supports data transfer in one direction except the control endpoint (whose default endpoint address is zero). It is the caller's responsibility to make sure that the EndPointAddress represents an interrupt endpoint.
IsSlowDeviceIndicates whether the target device is slow device or full-speed device.
MaximumPacketLengthIndicates the maximum packet size that the default control transfer 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. asynchronous interrupt pipe is canceled.
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. On input, it indicates the initial data toggle value the synchronous interrupt transfer should adopt; on output, it is updated to indicate the data toggle value of the subsequent synchronous interrupt transfer.
TimeOutIndicates the maximum time, in milliseconds, which the transfer is allowed to complete.
TransferResultA pointer to the detailed result information from the synchronous interrupt transfer.
Return values:
EFI_SUCCESSThe synchronous interrupt transfer was completed successfully.
EFI_OUT_OF_RESOURCESThe request could not be completed due to a lack of resources.
EFI_INVALID_PARAMETERSome parameters are invalid.
EFI_TIMEOUTThe synchronous interrupt transfer failed due to timeout.
EFI_DEVICE_ERRORThe synchronous interrupt transfer failed due to host controller or device error.

Definition at line 286 of file UsbHostController.h.

typedef EFI_STATUS(EFIAPI * EFI_USB_HC_PROTOCOL_ISOCHRONOUS_TRANSFER)(IN EFI_USB_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN UINT8 MaximumPacketLength, IN OUT VOID *Data, IN UINTN DataLength, OUT UINT32 *TransferResult)

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

Parameters:
ThisA pointer to the EFI_USB_HC_PROTOCOL instance.
DeviceAddressRepresents the address of the target device on the USB, which is assigned during USB enumeration.
EndPointAddressThe combination of an endpoint number and an endpoint direction of the target USB device. Each endpoint address supports data transfer in one direction except the control endpoint (whose default endpoint address is 0). It is the caller's responsibility to make sure that the EndPointAddress represents an isochronous endpoint.
MaximumPacketLengthIndicates the maximum packet size that the default control transfer 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. asynchronous interrupt pipe is canceled.
DataLengthSpecifies the length, in bytes, of the data to be sent to or received from the USB device.
TransferResultA pointer to the detailed result information from the isochronous transfer.
Return values:
EFI_SUCCESSThe isochronous transfer was completed successfully.
EFI_OUT_OF_RESOURCESThe isochronous could not be completed due to a lack of resources.
EFI_INVALID_PARAMETERSome parameters are invalid.
EFI_TIMEOUTThe isochronous transfer failed due to timeout.
EFI_DEVICE_ERRORThe isochronous transfer failed due to host controller or device error.

Definition at line 329 of file UsbHostController.h.

typedef EFI_STATUS(EFIAPI * EFI_USB_HC_PROTOCOL_ASYNC_ISOCHRONOUS_TRANSFER)(IN EFI_USB_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN UINT8 MaximumPacketLength, IN OUT VOID *Data, IN UINTN DataLength, IN EFI_ASYNC_USB_TRANSFER_CALLBACK IsochronousCallBack, IN VOID *Context OPTIONAL)

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

Parameters:
ThisA pointer to the EFI_USB_HC_PROTOCOL instance.
DeviceAddressRepresents the address of the target device on the USB, which is assigned during USB enumeration.
EndPointAddressThe combination of an endpoint number and an endpoint direction of the target USB device. Each endpoint address supports data transfer in one direction except the control endpoint (whose default endpoint address is zero). It is the caller's responsibility to make sure that the EndPointAddress represents an isochronous endpoint.
MaximumPacketLengthIndicates the maximum packet size that the default control transfer endpoint is capable of sending or receiving. For isochronous endpoints, this value is used to reserve the bus time in the schedule, required for the perframe data payloads. The pipe may, on an ongoing basis, actually use less bandwidth than that reserved.
DataA pointer to the buffer of data that will be transmitted to USB device or received from USB device. asynchronous interrupt pipe is canceled.
DataLengthSpecifies the length, in bytes, of the data to be sent to or received from the USB device.
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 was completed successfully.
EFI_OUT_OF_RESOURCESThe asynchronous isochronous could not be completed due to a lack of resources.
EFI_INVALID_PARAMETERSome parameters are invalid.

Definition at line 372 of file UsbHostController.h.

Retrieves the number of root hub ports.

Parameters:
ThisA pointer to the EFI_USB_HC_PROTOCOL instance.
PortNumberA pointer to the number of the root hub ports.
Return values:
EFI_SUCCESSThe port number was retrieved successfully.
EFI_DEVICE_ERRORAn error was encountered while attempting to retrieve the port number.
EFI_INVALID_PARAMETERPortNumber is NULL.

Definition at line 396 of file UsbHostController.h.

Retrieves the current status of a USB root hub port.

Parameters:
ThisA pointer to the EFI_USB_HC_PROTOCOL instance.
PortNumberSpecifies the root hub port from which the status is to be retrieved. This value is zero based. For example, if a root hub has two ports, then the first port is numbered 0, and the second port is numbered 1.
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 418 of file UsbHostController.h.

Sets a feature for the specified root hub port.

Parameters:
ThisA pointer to the EFI_USB_HC_PROTOCOL instance.
PortNumberSpecifies the root hub port from which the status is to be retrieved. This value is zero based. For example, if a root hub has two ports, then the first port is numbered 0, and the second port is numbered 1.
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 442 of file UsbHostController.h.

Clears a feature for the specified root hub port.

Parameters:
ThisA pointer to the EFI_USB_HC_PROTOCOL instance.
PortNumberSpecifies the root hub port from which the status is to be retrieved. This value is zero based. For example, if a root hub has two ports, then the first port is numbered 0, and the second port is numbered 1.
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 466 of file UsbHostController.h.


Function Documentation

FILE_LICENCE ( BSD3  )

Variable Documentation