timer_capture.h

Go to the documentation of this file.

#ifndef NEXUS_IO_TIMER_CAPTURE_H
#define NEXUS_IO_TIMER_CAPTURE_H
#include "nexus/core/time.h"
#ifdef __cplusplus
extern "C" {
#endif
enum nx_timer_capture_flags {
    NX_TIMER_CAPTURE_OVERCAPTURE = 1U,
    NX_TIMER_CAPTURE_RING_LOSS = 2U
};

typedef struct {
    nx_time_us_t observed_at;
    uint32_t captured_ticks;
    uint32_t flags;
} nx_timer_capture_event_t;

typedef struct {
    uint32_t tick_hz;
    uint32_t loss_incidents;
    size_t pending;
    uint8_t counter_bits;
    bool running;
    bool draining;
} nx_timer_capture_state_t;

typedef struct {
    nx_result_t (*start)(void* context, nx_timer_capture_event_t* events,
                         size_t capacity);
    nx_result_t (*stop)(void* context);
    nx_result_t (*read)(void* context, nx_timer_capture_event_t* event);
    nx_result_t (*state)(const void* context, nx_timer_capture_state_t* state);
} nx_timer_capture_ops_t;

typedef struct {
    const nx_timer_capture_ops_t* ops;
    void* context;
} nx_timer_capture_t;

nx_result_t nx_timer_capture_start(const nx_timer_capture_t* port,
                                   nx_timer_capture_event_t* events,
                                   size_t capacity);
nx_result_t nx_timer_capture_stop(const nx_timer_capture_t* port);
nx_result_t nx_timer_capture_read(const nx_timer_capture_t* port,
                                  nx_timer_capture_event_t* event);
nx_result_t nx_timer_capture_state(const nx_timer_capture_t* port,
                                   nx_timer_capture_state_t* state);
#ifdef __cplusplus
}
#endif
#endif