]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/PeiDxePostCodeLibReportStatusCode/PostCode.c
MdePkg: Apply uncrustify changes
[mirror_edk2.git] / MdePkg / Library / PeiDxePostCodeLibReportStatusCode / PostCode.c
index 3d5901548be4d282d1bc3eb60165392901670916..bf2da0c0cf25a7643684190f30673ede1b90c9fe 100644 (file)
@@ -1,18 +1,12 @@
 /** @file\r
-  Report Status Code Library Post Code functions for DXE Phase.\r
+  Post code library instace bases on report status code library\r
+  PostCode Library for PEIMs and DXE drivers that send PostCode to ReportStatusCode\r
 \r
-  Copyright (c) 2006, 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
-  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
+  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
-\r
 #include <PiPei.h>\r
 \r
 #include <Library/PostCodeLib.h>\r
   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 The 32-bit value to write to the POST card.\r
 \r
 **/\r
 UINT32\r
@@ -63,7 +57,6 @@ PostCode (
   return Value;\r
 }\r
 \r
-\r
 /**\r
   Sends an 32-bit value to a POST and associated ASCII string.\r
 \r
@@ -76,16 +69,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
+  @param  Description  The 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
 \r
-  @return  Value\r
+  @return The 32-bit value to write to the POST card.\r
 \r
 **/\r
 UINT32\r
@@ -112,7 +105,6 @@ PostCodeWithDescription (
   return Value;\r
 }\r
 \r
-\r
 /**\r
   Returns TRUE if POST Codes are enabled.\r
 \r
@@ -131,21 +123,19 @@ PostCodeEnabled (
   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_ENABLED) != 0);\r
 }\r
 \r
-\r
 /**\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
@@ -154,5 +144,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