Update the copyright notice format

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

diff --git a/MdeModulePkg/Bus/Pci/EhciDxe/EhciDebug.h b/MdeModulePkg/Bus/Pci/EhciDxe/EhciDebug.h
index 3dd4074bd432847f87d8ab203d4e6d86d032e565..bc84bb7864f7fb468d33a436a090a34c1614e63a 100644 (file)
--- a/MdeModulePkg/Bus/Pci/EhciDxe/EhciDebug.h
+++ b/MdeModulePkg/Bus/Pci/EhciDxe/EhciDebug.h
@@ -1,7 +1,9 @@
 /** @file\r
 \r
-Copyright (c) 2007, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+  This file contains the definination for host controller debug support routines.\r
+\r
+Copyright (c) 2007 - 2009, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
 http://opensource.org/licenses/bsd-license.php\r
@@ -9,16 +11,6 @@ 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
-  EhciDebug.h\r
-\r
-Abstract:\r
-\r
-  This file contains the definination for host controller debug support routines\r
-\r
-Revision History\r
-\r
 **/\r
 \r
 #ifndef _EFI_EHCI_DEBUG_H_\r
@@ -26,31 +18,25 @@ Revision History
 \r
 \r
 /**\r
-  Dump the fields of a QTD\r
-\r
-  @param  Qtd      The QTD to dump\r
-  @param  Msg      The message to print before the dump\r
+  Dump the fields of a QTD.\r
 \r
-  @return None\r
+  @param  Qtd      The QTD to dump.\r
+  @param  Msg      The message to print before the dump.\r
 \r
 **/\r
 VOID\r
 EhcDumpQtd (\r
   IN EHC_QTD              *Qtd,\r
   IN CHAR8                *Msg\r
-  )\r
-;\r
-\r
+  );\r
 \r
 \r
 /**\r
-  Dump the queue head\r
-\r
-  @param  Qh       The queue head to dump\r
-  @param  Msg      The message to print before the dump\r
-  @param  DumpBuf  Whether to dump the memory buffer of the associated QTD\r
+  Dump the queue head.\r
 \r
-  @return None\r
+  @param  Qh       The queue head to dump.\r
+  @param  Msg      The message to print before the dump.\r
+  @param  DumpBuf  Whether to dump the memory buffer of the associated QTD.\r
 \r
 **/\r
 VOID\r
@@ -58,25 +44,32 @@ EhcDumpQh (
   IN EHC_QH               *Qh,\r
   IN CHAR8                *Msg,\r
   IN BOOLEAN              DumpBuf\r
-  )\r
-;\r
-\r
+  );\r
 \r
 \r
 /**\r
-  Dump the buffer in the form of hex\r
-\r
-  @param  Buf      The buffer to dump\r
-  @param  Len      The length of buffer\r
+  Dump the buffer in the form of hex.\r
 \r
-  @return None\r
+  @param  Buf      The buffer to dump.\r
+  @param  Len      The length of buffer.\r
 \r
 **/\r
 VOID\r
 EhcDumpBuf (\r
   IN UINT8                *Buf,\r
   IN UINTN                Len\r
-  )\r
-;\r
+  );\r
+\r
+\r
+/**\r
+  Dump the EHCI status registers.\r
+\r
+  @param  Ehc    USB EHCI Host Controller instance\r
+\r
+**/\r
+VOID\r
+EhcDumpRegs (\r
+  IN  USB2_HC_DEV         *Ehc\r
+  );\r
 \r
 #endif\r