mirror of https://github.com/acidanthera/audk.git
154 lines
4.7 KiB
C
154 lines
4.7 KiB
C
/*++
|
|
|
|
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
|
|
//
|
|
struct _EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL {
|
|
EFI_SMM_POWER_BUTTON_REGISTER Register;
|
|
EFI_SMM_POWER_BUTTON_UNREGISTER UnRegister;
|
|
};
|
|
|
|
extern EFI_GUID gEfiSmmPowerButtonDispatchProtocolGuid;
|
|
|
|
#endif
|