Minor grammatical work--mostly adding periods. Sending separately a list of files...

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

diff --git a/MdePkg/Library/BaseLib/Ia32/CpuIdEx.c b/MdePkg/Library/BaseLib/Ia32/CpuIdEx.c
index 6ebbcbcf109552c00e7fd59a84b042e552351499..9f6463d1ea09aa60c8f791fe25e16d8a73564603 100644 (file)
--- a/MdePkg/Library/BaseLib/Ia32/CpuIdEx.c
+++ b/MdePkg/Library/BaseLib/Ia32/CpuIdEx.c
@@ -1,19 +1,49 @@
 /** @file\r
   AsmCpuidEx function.\r
 \r
-  Copyright (c) 2006, Intel Corporation<BR>\r
-  All rights reserved. This program and the accompanying materials\r
+  Copyright (c) 2006 - 2010, 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
+  http://opensource.org/licenses/bsd-license.php.\r
 \r
   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
 **/\r
 \r
-#if _MSC_EXTENSIONS\r
+/**\r
+  Retrieves CPUID information using an extended leaf identifier.\r
 \r
+  Executes the CPUID instruction with EAX set to the value specified by Index\r
+  and ECX set to the value specified by SubIndex. This function always returns\r
+  Index. This function is only available on IA-32 and x64.\r
+\r
+  If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.\r
+  If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.\r
+  If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.\r
+  If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.\r
+\r
+  @param  Index         The 32-bit value to load into EAX prior to invoking the\r
+                        CPUID instruction.\r
+  @param  SubIndex      The 32-bit value to load into ECX prior to invoking the\r
+                        CPUID instruction.\r
+  @param  RegisterEax   A pointer to the 32-bit EAX value returned by the CPUID\r
+                        instruction. This is an optional parameter that may be\r
+                        NULL.\r
+  @param  RegisterEbx   A pointer to the 32-bit EBX value returned by the CPUID\r
+                        instruction. This is an optional parameter that may be\r
+                        NULL.\r
+  @param  RegisterEcx   A pointer to the 32-bit ECX value returned by the CPUID\r
+                        instruction. This is an optional parameter that may be\r
+                        NULL.\r
+  @param  RegisterEdx   A pointer to the 32-bit EDX value returned by the CPUID\r
+                        instruction. This is an optional parameter that may be\r
+                        NULL.\r
+\r
+  @return Index.\r
+\r
+**/\r
 UINT32\r
 EFIAPI\r
 AsmCpuidEx (\r
@@ -50,5 +80,3 @@ SkipEdx:
     mov     eax, Index\r
   }\r
 }\r
-\r
-#endif\r