MdePkg: Follow PI1.4a to update EFI_SMM_SW_REGISTER2 return status

[mirror_edk2.git] / MdePkg / Include / Protocol / SmmSwDispatch2.h

diff --git a/MdePkg/Include/Protocol/SmmSwDispatch2.h b/MdePkg/Include/Protocol/SmmSwDispatch2.h
index 2732c3dd75c9835e10973876bde25d4af0da00c0..161493755568b77fa5157c991e9bc2f9ce87be7c 100644 (file)
--- a/MdePkg/Include/Protocol/SmmSwDispatch2.h
+++ b/MdePkg/Include/Protocol/SmmSwDispatch2.h
@@ -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, Intel Corporation\r
-  All rights reserved. This program and the accompanying materials\r
+  Copyright (c) 2009 - 2016, 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
@@ -65,22 +65,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
@@ -88,10 +88,10 @@ typedef struct _EFI_SMM_SW_DISPATCH2_PROTOCOL  EFI_SMM_SW_DISPATCH2_PROTOCOL;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SMM_SW_REGISTER)(\r
+(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
@@ -109,7 +109,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SMM_SW_UNREGISTER)(\r
+(EFIAPI *EFI_SMM_SW_UNREGISTER2)(\r
   IN CONST EFI_SMM_SW_DISPATCH2_PROTOCOL  *This,\r
   IN       EFI_HANDLE                     DispatchHandle\r
 );\r
@@ -122,8 +122,8 @@ EFI_STATUS
 /// 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
+  EFI_SMM_SW_REGISTER2    Register;\r
+  EFI_SMM_SW_UNREGISTER2  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