\r
This protocol provides the parent dispatch service for the periodical timer SMI source generator.\r
\r
- Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
- 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) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
+ SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
@par Revision Reference:\r
This protocol is from PI Version 1.1.\r
#define _SMM_PERIODIC_TIMER_DISPATCH2_H_\r
\r
#include <Pi/PiSmmCis.h>\r
+#include <Protocol/MmPeriodicTimerDispatch.h>\r
\r
-#define EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL_GUID \\r
- { \\r
- 0x4cec368e, 0x8e8e, 0x4d71, {0x8b, 0xe1, 0x95, 0x8c, 0x45, 0xfc, 0x8a, 0x53 } \\r
- }\r
+#define EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL_GUID EFI_MM_PERIODIC_TIMER_DISPATCH_PROTOCOL_GUID\r
\r
///\r
/// Example: A chipset supports periodic SMIs on every 64ms or 2 seconds.\r
///\r
typedef struct {\r
///\r
- /// The minimum period of time in 100 nanosecond units that the child gets called. The \r
+ /// The minimum period of time in 100 nanosecond units that the child gets called. The\r
/// 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 should use this \r
- /// field when registering for periodic timer intervals when a finer granularity periodic \r
+ /// The period of time interval between SMIs. Children of this interface should use this\r
+ /// field when registering for periodic timer intervals when a finer granularity periodic\r
/// SMI is desired.\r
///\r
UINT64 SmiTickInterval;\r
} EFI_SMM_PERIODIC_TIMER_REGISTER_CONTEXT;\r
\r
///\r
-/// The DispatchFunction will be called with Context set to the same value as was passed into \r
-/// Register() in RegisterContext and with CommBuffer pointing to an instance of \r
+/// The DispatchFunction will be called with Context set to the same value as was passed into\r
+/// Register() in RegisterContext and with CommBuffer pointing to an instance of\r
/// EFI_SMM_PERIODIC_TIMER_CONTEXT and CommBufferSize pointing to its size.\r
///\r
-typedef struct {\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
- UINT64 ElapsedTime;\r
-} EFI_SMM_PERIODIC_TIMER_CONTEXT;\r
+typedef EFI_MM_PERIODIC_TIMER_CONTEXT EFI_SMM_PERIODIC_TIMER_CONTEXT;\r
\r
typedef struct _EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL;\r
\r
/**\r
Register a child SMI source dispatch function for SMM periodic timer.\r
\r
- This service registers a function (DispatchFunction) which will be called when at least the \r
- amount of time specified by RegisterContext has elapsed. On return, DispatchHandle \r
+ This service registers a function (DispatchFunction) which will be called when at least the\r
+ amount of time specified by RegisterContext has elapsed. On return, DispatchHandle\r
contains a unique handle which may be used later to unregister the function using UnRegister().\r
- The DispatchFunction will be called with Context set to the same value as was passed into \r
- this function in RegisterContext and with CommBuffer pointing to an instance of \r
+ The DispatchFunction will be called with Context set to the same value as was passed into\r
+ this function in RegisterContext and with CommBuffer pointing to an instance of\r
EFI_SMM_PERIODIC_TIMER_CONTEXT and CommBufferSize pointing to its size.\r
\r
@param[in] This Pointer to the EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL instance.\r
@param[in] DispatchFunction Function to register for handler when at least the specified amount\r
- of time has elapsed. \r
+ of time has elapsed.\r
@param[in] RegisterContext 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[out] DispatchHandle Handle generated by the dispatcher to track the function instance. \r
+ @param[out] 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
Unregisters a periodic timer service.\r
\r
- This service removes the handler associated with DispatchHandle so that it will no longer be \r
+ This service removes the handler associated with DispatchHandle so that it will no longer be\r
called when the time has elapsed.\r
\r
@param[in] This Pointer to the EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL instance.\r
projects / mirror_edk2.git / blobdiff