kst_pio.h

Go to the documentation of this file.

#ifndef KST_PIO_H
#define KST_PIO_H
 
#include <stdbool.h>
#include <stdint.h>
 
#include "kst_wire.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define KST_PIO_TICK_CYCLES 4u
#define KST_PIO_BIT_OVERHEAD 4u
#define KST_PIO_LOW_OVERHEAD 2u
#define KST_PIO_SAMPLE_LEAD 3u
#define KST_PIO_SYNC_CYCLES 2u

#define KST_PIO_QUIET_NS 165000u

#define KST_PIO_MAX_TICK_NS 500u

#define KST_PIO_MAX_ERROR_PPM 2000u

#define KST_PIO_TX_WORDS 9u
#define KST_PIO_RX_WORDS (KST_CAP_MAX_EDGES + 2u)

typedef struct {
    uint32_t sys_hz;
    uint32_t half_cycles;     
    uint32_t release_cycles;  
    uint32_t quiet_ticks;               
} kst_pio_clock_t;

typedef struct {
    uint32_t window_ns;      
    uint32_t window_ticks;   
    uint32_t lead_ns;        
} kst_pio_run_t;

bool kst_pio_clock(uint32_t sys_hz, kst_pio_clock_t *out);

uint32_t kst_pio_half_cell_ns(const kst_pio_clock_t *clock);

uint32_t kst_pio_tick_ns(const kst_pio_clock_t *clock);

unsigned kst_pio_tx(const kst_pio_clock_t *clock, const kst_frame_t *frame,
                    uint32_t window_ns, uint32_t *words, kst_pio_run_t *run);

void kst_pio_capture(const kst_pio_clock_t *clock, const kst_pio_run_t *run,
                     const uint32_t *stamps, unsigned n, bool lost,
                     kst_capture_t *out);
 
#ifdef __cplusplus
}
#endif
 
#endif /* KST_PIO_H */