update comments to allign with spec

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h
index 831d78f46c261510b5a3e7f9d279121c7e44c382..55b360ce18b0124f629fa5b64de2e72e6fe5ba34 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h
@@ -59,7 +59,7 @@ typedef struct {
                                 The dispatch function will only be called\r
                                 for input values for which it is registered.\r
 \r
-  Nothing\r
+  @return None\r
 \r
 **/\r
 typedef\r
@@ -72,16 +72,14 @@ 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_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
-  @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 function instance.\r
 \r
   @retval EFI_SUCCESS           The dispatch function has been successfully\r
                                 registered and the SMI source has been enabled.\r
@@ -95,31 +93,30 @@ VOID
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_SMM_SW_REGISTER)(\r
-  IN EFI_SMM_SW_DISPATCH_PROTOCOL           *This,\r
-  IN  EFI_SMM_SW_DISPATCH                   DispatchFunction,\r
-  IN  EFI_SMM_SW_DISPATCH_CONTEXT           *DispatchContext,\r
-  OUT EFI_HANDLE                            *DispatchHandle\r
+  IN EFI_SMM_SW_DISPATCH_PROTOCOL          *This,\r
+  IN EFI_SMM_SW_DISPATCH                   DispatchFunction,\r
+  IN EFI_SMM_SW_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
 \r
-  @param  This                  Protocol instance pointer.\r
-  @param  DispatchHandle        Handle of dispatch function to deregister.\r
+  @param  This                  Pointer to the EFI_SMM_SW_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_SW_UNREGISTER)(\r
-  IN EFI_SMM_SW_DISPATCH_PROTOCOL           *This,\r
-  IN  EFI_HANDLE                            DispatchHandle\r
+  IN EFI_SMM_SW_DISPATCH_PROTOCOL          *This,\r
+  IN EFI_HANDLE                            DispatchHandle\r
   );\r
 \r
 //\r