logger.h

Go to the documentation of this file.

 
#ifndef INFUSE_SDK_INCLUDE_INFUSE_DATA_LOGGER_LOGGER_H_
#define INFUSE_SDK_INCLUDE_INFUSE_DATA_LOGGER_LOGGER_H_
 
#include <stdint.h>
 
#include <infuse/types.h>
#include <infuse/epacket/interface.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct data_logger_state {
        /* Bytes logged since reboot */
        uint64_t bytes_logged;
        /* Number of logical blocks on the logger */
        uint32_t logical_blocks;
        /* Number of physical blocks on the logger */
        uint32_t physical_blocks;
        /* Number of blocks present at boot */
        uint32_t boot_block;
        /* Number of logical blocks that have been written */
        uint32_t current_block;
        /* Earliest logical block that still exists on the logger */
        uint32_t earliest_block;
        /* Size of a single block in bytes */
        uint16_t block_size;
        /* Number of bytes at the start of the block that should not contain data */
        uint16_t block_overhead;
        /* Minimum erase unit of the logger in bytes */
        uint16_t erase_unit;
        /* Writes require the full block size to be provided */
        bool requires_full_block_write;
};
 
/* Header on every block logged to persistent storage */
struct data_logger_persistent_block_header {
        /* One byte wrap count (1 - 254) */
        uint8_t block_wrap;
        /* Type of block data */
        uint8_t block_type;
} __packed;
 
struct data_logger_cb {
        void (*block_size_update)(const struct device *dev, uint16_t block_size, void *user_data);
        void (*write_failure)(const struct device *dev, enum infuse_type data_type, const void *mem,
                              uint16_t mem_len, int reason, void *user_data);
        /* Arbitrary user data pointer */
        void *user_data;
        /* Private list iteration field */
        sys_snode_t node;
};
 
#define DATA_LOGGER_DEPENDENCIES_MET(node_id)                                                      \
        COND_CODE_1(DT_NODE_HAS_COMPAT(node_id, embeint_data_logger_epacket),                      \
                    (EPACKET_INTERFACE_IS_COMPILED_IN(DT_PROP(node_id, epacket))), (1))
 
#define DATA_LOGGER_MAX_SIZE(node_id)                                                              \
        COND_CODE_1(                                                                               \
                DT_NODE_HAS_COMPAT(node_id, embeint_data_logger_flash_map), (512),                 \
                (COND_CODE_1(DT_NODE_HAS_COMPAT(node_id, embeint_data_logger_epacket),             \
                             (EPACKET_INTERFACE_MAX_PAYLOAD(DT_PROP(node_id, epacket))),           \
                             ((COND_CODE_1(DT_NODE_HAS_COMPAT(node_id, embeint_data_logger_exfat), \
                                           (512), ()))))))
 
void data_logger_get_state(const struct device *dev, struct data_logger_state *state);
 
int data_logger_block_write(const struct device *dev, enum infuse_type type, void *block,
                            uint16_t block_len);
 
int data_logger_block_read(const struct device *dev, uint32_t block_idx, uint16_t block_offset,
                           void *block, uint16_t block_len);
 
int data_logger_erase(const struct device *dev, bool erase_all,
                      void (*erase_progress)(uint32_t blocks_erased));
 
int data_logger_flush(const struct device *dev);
 
void data_logger_register_cb(const struct device *dev, struct data_logger_cb *cb);
 
#ifdef CONFIG_ZTEST
 
void data_logger_set_erase_state(const struct device *dev, bool enabled);
 
#endif /* CONFIG_ZTEST */
 
#ifdef __cplusplus
}
#endif
 
#endif /* INFUSE_SDK_INCLUDE_INFUSE_DATA_LOGGER_LOGGER_H_ */