]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/SmmSwDispatch2.h
MdePkg FirmwareManagement.h: Fix typo EFI_SECURITY_VIOLATIO
[mirror_edk2.git] / MdePkg / Include / Protocol / SmmSwDispatch2.h
index 81ff7488d545182f1116355d219591f97a2269a6..b49ef96e481ec25006e07ccbbdc7d7124d3d527f 100644 (file)
@@ -1,11 +1,11 @@
 /** @file\r
-  SMM Software Dispatch Protocol as defined in PI 1.2 Specification\r
+  SMM Software Dispatch Protocol introduced from 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 - 2010, Intel Corporation\r
-  All rights reserved. This program and the accompanying materials\r
+  Copyright (c) 2009 - 2017, Intel Corporation. All rights reserved.<BR>\r
+  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
 #ifndef _SMM_SW_DISPATCH2_H_\r
 #define _SMM_SW_DISPATCH2_H_\r
 \r
+#include <Protocol/MmSwDispatch.h>\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
+#define EFI_SMM_SW_DISPATCH2_PROTOCOL_GUID EFI_MM_SW_DISPATCH_PROTOCOL_GUID\r
 \r
 ///\r
 /// A particular chipset may not support all possible software SMI input values.\r
@@ -65,22 +63,22 @@ typedef struct _EFI_SMM_SW_DISPATCH2_PROTOCOL  EFI_SMM_SW_DISPATCH2_PROTOCOL;
   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
+  @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, out] 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
+                                 is not within a valid range or is already in use.\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
@@ -91,7 +89,7 @@ EFI_STATUS
 (EFIAPI *EFI_SMM_SW_REGISTER2)(\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
+  IN  OUT   EFI_SMM_SW_REGISTER_CONTEXT    *RegisterContext,\r
   OUT       EFI_HANDLE                     *DispatchHandle\r
   );\r
 \r