MdeModulePkg/VariableSmmRuntimeDxe: switch to new MM communicate protocolstandalone-mm-va-vs-pa

Switch to the new MM communicate protocol, which can be backed by either
traditional MM or standalone MM, without any awareness of the distinction
on the part of the caller.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

3 files changed, 41 insertions, 39 deletions

diff --git a/MdeModulePkg/Include/Guid/SmmVariableCommon.h b/MdeModulePkg/Include/Guid/SmmVariableCommon.h
index 734eb19681..044844d467 100644
--- a/MdeModulePkg/Include/Guid/SmmVariableCommon.h
+++ b/MdeModulePkg/Include/Guid/SmmVariableCommon.h
@@ -74,12 +74,12 @@ typedef struct {
 #define SMM_VARIABLE_FUNCTION_GET_PAYLOAD_SIZE        11

 

 ///

-/// Size of SMM communicate header, without including the payload.

+/// Size of MM communicate header, without including the payload.

 ///

-#define SMM_COMMUNICATE_HEADER_SIZE  (OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data))

+#define MM_COMMUNICATE_HEADER_SIZE  (OFFSET_OF (EFI_MM_COMMUNICATE_HEADER, Data))

 

 ///

-/// Size of SMM variable communicate header, without including the payload.

+/// Size of MM variable communicate header, without including the payload.

 ///

 #define SMM_VARIABLE_COMMUNICATE_HEADER_SIZE  (OFFSET_OF (SMM_VARIABLE_COMMUNICATE_HEADER, Data))

 

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDxe.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDxe.c
index 85d655dc19..7851afaf80 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDxe.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDxe.c
@@ -26,7 +26,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <PiDxe.h>

 #include <Protocol/VariableWrite.h>

 #include <Protocol/Variable.h>

-#include <Protocol/SmmCommunication.h>

+#include <Protocol/MmCommunication.h>

 #include <Protocol/SmmVariable.h>

 #include <Protocol/VariableLock.h>

 #include <Protocol/VarCheck.h>

@@ -49,7 +49,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 EFI_HANDLE                       mHandle                    = NULL;

 EFI_SMM_VARIABLE_PROTOCOL       *mSmmVariable               = NULL;

 EFI_EVENT                        mVirtualAddressChangeEvent = NULL;

-EFI_SMM_COMMUNICATION_PROTOCOL  *mSmmCommunication          = NULL;

+EFI_MM_COMMUNICATION_PROTOCOL   *mMmCommunication           = NULL;

 UINT8                           *mVariableBuffer            = NULL;

 UINT8                           *mVariableBufferPhysical    = NULL;

 UINTN                            mVariableBufferSize;

@@ -116,7 +116,7 @@ ReleaseLockOnlyAtBootTime (
 /**

   Initialize the communicate buffer using DataSize and Function.

 

-  The communicate size is: SMM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE +

+  The communicate size is: MM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE +

   DataSize.

 

   Caution: This function may receive untrusted input.

@@ -137,19 +137,20 @@ InitCommunicateBuffer (
   IN      UINTN                             Function

   )

 {

-  EFI_SMM_COMMUNICATE_HEADER                *SmmCommunicateHeader;

+  EFI_MM_COMMUNICATE_HEADER                 *MmCommunicateHeader;

   SMM_VARIABLE_COMMUNICATE_HEADER           *SmmVariableFunctionHeader;

 

 

-  if (DataSize + SMM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE > mVariableBufferSize) {

+  if (DataSize + MM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE > mVariableBufferSize) {

     return EFI_INVALID_PARAMETER;

   }

 

-  SmmCommunicateHeader = (EFI_SMM_COMMUNICATE_HEADER *) mVariableBuffer;

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

-  SmmCommunicateHeader->MessageLength = DataSize + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;

+  MmCommunicateHeader = (EFI_MM_COMMUNICATE_HEADER *)mVariableBuffer;

+  MmCommunicateHeader->PhysicalAddress = (EFI_PHYSICAL_ADDRESS)(UINTN)mVariableBufferPhysical;

+  CopyGuid (&MmCommunicateHeader->HeaderGuid, &gEfiSmmVariableProtocolGuid);

+  MmCommunicateHeader->MessageLength = DataSize + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;

 

-  SmmVariableFunctionHeader = (SMM_VARIABLE_COMMUNICATE_HEADER *) SmmCommunicateHeader->Data;

+  SmmVariableFunctionHeader = (SMM_VARIABLE_COMMUNICATE_HEADER *) MmCommunicateHeader->Data;

   SmmVariableFunctionHeader->Function = Function;

   if (DataPtr != NULL) {

     *DataPtr = SmmVariableFunctionHeader->Data;

@@ -175,15 +176,15 @@ SendCommunicateBuffer (
 {

   EFI_STATUS                                Status;

   UINTN                                     CommSize;

-  EFI_SMM_COMMUNICATE_HEADER                *SmmCommunicateHeader;

+  EFI_MM_COMMUNICATE_HEADER                 *MmCommunicateHeader;

   SMM_VARIABLE_COMMUNICATE_HEADER           *SmmVariableFunctionHeader;

 

-  CommSize = DataSize + SMM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;

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

+  CommSize = DataSize + MM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;

+  Status = mMmCommunication->Communicate (mMmCommunication, mVariableBuffer, &CommSize);

   ASSERT_EFI_ERROR (Status);

 

-  SmmCommunicateHeader      = (EFI_SMM_COMMUNICATE_HEADER *) mVariableBuffer;

-  SmmVariableFunctionHeader = (SMM_VARIABLE_COMMUNICATE_HEADER *)SmmCommunicateHeader->Data;

+  MmCommunicateHeader       = (EFI_MM_COMMUNICATE_HEADER *)mVariableBuffer;

+  SmmVariableFunctionHeader = (SMM_VARIABLE_COMMUNICATE_HEADER *)MmCommunicateHeader->Data;

   return  SmmVariableFunctionHeader->ReturnStatus;

 }

 

@@ -233,7 +234,7 @@ VariableLockRequestToLock (
 

   //

   // Init the communicate buffer. The buffer data size is:

-  // SMM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + PayloadSize.

+  // MM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + PayloadSize.

   //

   PayloadSize = OFFSET_OF (SMM_VARIABLE_COMMUNICATE_LOCK_VARIABLE, Name) + VariableNameSize;

   Status = InitCommunicateBuffer ((VOID **) &VariableToLock, PayloadSize, SMM_VARIABLE_FUNCTION_LOCK_VARIABLE);

@@ -333,7 +334,7 @@ VarCheckVariablePropertySet (
 

   //

   // Init the communicate buffer. The buffer data size is:

-  // SMM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + PayloadSize.

+  // MM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + PayloadSize.

   //

   PayloadSize = OFFSET_OF (SMM_VARIABLE_COMMUNICATE_VAR_CHECK_VARIABLE_PROPERTY, Name) + VariableNameSize;

   Status = InitCommunicateBuffer ((VOID **) &CommVariableProperty, PayloadSize, SMM_VARIABLE_FUNCTION_VAR_CHECK_VARIABLE_PROPERTY_SET);

@@ -404,7 +405,7 @@ VarCheckVariablePropertyGet (
 

   //

   // Init the communicate buffer. The buffer data size is:

-  // SMM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + PayloadSize.

+  // MM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + PayloadSize.

   //

   PayloadSize = OFFSET_OF (SMM_VARIABLE_COMMUNICATE_VAR_CHECK_VARIABLE_PROPERTY, Name) + VariableNameSize;

   Status = InitCommunicateBuffer ((VOID **) &CommVariableProperty, PayloadSize, SMM_VARIABLE_FUNCTION_VAR_CHECK_VARIABLE_PROPERTY_GET);

@@ -484,7 +485,7 @@ RuntimeServiceGetVariable (
 

   //

   // Init the communicate buffer. The buffer data size is:

-  // SMM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + PayloadSize.

+  // MM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + PayloadSize.

   //

   if (TempDataSize > mVariableBufferPayloadSize - OFFSET_OF (SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE, Name) - VariableNameSize) {

     //

@@ -591,7 +592,7 @@ RuntimeServiceGetNextVariableName (
 

   //

   // Init the communicate buffer. The buffer data size is:

-  // SMM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + PayloadSize.

+  // MM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + PayloadSize.

   //

   if (OutVariableNameSize > mVariableBufferPayloadSize - OFFSET_OF (SMM_VARIABLE_COMMUNICATE_GET_NEXT_VARIABLE_NAME, Name)) {

     //

@@ -712,7 +713,7 @@ RuntimeServiceSetVariable (
 

   //

   // Init the communicate buffer. The buffer data size is:

-  // SMM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + PayloadSize.

+  // MM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + PayloadSize.

   //

   PayloadSize = OFFSET_OF (SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE, Name) + VariableNameSize + DataSize;

   Status = InitCommunicateBuffer ((VOID **)&SmmVariableHeader, PayloadSize, SMM_VARIABLE_FUNCTION_SET_VARIABLE);

@@ -788,7 +789,7 @@ RuntimeServiceQueryVariableInfo (
 

   //

   // Init the communicate buffer. The buffer data size is:

-  // SMM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + PayloadSize;

+  // MM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + PayloadSize;

   //

   PayloadSize = sizeof (SMM_VARIABLE_COMMUNICATE_QUERY_VARIABLE_INFO);

   Status = InitCommunicateBuffer ((VOID **)&SmmQueryVariableInfo, PayloadSize, SMM_VARIABLE_FUNCTION_QUERY_VARIABLE_INFO);

@@ -838,7 +839,7 @@ OnExitBootServices (
 {

   //

   // Init the communicate buffer. The buffer data size is:

-  // SMM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE.

+  // MM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE.

   //

   InitCommunicateBuffer (NULL, 0, SMM_VARIABLE_FUNCTION_EXIT_BOOT_SERVICE);

 

@@ -867,7 +868,7 @@ OnReadyToBoot (
 {

   //

   // Init the communicate buffer. The buffer data size is:

-  // SMM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE.

+  // MM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE.

   //

   InitCommunicateBuffer (NULL, 0, SMM_VARIABLE_FUNCTION_READY_TO_BOOT);

 

@@ -898,7 +899,7 @@ VariableAddressChangeEvent (
   )

 {

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

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

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

 }

 

 /**

@@ -918,7 +919,7 @@ GetVariablePayloadSize (
 {

   EFI_STATUS                                Status;

   SMM_VARIABLE_COMMUNICATE_GET_PAYLOAD_SIZE *SmmGetPayloadSize;

-  EFI_SMM_COMMUNICATE_HEADER                *SmmCommunicateHeader;

+  EFI_MM_COMMUNICATE_HEADER                 *MmCommunicateHeader;

   SMM_VARIABLE_COMMUNICATE_HEADER           *SmmVariableFunctionHeader;

   UINTN                                     CommSize;

   UINT8                                     *CommBuffer;

@@ -934,27 +935,28 @@ GetVariablePayloadSize (
 

   //

   // Init the communicate buffer. The buffer data size is:

-  // SMM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + sizeof (SMM_VARIABLE_COMMUNICATE_GET_PAYLOAD_SIZE);

+  // MM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + sizeof (SMM_VARIABLE_COMMUNICATE_GET_PAYLOAD_SIZE);

   //

-  CommSize = SMM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + sizeof (SMM_VARIABLE_COMMUNICATE_GET_PAYLOAD_SIZE);

+  CommSize = MM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + sizeof (SMM_VARIABLE_COMMUNICATE_GET_PAYLOAD_SIZE);

   CommBuffer = AllocateZeroPool (CommSize);

   if (CommBuffer == NULL) {

     Status = EFI_OUT_OF_RESOURCES;

     goto Done;

   }

 

-  SmmCommunicateHeader = (EFI_SMM_COMMUNICATE_HEADER *) CommBuffer;

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

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

+  MmCommunicateHeader = (EFI_MM_COMMUNICATE_HEADER *)CommBuffer;

+  MmCommunicateHeader->PhysicalAddress = (EFI_PHYSICAL_ADDRESS)(UINTN)CommBuffer;

+  CopyGuid (&MmCommunicateHeader->HeaderGuid, &gEfiSmmVariableProtocolGuid);

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

 

-  SmmVariableFunctionHeader = (SMM_VARIABLE_COMMUNICATE_HEADER *) SmmCommunicateHeader->Data;

+  SmmVariableFunctionHeader = (SMM_VARIABLE_COMMUNICATE_HEADER *) MmCommunicateHeader->Data;

   SmmVariableFunctionHeader->Function = SMM_VARIABLE_FUNCTION_GET_PAYLOAD_SIZE;

   SmmGetPayloadSize = (SMM_VARIABLE_COMMUNICATE_GET_PAYLOAD_SIZE *) SmmVariableFunctionHeader->Data;

 

   //

   // Send data to SMM.

   //

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

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

   ASSERT_EFI_ERROR (Status);

 

   Status = SmmVariableFunctionHeader->ReturnStatus;

@@ -996,7 +998,7 @@ SmmVariableReady (
     return;

   }

 

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

+  Status = gBS->LocateProtocol (&gEfiMmCommunicationProtocolGuid, NULL, (VOID **)&mMmCommunication);

   ASSERT_EFI_ERROR (Status);

 

   //

@@ -1004,7 +1006,7 @@ SmmVariableReady (
   //

   Status = GetVariablePayloadSize (&mVariableBufferPayloadSize);

   ASSERT_EFI_ERROR (Status);

-  mVariableBufferSize  = SMM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + mVariableBufferPayloadSize;

+  mVariableBufferSize  = MM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + mVariableBufferPayloadSize;

   mVariableBuffer      = AllocateRuntimePool (mVariableBufferSize);

   ASSERT (mVariableBuffer != NULL);

 

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDxe.inf b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDxe.inf
index bd73f7ac29..72c1073098 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDxe.inf
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDxe.inf
@@ -62,7 +62,7 @@
 [Protocols]

   gEfiVariableWriteArchProtocolGuid             ## PRODUCES

   gEfiVariableArchProtocolGuid                  ## PRODUCES

-  gEfiSmmCommunicationProtocolGuid              ## CONSUMES

+  gEfiMmCommunicationProtocolGuid               ## CONSUMES

   ## CONSUMES

   ## NOTIFY

   ## UNDEFINED # Used to do smm communication

@@ -88,7 +88,7 @@
   gEfiImageSecurityDatabaseGuid

 

 [Depex]

-  gEfiSmmCommunicationProtocolGuid

+  gEfiMmCommunicationProtocolGuid

 

 [UserExtensions.TianoCore."ExtraFiles"]

   VariableSmmRuntimeDxeExtra.uni