ECC Cleanup.

[mirror_edk2.git] / MdePkg / Library / BaseLib / Ia32 / ReadPmc.c

diff --git a/MdePkg/Library/BaseLib/Ia32/ReadPmc.c b/MdePkg/Library/BaseLib/Ia32/ReadPmc.c
index 761fa6bf4ed90025188f5dce16306b6fe6bffcda..e37425ada495795dc7008090ac94b6b41fc7f80c 100644 (file)
--- a/MdePkg/Library/BaseLib/Ia32/ReadPmc.c
+++ b/MdePkg/Library/BaseLib/Ia32/ReadPmc.c
@@ -1,7 +1,7 @@
 /** @file\r
   AsmReadPmc function\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation<BR>\r
+  Copyright (c) 2006 - 2008, Intel Corporation<BR>\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
@@ -12,19 +12,25 @@
 \r
 **/\r
 \r
-//\r
-// Include common header file for this module.\r
-//\r
+/**\r
+  Reads the current value of a Performance Counter (PMC).\r
 \r
+  Reads and returns the current value of performance counter specified by\r
+  Index. This function is only available on IA-32 and X64.\r
 \r
+  @param  Index The 32-bit Performance Counter index to read.\r
+\r
+  @return The value of the PMC specified by Index.\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 AsmReadPmc (\r
-  IN UINT32   PmcIndex\r
+  IN UINT32   Index\r
   )\r
 {\r
   _asm {\r
-    mov     ecx, PmcIndex\r
+    mov     ecx, Index\r
     rdpmc\r
   }\r
 }\r