]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Library/PostCodeLib.h
MdePkg UefiLib: Make the event empty function public
[mirror_edk2.git] / MdePkg / Include / Library / PostCodeLib.h
index 17ece49e4d03ead316b72d56321ee9a312680926..9a7a9e6a9967962dad9c3d81b63662f1aac1ea87 100644 (file)
@@ -1,14 +1,14 @@
 /** @file\r
-  Post Code Library functions defintion.\r
+  Provides services to send progress/error codes to a POST card.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         \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
+Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+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
+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
 \r
 **/\r
 \r
@@ -19,7 +19,7 @@
 #define POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED  0x00000010\r
 \r
 /**\r
-  Sends an 32-bit value to a POST card.\r
+  Sends a 32-bit value to a POST card.\r
 \r
   Sends the 32-bit value specified by Value to a POST card, and returns Value.  \r
   Some implementations of this library function may perform I/O operations \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 Post Code Library function, then \r
+  processing another 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 The 32-bit value to write to the POST card.\r
+  @return The 32-bit value to write to the POST card.\r
 \r
 **/\r
 UINT32\r
@@ -44,7 +44,7 @@ PostCode (
 \r
 \r
 /**\r
-  Sends an 32-bit value to a POST and associated ASCII string.\r
+  Sends a 32-bit value to a POST and associated ASCII string.\r
 \r
   Sends the 32-bit value specified by Value to a POST card, and returns Value.\r
   If Description is not NULL, then the ASCII string specified by Description is \r
@@ -55,16 +55,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 \r
-  Post Code Library function, then PostCodeWithDescription() \r
-  must return Value immediately.\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
 \r
-  @return  Value       The 32-bit value to write to the POST card.\r
+  @return The 32-bit value to write to the POST card.\r
 \r
 **/\r
 UINT32\r
@@ -114,7 +114,7 @@ PostCodeDescriptionEnabled (
 \r
 \r
 /**\r
-  Sends an 32-bit value to a POST card.\r
+  Sends a 32-bit value to a POST card.\r
 \r
   If POST codes are enabled in PcdPostCodeProperyMask, then call PostCode() \r
   passing in Value.  Value is returned.\r
@@ -127,7 +127,7 @@ PostCodeDescriptionEnabled (
 #define POST_CODE(Value)  PostCodeEnabled() ? PostCode(Value) : Value\r
 \r
 /**\r
-  Sends an 32-bit value to a POST and associated ASCII string.\r
+  Sends a 32-bit value to a POST and associated ASCII string.\r
 \r
   If POST codes and POST code descriptions are enabled in \r
   PcdPostCodeProperyMask, then call PostCodeWithDescription() passing in \r