timeutil.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Peter Bigot Consulting, LLC
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_SYS_TIMEUTIL_H_
#define ZEPHYR_INCLUDE_SYS_TIMEUTIL_H_
 
#include <time.h>
 
#include <zephyr/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Base Year value use in calculations in "timeutil_timegm64" API */
#define TIME_UTILS_BASE_YEAR 1900
 
int64_t timeutil_timegm64(const struct tm *tm);
 
time_t timeutil_timegm(const struct tm *tm);
 
struct timeutil_sync_config {
        uint32_t ref_Hz;
 
        uint32_t local_Hz;
};
 
struct timeutil_sync_instant {
        uint64_t ref;
 
        uint64_t local;
};
 
struct timeutil_sync_state {
        const struct timeutil_sync_config *cfg;
 
        struct timeutil_sync_instant base;
 
        struct timeutil_sync_instant latest;
 
        float skew;
};
 
int timeutil_sync_state_update(struct timeutil_sync_state *tsp,
                               const struct timeutil_sync_instant *inst);
 
int timeutil_sync_state_set_skew(struct timeutil_sync_state *tsp, float skew,
                                 const struct timeutil_sync_instant *base);
 
float timeutil_sync_estimate_skew(const struct timeutil_sync_state *tsp);
 
int timeutil_sync_ref_from_local(const struct timeutil_sync_state *tsp,
                                 uint64_t local, uint64_t *refp);
 
int timeutil_sync_local_from_ref(const struct timeutil_sync_state *tsp,
                                 uint64_t ref, int64_t *localp);
 
int32_t timeutil_sync_skew_to_ppb(float skew);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_SYS_TIMEUTIL_H_ */