Tools/Source/TianoTools/Include/Protocol/SmmControl.h

   1 /** @file
   2   This file declares SMM Control abstraction protocol.
   3
   4   Copyright (c) 2006, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13   Module Name:  SmmControl.h
  14
  15   @par Revision Reference:
  16   This Protocol is defined in Framework of EFI SMM Core Interface Spec
  17   Version 0.9.
  18
  19 **/
  20
  21 #ifndef _SMM_CONTROL_H_
  22 #define _SMM_CONTROL_H_
  23
  24 typedef struct _EFI_SMM_CONTROL_PROTOCOL              EFI_SMM_CONTROL_PROTOCOL;
  25
  26 #define EFI_SMM_CONTROL_PROTOCOL_GUID \
  27   { \
  28     0x8d12e231, 0xc667, 0x4fd1, {0x98, 0xf2, 0x24, 0x49, 0xa7, 0xe7, 0xb2, 0xe5 } \
  29   }
  30
  31 // SMM Access specification Data Structures
  32 //
  33 typedef struct {
  34   UINT8 SmiTriggerRegister;
  35   UINT8 SmiDataRegister;
  36 } EFI_SMM_CONTROL_REGISTER;
  37
  38 //
  39 // SMM Control specification member function
  40 //
  41 /**
  42   Invokes SMI activation from either the preboot or runtime environment.
  43
  44   @param  This The EFI_SMM_CONTROL_PROTOCOL instance.
  45
  46   @param  ArgumentBuffer Optional sized data to pass into the protocol activation.
  47
  48   @param  ArgumentBufferSize Optional size of the data.
  49
  50   @param  Periodic Optional mechanism to engender a periodic stream.
  51
  52   @param  ActivationInterval Optional parameter to repeat at this period one
  53   time or, if the Periodic Boolean is set, periodically.
  54
  55   @retval EFI_SUCCESS  The SMI/PMI has been engendered.
  56
  57   @retval EFI_DEVICE_ERROR  The timing is unsupported.
  58
  59   @retval EFI_INVALID_PARAMETER  The activation period is unsupported.
  60
  61   @retval EFI_NOT_STARTED  The SMM base service has not been initialized.
  62
  63 **/
  64 typedef
  65 EFI_STATUS
  66 (EFIAPI *EFI_SMM_ACTIVATE) (
  67   IN EFI_SMM_CONTROL_PROTOCOL                             *This,
  68   IN OUT INT8                                             *ArgumentBuffer OPTIONAL,
  69   IN OUT UINTN                                            *ArgumentBufferSize OPTIONAL,
  70   IN BOOLEAN                                              Periodic OPTIONAL,
  71   IN UINTN                                                ActivationInterval OPTIONAL
  72   );
  73
  74 /**
  75   Clears any system state that was created in response to the Active call.
  76
  77   @param  This The EFI_SMM_CONTROL_PROTOCOL instance.
  78
  79   @param  Periodic Optional parameter to repeat at this period one time
  80
  81   @retval EFI_SUCCESS  The SMI/PMI has been engendered.
  82
  83   @retval EFI_DEVICE_ERROR  The source could not be cleared.
  84
  85   @retval EFI_INVALID_PARAMETER  The service did not support the Periodic input argument.
  86
  87 **/
  88 typedef
  89 EFI_STATUS
  90 (EFIAPI *EFI_SMM_DEACTIVATE) (
  91   IN EFI_SMM_CONTROL_PROTOCOL                   *This,
  92   IN BOOLEAN                                    Periodic OPTIONAL
  93   );
  94
  95 /**
  96   Provides information on the source register used to generate the SMI.
  97
  98   @param  This The EFI_SMM_CONTROL_PROTOCOL instance.
  99
 100   @param  SmiRegister Pointer to the SMI register description structure
 101
 102   @retval EFI_SUCCESS  The register structure has been returned.
 103
 104 **/
 105 typedef
 106 EFI_STATUS
 107 (EFIAPI *EFI_SMM_GET_REGISTER_INFO) (
 108   IN EFI_SMM_CONTROL_PROTOCOL           *This,
 109   IN OUT EFI_SMM_CONTROL_REGISTER       *SmiRegister
 110   );
 111
 112 /**
 113   @par Protocol Description:
 114   This protocol is used initiate SMI/PMI activations.
 115
 116   @param Trigger
 117   Initiates the SMI/PMI activation.
 118
 119   @param Clear
 120   Quiesces the SMI/PMI activation.
 121
 122   @param GetRegisterInfo
 123   Provides data on the register used as the source of the SMI.
 124
 125   @param MinimumTriggerPeriod
 126   Minimum interval at which the platform can set the period.
 127
 128 **/
 129
 130 struct _EFI_SMM_CONTROL_PROTOCOL {
 131   EFI_SMM_ACTIVATE          Trigger;
 132   EFI_SMM_DEACTIVATE        Clear;
 133   EFI_SMM_GET_REGISTER_INFO GetRegisterInfo;
 134   UINTN                     MinimumTriggerPeriod;
 135 };
 136
 137 extern EFI_GUID gEfiSmmControlProtocolGuid;
 138
 139 #endif