]>
Commit | Line | Data |
---|---|---|
25126a05 | 1 | /** @file\r |
2 | Report Status Code Router Driver which produces Report Stataus Code Handler Protocol\r | |
3 | and Status Code Runtime 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 |
25126a05 | 7 | \r |
8 | **/\r | |
9 | \r | |
10 | #include "ReportStatusCodeRouterRuntimeDxe.h"\r | |
11 | \r | |
12 | EFI_HANDLE mHandle = NULL;\r | |
13 | LIST_ENTRY mCallbackListHead = INITIALIZE_LIST_HEAD_VARIABLE (mCallbackListHead);\r | |
14 | EFI_EVENT mVirtualAddressChangeEvent = NULL;\r | |
15 | \r | |
16 | //\r | |
17 | // Report operation nest status.\r | |
18 | // If it is set, then the report operation has nested.\r | |
19 | //\r | |
20 | UINT32 mStatusCodeNestStatus = 0;\r | |
21 | \r | |
22 | EFI_STATUS_CODE_PROTOCOL mStatusCodeProtocol = {\r | |
23 | ReportDispatcher\r | |
24 | };\r | |
25 | \r | |
26 | EFI_RSC_HANDLER_PROTOCOL mRscHandlerProtocol = {\r | |
27 | Register,\r | |
28 | Unregister\r | |
29 | };\r | |
30 | \r | |
cfc2ba61 | 31 | /**\r |
32 | Event callback function to invoke status code handler in list.\r | |
33 | \r | |
34 | @param Event Event whose notification function is being invoked.\r | |
35 | @param Context Pointer to the notification function's context, which is\r | |
36 | always zero in current implementation.\r | |
37 | \r | |
38 | **/\r | |
39 | VOID\r | |
40 | EFIAPI\r | |
41 | RscHandlerNotification (\r | |
42 | IN EFI_EVENT Event,\r | |
43 | IN VOID *Context\r | |
44 | )\r | |
45 | {\r | |
46 | RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;\r | |
47 | EFI_PHYSICAL_ADDRESS Address;\r | |
48 | RSC_DATA_ENTRY *RscData;\r | |
49 | \r | |
50 | CallbackEntry = (RSC_HANDLER_CALLBACK_ENTRY *) Context;\r | |
51 | \r | |
52 | //\r | |
53 | // Traverse the status code data buffer to parse all\r | |
54 | // data to report.\r | |
55 | //\r | |
56 | Address = CallbackEntry->StatusCodeDataBuffer;\r | |
57 | while (Address < CallbackEntry->EndPointer) {\r | |
58 | RscData = (RSC_DATA_ENTRY *) (UINTN) Address;\r | |
59 | CallbackEntry->RscHandlerCallback (\r | |
60 | RscData->Type,\r | |
61 | RscData->Value,\r | |
62 | RscData->Instance,\r | |
63 | &RscData->CallerId,\r | |
64 | &RscData->Data\r | |
65 | );\r | |
66 | \r | |
67 | Address += (sizeof (RSC_DATA_ENTRY) + RscData->Data.Size);\r | |
68 | Address = ALIGN_VARIABLE (Address);\r | |
69 | }\r | |
70 | \r | |
71 | CallbackEntry->EndPointer = CallbackEntry->StatusCodeDataBuffer;\r | |
72 | }\r | |
73 | \r | |
25126a05 | 74 | /**\r |
75 | Register the callback function for ReportStatusCode() notification.\r | |
d1102dba | 76 | \r |
25126a05 | 77 | When this function is called the function pointer is added to an internal list and any future calls to\r |
78 | ReportStatusCode() will be forwarded to the Callback function. During the bootservices,\r | |
79 | this is the callback for which this service can be invoked. The report status code router\r | |
80 | will create an event such that the callback function is only invoked at the TPL for which it was\r | |
81 | registered. The entity that registers for the callback should also register for an event upon\r | |
82 | generation of exit boot services and invoke the unregister service.\r | |
83 | If the handler does not have a TPL dependency, it should register for a callback at TPL high. The\r | |
84 | router infrastructure will support making callbacks at runtime, but the caller for runtime invocation\r | |
85 | must meet the following criteria:\r | |
86 | 1. must be a runtime driver type so that its memory is not reclaimed\r | |
87 | 2. not unregister at exit boot services so that the router will still have its callback address\r | |
88 | 3. the caller must be self-contained (eg. Not call out into any boot-service interfaces) and be\r | |
89 | runtime safe, in general.\r | |
d1102dba | 90 | \r |
25126a05 | 91 | @param[in] Callback A pointer to a function of type EFI_RSC_HANDLER_CALLBACK that is called when\r |
92 | a call to ReportStatusCode() occurs.\r | |
d1102dba LG |
93 | @param[in] Tpl TPL at which callback can be safely invoked.\r |
94 | \r | |
25126a05 | 95 | @retval EFI_SUCCESS Function was successfully registered.\r |
96 | @retval EFI_INVALID_PARAMETER The callback function was NULL.\r | |
97 | @retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be\r | |
98 | registered.\r | |
99 | @retval EFI_ALREADY_STARTED The function was already registered. It can't be registered again.\r | |
100 | \r | |
101 | **/\r | |
102 | EFI_STATUS\r | |
103 | EFIAPI\r | |
104 | Register (\r | |
105 | IN EFI_RSC_HANDLER_CALLBACK Callback,\r | |
106 | IN EFI_TPL Tpl\r | |
107 | )\r | |
108 | {\r | |
cfc2ba61 | 109 | EFI_STATUS Status;\r |
25126a05 | 110 | LIST_ENTRY *Link;\r |
111 | RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;\r | |
112 | \r | |
113 | if (Callback == NULL) {\r | |
114 | return EFI_INVALID_PARAMETER;\r | |
115 | }\r | |
116 | \r | |
117 | for (Link = GetFirstNode (&mCallbackListHead); !IsNull (&mCallbackListHead, Link); Link = GetNextNode (&mCallbackListHead, Link)) {\r | |
118 | CallbackEntry = CR (Link, RSC_HANDLER_CALLBACK_ENTRY, Node, RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE);\r | |
119 | if (CallbackEntry->RscHandlerCallback == Callback) {\r | |
120 | //\r | |
121 | // If the function was already registered. It can't be registered again.\r | |
122 | //\r | |
123 | return EFI_ALREADY_STARTED;\r | |
124 | }\r | |
125 | }\r | |
126 | \r | |
4e03ff80 | 127 | CallbackEntry = AllocateRuntimeZeroPool (sizeof (RSC_HANDLER_CALLBACK_ENTRY));\r |
25126a05 | 128 | ASSERT (CallbackEntry != NULL);\r |
129 | \r | |
130 | CallbackEntry->Signature = RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE;\r | |
131 | CallbackEntry->RscHandlerCallback = Callback;\r | |
132 | CallbackEntry->Tpl = Tpl;\r | |
133 | \r | |
cfc2ba61 | 134 | //\r |
135 | // If TPL of registered callback funtion is not TPL_HIGH_LEVEL, then event should be created\r | |
136 | // for it, and related buffer for status code data should be prepared.\r | |
137 | // Here the data buffer must be prepared in advance, because Report Status Code Protocol might\r | |
138 | // be invoked under TPL_HIGH_LEVEL and no memory allocation is allowed then.\r | |
139 | // If TPL is TPL_HIGH_LEVEL, then all status code will be reported immediately, without data\r | |
140 | // buffer and event trigger.\r | |
141 | //\r | |
142 | if (Tpl != TPL_HIGH_LEVEL) {\r | |
43e33207 | 143 | CallbackEntry->StatusCodeDataBuffer = (EFI_PHYSICAL_ADDRESS) (UINTN) AllocatePool (EFI_PAGE_SIZE);\r |
cfc2ba61 | 144 | CallbackEntry->BufferSize = EFI_PAGE_SIZE;\r |
145 | CallbackEntry->EndPointer = CallbackEntry->StatusCodeDataBuffer;\r | |
146 | Status = gBS->CreateEvent (\r | |
147 | EVT_NOTIFY_SIGNAL,\r | |
148 | Tpl,\r | |
149 | RscHandlerNotification,\r | |
150 | CallbackEntry,\r | |
151 | &CallbackEntry->Event\r | |
152 | );\r | |
153 | ASSERT_EFI_ERROR (Status);\r | |
154 | }\r | |
155 | \r | |
25126a05 | 156 | InsertTailList (&mCallbackListHead, &CallbackEntry->Node);\r |
157 | \r | |
158 | return EFI_SUCCESS;\r | |
159 | }\r | |
160 | \r | |
161 | /**\r | |
162 | Remove a previously registered callback function from the notification list.\r | |
d1102dba | 163 | \r |
25126a05 | 164 | A callback function must be unregistered before it is deallocated. It is important that any registered\r |
165 | callbacks that are not runtime complaint be unregistered when ExitBootServices() is called.\r | |
d1102dba | 166 | \r |
25126a05 | 167 | @param[in] Callback A pointer to a function of type EFI_RSC_HANDLER_CALLBACK that is to be\r |
168 | unregistered.\r | |
d1102dba | 169 | \r |
25126a05 | 170 | @retval EFI_SUCCESS The function was successfully unregistered.\r |
171 | @retval EFI_INVALID_PARAMETER The callback function was NULL.\r | |
172 | @retval EFI_NOT_FOUND The callback function was not found to be unregistered.\r | |
173 | \r | |
174 | **/\r | |
175 | EFI_STATUS\r | |
176 | EFIAPI\r | |
177 | Unregister (\r | |
178 | IN EFI_RSC_HANDLER_CALLBACK Callback\r | |
179 | )\r | |
180 | {\r | |
181 | LIST_ENTRY *Link;\r | |
182 | RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;\r | |
183 | \r | |
184 | if (Callback == NULL) {\r | |
185 | return EFI_INVALID_PARAMETER;\r | |
186 | }\r | |
187 | \r | |
188 | for (Link = GetFirstNode (&mCallbackListHead); !IsNull (&mCallbackListHead, Link); Link = GetNextNode (&mCallbackListHead, Link)) {\r | |
189 | CallbackEntry = CR (Link, RSC_HANDLER_CALLBACK_ENTRY, Node, RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE);\r | |
190 | if (CallbackEntry->RscHandlerCallback == Callback) {\r | |
191 | //\r | |
192 | // If the function is found in list, delete it and return.\r | |
193 | //\r | |
cfc2ba61 | 194 | if (CallbackEntry->Tpl != TPL_HIGH_LEVEL) {\r |
195 | FreePool ((VOID *) (UINTN) CallbackEntry->StatusCodeDataBuffer);\r | |
196 | gBS->CloseEvent (CallbackEntry->Event);\r | |
197 | }\r | |
25126a05 | 198 | RemoveEntryList (&CallbackEntry->Node);\r |
199 | FreePool (CallbackEntry);\r | |
200 | return EFI_SUCCESS;\r | |
201 | }\r | |
202 | }\r | |
203 | \r | |
204 | return EFI_NOT_FOUND;\r | |
205 | }\r | |
206 | \r | |
25126a05 | 207 | /**\r |
208 | Provides an interface that a software module can call to report a status code.\r | |
209 | \r | |
210 | @param Type Indicates the type of status code being reported.\r | |
211 | @param Value Describes the current status of a hardware or software entity.\r | |
212 | This included information about the class and subclass that is used to\r | |
213 | classify the entity as well as an operation.\r | |
214 | @param Instance The enumeration of a hardware or software entity within\r | |
215 | the system. Valid instance numbers start with 1.\r | |
216 | @param CallerId This optional parameter may be used to identify the caller.\r | |
217 | This parameter allows the status code driver to apply different rules to\r | |
218 | different callers.\r | |
219 | @param Data This optional parameter may be used to pass additional data.\r | |
220 | \r | |
221 | @retval EFI_SUCCESS The function completed successfully\r | |
222 | @retval EFI_DEVICE_ERROR The function should not be completed due to a device error.\r | |
223 | \r | |
224 | **/\r | |
225 | EFI_STATUS\r | |
226 | EFIAPI\r | |
227 | ReportDispatcher (\r | |
228 | IN EFI_STATUS_CODE_TYPE Type,\r | |
229 | IN EFI_STATUS_CODE_VALUE Value,\r | |
230 | IN UINT32 Instance,\r | |
231 | IN EFI_GUID *CallerId OPTIONAL,\r | |
232 | IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r | |
233 | )\r | |
234 | {\r | |
235 | LIST_ENTRY *Link;\r | |
236 | RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;\r | |
cfc2ba61 | 237 | RSC_DATA_ENTRY *RscData;\r |
25126a05 | 238 | EFI_STATUS Status;\r |
cfc2ba61 | 239 | VOID *NewBuffer;\r |
25126a05 | 240 | \r |
241 | //\r | |
242 | // Use atom operation to avoid the reentant of report.\r | |
243 | // If current status is not zero, then the function is reentrancy.\r | |
244 | //\r | |
245 | if (InterlockedCompareExchange32 (&mStatusCodeNestStatus, 0, 1) == 1) {\r | |
246 | return EFI_DEVICE_ERROR;\r | |
247 | }\r | |
248 | \r | |
04bbf1f3 | 249 | for (Link = GetFirstNode (&mCallbackListHead); !IsNull (&mCallbackListHead, Link);) {\r |
25126a05 | 250 | CallbackEntry = CR (Link, RSC_HANDLER_CALLBACK_ENTRY, Node, RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE);\r |
04bbf1f3 | 251 | //\r |
252 | // The handler may remove itself, so get the next handler in advance.\r | |
253 | //\r | |
254 | Link = GetNextNode (&mCallbackListHead, Link);\r | |
25126a05 | 255 | if ((CallbackEntry->Tpl == TPL_HIGH_LEVEL) || EfiAtRuntime ()) {\r |
256 | CallbackEntry->RscHandlerCallback (\r | |
257 | Type,\r | |
258 | Value,\r | |
259 | Instance,\r | |
260 | CallerId,\r | |
261 | Data\r | |
262 | );\r | |
263 | continue;\r | |
264 | }\r | |
265 | \r | |
cfc2ba61 | 266 | //\r |
267 | // If callback is registered with TPL lower than TPL_HIGH_LEVEL, event must be signaled at boot time to possibly wait for\r | |
268 | // allowed TPL to report status code. Related data should also be stored in data buffer.\r | |
269 | //\r | |
270 | CallbackEntry->EndPointer = ALIGN_VARIABLE (CallbackEntry->EndPointer);\r | |
271 | RscData = (RSC_DATA_ENTRY *) (UINTN) CallbackEntry->EndPointer;\r | |
272 | CallbackEntry->EndPointer += sizeof (RSC_DATA_ENTRY);\r | |
273 | if (Data != NULL) {\r | |
274 | CallbackEntry->EndPointer += Data->Size;\r | |
275 | }\r | |
25126a05 | 276 | \r |
cfc2ba61 | 277 | //\r |
278 | // If data buffer is about to be used up (7/8 here), try to reallocate a buffer with double size, if not at TPL_HIGH_LEVEL.\r | |
279 | //\r | |
280 | if (CallbackEntry->EndPointer > (CallbackEntry->StatusCodeDataBuffer + (CallbackEntry->BufferSize / 8) * 7)) {\r | |
281 | if (EfiGetCurrentTpl () < TPL_HIGH_LEVEL) {\r | |
282 | NewBuffer = ReallocatePool (\r | |
283 | CallbackEntry->BufferSize,\r | |
284 | CallbackEntry->BufferSize * 2,\r | |
285 | (VOID *) (UINTN) CallbackEntry->StatusCodeDataBuffer\r | |
286 | );\r | |
287 | if (NewBuffer != NULL) {\r | |
43e33207 | 288 | CallbackEntry->EndPointer = (EFI_PHYSICAL_ADDRESS) (UINTN) NewBuffer + (CallbackEntry->EndPointer - CallbackEntry->StatusCodeDataBuffer);\r |
289 | CallbackEntry->StatusCodeDataBuffer = (EFI_PHYSICAL_ADDRESS) (UINTN) NewBuffer;\r | |
cfc2ba61 | 290 | CallbackEntry->BufferSize *= 2;\r |
291 | }\r | |
292 | }\r | |
293 | }\r | |
25126a05 | 294 | \r |
cfc2ba61 | 295 | //\r |
296 | // If data buffer is used up, do not report for this time.\r | |
297 | //\r | |
298 | if (CallbackEntry->EndPointer > (CallbackEntry->StatusCodeDataBuffer + CallbackEntry->BufferSize)) {\r | |
299 | continue;\r | |
300 | }\r | |
301 | \r | |
302 | RscData->Type = Type;\r | |
303 | RscData->Value = Value;\r | |
304 | RscData->Instance = Instance;\r | |
305 | if (CallerId != NULL) {\r | |
306 | CopyGuid (&RscData->CallerId, CallerId);\r | |
307 | }\r | |
308 | if (Data != NULL) {\r | |
309 | CopyMem (&RscData->Data, Data, Data->HeaderSize + Data->Size);\r | |
310 | }\r | |
25126a05 | 311 | \r |
cfc2ba61 | 312 | Status = gBS->SignalEvent (CallbackEntry->Event);\r |
25126a05 | 313 | ASSERT_EFI_ERROR (Status);\r |
314 | }\r | |
315 | \r | |
316 | //\r | |
317 | // Restore the nest status of report\r | |
318 | //\r | |
319 | InterlockedCompareExchange32 (&mStatusCodeNestStatus, 1, 0);\r | |
320 | \r | |
321 | return EFI_SUCCESS;\r | |
322 | }\r | |
323 | \r | |
324 | /**\r | |
325 | Virtual address change notification call back. It converts global pointer\r | |
326 | to virtual address.\r | |
327 | \r | |
328 | @param Event Event whose notification function is being invoked.\r | |
329 | @param Context Pointer to the notification function's context, which is\r | |
330 | always zero in current implementation.\r | |
331 | \r | |
332 | **/\r | |
333 | VOID\r | |
334 | EFIAPI\r | |
335 | VirtualAddressChangeCallBack (\r | |
336 | IN EFI_EVENT Event,\r | |
337 | IN VOID *Context\r | |
338 | )\r | |
339 | {\r | |
d1102dba | 340 | EFI_STATUS Status;\r |
25126a05 | 341 | LIST_ENTRY *Link;\r |
342 | RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;\r | |
343 | \r | |
344 | for (Link = GetFirstNode (&mCallbackListHead); !IsNull (&mCallbackListHead, Link); Link = GetNextNode (&mCallbackListHead, Link)) {\r | |
345 | CallbackEntry = CR (Link, RSC_HANDLER_CALLBACK_ENTRY, Node, RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE);\r | |
346 | Status = EfiConvertFunctionPointer (0, (VOID **) &CallbackEntry->RscHandlerCallback);\r | |
347 | ASSERT_EFI_ERROR (Status);\r | |
348 | }\r | |
349 | \r | |
350 | Status = EfiConvertList (\r | |
351 | 0,\r | |
352 | &mCallbackListHead\r | |
353 | );\r | |
354 | ASSERT_EFI_ERROR (Status);\r | |
355 | }\r | |
356 | \r | |
357 | /**\r | |
358 | Entry point of Generic Status Code Driver.\r | |
359 | \r | |
360 | This function is the entry point of this Generic Status Code Driver.\r | |
361 | It installs eport Stataus Code Handler Protocol and Status Code Runtime Protocol,\r | |
362 | and registers event for EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.\r | |
363 | \r | |
364 | @param ImageHandle The firmware allocated handle for the EFI image.\r | |
365 | @param SystemTable A pointer to the EFI System Table.\r | |
d1102dba | 366 | \r |
25126a05 | 367 | @retval EFI_SUCCESS The entry point is executed successfully.\r |
368 | \r | |
369 | **/\r | |
370 | EFI_STATUS\r | |
371 | EFIAPI\r | |
372 | GenericStatusCodeRuntimeDxeEntry (\r | |
373 | IN EFI_HANDLE ImageHandle,\r | |
374 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
375 | )\r | |
376 | {\r | |
377 | EFI_STATUS Status;\r | |
378 | \r | |
379 | Status = gBS->InstallMultipleProtocolInterfaces (\r | |
380 | &mHandle,\r | |
381 | &gEfiRscHandlerProtocolGuid,\r | |
382 | &mRscHandlerProtocol,\r | |
383 | &gEfiStatusCodeRuntimeProtocolGuid,\r | |
384 | &mStatusCodeProtocol,\r | |
385 | NULL\r | |
386 | );\r | |
387 | ASSERT_EFI_ERROR (Status);\r | |
388 | \r | |
389 | Status = gBS->CreateEventEx (\r | |
390 | EVT_NOTIFY_SIGNAL,\r | |
391 | TPL_NOTIFY,\r | |
392 | VirtualAddressChangeCallBack,\r | |
393 | NULL,\r | |
394 | &gEfiEventVirtualAddressChangeGuid,\r | |
395 | &mVirtualAddressChangeEvent\r | |
396 | );\r | |
397 | ASSERT_EFI_ERROR (Status);\r | |
398 | \r | |
399 | return EFI_SUCCESS;\r | |
400 | }\r |