SMM General Purpose Input (GPI) Dispatch2 Protocol as defined in PI 1.1 Specification\r
Volume 4 System Management Mode Core Interface.\r
\r
- This protocol provides the parent dispatch service for the General Purpose Input \r
+ This protocol provides the parent dispatch service for the General Purpose Input\r
(GPI) SMI source generator.\r
\r
- The EFI_SMM_GPI_DISPATCH2_PROTOCOL provides the ability to install child handlers for the \r
- given event types. Several inputs can be enabled. This purpose of this interface is to generate an \r
+ The EFI_SMM_GPI_DISPATCH2_PROTOCOL provides the ability to install child handlers for the\r
+ given event types. Several inputs can be enabled. This purpose of this interface is to generate an\r
SMI in response to any of these inputs having a true value provided.\r
\r
- Copyright (c) 2009, 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
+ Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
+ SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
@par Revision Reference:\r
This protocol is from PI Version 1.1.\r
#ifndef _SMM_GPI_DISPATCH2_H_\r
#define _SMM_GPI_DISPATCH2_H_\r
\r
+#include <Protocol/MmGpiDispatch.h>\r
#include <Pi/PiSmmCis.h>\r
\r
-#define EFI_SMM_GPI_DISPATCH2_PROTOCOL_GUID \\r
- { \\r
- 0x25566b03, 0xb577, 0x4cbf, {0x95, 0x8c, 0xed, 0x66, 0x3e, 0xa2, 0x43, 0x80 } \\r
- }\r
-\r
+#define EFI_SMM_GPI_DISPATCH2_PROTOCOL_GUID EFI_MM_GPI_DISPATCH_PROTOCOL_GUID\r
///\r
/// The dispatch function's context.\r
///\r
-typedef struct {\r
- ///\r
- /// A bit mask of 64 possible GPIs that can generate an SMI. Bit 0 corresponds to logical \r
- /// GPI[0], 1 corresponds to logical GPI[1], and so on.\r
- ///\r
- UINT64 GpiNum;\r
-} EFI_SMM_GPI_REGISTER_CONTEXT;\r
-\r
-typedef struct _EFI_SMM_GPI_DISPATCH2_PROTOCOL EFI_SMM_GPI_DISPATCH2_PROTOCOL;\r
-\r
-/**\r
- Registers a child SMI source dispatch function with a parent SMM driver.\r
-\r
- This service registers a function (DispatchFunction) which will be called when an SMI is \r
- generated because of one or more of the GPIs specified by RegisterContext. On return, \r
- DispatchHandle contains a unique handle which may be used later to unregister the function \r
- using UnRegister().\r
- The DispatchFunction will be called with Context set to the same value as was passed into \r
- this function in RegisterContext and with CommBuffer pointing to another instance of \r
- EFI_SMM_GPI_REGISTER_CONTEXT describing the GPIs which actually caused the SMI and \r
- CommBufferSize pointing to the size of the structure.\r
-\r
- @param[in] This Pointer to the EFI_SMM_GPI_DISPATCH2_PROTOCOL instance.\r
- @param[in] DispatchFunction Function to register for handler when the specified GPI causes an SMI.\r
- @param[in] RegisterContext 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 GPI(s) for which the dispatch function\r
- should be invoked.\r
- @param[out] DispatchHandle Handle generated by the dispatcher to track the\r
- 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_INVALID_PARAMETER RegisterContext is invalid. The GPI input value\r
- is not within valid range.\r
- @retval EFI_OUT_OF_RESOURCES There is not enough memory (system or SMM) to manage this child.\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_SMM_GPI_REGISTER)(\r
- IN CONST EFI_SMM_GPI_DISPATCH2_PROTOCOL *This,\r
- IN EFI_SMM_HANDLER_ENTRY_POINT2 DispatchFunction,\r
- IN CONST EFI_SMM_GPI_REGISTER_CONTEXT *RegisterContext,\r
- OUT EFI_HANDLE *DispatchHandle\r
- );\r
-\r
-/**\r
- Unregisters a General Purpose Input (GPI) service.\r
-\r
- This service removes the handler associated with DispatchHandle so that it will no longer be \r
- called when the GPI triggers an SMI. \r
-\r
- @param[in] This Pointer to the EFI_SMM_GPI_DISPATCH2_PROTOCOL instance.\r
- @param[in] DispatchHandle Handle of the service to remove.\r
-\r
- @retval EFI_SUCCESS Handle of the service to remove.\r
- @retval EFI_INVALID_PARAMETER The DispatchHandle was not valid.\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_SMM_GPI_UNREGISTER)(\r
- IN CONST EFI_SMM_GPI_DISPATCH2_PROTOCOL *This,\r
- IN EFI_HANDLE DispatchHandle\r
- );\r
+typedef EFI_MM_GPI_REGISTER_CONTEXT EFI_SMM_GPI_REGISTER_CONTEXT;\r
+\r
+typedef EFI_MM_GPI_REGISTER EFI_SMM_GPI_REGISTER2;\r
+\r
+typedef EFI_MM_GPI_UNREGISTER EFI_SMM_GPI_UNREGISTER2;\r
+\r
+typedef EFI_MM_GPI_DISPATCH_PROTOCOL EFI_SMM_GPI_DISPATCH2_PROTOCOL;\r
+\r
\r
-///\r
-/// Interface structure for the SMM GPI SMI Dispatch Protocol\r
-///\r
-/// The SMM GPI SMI Dispatch Protocol provides the parent dispatch service\r
-/// for the General Purpose Input (GPI) SMI source generator.\r
-///\r
-struct _EFI_SMM_GPI_DISPATCH2_PROTOCOL {\r
- EFI_SMM_GPI_REGISTER Register;\r
- EFI_SMM_GPI_UNREGISTER UnRegister;\r
- ///\r
- /// Denotes the maximum value of inputs that can have handlers attached.\r
- ///\r
- UINTN NumSupportedGpis;\r
-};\r
\r
extern EFI_GUID gEfiSmmGpiDispatch2ProtocolGuid;\r
\r
projects / mirror_edk2.git / blobdiff