MdePkg/Include/Protocol/SmmControl2.h File Reference


Data Structures

struct  _EFI_SMM_CONTROL2_PROTOCOL

Defines

#define EFI_SMM_CONTROL2_PROTOCOL_GUID

Typedefs

typedef struct
_EFI_SMM_CONTROL2_PROTOCOL 
EFI_SMM_CONTROL2_PROTOCOL
typedef UINTN EFI_SMM_PERIOD
typedef EFI_STATUS(EFIAPIEFI_SMM_ACTIVATE2 )(IN CONST EFI_SMM_CONTROL2_PROTOCOL *This, IN OUT UINT8 *CommandPort, IN OUT UINT8 *DataPort, IN BOOLEAN Periodic, IN UINTN ActivationInterval)
typedef EFI_STATUS(EFIAPIEFI_SMM_DEACTIVATE2 )(IN CONST EFI_SMM_CONTROL2_PROTOCOL *This, IN BOOLEAN Periodic)

Variables

EFI_GUID gEfiSmmControl2ProtocolGuid

Detailed Description

EFI SMM Control2 Protocol as defined in the PI 1.2 specification.

This protocol is used initiate synchronous SMI activations. This protocol could be published by a processor driver to abstract the SMI IPI or a driver which abstracts the ASIC that is supporting the APM port. Because of the possibility of performing SMI IPI transactions, the ability to generate this event from a platform chipset agent is an optional capability for both IA-32 and x64-based systems.

The EFI_SMM_CONTROL2_PROTOCOL is produced by a runtime driver. It provides an abstraction of the platform hardware that generates an SMI. There are often I/O ports that, when accessed, will generate the SMI. Also, the hardware optionally supports the periodic generation of these signals.

Copyright (c) 2009 - 2011, 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 EFI_SMM_CONTROL2_PROTOCOL_GUID

Value:

{ \
    0x843dc720, 0xab1e, 0x42cb, {0x93, 0x57, 0x8a, 0x0, 0x78, 0xf3, 0x56, 0x1b}  \
  }


Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_SMM_ACTIVATE2)(IN CONST EFI_SMM_CONTROL2_PROTOCOL *This, IN OUT UINT8 *CommandPort, IN OUT UINT8 *DataPort, IN BOOLEAN Periodic, IN UINTN ActivationInterval)

Invokes SMI activation from either the preboot or runtime environment.

This function generates an SMI.

Parameters:
[in] This The EFI_SMM_CONTROL2_PROTOCOL instance.
[in,out] CommandPort The value written to the command port.
[in,out] DataPort The value written to the data port.
[in] Periodic Optional mechanism to engender a periodic stream.
[in] ActivationInterval 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_INVALID_PARAMETER The last periodic activation has not been cleared.
EFI_NOT_STARTED The SMM base service has not been initialized.

typedef EFI_STATUS(EFIAPI * EFI_SMM_DEACTIVATE2)(IN CONST EFI_SMM_CONTROL2_PROTOCOL *This, IN BOOLEAN Periodic)

Clears any system state that was created in response to the Trigger() call.

This function acknowledges and causes the deassertion of the SMI activation source.

Parameters:
[in] This The EFI_SMM_CONTROL2_PROTOCOL instance.
[in] Periodic Optional parameter to repeat at this period one time
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.

typedef UINTN EFI_SMM_PERIOD


Variable Documentation


Generated on Thu Sep 24 23:14:20 2015 for MdePkg[ALL] by  doxygen 1.5.7.1