Cordio Stack and Cordio Profiles  r2p3-02rel0
WSF Trace API

Macros

#define WSF_TRACE_ENABLED   FALSE
 Trace enable flag (default is disabled, override with compile-time directive).
 
#define WSF_TOKEN_ENABLED   FALSE
 Tokenized tracing enable flag (default is disabled, override with compile-time directive).
 
#define WSF_TRACE0(subsys, stat, msg)    WsfTrace(msg)
 Generic 0 argument trace.
 
#define WSF_TRACE1(subsys, stat, msg, var1)    WsfTrace(msg, var1)
 Generic 1 argument trace.
 
#define WSF_TRACE2(subsys, stat, msg, var1, var2)    WsfTrace(msg, var1, var2)
 Generic 2 argument trace.
 
#define WSF_TRACE3(subsys, stat, msg, var1, var2, var3)   WsfTrace(msg, var1, var2, var3)
 Generic 3 argument trace.
 
#define WSF_TRACE_INFO0(msg)
 0 argument WSF info trace.
 
#define WSF_TRACE_INFO1(msg, var1)
 1 argument WSF info trace.
 
#define WSF_TRACE_INFO2(msg, var1, var2)
 2 argument WSF info trace.
 
#define WSF_TRACE_INFO3(msg, var1, var2, var3)
 3 argument WSF info trace.
 
#define WSF_TRACE_WARN0(msg)    WSF_TRACE0("WSF", "WARN", msg)
 0 argument WSF warning trace.
 
#define WSF_TRACE_WARN1(msg, var1)    WSF_TRACE1("WSF", "WARN", msg, var1)
 1 argument WSF warning trace.
 
#define WSF_TRACE_WARN2(msg, var1, var2)    WSF_TRACE2("WSF", "WARN", msg, var1, var2)
 2 argument WSF warning trace.
 
#define WSF_TRACE_WARN3(msg, var1, var2, var3)    WSF_TRACE3("WSF", "WARN", msg, var1, var2, var3)
 3 argument WSF warning trace.
 
#define WSF_TRACE_ERR0(msg)    WSF_TRACE0("WSF", "ERR", msg)
 0 argument WSF error trace.
 
#define WSF_TRACE_ERR1(msg, var1)    WSF_TRACE1("WSF", "ERR", msg, var1)
 1 argument WSF error trace.
 
#define WSF_TRACE_ERR2(msg, var1, var2)    WSF_TRACE2("WSF", "ERR", msg, var1, var2)
 2 argument WSF error trace.
 
#define WSF_TRACE_ERR3(msg, var1, var2, var3)    WSF_TRACE3("WSF", "ERR", msg, var1, var2, var3)
 3 argument WSF error trace.
 
#define WSF_TRACE_ALLOC0(msg)
 0 argument WSF buffer allocation trace.
 
#define WSF_TRACE_ALLOC1(msg, var1)
 1 argument WSF buffer allocation trace.
 
#define WSF_TRACE_ALLOC2(msg, var1, var2)
 2 argument WSF buffer allocation trace.
 
#define WSF_TRACE_ALLOC3(msg, var1, var2, var3)
 3 argument WSF buffer allocation trace.
 
#define WSF_TRACE_FREE0(msg)
 0 argument WSF buffer free trace.
 
#define WSF_TRACE_FREE1(msg, var1)
 1 argument WSF buffer free trace.
 
#define WSF_TRACE_FREE2(msg, var1, var2)
 2 argument WSF buffer free trace.
 
#define WSF_TRACE_FREE3(msg, var1, var2, var3)
 3 argument WSF buffer free trace.
 
#define WSF_TRACE_MSG0(msg)
 0 argument WSF message trace.
 
#define WSF_TRACE_MSG1(msg, var1)
 1 argument WSF message trace.
 
#define WSF_TRACE_MSG2(msg, var1, var2)
 2 argument WSF message trace.
 
#define WSF_TRACE_MSG3(msg, var1, var2, var3)
 3 argument WSF message trace.
 
#define HCI_TRACE_INFO0(msg)    WSF_TRACE0("HCI", "INFO", msg)
 0 argument HCI info trace.
 
#define HCI_TRACE_INFO1(msg, var1)    WSF_TRACE1("HCI", "INFO", msg, var1)
 1 argument HCI info trace.
 
#define HCI_TRACE_INFO2(msg, var1, var2)    WSF_TRACE2("HCI", "INFO", msg, var1, var2)
 2 argument HCI info trace.
 
#define HCI_TRACE_INFO3(msg, var1, var2, var3)    WSF_TRACE3("HCI", "INFO", msg, var1, var2, var3)
 3 argument HCI info trace.
 
#define HCI_TRACE_WARN0(msg)    WSF_TRACE0("HCI", "WARN", msg)
 0 argument HCI warning trace.
 
#define HCI_TRACE_WARN1(msg, var1)    WSF_TRACE1("HCI", "WARN", msg, var1)
 1 argument HCI warning trace.
 
#define HCI_TRACE_WARN2(msg, var1, var2)    WSF_TRACE2("HCI", "WARN", msg, var1, var2)
 2 argument HCI warning trace.
 
#define HCI_TRACE_WARN3(msg, var1, var2, var3)    WSF_TRACE3("HCI", "WARN", msg, var1, var2, var3)
 3 argument HCI warning trace.
 
#define HCI_TRACE_ERR0(msg)    WSF_TRACE0("HCI", "ERR", msg)
 0 argument HCI error trace.
 
#define HCI_TRACE_ERR1(msg, var1)    WSF_TRACE1("HCI", "ERR", msg, var1)
 1 argument HCI error trace.
 
#define HCI_TRACE_ERR2(msg, var1, var2)    WSF_TRACE2("HCI", "ERR", msg, var1, var2)
 2 argument HCI error trace.
 
#define HCI_TRACE_ERR3(msg, var1, var2, var3)    WSF_TRACE3("HCI", "ERR", msg, var1, var2, var3)
 3 argument HCI error trace.
 
#define HCI_PDUMP_CMD(len, pBuf)
 HCI PDUMP on command.
 
#define HCI_PDUMP_EVT(len, pBuf)
 HCI PDUMP on event.
 
#define HCI_PDUMP_TX_ACL(len, pBuf)
 HCI PDUMP on transmitted ACL message.
 
#define HCI_PDUMP_RX_ACL(len, pBuf)
 HCI PDUMP on Received ACL message.
 
#define DM_TRACE_INFO0(msg)    WSF_TRACE0("DM", "INFO", msg)
 0 argument DM info trace.
 
#define DM_TRACE_INFO1(msg, var1)    WSF_TRACE1("DM", "INFO", msg, var1)
 1 argument DM info trace.
 
#define DM_TRACE_INFO2(msg, var1, var2)    WSF_TRACE2("DM", "INFO", msg, var1, var2)
 2 argument DM info trace.
 
#define DM_TRACE_INFO3(msg, var1, var2, var3)    WSF_TRACE3("DM", "INFO", msg, var1, var2, var3)
 3 argument DM info trace.
 
#define DM_TRACE_WARN0(msg)    WSF_TRACE0("DM", "WARN", msg)
 0 argument DM warning trace.
 
#define DM_TRACE_WARN1(msg, var1)    WSF_TRACE1("DM", "WARN", msg, var1)
 1 argument DM warning trace.
 
#define DM_TRACE_WARN2(msg, var1, var2)    WSF_TRACE2("DM", "WARN", msg, var1, var2)
 2 argument DM warning trace.
 
#define DM_TRACE_WARN3(msg, var1, var2, var3)    WSF_TRACE3("DM", "WARN", msg, var1, var2, var3)
 3 argument DM warning trace.
 
#define DM_TRACE_ERR0(msg)    WSF_TRACE0("DM", "ERR", msg)
 0 argument DM error trace.
 
#define DM_TRACE_ERR1(msg, var1)    WSF_TRACE1("DM", "ERR", msg, var1)
 1 argument DM error trace.
 
#define DM_TRACE_ERR2(msg, var1, var2)    WSF_TRACE2("DM", "ERR", msg, var1, var2)
 2 argument DM error trace.
 
#define DM_TRACE_ERR3(msg, var1, var2, var3)    WSF_TRACE3("DM", "ERR", msg, var1, var2, var3)
 3 argument DM error trace.
 
#define DM_TRACE_ALLOC0(msg)    WSF_TRACE0("DM", "ALLOC", msg)
 0 argument DM buffer allocation trace.
 
#define DM_TRACE_ALLOC1(msg, var1)    WSF_TRACE1("DM", "ALLOC", msg, var1)
 1 argument DM buffer allocation trace.
 
#define DM_TRACE_ALLOC2(msg, var1, var2)    WSF_TRACE2("DM", "ALLOC", msg, var1, var2)
 2 argument DM buffer allocation trace.
 
#define DM_TRACE_ALLOC3(msg, var1, var2, var3)    WSF_TRACE3("DM", "ALLOC", msg, var1, var2, var3)
 3 argument DM buffer allocation trace.
 
#define DM_TRACE_FREE0(msg)    WSF_TRACE0("DM", "FREE", msg)
 0 argument DM buffer free trace.
 
#define DM_TRACE_FREE1(msg, var1)    WSF_TRACE1("DM", "FREE", msg, var1)
 1 argument DM buffer free trace.
 
#define DM_TRACE_FREE2(msg, var1, var2)    WSF_TRACE2("DM", "FREE", msg, var1, var2)
 2 argument DM buffer free trace.
 
#define DM_TRACE_FREE3(msg, var1, var2, var3)    WSF_TRACE3("DM", "FREE", msg, var1, var2, var3)
 3 argument DM buffer free trace.
 
#define L2C_TRACE_INFO0(msg)    WSF_TRACE0("L2C", "INFO", msg)
 0 argument L2C info trace.
 
#define L2C_TRACE_INFO1(msg, var1)    WSF_TRACE1("L2C", "INFO", msg, var1)
 1 argument L2C info trace.
 
#define L2C_TRACE_INFO2(msg, var1, var2)    WSF_TRACE2("L2C", "INFO", msg, var1, var2)
 2 argument L2C info trace.
 
#define L2C_TRACE_INFO3(msg, var1, var2, var3)    WSF_TRACE3("L2C", "INFO", msg, var1, var2, var3)
 3 argument L2C info trace.
 
#define L2C_TRACE_WARN0(msg)    WSF_TRACE0("L2C", "WARN", msg)
 0 argument L2C warning trace.
 
#define L2C_TRACE_WARN1(msg, var1)    WSF_TRACE1("L2C", "WARN", msg, var1)
 1 argument L2C warning trace.
 
#define L2C_TRACE_WARN2(msg, var1, var2)    WSF_TRACE2("L2C", "WARN", msg, var1, var2)
 2 argument L2C warning trace.
 
#define L2C_TRACE_WARN3(msg, var1, var2, var3)    WSF_TRACE3("L2C", "WARN", msg, var1, var2, var3)
 3 argument L2C warning trace.
 
#define L2C_TRACE_ERR0(msg)    WSF_TRACE0("L2C", "ERR", msg)
 0 argument L2C error trace.
 
#define L2C_TRACE_ERR1(msg, var1)    WSF_TRACE1("L2C", "ERR", msg, var1)
 1 argument L2C error trace.
 
#define L2C_TRACE_ERR2(msg, var1, var2)    WSF_TRACE2("L2C", "ERR", msg, var1, var2)
 2 argument L2C error trace.
 
#define L2C_TRACE_ERR3(msg, var1, var2, var3)    WSF_TRACE3("L2C", "ERR", msg, var1, var2, var3)
 3 argument L2C error trace.
 
#define ATT_TRACE_INFO0(msg)    WSF_TRACE0("ATT", "INFO", msg)
 0 argument ATT info trace.
 
#define ATT_TRACE_INFO1(msg, var1)    WSF_TRACE1("ATT", "INFO", msg, var1)
 1 argument ATT info trace.
 
#define ATT_TRACE_INFO2(msg, var1, var2)    WSF_TRACE2("ATT", "INFO", msg, var1, var2)
 2 argument ATT info trace.
 
#define ATT_TRACE_INFO3(msg, var1, var2, var3)    WSF_TRACE3("ATT", "INFO", msg, var1, var2, var3)
 3 argument ATT info trace.
 
#define ATT_TRACE_WARN0(msg)    WSF_TRACE0("ATT", "WARN", msg)
 0 argument ATT warning trace.
 
#define ATT_TRACE_WARN1(msg, var1)    WSF_TRACE1("ATT", "WARN", msg, var1)
 1 argument ATT warning trace.
 
#define ATT_TRACE_WARN2(msg, var1, var2)    WSF_TRACE2("ATT", "WARN", msg, var1, var2)
 2 argument ATT warning trace.
 
#define ATT_TRACE_WARN3(msg, var1, var2, var3)    WSF_TRACE3("ATT", "WARN", msg, var1, var2, var3)
 3 argument ATT warning trace.
 
#define ATT_TRACE_ERR0(msg)    WSF_TRACE0("ATT", "ERR", msg)
 0 argument ATT error trace.
 
#define ATT_TRACE_ERR1(msg, var1)    WSF_TRACE1("ATT", "ERR", msg, var1)
 1 argument ATT error trace.
 
#define ATT_TRACE_ERR2(msg, var1, var2)    WSF_TRACE2("ATT", "ERR", msg, var1, var2)
 2 argument ATT error trace.
 
#define ATT_TRACE_ERR3(msg, var1, var2, var3)    WSF_TRACE3("ATT", "ERR", msg, var1, var2, var3)
 3 argument ATT error trace.
 
#define SMP_TRACE_INFO0(msg)    WSF_TRACE0("SMP", "INFO", msg)
 0 argument SMP info trace.
 
#define SMP_TRACE_INFO1(msg, var1)    WSF_TRACE1("SMP", "INFO", msg, var1)
 1 argument SMP info trace.
 
#define SMP_TRACE_INFO2(msg, var1, var2)    WSF_TRACE2("SMP", "INFO", msg, var1, var2)
 2 argument SMP info trace.
 
#define SMP_TRACE_INFO3(msg, var1, var2, var3)    WSF_TRACE3("SMP", "INFO", msg, var1, var2, var3)
 3 argument SMP info trace.
 
#define SMP_TRACE_WARN0(msg)    WSF_TRACE0("SMP", "WARN", msg)
 0 argument SMP warning trace.
 
#define SMP_TRACE_WARN1(msg, var1)    WSF_TRACE1("SMP", "WARN", msg, var1)
 1 argument SMP warning trace.
 
#define SMP_TRACE_WARN2(msg, var1, var2)    WSF_TRACE2("SMP", "WARN", msg, var1, var2)
 2 argument SMP warning trace.
 
#define SMP_TRACE_WARN3(msg, var1, var2, var3)    WSF_TRACE3("SMP", "WARN", msg, var1, var2, var3)
 3 argument SMP warning trace.
 
#define SMP_TRACE_ERR0(msg)    WSF_TRACE0("SMP", "ERR", msg)
 0 argument SMP error trace.
 
#define SMP_TRACE_ERR1(msg, var1)    WSF_TRACE1("SMP", "ERR", msg, var1)
 1 argument SMP error trace.
 
#define SMP_TRACE_ERR2(msg, var1, var2)    WSF_TRACE2("SMP", "ERR", msg, var1, var2)
 2 argument SMP error trace.
 
#define SMP_TRACE_ERR3(msg, var1, var2, var3)    WSF_TRACE3("SMP", "ERR", msg, var1, var2, var3)
 3 argument SMP error trace.
 
#define APP_TRACE_INFO0(msg)    WSF_TRACE0("APP", "INFO", msg)
 0 argument App info trace.
 
#define APP_TRACE_INFO1(msg, var1)    WSF_TRACE1("APP", "INFO", msg, var1)
 1 argument App info trace.
 
#define APP_TRACE_INFO2(msg, var1, var2)    WSF_TRACE2("APP", "INFO", msg, var1, var2)
 2 argument App info trace.
 
#define APP_TRACE_INFO3(msg, var1, var2, var3)    WSF_TRACE3("APP", "INFO", msg, var1, var2, var3)
 3 argument App info trace.
 
#define APP_TRACE_WARN0(msg)    WSF_TRACE0("APP", "WARN", msg)
 0 argument App warning trace.
 
#define APP_TRACE_WARN1(msg, var1)    WSF_TRACE1("APP", "WARN", msg, var1)
 1 argument App warning trace.
 
#define APP_TRACE_WARN2(msg, var1, var2)    WSF_TRACE2("APP", "WARN", msg, var1, var2)
 2 argument App warning trace.
 
#define APP_TRACE_WARN3(msg, var1, var2, var3)    WSF_TRACE3("APP", "WARN", msg, var1, var2, var3)
 3 argument App warning trace.
 
#define APP_TRACE_ERR0(msg)    WSF_TRACE0("APP", "ERR", msg)
 0 argument App error trace.
 
#define APP_TRACE_ERR1(msg, var1)    WSF_TRACE1("APP", "ERR", msg, var1)
 1 argument App error trace.
 
#define APP_TRACE_ERR2(msg, var1, var2)    WSF_TRACE2("APP", "ERR", msg, var1, var2)
 2 argument App error trace.
 
#define APP_TRACE_ERR3(msg, var1, var2, var3)    WSF_TRACE3("APP", "ERR", msg, var1, var2, var3)
 3 argument App error trace.
 
#define LL_TRACE_INFO0(msg)    WSF_TRACE0("LL", "INFO", msg)
 0 argument LL info trace.
 
#define LL_TRACE_INFO1(msg, var1)    WSF_TRACE1("LL", "INFO", msg, var1)
 1 argument LL info trace.
 
#define LL_TRACE_INFO2(msg, var1, var2)    WSF_TRACE2("LL", "INFO", msg, var1, var2)
 2 argument LL info trace.
 
#define LL_TRACE_INFO3(msg, var1, var2, var3)    WSF_TRACE3("LL", "INFO", msg, var1, var2, var3)
 3 argument LL info trace.
 
#define LL_TRACE_WARN0(msg)    WSF_TRACE0("LL", "WARN", msg)
 0 argument LL warning trace.
 
#define LL_TRACE_WARN1(msg, var1)    WSF_TRACE1("LL", "WARN", msg, var1)
 1 argument LL warning trace.
 
#define LL_TRACE_WARN2(msg, var1, var2)    WSF_TRACE2("LL", "WARN", msg, var1, var2)
 2 argument LL warning trace.
 
#define LL_TRACE_WARN3(msg, var1, var2, var3)    WSF_TRACE3("LL", "WARN", msg, var1, var2, var3)
 3 argument LL warning trace.
 
#define LL_TRACE_ERR0(msg)    WSF_TRACE0("LL", "ERR", msg)
 0 argument LL error trace.
 
#define LL_TRACE_ERR1(msg, var1)    WSF_TRACE1("LL", "ERR", msg, var1)
 1 argument LL error trace.
 
#define LL_TRACE_ERR2(msg, var1, var2)    WSF_TRACE2("LL", "ERR", msg, var1, var2)
 2 argument LL error trace.
 
#define LL_TRACE_ERR3(msg, var1, var2, var3)    WSF_TRACE3("LL", "ERR", msg, var1, var2, var3)
 3 argument LL error trace.
 
#define BBP_TRACE_INFO0(msg)    WSF_TRACE0("BBP", "INFO", msg)
 0 argument BBP warning trace.
 
#define BBP_TRACE_INFO1(msg, var1)    WSF_TRACE1("BBP", "INFO", msg, var1)
 1 argument BBP warning trace.
 
#define BBP_TRACE_INFO2(msg, var1, var2)    WSF_TRACE2("BBP", "INFO", msg, var1, var2)
 2 argument BBP warning trace.
 
#define BBP_TRACE_INFO3(msg, var1, var2, var3)    WSF_TRACE3("BBP", "INFO", msg, var1, var2, var3)
 3 argument BBP info trace.
 
#define BBP_TRACE_WARN0(msg)    WSF_TRACE0("BBP", "WARN", msg)
 0 argument BBP warning trace.
 
#define BBP_TRACE_WARN1(msg, var1)    WSF_TRACE1("BBP", "WARN", msg, var1)
 1 argument BBP warning trace.
 
#define BBP_TRACE_WARN2(msg, var1, var2)    WSF_TRACE2("BBP", "WARN", msg, var1, var2)
 2 argument BBP warning trace.
 
#define BBP_TRACE_WARN3(msg, var1, var2, var3)    WSF_TRACE3("BBP", "WARN", msg, var1, var2, var3)
 3 argument BBP warning trace.
 
#define BBP_TRACE_ERR0(msg)    WSF_TRACE0("BBP", "ERR", msg)
 0 argument BBP error trace.
 
#define BBP_TRACE_ERR1(msg, var1)    WSF_TRACE1("BBP", "ERR", msg, var1)
 1 argument BBP error trace.
 
#define BBP_TRACE_ERR2(msg, var1, var2)    WSF_TRACE2("BBP", "ERR", msg, var1, var2)
 2 argument BBP error trace.
 
#define BBP_TRACE_ERR3(msg, var1, var2, var3)    WSF_TRACE3("BBP", "ERR", msg, var1, var2, var3)
 3 argument BBP error trace.
 
#define LL_TRACE_ENABLE(ena)    WsfTraceEnable(ena)
 Enable LL trace.
 

Typedefs

typedef void(* WsfTokenHandler_t) (uint8_t *pBuf, uint8_t len)
 Token event handler.
 
typedef void(* wsfTraceCback_t) (const char *pStr, va_list args)
 Platform trace callback.
 

Functions

void WsfTrace (const char *pStr,...)
 Print a trace message. More...
 
void WsfToken (uint32_t tok, uint32_t var)
 Output tokenized message. More...
 
void WsfTraceEnable (bool_t enable)
 Enable trace messages. More...
 
bool_t WsfTokenService (void)
 Service the trace ring buffer. More...
 
void WsfTokenRegisterHandler (WsfTokenHandler_t tokenCback)
 Regsiter token handler. More...
 
void WsfTraceRegister (wsfTraceCback_t cback)
 Register platform trace callback function. More...
 

Description

Function Documentation

void WsfTrace ( const char *  pStr,
  ... 
)

Print a trace message.

Parameters
pStrMessage format string
...Additional arguments, printf-style
Returns
None.
void WsfToken ( uint32_t  tok,
uint32_t  var 
)

Output tokenized message.

Parameters
tokToken
varVariable
Returns
None.
void WsfTraceEnable ( bool_t  enable)

Enable trace messages.

Parameters
enableTRUE to enable, FALSE to disable
Returns
None.
bool_t WsfTokenService ( void  )

Service the trace ring buffer.

Returns
TRUE if trace messages pending, FALSE otherwise.

This routine is called in the main loop for a "push" type trace systems.

void WsfTokenRegisterHandler ( WsfTokenHandler_t  tokenCback)

Regsiter token handler.

Parameters
tokenCbackToken event handler.
Returns
None.

This routine registers a token callback. This callback is called when the next token event is ready to be written to the I/O.

void WsfTraceRegister ( wsfTraceCback_t  cback)

Register platform trace callback function.

Parameters
cbackCallback function
Returns
None.