port_view.h

/*
 * The programming ports as the screens see them, and the operator's asks
 * that change one (protocol 4.26).
 *
 * The control task reads the IOmcu's PROG page (prog_link.h) and hands
 * the UI task what each port holds: its PIN register, whether the IOmcu
 * refused that pin, and its FUNC.  OUTPUTS and PICK A PIN draw from this
 * view.  A port's PIN and FUNC are the IOmcu's, kept in its flash; a
 * screen changes one only by asking (port_view_ask()), which the control
 * task carries to prog_link_ask() and writes on a bench at rest.  The
 * outcome comes back here and the screens say it in words
 * (port_view_ask_line()).
 *
 * Until the page is read after a link-up the ports are not known: count
 * PORT_VIEW_UNKNOWN, no pin and no function.  A screen shows them as not
 * read, never as free.
 *
 * Pure state, no I/O.
 *
 * SPDX-License-Identifier: MIT
 */
#pragma once
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#include "link_pages.h"
#include "prog_link.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define PORT_VIEW_UNKNOWN 0xFFu
#define PORT_VIEW_NO_PIN  0xFFu
#define PORT_VIEW_FN_UNKNOWN 0xFFu
 
typedef struct {
    uint8_t count;                      
    bool    has_func;                   
    bool    has_dshot;                  
    uint8_t pin[LINK_PG_PORTS_MAX];     
    uint8_t func[LINK_PG_PORTS_MAX];    
    uint8_t refused;                    
} port_view_t;

void port_view_unknown(port_view_t *v);

void port_view_set(const port_view_t *v);
const port_view_t *port_view_get(void);
uint32_t port_view_revision(void);

bool port_view_has(uint8_t port);

uint8_t port_view_func(uint8_t port);

bool port_view_pwm(uint8_t port);

bool port_view_dshot(uint8_t port);

const char *port_view_fn_name(uint8_t fn);

typedef bool (*port_view_ask_fn)(uint8_t seq, uint8_t port,
                                 prog_link_ask_kind_t kind, uint16_t value);
void port_view_set_ask(port_view_ask_fn fn);

bool port_view_ask(uint8_t port, prog_link_ask_kind_t kind, uint16_t value);

void port_view_set_ask_state(uint8_t seq, prog_link_ask_state_t st);

prog_link_ask_state_t port_view_ask_state(uint8_t *port, uint8_t *kind);

uint8_t port_view_ask_seq(void);

bool port_view_ask_line(uint8_t port, char *buf, size_t cap);
 
#ifdef __cplusplus
}
#endif