X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=IntelFrameworkPkg%2FInclude%2FProtocol%2FSmmPeriodicTimerDispatch.h;fp=IntelFrameworkPkg%2FInclude%2FProtocol%2FSmmPeriodicTimerDispatch.h;h=1b400aab4288ae5326ae0dd7009cb9f568503e48;hp=5cdb320f5c6f453bc7f5795350fdaaf1c0a04bfa;hb=f22f941ed273753a0426d1234869857f19c28664;hpb=a89fa50ccf7a29405e3d24c49625dbd70cdba9fa

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