412fb9ef2d
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8709 6f19259b-4bc3-4df7-8a09-765794883524
183 lines
6.7 KiB
C
183 lines
6.7 KiB
C
/** @file
|
||
This file declares SMM Control abstraction protocol.
|
||
This protocol is used initiate SMI/PMI activations. This protocol could be published by either of
|
||
the following:
|
||
- A processor driver to abstract the SMI/PMI IPI
|
||
- The driver that abstracts the ASIC that is supporting the APM port, such as the ICH in an
|
||
Intel chipset
|
||
Because of the possibility of performing SMI or PMI IPI transactions, the ability to generate this
|
||
event from a platform chipset agent is an optional capability for both IA-32 and Itanium based
|
||
systems.
|
||
|
||
Copyright (c) 2007,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.
|
||
|
||
Module Name: SmmControl.h
|
||
|
||
@par Revision Reference:
|
||
This Protocol is defined in Framework of EFI SMM Core Interface Spec
|
||
Version 0.9.
|
||
|
||
**/
|
||
|
||
#ifndef _SMM_CONTROL_H_
|
||
#define _SMM_CONTROL_H_
|
||
|
||
#include <PiDxe.h>
|
||
|
||
typedef struct _EFI_SMM_CONTROL_PROTOCOL EFI_SMM_CONTROL_PROTOCOL;
|
||
|
||
#define EFI_SMM_CONTROL_PROTOCOL_GUID \
|
||
{ \
|
||
0x8d12e231, 0xc667, 0x4fd1, {0x98, 0xf2, 0x24, 0x49, 0xa7, 0xe7, 0xb2, 0xe5 } \
|
||
}
|
||
//
|
||
// SMM Access specification Data Structures
|
||
//
|
||
typedef struct {
|
||
///
|
||
/// Describes the I/O location of the particular port that engendered the synchronous
|
||
/// SMI. For example, this location can include but is not limited to the traditional
|
||
/// PCAT* APM port of 0B2h.
|
||
///
|
||
UINT8 SmiTriggerRegister;
|
||
///
|
||
/// Describes the value that was written to the respective activation port.
|
||
///
|
||
UINT8 SmiDataRegister;
|
||
} EFI_SMM_CONTROL_REGISTER;
|
||
|
||
//
|
||
// SMM Control specification member function
|
||
//
|
||
/**
|
||
Invokes SMI activation from either the preboot or runtime environment.
|
||
|
||
@param This The EFI_SMM_CONTROL_PROTOCOL instance.
|
||
@param ArgumentBuffer Optional sized data to pass into the protocol activation.
|
||
@param ArgumentBufferSize Optional size of the data.
|
||
@param Periodic Optional mechanism to engender a periodic stream.
|
||
@param 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 EFI_SMM_CONTROL_PROTOCOL *This,
|
||
IN OUT INT8 *ArgumentBuffer OPTIONAL,
|
||
IN OUT UINTN *ArgumentBufferSize OPTIONAL,
|
||
IN BOOLEAN Periodic OPTIONAL,
|
||
IN UINTN ActivationInterval OPTIONAL
|
||
);
|
||
|
||
/**
|
||
Clears any system state that was created in response to the Active call.
|
||
|
||
@param This The EFI_SMM_CONTROL_PROTOCOL instance.
|
||
@param Periodic 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 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 EFI_SMM_CONTROL_PROTOCOL *This,
|
||
IN BOOLEAN Periodic OPTIONAL
|
||
);
|
||
|
||
/**
|
||
Provides information on the source register used to generate the SMI.
|
||
|
||
@param This The EFI_SMM_CONTROL_PROTOCOL instance.
|
||
@param SmiRegister Pointer to the SMI register description structure
|
||
|
||
@retval EFI_SUCCESS The register structure has been returned.
|
||
@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_GET_REGISTER_INFO)(
|
||
IN EFI_SMM_CONTROL_PROTOCOL *This,
|
||
IN OUT EFI_SMM_CONTROL_REGISTER *SmiRegister
|
||
);
|
||
|
||
/**
|
||
@par Protocol Description:
|
||
This protocol is used initiate SMI/PMI activations.
|
||
|
||
@param Trigger
|
||
Initiates the SMI/PMI activation.
|
||
|
||
@param Clear
|
||
Quiesces the SMI/PMI activation.
|
||
|
||
@param GetRegisterInfo
|
||
Provides data on the register used as the source of the SMI.
|
||
|
||
@param MinimumTriggerPeriod
|
||
Minimum interval at which the platform can set the period.
|
||
|
||
@retval EFI_SUCCESS The register structure has been returned.
|
||
**/
|
||
|
||
//
|
||
// SMM Control Protocol
|
||
//
|
||
/**
|
||
This protocol is used initiate SMI/PMI activations.
|
||
This protocol could be published by either of the following:
|
||
- A processor driver to abstract the SMI/PMI IPI
|
||
- The driver that abstracts the ASIC that is supporting the APM port, such as the ICH in an Intel<65> chipset
|
||
Because of the possibility of performing SMI or PMI IPI transactions, the ability to generate this
|
||
|
||
The EFI_SMM_CONTROL_PROTOCOL is used by the platform chipset or processor driver. This
|
||
protocol is useable both in boot services and runtime. The runtime aspect is so that an
|
||
implementation of EFI_SMM_BASE_PROTOCOL.Communicate() can layer upon this service
|
||
and provide an SMI callback from a general EFI runtime driver.
|
||
The purpose of this protocol is to provide an abstraction to the platform hardware that generates an
|
||
SMI or PMI. There are often I/O ports that, when accessed, will engender the
|
||
**/
|
||
struct _EFI_SMM_CONTROL_PROTOCOL {
|
||
///
|
||
/// Initiates the SMI/PMI activation.
|
||
///
|
||
EFI_SMM_ACTIVATE Trigger;
|
||
///
|
||
/// Quiesces the SMI/PMI activation.
|
||
///
|
||
EFI_SMM_DEACTIVATE Clear;
|
||
///
|
||
/// Provides data on the register used as the source of the SMI.
|
||
///
|
||
EFI_SMM_GET_REGISTER_INFO GetRegisterInfo;
|
||
///
|
||
/// 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.
|
||
///
|
||
UINTN MinimumTriggerPeriod;
|
||
};
|
||
|
||
extern EFI_GUID gEfiSmmControlProtocolGuid;
|
||
|
||
#endif
|