X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdeModulePkg%2FBus%2FPci%2FUhciPei%2FUhcPeim.h;h=33d4f2f65f05f68785cfdd7a5a107468f3a9027c;hb=d1102dba7210b95e41d06c2338a22ba6af248645;hp=9935f522cd0d37e65f2d1e292965786210070b34;hpb=ca79bab7af4770c5eb578f6d495af01705aedb79;p=mirror_edk2.git
diff --git a/MdeModulePkg/Bus/Pci/UhciPei/UhcPeim.h b/MdeModulePkg/Bus/Pci/UhciPei/UhcPeim.h
index 9935f522cd..33d4f2f65f 100644
--- a/MdeModulePkg/Bus/Pci/UhciPei/UhcPeim.h
+++ b/MdeModulePkg/Bus/Pci/UhciPei/UhcPeim.h
@@ -1,8 +1,8 @@
/** @file
Private Header file for Usb Host Controller PEIM
-Copyright (c) 2006 - 2017, 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
of the BSD License which accompanies this distribution. The
@@ -203,12 +203,12 @@ typedef struct {
/**
Submits control transfer to a target USB device.
-
+
@param PeiServices The pointer of EFI_PEI_SERVICES.
@param This The pointer of PEI_USB_HOST_CONTROLLER_PPI.
@param DeviceAddress The target device address.
@param DeviceSpeed Target device speed.
- @param MaximumPacketLength Maximum packet size the default control transfer
+ @param MaximumPacketLength Maximum packet size the default control transfer
endpoint is capable of sending or receiving.
@param Request USB device request to send.
@param TransferDirection Specifies the data direction for the data stage.
@@ -242,18 +242,18 @@ UhcControlTransfer (
/**
Submits bulk transfer to a bulk endpoint of a USB device.
-
+
@param PeiServices The pointer of EFI_PEI_SERVICES.
@param This The pointer of PEI_USB_HOST_CONTROLLER_PPI.
@param DeviceAddress Target device address.
@param EndPointAddress Endpoint number and its direction in bit 7.
- @param MaximumPacketLength Maximum packet size the endpoint is capable of
+ @param MaximumPacketLength Maximum packet size the endpoint is capable of
sending or receiving.
- @param Data Array of pointers to the buffers of data to transmit
+ @param Data Array of pointers to the buffers of data to transmit
from or receive into.
@param DataLength The lenght of the data buffer.
@param DataToggle On input, the initial data toggle for the transfer;
- On output, it is updated to to next data toggle to use of
+ On output, it is updated to to next data toggle to use of
the subsequent bulk transfer.
@param TimeOut Indicates the maximum time, in millisecond, which the
transfer is allowed to complete.
@@ -286,10 +286,10 @@ UhcBulkTransfer (
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_INVALID_PARAMETER PortNumber is NULL.
@@ -304,10 +304,10 @@ UhcGetRootHubPortNumber (
/**
Retrieves the current status of a USB root hub port.
-
+
@param PeiServices The pointer of EFI_PEI_SERVICES.
@param This The pointer of PEI_USB_HOST_CONTROLLER_PPI.
- @param PortNumber The root hub port to retrieve the state from.
+ @param PortNumber The root hub port to retrieve the state from.
@param PortStatus Variable to receive the port state.
@retval EFI_SUCCESS The status of the USB root hub port specified.
@@ -326,7 +326,7 @@ UhcGetRootHubPortStatus (
/**
Sets a feature for the specified root hub port.
-
+
@param PeiServices The pointer of EFI_PEI_SERVICES
@param This The pointer of PEI_USB_HOST_CONTROLLER_PPI
@param PortNumber Root hub port to set.
@@ -348,7 +348,7 @@ UhcSetRootHubPortFeature (
/**
Clears a feature for the specified root hub port.
-
+
@param PeiServices The pointer of EFI_PEI_SERVICES.
@param This The pointer of PEI_USB_HOST_CONTROLLER_PPI.
@param PortNumber Specifies the root hub port whose feature
@@ -356,7 +356,7 @@ UhcSetRootHubPortFeature (
@param PortFeature Indicates the feature selector associated with the
feature clear request.
- @retval EFI_SUCCESS The feature specified by PortFeature was cleared
+ @retval EFI_SUCCESS The feature specified by PortFeature was cleared
for the USB root hub port specified by PortNumber.
@retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid.
@@ -400,7 +400,7 @@ CreateFrameList (
/**
Read a 16bit width data from Uhc HC IO space register.
-
+
@param UhcDev The UHCI device.
@param Port The IO space address of the register.
@@ -415,7 +415,7 @@ USBReadPortW (
/**
Write a 16bit width data into Uhc HC IO space register.
-
+
@param UhcDev The UHCI device.
@param Port The IO space address of the register.
@param Data The data written into the register.
@@ -430,7 +430,7 @@ USBWritePortW (
/**
Write a 32bit width data into Uhc HC IO space register.
-
+
@param UhcDev The UHCI device.
@param Port The IO space address of the register.
@param Data The data written into the register.
@@ -445,7 +445,7 @@ USBWritePortDW (
/**
Clear the content of UHCI's Status Register.
-
+
@param UhcDev The UHCI device.
@param StatusAddr The IO space address of the register.