#include <Base.h>
#include <Library/PostCodeLib.h>
#include <Library/DebugLib.h>
#include <Library/PcdLib.h>

Functions
UINT32 EFIAPI	PostCode (IN UINT32 Value)

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

BOOLEAN EFIAPI	PostCodeEnabled (VOID)

BOOLEAN EFIAPI	PostCodeDescriptionEnabled (VOID)

Detailed Description

The instance of Post Code Library that layers on top of a Debug Library instance.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file PostCode.c.

Function Documentation

◆ PostCode()

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.

Definition at line 35 of file PostCode.c.

◆ PostCodeDescriptionEnabled()

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.

Definition at line 113 of file PostCode.c.

◆ PostCodeEnabled()

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.

Definition at line 92 of file PostCode.c.

◆ PostCodeWithDescription()

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

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.