debug.h File Reference

Debugging facilities. More...

#include <stdio.h>
#include "os_port.h"

Go to the source code of this file.

Macros

#define TRACE_LEVEL_OFF   0
 
#define TRACE_LEVEL_FATAL   1
 
#define TRACE_LEVEL_ERROR   2
 
#define TRACE_LEVEL_WARNING   3
 
#define TRACE_LEVEL_INFO   4
 
#define TRACE_LEVEL_DEBUG   5
 
#define TRACE_LEVEL   TRACE_LEVEL_DEBUG
 
#define TRACE_PRINTF(...)   osSuspendAllTasks(), fprintf(stderr, __VA_ARGS__), osResumeAllTasks()
 
#define TRACE_ARRAY(p, a, n)   osSuspendAllTasks(), debugDisplayArray(stderr, p, a, n), osResumeAllTasks()
 
#define TRACE_MPI(p, a)   osSuspendAllTasks(), mpiDump(stderr, p, a), osResumeAllTasks()
 
#define TRACE_FATAL(...)   TRACE_PRINTF(__VA_ARGS__)
 
#define TRACE_FATAL_ARRAY(p, a, n)   TRACE_ARRAY(p, a, n)
 
#define TRACE_ERROR(...)   TRACE_PRINTF(__VA_ARGS__)
 
#define TRACE_ERROR_ARRAY(p, a, n)   TRACE_ARRAY(p, a, n)
 
#define TRACE_WARNING(...)   TRACE_PRINTF(__VA_ARGS__)
 
#define TRACE_WARNING_ARRAY(p, a, n)   TRACE_ARRAY(p, a, n)
 
#define TRACE_INFO(...)   TRACE_PRINTF(__VA_ARGS__)
 
#define TRACE_INFO_ARRAY(p, a, n)   TRACE_ARRAY(p, a, n)
 
#define TRACE_INFO_NET_BUFFER(p, b, o, n)
 
#define TRACE_INFO_MPI(p, a)   TRACE_MPI(p, a)
 
#define TRACE_DEBUG(...)   TRACE_PRINTF(__VA_ARGS__)
 
#define TRACE_DEBUG_ARRAY(p, a, n)   TRACE_ARRAY(p, a, n)
 
#define TRACE_DEBUG_NET_BUFFER(p, b, o, n)
 
#define TRACE_DEBUG_MPI(p, a)   TRACE_MPI(p, a)
 
#define TRACE_LEVEL_NO_TRACE   TRACE_LEVEL_OFF
 

Functions

void debugInit (uint32_t baudrate)
 
void debugDisplayArray (FILE *stream, const char_t *prepend, const void *data, size_t length)
 Display the contents of an array. More...
 

Detailed Description

Debugging facilities.

License

Copyright (C) 2010-2018 Oryx Embedded SARL. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author
Oryx Embedded SARL (www.oryx-embedded.com)
Version
1.9.0

Definition in file debug.h.

Macro Definition Documentation

◆ TRACE_ARRAY

#define TRACE_ARRAY (   p,
  a,
  n 
)    osSuspendAllTasks(), debugDisplayArray(stderr, p, a, n), osResumeAllTasks()

Definition at line 53 of file debug.h.

◆ TRACE_DEBUG

#define TRACE_DEBUG (   ...)    TRACE_PRINTF(__VA_ARGS__)

Definition at line 98 of file debug.h.

◆ TRACE_DEBUG_ARRAY

#define TRACE_DEBUG_ARRAY (   p,
  a,
  n 
)    TRACE_ARRAY(p, a, n)

Definition at line 99 of file debug.h.

◆ TRACE_DEBUG_MPI

#define TRACE_DEBUG_MPI (   p,
  a 
)    TRACE_MPI(p, a)

Definition at line 101 of file debug.h.

◆ TRACE_DEBUG_NET_BUFFER

#define TRACE_DEBUG_NET_BUFFER (   p,
  b,
  o,
  n 
)

Definition at line 100 of file debug.h.

◆ TRACE_ERROR

#define TRACE_ERROR (   ...)    TRACE_PRINTF(__VA_ARGS__)

Definition at line 70 of file debug.h.

◆ TRACE_ERROR_ARRAY

#define TRACE_ERROR_ARRAY (   p,
  a,
  n 
)    TRACE_ARRAY(p, a, n)

Definition at line 71 of file debug.h.

◆ TRACE_FATAL

#define TRACE_FATAL (   ...)    TRACE_PRINTF(__VA_ARGS__)

Definition at line 62 of file debug.h.

◆ TRACE_FATAL_ARRAY

#define TRACE_FATAL_ARRAY (   p,
  a,
  n 
)    TRACE_ARRAY(p, a, n)

Definition at line 63 of file debug.h.

◆ TRACE_INFO

#define TRACE_INFO (   ...)    TRACE_PRINTF(__VA_ARGS__)

Definition at line 86 of file debug.h.

◆ TRACE_INFO_ARRAY

#define TRACE_INFO_ARRAY (   p,
  a,
  n 
)    TRACE_ARRAY(p, a, n)

Definition at line 87 of file debug.h.

◆ TRACE_INFO_MPI

#define TRACE_INFO_MPI (   p,
  a 
)    TRACE_MPI(p, a)

Definition at line 89 of file debug.h.

◆ TRACE_INFO_NET_BUFFER

#define TRACE_INFO_NET_BUFFER (   p,
  b,
  o,
  n 
)

Definition at line 88 of file debug.h.

◆ TRACE_LEVEL

#define TRACE_LEVEL   TRACE_LEVEL_DEBUG

Definition at line 44 of file debug.h.

◆ TRACE_LEVEL_DEBUG

#define TRACE_LEVEL_DEBUG   5

Definition at line 40 of file debug.h.

◆ TRACE_LEVEL_ERROR

#define TRACE_LEVEL_ERROR   2

Definition at line 37 of file debug.h.

◆ TRACE_LEVEL_FATAL

#define TRACE_LEVEL_FATAL   1

Definition at line 36 of file debug.h.

◆ TRACE_LEVEL_INFO

#define TRACE_LEVEL_INFO   4

Definition at line 39 of file debug.h.

◆ TRACE_LEVEL_NO_TRACE

#define TRACE_LEVEL_NO_TRACE   TRACE_LEVEL_OFF

Definition at line 121 of file debug.h.

◆ TRACE_LEVEL_OFF

#define TRACE_LEVEL_OFF   0

Definition at line 35 of file debug.h.

◆ TRACE_LEVEL_WARNING

#define TRACE_LEVEL_WARNING   3

Definition at line 38 of file debug.h.

◆ TRACE_MPI

#define TRACE_MPI (   p,
  a 
)    osSuspendAllTasks(), mpiDump(stderr, p, a), osResumeAllTasks()

Definition at line 57 of file debug.h.

◆ TRACE_PRINTF

#define TRACE_PRINTF (   ...)    osSuspendAllTasks(), fprintf(stderr, __VA_ARGS__), osResumeAllTasks()

Definition at line 49 of file debug.h.

◆ TRACE_WARNING

#define TRACE_WARNING (   ...)    TRACE_PRINTF(__VA_ARGS__)

Definition at line 78 of file debug.h.

◆ TRACE_WARNING_ARRAY

#define TRACE_WARNING_ARRAY (   p,
  a,
  n 
)    TRACE_ARRAY(p, a, n)

Definition at line 79 of file debug.h.

Function Documentation

◆ debugDisplayArray()

void debugDisplayArray ( FILE *  stream,
const char_t prepend,
const void *  data,
size_t  length 
)

Display the contents of an array.

Parameters
[in]streamPointer to a FILE object that identifies an output stream
[in]prependString to prepend to the left of each line
[in]dataPointer to the data array
[in]lengthNumber of bytes to display

Definition at line 39 of file debug.c.

◆ debugInit()

void debugInit ( uint32_t  baudrate)