MdePkg/Include/Protocol/SmmPowerButtonDispatch2.h File Reference


Data Structures

struct  EFI_SMM_POWER_BUTTON_REGISTER_CONTEXT
struct  _EFI_SMM_POWER_BUTTON_DISPATCH2_PROTOCOL

Defines

#define EFI_SMM_POWER_BUTTON_DISPATCH2_PROTOCOL_GUID

Typedefs

typedef struct
_EFI_SMM_POWER_BUTTON_DISPATCH2_PROTOCOL 
EFI_SMM_POWER_BUTTON_DISPATCH2_PROTOCOL
typedef EFI_STATUS(EFIAPI * EFI_SMM_POWER_BUTTON_REGISTER2 )(IN CONST EFI_SMM_POWER_BUTTON_DISPATCH2_PROTOCOL *This, IN EFI_SMM_HANDLER_ENTRY_POINT2 DispatchFunction, IN EFI_SMM_POWER_BUTTON_REGISTER_CONTEXT *RegisterContext, OUT EFI_HANDLE *DispatchHandle)
typedef EFI_STATUS(EFIAPI * EFI_SMM_POWER_BUTTON_UNREGISTER2 )(IN CONST EFI_SMM_POWER_BUTTON_DISPATCH2_PROTOCOL *This, IN EFI_HANDLE DispatchHandle)

Enumerations

enum  EFI_POWER_BUTTON_PHASE { EfiPowerButtonEntry, EfiPowerButtonExit, EfiPowerButtonMax }

Variables

EFI_GUID gEfiSmmPowerButtonDispatch2ProtocolGuid

Detailed Description

SMM Power Button Dispatch2 Protocol as defined in PI 1.1 Specification Volume 4 System Management Mode Core Interface.

This protocol provides the parent dispatch service for the power button SMI source generator.

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

Revision Reference:
This protocol is from PI Version 1.1.

Define Documentation

#define EFI_SMM_POWER_BUTTON_DISPATCH2_PROTOCOL_GUID

Value:

{ \
    0x1b1183fa, 0x1823, 0x46a7, {0x88, 0x72, 0x9c, 0x57, 0x87, 0x55, 0x40, 0x9d } \
  }


Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_SMM_POWER_BUTTON_REGISTER2)(IN CONST EFI_SMM_POWER_BUTTON_DISPATCH2_PROTOCOL *This, IN EFI_SMM_HANDLER_ENTRY_POINT2 DispatchFunction, IN EFI_SMM_POWER_BUTTON_REGISTER_CONTEXT *RegisterContext, OUT EFI_HANDLE *DispatchHandle)

Provides the parent dispatch service for a power button event.

This service registers a function (DispatchFunction) which will be called when an SMI is generated because the power button was pressed or released, as specified by RegisterContext. On return, DispatchHandle contains a unique handle which may be used later to unregister the function using UnRegister(). The DispatchFunction will be called with Context set to the same value as was passed into this function in RegisterContext and with CommBuffer and CommBufferSize set to NULL.

Parameters:
[in] This Pointer to the EFI_SMM_POWER_BUTTON_DISPATCH2_PROTOCOL instance.
[in] DispatchFunction Function to register for handler when power button is pressed or released.
[in] RegisterContext Pointer to the dispatch function's context. The caller fills in this context before calling the Register() function to indicate to the Register() function the power button SMI phase for which the dispatch function should be invoked.
[out] DispatchHandle 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 was unable to enable the SMI source.
EFI_INVALID_PARAMETER RegisterContext is invalid. The power button input value is not within valid range.
EFI_OUT_OF_RESOURCES There is not enough memory (system or SMM) to manage this child.

typedef EFI_STATUS(EFIAPI * EFI_SMM_POWER_BUTTON_UNREGISTER2)(IN CONST EFI_SMM_POWER_BUTTON_DISPATCH2_PROTOCOL *This, IN EFI_HANDLE DispatchHandle)

Unregisters a power-button service.

This service removes the handler associated with DispatchHandle so that it will no longer be called when the standby button is pressed or released.

Parameters:
[in] This Pointer to the EFI_SMM_POWER_BUTTON_DISPATCH2_PROTOCOL instance.
[in] DispatchHandle Handle of the service to remove.
Return values:
EFI_SUCCESS The service has been successfully removed.
EFI_INVALID_PARAMETER The DispatchHandle was not valid.


Enumeration Type Documentation

Power Button phases.

Enumerator:
EfiPowerButtonEntry 
EfiPowerButtonExit 
EfiPowerButtonMax 


Variable Documentation


Generated on Wed Sep 23 16:24:24 2015 for MdePkg[ALL] by  doxygen 1.5.7.1