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

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5427 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 46 insertions, 63 deletions

diff --git a/MdeModulePkg/Bus/Pci/EhciDxe/EhciSched.h b/MdeModulePkg/Bus/Pci/EhciDxe/EhciSched.h
index d8f2661059..13f7b5ad41 100644
--- a/MdeModulePkg/Bus/Pci/EhciDxe/EhciSched.h
+++ b/MdeModulePkg/Bus/Pci/EhciDxe/EhciSched.h
@@ -1,5 +1,7 @@
 /** @file

 

+  This file contains the definination for host controller schedule routines.

+

 Copyright (c) 2007, 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

@@ -9,49 +11,32 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

-Module Name:

+**/

 

-  EhciSched.h

+#ifndef _EFI_EHCI_SCHED_H_

+#define _EFI_EHCI_SCHED_H_

 

-Abstract:

 

-  This file contains the definination for host controller schedule routines

+/**

+  Initialize the schedule data structure such as frame list.

 

-Revision History

+  @param Ehc                    The EHCI device to init schedule data for.

 

-**/

-

-#ifndef _EFI_EHCI_SCHED_H_

-#define _EFI_EHCI_SCHED_H_

+  @retval EFI_OUT_OF_RESOURCES  Failed to allocate resource to init schedule data.

+  @retval EFI_SUCCESS           The schedule data is initialized.

 

+**/

 EFI_STATUS

 EhcInitSched (

   IN USB2_HC_DEV          *Ehc

   )

-/*++

-

-Routine Description:

-

-  Initialize the schedule data structure such as frame list

-

-Arguments:

-

-  Ehc - The EHCI device to init schedule data for

-

-Returns:

-

-  EFI_OUT_OF_RESOURCES  - Failed to allocate resource to init schedule data

-  EFI_SUCCESS           - The schedule data is initialized

-

---*/

 ;

 

 

-

 /**

   Free the schedule data. It may be partially initialized.

 

-  @param  Ehc            The EHCI device

+  @param  Ehc            The EHCI device.

 

   @return None

 

@@ -63,7 +48,6 @@ EhcFreeSched (
 ;

 

 

-

 /**

   Link the queue head to the asynchronous schedule list.

   UEFI only supports one CTRL/BULK transfer at a time

@@ -71,10 +55,10 @@ EhcFreeSched (
   management: A reclamation header is always linked to

   the AsyncListAddr, the only active QH is appended to it.

 

-  @param  Ehc            The EHCI device

-  @param  Qh             The queue head to link

+  @param  Ehc            The EHCI device.

+  @param  Qh             The queue head to link.

 

-  @return None

+  @return None.

 

 **/

 VOID

@@ -87,12 +71,12 @@ EhcLinkQhToAsync (
 

 /**

   Unlink a queue head from the asynchronous schedule list.

-  Need to synchronize with hardware

+  Need to synchronize with hardware.

 

-  @param  Ehc            The EHCI device

-  @param  Qh             The queue head to unlink

+  @param  Ehc            The EHCI device.

+  @param  Qh             The queue head to unlink.

 

-  @return None

+  @return None.

 

 **/

 VOID

@@ -108,10 +92,10 @@ EhcUnlinkQhFromAsync (
   schedule frame list. This code is very much the same as

   that in UHCI.

 

-  @param  Ehc            The EHCI device

-  @param  Qh             The queue head to link

+  @param  Ehc            The EHCI device.

+  @param  Qh             The queue head to link.

 

-  @return None

+  @return None.

 

 **/

 VOID

@@ -124,12 +108,12 @@ EhcLinkQhToPeriod (
 

 /**

   Unlink an interrupt queue head from the periodic

-  schedule frame list

+  schedule frame list.

 

-  @param  Ehc            The EHCI device

-  @param  Qh             The queue head to unlink

+  @param  Ehc            The EHCI device.

+  @param  Qh             The queue head to unlink.

 

-  @return None

+  @return None.

 

 **/

 VOID

@@ -144,13 +128,13 @@ EhcUnlinkQhFromPeriod (
 /**

   Execute the transfer by polling the URB. This is a synchronous operation.

 

-  @param  Ehc            The EHCI device

-  @param  Urb            The URB to execute

-  @param  TimeOut        The time to wait before abort, in millisecond.

+  @param  Ehc               The EHCI device.

+  @param  Urb               The URB to execute.

+  @param  TimeOut           The time to wait before abort, in millisecond.

 

-  @return EFI_DEVICE_ERROR : The transfer failed due to transfer error

-  @return EFI_TIMEOUT      : The transfer failed due to time out

-  @return EFI_SUCCESS      : The transfer finished OK

+  @retval EFI_DEVICE_ERROR  The transfer failed due to transfer error.

+  @retval EFI_TIMEOUT       The transfer failed due to time out.

+  @retval EFI_SUCCESS       The transfer finished OK.

 

 **/

 EFI_STATUS

@@ -164,15 +148,15 @@ EhcExecTransfer (
 

 /**

   Delete a single asynchronous interrupt transfer for

-  the device and endpoint

+  the device and endpoint.

 

-  @param  Ehc            The EHCI device

-  @param  DevAddr        The address of the target device

-  @param  EpNum          The endpoint of the target

-  @param  DataToggle     Return the next data toggle to use

+  @param  Ehc            The EHCI device.

+  @param  DevAddr        The address of the target device.

+  @param  EpNum          The endpoint of the target.

+  @param  DataToggle     Return the next data toggle to use.

 

-  @retval EFI_SUCCESS    An asynchronous transfer is removed

-  @retval EFI_NOT_FOUND  No transfer for the device is found

+  @retval EFI_SUCCESS    An asynchronous transfer is removed.

+  @retval EFI_NOT_FOUND  No transfer for the device is found.

 

 **/

 EFI_STATUS

@@ -186,11 +170,11 @@ EhciDelAsyncIntTransfer (
 

 

 /**

-  Remove all the asynchronous interrutp transfers

+  Remove all the asynchronous interrutp transfers.

 

-  @param  Ehc            The EHCI device

+  @param  Ehc            The EHCI device.

 

-  @return None

+  @return None.

 

 **/

 VOID

@@ -200,14 +184,13 @@ EhciDelAllAsyncIntTransfers (
 ;

 

 

-

 /**

-  Interrupt transfer periodic check handler

+  Interrupt transfer periodic check handler.

 

-  @param  Event          Interrupt event

-  @param  Context        Pointer to USB2_HC_DEV

+  @param  Event          Interrupt event.

+  @param  Context        Pointer to USB2_HC_DEV.

 

-  @return None

+  @return None.

 

 **/

 VOID