diff options
author | raywu <raywu0301@gmail.com> | 2018-06-15 00:00:50 +0800 |
---|---|---|
committer | raywu <raywu0301@gmail.com> | 2018-06-15 00:00:50 +0800 |
commit | b7c51c9cf4864df6aabb99a1ae843becd577237c (patch) | |
tree | eebe9b0d0ca03062955223097e57da84dd618b9a /EDK/Foundation/Framework/Protocol/SmmPowerButtonDispatch | |
download | zprj-b7c51c9cf4864df6aabb99a1ae843becd577237c.tar.xz |
Diffstat (limited to 'EDK/Foundation/Framework/Protocol/SmmPowerButtonDispatch')
-rw-r--r-- | EDK/Foundation/Framework/Protocol/SmmPowerButtonDispatch/SmmPowerButtonDispatch.c | 34 | ||||
-rw-r--r-- | EDK/Foundation/Framework/Protocol/SmmPowerButtonDispatch/SmmPowerButtonDispatch.h | 153 |
2 files changed, 187 insertions, 0 deletions
diff --git a/EDK/Foundation/Framework/Protocol/SmmPowerButtonDispatch/SmmPowerButtonDispatch.c b/EDK/Foundation/Framework/Protocol/SmmPowerButtonDispatch/SmmPowerButtonDispatch.c new file mode 100644 index 0000000..13000e7 --- /dev/null +++ b/EDK/Foundation/Framework/Protocol/SmmPowerButtonDispatch/SmmPowerButtonDispatch.c @@ -0,0 +1,34 @@ +/*++ + +Copyright (c) 1999 - 2002, 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. + + +Module Name: + + SmmPowerButtonDispatch.c + +Abstract: + + EFI Smm Power Button Smi Child Protocol + +Revision History + +--*/ + +#include "Tiano.h" +#include EFI_PROTOCOL_DEFINITION (SmmPowerButtonDispatch) + +EFI_GUID gEfiSmmPowerButtonDispatchProtocolGuid = EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL_GUID; + +EFI_GUID_STRING + ( + &gEfiSmmPowerButtonDispatchProtocolGuid, "SMM Power Button SMI Dispatch Protocol", + "EFI 2.0 SMM Power Button SMI Dispatch Protocol" + ); diff --git a/EDK/Foundation/Framework/Protocol/SmmPowerButtonDispatch/SmmPowerButtonDispatch.h b/EDK/Foundation/Framework/Protocol/SmmPowerButtonDispatch/SmmPowerButtonDispatch.h new file mode 100644 index 0000000..b4e3673 --- /dev/null +++ b/EDK/Foundation/Framework/Protocol/SmmPowerButtonDispatch/SmmPowerButtonDispatch.h @@ -0,0 +1,153 @@ +/*++ + +Copyright (c) 1999 - 2002, 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. + + +Module Name: + + SmmPowerButtonDispatch.h + +Abstract: + + EFI Smm Power Button Smi Child Protocol + +Revision History + +--*/ + +#ifndef _EFI_SMM_POWER_BUTTON_DISPATCH_H_ +#define _EFI_SMM_POWER_BUTTON_DISPATCH_H_ + +// +// Global ID for the Power Button SMI Protocol +// +#define EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL_GUID \ + { \ + 0xb709efa0, 0x47a6, 0x4b41, 0xb9, 0x31, 0x12, 0xec, 0xe7, 0xa8, 0xee, 0x56 \ + } + +EFI_FORWARD_DECLARATION (EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL); + +// +// Related Definitions +// +// +// Power Button. Example, Use for changing LEDs before ACPI OS is on. +// - DXE/BDS Phase +// - OS Install Phase +// +typedef enum { + PowerButtonEntry, + PowerButtonExit +} EFI_POWER_BUTTON_PHASE; + +typedef struct { + EFI_POWER_BUTTON_PHASE Phase; +} EFI_SMM_POWER_BUTTON_DISPATCH_CONTEXT; + +// +// Member functions +// +typedef +VOID +(EFIAPI *EFI_SMM_POWER_BUTTON_DISPATCH) ( + IN EFI_HANDLE DispatchHandle, + IN EFI_SMM_POWER_BUTTON_DISPATCH_CONTEXT * DispatchContext + ); + +/*++ + + Routine Description: + Dispatch function for a Power Button SMI handler. + + Arguments: + DispatchHandle - Handle of this dispatch function. + DispatchContext - Pointer to the dispatch function's context. + The DispatchContext fields are filled in + by the dispatching driver prior to + invoking this dispatch function. + + Returns: + Nothing + +--*/ +typedef +EFI_STATUS +(EFIAPI *EFI_SMM_POWER_BUTTON_REGISTER) ( + IN EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL * This, + IN EFI_SMM_POWER_BUTTON_DISPATCH DispatchFunction, + IN EFI_SMM_POWER_BUTTON_DISPATCH_CONTEXT * DispatchContext, + OUT EFI_HANDLE * DispatchHandle + ); + +/*++ + + Routine Description: + Register a child SMI source dispatch function with a parent SMM driver + + Arguments: + This - Protocol instance pointer. + DispatchFunction - Pointer to dispatch function to be invoked for + this SMI source + DispatchContext - Pointer to the dispatch function's context. + The caller fills this context in before calling + the register function to indicate to the register + function the Power Button SMI phase for which the dispatch + function should be invoked. + DispatchHandle - Handle of dispatch function, for when interfacing + with the parent Sx state SMM driver. + + Returns: + 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_OUT_OF_RESOURCES - Not enough memory (system or SMM) to manage this + child. + EFI_INVALID_PARAMETER - DispatchContext is invalid. The Power Button SMI + phase is not within valid range. + +--*/ +typedef +EFI_STATUS +(EFIAPI *EFI_SMM_POWER_BUTTON_UNREGISTER) ( + IN EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL * This, + IN EFI_HANDLE DispatchHandle + ); + +/*++ + + Routine Description: + Unregister a child SMI source dispatch function with a parent SMM driver + + Arguments: + This - Protocol instance pointer. + DispatchHandle - Handle of dispatch function to deregister. + + Returns: + EFI_SUCCESS - The dispatch function has been successfully + unregistered and the SMI source has been disabled + if there are no other registered child dispatch + functions for this SMI source. + EFI_INVALID_PARAMETER - Handle is invalid. + other - TBD + +--*/ + +// +// Interface structure for the SMM Power Button SMI Dispatch Protocol +// +typedef struct _EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL { + EFI_SMM_POWER_BUTTON_REGISTER Register; + EFI_SMM_POWER_BUTTON_UNREGISTER UnRegister; +} EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL; + +extern EFI_GUID gEfiSmmPowerButtonDispatchProtocolGuid; + +#endif |