modify coding style to pass ecc tool and provide comments that complied with Doxgen.

[mirror_edk2.git] / MdeModulePkg / Bus / Pci / EhciDxe / EhciSched.h

diff --git a/MdeModulePkg/Bus/Pci/EhciDxe/EhciSched.h b/MdeModulePkg/Bus/Pci/EhciDxe/EhciSched.h
index d8f266105953889e84fd55360e3f4258383e2f96..13f7b5ad416b49a15efc65d5ee1beb46443dbda2 100644 (file)
--- a/MdeModulePkg/Bus/Pci/EhciDxe/EhciSched.h
+++ b/MdeModulePkg/Bus/Pci/EhciDxe/EhciSched.h
@@ -1,5 +1,7 @@
 /** @file\r
 \r
+  This file contains the definination for host controller schedule routines.\r
+\r
 Copyright (c) 2007, Intel Corporation\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
@@ -9,49 +11,32 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-Module Name:\r
+**/\r
 \r
-  EhciSched.h\r
+#ifndef _EFI_EHCI_SCHED_H_\r
+#define _EFI_EHCI_SCHED_H_\r
 \r
-Abstract:\r
 \r
-  This file contains the definination for host controller schedule routines\r
+/**\r
+  Initialize the schedule data structure such as frame list.\r
 \r
-Revision History\r
+  @param Ehc                    The EHCI device to init schedule data for.\r
 \r
-**/\r
-\r
-#ifndef _EFI_EHCI_SCHED_H_\r
-#define _EFI_EHCI_SCHED_H_\r
+  @retval EFI_OUT_OF_RESOURCES  Failed to allocate resource to init schedule data.\r
+  @retval EFI_SUCCESS           The schedule data is initialized.\r
 \r
+**/\r
 EFI_STATUS\r
 EhcInitSched (\r
   IN USB2_HC_DEV          *Ehc\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Initialize the schedule data structure such as frame list\r
-\r
-Arguments:\r
-\r
-  Ehc - The EHCI device to init schedule data for\r
-\r
-Returns:\r
-\r
-  EFI_OUT_OF_RESOURCES  - Failed to allocate resource to init schedule data\r
-  EFI_SUCCESS           - The schedule data is initialized\r
-\r
---*/\r
 ;\r
 \r
 \r
-\r
 /**\r
   Free the schedule data. It may be partially initialized.\r
 \r
-  @param  Ehc            The EHCI device\r
+  @param  Ehc            The EHCI device.\r
 \r
   @return None\r
 \r
@@ -63,7 +48,6 @@ EhcFreeSched (
 ;\r
 \r
 \r
-\r
 /**\r
   Link the queue head to the asynchronous schedule list.\r
   UEFI only supports one CTRL/BULK transfer at a time\r
@@ -71,10 +55,10 @@ EhcFreeSched (
   management: A reclamation header is always linked to\r
   the AsyncListAddr, the only active QH is appended to it.\r
 \r
-  @param  Ehc            The EHCI device\r
-  @param  Qh             The queue head to link\r
+  @param  Ehc            The EHCI device.\r
+  @param  Qh             The queue head to link.\r
 \r
-  @return None\r
+  @return None.\r
 \r
 **/\r
 VOID\r
@@ -87,12 +71,12 @@ EhcLinkQhToAsync (
 \r
 /**\r
   Unlink a queue head from the asynchronous schedule list.\r
-  Need to synchronize with hardware\r
+  Need to synchronize with hardware.\r
 \r
-  @param  Ehc            The EHCI device\r
-  @param  Qh             The queue head to unlink\r
+  @param  Ehc            The EHCI device.\r
+  @param  Qh             The queue head to unlink.\r
 \r
-  @return None\r
+  @return None.\r
 \r
 **/\r
 VOID\r
@@ -108,10 +92,10 @@ EhcUnlinkQhFromAsync (
   schedule frame list. This code is very much the same as\r
   that in UHCI.\r
 \r
-  @param  Ehc            The EHCI device\r
-  @param  Qh             The queue head to link\r
+  @param  Ehc            The EHCI device.\r
+  @param  Qh             The queue head to link.\r
 \r
-  @return None\r
+  @return None.\r
 \r
 **/\r
 VOID\r
@@ -124,12 +108,12 @@ EhcLinkQhToPeriod (
 \r
 /**\r
   Unlink an interrupt queue head from the periodic\r
-  schedule frame list\r
+  schedule frame list.\r
 \r
-  @param  Ehc            The EHCI device\r
-  @param  Qh             The queue head to unlink\r
+  @param  Ehc            The EHCI device.\r
+  @param  Qh             The queue head to unlink.\r
 \r
-  @return None\r
+  @return None.\r
 \r
 **/\r
 VOID\r
@@ -144,13 +128,13 @@ EhcUnlinkQhFromPeriod (
 /**\r
   Execute the transfer by polling the URB. This is a synchronous operation.\r
 \r
-  @param  Ehc            The EHCI device\r
-  @param  Urb            The URB to execute\r
-  @param  TimeOut        The time to wait before abort, in millisecond.\r
+  @param  Ehc               The EHCI device.\r
+  @param  Urb               The URB to execute.\r
+  @param  TimeOut           The time to wait before abort, in millisecond.\r
 \r
-  @return EFI_DEVICE_ERROR : The transfer failed due to transfer error\r
-  @return EFI_TIMEOUT      : The transfer failed due to time out\r
-  @return EFI_SUCCESS      : The transfer finished OK\r
+  @retval EFI_DEVICE_ERROR  The transfer failed due to transfer error.\r
+  @retval EFI_TIMEOUT       The transfer failed due to time out.\r
+  @retval EFI_SUCCESS       The transfer finished OK.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -164,15 +148,15 @@ EhcExecTransfer (
 \r
 /**\r
   Delete a single asynchronous interrupt transfer for\r
-  the device and endpoint\r
+  the device and endpoint.\r
 \r
-  @param  Ehc            The EHCI device\r
-  @param  DevAddr        The address of the target device\r
-  @param  EpNum          The endpoint of the target\r
-  @param  DataToggle     Return the next data toggle to use\r
+  @param  Ehc            The EHCI device.\r
+  @param  DevAddr        The address of the target device.\r
+  @param  EpNum          The endpoint of the target.\r
+  @param  DataToggle     Return the next data toggle to use.\r
 \r
-  @retval EFI_SUCCESS    An asynchronous transfer is removed\r
-  @retval EFI_NOT_FOUND  No transfer for the device is found\r
+  @retval EFI_SUCCESS    An asynchronous transfer is removed.\r
+  @retval EFI_NOT_FOUND  No transfer for the device is found.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -186,11 +170,11 @@ EhciDelAsyncIntTransfer (
 \r
 \r
 /**\r
-  Remove all the asynchronous interrutp transfers\r
+  Remove all the asynchronous interrutp transfers.\r
 \r
-  @param  Ehc            The EHCI device\r
+  @param  Ehc            The EHCI device.\r
 \r
-  @return None\r
+  @return None.\r
 \r
 **/\r
 VOID\r
@@ -200,14 +184,13 @@ EhciDelAllAsyncIntTransfers (
 ;\r
 \r
 \r
-\r
 /**\r
-  Interrupt transfer periodic check handler\r
+  Interrupt transfer periodic check handler.\r
 \r
-  @param  Event          Interrupt event\r
-  @param  Context        Pointer to USB2_HC_DEV\r
+  @param  Event          Interrupt event.\r
+  @param  Context        Pointer to USB2_HC_DEV.\r
 \r
-  @return None\r
+  @return None.\r
 \r
 **/\r
 VOID\r