OCEOS/oceos logging

OCEOS Logging

OCEOS logs time stamped records of anomalies detected during execution.

Logging Introduction

OCEOS logging is structured as a circular buffer. System calls are provided to add entries the log, set its maximum size, and return the number of entries, and reset.

OCEOS does not change the log entries after reset, so if log area is located in non volatile memory, after reset, the application can read to recover possible reasons of failure. Only call to oceos_log_reset() can be used to reset all log entries if desired.

Log directives can be called from main() after oceos_init().

OCEOS will call a user defined function void oceos_on_full_log(void*) when the log is approximately 75% full.

Logging Configuration

Application defines arrays to hold OCEOS internal data. User must specified array to accommodate all logging information. Please read OCEOS data area layouts

#define LOG_DATA_ARRAY_SIZE_U32S                0x100// Calculated value. Read manual
U32_t log_data[LOG_DATA_ARRAY_SIZE_U32S];
...
/*
 * Create the application configuration structure
 */
struct application_configuration           app_config = {0};
app_config.log_address                   = (adrs_t)log_data;

User must define number of log entries.

API Functions

API Functions

Directive	Description	main	task	IRQ handler
oceos_log_add_entry()	Add a log entry	*	*	*
oceos_log_remove_entry()	Read and remove the oldest unread log entry	*	*	*
oceos_log_get_indexed_entry()	Read the log entry at the given index	*	*	*
oceos_log_reset()	Clear all log entries and reset to empty	*	*	*
oceos_log_get_size()	Get the number of log entries	*	*	*