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

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
index fd65f77b368eb86152b9cb659b7a61ba93315f19..21506f9ec35c6ac32cf47bf7a45059ce058de1a3 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
@@ -1,14 +1,14 @@
 /** @file\r
   Provides the parent dispatch service for a given Sx-state source generator.\r
 \r
-  Copyright (c) 2007 - 2009, 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
-  which accompanies this distribution.  The full text of the license may be found at\r
-  http://opensource.org/licenses/bsd-license.php\r
-\r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2007 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php.                                          \r
+    \r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
   @par Revision Reference:\r
   This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
@@ -45,13 +45,13 @@ typedef struct {
 /**\r
   Dispatch function for a Sx state SMI handler.\r
 \r
-  @param  DispatchHandle        Handle of this dispatch function.\r
-  @param  DispatchContext       Pointer to the dispatch function's context.\r
+  @param  DispatchHandle        The handle of this dispatch function.\r
+  @param  DispatchContext       The pointer to the dispatch function's context.\r
                                 The Type and Phase fields are filled in by the Sx dispatch driver\r
                                 prior to invoking this dispatch function. For this interface,\r
                                 the Sx driver will call the dispatch function for all Sx type\r
                                 and phases, so the Sx state handler(s) must check the Type and\r
-                                Phase field of EFI_SMM_SX_DISPATCH_CONTEXT and act accordingly.\r
+                                Phase field of EFI_SMM_SX_DISPATCH_CONTEXT, and act accordingly.\r
 \r
   @return None\r
 \r
@@ -64,11 +64,11 @@ VOID
   );\r
 \r
 /**\r
-  Register a child SMI source dispatch function with a parent SMM driver\r
+  Register a child SMI source dispatch function with a parent SMM driver.\r
 \r
-  @param  This                  Pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.\r
-  @param  DispatchFunction      Function to install.\r
-  @param  DispatchContext       Pointer to the dispatch function's context.\r
+  @param  This                  The pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.\r
+  @param  DispatchFunction      The function to install.\r
+  @param  DispatchContext       The pointer to the dispatch function's context.\r
                                 The caller fills in this context before calling\r
                                 the register function to indicates to the register\r
                                 function which Sx state type and phase the caller\r
@@ -76,8 +76,8 @@ VOID
                                 the Sx driver will call the registered handlers for\r
                                 all Sx type and phases, so the Sx state handler(s)\r
                                 must check the Type and Phase field of the Dispatch\r
-                                context and act accordingly.\r
-  @param  DispatchHandle        Handle of dispatch function, for interfacing\r
+                                context, and act accordingly.\r
+  @param  DispatchHandle        The handle of dispatch function, for interfacing\r
                                 with the parent Sx state SMM driver.\r
 \r
   @retval EFI_SUCCESS           The dispatch function has been successfully\r
@@ -88,7 +88,7 @@ VOID
   @retval EFI_OUT_OF_RESOURCES  Not enough memory (system or SMM) to manage this\r
                                 child.\r
   @retval EFI_INVALID_PARAMETER DispatchContext is invalid. Type & Phase are not\r
-                                within valid range.\r
+                                within a valid range.\r
 \r
 **/\r
 typedef\r
@@ -103,11 +103,11 @@ EFI_STATUS
 /**\r
   Unregisters an Sx-state service\r
 \r
-  @param  This                  Pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.\r
-  @param  DispatchHandle        Handle of the service to remove.\r
+  @param  This                  The pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.\r
+  @param  DispatchHandle        The handle of the service to remove.\r
 \r
-  @retval EFI_SUCCESS           The dispatch function has been successfully unregistered and the\r
-                                SMI source has been disabled if there are no other registered child\r
+  @retval EFI_SUCCESS           The dispatch function has been successfully unregistered, and the\r
+                                SMI source has been disabled, if there are no other registered child\r
                                 dispatch functions for this SMI source.\r
   @retval EFI_INVALID_PARAMETER Handle is invalid.\r
 \r