]>
Commit | Line | Data |
---|---|---|
476f4780 | 1 | /** @file\r |
4009604f | 2 | This PPI provides registering and unregistering services to status code consumers.\r |
9095d37b LG |
3 | \r |
4 | Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r | |
9344f092 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
476f4780 | 6 | \r |
7 | **/\r | |
8 | \r | |
9 | #ifndef __REPORT_STATUS_CODE_HANDLER_PPI_H__\r | |
10 | #define __REPORT_STATUS_CODE_HANDLER_PPI_H__\r | |
11 | \r | |
12 | #define EFI_PEI_RSC_HANDLER_PPI_GUID \\r | |
13 | { \\r | |
4009604f | 14 | 0x65d394, 0x9951, 0x4144, {0x82, 0xa3, 0xa, 0xfc, 0x85, 0x79, 0xc2, 0x51} \\r |
476f4780 | 15 | }\r |
16 | \r | |
17 | typedef\r | |
18 | EFI_STATUS\r | |
19 | (EFIAPI *EFI_PEI_RSC_HANDLER_CALLBACK)(\r | |
20 | IN CONST EFI_PEI_SERVICES **PeiServices,\r | |
21 | IN EFI_STATUS_CODE_TYPE Type,\r | |
22 | IN EFI_STATUS_CODE_VALUE Value,\r | |
23 | IN UINT32 Instance,\r | |
24 | IN CONST EFI_GUID *CallerId,\r | |
25 | IN CONST EFI_STATUS_CODE_DATA *Data\r | |
2f88bd3a | 26 | );\r |
476f4780 | 27 | \r |
28 | /**\r | |
29 | Register the callback function for ReportStatusCode() notification.\r | |
9095d37b | 30 | \r |
476f4780 | 31 | When this function is called the function pointer is added to an internal list and any future calls to\r |
32 | ReportStatusCode() will be forwarded to the Callback function.\r | |
33 | \r | |
34 | @param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is called\r | |
35 | when a call to ReportStatusCode() occurs.\r | |
9095d37b | 36 | \r |
476f4780 | 37 | @retval EFI_SUCCESS Function was successfully registered.\r |
38 | @retval EFI_INVALID_PARAMETER The callback function was NULL.\r | |
39 | @retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be\r | |
40 | registered.\r | |
17664848 | 41 | @retval EFI_ALREADY_STARTED The function was already registered. It can't be registered again.\r |
9095d37b | 42 | \r |
476f4780 | 43 | **/\r |
44 | typedef\r | |
45 | EFI_STATUS\r | |
46 | (EFIAPI *EFI_PEI_RSC_HANDLER_REGISTER)(\r | |
47 | IN EFI_PEI_RSC_HANDLER_CALLBACK Callback\r | |
2f88bd3a | 48 | );\r |
476f4780 | 49 | \r |
50 | /**\r | |
51 | Remove a previously registered callback function from the notification list.\r | |
9095d37b | 52 | \r |
476f4780 | 53 | ReportStatusCode() messages will no longer be forwarded to the Callback function.\r |
9095d37b | 54 | \r |
476f4780 | 55 | @param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is to be\r |
56 | unregistered.\r | |
57 | \r | |
58 | @retval EFI_SUCCESS The function was successfully unregistered.\r | |
59 | @retval EFI_INVALID_PARAMETER The callback function was NULL.\r | |
60 | @retval EFI_NOT_FOUND The callback function was not found to be unregistered.\r | |
9095d37b | 61 | \r |
476f4780 | 62 | **/\r |
63 | typedef\r | |
64 | EFI_STATUS\r | |
65 | (EFIAPI *EFI_PEI_RSC_HANDLER_UNREGISTER)(\r | |
66 | IN EFI_PEI_RSC_HANDLER_CALLBACK Callback\r | |
2f88bd3a | 67 | );\r |
476f4780 | 68 | \r |
69 | typedef struct _EFI_PEI_RSC_HANDLER_PPI {\r | |
2f88bd3a MK |
70 | EFI_PEI_RSC_HANDLER_REGISTER Register;\r |
71 | EFI_PEI_RSC_HANDLER_UNREGISTER Unregister;\r | |
476f4780 | 72 | } EFI_PEI_RSC_HANDLER_PPI;\r |
73 | \r | |
2f88bd3a | 74 | extern EFI_GUID gEfiPeiRscHandlerPpiGuid;\r |
476f4780 | 75 | \r |
76 | #endif // __REPORT_STATUS_CODE_HANDLER_PPI_H__\r |