Code Scrub for MdePkg.

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

diff --git a/MdePkg/Library/BaseLib/Ia32/ReadMsr64.c b/MdePkg/Library/BaseLib/Ia32/ReadMsr64.c
index d93b9cd6e426473c78f7c760b3fdf0f41fc05817..eed41d41dfa18ad84a409eea5cc8f1a6337b525a 100644 (file)
--- a/MdePkg/Library/BaseLib/Ia32/ReadMsr64.c
+++ b/MdePkg/Library/BaseLib/Ia32/ReadMsr64.c
@@ -17,6 +17,20 @@
 //\r
 \r
 \r
+/**\r
+  Returns a 64-bit Machine Specific Register(MSR).\r
+\r
+  Reads and returns the 64-bit MSR specified by Index. No parameter checking is\r
+  performed on Index, and some Index values may cause CPU exceptions. The\r
+  caller must either guarantee that Index is valid, or the caller must set up\r
+  exception handlers to catch the exceptions. This function is only available\r
+  on IA-32 and X64.\r
+\r
+  @param  Index The 32-bit MSR index to read.\r
+\r
+  @return The value of the MSR identified by Index.\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 AsmReadMsr64 (\r