X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FInclude%2FLibrary%2FPostCodeLib.h;h=9a7a9e6a9967962dad9c3d81b63662f1aac1ea87;hp=17ece49e4d03ead316b72d56321ee9a312680926;hb=1b1970630d3f607c4e0c25c491914ef2a3200119;hpb=eceb3a4cb9b97d331ba91ea0a930465c05e8e20b diff --git a/MdePkg/Include/Library/PostCodeLib.h b/MdePkg/Include/Library/PostCodeLib.h index 17ece49e4d..9a7a9e6a99 100644 --- a/MdePkg/Include/Library/PostCodeLib.h +++ b/MdePkg/Include/Library/PostCodeLib.h @@ -1,14 +1,14 @@ /** @file - Post Code Library functions defintion. + Provides services to send progress/error codes to a POST card. - Copyright (c) 2006 - 2008, Intel Corporation - All rights reserved. This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php +Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.
+This program and the accompanying materials +are licensed and made available under the terms and conditions of the BSD License +which accompanies this distribution. The full text of the license may be found at +http://opensource.org/licenses/bsd-license.php - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -19,7 +19,7 @@ #define POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED 0x00000010 /** - Sends an 32-bit value to a POST card. + Sends a 32-bit value to a POST card. Sends the 32-bit value specified by Value to a POST card, and returns Value. Some implementations of this library function may perform I/O operations @@ -28,12 +28,12 @@ display the 32-bit value on the status reporting device. PostCode() must actively prevent recursion. If PostCode() is called while - processing another any other Post Code Library function, then + processing another Post Code Library function, then PostCode() must return Value immediately. @param Value The 32-bit value to write to the POST card. - @return Value The 32-bit value to write to the POST card. + @return The 32-bit value to write to the POST card. **/ UINT32 @@ -44,7 +44,7 @@ PostCode ( /** - Sends an 32-bit value to a POST and associated ASCII string. + Sends a 32-bit value to a POST and associated ASCII string. Sends the 32-bit value specified by Value to a POST card, and returns Value. If Description is not NULL, then the ASCII string specified by Description is @@ -55,16 +55,16 @@ PostCode ( value on the status reporting device. PostCodeWithDescription()must actively prevent recursion. If - PostCodeWithDescription() is called while processing another any other - Post Code Library function, then PostCodeWithDescription() - must return Value immediately. + PostCodeWithDescription() is called while processing another any other Post + Code Library function, then PostCodeWithDescription() must return Value + immediately. @param Value The 32-bit value to write to the POST card. @param Description Pointer to an ASCII string that is a description of the POST code value. This is an optional parameter that may be NULL. - @return Value The 32-bit value to write to the POST card. + @return The 32-bit value to write to the POST card. **/ UINT32 @@ -114,7 +114,7 @@ PostCodeDescriptionEnabled ( /** - Sends an 32-bit value to a POST card. + Sends a 32-bit value to a POST card. If POST codes are enabled in PcdPostCodeProperyMask, then call PostCode() passing in Value. Value is returned. @@ -127,7 +127,7 @@ PostCodeDescriptionEnabled ( #define POST_CODE(Value) PostCodeEnabled() ? PostCode(Value) : Value /** - Sends an 32-bit value to a POST and associated ASCII string. + Sends a 32-bit value to a POST and associated ASCII string. If POST codes and POST code descriptions are enabled in PcdPostCodeProperyMask, then call PostCodeWithDescription() passing in