kst_port.h

Go to the documentation of this file.

#ifndef RCBENCH_KST_PORT_H
#define RCBENCH_KST_PORT_H
 
#include <stdbool.h>
#include <stdint.h>
 
#include "kst_session.h"
#include "link_pages.h"
#include "outputs.h"
#include "supply_page.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define KST_PORT_STOP_MS 50u
#define KST_PORT_LOW_MS 100u
#define KST_PORT_RAIL_OFF_MS 2000u
#define KST_PORT_RAIL_WAIT_MS 1000u
#define KST_PORT_SUPPLY_MS 3000u
#define KST_PORT_SUPPLY_MAX_MV 8400u
#define KST_PORT_SUPPLY_MIN_MV 4800u

typedef struct {
    void *ctx;
    uint8_t ports;
    uint8_t (*pin)(void *ctx, uint8_t port);
    bool (*take)(void *ctx, uint8_t port, uint8_t pin);
    void (*give)(void *ctx);
    void (*supply)(void *ctx, supply_port_view_t *out);
    bool (*supply_set)(void *ctx, bool on, uint16_t mv, uint16_t ma);
    kst_driver_t driver;
} kst_port_hw_t;

typedef struct {
    kst_port_hw_t hw;
    kst_session_t session;
    kst_image_t work;    
    uint16_t staged[LINK_KS_W_STAGED];  
    uint16_t last_cmd[LINK_KS_W_CMD_FRAME];  
    uint32_t t0_ms;                     
    uint32_t t1_ms;                     
    uint16_t seq;                       
    uint16_t frames;                    
    uint16_t supply_mv;  
    uint16_t supply_ma;                 
    uint16_t want_mv;    
    uint16_t want_ma;                   
    uint16_t back_mv;    
    uint16_t back_ma;                   
    uint16_t leave_ms;   
    uint16_t wait_ms;    
    uint8_t  state;      
    uint8_t  port;                      
    uint8_t  pin;                       
    uint8_t  op;         
    uint8_t  result;     
    uint8_t  refusal;    
    uint8_t  fail_reg;                  
    uint8_t  steps_done;                
    uint8_t  seen_step;                 
    uint8_t  busy;       
    uint8_t  running;    
    uint8_t  leaving;    
    uint8_t  framed;     
    uint8_t  must_read;                 
    uint8_t  view;                      
    uint8_t  safe;                      
    uint8_t  armed;       
    uint8_t  other;      
    uint8_t  has_pin;    
    uint8_t  sup;        
    uint8_t  on_here;    
    uint8_t  watch;      
    uint8_t  again;      
    uint8_t  from_pwm;   
} kst_port_t;

bool kst_port_init(kst_port_t *p, const kst_port_hw_t *hw);

uint8_t kst_port_write(kst_port_t *p, uint8_t off, uint8_t n,
                       const uint16_t *in, uint32_t now_ms);

void kst_port_read(const kst_port_t *p, uint8_t off, uint8_t n,
                   uint16_t *out);

void kst_port_step(kst_port_t *p, bool safe, bool stop, uint32_t now_ms);

link_kst_state_t kst_port_state(const kst_port_t *p);

uint8_t kst_port_quiet_mask(const kst_port_t *p);

bool kst_port_frame_out(const kst_port_t *p);

void kst_port_bench_armed(kst_port_t *p, bool armed);

void kst_port_other_mask(kst_port_t *p, uint8_t mask);

uint8_t kst_port_pin_mask(const kst_port_t *p);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RCBENCH_KST_PORT_H */