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@5429 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 41 insertions, 50 deletions

diff --git a/MdeModulePkg/Bus/Pci/UhciDxe/UhciReg.h b/MdeModulePkg/Bus/Pci/UhciDxe/UhciReg.h
index 224f402c3c..8ba1cc23cd 100644
--- a/MdeModulePkg/Bus/Pci/UhciDxe/UhciReg.h
+++ b/MdeModulePkg/Bus/Pci/UhciDxe/UhciReg.h
@@ -1,5 +1,7 @@
 /** @file

 

+  The definition for UHCI register operation routines.

+

 Copyright (c) 2007 - 2008, 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,17 +11,6 @@ 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:

-

-  UhciReg.h

-

-Abstract:

-

-  The definition for UHCI register operation routines.

-

-Revision History

-

-

 **/

 

 #ifndef _EFI_UHCI_REG_H_

@@ -27,7 +18,7 @@ Revision History
 

 #define BIT(a)  (1 << (a))

 

-enum {

+typedef enum {

   UHCI_FRAME_NUM        = 1024,

 

   //

@@ -104,16 +95,16 @@ enum {
   USBTD_NAK             = BIT(3),  // NAK is received

   USBTD_CRC             = BIT(2),  // CRC/Time out error

   USBTD_BITSTUFF        = BIT(1)  // Bit stuff error

-};

+}UHCI_REGISTER_OFFSET;

 

 

 /**

-  Read a UHCI register

+  Read a UHCI register.

 

-  @param  PciIo        The EFI_PCI_IO_PROTOCOL to use

-  @param  Offset       Register offset to USB_BAR_INDEX

+  @param  PciIo        The EFI_PCI_IO_PROTOCOL to use.

+  @param  Offset       Register offset to USB_BAR_INDEX.

 

-  @return Content of register

+  @return Content of register.

 

 **/

 UINT16

@@ -126,13 +117,13 @@ UhciReadReg (
 

 

 /**

-  Write data to UHCI register

+  Write data to UHCI register.

 

-  @param  PciIo        The EFI_PCI_IO_PROTOCOL to use

-  @param  Offset       Register offset to USB_BAR_INDEX

-  @param  Data         Data to write

+  @param  PciIo        The EFI_PCI_IO_PROTOCOL to use.

+  @param  Offset       Register offset to USB_BAR_INDEX.

+  @param  Data         Data to write.

 

-  @return VOID

+  @return None.

 

 **/

 VOID

@@ -146,13 +137,13 @@ UhciWriteReg (
 

 

 /**

-  Set a bit of the UHCI Register

+  Set a bit of the UHCI Register.

 

-  @param  PciIo        The EFI_PCI_IO_PROTOCOL to use

-  @param  Offset       Register offset to USB_BAR_INDEX

-  @param  Bit          The bit to set

+  @param  PciIo        The EFI_PCI_IO_PROTOCOL to use.

+  @param  Offset       Register offset to USB_BAR_INDEX.

+  @param  Bit          The bit to set.

 

-  @return None

+  @return None.

 

 **/

 VOID

@@ -166,13 +157,13 @@ UhciSetRegBit (
 

 

 /**

-  Clear a bit of the UHCI Register

+  Clear a bit of the UHCI Register.

 

-  @param  PciIo        The PCI_IO protocol to access the PCI

-  @param  Offset       Register offset to USB_BAR_INDEX

-  @param  Bit          The bit to clear

+  @param  PciIo        The PCI_IO protocol to access the PCI.

+  @param  Offset       Register offset to USB_BAR_INDEX.

+  @param  Bit          The bit to clear.

 

-  @return None

+  @return None.

 

 **/

 VOID

@@ -186,11 +177,11 @@ UhciClearRegBit (
 

 /**

   Clear all the interrutp status bits, these bits

-  are Write-Clean

+  are Write-Clean.

 

-  @param  Uhc          The UHCI device

+  @param  Uhc          The UHCI device.

 

-  @return None

+  @return None.

 

 **/

 VOID

@@ -201,13 +192,13 @@ UhciAckAllInterrupt (
 

 

 /**

-  Stop the host controller

+  Stop the host controller.

 

-  @param  Uhc          The UHCI device

-  @param  Timeout      Max time allowed

+  @param  Uhc          The UHCI device.

+  @param  Timeout      Max time allowed.

 

-  @retval EFI_SUCCESS  The host controller is stopped

-  @retval EFI_TIMEOUT  Failed to stop the host controller

+  @retval EFI_SUCCESS  The host controller is stopped.

+  @retval EFI_TIMEOUT  Failed to stop the host controller.

 

 **/

 EFI_STATUS

@@ -220,12 +211,12 @@ UhciStopHc (
 

 

 /**

-  Check whether the host controller operates well

+  Check whether the host controller operates well.

 

-  @param  PciIo        The PCI_IO protocol to use

+  @param  PciIo        The PCI_IO protocol to use.

 

-  @retval TRUE         Host controller is working

-  @retval FALSE        Host controller is halted or system error

+  @retval TRUE         Host controller is working.

+  @retval FALSE        Host controller is halted or system error.

 

 **/

 BOOLEAN

@@ -239,10 +230,10 @@ UhciIsHcWorking (
   Set the UHCI frame list base address. It can't use

   UhciWriteReg which access memory in UINT16.

 

-  @param  PciIo        The EFI_PCI_IO_PROTOCOL to use

-  @param  Addr         Address to set

+  @param  PciIo        The EFI_PCI_IO_PROTOCOL to use.

+  @param  Addr         Address to set.

 

-  @return VOID

+  @return None.

 

 **/

 VOID

@@ -254,11 +245,11 @@ UhciSetFrameListBaseAddr (
 

 

 /**

-  Disable USB Emulation

+  Disable USB Emulation.

 

-  @param  PciIo        The EFI_PCI_IO_PROTOCOL protocol to use

+  @param  PciIo        The EFI_PCI_IO_PROTOCOL protocol to use.

 

-  @return VOID

+  @return None.

 

 **/

 VOID