]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkModulePkg/Universal/StatusCode/Dxe/DxeStatusCodeCommon.c
Code Scrub for Status Code Runtime Dxe driver.
[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / StatusCode / Dxe / DxeStatusCodeCommon.c
index 954e82740588f2537c27c5b4fa5549dc36abc71c..2a156a503d45b64f5de3d8ccb2d96656bc310468 100644 (file)
 \r
 #include "DxeStatusCode.h"\r
 \r
-//\r
-// Event for Exit Boot Services Callback\r
-//\r
-EFI_EVENT mExitBootServicesEvent = NULL;\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
+EFI_EVENT    mVirtualAddressChangeEvent = NULL;\r
+EFI_HANDLE   mHandle = NULL;\r
 \r
 //\r
 // Declaration of status code protocol.\r
@@ -64,24 +25,21 @@ EFI_STATUS_CODE_PROTOCOL  mEfiStatusCodeProtocol  = {
 };\r
 \r
 //\r
-// Delaration of DXE status code controller\r
+// Report operation nest status.\r
+// If it is set, then the report operation has nested.\r
 //\r
-DXE_STATUS_CODE_CONTROLLER gDxeStatusCode = {\r
-  //\r
-  // Initialize nest status as non nested.\r
-  //\r
-  0,\r
-  {NULL, NULL}\r
-};\r
+UINT32  mStatusCodeNestStatus = 0;\r
 \r
 /**\r
+  Entry point of DXE Status Code Driver.\r
 \r
-  Install the ReportStatusCode runtime service.\r
+  This function is the entry point of this DXE Status Code Driver.\r
+  It installs Status Code Runtime Protocol, and registers event for EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.\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
+  @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
@@ -91,7 +49,6 @@ DxeStatusCodeDriverEntry (
   IN EFI_SYSTEM_TABLE   *SystemTable\r
   )\r
 {\r
-  EFI_HANDLE  Handle       = NULL;\r
   EFI_STATUS  Status;\r
 \r
   //\r
@@ -100,11 +57,10 @@ DxeStatusCodeDriverEntry (
   InitializationDispatcherWorker ();\r
 \r
   //\r
-  // Install Status Code Architectural Protocol implementation as defined in Tiano\r
-  // Architecture Specification.\r
+  // Install Status Code Runtime Protocol implementation as defined in PI Specification.\r
   //\r
   Status = gBS->InstallMultipleProtocolInterfaces (\r
-                  &Handle,\r
+                  &mHandle,\r
                   &gEfiStatusCodeRuntimeProtocolGuid,\r
                   &mEfiStatusCodeProtocol,\r
                   NULL\r
@@ -116,39 +72,33 @@ DxeStatusCodeDriverEntry (
                   TPL_NOTIFY,\r
                   VirtualAddressChangeCallBack,\r
                   NULL,\r
-                  &gEfiEventExitBootServicesGuid,\r
-                  &mExitBootServicesEvent\r
+                  &gEfiEventVirtualAddressChangeGuid,\r
+                  &mVirtualAddressChangeEvent\r
                   );\r
   ASSERT_EFI_ERROR (Status);\r
 \r
-  return Status;\r
+  return EFI_SUCCESS;\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
+  This function implements EFI_STATUS_CODE_PROTOCOL.ReportStatusCode().\r
+  It calls into the workers which dispatches the platform specific listeners.\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
@@ -165,7 +115,7 @@ ReportDispatcher (
   // 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
+  if (InterlockedCompareExchange32 (&mStatusCodeNestStatus, 0, 1) == 1) {\r
     return EFI_DEVICE_ERROR;\r
   }\r
 \r
@@ -180,7 +130,6 @@ ReportDispatcher (
   }\r
   if (FeaturePcdGet (PcdStatusCodeUseRuntimeMemory)) {\r
     RtMemoryStatusCodeReportWorker (\r
-      gDxeStatusCode.RtMemoryStatusCodeTable[PHYSICAL_MODE],\r
       CodeType,\r
       Value,\r
       Instance\r
@@ -196,6 +145,9 @@ ReportDispatcher (
       );\r
   }\r
   if (FeaturePcdGet (PcdStatusCodeUseOEM)) {\r
+    //\r
+    // Call OEM hook status code library API to report status code to OEM device\r
+    //\r
     OemHookStatusCodeReport (\r
       CodeType,\r
       Value,\r
@@ -208,7 +160,7 @@ ReportDispatcher (
   //\r
   // Restore the nest status of report\r
   //\r
-  InterlockedCompareExchange32 (&gDxeStatusCode.StatusCodeNestStatus, 1, 0);\r
+  InterlockedCompareExchange32 (&mStatusCodeNestStatus, 1, 0);\r
 \r
   return EFI_SUCCESS;\r
 }\r
@@ -235,7 +187,7 @@ VirtualAddressChangeCallBack (
   //\r
   EfiConvertPointer (\r
     0,\r
-    (VOID **) &gDxeStatusCode.RtMemoryStatusCodeTable[PHYSICAL_MODE]\r
+    (VOID **) &mRtMemoryStatusCodeTable\r
     );\r
 }\r
 \r