timeout_q.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015 Wind River Systems, Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_KERNEL_INCLUDE_TIMEOUT_Q_H_
#define ZEPHYR_KERNEL_INCLUDE_TIMEOUT_Q_H_
 
#include <kernel.h>
 
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifdef CONFIG_SYS_CLOCK_EXISTS
 
static inline void z_init_timeout(struct _timeout *to)
{
        sys_dnode_init(&to->node);
}
 
void z_add_timeout(struct _timeout *to, _timeout_func_t fn,
                   k_timeout_t timeout);
 
int z_abort_timeout(struct _timeout *to);
 
static inline bool z_is_inactive_timeout(const struct _timeout *to)
{
        return !sys_dnode_is_linked(&to->node);
}
 
static inline void z_init_thread_timeout(struct _thread_base *thread_base)
{
        z_init_timeout(&thread_base->timeout);
}
 
extern void z_thread_timeout(struct _timeout *timeout);
 
static inline void z_add_thread_timeout(struct k_thread *thread, k_timeout_t ticks)
{
        z_add_timeout(&thread->base.timeout, z_thread_timeout, ticks);
}
 
static inline int z_abort_thread_timeout(struct k_thread *thread)
{
        return z_abort_timeout(&thread->base.timeout);
}
 
int32_t z_get_next_timeout_expiry(void);
 
void z_set_timeout_expiry(int32_t ticks, bool is_idle);
 
k_ticks_t z_timeout_remaining(const struct _timeout *timeout);
 
#else
 
/* Stubs when !CONFIG_SYS_CLOCK_EXISTS */
#define z_init_thread_timeout(thread_base) do {} while (false)
#define z_abort_thread_timeout(to) (0)
#define z_is_inactive_timeout(to) 0
#define z_get_next_timeout_expiry() ((int32_t) K_TICKS_FOREVER)
#define z_set_timeout_expiry(ticks, is_idle) do {} while (false)
 
static inline void z_add_thread_timeout(struct k_thread *thread, k_timeout_t ticks)
{
        ARG_UNUSED(thread);
        ARG_UNUSED(ticks);
}
 
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_KERNEL_INCLUDE_TIMEOUT_Q_H_ */