diff options
Diffstat (limited to 'MdePkg/Include/Protocol/SmmSxDispatch2.h')
| -rw-r--r-- | MdePkg/Include/Protocol/SmmSxDispatch2.h | 135 |
1 files changed, 0 insertions, 135 deletions
diff --git a/MdePkg/Include/Protocol/SmmSxDispatch2.h b/MdePkg/Include/Protocol/SmmSxDispatch2.h deleted file mode 100644 index 37effda44d..0000000000 --- a/MdePkg/Include/Protocol/SmmSxDispatch2.h +++ /dev/null @@ -1,135 +0,0 @@ -/** @file
- SMM Sx Dispatch Protocol as defined in PI 1.2 Specification
- Volume 4 System Management Mode Core Interface.
-
- Provides the parent dispatch service for a given Sx-state source generator.
-
- Copyright (c) 2009 - 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
- 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.
-
-**/
-
-#ifndef _SMM_SX_DISPATCH2_H_
-#define _SMM_SX_DISPATCH2_H_
-
-#include <Pi/PiSmmCis.h>
-
-#define EFI_SMM_SX_DISPATCH2_PROTOCOL_GUID \
- { \
- 0x456d2859, 0xa84b, 0x4e47, {0xa2, 0xee, 0x32, 0x76, 0xd8, 0x86, 0x99, 0x7d } \
- }
-
-///
-/// Sleep states S0-S5
-///
-typedef enum {
- SxS0,
- SxS1,
- SxS2,
- SxS3,
- SxS4,
- SxS5,
- EfiMaximumSleepType
-} EFI_SLEEP_TYPE;
-
-///
-/// Sleep state phase: entry or exit
-///
-typedef enum {
- SxEntry,
- SxExit,
- EfiMaximumPhase
-} EFI_SLEEP_PHASE;
-
-///
-/// The dispatch function's context
-///
-typedef struct {
- EFI_SLEEP_TYPE Type;
- EFI_SLEEP_PHASE Phase;
-} EFI_SMM_SX_REGISTER_CONTEXT;
-
-typedef struct _EFI_SMM_SX_DISPATCH2_PROTOCOL EFI_SMM_SX_DISPATCH2_PROTOCOL;
-
-/**
- Provides the parent dispatch service for a given Sx source generator.
-
- This service registers a function (DispatchFunction) which will be called when the sleep state
- event specified by RegisterContext is detected. On return, DispatchHandle contains a
- unique handle which may be used later to unregister the function using UnRegister().
- The DispatchFunction will be called with Context set to the same value as was passed into
- this function in RegisterContext and with CommBuffer and CommBufferSize set to
- NULL and 0 respectively.
-
- @param[in] This Pointer to the EFI_SMM_SX_DISPATCH2_PROTOCOL instance.
- @param[in] DispatchFunction Function to register for handler when the specified sleep state event occurs.
- @param[in] RegisterContext 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[out] 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_INVALID_PARAMETER RegisterContext is invalid. Type & Phase are not
- within valid range.
- @retval EFI_OUT_OF_RESOURCES There is not enough memory (system or SMM) to manage this
- child.
-**/
-typedef
-EFI_STATUS
-(EFIAPI *EFI_SMM_SX_REGISTER2)(
- IN CONST EFI_SMM_SX_DISPATCH2_PROTOCOL *This,
- IN EFI_SMM_HANDLER_ENTRY_POINT2 DispatchFunction,
- IN CONST EFI_SMM_SX_REGISTER_CONTEXT *RegisterContext,
- OUT EFI_HANDLE *DispatchHandle
- );
-
-/**
- Unregisters an Sx-state service.
-
- This service removes the handler associated with DispatchHandle so that it will no longer be
- called in response to sleep event.
-
- @param[in] This Pointer to the EFI_SMM_SX_DISPATCH2_PROTOCOL instance.
- @param[in] DispatchHandle Handle of the service to remove.
-
- @retval EFI_SUCCESS The service has been successfully removed.
- @retval EFI_INVALID_PARAMETER The DispatchHandle was not valid.
-**/
-typedef
-EFI_STATUS
-(EFIAPI *EFI_SMM_SX_UNREGISTER2)(
- IN CONST EFI_SMM_SX_DISPATCH2_PROTOCOL *This,
- IN EFI_HANDLE DispatchHandle
- );
-
-///
-/// Interface structure for the SMM Sx Dispatch Protocol
-///
-/// The EFI_SMM_SX_DISPATCH2_PROTOCOL provides the ability to install child handlers to
-/// respond to sleep state related events.
-///
-struct _EFI_SMM_SX_DISPATCH2_PROTOCOL {
- EFI_SMM_SX_REGISTER2 Register;
- EFI_SMM_SX_UNREGISTER2 UnRegister;
-};
-
-extern EFI_GUID gEfiSmmSxDispatch2ProtocolGuid;
-
-#endif
|