hitec_pio.h

Go to the documentation of this file.

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

#define HITEC_PIO_CYCLES_PER_BIT 16u
#define HITEC_PIO_TICK_CYCLES 2u
#define HITEC_PIO_MIN_DIV 4u
#define HITEC_PIO_MAX_DIV 65535u
#define HITEC_PIO_SYNC_SYS_CYCLES 2u
#define HITEC_PIO_MAX_ERROR_PPM 500u

#define HITEC_PIO_LEAD_CYCLES 8u
#define HITEC_PIO_BYTE_CYCLES 157u
#define HITEC_PIO_ANSWER_CYCLES 165u
#define HITEC_PIO_ANSWER_CYCLES_TO_EDGE 160u
#define HITEC_PIO_ANSWER_BITS 10u
#define HITEC_PIO_ANSWER_DROP_BITS 6u
#define HITEC_PIO_DRAIN_CYCLES 2u

#define HITEC_PIO_PROGRAM_WORDS 30u
#define HITEC_PIO_IDLE_PC    1u
#define HITEC_PIO_BIT_PC     8u
#define HITEC_PIO_RELEASE_PC 11u
#define HITEC_PIO_ASK_PC     22u
#define HITEC_PIO_ANSWER_PC  24u
#define HITEC_PIO_DRAIN_PC   28u

#define HITEC_PIO_STAMP_BITS 23u
#define HITEC_PIO_MAX_WINDOW_TICKS ((1u << HITEC_PIO_STAMP_BITS) - 1u)
#define HITEC_PIO_MAX_LEAD ((1u << 30) - 1u)

#define HITEC_PIO_TX_WORDS 11u

typedef struct {
    uint32_t sys_hz;   
    uint32_t div256;   
    uint32_t err_ppm;  
    uint8_t  family;   
} hitec_pio_clock_t;

typedef struct {
    uint32_t window_ns;     
    uint32_t window_ticks;  
    uint32_t lead_ns;
    uint32_t span_us;
    uint8_t  family;        
    uint8_t  max_rx;        
    uint8_t  answer;        
} hitec_pio_run_t;

bool hitec_pio_clock(uint32_t sys_hz, uint8_t family, hitec_pio_clock_t *out);

uint32_t hitec_pio_bit_ns(const hitec_pio_clock_t *clock);

uint32_t hitec_pio_cycles_ns(const hitec_pio_clock_t *clock, uint64_t cycles);

unsigned hitec_pio_tx(const hitec_pio_clock_t *clock, uint8_t drive,
                      const hitec_xfer_t *xfer, uint32_t *words,
                      hitec_pio_run_t *run);

bool hitec_pio_answer_due(const hitec_pio_run_t *run, unsigned n,
                          unsigned pc);

void hitec_pio_capture(const hitec_pio_clock_t *clock,
                       const hitec_pio_run_t *run, const uint32_t *stamps,
                       unsigned n, bool full, bool lost, bool aborted,
                       bool cut, hitec_capture_t *out);
 
#ifdef __cplusplus
}
#endif
 
#endif /* HITEC_PIO_H */