fw_install.h

Go to the documentation of this file.

 
#ifndef RCBENCH_FW_INSTALL_H
#define RCBENCH_FW_INSTALL_H
 
#include <stdbool.h>
#include <stdint.h>
 
#include "fw_image.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define FW_WRITE_CHUNK (64u * 1024u)
 
/* ---------------------------------------------------------------- the gate */

typedef enum {
    FW_GATE_OPEN = 0,
    FW_GATE_ARMED,    
    FW_GATE_SUPPLY,   
    FW_GATE_RUN,      
    FW_GATE_DRAWING,  
    FW_GATE_COPROC,   
} fw_gate_t;

fw_gate_t fw_gate(bool armed, bool supply, bool run_open, bool drawing,
                  bool coproc);

bool fw_coproc_may_start(bool radio_down, bool installing);
 
/* ----------------------------------------------------------- the installer */

typedef struct {
    bool (*begin)(void *ctx, uint32_t bytes);
    bool (*write)(void *ctx, uint32_t off, const uint8_t *src, uint32_t len);
    bool (*finish)(void *ctx);
    void (*abort)(void *ctx);
    void *ctx;
} fw_flash_t;
 
typedef enum {
    FW_INSTALL_IDLE = 0,  
    FW_INSTALL_WAITING,   
    FW_INSTALL_RUNNING,   
    FW_INSTALL_DONE,      
    FW_INSTALL_FAILED,    
} fw_install_status_t;
 
typedef struct {
    const fw_flash_t *f;
    const uint8_t    *img;
    uint32_t          bytes;
    uint32_t          done;     
    bool              opened;   
    bool              touched;  
    bool              busy;
    fw_err_t          err;
    fw_offer_t        offer;
    fw_image_info_t   info;
} fw_install_t;

fw_err_t fw_install_begin(fw_install_t *in, const fw_flash_t *f,
                          const uint8_t *img, uint32_t bytes, uint32_t slot,
                          const fw_image_info_t *running);

fw_install_status_t fw_install_step(fw_install_t *in, bool quiet);

bool fw_install_finishing(const fw_install_t *in);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RCBENCH_FW_INSTALL_H */