Sl_bgapi_trace#
BGAPI trace utility for tracing BGAPI commands and events.
The functions provided by this component are automatically called by the BGAPI protocol implementation when a command is processed or an event is delivered to the application. The application does not need to and must not call these functions directly.
Enumerations#
enum
sli_bgapi_trace_message_type_command = 0x0
sli_bgapi_trace_message_type_response = 0x1
sli_bgapi_trace_message_type_event = 0x2
}
Specifies the full type of a BGAPI message.
Functions#
void
sli_bgapi_trace_init(void)
void
sli_bgapi_trace_output_message(sli_bgapi_trace_message_type_t type, uint32_t header, const void *data)
Enumeration Documentation#
sli_bgapi_trace_message_type_t#
sli_bgapi_trace_message_type_t
Specifies the full type of a BGAPI message.
| Enumerator | |
|---|---|
| sli_bgapi_trace_message_type_command | (0x0) The message is a BGAPI command |
| sli_bgapi_trace_message_type_response | (0x1) The message is a BGAPI response |
| sli_bgapi_trace_message_type_event | (0x2) The message is a BGAPI event |
Definition at line
44 of file include/sli_bgapi_trace.hFunction Documentation#
sli_bgapi_trace_init#
void sli_bgapi_trace_init (void )
Parameters
| N/A |
Initialize BGAPI tracing.
Definition at line
53 of file include/sli_bgapi_trace.hsli_bgapi_trace_output_message#
void sli_bgapi_trace_output_message (sli_bgapi_trace_message_type_t type, uint32_t header, const void * data)
Parameters
| [in] | type | The BGAPI message type |
| [in] | header | The BGAPI message header |
| [in] | data | The BGAPI message payload data |
Output a BGAPI message to the trace channel.
Definition at line
62 of file include/sli_bgapi_trace.h