sternum_trace_api.h

Go to the documentation of this file.

 
#ifndef __STERNUM_TRACE_API_H__
#define __STERNUM_TRACE_API_H__
 
#ifdef __cplusplus
 extern "C" {
#endif
 
#include <stdint.h>
#include <stdbool.h>
#include <stdlib.h>
 
#include "trace_protocol_user_definition.h"
#include "error_codes.h"
#include "device_type.h"
 
 
#define STERNUM_ADS_TRACE(TRACE, ...)                       sternum_trace_dynamic(TRACE, ## __VA_ARGS__, END_OF_ARGUMENTS)
#define STERNUM_ADS_TRACEF(TRACE, ARG_ROLE, MAX_LENGTH, FORMAT, ...)    sternum_trace_string_format(TRACE, ARG_ROLE, MAX_LENGTH, FORMAT, ## __VA_ARGS__)
 
 
#define END_OF_ARGUMENTS 0
#define POINTER_DEREFERENCE_INDICATOR 0x8000
#define UNSIGNED_INTEGER_TYPE 0
#define SIGNED_INTEGER_TYPE 1
#define FLOAT_TYPE 2
#define POINTER_TYPE 3
#define BLOB_TYPE (4 | POINTER_DEREFERENCE_INDICATOR)
#define STRING_TYPE (5 | POINTER_DEREFERENCE_INDICATOR)
 
#define ARGUMENT_STRING(ARG_ROLE, MAX_SIZE, ARG_VALUE)  (unsigned int)ARG_ROLE, (unsigned int)STRING_TYPE,              (unsigned int)MAX_SIZE,             (char*)(ARG_VALUE)
#define ARGUMENT_BLOB(ARG_ROLE, SIZE, ARG_VALUE)        (unsigned int)ARG_ROLE, (unsigned int)BLOB_TYPE,                (unsigned int)SIZE,                 (uint8_t*)(ARG_VALUE)
#define ARGUMENT_INTEGER(ARG_ROLE, ARG_VALUE)           (unsigned int)ARG_ROLE, (unsigned int)SIGNED_INTEGER_TYPE,      (unsigned int)sizeof(ARG_VALUE),    (ARG_VALUE)
#define ARGUMENT_UINTEGER(ARG_ROLE, ARG_VALUE)          (unsigned int)ARG_ROLE, (unsigned int)UNSIGNED_INTEGER_TYPE,    (unsigned int)sizeof(ARG_VALUE),    (ARG_VALUE)
#define ARGUMENT_POINTER(ARG_ROLE, ARG_VALUE)           (unsigned int)ARG_ROLE, (unsigned int)POINTER_TYPE,             (unsigned int)sizeof(ARG_VALUE),    (ARG_VALUE)
#define ARGUMENT_FLOAT(ARG_ROLE, ARG_VALUE)             (unsigned int)ARG_ROLE, (unsigned int)FLOAT_TYPE,               (unsigned int)sizeof(ARG_VALUE),    (ARG_VALUE)
 
sternum_code_t sternum_trace_dynamic(int trace_event_type, ...);
sternum_code_t sternum_trace_string_format(uint16_t trace_event_type, uint16_t argument_role_type, uint16_t max_length, const char* format, ...);
 
/***********************************************************************************************
 * Predefined traces definitions
 **********************************************************************************************/
 
void trace_battery_health(unsigned int capacity_percent, unsigned int voltage_mV);
 
void trace_error(unsigned int error_code, const char* message, const char* file_name, unsigned int line);
 
#define STERNUM_ADS_TRACE_ERROR(error_code, message) trace_error(error_code, message, __FILE__, __LINE__)
 
void trace_firmware_update_start(const char* firmware_version, const char* firmware_hash, const char* hash_algorithm);
 
 void trace_firmware_update_finish(void);
 
void trace_reboot_reason(const char* reboot_reason);
 
void trace_signal_strength_report(unsigned int communication_type, int signal_strength);
 
void upload_text_file(const char* path, size_t fseek_offset, size_t max_size);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* __STERNUM_TRACE_API_H__ */