timer.h revision e7cef9b6cf140765aa2fdefe04b9db3b808c70ea
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * IPRT - Timer.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * Copyright (C) 2006-2007 Sun Microsystems, Inc.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * available from http://www.virtualbox.org. This file is free software;
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * you can redistribute it and/or modify it under the terms of the GNU
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * General Public License (GPL) as published by the Free Software
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * The contents of this file may alternatively be used under the terms
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * of the Common Development and Distribution License Version 1.0
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * VirtualBox OSE distribution, in which case the provisions of the
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * CDDL are applicable instead of those of the GPL.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * You may elect to license modified versions of this file under the
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * terms and conditions of either the GPL or the CDDL or both.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * additional information or have any questions.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync/** @defgroup grp_rt_timer RTTimer - Timer
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * The IPRT timer API provides a simple abstraction of recurring and one-shot callback timers.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * Because of the great variation in the native APIs and the quality of
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * the service delivered by those native APIs, the timers are operated
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * on at best effort basis.
0f77dc54d7ec617480988ccdfcd080f480e79698vboxsync * All the ring-3 implementations are naturally at the mercy of the scheduler,
0f77dc54d7ec617480988ccdfcd080f480e79698vboxsync * which means that the callback rate might vary quite a bit and we might skip
0f77dc54d7ec617480988ccdfcd080f480e79698vboxsync * ticks. Many systems have a restriction that a process can only have one
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * timer. IPRT currently makes no efforts at multiplexing timers in those kind
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * of situations and will simply fail if you try to create more than one timer.
2c95722bb302f4ce9454d04324b09314c0ccc038vboxsync * Things are generally better in ring-0. The implementations will use interrupt
2c95722bb302f4ce9454d04324b09314c0ccc038vboxsync * time callbacks wherever available, and if not, resort to a high priority
2c95722bb302f4ce9454d04324b09314c0ccc038vboxsync * kernel thread.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @ingroup grp_rt
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync/** Timer handle. */
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * Timer callback function.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * The context this call is made in varies with different platforms and
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * kernel / user mode IPRT.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * In kernel mode a timer callback should not waste time, it shouldn't
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * waste stack and it should be prepared that some APIs might not work
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * correctly because of weird OS restrictions in this context that we
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * haven't discovered and avoided yet. Please fix those APIs so they
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * at least avoid panics and weird behaviour.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @param pTimer Timer handle.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @param pvUser User argument.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @param iTick The current timer tick. This is always 1 on the first
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * callback after the timer was started. For omni timers
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * this will be 1 when a cpu comes back online.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsynctypedef DECLCALLBACK(void) FNRTTIMER(PRTTIMER pTimer, void *pvUser, uint64_t iTick);
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync/** Pointer to FNRTTIMER() function. */
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * Create a recurring timer.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @returns iprt status code.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @param ppTimer Where to store the timer handle.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @param uMilliesInterval Milliseconds between the timer ticks.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * This is rounded up to the system granularity.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @param pfnTimer Callback function which shall be scheduled for execution
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * on every timer tick.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @param pvUser User argument for the callback.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @see RTTimerDestroy, RTTimerStop
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsyncRTDECL(int) RTTimerCreate(PRTTIMER *ppTimer, unsigned uMilliesInterval, PFNRTTIMER pfnTimer, void *pvUser);
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * Create a suspended timer.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @returns iprt status code.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @retval VERR_NOT_SUPPORTED if an unsupported flag was specfied.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @param ppTimer Where to store the timer handle.
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * @param u64NanoInterval The interval between timer ticks specified in nanoseconds if it's
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * a recurring timer. This is rounded to the fit the system timer granularity.
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * For one shot timers, pass 0.
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * @param fFlags Timer flags.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @param pfnTimer Callback function which shall be scheduled for execution
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * on every timer tick.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @param pvUser User argument for the callback.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @see RTTimerStart, RTTimerStop, RTTimerDestroy, RTTimerGetSystemGranularity
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsyncRTDECL(int) RTTimerCreateEx(PRTTIMER *ppTimer, uint64_t u64NanoInterval, unsigned fFlags, PFNRTTIMER pfnTimer, void *pvUser);
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync/** @name RTTimerCreateEx flags
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync/** Any CPU is fine. (Must be 0.) */
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync/** One specific CPU */
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync/** Omni timer, run on all online CPUs.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @remarks The timer callback isn't necessarily running at the time same time on each CPU. */
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync#define RTTIMER_FLAGS_CPU_ALL ( RTTIMER_FLAGS_CPU_MASK | RTTIMER_FLAGS_CPU_SPECIFIC )
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync/** CPU mask. */
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync/** Convert a CPU number (0-based) to RTTimerCreateEx flags.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * This will automatically OR in the RTTIMER_FLAG_CPU_SPECIFIC flag. */
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync#define RTTIMER_FLAGS_CPU(iCpu) ( (iCpu) | RTTIMER_FLAG_CPU_SPECIFIC )
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync/** Macro that validates the flags. */
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync#define RTTIMER_FLAGS_ARE_VALID(fFlags) ( !((fFlags) & ~((fFlags) & RTTIMER_FLAGS_CPU_SPECIFIC ? 0x1ffU : 0x100U)) )
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * Stops and destroys a running timer.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @returns iprt status code.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @param pTimer Timer to stop and destroy. NULL is ok.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * Stops an active timer.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @returns IPRT status code.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @retval VERR_INVALID_HANDLE if pTimer isn't valid.
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * @retval VERR_TIMER_ACTIVE if the timer isn't suspended.
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * @param pTimer The timer to activate.
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * @param u64First The RTTimeSystemNanoTS() for when the timer should start
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * firing (relative). If 0 is specified, the timer will fire ASAP.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @see RTTimerStop
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsyncRTDECL(int) RTTimerStart(PRTTIMER pTimer, uint64_t u64First);
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * Stops an active timer.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @returns IPRT status code.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @retval VERR_INVALID_HANDLE if pTimer isn't valid.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @retval VERR_TIMER_SUSPENDED if the timer isn't active.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @retval VERR_NOT_SUPPORTED if the IPRT implementation doesn't support stopping a timer.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @param pTimer The timer to suspend.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @see RTTimerStart
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * Gets the (current) timer granularity of the system.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @returns The timer granularity of the system in nanoseconds.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @see RTTimerRequestSystemGranularity
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * Requests a specific system timer granularity.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * Successfull calls to this API must be coupled with the exact same number of
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * calls to RTTimerReleaseSystemGranularity() in order to undo any changes made.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @returns IPRT status code.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @retval VERR_NOT_SUPPORTED if the requested value isn't supported by the host platform
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * or if the host platform doesn't support modifying the system timer granularity.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @retval VERR_PERMISSION_DENIED if the caller doesn't have the necessary privilege to
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * modify the system timer granularity.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @param u32Request The requested system timer granularity in nanoseconds.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @param pu32Granted Where to store the granted system granularity. This is the value
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * that should be passed to RTTimerReleaseSystemGranularity(). It
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * is what RTTimerGetSystemGranularity() would return immediately
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * after the change was made.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * The value differ from the request in two ways; rounding and
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * scale. Meaning if your request is for 10.000.000 you might
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * be granted 10.000.055 or 1.000.000.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @see RTTimerReleaseSystemGranularity, RTTimerGetSystemGranularity
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsyncRTDECL(int) RTTimerRequestSystemGranularity(uint32_t u32Request, uint32_t *pu32Granted);
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * Releases a system timer granularity grant acquired by RTTimerRequestSystemGranularity().
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * @returns IPRT status code.
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * @retval VERR_NOT_SUPPORTED if the host platform doesn't have any way of modifying
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * the system timer granularity.
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * @retval VERR_WRONG_ORDER if nobody call RTTimerRequestSystemGranularity() with the
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * given grant value.
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * @param u32Granted The granted system granularity.
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * @see RTTimerRequestSystemGranularity
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsyncRTDECL(int) RTTimerReleaseSystemGranularity(uint32_t u32Granted);
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * Timer callback function for low res timers.
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * This is identfical to FNRTTIMER except for the first parameter, so
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * see FNRTTIMER for details.
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * @param hTimerLR The low resolution timer handle.
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * @param pvUser User argument.
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * @param iTick The current timer tick. This is always 1 on the first
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * callback after the timer was started. Will jump if we've
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * skipped ticks when lagging behind.
0f77dc54d7ec617480988ccdfcd080f480e79698vboxsynctypedef DECLCALLBACK(void) FNRTTIMERLR(RTTIMERLR hTimerLR, void *pvUser, uint64_t iTick);
0f77dc54d7ec617480988ccdfcd080f480e79698vboxsync/** Pointer to FNRTTIMER() function. */
0f77dc54d7ec617480988ccdfcd080f480e79698vboxsync * Create a recurring low resolution timer.
0f77dc54d7ec617480988ccdfcd080f480e79698vboxsync * @returns iprt status code.
0f77dc54d7ec617480988ccdfcd080f480e79698vboxsync * @param phTimerLR Where to store the timer handle.
0f77dc54d7ec617480988ccdfcd080f480e79698vboxsync * @param uMilliesInterval Milliseconds between the timer ticks, at least 100 ms.
0f77dc54d7ec617480988ccdfcd080f480e79698vboxsync * If higher resolution is required use the other API.
0f77dc54d7ec617480988ccdfcd080f480e79698vboxsync * @param pfnTimer Callback function which shall be scheduled for execution
0f77dc54d7ec617480988ccdfcd080f480e79698vboxsync * on every timer tick.
0f77dc54d7ec617480988ccdfcd080f480e79698vboxsync * @param pvUser User argument for the callback.
0f77dc54d7ec617480988ccdfcd080f480e79698vboxsync * @see RTTimerLRCreateEx, RTTimerLRDestroy, RTTimerLRStop
0f77dc54d7ec617480988ccdfcd080f480e79698vboxsyncRTDECL(int) RTTimerLRCreate(PRTTIMERLR phTimerLR, uint32_t uMilliesInterval, PFNRTTIMERLR pfnTimer, void *pvUser);
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * Create a suspended low resolution timer.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @returns iprt status code.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @retval VERR_NOT_SUPPORTED if an unsupported flag was specfied.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @param phTimerLR Where to store the timer handle.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @param u64NanoInterval The interval between timer ticks specified in nanoseconds if it's
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * a recurring timer, the minimum for is 100000000 ns.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * For one shot timers, pass 0.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @param fFlags Timer flags. Same as RTTimerCreateEx.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @param pfnTimer Callback function which shall be scheduled for execution
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * on every timer tick.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @param pvUser User argument for the callback.
0f77dc54d7ec617480988ccdfcd080f480e79698vboxsync * @see RTTimerLRStart, RTTimerLRStop, RTTimerLRDestroy
0f77dc54d7ec617480988ccdfcd080f480e79698vboxsyncRTDECL(int) RTTimerLRCreateEx(PRTTIMERLR phTimerLR, uint64_t u64NanoInterval, uint32_t fFlags, PFNRTTIMERLR pfnTimer, void *pvUser);
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * Stops and destroys a running low resolution timer.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @returns iprt status code.
0f77dc54d7ec617480988ccdfcd080f480e79698vboxsync * @param hTimerLR The low resolution timer to stop and destroy.
4aafb1203580a5c145a7bdae57ebf69a36fa4f01vboxsync * NIL_RTTIMERLR is accepted.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * Starts a low resolution timer.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @returns IPRT status code.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @retval VERR_INVALID_HANDLE if pTimer isn't valid.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @retval VERR_TIMER_ACTIVE if the timer isn't suspended.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @param hTimerLR The low resolution timer to activate.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @param u64First The RTTimeSystemNanoTS() for when the timer should start
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * firing (relative), the minimum is 100000000 ns.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * If 0 is specified, the timer will fire ASAP.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @see RTTimerLRStop
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsyncRTDECL(int) RTTimerLRStart(RTTIMERLR hTimerLR, uint64_t u64First);
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * Stops an active low resolution timer.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @returns IPRT status code.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @retval VERR_INVALID_HANDLE if pTimer isn't valid.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @retval VERR_TIMER_SUSPENDED if the timer isn't active.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @retval VERR_NOT_SUPPORTED if the IPRT implementation doesn't support stopping a timer.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @param hTimerLR The low resolution timer to suspend.
ae41886ba231ade1b868dd32ff24ee49813ebbabvboxsync * @see RTTimerLRStart