MdeModulePkg/VariableSmmRuntimeDxe: switch to MM communicate 2

Switch to the new MM communicate 2 protocol which supports both
traditional and standalone MM.

Signed-off-by: Ard Biesheuvel <ard.biesheuvel@arm.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>

2 files changed, 23 insertions, 20 deletions

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDxe.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDxe.c
index ca833fb024..663a1aaa12 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDxe.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDxe.c
@@ -21,7 +21,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 #include <PiDxe.h>

 #include <Protocol/VariableWrite.h>

 #include <Protocol/Variable.h>

-#include <Protocol/SmmCommunication.h>

+#include <Protocol/MmCommunication2.h>

 #include <Protocol/SmmVariable.h>

 #include <Protocol/VariableLock.h>

 #include <Protocol/VarCheck.h>

@@ -45,7 +45,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 EFI_HANDLE                       mHandle                    = NULL;

 EFI_SMM_VARIABLE_PROTOCOL       *mSmmVariable               = NULL;

 EFI_EVENT                        mVirtualAddressChangeEvent = NULL;

-EFI_SMM_COMMUNICATION_PROTOCOL  *mSmmCommunication          = NULL;

+EFI_MM_COMMUNICATION2_PROTOCOL  *mMmCommunication2          = NULL;

 UINT8                           *mVariableBuffer            = NULL;

 UINT8                           *mVariableBufferPhysical    = NULL;

 VARIABLE_INFO_ENTRY             *mVariableInfo              = NULL;

@@ -210,7 +210,7 @@ InitCommunicateBuffer (
   IN      UINTN                             Function

   )

 {

-  EFI_SMM_COMMUNICATE_HEADER                *SmmCommunicateHeader;

+  EFI_MM_COMMUNICATE_HEADER                 *SmmCommunicateHeader;

   SMM_VARIABLE_COMMUNICATE_HEADER           *SmmVariableFunctionHeader;

 

 

@@ -218,7 +218,7 @@ InitCommunicateBuffer (
     return EFI_INVALID_PARAMETER;

   }

 

-  SmmCommunicateHeader = (EFI_SMM_COMMUNICATE_HEADER *) mVariableBuffer;

+  SmmCommunicateHeader = (EFI_MM_COMMUNICATE_HEADER *) mVariableBuffer;

   CopyGuid (&SmmCommunicateHeader->HeaderGuid, &gEfiSmmVariableProtocolGuid);

   SmmCommunicateHeader->MessageLength = DataSize + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;

 

@@ -248,14 +248,17 @@ SendCommunicateBuffer (
 {

   EFI_STATUS                                Status;

   UINTN                                     CommSize;

-  EFI_SMM_COMMUNICATE_HEADER                *SmmCommunicateHeader;

+  EFI_MM_COMMUNICATE_HEADER                 *SmmCommunicateHeader;

   SMM_VARIABLE_COMMUNICATE_HEADER           *SmmVariableFunctionHeader;

 

   CommSize = DataSize + SMM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;

-  Status = mSmmCommunication->Communicate (mSmmCommunication, mVariableBufferPhysical, &CommSize);

+  Status = mMmCommunication2->Communicate (mMmCommunication2,

+                                           mVariableBufferPhysical,

+                                           mVariableBuffer,

+                                           &CommSize);

   ASSERT_EFI_ERROR (Status);

 

-  SmmCommunicateHeader      = (EFI_SMM_COMMUNICATE_HEADER *) mVariableBuffer;

+  SmmCommunicateHeader      = (EFI_MM_COMMUNICATE_HEADER *) mVariableBuffer;

   SmmVariableFunctionHeader = (SMM_VARIABLE_COMMUNICATE_HEADER *)SmmCommunicateHeader->Data;

   return  SmmVariableFunctionHeader->ReturnStatus;

 }

@@ -1309,7 +1312,7 @@ VariableAddressChangeEvent (
   )

 {

   EfiConvertPointer (0x0, (VOID **) &mVariableBuffer);

-  EfiConvertPointer (0x0, (VOID **) &mSmmCommunication);

+  EfiConvertPointer (0x0, (VOID **) &mMmCommunication2);

   EfiConvertPointer (EFI_OPTIONAL_PTR, (VOID **) &mVariableRuntimeHobCacheBuffer);

   EfiConvertPointer (EFI_OPTIONAL_PTR, (VOID **) &mVariableRuntimeNvCacheBuffer);

   EfiConvertPointer (EFI_OPTIONAL_PTR, (VOID **) &mVariableRuntimeVolatileCacheBuffer);

@@ -1332,7 +1335,7 @@ GetVariablePayloadSize (
 {

   EFI_STATUS                                Status;

   SMM_VARIABLE_COMMUNICATE_GET_PAYLOAD_SIZE *SmmGetPayloadSize;

-  EFI_SMM_COMMUNICATE_HEADER                *SmmCommunicateHeader;

+  EFI_MM_COMMUNICATE_HEADER                 *SmmCommunicateHeader;

   SMM_VARIABLE_COMMUNICATE_HEADER           *SmmVariableFunctionHeader;

   UINTN                                     CommSize;

   UINT8                                     *CommBuffer;

@@ -1357,7 +1360,7 @@ GetVariablePayloadSize (
     goto Done;

   }

 

-  SmmCommunicateHeader = (EFI_SMM_COMMUNICATE_HEADER *) CommBuffer;

+  SmmCommunicateHeader = (EFI_MM_COMMUNICATE_HEADER *) CommBuffer;

   CopyGuid (&SmmCommunicateHeader->HeaderGuid, &gEfiSmmVariableProtocolGuid);

   SmmCommunicateHeader->MessageLength = SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + sizeof (SMM_VARIABLE_COMMUNICATE_GET_PAYLOAD_SIZE);

 

@@ -1368,7 +1371,7 @@ GetVariablePayloadSize (
   //

   // Send data to SMM.

   //

-  Status = mSmmCommunication->Communicate (mSmmCommunication, CommBuffer, &CommSize);

+  Status = mMmCommunication2->Communicate (mMmCommunication2, CommBuffer, CommBuffer, &CommSize);

   ASSERT_EFI_ERROR (Status);

 

   Status = SmmVariableFunctionHeader->ReturnStatus;

@@ -1413,7 +1416,7 @@ GetRuntimeCacheInfo (
 {

   EFI_STATUS                                          Status;

   SMM_VARIABLE_COMMUNICATE_GET_RUNTIME_CACHE_INFO     *SmmGetRuntimeCacheInfo;

-  EFI_SMM_COMMUNICATE_HEADER                          *SmmCommunicateHeader;

+  EFI_MM_COMMUNICATE_HEADER                           *SmmCommunicateHeader;

   SMM_VARIABLE_COMMUNICATE_HEADER                     *SmmVariableFunctionHeader;

   UINTN                                               CommSize;

   UINT8                                               *CommBuffer;

@@ -1434,7 +1437,7 @@ GetRuntimeCacheInfo (
   CommSize = SMM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + sizeof (SMM_VARIABLE_COMMUNICATE_GET_RUNTIME_CACHE_INFO);

   ZeroMem (CommBuffer, CommSize);

 

-  SmmCommunicateHeader = (EFI_SMM_COMMUNICATE_HEADER *) CommBuffer;

+  SmmCommunicateHeader = (EFI_MM_COMMUNICATE_HEADER *) CommBuffer;

   CopyGuid (&SmmCommunicateHeader->HeaderGuid, &gEfiSmmVariableProtocolGuid);

   SmmCommunicateHeader->MessageLength = SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + sizeof (SMM_VARIABLE_COMMUNICATE_GET_RUNTIME_CACHE_INFO);

 

@@ -1445,7 +1448,7 @@ GetRuntimeCacheInfo (
   //

   // Send data to SMM.

   //

-  Status = mSmmCommunication->Communicate (mSmmCommunication, CommBuffer, &CommSize);

+  Status = mMmCommunication2->Communicate (mMmCommunication2, CommBuffer, CommBuffer, &CommSize);

   ASSERT_EFI_ERROR (Status);

   if (CommSize <= SMM_VARIABLE_COMMUNICATE_HEADER_SIZE) {

     Status = EFI_BAD_BUFFER_SIZE;

@@ -1486,7 +1489,7 @@ SendRuntimeVariableCacheContextToSmm (
 {

   EFI_STATUS                                                Status;

   SMM_VARIABLE_COMMUNICATE_RUNTIME_VARIABLE_CACHE_CONTEXT   *SmmRuntimeVarCacheContext;

-  EFI_SMM_COMMUNICATE_HEADER                                *SmmCommunicateHeader;

+  EFI_MM_COMMUNICATE_HEADER                                 *SmmCommunicateHeader;

   SMM_VARIABLE_COMMUNICATE_HEADER                           *SmmVariableFunctionHeader;

   UINTN                                                     CommSize;

   UINT8                                                     *CommBuffer;

@@ -1507,7 +1510,7 @@ SendRuntimeVariableCacheContextToSmm (
   CommSize = SMM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + sizeof (SMM_VARIABLE_COMMUNICATE_RUNTIME_VARIABLE_CACHE_CONTEXT);

   ZeroMem (CommBuffer, CommSize);

 

-  SmmCommunicateHeader = (EFI_SMM_COMMUNICATE_HEADER *) CommBuffer;

+  SmmCommunicateHeader = (EFI_MM_COMMUNICATE_HEADER *) CommBuffer;

   CopyGuid (&SmmCommunicateHeader->HeaderGuid, &gEfiSmmVariableProtocolGuid);

   SmmCommunicateHeader->MessageLength = SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + sizeof (SMM_VARIABLE_COMMUNICATE_RUNTIME_VARIABLE_CACHE_CONTEXT);

 

@@ -1525,7 +1528,7 @@ SendRuntimeVariableCacheContextToSmm (
   //

   // Send data to SMM.

   //

-  Status = mSmmCommunication->Communicate (mSmmCommunication, CommBuffer, &CommSize);

+  Status = mMmCommunication2->Communicate (mMmCommunication2, CommBuffer, CommBuffer, &CommSize);

   ASSERT_EFI_ERROR (Status);

   if (CommSize <= SMM_VARIABLE_COMMUNICATE_HEADER_SIZE) {

     Status = EFI_BAD_BUFFER_SIZE;

@@ -1563,7 +1566,7 @@ SmmVariableReady (
     return;

   }

 

-  Status = gBS->LocateProtocol (&gEfiSmmCommunicationProtocolGuid, NULL, (VOID **) &mSmmCommunication);

+  Status = gBS->LocateProtocol (&gEfiMmCommunication2ProtocolGuid, NULL, (VOID **) &mMmCommunication2);

   ASSERT_EFI_ERROR (Status);

 

   //

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDxe.inf b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDxe.inf
index 5928627733..01564e4c50 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDxe.inf
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDxe.inf
@@ -60,7 +60,7 @@
 [Protocols]

   gEfiVariableWriteArchProtocolGuid             ## PRODUCES

   gEfiVariableArchProtocolGuid                  ## PRODUCES

-  gEfiSmmCommunicationProtocolGuid              ## CONSUMES

+  gEfiMmCommunication2ProtocolGuid              ## CONSUMES

   ## CONSUMES

   ## NOTIFY

   ## UNDEFINED # Used to do smm communication

@@ -100,7 +100,7 @@
   gEfiImageSecurityDatabaseGuid

 

 [Depex]

-  gEfiSmmCommunicationProtocolGuid

+  gEfiMmCommunication2ProtocolGuid

 

 [UserExtensions.TianoCore."ExtraFiles"]

   VariableSmmRuntimeDxeExtra.uni