/** @file | |
Internal include file for Status Code Handler PEIM. | |
Copyright (c) 2006 - 2012, 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. | |
**/ | |
#ifndef __STATUS_CODE_HANDLER_PEI_H__ | |
#define __STATUS_CODE_HANDLER_PEI_H__ | |
#include <Ppi/ReportStatusCodeHandler.h> | |
#include <Guid/MemoryStatusCodeRecord.h> | |
#include <Guid/StatusCodeDataTypeId.h> | |
#include <Guid/StatusCodeDataTypeDebug.h> | |
#include <Library/DebugLib.h> | |
#include <Library/PrintLib.h> | |
#include <Library/ReportStatusCodeLib.h> | |
#include <Library/SerialPortLib.h> | |
#include <Library/HobLib.h> | |
#include <Library/PcdLib.h> | |
#include <Library/PeiServicesLib.h> | |
#include <Library/PeimEntryPoint.h> | |
#include <Library/BaseMemoryLib.h> | |
// | |
// Define the maximum message length | |
// | |
#define MAX_DEBUG_MESSAGE_LENGTH 0x100 | |
/** | |
Convert status code value and extended data to readable ASCII string, send string to serial I/O device. | |
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. | |
@param CodeType Indicates the type of status code being reported. | |
@param Value Describes the current status of a hardware or | |
software entity. This includes information about the class and | |
subclass that is used to classify the entity as well as an operation. | |
For progress codes, the operation is the current activity. | |
For error codes, it is the exception.For debug codes,it is not defined at this time. | |
@param Instance The enumeration of a hardware or software entity within | |
the system. A system may contain multiple entities that match a class/subclass | |
pairing. The instance differentiates between them. An instance of 0 indicates | |
that instance information is unavailable, not meaningful, or not relevant. | |
Valid instance numbers start with 1. | |
@param CallerId This optional parameter may be used to identify the caller. | |
This parameter allows the status code driver to apply different rules to | |
different callers. | |
@param Data This optional parameter may be used to pass additional data. | |
@retval EFI_SUCCESS Status code reported to serial I/O successfully. | |
**/ | |
EFI_STATUS | |
EFIAPI | |
SerialStatusCodeReportWorker ( | |
IN CONST EFI_PEI_SERVICES **PeiServices, | |
IN EFI_STATUS_CODE_TYPE CodeType, | |
IN EFI_STATUS_CODE_VALUE Value, | |
IN UINT32 Instance, | |
IN CONST EFI_GUID *CallerId, | |
IN CONST EFI_STATUS_CODE_DATA *Data OPTIONAL | |
); | |
/** | |
Create the first memory status code GUID'ed HOB as initialization for memory status code worker. | |
@retval EFI_SUCCESS The GUID'ed HOB is created successfully. | |
**/ | |
EFI_STATUS | |
MemoryStatusCodeInitializeWorker ( | |
VOID | |
); | |
/** | |
Report status code into GUID'ed HOB. | |
This function reports status code into GUID'ed HOB. If not all packets are full, then | |
write status code into available entry. Otherwise, create a new packet for it. | |
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. | |
@param CodeType Indicates the type of status code being reported. | |
@param Value Describes the current status of a hardware or | |
software entity. This includes information about the class and | |
subclass that is used to classify the entity as well as an operation. | |
For progress codes, the operation is the current activity. | |
For error codes, it is the exception.For debug codes,it is not defined at this time. | |
@param Instance The enumeration of a hardware or software entity within | |
the system. A system may contain multiple entities that match a class/subclass | |
pairing. The instance differentiates between them. An instance of 0 indicates | |
that instance information is unavailable, not meaningful, or not relevant. | |
Valid instance numbers start with 1. | |
@param CallerId This optional parameter may be used to identify the caller. | |
This parameter allows the status code driver to apply different rules to | |
different callers. | |
@param Data This optional parameter may be used to pass additional data. | |
@retval EFI_SUCCESS The function always return EFI_SUCCESS. | |
**/ | |
EFI_STATUS | |
EFIAPI | |
MemoryStatusCodeReportWorker ( | |
IN CONST EFI_PEI_SERVICES **PeiServices, | |
IN EFI_STATUS_CODE_TYPE CodeType, | |
IN EFI_STATUS_CODE_VALUE Value, | |
IN UINT32 Instance, | |
IN CONST EFI_GUID *CallerId, | |
IN CONST EFI_STATUS_CODE_DATA *Data OPTIONAL | |
); | |
#endif | |