X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=IntelFrameworkPkg%2FInclude%2FProtocol%2FSmmSwDispatch.h;h=d3c516261e04da4fc019e519ce3fb5a805605795;hb=1c2f052de2064a0f973aa27767516dfbd90b4fbd;hp=53ce1e12f2ddb2658faea5cbfbf70d98abeb2a19;hpb=0e0eeecad42a9aaf17e304fdffabbeed0e8d3a44;p=mirror_edk2.git

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h
index 53ce1e12f2..d3c516261e 100644
--- a/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h
@@ -1,16 +1,14 @@
 /** @file
   Provides the parent dispatch service for a given SMI source generator.
 
-  Copyright (c) 2007 - 2009, Intel Corporation
-  All rights reserved. This program and the accompanying materials
-  are licensed and made available under the terms and conditions of the BSD License
-  which accompanies this distribution.  The full text of the license may be found at
-  http://opensource.org/licenses/bsd-license.php
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
+This program and the accompanying materials are licensed and made available under
+the terms and conditions of the BSD License that accompanies this distribution.
+The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php.
 
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
-  Module Name:  SmmSwDispatch.h
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   @par Revision Reference:
   This Protocol is defined in Framework for EFI SMM Core Interface Spec
@@ -50,8 +48,8 @@ typedef struct {
 /**
   Dispatch function for a Software SMI handler.
 
-  @param  DispatchHandle        Handle of this dispatch function.
-  @param  DispatchContext       Pointer to the dispatch function's context.
+  @param  DispatchHandle        The handle of this dispatch function.
+  @param  DispatchContext       The pointer to the dispatch function's context.
                                 The SwSmiInputValue field is filled in
                                 by the software dispatch driver prior to
                                 invoking this dispatch function.
@@ -69,20 +67,20 @@ VOID
   );
 
 /**
-  Register a child SMI source dispatch function with a parent SMM driver
+  Register a child SMI source dispatch function with a parent SMM driver.
 
-  @param  This                  Pointer to the EFI_SMM_SW_DISPATCH_PROTOCOL instance.
-  @param  DispatchFunction      Function to install.
-  @param  DispatchContext       Pointer to the dispatch function's context.
-                                The caller fills this context in before calling
-                                the register function to indicate to the register
-                                function which Software SMI input value the
-                                dispatch function should be invoked for.
-  @param  DispatchHandle        Handle generated by the dispatcher to track the function instance.
+  @param  This                  The pointer to the EFI_SMM_SW_DISPATCH_PROTOCOL instance.
+  @param  DispatchFunction      The function to install.
+  @param  DispatchContext       The pointer to the dispatch function's context.
+                                Indicates to the register
+                                function the Software SMI input value for which
+                                to invoke the dispatch function.
+  @param  DispatchHandle        The handle generated by the dispatcher to track
+                                the function instance.
 
   @retval EFI_SUCCESS           The dispatch function has been successfully
                                 registered and the SMI source has been enabled.
-  @retval EFI_DEVICE_ERROR      The SW driver was unable to enable the SMI source.
+  @retval EFI_DEVICE_ERROR      The SW driver could not enable the SMI source.
   @retval EFI_OUT_OF_RESOURCES  Not enough memory (system or SMM) to manage this
                                 child.
   @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The SW SMI input value
@@ -101,14 +99,14 @@ EFI_STATUS
 /**
   Unregister a child SMI source dispatch function with a parent SMM driver
 
-  @param  This                  Pointer to the EFI_SMM_SW_DISPATCH_PROTOCOL instance.
-  @param  DispatchHandle        Handle of the service to remove.
+  @param  This                  The pointer to the EFI_SMM_SW_DISPATCH_PROTOCOL instance.
+  @param  DispatchHandle        The handle of the service to remove.
 
   @retval EFI_SUCCESS           The dispatch function has been successfully
                                 unregistered and the SMI source has been disabled
                                 if there are no other registered child dispatch
                                 functions for this SMI source.
-  @retval EFI_INVALID_PARAMETER Handle is invalid.
+  @retval EFI_INVALID_PARAMETER The handle is invalid.
 
 **/
 typedef
@@ -126,8 +124,9 @@ EFI_STATUS
   Provides the parent dispatch service for a given SMI source generator.
 **/
 ///
-/// Inconsistent with specification here:
-/// In framework spec SmmCis, this definition is named as _EFI_SMM_ICHN_DISPATCH_PROTOCOL by mistake.
+/// Inconsistent with the specification here:
+/// In The Framework specification SmmCis, this definition is named as
+/// _EFI_SMM_ICHN_DISPATCH_PROTOCOL by mistake.
 ///
 struct _EFI_SMM_SW_DISPATCH_PROTOCOL {
   ///