]> git.proxmox.com Git - mirror_edk2.git/commitdiff
1) Fix a typo in EhcMoniteAsyncRequests.
authorqwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524>
Wed, 4 Feb 2009 06:56:31 +0000 (06:56 +0000)
committerqwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524>
Wed, 4 Feb 2009 06:56:31 +0000 (06:56 +0000)
2) Code cleanup.
3) Doxygen comment cleanup.

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

13 files changed:
MdeModulePkg/Bus/Pci/EhciDxe/Ehci.c
MdeModulePkg/Bus/Pci/EhciDxe/Ehci.h
MdeModulePkg/Bus/Pci/EhciDxe/EhciDebug.c
MdeModulePkg/Bus/Pci/EhciDxe/EhciDebug.h
MdeModulePkg/Bus/Pci/EhciDxe/EhciDxe.inf
MdeModulePkg/Bus/Pci/EhciDxe/EhciReg.c
MdeModulePkg/Bus/Pci/EhciDxe/EhciReg.h
MdeModulePkg/Bus/Pci/EhciDxe/EhciSched.c
MdeModulePkg/Bus/Pci/EhciDxe/EhciSched.h
MdeModulePkg/Bus/Pci/EhciDxe/EhciUrb.c
MdeModulePkg/Bus/Pci/EhciDxe/EhciUrb.h
MdeModulePkg/Bus/Pci/EhciDxe/UsbHcMem.c
MdeModulePkg/Bus/Pci/EhciDxe/UsbHcMem.h

index 0667fa645d675e83688e531025ddf126e4804034..c8de7052bb9f1b90778e188004e1bb3dd5b0cbfa 100644 (file)
@@ -2,7 +2,7 @@
   \r
   The Ehci controller driver.\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation\r
+Copyright (c) 2006 - 2009, 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
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -1436,7 +1436,7 @@ EhcCreateUsb2Hc (
   Status = gBS->CreateEvent (\r
                   EVT_TIMER | EVT_NOTIFY_SIGNAL,\r
                   TPL_CALLBACK,\r
-                  EhcMoniteAsyncRequests,\r
+                  EhcMonitorAsyncRequests,\r
                   Ehc,\r
                   &Ehc->PollTimer\r
                   );\r
index f2fdb929a979cf0a3ac605d4d2521dc8e6c44f82..85772fb30d25e6545031ff9c05daeb1cc3447bac 100644 (file)
@@ -2,7 +2,7 @@
 \r
   Provides some data struct used by EHCI controller driver.\r
 \r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+Copyright (c) 2006 - 2009, 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
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -67,14 +67,12 @@ typedef enum {
 } EHC_TIMEOUT_EXPERIENCE_VALUE;\r
 \r
 \r
-  //\r
-  // EHC raises TPL to TPL_NOTIFY to serialize all its operations\r
-  // to protect shared data structures.\r
-  //\r
+//\r
+// EHC raises TPL to TPL_NOTIFY to serialize all its operations\r
+// to protect shared data structures.\r
+//\r
 #define  EHC_TPL                TPL_NOTIFY\r
 \r
-#define  USB2_HC_DEV_SIGNATURE  SIGNATURE_32 ('e', 'h', 'c', 'i')\r
-\r
 //\r
 //Iterate through the doule linked list. NOT delete safe\r
 //\r
@@ -99,7 +97,8 @@ typedef enum {
 #define EHC_REG_BIT_IS_SET(Ehc, Offset, Bit) \\r
           (EHC_BIT_IS_SET(EhcReadOpReg ((Ehc), (Offset)), (Bit)))\r
 \r
-#define EHC_FROM_THIS(a)   CR(a, USB2_HC_DEV, Usb2Hc, USB2_HC_DEV_SIGNATURE)\r
+#define USB2_HC_DEV_SIGNATURE  SIGNATURE_32 ('e', 'h', 'c', 'i')\r
+#define EHC_FROM_THIS(a)       CR(a, USB2_HC_DEV, Usb2Hc, USB2_HC_DEV_SIGNATURE)\r
 \r
 struct _USB2_HC_DEV {\r
   UINTN                     Signature;\r
index 7177c33aa7dd23a687441b32ee453ea246d6224e..892021c1c0e0801de6aba9430e9b467db3fc7f31 100644 (file)
@@ -2,7 +2,7 @@
 \r
   This file provides the information dump support for EHCI when in debug mode.\r
 \r
-Copyright (c) 2007, Intel Corporation\r
+Copyright (c) 2007 - 2009, 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
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -21,8 +21,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   @param  State    The state in the QTD/QH.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcDumpStatus (\r
@@ -71,8 +69,6 @@ EhcDumpStatus (
   @param  Qtd      The QTD to dump.\r
   @param  Msg      The message to print before the dump.\r
 \r
-  @return None\r
-\r
 **/\r
 VOID\r
 EhcDumpQtd (\r
@@ -126,8 +122,6 @@ EhcDumpQtd (
   @param  Msg      The message to print before the dump.\r
   @param  DumpBuf  Whether to dump the memory buffer of the associated QTD.\r
 \r
-  @return None\r
-\r
 **/\r
 VOID\r
 EhcDumpQh (\r
@@ -214,8 +208,6 @@ EhcDumpQh (
   @param  Buf      The buffer to dump.\r
   @param  Len      The length of buffer.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcDumpBuf (\r
index 3f786bc2857479226af66813d19cf09ad1abf248..889047c7a7e26d6b6aef61780cccdd191ba5563a 100644 (file)
@@ -2,7 +2,7 @@
 \r
   This file contains the definination for host controller debug support routines.\r
 \r
-Copyright (c) 2007, Intel Corporation\r
+Copyright (c) 2007 - 2009, 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
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -23,8 +23,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @param  Qtd      The QTD to dump.\r
   @param  Msg      The message to print before the dump.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcDumpQtd (\r
@@ -40,8 +38,6 @@ EhcDumpQtd (
   @param  Msg      The message to print before the dump.\r
   @param  DumpBuf  Whether to dump the memory buffer of the associated QTD.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcDumpQh (\r
@@ -57,8 +53,6 @@ EhcDumpQh (
   @param  Buf      The buffer to dump.\r
   @param  Len      The length of buffer.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcDumpBuf (\r
index a37d55a9fa48d8b407545e1f1c7317352f0a4615..78ab813efea40b31320205831a7f16c2cb0f4004 100644 (file)
@@ -6,7 +6,7 @@
 #  It implements the interfaces of monitoring the status of all ports and transferring \r
 #  Control, Bulk, Interrupt and Isochronous requests to Usb2.0 device.\r
 #\r
-#  Copyright (c) 2006 - 2008, Intel Corporation. \r
+#  Copyright (c) 2006 - 2009, Intel Corporation. \r
 #\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
@@ -72,8 +72,8 @@
   PcdLib\r
 \r
 [Protocols]\r
-  gEfiPciIoProtocolGuid                         ## ALWAYS_CONSUMED\r
-  gEfiUsb2HcProtocolGuid                        ## ALWAYS_PRODUCED\r
+  gEfiPciIoProtocolGuid                         ## CONSUMES\r
+  gEfiUsb2HcProtocolGuid                        ## PRODUCES\r
 \r
 # [Event]\r
 #   ##\r
index 87a41e1e889505c8b9e6bbf2ad4f12a5a8145cbc..eca9b0b2728ba34facc27285d9176e18cfdd414b 100644 (file)
@@ -2,7 +2,7 @@
 \r
   The EHCI register operation routines.\r
 \r
-Copyright (c) 2007, Intel Corporation\r
+Copyright (c) 2007 - 2009, 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
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -100,8 +100,6 @@ EhcReadOpReg (
   @param  Offset       EHCI operation register offset.\r
   @param  Data         The data to write.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcWriteOpReg (\r
@@ -136,8 +134,6 @@ EhcWriteOpReg (
   @param  Offset       The offset of the operational register.\r
   @param  Bit          The bit mask of the register to set.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcSetOpRegBit (\r
@@ -161,8 +157,6 @@ EhcSetOpRegBit (
   @param  Offset       The offset of the operational register.\r
   @param  Bit          The bit mask of the register to clear.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcClearOpRegBit (\r
@@ -222,8 +216,6 @@ EhcWaitOpRegBit (
 \r
   @param  Ehc          The EHCI device.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcClearLegacySupport (\r
@@ -308,8 +300,6 @@ EhcSetAndWaitDoorBell (
 \r
   @param  Ehc          The EHCI device.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcAckAllInterrupt (\r
index f6ca7646739ca6c6d1c500af95db413775af7aac..23f794381f379e6cd0de7cf1baefff706156b92d 100644 (file)
@@ -2,7 +2,7 @@
 \r
   This file contains the definination for host controller register operation routines.\r
 \r
-Copyright (c) 2007, Intel Corporation\r
+Copyright (c) 2007 - 2009, 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
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -154,8 +154,6 @@ EhcReadOpReg (
   @param  Offset   EHCI operation register offset.\r
   @param  Data     The data to write.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcWriteOpReg (\r
@@ -171,8 +169,6 @@ EhcWriteOpReg (
 \r
   @param  Ehc      The EHCI device.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcClearLegacySupport (\r
@@ -204,8 +200,6 @@ EhcSetAndWaitDoorBell (
 \r
   @param  Ehc      The EHCI device.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcAckAllInterrupt (\r
index 936a855f12c1b68423f8dd9a043eaa1f234cd4e8..0c5195e318e03e3a299230cc0d4266d541e7daa2 100644 (file)
@@ -2,7 +2,7 @@
 \r
   EHCI transfer scheduling routines.\r
 \r
-Copyright (c) 2007, Intel Corporation\r
+Copyright (c) 2007 - 2009, 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
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -208,8 +208,6 @@ EhcInitSched (
 \r
   @param  Ehc                   The EHCI device.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcFreeSched (\r
@@ -268,8 +266,6 @@ EhcFreeSched (
   @param  Ehc                   The EHCI device.\r
   @param  Qh                    The queue head to link.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcLinkQhToAsync (\r
@@ -301,8 +297,6 @@ EhcLinkQhToAsync (
   @param  Ehc                   The EHCI device.\r
   @param  Qh                    The queue head to unlink.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcUnlinkQhFromAsync (\r
@@ -346,8 +340,6 @@ EhcUnlinkQhFromAsync (
   @param  Ehc                   The EHCI device.\r
   @param  Qh                    The queue head to link.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcLinkQhToPeriod (\r
@@ -447,8 +439,6 @@ EhcLinkQhToPeriod (
   @param  Ehc                   The EHCI device.\r
   @param  Qh                    The queue head to unlink.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcUnlinkQhFromPeriod (\r
@@ -734,8 +724,6 @@ EhciDelAsyncIntTransfer (
 \r
   @param  Ehc                   The EHCI device.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhciDelAllAsyncIntTransfers (\r
@@ -817,8 +805,6 @@ ON_ERROR:
 \r
   @param  Urb                   The URB to update.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcUpdateAsyncRequest (\r
@@ -895,11 +881,9 @@ EhcUpdateAsyncRequest (
   @param  Event                 Interrupt event.\r
   @param  Context               Pointer to USB2_HC_DEV.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
-EhcMoniteAsyncRequests (\r
+EhcMonitorAsyncRequests (\r
   IN EFI_EVENT            Event,\r
   IN VOID                 *Context\r
   )\r
@@ -935,7 +919,7 @@ EhcMoniteAsyncRequests (
     //\r
     Status = EhcFlushAsyncIntMap (Ehc, Urb);\r
     if (EFI_ERROR (Status)) {\r
-      DEBUG ((EFI_D_ERROR, "EhcMoniteAsyncRequests: Fail to Flush AsyncInt Mapped Memeory\n"));\r
+      DEBUG ((EFI_D_ERROR, "EhcMonitorAsyncRequests: Fail to Flush AsyncInt Mapped Memeory\n"));\r
     }\r
 \r
     //\r
index fb002a91c5cf9a28f0e03077c51076ff745fdb9d..6a1bf0b86fe5533f2789ec50c69327282dc10bb9 100644 (file)
@@ -2,7 +2,7 @@
 \r
   This file contains the definination for host controller schedule routines.\r
 \r
-Copyright (c) 2007, Intel Corporation\r
+Copyright (c) 2007 - 2009, 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
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -37,8 +37,6 @@ EhcInitSched (
 \r
   @param  Ehc            The EHCI device.\r
 \r
-  @return None\r
-\r
 **/\r
 VOID\r
 EhcFreeSched (\r
@@ -56,8 +54,6 @@ EhcFreeSched (
   @param  Ehc            The EHCI device.\r
   @param  Qh             The queue head to link.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcLinkQhToAsync (\r
@@ -73,8 +69,6 @@ EhcLinkQhToAsync (
   @param  Ehc            The EHCI device.\r
   @param  Qh             The queue head to unlink.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcUnlinkQhFromAsync (\r
@@ -91,8 +85,6 @@ EhcUnlinkQhFromAsync (
   @param  Ehc            The EHCI device.\r
   @param  Qh             The queue head to link.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcLinkQhToPeriod (\r
@@ -108,8 +100,6 @@ EhcLinkQhToPeriod (
   @param  Ehc            The EHCI device.\r
   @param  Qh             The queue head to unlink.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcUnlinkQhFromPeriod (\r
@@ -166,8 +156,6 @@ EhciDelAsyncIntTransfer (
 \r
   @param  Ehc            The EHCI device.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhciDelAllAsyncIntTransfers (\r
@@ -181,11 +169,9 @@ EhciDelAllAsyncIntTransfers (
   @param  Event          Interrupt event.\r
   @param  Context        Pointer to USB2_HC_DEV.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
-EhcMoniteAsyncRequests (\r
+EhcMonitorAsyncRequests (\r
   IN EFI_EVENT            Event,\r
   IN VOID                 *Context\r
   );\r
index 4d8e38be2cc557e3517e3a2676256bd4f2f40d0a..6d1bf9b3367e2e8351af4e819fd3cd89ef2e0fca 100644 (file)
@@ -3,7 +3,7 @@
     This file contains URB request, each request is warpped in a\r
     URB (Usb Request Block).\r
 \r
-Copyright (c) 2007, Intel Corporation\r
+Copyright (c) 2007 - 2009, 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
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -125,8 +125,6 @@ EhcCreateQtd (
   @param  Ep                    The queue head's related endpoint.\r
   @param  QhHw                  The queue head to initialize.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcInitIntQh (\r
@@ -293,8 +291,6 @@ EhcConvertPollRate (
   @param  Ehc                   The EHCI device.\r
   @param  Qtds                  The list head of the QTD.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcFreeQtds (\r
@@ -321,8 +317,6 @@ EhcFreeQtds (
   @param  Ehc                   The EHCI device.\r
   @param  Urb                   The URB to free.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcFreeUrb (\r
index 7b66184a19acf2f7abcca90c843eabf4f63bb211..1079be003b77891c36eca3f57d5d6eb18f0c4a69 100644 (file)
@@ -3,7 +3,7 @@
     This file contains URB request, each request is warpped in a\r
     URB (Usb Request Block).\r
 \r
-Copyright (c) 2007, Intel Corporation\r
+Copyright (c) 2007 - 2009, 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
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -287,8 +287,6 @@ EhcCreateQh (
   @param  Ehc        The EHCI device.\r
   @param  Urb        The URB to free.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcFreeUrb (\r
index 92d7bf7a84414ac8fb46f54d6f80c5f2bf1176a4..af8070e569baa4c77d158e6234dcecf458248c06 100644 (file)
@@ -2,7 +2,7 @@
 \r
   Routine procedures for memory allocate/free.\r
 \r
-Copyright (c) 2007, Intel Corporation\r
+Copyright (c) 2007 - 2009, 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
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -124,8 +124,6 @@ FREE_BITARRAY:
   @param  Pool           The memory pool to free the block from.\r
   @param  Block          The memory block to free.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 UsbHcFreeMemBlock (\r
@@ -230,8 +228,6 @@ UsbHcAllocMemFromBlock (
   @param  Head           The head of the memory pool's block list.\r
   @param  Block          The memory block to insert.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 UsbHcInsertMemBlockToPool (\r
@@ -277,8 +273,6 @@ UsbHcIsMemBlockEmpty (
   @param  Head           The block list head of the memory's pool.\r
   @param  BlockToUnlink  The memory block to unlink.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 UsbHcUnlinkMemBlock (\r
@@ -459,8 +453,6 @@ UsbHcAllocateMem (
   @param  Mem            The memory to free.\r
   @param  Size           The size of the memory to free.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 UsbHcFreeMem (\r
index 944acdc11e6e4c3d26b61d4044f034a96684ec7c..c835b66d7aaa7015911bcd8920e53252ce451e78 100644 (file)
@@ -2,7 +2,7 @@
 \r
   This file contains the definination for host controller memory management routines.\r
 \r
-Copyright (c) 2007, Intel Corporation\r
+Copyright (c) 2007 - 2009, 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
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -133,8 +133,6 @@ UsbHcAllocateMem (
   @param  Mem   The memory to free.\r
   @param  Size  The size of the memory to free.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 UsbHcFreeMem (\r