tables.h

Go to the documentation of this file.

 
#ifndef ICARUS_TABLES_H
#define ICARUS_TABLES_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <stdbool.h>
 
/* ---- Configuration constants -------------------------------------------- */
 
#define TBL_MAX_REGISTERED  8    
#define TBL_MAX_SIZE        512  
#define TBL_NAME_LEN        12   
/* ---- Generic table id ---------------------------------------------------- */
 
typedef uint8_t tbl_id_t;
 
/* ---- Descriptor --------------------------------------------------------- */
 
typedef bool (*tbl_activate_fn)(const void *data, uint16_t len);
 
typedef struct {
    tbl_id_t        id;                 
    char            name[TBL_NAME_LEN]; 
    uint16_t        size;               
    uint16_t        schema_crc;         
    tbl_activate_fn activate;           
} tbl_descriptor_t;
 
/* ---- API ---------------------------------------------------------------- */
 
void     tbl_init(void);
 
bool     tbl_register(const tbl_descriptor_t *desc);
 
bool     tbl_load(tbl_id_t id, const uint8_t *data, uint16_t len,
                  uint16_t schema_crc);
 
bool     tbl_activate(tbl_id_t id);
 
int16_t  tbl_dump(tbl_id_t id, uint8_t *out, uint16_t max);
 
const tbl_descriptor_t *tbl_get_descriptor(tbl_id_t id);
 
uint8_t  tbl_count(void);
 
/* ---- Privileged implementations (internal — do not call directly) ----- */
 
void                    __tbl_init(void);
bool                    __tbl_register(const tbl_descriptor_t *desc);
bool                    __tbl_load(tbl_id_t id, const uint8_t *data,
                                   uint16_t len, uint16_t schema_crc);
bool                    __tbl_activate_prepare(tbl_id_t id, uint8_t *out_data,
                                               uint16_t *out_len,
                                               tbl_activate_fn *out_activate);
bool                    __tbl_activate_commit(tbl_id_t id, const uint8_t *data,
                                              uint16_t len);
int16_t                 __tbl_dump(tbl_id_t id, uint8_t *out, uint16_t max);
const tbl_descriptor_t *__tbl_get_descriptor(tbl_id_t id);
uint8_t                 __tbl_count(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ICARUS_TABLES_H */