michaelh/zephyr
1
0
Fork 0
Code Releases Activity

include: sys: Add SYS_FOREVER_MS and SYS_TIMEOUT_MS macros

Browse source 
Add a macro that represents a system-wide forever wait for millisecond
timeouts, and a second one that converts from ms to kernel timeout
units.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
This commit is contained in:
Carles Cufi 2020-04-10 17:44:46 +02:00 • committed by Johan Hedberg
commit 1ed6a3889b
1 changed files with 13 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
include/sys/time_units.h
View file

@ -11,6 +11,19 @@
extern "C" { extern "C" {
#endif #endif
/** @brief System-wide macro to denote "forever" in milliseconds
*
* Usage of this macro is limited to APIs that want to expose a timeout value
* that can optionally be unlimited, or "forever".
* This macro can not be fed into kernel functions or macros directly. Use
* @ref SYS_TIMEOUT_MS instead.
*/
#define SYS_FOREVER_MS (-1)
/** @brief System-wide macro to convert milliseconds to kernel timeouts
*/
#define SYS_TIMEOUT_MS (ms) ((ms) == SYS_FOREVER_MS ? K_FOREVER : K_MSEC(ms))
/* Exhaustively enumerated, highly optimized time unit conversion API */ /* Exhaustively enumerated, highly optimized time unit conversion API */
#if defined(CONFIG_TIMER_READS_ITS_FREQUENCY_AT_RUNTIME) #if defined(CONFIG_TIMER_READS_ITS_FREQUENCY_AT_RUNTIME)