coap_time.h

Go to the documentation of this file.

/*
 * coap_time.h -- Clock Handling
 *
 * Copyright (C) 2010-2025 Olaf Bergmann <bergmann@tzi.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * This file is part of the CoAP library libcoap. Please see README for terms
 * of use.
 */
 
#ifndef COAP_TIME_H_
#define COAP_TIME_H_
 
#if defined(WITH_LWIP)
#include <stdint.h>
#include <lwip/sys.h>
#elif defined(WITH_CONTIKI)
#include "clock.h"
#elif defined(RIOT_VERSION)
#include <xtimer.h>
#else /* !WITH_LWIP && !WITH_CONTIKI && !RIOT_VERSION */
#include <stdint.h>
#endif /* !WITH_LWIP && !WITH_CONTIKI && !RIOT_VERSION */
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if defined(WITH_LWIP)
 
/* lwIP provides ms in sys_now */
#define COAP_TICKS_PER_SECOND 1000
 
typedef uint32_t coap_tick_t;
typedef uint32_t coap_time_t;
typedef int32_t coap_tick_diff_t;
 
COAP_STATIC_INLINE void
coap_ticks_impl(coap_tick_t *t) {
  *t = sys_now();
}
 
COAP_STATIC_INLINE void
coap_clock_init_impl(void) {
}
 
#define coap_clock_init coap_clock_init_impl
#define coap_ticks coap_ticks_impl
 
COAP_STATIC_INLINE coap_time_t
coap_ticks_to_rt(coap_tick_t t) {
  return t / COAP_TICKS_PER_SECOND;
}
 
COAP_STATIC_INLINE uint64_t
coap_ticks_to_rt_us(coap_tick_t t) {
  return (uint64_t)t * 1000000 / COAP_TICKS_PER_SECOND;
}
 
#elif defined(WITH_CONTIKI)
 
typedef clock_time_t coap_tick_t;
typedef clock_time_t coap_time_t;
 
typedef int coap_tick_diff_t;
 
#define COAP_TICKS_PER_SECOND CLOCK_SECOND
 
COAP_STATIC_INLINE void
coap_clock_init(void) {
}
 
COAP_STATIC_INLINE void
coap_ticks(coap_tick_t *t) {
  *t = clock_time();
}
 
COAP_STATIC_INLINE coap_time_t
coap_ticks_to_rt(coap_tick_t t) {
  return t / COAP_TICKS_PER_SECOND;
}
 
COAP_STATIC_INLINE uint64_t
coap_ticks_to_rt_us(coap_tick_t t) {
  return (uint64_t)t * 1000000 / COAP_TICKS_PER_SECOND;
}
 
#elif defined(RIOT_VERSION)
 
#ifdef XTIMER_HZ
#define COAP_TICKS_PER_SECOND (XTIMER_HZ)
#else /* XTIMER_HZ */
#define COAP_TICKS_PER_SECOND (1000000U)
#endif /* XTIMER_HZ */
 
typedef uint64_t coap_tick_t;
typedef int64_t coap_tick_diff_t;
typedef uint32_t coap_time_t;
 
COAP_STATIC_INLINE void
coap_clock_init(void) {}
 
COAP_STATIC_INLINE void
coap_ticks(coap_tick_t *t) {
#ifdef MODULE_ZTIMER64_XTIMER_COMPAT
  *t = xtimer_now_usec64();
#else /* MODULE_ZTIMER64_XTIMER_COMPAT */
  *t = xtimer_now_usec();
#endif /* MODULE_ZTIMER64_XTIMER_COMPAT */
}
 
COAP_STATIC_INLINE coap_time_t
coap_ticks_to_rt(coap_tick_t t) {
  return t / 1000000UL;
}
 
COAP_STATIC_INLINE uint64_t
coap_ticks_to_rt_us(coap_tick_t t) {
  return t;
}
 
COAP_STATIC_INLINE coap_tick_t
coap_ticks_from_rt_us(uint64_t t) {
  return t / 1000000UL;
}
 
#else /* !WITH_LWIP && !WITH_CONTIKI && !RIOT_VERSION */
 
typedef uint64_t coap_tick_t;
 
typedef time_t coap_time_t;
 
typedef int64_t coap_tick_diff_t;
 
#define COAP_TICKS_PER_SECOND ((coap_tick_t)(1000U))
 
void coap_clock_init(void);
 
void coap_ticks(coap_tick_t *t);
 
coap_time_t coap_ticks_to_rt(coap_tick_t t);
 
uint64_t coap_ticks_to_rt_us(coap_tick_t t);
 
coap_tick_t coap_ticks_from_rt_us(uint64_t t);
 
#endif /* !WITH_LWIP && !WITH_CONTIKI && !RIOT_VERSION */
 
COAP_STATIC_INLINE int
coap_time_lt(coap_tick_t a, coap_tick_t b) {
  return ((coap_tick_diff_t)(a - b)) < 0;
}
 
COAP_STATIC_INLINE int
coap_time_le(coap_tick_t a, coap_tick_t b) {
  return a == b || coap_time_lt(a,b);
}
 
/* Can delay up to 24 hrs before next wakeup (coap_tick_t can be 4 bytes or int64 */
#define COAP_MAX_DELAY_TICKS (24 * 60 * 60 * COAP_TICKS_PER_SECOND)
 
#ifdef __cplusplus
}
#endif
 
#endif /* COAP_TIME_H_ */