This topic describes how to use the framework's built-in timer support. It applies to both Kernel-Mode Driver Framework (KMDF) drivers as well as User-Mode Driver Framework (UMDF) drivers starting in version 2.
The framework provides a timer object that enables drivers to create timers. After a driver creates a timer object and starts the timer's clock, the framework calls a driver-supplied callback function after a specified amount of time has elapsed. Optionally, your driver can set up the timer so that the framework calls the callback function repeatedly, whenever a specified amount of time has elapsed.
To create a framework timer object, your driver must call the WdfTimerCreate method. This method registers an EvtTimerFunc callback function and a periodic time interval. If you want the framework to call the callback function only once, your driver specifies zero for the periodic time interval.
Typically, you will know the number of timers that your driver will need for each device. Therefore, the driver can create timer objects by calling WdfTimerCreate in its EvtDriverDeviceAdd callback function, and it can store timer object handles in a device or queue object's context space.
To start the timer, your driver calls WdfTimerStart, passing a "due time". The framework starts the timer's clock and calls the EvtTimerFunc callback function when the specified amount of time has elapsed.
If the driver supplied a periodic time interval when it called WdfTimerCreate, the timer is referred to as a periodic timer. A periodic timer's clock continues to run after the initial "due time" has elapsed, and the framework calls the driver's callback function repeatedly, whenever the periodic time interval has elapsed.
To stop a timer, the driver can call WdfTimerStop. Your driver can reuse timers by starting and stopping them repeatedly.
When your driver creates a timer object, it must specify a parent object. The framework stops the timer and deletes the timer object when the parent is deleted. To obtain a timer object's parent object, your driver can call WdfTimerGetParentObject.
In KMDF versions prior to version 1.9, you cannot easily use timer objects if you want all of your driver's callback functions to run at IRQL = PASSIVE_LEVEL. The framework implements the timer object's EvtTimerFunc callback function as a deferred procedure call (DPC) that is called at IRQL = DISPATCH_LEVEL. Therefore, if you want your timer expiration code to run at PASSIVE_LEVEL the EvtTimerFunc callback function must queue a work item that runs at PASSIVE_LEVEL.
In KMDF versions 1.9 and later, you can create passive-level timers, which are timers that run at PASSIVE_LEVEL. To create a passive-level timer, specify the WdfExecutionLevelPassive execution level when your driver calls WdfTimerCreate. As a result, the framework implements EvtTimerFunc callback functions as work items that run at PASSIVE_LEVEL. Note that passive-level timers cannot be periodic timers.
Starting in UMDF version 2.0, the framework implements the timer object's EvtTimerFunc callback functions as worker threads from the user-mode thread pool. As a result, a UMDF driver's timer callback functions always run at PASSIVE_LEVEL.
System power efficiency is reduced by timers that repeatedly cause the system to resume from low-power states. One way to improve battery life is to delay non-critical periodic operations rather than waking the system. Starting in Windows 8.1, you can use no wake timers to perform such non-critical operations in either a KMDF or UMDF driver. A no wake timer does not wake the system if it expires while the system is in a low-power state. Instead, the framework calls the driver's EvtTimerFunc callback function the next time the system is in its fully on, S0 state.
No wake timers are available starting with KMDF version 1.13 and UMDF version 2.0.
To create a no wake timer, set the TolerableDelay member of WDF_TIMER_CONFIG to TolerableDelayUnlimited.
For more information about no wake timers, see No-Wake Timers.
Standard framework timers have an accuracy that matches the system clock tick interval, which is by default 15.6 milliseconds. Starting in Windows 8.1, you can create high resolution timers. A high resolution timer has an accuracy of one millisecond. You might use a high resolution timer for a critical operation that requires a precise, predictable expiration time. As a result of the frequent servicing that it requires, a high resolution timer may result in decreased battery life.
High resolution timers are available only to KMDF drivers, starting with KMDF version 1.13.
To create a high resolution timer, set the UseHighResolutionTimer member of WDF_TIMER_CONFIG to WdfTrue, and then adjust the Period value to the desired resolution.
The following table shows examples of timer behavior based on different values that the driver provides for Period. These examples assume that the system clock tick interval is 15 milliseconds.
|Period, in ms||Standard Timer||High Resolution Timer|
The timer expires between 0 milliseconds and 25 milliseconds.
The timer expires as soon after 10 milliseconds as possible.
The timer expires between 15 milliseconds and 30 milliseconds.
The timer expires as soon after 16 milliseconds as possible.
For more information about high resolution timers, see High-Resolution Timers.
For more information about how timer accuracy is related to the granularity of the system clock, see Timer Accuracy.