fw_boot.h

/*
 * The first start after an update: keep the new build, or go back.
 *
 * The bootloader is built with rollback: a build's first start is a trial
 * (pending verify), and a restart while it still is starts the build
 * before it.  fw_boot_decide() is the order of the calls that settle the
 * trial; the calls themselves are the panel's (fw_ota.c), so the host
 * suite runs the order against fakes.
 *
 * A failed start is never kept.  When marking it invalid returns -- the
 * call restarts on success -- the panel restarts anyway, which leaves the
 * trial unconfirmed and so goes back too.  Marking a good start valid can
 * fail: the build then runs this once, and the next start goes back.
 *
 * Pure C, no ESP-IDF (Espressif Internet-of-Things Development Framework).
 *
 * SPDX-License-Identifier: MIT
 */
 
#ifndef RCBENCH_FW_BOOT_H
#define RCBENCH_FW_BOOT_H
 
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
    FW_BOOT_NORMAL = 0,
    FW_BOOT_UPDATED,      
    FW_BOOT_ROLLED_BACK,  
    FW_BOOT_UNCONFIRMED,  
} fw_boot_t;
 
typedef struct {
    bool (*pending)(void *ctx);
    void (*mark_invalid)(void *ctx);
    bool (*mark_valid)(void *ctx);
    void (*restart)(void *ctx);
    bool (*last_invalid)(void *ctx);
    void *ctx;
} fw_boot_ops_t;

fw_boot_t fw_boot_decide(const fw_boot_ops_t *ops, bool ui_up, bool noted);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RCBENCH_FW_BOOT_H */