147 lines
2.8 KiB
C
147 lines
2.8 KiB
C
|
//
|
||
|
|
// This file is part of the µOS++ III distribution.
|
||
|
|
// Copyright (c) 2014 Liviu Ionescu.
|
||
|
|
//
|
||
|
|
|
||
|
|
#ifndef DIAG_TRACE_H_
|
||
|
|
#define DIAG_TRACE_H_
|
||
|
|
|
||
|
|
// ----------------------------------------------------------------------------
|
||
|
|
|
||
|
|
#include <unistd.h>
|
||
|
|
|
||
|
|
// ----------------------------------------------------------------------------
|
||
|
|
|
||
|
|
// The trace device is an independent output channel, intended for debug
|
||
|
|
// purposes.
|
||
|
|
//
|
||
|
|
// The API is simple, and mimics the standard output calls:
|
||
|
|
// - trace_printf()
|
||
|
|
// - trace_puts()
|
||
|
|
// - trace_putchar();
|
||
|
|
//
|
||
|
|
// The implementation is done in
|
||
|
|
// - trace_write()
|
||
|
|
//
|
||
|
|
// Trace support is enabled by adding the TRACE definition.
|
||
|
|
// By default the trace messages are forwarded to the ITM output,
|
||
|
|
// but can be rerouted via any device or completely suppressed by
|
||
|
|
// changing the definitions required in system/src/diag/trace_impl.c
|
||
|
|
// (currently OS_USE_TRACE_ITM, OS_USE_TRACE_SEMIHOSTING_DEBUG/_STDOUT).
|
||
|
|
//
|
||
|
|
// When TRACE is not defined, all functions are inlined to empty bodies.
|
||
|
|
// This has the advantage that the trace call do not need to be conditionally
|
||
|
|
// compiled with #ifdef TRACE/#endif
|
||
|
|
|
||
|
|
|
||
|
|
#if defined(TRACE)
|
||
|
|
|
||
|
|
#if defined(__cplusplus)
|
||
|
|
extern "C"
|
||
|
|
{
|
||
|
|
#endif
|
||
|
|
|
||
|
|
void
|
||
|
|
trace_initialize(void);
|
||
|
|
|
||
|
|
// Implementation dependent
|
||
|
|
ssize_t
|
||
|
|
trace_write(const char* buf, size_t nbyte);
|
||
|
|
|
||
|
|
// ----- Portable -----
|
||
|
|
|
||
|
|
int
|
||
|
|
trace_printf(const char* format, ...);
|
||
|
|
|
||
|
|
int
|
||
|
|
trace_puts(const char *s);
|
||
|
|
|
||
|
|
int
|
||
|
|
trace_putchar(int c);
|
||
|
|
|
||
|
|
void
|
||
|
|
trace_dump_args(int argc, char* argv[]);
|
||
|
|
|
||
|
|
#if defined(__cplusplus)
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#else // !defined(TRACE)
|
||
|
|
|
||
|
|
#if defined(__cplusplus)
|
||
|
|
extern "C"
|
||
|
|
{
|
||
|
|
#endif
|
||
|
|
|
||
|
|
inline void
|
||
|
|
trace_initialize(void);
|
||
|
|
|
||
|
|
// Implementation dependent
|
||
|
|
inline ssize_t
|
||
|
|
trace_write(const char* buf, size_t nbyte);
|
||
|
|
|
||
|
|
inline int
|
||
|
|
trace_printf(const char* format, ...);
|
||
|
|
|
||
|
|
inline int
|
||
|
|
trace_puts(const char *s);
|
||
|
|
|
||
|
|
inline int
|
||
|
|
trace_putchar(int c);
|
||
|
|
|
||
|
|
inline void
|
||
|
|
trace_dump_args(int argc, char* argv[]);
|
||
|
|
|
||
|
|
#if defined(__cplusplus)
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
inline void
|
||
|
|
__attribute__((always_inline))
|
||
|
|
trace_initialize(void)
|
||
|
|
{
|
||
|
|
}
|
||
|
|
|
||
|
|
// Empty definitions when trace is not defined
|
||
|
|
inline ssize_t
|
||
|
|
__attribute__((always_inline))
|
||
|
|
trace_write(const char* buf __attribute__((unused)),
|
||
|
|
size_t nbyte __attribute__((unused)))
|
||
|
|
{
|
||
|
|
return 0;
|
||
|
|
}
|
||
|
|
|
||
|
|
inline int
|
||
|
|
__attribute__((always_inline))
|
||
|
|
trace_printf(const char* format __attribute__((unused)), ...)
|
||
|
|
{
|
||
|
|
return 0;
|
||
|
|
}
|
||
|
|
|
||
|
|
inline int
|
||
|
|
__attribute__((always_inline))
|
||
|
|
trace_puts(const char *s __attribute__((unused)))
|
||
|
|
{
|
||
|
|
return 0;
|
||
|
|
}
|
||
|
|
|
||
|
|
inline int
|
||
|
|
__attribute__((always_inline))
|
||
|
|
trace_putchar(int c)
|
||
|
|
{
|
||
|
|
return c;
|
||
|
|
}
|
||
|
|
|
||
|
|
inline void
|
||
|
|
__attribute__((always_inline))
|
||
|
|
trace_dump_args(int argc __attribute__((unused)),
|
||
|
|
char* argv[] __attribute__((unused)))
|
||
|
|
{
|
||
|
|
}
|
||
|
|
|
||
|
|
#endif // defined(TRACE)
|
||
|
|
|
||
|
|
// ----------------------------------------------------------------------------
|
||
|
|
|
||
|
|
#endif // DIAG_TRACE_H_
|