blackbox_logger_internal.h

Go to the documentation of this file.

 
#ifndef BLACKBOX_LOGGER_INTERNAL_H
#define BLACKBOX_LOGGER_INTERNAL_H
 
#include "blackbox_logger.h"
 
#include <stdint.h>
 
#define BLACKBOX_LOGGER_HEADER_MAGIC (0x5355424DUL) 
#define BLACKBOX_LOGGER_TAIL_MAGIC   (0x4D425553UL) 
#define BLACKBOX_LOGGER_ENTRY_SIZE_WITHOUT_DATA_LENGTH                                                       \
    (sizeof (blackbox_logger_entry_header_t) +                                                               \
     sizeof (blackbox_logger_entry_tail_t))           
#define BLACKBOX_LOGGER_WRITE_LOCK_TIMEOUT_MS  (50U)  
#define BLACKBOX_LOGGER_SECTOR_LOCK_TIMEOUT_MS (500U) 
typedef struct {
    uint32_t header_magic; 
    uint32_t id;           
    uint32_t length;       
} __attribute__ ((packed)) blackbox_logger_entry_header_t;
 
typedef struct {
    uint16_t crc;        
    uint32_t tail_magic; 
} __attribute__ ((packed)) blackbox_logger_entry_tail_t;
 
inline size_t align_num_up_helper (size_t number, size_t align_to)
{
    return ((number + (align_to - 1U)) & (~(align_to - 1U)));
}
 
inline size_t entry_total_size_helper (size_t data_length)
{
    return (BLACKBOX_LOGGER_ENTRY_SIZE_WITHOUT_DATA_LENGTH + data_length);
}
 
size_t entry_total_aligned_size_helper (size_t data_length, size_t align_to)
{
    return align_num_up_helper (BLACKBOX_LOGGER_ENTRY_SIZE_WITHOUT_DATA_LENGTH + data_length, align_to);
}
 
static inline bool is_logically_next_in_order_helper (uint32_t candidate, uint32_t reference)
{
    // Modular arithmetic for sequence numbers
    return (uint32_t) (candidate - reference) < 0x80000000U;
}
 
#endif