updated comment

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h
index c6cdf608f52e5142887deca8b284202b723f6669..d93272e214de93db87f91fca800b6462f4d286b1 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h
@@ -1,6 +1,9 @@
 /** @file\r
   This file declares Smm Gpi Smi Child Protocol\r
-\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
+  SMI in response to any of these inputs having a true value provided.\r
+  \r
   Copyright (c) 2007, 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
@@ -64,7 +67,7 @@ typedef struct {
 **/\r
 typedef\r
 VOID\r
-(EFIAPI *EFI_SMM_GPI_DISPATCH) (\r
+(EFIAPI *EFI_SMM_GPI_DISPATCH)(\r
   IN  EFI_HANDLE                    DispatchHandle,\r
   IN  EFI_SMM_GPI_DISPATCH_CONTEXT  *DispatchContext\r
   );\r
@@ -72,16 +75,15 @@ VOID
 /**\r
   Register a child SMI source dispatch function with a parent SMM driver\r
 \r
-  @param  This                  Protocol instance pointer.\r
-  @param  DispatchFunction      Pointer to dispatch function to be invoked for\r
-                                this SMI source\r
+  @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
                                 function the GPI(s) for which the dispatch function\r
                                 should be invoked.\r
-  @param  DispatchHandle        Handle of dispatch function, for when interfacing\r
-                                with the parent Sx state SMM driver.\r
+  @param  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
@@ -94,32 +96,31 @@ VOID
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SMM_GPI_REGISTER) (\r
-  IN EFI_SMM_GPI_DISPATCH_PROTOCOL            *This,\r
-  IN  EFI_SMM_GPI_DISPATCH                    DispatchFunction,\r
-  IN  EFI_SMM_GPI_DISPATCH_CONTEXT            *DispatchContext,\r
-  OUT EFI_HANDLE                              *DispatchHandle\r
+(EFIAPI *EFI_SMM_GPI_REGISTER)(\r
+  IN EFI_SMM_GPI_DISPATCH_PROTOCOL           *This,\r
+  IN EFI_SMM_GPI_DISPATCH                    DispatchFunction,\r
+  IN EFI_SMM_GPI_DISPATCH_CONTEXT            *DispatchContext,\r
+  OUT EFI_HANDLE                             *DispatchHandle\r
   );\r
 \r
 /**\r
-  Unregister a child SMI source dispatch function with a parent SMM driver\r
+  Unregisters a General Purpose Input (GPI) service.\r
 \r
-  @param  This                  Protocol instance pointer.\r
-  @param  DispatchHandle        Handle of dispatch function to deregister.\r
+  @param  This                  Pointer to the EFI_SMM_GPI_DISPATCH_PROTOCOL instance.\r
+  @param  DispatchHandle        Handle of the service to remove.\r
 \r
   @retval EFI_SUCCESS           The dispatch function has been successfully\r
                                 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 other                 TBD\r
+  @retval EFI_INVALID_PARAMETER DispatchHandle is invalid.\r
 \r
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SMM_GPI_UNREGISTER) (\r
-  IN EFI_SMM_GPI_DISPATCH_PROTOCOL            *This,\r
-  IN  EFI_HANDLE                              DispatchHandle\r
+(EFIAPI *EFI_SMM_GPI_UNREGISTER)(\r
+  IN EFI_SMM_GPI_DISPATCH_PROTOCOL           *This,\r
+  IN EFI_HANDLE                              DispatchHandle\r
   );\r
 \r
 //\r