MdeModulePkg/Include/Ppi/SmmControl.h File Reference


Data Structures

struct  _PEI_SMM_CONTROL_PPI

Defines

#define PEI_SMM_CONTROL_PPI_GUID   { 0x61c68702, 0x4d7e, 0x4f43, 0x8d, 0xef, 0xa7, 0x43, 0x5, 0xce, 0x74, 0xc5 }

Typedefs

typedef struct _PEI_SMM_CONTROL_PPI PEI_SMM_CONTROL_PPI
typedef IN PEI_SMM_CONTROL_PPIThis
typedef IN PEI_SMM_CONTROL_PPI
IN OUT INT8 * 
ArgumentBuffer
typedef IN PEI_SMM_CONTROL_PPI
IN OUT INT8 IN OUT UINTN * 
ArgumentBufferSize
typedef IN PEI_SMM_CONTROL_PPI
IN OUT INT8 IN OUT UINTN IN
BOOLEAN 
Periodic
typedef IN PEI_SMM_CONTROL_PPI
IN OUT INT8 IN OUT UINTN IN
BOOLEAN IN UINTN 
ActivationInterval

Functions

typedef EFI_STATUS (EFIAPI *PEI_SMM_ACTIVATE)(IN EFI_PEI_SERVICES **PeiServices

Variables

EFI_GUID gPeiSmmControlPpiGuid

Detailed Description

EFI SMM Control PPI definition.

This PPI is used to initiate SMI/PMI activations. This protocol could be published by either:

Copyright (c) 2010, 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.


Define Documentation

#define PEI_SMM_CONTROL_PPI_GUID   { 0x61c68702, 0x4d7e, 0x4f43, 0x8d, 0xef, 0xa7, 0x43, 0x5, 0xce, 0x74, 0xc5 }


Typedef Documentation

typedef IN PEI_SMM_CONTROL_PPI IN OUT INT8 IN OUT UINTN IN BOOLEAN IN UINTN ActivationInterval

typedef IN PEI_SMM_CONTROL_PPI IN OUT INT8* ArgumentBuffer

typedef IN PEI_SMM_CONTROL_PPI IN OUT INT8 IN OUT UINTN* ArgumentBufferSize

typedef IN PEI_SMM_CONTROL_PPI IN BOOLEAN Periodic


Function Documentation

typedef EFI_STATUS ( EFIAPI *  PEI_SMM_DEACTIVATE  ) 

Invokes SMI activation from either the preboot or runtime environment.

Parameters:
PeiServices General purpose services available to every PEIM.
This The PEI_SMM_CONTROL_PPI instance.
ArgumentBuffer The optional sized data to pass into the protocol activation.
ArgumentBufferSize The optional size of the data.
Periodic An optional mechanism to periodically repeat activation.
ActivationInterval An optional parameter to repeat at this period one time or, if the Periodic Boolean is set, periodically.
Return values:
EFI_SUCCESS The SMI/PMI has been engendered.
EFI_DEVICE_ERROR The timing is unsupported.
EFI_INVALID_PARAMETER The activation period is unsupported.
EFI_NOT_STARTED The SMM base service has not been initialized.
Clears any system state that was created in response to the Active call.

Parameters:
PeiServices General purpose services available to every PEIM.
This The PEI_SMM_CONTROL_PPI instance.
Periodic Optional parameter to repeat at this period one time or, if the Periodic Boolean is set, periodically.
Return values:
EFI_SUCCESS The SMI/PMI has been engendered.
EFI_DEVICE_ERROR The source could not be cleared.
EFI_INVALID_PARAMETER The service did not support the Periodic input argument.


Variable Documentation


Generated on Thu Sep 24 23:30:15 2015 for MdeModulePkg[ALL] by  doxygen 1.5.7.1