[PATCH v2 05/10] MdePkg: add MmRegisterShutdownInterface()

["Ankur Arora" <ankur.a.arora@oracle.com>]

Add MmRegisterShutdownInterface(), which is used to register a callback,
that gets used to do the final ejection as part of CPU hot-unplug.

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Zhiguang Liu <zhiguang.liu@intel.com>
Cc: Eric Dong <eric.dong@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Cc: Rahul Kumar <rahul1.kumar@intel.com>
Cc: Igor Mammedov <imammedo@redhat.com>
Cc: Boris Ostrovsky <boris.ostrovsky@oracle.com>
Cc: Aaron Young <aaron.young@oracle.com>
Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=3132
Signed-off-by: Ankur Arora <ankur.a.arora@oracle.com>
---

Not sure this is the right way to register a callback to be called
from SmmCpuFeaturesRendezvousExit(). Happy to hear suggestions for
a better way to accomplish this.

---
 MdeModulePkg/Core/PiSmmCore/PiSmmCore.c                |  1 +
 MdePkg/Include/Pi/PiMmCis.h                            | 16 ++++++++++++++++
 MdePkg/Include/Pi/PiSmmCis.h                           |  2 ++
 MdePkg/Library/MmServicesTableLib/MmServicesTableLib.c | 11 +++++++++++
 UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.c             |  1 +
 UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h             |  1 +
 6 files changed, 32 insertions(+)

diff --git a/MdeModulePkg/Core/PiSmmCore/PiSmmCore.c b/MdeModulePkg/Core/PiSmmCore/PiSmmCore.c
index cfa9922cbdb5..9d883bb06633 100644
--- a/MdeModulePkg/Core/PiSmmCore/PiSmmCore.c
+++ b/MdeModulePkg/Core/PiSmmCore/PiSmmCore.c
@@ -39,6 +39,7 @@ EFI_SMM_SYSTEM_TABLE2  gSmmCoreSmst = {
   SmmFreePool,
   SmmAllocatePages,
   SmmFreePages,
+  NULL,                          // SmmShutdownAp
   NULL,                          // SmmStartupThisAp
   0,                             // CurrentlyExecutingCpu
   0,                             // NumberOfCpus
diff --git a/MdePkg/Include/Pi/PiMmCis.h b/MdePkg/Include/Pi/PiMmCis.h
index fdf0591a03d6..237bd8dcba76 100644
--- a/MdePkg/Include/Pi/PiMmCis.h
+++ b/MdePkg/Include/Pi/PiMmCis.h
@@ -77,6 +77,14 @@ EFI_STATUS
   IN OUT VOID          *ProcArguments OPTIONAL
   );
 
+typedef
+EFI_STATUS
+(EFIAPI *EFI_MM_SHUTDOWN_AP)(
+  IN UINTN             CpuNumber,
+  IN BOOLEAN           IsBSP
+  );
+
+
 /**
   Function prototype for protocol install notification.
 
@@ -242,6 +250,13 @@ VOID
   IN CONST EFI_MM_ENTRY_CONTEXT  *MmEntryContext
   );
 
+EFI_STATUS
+EFIAPI
+MmRegisterShutdownInterface (
+  IN EFI_MM_SHUTDOWN_AP    Procedure
+  );
+
+
 ///
 /// Management Mode System Table (MMST)
 ///
@@ -282,6 +297,7 @@ struct _EFI_MM_SYSTEM_TABLE {
   ///
   /// MP service
   ///
+  EFI_MM_SHUTDOWN_AP                   MmShutdownAp;
   EFI_MM_STARTUP_THIS_AP               MmStartupThisAp;
 
   ///
diff --git a/MdePkg/Include/Pi/PiSmmCis.h b/MdePkg/Include/Pi/PiSmmCis.h
index 06ef4aecd7b5..296dc01f6703 100644
--- a/MdePkg/Include/Pi/PiSmmCis.h
+++ b/MdePkg/Include/Pi/PiSmmCis.h
@@ -49,6 +49,7 @@ EFI_STATUS
   IN UINTN                          TableSize
   );
 
+typedef  EFI_MM_SHUTDOWN_AP                    EFI_SMM_SHUTDOWN_AP;
 typedef  EFI_MM_STARTUP_THIS_AP                EFI_SMM_STARTUP_THIS_AP;
 typedef  EFI_MM_NOTIFY_FN                      EFI_SMM_NOTIFY_FN;
 typedef  EFI_MM_REGISTER_PROTOCOL_NOTIFY       EFI_SMM_REGISTER_PROTOCOL_NOTIFY;
@@ -137,6 +138,7 @@ struct _EFI_SMM_SYSTEM_TABLE2 {
   ///
   /// MP service
   ///
+  EFI_SMM_SHUTDOWN_AP                  SmmShutdownAp;
   EFI_SMM_STARTUP_THIS_AP              SmmStartupThisAp;
 
   ///
diff --git a/MdePkg/Library/MmServicesTableLib/MmServicesTableLib.c b/MdePkg/Library/MmServicesTableLib/MmServicesTableLib.c
index 27f9d526e396..c7d81a0dc193 100644
--- a/MdePkg/Library/MmServicesTableLib/MmServicesTableLib.c
+++ b/MdePkg/Library/MmServicesTableLib/MmServicesTableLib.c
@@ -55,3 +55,14 @@ MmServicesTableLibConstructor (
 
   return EFI_SUCCESS;
 }
+
+EFI_STATUS
+EFIAPI
+MmRegisterShutdownInterface (
+  IN      EFI_MM_SHUTDOWN_AP          Procedure
+  )
+{
+  gMmst->MmShutdownAp = Procedure;
+
+  return EFI_SUCCESS;
+}
diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.c b/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.c
index db68e1316ec5..f2f67e85e5e9 100644
--- a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.c
+++ b/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.c
@@ -22,6 +22,7 @@ SMM_CPU_PRIVATE_DATA  mSmmCpuPrivateData = {
   NULL,                                         // Pointer to CpuSaveStateSize array
   NULL,                                         // Pointer to CpuSaveState array
   { {0} },                                      // SmmReservedSmramRegion
+  NULL,                                         // SmmShutdownAp
   {
     SmmStartupThisAp,                           // SmmCoreEntryContext.SmmStartupThisAp
     0,                                          // SmmCoreEntryContext.CurrentlyExecutingCpu
diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h b/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h
index b8aa9e1769d3..7672834a2f70 100644
--- a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h
+++ b/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h
@@ -247,6 +247,7 @@ typedef struct {
   VOID                            **CpuSaveState;
 
   EFI_SMM_RESERVED_SMRAM_REGION   SmmReservedSmramRegion[1];
+  EFI_SMM_SHUTDOWN_AP             SmmShutdownAp;
   EFI_SMM_ENTRY_CONTEXT           SmmCoreEntryContext;
   EFI_SMM_ENTRY_POINT             SmmCoreEntry;
 
-- 
2.9.3