Code scrub for the Debug library, PostCode library, Print library, and ExtractGuidedS...

[mirror_edk2.git] / MdePkg / Library / BasePostCodeLibPort80 / PostCode.c

diff --git a/MdePkg/Library/BasePostCodeLibPort80/PostCode.c b/MdePkg/Library/BasePostCodeLibPort80/PostCode.c
index 7ac4efce28f27b001008615b40a804a06bcac311..358c9ba1da0f66592fc10819a0f8c0beef764ea8 100644 (file)
--- a/MdePkg/Library/BasePostCodeLibPort80/PostCode.c
+++ b/MdePkg/Library/BasePostCodeLibPort80/PostCode.c
@@ -1,7 +1,7 @@
 /** @file\r
-  Report Status Code Library Post Code functions for DXE Phase.\r
+  Post Code Library instance that writes post code values to I/O port 0x80.\r
 \r
-  Copyright (c) 2006, 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
@@ -31,12 +31,12 @@
   display the 32-bit value on the status reporting device.\r
   \r
   PostCode() must actively prevent recursion.  If PostCode() is called while \r
-  processing another any other Report Status Code Library function, then \r
+  processing another any other Post Code Library function, then \r
   PostCode() must return Value immediately.\r
 \r
   @param  Value  The 32-bit value to write to the POST card.\r
 \r
-  @return  Value\r
+  @return  Value The 32-bit value to write to the POST card.\r
 \r
 **/\r
 UINT32\r
@@ -62,16 +62,16 @@ PostCode (
   value on the status reporting device.  \r
 \r
   PostCodeWithDescription()must actively prevent recursion.  If \r
-  PostCodeWithDescription() is called while processing another any other Report \r
-  Status Code Library function, then PostCodeWithDescription() must return Value \r
+  PostCodeWithDescription() is called while processing another any other Post \r
+  Code Library function, then PostCodeWithDescription() must return Value \r
   immediately.\r
 \r
   @param  Value        The 32-bit value to write to the POST card.\r
   @param  Description  Pointer to an ASCII string that is a description of the \r
                        POST code value.  This is an optional parameter that may \r
-                       be NULL.\r
+                       be NULL. Ihis parameter is ignored in this implementation. \r
 \r
-  @return  Value\r
+  @return  Value       The 32-bit value to write to the POST card.\r
 \r
 **/\r
 UINT32\r
@@ -111,14 +111,13 @@ PostCodeEnabled (
 /**\r
   Returns TRUE if POST code descriptions are enabled.\r
 \r
-  This function returns TRUE if the \r
-  POST_CODE_PROPERTY_POST_CODE_ENABLED bit of \r
-  PcdPostCodePropertyMask is set.  Otherwise FALSE is returned.\r
+  This function returns TRUE if the POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED\r
+  bit of PcdPostCodePropertyMask is set.  Otherwise FALSE is returned.\r
 \r
-  @retval  TRUE   The POST_CODE_PROPERTY_POST_CODE_ENABLED \r
-                  bit of PcdPostCodeProperyMask is set.\r
-  @retval  FALSE  The POST_CODE_PROPERTY_POST_CODE_ENABLED \r
-                  bit of PcdPostCodeProperyMask is clear.\r
+  @retval  TRUE   The POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED bit of\r
+                  PcdPostCodeProperyMask is set.\r
+  @retval  FALSE  The POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED bit of\r
+                  PcdPostCodeProperyMask is clear.\r
 \r
 **/\r
 BOOLEAN\r
@@ -127,5 +126,5 @@ PostCodeDescriptionEnabled (
   VOID\r
   )\r
 {\r
-  return (BOOLEAN) ((PcdGet8(PcdPostCodePropertyMask) & POST_CODE_PROPERTY_POST_CODE_ENABLED) != 0);\r
+  return (BOOLEAN) ((PcdGet8(PcdPostCodePropertyMask) & POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED) != 0);\r
 }\r