UefiCpuPkg PiSmmCommunicationSmm: Deprecate SMM Communication ACPI Table

Follow UEFI 2.7 spec to deprecate SMM Communication ACPI Table,
PiSmmCommunicationSmm will not install SMM Communication ACPI Table
anymore.

Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Jeff Fan <jeff.fan@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Jiewen Yao <jiewen.yao@intel.com>

4 files changed, 13 insertions, 94 deletions

diff --git a/UefiCpuPkg/PiSmmCommunication/PiSmmCommunicationSmm.c b/UefiCpuPkg/PiSmmCommunication/PiSmmCommunicationSmm.c
index 077eacc..2b395f3 100644
--- a/UefiCpuPkg/PiSmmCommunication/PiSmmCommunicationSmm.c
+++ b/UefiCpuPkg/PiSmmCommunication/PiSmmCommunicationSmm.c
@@ -1,7 +1,7 @@
 /** @file

 PiSmmCommunication SMM Driver.

 

-Copyright (c) 2010 - 2015, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -19,16 +19,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Library/SmmServicesTableLib.h>

 #include <Library/BaseLib.h>

 #include <Library/BaseMemoryLib.h>

-#include <Library/HobLib.h>

 #include <Library/DebugLib.h>

 #include <Library/SmmMemLib.h>

-#include <Library/PcdLib.h>

 #include <Protocol/SmmSwDispatch2.h>

-#include <Protocol/SmmReadyToLock.h>

 #include <Protocol/SmmCommunication.h>

-#include <Protocol/AcpiTable.h>

 #include <Ppi/SmmCommunication.h>

-#include <Guid/Acpi.h>

 

 #include "PiSmmCommunicationPrivate.h"

 

@@ -36,26 +31,6 @@ EFI_SMM_COMMUNICATION_CONTEXT  mSmmCommunicationContext = {
   SMM_COMMUNICATION_SIGNATURE

 };

 

-EFI_SMM_COMMUNICATION_ACPI_TABLE  mSmmCommunicationAcpiTable = {

-  {

-    {

-      EFI_ACPI_4_0_UEFI_ACPI_DATA_TABLE_SIGNATURE,

-      sizeof (EFI_SMM_COMMUNICATION_ACPI_TABLE),

-      0x1,   // Revision

-      0x0,   // Checksum

-      {0x0}, // OemId[6]

-      0x0,   // OemTableId

-      0x0,   // OemRevision

-      0x0,   // CreatorId

-      0x0    // CreatorRevision

-    },

-    {0x0},                                                      // Identifier

-    OFFSET_OF (EFI_SMM_COMMUNICATION_ACPI_TABLE, SwSmiNumber)   // DataOffset

-  },

-  0x0,                                                   // SwSmiNumber

-  0x0                                                    // BufferPtrAddress

-};

-

 /**

   Set SMM communication context.

 **/

@@ -200,22 +175,8 @@ PiSmmCommunicationSmmEntryPoint (
   EFI_SMM_SW_DISPATCH2_PROTOCOL *SmmSwDispatch2;

   EFI_SMM_SW_REGISTER_CONTEXT   SmmSwDispatchContext;

   EFI_HANDLE                    DispatchHandle;

-  EFI_ACPI_TABLE_PROTOCOL       *AcpiTableProtocol;

-  UINTN                         TableKey;

-  UINT64                        OemTableId;

   EFI_PHYSICAL_ADDRESS          *BufferPtrAddress;

 

-  CopyMem (

-    mSmmCommunicationAcpiTable.UefiAcpiDataTable.Header.OemId,

-    PcdGetPtr (PcdAcpiDefaultOemId),

-    sizeof (mSmmCommunicationAcpiTable.UefiAcpiDataTable.Header.OemId)

-    );

-  OemTableId = PcdGet64 (PcdAcpiDefaultOemTableId);

-  CopyMem (&mSmmCommunicationAcpiTable.UefiAcpiDataTable.Header.OemTableId, &OemTableId, sizeof (UINT64));

-  mSmmCommunicationAcpiTable.UefiAcpiDataTable.Header.OemRevision      = PcdGet32 (PcdAcpiDefaultOemRevision);

-  mSmmCommunicationAcpiTable.UefiAcpiDataTable.Header.CreatorId        = PcdGet32 (PcdAcpiDefaultCreatorId);

-  mSmmCommunicationAcpiTable.UefiAcpiDataTable.Header.CreatorRevision  = PcdGet32 (PcdAcpiDefaultCreatorRevision);

-

   //

   // Register software SMI handler

   //

@@ -237,32 +198,15 @@ PiSmmCommunicationSmmEntryPoint (
 

   DEBUG ((EFI_D_INFO, "SmmCommunication SwSmi: %x\n", (UINTN)SmmSwDispatchContext.SwSmiInputValue));

 

-  //

-  // Set ACPI table

-  //

-  Status = gBS->LocateProtocol (&gEfiAcpiTableProtocolGuid, NULL, (VOID **) &AcpiTableProtocol);

-  ASSERT_EFI_ERROR (Status);

-

-  mSmmCommunicationAcpiTable.SwSmiNumber = (UINT32)SmmSwDispatchContext.SwSmiInputValue;

   BufferPtrAddress = AllocateAcpiNvsMemoryBelow4G (sizeof(EFI_PHYSICAL_ADDRESS));

   ASSERT (BufferPtrAddress != NULL);

   DEBUG ((EFI_D_INFO, "SmmCommunication BufferPtrAddress: 0x%016lx, BufferPtr: 0x%016lx\n", (EFI_PHYSICAL_ADDRESS)(UINTN)BufferPtrAddress, *BufferPtrAddress));

-  mSmmCommunicationAcpiTable.BufferPtrAddress = (EFI_PHYSICAL_ADDRESS)(UINTN)BufferPtrAddress;

-  CopyMem (&mSmmCommunicationAcpiTable.UefiAcpiDataTable.Identifier, &gEfiSmmCommunicationProtocolGuid, sizeof(gEfiSmmCommunicationProtocolGuid));

-

-  Status = AcpiTableProtocol->InstallAcpiTable (

-                                AcpiTableProtocol,

-                                &mSmmCommunicationAcpiTable,

-                                sizeof(mSmmCommunicationAcpiTable),

-                                &TableKey

-                                );

-  ASSERT_EFI_ERROR (Status);

 

   //

   // Save context

   //

   mSmmCommunicationContext.SwSmiNumber = (UINT32)SmmSwDispatchContext.SwSmiInputValue;

-  mSmmCommunicationContext.BufferPtrAddress = mSmmCommunicationAcpiTable.BufferPtrAddress;

+  mSmmCommunicationContext.BufferPtrAddress = (EFI_PHYSICAL_ADDRESS)(UINTN)BufferPtrAddress;

   SetCommunicationContext ();

 

   return Status;

diff --git a/UefiCpuPkg/PiSmmCommunication/PiSmmCommunicationSmm.inf b/UefiCpuPkg/PiSmmCommunication/PiSmmCommunicationSmm.inf
index 9b03837..67799e9 100644
--- a/UefiCpuPkg/PiSmmCommunication/PiSmmCommunicationSmm.inf
+++ b/UefiCpuPkg/PiSmmCommunication/PiSmmCommunicationSmm.inf
@@ -1,12 +1,8 @@
 ## @file

-# PI SMM Communication SMM driver that installs the SMM Communication ACPI Table.

+# PI SMM Communication SMM driver that saves SMM communication context

+# for use by SMM Communication PEIM in the S3 boot mode.

 #

-# This SMM driver installs the SMM Communication ACPI Table defined in the UEFI spec

-# which provides a mechanism that can be used in the OS present environment by

-# non-firmware agents for inter-mode communication with SMM agents. It also saves

-# SMM communication context for use by SMM Communication PEIM in the S3 boot mode.

-#

-# Copyright (c) 2010 - 2015, Intel Corporation. All rights reserved.<BR>

+# Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR>

 #

 # This program and the accompanying materials

 # are licensed and made available under the terms and conditions of the BSD License

@@ -49,34 +45,17 @@
   SmmServicesTableLib

   BaseLib

   BaseMemoryLib

-  HobLib

   DebugLib

   SmmMemLib

-  PcdLib

-

-[Guids]

-  gEfiAcpi20TableGuid                ## SOMETIMES_CONSUMES  ## SystemTable

-  gEfiAcpi10TableGuid                ## SOMETIMES_CONSUMES  ## SystemTable

-  gEfiAcpiTableGuid                  ## SOMETIMES_CONSUMES  ## SystemTable

 

 [Ppis]

   gEfiPeiSmmCommunicationPpiGuid     ## UNDEFINED # SMM Configuration Table

 

 [Protocols]

   gEfiSmmSwDispatch2ProtocolGuid     ## CONSUMES

-  gEfiSmmCommunicationProtocolGuid   ## UNDEFINED # SMM Communication ACPI Table GUID

-  gEfiAcpiTableProtocolGuid          ## CONSUMES

-

-[Pcd]

-  gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemId             ## CONSUMES

-  gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemTableId        ## CONSUMES

-  gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemRevision       ## CONSUMES

-  gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultCreatorId         ## CONSUMES

-  gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultCreatorRevision   ## CONSUMES

 

 [Depex]

-  gEfiSmmSwDispatch2ProtocolGuid AND

-  gEfiAcpiTableProtocolGuid

+  gEfiSmmSwDispatch2ProtocolGuid

 

 [UserExtensions.TianoCore."ExtraFiles"]

   PiSmmCommunicationSmmExtra.uni

diff --git a/UefiCpuPkg/PiSmmCommunication/PiSmmCommunicationSmm.uni b/UefiCpuPkg/PiSmmCommunication/PiSmmCommunicationSmm.uni
index 55df390..9995b4e 100644
--- a/UefiCpuPkg/PiSmmCommunication/PiSmmCommunicationSmm.uni
+++ b/UefiCpuPkg/PiSmmCommunication/PiSmmCommunicationSmm.uni
@@ -1,12 +1,8 @@
 // /** @file

-// PI SMM Communication SMM driver that installs the SMM Communication ACPI Table.

+// PI SMM Communication SMM driver that saves SMM communication context

+// for use by SMM Communication PEIM in the S3 boot mode.

 //

-// This SMM driver installs the SMM Communication ACPI Table defined in the UEFI spec

-// which provides a mechanism that can be used in the OS present environment by

-// non-firmware agents for inter-mode communication with SMM agents. It also saves

-// SMM communication context for use by SMM Communication PEIM in the S3 boot mode.

-//

-// Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR>

+// Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR>

 //

 // This program and the accompanying materials

 // are licensed and made available under the terms and conditions of the BSD License

@@ -18,6 +14,6 @@
 //

 // **/

 

-#string STR_MODULE_ABSTRACT             #language en-US "PI SMM Communication SMM driver that installs the SMM Communication ACPI Table"

+#string STR_MODULE_ABSTRACT             #language en-US "PI SMM Communication SMM driver that saves SMM communication context"

 

-#string STR_MODULE_DESCRIPTION          #language en-US "This SMM driver installs the SMM Communication ACPI Table defined in the UEFI Specification, which provides a mechanism that can be used in the OS-present environment by non-firmware agents for inter-mode communication with SMM agents. It also saves an SMM communication context for use by SMM Communication PEIM in the S3 boot mode."

+#string STR_MODULE_DESCRIPTION          #language en-US "PI SMM Communication SMM driver that saves SMM communication context for use by SMM Communication PEIM in the S3 boot mode."

diff --git a/UefiCpuPkg/PiSmmCommunication/PiSmmCommunicationSmmExtra.uni b/UefiCpuPkg/PiSmmCommunication/PiSmmCommunicationSmmExtra.uni
index 34e7731..bb7ce62 100644
--- a/UefiCpuPkg/PiSmmCommunication/PiSmmCommunicationSmmExtra.uni
+++ b/UefiCpuPkg/PiSmmCommunication/PiSmmCommunicationSmmExtra.uni
@@ -1,7 +1,7 @@
 // /** @file

 // PiSmmCommunicationSmm Localized Strings and Content

 //

-// Copyright (c) 2013 - 2014, Intel Corporation. All rights reserved.<BR>

+// Copyright (c) 2013 - 2017, Intel Corporation. All rights reserved.<BR>

 //

 // This program and the accompanying materials

 // are licensed and made available under the terms and conditions of the BSD License

@@ -15,4 +15,4 @@
 

 #string STR_PROPERTIES_MODULE_NAME

 #language en-US

-"SMM Communication ACPI Table DXE Driver"

+"SMM Communication SMM Driver"