2 This file declares SMM Control abstraction protocol.
3 This protocol is used initiate SMI/PMI activations. This protocol could be published by either of
5 - A processor driver to abstract the SMI/PMI IPI
6 - The driver that abstracts the ASIC that is supporting the APM port, such as the ICH in an
8 Because of the possibility of performing SMI or PMI IPI transactions, the ability to generate this
9 event from a platform chipset agent is an optional capability for both IA-32 and Itanium based
12 Copyright (c) 2007, Intel Corporation
13 All rights reserved. This program and the accompanying materials
14 are licensed and made available under the terms and conditions of the BSD License
15 which accompanies this distribution. The full text of the license may be found at
16 http://opensource.org/licenses/bsd-license.php
18 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
19 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
21 Module Name: SmmControl.h
23 @par Revision Reference:
24 This Protocol is defined in Framework of EFI SMM Core Interface Spec
29 #ifndef _SMM_CONTROL_H_
30 #define _SMM_CONTROL_H_
34 typedef struct _EFI_SMM_CONTROL_PROTOCOL EFI_SMM_CONTROL_PROTOCOL
;
36 #define EFI_SMM_CONTROL_PROTOCOL_GUID \
38 0x8d12e231, 0xc667, 0x4fd1, {0x98, 0xf2, 0x24, 0x49, 0xa7, 0xe7, 0xb2, 0xe5 } \
41 // SMM Access specification Data Structures
44 UINT8 SmiTriggerRegister
;
45 UINT8 SmiDataRegister
;
46 } EFI_SMM_CONTROL_REGISTER
;
49 // SMM Control specification member function
52 Invokes SMI activation from either the preboot or runtime environment.
54 @param This The EFI_SMM_CONTROL_PROTOCOL instance.
55 @param ArgumentBuffer Optional sized data to pass into the protocol activation.
56 @param ArgumentBufferSize Optional size of the data.
57 @param Periodic Optional mechanism to engender a periodic stream.
58 @param ActivationInterval Optional parameter to repeat at this period one
59 time or, if the Periodic Boolean is set, periodically.
61 @retval EFI_SUCCESS The SMI/PMI has been engendered.
62 @retval EFI_DEVICE_ERROR The timing is unsupported.
63 @retval EFI_INVALID_PARAMETER The activation period is unsupported.
64 @retval EFI_NOT_STARTED The SMM base service has not been initialized.
69 (EFIAPI
*EFI_SMM_ACTIVATE
)(
70 IN EFI_SMM_CONTROL_PROTOCOL
*This
,
71 IN OUT INT8
*ArgumentBuffer OPTIONAL
,
72 IN OUT UINTN
*ArgumentBufferSize OPTIONAL
,
73 IN BOOLEAN Periodic OPTIONAL
,
74 IN UINTN ActivationInterval OPTIONAL
78 Clears any system state that was created in response to the Active call.
80 @param This The EFI_SMM_CONTROL_PROTOCOL instance.
81 @param Periodic Optional parameter to repeat at this period one
82 time or, if the Periodic Boolean is set, periodically.
84 @retval EFI_SUCCESS The SMI/PMI has been engendered.
85 @retval EFI_DEVICE_ERROR The source could not be cleared.
86 @retval EFI_INVALID_PARAMETER The service did not support the Periodic input argument.
91 (EFIAPI
*EFI_SMM_DEACTIVATE
)(
92 IN EFI_SMM_CONTROL_PROTOCOL
*This
,
93 IN BOOLEAN Periodic OPTIONAL
97 Provides information on the source register used to generate the SMI.
99 @param This The EFI_SMM_CONTROL_PROTOCOL instance.
100 @param SmiRegister Pointer to the SMI register description structure
102 @retval EFI_SUCCESS The register structure has been returned.
107 (EFIAPI
*EFI_SMM_GET_REGISTER_INFO
)(
108 IN EFI_SMM_CONTROL_PROTOCOL
*This
,
109 IN OUT EFI_SMM_CONTROL_REGISTER
*SmiRegister
113 @par Protocol Description:
114 This protocol is used initiate SMI/PMI activations.
117 Initiates the SMI/PMI activation.
120 Quiesces the SMI/PMI activation.
122 @param GetRegisterInfo
123 Provides data on the register used as the source of the SMI.
125 @param MinimumTriggerPeriod
126 Minimum interval at which the platform can set the period.
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
;
137 extern EFI_GUID gEfiSmmControlProtocolGuid
;