prog_link.h

Go to the documentation of this file.

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

#define PROG_LINK_POLL_MS 500u
#define PROG_LINK_NO_PIN 0xFFu
#define PROG_LINK_TARGET_UNKNOWN 0xFEu
#define PROG_LINK_TARGET_NO_LINK 0xFFu
#define PROG_LINK_CFG_REGS 3u

typedef enum {
    PROG_LINK_RATE_KEPT = 0,   
    PROG_LINK_RATE_RESET,      
    PROG_LINK_RATE_UNKNOWN,    
} prog_link_rate_t;

#define PROG_LINK_SEEN_NONE 0xFFu

typedef enum {
    PROG_LINK_ASK_PIN = 0,
    PROG_LINK_ASK_FUNC,
} prog_link_ask_kind_t;

typedef enum {
    PROG_LINK_ASK_IDLE = 0,    
    PROG_LINK_ASK_WAITING,     
    PROG_LINK_ASK_DONE,        
    PROG_LINK_ASK_REFUSED,     
    PROG_LINK_ASK_LOST,        
} prog_link_ask_state_t;

typedef struct {
    bool     up;                   
    bool     page;                 
    bool     target_rate;          
    uint8_t  seen;                 
    uint8_t  rate;                 
    bool     known;                
    bool     read_once;            
    uint32_t read_ms;                   
    uint16_t regs[LINK_PG_REGS];        
    uint8_t  want_target;          
    bool     want_pwm;                  
    bool     held;                 
    bool     func;                 
    bool     dshot;                
    uint8_t  ask_state;            
    uint8_t  ask_port;                  
    uint8_t  ask_kind;             
    uint16_t ask_value;            
    bool     reread;               
    bool     hitec;                
    uint8_t  hitec_held;           
} prog_link_t;

typedef struct {
    uint8_t  off;
    uint16_t value;
} prog_link_write_t;

void prog_link_init(prog_link_t *p);

void prog_link_came_up(prog_link_t *p, uint16_t minor);

void prog_link_lost(prog_link_t *p);

void prog_link_want(prog_link_t *p, uint8_t target, bool pwm);

void prog_link_hold(prog_link_t *p, bool held);
bool prog_link_held(const prog_link_t *p);

uint8_t prog_link_regs(const prog_link_t *p);

bool prog_link_has_func(const prog_link_t *p);

bool prog_link_has_dshot(const prog_link_t *p);

bool prog_link_ask(prog_link_t *p, uint8_t port, prog_link_ask_kind_t kind,
                   uint16_t value);

prog_link_ask_state_t prog_link_ask_state(const prog_link_t *p,
                                          uint8_t *port, uint8_t *kind,
                                          uint16_t *value);

bool prog_link_read_due(const prog_link_t *p, uint32_t now_ms);

bool prog_link_hitec_due(const prog_link_t *p);

void prog_link_hitec_read(prog_link_t *p, const uint16_t *state);

uint8_t prog_link_hitec_held(const prog_link_t *p);

void prog_link_read(prog_link_t *p, const uint16_t *regs, uint32_t now_ms);

void prog_link_stale(prog_link_t *p);

bool prog_link_next(const prog_link_t *p, bool quiet, prog_link_write_t *w);

uint8_t prog_link_pulse_on(const prog_link_t *p, const prog_link_write_t *w);

void prog_link_written(prog_link_t *p, const prog_link_write_t *w, bool ack);

uint8_t prog_link_wanted(const prog_link_t *p);

bool prog_link_ready(const prog_link_t *p);

uint8_t prog_link_target(const prog_link_t *p);

bool prog_link_pending(const prog_link_t *p);

bool prog_link_settled(const prog_link_t *p);

bool prog_link_command(const prog_link_t *p, bool release);

prog_link_rate_t prog_link_rate(prog_link_t *p);

bool prog_link_pwm(const prog_link_t *p);

#define PROG_LINK_COUNT_UNKNOWN 0xFFu

uint8_t prog_link_count(const prog_link_t *p);

uint8_t prog_link_pin(const prog_link_t *p, uint8_t port);

typedef struct {
    uint8_t pin;        
    uint8_t func;       
    bool    refused;    
} prog_link_port_t;

bool prog_link_port(const prog_link_t *p, uint8_t port, prog_link_port_t *out);

typedef struct {
    uint8_t target;     
    uint8_t pin;        
    bool    pwm;        
} prog_link_drive_t;

bool prog_link_no_drive(const prog_link_t *p);

prog_link_drive_t prog_link_drive(const prog_link_t *p);

void prog_link_cfg(const uint16_t *cc, uint16_t *out);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RCBENCH_PROG_LINK_H */