ReportStatusCodeRouterCommon.h File Reference

#include <Protocol/MmReportStatusCodeHandler.h>
#include <Protocol/MmStatusCode.h>
#include <Library/BaseLib.h>
#include <Library/SynchronizationLib.h>
#include <Library/DebugLib.h>
#include <Library/PcdLib.h>
#include <Library/MmServicesTableLib.h>
#include <Library/MemoryAllocationLib.h>

Go to the source code of this file.

Data Structures
struct	MM_RSC_HANDLER_CALLBACK_ENTRY

Macros
#define	MM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE   SIGNATURE_32 ('s', 'h', 'c', 'e')

Functions
EFI_STATUS EFIAPI	Register (IN EFI_MM_RSC_HANDLER_CALLBACK Callback)
EFI_STATUS EFIAPI	Unregister (IN EFI_MM_RSC_HANDLER_CALLBACK Callback)
EFI_STATUS EFIAPI	ReportDispatcher (IN CONST EFI_MM_STATUS_CODE_PROTOCOL *This, IN EFI_STATUS_CODE_TYPE CodeType, IN EFI_STATUS_CODE_VALUE Value, IN UINT32 Instance, IN CONST EFI_GUID *CallerId, IN EFI_STATUS_CODE_DATA *Data OPTIONAL)
EFI_STATUS	GenericStatusCodeCommonEntry (VOID)

Detailed Description

Internal include file for Report Status Code Router Driver.

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

Definition in file ReportStatusCodeRouterCommon.h.

Macro Definition Documentation

MM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE

#define MM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE   SIGNATURE_32 ('s', 'h', 'c', 'e')

Definition at line 22 of file ReportStatusCodeRouterCommon.h.

Function Documentation

GenericStatusCodeCommonEntry()

EFI_STATUS GenericStatusCodeCommonEntry

(

VOID

)

Entry point of Generic Status Code Driver.

This function is the common entry point of MM Status Code Router. It produces MM Report Status Code Handler and Status Code protocol.

Return values

EFI_SUCCESS

The entry point is executed successfully.

Definition at line 194 of file ReportStatusCodeRouterCommon.c.

Register()

EFI_STATUS EFIAPI Register

(

IN EFI_MM_RSC_HANDLER_CALLBACK

Callback

)

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.

Parameters

[in]

Callback

A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is called when a call to ReportStatusCode() occurs.

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 47 of file ReportStatusCodeRouterCommon.c.

ReportDispatcher()

EFI_STATUS EFIAPI ReportDispatcher	(	IN CONST EFI_MM_STATUS_CODE_PROTOCOL *	This,
		IN EFI_STATUS_CODE_TYPE	CodeType,
		IN EFI_STATUS_CODE_VALUE	Value,
		IN UINT32	Instance,
		IN CONST EFI_GUID *	CallerId,
		IN EFI_STATUS_CODE_DATA *Data	OPTIONAL
	)

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

Parameters

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

Definition at line 141 of file ReportStatusCodeRouterCommon.c.

Unregister()

EFI_STATUS EFIAPI Unregister

(

IN EFI_MM_RSC_HANDLER_CALLBACK

Callback

)

Remove a previously registered callback function from the notification list.

ReportStatusCode() messages will no longer be forwarded to the Callback function.

Parameters

[in]

Callback

A pointer to a function of type EFI_PEI_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.

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.