LogSinkBuf.h File Reference

#include <ti/log/Log.h>
#include <stdint.h>

Include dependency graph for LogSinkBuf.h:

Go to the source code of this file.

Data Structures
struct	LogSinkBuf_Rec
struct	LogSinkBuf_Instance

Macros
#define	Log_TI_LOG_SINK_BUF_VERSION   0.1.0
#define	LogSinkBuf_Type_LINEAR   (1)
#define	LogSinkBuf_Type_CIRCULAR   (2)
#define	LogSinkBuf_WORDS_PER_RECORD   (5)
#define	LogSinkBuf_BUF_HEADER_SIZE   sizeof(LogSinkBuf_RecordType) + sizeof(uint32_t)
#define	LogSinkBuf_SIZEOF_RECORD   (sizeof(uint32_t) * LogSinkBuf_WORDS_PER_RECORD)
#define	Log_SINK_BUF_DEFINE(name, type, num_entries)
#define	Log_SINK_BUF_USE(name)   extern LogSinkBuf_Instance LogSinkBuf_##name##_Config
#define	Log_MODULE_INIT_SINK_BUF(name, _levels)

Typedefs
typedef struct LogSinkBuf_Rec	LogSinkBuf_Rec
typedef struct LogSinkBuf_Instance	LogSinkBuf_Instance
typedef LogSinkBuf_Instance *	LogSinkBuf_Handle

Enumerations
enum	LogSinkBuf_RecordType { LogSinkBuf_EVENT = 0, LogSinkBuf_PRINTF = 1, LogSinkBuf_BUFFER_START = 2, LogSinkBuf_BUFFER_CONTINUED = 3 }

Functions
void	ti_log_LogSinkBuf_printf (const Log_Module *handle, uint32_t header, uint32_t index, uint32_t numArgs,...)
void	ti_log_LogSinkBuf_buf (const Log_Module *handle, uint32_t header, uint32_t index, uint8_t *data, size_t size)
	_Log_DEFINE_LOG_VERSION (LogSinkBuf, 0.1.0)

Macro Definition Documentation

Log_TI_LOG_SINK_BUF_VERSION

#define Log_TI_LOG_SINK_BUF_VERSION   0.1.0

LogSinkBuf_Type_LINEAR

#define LogSinkBuf_Type_LINEAR   (1)

LogSinkBuf_Type_CIRCULAR

#define LogSinkBuf_Type_CIRCULAR   (2)

LogSinkBuf_WORDS_PER_RECORD

#define LogSinkBuf_WORDS_PER_RECORD   (5)

LogSinkBuf_BUF_HEADER_SIZE

#define LogSinkBuf_BUF_HEADER_SIZE   sizeof(LogSinkBuf_RecordType) + sizeof(uint32_t)

LogSinkBuf_SIZEOF_RECORD

#define LogSinkBuf_SIZEOF_RECORD   (sizeof(uint32_t) * LogSinkBuf_WORDS_PER_RECORD)

Log_SINK_BUF_DEFINE

#define Log_SINK_BUF_DEFINE	(		name,
			type,
			num_entries
	)

Value:

static LogSinkBuf_Rec logSinkBuf_##name##_buffer[num_entries];                              \
    LogSinkBuf_Instance LogSinkBuf_##name##_Config = {.serial     = 0,                          \
                                                      .bufType    = type,                       \
                                                      .advance    = type,                       \
                                                      .numEntries = num_entries,                \
                                                      .buffer     = logSinkBuf_##name##_buffer, \
                                                      .curEntry   = logSinkBuf_##name##_buffer, \
                                                      .endEntry   = logSinkBuf_##name##_buffer + (num_entries - 1)}

Log_SINK_BUF_USE

#define Log_SINK_BUF_USE

(

name

)

extern LogSinkBuf_Instance LogSinkBuf_##name##_Config

Log_MODULE_INIT_SINK_BUF

#define Log_MODULE_INIT_SINK_BUF	(		name,
			_levels
	)

Value:

{                                                                                                                \
        .sinkConfig = &LogSinkBuf_##name##_Config, .printf = ti_log_LogSinkBuf_printf, .buf = ti_log_LogSinkBuf_buf, \
        .levels = _levels,                                                                                           \
    }

Typedef Documentation

LogSinkBuf_Rec

typedef struct LogSinkBuf_Rec LogSinkBuf_Rec

LogSinkBuf_Instance

typedef struct LogSinkBuf_Instance LogSinkBuf_Instance

LogSinkBuf_Handle

typedef LogSinkBuf_Instance* LogSinkBuf_Handle

Enumeration Type Documentation

LogSinkBuf_RecordType

enum LogSinkBuf_RecordType

Enumerator
LogSinkBuf_EVENT
LogSinkBuf_PRINTF
LogSinkBuf_BUFFER_START
LogSinkBuf_BUFFER_CONTINUED

Function Documentation

ti_log_LogSinkBuf_printf()

void ti_log_LogSinkBuf_printf	(	const Log_Module *	handle,
		uint32_t	header,
		uint32_t	index,
		uint32_t	numArgs,
			...
	)

ti_log_LogSinkBuf_buf()

void ti_log_LogSinkBuf_buf	(	const Log_Module *	handle,
		uint32_t	header,
		uint32_t	index,
		uint8_t *	data,
		size_t	size
	)

_Log_DEFINE_LOG_VERSION()

_Log_DEFINE_LOG_VERSION	(	LogSinkBuf	,
		0.1.	0
	)