2 Provides the parent dispatch service for the standby button SMI source generator.
4 Copyright (c) 2007, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 Module Name: SmmStandbyButtonDispatch.h
15 @par Revision Reference:
16 This Protocol is defined in Framework of EFI SMM Core Interface Spec
21 #ifndef _EFI_SMM_STANDBY_BUTTON_DISPATCH_H_
22 #define _EFI_SMM_STANDBY_BUTTON_DISPATCH_H_
27 // Global ID for the Standby Button SMI Protocol
29 #define EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL_GUID \
31 0x78965b98, 0xb0bf, 0x449e, {0x8b, 0x22, 0xd2, 0x91, 0x4e, 0x49, 0x8a, 0x98 } \
34 typedef struct _EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL
;
37 // Related Definitions
40 // Standby Button. Example, Use for changing LEDs before ACPI OS is on.
45 EfiStandbyButtonEntry
,
48 } EFI_STANDBY_BUTTON_PHASE
;
51 EFI_STANDBY_BUTTON_PHASE Phase
;
52 } EFI_SMM_STANDBY_BUTTON_DISPATCH_CONTEXT
;
58 Dispatch function for a Standby Button SMI handler.
60 @param DispatchHandle Handle of this dispatch function.
61 @param DispatchContext Pointer to the dispatch function's context.
62 The DispatchContext fields are filled in
63 by the dispatching driver prior to
64 invoking this dispatch function.
71 (EFIAPI
*EFI_SMM_STANDBY_BUTTON_DISPATCH
)(
72 IN EFI_HANDLE DispatchHandle
,
73 IN EFI_SMM_STANDBY_BUTTON_DISPATCH_CONTEXT
*DispatchContext
77 Provides the parent dispatch service for a given SMI source generator
79 @param This Pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL instance.
80 @param DispatchFunction Function to install.
81 @param DispatchContext Pointer to the dispatch function's context.
82 The caller fills this context in before calling
83 the register function to indicate to the register
84 function the Standby Button SMI phase for which the dispatch
85 function should be invoked.
86 @param DispatchHandle Handle generated by the dispatcher to track the function instance.
88 @retval EFI_SUCCESS The dispatch function has been successfully
89 registered and the SMI source has been enabled.
90 @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
91 @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
93 @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The Standby Button SMI
94 phase is not within valid range.
99 (EFIAPI
*EFI_SMM_STANDBY_BUTTON_REGISTER
)(
100 IN EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL
*This
,
101 IN EFI_SMM_STANDBY_BUTTON_DISPATCH DispatchFunction
,
102 IN EFI_SMM_STANDBY_BUTTON_DISPATCH_CONTEXT
*DispatchContext
,
103 OUT EFI_HANDLE
*DispatchHandle
107 Unregister a child SMI source dispatch function with a parent SMM driver
109 @param This Pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL instance.
110 @param DispatchHandle Handle of the service to remove.
112 @retval EFI_SUCCESS The dispatch function has been successfully
113 unregistered and the SMI source has been disabled
114 if there are no other registered child dispatch
115 functions for this SMI source.
116 @retval EFI_INVALID_PARAMETER Handle is invalid.
121 (EFIAPI
*EFI_SMM_STANDBY_BUTTON_UNREGISTER
)(
122 IN EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL
*This
,
123 IN EFI_HANDLE DispatchHandle
127 // Interface structure for the SMM Standby Button SMI Dispatch Protocol
130 @par Protocol Description:
131 Provides the parent dispatch service for the standby button SMI source generator.
134 Installs a child service to be dispatched by this protocol.
137 Removes a child service dispatched by this protocol.
140 struct _EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL
{
141 EFI_SMM_STANDBY_BUTTON_REGISTER Register
;
142 EFI_SMM_STANDBY_BUTTON_UNREGISTER UnRegister
;
145 extern EFI_GUID gEfiSmmStandbyButtonDispatchProtocolGuid
;