Remove IntelFrameworkPkg

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h
deleted file mode 100644 (file)
index eff188f..0000000
--- a/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h
+++ /dev/null
@@ -1,145 +0,0 @@
-/** @file\r
-  Provides the parent dispatch service for a given 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 for EFI SMM Core Interface Spec\r
-  Version 0.9.\r
-\r
-**/\r
-\r
-#ifndef _EFI_SMM_SW_DISPATCH_H_\r
-#define _EFI_SMM_SW_DISPATCH_H_\r
-\r
-\r
-//\r
-// Global ID for the SW SMI Protocol\r
-//\r
-#define EFI_SMM_SW_DISPATCH_PROTOCOL_GUID \\r
-  { \\r
-    0xe541b773, 0xdd11, 0x420c, {0xb0, 0x26, 0xdf, 0x99, 0x36, 0x53, 0xf8, 0xbf } \\r
-  }\r
-\r
-typedef struct _EFI_SMM_SW_DISPATCH_PROTOCOL  EFI_SMM_SW_DISPATCH_PROTOCOL;\r
-\r
-//\r
-// Related Definitions\r
-//\r
-//\r
-// A particular chipset may not support all possible software SMI input values.\r
-// For example, the ICH supports only values 00h to 0FFh.  The parent only allows a single\r
-// child registration for each SwSmiInputValue.\r
-//\r
-typedef struct {\r
-  UINTN SwSmiInputValue;\r
-} EFI_SMM_SW_DISPATCH_CONTEXT;\r
-\r
-//\r
-// Member functions\r
-//\r
-/**\r
-  Dispatch function for a Software 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 SwSmiInputValue field is filled in\r
-                                by the software dispatch driver prior to\r
-                                invoking this dispatch function.\r
-                                The dispatch function will only be called\r
-                                for input values for which it is registered.\r
-\r
-  @return None\r
-\r
-**/\r
-typedef\r
-VOID\r
-(EFIAPI *EFI_SMM_SW_DISPATCH)(\r
-  IN  EFI_HANDLE                    DispatchHandle,\r
-  IN  EFI_SMM_SW_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_SW_DISPATCH_PROTOCOL instance.\r
-  @param  DispatchFunction      The function to install.\r
-  @param  DispatchContext       The pointer to the dispatch function's context.\r
-                                Indicates to the register\r
-                                function the Software SMI input value for which\r
-                                to invoke the dispatch function.\r
-  @param  DispatchHandle        The 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 SW driver could not 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 SW SMI input value\r
-                                is not within valid range.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_SMM_SW_REGISTER)(\r
-  IN EFI_SMM_SW_DISPATCH_PROTOCOL          *This,\r
-  IN EFI_SMM_SW_DISPATCH                   DispatchFunction,\r
-  IN EFI_SMM_SW_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                  The pointer to the EFI_SMM_SW_DISPATCH_PROTOCOL instance.\r
-  @param  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 disabled\r
-                                if there are no other registered child dispatch\r
-                                functions for this SMI source.\r
-  @retval EFI_INVALID_PARAMETER The handle is invalid.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_SMM_SW_UNREGISTER)(\r
-  IN EFI_SMM_SW_DISPATCH_PROTOCOL          *This,\r
-  IN EFI_HANDLE                            DispatchHandle\r
-  );\r
-\r
-\r
-//\r
-// Interface structure for the SMM Software SMI Dispatch Protocol\r
-//\r
-/**\r
-  Provides the parent dispatch service for a given SMI source generator.\r
-**/\r
-///\r
-/// Inconsistent with the specification here:\r
-/// In The Framework specification SmmCis, this definition is named as\r
-/// _EFI_SMM_ICHN_DISPATCH_PROTOCOL by mistake.\r
-///\r
-struct _EFI_SMM_SW_DISPATCH_PROTOCOL {\r
-  ///\r
-  /// Installs a child service to be dispatched by this protocol.\r
-  ///\r
-  EFI_SMM_SW_REGISTER   Register;\r
-\r
-  ///\r
-  /// Removes a child service dispatched by this protocol.\r
-  ///\r
-  EFI_SMM_SW_UNREGISTER UnRegister;\r
-\r
-  ///\r
-  /// A read-only field that describes the maximum value that can be used\r
-  /// in the EFI_SMM_SW_DISPATCH_PROTOCOL.Register() service.\r
-  ///\r
-  UINTN                 MaximumSwiValue;\r
-};\r
-\r
-extern EFI_GUID gEfiSmmSwDispatchProtocolGuid;\r
-\r
-#endif\r