]>
Commit | Line | Data |
---|---|---|
202c3279 | 1 | /** @file\r |
2 | Report Status Code Router Driver which produces SMM Report Stataus Code Handler Protocol\r | |
3 | and SMM Status Code Protocol.\r | |
4 | \r | |
d1102dba | 5 | Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r |
9d510e61 | 6 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
202c3279 | 7 | \r |
8 | **/\r | |
9 | \r | |
b1e97194 | 10 | #include "ReportStatusCodeRouterCommon.h"\r |
202c3279 | 11 | \r |
12 | LIST_ENTRY mCallbackListHead = INITIALIZE_LIST_HEAD_VARIABLE (mCallbackListHead);\r | |
13 | \r | |
14 | //\r | |
15 | // Report operation nest status.\r | |
16 | // If it is set, then the report operation has nested.\r | |
17 | //\r | |
18 | UINT32 mStatusCodeNestStatus = 0;\r | |
19 | \r | |
b1e97194 | 20 | EFI_MM_STATUS_CODE_PROTOCOL mSmmStatusCodeProtocol = {\r |
202c3279 | 21 | ReportDispatcher\r |
22 | };\r | |
23 | \r | |
b1e97194 | 24 | EFI_MM_RSC_HANDLER_PROTOCOL mSmmRscHandlerProtocol = {\r |
202c3279 | 25 | Register,\r |
26 | Unregister\r | |
27 | };\r | |
28 | \r | |
29 | /**\r | |
30 | Register the callback function for ReportStatusCode() notification.\r | |
d1102dba | 31 | \r |
202c3279 | 32 | When this function is called the function pointer is added to an internal list and any future calls to\r |
33 | ReportStatusCode() will be forwarded to the Callback function.\r | |
34 | \r | |
35 | @param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is called\r | |
36 | when a call to ReportStatusCode() occurs.\r | |
d1102dba | 37 | \r |
202c3279 | 38 | @retval EFI_SUCCESS Function was successfully registered.\r |
39 | @retval EFI_INVALID_PARAMETER The callback function was NULL.\r | |
40 | @retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be\r | |
41 | registered.\r | |
42 | @retval EFI_ALREADY_STARTED The function was already registered. It can't be registered again.\r | |
d1102dba | 43 | \r |
202c3279 | 44 | **/\r |
45 | EFI_STATUS\r | |
46 | EFIAPI\r | |
47 | Register (\r | |
b1e97194 | 48 | IN EFI_MM_RSC_HANDLER_CALLBACK Callback\r |
202c3279 | 49 | )\r |
50 | {\r | |
d3308de7 | 51 | LIST_ENTRY *Link;\r |
b1e97194 | 52 | MM_RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;\r |
202c3279 | 53 | \r |
54 | if (Callback == NULL) {\r | |
55 | return EFI_INVALID_PARAMETER;\r | |
56 | }\r | |
57 | \r | |
58 | for (Link = GetFirstNode (&mCallbackListHead); !IsNull (&mCallbackListHead, Link); Link = GetNextNode (&mCallbackListHead, Link)) {\r | |
b1e97194 | 59 | CallbackEntry = CR (Link, MM_RSC_HANDLER_CALLBACK_ENTRY, Node, MM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE);\r |
202c3279 | 60 | if (CallbackEntry->RscHandlerCallback == Callback) {\r |
61 | //\r | |
62 | // If the function was already registered. It can't be registered again.\r | |
63 | //\r | |
64 | return EFI_ALREADY_STARTED;\r | |
65 | }\r | |
66 | }\r | |
67 | \r | |
b1e97194 | 68 | CallbackEntry = (MM_RSC_HANDLER_CALLBACK_ENTRY *)AllocatePool (sizeof (MM_RSC_HANDLER_CALLBACK_ENTRY));\r |
202c3279 | 69 | ASSERT (CallbackEntry != NULL);\r |
70 | \r | |
b1e97194 | 71 | CallbackEntry->Signature = MM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE;\r |
202c3279 | 72 | CallbackEntry->RscHandlerCallback = Callback;\r |
73 | \r | |
74 | InsertTailList (&mCallbackListHead, &CallbackEntry->Node);\r | |
75 | \r | |
76 | return EFI_SUCCESS;\r | |
77 | }\r | |
78 | \r | |
79 | /**\r | |
80 | Remove a previously registered callback function from the notification list.\r | |
d1102dba | 81 | \r |
202c3279 | 82 | ReportStatusCode() messages will no longer be forwarded to the Callback function.\r |
d1102dba | 83 | \r |
202c3279 | 84 | @param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is to be\r |
85 | unregistered.\r | |
86 | \r | |
87 | @retval EFI_SUCCESS The function was successfully unregistered.\r | |
88 | @retval EFI_INVALID_PARAMETER The callback function was NULL.\r | |
89 | @retval EFI_NOT_FOUND The callback function was not found to be unregistered.\r | |
d1102dba | 90 | \r |
202c3279 | 91 | **/\r |
92 | EFI_STATUS\r | |
93 | EFIAPI\r | |
94 | Unregister (\r | |
b1e97194 | 95 | IN EFI_MM_RSC_HANDLER_CALLBACK Callback\r |
202c3279 | 96 | )\r |
97 | {\r | |
98 | LIST_ENTRY *Link;\r | |
b1e97194 | 99 | MM_RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;\r |
202c3279 | 100 | \r |
101 | if (Callback == NULL) {\r | |
102 | return EFI_INVALID_PARAMETER;\r | |
103 | }\r | |
104 | \r | |
105 | for (Link = GetFirstNode (&mCallbackListHead); !IsNull (&mCallbackListHead, Link); Link = GetNextNode (&mCallbackListHead, Link)) {\r | |
b1e97194 | 106 | CallbackEntry = CR (Link, MM_RSC_HANDLER_CALLBACK_ENTRY, Node, MM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE);\r |
202c3279 | 107 | if (CallbackEntry->RscHandlerCallback == Callback) {\r |
108 | //\r | |
109 | // If the function is found in list, delete it and return.\r | |
110 | //\r | |
111 | RemoveEntryList (&CallbackEntry->Node);\r | |
d3308de7 | 112 | FreePool (CallbackEntry);\r |
202c3279 | 113 | return EFI_SUCCESS;\r |
114 | }\r | |
115 | }\r | |
116 | \r | |
117 | return EFI_NOT_FOUND;\r | |
118 | }\r | |
119 | \r | |
120 | \r | |
121 | /**\r | |
122 | Provides an interface that a software module can call to report a status code.\r | |
123 | \r | |
b1e97194 KQ |
124 | @param This EFI_MM_STATUS_CODE_PROTOCOL instance.\r |
125 | @param CodeType Indicates the type of status code being reported.\r | |
202c3279 | 126 | @param Value Describes the current status of a hardware or software entity.\r |
127 | This included information about the class and subclass that is used to\r | |
128 | classify the entity as well as an operation.\r | |
129 | @param Instance The enumeration of a hardware or software entity within\r | |
130 | the system. Valid instance numbers start with 1.\r | |
131 | @param CallerId This optional parameter may be used to identify the caller.\r | |
132 | This parameter allows the status code driver to apply different rules to\r | |
133 | different callers.\r | |
134 | @param Data This optional parameter may be used to pass additional data.\r | |
135 | \r | |
136 | @retval EFI_SUCCESS The function completed successfully\r | |
137 | @retval EFI_DEVICE_ERROR The function should not be completed due to a device error.\r | |
138 | \r | |
139 | **/\r | |
140 | EFI_STATUS\r | |
141 | EFIAPI\r | |
142 | ReportDispatcher (\r | |
b1e97194 KQ |
143 | IN CONST EFI_MM_STATUS_CODE_PROTOCOL *This,\r |
144 | IN EFI_STATUS_CODE_TYPE CodeType,\r | |
202c3279 | 145 | IN EFI_STATUS_CODE_VALUE Value,\r |
146 | IN UINT32 Instance,\r | |
b1e97194 | 147 | IN CONST EFI_GUID *CallerId,\r |
202c3279 | 148 | IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r |
149 | )\r | |
150 | {\r | |
151 | LIST_ENTRY *Link;\r | |
b1e97194 | 152 | MM_RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;\r |
202c3279 | 153 | \r |
154 | //\r | |
155 | // Use atom operation to avoid the reentant of report.\r | |
156 | // If current status is not zero, then the function is reentrancy.\r | |
157 | //\r | |
158 | if (InterlockedCompareExchange32 (&mStatusCodeNestStatus, 0, 1) == 1) {\r | |
159 | return EFI_DEVICE_ERROR;\r | |
160 | }\r | |
161 | \r | |
04bbf1f3 | 162 | for (Link = GetFirstNode (&mCallbackListHead); !IsNull (&mCallbackListHead, Link);) {\r |
b1e97194 | 163 | CallbackEntry = CR (Link, MM_RSC_HANDLER_CALLBACK_ENTRY, Node, MM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE);\r |
04bbf1f3 | 164 | //\r |
165 | // The handler may remove itself, so get the next handler in advance.\r | |
166 | //\r | |
167 | Link = GetNextNode (&mCallbackListHead, Link);\r | |
202c3279 | 168 | CallbackEntry->RscHandlerCallback (\r |
b1e97194 | 169 | CodeType,\r |
202c3279 | 170 | Value,\r |
171 | Instance,\r | |
172 | (EFI_GUID*)CallerId,\r | |
173 | Data\r | |
174 | );\r | |
175 | \r | |
176 | }\r | |
177 | \r | |
178 | //\r | |
179 | // Restore the nest status of report\r | |
180 | //\r | |
181 | InterlockedCompareExchange32 (&mStatusCodeNestStatus, 1, 0);\r | |
182 | \r | |
183 | return EFI_SUCCESS;\r | |
184 | }\r | |
185 | \r | |
186 | /**\r | |
187 | Entry point of Generic Status Code Driver.\r | |
188 | \r | |
b1e97194 KQ |
189 | This function is the common entry point of MM Status Code Router.\r |
190 | It produces MM Report Status Code Handler and Status Code protocol.\r | |
d1102dba | 191 | \r |
202c3279 | 192 | @retval EFI_SUCCESS The entry point is executed successfully.\r |
193 | \r | |
194 | **/\r | |
195 | EFI_STATUS\r | |
b1e97194 KQ |
196 | GenericStatusCodeCommonEntry (\r |
197 | VOID\r | |
202c3279 | 198 | )\r |
199 | {\r | |
200 | EFI_STATUS Status;\r | |
201 | EFI_HANDLE Handle;\r | |
202 | \r | |
203 | Handle = NULL;\r | |
d1102dba | 204 | \r |
202c3279 | 205 | //\r |
206 | // Install SmmRscHandler Protocol\r | |
207 | //\r | |
b1e97194 | 208 | Status = gMmst->MmInstallProtocolInterface (\r |
202c3279 | 209 | &Handle,\r |
b1e97194 | 210 | &gEfiMmRscHandlerProtocolGuid,\r |
202c3279 | 211 | EFI_NATIVE_INTERFACE,\r |
212 | &mSmmRscHandlerProtocol\r | |
213 | );\r | |
214 | ASSERT_EFI_ERROR (Status);\r | |
215 | \r | |
216 | //\r | |
217 | // Install SmmStatusCode Protocol\r | |
218 | //\r | |
b1e97194 | 219 | Status = gMmst->MmInstallProtocolInterface (\r |
202c3279 | 220 | &Handle,\r |
b1e97194 | 221 | &gEfiMmStatusCodeProtocolGuid,\r |
202c3279 | 222 | EFI_NATIVE_INTERFACE,\r |
223 | &mSmmStatusCodeProtocol\r | |
224 | );\r | |
225 | ASSERT_EFI_ERROR (Status);\r | |
226 | \r | |
227 | return EFI_SUCCESS;\r | |
228 | }\r |