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

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

diff --git a/MdePkg/Library/BasePostCodeLibDebug/PostCode.c b/MdePkg/Library/BasePostCodeLibDebug/PostCode.c
index f929ba811dd04d3ad815b855dd94d2d49e4e5fc1..4335acb1aea2fff605cd960496c3fc51ecc16cb7 100644 (file)
--- a/MdePkg/Library/BasePostCodeLibDebug/PostCode.c
+++ b/MdePkg/Library/BasePostCodeLibDebug/PostCode.c
@@ -1,7 +1,7 @@
 /** @file\r
-  Report Status Code Library Post Code functions for DXE Phase.\r
+  Base Post Code Library instance based on Debug Library.\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
@@ -13,10 +13,13 @@
 **/\r
 \r
 \r
-//\r
-// Include common header file for this module.\r
-//\r
-#include "CommonHeader.h"\r
+\r
+#include <Base.h>\r
+\r
+\r
+#include <Library/PostCodeLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/PcdLib.h>\r
 \r
 /**\r
   Sends an 32-bit value to a POST card.\r
@@ -28,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
+  @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
@@ -59,8 +62,8 @@ 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
@@ -68,7 +71,7 @@ PostCode (
                        POST code value.  This is an optional parameter that may \r
                        be NULL.\r
 \r
-  @return  Value\r
+  @return  Value       The 32-bit value to write to the POST card.\r
 \r
 **/\r
 UINT32\r
@@ -108,12 +111,12 @@ PostCodeEnabled (
 /**\r
   Returns TRUE if POST code descriptions are enabled.\r
 \r
-  This function returns TRUE if the POST_CODE_PROPERTY_POST_CODE_ENABLED\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 bit of\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_ENABLED bit of\r
+  @retval  FALSE  The POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED bit of\r
                   PcdPostCodeProperyMask is clear.\r
 \r
 **/\r
@@ -123,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