Grammatical and disclaimer changes (does not follow internal C coding stds.)

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10249 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 24 insertions, 22 deletions

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h
index 7a17fbdabd..db46c22f93 100644
--- a/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h
@@ -1,14 +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

-

-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+Copyright (c) 2007 - 2010, 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.

 

   @par Revision Reference:

   This Protocol is defined in Framework for EFI SMM Core Interface Spec

@@ -48,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.

@@ -67,15 +67,16 @@ 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.

+  @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        Handle generated by the dispatcher to track the function instance.

+                                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.

@@ -98,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

@@ -123,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 {

   ///