--- /dev/null
+/** @file\r
+ SMM Software Dispatch Protocol as defined in PI 1.2 Specification\r
+ Volume 4 System Management Mode Core Interface.\r
+\r
+ This protocol provides the parent dispatch service for a given SMI source generator.\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
+\r
+**/\r
+\r
+#ifndef _SMM_SW_DISPATCH2_H_\r
+#define _SMM_SW_DISPATCH2_H_\r
+\r
+#include <Pi/PiSmmCis.h>\r
+\r
+#define EFI_SMM_SW_DISPATCH2_PROTOCOL_GUID \\r
+ { \\r
+ 0x18a3c6dc, 0x5eea, 0x48c8, {0xa1, 0xc1, 0xb5, 0x33, 0x89, 0xf9, 0x89, 0x99 } \\r
+ }\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_REGISTER_CONTEXT;\r
+\r
+///\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 (and CommBufferSize) pointing\r
+/// to an instance of EFI_SMM_SW_CONTEXT indicating the index of the CPU which generated the \r
+/// software SMI.\r
+///\r
+typedef struct {\r
+ ///\r
+ /// The 0-based index of the CPU which generated the software SMI.\r
+ ///\r
+ UINTN SwSmiCpuIndex;\r
+ ///\r
+ /// This value corresponds directly to the CommandPort parameter used in the call to Trigger().\r
+ ///\r
+ UINT8 CommandPort;\r
+ ///\r
+ /// This value corresponds directly to the DataPort parameter used in the call to Trigger().\r
+ ///\r
+ UINT8 DataPort;\r
+} EFI_SMM_SW_CONTEXT;\r
+\r
+typedef struct _EFI_SMM_SW_DISPATCH2_PROTOCOL EFI_SMM_SW_DISPATCH2_PROTOCOL;\r
+\r
+/**\r
+ Register a child SMI source dispatch function for the specified software SMI.\r
+\r
+ This service registers a function (DispatchFunction) which will be called when the software \r
+ SMI source specified by RegisterContext->SwSmiCpuIndex is detected. On return, \r
+ DispatchHandle contains a unique handle which may be used later to unregister the function \r
+ using UnRegister().\r
+\r
+ @param[in] This Pointer to the EFI_SMM_SW_DISPATCH2_PROTOCOL instance.\r
+ @param[in] DispatchFunction Function to register for handler when the specified software \r
+ SMI is generated. \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 which Software SMI input value the\r
+ dispatch function should be invoked for.\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 SW driver was unable to enable the SMI source.\r
+ @retval EFI_INVALID_PARAMETER RegisterContext is invalid. The SW SMI 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\r
+ child.\r
+ @retval EFI_OUT_OF_RESOURCES A unique software SMI value could not be assigned\r
+ for this dispatch.\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_SMM_SW_REGISTER)(\r
+ IN CONST EFI_SMM_SW_DISPATCH2_PROTOCOL *This,\r
+ IN EFI_SMM_HANDLER_ENTRY_POINT2 DispatchFunction,\r
+ IN CONST EFI_SMM_SW_REGISTER_CONTEXT *RegisterContext,\r
+ OUT EFI_HANDLE *DispatchHandle\r
+ );\r
+\r
+/**\r
+ Unregister a child SMI source dispatch function for the specified software SMI.\r
+\r
+ This service removes the handler associated with DispatchHandle so that it will no longer be \r
+ called in response to a software SMI.\r
+\r
+ @param[in] This Pointer to the EFI_SMM_SW_DISPATCH2_PROTOCOL instance.\r
+ @param[in] DispatchHandle Handle of dispatch function to deregister.\r
+\r
+ @retval EFI_SUCCESS The dispatch function has been successfully unregistered.\r
+ @retval EFI_INVALID_PARAMETER The DispatchHandle was not valid.\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_SMM_SW_UNREGISTER)(\r
+ IN CONST EFI_SMM_SW_DISPATCH2_PROTOCOL *This,\r
+ IN EFI_HANDLE DispatchHandle\r
+);\r
+\r
+///\r
+/// Interface structure for the SMM Software SMI Dispatch Protocol.\r
+///\r
+/// The EFI_SMM_SW_DISPATCH2_PROTOCOL provides the ability to install child handlers for the \r
+/// given software. These handlers will respond to software interrupts, and the maximum software \r
+/// interrupt in the EFI_SMM_SW_REGISTER_CONTEXT is denoted by MaximumSwiValue.\r
+///\r
+struct _EFI_SMM_SW_DISPATCH2_PROTOCOL {\r
+ EFI_SMM_SW_REGISTER Register;\r
+ EFI_SMM_SW_UNREGISTER UnRegister;\r
+ ///\r
+ /// A read-only field that describes the maximum value that can be used in the \r
+ /// EFI_SMM_SW_DISPATCH2_PROTOCOL.Register() service.\r
+ ///\r
+ UINTN MaximumSwiValue;\r
+};\r
+\r
+extern EFI_GUID gEfiSmmSwDispatch2ProtocolGuid;\r
+\r
+#endif\r
projects / mirror_edk2.git / commitdiff