diff options
Diffstat (limited to 'OldMdePkg/Include/Protocol/SmmSxDispatch.h')
| -rw-r--r-- | OldMdePkg/Include/Protocol/SmmSxDispatch.h | 160 |
1 files changed, 0 insertions, 160 deletions
diff --git a/OldMdePkg/Include/Protocol/SmmSxDispatch.h b/OldMdePkg/Include/Protocol/SmmSxDispatch.h deleted file mode 100644 index 43570aa425..0000000000 --- a/OldMdePkg/Include/Protocol/SmmSxDispatch.h +++ /dev/null @@ -1,160 +0,0 @@ -/** @file
- This file declares EFI Smm Sx Smi Child Protocol
-
- Copyright (c) 2006, 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: SmmSxDispatch.h
-
- @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_
-
-//
-// 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;
-//
-// Related Definitions
-//
-typedef enum {
- SxS0,
- SxS1,
- SxS2,
- SxS3,
- SxS4,
- SxS5,
- EfiMaximumSleepType
-} EFI_SLEEP_TYPE;
-
-typedef enum {
- SxEntry,
- SxExit,
- EfiMaximumPhase
-} EFI_SLEEP_PHASE;
-
-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 Handle of this dispatch function.
- @param DispatchContext 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.
-
- Nothing
-
-**/
-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 Protocol instance pointer.
- @param DispatchFunction Pointer to dispatch function to be invoked for
- this SMI source
- @param 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 which Sx state type and phase the caller
- wishes to be called back on. For this intertace,
- 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 Handle of dispatch function, for when 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 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
- );
-
-/**
- Unregister a child SMI source dispatch function with a parent SMM driver
-
- @param This Protocol instance pointer.
- @param DispatchHandle Handle of dispatch function to deregister.
-
- @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.
- @retval other TBD
-
-**/
-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
-//
-/**
- @par Protocol Description:
- Provides the parent dispatch service for a given Sx-state source generator.
-
- @param Register
- Installs a child service to be dispatched by this protocol.
-
- @param UnRegister
- Removes a child service dispatched by this protocol.
-
-**/
-struct _EFI_SMM_SX_DISPATCH_PROTOCOL {
- EFI_SMM_SX_REGISTER Register;
- EFI_SMM_SX_UNREGISTER UnRegister;
-};
-
-extern EFI_GUID gEfiSmmSxDispatchProtocolGuid;
-
-#endif
|