/** @file\r
EFI_USB_HC_PROTOCOL as defined in EFI 1.10.\r
\r
- Copyright (c) 2006, Intel Corporation \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 \r
+ over a USB bus. In addition, it provides an abstraction for the root hub of the USB bus.\r
+\r
+ Copyright (c) 2006 - 2008, Intel Corporation \r
All rights reserved. This program and the accompanying materials \r
are licensed and made available under the terms and conditions of the BSD License \r
which accompanies this distribution. The full text of the license may be found at \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
\r
- Module Name: UsbHostController.h\r
-\r
**/\r
\r
#ifndef _USB_HOSTCONTROLLER_H_\r
#define _USB_HOSTCONTROLLER_H_\r
\r
+#include <Protocol/Usb2HostController.h>\r
+\r
#define EFI_USB_HC_PROTOCOL_GUID \\r
{ \\r
0xf5089266, 0x1aa0, 0x4953, {0x97, 0xd8, 0x56, 0x2f, 0x8a, 0x73, 0xb5, 0x19 } \\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_USB_HC_PROTOCOL_RESET) (\r
+(EFIAPI *EFI_USB_HC_PROTOCOL_RESET)(\r
IN EFI_USB_HC_PROTOCOL *This,\r
IN UINT16 Attributes\r
);\r
\r
@retval EFI_SUCCESS The state information of the host controller was returned in State.\r
@retval EFI_INVALID_PARAMETER State is NULL.\r
- @retval EFI_DEVICE_ERROR An error was encountered while attempting to retrieve the host controller¡¯s\r
+ @retval EFI_DEVICE_ERROR An error was encountered while attempting to retrieve the host controller's\r
current state. \r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_USB_HC_PROTOCOL_GET_STATE) (\r
+(EFIAPI *EFI_USB_HC_PROTOCOL_GET_STATE)(\r
IN EFI_USB_HC_PROTOCOL *This,\r
OUT EFI_USB_HC_STATE *State\r
);\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_USB_HC_PROTOCOL_SET_STATE) (\r
+(EFIAPI *EFI_USB_HC_PROTOCOL_SET_STATE)(\r
IN EFI_USB_HC_PROTOCOL *This,\r
IN EFI_USB_HC_STATE State\r
);\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_USB_HC_PROTOCOL_CONTROL_TRANSFER) (\r
+(EFIAPI *EFI_USB_HC_PROTOCOL_CONTROL_TRANSFER)(\r
IN EFI_USB_HC_PROTOCOL *This,\r
IN UINT8 DeviceAddress,\r
IN BOOLEAN IsSlowDevice,\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_USB_HC_PROTOCOL_BULK_TRANSFER) (\r
+(EFIAPI *EFI_USB_HC_PROTOCOL_BULK_TRANSFER)(\r
IN EFI_USB_HC_PROTOCOL *This,\r
IN UINT8 DeviceAddress,\r
IN UINT8 EndPointAddress,\r
transfer endpoint is capable of sending or receiving. \r
@param IsNewTransfer If TRUE, an asynchronous interrupt pipe is built between the host \r
and the target interrupt endpoint. If FALSE, the specified \r
- \r
@param DataToggle A pointer to the data toggle value. \r
@param PollingInterval Indicates the interval, in milliseconds, that the asynchronous\r
interrupt transfer is polled. asynchronous interrupt pipe is canceled. \r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_USB_HC_PROTOCOL_ASYNC_INTERRUPT_TRANSFER) (\r
+(EFIAPI *EFI_USB_HC_PROTOCOL_ASYNC_INTERRUPT_TRANSFER)(\r
IN EFI_USB_HC_PROTOCOL *This,\r
IN UINT8 DeviceAddress,\r
IN UINT8 EndPointAddress,\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_USB_HC_PROTOCOL_SYNC_INTERRUPT_TRANSFER) (\r
+(EFIAPI *EFI_USB_HC_PROTOCOL_SYNC_INTERRUPT_TRANSFER)(\r
IN EFI_USB_HC_PROTOCOL *This,\r
IN UINT8 DeviceAddress,\r
IN UINT8 EndPointAddress,\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_USB_HC_PROTOCOL_ISOCHRONOUS_TRANSFER) (\r
+(EFIAPI *EFI_USB_HC_PROTOCOL_ISOCHRONOUS_TRANSFER)(\r
IN EFI_USB_HC_PROTOCOL *This,\r
IN UINT8 DeviceAddress,\r
IN UINT8 EndPointAddress,\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_USB_HC_PROTOCOL_ASYNC_ISOCHRONOUS_TRANSFER) (\r
+(EFIAPI *EFI_USB_HC_PROTOCOL_ASYNC_ISOCHRONOUS_TRANSFER)(\r
IN EFI_USB_HC_PROTOCOL *This,\r
IN UINT8 DeviceAddress,\r
IN UINT8 EndPointAddress,\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_USB_HC_PROTOCOL_GET_ROOTHUB_PORT_NUMBER) (\r
+(EFIAPI *EFI_USB_HC_PROTOCOL_GET_ROOTHUB_PORT_NUMBER)(\r
IN EFI_USB_HC_PROTOCOL *This,\r
OUT UINT8 *PortNumber\r
);\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_USB_HC_PROTOCOL_GET_ROOTHUB_PORT_STATUS) (\r
+(EFIAPI *EFI_USB_HC_PROTOCOL_GET_ROOTHUB_PORT_STATUS)(\r
IN EFI_USB_HC_PROTOCOL *This,\r
IN UINT8 PortNumber,\r
OUT EFI_USB_PORT_STATUS *PortStatus\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_USB_HC_PROTOCOL_SET_ROOTHUB_PORT_FEATURE) (\r
+(EFIAPI *EFI_USB_HC_PROTOCOL_SET_ROOTHUB_PORT_FEATURE)(\r
IN EFI_USB_HC_PROTOCOL *This,\r
IN UINT8 PortNumber,\r
IN EFI_USB_PORT_FEATURE PortFeature\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_USB_HC_PROTOCOL_CLEAR_ROOTHUB_PORT_FEATURE) (\r
+(EFIAPI *EFI_USB_HC_PROTOCOL_CLEAR_ROOTHUB_PORT_FEATURE)(\r
IN EFI_USB_HC_PROTOCOL *This,\r
IN UINT8 PortNumber,\r
IN EFI_USB_PORT_FEATURE PortFeature\r
);\r
\r
+\r
+/** \r
+ @par Protocol Description:\r
+ The EFI_USB_HC_PROTOCOL provides USB host controller management, basic data transactions\r
+ over a USB bus, and USB root hub access. A device driver that wishes to manage a USB bus in a\r
+ system retrieves the EFI_USB_HC_PROTOCOL instance that is associated with the USB bus to be\r
+ managed. A device handle for a USB host controller will minimally contain an\r
+ EFI_DEVICE_PATH_PROTOCOL instance, and an EFI_USB_HC_PROTOCOL instance. \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\r
+ of a USB device. \r
+\r
+ @param SyncInterruptTransfer\r
+ Submits a synchronous interrupt transfer to an interrupt endpoint\r
+ 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 GetRootHubPortNumber \r
+ Retrieves the number of root hub ports that are produced by the\r
+ USB host controller. \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\r
+ revision information indicates the release of the Universal Serial\r
+ Bus Specification with which the host controller is compliant.\r
+\r
+ @param MinorRevision \r
+ The minor revision number of the USB host controller. The\r
+ revision information indicates the release of the Universal Serial\r
+ Bus Specification with which the host controller is compliant.\r
+ \r
+**/\r
struct _EFI_USB_HC_PROTOCOL {\r
EFI_USB_HC_PROTOCOL_RESET Reset;\r
EFI_USB_HC_PROTOCOL_GET_STATE GetState;\r
projects / mirror_edk2.git / blobdiff