57 lines
1.5 KiB
C
57 lines
1.5 KiB
C
|
#ifndef __DEBUG_H_
|
||
|
|
#define __DEBUG_H_
|
||
|
|
|
||
|
|
#include <stdint.h>
|
||
|
|
#include <stdio.h>
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @defgroup app_trace Debug Logger
|
||
|
|
* @ingroup app_common
|
||
|
|
* @{
|
||
|
|
* @brief Enables debug logs/ trace over UART.
|
||
|
|
* @details Enables debug logs/ trace over UART. Tracing is enabled only if
|
||
|
|
* ENABLE_DEBUG_LOG_SUPPORT is defined in the project.
|
||
|
|
*/
|
||
|
|
#ifdef ENABLE_DEBUG_LOG_SUPPORT
|
||
|
|
#include "nrf_log.h"
|
||
|
|
/**
|
||
|
|
* @brief Module Initialization.
|
||
|
|
*
|
||
|
|
* @details Initializes the module to use UART as trace output.
|
||
|
|
*
|
||
|
|
* @warning This function will configure UART using default board configuration.
|
||
|
|
* Do not call this function if UART is configured from a higher level in the application.
|
||
|
|
*/
|
||
|
|
void app_trace_init(void);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Log debug messages.
|
||
|
|
*
|
||
|
|
* @details This API logs messages over UART. The module must be initialized before using this API.
|
||
|
|
*
|
||
|
|
* @note Though this is currently a macro, it should be used used and treated as function.
|
||
|
|
*/
|
||
|
|
#define app_trace_log NRF_LOG_PRINTF
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Dump auxiliary byte buffer to the debug trace.
|
||
|
|
*
|
||
|
|
* @details This API logs messages over UART. The module must be initialized before using this API.
|
||
|
|
*
|
||
|
|
* @param[in] p_buffer Buffer to be dumped on the debug trace.
|
||
|
|
* @param[in] len Size of the buffer.
|
||
|
|
*/
|
||
|
|
void app_trace_dump(uint8_t * p_buffer, uint32_t len);
|
||
|
|
|
||
|
|
#else // ENABLE_DEBUG_LOG_SUPPORT
|
||
|
|
|
||
|
|
#define app_trace_init(...)
|
||
|
|
#define app_trace_log(...)
|
||
|
|
#define app_trace_dump(...)
|
||
|
|
|
||
|
|
#endif // ENABLE_DEBUG_LOG_SUPPORT
|
||
|
|
|
||
|
|
/** @} */
|
||
|
|
|
||
|
|
#endif //__DEBUG_H_
|