Move SmmLib from IntelFrameworkPkg to MdePkg because this library is useful to both...

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / SmmSwDispatch.h

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h
index 9bcd093c6c96d71fa479daa98dedcd872934e098..7a17fbdabd421f9a4aedcea34c5d5d88ba9ad237 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h
@@ -1,7 +1,7 @@
 /** @file\r
   Provides the parent dispatch service for a given SMI source generator.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 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
@@ -10,8 +10,6 @@
   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:  SmmSwDispatch.h\r
-\r
   @par Revision Reference:\r
   This Protocol is defined in Framework for EFI SMM Core Interface Spec\r
   Version 0.9.\r
@@ -21,7 +19,6 @@
 #ifndef _EFI_SMM_SW_DISPATCH_H_\r
 #define _EFI_SMM_SW_DISPATCH_H_\r
 \r
-#include <PiDxe.h>\r
 \r
 //\r
 // Global ID for the SW SMI Protocol\r
@@ -75,15 +72,14 @@ VOID
   @param  This                  Pointer to the EFI_SMM_SW_DISPATCH_PROTOCOL instance.\r
   @param  DispatchFunction      Function to install.\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 which Software SMI input value the\r
-                                dispatch function should be invoked for.\r
+                                Indicates to the register\r
+                                function the Software SMI input value for which to invoke the\r
+                                dispatch function.\r
   @param  DispatchHandle        Handle generated by the dispatcher to track the 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_DEVICE_ERROR      The SW driver could not 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 SW SMI input value\r
@@ -119,27 +115,33 @@ EFI_STATUS
   IN EFI_HANDLE                            DispatchHandle\r
   );\r
 \r
+\r
 //\r
 // Interface structure for the SMM Software SMI Dispatch Protocol\r
 //\r
 /**\r
-  @par Protocol Description:\r
   Provides the parent dispatch service for a given SMI source generator.\r
 **/\r
-struct _EFI_SMM_SW_DISPATCH_PROTOCOL {\r
 ///\r
-/// Installs a child service to be dispatched by this protocol.\r
+/// Inconsistent with specification here:\r
+/// In framework spec SmmCis, this definition is named as _EFI_SMM_ICHN_DISPATCH_PROTOCOL by mistake.\r
 ///\r
+struct _EFI_SMM_SW_DISPATCH_PROTOCOL {\r
+  ///\r
+  /// Installs a child service to be dispatched by this protocol.\r
+  ///\r
   EFI_SMM_SW_REGISTER   Register;\r
-///\r
-/// Removes a child service dispatched by this protocol.\r
-///\r
+\r
+  ///\r
+  /// Removes a child service dispatched by this protocol.\r
+  ///\r
   EFI_SMM_SW_UNREGISTER UnRegister;\r
-///\r
-/// A read-only field that describes the maximum value that can be used\r
-/// in the EFI_SMM_SW_DISPATCH_PROTOCOL.Register() service.\r
-///\r
-UINTN                 MaximumSwiValue;\r
+\r
+  ///\r
+  /// A read-only field that describes the maximum value that can be used\r
+  /// in the EFI_SMM_SW_DISPATCH_PROTOCOL.Register() service.\r
+  ///\r
+  UINTN                 MaximumSwiValue;\r
 };\r
 \r
 extern EFI_GUID gEfiSmmSwDispatchProtocolGuid;\r