nrf_modem_dect_clock_sync.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef NRF_MODEM_DECT_CLOCK_SYNC_H__
#define NRF_MODEM_DECT_CLOCK_SYNC_H__
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum nrf_modem_dect_clock_sync_err {
        NRF_MODEM_DECT_CLOCK_SYNC_NO_ERROR = 0,
        NRF_MODEM_DECT_CLOCK_SYNC_NOT_ACTIVE = 0xFFFE,
        NRF_MODEM_DECT_CLOCK_SYNC_ERROR = 0xFFFF
};
 
struct nrf_modem_dect_clock_sync_enable_event {
        enum nrf_modem_dect_clock_sync_err err;
};
 
struct nrf_modem_dect_clock_sync_pulse_info_event {
        enum nrf_modem_dect_clock_sync_err err;
 
        uint16_t pulse_direction;
 
        uint8_t pad[2];
 
        uint64_t pulse_time;
};
 
struct nrf_modem_dect_clock_sync_disable_event {
        enum nrf_modem_dect_clock_sync_err err;
};
 
struct nrf_modem_dect_clock_sync_state_event {
        enum nrf_modem_dect_clock_sync_err err;
 
        bool synchronized;
 
        int16_t clock_std_ppm;
};
 
struct nrf_modem_dect_clock_sync_enable_ref_output_event {
        enum nrf_modem_dect_clock_sync_err err;
};
 
struct nrf_modem_dect_clock_sync_disable_ref_output_event {
        enum nrf_modem_dect_clock_sync_err err;
};
 
 
enum nrf_modem_dect_clock_sync_event_id {
        NRF_MODEM_DECT_CLOCK_SYNC_EVT_ENABLE,
        NRF_MODEM_DECT_CLOCK_SYNC_EVT_DISABLE,
        NRF_MODEM_DECT_CLOCK_SYNC_EVT_PULSE_INFO,
        NRF_MODEM_DECT_CLOCK_SYNC_EVT_STATE,
        NRF_MODEM_DECT_CLOCK_SYNC_EVT_ENABLE_REF_OUTPUT,
        NRF_MODEM_DECT_CLOCK_SYNC_EVT_DISABLE_REF_OUTPUT,
};
 
struct nrf_modem_dect_clock_sync_event {
        enum nrf_modem_dect_clock_sync_event_id id;
        union {
                struct nrf_modem_dect_clock_sync_enable_event clock_sync_enable;
                struct nrf_modem_dect_clock_sync_disable_event clock_sync_disable;
                struct nrf_modem_dect_clock_sync_pulse_info_event clock_sync_pulse_info;
                struct nrf_modem_dect_clock_sync_state_event clock_sync_state;
                struct nrf_modem_dect_clock_sync_enable_ref_output_event
                        clock_sync_enable_ref_output;
                struct nrf_modem_dect_clock_sync_disable_ref_output_event
                        clock_sync_disable_ref_output;
        };
};
 
typedef void (*nrf_modem_dect_clock_sync_event_handler_t)(
        const struct nrf_modem_dect_clock_sync_event *event);
 
int nrf_modem_dect_clock_sync_event_handler_set(nrf_modem_dect_clock_sync_event_handler_t handler);
 
enum nrf_modem_dect_clock_sync_pulse_direction {
        NRF_MODEM_DECT_CLOCK_SYNC_PULSE_INCOMING = 0,
        NRF_MODEM_DECT_CLOCK_SYNC_PULSE_OUTGOING = 1,
};
 
int nrf_modem_dect_clock_sync_enable(void);
 
int nrf_modem_dect_clock_sync_disable(void);
 
int nrf_modem_dect_clock_sync_get_pulse_info(
        enum nrf_modem_dect_clock_sync_pulse_direction direction);
 
int nrf_modem_dect_clock_sync_get_state(void);
 
int nrf_modem_dect_clock_sync_enable_ref_output(void);
 
int nrf_modem_dect_clock_sync_disable_ref_output(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NRF_MODEM_DECT_CLOCK_SYNC_H__ */