2 This PPI provides registering and unregistering services to status code consumers.
4 Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
9 #ifndef __REPORT_STATUS_CODE_HANDLER_PPI_H__
10 #define __REPORT_STATUS_CODE_HANDLER_PPI_H__
12 #define EFI_PEI_RSC_HANDLER_PPI_GUID \
14 0x65d394, 0x9951, 0x4144, {0x82, 0xa3, 0xa, 0xfc, 0x85, 0x79, 0xc2, 0x51} \
19 (EFIAPI
*EFI_PEI_RSC_HANDLER_CALLBACK
)(
20 IN CONST EFI_PEI_SERVICES
**PeiServices
,
21 IN EFI_STATUS_CODE_TYPE Type
,
22 IN EFI_STATUS_CODE_VALUE Value
,
24 IN CONST EFI_GUID
*CallerId
,
25 IN CONST EFI_STATUS_CODE_DATA
*Data
29 Register the callback function for ReportStatusCode() notification.
31 When this function is called the function pointer is added to an internal list and any future calls to
32 ReportStatusCode() will be forwarded to the Callback function.
34 @param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is called
35 when a call to ReportStatusCode() occurs.
37 @retval EFI_SUCCESS Function was successfully registered.
38 @retval EFI_INVALID_PARAMETER The callback function was NULL.
39 @retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be
41 @retval EFI_ALREADY_STARTED The function was already registered. It can't be registered again.
46 (EFIAPI
*EFI_PEI_RSC_HANDLER_REGISTER
)(
47 IN EFI_PEI_RSC_HANDLER_CALLBACK Callback
51 Remove a previously registered callback function from the notification list.
53 ReportStatusCode() messages will no longer be forwarded to the Callback function.
55 @param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is to be
58 @retval EFI_SUCCESS The function was successfully unregistered.
59 @retval EFI_INVALID_PARAMETER The callback function was NULL.
60 @retval EFI_NOT_FOUND The callback function was not found to be unregistered.
65 (EFIAPI
*EFI_PEI_RSC_HANDLER_UNREGISTER
)(
66 IN EFI_PEI_RSC_HANDLER_CALLBACK Callback
69 typedef struct _EFI_PEI_RSC_HANDLER_PPI
{
70 EFI_PEI_RSC_HANDLER_REGISTER Register
;
71 EFI_PEI_RSC_HANDLER_UNREGISTER Unregister
;
72 } EFI_PEI_RSC_HANDLER_PPI
;
74 extern EFI_GUID gEfiPeiRscHandlerPpiGuid
;
76 #endif // __REPORT_STATUS_CODE_HANDLER_PPI_H__