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

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h
index 5cdb320f5c6f453bc7f5795350fdaaf1c0a04bfa..1b400aab4288ae5326ae0dd7009cb9f568503e48 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h
@@ -1,14 +1,14 @@
 /** @file\r
   Provides the parent dispatch service for the periodical timer SMI 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
@@ -36,7 +36,7 @@ typedef struct _EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL  EFI_SMM_PERIODIC_TIMER
 \r
 typedef struct {\r
   ///\r
-  /// The minimum period of time that child gets called, in 100 nanosecond units.\r
+  /// The minimum period of time that the child gets called, in 100 nanosecond units.\r
   /// The child will be called back after a time greater than the time Period.\r
   ///\r
   UINT64  Period;\r
@@ -61,8 +61,8 @@ typedef struct {
 /**\r
   Dispatch function for a Periodic Timer 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 DispatchContext fields are filled in\r
                                 by the dispatching driver prior to\r
                                 invoking this dispatch function.\r
@@ -81,8 +81,8 @@ VOID
   Returns the next SMI tick period supported by the chipset.  The order\r
   returned is from longest to shortest interval period.\r
 \r
-  @param  This                  Protocol instance pointer.\r
-  @param  SmiTickInterval       Pointer to pointer of next shorter SMI interval\r
+  @param  This                  The protocol instance pointer.\r
+  @param  SmiTickInterval       The pointer to pointer of next shorter SMI interval\r
                                 period supported by the child. This parameter works as a get-first,\r
                                 get-next field. The first time this function is called, *SmiTickInterval\r
                                 should be set to NULL to get the longest SMI interval. The returned\r
@@ -102,16 +102,16 @@ EFI_STATUS
 /**\r
   Register a child SMI source dispatch function with a parent SMM driver\r
 \r
-  @param  This                  Pointer to the EFI_SMM_PERIODIC_TIMER_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_PERIODIC_TIMER_DISPATCH_PROTOCOL instance.\r
+  @param  DispatchFunction      The function to install.\r
+  @param  DispatchContext       The pointer to the dispatch function's context.\r
                                 Indicates to the register\r
                                 function the period at which the dispatch function\r
                                 should be invoked.\r
-  @param  DispatchHandle        Handle generated by the dispatcher to track the function instance.\r
+  @param  DispatchHandle        The 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
+                                registered, and the SMI source has been enabled.\r
   @retval EFI_DEVICE_ERROR      The driver was unable to enable the SMI source.\r
   @retval EFI_OUT_OF_RESOURCES  Not enough memory (system or SMM) to manage this\r
                                 child.\r
@@ -131,14 +131,14 @@ EFI_STATUS
 /**\r
   Unregisters a periodic timer service.\r
 \r
-  @param  This                  Pointer to the EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL instance.\r
-  @param  DispatchHandle        Handle of the service to remove.\r
+  @param  This                  The pointer to the EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL instance.\r
+  @param  DispatchHandle        The 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
+                                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 EFI_INVALID_PARAMETER The handle is invalid.\r
 \r
 **/\r
 typedef\r