Add limitation clarification for usage of AsmPrepareThunk16(), AsmThunk16(), AsmPrepa...

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

diff --git a/MdePkg/Library/BaseLib/Ia32/ReadMm5.c b/MdePkg/Library/BaseLib/Ia32/ReadMm5.c
index 6b5d5df5b72a7ded7867847262f7347fefaf90e1..8d212a055d535ba143bf8fa27942748b4a2668b9 100644 (file)
--- a/MdePkg/Library/BaseLib/Ia32/ReadMm5.c
+++ b/MdePkg/Library/BaseLib/Ia32/ReadMm5.c
@@ -1,7 +1,7 @@
 /** @file\r
   AsmReadMm5 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,11 +12,18 @@
 \r
 **/\r
 \r
-//\r
-// Include common header file for this module.\r
-//\r
 \r
 \r
+\r
+/**\r
+  Reads the current value of 64-bit MMX Register #5 (MM5).\r
+\r
+  Reads and returns the current value of MM5. This function is only available\r
+  on IA-32 and x64.\r
+\r
+  @return The current value of MM5.\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 AsmReadMm5 (\r