OS  v7.3.3
Documentation

API interfaces to print out trace and debug messages. More...

Collaboration diagram for Trace:

Macros

#define qTrace()
 Output a trace message,. More...
 
#define qDebug_Caller()
 Output a debug message,. More...
 
#define qTrace_Mem(pMem, bSize)
 Output a trace message for the memory from the specified address (HEX output) More...
 
#define qTrace_Memory(pMem, bSize)
 Same behavior of qTrace_Mem. More...
 
#define qDebug_Mem(pMem, bSize)
 Output a debug message for the memory from the specified address (HEX output) More...
 
#define qDebug_Memory(pMem, bSize)
 Same behavior of qDebug_Mem. More...
 
#define qTrace_Var(v, mode)
 Output a trace message for the supplied variable (up to 32bit data) More...
 
#define qTrace_Variable(v, mode)
 Same behavior of qTrace_Var. More...
 
#define qDebug_Var(v, mode)
 Output a debug message for the supplied variable (up to 32bit data) More...
 
#define qDebug_Variable(v, mode)
 Same behavior of qDebug_Var. More...
 

Functions

void qTrace_Set_OutputFcn (qPutChar_t fcn)
 This API set the output method for debug/trace messages. More...
 

Detailed Description

API interfaces to print out trace and debug messages.

Macro Definition Documentation

◆ qDebug_Caller

#define qDebug_Caller ( )

Output a debug message,.

Note
the Debug/Trace function must be previously defined with qTrace_Set_OutputFcn
Returns
none.

◆ qDebug_Mem

#define qDebug_Mem (   pMem,
  bSize 
)

Output a debug message for the memory from the specified address (HEX output)

Note
The Debug/Trace function must be previously defined with qTrace_Set_OutputFcn()
Parameters
[in]pMemThe target memory address
[in]bSizeNumber of bytes
Returns
none.

◆ qDebug_Memory

#define qDebug_Memory (   pMem,
  bSize 
)

Same behavior of qDebug_Mem.

Note
The Debug/Trace function must be previously defined with qTrace_Set_OutputFcn()
Parameters
[in]pMemThe target memory address
[in]bSizeNumber of bytes
Returns
none.

◆ qDebug_Var

#define qDebug_Var (   v,
  mode 
)

Output a debug message for the supplied variable (up to 32bit data)

Note
The Debug/Trace function must be previously defined with qTrace_Set_OutputFcn()
Parameters
vThe target variable
modeVisualization mode. It must be one of the following parameters:
  • Bool
  • qBool
  • Float
  • Binary
  • Octal
  • Decimal
  • Hexadecimal
  • UnsignedBinary,
  • UnsignedOctal
  • UnsignedDecimal
  • UnsignedHexadecimal.
  • String
  • Message
Returns
none.

◆ qDebug_Variable

#define qDebug_Variable (   v,
  mode 
)

Same behavior of qDebug_Var.

Note
The Debug/Trace function must be previously defined with qTrace_Set_OutputFcn()
Parameters
[in]vThe target variable
[in]modeVisualization mode.
Returns
none.

◆ qTrace

#define qTrace ( )

Output a trace message,.

Note
The Debug/Trace function must be previously defined with qTrace_Set_OutputFcn()
Returns
none.

◆ qTrace_Mem

#define qTrace_Mem (   pMem,
  bSize 
)

Output a trace message for the memory from the specified address (HEX output)

Note
The Debug/Trace function must be previously defined with qTrace_Set_OutputFcn()
Parameters
[in]pMemThe target memory address
[in]bSizeNumber of bytes
Returns
none.

◆ qTrace_Memory

#define qTrace_Memory (   pMem,
  bSize 
)

Same behavior of qTrace_Mem.

Parameters
[in]pMemThe target memory address
[in]bSizeNumber of bytes
Returns
none.

◆ qTrace_Var

#define qTrace_Var (   v,
  mode 
)

Output a trace message for the supplied variable (up to 32bit data)

Note
The Debug/Trace function must be previously defined with qTrace_Set_OutputFcn()
Parameters
[in]vThe target variable
[in]modeVisualization mode. It must be one of the following parameters:
  • Bool
  • qBool
  • Float
  • Binary
  • Octal
  • Decimal
  • Hexadecimal
  • UnsignedBinary,
  • UnsignedOctal
  • UnsignedDecimal
  • UnsignedHexadecimal.
  • String
  • Message
Returns
none.

◆ qTrace_Variable

#define qTrace_Variable (   v,
  mode 
)

Same behavior of qTrace_Var.

Note
The Debug/Trace function must be previously defined with qTrace_Set_OutputFcn()
Parameters
[in]vThe target variable
[in]modeVisualization mode.
Returns
none.

Function Documentation

◆ qTrace_Set_OutputFcn()

void qTrace_Set_OutputFcn ( qPutChar_t  fcn)

This API set the output method for debug/trace messages.

Parameters
[in]fcnThe basic output byte function.
Returns
none.