+++ /dev/null
-/*++\r
-\r
-Copyright (c) 1999 - 2002, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
-\r
-Module Name:\r
-\r
- SmmSxDispatch.h\r
-\r
-Abstract:\r
-\r
- EFI Smm Sx Smi Child Protocol\r
-\r
-Revision History\r
-\r
---*/\r
-\r
-#ifndef _EFI_SMM_SX_DISPATCH_H_\r
-#define _EFI_SMM_SX_DISPATCH_H_\r
-\r
-//\r
-// Global ID for the Sx SMI Protocol\r
-//\r
-#define EFI_SMM_SX_DISPATCH_PROTOCOL_GUID \\r
- { \\r
- 0x14fc52be, 0x1dc, 0x426c, {0x91, 0xae, 0xa2, 0x3c, 0x3e, 0x22, 0xa, 0xe8} \\r
- }\r
-\r
-EFI_FORWARD_DECLARATION (EFI_SMM_SX_DISPATCH_PROTOCOL);\r
-\r
-//\r
-// Related Definitions\r
-//\r
-typedef enum {\r
- SxS0,\r
- SxS1,\r
- SxS2,\r
- SxS3,\r
- SxS4,\r
- SxS5,\r
- EfiMaximumSleepType\r
-} EFI_SLEEP_TYPE;\r
-\r
-typedef enum {\r
- SxEntry,\r
- SxExit,\r
- EfiMaximumPhase\r
-} EFI_SLEEP_PHASE;\r
-\r
-typedef struct {\r
- EFI_SLEEP_TYPE Type;\r
- EFI_SLEEP_PHASE Phase;\r
-} EFI_SMM_SX_DISPATCH_CONTEXT;\r
-\r
-//\r
-// Member functions\r
-//\r
-typedef\r
-VOID\r
-(EFIAPI *EFI_SMM_SX_DISPATCH) (\r
- IN EFI_HANDLE DispatchHandle,\r
- IN EFI_SMM_SX_DISPATCH_CONTEXT * DispatchContext\r
- );\r
-\r
-/*++\r
-\r
- Routine Description:\r
- Dispatch function for a Sx state SMI handler.\r
-\r
- Arguments:\r
- DispatchHandle - Handle of this dispatch function.\r
- DispatchContext - Pointer to the dispatch function's context.\r
- The Type and Phase fields are filled in\r
- by the Sx dispatch driver prior to invoking\r
- this dispatch function.\r
- For this intertace, the Sx driver will call the\r
- dispatch function for all Sx type and phases,\r
- so the Sx state handler(s) must check the Type\r
- and Phase field of the Dispatch context and act\r
- accordingly.\r
-\r
- Returns:\r
- Nothing\r
-\r
---*/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_SMM_SX_REGISTER) (\r
- IN EFI_SMM_SX_DISPATCH_PROTOCOL * This,\r
- IN EFI_SMM_SX_DISPATCH DispatchFunction,\r
- IN EFI_SMM_SX_DISPATCH_CONTEXT * DispatchContext,\r
- OUT EFI_HANDLE * DispatchHandle\r
- );\r
-\r
-/*++\r
-\r
- Routine Description:\r
- Register a child SMI source dispatch function with a parent SMM driver\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- DispatchFunction - Pointer to dispatch function to be invoked for\r
- this SMI source\r
- DispatchContext - Pointer to the dispatch function's context.\r
- The caller fills this context in before calling\r
- the register function to indicate to the register\r
- function which Sx state type and phase the caller\r
- wishes to be called back on. For this intertace,\r
- the Sx driver will call the registered handlers for\r
- all Sx type and phases, so the Sx state handler(s)\r
- must check the Type and Phase field of the Dispatch\r
- context and act accordingly.\r
- DispatchHandle - Handle of dispatch function, for when interfacing\r
- with the parent Sx state SMM driver.\r
-\r
- Returns:\r
- EFI_SUCCESS - The dispatch function has been successfully\r
- registered and the SMI source has been enabled.\r
- EFI_UNSUPPORTED - The Sx driver or hardware does not support that\r
- Sx Type/Phase.\r
- EFI_DEVICE_ERROR - The Sx driver was unable to enable the SMI source.\r
- EFI_OUT_OF_RESOURCES - Not enough memory (system or SMM) to manage this\r
- child.\r
- EFI_INVALID_PARAMETER - DispatchContext is invalid. Type & Phase are not\r
- within valid range.\r
-\r
---*/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_SMM_SX_UNREGISTER) (\r
- IN EFI_SMM_SX_DISPATCH_PROTOCOL * This,\r
- IN EFI_HANDLE DispatchHandle\r
- );\r
-\r
-/*++\r
-\r
- Routine Description:\r
- Unregister a child SMI source dispatch function with a parent SMM driver\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- DispatchHandle - Handle of dispatch function to deregister.\r
-\r
- Returns:\r
- EFI_SUCCESS - The dispatch function has been successfully unregistered and the\r
- SMI source has been disabled if there are no other registered child\r
- dispatch functions for this SMI source.\r
- EFI_INVALID_PARAMETER - Handle is invalid.\r
- other - TBD\r
-\r
---*/\r
-\r
-//\r
-// Interface structure for the SMM Child Dispatch Protocol\r
-//\r
-struct _EFI_SMM_SX_DISPATCH_PROTOCOL {\r
- EFI_SMM_SX_REGISTER Register;\r
- EFI_SMM_SX_UNREGISTER UnRegister;\r
-};\r
-\r
-extern EFI_GUID gEfiSmmSxDispatchProtocolGuid;\r
-\r
-#endif\r
projects / mirror_edk2.git / blobdiff