art_store.h

Go to the documentation of this file.

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

#define ART_SLOT_BYTES  (16u * 1024u)

typedef struct {
    bool (*read)(void *ctx, uint32_t off, void *dst, uint32_t len);
    bool (*erase)(void *ctx, uint32_t off, uint32_t len);
    bool (*write)(void *ctx, uint32_t off, const void *src, uint32_t len);
    void    *ctx;
    uint32_t size;    
    uint32_t sector;  
} art_flash_t;

typedef struct {
    uint16_t board;
    uint16_t format;  
    uint16_t width;                     
    uint16_t height;                    
    uint16_t crc;     
    uint32_t hash;    
    uint32_t bytes;                     
} art_entry_t;

bool art_entry_same(const art_entry_t *a, const art_entry_t *b);

uint32_t art_store_slots(const art_flash_t *f);

uint32_t art_store_capacity(const art_flash_t *f);

bool art_store_find(const art_flash_t *f, uint16_t board, art_entry_t *out);

bool art_store_read(const art_flash_t *f, uint16_t board, uint8_t *dst,
                    uint32_t cap);

bool art_store_read_same(const art_flash_t *f, const art_entry_t *key,
                         uint8_t *dst, uint32_t cap);

bool art_store_put(const art_flash_t *f, uint16_t board,
                   const art_entry_t *entry, const uint8_t *payload);

bool art_store_forget(const art_flash_t *f, uint16_t board);
 
/* ------------------------------------------------- a keep, a sector at a time */

#define ART_KEEP_READ_BYTES 256u

typedef enum {
    ART_KEEP_IDLE = 0,  
    ART_KEEP_WAITING,   
    ART_KEEP_RUNNING,   
    ART_KEEP_DONE,      
    ART_KEEP_FAILED,    
} art_keep_status_t;

typedef struct {
    const art_flash_t *f;
    const uint8_t     *payload;
    art_entry_t        entry;
    uint16_t           board;
    uint8_t            phase;    
    uint32_t           at;       
    uint32_t           span;     
    uint32_t           done;     
    uint16_t           crc;      
    uint32_t           hash;     
    uint8_t            buf[ART_KEEP_READ_BYTES];  
} art_keep_t;

bool art_keep_begin(art_keep_t *k, const art_flash_t *f, uint16_t board,
                    const art_entry_t *entry, const uint8_t *payload);

art_keep_status_t art_keep_step(art_keep_t *k, bool may_write);

bool art_keep_busy(const art_keep_t *k);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RCBENCH_ART_STORE_H */