2b3687dbb5
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10404 6f19259b-4bc3-4df7-8a09-765794883524
136 lines
5.3 KiB
C
136 lines
5.3 KiB
C
/** @file
|
|
Provides the parent dispatch service for a given Sx-state source generator.
|
|
|
|
Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
|
|
This program and the accompanying materials are licensed and made available under
|
|
the terms and conditions of the BSD License that 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.
|
|
|
|
@par Revision Reference:
|
|
This Protocol is defined in Framework of EFI SMM Core Interface Spec
|
|
Version 0.9.
|
|
|
|
**/
|
|
|
|
#ifndef _EFI_SMM_SX_DISPATCH_H_
|
|
#define _EFI_SMM_SX_DISPATCH_H_
|
|
|
|
//
|
|
// Share some common definitions with PI SMM
|
|
//
|
|
#include <Protocol/SmmSxDispatch2.h>
|
|
|
|
//
|
|
// Global ID for the Sx SMI Protocol
|
|
//
|
|
#define EFI_SMM_SX_DISPATCH_PROTOCOL_GUID \
|
|
{ \
|
|
0x14fc52be, 0x1dc, 0x426c, {0x91, 0xae, 0xa2, 0x3c, 0x3e, 0x22, 0xa, 0xe8 } \
|
|
}
|
|
|
|
typedef struct _EFI_SMM_SX_DISPATCH_PROTOCOL EFI_SMM_SX_DISPATCH_PROTOCOL;
|
|
|
|
typedef struct {
|
|
EFI_SLEEP_TYPE Type;
|
|
EFI_SLEEP_PHASE Phase;
|
|
} EFI_SMM_SX_DISPATCH_CONTEXT;
|
|
|
|
//
|
|
// Member functions
|
|
//
|
|
/**
|
|
Dispatch function for a Sx state SMI handler.
|
|
|
|
@param DispatchHandle The handle of this dispatch function.
|
|
@param DispatchContext The pointer to the dispatch function's context.
|
|
The Type and Phase fields are filled in by the Sx dispatch driver
|
|
prior to invoking this dispatch function. For this interface,
|
|
the Sx driver will call the dispatch function for all Sx type
|
|
and phases, so the Sx state handler(s) must check the Type and
|
|
Phase field of EFI_SMM_SX_DISPATCH_CONTEXT, and act accordingly.
|
|
|
|
@return None
|
|
|
|
**/
|
|
typedef
|
|
VOID
|
|
(EFIAPI *EFI_SMM_SX_DISPATCH)(
|
|
IN EFI_HANDLE DispatchHandle,
|
|
IN EFI_SMM_SX_DISPATCH_CONTEXT *DispatchContext
|
|
);
|
|
|
|
/**
|
|
Register a child SMI source dispatch function with a parent SMM driver.
|
|
|
|
@param This The pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.
|
|
@param DispatchFunction The function to install.
|
|
@param DispatchContext The pointer to the dispatch function's context.
|
|
The caller fills in this context before calling
|
|
the register function to indicates to the register
|
|
function which Sx state type and phase the caller
|
|
wishes to be called back on. For this interface,
|
|
the Sx driver will call the registered handlers for
|
|
all Sx type and phases, so the Sx state handler(s)
|
|
must check the Type and Phase field of the Dispatch
|
|
context, and act accordingly.
|
|
@param DispatchHandle The handle of dispatch function, for interfacing
|
|
with the parent Sx state SMM driver.
|
|
|
|
@retval EFI_SUCCESS The dispatch function has been successfully
|
|
registered and the SMI source has been enabled.
|
|
@retval EFI_UNSUPPORTED The Sx driver or hardware does not support that
|
|
Sx Type/Phase.
|
|
@retval EFI_DEVICE_ERROR The Sx driver was unable to enable the SMI source.
|
|
@retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
|
|
child.
|
|
@retval EFI_INVALID_PARAMETER DispatchContext is invalid. Type & Phase are not
|
|
within a valid range.
|
|
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_SMM_SX_REGISTER)(
|
|
IN EFI_SMM_SX_DISPATCH_PROTOCOL *This,
|
|
IN EFI_SMM_SX_DISPATCH DispatchFunction,
|
|
IN EFI_SMM_SX_DISPATCH_CONTEXT *DispatchContext,
|
|
OUT EFI_HANDLE *DispatchHandle
|
|
);
|
|
|
|
/**
|
|
Unregisters an Sx-state service
|
|
|
|
@param This The pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.
|
|
@param DispatchHandle The handle of the service to remove.
|
|
|
|
@retval 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.
|
|
@retval EFI_INVALID_PARAMETER Handle is invalid.
|
|
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_SMM_SX_UNREGISTER)(
|
|
IN EFI_SMM_SX_DISPATCH_PROTOCOL *This,
|
|
IN EFI_HANDLE DispatchHandle
|
|
);
|
|
|
|
//
|
|
// Interface structure for the SMM Child Dispatch Protocol
|
|
//
|
|
/**
|
|
Provides the parent dispatch service for a given Sx-state source generator.
|
|
**/
|
|
struct _EFI_SMM_SX_DISPATCH_PROTOCOL {
|
|
EFI_SMM_SX_REGISTER Register; ///< Installs a child service to be dispatched by this protocol.
|
|
EFI_SMM_SX_UNREGISTER UnRegister; ///< Removes a child service dispatched by this protocol.
|
|
};
|
|
|
|
extern EFI_GUID gEfiSmmSxDispatchProtocolGuid;
|
|
|
|
#endif
|