]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Bus/Pci/EhciPei/EhciReg.h
MdeModulePkg: Clean up source files
[mirror_edk2.git] / MdeModulePkg / Bus / Pci / EhciPei / EhciReg.h
index 34c61d8a9436be8fd022b4c15071349e12546429..14d3f77e44315b8eb48d32073ab5b3b737bf1062 100644 (file)
@@ -1,8 +1,8 @@
 /** @file\r
 Private Header file for Usb Host Controller PEIM\r
 \r
-Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>\r
-  \r
+Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r
+\r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions\r
 of the BSD License which accompanies this distribution.  The\r
@@ -94,8 +94,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define EHCI_IS_DATAIN(EndpointAddr) EHC_BIT_IS_SET((EndpointAddr), 0x80)\r
 \r
 //\r
-// Structure to map the hardware port states to the \r
-// UEFI's port states. \r
+// Structure to map the hardware port states to the\r
+// UEFI's port states.\r
 //\r
 typedef struct {\r
   UINT16                  HwState;\r
@@ -116,7 +116,7 @@ typedef struct {
 \r
 /**\r
   Read EHCI capability register.\r
-  \r
+\r
   @param  Ehc       The EHCI device.\r
   @param  Offset    Capability register address.\r
 \r
@@ -132,7 +132,7 @@ EhcReadCapRegister (
 \r
 /**\r
   Read Ehc Operation register.\r
-  \r
+\r
   @param  Ehc       The EHCI device.\r
   @param  Offset    The operation register offset.\r
 \r
@@ -148,7 +148,7 @@ EhcReadOpReg (
 \r
 /**\r
   Write the data to the EHCI operation register.\r
-  \r
+\r
   @param  Ehc       The EHCI device.\r
   @param  Offset    EHCI operation register offset.\r
   @param  Data      The data to write.\r
@@ -164,7 +164,7 @@ EhcWriteOpReg (
 \r
 /**\r
   Stop the legacy USB SMI support.\r
-  \r
+\r
   @param  Ehc       The EHCI device.\r
 \r
 **/\r
@@ -177,7 +177,7 @@ EhcClearLegacySupport (
 /**\r
   Set door bell and wait it to be ACKed by host controller.\r
   This function is used to synchronize with the hardware.\r
-  \r
+\r
   @param  Ehc       The EHCI device.\r
   @param  Timeout   The time to wait before abort (in millisecond, ms).\r
 \r
@@ -193,9 +193,9 @@ EhcSetAndWaitDoorBell (
 ;\r
 \r
 /**\r
-  Clear all the interrutp status bits, these bits \r
+  Clear all the interrutp status bits, these bits\r
   are Write-Clean.\r
-  \r
+\r
   @param  Ehc       The EHCI device.\r
 \r
 **/\r
@@ -207,7 +207,7 @@ EhcAckAllInterrupt (
 \r
 /**\r
   Check whether Ehc is halted.\r
-  \r
+\r
   @param  Ehc       The EHCI device.\r
 \r
   @retval TRUE      The controller is halted.\r
@@ -222,7 +222,7 @@ EhcIsHalt (
 \r
 /**\r
   Check whether system error occurred.\r
-  \r
+\r
   @param  Ehc       The EHCI device.\r
 \r
   @retval TRUE      System error happened.\r
@@ -237,7 +237,7 @@ EhcIsSysError (
 \r
 /**\r
   Reset the host controller.\r
-  \r
+\r
   @param  Ehc             The EHCI device.\r
   @param  Timeout         Time to wait before abort (in millisecond, ms).\r
 \r
@@ -254,7 +254,7 @@ EhcResetHC (
 \r
 /**\r
   Halt the host controller.\r
-  \r
+\r
   @param  Ehc             The EHCI device.\r
   @param  Timeout         Time to wait before abort.\r
 \r
@@ -271,7 +271,7 @@ EhcHaltHC (
 \r
 /**\r
   Set the EHCI to run\r
-  \r
+\r
   @param  Ehc             The EHCI device.\r
   @param  Timeout         Time to wait before abort.\r
 \r
@@ -287,14 +287,14 @@ EhcRunHC (
 ;\r
 \r
 /**\r
-  Initialize the HC hardware. \r
+  Initialize the HC hardware.\r
   EHCI spec lists the five things to do to initialize the hardware.\r
   1. Program CTRLDSSEGMENT.\r
   2. Set USBINTR to enable interrupts.\r
   3. Set periodic list base.\r
   4. Set USBCMD, interrupt threshold, frame list size etc.\r
   5. Write 1 to CONFIGFLAG to route all ports to EHCI.\r
-  \r
+\r
   @param  Ehc             The EHCI device.\r
 \r
   @retval EFI_SUCCESS     The EHCI has come out of halt state.\r