2f88bd3a12
REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3737 Apply uncrustify changes to .c/.h files in the MdePkg package Cc: Andrew Fish <afish@apple.com> Cc: Leif Lindholm <leif@nuviainc.com> Cc: Michael D Kinney <michael.d.kinney@intel.com> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>
149 lines
4.6 KiB
C
149 lines
4.6 KiB
C
/** @file
|
|
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 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#include <PiPei.h>
|
|
|
|
#include <Library/PostCodeLib.h>
|
|
#include <Library/ReportStatusCodeLib.h>
|
|
#include <Library/PcdLib.h>
|
|
#include <Library/BaseLib.h>
|
|
|
|
/**
|
|
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.
|
|
|
|
@param PostCode POST code value.
|
|
|
|
@return The converted status code value.
|
|
|
|
**/
|
|
#define POST_CODE_TO_STATUS_CODE_VALUE(PostCode) \
|
|
((EFI_STATUS_CODE_VALUE) (((PostCode & 0x1f) << 16) | ((PostCode & 0x3) << 19)))
|
|
|
|
/**
|
|
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.
|
|
|
|
@param Value The 32-bit value to write to the POST card.
|
|
|
|
@return The 32-bit value to write to the POST card.
|
|
|
|
**/
|
|
UINT32
|
|
EFIAPI
|
|
PostCode (
|
|
IN UINT32 Value
|
|
)
|
|
{
|
|
REPORT_STATUS_CODE (EFI_PROGRESS_CODE, POST_CODE_TO_STATUS_CODE_VALUE (Value));
|
|
return Value;
|
|
}
|
|
|
|
/**
|
|
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.
|
|
|
|
@param Value The 32-bit value to write to the POST card.
|
|
@param 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.
|
|
|
|
@return The 32-bit value to write to the POST card.
|
|
|
|
**/
|
|
UINT32
|
|
EFIAPI
|
|
PostCodeWithDescription (
|
|
IN UINT32 Value,
|
|
IN CONST CHAR8 *Description OPTIONAL
|
|
)
|
|
{
|
|
if (Description == NULL) {
|
|
REPORT_STATUS_CODE (
|
|
EFI_PROGRESS_CODE,
|
|
POST_CODE_TO_STATUS_CODE_VALUE (Value)
|
|
);
|
|
} else {
|
|
REPORT_STATUS_CODE_WITH_EXTENDED_DATA (
|
|
EFI_PROGRESS_CODE,
|
|
POST_CODE_TO_STATUS_CODE_VALUE (Value),
|
|
Description,
|
|
AsciiStrSize (Description)
|
|
);
|
|
}
|
|
|
|
return Value;
|
|
}
|
|
|
|
/**
|
|
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.
|
|
|
|
@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
|
|
PcdPostCodeProperyMask is clear.
|
|
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
PostCodeEnabled (
|
|
VOID
|
|
)
|
|
{
|
|
return (BOOLEAN)((PcdGet8 (PcdPostCodePropertyMask) & POST_CODE_PROPERTY_POST_CODE_ENABLED) != 0);
|
|
}
|
|
|
|
/**
|
|
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.
|
|
|
|
@retval TRUE The POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED bit of
|
|
PcdPostCodeProperyMask is set.
|
|
@retval FALSE The POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED bit of
|
|
PcdPostCodeProperyMask is clear.
|
|
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
PostCodeDescriptionEnabled (
|
|
VOID
|
|
)
|
|
{
|
|
return (BOOLEAN)((PcdGet8 (PcdPostCodePropertyMask) & POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED) != 0);
|
|
}
|