/** @file\r
EFI_USB2_HC_PROTOCOL as defined in UEFI 2.0.\r
+ The USB Host Controller Protocol is used by code, typically USB bus drivers, \r
+ running in the EFI boot services environment, to perform data transactions over \r
+ a USB bus. In addition, it provides an abstraction for the root hub of the USB bus.\r
\r
Copyright (c) 2006, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
\r
/**\r
\r
- @param EfiUsbHcStateHalt The host controller is in halt\r
- state. No USB transactions can occur\r
- while in this state. The host\r
- controller can enter this state for\r
- three reasons: 1) After host\r
- controller hardware reset. 2)\r
- Explicitly set by software. 3)\r
- Triggered by a fatal error such as\r
- consistency check failure.\r
+ @param EfiUsbHcStateHalt The host controller is in halt\r
+ state. No USB transactions can occur\r
+ while in this state. The host\r
+ controller can enter this state for\r
+ three reasons: 1) After host\r
+ controller hardware reset. 2)\r
+ Explicitly set by software. 3)\r
+ Triggered by a fatal error such as\r
+ consistency check failure.\r
\r
\r
@param EfiUsbHcStateOperational The host controller is in an\r
USB bus traffic.\r
\r
\r
- @param EfiUsbHcStateSuspend The host controller is in the\r
- suspend state. No USB\r
- transactions can occur while in\r
- this state. The host controller\r
- enters this state for the\r
- following reasons: 1) Explicitly\r
- set by software. 2) Triggered\r
- when there is no bus traffic for\r
- 3 microseconds.\r
+ @param EfiUsbHcStateSuspend The host controller is in the\r
+ suspend state. No USB\r
+ transactions can occur while in\r
+ this state. The host controller\r
+ enters this state for the\r
+ following reasons: 1) Explicitly\r
+ set by software. 2) Triggered\r
+ when there is no bus traffic for\r
+ 3 microseconds.\r
\r
**/\r
typedef enum {\r
received from USB device.\r
@param DataLength On input, indicates the size, in bytes, of the data buffer specified by Data.\r
On output, indicates the amount of data actually transferred.\r
- @param Translator A pointer to the transaction translator data.\r
@param TimeOut Indicates the maximum time, in milliseconds, which the transfer is\r
allowed to complete.\r
+ @param Translator A pointer to the transaction translator data.\r
@param TransferResult A pointer to the detailed result information generated by this control\r
transfer.\r
\r
@param DataLength When input, indicates the size, in bytes, of the data buffers specified by\r
Data. When output, indicates the actually transferred data size.\r
@param DataToggle A pointer to the data toggle value.\r
- @param Translator A pointer to the transaction translator data.\r
@param TimeOut Indicates the maximum time, in milliseconds, which the transfer is\r
allowed to complete.\r
+ @param Translator A pointer to the transaction translator data.\r
@param TransferResult A pointer to the detailed result information of the bulk transfer.\r
\r
@retval EFI_SUCCESS The bulk transfer was completed successfully.\r
)\r
;\r
\r
+/** \r
+ @par Protocol Description:\r
+ The EFI_USB2_HC_PROTOCOL provides USB host controller management, basic \r
+ data transactions over a USB bus, and USB root hub access. A device driver \r
+ that wishes to manage a USB bus in a system retrieves the EFI_USB2_HC_PROTOCOL \r
+ instance that is associated with the USB bus to be managed. A device handle \r
+ for a USB host controller will minimally contain an EFI_DEVICE_PATH_PROTOCOL \r
+ instance, and an EFI_USB2_HC_PROTOCOL instance.\r
+\r
+ @param GetCapability\r
+ Retrieves the capabilities of the USB host controller. \r
+\r
+ @param Reset\r
+ Software reset of USB. \r
+\r
+ @param GetState\r
+ Retrieves the current state of the USB host controller. \r
+\r
+ @param SetState\r
+ Sets the USB host controller to a specific state. \r
+\r
+ @param ControlTransfer\r
+ Submits a control transfer to a target USB device. \r
+\r
+ @param BulkTransfer\r
+ Submits a bulk transfer to a bulk endpoint of a USB device. \r
+\r
+ @param AsyncInterruptTransfer\r
+ Submits an asynchronous interrupt transfer to an interrupt endpoint of a USB device. \r
+\r
+ @param SyncInterruptTransfer\r
+ Submits a synchronous interrupt transfer to an interrupt endpoint of a USB device. \r
+\r
+ @param IsochronousTransfer\r
+ Submits isochronous transfer to an isochronous endpoint of a USB device. \r
+\r
+ @param AsyncIsochronousTransfer\r
+ Submits nonblocking USB isochronous transfer. \r
+\r
+ @param GetRootHubPortStatus\r
+ Retrieves the status of the specified root hub port. \r
+\r
+ @param SetRootHubPortFeature\r
+ Sets the feature for the specified root hub port. \r
+\r
+ @param ClearRootHubPortFeature\r
+ Clears the feature for the specified root hub port. \r
+\r
+ @param MajorRevision\r
+ The major revision number of the USB host controller. The revision information \r
+ indicates the release of the Universal Serial Bus Specification with which the \r
+ host controller is compliant.\r
+\r
+ @param MinorRevision\r
+ The minor revision number of the USB host controller. The revision information \r
+ indicates the release of the Universal Serial Bus Specification with which the \r
+ host controller is compliant.\r
+**/\r
struct _EFI_USB2_HC_PROTOCOL {\r
EFI_USB2_HC_PROTOCOL_GET_CAPABILITY GetCapability;\r
EFI_USB2_HC_PROTOCOL_RESET Reset;\r