/** @file\r
Provides the parent dispatch service for the periodical timer SMI source generator.\r
\r
- Copyright (c) 2007, Intel Corporation\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
//\r
// Related Definitions\r
//\r
-//\r
-// Period is the minimum period of time in 100 nanosecond units that child gets called.\r
-// The child will be called back after a time greater than the time Period.\r
-//\r
-// SmiTickInterval is the period of time interval between SMIs. Children of this interface\r
-// should use this field when registering for periodic timer intervals when a finer\r
-// granularity periodic SMI is desired. Valid values for this field are those returned\r
-// by GetNextInterval. A value of 0 indicates the parent is allowed to use any SMI\r
-// interval period to satisfy the requested period.\r
-// Example: A chipset supports periodic SMIs on every 64ms or 2 seconds.\r
-// A child wishes schedule a period SMI to fire on a period of 3 seconds, there\r
-// are several ways to approach the problem:\r
-// 1. The child may accept a 4 second periodic rate, in which case it registers with\r
-// Period = 40000\r
-// SmiTickInterval = 20000\r
-// The resulting SMI will occur every 2 seconds with the child called back on\r
-// every 2nd SMI.\r
-// NOTE: the same result would occur if the child set SmiTickInterval = 0.\r
-// 2. The child may choose the finer granularity SMI (64ms):\r
-// Period = 30000\r
-// SmiTickInterval = 640\r
-// The resulting SMI will occur every 64ms with the child called back on\r
-// every 47th SMI.\r
-// NOTE: the child driver should be aware that this will result in more\r
-// SMIs occuring during system runtime which can negatively impact system\r
-// performance.\r
-//\r
-// ElapsedTime is the actual time in 100 nanosecond units elapsed since last called, a\r
-// value of 0 indicates an unknown amount of time.\r
-//\r
+\r
typedef struct {\r
+ ///\r
+ /// The minimum period of time in 100 nanosecond units that child gets called.\r
+ /// The child will be called back after a time greater than the time Period.\r
+ ///\r
UINT64 Period;\r
+ ///\r
+ /// The period of time interval between SMIs. Children of this interface\r
+ /// should use this field when registering for periodic timer intervals when a finer\r
+ /// granularity periodic SMI is desired. Valid values for this field are those returned\r
+ /// by GetNextInterval. A value of 0 indicates the parent is allowed to use any SMI\r
+ /// interval period to satisfy the requested period.\r
+ ///\r
UINT64 SmiTickInterval;\r
+ ///\r
+ /// The actual time in 100 nanosecond units elapsed since last called, a\r
+ /// value of 0 indicates an unknown amount of time.\r
+ ///\r
UINT64 ElapsedTime;\r
} EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT;\r
\r
by the dispatching driver prior to\r
invoking this dispatch function.\r
\r
- Nothing\r
+ @return None\r
\r
**/\r
typedef\r
VOID\r
-(EFIAPI *EFI_SMM_PERIODIC_TIMER_DISPATCH) (\r
- IN EFI_HANDLE DispatchHandle,\r
- IN EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT *DispatchContext\r
+(EFIAPI *EFI_SMM_PERIODIC_TIMER_DISPATCH)(\r
+ IN EFI_HANDLE DispatchHandle,\r
+ IN EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT *DispatchContext\r
);\r
\r
/**\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SMM_PERIODIC_TIMER_INTERVAL) (\r
+(EFIAPI *EFI_SMM_PERIODIC_TIMER_INTERVAL)(\r
IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL *This,\r
IN OUT UINT64 **SmiTickInterval\r
);\r
/**\r
Register a child SMI source dispatch function with a parent SMM driver\r
\r
- @param This Protocol instance pointer.\r
- @param DispatchFunction Pointer to dispatch function to be invoked for\r
- this SMI source\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
The caller fills this context in before calling\r
the register function to indicate to the register\r
function the period at which the dispatch function\r
should be invoked.\r
- @param DispatchHandle Handle of dispatch function, for when interfacing\r
- with the parent Sx state SMM driver.\r
+ @param DispatchHandle 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
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SMM_PERIODIC_TIMER_REGISTER) (\r
- IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL *This,\r
- IN EFI_SMM_PERIODIC_TIMER_DISPATCH DispatchFunction,\r
- IN EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT *DispatchContext,\r
- OUT EFI_HANDLE *DispatchHandle\r
+(EFIAPI *EFI_SMM_PERIODIC_TIMER_REGISTER)(\r
+ IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL *This,\r
+ IN EFI_SMM_PERIODIC_TIMER_DISPATCH DispatchFunction,\r
+ IN EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT *DispatchContext,\r
+ OUT EFI_HANDLE *DispatchHandle\r
);\r
\r
/**\r
- Unregister a child SMI source dispatch function with a parent SMM driver\r
+ Unregisters a periodic timer service.\r
\r
- @param This Protocol instance pointer.\r
- @param DispatchHandle Handle of dispatch function to deregister.\r
+ @param This Pointer to the EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL instance.\r
+ @param DispatchHandle 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
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SMM_PERIODIC_TIMER_UNREGISTER) (\r
- IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL *This,\r
- IN EFI_HANDLE DispatchHandle\r
+(EFIAPI *EFI_SMM_PERIODIC_TIMER_UNREGISTER)(\r
+ IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL *This,\r
+ IN EFI_HANDLE DispatchHandle\r
);\r
\r
//\r
// Interface structure for the SMM Periodic Timer Dispatch Protocol\r
//\r
/**\r
- @par Protocol Description:\r
Provides the parent dispatch service for the periodical timer SMI source generator.\r
-\r
- @param Register\r
- Installs a child service to be dispatched by this protocol.\r
-\r
- @param UnRegister\r
- Removes a child service dispatched by this protocol.\r
-\r
- @param GetNextShorterInterval\r
- Returns the next SMI tick period that is supported by the chipset.\r
-\r
**/\r
struct _EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL {\r
+ ///\r
+ /// Installs a child service to be dispatched by this protocol.\r
+ ///\r
EFI_SMM_PERIODIC_TIMER_REGISTER Register;\r
+ \r
+ ///\r
+ /// Removes a child service dispatched by this protocol.\r
+ ///\r
EFI_SMM_PERIODIC_TIMER_UNREGISTER UnRegister;\r
+ \r
+ ///\r
+ /// Returns the next SMI tick period that is supported by the chipset.\r
+ ///\r
EFI_SMM_PERIODIC_TIMER_INTERVAL GetNextShorterInterval;\r
};\r
\r
projects / mirror_edk2.git / blobdiff