hitec_pre.h

Go to the documentation of this file.

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

typedef enum {
    HITEC_RX_PULL_UP = 0,
    HITEC_RX_PRECHARGE = 1,
} hitec_rx_mode_t;

#define HITEC_PRE_SAMPLES_PER_BIT 8u
#define HITEC_PRE_CHARGE_NS 100u
#define HITEC_PRE_SAMPLE_NS 113u
#define HITEC_PRE_CHARGE_MIN_NS 7u
#define HITEC_PRE_CHARGE_MAX_NS 200u
#define HITEC_PRE_SAMPLE_MIN_NS 40u
#define HITEC_PRE_SAMPLE_MAX_NS 187u
#define HITEC_PRE_MIN_HZ  48000000u
#define HITEC_PRE_MAX_HZ 250000000u
#define HITEC_PRE_WINDOW_MAX_US 30000u
#define HITEC_PRE_WORDS 928u
#define HITEC_PRE_PROGRAM_MAX 12u
#define HITEC_PRE_FRAME_BITS 10u

typedef struct {
    uint32_t sys_hz;    
    uint32_t period;    
    uint32_t charge;    
    uint32_t wait;      
    uint32_t spb_q16;   
    uint16_t mid[HITEC_PRE_FRAME_BITS];
} hitec_pre_timing_t;

bool hitec_pre_timing(uint32_t sys_hz, hitec_pre_timing_t *out);

uint32_t hitec_pre_cycles_ns(const hitec_pre_timing_t *t, uint64_t cycles);

unsigned hitec_pre_program(const hitec_pre_timing_t *t, uint16_t *words,
                           unsigned max);

uint32_t hitec_pre_window_samples(const hitec_pre_timing_t *t,
                                  uint32_t window_us);

uint32_t hitec_pre_words(const hitec_pre_timing_t *t, uint32_t window_us,
                         uint8_t max_rx);

static inline unsigned hitec_pre_sample(const uint32_t *words, uint32_t k)
{
    return (unsigned)((words[k >> 5] >> (31u - (k & 31u))) & 1u);
}
 
/* --- the decoder ---------------------------------------------------------- */

typedef enum {
    HITEC_PRE_WAIT_REST = 0,  
    HITEC_PRE_WAIT_START,     
    HITEC_PRE_IN_BYTE,        
    HITEC_PRE_DEC_DONE,       
} hitec_pre_dec_phase_t;

typedef enum {
    HITEC_PRE_END_NONE = 0,   
    HITEC_PRE_END_FULL,       
    HITEC_PRE_END_WINDOW,     
    HITEC_PRE_END_SHORT,      
} hitec_pre_end_t;

typedef struct {
    uint32_t window;          
    uint32_t at;              
    uint32_t waited;          
    uint32_t start[HITEC_RX_MAX]; 
    uint8_t  value[HITEC_RX_MAX];  
    uint16_t framing;         
    uint8_t  n;               
    uint8_t  max_rx;          
    uint8_t  phase;           
    uint8_t  end;             
} hitec_pre_dec_t;

void hitec_pre_dec_init(hitec_pre_dec_t *d, const hitec_pre_timing_t *t,
                        uint32_t window_us, uint8_t max_rx);

bool hitec_pre_dec_feed(hitec_pre_dec_t *d, const hitec_pre_timing_t *t,
                        const uint32_t *words, uint32_t n_words);

void hitec_pre_dec_close(hitec_pre_dec_t *d);
 
/* --- the run -------------------------------------------------------------- */

typedef enum {
    HITEC_PRE_PLAN_LINE = 0,
    HITEC_PRE_PLAN_SEND,
    HITEC_PRE_PLAN_LISTEN,
    HITEC_PRE_PLAN_REFUSE,
} hitec_pre_plan_t;

typedef enum {
    HITEC_PRE_IDLE = 0,       
    HITEC_PRE_TX,             
    HITEC_PRE_SAMPLE,         
    HITEC_PRE_DONE,           
} hitec_pre_phase_t;

typedef struct {
    hitec_pre_dec_t dec;      
    uint32_t words;           
    uint32_t window_ns;       
    uint8_t  phase;           
    uint8_t  aborted;         
    uint8_t  lost;            
} hitec_pre_run_t;

hitec_pre_plan_t hitec_pre_begin(hitec_pre_run_t *r,
                                 const hitec_pre_timing_t *t,
                                 const hitec_xfer_t *x);

void hitec_pre_tx_xfer(const hitec_xfer_t *x, hitec_xfer_t *out);

void hitec_pre_tx_done(hitec_pre_run_t *r);

bool hitec_pre_step(hitec_pre_run_t *r, const hitec_pre_timing_t *t,
                    const uint32_t *words, uint32_t n_words, bool all_in);

void hitec_pre_abort(hitec_pre_run_t *r, const hitec_pre_timing_t *t,
                     const uint32_t *words, uint32_t n_words);

void hitec_pre_lost(hitec_pre_run_t *r);

void hitec_pre_capture(const hitec_pre_run_t *r, const hitec_pre_timing_t *t,
                       int32_t offset_ns, hitec_capture_t *out);
 
#ifdef __cplusplus
}
#endif
 
#endif /* HITEC_PRE_H */