#include "ReportStatusCodeRouterRuntimeDxe.h"

Functions
VOID EFIAPI	RscHandlerNotification (IN EFI_EVENT Event, IN VOID *Context)

EFI_STATUS EFIAPI	Register (IN EFI_RSC_HANDLER_CALLBACK Callback, IN EFI_TPL Tpl)

EFI_STATUS EFIAPI	Unregister (IN EFI_RSC_HANDLER_CALLBACK Callback)

EFI_STATUS EFIAPI	ReportDispatcher (IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value, IN UINT32 Instance, IN EFI_GUID CallerId OPTIONAL, IN EFI_STATUS_CODE_DATA Data OPTIONAL)

VOID EFIAPI	VirtualAddressChangeCallBack (IN EFI_EVENT Event, IN VOID *Context)

EFI_STATUS EFIAPI	GenericStatusCodeRuntimeDxeEntry (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables
EFI_HANDLE	mHandle = NULL

LIST_ENTRY	mCallbackListHead = INITIALIZE_LIST_HEAD_VARIABLE (mCallbackListHead)

EFI_EVENT	mVirtualAddressChangeEvent = NULL

UINT32	mStatusCodeNestStatus = 0

EFI_STATUS_CODE_PROTOCOL	mStatusCodeProtocol

EFI_RSC_HANDLER_PROTOCOL	mRscHandlerProtocol

Detailed Description

Report Status Code Router Driver which produces Report Stataus Code Handler Protocol and Status Code Runtime Protocol.

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

Definition in file ReportStatusCodeRouterRuntimeDxe.c.

Function Documentation

◆ GenericStatusCodeRuntimeDxeEntry()

EFI_STATUS EFIAPI GenericStatusCodeRuntimeDxeEntry	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Entry point of Generic Status Code Driver.

This function is the entry point of this Generic Status Code Driver. It installs eport Stataus Code Handler Protocol and Status Code Runtime Protocol, and registers event for EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.

Parameters

ImageHandle	The firmware allocated handle for the EFI image.
SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS The entry point is executed successfully.

Definition at line 383 of file ReportStatusCodeRouterRuntimeDxe.c.

◆ Register()

EFI_STATUS EFIAPI Register	(	IN EFI_RSC_HANDLER_CALLBACK	Callback,
		IN EFI_TPL	Tpl
	)

Register the callback function for ReportStatusCode() notification.

When this function is called the function pointer is added to an internal list and any future calls to ReportStatusCode() will be forwarded to the Callback function. During the bootservices, this is the callback for which this service can be invoked. The report status code router will create an event such that the callback function is only invoked at the TPL for which it was registered. The entity that registers for the callback should also register for an event upon generation of exit boot services and invoke the unregister service. If the handler does not have a TPL dependency, it should register for a callback at TPL high. The router infrastructure will support making callbacks at runtime, but the caller for runtime invocation must meet the following criteria:

must be a runtime driver type so that its memory is not reclaimed
not unregister at exit boot services so that the router will still have its callback address
the caller must be self-contained (eg. Not call out into any boot-service interfaces) and be runtime safe, in general.

Parameters

[in]	Callback	A pointer to a function of type EFI_RSC_HANDLER_CALLBACK that is called when a call to ReportStatusCode() occurs.
[in]	Tpl	TPL at which callback can be safely invoked.

Return values

EFI_SUCCESS	Function was successfully registered.
EFI_INVALID_PARAMETER	The callback function was NULL.
EFI_OUT_OF_RESOURCES	The internal buffer ran out of space. No more functions can be registered.
EFI_ALREADY_STARTED	The function was already registered. It can't be registered again.

Definition at line 105 of file ReportStatusCodeRouterRuntimeDxe.c.

◆ ReportDispatcher()

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

Provides an interface that a software module can call to report a status code.

Parameters

Type	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	The function completed successfully
EFI_DEVICE_ERROR	The function should not be completed due to a device error.

Definition at line 229 of file ReportStatusCodeRouterRuntimeDxe.c.

◆ RscHandlerNotification()

VOID EFIAPI RscHandlerNotification	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Event callback function to invoke status code handler in list.

Parameters

Event	Event whose notification function is being invoked.
Context	Pointer to the notification function's context, which is always zero in current implementation.

Definition at line 42 of file ReportStatusCodeRouterRuntimeDxe.c.

◆ Unregister()

EFI_STATUS EFIAPI Unregister ( IN EFI_RSC_HANDLER_CALLBACK Callback )

Remove a previously registered callback function from the notification list.

A callback function must be unregistered before it is deallocated. It is important that any registered callbacks that are not runtime complaint be unregistered when ExitBootServices() is called.

Parameters

[in] Callback A pointer to a function of type EFI_RSC_HANDLER_CALLBACK that is to be unregistered.

Return values

EFI_SUCCESS	The function was successfully unregistered.
EFI_INVALID_PARAMETER	The callback function was NULL.
EFI_NOT_FOUND	The callback function was not found to be unregistered.

Definition at line 178 of file ReportStatusCodeRouterRuntimeDxe.c.

◆ VirtualAddressChangeCallBack()

VOID EFIAPI VirtualAddressChangeCallBack	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Virtual address change notification call back. It converts global pointer to virtual address.

Parameters

Event	Event whose notification function is being invoked.
Context	Pointer to the notification function's context, which is always zero in current implementation.

Definition at line 346 of file ReportStatusCodeRouterRuntimeDxe.c.