link_host.h

Go to the documentation of this file.

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

#define LINK_HOST_TIMEOUT_MS 1000u

typedef struct {
    /* The outstanding question, kept so an answer to an older one cannot be
     * mistaken for an answer to this one. */
    bool     pending;
    uint8_t  op;
    uint8_t  page;
    uint8_t  offset;
    uint8_t  count;
 
    uint32_t sent_ms;      
    uint32_t last_reply_ms;
    bool     escalated;
 
    uint32_t polls;
    uint32_t replies;
    uint32_t mismatches; 
    uint32_t nacks;
    uint32_t timeouts;   
 
    /*
     * Reassembly.  A CAN (Controller Area Network) frame carries four
     * registers, so a reply to a 13-register read arrives as four messages,
     * each with its own offset and count.  There is no sequence to follow
     * and no continuation to wait for: the window asked for is known here,
     * and a bit is set as each part of it lands.
     */
    uint16_t acc[LINK_MAX_REGS];
    uint32_t acc_seen;   
} link_host_t;

void link_host_init(link_host_t *h, uint32_t now_ms);

bool link_host_read(link_host_t *h, uint8_t page, uint8_t offset,
                    uint8_t count, uint32_t now_ms, link_msg_t *out);
bool link_host_write(link_host_t *h, uint8_t page, uint8_t offset,
                     uint8_t count, const uint16_t *regs, uint32_t now_ms,
                     link_msg_t *out);

bool link_host_accept(link_host_t *h, const link_msg_t *part, uint32_t now_ms,
                      link_msg_t *whole);

bool link_host_tick(link_host_t *h, uint32_t now_ms);

void link_host_abandon(link_host_t *h);

bool link_host_pending(const link_host_t *h);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RCBENCH_LINK_HOST_H */