Add into MdePkg definitions for the EFI SMM Control2 Protocol as defined in the PI 1.2 specification.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9214 6f19259b-4bc3-4df7-8a09-765794883524

2 files changed, 108 insertions, 0 deletions

diff --git a/MdePkg/Include/Protocol/SmmControl2.h b/MdePkg/Include/Protocol/SmmControl2.h
new file mode 100644
index 0000000000..59eccdf6c3
--- /dev/null
+++ b/MdePkg/Include/Protocol/SmmControl2.h
@@ -0,0 +1,105 @@
+/** @file

+  EFI SMM Control2 Protocol as defined in the PI 1.2 specification.

+

+  This protocol is used initiate synchronous SMI activations. This protocol could be published by a

+  processor driver to abstract the SMI IPI or a driver which abstracts the ASIC that is supporting the

+  APM port. Because of the possibility of performing SMI IPI transactions, the ability to generate this 

+  event from a platform chipset agent is an optional capability for both IA-32 and x64-based systems.

+

+  The EFI_SMM_CONTROL2_PROTOCOL is produced by a runtime driver. It provides  an 

+  abstraction of the platform hardware that generates an SMI.  There are often I/O ports that, when 

+  accessed, will generate the SMI.  Also, the hardware optionally supports the periodic generation of 

+  these signals.

+

+  Copyright (c) 2009, Intel Corporation                                                         

+  All rights reserved. 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        

+  http://opensource.org/licenses/bsd-license.php                                            

+

+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

+

+**/

+

+#ifndef _SMM_CONTROL2_H_

+#define _SMM_CONTROL2_H_

+

+#include <PiDxe.h>

+

+#define EFI_SMM_CONTROL2_PROTOCOL_GUID \

+  { \

+    0x843dc720, 0xab1e, 0x42cb, {0x93, 0x57, 0x8a, 0x0, 0x78, 0xf3, 0x56, 0x1b}  \

+  }

+

+typedef struct _EFI_SMM_CONTROL2_PROTOCOL  EFI_SMM_CONTROL2_PROTOCOL;

+typedef UINTN  EFI_SMM_PERIOD;

+

+/**

+  Invokes SMI activation from either the preboot or runtime environment.

+

+  This function generates an SMI.

+

+  @param[in]     This                The EFI_SMM_CONTROL2_PROTOCOL instance.

+  @param[in,out] CommandPort         The value written to the command port.

+  @param[in,out] DataPort            The value written to the data port.

+  @param[in]     Periodic            Optional mechanism to engender a periodic stream.

+  @param[in]     ActivationInterval  Optional parameter to repeat at this period one

+                                     time or, if the Periodic Boolean is set, periodically.

+

+  @retval EFI_SUCCESS            The SMI/PMI has been engendered.

+  @retval EFI_DEVICE_ERROR       The timing is unsupported.

+  @retval EFI_INVALID_PARAMETER  The activation period is unsupported.

+  @retval EFI_NOT_STARTED        The SMM base service has not been initialized.

+**/

+typedef

+EFI_STATUS

+(EFIAPI *EFI_SMM_ACTIVATE)(

+  IN CONST EFI_SMM_CONTROL2_PROTOCOL  *This,

+  IN OUT UINT8                        *CommandPort       OPTIONAL,

+  IN OUT UINT8                        *DataPort          OPTIONAL,

+  IN BOOLEAN                          Periodic           OPTIONAL,

+  IN UINTN                            ActivationInterval OPTIONAL

+  );

+

+/**

+  Clears any system state that was created in response to the Trigger() call.

+

+  This function acknowledges and causes the deassertion of the SMI activation source.

+

+  @param[in] This                The EFI_SMM_CONTROL2_PROTOCOL instance.

+  @param[in] Periodic            Optional parameter to repeat at this period one time

+

+  @retval EFI_SUCCESS            The SMI/PMI has been engendered.

+  @retval EFI_DEVICE_ERROR       The source could not be cleared.

+  @retval EFI_INVALID_PARAMETER  The service did not support the Periodic input argument.

+**/

+typedef

+EFI_STATUS

+(EFIAPI *EFI_SMM_DEACTIVATE)(

+  IN CONST EFI_SMM_CONTROL2_PROTOCOL  *This,

+  IN BOOLEAN                          Periodic OPTIONAL

+  );

+

+///

+/// The EFI_SMM_CONTROL2_PROTOCOL is produced by a runtime driver. It provides  an 

+/// abstraction of the platform hardware that generates an SMI.  There are often I/O ports that, when 

+/// accessed, will generate the SMI.  Also, the hardware optionally supports the periodic generation of 

+/// these signals.

+///

+struct _EFI_SMM_CONTROL2_PROTOCOL {

+  EFI_SMM_ACTIVATE    Trigger;

+  EFI_SMM_DEACTIVATE  Clear;

+  ///

+  /// Minimum interval at which the platform can set the period.  A maximum is not 

+  /// specified in that the SMM infrastructure code can emulate a maximum interval that is 

+  /// greater than the hardware capabilities by using software emulation in the SMM 

+  /// infrastructure code.

+  ///

+  EFI_SMM_PERIOD      MinimumTriggerPeriod;

+};

+

+extern EFI_GUID gEfiSmmControl2ProtocolGuid;

+

+#endif

+

diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec
index a5ecb47208..23de15f18d 100644
--- a/MdePkg/MdePkg.dec
+++ b/MdePkg/MdePkg.dec
@@ -584,6 +584,9 @@
   ## Include/Protocol/SmmAccess2.h

   gEfiSmmAccess2ProtocolGuid      = { 0xc2702b74, 0x800c, 0x4131, {0x87, 0x46, 0x8f, 0xb5, 0xb8, 0x9c, 0xe4, 0xac }}

 

+  ## Include/Protocol/SmmControl2.h

+  gEfiSmmControl2ProtocolGuid     = { 0x843dc720, 0xab1e, 0x42cb, {0x93, 0x57, 0x8a, 0x0, 0x78, 0xf3, 0x56, 0x1b}}

+

   #

   # Protocols defined in UEFI2.1/UEFI2.0/EFI1.1

   #