--- /dev/null
+/** @file\r
+ This file declares Smm Gpi 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: SmmGpiDispatch.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_GPI_DISPATCH_H_\r
+#define _EFI_SMM_GPI_DISPATCH_H_\r
+\r
+//\r
+// Global ID for the GPI SMI Protocol\r
+//\r
+#define EFI_SMM_GPI_DISPATCH_PROTOCOL_GUID \\r
+ { \\r
+ 0xe0744b81, 0x9513, 0x49cd, {0x8c, 0xea, 0xe9, 0x24, 0x5e, 0x70, 0x39, 0xda } \\r
+ }\r
+\r
+typedef struct _EFI_SMM_GPI_DISPATCH_PROTOCOL EFI_SMM_GPI_DISPATCH_PROTOCOL;\r
+\r
+//\r
+// Related Definitions\r
+//\r
+//\r
+// GpiMask is a bit mask of 32 possible general purpose inputs that can generate a\r
+// a SMI. Bit 0 corresponds to logical GPI[0], 1 corresponds to logical GPI[1], etc.\r
+//\r
+// The logical GPI index to physical pin on device is described by the GPI device name\r
+// found on the same handle as the GpiSmi child dispatch protocol. The GPI device name\r
+// is defined as protocol with a GUID name and NULL protocol pointer.\r
+//\r
+typedef struct {\r
+ UINTN GpiNum;\r
+} EFI_SMM_GPI_DISPATCH_CONTEXT;\r
+\r
+//\r
+// Member functions\r
+//\r
+/**\r
+ Dispatch function for a GPI 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 by the dispatching driver prior to\r
+ invoking this dispatch function.\r
+\r
+ @return None\r
+\r
+**/\r
+typedef\r
+VOID\r
+(EFIAPI *EFI_SMM_GPI_DISPATCH) (\r
+ IN EFI_HANDLE DispatchHandle,\r
+ IN EFI_SMM_GPI_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 GPI(s) for which the dispatch function\r
+ 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 GPI input value\r
+ is not within valid range.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_SMM_GPI_REGISTER) (\r
+ IN EFI_SMM_GPI_DISPATCH_PROTOCOL *This,\r
+ IN EFI_SMM_GPI_DISPATCH DispatchFunction,\r
+ IN EFI_SMM_GPI_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_GPI_UNREGISTER) (\r
+ IN EFI_SMM_GPI_DISPATCH_PROTOCOL *This,\r
+ IN EFI_HANDLE DispatchHandle\r
+ );\r
+\r
+//\r
+// Interface structure for the SMM GPI SMI Dispatch Protocol\r
+//\r
+/**\r
+ @par Protocol Description:\r
+ Provides the parent dispatch service for the General Purpose Input \r
+ (GPI) 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
+ @param NumSupportedGpis\r
+ Denotes the maximum value of inputs that can have handlers attached.\r
+\r
+**/\r
+struct _EFI_SMM_GPI_DISPATCH_PROTOCOL {\r
+ EFI_SMM_GPI_REGISTER Register;\r
+ EFI_SMM_GPI_UNREGISTER UnRegister;\r
+ UINTN NumSupportedGpis;\r
+};\r
+\r
+extern EFI_GUID gEfiSmmGpiDispatchProtocolGuid;\r
+\r
+#endif\r
+\r
projects / mirror_edk2.git / blobdiff