Remove IntelFrameworkPkg

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / SmmSxDispatch.h

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
deleted file mode 100644 (file)
index 6f2bb7f..0000000
--- a/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
+++ /dev/null
@@ -1,129 +0,0 @@
-/** @file\r
-  Provides the parent dispatch service for a given Sx-state source generator.\r
-\r
-Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
-SPDX-License-Identifier: BSD-2-Clause-Patent\r
-\r
-  @par Revision Reference:\r
-  This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
-  Version 0.9.\r
-\r
-**/\r
-\r
-#ifndef _EFI_SMM_SX_DISPATCH_H_\r
-#define _EFI_SMM_SX_DISPATCH_H_\r
-\r
-//\r
-// Share some common definitions with PI SMM\r
-//\r
-#include <Protocol/SmmSxDispatch2.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
-typedef struct _EFI_SMM_SX_DISPATCH_PROTOCOL  EFI_SMM_SX_DISPATCH_PROTOCOL;\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
-/**\r
-  Dispatch function for a Sx state SMI handler.\r
-\r
-  @param  DispatchHandle        The handle of this dispatch function.\r
-  @param  DispatchContext       The pointer to the dispatch function's context.\r
-                                The Type and Phase fields are filled in by the Sx dispatch driver\r
-                                prior to invoking this dispatch function. For this interface,\r
-                                the Sx driver will call the dispatch function for all Sx type\r
-                                and phases, so the Sx state handler(s) must check the Type and\r
-                                Phase field of EFI_SMM_SX_DISPATCH_CONTEXT, and act accordingly.\r
-\r
-  @return None\r
-\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
-  Register a child SMI source dispatch function with a parent SMM driver.\r
-\r
-  @param  This                  The pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.\r
-  @param  DispatchFunction      The function to install.\r
-  @param  DispatchContext       The pointer to the dispatch function's context.\r
-                                The caller fills in this context before calling\r
-                                the register function to indicates to the register\r
-                                function which Sx state type and phase the caller\r
-                                wishes to be called back on. For this interface,\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
-  @param  DispatchHandle        The handle of dispatch function, for interfacing\r
-                                with the parent Sx state SMM driver.\r
-\r
-  @retval EFI_SUCCESS           The dispatch function has been successfully\r
-                                registered and the SMI source has been enabled.\r
-  @retval EFI_UNSUPPORTED       The Sx driver or hardware does not support that\r
-                                Sx Type/Phase.\r
-  @retval EFI_DEVICE_ERROR      The Sx driver was unable to enable the SMI source.\r
-  @retval EFI_OUT_OF_RESOURCES  Not enough memory (system or SMM) to manage this\r
-                                child.\r
-  @retval EFI_INVALID_PARAMETER DispatchContext is invalid. Type & Phase are not\r
-                                within a valid range.\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
-  Unregisters an Sx-state service\r
-\r
-  @param  This                  The pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.\r
-  @param  DispatchHandle        The handle of the service to remove.\r
-\r
-  @retval 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
-  @retval EFI_INVALID_PARAMETER Handle is invalid.\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
-// Interface structure for the SMM Child Dispatch Protocol\r
-//\r
-/**\r
-  Provides the parent dispatch service for a given Sx-state source generator.\r
-**/\r
-struct _EFI_SMM_SX_DISPATCH_PROTOCOL {\r
-  EFI_SMM_SX_REGISTER   Register;     ///< Installs a child service to be dispatched by this protocol.\r
-  EFI_SMM_SX_UNREGISTER UnRegister;   ///< Removes a child service dispatched by this protocol.\r
-};\r
-\r
-extern EFI_GUID gEfiSmmSxDispatchProtocolGuid;\r
-\r
-#endif\r