Retiring the ANT/JAVA build and removing the older EDK II packages that required...

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

diff --git a/OldMdePkg/Include/Protocol/SmmPowerButtonDispatch.h b/OldMdePkg/Include/Protocol/SmmPowerButtonDispatch.h
deleted file mode 100644 (file)
index 891a1fd..0000000
--- a/OldMdePkg/Include/Protocol/SmmPowerButtonDispatch.h
+++ /dev/null
@@ -1,147 +0,0 @@
-/** @file\r
-  This file declares EFI Smm Power Button Smi Child Protocol\r
-\r
-  Copyright (c) 2006, Intel Corporation                                                         \r
-  All rights reserved. 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
-  Module Name:  SmmPowerButtonDispatch.h\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
-// 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  DispatchHandle        Handle of this dispatch function.\r
-  @param  DispatchContext       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
-  Nothing\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
-  Register a child SMI source dispatch function with a parent SMM driver\r
-\r
-  @param  This                  Protocol instance pointer.\r
-  @param  DispatchFunction      Pointer to dispatch function to be invoked for\r
-                                this SMI source\r
-  @param  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 the Power Button SMI phase for which the dispatch\r
-                                function should be invoked.\r
-  @param  DispatchHandle        Handle of dispatch function, for when 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_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
-  Unregister a child SMI source dispatch function with a parent SMM driver\r
-\r
-  @param  This                  Protocol instance pointer.\r
-  @param  DispatchHandle        Handle of dispatch function to deregister.\r
-\r
-  @retval EFI_SUCCESS           The dispatch function has been successfully\r
-                                unregistered and the SMI source has been disabled\r
-                                if there are no other registered child dispatch\r
-                                functions for this SMI source.\r
-  @retval EFI_INVALID_PARAMETER Handle is invalid.\r
-  @retval other                 TBD\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
-// Interface structure for the SMM Power Button SMI Dispatch Protocol\r
-//\r
-/**\r
-  @par Protocol Description:\r
-  Provides the parent dispatch service for the SMM power button SMI source generator.\r
-\r
-  @param Register\r
-  Installs a child service to be dispatched by this protocol.\r
-\r
-  @param UnRegister\r
-  Removes a child service dispatched by this protocol.\r
-\r
-**/\r
-struct _EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL {\r
-  EFI_SMM_POWER_BUTTON_REGISTER   Register;\r
-  EFI_SMM_POWER_BUTTON_UNREGISTER UnRegister;\r
-};\r
-\r
-extern EFI_GUID gEfiSmmPowerButtonDispatchProtocolGuid;\r
-\r
-#endif\r