update comments to allign with spec

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h
index 70d9ef641c45d31d0fa3c424797daeeb6209b769..6f70acd31ede145703b4c49db7391db0837f3120 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h
@@ -75,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
@@ -98,31 +97,30 @@ VOID
 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
+  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
 \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
+  IN EFI_SMM_GPI_DISPATCH_PROTOCOL           *This,\r
+  IN EFI_HANDLE                              DispatchHandle\r
   );\r
 \r
 //\r