2 Report Status Code Router Driver which produces Report Stataus Code Handler Protocol
3 and Status Code Runtime Protocol.
5 Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>
6 Copyright (c) Microsoft Corporation.<BR>
7 SPDX-License-Identifier: BSD-2-Clause-Patent
11 #include "ReportStatusCodeRouterRuntimeDxe.h"
13 EFI_HANDLE mHandle
= NULL
;
14 LIST_ENTRY mCallbackListHead
= INITIALIZE_LIST_HEAD_VARIABLE (mCallbackListHead
);
15 EFI_EVENT mVirtualAddressChangeEvent
= NULL
;
18 // Report operation nest status.
19 // If it is set, then the report operation has nested.
21 UINT32 mStatusCodeNestStatus
= 0;
23 EFI_STATUS_CODE_PROTOCOL mStatusCodeProtocol
= {
27 EFI_RSC_HANDLER_PROTOCOL mRscHandlerProtocol
= {
33 Event callback function to invoke status code handler in list.
35 @param Event Event whose notification function is being invoked.
36 @param Context Pointer to the notification function's context, which is
37 always zero in current implementation.
42 RscHandlerNotification (
47 RSC_HANDLER_CALLBACK_ENTRY
*CallbackEntry
;
48 EFI_PHYSICAL_ADDRESS Address
;
49 RSC_DATA_ENTRY
*RscData
;
51 CallbackEntry
= (RSC_HANDLER_CALLBACK_ENTRY
*) Context
;
54 // Traverse the status code data buffer to parse all
57 Address
= CallbackEntry
->StatusCodeDataBuffer
;
58 while (Address
< CallbackEntry
->EndPointer
) {
59 RscData
= (RSC_DATA_ENTRY
*) (UINTN
) Address
;
60 CallbackEntry
->RscHandlerCallback (
68 Address
+= (OFFSET_OF (RSC_DATA_ENTRY
, Data
) + RscData
->Data
.HeaderSize
+ RscData
->Data
.Size
);
69 Address
= ALIGN_VARIABLE (Address
);
72 CallbackEntry
->EndPointer
= CallbackEntry
->StatusCodeDataBuffer
;
76 Register the callback function for ReportStatusCode() notification.
78 When this function is called the function pointer is added to an internal list and any future calls to
79 ReportStatusCode() will be forwarded to the Callback function. During the bootservices,
80 this is the callback for which this service can be invoked. The report status code router
81 will create an event such that the callback function is only invoked at the TPL for which it was
82 registered. The entity that registers for the callback should also register for an event upon
83 generation of exit boot services and invoke the unregister service.
84 If the handler does not have a TPL dependency, it should register for a callback at TPL high. The
85 router infrastructure will support making callbacks at runtime, but the caller for runtime invocation
86 must meet the following criteria:
87 1. must be a runtime driver type so that its memory is not reclaimed
88 2. not unregister at exit boot services so that the router will still have its callback address
89 3. the caller must be self-contained (eg. Not call out into any boot-service interfaces) and be
90 runtime safe, in general.
92 @param[in] Callback A pointer to a function of type EFI_RSC_HANDLER_CALLBACK that is called when
93 a call to ReportStatusCode() occurs.
94 @param[in] Tpl TPL at which callback can be safely invoked.
96 @retval EFI_SUCCESS Function was successfully registered.
97 @retval EFI_INVALID_PARAMETER The callback function was NULL.
98 @retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be
100 @retval EFI_ALREADY_STARTED The function was already registered. It can't be registered again.
106 IN EFI_RSC_HANDLER_CALLBACK Callback
,
112 RSC_HANDLER_CALLBACK_ENTRY
*CallbackEntry
;
114 if (Callback
== NULL
) {
115 return EFI_INVALID_PARAMETER
;
118 for (Link
= GetFirstNode (&mCallbackListHead
); !IsNull (&mCallbackListHead
, Link
); Link
= GetNextNode (&mCallbackListHead
, Link
)) {
119 CallbackEntry
= CR (Link
, RSC_HANDLER_CALLBACK_ENTRY
, Node
, RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE
);
120 if (CallbackEntry
->RscHandlerCallback
== Callback
) {
122 // If the function was already registered. It can't be registered again.
124 return EFI_ALREADY_STARTED
;
128 CallbackEntry
= AllocateRuntimeZeroPool (sizeof (RSC_HANDLER_CALLBACK_ENTRY
));
129 ASSERT (CallbackEntry
!= NULL
);
131 CallbackEntry
->Signature
= RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE
;
132 CallbackEntry
->RscHandlerCallback
= Callback
;
133 CallbackEntry
->Tpl
= Tpl
;
136 // If TPL of registered callback funtion is not TPL_HIGH_LEVEL, then event should be created
137 // for it, and related buffer for status code data should be prepared.
138 // Here the data buffer must be prepared in advance, because Report Status Code Protocol might
139 // be invoked under TPL_HIGH_LEVEL and no memory allocation is allowed then.
140 // If TPL is TPL_HIGH_LEVEL, then all status code will be reported immediately, without data
141 // buffer and event trigger.
143 if (Tpl
!= TPL_HIGH_LEVEL
) {
144 CallbackEntry
->StatusCodeDataBuffer
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) AllocatePool (EFI_PAGE_SIZE
);
145 CallbackEntry
->BufferSize
= EFI_PAGE_SIZE
;
146 CallbackEntry
->EndPointer
= CallbackEntry
->StatusCodeDataBuffer
;
147 Status
= gBS
->CreateEvent (
150 RscHandlerNotification
,
152 &CallbackEntry
->Event
154 ASSERT_EFI_ERROR (Status
);
157 InsertTailList (&mCallbackListHead
, &CallbackEntry
->Node
);
163 Remove a previously registered callback function from the notification list.
165 A callback function must be unregistered before it is deallocated. It is important that any registered
166 callbacks that are not runtime complaint be unregistered when ExitBootServices() is called.
168 @param[in] Callback A pointer to a function of type EFI_RSC_HANDLER_CALLBACK that is to be
171 @retval EFI_SUCCESS The function was successfully unregistered.
172 @retval EFI_INVALID_PARAMETER The callback function was NULL.
173 @retval EFI_NOT_FOUND The callback function was not found to be unregistered.
179 IN EFI_RSC_HANDLER_CALLBACK Callback
183 RSC_HANDLER_CALLBACK_ENTRY
*CallbackEntry
;
185 if (Callback
== NULL
) {
186 return EFI_INVALID_PARAMETER
;
189 for (Link
= GetFirstNode (&mCallbackListHead
); !IsNull (&mCallbackListHead
, Link
); Link
= GetNextNode (&mCallbackListHead
, Link
)) {
190 CallbackEntry
= CR (Link
, RSC_HANDLER_CALLBACK_ENTRY
, Node
, RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE
);
191 if (CallbackEntry
->RscHandlerCallback
== Callback
) {
193 // If the function is found in list, delete it and return.
195 if (CallbackEntry
->Tpl
!= TPL_HIGH_LEVEL
) {
196 FreePool ((VOID
*) (UINTN
) CallbackEntry
->StatusCodeDataBuffer
);
197 gBS
->CloseEvent (CallbackEntry
->Event
);
199 RemoveEntryList (&CallbackEntry
->Node
);
200 FreePool (CallbackEntry
);
205 return EFI_NOT_FOUND
;
209 Provides an interface that a software module can call to report a status code.
211 @param Type Indicates the type of status code being reported.
212 @param Value Describes the current status of a hardware or software entity.
213 This included information about the class and subclass that is used to
214 classify the entity as well as an operation.
215 @param Instance The enumeration of a hardware or software entity within
216 the system. Valid instance numbers start with 1.
217 @param CallerId This optional parameter may be used to identify the caller.
218 This parameter allows the status code driver to apply different rules to
220 @param Data This optional parameter may be used to pass additional data.
222 @retval EFI_SUCCESS The function completed successfully
223 @retval EFI_DEVICE_ERROR The function should not be completed due to a device error.
229 IN EFI_STATUS_CODE_TYPE Type
,
230 IN EFI_STATUS_CODE_VALUE Value
,
232 IN EFI_GUID
*CallerId OPTIONAL
,
233 IN EFI_STATUS_CODE_DATA
*Data OPTIONAL
237 RSC_HANDLER_CALLBACK_ENTRY
*CallbackEntry
;
238 RSC_DATA_ENTRY
*RscData
;
241 EFI_PHYSICAL_ADDRESS FailSafeEndPointer
;
244 // Use atom operation to avoid the reentant of report.
245 // If current status is not zero, then the function is reentrancy.
247 if (InterlockedCompareExchange32 (&mStatusCodeNestStatus
, 0, 1) == 1) {
248 return EFI_DEVICE_ERROR
;
251 for (Link
= GetFirstNode (&mCallbackListHead
); !IsNull (&mCallbackListHead
, Link
);) {
252 CallbackEntry
= CR (Link
, RSC_HANDLER_CALLBACK_ENTRY
, Node
, RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE
);
254 // The handler may remove itself, so get the next handler in advance.
256 Link
= GetNextNode (&mCallbackListHead
, Link
);
257 if ((CallbackEntry
->Tpl
== TPL_HIGH_LEVEL
) || EfiAtRuntime ()) {
258 CallbackEntry
->RscHandlerCallback (
269 // If callback is registered with TPL lower than TPL_HIGH_LEVEL, event must be signaled at boot time to possibly wait for
270 // allowed TPL to report status code. Related data should also be stored in data buffer.
272 FailSafeEndPointer
= CallbackEntry
->EndPointer
;
273 CallbackEntry
->EndPointer
= ALIGN_VARIABLE (CallbackEntry
->EndPointer
);
274 RscData
= (RSC_DATA_ENTRY
*) (UINTN
) CallbackEntry
->EndPointer
;
275 CallbackEntry
->EndPointer
+= sizeof (RSC_DATA_ENTRY
);
277 CallbackEntry
->EndPointer
+= (Data
->Size
+ Data
->HeaderSize
- sizeof (EFI_STATUS_CODE_DATA
));
281 // 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.
283 if (CallbackEntry
->EndPointer
> (CallbackEntry
->StatusCodeDataBuffer
+ (CallbackEntry
->BufferSize
/ 8) * 7)) {
284 if (EfiGetCurrentTpl () < TPL_HIGH_LEVEL
) {
285 NewBuffer
= ReallocatePool (
286 CallbackEntry
->BufferSize
,
287 CallbackEntry
->BufferSize
* 2,
288 (VOID
*) (UINTN
) CallbackEntry
->StatusCodeDataBuffer
290 if (NewBuffer
!= NULL
) {
291 FailSafeEndPointer
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) NewBuffer
+ (FailSafeEndPointer
- CallbackEntry
->StatusCodeDataBuffer
);
292 CallbackEntry
->EndPointer
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) NewBuffer
+ (CallbackEntry
->EndPointer
- CallbackEntry
->StatusCodeDataBuffer
);
293 RscData
= (RSC_DATA_ENTRY
*) (UINTN
) ((UINTN
) NewBuffer
+ ((UINTN
) RscData
- CallbackEntry
->StatusCodeDataBuffer
));
294 CallbackEntry
->StatusCodeDataBuffer
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) NewBuffer
;
295 CallbackEntry
->BufferSize
*= 2;
301 // If data buffer is used up, do not report for this time.
303 if (CallbackEntry
->EndPointer
> (CallbackEntry
->StatusCodeDataBuffer
+ CallbackEntry
->BufferSize
)) {
304 CallbackEntry
->EndPointer
= FailSafeEndPointer
;
308 RscData
->Type
= Type
;
309 RscData
->Value
= Value
;
310 RscData
->Instance
= Instance
;
311 if (CallerId
!= NULL
) {
312 CopyGuid (&RscData
->CallerId
, CallerId
);
315 CopyMem (&RscData
->Data
, Data
, Data
->HeaderSize
+ Data
->Size
);
317 ZeroMem (&RscData
->Data
, sizeof (RscData
->Data
));
318 RscData
->Data
.HeaderSize
= sizeof (RscData
->Data
);
321 Status
= gBS
->SignalEvent (CallbackEntry
->Event
);
322 ASSERT_EFI_ERROR (Status
);
326 // Restore the nest status of report
328 InterlockedCompareExchange32 (&mStatusCodeNestStatus
, 1, 0);
334 Virtual address change notification call back. It converts global pointer
337 @param Event Event whose notification function is being invoked.
338 @param Context Pointer to the notification function's context, which is
339 always zero in current implementation.
344 VirtualAddressChangeCallBack (
351 RSC_HANDLER_CALLBACK_ENTRY
*CallbackEntry
;
353 for (Link
= GetFirstNode (&mCallbackListHead
); !IsNull (&mCallbackListHead
, Link
); Link
= GetNextNode (&mCallbackListHead
, Link
)) {
354 CallbackEntry
= CR (Link
, RSC_HANDLER_CALLBACK_ENTRY
, Node
, RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE
);
355 Status
= EfiConvertFunctionPointer (0, (VOID
**) &CallbackEntry
->RscHandlerCallback
);
356 ASSERT_EFI_ERROR (Status
);
359 Status
= EfiConvertList (
363 ASSERT_EFI_ERROR (Status
);
367 Entry point of Generic Status Code Driver.
369 This function is the entry point of this Generic Status Code Driver.
370 It installs eport Stataus Code Handler Protocol and Status Code Runtime Protocol,
371 and registers event for EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.
373 @param ImageHandle The firmware allocated handle for the EFI image.
374 @param SystemTable A pointer to the EFI System Table.
376 @retval EFI_SUCCESS The entry point is executed successfully.
381 GenericStatusCodeRuntimeDxeEntry (
382 IN EFI_HANDLE ImageHandle
,
383 IN EFI_SYSTEM_TABLE
*SystemTable
388 Status
= gBS
->InstallMultipleProtocolInterfaces (
390 &gEfiRscHandlerProtocolGuid
,
391 &mRscHandlerProtocol
,
392 &gEfiStatusCodeRuntimeProtocolGuid
,
393 &mStatusCodeProtocol
,
396 ASSERT_EFI_ERROR (Status
);
398 Status
= gBS
->CreateEventEx (
401 VirtualAddressChangeCallBack
,
403 &gEfiEventVirtualAddressChangeGuid
,
404 &mVirtualAddressChangeEvent
406 ASSERT_EFI_ERROR (Status
);