2 Provides the parent dispatch service for the power button SMI source generator.
4 @par Revision Reference:
5 This Protocol is defined in Framework of EFI SMM Core Interface Spec
8 Copyright (c) 2007, Intel Corporation
9 All rights reserved. This program and the accompanying materials
10 are licensed and made available under the terms and conditions of the BSD License
11 which accompanies this distribution. The full text of the license may be found at
12 http://opensource.org/licenses/bsd-license.php
14 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
15 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 #ifndef _EFI_SMM_POWER_BUTTON_DISPATCH_H_
20 #define _EFI_SMM_POWER_BUTTON_DISPATCH_H_
24 // Global ID for the Power Button SMI Protocol
26 #define EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL_GUID \
28 0xb709efa0, 0x47a6, 0x4b41, {0xb9, 0x31, 0x12, 0xec, 0xe7, 0xa8, 0xee, 0x56 } \
31 typedef struct _EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL
;
34 // Related Definitions
37 // Power Button. Example, Use for changing LEDs before ACPI OS is on.
44 } EFI_POWER_BUTTON_PHASE
;
47 EFI_POWER_BUTTON_PHASE Phase
;
48 } EFI_SMM_POWER_BUTTON_DISPATCH_CONTEXT
;
54 Dispatch function for a Power Button SMI handler.
56 @param[in] DispatchHandle Handle of this dispatch function.
57 @param[in] DispatchContext Pointer to the dispatch function's context.
58 The DispatchContext fields are filled in
59 by the dispatching driver prior to
60 invoking this dispatch function.
65 (EFIAPI
*EFI_SMM_POWER_BUTTON_DISPATCH
)(
66 IN EFI_HANDLE DispatchHandle
,
67 IN EFI_SMM_POWER_BUTTON_DISPATCH_CONTEXT
*DispatchContext
71 Provides the parent dispatch service for a given SMI source generator
73 @param[in] This Pointer to the EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance.
74 @param[in] DispatchFunction Function to install.
75 @param[in] DispatchContext Pointer to the dispatch function's context.
76 Indicates to the register
77 function the Power Button SMI phase for which to invoke the dispatch
79 @param[out] DispatchHandle Handle generated by the dispatcher to track the function instance.
81 @retval EFI_SUCCESS The dispatch function has been successfully
82 registered and the SMI source has been enabled.
83 @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
84 @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
86 @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The Power Button SMI
87 phase is not within valid range.
92 (EFIAPI
*EFI_SMM_POWER_BUTTON_REGISTER
)(
93 IN EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL
*This
,
94 IN EFI_SMM_POWER_BUTTON_DISPATCH DispatchFunction
,
95 IN EFI_SMM_POWER_BUTTON_DISPATCH_CONTEXT
*DispatchContext
,
96 OUT EFI_HANDLE
*DispatchHandle
100 Unregisters a power-button service.
102 @param[in] This Pointer to the EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance.
103 @param[in] DispatchHandle Handle of the service to remove.
105 @retval EFI_SUCCESS The dispatch function has been successfully
106 unregistered and the SMI source has been
107 disabled if there are no other registered
108 child dispatch functions for this SMI
110 @retval EFI_INVALID_PARAMETER Handle is invalid.
115 (EFIAPI
*EFI_SMM_POWER_BUTTON_UNREGISTER
)(
116 IN EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL
*This
,
117 IN EFI_HANDLE DispatchHandle
121 @par Protocol Description:
122 Provides the parent dispatch service for the SMM power button SMI source generator.
125 struct _EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL
{
127 /// Installs a child service to be dispatched by this protocol.
129 EFI_SMM_POWER_BUTTON_REGISTER Register
;
132 /// Removes a child service dispatched by this protocol.
134 EFI_SMM_POWER_BUTTON_UNREGISTER UnRegister
;
137 extern EFI_GUID gEfiSmmPowerButtonDispatchProtocolGuid
;