X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdeModulePkg%2FInclude%2FPpi%2FUsbHostController.h;h=627b0fda2ca26181f3288e7ffbdb414de0db5324;hp=232a6667348b3ff9c97d840cfaaec585dfd7d26f;hb=d1102dba7210b95e41d06c2338a22ba6af248645;hpb=ca79bab7af4770c5eb578f6d495af01705aedb79
diff --git a/MdeModulePkg/Include/Ppi/UsbHostController.h b/MdeModulePkg/Include/Ppi/UsbHostController.h
index 232a666734..627b0fda2c 100644
--- a/MdeModulePkg/Include/Ppi/UsbHostController.h
+++ b/MdeModulePkg/Include/Ppi/UsbHostController.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) 2006 - 2013, Intel Corporation. All rights reserved.
+
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
This program and the accompanying materials
are licensed and made available under the terms and conditions
@@ -37,38 +37,38 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
typedef struct _PEI_USB_HOST_CONTROLLER_PPI PEI_USB_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_USB_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,
- that the transfer is allowed to complete.
+ @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[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_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_SUCCESS The control transfer was completed successfully.
@@ -90,21 +90,21 @@ 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_USB_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] 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.
@@ -113,7 +113,7 @@ EFI_STATUS
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[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.
@@ -140,12 +140,12 @@ 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_USB_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_DEVICE_ERROR An error was encountered while attempting to retrieve
+ @retval EFI_DEVICE_ERROR An error was encountered while attempting to retrieve
the port number.
@retval EFI_INVALID_PARAMETER PortNumber is NULL.
@@ -162,15 +162,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_USB_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.
@@ -188,16 +188,16 @@ 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_USB_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.
**/
@@ -214,7 +214,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_USB_HOST_CONTROLLER_PPI.
@param[in] PortNumber Specifies the root hub port whose feature is
requested to be cleared.
@@ -239,7 +239,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_USB_HOST_CONTROLLER_PPI {