MdePkg/Include/Ppi/MmControl.h

   1 /** @file
   2   EFI MM Control PPI definition.
   3
   4   This PPI is used initiate synchronous MMI activations. This PPI could be published by a processor
   5   driver to abstract the MMI IPI or a driver which abstracts the ASIC that is supporting the APM port.
   6   Because of the possibility of performing MMI IPI transactions, the ability to generate this event
   7   from a platform chipset agent is an optional capability for both IA-32 and x64-based systems.
   8
   9   Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
  10   SPDX-License-Identifier: BSD-2-Clause-Patent
  11
  12   @par Revision Reference:
  13   This PPI is introduced in PI Version 1.5.
  14
  15 **/
  16
  17
  18 #ifndef _MM_CONTROL_PPI_H_
  19 #define _MM_CONTROL_PPI_H_
  20
  21 #define EFI_PEI_MM_CONTROL_PPI_GUID \
  22   { 0x61c68702, 0x4d7e, 0x4f43, 0x8d, 0xef, 0xa7, 0x43, 0x5, 0xce, 0x74, 0xc5 }
  23
  24 typedef struct _EFI_PEI_MM_CONTROL_PPI  EFI_PEI_MM_CONTROL_PPI;
  25
  26 /**
  27   Invokes PPI activation from the PI PEI environment.
  28
  29   @param  PeiServices           An indirect pointer to the PEI Services Table published by the PEI Foundation.
  30   @param  This                  The PEI_MM_CONTROL_PPI instance.
  31   @param  ArgumentBuffer        The value passed to the MMI handler. This value corresponds to the
  32                                 SwMmiInputValue in the RegisterContext parameter for the Register()
  33                                 function in the EFI_MM_SW_DISPATCH_PROTOCOL and in the Context parameter
  34                                 in the call to the DispatchFunction
  35   @param  ArgumentBufferSize    The size of the data passed in ArgumentBuffer or NULL if ArgumentBuffer is NULL.
  36   @param  Periodic              An optional mechanism to periodically repeat activation.
  37   @param  ActivationInterval    An optional parameter to repeat at this period one
  38                                 time or, if the Periodic Boolean is set, periodically.
  39
  40   @retval EFI_SUCCESS           The MMI has been engendered.
  41   @retval EFI_DEVICE_ERROR      The timing is unsupported.
  42   @retval EFI_INVALID_PARAMETER The activation period is unsupported.
  43   @retval EFI_NOT_STARTED       The MM base service has not been initialized.
  44
  45 **/
  46 typedef
  47 EFI_STATUS
  48 (EFIAPI *EFI_PEI_MM_ACTIVATE) (
  49   IN EFI_PEI_SERVICES                                **PeiServices,
  50   IN EFI_PEI_MM_CONTROL_PPI                          * This,
  51   IN OUT INT8                                        *ArgumentBuffer OPTIONAL,
  52   IN OUT UINTN                                       *ArgumentBufferSize OPTIONAL,
  53   IN BOOLEAN                                         Periodic OPTIONAL,
  54   IN UINTN                                           ActivationInterval OPTIONAL
  55   );
  56
  57 /**
  58   Clears any system state that was created in response to the Trigger() call.
  59
  60   @param  PeiServices           General purpose services available to every PEIM.
  61   @param  This                  The PEI_MM_CONTROL_PPI instance.
  62   @param  Periodic              Optional parameter to repeat at this period one
  63                                 time or, if the Periodic Boolean is set, periodically.
  64
  65   @retval EFI_SUCCESS           The MMI has been engendered.
  66   @retval EFI_DEVICE_ERROR      The source could not be cleared.
  67   @retval EFI_INVALID_PARAMETER The service did not support the Periodic input argument.
  68
  69 **/
  70 typedef
  71 EFI_STATUS
  72 (EFIAPI *EFI_PEI_MM_DEACTIVATE) (
  73   IN EFI_PEI_SERVICES                      **PeiServices,
  74   IN EFI_PEI_MM_CONTROL_PPI                * This,
  75   IN BOOLEAN                               Periodic OPTIONAL
  76   );
  77
  78 ///
  79 ///  The EFI_PEI_MM_CONTROL_PPI is produced by a PEIM. It provides an abstraction of the
  80 ///  platform hardware that generates an MMI. There are often I/O ports that, when accessed, will
  81 ///  generate the MMI. Also, the hardware optionally supports the periodic generation of these signals.
  82 ///
  83 struct _EFI_PEI_MM_CONTROL_PPI {
  84   EFI_PEI_MM_ACTIVATE    Trigger;
  85   EFI_PEI_MM_DEACTIVATE  Clear;
  86 };
  87
  88 extern EFI_GUID gEfiPeiMmControlPpiGuid;
  89
  90 #endif