Data Structures | |
struct | EFI_SMM_STANDBY_BUTTON_REGISTER_CONTEXT |
struct | _EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL |
Defines | |
#define | EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL_GUID |
Typedefs | |
typedef struct _EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL | EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL |
typedef EFI_STATUS(EFIAPI * | EFI_SMM_STANDBY_BUTTON_REGISTER2 )(IN CONST EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL *This, IN EFI_SMM_HANDLER_ENTRY_POINT2 DispatchFunction, IN EFI_SMM_STANDBY_BUTTON_REGISTER_CONTEXT *RegisterContext, OUT EFI_HANDLE *DispatchHandle) |
typedef EFI_STATUS(EFIAPI * | EFI_SMM_STANDBY_BUTTON_UNREGISTER2 )(IN CONST EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL *This, IN EFI_HANDLE DispatchHandle) |
Enumerations | |
enum | EFI_STANDBY_BUTTON_PHASE { EfiStandbyButtonEntry, EfiStandbyButtonExit, EfiStandbyButtonMax } |
Variables | |
EFI_GUID | gEfiSmmStandbyButtonDispatch2ProtocolGuid |
This protocol provides the parent dispatch service for the standby 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.
#define EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL_GUID |
Value:
{ \ 0x7300c4a1, 0x43f2, 0x4017, {0xa5, 0x1b, 0xc8, 0x1a, 0x7f, 0x40, 0x58, 0x5b } \ }
typedef EFI_STATUS(EFIAPI * EFI_SMM_STANDBY_BUTTON_REGISTER2)(IN CONST EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL *This, IN EFI_SMM_HANDLER_ENTRY_POINT2 DispatchFunction, IN EFI_SMM_STANDBY_BUTTON_REGISTER_CONTEXT *RegisterContext, OUT EFI_HANDLE *DispatchHandle) |
Provides the parent dispatch service for a standby button event.
This service registers a function (DispatchFunction) which will be called when an SMI is generated because the standby 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.
[in] | This | Pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL instance. |
[in] | DispatchFunction | Function to register for handler when the standby 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 standby button SMI source for which the dispatch function should be invoked. |
[out] | DispatchHandle | Handle generated by the dispatcher to track the function instance. |
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 standby 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_STANDBY_BUTTON_UNREGISTER2)(IN CONST EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL *This, IN EFI_HANDLE DispatchHandle) |
Unregisters a child SMI source dispatch function with a parent SMM driver.
This service removes the handler associated with DispatchHandle so that it will no longer be called when the standby button is pressed or released.
[in] | This | Pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL instance. |
[in] | DispatchHandle | Handle of the service to remove. |
EFI_SUCCESS | The service has been successfully removed. | |
EFI_INVALID_PARAMETER | The DispatchHandle was not valid. |