]>
Commit | Line | Data |
---|---|---|
07c6a47e ED |
1 | /** @file\r |
2 | This protocol provides registering and unregistering services to status code consumers while in DXE MM.\r | |
3 | \r | |
4 | Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>\r | |
9344f092 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
07c6a47e | 6 | \r |
497a5fb1 SZ |
7 | @par Revision Reference:\r |
8 | This Protocol was introduced in PI Specification 1.1.\r | |
9 | \r | |
07c6a47e ED |
10 | **/\r |
11 | \r | |
12 | #ifndef __MM_REPORT_STATUS_CODE_HANDLER_PROTOCOL_H__\r | |
13 | #define __MM_REPORT_STATUS_CODE_HANDLER_PROTOCOL_H__\r | |
14 | \r | |
15 | #define EFI_MM_RSC_HANDLER_PROTOCOL_GUID \\r | |
16 | { \\r | |
17 | 0x2ff29fa7, 0x5e80, 0x4ed9, {0xb3, 0x80, 0x1, 0x7d, 0x3c, 0x55, 0x4f, 0xf4} \\r | |
18 | }\r | |
19 | \r | |
20 | typedef\r | |
21 | EFI_STATUS\r | |
22 | (EFIAPI *EFI_MM_RSC_HANDLER_CALLBACK)(\r | |
23 | IN EFI_STATUS_CODE_TYPE CodeType,\r | |
24 | IN EFI_STATUS_CODE_VALUE Value,\r | |
25 | IN UINT32 Instance,\r | |
26 | IN EFI_GUID *CallerId,\r | |
27 | IN EFI_STATUS_CODE_DATA *Data\r | |
28 | );\r | |
29 | \r | |
30 | /**\r | |
31 | Register the callback function for ReportStatusCode() notification.\r | |
32 | \r | |
33 | When this function is called the function pointer is added to an internal list and any future calls to\r | |
34 | ReportStatusCode() will be forwarded to the Callback function.\r | |
35 | \r | |
36 | @param[in] Callback A pointer to a function of type EFI_MM_RSC_HANDLER_CALLBACK that is\r | |
37 | called when a call to ReportStatusCode() occurs.\r | |
38 | \r | |
39 | @retval EFI_SUCCESS Function was successfully registered.\r | |
40 | @retval EFI_INVALID_PARAMETER The callback function was NULL.\r | |
41 | @retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be\r | |
42 | registered.\r | |
43 | @retval EFI_ALREADY_STARTED The function was already registered. It can't be registered again.\r | |
44 | **/\r | |
45 | typedef\r | |
46 | EFI_STATUS\r | |
47 | (EFIAPI *EFI_MM_RSC_HANDLER_REGISTER)(\r | |
48 | IN EFI_MM_RSC_HANDLER_CALLBACK Callback\r | |
49 | );\r | |
50 | \r | |
51 | /**\r | |
52 | Remove a previously registered callback function from the notification list.\r | |
53 | \r | |
54 | A callback function must be unregistered before it is deallocated. It is important that any registered\r | |
55 | callbacks that are not runtime complaint be unregistered when ExitBootServices() is called.\r | |
56 | \r | |
57 | @param[in] Callback A pointer to a function of type EFI_MM_RSC_HANDLER_CALLBACK that is to be\r | |
58 | unregistered.\r | |
59 | \r | |
60 | @retval EFI_SUCCESS The function was successfully unregistered.\r | |
61 | @retval EFI_INVALID_PARAMETER The callback function was NULL.\r | |
62 | @retval EFI_NOT_FOUND The callback function was not found to be unregistered.\r | |
63 | \r | |
64 | **/\r | |
65 | typedef\r | |
66 | EFI_STATUS\r | |
67 | (EFIAPI *EFI_MM_RSC_HANDLER_UNREGISTER)(\r | |
68 | IN EFI_MM_RSC_HANDLER_CALLBACK Callback\r | |
69 | );\r | |
70 | \r | |
71 | typedef struct _EFI_MM_RSC_HANDLER_PROTOCOL {\r | |
72 | EFI_MM_RSC_HANDLER_REGISTER Register;\r | |
73 | EFI_MM_RSC_HANDLER_UNREGISTER Unregister;\r | |
74 | } EFI_MM_RSC_HANDLER_PROTOCOL;\r | |
75 | \r | |
76 | extern EFI_GUID gEfiMmRscHandlerProtocolGuid;\r | |
77 | \r | |
78 | #endif\r |