blackbox_logger.h

Go to the documentation of this file.

 
#ifndef BLACKBOX_LOGGER_H
#define BLACKBOX_LOGGER_H
 
#include "esp_partition.h"
#include "esp_timer.h"
#include "freertos/FreeRTOS.h"
#include "freertos/semphr.h"
 
#include <stdint.h>
 
typedef enum {
    BLACKBOX_LOGGER_OK,                
    BLACKBOX_LOGGER_ERR_FAIL,          
    BLACKBOX_LOGGER_ERR_INVALID_ARG,   
    BLACKBOX_LOGGER_ERR_NO_MEM,        
    BLACKBOX_LOGGER_ERR_TIMEOUT,       
    BLACKBOX_LOGGER_ERR_INVALID_CRC,   
    BLACKBOX_LOGGER_ERR_INVALID_ENTRY, 
    BLACKBOX_LOGGER_ERR_ERASE_FAIL,    
    BLACKBOX_LOGGER_ERR_WRITE_FAIL,    
    BLACKBOX_LOGGER_ERR_PROCESS_FAIL,  
} blackbox_logger_err_t;
 
typedef struct {
    uint8_t *data_ptr; 
    size_t length;     
} blackbox_logger_entry_view_t;
 
typedef bool (*blackbox_logger_iter_cb_t) (
    void *, const blackbox_logger_entry_view_t *); 
typedef struct {
    uint32_t write_offset;  
    uint32_t replay_offset; 
    uint32_t last_id;       
    bool is_dirty;          
} blackbox_logger_parameters_t;
 
typedef struct {
    esp_partition_t *partition_ptr;          
    blackbox_logger_parameters_t parameters; 
    const uint8_t address_align;           
    const uint64_t flush_timer_timeout_us; 
    // Pointers/Sizes to user-allocated buffers
    uint8_t *const sector_buf_ptr; 
    const size_t sector_buf_size;  
    uint8_t *const batch_buf_ptr;  
    const size_t batch_buf_size;   
    void (*on_replay_available_func) (void); 
    // Driver hooks
    esp_err_t (*write_func) (const esp_partition_t *,
                             size_t,
                             const void *const,
                             size_t); 
    esp_err_t (*read_func) (const esp_partition_t *,
                            size_t,
                            void *const,
                            size_t);                                   
    esp_err_t (*erase_func) (const esp_partition_t *, size_t, size_t); 
} blackbox_logger_config_t;
 
typedef struct {
    // Configuration
    blackbox_logger_config_t *config_ptr; 
    // Logger states
    uint32_t write_offset;      
    uint32_t replay_offset;     
    uint32_t last_id;           
    int32_t last_erased_sector; 
    size_t batch_len;           
    // Flags and OS handles
    SemaphoreHandle_t sector_buf_lock; 
    SemaphoreHandle_t write_lock;      
    esp_timer_handle_t flush_timer;    
} blackbox_logger_t;
 
blackbox_logger_err_t blackbox_logger_init (blackbox_logger_t *logger_ptr,
                                            blackbox_logger_config_t *config_ptr);
 
blackbox_logger_err_t blackbox_logger_write (blackbox_logger_t *logger_ptr,
                                             const blackbox_logger_entry_view_t *entry_ptr);
 
blackbox_logger_err_t blackbox_logger_read (const blackbox_logger_t *logger_ptr,
                                            uint32_t read_offset,
                                            blackbox_logger_entry_view_t *entry_ptr,
                                            size_t entry_buf_max_capacity);
 
blackbox_logger_err_t blackbox_logger_flush (blackbox_logger_t *logger_ptr);
 
blackbox_logger_err_t blackbox_logger_next_replay (blackbox_logger_t *logger_ptr,
                                                   blackbox_logger_iter_cb_t is_entry_processed_cb_func,
                                                   void *cb_arg_void_ptr,
                                                   blackbox_logger_entry_view_t *entry_ptr,
                                                   const size_t entry_buf_max_capacity);
 
blackbox_logger_err_t blackbox_logger_iterate_replay (blackbox_logger_t *logger_ptr,
                                                      blackbox_logger_iter_cb_t is_entry_processed_cb_func,
                                                      void *cb_arg_void_ptr,
                                                      blackbox_logger_entry_view_t *entry_ptr,
                                                      const size_t entry_buf_max_capacity);
 
void blackbox_logger_get_parameters_defaults (blackbox_logger_parameters_t *parameter_ptr);
 
bool blackbox_logger_has_replay_data (const blackbox_logger_t *logger_ptr);
 
void blackbox_logger_deinit (blackbox_logger_t *logger_ptr);
 
#endif