supply_link.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdbool.h>
#include <stdint.h>
 
#include "link_pages.h"
#include "supply.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define SUPPLY_CAPS_PDMINI { 1.0f, 20.0f, 0.01f, 0.05f, 3.0f, 0.01f }

#define SUPPLY_LINK_STALE_MS 1500u
#define SUPPLY_LINK_BLIND_MS (2u * SUPPLY_LINK_STALE_MS)
#define SUPPLY_LINK_READ_MS  100u

#define SUPPLY_LINK_BAUD_AUTO 7u

typedef struct {
    bool    en;
    int8_t  tx, rx;   
    uint8_t baud;     
} supply_wiring_t;

#define SUPPLY_LINK_NO_ANSWER (-1)
#define SUPPLY_LINK_ACK       0

enum {
    SUPPLY_LINK_EV_WIRING_REFUSED = 0x01,  
    SUPPLY_LINK_EV_ON_REFUSED     = 0x02,  
    SUPPLY_LINK_EV_ON_LOST        = 0x04,  
    SUPPLY_LINK_EV_STUCK          = 0x08,  
    SUPPLY_LINK_EV_SET_STUCK      = 0x10,  
    SUPPLY_LINK_EV_TRIPPED        = 0x20,  
    SUPPLY_LINK_EV_BAUD_FOUND     = 0x40,  
    SUPPLY_LINK_EV_SAGGED         = 0x80,  
    SUPPLY_LINK_EV_WIRING_LIVE    = 0x100, 
};

typedef enum {
    SUPPLY_LINK_W_NONE = 0,
    SUPPLY_LINK_W_OFF,
    SUPPLY_LINK_W_WIRING,
    SUPPLY_LINK_W_COMMAND,
    SUPPLY_LINK_W_RESET,
} supply_link_write_t;

typedef struct {
    /* What is asked. */
    supply_wiring_t want;
    bool     on;
    uint16_t mv, ma;
 
    /* What the page holds, as written and acknowledged since the last
     * time it was known. */
    bool     wired;          /* page.wiring holds `want` as it was then */
    bool     wire_wait;      /* page.wiring acknowledged, not yet read held */
    supply_wiring_t page;
    bool     refused;        /* `want` was refused; not written again   */
    bool     commanded;      /* the page holds page_on, page_mv, page_ma */
    bool     page_on;
    uint16_t page_mv, page_ma;
 
    /* The write in flight. */
    supply_link_write_t pending;
    uint16_t out[LINK_SP_FLAGS];
 
    /* The last read. */
    uint16_t regs[LINK_SP_COUNT];
    bool     read_any;
    bool     asked;          /* a read was asked for since it was known */
    uint32_t read_ms;
    uint32_t asked_ms;       /* when the last read was asked for        */
    /* The module's readings: SAMPLES as last read, and the page read that
     * first showed it.  A page read whose SAMPLES did not move brings no
     * new reading -- a display read on the IOmcu that was slow or
     * failed -- however fresh the page itself is. */
    uint16_t samples_seen;
    uint32_t sample_ms;
 
    uint16_t events;
    uint8_t  found;          /* the rate AUTO last reported, 7 none    */
    /* The input and the set point, in mV, on the read that first showed
     * the output switched off for a sagging input (FLAGS bit 10). */
    uint16_t sag_vin_mv, sag_set_mv;
    bool     reset_owed;     /* a module restart asked, not yet written */
    bool     port_held;      /* the last read had LINK_SP_PORT set      */
    bool     judge;          /* set points refused on an output that is
                                on: the next read says by whom           */
    bool     adopted;        /* on, mv, ma were taken from the page and
                                not yet handed out                      */
} supply_link_t;

void supply_link_init(supply_link_t *s);

void supply_link_lost(supply_link_t *s);

void supply_link_wire(supply_link_t *s, const supply_wiring_t *w);

void supply_link_command(supply_link_t *s, bool on, uint16_t mv, uint16_t ma);

void supply_link_reset(supply_link_t *s);

supply_link_write_t supply_link_next(supply_link_t *s, uint8_t *off,
                                     uint8_t *n, uint16_t *regs);

void supply_link_written(supply_link_t *s, int result);

bool supply_link_settled(const supply_link_t *s);

bool supply_link_event_stands(const supply_link_t *s, uint16_t ev);

bool supply_link_read_due(const supply_link_t *s, uint32_t now_ms);

void supply_link_read(supply_link_t *s, const uint16_t *regs,
                      uint32_t now_ms);

void supply_link_state(const supply_link_t *s, uint32_t now_ms,
                       supply_state_t *st);

bool supply_link_blind(const supply_link_t *s, uint32_t now_ms);

bool supply_link_adopted(supply_link_t *s, bool *on, uint16_t *mv,
                         uint16_t *ma);

uint16_t supply_link_events(supply_link_t *s);

void supply_link_sag(const supply_link_t *s, uint16_t *vin_mv,
                     uint16_t *set_mv);

typedef struct {
    bool     seen;
    unsigned edits, word;
} supply_link_follow_t;

bool supply_link_wiring_moved(supply_link_follow_t *f, unsigned edits,
                              unsigned word);

bool supply_link_held_pins(const supply_link_t *s, int *tx, int *rx);

bool supply_link_port_held(const supply_link_t *s);
 
#ifdef __cplusplus
}
#endif