m2mb_trace.h File Reference

Base trace system for m2m application. More...

#include <string.h>
#include "m2mb_platform_defines.h"

Include dependency graph for m2mb_trace.h:

Go to the source code of this file.

Macros
#define	__FILENAMEI__   (strrchr(__FILE__, '\\') ? strrchr(__FILE__, '\\') + 1 : __FILE__)
#define	__FILENAMER__   (strrchr(__FILENAMEI__, '/') ? strrchr(__FILENAMEI__, '/') + 1 : __FILENAMEI__)
#define	__MODULE__   __FILENAMER__
#define	m2mb_trace_printf(_class, level, format, ...)   m2mb_trace_print_##level( _class, level, format, ##__VA_ARGS__ )
#define	m2mb_trace_print_M2MB_TL_FATAL(_class, level, format, ...)   m2mb_trace_file_line_printf(__MODULE__, __LINE__, _class, level, format, ##__VA_ARGS__)
#define	m2mb_trace_print_M2MB_TL_ERROR(_class, level, format, ...)   m2mb_trace_file_line_printf(__MODULE__, __LINE__, _class, level, format, ##__VA_ARGS__)
#define	m2mb_trace_print_M2MB_TL_WARNING(_class, level, format, ...)   m2mb_trace_file_line_printf(__MODULE__, __LINE__, _class, level, format, ##__VA_ARGS__)
#define	m2mb_trace_print_M2MB_TL_LOG(_class, level, format, ...)   m2mb_trace_file_line_printf(__MODULE__, __LINE__, _class, level, format, ##__VA_ARGS__)
#define	m2mb_trace_print_M2MB_TL_DEBUG(_class, level, format, ...)   m2mb_trace_file_line_printf(__MODULE__, __LINE__, _class, level, format, ##__VA_ARGS__)
#define	SUBSYS_TRACE_TABLE
#define	SUB_TR_AZ(a, b)   a,

Typedefs
typedef HANDLE	M2MB_TRACE_HANDLE

Enumerations
enum	M2MB_TRACE_CLASS { NUM_M2MB_TC }
enum	M2MB_TRACE_LEVEL {   M2MB_TL_FATAL = 1, M2MB_TL_ERROR = 2, M2MB_TL_WARNING = 3, M2MB_TL_LOG = 4,   M2MB_TL_DEBUG = 5, NUM_M2MB_TL }
enum	M2MB_TRACE_OUTPUT_TYPE { LOG_TRACE, LOG_USB0, LOG_USB1, LOG_UART }

Functions
M2MB_RESULT_E	m2mb_trace_init (void)
	Base trace system initializazion. More...
M2MB_RESULT_E	m2mb_trace_deinit (void)
	Base trace system deinitializazion. More...
M2MB_RESULT_E	m2mb_trace_enable (M2MB_TRACE_CLASS traceClass)
	Base trace abilitation. More...
M2MB_RESULT_E	m2mb_trace_disable (M2MB_TRACE_CLASS traceClass)
	Base trace disabilitation. More...
M2MB_RESULT_E	m2mb_trace_file_line_printf (const CHAR *file, INT32 line, M2MB_TRACE_CLASS traceClass, M2MB_TRACE_LEVEL level, CHAR *fmt,...)
	Base trace printf with file and line info. More...
M2MB_RESULT_E	m2mb_trace_all (UINT8 val)
	m2mb_trace_all disable/enable all traces More...
UINT8	m2mb_is_trace_class_enabled (M2MB_TRACE_CLASS traceClass)
	Base trace abilitation check. More...

Detailed Description

Base trace system for m2m application.

m2m/m2m_common/m2mb_inc/m2mb_trace.h

@notes Dependencies: stdarg.h, m2mb_types.h

Author

mb_ dinoa

Date

17/02/2017 05/04/2018

Function Documentation

m2mb_is_trace_class_enabled()

UINT8 m2mb_is_trace_class_enabled

(

M2MB_TRACE_CLASS

traceClass

)

Base trace abilitation check.

Check if a trace class is enabled or not.

Parameters

[in]

traceClass

Enum from M2MB_TRACE_CLASS that specifies the class of the trace

Returns

1: the trace class is enabled - 0: the trace class is disabled

Example

UINT8 ret;
 
ret = m2mb_is_trace_class_enabled(M2MB_TC_GENERIC);

m2mb_trace_all()

M2MB_RESULT_E m2mb_trace_all

(

UINT8

val

)

m2mb_trace_all disable/enable all traces

m2mb_trace_all allows to disable/enable all class of traces

Parameters

[in]

val

is the value to enable/disable all trace: 1 - enable 0 - disable

Returns

returns M2MB_RESULT_SUCCESS on success, a different value on error.

Note

m2mb_trace_deinit()

M2MB_RESULT_E m2mb_trace_deinit

(

void

)

Base trace system deinitializazion.

This function deinitialize and free the structure needed for the trace If there are no other log connections from other Apps close also the ports USB/UART open (if any)

Returns

M2MB_RESULT_SUCCESS - Ok

See M2MB_RESULT_E for error codes

Example

M2MB_RESULT_E Ret = m2mb_trace_deinit();

m2mb_trace_disable()

M2MB_RESULT_E m2mb_trace_disable

(

M2MB_TRACE_CLASS

traceClass

)

Base trace disabilitation.

This function disaables a specific trace class

Parameters

[in]

traceClass

Class of the trace to be disabled If the log is not active, doesn't do anything. If the traceClass deactivated is the only active, it deactivates the trace

Returns

M2MB_RESULT_SUCCESS - Ok

See M2MB_RESULT_E for error codes

Example

M2MB_RESULT_E Ret = m2mb_trace_disable(M2MB_TC_GENERIC);

m2mb_trace_enable()

M2MB_RESULT_E m2mb_trace_enable

(

M2MB_TRACE_CLASS

traceClass

)

Base trace abilitation.

This function enables a specific trace class

Parameters

[in]

traceClass

Class of the trace to be enabled at a M2MB_TRACE_LEVEL of M2MB_TL_DEBUG (5) If it is used after m2mb_trace_init, it activates the selected trace class. If it is used before or instead of m2mb_trace_init, it bypasses any reading of log_az.ini and activates the trace as LOG_TRACE with only the selected trace class activated

Returns

M2MB_RESULT_SUCCESS - Ok

See M2MB_RESULT_E for error codes

Example

M2MB_RESULT_E Ret = m2mb_trace_enable(M2MB_TC_GENERIC);

m2mb_trace_file_line_printf()

M2MB_RESULT_E m2mb_trace_file_line_printf	(	const CHAR *	file,
		INT32	line,
		M2MB_TRACE_CLASS	traceClass,
		M2MB_TRACE_LEVEL	level,
		CHAR *	fmt,
			...
	)

Base trace printf with file and line info.

Print formatted data to to trace system including file and line information.

Parameters

[in]	file	String containing the name of the file from where the trace is called
[in]	line	String containing the line in the file from where the trace is called
[in]	traceClass	Enum from M2MB_TRACE_CLASS that specifies class of the trace
[in]	level	Enum from M2MB_TRACE_LEVEL that specifies level of the trace
[in]	fmt	Format string for printf
[in]	...	Unnamed arguments

Returns

M2MB_RESULT_SUCCESS - Ok

See M2MB_RESULT_E for error codes

Example

#include <stdarg.h>
 
M2MB_RESULT_E ret;
 
ret = m2mb_trace_file_line_printf(__MODULE__, __LINE__, M2MB_TC_GENERIC, "%s", "Test");

m2mb_trace_init()

M2MB_RESULT_E m2mb_trace_init

(

void

)

Base trace system initializazion.

This function collects all necessary initializatione for the base trace system If there is no log_az.ini, all the classes to a M2MB_TRACE_LEVEL of M2MB_TL_DEBUG (5), that is all traces will be shown. ( user case )

Returns

M2MB_RESULT_SUCCESS - Ok

See M2MB_RESULT_E for error codes

Example

M2MB_RESULT_E Ret = m2mb_trace_init();