MmReportStatusCodeHandler.h File Reference

Data Structures
struct	_EFI_MM_RSC_HANDLER_PROTOCOL

Macros
#define	EFI_MM_RSC_HANDLER_PROTOCOL_GUID

Typedefs
typedef EFI_STATUS(EFIAPI *	EFI_MM_RSC_HANDLER_CALLBACK )(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)
typedef EFI_STATUS(EFIAPI *	EFI_MM_RSC_HANDLER_REGISTER )(IN EFI_MM_RSC_HANDLER_CALLBACK Callback)
typedef EFI_STATUS(EFIAPI *	EFI_MM_RSC_HANDLER_UNREGISTER )(IN EFI_MM_RSC_HANDLER_CALLBACK Callback)
typedef struct _EFI_MM_RSC_HANDLER_PROTOCOL	EFI_MM_RSC_HANDLER_PROTOCOL

Variables
EFI_GUID	gEfiMmRscHandlerProtocolGuid

Detailed Description

This protocol provides registering and unregistering services to status code consumers while in DXE MM.

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

Revision Reference:

This Protocol was introduced in PI Specification 1.1.

Macro Definition Documentation

#define EFI_MM_RSC_HANDLER_PROTOCOL_GUID

Value:

{ \
    0x2ff29fa7, 0x5e80, 0x4ed9, {0xb3, 0x80, 0x1, 0x7d, 0x3c, 0x55, 0x4f, 0xf4} \
  }

Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_MM_RSC_HANDLER_CALLBACK)(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)

typedef struct _EFI_MM_RSC_HANDLER_PROTOCOL EFI_MM_RSC_HANDLER_PROTOCOL

typedef EFI_STATUS(EFIAPI * EFI_MM_RSC_HANDLER_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_MM_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.

typedef EFI_STATUS(EFIAPI * EFI_MM_RSC_HANDLER_UNREGISTER)(IN EFI_MM_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_MM_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.

Variable Documentation

EFI_GUID gEfiMmRscHandlerProtocolGuid