MmPowerButtonDispatch.h File Reference

Data Structures
struct	EFI_MM_POWER_BUTTON_REGISTER_CONTEXT
struct	_EFI_MM_POWER_BUTTON_DISPATCH_PROTOCOL

Macros
#define	EFI_MM_POWER_BUTTON_DISPATCH_PROTOCOL_GUID

Typedefs
typedef struct _EFI_MM_POWER_BUTTON_DISPATCH_PROTOCOL	EFI_MM_POWER_BUTTON_DISPATCH_PROTOCOL
typedef EFI_STATUS(EFIAPI *	EFI_MM_POWER_BUTTON_REGISTER )(IN CONST EFI_MM_POWER_BUTTON_DISPATCH_PROTOCOL *This, IN EFI_MM_HANDLER_ENTRY_POINT DispatchFunction, IN EFI_MM_POWER_BUTTON_REGISTER_CONTEXT *RegisterContext, OUT EFI_HANDLE *DispatchHandle)
typedef EFI_STATUS(EFIAPI *	EFI_MM_POWER_BUTTON_UNREGISTER )(IN CONST EFI_MM_POWER_BUTTON_DISPATCH_PROTOCOL *This, IN EFI_HANDLE DispatchHandle)

Enumerations
enum	EFI_POWER_BUTTON_PHASE { EfiPowerButtonEntry, EfiPowerButtonExit, EfiPowerButtonMax }

Variables
EFI_GUID	gEfiMmPowerButtonDispatchProtocolGuid

Detailed Description

MM Power Button Dispatch Protocol as defined in PI 1.5 Specification Volume 4 Management Mode Core Interface.

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

Copyright (c) 2017, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Revision Reference:

This protocol is from PI Version 1.5.

Macro Definition Documentation

#define EFI_MM_POWER_BUTTON_DISPATCH_PROTOCOL_GUID

Value:

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

Typedef Documentation

typedef struct _EFI_MM_POWER_BUTTON_DISPATCH_PROTOCOL EFI_MM_POWER_BUTTON_DISPATCH_PROTOCOL

typedef EFI_STATUS(EFIAPI * EFI_MM_POWER_BUTTON_REGISTER)(IN CONST EFI_MM_POWER_BUTTON_DISPATCH_PROTOCOL *This, IN EFI_MM_HANDLER_ENTRY_POINT DispatchFunction, IN EFI_MM_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 MMI 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_MM_POWER_BUTTON_DISPATCH_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 MMI 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 MMI source has been enabled.
EFI_DEVICE_ERROR	The driver was unable to enable the MMI 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 MM) to manage this child.

typedef EFI_STATUS(EFIAPI * EFI_MM_POWER_BUTTON_UNREGISTER)(IN CONST EFI_MM_POWER_BUTTON_DISPATCH_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_MM_POWER_BUTTON_DISPATCH_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

enum EFI_POWER_BUTTON_PHASE

Power Button phases.

Enumerator
EfiPowerButtonEntry
EfiPowerButtonExit
EfiPowerButtonMax

Variable Documentation

EFI_GUID gEfiMmPowerButtonDispatchProtocolGuid