diff options
Diffstat (limited to 'MdeModulePkg/Include/Ppi/Usb2HostController.h')
| -rw-r--r-- | MdeModulePkg/Include/Ppi/Usb2HostController.h | 96 |
1 files changed, 48 insertions, 48 deletions
diff --git a/MdeModulePkg/Include/Ppi/Usb2HostController.h b/MdeModulePkg/Include/Ppi/Usb2HostController.h index 7bcb341a94..5e0b300ca7 100644 --- a/MdeModulePkg/Include/Ppi/Usb2HostController.h +++ b/MdeModulePkg/Include/Ppi/Usb2HostController.h @@ -1,11 +1,11 @@ /** @file
- Defines the USB Host Controller PPI that provides I/O services for a USB Host
- Controller that may be used to access recovery devices. These interfaces are
+ Defines the USB Host Controller PPI that provides I/O services for a USB Host
+ Controller that may be used to access recovery devices. These interfaces are
modeled on the UEFI 2.3 specification EFI_USB2_HOST_CONTROLLER_PROTOCOL.
- Refer to section 16.1 of the UEFI 2.3 Specification for more information on
+ Refer to section 16.1 of the UEFI 2.3 Specification for more information on
these interfaces.
-
-Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved. <BR>
+
+Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved. <BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions
@@ -37,45 +37,45 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. typedef struct _PEI_USB2_HOST_CONTROLLER_PPI PEI_USB2_HOST_CONTROLLER_PPI;
/**
- Initiate a USB control transfer using a specific USB Host controller on the USB bus.
+ Initiate a USB control transfer using a specific USB Host controller on the USB bus.
@param[in] PeiServices The pointer to the PEI Services Table.
- @param[in] This The pointer to this instance of the
+ @param[in] This The pointer to this instance of the
PEI_USB2_HOST_CONTROLLER_PPI.
- @param[in] DeviceAddress Represents the address of the target device
+ @param[in] DeviceAddress Represents the address of the target device
on the USB.
@param[in] DeviceSpeed Indicates device speed.
- @param[in] MaximumPacketLength Indicates the maximum packet size that the
+ @param[in] MaximumPacketLength Indicates the maximum packet size that the
default control transfer
endpoint is capable of sending or receiving.
- @param[in] Request A pointer to the USB device request that
+ @param[in] Request A pointer to the USB device request that
will be sent to the USB device.
- @param[in] TransferDirection Specifies the data direction for the transfer.
- There are three values available:
+ @param[in] TransferDirection Specifies the data direction for the transfer.
+ There are three values available:
EfiUsbDataIn, EfiUsbDataOut and EfiUsbNoData.
- @param[in,out] Data A pointer to the buffer of data that will
+ @param[in,out] Data A pointer to the buffer of data that will
be transmitted to USB device or
received from USB device.
- @param[in,out] DataLength On input, indicates the size, in bytes, of
+ @param[in,out] DataLength On input, indicates the size, in bytes, of
the data buffer specified by Data.
- On output, indicates the amount of data
+ On output, indicates the amount of data
actually transferred.
- @param[in] TimeOut Indicates the maximum time, in milliseconds,
+ @param[in] TimeOut Indicates the maximum time, in milliseconds,
that the transfer is allowed to complete.
If Timeout is 0, then the caller must wait for
the function to be completed until EFI_SUCCESS
or EFI_DEVICE_ERROR is returned.
@param[in] Translator A pointer to the transaction translator data.
- @param[out] TransferResult A pointer to the detailed result information
+ @param[out] TransferResult A pointer to the detailed result information
generated by this control transfer.
@retval EFI_SUCCESS The control transfer was completed successfully.
- @retval EFI_DEVICE_ERROR The control transfer failed due to host controller
+ @retval EFI_DEVICE_ERROR The control transfer failed due to host controller
or device error.
@retval EFI_INVALID_PARAMETER Some parameters are invalid.
@retval EFI_OUT_OF_RESOURCES The control transfer could not be completed due to a lack of resources.
@retval EFI_TIMEOUT The control transfer failed due to timeout.
-
+
**/
typedef
@@ -96,22 +96,22 @@ EFI_STATUS );
/**
- Initiate a USB bulk transfer using a specific USB Host controller on the USB bus.
+ Initiate a USB bulk transfer using a specific USB Host controller on the USB bus.
@param[in] PeiServices The pointer to the PEI Services Table.
- @param[in] This The pointer to this instance of the
+ @param[in] This The pointer to this instance of the
PEI_USB2_HOST_CONTROLLER_PPI.
- @param[in] DeviceAddress Represents the address of the target device
+ @param[in] DeviceAddress Represents the address of the target device
on the USB.
- @param[in] EndPointAddress The combination of an endpoint number and
+ @param[in] EndPointAddress The combination of an endpoint number and
an endpoint direction of the target USB device.
@param[in] DeviceSpeed Indicates device speed.
- @param[in] MaximumPacketLength Indicates the maximum packet size the target
+ @param[in] MaximumPacketLength Indicates the maximum packet size the target
endpoint is capable of sending or receiving.
- @param[in,out] Data Array of pointers to the buffers of data
- that will be transmitted to USB device or
+ @param[in,out] Data Array of pointers to the buffers of data
+ that will be transmitted to USB device or
received from USB device.
- @param[in,out] DataLength When input, indicates the size, in bytes, of
+ @param[in,out] DataLength When input, indicates the size, in bytes, of
the data buffers specified by Data. When output,
indicates the data size actually transferred.
@param[in,out] DataToggle A pointer to the data toggle value.
@@ -121,7 +121,7 @@ EFI_STATUS the function to be completed until EFI_SUCCESS
or EFI_DEVICE_ERROR is returned.
@param[in] Translator A pointer to the transaction translator data.
- @param[out] TransferResult A pointer to the detailed result information
+ @param[out] TransferResult A pointer to the detailed result information
of the bulk transfer.
@retval EFI_SUCCESS The bulk transfer was completed successfully.
@@ -129,8 +129,8 @@ EFI_STATUS Caller should check TransferResult for detailed error information.
@retval EFI_INVALID_PARAMETER Some parameters are invalid.
@retval EFI_OUT_OF_RESOURCES The bulk transfer could not be submitted due to a lack of resources.
- @retval EFI_TIMEOUT The bulk transfer failed due to timeout.
-
+ @retval EFI_TIMEOUT The bulk transfer failed due to timeout.
+
**/
typedef
@@ -140,7 +140,7 @@ EFI_STATUS IN PEI_USB2_HOST_CONTROLLER_PPI *This,
IN UINT8 DeviceAddress,
IN UINT8 EndPointAddress,
- IN UINT8 DeviceSpeed,
+ IN UINT8 DeviceSpeed,
IN UINTN MaximumPacketLength,
IN OUT VOID *Data[EFI_USB_MAX_BULK_BUFFER_NUM],
IN OUT UINTN *DataLength,
@@ -154,10 +154,10 @@ EFI_STATUS Retrieves the number of root hub ports.
@param[in] PeiServices The pointer to the PEI Services Table.
- @param[in] This The pointer to this instance of the
+ @param[in] This The pointer to this instance of the
PEI_USB2_HOST_CONTROLLER_PPI.
- @param[out] PortNumber The pointer to the number of the root hub ports.
-
+ @param[out] PortNumber The pointer to the number of the root hub ports.
+
@retval EFI_SUCCESS The port number was retrieved successfully.
@retval EFI_INVALID_PARAMETER PortNumber is NULL.
@@ -174,15 +174,15 @@ EFI_STATUS Retrieves the current status of a USB root hub port.
@param[in] PeiServices The pointer to the PEI Services Table.
- @param[in] This The pointer to this instance of the
+ @param[in] This The pointer to this instance of the
PEI_USB2_HOST_CONTROLLER_PPI.
- @param[in] PortNumber Specifies the root hub port from which the status is
+ @param[in] PortNumber Specifies the root hub port from which the status is
to be retrieved.
This value is zero based.
- @param[out] PortStatus A pointer to the current port status bits and port
+ @param[out] PortStatus A pointer to the current port status bits and port
status change bits.
-
- @retval EFI_SUCCESS The status of the USB root hub port specified by
+
+ @retval EFI_SUCCESS The status of the USB root hub port specified by
PortNumber was returned in PortStatus.
@retval EFI_INVALID_PARAMETER PortNumber is invalid.
@@ -200,18 +200,18 @@ EFI_STATUS Sets a feature for the specified root hub port.
@param[in] PeiServices The pointer to the PEI Services Table.
- @param[in] This The pointer to this instance of the
+ @param[in] This The pointer to this instance of the
PEI_USB2_HOST_CONTROLLER_PPI.
- @param[in] PortNumber Specifies the root hub port whose feature is requested
+ @param[in] PortNumber Specifies the root hub port whose feature is requested
to be set. This value is zero based.
- @param[in] PortFeature Indicates the feature selector associated with the feature
+ @param[in] PortFeature Indicates the feature selector associated with the feature
set request.
-
- @retval EFI_SUCCESS The feature specified by PortFeature was set for
+
+ @retval EFI_SUCCESS The feature specified by PortFeature was set for
the USB root hub port specified by PortNumber.
- @retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid
+ @retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid
for this function.
- @retval EFI_TIMEOUT The time out occurred
+ @retval EFI_TIMEOUT The time out occurred
**/
typedef
@@ -227,7 +227,7 @@ EFI_STATUS Clears a feature for the specified root hub port.
@param[in] PeiServices The pointer to the PEI Services Table.
- @param[in] This The pointer to this instance of the
+ @param[in] This The pointer to this instance of the
PEI_USB2_HOST_CONTROLLER_PPI.
@param[in] PortNumber Specifies the root hub port whose feature is
requested to be cleared.
@@ -251,7 +251,7 @@ EFI_STATUS ///
/// This PPI contains a set of services to interact with the USB host controller.
/// These interfaces are modeled on the UEFI 2.3 specification protocol
-/// EFI_USB2_HOST_CONTROLLER_PROTOCOL. Refer to section 16.1 of the UEFI 2.3
+/// EFI_USB2_HOST_CONTROLLER_PROTOCOL. Refer to section 16.1 of the UEFI 2.3
/// Specification for more information on these interfaces.
///
struct _PEI_USB2_HOST_CONTROLLER_PPI {
|