MdePkg/Library/PeiDxePostCodeLibReportStatusCode/PostCode.c File Reference


Defines

#define POST_CODE_TO_STATUS_CODE_VALUE(PostCode)   ((EFI_STATUS_CODE_VALUE) (((PostCode & 0x1f) << 16) | ((PostCode & 0x3) << 19)))

Functions

UINT32 EFIAPI PostCode (IN UINT32 Value)
UINT32 EFIAPI PostCodeWithDescription (IN UINT32 Value, IN CONST CHAR8 *Description)
BOOLEAN EFIAPI PostCodeEnabled (VOID)
BOOLEAN EFIAPI PostCodeDescriptionEnabled (VOID)

Detailed Description

Post code library instace bases on report status code library PostCode Library for PEIMs and DXE drivers that send PostCode to ReportStatusCode

Copyright (c) 2006 - 2010, 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.


Define Documentation

#define POST_CODE_TO_STATUS_CODE_VALUE ( PostCode   )     ((EFI_STATUS_CODE_VALUE) (((PostCode & 0x1f) << 16) | ((PostCode & 0x3) << 19)))

Converts POST code value to status code value.

This macro converts the post code to status code value. Bits 0..4 of PostCode are mapped to bits 16..20 of status code value, and bits 5..7 of PostCode are mapped to bits 24..26 of status code value.

Parameters:
PostCode POST code value.
Returns:
The converted status code value.

Referenced by PostCode(), and PostCodeWithDescription().


Function Documentation

UINT32 EFIAPI PostCode ( IN UINT32  Value  ) 

Sends an 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 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 PostCode() must return Value immediately.

Parameters:
Value The 32-bit value to write to the POST card.
Returns:
The 32-bit value to write to the POST card.

References EFI_PROGRESS_CODE, POST_CODE_TO_STATUS_CODE_VALUE, and REPORT_STATUS_CODE.

BOOLEAN EFIAPI PostCodeDescriptionEnabled ( VOID   ) 

Returns TRUE if POST code descriptions are enabled.

This function returns TRUE if the POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED bit of PcdPostCodePropertyMask is set. Otherwise FALSE is returned.

Return values:
TRUE The POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED bit of PcdPostCodeProperyMask is set.
FALSE The POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED bit of PcdPostCodeProperyMask is clear.

References PcdGet8, and POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED.

BOOLEAN EFIAPI PostCodeEnabled ( VOID   ) 

Returns TRUE if POST Codes are enabled.

This function returns TRUE if the POST_CODE_PROPERTY_POST_CODE_ENABLED bit of PcdPostCodePropertyMask is set. Otherwise FALSE is returned.

Return values:
TRUE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of PcdPostCodeProperyMask is set.
FALSE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of PcdPostCodeProperyMask is clear.

References PcdGet8, and POST_CODE_PROPERTY_POST_CODE_ENABLED.

UINT32 EFIAPI PostCodeWithDescription ( IN UINT32  Value,
IN CONST CHAR8 Description 
)

Sends an 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 immediately.

Parameters:
Value The 32-bit value to write to the POST card.
Description The pointer to an ASCII string that is a description of the POST code value. This is an optional parameter that may be NULL.
Returns:
The 32-bit value to write to the POST card.

References AsciiStrSize(), EFI_PROGRESS_CODE, NULL, POST_CODE_TO_STATUS_CODE_VALUE, REPORT_STATUS_CODE, and REPORT_STATUS_CODE_WITH_EXTENDED_DATA.


Generated on Thu Sep 24 23:14:23 2015 for MdePkg[ALL] by  doxygen 1.5.7.1