]>
Commit | Line | Data |
---|---|---|
476f4780 | 1 | /** @file\r |
4009604f | 2 | This PPI provides registering and unregistering services to status code consumers.\r |
476f4780 | 3 | \r |
9df063a0 HT |
4 | Copyright (c) 2007 - 2009, Intel Corporation. All rights reserved.<BR>\r |
5 | This program and the accompanying materials\r | |
476f4780 | 6 | are licensed and made available under the terms and conditions of the BSD License\r |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | **/\r | |
14 | \r | |
15 | #ifndef __REPORT_STATUS_CODE_HANDLER_PPI_H__\r | |
16 | #define __REPORT_STATUS_CODE_HANDLER_PPI_H__\r | |
17 | \r | |
18 | #define EFI_PEI_RSC_HANDLER_PPI_GUID \\r | |
19 | { \\r | |
4009604f | 20 | 0x65d394, 0x9951, 0x4144, {0x82, 0xa3, 0xa, 0xfc, 0x85, 0x79, 0xc2, 0x51} \\r |
476f4780 | 21 | }\r |
22 | \r | |
23 | typedef\r | |
24 | EFI_STATUS\r | |
25 | (EFIAPI *EFI_PEI_RSC_HANDLER_CALLBACK)(\r | |
26 | IN CONST EFI_PEI_SERVICES **PeiServices,\r | |
27 | IN EFI_STATUS_CODE_TYPE Type,\r | |
28 | IN EFI_STATUS_CODE_VALUE Value,\r | |
29 | IN UINT32 Instance,\r | |
30 | IN CONST EFI_GUID *CallerId,\r | |
31 | IN CONST EFI_STATUS_CODE_DATA *Data\r | |
32 | );\r | |
33 | \r | |
34 | /**\r | |
35 | Register the callback function for ReportStatusCode() notification.\r | |
36 | \r | |
37 | When this function is called the function pointer is added to an internal list and any future calls to\r | |
38 | ReportStatusCode() will be forwarded to the Callback function.\r | |
39 | \r | |
40 | @param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is called\r | |
41 | when a call to ReportStatusCode() occurs.\r | |
42 | \r | |
43 | @retval EFI_SUCCESS Function was successfully registered.\r | |
44 | @retval EFI_INVALID_PARAMETER The callback function was NULL.\r | |
45 | @retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be\r | |
46 | registered.\r | |
17664848 | 47 | @retval EFI_ALREADY_STARTED The function was already registered. It can't be registered again.\r |
476f4780 | 48 | \r |
49 | **/\r | |
50 | typedef\r | |
51 | EFI_STATUS\r | |
52 | (EFIAPI *EFI_PEI_RSC_HANDLER_REGISTER)(\r | |
53 | IN EFI_PEI_RSC_HANDLER_CALLBACK Callback\r | |
54 | );\r | |
55 | \r | |
56 | /**\r | |
57 | Remove a previously registered callback function from the notification list.\r | |
58 | \r | |
59 | ReportStatusCode() messages will no longer be forwarded to the Callback function.\r | |
60 | \r | |
61 | @param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is to be\r | |
62 | unregistered.\r | |
63 | \r | |
64 | @retval EFI_SUCCESS The function was successfully unregistered.\r | |
65 | @retval EFI_INVALID_PARAMETER The callback function was NULL.\r | |
66 | @retval EFI_NOT_FOUND The callback function was not found to be unregistered.\r | |
67 | \r | |
68 | **/\r | |
69 | typedef\r | |
70 | EFI_STATUS\r | |
71 | (EFIAPI *EFI_PEI_RSC_HANDLER_UNREGISTER)(\r | |
72 | IN EFI_PEI_RSC_HANDLER_CALLBACK Callback\r | |
73 | );\r | |
74 | \r | |
75 | typedef struct _EFI_PEI_RSC_HANDLER_PPI {\r | |
76 | EFI_PEI_RSC_HANDLER_REGISTER Register;\r | |
77 | EFI_PEI_RSC_HANDLER_UNREGISTER Unregister;\r | |
78 | } EFI_PEI_RSC_HANDLER_PPI;\r | |
79 | \r | |
80 | extern EFI_GUID gEfiPeiRscHandlerPpiGuid;\r | |
81 | \r | |
82 | #endif // __REPORT_STATUS_CODE_HANDLER_PPI_H__\r |