IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h File Reference


Data Structures

struct  EFI_SMM_STANDBY_BUTTON_DISPATCH_CONTEXT
struct  _EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL

Defines

#define EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL_GUID

Typedefs

typedef struct
_EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL 
EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL
typedef VOID(EFIAPI * EFI_SMM_STANDBY_BUTTON_DISPATCH )(IN EFI_HANDLE DispatchHandle, IN EFI_SMM_STANDBY_BUTTON_DISPATCH_CONTEXT *DispatchContext)
typedef EFI_STATUS(EFIAPI * EFI_SMM_STANDBY_BUTTON_REGISTER )(IN EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL *This, IN EFI_SMM_STANDBY_BUTTON_DISPATCH DispatchFunction, IN EFI_SMM_STANDBY_BUTTON_DISPATCH_CONTEXT *DispatchContext, OUT EFI_HANDLE *DispatchHandle)
typedef EFI_STATUS(EFIAPI * EFI_SMM_STANDBY_BUTTON_UNREGISTER )(IN EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL *This, IN EFI_HANDLE DispatchHandle)

Variables

EFI_GUID gEfiSmmStandbyButtonDispatchProtocolGuid

Detailed Description

Provides the parent dispatch service for the standby button SMI source generator.

The SMM Standby Button Dispatch Protocol is defined in the Intel Platform Innovation Framework for EFI SMM Core Interface Specification (SMM CIS) Version 0.9.

Copyright (c) 2007 - 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 that 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.

Revision Reference:
This Protocol is defined in Framework of EFI SMM Core Interface Spec Version 0.9.

Define Documentation

#define EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL_GUID

Value:

{ \
    0x78965b98, 0xb0bf, 0x449e, {0x8b, 0x22, 0xd2, 0x91, 0x4e, 0x49, 0x8a, 0x98 } \
  }


Typedef Documentation

typedef VOID(EFIAPI * EFI_SMM_STANDBY_BUTTON_DISPATCH)(IN EFI_HANDLE DispatchHandle, IN EFI_SMM_STANDBY_BUTTON_DISPATCH_CONTEXT *DispatchContext)

Dispatch function for a Standby Button SMI handler.

Parameters:
DispatchHandle The handle of this dispatch function.
DispatchContext The pointer to the dispatch function's context. The DispatchContext fields are filled in by the dispatching driver prior to invoking this dispatch function.

typedef EFI_STATUS(EFIAPI * EFI_SMM_STANDBY_BUTTON_REGISTER)(IN EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL *This, IN EFI_SMM_STANDBY_BUTTON_DISPATCH DispatchFunction, IN EFI_SMM_STANDBY_BUTTON_DISPATCH_CONTEXT *DispatchContext, OUT EFI_HANDLE *DispatchHandle)

Provides the parent dispatch service for a given SMI source generator

Parameters:
This The pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL instance.
DispatchFunction The function to install.
DispatchContext The pointer to the dispatch function's context. Indicates to the register function the Standby Button SMI phase for which to invoke the dispatch function.
DispatchHandle The handle generated by the dispatcher to track the function instance.
Return values:
EFI_SUCCESS The dispatch function has been successfully registered, and the SMI source has been enabled.
EFI_DEVICE_ERROR The driver could not enable the SMI source.
EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this child.
EFI_INVALID_PARAMETER DispatchContext is invalid. The Standby Button SMI phase is not within valid range.

typedef EFI_STATUS(EFIAPI * EFI_SMM_STANDBY_BUTTON_UNREGISTER)(IN EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL *This, IN EFI_HANDLE DispatchHandle)

Unregister a child SMI source dispatch function with a parent SMM driver.

Parameters:
This The pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL instance.
DispatchHandle The handle of the service to remove.
Return values:
EFI_SUCCESS The dispatch function has been successfully unregistered, and the SMI source has been disabled, if there are no other registered child dispatch functions for this SMI source.
EFI_INVALID_PARAMETER The handle is invalid.


Variable Documentation


Generated on Wed Sep 2 13:08:33 2015 for IntelFrameworkPkg[ALL] by  doxygen 1.5.7.1