diff options
Diffstat (limited to 'MdePkg/Include/Library/PostCodeLib.h')
| -rw-r--r-- | MdePkg/Include/Library/PostCodeLib.h | 64 |
1 files changed, 29 insertions, 35 deletions
diff --git a/MdePkg/Include/Library/PostCodeLib.h b/MdePkg/Include/Library/PostCodeLib.h index bfc0b227079a..df43c06ad8ea 100644 --- a/MdePkg/Include/Library/PostCodeLib.h +++ b/MdePkg/Include/Library/PostCodeLib.h @@ -1,14 +1,8 @@ /** @file Provides services to send progress/error codes to a POST card. -Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR> -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. +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR> +SPDX-License-Identifier: BSD-2-Clause-Patent **/ @@ -21,14 +15,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /** 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 - directly to a POST card device. Other implementations may send Value to - ReportStatusCode(), and the status code reporting mechanism will eventually + 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 + directly to a POST card device. Other implementations may send Value to + ReportStatusCode(), and the status code reporting mechanism will eventually display the 32-bit value on the status reporting device. - - PostCode() must actively prevent recursion. If PostCode() is called while - processing another Post Code Library function, then + + PostCode() must actively prevent recursion. If PostCode() is called while + processing another Post Code Library function, then PostCode() must return Value immediately. @param Value The 32-bit value to write to the POST card. @@ -47,21 +41,21 @@ PostCode ( 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 - also passed to the handler that displays the POST card value. Some - implementations of this library function may perform I/O operations directly - to a POST card device. Other implementations may send Value to ReportStatusCode(), - and the status code reporting mechanism will eventually display the 32-bit - 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 + If Description is not NULL, then the ASCII string specified by Description is + also passed to the handler that displays the POST card value. Some + implementations of this library function may perform I/O operations directly + to a POST card device. Other implementations may send Value to ReportStatusCode(), + and the status code reporting mechanism will eventually display the 32-bit + 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. @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 + @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 The 32-bit value to write to the POST card. @@ -78,12 +72,12 @@ PostCodeWithDescription ( /** Returns TRUE if POST Codes are enabled. - This function returns TRUE if the POST_CODE_PROPERTY_POST_CODE_ENABLED + This function returns TRUE if the POST_CODE_PROPERTY_POST_CODE_ENABLED bit of PcdPostCodePropertyMask is set. Otherwise FALSE is returned. - @retval TRUE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of + @retval TRUE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of PcdPostCodeProperyMask is set. - @retval FALSE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of + @retval FALSE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of PcdPostCodeProperyMask is clear. **/ @@ -116,7 +110,7 @@ PostCodeDescriptionEnabled ( /** Sends a 32-bit value to a POST card. - If POST codes are enabled in PcdPostCodeProperyMask, then call PostCode() + If POST codes are enabled in PcdPostCodeProperyMask, then call PostCode() passing in Value. Value is returned. @param Value The 32-bit value to write to the POST card. @@ -129,13 +123,13 @@ PostCodeDescriptionEnabled ( /** 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 - Value and Description. If only POST codes are enabled, then call PostCode() + If POST codes and POST code descriptions are enabled in + PcdPostCodeProperyMask, then call PostCodeWithDescription() passing in + Value and Description. If only POST codes are enabled, then call PostCode() passing in Value. Value is returned. @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 + @param Description Pointer to an ASCII string that is a description of the POST code value. @return Value The 32-bit value to write to the POST card. |