Report Status Code Router Driver which produces Report Stataus Code Handler Protocol\r
and Status Code Runtime Protocol.\r
\r
- Copyright (c) 2009, Intel Corporation\r
- All rights reserved. This program and the accompanying materials\r
- are licensed and made available under the terms and conditions of the BSD License\r
- which accompanies this distribution. The full text of the license may be found at\r
- http://opensource.org/licenses/bsd-license.php\r
-\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+ Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
+ Copyright (c) Microsoft Corporation.<BR>\r
+ SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "ReportStatusCodeRouterRuntimeDxe.h"\r
\r
-EFI_HANDLE mHandle = NULL;\r
-LIST_ENTRY mCallbackListHead = INITIALIZE_LIST_HEAD_VARIABLE (mCallbackListHead);\r
-EFI_EVENT mVirtualAddressChangeEvent = NULL;\r
+EFI_HANDLE mHandle = NULL;\r
+LIST_ENTRY mCallbackListHead = INITIALIZE_LIST_HEAD_VARIABLE (mCallbackListHead);\r
+EFI_EVENT mVirtualAddressChangeEvent = NULL;\r
\r
//\r
// Report operation nest status.\r
// If it is set, then the report operation has nested.\r
//\r
-UINT32 mStatusCodeNestStatus = 0;\r
+UINT32 mStatusCodeNestStatus = 0;\r
\r
-EFI_STATUS_CODE_PROTOCOL mStatusCodeProtocol = {\r
+EFI_STATUS_CODE_PROTOCOL mStatusCodeProtocol = {\r
ReportDispatcher\r
};\r
\r
EFI_RSC_HANDLER_PROTOCOL mRscHandlerProtocol = {\r
Register,\r
Unregister\r
- };\r
+};\r
\r
/**\r
Event callback function to invoke status code handler in list.\r
VOID\r
EFIAPI\r
RscHandlerNotification (\r
- IN EFI_EVENT Event,\r
- IN VOID *Context\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
)\r
{\r
RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;\r
EFI_PHYSICAL_ADDRESS Address;\r
RSC_DATA_ENTRY *RscData;\r
\r
- CallbackEntry = (RSC_HANDLER_CALLBACK_ENTRY *) Context;\r
+ CallbackEntry = (RSC_HANDLER_CALLBACK_ENTRY *)Context;\r
\r
//\r
// Traverse the status code data buffer to parse all\r
//\r
Address = CallbackEntry->StatusCodeDataBuffer;\r
while (Address < CallbackEntry->EndPointer) {\r
- RscData = (RSC_DATA_ENTRY *) (UINTN) Address;\r
+ RscData = (RSC_DATA_ENTRY *)(UINTN)Address;\r
CallbackEntry->RscHandlerCallback (\r
RscData->Type,\r
RscData->Value,\r
&RscData->Data\r
);\r
\r
- Address += (sizeof (RSC_DATA_ENTRY) + RscData->Data.Size);\r
+ Address += (OFFSET_OF (RSC_DATA_ENTRY, Data) + RscData->Data.HeaderSize + RscData->Data.Size);\r
Address = ALIGN_VARIABLE (Address);\r
}\r
\r
\r
/**\r
Register the callback function for ReportStatusCode() notification.\r
- \r
+\r
When this function is called the function pointer is added to an internal list and any future calls to\r
ReportStatusCode() will be forwarded to the Callback function. During the bootservices,\r
this is the callback for which this service can be invoked. The report status code router\r
2. not unregister at exit boot services so that the router will still have its callback address\r
3. the caller must be self-contained (eg. Not call out into any boot-service interfaces) and be\r
runtime safe, in general.\r
- \r
+\r
@param[in] Callback A pointer to a function of type EFI_RSC_HANDLER_CALLBACK that is called when\r
a call to ReportStatusCode() occurs.\r
- @param[in] Tpl TPL at which callback can be safely invoked. \r
- \r
+ @param[in] Tpl TPL at which callback can be safely invoked.\r
+\r
@retval EFI_SUCCESS Function was successfully registered.\r
@retval EFI_INVALID_PARAMETER The callback function was NULL.\r
@retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be\r
EFI_STATUS\r
EFIAPI\r
Register (\r
- IN EFI_RSC_HANDLER_CALLBACK Callback,\r
- IN EFI_TPL Tpl\r
+ IN EFI_RSC_HANDLER_CALLBACK Callback,\r
+ IN EFI_TPL Tpl\r
)\r
{\r
- EFI_STATUS Status;\r
- LIST_ENTRY *Link;\r
- RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;\r
+ EFI_STATUS Status;\r
+ LIST_ENTRY *Link;\r
+ RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;\r
\r
if (Callback == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
}\r
\r
- CallbackEntry = AllocateZeroPool (sizeof (RSC_HANDLER_CALLBACK_ENTRY));\r
+ CallbackEntry = AllocateRuntimeZeroPool (sizeof (RSC_HANDLER_CALLBACK_ENTRY));\r
ASSERT (CallbackEntry != NULL);\r
\r
CallbackEntry->Signature = RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE;\r
// buffer and event trigger.\r
//\r
if (Tpl != TPL_HIGH_LEVEL) {\r
- CallbackEntry->StatusCodeDataBuffer = (EFI_PHYSICAL_ADDRESS) (UINTN) AllocatePool (EFI_PAGE_SIZE);\r
+ CallbackEntry->StatusCodeDataBuffer = (EFI_PHYSICAL_ADDRESS)(UINTN)AllocatePool (EFI_PAGE_SIZE);\r
CallbackEntry->BufferSize = EFI_PAGE_SIZE;\r
CallbackEntry->EndPointer = CallbackEntry->StatusCodeDataBuffer;\r
- Status = gBS->CreateEvent (\r
- EVT_NOTIFY_SIGNAL,\r
- Tpl,\r
- RscHandlerNotification,\r
- CallbackEntry,\r
- &CallbackEntry->Event\r
- );\r
+ Status = gBS->CreateEvent (\r
+ EVT_NOTIFY_SIGNAL,\r
+ Tpl,\r
+ RscHandlerNotification,\r
+ CallbackEntry,\r
+ &CallbackEntry->Event\r
+ );\r
ASSERT_EFI_ERROR (Status);\r
}\r
\r
\r
/**\r
Remove a previously registered callback function from the notification list.\r
- \r
+\r
A callback function must be unregistered before it is deallocated. It is important that any registered\r
callbacks that are not runtime complaint be unregistered when ExitBootServices() is called.\r
- \r
+\r
@param[in] Callback A pointer to a function of type EFI_RSC_HANDLER_CALLBACK that is to be\r
unregistered.\r
- \r
+\r
@retval EFI_SUCCESS The function was successfully unregistered.\r
@retval EFI_INVALID_PARAMETER The callback function was NULL.\r
@retval EFI_NOT_FOUND The callback function was not found to be unregistered.\r
EFI_STATUS\r
EFIAPI\r
Unregister (\r
- IN EFI_RSC_HANDLER_CALLBACK Callback\r
+ IN EFI_RSC_HANDLER_CALLBACK Callback\r
)\r
{\r
- LIST_ENTRY *Link;\r
- RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;\r
+ LIST_ENTRY *Link;\r
+ RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;\r
\r
if (Callback == NULL) {\r
return EFI_INVALID_PARAMETER;\r
// If the function is found in list, delete it and return.\r
//\r
if (CallbackEntry->Tpl != TPL_HIGH_LEVEL) {\r
- FreePool ((VOID *) (UINTN) CallbackEntry->StatusCodeDataBuffer);\r
+ FreePool ((VOID *)(UINTN)CallbackEntry->StatusCodeDataBuffer);\r
gBS->CloseEvent (CallbackEntry->Event);\r
}\r
+\r
RemoveEntryList (&CallbackEntry->Node);\r
FreePool (CallbackEntry);\r
return EFI_SUCCESS;\r
EFI_STATUS\r
EFIAPI\r
ReportDispatcher (\r
- IN EFI_STATUS_CODE_TYPE Type,\r
- IN EFI_STATUS_CODE_VALUE Value,\r
- IN UINT32 Instance,\r
- IN EFI_GUID *CallerId OPTIONAL,\r
- IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r
+ IN EFI_STATUS_CODE_TYPE Type,\r
+ IN EFI_STATUS_CODE_VALUE Value,\r
+ IN UINT32 Instance,\r
+ IN EFI_GUID *CallerId OPTIONAL,\r
+ IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r
)\r
{\r
- LIST_ENTRY *Link;\r
- RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;\r
- RSC_DATA_ENTRY *RscData;\r
- EFI_STATUS Status;\r
- VOID *NewBuffer;\r
+ LIST_ENTRY *Link;\r
+ RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;\r
+ RSC_DATA_ENTRY *RscData;\r
+ EFI_STATUS Status;\r
+ VOID *NewBuffer;\r
+ EFI_PHYSICAL_ADDRESS FailSafeEndPointer;\r
\r
//\r
// Use atom operation to avoid the reentant of report.\r
return EFI_DEVICE_ERROR;\r
}\r
\r
- for (Link = GetFirstNode (&mCallbackListHead); !IsNull (&mCallbackListHead, Link); Link = GetNextNode (&mCallbackListHead, Link)) {\r
+ for (Link = GetFirstNode (&mCallbackListHead); !IsNull (&mCallbackListHead, Link);) {\r
CallbackEntry = CR (Link, RSC_HANDLER_CALLBACK_ENTRY, Node, RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE);\r
-\r
+ //\r
+ // The handler may remove itself, so get the next handler in advance.\r
+ //\r
+ Link = GetNextNode (&mCallbackListHead, Link);\r
if ((CallbackEntry->Tpl == TPL_HIGH_LEVEL) || EfiAtRuntime ()) {\r
CallbackEntry->RscHandlerCallback (\r
Type,\r
// If callback is registered with TPL lower than TPL_HIGH_LEVEL, event must be signaled at boot time to possibly wait for\r
// allowed TPL to report status code. Related data should also be stored in data buffer.\r
//\r
+ FailSafeEndPointer = CallbackEntry->EndPointer;\r
CallbackEntry->EndPointer = ALIGN_VARIABLE (CallbackEntry->EndPointer);\r
- RscData = (RSC_DATA_ENTRY *) (UINTN) CallbackEntry->EndPointer;\r
+ RscData = (RSC_DATA_ENTRY *)(UINTN)CallbackEntry->EndPointer;\r
CallbackEntry->EndPointer += sizeof (RSC_DATA_ENTRY);\r
if (Data != NULL) {\r
- CallbackEntry->EndPointer += Data->Size;\r
+ CallbackEntry->EndPointer += (Data->Size + Data->HeaderSize - sizeof (EFI_STATUS_CODE_DATA));\r
}\r
\r
//\r
NewBuffer = ReallocatePool (\r
CallbackEntry->BufferSize,\r
CallbackEntry->BufferSize * 2,\r
- (VOID *) (UINTN) CallbackEntry->StatusCodeDataBuffer\r
+ (VOID *)(UINTN)CallbackEntry->StatusCodeDataBuffer\r
);\r
if (NewBuffer != NULL) {\r
- CallbackEntry->EndPointer = (EFI_PHYSICAL_ADDRESS) (UINTN) NewBuffer + (CallbackEntry->EndPointer - CallbackEntry->StatusCodeDataBuffer);\r
- CallbackEntry->StatusCodeDataBuffer = (EFI_PHYSICAL_ADDRESS) (UINTN) NewBuffer;\r
- CallbackEntry->BufferSize *= 2;\r
+ FailSafeEndPointer = (EFI_PHYSICAL_ADDRESS)(UINTN)NewBuffer + (FailSafeEndPointer - CallbackEntry->StatusCodeDataBuffer);\r
+ CallbackEntry->EndPointer = (EFI_PHYSICAL_ADDRESS)(UINTN)NewBuffer + (CallbackEntry->EndPointer - CallbackEntry->StatusCodeDataBuffer);\r
+ RscData = (RSC_DATA_ENTRY *)(UINTN)((UINTN)NewBuffer + ((UINTN)RscData - CallbackEntry->StatusCodeDataBuffer));\r
+ CallbackEntry->StatusCodeDataBuffer = (EFI_PHYSICAL_ADDRESS)(UINTN)NewBuffer;\r
+ CallbackEntry->BufferSize *= 2;\r
}\r
}\r
}\r
// If data buffer is used up, do not report for this time.\r
//\r
if (CallbackEntry->EndPointer > (CallbackEntry->StatusCodeDataBuffer + CallbackEntry->BufferSize)) {\r
+ CallbackEntry->EndPointer = FailSafeEndPointer;\r
continue;\r
}\r
\r
- RscData->Type = Type;\r
- RscData->Value = Value;\r
- RscData->Instance = Instance;\r
+ RscData->Type = Type;\r
+ RscData->Value = Value;\r
+ RscData->Instance = Instance;\r
if (CallerId != NULL) {\r
CopyGuid (&RscData->CallerId, CallerId);\r
}\r
+\r
if (Data != NULL) {\r
CopyMem (&RscData->Data, Data, Data->HeaderSize + Data->Size);\r
+ } else {\r
+ ZeroMem (&RscData->Data, sizeof (RscData->Data));\r
+ RscData->Data.HeaderSize = sizeof (RscData->Data);\r
}\r
\r
Status = gBS->SignalEvent (CallbackEntry->Event);\r
VOID\r
EFIAPI\r
VirtualAddressChangeCallBack (\r
- IN EFI_EVENT Event,\r
- IN VOID *Context\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
)\r
{\r
- EFI_STATUS Status;\r
- LIST_ENTRY *Link;\r
- RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;\r
+ EFI_STATUS Status;\r
+ LIST_ENTRY *Link;\r
+ RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;\r
\r
for (Link = GetFirstNode (&mCallbackListHead); !IsNull (&mCallbackListHead, Link); Link = GetNextNode (&mCallbackListHead, Link)) {\r
CallbackEntry = CR (Link, RSC_HANDLER_CALLBACK_ENTRY, Node, RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE);\r
- Status = EfiConvertFunctionPointer (0, (VOID **) &CallbackEntry->RscHandlerCallback);\r
+ Status = EfiConvertFunctionPointer (0, (VOID **)&CallbackEntry->RscHandlerCallback);\r
ASSERT_EFI_ERROR (Status);\r
}\r
\r
\r
@param ImageHandle The firmware allocated handle for the EFI image.\r
@param SystemTable A pointer to the EFI System Table.\r
- \r
+\r
@retval EFI_SUCCESS The entry point is executed successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GenericStatusCodeRuntimeDxeEntry (\r
- IN EFI_HANDLE ImageHandle,\r
- IN EFI_SYSTEM_TABLE *SystemTable\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
)\r
{\r
- EFI_STATUS Status;\r
+ EFI_STATUS Status;\r
\r
Status = gBS->InstallMultipleProtocolInterfaces (\r
&mHandle,\r
projects / mirror_edk2.git / blobdiff