ReportStatusCodeHandler.h File Reference

Go to the source code of this file.

Data Structures
struct	EFI_RSC_HANDLER_PROTOCOL

Macros
#define	EFI_RSC_HANDLER_PROTOCOL_GUID

Typedefs
typedef EFI_STATUS(EFIAPI *	EFI_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_RSC_HANDLER_REGISTER) (IN EFI_RSC_HANDLER_CALLBACK Callback, IN EFI_TPL Tpl)
typedef EFI_STATUS(EFIAPI *	EFI_RSC_HANDLER_UNREGISTER) (IN EFI_RSC_HANDLER_CALLBACK Callback)

Variables
EFI_GUID	gEfiRscHandlerProtocolGuid

Detailed Description

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

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

Revision Reference:

This Protocol was introduced in PI Specification 1.2.

Definition in file ReportStatusCodeHandler.h.

Macro Definition Documentation

EFI_RSC_HANDLER_PROTOCOL_GUID

#define EFI_RSC_HANDLER_PROTOCOL_GUID

Value:

  { \
    0x86212936, 0xe76, 0x41c8, {0xa0, 0x3a, 0x2a, 0xf2, 0xfc, 0x1c, 0x39, 0xe2} \
  }

Definition at line 16 of file ReportStatusCodeHandler.h.

Typedef Documentation

EFI_RSC_HANDLER_CALLBACK

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

Definition at line 22 of file ReportStatusCodeHandler.h.

EFI_RSC_HANDLER_REGISTER

typedef EFI_STATUS(EFIAPI * EFI_RSC_HANDLER_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:

1. must be a runtime driver type so that its memory is not reclaimed
2. not unregister at exit boot services so that the router will still have its callback address
3. 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 59 of file ReportStatusCodeHandler.h.

EFI_RSC_HANDLER_UNREGISTER

typedef EFI_STATUS(EFIAPI * EFI_RSC_HANDLER_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 79 of file ReportStatusCodeHandler.h.