blackbox_logger_config_t Struct Reference

BlackBox logger configuration structure. More...

#include <blackbox_logger.h>

Collaboration diagram for blackbox_logger_config_t:

Data Fields
esp_partition_t *	partition_ptr
blackbox_logger_parameters_t	parameters
const uint8_t	address_align
const uint64_t	flush_timer_timeout_us
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)
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)

Detailed Description

BlackBox logger configuration structure.

Field Documentation

address_align

const uint8_t blackbox_logger_config_t::address_align

Address alignment imposed by system

batch_buf_ptr

uint8_t* const blackbox_logger_config_t::batch_buf_ptr

Pointer to batch buffer

batch_buf_size

const size_t blackbox_logger_config_t::batch_buf_size

Batch buffer size

erase_func

esp_err_t(* blackbox_logger_config_t::erase_func) (const esp_partition_t *, size_t, size_t)

Erase flash function

flush_timer_timeout_us

const uint64_t blackbox_logger_config_t::flush_timer_timeout_us

One-shot timer timeout for flushing

on_replay_available_func

void(* blackbox_logger_config_t::on_replay_available_func) (void)

Callback for when replay available

parameters

blackbox_logger_parameters_t blackbox_logger_config_t::parameters

Parameters instance saved as recover hint

partition_ptr

esp_partition_t* blackbox_logger_config_t::partition_ptr

Point to logging partition

read_func

esp_err_t(* blackbox_logger_config_t::read_func) (const esp_partition_t *, size_t, void *const, size_t)

Read from flash function

sector_buf_ptr

uint8_t* const blackbox_logger_config_t::sector_buf_ptr

Pointer to sector buffer

sector_buf_size

const size_t blackbox_logger_config_t::sector_buf_size

Sector buffer size

write_func

esp_err_t(* blackbox_logger_config_t::write_func) (const esp_partition_t *, size_t, const void *const, size_t)

Write to flash function

---

The documentation for this struct was generated from the following file:

• components/blackbox_logger/include/blackbox_logger.h