busfault_screen.h

/*
 * The screen a bad CAN (Controller Area Network) bus gets at start-up.
 *
 * The panel runs the echo self-test once, before the bench is usable, and
 * shows this instead of the menu when the test does not pass.  It exists
 * because the fault it reports is not visible from any other screen: a bus
 * that does not carry frames looks exactly like an IOmcu that is not
 * there, and both look like a bench that simply shows no numbers.
 *
 * What it puts on the panel is the verdict, the counts behind it, and the
 * things to check in the order that costs least to check.  An operator with
 * no console and no meter can act on it.
 *
 * Leaving it takes a two-second hold, the ARM gesture: this is the one screen
 * that says the bench cannot be trusted, and an acknowledgement given by
 * brushing the panel is not one.
 *
 * SPDX-License-Identifier: MIT
 */
 
#ifndef RCBENCH_BUSFAULT_SCREEN_H
#define RCBENCH_BUSFAULT_SCREEN_H
 
#include <stdbool.h>
#include <stdint.h>
 
#include "can_selftest.h"
#include "ui_screen.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    BUSFAULT_SELFTEST = 0,
    BUSFAULT_LINK_LOST,
} busfault_kind_t;

typedef enum {
    BUSFAULT_BUS_UNKNOWN = 0, 
    BUSFAULT_BUS_RUNNING,     
    BUSFAULT_BUS_RECOVERING,  
    BUSFAULT_BUS_STOPPED,     
    BUSFAULT_BUS_OFF,         
} busfault_bus_t;

typedef struct {
    busfault_kind_t kind;
    can_selftest_verdict_t verdict;
 
    uint32_t sent;
    uint32_t echoed;
    uint32_t corrupt;
    uint32_t lost;
 
    uint32_t tx_errors;   
    uint32_t rx_errors;
    uint32_t bus_errors;
    bool     bus_off;
 
    /* --- BUSFAULT_LINK_LOST only ------------------------------------- */
    busfault_bus_t bus;        
    uint32_t       down_s;     
    uint32_t       recoveries; 
    uint32_t       polls;      
    uint32_t       timeouts;   
 
    bool     have_remote; 
    bool     remote_up;   
    uint8_t  remote_tx_errors;
    uint8_t  remote_rx_errors;
    uint8_t  remote_flags;
    uint16_t remote_overflows;
} busfault_report_t;

void busfault_screen_set(const busfault_report_t *r);

const busfault_report_t *busfault_screen_report(void);

bool busfault_screen_take_ack(void);
 
void busfault_screen_invalidate(void);

const char *busfault_verdict_text(can_selftest_verdict_t v);
 
const ui_screen_t *busfault_screen(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RCBENCH_BUSFAULT_SCREEN_H */