MdePkg/Include/Protocol/UsbHostController.h File Reference


Data Structures

struct  _EFI_USB_HC_PROTOCOL

Defines

#define EFI_USB_HC_PROTOCOL_GUID

Typedefs

typedef struct _EFI_USB_HC_PROTOCOL EFI_USB_HC_PROTOCOL
typedef EFI_STATUS(EFIAPIEFI_USB_HC_PROTOCOL_RESET )(IN EFI_USB_HC_PROTOCOL *This, IN UINT16 Attributes)
typedef EFI_STATUS(EFIAPIEFI_USB_HC_PROTOCOL_GET_STATE )(IN EFI_USB_HC_PROTOCOL *This, OUT EFI_USB_HC_STATE *State)
typedef EFI_STATUS(EFIAPIEFI_USB_HC_PROTOCOL_SET_STATE )(IN EFI_USB_HC_PROTOCOL *This, IN EFI_USB_HC_STATE 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, IN OUT UINTN *DataLength, IN UINTN TimeOut, OUT UINT32 *TransferResult)
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)
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, IN UINTN DataLength, IN EFI_ASYNC_USB_TRANSFER_CALLBACK CallBackFunction, IN VOID *Context)
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)
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)
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)
typedef EFI_STATUS(EFIAPIEFI_USB_HC_PROTOCOL_GET_ROOTHUB_PORT_NUMBER )(IN EFI_USB_HC_PROTOCOL *This, OUT UINT8 *PortNumber)
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)
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)
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)

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.


Define Documentation

#define EFI_USB_HC_PROTOCOL_GUID

Value:

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


Typedef Documentation

Forward reference for pure ANSI compatability

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, IN UINTN DataLength, IN EFI_ASYNC_USB_TRANSFER_CALLBACK CallBackFunction, IN VOID *Context)

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

Parameters:
This A pointer to the EFI_USB_HC_PROTOCOL instance.
DeviceAddress Represents the address of the target device on the USB, which is assigned during USB enumeration.
EndPointAddress The 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.
IsSlowDevice Indicates whether the target device is slow device or full-speed device.
MaximumPacketLength Indicates the maximum packet size that the default control transfer endpoint is capable of sending or receiving.
IsNewTransfer If 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.
DataToggle A 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.
PollingInterval Indicates the interval, in milliseconds, that the asynchronous interrupt transfer is polled.
DataLength Indicates 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.
CallBackFunction The Callback function. This function is called at the rate specified by PollingInterval. This parameter is only required when IsNewTransfer is TRUE.
Context The context that is passed to the CallBackFunction.
Return values:
EFI_SUCCESS The asynchronous interrupt transfer request has been successfully submitted or canceled.
EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
EFI_INVALID_PARAMETER Some parameters are invalid.
EFI_TIMEOUT The bulk transfer failed due to timeout.
EFI_DEVICE_ERROR The bulk transfer failed due to host controller or device error.

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)

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

Parameters:
This A pointer to the EFI_USB_HC_PROTOCOL instance.
DeviceAddress Represents the address of the target device on the USB, which is assigned during USB enumeration.
EndPointAddress The 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.
MaximumPacketLength Indicates 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.
Data A pointer to the buffer of data that will be transmitted to USB device or received from USB device. asynchronous interrupt pipe is canceled.
DataLength Specifies the length, in bytes, of the data to be sent to or received from the USB device.
IsochronousCallback The Callback function.This function is called if the requested isochronous transfer is completed.
Context Data passed to the IsochronousCallback function. This is an optional parameter and may be NULL.
Return values:
EFI_SUCCESS The asynchronous isochronous transfer was completed successfully.
EFI_OUT_OF_RESOURCES The asynchronous isochronous could not be completed due to a lack of resources.
EFI_INVALID_PARAMETER Some parameters are invalid.

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:
This A pointer to the EFI_USB_HC_PROTOCOL instance.
DeviceAddress Represents the address of the target device on the USB, which is assigned during USB enumeration.
EndPointAddress The 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.
MaximumPacketLength Indicates the maximum packet size that the default control transfer endpoint is capable of sending or receiving.
Data A pointer to the buffer of data that will be transmitted to USB device or received from USB device.
DataLength On input, indicates the size, in bytes, of the data buffer specified by Data. On output, indicates the amount of data actually transferred.
DataToggle A pointer to the data toggle value.
TimeOut Indicates the maximum time, in milliseconds, which the transfer is allowed to complete.
TransferResult A pointer to the detailed result information of the bulk transfer.
Return values:
EFI_SUCCESS The bulk transfer was completed successfully.
EFI_OUT_OF_RESOURCES The bulk transfer could not be completed due to a lack of resources.
EFI_INVALID_PARAMETER Some parameters are invalid.
EFI_TIMEOUT The bulk transfer failed due to timeout.
EFI_DEVICE_ERROR The bulk transfer failed due to host controller or device error.

Clears a feature for the specified root hub port.

Parameters:
This A pointer to the EFI_USB_HC_PROTOCOL instance.
PortNumber Specifies 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.
PortFeature Indicates the feature selector associated with the feature clear request.
Return values:
EFI_SUCCESS The feature specified by PortFeature was cleared for the USB root hub port specified by PortNumber.
EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid for this function.

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, IN OUT UINTN *DataLength, IN UINTN TimeOut, OUT UINT32 *TransferResult)

Submits control transfer to a target USB device.

Parameters:
This A pointer to the EFI_USB_HC_PROTOCOL instance.
DeviceAddress Represents the address of the target device on the USB, which is assigned during USB enumeration.
IsSlowDevice Indicates whether the target device is slow device or full-speed device.
MaximumPacketLength Indicates the maximum packet size that the default control transfer endpoint is capable of sending or receiving.
Request A pointer to the USB device request that will be sent to the USB device.
TransferDirection Specifies the data direction for the transfer. There are three values available, EfiUsbDataIn, EfiUsbDataOut and EfiUsbNoData.
Data A pointer to the buffer of data that will be transmitted to USB device or received from USB device.
DataLength On input, indicates the size, in bytes, of the data buffer specified by Data. On output, indicates the amount of data actually transferred.
TimeOut Indicates the maximum time, in milliseconds, which the transfer is allowed to complete.
TransferResult A pointer to the detailed result information generated by this control transfer.
Return values:
EFI_SUCCESS The control transfer was completed successfully.
EFI_OUT_OF_RESOURCES The control transfer could not be completed due to a lack of resources.
EFI_INVALID_PARAMETER Some parameters are invalid.
EFI_TIMEOUT The control transfer failed due to timeout.
EFI_DEVICE_ERROR The control transfer failed due to host controller or device error.

Retrieves the number of root hub ports.

Parameters:
This A pointer to the EFI_USB_HC_PROTOCOL instance.
PortNumber A pointer to the number of the root hub ports.
Return values:
EFI_SUCCESS The port number was retrieved successfully.
EFI_DEVICE_ERROR An error was encountered while attempting to retrieve the port number.
EFI_INVALID_PARAMETER PortNumber is NULL.

typedef EFI_STATUS(EFIAPI * EFI_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.

Parameters:
This A pointer to the EFI_USB_HC_PROTOCOL instance.
PortNumber Specifies 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.
PortStatus A pointer to the current port status bits and port status change bits.
Return values:
EFI_SUCCESS The status of the USB root hub port specified by PortNumber was returned in PortStatus.
EFI_INVALID_PARAMETER PortNumber is invalid.

Retrieves current state of the USB host controller.

Parameters:
This A pointer to the EFI_USB_HC_PROTOCOL instance.
State A pointer to the EFI_USB_HC_STATE data structure that indicates current state of the USB host controller.
Return values:
EFI_SUCCESS The state information of the host controller was returned in State.
EFI_INVALID_PARAMETER State is NULL.
EFI_DEVICE_ERROR An error was encountered while attempting to retrieve the host controller's current state.

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:
This A pointer to the EFI_USB_HC_PROTOCOL instance.
DeviceAddress Represents the address of the target device on the USB, which is assigned during USB enumeration.
EndPointAddress The 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.
MaximumPacketLength Indicates the maximum packet size that the default control transfer endpoint is capable of sending or receiving.
Data A pointer to the buffer of data that will be transmitted to USB device or received from USB device. asynchronous interrupt pipe is canceled.
DataLength Specifies the length, in bytes, of the data to be sent to or received from the USB device.
TransferResult A pointer to the detailed result information from the isochronous transfer.
Return values:
EFI_SUCCESS The isochronous transfer was completed successfully.
EFI_OUT_OF_RESOURCES The isochronous could not be completed due to a lack of resources.
EFI_INVALID_PARAMETER Some parameters are invalid.
EFI_TIMEOUT The isochronous transfer failed due to timeout.
EFI_DEVICE_ERROR The isochronous transfer failed due to host controller or device error.

typedef EFI_STATUS(EFIAPI * EFI_USB_HC_PROTOCOL_RESET)(IN EFI_USB_HC_PROTOCOL *This, IN UINT16 Attributes)

Provides software reset for the USB host controller.

Parameters:
This A pointer to the EFI_USB_HC_PROTOCOL instance.
Attributes A bit mask of the reset operation to perform.
Return values:
EFI_SUCCESS The reset operation succeeded.
EFI_UNSUPPORTED The type of reset specified by Attributes is not currently supported by the host controller hardware.
EFI_INVALID_PARAMETER Attributes is not valid.
EFI_DEVICE_ERROR An error was encountered while attempting to perform the reset operation.

Sets a feature for the specified root hub port.

Parameters:
This A pointer to the EFI_USB_HC_PROTOCOL instance.
PortNumber Specifies 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.
PortFeature Indicates the feature selector associated with the feature set request.
Return values:
EFI_SUCCESS The feature specified by PortFeature was set for the USB root hub port specified by PortNumber.
EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid for this function.

Sets the USB host controller to a specific state.

Parameters:
This A pointer to the EFI_USB_HC_PROTOCOL instance.
State Indicates the state of the host controller that will be set.
Return values:
EFI_SUCCESS The USB host controller was successfully placed in the state specified by State.
EFI_INVALID_PARAMETER State is NULL.
EFI_DEVICE_ERROR Failed to set the state specified by State due to device error.

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:
This A pointer to the EFI_USB_HC_PROTOCOL instance.
DeviceAddress Represents the address of the target device on the USB, which is assigned during USB enumeration.
EndPointAddress The 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.
IsSlowDevice Indicates whether the target device is slow device or full-speed device.
MaximumPacketLength Indicates the maximum packet size that the default control transfer endpoint is capable of sending or receiving.
Data A pointer to the buffer of data that will be transmitted to USB device or received from USB device. asynchronous interrupt pipe is canceled.
DataLength On input, the size, in bytes, of the data buffer specified by Data. On output, the number of bytes transferred.
DataToggle A 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.
TimeOut Indicates the maximum time, in milliseconds, which the transfer is allowed to complete.
TransferResult A pointer to the detailed result information from the synchronous interrupt transfer.
Return values:
EFI_SUCCESS The synchronous interrupt transfer was completed successfully.
EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
EFI_INVALID_PARAMETER Some parameters are invalid.
EFI_TIMEOUT The synchronous interrupt transfer failed due to timeout.
EFI_DEVICE_ERROR The synchronous interrupt transfer failed due to host controller or device error.


Variable Documentation


Generated on Thu Sep 24 23:14:21 2015 for MdePkg[ALL] by  doxygen 1.5.7.1