4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SMM Standby Button Dispatch2 Protocol as defined in PI 1.1 Specification
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Volume 4 System Management Mode Core Interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This protocol provides the parent dispatch service for the standby button SMI source generator.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @par Revision Reference:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This protocol is from PI Version 1.1.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL_GUID \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x7300c4a1, 0x43f2, 0x4017, {0xa5, 0x1b, 0xc8, 0x1a, 0x7f, 0x40, 0x58, 0x5b } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Standby Button phases
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The dispatch function's context.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Describes whether the child handler should be invoked upon the entry to the button
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// activation or upon exit.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Provides the parent dispatch service for a standby button event.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service registers a function (DispatchFunction) which will be called when an SMI is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync generated because the standby button was pressed or released, as specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RegisterContext. On return, DispatchHandle contains a unique handle which may be used
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync later to unregister the function using UnRegister().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The DispatchFunction will be called with Context set to the same value as was passed into
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this function in RegisterContext and with CommBuffer and CommBufferSize set to NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DispatchFunction Function to register for handler when the standby button is pressed or released.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] RegisterContext Pointer to the dispatch function's context. The caller fills in this context
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync before calling the register function to indicate to the register function the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync standby button SMI source for which the dispatch function should be invoked.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] DispatchHandle Handle generated by the dispatcher to track the function instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The dispatch function has been successfully
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync registered and the SMI source has been enabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER RegisterContext is invalid. The standby button input value
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is not within valid range.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There is not enough memory (system or SMM) to manage this child.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN CONST EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_SMM_STANDBY_BUTTON_REGISTER_CONTEXT *RegisterContext,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Unregisters a child SMI source dispatch function with a parent SMM driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service removes the handler associated with DispatchHandle so that it will no longer be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync called when the standby button is pressed or released.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DispatchHandle Handle of the service to remove.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The service has been successfully removed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The DispatchHandle was not valid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN CONST EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Interface structure for the SMM Standby Button Dispatch2 Protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This protocol provides the parent dispatch service for the standby
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// button SMI source generator.