precision_clock.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright The Zephyr Project Contributors
 * SPDX-FileCopyrightText: Copyright (c) 2026 Philipp Steiner
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_ZEPHYR_PRECISION_TIMING_PRECISION_CLOCK_H_
#define ZEPHYR_INCLUDE_ZEPHYR_PRECISION_TIMING_PRECISION_CLOCK_H_
 
#include <stdint.h>
 
#include <zephyr/precision_timing/precision_time.h>
 
#ifdef __cplusplus
extern "C" {
#endif

 
struct precision_clock;

#define PRECISION_CLOCK_SCALED_PPM_SHIFT 16

#define PRECISION_CLOCK_SCALED_PPM_ONE (INT64_C(1) << PRECISION_CLOCK_SCALED_PPM_SHIFT)

struct precision_clock_api {
        int (*read)(const struct precision_clock *precision_clk, precision_time_t *time_ns);
        int (*set)(const struct precision_clock *precision_clk, precision_time_t time_ns);
        int (*adjust_phase)(const struct precision_clock *precision_clk, precision_time_t phase_ns);
        int (*adjust_rate)(const struct precision_clock *precision_clk, int64_t scaled_ppm);
};

struct precision_clock {
        const struct precision_clock_api *api;
        void *data;
};

int precision_clock_read(const struct precision_clock *precision_clk, precision_time_t *time_ns);

int precision_clock_set(const struct precision_clock *precision_clk, precision_time_t time_ns);

int precision_clock_adjust_phase(const struct precision_clock *precision_clk,
                                 precision_time_t phase_ns);

int precision_clock_ppb_to_scaled_ppm(double ppb, int64_t *scaled_ppm);

int precision_clock_adjust_rate(const struct precision_clock *precision_clk, int64_t scaled_ppm);

 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_ZEPHYR_PRECISION_TIMING_PRECISION_CLOCK_H_ */