MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Include / Ppi / SmmControl.h

/** @file\r
  EFI SMM Control PPI definition.\r
\r
  This PPI is used to initiate SMI/PMI activations. This protocol could be published by either:\r
  - A processor driver to abstract the SMI/PMI IPI\r
  - The driver that abstracts the ASIC that is supporting the APM port, such as the ICH in an\r
  Intel chipset\r
  Because of the possibility of performing SMI or PMI IPI transactions, the ability to generate this\r
  event from a platform chipset agent is an optional capability for both IA-32 and Itanium-based\r
  systems.\r
\r
  Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
\r
#ifndef _SMM_CONTROL_PPI_H_\r
#define _SMM_CONTROL_PPI_H_\r
\r
#define PEI_SMM_CONTROL_PPI_GUID \\r
  { 0x61c68702, 0x4d7e, 0x4f43, 0x8d, 0xef, 0xa7, 0x43, 0x5, 0xce, 0x74, 0xc5 }\r
\r
typedef struct _PEI_SMM_CONTROL_PPI  PEI_SMM_CONTROL_PPI;\r
\r
/**\r
  Invokes SMI activation from either the preboot or runtime environment.\r
\r
  @param  PeiServices           General purpose services available to every PEIM.\r
  @param  This                  The PEI_SMM_CONTROL_PPI instance.\r
  @param  ArgumentBuffer        The optional sized data to pass into the protocol activation.\r
  @param  ArgumentBufferSize    The optional size of the data.\r
  @param  Periodic              An optional mechanism to periodically repeat activation.\r
  @param  ActivationInterval    An optional parameter to repeat at this period one\r
                                time or, if the Periodic Boolean is set, periodically.\r
\r
  @retval EFI_SUCCESS           The SMI/PMI has been engendered.\r
  @retval EFI_DEVICE_ERROR      The timing is unsupported.\r
  @retval EFI_INVALID_PARAMETER The activation period is unsupported.\r
  @retval EFI_NOT_STARTED       The SMM base service has not been initialized.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *PEI_SMM_ACTIVATE) (\r
  IN EFI_PEI_SERVICES                                **PeiServices,\r
  IN PEI_SMM_CONTROL_PPI                             * This,\r
  IN OUT INT8                                        *ArgumentBuffer OPTIONAL,\r
  IN OUT UINTN                                       *ArgumentBufferSize OPTIONAL,\r
  IN BOOLEAN                                         Periodic OPTIONAL,\r
  IN UINTN                                           ActivationInterval OPTIONAL\r
  );\r
\r
/**\r
  Clears any system state that was created in response to the Active call.\r
\r
  @param  PeiServices           General purpose services available to every PEIM.\r
  @param  This                  The PEI_SMM_CONTROL_PPI instance.\r
  @param  Periodic              Optional parameter to repeat at this period one\r
                                time or, if the Periodic Boolean is set, periodically.\r
\r
  @retval EFI_SUCCESS           The SMI/PMI has been engendered.\r
  @retval EFI_DEVICE_ERROR      The source could not be cleared.\r
  @retval EFI_INVALID_PARAMETER The service did not support the Periodic input argument.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *PEI_SMM_DEACTIVATE) (\r
  IN EFI_PEI_SERVICES                      **PeiServices,\r
  IN PEI_SMM_CONTROL_PPI                   * This,\r
  IN BOOLEAN                               Periodic OPTIONAL\r
  );\r
\r
///\r
///  PEI SMM Control PPI is used to initiate SMI/PMI activations. This protocol could be published by either:\r
///  - A processor driver to abstract the SMI/PMI IPI\r
///  - The driver that abstracts the ASIC that is supporting the APM port, such as the ICH in an\r
///  Intel chipset\r
///\r
struct _PEI_SMM_CONTROL_PPI {\r
  PEI_SMM_ACTIVATE    Trigger;\r
  PEI_SMM_DEACTIVATE  Clear;\r
};\r
\r
extern EFI_GUID gPeiSmmControlPpiGuid;\r
\r
#endif\r