-/** @file\r
- Status code driver for IA32/X64/EBC architecture.\r
-\r
- Copyright (c) 2006, 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
- Module Name: DxeStatusCodeCommon.c\r
-\r
-**/\r
-//\r
-// Include common header file for this module.\r
-//\r
-#include "CommonHeader.h"\r
-\r
-#include "DxeStatusCode.h"\r
-\r
-\r
-/**\r
- Report status code to all supported device. \r
- Calls into the workers which dispatches the platform specific\r
- listeners. \r
-\r
- @param Type Indicates the type of status code being reported. \r
- The type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r
- @param Value Describes the current status of a hardware or software entity. \r
- This includes information about the class and subclass that is used to classify the entity \r
- as well as an operation. For progress codes, the operation is the current activity. \r
- For error codes, it is the exception. For debug codes, it is not defined at this time. \r
- Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. \r
- Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r
- @param Instance The enumeration of a hardware or software entity within the system. \r
- A system may contain multiple entities that match a class/subclass pairing. \r
- The instance differentiates between them. An instance of 0 indicates that instance \r
- information is unavailable, not meaningful, or not relevant. 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 different callers.\r
- @param Data This optional parameter may be used to pass additional data. \r
- Type EFI_STATUS_CODE_DATA is defined in "Related Definitions" below. \r
- The contents of this data type may have additional GUID-specific data. The standard GUIDs and \r
- their associated data structures are defined in the Intel? Platform Innovation Framework for EFI Status Codes Specification.\r
-\r
- @return Always return EFI_SUCCESS.\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
-//\r
-// Declaration of status code protocol.\r
-//\r
-STATIC\r
-EFI_STATUS_CODE_PROTOCOL mEfiStatusCodeProtocol = {\r
- ReportDispatcher\r
-};\r
-\r
-//\r
-// Delaration of DXE status code controller \r
-//\r
-DXE_STATUS_CODE_CONTROLLER gDxeStatusCode = {\r
- //\r
- // Initialize nest status as non nested. \r
- // \r
- 0,\r
- {NULL, NULL}\r
-};\r
-\r
-/**\r
-\r
- Install the ReportStatusCode runtime service.\r
- \r
- @param ImageHandle Image handle of the loaded driver\r
- @param SystemTable Pointer to the System Table\r
-\r
- @return The function always returns success.\r
-\r
-**/\r
-EFI_STATUS\r
-DxeStatusCodeDriverEntry (\r
- IN EFI_HANDLE ImageHandle,\r
- IN EFI_SYSTEM_TABLE *SystemTable\r
- )\r
-{\r
- EFI_HANDLE Handle = NULL;\r
- EFI_STATUS Status;\r
-\r
- //\r
- // Dispatch initialization request to supported devices\r
- //\r
- InitializationDispatcherWorker ();\r
-\r
- //\r
- // Install Status Code Architectural Protocol implementation as defined in Tiano\r
- // Architecture Specification.\r
- //\r
- Status = gBS->InstallMultipleProtocolInterfaces (\r
- &Handle,\r
- &gEfiStatusCodeRuntimeProtocolGuid,\r
- &mEfiStatusCodeProtocol,\r
- NULL\r
- );\r
- ASSERT_EFI_ERROR (Status);\r
-\r
- return Status;\r
-}\r
-\r
-/**\r
- Report status code to all supported device. \r
- Calls into the workers which dispatches the platform specific\r
- listeners. \r
-\r
- @param CodeType Indicates the type of status code being reported. \r
- The type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r
- @param Value Describes the current status of a hardware or software entity. \r
- This includes information about the class and subclass that is used to classify the entity \r
- as well as an operation. For progress codes, the operation is the current activity. \r
- For error codes, it is the exception. For debug codes, it is not defined at this time. \r
- Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. \r
- Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r
- @param Instance The enumeration of a hardware or software entity within the system. \r
- A system may contain multiple entities that match a class/subclass pairing. \r
- The instance differentiates between them. An instance of 0 indicates that instance \r
- information is unavailable, not meaningful, or not relevant. 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 different callers.\r
- @param Data This optional parameter may be used to pass additional data. \r
- Type EFI_STATUS_CODE_DATA is defined in "Related Definitions" below. \r
- The contents of this data type may have additional GUID-specific data. The standard GUIDs and \r
- their associated data structures are defined in the Intel? Platform Innovation Framework for EFI Status Codes Specification.\r
-\r
- @return Always return EFI_SUCCESS.\r
-\r
-**/\r
-EFI_STATUS \r
-EFIAPI\r
-ReportDispatcher (\r
- IN EFI_STATUS_CODE_TYPE CodeType,\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
- //\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 (1 == InterlockedCompareExchange32 (&gDxeStatusCode.StatusCodeNestStatus, 0, 1)) {\r
- return EFI_DEVICE_ERROR;\r
- }\r
-\r
- if (FeaturePcdGet (PcdStatusCodeUseEfiSerial) || FeaturePcdGet (PcdStatusCodeUseHardSerial)) {\r
- SerialStatusCodeReportWorker (\r
- CodeType,\r
- Value,\r
- Instance,\r
- CallerId,\r
- Data\r
- );\r
- }\r
- if (FeaturePcdGet (PcdStatusCodeUseRuntimeMemory)) {\r
- RtMemoryStatusCodeReportWorker (\r
- gDxeStatusCode.RtMemoryStatusCodeTable[PHYSICAL_MODE],\r
- CodeType,\r
- Value,\r
- Instance\r
- );\r
- }\r
- if (FeaturePcdGet (PcdStatusCodeUseDataHub)) {\r
- DataHubStatusCodeReportWorker (\r
- CodeType,\r
- Value,\r
- Instance,\r
- CallerId,\r
- Data\r
- );\r
- }\r
- if (FeaturePcdGet (PcdStatusCodeUseOEM)) {\r
- OemHookStatusCodeReport (\r
- CodeType,\r
- Value,\r
- Instance,\r
- CallerId,\r
- Data\r
- );\r
- }\r
-\r
- //\r
- // Restore the nest status of report\r
- //\r
- InterlockedCompareExchange32 (&gDxeStatusCode.StatusCodeNestStatus, 1, 0);\r
-\r
- return EFI_SUCCESS;\r
-}\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
- //\r
- // Convert memory status code table to virtual address;\r
- //\r
- EfiConvertPointer (\r
- 0, \r
- (VOID **) &gDxeStatusCode.RtMemoryStatusCodeTable[PHYSICAL_MODE]\r
- );\r
-}\r
-\r