4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The instance of Post Code Library that layers on top of a Debug Library instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync http://opensource.org/licenses/bsd-license.php.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Base.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/PostCodeLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/DebugLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/PcdLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sends an 32-bit value to a POST card.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sends the 32-bit value specified by Value to a POST card, and returns Value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Some implementations of this library function may perform I/O operations
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync directly to a POST card device. Other implementations may send Value to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ReportStatusCode(), and the status code reporting mechanism will eventually
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync display the 32-bit value on the status reporting device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PostCode() must actively prevent recursion. If PostCode() is called while
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync processing another any other Post Code Library function, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PostCode() must return Value immediately.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Value The 32-bit value to write to the POST card.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The 32-bit value to write to the POST card.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncUINT32
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncPostCode (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT32 Value
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DEBUG((EFI_D_INFO, "POST %08x\n", Value));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return Value;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sends an 32-bit value to a POST and associated ASCII string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sends the 32-bit value specified by Value to a POST card, and returns Value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Description is not NULL, then the ASCII string specified by Description is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync also passed to the handler that displays the POST card value. Some
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync implementations of this library function may perform I/O operations directly
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to a POST card device. Other implementations may send Value to ReportStatusCode(),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and the status code reporting mechanism will eventually display the 32-bit
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync value on the status reporting device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PostCodeWithDescription()must actively prevent recursion. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PostCodeWithDescription() is called while processing another any other Post
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Code Library function, then PostCodeWithDescription() must return Value
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync immediately.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Value The 32-bit value to write to the POST card.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Description The pointer to an ASCII string that is a description of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync POST code value. This is an optional parameter that may
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The 32-bit value to write to the POST card.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncUINT32
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncPostCodeWithDescription (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT32 Value,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN CONST CHAR8 *Description OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DEBUG((EFI_D_INFO, "POST %08x - %s\n", Value, Description));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return Value;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns TRUE if POST Codes are enabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns TRUE if the POST_CODE_PROPERTY_POST_CODE_ENABLED
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bit of PcdPostCodePropertyMask is set. Otherwise FALSE is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PcdPostCodeProperyMask is set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PcdPostCodeProperyMask is clear.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncBOOLEAN
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncPostCodeEnabled (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (BOOLEAN) ((PcdGet8(PcdPostCodePropertyMask) & POST_CODE_PROPERTY_POST_CODE_ENABLED) != 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns TRUE if POST code descriptions are enabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns TRUE if the POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bit of PcdPostCodePropertyMask is set. Otherwise FALSE is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE The POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED bit of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PcdPostCodeProperyMask is set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE The POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED bit of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PcdPostCodeProperyMask is clear.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncBOOLEAN
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncPostCodeDescriptionEnabled (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (BOOLEAN) ((PcdGet8(PcdPostCodePropertyMask) & POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED) != 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}