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

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h
index 6f70acd31ede145703b4c49db7391db0837f3120..3c742dc070f24cf9a9fac7d4b50f219992f94cb9 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h
@@ -1,10 +1,12 @@
 /** @file\r
-  This file declares Smm Gpi Smi Child Protocol\r
-  The EFI_SMM_GPI_DISPATCH_PROTOCOL provides the ability to install child handlers for the\r
-  given event types. Several inputs can be enabled. This purpose of this interface is to generate an\r
+  This file declares Smm Gpi Smi Child Protocol.\r
+  \r
+  The EFI_SMM_GPI_DISPATCH_PROTOCOL is defined in Framework of EFI SMM Core Interface Spec\r
+  Version 0.9. It provides the ability to install child handlers for the given event types.\r
+  Several inputs can be enabled. This purpose of this interface is to generate an\r
   SMI in response to any of these inputs having a true value provided.\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
@@ -13,18 +15,11 @@
   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
+#ifndef _SMM_GPI_DISPATCH_H_\r
+#define _SMM_GPI_DISPATCH_H_\r
 \r
-#include <PiDxe.h>\r
 \r
 //\r
 // Global ID for the GPI SMI Protocol\r
@@ -39,9 +34,10 @@ typedef struct _EFI_SMM_GPI_DISPATCH_PROTOCOL  EFI_SMM_GPI_DISPATCH_PROTOCOL;
 //\r
 // Related Definitions\r
 //\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
+// GpiMask is a bit mask of 32 possible general purpose inputs that can generate \r
+// an SMI. Bit 0 corresponds to logical GPI[0], 1 corresponds to logical GPI[1], and so on.\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
@@ -54,6 +50,7 @@ typedef struct {
 //\r
 // Member functions\r
 //\r
+\r
 /**\r
   Dispatch function for a GPI SMI handler.\r
 \r
@@ -61,9 +58,6 @@ typedef struct {
   @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
@@ -78,8 +72,7 @@ VOID
   @param  This                  Pointer to the EFI_SMM_GPI_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
+                                Indicates to the register\r
                                 function the GPI(s) for which the dispatch function\r
                                 should be invoked.\r
   @param  DispatchHandle        Handle generated by the dispatcher to track the \r
@@ -113,7 +106,7 @@ EFI_STATUS
                                 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 EFI_INVALID_PARAMETER DispatchHandle is invalid.\r
 \r
 **/\r
 typedef\r
@@ -126,27 +119,17 @@ EFI_STATUS
 //\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
+\r
+  ///\r
+  /// Denotes the maximum value of inputs that can have handlers attached.\r
+  ///\r
   UINTN                   NumSupportedGpis;\r
 };\r
 \r
 extern EFI_GUID gEfiSmmGpiDispatchProtocolGuid;\r
 \r
 #endif\r
+\r