ReportStatusCodeHandler.h File Reference

Data Structures
struct	_EFI_PEI_RSC_HANDLER_PPI

Macros
#define	EFI_PEI_RSC_HANDLER_PPI_GUID

Typedefs
typedef EFI_STATUS(EFIAPI *	EFI_PEI_RSC_HANDLER_CALLBACK )(IN CONST EFI_PEI_SERVICES **PeiServices, IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value, IN UINT32 Instance, IN CONST EFI_GUID *CallerId, IN CONST EFI_STATUS_CODE_DATA *Data)
typedef EFI_STATUS(EFIAPI *	EFI_PEI_RSC_HANDLER_REGISTER )(IN EFI_PEI_RSC_HANDLER_CALLBACK Callback)
typedef EFI_STATUS(EFIAPI *	EFI_PEI_RSC_HANDLER_UNREGISTER )(IN EFI_PEI_RSC_HANDLER_CALLBACK Callback)
typedef struct _EFI_PEI_RSC_HANDLER_PPI	EFI_PEI_RSC_HANDLER_PPI

Variables
EFI_GUID	gEfiPeiRscHandlerPpiGuid

Detailed Description

This PPI provides registering and unregistering services to status code consumers.

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

Macro Definition Documentation

#define EFI_PEI_RSC_HANDLER_PPI_GUID

Value:

{ \
    0x65d394, 0x9951, 0x4144, {0x82, 0xa3, 0xa, 0xfc, 0x85, 0x79, 0xc2, 0x51} \
  }

Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_PEI_RSC_HANDLER_CALLBACK)(IN CONST EFI_PEI_SERVICES **PeiServices, IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value, IN UINT32 Instance, IN CONST EFI_GUID *CallerId, IN CONST EFI_STATUS_CODE_DATA *Data)

typedef struct _EFI_PEI_RSC_HANDLER_PPI EFI_PEI_RSC_HANDLER_PPI

typedef EFI_STATUS(EFIAPI * EFI_PEI_RSC_HANDLER_REGISTER)(IN EFI_PEI_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.

typedef EFI_STATUS(EFIAPI * EFI_PEI_RSC_HANDLER_UNREGISTER)(IN EFI_PEI_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.

Variable Documentation

EFI_GUID gEfiPeiRscHandlerPpiGuid