StatusCodeHandlerRuntimeDxe.h File Reference

#include <Protocol/ReportStatusCodeHandler.h>
#include <Guid/MemoryStatusCodeRecord.h>
#include <Guid/StatusCodeDataTypeId.h>
#include <Guid/StatusCodeDataTypeDebug.h>
#include <Guid/EventGroup.h>
#include <Library/SynchronizationLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/ReportStatusCodeLib.h>
#include <Library/PrintLib.h>
#include <Library/PcdLib.h>
#include <Library/HobLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UefiRuntimeLib.h>
#include <Library/SerialPortLib.h>

Go to the source code of this file.

Macros
#define	MAX_DEBUG_MESSAGE_LENGTH   0x100

Functions
EFI_STATUS	EfiSerialStatusCodeInitializeWorker (VOID)
EFI_STATUS EFIAPI	SerialStatusCodeReportWorker (IN EFI_STATUS_CODE_TYPE CodeType, IN EFI_STATUS_CODE_VALUE Value, IN UINT32 Instance, IN EFI_GUID *CallerId, IN EFI_STATUS_CODE_DATA *Data OPTIONAL)
EFI_STATUS	RtMemoryStatusCodeInitializeWorker (VOID)
EFI_STATUS EFIAPI	RtMemoryStatusCodeReportWorker (IN EFI_STATUS_CODE_TYPE CodeType, IN EFI_STATUS_CODE_VALUE Value, IN UINT32 Instance, IN EFI_GUID *CallerId, IN EFI_STATUS_CODE_DATA *Data OPTIONAL)
VOID EFIAPI	UnregisterSerialBootTimeHandlers (VOID)

Variables
RUNTIME_MEMORY_STATUSCODE_HEADER *	mRtMemoryStatusCodeTable

Detailed Description

Internal include file for Status Code Handler Driver.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
(C) Copyright 2016 Hewlett Packard Enterprise Development LP
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file StatusCodeHandlerRuntimeDxe.h.

Macro Definition Documentation

MAX_DEBUG_MESSAGE_LENGTH

#define MAX_DEBUG_MESSAGE_LENGTH   0x100

Definition at line 36 of file StatusCodeHandlerRuntimeDxe.h.

Function Documentation

EfiSerialStatusCodeInitializeWorker()

EFI_STATUS EfiSerialStatusCodeInitializeWorker

(

VOID

)

Locates Serial I/O Protocol as initialization for serial status code worker.

Return values

EFI_SUCCESS

Serial I/O Protocol is successfully located.

RtMemoryStatusCodeInitializeWorker()

EFI_STATUS RtMemoryStatusCodeInitializeWorker

(

VOID

)

Initialize runtime memory status code table as initialization for runtime memory status code worker

Return values

EFI_SUCCESS	Runtime memory status code table successfully initialized.
others	Errors from gBS->InstallConfigurationTable().

Definition at line 22 of file MemoryStatusCodeWorker.c.

RtMemoryStatusCodeReportWorker()

EFI_STATUS EFIAPI RtMemoryStatusCodeReportWorker	(	IN EFI_STATUS_CODE_TYPE	CodeType,
		IN EFI_STATUS_CODE_VALUE	Value,
		IN UINT32	Instance,
		IN EFI_GUID *	CallerId,
		IN EFI_STATUS_CODE_DATA *Data	OPTIONAL
	)

Report status code into runtime memory. If the runtime pool is full, roll back to the first record and overwrite it.

Parameters

CodeType	Indicates the type of status code being reported.
Value	Describes the current status of a hardware or software entity. This included information about the class and subclass that is used to classify the entity as well as an operation.
Instance	The enumeration of a hardware or software entity within the system. Valid instance numbers start with 1.
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.
Data	This optional parameter may be used to pass additional data.

Return values

EFI_SUCCESS

Status code successfully recorded in runtime memory status code table.

Definition at line 66 of file MemoryStatusCodeWorker.c.

SerialStatusCodeReportWorker()

EFI_STATUS EFIAPI SerialStatusCodeReportWorker	(	IN EFI_STATUS_CODE_TYPE	CodeType,
		IN EFI_STATUS_CODE_VALUE	Value,
		IN UINT32	Instance,
		IN EFI_GUID *	CallerId,
		IN EFI_STATUS_CODE_DATA *Data	OPTIONAL
	)

Convert status code value and extended data to readable ASCII string, send string to serial I/O device.

Parameters

CodeType	Indicates the type of status code being reported.
Value	Describes the current status of a hardware or software entity. This included information about the class and subclass that is used to classify the entity as well as an operation.
Instance	The enumeration of a hardware or software entity within the system. Valid instance numbers start with 1.
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.
Data	This optional parameter may be used to pass additional data.

Return values

EFI_SUCCESS	Status code reported to serial I/O successfully.
EFI_DEVICE_ERROR	EFI serial device cannot work after ExitBootService() is called.
EFI_DEVICE_ERROR	EFI serial device cannot work with TPL higher than TPL_CALLBACK.

Definition at line 32 of file SerialStatusCodeWorker.c.

UnregisterSerialBootTimeHandlers()

VOID EFIAPI UnregisterSerialBootTimeHandlers

(

VOID

)

Unregister status code callback functions only available at boot time from report status code router when exiting boot services.

Definition at line 22 of file StatusCodeHandlerRuntimeDxe.c.

Variable Documentation

mRtMemoryStatusCodeTable

RUNTIME_MEMORY_STATUSCODE_HEADER* mRtMemoryStatusCodeTable

extern

Definition at line 12 of file MemoryStatusCodeWorker.c.