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
+ Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+ 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
http://opensource.org/licenses/bsd-license.php \r
direction of the target USB device. Each endpoint address \r
supports data transfer in one direction except the control \r
endpoint (whose default endpoint address is 0). It is the \r
- caller’s responsibility to make sure that the EndPointAddress \r
+ caller's responsibility to make sure that the EndPointAddress \r
represents a bulk endpoint. \r
@param MaximumPacketLength Indicates the maximum packet size that the default control \r
transfer endpoint is capable of sending or receiving. \r
@param This A pointer to the EFI_USB_HC_PROTOCOL instance.\r
@param DeviceAddress Represents the address of the target device on the USB, which is\r
assigned during USB enumeration. \r
- @param EndPointAddress The combination of an endpoint number and an endpoint \r
- direction of the target USB device. Each endpoint address \r
- supports data transfer in one direction except the control \r
- endpoint (whose default endpoint address is 0). It is the \r
- caller’s responsibility to make sure that the EndPointAddress \r
- represents a bulk endpoint. \r
+ @param EndPointAddress The combination of an endpoint number and an endpoint\r
+ direction of the target USB device. Each endpoint address\r
+ supports data transfer in one direction except the control\r
+ endpoint (whose default endpoint address is zero). It is the\r
+ caller's responsibility to make sure that the\r
+ EndPointAddress represents an interrupt endpoint. \r
@param IsSlowDevice Indicates whether the target device is slow device or full-speed\r
device. \r
@param MaximumPacketLength Indicates the maximum packet size that the default control \r
@param This A pointer to the EFI_USB_HC_PROTOCOL instance.\r
@param DeviceAddress Represents the address of the target device on the USB, which is\r
assigned during USB enumeration. \r
- @param EndPointAddress The combination of an endpoint number and an endpoint \r
- direction of the target USB device. Each endpoint address \r
- supports data transfer in one direction except the control \r
- endpoint (whose default endpoint address is 0). It is the \r
- caller’s responsibility to make sure that the EndPointAddress \r
- represents a bulk endpoint. \r
+ @param EndPointAddress The combination of an endpoint number and an endpoint\r
+ direction of the target USB device. Each endpoint address\r
+ supports data transfer in one direction except the control\r
+ endpoint (whose default endpoint address is zero). It is the\r
+ caller's responsibility to make sure that the\r
+ EndPointAddress represents an interrupt endpoint. \r
@param IsSlowDevice Indicates whether the target device is slow device or full-speed\r
device. \r
@param MaximumPacketLength Indicates the maximum packet size that the default control \r
@param This A pointer to the EFI_USB_HC_PROTOCOL instance.\r
@param DeviceAddress Represents the address of the target device on the USB, which is\r
assigned during USB enumeration. \r
- @param EndPointAddress The combination of an endpoint number and an endpoint \r
- direction of the target USB device. Each endpoint address \r
- supports data transfer in one direction except the control \r
- endpoint (whose default endpoint address is 0). It is the \r
- caller’s responsibility to make sure that the EndPointAddress \r
- represents a bulk endpoint. \r
+ @param EndPointAddress The combination of an endpoint number and an endpoint\r
+ direction of the target USB device. Each endpoint address\r
+ supports data transfer in one direction except the control\r
+ endpoint (whose default endpoint address is 0). It is the caller's\r
+ responsibility to make sure that the EndPointAddress\r
+ represents an isochronous endpoint. \r
@param MaximumPacketLength Indicates the maximum packet size that the default control \r
transfer endpoint is capable of sending or receiving. \r
@param Data A pointer to the buffer of data that will be transmitted to USB\r
@param This A pointer to the EFI_USB_HC_PROTOCOL instance.\r
@param DeviceAddress Represents the address of the target device on the USB, which is\r
assigned during USB enumeration. \r
- @param EndPointAddress The combination of an endpoint number and an endpoint \r
- direction of the target USB device. Each endpoint address \r
- supports data transfer in one direction except the control \r
- endpoint (whose default endpoint address is 0). It is the \r
- caller’s responsibility to make sure that the EndPointAddress \r
- represents a bulk endpoint. \r
+ @param EndPointAddress The combination of an endpoint number and an endpoint\r
+ direction of the target USB device. Each endpoint address\r
+ supports data transfer in one direction except the control\r
+ endpoint (whose default endpoint address is zero). It is the\r
+ caller's responsibility to make sure that the\r
+ EndPointAddress represents an isochronous endpoint. \r
@param MaximumPacketLength Indicates the maximum packet size that the default control \r
transfer endpoint is capable of sending or receiving. For isochronous \r
endpoints, this value is used to reserve the bus time in the schedule, \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
+///\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
struct _EFI_USB_HC_PROTOCOL {\r
EFI_USB_HC_PROTOCOL_RESET Reset;\r
EFI_USB_HC_PROTOCOL_GET_STATE GetState;\r
EFI_USB_HC_PROTOCOL_GET_ROOTHUB_PORT_STATUS GetRootHubPortStatus;\r
EFI_USB_HC_PROTOCOL_SET_ROOTHUB_PORT_FEATURE SetRootHubPortFeature;\r
EFI_USB_HC_PROTOCOL_CLEAR_ROOTHUB_PORT_FEATURE ClearRootHubPortFeature;\r
+ ///\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
UINT16 MajorRevision;\r
+ ///\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
UINT16 MinorRevision;\r
};\r
\r
projects / mirror_edk2.git / blobdiff