+/** @file\r
+ 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
+\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
+\r
+//\r
+// Report operation nest status.\r
+// If it is set, then the report operation has nested.\r
+//\r
+UINT32 mStatusCodeNestStatus = 0;\r
+\r
+EFI_STATUS_CODE_PROTOCOL mStatusCodeProtocol = {\r
+ ReportDispatcher\r
+};\r
+\r
+EFI_RSC_HANDLER_PROTOCOL mRscHandlerProtocol = {\r
+ Register,\r
+ Unregister\r
+ };\r
+\r
+/**\r
+ Register the callback function for ReportStatusCode() notification.\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
+ will create an event such that the callback function is only invoked at the TPL for which it was\r
+ registered. The entity that registers for the callback should also register for an event upon\r
+ generation of exit boot services and invoke the unregister service.\r
+ If the handler does not have a TPL dependency, it should register for a callback at TPL high. The\r
+ router infrastructure will support making callbacks at runtime, but the caller for runtime invocation\r
+ must meet the following criteria:\r
+ 1. must be a runtime driver type so that its memory is not reclaimed\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
+ @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
+ @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
+ registered.\r
+ @retval EFI_ALREADY_STARTED The function was already registered. It can't be registered again.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+Register (\r
+ IN EFI_RSC_HANDLER_CALLBACK Callback,\r
+ IN EFI_TPL Tpl\r
+ )\r
+{\r
+ LIST_ENTRY *Link;\r
+ RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;\r
+\r
+ if (Callback == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\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
+ if (CallbackEntry->RscHandlerCallback == Callback) {\r
+ //\r
+ // If the function was already registered. It can't be registered again.\r
+ //\r
+ return EFI_ALREADY_STARTED;\r
+ }\r
+ }\r
+\r
+ CallbackEntry = AllocatePool (sizeof (RSC_HANDLER_CALLBACK_ENTRY));\r
+ ASSERT (CallbackEntry != NULL);\r
+\r
+ CallbackEntry->Signature = RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE;\r
+ CallbackEntry->RscHandlerCallback = Callback;\r
+ CallbackEntry->Tpl = Tpl;\r
+\r
+ InsertTailList (&mCallbackListHead, &CallbackEntry->Node);\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ Remove a previously registered callback function from the notification list.\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
+ @param[in] Callback A pointer to a function of type EFI_RSC_HANDLER_CALLBACK that is to be\r
+ unregistered.\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
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+Unregister (\r
+ IN EFI_RSC_HANDLER_CALLBACK Callback\r
+ )\r
+{\r
+ LIST_ENTRY *Link;\r
+ RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;\r
+\r
+ if (Callback == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\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
+ if (CallbackEntry->RscHandlerCallback == Callback) {\r
+ //\r
+ // If the function is found in list, delete it and return.\r
+ //\r
+ RemoveEntryList (&CallbackEntry->Node);\r
+ FreePool (CallbackEntry);\r
+ return EFI_SUCCESS;\r
+ }\r
+ }\r
+\r
+ return EFI_NOT_FOUND;\r
+}\r
+\r
+/**\r
+ Event callback function to invoke status code handler in list.\r
+\r
+ @param Event Event whose notification function is being invoked.\r
+ @param Context Pointer to the notification function's context, which is\r
+ always zero in current implementation.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+RscHandlerNotification (\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
+ )\r
+{\r
+ RSC_EVENT_CONTEXT *RscContext;\r
+\r
+ RscContext = (RSC_EVENT_CONTEXT *) Context;\r
+\r
+ RscContext->RscHandlerCallback (\r
+ RscContext->Type,\r
+ RscContext->Value,\r
+ RscContext->Instance,\r
+ RscContext->CallerId,\r
+ RscContext->Data\r
+ );\r
+}\r
+\r
+/**\r
+ Provides an interface that a software module can call to report a status code.\r
+\r
+ @param Type Indicates the type of status code being reported.\r
+ @param Value Describes the current status of a hardware or software entity.\r
+ This included information about the class and subclass that is used to\r
+ classify the entity as well as an operation.\r
+ @param Instance The enumeration of a hardware or software entity within\r
+ the system. Valid instance numbers start with 1.\r
+ @param CallerId This optional parameter may be used to identify the caller.\r
+ This parameter allows the status code driver to apply different rules to\r
+ different callers.\r
+ @param Data This optional parameter may be used to pass additional data.\r
+\r
+ @retval EFI_SUCCESS The function completed successfully\r
+ @retval EFI_DEVICE_ERROR The function should not be completed due to a device error.\r
+\r
+**/\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
+ )\r
+{\r
+ LIST_ENTRY *Link;\r
+ RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;\r
+ RSC_EVENT_CONTEXT Context;\r
+ EFI_EVENT Event;\r
+ EFI_STATUS Status;\r
+\r
+ //\r
+ // Use atom operation to avoid the reentant of report.\r
+ // If current status is not zero, then the function is reentrancy.\r
+ //\r
+ if (InterlockedCompareExchange32 (&mStatusCodeNestStatus, 0, 1) == 1) {\r
+ return EFI_DEVICE_ERROR;\r
+ }\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
+\r
+ if ((CallbackEntry->Tpl == TPL_HIGH_LEVEL) || EfiAtRuntime ()) {\r
+ CallbackEntry->RscHandlerCallback (\r
+ Type,\r
+ Value,\r
+ Instance,\r
+ CallerId,\r
+ Data\r
+ );\r
+ continue;\r
+ }\r
+\r
+ Context.RscHandlerCallback = CallbackEntry->RscHandlerCallback;\r
+ Context.Type = Type;\r
+ Context.Value = Value;\r
+ Context.Instance = Instance;\r
+ Context.CallerId = CallerId;\r
+ Context.Data = Data;\r
+\r
+ Status = gBS->CreateEvent (\r
+ EVT_NOTIFY_SIGNAL,\r
+ CallbackEntry->Tpl,\r
+ RscHandlerNotification,\r
+ &Context,\r
+ &Event\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ Status = gBS->SignalEvent (Event);\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ Status = gBS->CloseEvent (Event);\r
+ ASSERT_EFI_ERROR (Status);\r
+ }\r
+\r
+ //\r
+ // Restore the nest status of report\r
+ //\r
+ InterlockedCompareExchange32 (&mStatusCodeNestStatus, 1, 0);\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ Virtual address change notification call back. It converts global pointer\r
+ to virtual address.\r
+\r
+ @param Event Event whose notification function is being invoked.\r
+ @param Context Pointer to the notification function's context, which is\r
+ always zero in current implementation.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+VirtualAddressChangeCallBack (\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
+\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
+ ASSERT_EFI_ERROR (Status);\r
+ }\r
+\r
+ Status = EfiConvertList (\r
+ 0,\r
+ &mCallbackListHead\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+}\r
+\r
+/**\r
+ Entry point of Generic Status Code Driver.\r
+\r
+ This function is the entry point of this Generic Status Code Driver.\r
+ It installs eport Stataus Code Handler Protocol and Status Code Runtime Protocol,\r
+ and registers event for EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.\r
+\r
+ @param ImageHandle The firmware allocated handle for the EFI image.\r
+ @param SystemTable A pointer to the EFI System Table.\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
+ )\r
+{\r
+ EFI_STATUS Status;\r
+\r
+ Status = gBS->InstallMultipleProtocolInterfaces (\r
+ &mHandle,\r
+ &gEfiRscHandlerProtocolGuid,\r
+ &mRscHandlerProtocol,\r
+ &gEfiStatusCodeRuntimeProtocolGuid,\r
+ &mStatusCodeProtocol,\r
+ NULL\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ Status = gBS->CreateEventEx (\r
+ EVT_NOTIFY_SIGNAL,\r
+ TPL_NOTIFY,\r
+ VirtualAddressChangeCallBack,\r
+ NULL,\r
+ &gEfiEventVirtualAddressChangeGuid,\r
+ &mVirtualAddressChangeEvent\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return EFI_SUCCESS;\r
+}\r