Remove IntelFrameworkPkg

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h
deleted file mode 100644 (file)
index df14fb9..0000000
--- a/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h
+++ /dev/null
@@ -1,135 +0,0 @@
-/** @file\r
-  Provides the parent dispatch service for the power button SMI 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_POWER_BUTTON_DISPATCH_H_\r
-#define _EFI_SMM_POWER_BUTTON_DISPATCH_H_\r
-\r
-\r
-//\r
-// Global ID for the Power Button SMI Protocol\r
-//\r
-#define EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL_GUID \\r
-  { \\r
-    0xb709efa0, 0x47a6, 0x4b41, {0xb9, 0x31, 0x12, 0xec, 0xe7, 0xa8, 0xee, 0x56 } \\r
-  }\r
-\r
-typedef struct _EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL  EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL;\r
-\r
-//\r
-// Related Definitions\r
-//\r
-//\r
-// Power Button. Example, Use for changing LEDs before ACPI OS is on.\r
-//    - DXE/BDS Phase\r
-//    - OS Install Phase\r
-//\r
-typedef enum {\r
-  PowerButtonEntry,\r
-  PowerButtonExit\r
-} EFI_POWER_BUTTON_PHASE;\r
-\r
-typedef struct {\r
-  EFI_POWER_BUTTON_PHASE  Phase;\r
-} EFI_SMM_POWER_BUTTON_DISPATCH_CONTEXT;\r
-\r
-//\r
-// Member functions\r
-//\r
-/**\r
-  Dispatch function for a Power Button SMI handler.\r
-\r
-  @param[in]  DispatchHandle        The handle of this dispatch function.\r
-  @param[in]  DispatchContext       The pointer to the dispatch function's context.\r
-                                    The DispatchContext fields are filled in\r
-                                    by the dispatching driver prior to\r
-                                    invoking this dispatch function.\r
-\r
-**/\r
-typedef\r
-VOID\r
-(EFIAPI *EFI_SMM_POWER_BUTTON_DISPATCH)(\r
-  IN  EFI_HANDLE                             DispatchHandle,\r
-  IN  EFI_SMM_POWER_BUTTON_DISPATCH_CONTEXT  *DispatchContext\r
-  );\r
-\r
-/**\r
-  Provides the parent dispatch service for a given SMI source generator\r
-\r
-  @param[in]   This                  The pointer to the\r
-                                     EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance.\r
-  @param[in]   DispatchFunction      The function to install.\r
-  @param[in]   DispatchContext       The pointer to the dispatch function's context.\r
-                                     Indicates to the register\r
-                                     function the Power Button SMI phase for which\r
-                                     to invoke the dispatch function.\r
-  @param[out]  DispatchHandle        Handle generated by the dispatcher to track\r
-                                     the function instance.\r
-\r
-  @retval      EFI_SUCCESS           The dispatch function has been successfully\r
-                                     registered and the SMI source has been enabled.\r
-  @retval      EFI_DEVICE_ERROR      The 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. The Power Button SMI\r
-                                     phase is not within valid range.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_SMM_POWER_BUTTON_REGISTER)(\r
-  IN EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL           *This,\r
-  IN EFI_SMM_POWER_BUTTON_DISPATCH                    DispatchFunction,\r
-  IN EFI_SMM_POWER_BUTTON_DISPATCH_CONTEXT            *DispatchContext,\r
-  OUT EFI_HANDLE                                      *DispatchHandle\r
-  );\r
-\r
-/**\r
-  Unregisters a power-button service.\r
-\r
-  @param[in]  This                  The pointer to the EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance.\r
-  @param[in]  DispatchHandle        The handle of the service to remove.\r
-\r
-  @retval     EFI_SUCCESS           The dispatch function has been successfully\r
-                                    unregistered, and the SMI source has been\r
-            disabled, if there are no other registered\r
-            child dispatch functions for this SMI\r
-            source.\r
-  @retval     EFI_INVALID_PARAMETER The handle is invalid.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_SMM_POWER_BUTTON_UNREGISTER)(\r
-  IN EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL            *This,\r
-  IN EFI_HANDLE                                        DispatchHandle\r
-  );\r
-\r
-/**\r
-  @par Protocol Description:\r
-  Provides the parent dispatch service for the SMM power button SMI source generator.\r
-\r
-**/\r
-struct _EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL {\r
-  ///\r
-  ///  Installs a child service to be dispatched by this protocol.\r
-  ///\r
-  EFI_SMM_POWER_BUTTON_REGISTER   Register;\r
-\r
-  ///\r
-  ///  Removes a child service dispatched by this protocol.\r
-  ///\r
-  EFI_SMM_POWER_BUTTON_UNREGISTER UnRegister;\r
-};\r
-\r
-extern EFI_GUID gEfiSmmPowerButtonDispatchProtocolGuid;\r
-\r
-#endif\r