X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdeModulePkg%2FBus%2FPci%2FUhciPei%2FUhcPeim.c;h=ec2daf16497589db6087d75601f3f586c33db9a1;hp=482c404c0eaeadec2068acaf652e18e10e440c2f;hb=d1102dba7210b95e41d06c2338a22ba6af248645;hpb=ca79bab7af4770c5eb578f6d495af01705aedb79 diff --git a/MdeModulePkg/Bus/Pci/UhciPei/UhcPeim.c b/MdeModulePkg/Bus/Pci/UhciPei/UhcPeim.c index 482c404c0e..ec2daf1649 100644 --- a/MdeModulePkg/Bus/Pci/UhciPei/UhcPeim.c +++ b/MdeModulePkg/Bus/Pci/UhciPei/UhcPeim.c @@ -2,8 +2,8 @@ PEIM to produce gPeiUsbHostControllerPpiGuid based on gPeiUsbControllerPpiGuid which is used to enable recovery function from USB Drivers. -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 @@ -220,12 +220,12 @@ UhcPeimEntry ( /** 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. @@ -458,18 +458,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. @@ -694,10 +694,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. @@ -739,10 +739,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. @@ -832,7 +832,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. @@ -908,7 +908,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 @@ -916,7 +916,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. @@ -1131,7 +1131,7 @@ CreateFrameList ( ASSERT (UhcDev->BulkQH != NULL); // - //Set the corresponding QH pointer + //Set the corresponding QH pointer // SetQHHorizontalLinkPtr(UhcDev->ConfigQH, UhcDev->BulkQH); SetQHHorizontalQHorTDSelect (UhcDev->ConfigQH, TRUE); @@ -1154,7 +1154,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. @@ -1172,7 +1172,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. @@ -1190,7 +1190,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. @@ -1208,7 +1208,7 @@ USBWritePortDW ( /** Clear the content of UHCI's Status Register. - + @param UhcDev The UHCI device. @param StatusAddr The IO space address of the register.