]> git.proxmox.com Git - mirror_edk2.git/commitdiff
MdeModulePkg: ReportStatusCodeRouter: Support StandaloneMm RSC Router
authorKun Qin <kun.q@outlook.com>
Thu, 17 Dec 2020 22:28:57 +0000 (14:28 -0800)
committerKun Qin <kun.q@outlook.com>
Mon, 1 Feb 2021 18:01:04 +0000 (10:01 -0800)
This change added support of RSC router under StandaloneMm. It replaces
SMM version ReportStatusCode protocol definitions with MM version. This
patch also switched to use gMmst instead of gSmst. Lastly, it abstracts
standalone and traditional MM driver entrypoints into separate files to
allow maximal common implementations.

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Hao A Wu <hao.a.wu@intel.com>
Cc: Dandan Bi <dandan.bi@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Signed-off-by: Kun Qin <kun.q@outlook.com>
Reviewed-by: Hao A Wu <hao.a.wu@intel.com>
MdeModulePkg/MdeModulePkg.dsc
MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterCommon.c [new file with mode: 0644]
MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterCommon.h [new file with mode: 0644]
MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterSmm.c [deleted file]
MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterSmm.h [deleted file]
MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterSmm.inf
MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterStandaloneMm.c [new file with mode: 0644]
MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterStandaloneMm.inf [new file with mode: 0644]
MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterTraditional.c [new file with mode: 0644]

index 34ca571ca6621b00843407592d64708ab573ceca..f95c7cd69ee1f593061c2339a168589d68e41c4c 100644 (file)
   MdeModulePkg/Universal/StatusCodeHandler/Smm/StatusCodeHandlerSmm.inf\r
   MdeModulePkg/Universal/StatusCodeHandler/Smm/StatusCodeHandlerStandaloneMm.inf\r
   MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterSmm.inf\r
+  MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterStandaloneMm.inf\r
   MdeModulePkg/Universal/LockBox/SmmLockBox/SmmLockBox.inf\r
   MdeModulePkg/Library/SmmMemoryAllocationProfileLib/SmmMemoryAllocationProfileLib.inf\r
   MdeModulePkg/Library/PiSmmCoreMemoryAllocationLib/PiSmmCoreMemoryAllocationProfileLib.inf\r
diff --git a/MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterCommon.c b/MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterCommon.c
new file mode 100644 (file)
index 0000000..c4843a7
--- /dev/null
@@ -0,0 +1,228 @@
+/** @file\r
+  Report Status Code Router Driver which produces SMM Report Stataus Code Handler Protocol\r
+  and SMM Status Code Protocol.\r
+\r
+  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
+\r
+**/\r
+\r
+#include "ReportStatusCodeRouterCommon.h"\r
+\r
+LIST_ENTRY   mCallbackListHead          = INITIALIZE_LIST_HEAD_VARIABLE (mCallbackListHead);\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_MM_STATUS_CODE_PROTOCOL   mSmmStatusCodeProtocol  = {\r
+  ReportDispatcher\r
+};\r
+\r
+EFI_MM_RSC_HANDLER_PROTOCOL   mSmmRscHandlerProtocol = {\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.\r
+\r
+  @param[in] Callback           A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is called\r
+                                when a call to ReportStatusCode() occurs.\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_MM_RSC_HANDLER_CALLBACK    Callback\r
+  )\r
+{\r
+  LIST_ENTRY                      *Link;\r
+  MM_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, MM_RSC_HANDLER_CALLBACK_ENTRY, Node, MM_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 = (MM_RSC_HANDLER_CALLBACK_ENTRY *)AllocatePool (sizeof (MM_RSC_HANDLER_CALLBACK_ENTRY));\r
+  ASSERT (CallbackEntry != NULL);\r
+\r
+  CallbackEntry->Signature          = MM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE;\r
+  CallbackEntry->RscHandlerCallback = Callback;\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
+  ReportStatusCode() messages will no longer be forwarded to the Callback function.\r
+\r
+  @param[in] Callback           A pointer to a function of type EFI_PEI_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_MM_RSC_HANDLER_CALLBACK  Callback\r
+  )\r
+{\r
+  LIST_ENTRY                        *Link;\r
+  MM_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, MM_RSC_HANDLER_CALLBACK_ENTRY, Node, MM_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
+/**\r
+  Provides an interface that a software module can call to report a status code.\r
+\r
+  @param  This             EFI_MM_STATUS_CODE_PROTOCOL instance.\r
+  @param  CodeType         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 CONST EFI_MM_STATUS_CODE_PROTOCOL   *This,\r
+  IN EFI_STATUS_CODE_TYPE                CodeType,\r
+  IN EFI_STATUS_CODE_VALUE               Value,\r
+  IN UINT32                              Instance,\r
+  IN CONST EFI_GUID                      *CallerId,\r
+  IN EFI_STATUS_CODE_DATA                *Data      OPTIONAL\r
+  )\r
+{\r
+  LIST_ENTRY                        *Link;\r
+  MM_RSC_HANDLER_CALLBACK_ENTRY    *CallbackEntry;\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);) {\r
+    CallbackEntry = CR (Link, MM_RSC_HANDLER_CALLBACK_ENTRY, Node, MM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE);\r
+    //\r
+    // The handler may remove itself, so get the next handler in advance.\r
+    //\r
+    Link = GetNextNode (&mCallbackListHead, Link);\r
+    CallbackEntry->RscHandlerCallback (\r
+                     CodeType,\r
+                     Value,\r
+                     Instance,\r
+                     (EFI_GUID*)CallerId,\r
+                     Data\r
+                     );\r
+\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
+  Entry point of Generic Status Code Driver.\r
+\r
+  This function is the common entry point of MM Status Code Router.\r
+  It produces MM Report Status Code Handler and Status Code protocol.\r
+\r
+  @retval EFI_SUCCESS       The entry point is executed successfully.\r
+\r
+**/\r
+EFI_STATUS\r
+GenericStatusCodeCommonEntry (\r
+  VOID\r
+  )\r
+{\r
+  EFI_STATUS     Status;\r
+  EFI_HANDLE     Handle;\r
+\r
+  Handle     = NULL;\r
+\r
+  //\r
+  // Install SmmRscHandler Protocol\r
+  //\r
+  Status = gMmst->MmInstallProtocolInterface (\r
+                    &Handle,\r
+                    &gEfiMmRscHandlerProtocolGuid,\r
+                    EFI_NATIVE_INTERFACE,\r
+                    &mSmmRscHandlerProtocol\r
+                    );\r
+  ASSERT_EFI_ERROR (Status);\r
+\r
+  //\r
+  // Install SmmStatusCode Protocol\r
+  //\r
+  Status = gMmst->MmInstallProtocolInterface (\r
+                    &Handle,\r
+                    &gEfiMmStatusCodeProtocolGuid,\r
+                    EFI_NATIVE_INTERFACE,\r
+                    &mSmmStatusCodeProtocol\r
+                    );\r
+  ASSERT_EFI_ERROR (Status);\r
+\r
+  return EFI_SUCCESS;\r
+}\r
diff --git a/MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterCommon.h b/MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterCommon.h
new file mode 100644 (file)
index 0000000..4f4d055
--- /dev/null
@@ -0,0 +1,115 @@
+/** @file\r
+  Internal include file for Report Status Code Router Driver.\r
+\r
+  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
+\r
+**/\r
+\r
+#ifndef __REPORT_STATUS_CODE_ROUTER_COMMON_H__\r
+#define __REPORT_STATUS_CODE_ROUTER_COMMON_H__\r
+\r
+#include <Protocol/MmReportStatusCodeHandler.h>\r
+#include <Protocol/MmStatusCode.h>\r
+\r
+#include <Library/BaseLib.h>\r
+#include <Library/SynchronizationLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/PcdLib.h>\r
+#include <Library/MmServicesTableLib.h>\r
+#include <Library/MemoryAllocationLib.h>\r
+\r
+#define MM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE  SIGNATURE_32 ('s', 'h', 'c', 'e')\r
+\r
+typedef struct {\r
+  UINTN                         Signature;\r
+  EFI_MM_RSC_HANDLER_CALLBACK   RscHandlerCallback;\r
+  LIST_ENTRY                    Node;\r
+} MM_RSC_HANDLER_CALLBACK_ENTRY;\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.\r
+\r
+  @param[in] Callback           A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is called\r
+                                when a call to ReportStatusCode() occurs.\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_MM_RSC_HANDLER_CALLBACK    Callback\r
+  );\r
+\r
+/**\r
+  Remove a previously registered callback function from the notification list.\r
+\r
+  ReportStatusCode() messages will no longer be forwarded to the Callback function.\r
+\r
+  @param[in] Callback           A pointer to a function of type EFI_PEI_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_MM_RSC_HANDLER_CALLBACK  Callback\r
+  );\r
+\r
+/**\r
+  Provides an interface that a software module can call to report a status code.\r
+\r
+  @param  This             EFI_MM_STATUS_CODE_PROTOCOL instance.\r
+  @param  CodeType         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 CONST EFI_MM_STATUS_CODE_PROTOCOL   *This,\r
+  IN EFI_STATUS_CODE_TYPE                CodeType,\r
+  IN EFI_STATUS_CODE_VALUE               Value,\r
+  IN UINT32                              Instance,\r
+  IN CONST EFI_GUID                      *CallerId,\r
+  IN EFI_STATUS_CODE_DATA                *Data      OPTIONAL\r
+  );\r
+\r
+/**\r
+  Entry point of Generic Status Code Driver.\r
+\r
+  This function is the common entry point of MM Status Code Router.\r
+  It produces MM Report Status Code Handler and Status Code protocol.\r
+\r
+  @retval EFI_SUCCESS       The entry point is executed successfully.\r
+\r
+**/\r
+EFI_STATUS\r
+GenericStatusCodeCommonEntry (\r
+  VOID\r
+  );\r
+\r
+#endif\r
diff --git a/MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterSmm.c b/MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterSmm.c
deleted file mode 100644 (file)
index c3ab5cd..0000000
+++ /dev/null
@@ -1,233 +0,0 @@
-/** @file\r
-  Report Status Code Router Driver which produces SMM Report Stataus Code Handler Protocol\r
-  and SMM Status Code Protocol.\r
-\r
-  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
-  SPDX-License-Identifier: BSD-2-Clause-Patent\r
-\r
-**/\r
-\r
-#include "ReportStatusCodeRouterSmm.h"\r
-\r
-LIST_ENTRY   mCallbackListHead          = INITIALIZE_LIST_HEAD_VARIABLE (mCallbackListHead);\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_SMM_STATUS_CODE_PROTOCOL  mSmmStatusCodeProtocol  = {\r
-  ReportDispatcher\r
-};\r
-\r
-EFI_SMM_RSC_HANDLER_PROTOCOL  mSmmRscHandlerProtocol = {\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.\r
-\r
-  @param[in] Callback           A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is called\r
-                                when a call to ReportStatusCode() occurs.\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_SMM_RSC_HANDLER_CALLBACK   Callback\r
-  )\r
-{\r
-  LIST_ENTRY                      *Link;\r
-  SMM_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, SMM_RSC_HANDLER_CALLBACK_ENTRY, Node, SMM_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 = (SMM_RSC_HANDLER_CALLBACK_ENTRY *)AllocatePool (sizeof (SMM_RSC_HANDLER_CALLBACK_ENTRY));\r
-  ASSERT (CallbackEntry != NULL);\r
-\r
-  CallbackEntry->Signature          = SMM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE;\r
-  CallbackEntry->RscHandlerCallback = Callback;\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
-  ReportStatusCode() messages will no longer be forwarded to the Callback function.\r
-\r
-  @param[in] Callback           A pointer to a function of type EFI_PEI_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_SMM_RSC_HANDLER_CALLBACK Callback\r
-  )\r
-{\r
-  LIST_ENTRY                        *Link;\r
-  SMM_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, SMM_RSC_HANDLER_CALLBACK_ENTRY, Node, SMM_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
-/**\r
-  Provides an interface that a software module can call to report a status code.\r
-\r
-  @param  This             EFI_SMM_STATUS_CODE_PROTOCOL instance.\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 CONST EFI_SMM_STATUS_CODE_PROTOCOL  *This,\r
-  IN EFI_STATUS_CODE_TYPE                Type,\r
-  IN EFI_STATUS_CODE_VALUE               Value,\r
-  IN UINT32                              Instance,\r
-  IN CONST EFI_GUID                      *CallerId  OPTIONAL,\r
-  IN EFI_STATUS_CODE_DATA                *Data      OPTIONAL\r
-  )\r
-{\r
-  LIST_ENTRY                        *Link;\r
-  SMM_RSC_HANDLER_CALLBACK_ENTRY    *CallbackEntry;\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);) {\r
-    CallbackEntry = CR (Link, SMM_RSC_HANDLER_CALLBACK_ENTRY, Node, SMM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE);\r
-    //\r
-    // The handler may remove itself, so get the next handler in advance.\r
-    //\r
-    Link = GetNextNode (&mCallbackListHead, Link);\r
-    CallbackEntry->RscHandlerCallback (\r
-                     Type,\r
-                     Value,\r
-                     Instance,\r
-                     (EFI_GUID*)CallerId,\r
-                     Data\r
-                     );\r
-\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
-  Entry point of Generic Status Code Driver.\r
-\r
-  This function is the entry point of SMM Status Code Router .\r
-  It produces SMM Report Stataus Code Handler and Status Code protocol.\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
-GenericStatusCodeSmmEntry (\r
-  IN EFI_HANDLE         ImageHandle,\r
-  IN EFI_SYSTEM_TABLE   *SystemTable\r
-  )\r
-{\r
-  EFI_STATUS     Status;\r
-  EFI_HANDLE     Handle;\r
-\r
-  Handle     = NULL;\r
-\r
-  //\r
-  // Install SmmRscHandler Protocol\r
-  //\r
-  Status = gSmst->SmmInstallProtocolInterface (\r
-                    &Handle,\r
-                    &gEfiSmmRscHandlerProtocolGuid,\r
-                    EFI_NATIVE_INTERFACE,\r
-                    &mSmmRscHandlerProtocol\r
-                    );\r
-  ASSERT_EFI_ERROR (Status);\r
-\r
-  //\r
-  // Install SmmStatusCode Protocol\r
-  //\r
-  Status = gSmst->SmmInstallProtocolInterface (\r
-                    &Handle,\r
-                    &gEfiSmmStatusCodeProtocolGuid,\r
-                    EFI_NATIVE_INTERFACE,\r
-                    &mSmmStatusCodeProtocol\r
-                    );\r
-  ASSERT_EFI_ERROR (Status);\r
-\r
-  return EFI_SUCCESS;\r
-}\r
diff --git a/MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterSmm.h b/MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterSmm.h
deleted file mode 100644 (file)
index f8c48c6..0000000
+++ /dev/null
@@ -1,103 +0,0 @@
-/** @file\r
-  Internal include file for Report Status Code Router Driver.\r
-\r
-  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
-  SPDX-License-Identifier: BSD-2-Clause-Patent\r
-\r
-**/\r
-\r
-#ifndef __REPORT_STATUS_CODE_ROUTER_SMM_H__\r
-#define __REPORT_STATUS_CODE_ROUTER_SMM_H__\r
-\r
-\r
-#include <Protocol/SmmReportStatusCodeHandler.h>\r
-#include <Protocol/SmmStatusCode.h>\r
-\r
-#include <Library/BaseLib.h>\r
-#include <Library/SynchronizationLib.h>\r
-#include <Library/DebugLib.h>\r
-#include <Library/PcdLib.h>\r
-#include <Library/UefiDriverEntryPoint.h>\r
-#include <Library/SmmServicesTableLib.h>\r
-#include <Library/MemoryAllocationLib.h>\r
-\r
-#define SMM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE  SIGNATURE_32 ('s', 'h', 'c', 'e')\r
-\r
-typedef struct {\r
-  UINTN                         Signature;\r
-  EFI_SMM_RSC_HANDLER_CALLBACK  RscHandlerCallback;\r
-  LIST_ENTRY                    Node;\r
-} SMM_RSC_HANDLER_CALLBACK_ENTRY;\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.\r
-\r
-  @param[in] Callback           A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is called\r
-                                when a call to ReportStatusCode() occurs.\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_SMM_RSC_HANDLER_CALLBACK   Callback\r
-  );\r
-\r
-/**\r
-  Remove a previously registered callback function from the notification list.\r
-\r
-  ReportStatusCode() messages will no longer be forwarded to the Callback function.\r
-\r
-  @param[in] Callback           A pointer to a function of type EFI_PEI_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_SMM_RSC_HANDLER_CALLBACK Callback\r
-  );\r
-\r
-/**\r
-  Provides an interface that a software module can call to report a status code.\r
-\r
-  @param  This             EFI_SMM_STATUS_CODE_PROTOCOL instance.\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 CONST EFI_SMM_STATUS_CODE_PROTOCOL  *This,\r
-  IN EFI_STATUS_CODE_TYPE                Type,\r
-  IN EFI_STATUS_CODE_VALUE               Value,\r
-  IN UINT32                              Instance,\r
-  IN CONST EFI_GUID                      *CallerId  OPTIONAL,\r
-  IN EFI_STATUS_CODE_DATA                *Data      OPTIONAL\r
-  );\r
-\r
-#endif\r
index 46fdcb7bf9597da344138abe0282fc9578150178..539badc4c7553092a5dae7f1a238ab81e76d8729 100644 (file)
@@ -16,7 +16,7 @@
   MODULE_TYPE                    = DXE_SMM_DRIVER\r
   PI_SPECIFICATION_VERSION       = 0x0001000A\r
   VERSION_STRING                 = 1.0\r
-  ENTRY_POINT                    = GenericStatusCodeSmmEntry\r
+  ENTRY_POINT                    = GenericStatusCodeTraditionalEntry\r
 \r
 #\r
 # The following information is for reference only and not required by the build tools.\r
 #\r
 \r
 [Sources]\r
-  ReportStatusCodeRouterSmm.c\r
-  ReportStatusCodeRouterSmm.h\r
+  ReportStatusCodeRouterCommon.c\r
+  ReportStatusCodeRouterCommon.h\r
+  ReportStatusCodeRouterTraditional.c\r
 \r
 [Packages]\r
   MdePkg/MdePkg.dec\r
   MdeModulePkg/MdeModulePkg.dec\r
 \r
 [LibraryClasses]\r
-  SmmServicesTableLib\r
+  MmServicesTableLib\r
   UefiDriverEntryPoint\r
   DebugLib\r
   BaseLib\r
@@ -41,8 +42,8 @@
   MemoryAllocationLib\r
 \r
 [Protocols]\r
-  gEfiSmmRscHandlerProtocolGuid               ## PRODUCES\r
-  gEfiSmmStatusCodeProtocolGuid               ## PRODUCES\r
+  gEfiMmRscHandlerProtocolGuid               ## PRODUCES\r
+  gEfiMmStatusCodeProtocolGuid               ## PRODUCES\r
 \r
 [Depex]\r
   TRUE\r
diff --git a/MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterStandaloneMm.c b/MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterStandaloneMm.c
new file mode 100644 (file)
index 0000000..bd1519f
--- /dev/null
@@ -0,0 +1,33 @@
+/** @file\r
+  Report Status Code Router Driver which produces MM Report Stataus Code Handler Protocol\r
+  and MM Status Code Protocol.\r
+\r
+  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) Microsoft Corporation.\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
+\r
+**/\r
+\r
+#include "ReportStatusCodeRouterCommon.h"\r
+\r
+/**\r
+  Entry point of Generic Status Code Driver.\r
+\r
+  This function is the entry point of MM Status Code Router .\r
+  It produces MM Report Stataus Code Handler and Status Code protocol.\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
+GenericStatusCodeStandaloneMmEntry (\r
+  IN EFI_HANDLE             ImageHandle,\r
+  IN EFI_MM_SYSTEM_TABLE    *SystemTable\r
+  )\r
+{\r
+  return GenericStatusCodeCommonEntry ();\r
+}\r
diff --git a/MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterStandaloneMm.inf b/MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterStandaloneMm.inf
new file mode 100644 (file)
index 0000000..7aa0127
--- /dev/null
@@ -0,0 +1,49 @@
+## @file\r
+#  Report Status Code Router Driver which produces MM Report Stataus Code Handler Protocol and MM Status Code Protocol.\r
+#\r
+#  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
+#  Copyright (c) Microsoft Corporation.\r
+#\r
+#  SPDX-License-Identifier: BSD-2-Clause-Patent\r
+#\r
+#\r
+##\r
+\r
+[Defines]\r
+  INF_VERSION                    = 0x00010005\r
+  BASE_NAME                      = ReportStatusCodeRouterStandaloneMm\r
+  FILE_GUID                      = EAEEDEF9-ABE7-4B95-82B0-5A534C899B46\r
+  MODULE_TYPE                    = MM_STANDALONE\r
+  PI_SPECIFICATION_VERSION       = 0x00010032\r
+  VERSION_STRING                 = 1.0\r
+  ENTRY_POINT                    = GenericStatusCodeStandaloneMmEntry\r
+\r
+#\r
+# The following information is for reference only and not required by the build tools.\r
+#\r
+#  VALID_ARCHITECTURES           = IA32 X64\r
+#\r
+\r
+[Sources]\r
+  ReportStatusCodeRouterCommon.c\r
+  ReportStatusCodeRouterCommon.h\r
+  ReportStatusCodeRouterStandaloneMm.c\r
+\r
+[Packages]\r
+  MdePkg/MdePkg.dec\r
+  MdeModulePkg/MdeModulePkg.dec\r
+\r
+[LibraryClasses]\r
+  MmServicesTableLib\r
+  StandaloneMmDriverEntryPoint\r
+  DebugLib\r
+  BaseLib\r
+  SynchronizationLib\r
+  MemoryAllocationLib\r
+\r
+[Protocols]\r
+  gEfiMmRscHandlerProtocolGuid               ## PRODUCES\r
+  gEfiMmStatusCodeProtocolGuid               ## PRODUCES\r
+\r
+[Depex]\r
+  TRUE\r
diff --git a/MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterTraditional.c b/MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterTraditional.c
new file mode 100644 (file)
index 0000000..360a0ee
--- /dev/null
@@ -0,0 +1,33 @@
+/** @file\r
+  Report Status Code Router Driver which produces MM Report Stataus Code Handler Protocol\r
+  and MM Status Code Protocol.\r
+\r
+  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) Microsoft Corporation.\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
+\r
+**/\r
+\r
+#include "ReportStatusCodeRouterCommon.h"\r
+\r
+/**\r
+  Entry point of Generic Status Code Driver.\r
+\r
+  This function is the entry point of SMM Status Code Router .\r
+  It produces SMM Report Stataus Code Handler and Status Code protocol.\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
+GenericStatusCodeTraditionalEntry (\r
+  IN EFI_HANDLE         ImageHandle,\r
+  IN EFI_SYSTEM_TABLE   *SystemTable\r
+  )\r
+{\r
+  return GenericStatusCodeCommonEntry ();\r
+}\r