fw_image.h

Go to the documentation of this file.

 
#ifndef RCBENCH_FW_IMAGE_H
#define RCBENCH_FW_IMAGE_H
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#include "fw_sha256.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define FW_HEAD_BYTES     288u
#define FW_IMAGE_MAGIC    0xE9u  
#define FW_CHIP_ESP32P4   0x0012u
#define FW_DESC_MAGIC     0xABCD5432uL  
#define FW_PROJECT        "rcbench-panel"
#define FW_TEXT_MAX       32u
#define FW_MAX_SEGMENTS   16u

typedef struct {
    uint16_t major;
    uint16_t minor;
    uint16_t patch;
} fw_version_t;

typedef enum {
    FW_OK = 0,
    FW_ERR_EMPTY,      
    FW_ERR_SHORT,      
    FW_ERR_TOO_BIG,    
    FW_ERR_NOT_IMAGE,  
    FW_ERR_CHIP,       
    FW_ERR_NO_DESC,    
    FW_ERR_PROJECT,    
    FW_ERR_VERSION,    
    FW_ERR_NO_HASH,    
    FW_ERR_LENGTH,     
    FW_ERR_HASH,       
    FW_ERR_READ,       
    FW_ERR_RUNNING,    
    FW_ERR_MEMORY,     
    FW_ERR_FLASH,      
    FW_ERR_BUSY,       
    FW_ERR_COUNT
} fw_err_t;

typedef struct {
    uint32_t     bytes;
    fw_version_t version;
    char         version_text[FW_TEXT_MAX];
    uint8_t      elf_sha[FW_SHA256_BYTES];
} fw_image_info_t;

const char *fw_err_str(fw_err_t e);

bool fw_version_parse(const char *text, size_t n, fw_version_t *out);

int fw_version_cmp(fw_version_t a, fw_version_t b);

fw_err_t fw_image_head(const uint8_t *head, uint32_t have, uint32_t bytes,
                       uint32_t slot, fw_image_info_t *out);

fw_err_t fw_image_check(const uint8_t *img, uint32_t bytes, uint32_t slot,
                        fw_image_info_t *out);
 
/* ------------------------------------------------------ against the panel */

typedef enum {
    FW_OFFER_NEWER = 0,  
    FW_OFFER_OLDER,      
    FW_OFFER_REBUILD,    
    FW_OFFER_INSTALLED,  
} fw_offer_t;

fw_offer_t fw_offer(const fw_image_info_t *running,
                    const fw_image_info_t *image);

bool fw_offer_installable(fw_offer_t o);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RCBENCH_FW_IMAGE_H */