transfer endpoint is capable of sending or receiving. \r
@param Request A pointer to the USB device request that will be sent to the USB\r
device.\r
- @param TransferDirection Specifies the data direction for the transfer. \r
+ @param TransferDirection Specifies the data direction for the transfer. There are three \r
+ values available, EfiUsbDataIn, EfiUsbDataOut and EfiUsbNoData.\r
@param Data A pointer to the buffer of data that will be transmitted to USB \r
device or received from USB device. \r
@param DataLength On input, indicates the size, in bytes, of the data buffer specified\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. \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 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. \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 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
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
- @param DataToggle A pointer to the data toggle value. \r
+ and the target interrupt endpoint. If FALSE, the specified asynchronous \r
+ interrupt pipe is canceled. If TRUE, and an interrupt transfer exists \r
+ for the target end point, then EFI_INVALID_PARAMETER is returned. \r
+ @param DataToggle A pointer to the data toggle value. On input, it is valid when \r
+ IsNewTransfer is TRUE, and it indicates the initial data toggle \r
+ value the asynchronous interrupt transfer should adopt. On output, \r
+ it is valid when IsNewTransfer is FALSE, and it is updated to indicate \r
+ the data toggle value of the subsequent asynchronous interrupt transfer. \r
@param PollingInterval Indicates the interval, in milliseconds, that the asynchronous\r
- interrupt transfer is polled. asynchronous interrupt pipe is canceled. \r
+ interrupt transfer is polled. \r
@param DataLength Indicates the length of data to be received at the rate specified by\r
PollingInterval from the target asynchronous interrupt \r
- endpoint. \r
- @param CallBackFunction The Callback function. \r
+ endpoint. This parameter is only required when IsNewTransfer is TRUE. \r
+ @param CallBackFunction The Callback function. This function is called at the rate specified by \r
+ PollingInterval. This parameter is only required when IsNewTransfer is TRUE. \r
@param Context The context that is passed to the CallBackFunction.\r
\r
@retval EFI_SUCCESS The asynchronous interrupt transfer request has been successfully\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. \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 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
device or received from USB device. asynchronous interrupt pipe is canceled. \r
@param DataLength On input, the size, in bytes, of the data buffer specified by Data.\r
On output, the number of bytes transferred. \r
- @param DataToggle A pointer to the data toggle value. \r
+ @param DataToggle A pointer to the data toggle value. On input, it indicates the initial \r
+ data toggle value the synchronous interrupt transfer should adopt; \r
+ on output, it is updated to indicate the data toggle value of the \r
+ subsequent synchronous interrupt transfer. \r
@param TimeOut Indicates the maximum time, in milliseconds, which the transfer \r
is allowed to complete. \r
@param TransferResult A pointer to the detailed result information from the synchronous\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. \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 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. \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 MaximumPacketLength Indicates the maximum packet size that the default control \r
- transfer endpoint is capable of sending or receiving. \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
+ required for the perframe data payloads. The pipe may, on an ongoing basis,\r
+ actually use less bandwidth than that reserved. \r
@param Data A pointer to the buffer of data that will be transmitted to USB\r
device or received from USB device. asynchronous interrupt pipe is canceled. \r
@param DataLength Specifies the length, in bytes, of the data to be sent to or received\r
from the USB device. \r
- @param IsochronousCallback The Callback function.\r
+ @param IsochronousCallback The Callback function.This function is called if the requested\r
+ isochronous transfer is completed.\r
@param Context Data passed to the IsochronousCallback function. This is\r
an optional parameter and may be NULL.\r
\r
\r
@param This A pointer to the EFI_USB_HC_PROTOCOL instance.\r
@param PortNumber Specifies the root hub port from which the status is to be retrieved.\r
- This value is zero based.\r
+ This value is zero based. For example, if a root hub has two ports,\r
+ then the first port is numbered 0, and the second port is\r
+ numbered 1.\r
@param PortStatus A pointer to the current port status bits and port status change bits. \r
\r
@retval EFI_SUCCESS The status of the USB root hub port specified by PortNumber\r
\r
@param This A pointer to the EFI_USB_HC_PROTOCOL instance.\r
@param PortNumber Specifies the root hub port from which the status is to be retrieved.\r
- This value is zero based.\r
+ This value is zero based. For example, if a root hub has two ports,\r
+ then the first port is numbered 0, and the second port is\r
+ numbered 1.\r
@param PortFeature Indicates the feature selector associated with the feature set\r
request.\r
\r
Clears a feature for the specified root hub port.\r
\r
@param This A pointer to the EFI_USB_HC_PROTOCOL instance.\r
- @param PortNumber Specifies the root hub port from which the status is to be cleared.\r
- This value is zero based.\r
+ @param PortNumber Specifies the root hub port from which the status is to be retrieved.\r
+ This value is zero based. For example, if a root hub has two ports,\r
+ then the first port is numbered 0, and the second port is\r
+ numbered 1.\r
@param PortFeature Indicates the feature selector associated with the feature clear\r
request.\r
\r
projects / mirror_edk2.git / commitdiff