初始版本
This commit is contained in:
296
components/libraries/log/nrf_log.h
Normal file
296
components/libraries/log/nrf_log.h
Normal file
@@ -0,0 +1,296 @@
|
||||
/**
|
||||
* Copyright (c) 2016 - 2020, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
/**@file
|
||||
*
|
||||
* @defgroup nrf_log Logger module
|
||||
* @{
|
||||
* @ingroup app_common
|
||||
*
|
||||
* @brief The nrf_log module interface.
|
||||
*/
|
||||
|
||||
#ifndef NRF_LOG_H_
|
||||
#define NRF_LOG_H_
|
||||
|
||||
#include "sdk_common.h"
|
||||
#include "nrf_section.h"
|
||||
#if NRF_MODULE_ENABLED(NRF_LOG)
|
||||
#include "nrf_strerror.h"
|
||||
#define NRF_LOG_ERROR_STRING_GET(code) nrf_strerror_get(code)
|
||||
#else
|
||||
#define NRF_LOG_ERROR_STRING_GET(code) ""
|
||||
#endif
|
||||
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/** @brief Severity level for the module.
|
||||
*
|
||||
* The severity level can be defined in a module to override the default.
|
||||
*/
|
||||
#ifndef NRF_LOG_LEVEL
|
||||
#define NRF_LOG_LEVEL NRF_LOG_DEFAULT_LEVEL
|
||||
#endif
|
||||
|
||||
/** @brief Initial severity if filtering is enabled.
|
||||
*/
|
||||
#ifndef NRF_LOG_INITIAL_LEVEL
|
||||
#define NRF_LOG_INITIAL_LEVEL NRF_LOG_LEVEL
|
||||
#endif
|
||||
|
||||
|
||||
#include "nrf_log_internal.h"
|
||||
|
||||
/** @def NRF_LOG_ERROR
|
||||
* @brief Macro for logging error messages. It takes a printf-like, formatted
|
||||
* string with up to seven arguments.
|
||||
*
|
||||
* @details This macro is compiled only if @ref NRF_LOG_LEVEL includes error logs.
|
||||
*/
|
||||
|
||||
/** @def NRF_LOG_WARNING
|
||||
* @brief Macro for logging error messages. It takes a printf-like, formatted
|
||||
* string with up to seven arguments.
|
||||
*
|
||||
* @details This macro is compiled only if @ref NRF_LOG_LEVEL includes warning logs.
|
||||
*/
|
||||
|
||||
/** @def NRF_LOG_INFO
|
||||
* @brief Macro for logging error messages. It takes a printf-like, formatted
|
||||
* string with up to seven arguments.
|
||||
*
|
||||
* @details This macro is compiled only if @ref NRF_LOG_LEVEL includes info logs.
|
||||
*/
|
||||
|
||||
/** @def NRF_LOG_DEBUG
|
||||
* @brief Macro for logging error messages. It takes a printf-like, formatted
|
||||
* string with up to seven arguments.
|
||||
*
|
||||
* @details This macro is compiled only if @ref NRF_LOG_LEVEL includes debug logs.
|
||||
*/
|
||||
|
||||
#define NRF_LOG_ERROR(...) NRF_LOG_INTERNAL_ERROR(__VA_ARGS__)
|
||||
#define NRF_LOG_WARNING(...) NRF_LOG_INTERNAL_WARNING( __VA_ARGS__)
|
||||
#define NRF_LOG_INFO(...) NRF_LOG_INTERNAL_INFO( __VA_ARGS__)
|
||||
#define NRF_LOG_DEBUG(...) NRF_LOG_INTERNAL_DEBUG( __VA_ARGS__)
|
||||
|
||||
/** @def NRF_LOG_INST_ERROR
|
||||
* @brief Macro for logging error messages for a given module instance. It takes a printf-like, formatted
|
||||
* string with up to seven arguments.
|
||||
*
|
||||
* @param p_inst Pointer to the instance with logging support.
|
||||
*
|
||||
* @details This macro is compiled only if @ref NRF_LOG_LEVEL includes error logs.
|
||||
*/
|
||||
|
||||
/** @def NRF_LOG_INST_WARNING
|
||||
* @brief Macro for logging error messages for a given module instance. It takes a printf-like, formatted
|
||||
* string with up to seven arguments.
|
||||
*
|
||||
* @param p_inst Pointer to the instance with logging support.
|
||||
*
|
||||
* @details This macro is compiled only if @ref NRF_LOG_LEVEL includes error logs.
|
||||
*/
|
||||
|
||||
/** @def NRF_LOG_INST_INFO
|
||||
* @brief Macro for logging error messages for a given module instance. It takes a printf-like, formatted
|
||||
* string with up to seven arguments.
|
||||
*
|
||||
* @param p_inst Pointer to the instance with logging support.
|
||||
*
|
||||
* @details This macro is compiled only if @ref NRF_LOG_LEVEL includes error logs.
|
||||
*/
|
||||
|
||||
/** @def NRF_LOG_INST_DEBUG
|
||||
* @brief Macro for logging error messages for given module instance. It takes a printf-like, formatted
|
||||
* string with up to seven arguments.
|
||||
*
|
||||
* @param p_inst Pointer to the instance with logging support.
|
||||
*
|
||||
* @details This macro is compiled only if @ref NRF_LOG_LEVEL includes error logs.
|
||||
*/
|
||||
#define NRF_LOG_INST_ERROR(p_inst,...) NRF_LOG_INTERNAL_INST_ERROR(p_inst,__VA_ARGS__)
|
||||
#define NRF_LOG_INST_WARNING(p_inst,...) NRF_LOG_INTERNAL_INST_WARNING(p_inst,__VA_ARGS__)
|
||||
#define NRF_LOG_INST_INFO(p_inst,...) NRF_LOG_INTERNAL_INST_INFO(p_inst, __VA_ARGS__)
|
||||
#define NRF_LOG_INST_DEBUG(p_inst,...) NRF_LOG_INTERNAL_INST_DEBUG(p_inst, __VA_ARGS__)
|
||||
|
||||
/**
|
||||
* @brief Macro for logging a formatted string without any prefix or timestamp.
|
||||
*/
|
||||
#define NRF_LOG_RAW_INFO(...) NRF_LOG_INTERNAL_RAW_INFO( __VA_ARGS__)
|
||||
|
||||
/** @def NRF_LOG_HEXDUMP_ERROR
|
||||
* @brief Macro for logging raw bytes.
|
||||
* @details This macro is compiled only if @ref NRF_LOG_LEVEL includes error logs.
|
||||
*
|
||||
* @param p_data Pointer to data.
|
||||
* @param len Data length in bytes.
|
||||
*/
|
||||
/** @def NRF_LOG_HEXDUMP_WARNING
|
||||
* @brief Macro for logging raw bytes.
|
||||
* @details This macro is compiled only if @ref NRF_LOG_LEVEL includes warning logs.
|
||||
*
|
||||
* @param p_data Pointer to data.
|
||||
* @param len Data length in bytes.
|
||||
*/
|
||||
/** @def NRF_LOG_HEXDUMP_INFO
|
||||
* @brief Macro for logging raw bytes.
|
||||
* @details This macro is compiled only if @ref NRF_LOG_LEVEL includes info logs.
|
||||
*
|
||||
* @param p_data Pointer to data.
|
||||
* @param len Data length in bytes.
|
||||
*/
|
||||
/** @def NRF_LOG_HEXDUMP_DEBUG
|
||||
* @brief Macro for logging raw bytes.
|
||||
* @details This macro is compiled only if @ref NRF_LOG_LEVEL includes debug logs.
|
||||
*
|
||||
* @param p_data Pointer to data.
|
||||
* @param len Data length in bytes.
|
||||
*/
|
||||
#define NRF_LOG_HEXDUMP_ERROR(p_data, len) NRF_LOG_INTERNAL_HEXDUMP_ERROR(p_data, len)
|
||||
#define NRF_LOG_HEXDUMP_WARNING(p_data, len) NRF_LOG_INTERNAL_HEXDUMP_WARNING(p_data, len)
|
||||
#define NRF_LOG_HEXDUMP_INFO(p_data, len) NRF_LOG_INTERNAL_HEXDUMP_INFO(p_data, len)
|
||||
#define NRF_LOG_HEXDUMP_DEBUG(p_data, len) NRF_LOG_INTERNAL_HEXDUMP_DEBUG(p_data, len)
|
||||
|
||||
/** @def NRF_LOG_HEXDUMP_INST_ERROR
|
||||
* @brief Macro for logging raw bytes for a specific module instance.
|
||||
* @details This macro is compiled only if @ref NRF_LOG_LEVEL includes error logs.
|
||||
*
|
||||
* @param p_inst Pointer to the instance with logging support.
|
||||
* @param p_data Pointer to data.
|
||||
* @param len Data length in bytes.
|
||||
*/
|
||||
/** @def NRF_LOG_HEXDUMP_INST_WARNING
|
||||
* @brief Macro for logging raw bytes for a specific module instance.
|
||||
* @details This macro is compiled only if @ref NRF_LOG_LEVEL includes error logs.
|
||||
*
|
||||
* @param p_inst Pointer to the instance with logging support.
|
||||
* @param p_data Pointer to data.
|
||||
* @param len Data length in bytes.
|
||||
*/
|
||||
/** @def NRF_LOG_HEXDUMP_INST_INFO
|
||||
* @brief Macro for logging raw bytes for a specific module instance.
|
||||
* @details This macro is compiled only if @ref NRF_LOG_LEVEL includes error logs.
|
||||
*
|
||||
* @param p_inst Pointer to the instance with logging support.
|
||||
* @param p_data Pointer to data.
|
||||
* @param len Data length in bytes.
|
||||
*/
|
||||
/** @def NRF_LOG_HEXDUMP_INST_DEBUG
|
||||
* @brief Macro for logging raw bytes for a specific module instance.
|
||||
* @details This macro is compiled only if @ref NRF_LOG_LEVEL includes error logs.
|
||||
*
|
||||
* @param p_inst Pointer to the instance with logging support.
|
||||
* @param p_data Pointer to data.
|
||||
* @param len Data length in bytes.
|
||||
*/
|
||||
#define NRF_LOG_HEXDUMP_INST_ERROR(p_inst, p_data, len) NRF_LOG_INTERNAL_HEXDUMP_INST_ERROR(p_inst, p_data, len)
|
||||
#define NRF_LOG_HEXDUMP_INST_WARNING(p_inst, p_data, len) NRF_LOG_INTERNAL_HEXDUMP_INST_WARNING(p_inst, p_data, len)
|
||||
#define NRF_LOG_HEXDUMP_INST_INFO(p_inst, p_data, len) NRF_LOG_INTERNAL_HEXDUMP_INST_INFO(p_inst, p_data, len)
|
||||
#define NRF_LOG_HEXDUMP_INST_DEBUG(p_inst, p_data, len) NRF_LOG_INTERNAL_HEXDUMP_INST_DEBUG(p_inst, p_data, len)
|
||||
|
||||
/**
|
||||
* @brief Macro for logging hexdump without any prefix or timestamp.
|
||||
*/
|
||||
#define NRF_LOG_RAW_HEXDUMP_INFO(p_data, len) NRF_LOG_INTERNAL_RAW_HEXDUMP_INFO(p_data, len)
|
||||
|
||||
|
||||
/**
|
||||
* @brief Macro for copying a string to internal logger buffer if logs are deferred.
|
||||
*
|
||||
* @param _str String.
|
||||
*/
|
||||
#define NRF_LOG_PUSH(_str) NRF_LOG_INTERNAL_LOG_PUSH(_str)
|
||||
|
||||
/**
|
||||
* @brief Function for copying a string to the internal logger buffer if logs are deferred.
|
||||
*
|
||||
* Use this function to store a string that is volatile (for example allocated
|
||||
* on stack) or that may change before the deferred logs are processed. Such string is copied
|
||||
* into the internal logger buffer (see @ref NRF_LOG_STR_PUSH_BUFFER_SIZE).
|
||||
*
|
||||
* @note String storing is not reliable. It means that string is copied to the buffer but there is
|
||||
* no indication when it was used and could be freed. String may be overwritten by another
|
||||
* @ref nrf_log_push call before being processed. For reliable data dumping use
|
||||
* hexdump macros (e.g. @ref NRF_LOG_HEXDUMP_INFO).
|
||||
*
|
||||
* @note If the logs are not deferred, then this function returns the input parameter.
|
||||
*
|
||||
* @param p_str Pointer to the user string.
|
||||
*
|
||||
* @return Address to the location where the string is stored in the internal logger buffer.
|
||||
*/
|
||||
char const * nrf_log_push(char * const p_str);
|
||||
|
||||
/**
|
||||
* @brief Macro to be used in a formatted string to a pass float number to the log.
|
||||
*
|
||||
* Use this macro in a formatted string instead of the %f specifier together with
|
||||
* @ref NRF_LOG_FLOAT macro.
|
||||
* Example: NRF_LOG_INFO("My float number" NRF_LOG_FLOAT_MARKER "\r\n", NRF_LOG_FLOAT(f)))
|
||||
*/
|
||||
#define NRF_LOG_FLOAT_MARKER "%s%d.%02d"
|
||||
|
||||
/**
|
||||
* @brief Macro for dissecting a float number into two numbers (integer and residuum).
|
||||
*/
|
||||
#define NRF_LOG_FLOAT(val) (uint32_t)(((val) < 0 && (val) > -1.0) ? "-" : ""), \
|
||||
(int32_t)(val), \
|
||||
(int32_t)((((val) > 0) ? (val) - (int32_t)(val) \
|
||||
: (int32_t)(val) - (val))*100)
|
||||
|
||||
|
||||
/**
|
||||
* @brief Macro for registering an independent module.
|
||||
*
|
||||
* Registration creates set of dynamic (RAM) and constant variables associated with the module.
|
||||
*/
|
||||
#define NRF_LOG_MODULE_REGISTER() NRF_LOG_INTERNAL_MODULE_REGISTER()
|
||||
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif // NRF_LOG_H_
|
||||
|
||||
/** @} */
|
||||
125
components/libraries/log/nrf_log_backend_flash.h
Normal file
125
components/libraries/log/nrf_log_backend_flash.h
Normal file
@@ -0,0 +1,125 @@
|
||||
/**
|
||||
* Copyright (c) 2018 - 2020, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
|
||||
/**@file
|
||||
*
|
||||
* @defgroup nrf_log_backend_flash Flash logger backend
|
||||
* @{
|
||||
* @ingroup nrf_log
|
||||
* @brief Flash logger backend.
|
||||
*/
|
||||
|
||||
#ifndef NRF_LOG_BACKEND_FLASH_H
|
||||
#define NRF_LOG_BACKEND_FLASH_H
|
||||
|
||||
#include "nrf_log_backend_interface.h"
|
||||
#include "nrf_fstorage.h"
|
||||
#include "nrf_log_internal.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/** @brief Flashlog logger backend API. */
|
||||
extern const nrf_log_backend_api_t nrf_log_backend_flashlog_api;
|
||||
|
||||
/** @brief Crashlog logger backend API. */
|
||||
extern const nrf_log_backend_api_t nrf_log_backend_crashlog_api;
|
||||
|
||||
/** @brief Flashlog logger backend structure. */
|
||||
typedef struct {
|
||||
nrf_log_backend_t backend;
|
||||
} nrf_log_backend_flashlog_t;
|
||||
|
||||
/** @brief Crashlog logger backend structure. */
|
||||
typedef struct {
|
||||
nrf_log_backend_t backend;
|
||||
} nrf_log_backend_crashlog_t;
|
||||
|
||||
/** @brief Macro for creating an instance of the flashlog logger backend. */
|
||||
#define NRF_LOG_BACKEND_FLASHLOG_DEF(_name) \
|
||||
NRF_LOG_BACKEND_DEF(_name, nrf_log_backend_flashlog_api, NULL)
|
||||
|
||||
/** @brief Macro for creating an instance of the crashlog logger backend. */
|
||||
#define NRF_LOG_BACKEND_CRASHLOG_DEF(_name) \
|
||||
NRF_LOG_BACKEND_DEF(_name, nrf_log_backend_crashlog_api, NULL)
|
||||
|
||||
/**
|
||||
* @brief Function for initializing the flash logger backend.
|
||||
*
|
||||
* Flash logger backend consists of two logical backends: flashlog and crashlog. Since both
|
||||
* backends write to the same flash area, the initialization is common.
|
||||
*
|
||||
* @param p_fs_api fstorage API to be used.
|
||||
*
|
||||
* @return NRF_SUCCESS or error code returned by @ref nrf_fstorage_init.
|
||||
*/
|
||||
ret_code_t nrf_log_backend_flash_init(nrf_fstorage_api_t const * p_fs_api);
|
||||
|
||||
/**
|
||||
* @brief Function for getting a log entry stored in flash.
|
||||
*
|
||||
* Log messages stored in flash can be read one by one starting from the oldest one.
|
||||
*
|
||||
* @param[in, out] p_token Token reused between consecutive readings of log entries.
|
||||
* Token must be set to 0 to read the first entry.
|
||||
* @param[out] pp_header Pointer to the entry header.
|
||||
* @param[out] pp_data Pointer to the data part of the entry (arguments or data in case of hexdump).
|
||||
*
|
||||
* @retval NRF_SUCCESS Entry was successfully read.
|
||||
* @retval NRF_ERROR_NOT_SUPPORTED fstorage API does not support direct reading.
|
||||
* @retval NRF_ERROR_NOT_FOUND Entry not found. Last entry was already reached or area is empty.
|
||||
*/
|
||||
ret_code_t nrf_log_backend_flash_next_entry_get(uint32_t * p_token,
|
||||
nrf_log_header_t * * pp_header,
|
||||
uint8_t * * pp_data);
|
||||
|
||||
/**
|
||||
* @brief Function for erasing flash area dedicated for the flash logger backend.
|
||||
*/
|
||||
ret_code_t nrf_log_backend_flash_erase(void);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif //NRF_LOG_BACKEND_UART_H
|
||||
|
||||
/** @} */
|
||||
271
components/libraries/log/nrf_log_backend_interface.h
Normal file
271
components/libraries/log/nrf_log_backend_interface.h
Normal file
@@ -0,0 +1,271 @@
|
||||
/**
|
||||
* Copyright (c) 2017 - 2020, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
#ifndef NRF_LOG_BACKEND_INTERFACE_H
|
||||
#define NRF_LOG_BACKEND_INTERFACE_H
|
||||
|
||||
/**@file
|
||||
* @addtogroup nrf_log Logger module
|
||||
* @ingroup app_common
|
||||
*
|
||||
* @defgroup nrf_log_backend_interface Logger backend interface
|
||||
* @{
|
||||
* @ingroup nrf_log
|
||||
* @brief The nrf_log backend interface.
|
||||
*/
|
||||
|
||||
#if NRF_MODULE_ENABLED(NRF_LOG)
|
||||
#include "nrf_memobj.h"
|
||||
#endif
|
||||
|
||||
#include "nrf_section.h"
|
||||
#include "nordic_common.h"
|
||||
#include <stdint.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief nrf_log entry.
|
||||
*/
|
||||
#if NRF_LOG_ENABLED
|
||||
typedef nrf_memobj_t nrf_log_entry_t;
|
||||
#else
|
||||
typedef void nrf_log_entry_t;
|
||||
#endif
|
||||
|
||||
/* Forward declaration of the nrf_log_backend_t type. */
|
||||
typedef struct nrf_log_backend_s nrf_log_backend_t;
|
||||
|
||||
/**
|
||||
* @brief Logger backend API.
|
||||
*/
|
||||
typedef struct
|
||||
{
|
||||
/**
|
||||
* @brief @ref nrf_log_backend_put
|
||||
*/
|
||||
void (*put)(nrf_log_backend_t const * p_backend, nrf_log_entry_t * p_entry);
|
||||
|
||||
/**
|
||||
* @brief @ref nrf_log_backend_panic_set
|
||||
*/
|
||||
void (*panic_set)(nrf_log_backend_t const * p_backend);
|
||||
|
||||
/**
|
||||
* @brief @ref nrf_log_backend_flush
|
||||
*/
|
||||
void (*flush)(nrf_log_backend_t const * p_backend);
|
||||
} nrf_log_backend_api_t;
|
||||
|
||||
/**
|
||||
* @brief Logger backend control block.
|
||||
*/
|
||||
typedef struct
|
||||
{
|
||||
nrf_log_backend_t const * p_next; //!< Pointer to the next backend in the logger.
|
||||
uint8_t id; //!< ID of the backend.
|
||||
bool enabled; //!< Enable flag.
|
||||
} nrf_log_backend_cb_t;
|
||||
|
||||
/**
|
||||
* @brief Logger backend structure.
|
||||
*/
|
||||
struct nrf_log_backend_s
|
||||
{
|
||||
nrf_log_backend_api_t const * p_api; //!< Pointer to interface.
|
||||
void * p_ctx; //!< User context.
|
||||
char * p_name; //!< Name of the backend.
|
||||
nrf_log_backend_cb_t * p_cb; //!< Pointer to the backend control block.
|
||||
};
|
||||
|
||||
|
||||
#define NRF_LOG_BACKEND_SECTION_NAME log_backends
|
||||
|
||||
#define NRF_LOG_BACKEND_SUBSECTION_NAME(_name) NRF_LOG_BACKEND_SECTION_NAME
|
||||
|
||||
/** @brief Invalid ID value indicating that logger backend is not attached to the logger frontend.*/
|
||||
#define NRF_LOG_BACKEND_INVALID_ID 0xFF
|
||||
|
||||
/** @brief Memory section where backends are located. */
|
||||
NRF_SECTION_DEF(NRF_LOG_BACKEND_SECTION_NAME, nrf_log_backend_t);
|
||||
|
||||
/**
|
||||
* @brief Macro for creating a logger backend instance.
|
||||
*
|
||||
* @param _name Name of the backend instance.
|
||||
* @param _api Logger backend API.
|
||||
* @param _p_ctx Pointer to the user context.
|
||||
*/
|
||||
#define NRF_LOG_BACKEND_DEF(_name, _api, _p_ctx) \
|
||||
static nrf_log_backend_cb_t CONCAT_2(log_backend_cb_, _name) = { \
|
||||
.enabled = false, \
|
||||
.id = NRF_LOG_BACKEND_INVALID_ID, \
|
||||
.p_next = NULL \
|
||||
}; \
|
||||
NRF_SECTION_ITEM_REGISTER(NRF_LOG_BACKEND_SUBSECTION_NAME(_name), \
|
||||
static const nrf_log_backend_t _name) = { \
|
||||
.p_api = &_api, \
|
||||
.p_ctx = _p_ctx, \
|
||||
.p_cb = &CONCAT_2(log_backend_cb_, _name), \
|
||||
.p_name = (char *)STRINGIFY(_name) \
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @brief Function for putting message with log entry to the backend.
|
||||
*
|
||||
* @param[in] p_backend Pointer to the backend instance.
|
||||
* @param[in] p_msg Pointer to message with log entry.
|
||||
*/
|
||||
__STATIC_INLINE void nrf_log_backend_put(nrf_log_backend_t const * const p_backend,
|
||||
nrf_log_entry_t * p_msg);
|
||||
|
||||
/**
|
||||
* @brief Function for reconfiguring backend to panic mode.
|
||||
*
|
||||
* @param[in] p_backend Pointer to the backend instance.
|
||||
*/
|
||||
__STATIC_INLINE void nrf_log_backend_panic_set(nrf_log_backend_t const * const p_backend);
|
||||
|
||||
/**
|
||||
* @brief Function for flushing backend.
|
||||
*
|
||||
* On flushing request backend should release log message(s).
|
||||
*
|
||||
* @param[in] p_backend Pointer to the backend instance.
|
||||
*/
|
||||
__STATIC_INLINE void nrf_log_backend_flush(nrf_log_backend_t const * const p_backend);
|
||||
|
||||
|
||||
/**
|
||||
* @brief Function for setting backend id.
|
||||
*
|
||||
* @note It is used internally by the logger.
|
||||
*
|
||||
* @param[in] p_backend Pointer to the backend instance.
|
||||
* @param[in] id Id.
|
||||
*/
|
||||
__STATIC_INLINE void nrf_log_backend_id_set(nrf_log_backend_t const * const p_backend, uint8_t id);
|
||||
|
||||
/**
|
||||
* @brief Function for getting backend id.
|
||||
*
|
||||
* @note It is used internally by the logger.
|
||||
*
|
||||
* @param[in] p_backend Pointer to the backend instance.
|
||||
* @return Id.
|
||||
*/
|
||||
__STATIC_INLINE uint8_t nrf_log_backend_id_get(nrf_log_backend_t const * const p_backend);
|
||||
|
||||
/**
|
||||
* @brief Function for enabling backend.
|
||||
*
|
||||
* @param[in] p_backend Pointer to the backend instance.
|
||||
*/
|
||||
__STATIC_INLINE void nrf_log_backend_enable(nrf_log_backend_t const * const p_backend);
|
||||
|
||||
/**
|
||||
* @brief Function for disabling backend.
|
||||
*
|
||||
* @param[in] p_backend Pointer to the backend instance.
|
||||
*/
|
||||
__STATIC_INLINE void nrf_log_backend_disable(nrf_log_backend_t const * const p_backend);
|
||||
|
||||
/**
|
||||
* @brief Function for checking state of the backend.
|
||||
*
|
||||
* @param[in] p_backend Pointer to the backend instance.
|
||||
*
|
||||
* @return True if backend is enabled, false otherwise.
|
||||
*/
|
||||
__STATIC_INLINE bool nrf_log_backend_is_enabled(nrf_log_backend_t const * const p_backend);
|
||||
|
||||
#ifndef SUPPRESS_INLINE_IMPLEMENTATION
|
||||
__STATIC_INLINE void nrf_log_backend_put(nrf_log_backend_t const * const p_backend,
|
||||
nrf_log_entry_t * p_msg)
|
||||
{
|
||||
p_backend->p_api->put(p_backend, p_msg);
|
||||
}
|
||||
|
||||
__STATIC_INLINE void nrf_log_backend_panic_set(nrf_log_backend_t const * const p_backend)
|
||||
{
|
||||
p_backend->p_api->panic_set(p_backend);
|
||||
}
|
||||
|
||||
__STATIC_INLINE void nrf_log_backend_flush(nrf_log_backend_t const * const p_backend)
|
||||
{
|
||||
p_backend->p_api->flush(p_backend);
|
||||
}
|
||||
|
||||
__STATIC_INLINE void nrf_log_backend_id_set(nrf_log_backend_t const * const p_backend, uint8_t id)
|
||||
{
|
||||
p_backend->p_cb->id = id;
|
||||
}
|
||||
|
||||
__STATIC_INLINE uint8_t nrf_log_backend_id_get(nrf_log_backend_t const * const p_backend)
|
||||
{
|
||||
return p_backend->p_cb->id;
|
||||
}
|
||||
|
||||
__STATIC_INLINE void nrf_log_backend_enable(nrf_log_backend_t const * const p_backend)
|
||||
{
|
||||
p_backend->p_cb->enabled = true;
|
||||
}
|
||||
|
||||
__STATIC_INLINE void nrf_log_backend_disable(nrf_log_backend_t const * const p_backend)
|
||||
{
|
||||
p_backend->p_cb->enabled = false;
|
||||
}
|
||||
|
||||
__STATIC_INLINE bool nrf_log_backend_is_enabled(nrf_log_backend_t const * const p_backend)
|
||||
{
|
||||
return p_backend->p_cb->enabled;
|
||||
}
|
||||
|
||||
#endif // SUPPRESS_INLINE_IMPLEMENTATION
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif //NRF_LOG_BACKEND_INTERFACE_H
|
||||
|
||||
/** @} */
|
||||
80
components/libraries/log/nrf_log_backend_rtt.h
Normal file
80
components/libraries/log/nrf_log_backend_rtt.h
Normal file
@@ -0,0 +1,80 @@
|
||||
/**
|
||||
* Copyright (c) 2017 - 2020, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
|
||||
/**@file
|
||||
*
|
||||
* @defgroup nrf_log_backend_rtt Log RTT backend
|
||||
* @{
|
||||
* @ingroup nrf_log
|
||||
* @brief Log RTT backend.
|
||||
*/
|
||||
|
||||
#ifndef NRF_LOG_BACKEND_RTT_H
|
||||
#define NRF_LOG_BACKEND_RTT_H
|
||||
|
||||
#include "nrf_log_backend_interface.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
extern const nrf_log_backend_api_t nrf_log_backend_rtt_api;
|
||||
|
||||
typedef struct {
|
||||
nrf_log_backend_t backend;
|
||||
} nrf_log_backend_rtt_t;
|
||||
|
||||
/**
|
||||
* @brief RTT backend definition
|
||||
*
|
||||
* @param _name Name of the instance.
|
||||
*/
|
||||
#define NRF_LOG_BACKEND_RTT_DEF(_name) \
|
||||
NRF_LOG_BACKEND_DEF(_name, nrf_log_backend_rtt_api, NULL)
|
||||
|
||||
void nrf_log_backend_rtt_init(void);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif //NRF_LOG_BACKEND_RTT_H
|
||||
|
||||
/** @} */
|
||||
75
components/libraries/log/nrf_log_backend_uart.h
Normal file
75
components/libraries/log/nrf_log_backend_uart.h
Normal file
@@ -0,0 +1,75 @@
|
||||
/**
|
||||
* Copyright (c) 2016 - 2020, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
|
||||
/**@file
|
||||
*
|
||||
* @defgroup nrf_log_backend_uart Log UART backend
|
||||
* @{
|
||||
* @ingroup nrf_log
|
||||
* @brief Log UART backend.
|
||||
*/
|
||||
|
||||
#ifndef NRF_LOG_BACKEND_UART_H
|
||||
#define NRF_LOG_BACKEND_UART_H
|
||||
|
||||
#include "nrf_log_backend_interface.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
extern const nrf_log_backend_api_t nrf_log_backend_uart_api;
|
||||
|
||||
typedef struct {
|
||||
nrf_log_backend_t backend;
|
||||
} nrf_log_backend_uart_t;
|
||||
|
||||
#define NRF_LOG_BACKEND_UART_DEF(_name) \
|
||||
NRF_LOG_BACKEND_DEF(_name, nrf_log_backend_uart_api, NULL)
|
||||
|
||||
void nrf_log_backend_uart_init(void);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif //NRF_LOG_BACKEND_UART_H
|
||||
|
||||
/** @} */
|
||||
243
components/libraries/log/nrf_log_ctrl.h
Normal file
243
components/libraries/log/nrf_log_ctrl.h
Normal file
@@ -0,0 +1,243 @@
|
||||
/**
|
||||
* Copyright (c) 2016 - 2020, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
#ifndef NRF_LOG_CTRL_H
|
||||
#define NRF_LOG_CTRL_H
|
||||
|
||||
/**@file
|
||||
* @addtogroup nrf_log Logger module
|
||||
* @ingroup app_common
|
||||
*
|
||||
* @defgroup nrf_log_ctrl Functions for controlling nrf_log
|
||||
* @{
|
||||
* @ingroup nrf_log
|
||||
* @brief The nrf_log control interface.
|
||||
*/
|
||||
|
||||
#include "sdk_config.h"
|
||||
#include "sdk_errors.h"
|
||||
#include <stdint.h>
|
||||
#include <stdbool.h>
|
||||
#include "nrf_log_types.h"
|
||||
#include "nrf_log_ctrl_internal.h"
|
||||
#include "nrf_log_backend_interface.h"
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief Timestamp function prototype.
|
||||
*
|
||||
* @return Timestamp value.
|
||||
*/
|
||||
typedef uint32_t (*nrf_log_timestamp_func_t)(void);
|
||||
|
||||
|
||||
/**@brief Macro for initializing the logs.
|
||||
*
|
||||
* Macro has one or two parameters. First parameter (obligatory) is the timestamp function (@ref nrf_log_timestamp_func_t).
|
||||
* Additionally, as the second parameter timestamp frequency in Hz can be provided. If not provided then default
|
||||
* frequency is used (@ref NRF_LOG_TIMESTAMP_DEFAULT_FREQUENCY). Frequency is used to format timestamp prefix if
|
||||
* @ref NRF_LOG_STR_FORMATTER_TIMESTAMP_FORMAT_ENABLED is set.
|
||||
*
|
||||
* @return NRF_SUCCESS after successful initialization, otherwise an error code.
|
||||
*/
|
||||
#define NRF_LOG_INIT(...) NRF_LOG_INTERNAL_INIT(__VA_ARGS__)
|
||||
|
||||
|
||||
/**@brief Macro for processing a single log entry from a queue of deferred logs.
|
||||
*
|
||||
* You can call this macro from the main context or from the error handler to process
|
||||
* log entries one by one.
|
||||
*
|
||||
* @note If logs are not deferred, this call has no use and is defined as 'false'.
|
||||
*
|
||||
* @retval true There are more logs to process in the buffer.
|
||||
* @retval false No more logs in the buffer.
|
||||
*/
|
||||
#define NRF_LOG_PROCESS() NRF_LOG_INTERNAL_PROCESS()
|
||||
|
||||
/** @brief Macro for processing all log entries from the buffer.
|
||||
* It blocks until all buffered entries are processed by the backend.
|
||||
*
|
||||
* @note If logs are not deferred, this call has no use and is empty.
|
||||
*/
|
||||
#define NRF_LOG_FLUSH() NRF_LOG_INTERNAL_FLUSH()
|
||||
|
||||
/** @brief Macro for flushing log data before reset.
|
||||
*
|
||||
* @note If logs are not deferred, this call has no use and is empty.
|
||||
*
|
||||
* @note If RTT is used, then a breakpoint is hit once flushed.
|
||||
*/
|
||||
#define NRF_LOG_FINAL_FLUSH() NRF_LOG_INTERNAL_FINAL_FLUSH()
|
||||
|
||||
/**
|
||||
* @brief Function for initializing the frontend and the default backend.
|
||||
*
|
||||
* @ref NRF_LOG_INIT calls this function to initialize the frontend and the backend.
|
||||
* If custom backend is used, then @ref NRF_LOG_INIT should not be called.
|
||||
* Instead, frontend and user backend should be verbosely initialized.
|
||||
*
|
||||
* @param timestamp_func Function for getting a 32-bit timestamp.
|
||||
* @param timestamp_freq Frequency of the timestamp.
|
||||
*
|
||||
* @return Error status.
|
||||
*
|
||||
*/
|
||||
ret_code_t nrf_log_init(nrf_log_timestamp_func_t timestamp_func, uint32_t timestamp_freq);
|
||||
|
||||
/**
|
||||
* @brief Function for adding new backend interface to the logger.
|
||||
*
|
||||
* @param p_backend Pointer to the backend interface.
|
||||
* @param severity Initial value of severity level for each module forwarded to the backend. This
|
||||
* option is only applicable if @ref NRF_LOG_FILTERS_ENABLED is set.
|
||||
* @return -1 if backend cannot be added or positive number (backend ID).
|
||||
*/
|
||||
int32_t nrf_log_backend_add(nrf_log_backend_t const * p_backend, nrf_log_severity_t severity);
|
||||
|
||||
/**
|
||||
* @brief Function for removing backend from the logger.
|
||||
*
|
||||
* @param p_backend Pointer to the backend interface.
|
||||
*
|
||||
*/
|
||||
void nrf_log_backend_remove(nrf_log_backend_t const * p_backend);
|
||||
|
||||
/**
|
||||
* @brief Function for setting logger backends into panic mode.
|
||||
*
|
||||
* When this function is called all attached backends are informed about panic state of the system.
|
||||
* It is up to the backend to react properly (hold or process logs in blocking mode, etc.)
|
||||
*/
|
||||
void nrf_log_panic(void);
|
||||
|
||||
/**
|
||||
* @brief Function for handling a single log entry.
|
||||
*
|
||||
* Use this function only if the logs are buffered. It takes a single entry from the
|
||||
* buffer and attempts to process it.
|
||||
*
|
||||
* @retval true If there are more entries to process.
|
||||
* @retval false If there are no more entries to process.
|
||||
*/
|
||||
bool nrf_log_frontend_dequeue(void);
|
||||
|
||||
/**
|
||||
* @brief Function for getting number of independent log modules registered into the logger.
|
||||
*
|
||||
* @return Number of registered modules.
|
||||
*/
|
||||
uint32_t nrf_log_module_cnt_get(void);
|
||||
|
||||
/**
|
||||
* @brief Function for getting module name.
|
||||
*
|
||||
* @param module_id Module ID.
|
||||
* @param is_ordered_idx Module ID is given is index in alphabetically sorted list of modules.
|
||||
* @return Pointer to string with module name.
|
||||
*/
|
||||
const char * nrf_log_module_name_get(uint32_t module_id, bool is_ordered_idx);
|
||||
|
||||
/**
|
||||
* @brief Function for getting coloring of specific logs.
|
||||
*
|
||||
* @param module_id Module ID.
|
||||
* @param severity Log severity.
|
||||
*
|
||||
* @return ID of the color.
|
||||
*/
|
||||
uint8_t nrf_log_color_id_get(uint32_t module_id, nrf_log_severity_t severity);
|
||||
|
||||
/**
|
||||
* @brief Function for configuring filtering ofs logs in the module.
|
||||
*
|
||||
* Filtering of logs in modules is independent for each backend.
|
||||
*
|
||||
* @param backend_id Backend ID which want to chenge its configuration.
|
||||
* @param module_id Module ID which logs will be reconfigured.
|
||||
* @param severity New severity filter.
|
||||
*/
|
||||
void nrf_log_module_filter_set(uint32_t backend_id,
|
||||
uint32_t module_id,
|
||||
nrf_log_severity_t severity);
|
||||
|
||||
/**
|
||||
* @brief Function for getting module severity level.
|
||||
*
|
||||
* @param backend_id Backend ID.
|
||||
* @param module_id Module ID.
|
||||
* @param is_ordered_idx Module ID is given is index in alphabetically sorted list of modules.
|
||||
* @param dynamic It true current filter for given backend is returned. If false then
|
||||
* compiled-in level is returned (maximum available). If this parameter is
|
||||
* false then backend_id parameter is not used.
|
||||
*
|
||||
* @return Severity.
|
||||
*/
|
||||
nrf_log_severity_t nrf_log_module_filter_get(uint32_t backend_id,
|
||||
uint32_t module_id,
|
||||
bool is_ordered_idx,
|
||||
bool dynamic);
|
||||
|
||||
/**
|
||||
* @brief Function stores current filtering configuration into non-volatile memory using @ref fds module.
|
||||
*
|
||||
* @return NRF_SUCCESS or @ref fds error code.
|
||||
*/
|
||||
ret_code_t nrf_log_config_store(void);
|
||||
|
||||
/**
|
||||
* @brief Function loads configuration from non-volatile memory using @ref fds module.
|
||||
*
|
||||
* @retval NRF_SUCCESS On successful loading.
|
||||
* @retval NRF_ERROR_NOT_FOUND Configuration file not found.
|
||||
* @retval NRF_ERROR_INTERNAL Other @ref fds error on reading configuration file.
|
||||
*/
|
||||
ret_code_t nrf_log_config_load(void);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif // NRF_LOG_CTRL_H
|
||||
|
||||
/**
|
||||
*@}
|
||||
**/
|
||||
81
components/libraries/log/nrf_log_default_backends.h
Normal file
81
components/libraries/log/nrf_log_default_backends.h
Normal file
@@ -0,0 +1,81 @@
|
||||
/**
|
||||
* Copyright (c) 2017 - 2020, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
#ifndef NRF_LOG_DEFAULT_BACKENDS_H__
|
||||
#define NRF_LOG_DEFAULT_BACKENDS_H__
|
||||
|
||||
/**@file
|
||||
* @addtogroup nrf_log Logger module
|
||||
* @ingroup app_common
|
||||
*
|
||||
* @defgroup nrf_log_default_backends Functions for initializing and adding default backends
|
||||
* @{
|
||||
* @ingroup nrf_log
|
||||
* @brief The nrf_log default backends.
|
||||
*/
|
||||
|
||||
#include "sdk_config.h"
|
||||
#include "sdk_errors.h"
|
||||
#include <stdbool.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @def NRF_LOG_DEFAULT_BACKENDS_INIT
|
||||
* @brief Macro for initializing default backends.
|
||||
*
|
||||
* Each backend enabled in configuration is initialized and added as a backend to the logger.
|
||||
*/
|
||||
#if NRF_LOG_ENABLED
|
||||
#define NRF_LOG_DEFAULT_BACKENDS_INIT() nrf_log_default_backends_init()
|
||||
#else
|
||||
#define NRF_LOG_DEFAULT_BACKENDS_INIT()
|
||||
#endif
|
||||
|
||||
void nrf_log_default_backends_init(void);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
/** @} */
|
||||
|
||||
#endif // NRF_LOG_DEFAULT_BACKENDS_H__
|
||||
163
components/libraries/log/nrf_log_instance.h
Normal file
163
components/libraries/log/nrf_log_instance.h
Normal file
@@ -0,0 +1,163 @@
|
||||
/**
|
||||
* Copyright (c) 2018 - 2020, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
#ifndef NRF_LOG_INSTANCE_H
|
||||
#define NRF_LOG_INSTANCE_H
|
||||
|
||||
#include "sdk_config.h"
|
||||
#include "nrf_section.h"
|
||||
#include "nrf_log_types.h"
|
||||
#include <stdint.h>
|
||||
|
||||
|
||||
/*
|
||||
* For GCC, sections are sorted in the group by the linker. For IAR and KEIL, it is assumed that linker will sort
|
||||
* dynamic and const section in the same order (but in different locations). Proper message formatting
|
||||
* is based on that assumption.
|
||||
*/
|
||||
#if defined(__GNUC__)
|
||||
#define NRF_LOG_DYNAMIC_SECTION_NAME(_module_name) CONCAT_2(log_dynamic_data_,_module_name)
|
||||
#define NRF_LOG_FILTER_SECTION_NAME(_module_name) CONCAT_2(log_filter_data_,_module_name)
|
||||
#define NRF_LOG_CONST_SECTION_NAME(_module_name) CONCAT_2(log_const_data_,_module_name)
|
||||
#else
|
||||
#define NRF_LOG_DYNAMIC_SECTION_NAME(_module_name) log_dynamic_data
|
||||
#define NRF_LOG_FILTER_SECTION_NAME(_module_name) log_filter_data
|
||||
#define NRF_LOG_CONST_SECTION_NAME(_module_name) log_const_data
|
||||
#endif
|
||||
|
||||
#define NRF_LOG_ITEM_DATA(_name) CONCAT_3(m_nrf_log_,_name,_logs_data)
|
||||
#define NRF_LOG_ITEM_DATA_DYNAMIC(_name) CONCAT_2(NRF_LOG_ITEM_DATA(_name),_dynamic)
|
||||
#define NRF_LOG_ITEM_DATA_FILTER(_name) CONCAT_2(NRF_LOG_ITEM_DATA(_name),_filter)
|
||||
#define NRF_LOG_ITEM_DATA_CONST(_name) CONCAT_2(NRF_LOG_ITEM_DATA(_name),_const)
|
||||
|
||||
#ifdef UNIT_TEST
|
||||
#define _CONST
|
||||
#else
|
||||
#define _CONST const
|
||||
#endif
|
||||
|
||||
/*lint -save -esym(526,log_const_data*) -esym(526,log_dynamic_data*)*/
|
||||
NRF_SECTION_DEF(log_dynamic_data, nrf_log_module_dynamic_data_t);
|
||||
NRF_SECTION_DEF(log_filter_data, nrf_log_module_filter_data_t);
|
||||
NRF_SECTION_DEF(log_const_data, nrf_log_module_const_data_t);
|
||||
/*lint -restore*/
|
||||
|
||||
#define NRF_LOG_INTERNAL_CONST_ITEM_REGISTER( \
|
||||
_name, _str_name, _info_color, _debug_color, _initial_lvl, _compiled_lvl) \
|
||||
NRF_SECTION_ITEM_REGISTER(NRF_LOG_CONST_SECTION_NAME(_name), \
|
||||
_CONST nrf_log_module_const_data_t NRF_LOG_ITEM_DATA_CONST(_name)) = { \
|
||||
.p_module_name = _str_name, \
|
||||
.info_color_id = (_info_color), \
|
||||
.debug_color_id = (_debug_color), \
|
||||
.compiled_lvl = (nrf_log_severity_t)(_compiled_lvl), \
|
||||
.initial_lvl = (nrf_log_severity_t)(_initial_lvl), \
|
||||
}
|
||||
|
||||
#if NRF_LOG_FILTERS_ENABLED
|
||||
#define NRF_LOG_INTERNAL_ITEM_REGISTER( \
|
||||
_name, _str_name, _info_color, _debug_color, _initial_lvl, _compiled_lvl) \
|
||||
NRF_LOG_INTERNAL_CONST_ITEM_REGISTER(_name, \
|
||||
_str_name, \
|
||||
_info_color, \
|
||||
_debug_color, \
|
||||
_initial_lvl, \
|
||||
_compiled_lvl); \
|
||||
NRF_SECTION_ITEM_REGISTER(NRF_LOG_DYNAMIC_SECTION_NAME(_name), \
|
||||
nrf_log_module_dynamic_data_t NRF_LOG_ITEM_DATA_DYNAMIC(_name)); \
|
||||
NRF_SECTION_ITEM_REGISTER(NRF_LOG_FILTER_SECTION_NAME(_name), \
|
||||
nrf_log_module_filter_data_t NRF_LOG_ITEM_DATA_FILTER(_name))
|
||||
|
||||
#else
|
||||
#define NRF_LOG_INTERNAL_ITEM_REGISTER( \
|
||||
_name, _str_name, _info_color, _debug_color, _initial_lvl, _compiled_lvl) \
|
||||
NRF_LOG_INTERNAL_CONST_ITEM_REGISTER(_name, \
|
||||
_str_name, \
|
||||
_info_color, \
|
||||
_debug_color, \
|
||||
_initial_lvl, \
|
||||
_compiled_lvl)
|
||||
|
||||
#endif
|
||||
/**@file
|
||||
*
|
||||
* @defgroup nrf_log_instance Macros for logging on instance level
|
||||
* @{
|
||||
* @ingroup nrf_log
|
||||
*
|
||||
* @brief Macros for logging on instance level
|
||||
*/
|
||||
|
||||
/** @def NRF_LOG_INSTANCE_PTR_DECLARE
|
||||
* @brief Macro for declaring a logger instance pointer in the module stucture.
|
||||
*/
|
||||
|
||||
/** @def NRF_LOG_INSTANCE_REGISTER
|
||||
* @brief Macro for creating an independent module instance.
|
||||
*
|
||||
* Module instance provides filtering of logs on instance level instead of module level.
|
||||
*/
|
||||
|
||||
/** @def NRF_LOG_INSTANCE_PTR_INIT
|
||||
* @brief Macro for initializing a pointer to the logger instance.
|
||||
*/
|
||||
|
||||
|
||||
/** @} */
|
||||
#if NRF_LOG_ENABLED && NRF_LOG_FILTERS_ENABLED
|
||||
#define NRF_LOG_INSTANCE_PTR_DECLARE(_p_name) nrf_log_module_dynamic_data_t * _p_name;
|
||||
|
||||
#define NRF_LOG_INSTANCE_REGISTER( \
|
||||
_module_name, _inst_name, _info_color, _debug_color, _initial_lvl, _compiled_lvl) \
|
||||
NRF_LOG_INTERNAL_ITEM_REGISTER(CONCAT_3(_module_name,_,_inst_name), \
|
||||
STRINGIFY(_module_name._inst_name), \
|
||||
_info_color, \
|
||||
_debug_color, \
|
||||
_initial_lvl, \
|
||||
_compiled_lvl)
|
||||
|
||||
#define NRF_LOG_INSTANCE_PTR_INIT(_p_name, _module_name, _inst_name) \
|
||||
._p_name = &NRF_LOG_ITEM_DATA_DYNAMIC(CONCAT_3(_module_name,_,_inst_name)),
|
||||
|
||||
#else
|
||||
#define NRF_LOG_INSTANCE_PTR_DECLARE(_p_name)
|
||||
#define NRF_LOG_INSTANCE_REGISTER(_module_name, _inst_name, info_color, debug_color, _initial_lvl, compiled_lvl)
|
||||
#define NRF_LOG_INSTANCE_PTR_INIT(_p_name, _module_name, _inst_name)
|
||||
#endif
|
||||
|
||||
#endif //NRF_LOG_INSTANCE_H
|
||||
86
components/libraries/log/nrf_log_str_formatter.h
Normal file
86
components/libraries/log/nrf_log_str_formatter.h
Normal file
@@ -0,0 +1,86 @@
|
||||
/**
|
||||
* Copyright (c) 2016 - 2020, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
|
||||
/**@file
|
||||
*
|
||||
* @defgroup nrf_log_str_formatter String formatter for the logger messages
|
||||
* @{
|
||||
* @ingroup nrf_log
|
||||
*/
|
||||
|
||||
#ifndef NRF_LOG_STR_FORMATTER_H
|
||||
#define NRF_LOG_STR_FORMATTER_H
|
||||
|
||||
#include <stdint.h>
|
||||
#include "nrf_fprintf.h"
|
||||
#include "nrf_log_ctrl.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
typedef struct
|
||||
{
|
||||
uint32_t timestamp;
|
||||
uint16_t module_id;
|
||||
uint16_t dropped;
|
||||
nrf_log_severity_t severity;
|
||||
uint8_t use_colors;
|
||||
} nrf_log_str_formatter_entry_params_t;
|
||||
|
||||
|
||||
void nrf_log_std_entry_process(char const * p_str,
|
||||
uint32_t const * p_args,
|
||||
uint32_t nargs,
|
||||
nrf_log_str_formatter_entry_params_t * p_params,
|
||||
nrf_fprintf_ctx_t * p_ctx);
|
||||
|
||||
void nrf_log_hexdump_entry_process(uint8_t * p_data,
|
||||
uint32_t data_len,
|
||||
nrf_log_str_formatter_entry_params_t * p_params,
|
||||
nrf_fprintf_ctx_t * p_ctx);
|
||||
|
||||
void nrf_log_str_formatter_timestamp_freq_set(uint32_t freq);
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif //NRF_LOG_STR_FORMATTER_H
|
||||
/** @} */
|
||||
93
components/libraries/log/nrf_log_types.h
Normal file
93
components/libraries/log/nrf_log_types.h
Normal file
@@ -0,0 +1,93 @@
|
||||
/**
|
||||
* Copyright (c) 2018 - 2020, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
#ifndef NRF_LOG_TYPES_H
|
||||
#define NRF_LOG_TYPES_H
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
/**
|
||||
* @brief Logger severity levels.
|
||||
*/
|
||||
typedef enum
|
||||
{
|
||||
NRF_LOG_SEVERITY_NONE,
|
||||
NRF_LOG_SEVERITY_ERROR,
|
||||
NRF_LOG_SEVERITY_WARNING,
|
||||
NRF_LOG_SEVERITY_INFO,
|
||||
NRF_LOG_SEVERITY_DEBUG,
|
||||
NRF_LOG_SEVERITY_INFO_RAW, /* Artificial level to pass information about skipping string postprocessing.*/
|
||||
} nrf_log_severity_t;
|
||||
|
||||
/**
|
||||
* @brief Structure holding dynamic data associated with a module.
|
||||
*
|
||||
* See @ref NRF_LOG_MODULE_REGISTER and @ref NRF_LOG_INSTANCE_REGISTER.
|
||||
*/
|
||||
typedef struct
|
||||
{
|
||||
uint16_t order_idx; ///< Ordered index of the module (used for auto-completion).
|
||||
uint16_t filter; ///< Current highest severity level accepted (redundant to @ref nrf_log_module_filter_data_t::filter_lvls, used for optimization)
|
||||
} nrf_log_module_dynamic_data_t;
|
||||
|
||||
/**
|
||||
* @brief Structure holding dynamic filters associated with a module or instance if filtering is enabled (@ref NRF_LOG_FILTERS_ENABLED).
|
||||
*
|
||||
* @note Backend filters logically are part of @ref nrf_log_module_dynamic_data_t but they are kept separated to enable storing them in non-volatile memory.
|
||||
*/
|
||||
typedef struct
|
||||
{
|
||||
uint32_t filter_lvls; ///< Current severity levels for each backend (3 bits per backend).
|
||||
} nrf_log_module_filter_data_t;
|
||||
|
||||
/**
|
||||
* @brief Structure holding constant data associated with a module or instance.
|
||||
*
|
||||
* See @ref NRF_LOG_MODULE_REGISTER and @ref NRF_LOG_INSTANCE_REGISTER.
|
||||
*/
|
||||
typedef struct
|
||||
{
|
||||
const char * p_module_name; ///< Module or instance name.
|
||||
uint8_t info_color_id; ///< Color code of info messages.
|
||||
uint8_t debug_color_id; ///< Color code of debug messages.
|
||||
nrf_log_severity_t compiled_lvl; ///< Compiled highest severity level.
|
||||
nrf_log_severity_t initial_lvl; ///< Severity level for given module or instance set on backend initialization.
|
||||
} nrf_log_module_const_data_t;
|
||||
|
||||
#endif //NRF_LOG_TYPES_H
|
||||
740
components/libraries/log/src/nrf_log_backend_flash.c
Normal file
740
components/libraries/log/src/nrf_log_backend_flash.c
Normal file
@@ -0,0 +1,740 @@
|
||||
/**
|
||||
* Copyright (c) 2016 - 2020, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
#include "sdk_common.h"
|
||||
#if NRF_MODULE_ENABLED(NRF_LOG) && NRF_MODULE_ENABLED(NRF_LOG_BACKEND_FLASH)
|
||||
#include "nrf_log_backend_flash.h"
|
||||
#include "nrf_log_str_formatter.h"
|
||||
#include "nrf_fstorage_nvmc.h"
|
||||
#include "nrf_log.h"
|
||||
#include "nrf_atomic.h"
|
||||
#include "nrf_queue.h"
|
||||
#include "app_error.h"
|
||||
#include <stdbool.h>
|
||||
|
||||
#if (NRF_LOG_BACKEND_FLASHLOG_ENABLED == 0) && (NRF_LOG_BACKEND_CRASHLOG_ENABLED == 0)
|
||||
#error "No flash backend enabled."
|
||||
#endif
|
||||
|
||||
/** @brief Maximum logger message payload (arguments or data in hexdump) which can be stored. */
|
||||
#define FLASH_LOG_MAX_PAYLOAD_SIZE (NRF_LOG_BACKEND_FLASH_SER_BUFFER_SIZE - sizeof(nrf_log_header_t))
|
||||
|
||||
/** @brief Size of serialization buffer in words. */
|
||||
#define FLASH_LOG_SER_BUFFER_WORDS (NRF_LOG_BACKEND_FLASH_SER_BUFFER_SIZE/sizeof(uint32_t))
|
||||
|
||||
/** @brief Length of logger header. */
|
||||
#define LOG_HEADER_LEN (sizeof(nrf_log_header_t))
|
||||
|
||||
/** @brief Length of logger header given in 32 bit words. */
|
||||
#define LOG_HEADER_LEN_WORDS (LOG_HEADER_LEN/sizeof(uint32_t))
|
||||
|
||||
/** @brief Maximum possible length of standard log message. */
|
||||
#define STD_LOG_MSG_MAX_LEN (LOG_HEADER_LEN + NRF_LOG_MAX_NUM_OF_ARGS*sizeof(uint32_t))
|
||||
|
||||
/* Buffer must be multiple of 4. */
|
||||
STATIC_ASSERT((NRF_LOG_BACKEND_FLASH_SER_BUFFER_SIZE % sizeof(uint32_t)) == 0);
|
||||
|
||||
/* Buffer must fit standard log message. */
|
||||
STATIC_ASSERT(NRF_LOG_BACKEND_FLASH_SER_BUFFER_SIZE >= STD_LOG_MSG_MAX_LEN);
|
||||
|
||||
/** @brief Flash page size in bytes. */
|
||||
#define CODE_PAGE_SIZE 4096
|
||||
|
||||
/** @brief Start address of the area dedicated for flash log. */
|
||||
#define FLASH_LOG_START_ADDR (NRF_LOG_BACKEND_FLASH_START_PAGE * CODE_PAGE_SIZE)
|
||||
|
||||
/** @brief End address of the area dedicated for flash log. */
|
||||
#define FLASH_LOG_END_ADDR (FLASH_LOG_START_ADDR + (NRF_LOG_BACKEND_PAGES * CODE_PAGE_SIZE) - 1)
|
||||
|
||||
/** @brief Size of the area dedicated for flash log. */
|
||||
#define FLASH_LOG_SIZE (NRF_LOG_BACKEND_PAGES * CODE_PAGE_SIZE)
|
||||
|
||||
/** @brief Start address determined in runtime.
|
||||
*
|
||||
* If configuration indicates that flash log should be placed after application.
|
||||
* */
|
||||
#if defined ( __CC_ARM )
|
||||
#define RUNTIME_START_ADDR \
|
||||
_Pragma("diag_suppress 170") \
|
||||
((NRF_LOG_BACKEND_FLASH_START_PAGE == 0) ? \
|
||||
(CODE_PAGE_SIZE*CEIL_DIV((uint32_t)CODE_END, CODE_PAGE_SIZE)) : FLASH_LOG_START_ADDR) \
|
||||
_Pragma("diag_default 170")
|
||||
#else
|
||||
#define RUNTIME_START_ADDR ((NRF_LOG_BACKEND_FLASH_START_PAGE == 0) ? \
|
||||
(CODE_PAGE_SIZE*CEIL_DIV((uint32_t)CODE_END, CODE_PAGE_SIZE)) : FLASH_LOG_START_ADDR)
|
||||
#endif
|
||||
static void fstorage_evt_handler(nrf_fstorage_evt_t * p_evt);
|
||||
|
||||
/** @brief Message queue for run time flash log. */
|
||||
#if NRF_LOG_BACKEND_FLASHLOG_ENABLED
|
||||
NRF_QUEUE_DEF(nrf_log_entry_t *,
|
||||
m_flashlog_queue,
|
||||
NRF_LOG_BACKEND_FLASHLOG_QUEUE_SIZE,
|
||||
NRF_QUEUE_MODE_NO_OVERFLOW);
|
||||
static const nrf_queue_t * mp_flashlog_queue = &m_flashlog_queue;
|
||||
#else
|
||||
static const nrf_queue_t * mp_flashlog_queue = NULL;
|
||||
#endif
|
||||
|
||||
|
||||
/** @brief Message FIFO for crash log. */
|
||||
#if NRF_LOG_BACKEND_CRASHLOG_ENABLED
|
||||
NRF_QUEUE_DEF(nrf_log_entry_t *,
|
||||
m_crashlog_queue,
|
||||
NRF_LOG_BACKEND_CRASHLOG_FIFO_SIZE,
|
||||
NRF_QUEUE_MODE_NO_OVERFLOW);
|
||||
static const nrf_queue_t * mp_crashlog_queue = &m_crashlog_queue;
|
||||
#else
|
||||
static const nrf_queue_t * mp_crashlog_queue = NULL;
|
||||
#endif
|
||||
|
||||
|
||||
/** @brief Fstorage instance used for flash log. */
|
||||
NRF_FSTORAGE_DEF(nrf_fstorage_t m_log_flash_fstorage) =
|
||||
{
|
||||
/* Set a handler for fstorage events. */
|
||||
.evt_handler = fstorage_evt_handler,
|
||||
.start_addr = FLASH_LOG_START_ADDR,
|
||||
.end_addr = FLASH_LOG_END_ADDR,
|
||||
};
|
||||
|
||||
/** @brief Flash log state. */
|
||||
typedef enum
|
||||
{
|
||||
LOG_BACKEND_FLASH_ACTIVE, /**< Flash backend is active. */
|
||||
LOG_BACKEND_FLASH_INACTIVE, /**< Flash backend is inactive. All incoming requests are skipped. */
|
||||
LOG_BACKEND_FLASH_IN_PANIC, /**< Flash backend is in panic mode. Incoming messages are written to flash in synchronous mode. */
|
||||
} log_backend_flash_state_t;
|
||||
|
||||
static log_backend_flash_state_t m_state; /**< Flash logger backend state. */
|
||||
static nrf_atomic_flag_t m_busy_flag; /**< Flag indicating if module performs flash writing. */
|
||||
static uint32_t m_flash_buf[FLASH_LOG_SER_BUFFER_WORDS]; /**< Buffer used for serializing messages. */
|
||||
static uint32_t m_curr_addr; /**< Address of free spot in the storage area. */
|
||||
static size_t m_curr_len; /**< Length of current message being written. */
|
||||
static uint32_t m_dropped; /**< Number of dropped messages. */
|
||||
|
||||
/** @brief Log message string injected when entering panic mode. */
|
||||
static const char crashlog_str[] = "-----------CRASHLOG------------\r\n";
|
||||
|
||||
/** @brief Function saturates input to maximum possible length and rounds up value to be multiple
|
||||
* of word size.
|
||||
*
|
||||
* @param length Length value.
|
||||
*
|
||||
* @return Modified input length.
|
||||
*/
|
||||
static uint32_t saturate_align_length(uint32_t length)
|
||||
{
|
||||
length = (length > FLASH_LOG_MAX_PAYLOAD_SIZE) ? FLASH_LOG_MAX_PAYLOAD_SIZE : length; //saturate
|
||||
length = CEIL_DIV(length, sizeof(uint32_t))*sizeof(uint32_t);
|
||||
return length;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @brief Function for copying logger message to the buffer.
|
||||
*
|
||||
* @param[in] p_msg Logger message.
|
||||
* @param[out] p_buf Output buffer where serialized message is placed.
|
||||
* @param[in,out] p_len Buffer size as input, length of prepared data as output.
|
||||
*
|
||||
* @return True if message fits into the buffer, false otherwise
|
||||
*/
|
||||
static bool msg_to_buf(nrf_log_entry_t * p_msg, uint8_t * p_buf, size_t * p_len)
|
||||
{
|
||||
uint32_t data_len;
|
||||
nrf_log_header_t header = {0};
|
||||
size_t memobj_offset = HEADER_SIZE*sizeof(uint32_t);
|
||||
|
||||
nrf_memobj_read(p_msg, &header, HEADER_SIZE*sizeof(uint32_t), 0);
|
||||
|
||||
memcpy(p_buf, &header, sizeof(nrf_log_header_t));
|
||||
p_buf += sizeof(nrf_log_header_t);
|
||||
|
||||
switch (header.base.generic.type)
|
||||
{
|
||||
case HEADER_TYPE_STD:
|
||||
{
|
||||
data_len = header.base.std.nargs * sizeof(uint32_t);
|
||||
break;
|
||||
}
|
||||
case HEADER_TYPE_HEXDUMP:
|
||||
{
|
||||
data_len = saturate_align_length(header.base.hexdump.len);
|
||||
break;
|
||||
}
|
||||
default:
|
||||
*p_len = 0;
|
||||
return false;
|
||||
}
|
||||
nrf_memobj_read(p_msg, p_buf, data_len, memobj_offset);
|
||||
|
||||
if (*p_len >= sizeof(nrf_log_header_t) + data_len)
|
||||
{
|
||||
*p_len = sizeof(nrf_log_header_t) + data_len;
|
||||
return true;
|
||||
}
|
||||
else
|
||||
{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Function for getting logger message stored in flash.
|
||||
*
|
||||
* @param[in] p_buf Pointer to the location where message is stored.
|
||||
* @param[out] pp_header Pointer to the log message header.
|
||||
* @param[out] pp_data Pointer to the log message data (arguments or data in case of hexdump).
|
||||
*
|
||||
* @return True if message was successfully fetched, false otherwise.
|
||||
*/
|
||||
static bool msg_from_buf(uint32_t * p_buf,
|
||||
nrf_log_header_t * * pp_header,
|
||||
uint8_t * * pp_data,
|
||||
uint32_t * p_len)
|
||||
{
|
||||
*pp_header = (nrf_log_header_t *)p_buf;
|
||||
*pp_data = (uint8_t *)&p_buf[LOG_HEADER_LEN_WORDS];
|
||||
|
||||
uint32_t data_len;
|
||||
|
||||
switch ((*pp_header)->base.generic.type)
|
||||
{
|
||||
case HEADER_TYPE_STD:
|
||||
{
|
||||
data_len = ((*pp_header)->base.std.nargs)*sizeof(uint32_t);
|
||||
break;
|
||||
}
|
||||
case HEADER_TYPE_HEXDUMP:
|
||||
{
|
||||
|
||||
data_len = saturate_align_length((*pp_header)->base.hexdump.len);
|
||||
break;
|
||||
}
|
||||
default:
|
||||
return false;
|
||||
}
|
||||
|
||||
*p_len = LOG_HEADER_LEN + data_len;
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Function for processing log message queue.
|
||||
*
|
||||
* If writing to flash is synchronous then function drains the queue and writes all messages to flash.
|
||||
* If writing to flash is asynchronous then function starts single write operation. In asynchronous mode
|
||||
* function is called when new message is put into the queue from from flash operation callback.
|
||||
*
|
||||
* Function detects the situation that flash module reports attempt to write outside dedicated area.
|
||||
* In that case flash backend stops writing any new messages.
|
||||
*
|
||||
* @param p_queue Queue will log messages
|
||||
* @param fstorage_blocking If true it indicates that flash operations are blocking, event handler is not used.
|
||||
*/
|
||||
static void log_msg_queue_process(nrf_queue_t const * p_queue, bool fstorage_blocking)
|
||||
{
|
||||
nrf_log_entry_t * p_msg;
|
||||
bool busy = false;
|
||||
while (nrf_queue_pop(p_queue, &p_msg) == NRF_SUCCESS)
|
||||
{
|
||||
ret_code_t err_code;
|
||||
|
||||
m_curr_len = sizeof(m_flash_buf);
|
||||
if (!msg_to_buf(p_msg, (uint8_t *)m_flash_buf, &m_curr_len))
|
||||
{
|
||||
nrf_memobj_put(p_msg);
|
||||
continue;
|
||||
}
|
||||
|
||||
err_code = nrf_fstorage_write(&m_log_flash_fstorage, m_curr_addr, m_flash_buf, m_curr_len, p_msg);
|
||||
|
||||
if (err_code == NRF_SUCCESS)
|
||||
{
|
||||
if (fstorage_blocking)
|
||||
{
|
||||
m_curr_addr += m_curr_len;
|
||||
|
||||
nrf_memobj_put(p_msg);
|
||||
}
|
||||
else
|
||||
{
|
||||
busy = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
else if (!fstorage_blocking && (err_code == NRF_ERROR_NO_MEM))
|
||||
{
|
||||
// fstorage queue got full. Drop entry.
|
||||
nrf_memobj_put(p_msg);
|
||||
m_dropped++;
|
||||
break;
|
||||
}
|
||||
else if (err_code == NRF_ERROR_INVALID_ADDR)
|
||||
{
|
||||
// Trying to write outside the area, flash log is full. Skip any new writes.
|
||||
nrf_memobj_put(p_msg);
|
||||
m_state = LOG_BACKEND_FLASH_INACTIVE;
|
||||
}
|
||||
else
|
||||
{
|
||||
ASSERT(false);
|
||||
}
|
||||
}
|
||||
|
||||
if (!busy)
|
||||
{
|
||||
UNUSED_RETURN_VALUE(nrf_atomic_flag_clear(&m_busy_flag));
|
||||
}
|
||||
}
|
||||
|
||||
static void queue_element_drop(nrf_queue_t const * p_queue)
|
||||
{
|
||||
nrf_log_entry_t * p_msg;
|
||||
if (nrf_queue_pop(p_queue, &p_msg) == NRF_SUCCESS)
|
||||
{
|
||||
m_dropped++;
|
||||
nrf_memobj_put(p_msg);
|
||||
}
|
||||
}
|
||||
|
||||
static void fstorage_evt_handler(nrf_fstorage_evt_t * p_evt)
|
||||
{
|
||||
if (m_state == LOG_BACKEND_FLASH_ACTIVE)
|
||||
{
|
||||
switch (p_evt->id)
|
||||
{
|
||||
case NRF_FSTORAGE_EVT_WRITE_RESULT:
|
||||
{
|
||||
if (p_evt->result == NRF_SUCCESS)
|
||||
{
|
||||
m_curr_addr += m_curr_len;
|
||||
m_curr_len = 0;
|
||||
log_msg_queue_process(mp_flashlog_queue, false);
|
||||
}
|
||||
else
|
||||
{
|
||||
m_dropped++;
|
||||
}
|
||||
|
||||
if (p_evt->p_param)
|
||||
{
|
||||
nrf_memobj_put((nrf_log_entry_t *)p_evt->p_param);
|
||||
}
|
||||
break;
|
||||
}
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
else if ((m_state == LOG_BACKEND_FLASH_INACTIVE) &&
|
||||
(p_evt->id == NRF_FSTORAGE_EVT_ERASE_RESULT) &&
|
||||
(p_evt->addr == RUNTIME_START_ADDR))
|
||||
{
|
||||
m_state = LOG_BACKEND_FLASH_ACTIVE;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Function for enqueueing new message.
|
||||
*
|
||||
* If queue is full then the oldest message is freed.
|
||||
*
|
||||
* @param p_queue Queue.
|
||||
* @param p_msg Message.
|
||||
*
|
||||
* @return Number of dropped messages
|
||||
*/
|
||||
static uint32_t message_enqueue(nrf_queue_t const * p_queue, nrf_log_entry_t * p_msg)
|
||||
{
|
||||
uint32_t dropped = 0;
|
||||
|
||||
//flag was set, busy so enqueue message
|
||||
while (nrf_queue_push(p_queue, &p_msg) != NRF_SUCCESS)
|
||||
{
|
||||
|
||||
nrf_log_entry_t * p_old_msg;
|
||||
if (nrf_queue_pop(p_queue, &p_old_msg) == NRF_SUCCESS)
|
||||
{
|
||||
nrf_memobj_put(p_old_msg);
|
||||
dropped++;
|
||||
}
|
||||
}
|
||||
|
||||
return dropped;
|
||||
}
|
||||
|
||||
|
||||
void nrf_log_backend_flashlog_put(nrf_log_backend_t const * p_backend,
|
||||
nrf_log_entry_t * p_msg)
|
||||
{
|
||||
if (m_state == LOG_BACKEND_FLASH_ACTIVE)
|
||||
{
|
||||
nrf_memobj_get(p_msg);
|
||||
|
||||
m_dropped += message_enqueue(mp_flashlog_queue, p_msg);
|
||||
|
||||
if (nrf_atomic_flag_set_fetch(&m_busy_flag) == 0)
|
||||
{
|
||||
log_msg_queue_process(mp_flashlog_queue, false);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void nrf_log_backend_crashlog_put(nrf_log_backend_t const * p_backend,
|
||||
nrf_log_entry_t * p_msg)
|
||||
{
|
||||
if (m_state != LOG_BACKEND_FLASH_INACTIVE)
|
||||
{
|
||||
nrf_memobj_get(p_msg);
|
||||
|
||||
UNUSED_RETURN_VALUE(message_enqueue(mp_crashlog_queue, p_msg));
|
||||
}
|
||||
|
||||
if (m_state == LOG_BACKEND_FLASH_IN_PANIC)
|
||||
{
|
||||
log_msg_queue_process(mp_crashlog_queue, true);
|
||||
}
|
||||
}
|
||||
|
||||
void nrf_log_backend_flashlog_flush(nrf_log_backend_t const * p_backend)
|
||||
{
|
||||
queue_element_drop(mp_flashlog_queue);
|
||||
}
|
||||
|
||||
void nrf_log_backend_crashlog_flush(nrf_log_backend_t const * p_backend)
|
||||
{
|
||||
queue_element_drop(mp_crashlog_queue);
|
||||
}
|
||||
|
||||
void nrf_log_backend_flashlog_panic_set(nrf_log_backend_t const * p_backend)
|
||||
{
|
||||
/* Empty */
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Function for injecting log message which will indicate start of crash log.
|
||||
*/
|
||||
static void crashlog_marker_inject(void)
|
||||
{
|
||||
nrf_log_header_t crashlog_marker_hdr = {
|
||||
.base = {
|
||||
.std = {
|
||||
.type = HEADER_TYPE_STD,
|
||||
.severity = NRF_LOG_SEVERITY_INFO_RAW,
|
||||
.nargs = 0,
|
||||
.addr = (uint32_t)crashlog_str & STD_ADDR_MASK
|
||||
}
|
||||
},
|
||||
.module_id = 0,
|
||||
.timestamp = 0,
|
||||
};
|
||||
m_flash_buf[0] = crashlog_marker_hdr.base.raw;
|
||||
m_flash_buf[1] = crashlog_marker_hdr.module_id;
|
||||
m_flash_buf[2] = crashlog_marker_hdr.timestamp;
|
||||
(void)nrf_fstorage_write(&m_log_flash_fstorage, m_curr_addr, m_flash_buf, LOG_HEADER_LEN, NULL);
|
||||
m_curr_addr += LOG_HEADER_LEN;
|
||||
}
|
||||
|
||||
|
||||
void nrf_log_backend_crashlog_panic_set(nrf_log_backend_t const * p_backend)
|
||||
{
|
||||
if (nrf_fstorage_init(&m_log_flash_fstorage, &nrf_fstorage_nvmc, NULL) == NRF_SUCCESS)
|
||||
{
|
||||
m_state = LOG_BACKEND_FLASH_IN_PANIC;
|
||||
|
||||
/* In case of Softdevice MWU may protect access to NVMC. */
|
||||
NVIC_DisableIRQ(MWU_IRQn);
|
||||
|
||||
log_msg_queue_process(mp_flashlog_queue, true);
|
||||
|
||||
crashlog_marker_inject();
|
||||
|
||||
log_msg_queue_process(mp_crashlog_queue, true);
|
||||
}
|
||||
else
|
||||
{
|
||||
m_state = LOG_BACKEND_FLASH_INACTIVE;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Function for determining first empty location in area dedicated for flash logger backend.
|
||||
*/
|
||||
static uint32_t empty_addr_get(void)
|
||||
{
|
||||
uint32_t token = 0;
|
||||
nrf_log_header_t * p_dummy_header;
|
||||
uint8_t * p_dummy_data;
|
||||
|
||||
while(nrf_log_backend_flash_next_entry_get(&token, &p_dummy_header, &p_dummy_data) == NRF_SUCCESS)
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
return token;
|
||||
}
|
||||
|
||||
|
||||
ret_code_t nrf_log_backend_flash_init(nrf_fstorage_api_t const * p_fs_api)
|
||||
{
|
||||
ret_code_t err_code;
|
||||
|
||||
|
||||
uint32_t start_addr = RUNTIME_START_ADDR;
|
||||
uint32_t end_addr = start_addr + FLASH_LOG_SIZE - 1;
|
||||
|
||||
m_log_flash_fstorage.start_addr = start_addr;
|
||||
m_log_flash_fstorage.end_addr = end_addr;
|
||||
|
||||
err_code = nrf_fstorage_init(&m_log_flash_fstorage, p_fs_api, NULL);
|
||||
if (err_code != NRF_SUCCESS)
|
||||
{
|
||||
return err_code;
|
||||
}
|
||||
|
||||
m_curr_addr = empty_addr_get();
|
||||
m_state = LOG_BACKEND_FLASH_ACTIVE;
|
||||
|
||||
return err_code;
|
||||
}
|
||||
|
||||
|
||||
ret_code_t nrf_log_backend_flash_next_entry_get(uint32_t * p_token,
|
||||
nrf_log_header_t * * pp_header,
|
||||
uint8_t * * pp_data)
|
||||
{
|
||||
uint32_t * p_addr = p_token;
|
||||
uint32_t len;
|
||||
|
||||
*p_addr = (*p_addr == 0) ? RUNTIME_START_ADDR : *p_addr;
|
||||
|
||||
if (nrf_fstorage_rmap(&m_log_flash_fstorage, *p_addr) == NULL)
|
||||
{
|
||||
//Supports only memories which can be mapped for reading.
|
||||
return NRF_ERROR_NOT_SUPPORTED;
|
||||
}
|
||||
|
||||
if (msg_from_buf((uint32_t *)*p_addr, pp_header, pp_data, &len))
|
||||
{
|
||||
*p_addr += len;
|
||||
return NRF_SUCCESS;
|
||||
}
|
||||
else
|
||||
{
|
||||
return NRF_ERROR_NOT_FOUND;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
ret_code_t nrf_log_backend_flash_erase(void)
|
||||
{
|
||||
ret_code_t err_code;
|
||||
|
||||
m_state = LOG_BACKEND_FLASH_INACTIVE;
|
||||
err_code = nrf_fstorage_erase(&m_log_flash_fstorage, RUNTIME_START_ADDR, NRF_LOG_BACKEND_PAGES, NULL);
|
||||
|
||||
m_curr_addr = RUNTIME_START_ADDR;
|
||||
|
||||
return err_code;
|
||||
}
|
||||
|
||||
#if NRF_LOG_BACKEND_FLASHLOG_ENABLED
|
||||
const nrf_log_backend_api_t nrf_log_backend_flashlog_api = {
|
||||
.put = nrf_log_backend_flashlog_put,
|
||||
.flush = nrf_log_backend_flashlog_flush,
|
||||
.panic_set = nrf_log_backend_flashlog_panic_set,
|
||||
};
|
||||
#endif
|
||||
|
||||
#if NRF_LOG_BACKEND_CRASHLOG_ENABLED
|
||||
const nrf_log_backend_api_t nrf_log_backend_crashlog_api = {
|
||||
.put = nrf_log_backend_crashlog_put,
|
||||
.flush = nrf_log_backend_crashlog_flush,
|
||||
.panic_set = nrf_log_backend_crashlog_panic_set,
|
||||
};
|
||||
#endif
|
||||
|
||||
#if NRF_LOG_BACKEND_FLASH_CLI_CMDS
|
||||
#include "nrf_cli.h"
|
||||
|
||||
static uint8_t m_buffer[64];
|
||||
static nrf_cli_t const * mp_cli;
|
||||
|
||||
static void cli_tx(void const * p_context, char const * p_buffer, size_t len);
|
||||
|
||||
static nrf_fprintf_ctx_t m_fprintf_ctx =
|
||||
{
|
||||
.p_io_buffer = (char *)m_buffer,
|
||||
.io_buffer_size = sizeof(m_buffer)-1,
|
||||
.io_buffer_cnt = 0,
|
||||
.auto_flush = true,
|
||||
.p_user_ctx = &mp_cli,
|
||||
.fwrite = cli_tx
|
||||
};
|
||||
|
||||
|
||||
static void flashlog_clear_cmd(nrf_cli_t const * p_cli, size_t argc, char ** argv)
|
||||
{
|
||||
if (nrf_cli_help_requested(p_cli))
|
||||
{
|
||||
nrf_cli_help_print(p_cli, NULL, 0);
|
||||
}
|
||||
|
||||
UNUSED_RETURN_VALUE(nrf_log_backend_flash_erase());
|
||||
}
|
||||
|
||||
#include "nrf_delay.h"
|
||||
static void cli_tx(void const * p_context, char const * p_buffer, size_t len)
|
||||
{
|
||||
nrf_cli_t * * pp_cli = (nrf_cli_t * *)p_context;
|
||||
char * p_strbuf = (char *)&p_buffer[len];
|
||||
*p_strbuf = '\0';
|
||||
nrf_cli_fprintf((nrf_cli_t const *)*pp_cli, NRF_CLI_DEFAULT, p_buffer);
|
||||
// nrf_delay_ms(10);
|
||||
}
|
||||
|
||||
|
||||
static void entry_process(nrf_cli_t const * p_cli, nrf_log_header_t * p_header, uint8_t * p_data)
|
||||
{
|
||||
mp_cli = p_cli;
|
||||
|
||||
nrf_log_str_formatter_entry_params_t params =
|
||||
{
|
||||
.timestamp = p_header->timestamp,
|
||||
.module_id = p_header->module_id,
|
||||
.use_colors = 0,
|
||||
};
|
||||
|
||||
switch (p_header->base.generic.type)
|
||||
{
|
||||
case HEADER_TYPE_STD:
|
||||
{
|
||||
params.severity = (nrf_log_severity_t)p_header->base.std.severity;
|
||||
nrf_log_std_entry_process((const char *)((uint32_t)p_header->base.std.addr),
|
||||
(uint32_t *)p_data,
|
||||
p_header->base.std.nargs,
|
||||
¶ms,
|
||||
&m_fprintf_ctx);
|
||||
break;
|
||||
}
|
||||
case HEADER_TYPE_HEXDUMP:
|
||||
{
|
||||
params.severity = (nrf_log_severity_t)p_header->base.hexdump.severity;
|
||||
|
||||
nrf_log_hexdump_entry_process(p_data,
|
||||
p_header->base.hexdump.len,
|
||||
¶ms,
|
||||
&m_fprintf_ctx);
|
||||
break;
|
||||
}
|
||||
default:
|
||||
ASSERT(0);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
static void flashlog_read_cmd(nrf_cli_t const * p_cli, size_t argc, char ** argv)
|
||||
{
|
||||
if (nrf_cli_help_requested(p_cli))
|
||||
{
|
||||
nrf_cli_help_print(p_cli, NULL, 0);
|
||||
}
|
||||
|
||||
uint32_t token = 0;
|
||||
uint8_t * p_data = NULL;
|
||||
bool empty = true;
|
||||
nrf_log_header_t * p_header;
|
||||
|
||||
while (1)
|
||||
{
|
||||
if (nrf_log_backend_flash_next_entry_get(&token, &p_header, &p_data) == NRF_SUCCESS)
|
||||
{
|
||||
entry_process(p_cli, p_header, p_data);
|
||||
empty = false;
|
||||
}
|
||||
else
|
||||
{
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (empty)
|
||||
{
|
||||
nrf_cli_fprintf(p_cli, NRF_CLI_ERROR, "Flash log empty\r\n");
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
static void flashlog_status_cmd(nrf_cli_t const * p_cli, size_t argc, char ** argv)
|
||||
{
|
||||
if (nrf_cli_help_requested(p_cli))
|
||||
{
|
||||
nrf_cli_help_print(p_cli, NULL, 0);
|
||||
}
|
||||
|
||||
nrf_cli_fprintf(p_cli, NRF_CLI_NORMAL, "Flash log status:\r\n");
|
||||
nrf_cli_fprintf(p_cli, NRF_CLI_NORMAL, "\t\t- Location (address: 0x%08X, length: %d)\r\n",
|
||||
RUNTIME_START_ADDR, FLASH_LOG_SIZE);
|
||||
nrf_cli_fprintf(p_cli, NRF_CLI_NORMAL, "\t\t- Current usage:%d%% (%d of %d bytes used)\r\n",
|
||||
100ul * (m_curr_addr - RUNTIME_START_ADDR)/FLASH_LOG_SIZE,
|
||||
m_curr_addr - RUNTIME_START_ADDR,
|
||||
FLASH_LOG_SIZE);
|
||||
nrf_cli_fprintf(p_cli, NRF_CLI_NORMAL, "\t\t- Dropped logs: %d\r\n", m_dropped);
|
||||
|
||||
|
||||
}
|
||||
|
||||
|
||||
NRF_CLI_CREATE_STATIC_SUBCMD_SET(m_flashlog_cmd)
|
||||
{
|
||||
NRF_CLI_CMD(clear, NULL, "Remove logs", flashlog_clear_cmd),
|
||||
NRF_CLI_CMD(read, NULL, "Read stored logs", flashlog_read_cmd),
|
||||
NRF_CLI_CMD(status, NULL, "Flash log status", flashlog_status_cmd),
|
||||
NRF_CLI_SUBCMD_SET_END
|
||||
};
|
||||
|
||||
NRF_CLI_CMD_REGISTER(flashlog, &m_flashlog_cmd, "Commands for reading logs stored in non-volatile memory", NULL);
|
||||
|
||||
#endif //NRF_LOG_BACKEND_FLASH_CLI_CMDS
|
||||
|
||||
#endif //NRF_MODULE_ENABLED(NRF_LOG) && NRF_MODULE_ENABLED(NRF_LOG_BACKEND_FLASH)
|
||||
123
components/libraries/log/src/nrf_log_backend_rtt.c
Normal file
123
components/libraries/log/src/nrf_log_backend_rtt.c
Normal file
@@ -0,0 +1,123 @@
|
||||
/**
|
||||
* Copyright (c) 2016 - 2020, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
#include "sdk_common.h"
|
||||
#if NRF_MODULE_ENABLED(NRF_LOG) && NRF_MODULE_ENABLED(NRF_LOG_BACKEND_RTT)
|
||||
#include "nrf_log_backend_rtt.h"
|
||||
#include "nrf_log_backend_serial.h"
|
||||
#include "nrf_log_str_formatter.h"
|
||||
#include "nrf_log_internal.h"
|
||||
#include "nrf_delay.h"
|
||||
#include <SEGGER_RTT_Conf.h>
|
||||
#include <SEGGER_RTT.h>
|
||||
|
||||
static bool m_host_present;
|
||||
|
||||
static uint8_t m_string_buff[NRF_LOG_BACKEND_RTT_TEMP_BUFFER_SIZE];
|
||||
|
||||
void nrf_log_backend_rtt_init(void)
|
||||
{
|
||||
SEGGER_RTT_Init();
|
||||
}
|
||||
|
||||
static void serial_tx(void const * p_context, char const * buffer, size_t len)
|
||||
{
|
||||
if (len)
|
||||
{
|
||||
uint32_t idx = 0;
|
||||
uint32_t processed;
|
||||
uint32_t watchdog_counter = NRF_LOG_BACKEND_RTT_TX_RETRY_CNT;
|
||||
do
|
||||
{
|
||||
processed = SEGGER_RTT_WriteNoLock(0, &buffer[idx], len);
|
||||
idx += processed;
|
||||
len -= processed;
|
||||
if (processed == 0)
|
||||
{
|
||||
/* There are two possible reasons for not writing any data to RTT:
|
||||
* - The host is not connected and not reading the data.
|
||||
* - The buffer got full and will be read by the host.
|
||||
* These two situations are distinguished using the following algorithm.
|
||||
* At the begining, the module assumes that the host is active,
|
||||
* so when no data is read, it busy waits and retries.
|
||||
* If, after retrying, the host reads the data, the module assumes that the host is active.
|
||||
* If it fails, the module assumes that the host is inactive and stores that information. On next
|
||||
* call, only one attempt takes place. The host is marked as active if the attempt is successful.
|
||||
*/
|
||||
if (!m_host_present)
|
||||
{
|
||||
break;
|
||||
}
|
||||
else
|
||||
{
|
||||
nrf_delay_ms(NRF_LOG_BACKEND_RTT_TX_RETRY_DELAY_MS);
|
||||
watchdog_counter--;
|
||||
if (watchdog_counter == 0)
|
||||
{
|
||||
m_host_present = false;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
m_host_present = true;
|
||||
} while (len);
|
||||
}
|
||||
}
|
||||
static void nrf_log_backend_rtt_put(nrf_log_backend_t const * p_backend,
|
||||
nrf_log_entry_t * p_msg)
|
||||
{
|
||||
nrf_log_backend_serial_put(p_backend, p_msg, m_string_buff, NRF_LOG_BACKEND_RTT_TEMP_BUFFER_SIZE, serial_tx);
|
||||
}
|
||||
|
||||
static void nrf_log_backend_rtt_flush(nrf_log_backend_t const * p_backend)
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
static void nrf_log_backend_rtt_panic_set(nrf_log_backend_t const * p_backend)
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
const nrf_log_backend_api_t nrf_log_backend_rtt_api = {
|
||||
.put = nrf_log_backend_rtt_put,
|
||||
.flush = nrf_log_backend_rtt_flush,
|
||||
.panic_set = nrf_log_backend_rtt_panic_set,
|
||||
};
|
||||
#endif //NRF_MODULE_ENABLED(NRF_LOG) && NRF_MODULE_ENABLED(NRF_LOG_BACKEND_RTT)
|
||||
116
components/libraries/log/src/nrf_log_backend_serial.c
Normal file
116
components/libraries/log/src/nrf_log_backend_serial.c
Normal file
@@ -0,0 +1,116 @@
|
||||
/**
|
||||
* Copyright (c) 2016 - 2020, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
#include "sdk_common.h"
|
||||
#if NRF_MODULE_ENABLED(NRF_LOG)
|
||||
#include "nrf_log_backend_serial.h"
|
||||
#include "nrf_log_str_formatter.h"
|
||||
#include "nrf_log_internal.h"
|
||||
|
||||
void nrf_log_backend_serial_put(nrf_log_backend_t const * p_backend,
|
||||
nrf_log_entry_t * p_msg,
|
||||
uint8_t * p_buffer,
|
||||
uint32_t length,
|
||||
nrf_fprintf_fwrite tx_func)
|
||||
{
|
||||
nrf_memobj_get(p_msg);
|
||||
|
||||
nrf_fprintf_ctx_t fprintf_ctx = {
|
||||
.p_io_buffer = (char *)p_buffer,
|
||||
.io_buffer_size = length,
|
||||
.io_buffer_cnt = 0,
|
||||
.auto_flush = false,
|
||||
.p_user_ctx = NULL,
|
||||
.fwrite = tx_func
|
||||
};
|
||||
|
||||
nrf_log_str_formatter_entry_params_t params;
|
||||
|
||||
nrf_log_header_t header;
|
||||
size_t memobj_offset = 0;
|
||||
|
||||
nrf_memobj_read(p_msg, &header, HEADER_SIZE*sizeof(uint32_t), memobj_offset);
|
||||
memobj_offset = HEADER_SIZE*sizeof(uint32_t);
|
||||
|
||||
params.timestamp = header.timestamp;
|
||||
params.module_id = header.module_id;
|
||||
params.dropped = header.dropped;
|
||||
params.use_colors = NRF_LOG_USES_COLORS;
|
||||
|
||||
/*lint -save -e438*/
|
||||
if (header.base.generic.type == HEADER_TYPE_STD)
|
||||
{
|
||||
char const * p_log_str = (char const *)((uint32_t)header.base.std.addr);
|
||||
params.severity = (nrf_log_severity_t)header.base.std.severity;
|
||||
uint32_t nargs = header.base.std.nargs;
|
||||
uint32_t args[NRF_LOG_MAX_NUM_OF_ARGS];
|
||||
|
||||
nrf_memobj_read(p_msg, args, nargs*sizeof(uint32_t), memobj_offset);
|
||||
memobj_offset += (nargs*sizeof(uint32_t));
|
||||
|
||||
nrf_log_std_entry_process(p_log_str,
|
||||
args,
|
||||
nargs,
|
||||
¶ms,
|
||||
&fprintf_ctx);
|
||||
|
||||
}
|
||||
else if (header.base.generic.type == HEADER_TYPE_HEXDUMP)
|
||||
{
|
||||
uint32_t data_len = header.base.hexdump.len;
|
||||
params.severity = (nrf_log_severity_t)header.base.hexdump.severity;
|
||||
uint8_t data_buf[8];
|
||||
uint32_t chunk_len;
|
||||
do
|
||||
{
|
||||
chunk_len = sizeof(data_buf) > data_len ? data_len : sizeof(data_buf);
|
||||
nrf_memobj_read(p_msg, data_buf, chunk_len, memobj_offset);
|
||||
memobj_offset += chunk_len;
|
||||
data_len -= chunk_len;
|
||||
|
||||
nrf_log_hexdump_entry_process(data_buf,
|
||||
chunk_len,
|
||||
¶ms,
|
||||
&fprintf_ctx);
|
||||
} while (data_len > 0);
|
||||
}
|
||||
nrf_memobj_put(p_msg);
|
||||
/*lint -restore*/
|
||||
}
|
||||
#endif //NRF_LOG_ENABLED
|
||||
77
components/libraries/log/src/nrf_log_backend_serial.h
Normal file
77
components/libraries/log/src/nrf_log_backend_serial.h
Normal file
@@ -0,0 +1,77 @@
|
||||
/**
|
||||
* Copyright (c) 2017 - 2020, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
#ifndef NRF_LOG_BACKEND_SERIAL_H
|
||||
#define NRF_LOG_BACKEND_SERIAL_H
|
||||
/**@file
|
||||
* @addtogroup nrf_log Logger module
|
||||
* @ingroup app_common
|
||||
*
|
||||
* @defgroup nrf_log_backend_serial Common part of serial backends
|
||||
* @{
|
||||
* @ingroup nrf_log
|
||||
* @brief The nrf_log serial backend common put function.
|
||||
*/
|
||||
|
||||
|
||||
#include "nrf_log_backend_interface.h"
|
||||
#include "nrf_fprintf.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief A function for processing logger entry with simple serial interface as output.
|
||||
*
|
||||
*
|
||||
*/
|
||||
void nrf_log_backend_serial_put(nrf_log_backend_t const * p_backend,
|
||||
nrf_log_entry_t * p_msg,
|
||||
uint8_t * p_buffer,
|
||||
uint32_t length,
|
||||
nrf_fprintf_fwrite tx_func);
|
||||
|
||||
#endif //NRF_LOG_BACKEND_SERIAL_H
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
/** @} */
|
||||
116
components/libraries/log/src/nrf_log_backend_uart.c
Normal file
116
components/libraries/log/src/nrf_log_backend_uart.c
Normal file
@@ -0,0 +1,116 @@
|
||||
/**
|
||||
* Copyright (c) 2016 - 2020, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
#include "sdk_common.h"
|
||||
#if NRF_MODULE_ENABLED(NRF_LOG) && NRF_MODULE_ENABLED(NRF_LOG_BACKEND_UART)
|
||||
#include "nrf_log_backend_uart.h"
|
||||
#include "nrf_log_backend_serial.h"
|
||||
#include "nrf_log_internal.h"
|
||||
#include "nrf_drv_uart.h"
|
||||
#include "app_error.h"
|
||||
|
||||
nrf_drv_uart_t m_uart = NRF_DRV_UART_INSTANCE(0);
|
||||
|
||||
static uint8_t m_string_buff[NRF_LOG_BACKEND_UART_TEMP_BUFFER_SIZE];
|
||||
static volatile bool m_xfer_done;
|
||||
static bool m_async_mode;
|
||||
static void uart_evt_handler(nrf_drv_uart_event_t * p_event, void * p_context)
|
||||
{
|
||||
m_xfer_done = true;
|
||||
}
|
||||
|
||||
static void uart_init(bool async_mode)
|
||||
{
|
||||
nrf_drv_uart_config_t config = NRF_DRV_UART_DEFAULT_CONFIG;
|
||||
config.pseltxd = NRF_LOG_BACKEND_UART_TX_PIN;
|
||||
config.pselrxd = NRF_UART_PSEL_DISCONNECTED;
|
||||
config.pselcts = NRF_UART_PSEL_DISCONNECTED;
|
||||
config.pselrts = NRF_UART_PSEL_DISCONNECTED;
|
||||
config.baudrate = (nrf_uart_baudrate_t)NRF_LOG_BACKEND_UART_BAUDRATE;
|
||||
ret_code_t err_code = nrf_drv_uart_init(&m_uart, &config, async_mode ? uart_evt_handler : NULL);
|
||||
APP_ERROR_CHECK(err_code);
|
||||
|
||||
m_async_mode = async_mode;
|
||||
}
|
||||
|
||||
void nrf_log_backend_uart_init(void)
|
||||
{
|
||||
bool async_mode = NRF_LOG_DEFERRED ? true : false;
|
||||
uart_init(async_mode);
|
||||
}
|
||||
|
||||
static void serial_tx(void const * p_context, char const * p_buffer, size_t len)
|
||||
{
|
||||
uint8_t len8 = (uint8_t)(len & 0x000000FF);
|
||||
m_xfer_done = false;
|
||||
ret_code_t err_code = nrf_drv_uart_tx(&m_uart, (uint8_t *)p_buffer, len8);
|
||||
APP_ERROR_CHECK(err_code);
|
||||
/* wait for completion since buffer is reused*/
|
||||
while (m_async_mode && (m_xfer_done == false))
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
static void nrf_log_backend_uart_put(nrf_log_backend_t const * p_backend,
|
||||
nrf_log_entry_t * p_msg)
|
||||
{
|
||||
nrf_log_backend_serial_put(p_backend, p_msg, m_string_buff,
|
||||
NRF_LOG_BACKEND_UART_TEMP_BUFFER_SIZE, serial_tx);
|
||||
}
|
||||
|
||||
static void nrf_log_backend_uart_flush(nrf_log_backend_t const * p_backend)
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
static void nrf_log_backend_uart_panic_set(nrf_log_backend_t const * p_backend)
|
||||
{
|
||||
nrf_drv_uart_uninit(&m_uart);
|
||||
|
||||
uart_init(false);
|
||||
}
|
||||
|
||||
const nrf_log_backend_api_t nrf_log_backend_uart_api = {
|
||||
.put = nrf_log_backend_uart_put,
|
||||
.flush = nrf_log_backend_uart_flush,
|
||||
.panic_set = nrf_log_backend_uart_panic_set,
|
||||
};
|
||||
#endif //NRF_MODULE_ENABLED(NRF_LOG) && NRF_MODULE_ENABLED(NRF_LOG_BACKEND_UART)
|
||||
91
components/libraries/log/src/nrf_log_ctrl_internal.h
Normal file
91
components/libraries/log/src/nrf_log_ctrl_internal.h
Normal file
@@ -0,0 +1,91 @@
|
||||
/**
|
||||
* Copyright (c) 2016 - 2020, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
#ifndef NRF_LOG_CTRL_INTERNAL_H
|
||||
#define NRF_LOG_CTRL_INTERNAL_H
|
||||
/**
|
||||
* @cond (NODOX)
|
||||
* @defgroup nrf_log_ctrl_internal Auxiliary internal types declarations
|
||||
* @{
|
||||
* @internal
|
||||
*/
|
||||
|
||||
#include "sdk_common.h"
|
||||
#if NRF_MODULE_ENABLED(NRF_LOG)
|
||||
|
||||
#define NRF_LOG_LFCLK_FREQ 32768
|
||||
|
||||
#ifdef APP_TIMER_CONFIG_RTC_FREQUENCY
|
||||
#define LOG_TIMESTAMP_DEFAULT_FREQUENCY ((NRF_LOG_TIMESTAMP_DEFAULT_FREQUENCY == 0) ? \
|
||||
(NRF_LOG_LFCLK_FREQ/(APP_TIMER_CONFIG_RTC_FREQUENCY + 1)) : \
|
||||
NRF_LOG_TIMESTAMP_DEFAULT_FREQUENCY)
|
||||
#else
|
||||
#define LOG_TIMESTAMP_DEFAULT_FREQUENCY NRF_LOG_TIMESTAMP_DEFAULT_FREQUENCY
|
||||
#endif
|
||||
|
||||
#define NRF_LOG_INTERNAL_INIT(...) \
|
||||
nrf_log_init(GET_VA_ARG_1(__VA_ARGS__), \
|
||||
GET_VA_ARG_1(GET_ARGS_AFTER_1(__VA_ARGS__, LOG_TIMESTAMP_DEFAULT_FREQUENCY)))
|
||||
|
||||
#define NRF_LOG_INTERNAL_PROCESS() nrf_log_frontend_dequeue()
|
||||
#define NRF_LOG_INTERNAL_FLUSH() \
|
||||
do { \
|
||||
while (NRF_LOG_INTERNAL_PROCESS()); \
|
||||
} while (0)
|
||||
|
||||
#define NRF_LOG_INTERNAL_FINAL_FLUSH() \
|
||||
do { \
|
||||
nrf_log_panic(); \
|
||||
NRF_LOG_INTERNAL_FLUSH(); \
|
||||
} while (0)
|
||||
|
||||
|
||||
#else // NRF_MODULE_ENABLED(NRF_LOG)
|
||||
#define NRF_LOG_INTERNAL_PROCESS() false
|
||||
#define NRF_LOG_INTERNAL_FLUSH()
|
||||
#define NRF_LOG_INTERNAL_INIT(...) NRF_SUCCESS
|
||||
#define NRF_LOG_INTERNAL_HANDLERS_SET(default_handler, bytes_handler) \
|
||||
UNUSED_PARAMETER(default_handler); UNUSED_PARAMETER(bytes_handler)
|
||||
#define NRF_LOG_INTERNAL_FINAL_FLUSH()
|
||||
#endif // NRF_MODULE_ENABLED(NRF_LOG)
|
||||
|
||||
/** @}
|
||||
* @endcond
|
||||
*/
|
||||
#endif // NRF_LOG_CTRL_INTERNAL_H
|
||||
76
components/libraries/log/src/nrf_log_default_backends.c
Normal file
76
components/libraries/log/src/nrf_log_default_backends.c
Normal file
@@ -0,0 +1,76 @@
|
||||
/**
|
||||
* Copyright (c) 2017 - 2020, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
|
||||
#include "sdk_common.h"
|
||||
#if NRF_MODULE_ENABLED(NRF_LOG)
|
||||
#include "nrf_log_default_backends.h"
|
||||
#include "nrf_log_ctrl.h"
|
||||
#include "nrf_log_internal.h"
|
||||
#include "nrf_assert.h"
|
||||
|
||||
#if defined(NRF_LOG_BACKEND_RTT_ENABLED) && NRF_LOG_BACKEND_RTT_ENABLED
|
||||
#include "nrf_log_backend_rtt.h"
|
||||
NRF_LOG_BACKEND_RTT_DEF(rtt_log_backend);
|
||||
#endif
|
||||
|
||||
#if defined(NRF_LOG_BACKEND_UART_ENABLED) && NRF_LOG_BACKEND_UART_ENABLED
|
||||
#include "nrf_log_backend_uart.h"
|
||||
NRF_LOG_BACKEND_UART_DEF(uart_log_backend);
|
||||
#endif
|
||||
|
||||
void nrf_log_default_backends_init(void)
|
||||
{
|
||||
int32_t backend_id = -1;
|
||||
(void)backend_id;
|
||||
#if defined(NRF_LOG_BACKEND_RTT_ENABLED) && NRF_LOG_BACKEND_RTT_ENABLED
|
||||
nrf_log_backend_rtt_init();
|
||||
backend_id = nrf_log_backend_add(&rtt_log_backend, NRF_LOG_SEVERITY_DEBUG);
|
||||
ASSERT(backend_id >= 0);
|
||||
nrf_log_backend_enable(&rtt_log_backend);
|
||||
#endif
|
||||
|
||||
#if defined(NRF_LOG_BACKEND_UART_ENABLED) && NRF_LOG_BACKEND_UART_ENABLED
|
||||
nrf_log_backend_uart_init();
|
||||
backend_id = nrf_log_backend_add(&uart_log_backend, NRF_LOG_SEVERITY_DEBUG);
|
||||
ASSERT(backend_id >= 0);
|
||||
nrf_log_backend_enable(&uart_log_backend);
|
||||
#endif
|
||||
}
|
||||
#endif
|
||||
1583
components/libraries/log/src/nrf_log_frontend.c
Normal file
1583
components/libraries/log/src/nrf_log_frontend.c
Normal file
File diff suppressed because it is too large
Load Diff
516
components/libraries/log/src/nrf_log_internal.h
Normal file
516
components/libraries/log/src/nrf_log_internal.h
Normal file
@@ -0,0 +1,516 @@
|
||||
/**
|
||||
* Copyright (c) 2016 - 2020, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
#ifndef NRF_LOG_INTERNAL_H__
|
||||
#define NRF_LOG_INTERNAL_H__
|
||||
#include "sdk_common.h"
|
||||
#include "nrf.h"
|
||||
#include "nrf_error.h"
|
||||
#include "app_util.h"
|
||||
#include <stdint.h>
|
||||
#include <stdbool.h>
|
||||
#include "nrf_log_instance.h"
|
||||
#include "nrf_log_types.h"
|
||||
|
||||
#ifndef NRF_LOG_ERROR_COLOR
|
||||
#define NRF_LOG_ERROR_COLOR NRF_LOG_COLOR_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef NRF_LOG_WARNING_COLOR
|
||||
#define NRF_LOG_WARNING_COLOR NRF_LOG_COLOR_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef NRF_LOG_INFO_COLOR
|
||||
#define NRF_LOG_INFO_COLOR NRF_LOG_COLOR_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef NRF_LOG_DEBUG_COLOR
|
||||
#define NRF_LOG_DEBUG_COLOR NRF_LOG_COLOR_DEFAULT
|
||||
#endif
|
||||
|
||||
|
||||
#ifndef NRF_LOG_COLOR_DEFAULT
|
||||
#define NRF_LOG_COLOR_DEFAULT 0
|
||||
#endif
|
||||
|
||||
#ifndef NRF_LOG_DEFAULT_LEVEL
|
||||
#define NRF_LOG_DEFAULT_LEVEL 0
|
||||
#endif
|
||||
|
||||
#ifndef NRF_LOG_USES_COLORS
|
||||
#define NRF_LOG_USES_COLORS 0
|
||||
#endif
|
||||
|
||||
#ifndef NRF_LOG_USES_TIMESTAMP
|
||||
#define NRF_LOG_USES_TIMESTAMP 0
|
||||
#endif
|
||||
|
||||
#ifndef NRF_LOG_FILTERS_ENABLED
|
||||
#define NRF_LOG_FILTERS_ENABLED 0
|
||||
#endif
|
||||
|
||||
#ifndef NRF_LOG_MODULE_NAME
|
||||
#define NRF_LOG_MODULE_NAME app
|
||||
#endif
|
||||
|
||||
#define NRF_LOG_LEVEL_BITS 3
|
||||
#define NRF_LOG_LEVEL_MASK ((1UL << NRF_LOG_LEVEL_BITS) - 1)
|
||||
#define NRF_LOG_MODULE_ID_BITS 16
|
||||
#define NRF_LOG_MODULE_ID_POS 16
|
||||
|
||||
|
||||
#define NRF_LOG_MAX_NUM_OF_ARGS 6
|
||||
|
||||
|
||||
#if NRF_LOG_FILTERS_ENABLED && NRF_LOG_ENABLED
|
||||
#define NRF_LOG_FILTER NRF_LOG_ITEM_DATA_DYNAMIC(NRF_LOG_MODULE_NAME).filter
|
||||
#define NRF_LOG_INST_FILTER(p_inst) (p_inst)->filter
|
||||
#else
|
||||
#undef NRF_LOG_FILTER
|
||||
#define NRF_LOG_FILTER NRF_LOG_SEVERITY_DEBUG
|
||||
#define NRF_LOG_INST_FILTER(p_inst) NRF_LOG_SEVERITY_DEBUG
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief Macro for calculating module id based on address and section start address
|
||||
*/
|
||||
#define NRF_LOG_MODULE_ID_GET_CONST(addr) (((uint32_t)(addr) - \
|
||||
(uint32_t)NRF_SECTION_START_ADDR(log_const_data)) / \
|
||||
sizeof(nrf_log_module_const_data_t))
|
||||
/**
|
||||
* @brief Macro for calculating module id based on address and section start address
|
||||
*/
|
||||
#define NRF_LOG_MODULE_ID_GET_DYNAMIC(addr) (((uint32_t)(addr) - \
|
||||
(uint32_t)NRF_SECTION_START_ADDR(log_dynamic_data)) / \
|
||||
sizeof(nrf_log_module_dynamic_data_t))
|
||||
|
||||
|
||||
#if NRF_LOG_ENABLED
|
||||
#define NRF_LOG_MODULE_ID NRF_LOG_MODULE_ID_GET_CONST(&NRF_LOG_ITEM_DATA_CONST(NRF_LOG_MODULE_NAME))
|
||||
#if NRF_LOG_FILTERS_ENABLED
|
||||
#define NRF_LOG_INST_ID(p_inst) NRF_LOG_MODULE_ID_GET_DYNAMIC(p_inst)
|
||||
#else
|
||||
#define NRF_LOG_INST_ID(p_inst) NRF_LOG_MODULE_ID
|
||||
#endif
|
||||
#else
|
||||
#define NRF_LOG_MODULE_ID 0
|
||||
#define NRF_LOG_INST_ID(p_inst) 0
|
||||
#endif
|
||||
|
||||
|
||||
#define LOG_INTERNAL_X(N, ...) CONCAT_2(LOG_INTERNAL_, N) (__VA_ARGS__)
|
||||
#define LOG_INTERNAL(type, ...) LOG_INTERNAL_X(NUM_VA_ARGS_LESS_1( \
|
||||
__VA_ARGS__), type, __VA_ARGS__)
|
||||
#if NRF_LOG_ENABLED
|
||||
#define NRF_LOG_INTERNAL_LOG_PUSH(_str) nrf_log_push(_str)
|
||||
#define LOG_INTERNAL_0(type, str) \
|
||||
nrf_log_frontend_std_0(type, str)
|
||||
#define LOG_INTERNAL_1(type, str, arg0) \
|
||||
/*lint -save -e571*/nrf_log_frontend_std_1(type, str, (uint32_t)(arg0))/*lint -restore*/
|
||||
#define LOG_INTERNAL_2(type, str, arg0, arg1) \
|
||||
/*lint -save -e571*/nrf_log_frontend_std_2(type, str, (uint32_t)(arg0), \
|
||||
(uint32_t)(arg1))/*lint -restore*/
|
||||
#define LOG_INTERNAL_3(type, str, arg0, arg1, arg2) \
|
||||
/*lint -save -e571*/nrf_log_frontend_std_3(type, str, (uint32_t)(arg0), \
|
||||
(uint32_t)(arg1), (uint32_t)(arg2))/*lint -restore*/
|
||||
#define LOG_INTERNAL_4(type, str, arg0, arg1, arg2, arg3) \
|
||||
/*lint -save -e571*/nrf_log_frontend_std_4(type, str, (uint32_t)(arg0), \
|
||||
(uint32_t)(arg1), (uint32_t)(arg2), (uint32_t)(arg3))/*lint -restore*/
|
||||
#define LOG_INTERNAL_5(type, str, arg0, arg1, arg2, arg3, arg4) \
|
||||
/*lint -save -e571*/nrf_log_frontend_std_5(type, str, (uint32_t)(arg0), \
|
||||
(uint32_t)(arg1), (uint32_t)(arg2), (uint32_t)(arg3), (uint32_t)(arg4))/*lint -restore*/
|
||||
#define LOG_INTERNAL_6(type, str, arg0, arg1, arg2, arg3, arg4, arg5) \
|
||||
/*lint -save -e571*/nrf_log_frontend_std_6(type, str, (uint32_t)(arg0), \
|
||||
(uint32_t)(arg1), (uint32_t)(arg2), (uint32_t)(arg3), (uint32_t)(arg4), (uint32_t)(arg5))/*lint -restore*/
|
||||
|
||||
|
||||
#else //NRF_LOG_ENABLED
|
||||
#define NRF_LOG_INTERNAL_LOG_PUSH(_str) (void)(_str)
|
||||
#define LOG_INTERNAL_0(_type, _str) \
|
||||
(void)(_type); (void)(_str)
|
||||
#define LOG_INTERNAL_1(_type, _str, _arg0) \
|
||||
(void)(_type); (void)(_str); (void)(_arg0)
|
||||
#define LOG_INTERNAL_2(_type, _str, _arg0, _arg1) \
|
||||
(void)(_type); (void)(_str); (void)(_arg0); (void)(_arg1)
|
||||
#define LOG_INTERNAL_3(_type, _str, _arg0, _arg1, _arg2) \
|
||||
(void)(_type); (void)(_str); (void)(_arg0); (void)(_arg1); (void)(_arg2)
|
||||
#define LOG_INTERNAL_4(_type, _str, _arg0, _arg1, _arg2, _arg3) \
|
||||
(void)(_type); (void)(_str); (void)(_arg0); (void)(_arg1); (void)(_arg2); (void)(_arg3)
|
||||
#define LOG_INTERNAL_5(_type, _str, _arg0, _arg1, _arg2, _arg3, _arg4) \
|
||||
(void)(_type); (void)(_str); (void)(_arg0); (void)(_arg1); (void)(_arg2); (void)(_arg3); (void)(_arg4)
|
||||
#define LOG_INTERNAL_6(_type, _str, _arg0, _arg1, _arg2, _arg3, _arg4, _arg5) \
|
||||
(void)(_type); (void)(_str); (void)(_arg0); (void)(_arg1); (void)(_arg2); (void)(_arg3); (void)(_arg4); (void)(_arg5)
|
||||
#endif //NRF_LOG_ENABLED
|
||||
|
||||
#define LOG_SEVERITY_MOD_ID(severity) ((severity) | NRF_LOG_MODULE_ID << NRF_LOG_MODULE_ID_POS)
|
||||
#define LOG_SEVERITY_INST_ID(severity,p_inst) ((severity) | NRF_LOG_INST_ID(p_inst) << NRF_LOG_MODULE_ID_POS)
|
||||
|
||||
#if NRF_LOG_ENABLED
|
||||
#define LOG_HEXDUMP(_severity, _p_data, _length) \
|
||||
nrf_log_frontend_hexdump((_severity), (_p_data), (_length))
|
||||
#else
|
||||
#define LOG_HEXDUMP(_severity, _p_data, _length) \
|
||||
(void)(_severity); (void)(_p_data); (void)_length
|
||||
#endif
|
||||
|
||||
#define NRF_LOG_INTERNAL_INST(level, level_id, p_inst, ...) \
|
||||
if (NRF_LOG_ENABLED && (NRF_LOG_LEVEL >= level) && \
|
||||
(level <= NRF_LOG_DEFAULT_LEVEL)) \
|
||||
{ \
|
||||
if (NRF_LOG_INST_FILTER(p_inst) >= level) \
|
||||
{ \
|
||||
LOG_INTERNAL(LOG_SEVERITY_INST_ID(level_id, p_inst), __VA_ARGS__); \
|
||||
} \
|
||||
}
|
||||
|
||||
#define NRF_LOG_INTERNAL_MODULE(level, level_id, ...) \
|
||||
if (NRF_LOG_ENABLED && (NRF_LOG_LEVEL >= level) && \
|
||||
(level <= NRF_LOG_DEFAULT_LEVEL)) \
|
||||
{ \
|
||||
if (NRF_LOG_FILTER >= level) \
|
||||
{ \
|
||||
LOG_INTERNAL(LOG_SEVERITY_MOD_ID(level_id), __VA_ARGS__); \
|
||||
} \
|
||||
}
|
||||
|
||||
#define NRF_LOG_INTERNAL_HEXDUMP_INST(level, level_id, p_inst, p_data, len) \
|
||||
if (NRF_LOG_ENABLED && (NRF_LOG_LEVEL >= level) && \
|
||||
(level <= NRF_LOG_DEFAULT_LEVEL)) \
|
||||
{ \
|
||||
if (NRF_LOG_INST_FILTER(p_inst) >= level) \
|
||||
{ \
|
||||
LOG_HEXDUMP(LOG_SEVERITY_INST_ID(level_id, p_inst), \
|
||||
(p_data), (len)); \
|
||||
} \
|
||||
}
|
||||
|
||||
#define NRF_LOG_INTERNAL_HEXDUMP_MODULE(level, level_id, p_data, len) \
|
||||
if (NRF_LOG_ENABLED && (NRF_LOG_LEVEL >= level) && \
|
||||
(level <= NRF_LOG_DEFAULT_LEVEL)) \
|
||||
{ \
|
||||
if (NRF_LOG_FILTER >= level) \
|
||||
{ \
|
||||
LOG_HEXDUMP(LOG_SEVERITY_MOD_ID(level_id), \
|
||||
(p_data), (len)); \
|
||||
} \
|
||||
}
|
||||
|
||||
#define NRF_LOG_INTERNAL_INST_ERROR(p_inst, ...) \
|
||||
NRF_LOG_INTERNAL_INST(NRF_LOG_SEVERITY_ERROR, NRF_LOG_SEVERITY_ERROR, p_inst, __VA_ARGS__)
|
||||
|
||||
#define NRF_LOG_INTERNAL_ERROR(...) \
|
||||
NRF_LOG_INTERNAL_MODULE(NRF_LOG_SEVERITY_ERROR, NRF_LOG_SEVERITY_ERROR,__VA_ARGS__)
|
||||
|
||||
#define NRF_LOG_INTERNAL_HEXDUMP_INST_ERROR(p_inst, p_data, len) \
|
||||
NRF_LOG_INTERNAL_HEXDUMP_INST(NRF_LOG_SEVERITY_ERROR, NRF_LOG_SEVERITY_ERROR, p_inst, p_data, len)
|
||||
|
||||
#define NRF_LOG_INTERNAL_HEXDUMP_ERROR(p_data, len) \
|
||||
NRF_LOG_INTERNAL_HEXDUMP_MODULE(NRF_LOG_SEVERITY_ERROR, NRF_LOG_SEVERITY_ERROR, p_data, len)
|
||||
|
||||
#define NRF_LOG_INTERNAL_INST_WARNING(p_inst, ...) \
|
||||
NRF_LOG_INTERNAL_INST(NRF_LOG_SEVERITY_WARNING, NRF_LOG_SEVERITY_WARNING, p_inst, __VA_ARGS__)
|
||||
|
||||
#define NRF_LOG_INTERNAL_WARNING(...) \
|
||||
NRF_LOG_INTERNAL_MODULE(NRF_LOG_SEVERITY_WARNING, NRF_LOG_SEVERITY_WARNING,__VA_ARGS__)
|
||||
|
||||
#define NRF_LOG_INTERNAL_HEXDUMP_INST_WARNING(p_inst, p_data, len) \
|
||||
NRF_LOG_INTERNAL_HEXDUMP_INST(NRF_LOG_SEVERITY_WARNING, NRF_LOG_SEVERITY_WARNING, p_inst, p_data, len)
|
||||
|
||||
#define NRF_LOG_INTERNAL_HEXDUMP_WARNING(p_data, len) \
|
||||
NRF_LOG_INTERNAL_HEXDUMP_MODULE(NRF_LOG_SEVERITY_WARNING, NRF_LOG_SEVERITY_WARNING, p_data, len)
|
||||
|
||||
#define NRF_LOG_INTERNAL_INST_INFO(p_inst, ...) \
|
||||
NRF_LOG_INTERNAL_INST(NRF_LOG_SEVERITY_INFO, NRF_LOG_SEVERITY_INFO, p_inst, __VA_ARGS__)
|
||||
|
||||
#define NRF_LOG_INTERNAL_INFO(...) \
|
||||
NRF_LOG_INTERNAL_MODULE(NRF_LOG_SEVERITY_INFO, NRF_LOG_SEVERITY_INFO, __VA_ARGS__)
|
||||
|
||||
#define NRF_LOG_INTERNAL_HEXDUMP_INST_INFO(p_inst, p_data, len) \
|
||||
NRF_LOG_INTERNAL_HEXDUMP_INST(NRF_LOG_SEVERITY_INFO, NRF_LOG_SEVERITY_INFO, p_inst, p_data, len)
|
||||
|
||||
#define NRF_LOG_INTERNAL_HEXDUMP_INFO(p_data, len) \
|
||||
NRF_LOG_INTERNAL_HEXDUMP_MODULE(NRF_LOG_SEVERITY_INFO, NRF_LOG_SEVERITY_INFO, p_data, len)
|
||||
|
||||
#define NRF_LOG_INTERNAL_RAW_INFO(...) \
|
||||
NRF_LOG_INTERNAL_MODULE(NRF_LOG_SEVERITY_INFO, NRF_LOG_SEVERITY_INFO_RAW, __VA_ARGS__)
|
||||
|
||||
#define NRF_LOG_INTERNAL_RAW_HEXDUMP_INFO(p_data, len) \
|
||||
NRF_LOG_INTERNAL_HEXDUMP_MODULE(NRF_LOG_SEVERITY_INFO, NRF_LOG_SEVERITY_INFO_RAW, p_data, len)
|
||||
|
||||
#define NRF_LOG_INTERNAL_INST_DEBUG(p_inst, ...) \
|
||||
NRF_LOG_INTERNAL_INST(NRF_LOG_SEVERITY_DEBUG, NRF_LOG_SEVERITY_DEBUG, p_inst, __VA_ARGS__)
|
||||
|
||||
#define NRF_LOG_INTERNAL_DEBUG(...) \
|
||||
NRF_LOG_INTERNAL_MODULE(NRF_LOG_SEVERITY_DEBUG, NRF_LOG_SEVERITY_DEBUG, __VA_ARGS__)
|
||||
|
||||
#define NRF_LOG_INTERNAL_HEXDUMP_INST_DEBUG(p_inst, p_data, len) \
|
||||
NRF_LOG_INTERNAL_HEXDUMP_INST(NRF_LOG_SEVERITY_DEBUG, NRF_LOG_SEVERITY_DEBUG, p_inst, p_data, len)
|
||||
|
||||
#define NRF_LOG_INTERNAL_HEXDUMP_DEBUG(p_data, len) \
|
||||
NRF_LOG_INTERNAL_HEXDUMP_MODULE(NRF_LOG_SEVERITY_DEBUG, NRF_LOG_SEVERITY_DEBUG, p_data, len)
|
||||
|
||||
|
||||
#if NRF_LOG_ENABLED
|
||||
|
||||
#ifdef UNIT_TEST
|
||||
#define COMPILED_LOG_LEVEL 4
|
||||
#else
|
||||
#define COMPILED_LOG_LEVEL NRF_LOG_LEVEL
|
||||
#endif
|
||||
|
||||
|
||||
#define NRF_LOG_INTERNAL_MODULE_REGISTER() \
|
||||
NRF_LOG_INTERNAL_ITEM_REGISTER(NRF_LOG_MODULE_NAME, \
|
||||
STRINGIFY(NRF_LOG_MODULE_NAME), \
|
||||
NRF_LOG_INFO_COLOR, \
|
||||
NRF_LOG_DEBUG_COLOR, \
|
||||
NRF_LOG_INITIAL_LEVEL, \
|
||||
COMPILED_LOG_LEVEL)
|
||||
|
||||
#else
|
||||
#define NRF_LOG_INTERNAL_MODULE_REGISTER() /*lint -save -e19*/ /*lint -restore*/
|
||||
#endif
|
||||
|
||||
extern nrf_log_module_dynamic_data_t NRF_LOG_ITEM_DATA_DYNAMIC(NRF_LOG_MODULE_NAME);
|
||||
extern _CONST nrf_log_module_const_data_t NRF_LOG_ITEM_DATA_CONST(NRF_LOG_MODULE_NAME);
|
||||
|
||||
/**
|
||||
* Set of macros for encoding and decoding header for log entries.
|
||||
* There are 2 types of entries:
|
||||
* 1. Standard entry (STD)
|
||||
* An entry consists of header, pointer to string and values. Header contains
|
||||
* severity leveland determines number of arguments and thus size of the entry.
|
||||
* Since flash address space starts from 0x00000000 and is limited to kB rather
|
||||
* than MB 22 bits are used to store the address (4MB). It is used that way to
|
||||
* save one RAM memory.
|
||||
*
|
||||
* --------------------------------
|
||||
* |TYPE|SEVERITY|NARGS| P_STR |
|
||||
* |------------------------------|
|
||||
* | Module_ID (optional) |
|
||||
* |------------------------------|
|
||||
* | TIMESTAMP (optional) |
|
||||
* |------------------------------|
|
||||
* | ARG0 |
|
||||
* |------------------------------|
|
||||
* | .... |
|
||||
* |------------------------------|
|
||||
* | ARG(nargs-1) |
|
||||
* --------------------------------
|
||||
*
|
||||
* 2. Hexdump entry (HEXDUMP) is used for dumping raw data. An entry consists of
|
||||
* header, optional timestamp, pointer to string and data. A header contains
|
||||
* length (10bit) and offset which is updated after backend processes part of
|
||||
* data.
|
||||
*
|
||||
* --------------------------------
|
||||
* |TYPE|SEVERITY|NARGS|OFFSET|LEN|
|
||||
* |------------------------------|
|
||||
* | Module_ID (optional) |
|
||||
* |------------------------------|
|
||||
* | TIMESTAMP (optional) |
|
||||
* |------------------------------|
|
||||
* | P_STR |
|
||||
* |------------------------------|
|
||||
* | data |
|
||||
* |------------------------------|
|
||||
* | data | dummy |
|
||||
* --------------------------------
|
||||
*
|
||||
*/
|
||||
|
||||
#define STD_ADDR_MASK ((uint32_t)(1U << 22) - 1U)
|
||||
#define HEADER_TYPE_STD 1U
|
||||
#define HEADER_TYPE_HEXDUMP 2U
|
||||
#define HEADER_TYPE_INVALID 3U
|
||||
|
||||
typedef struct
|
||||
{
|
||||
uint32_t type : 2;
|
||||
uint32_t in_progress: 1;
|
||||
uint32_t data : 29;
|
||||
} nrf_log_generic_header_t;
|
||||
|
||||
typedef struct
|
||||
{
|
||||
uint32_t type : 2;
|
||||
uint32_t in_progress: 1;
|
||||
uint32_t severity : 3;
|
||||
uint32_t nargs : 4;
|
||||
uint32_t addr : 22;
|
||||
} nrf_log_std_header_t;
|
||||
|
||||
typedef struct
|
||||
{
|
||||
uint32_t type : 2;
|
||||
uint32_t in_progress: 1;
|
||||
uint32_t severity : 3;
|
||||
uint32_t offset : 10;
|
||||
uint32_t reserved : 6;
|
||||
uint32_t len : 10;
|
||||
} nrf_log_hexdump_header_t;
|
||||
|
||||
typedef union
|
||||
{
|
||||
nrf_log_generic_header_t generic;
|
||||
nrf_log_std_header_t std;
|
||||
nrf_log_hexdump_header_t hexdump;
|
||||
uint32_t raw;
|
||||
} nrf_log_main_header_t;
|
||||
|
||||
typedef struct
|
||||
{
|
||||
nrf_log_main_header_t base;
|
||||
uint16_t module_id;
|
||||
uint16_t dropped;
|
||||
uint32_t timestamp;
|
||||
} nrf_log_header_t;
|
||||
|
||||
#define HEADER_SIZE (sizeof(nrf_log_header_t)/sizeof(uint32_t) - \
|
||||
(NRF_LOG_USES_TIMESTAMP ? 0 : 1))
|
||||
|
||||
/**
|
||||
* @brief A function for logging raw string.
|
||||
*
|
||||
* @param severity_mid Severity.
|
||||
* @param p_str A pointer to a string.
|
||||
*/
|
||||
void nrf_log_frontend_std_0(uint32_t severity_mid, char const * const p_str);
|
||||
|
||||
/**
|
||||
* @brief A function for logging a formatted string with one argument.
|
||||
*
|
||||
* @param severity_mid Severity.
|
||||
* @param p_str A pointer to a formatted string.
|
||||
* @param val0 An argument.
|
||||
*/
|
||||
void nrf_log_frontend_std_1(uint32_t severity_mid,
|
||||
char const * const p_str,
|
||||
uint32_t val0);
|
||||
|
||||
/**
|
||||
* @brief A function for logging a formatted string with 2 arguments.
|
||||
*
|
||||
* @param severity_mid Severity.
|
||||
* @param p_str A pointer to a formatted string.
|
||||
* @param val0, val1 Arguments for formatting string.
|
||||
*/
|
||||
void nrf_log_frontend_std_2(uint32_t severity_mid,
|
||||
char const * const p_str,
|
||||
uint32_t val0,
|
||||
uint32_t val1);
|
||||
|
||||
/**
|
||||
* @brief A function for logging a formatted string with 3 arguments.
|
||||
*
|
||||
* @param severity_mid Severity.
|
||||
* @param p_str A pointer to a formatted string.
|
||||
* @param val0, val1, val2 Arguments for formatting string.
|
||||
*/
|
||||
void nrf_log_frontend_std_3(uint32_t severity_mid,
|
||||
char const * const p_str,
|
||||
uint32_t val0,
|
||||
uint32_t val1,
|
||||
uint32_t val2);
|
||||
|
||||
/**
|
||||
* @brief A function for logging a formatted string with 4 arguments.
|
||||
*
|
||||
* @param severity_mid Severity.
|
||||
* @param p_str A pointer to a formatted string.
|
||||
* @param val0, val1, val2, val3 Arguments for formatting string.
|
||||
*/
|
||||
void nrf_log_frontend_std_4(uint32_t severity_mid,
|
||||
char const * const p_str,
|
||||
uint32_t val0,
|
||||
uint32_t val1,
|
||||
uint32_t val2,
|
||||
uint32_t val3);
|
||||
|
||||
/**
|
||||
* @brief A function for logging a formatted string with 5 arguments.
|
||||
*
|
||||
* @param severity_mid Severity.
|
||||
* @param p_str A pointer to a formatted string.
|
||||
* @param val0, val1, val2, val3, val4 Arguments for formatting string.
|
||||
*/
|
||||
void nrf_log_frontend_std_5(uint32_t severity_mid,
|
||||
char const * const p_str,
|
||||
uint32_t val0,
|
||||
uint32_t val1,
|
||||
uint32_t val2,
|
||||
uint32_t val3,
|
||||
uint32_t val4);
|
||||
|
||||
/**
|
||||
* @brief A function for logging a formatted string with 6 arguments.
|
||||
*
|
||||
* @param severity_mid Severity.
|
||||
* @param p_str A pointer to a formatted string.
|
||||
* @param val0, val1, val2, val3, val4, val5 Arguments for formatting string.
|
||||
*/
|
||||
void nrf_log_frontend_std_6(uint32_t severity_mid,
|
||||
char const * const p_str,
|
||||
uint32_t val0,
|
||||
uint32_t val1,
|
||||
uint32_t val2,
|
||||
uint32_t val3,
|
||||
uint32_t val4,
|
||||
uint32_t val5);
|
||||
|
||||
/**
|
||||
* @brief A function for logging raw data.
|
||||
*
|
||||
* @param severity_mid Severity.
|
||||
* @param p_str A pointer to a string which is prefixing the data.
|
||||
* @param p_data A pointer to data to be dumped.
|
||||
* @param length Length of data (in bytes).
|
||||
*
|
||||
*/
|
||||
void nrf_log_frontend_hexdump(uint32_t severity_mid,
|
||||
const void * const p_data,
|
||||
uint16_t length);
|
||||
|
||||
/**
|
||||
* @brief A function for reading a byte from log backend.
|
||||
*
|
||||
* @return Byte.
|
||||
*/
|
||||
uint8_t nrf_log_getchar(void);
|
||||
#endif // NRF_LOG_INTERNAL_H__
|
||||
258
components/libraries/log/src/nrf_log_str_formatter.c
Normal file
258
components/libraries/log/src/nrf_log_str_formatter.c
Normal file
@@ -0,0 +1,258 @@
|
||||
/**
|
||||
* Copyright (c) 2016 - 2020, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
#include "sdk_common.h"
|
||||
#if NRF_MODULE_ENABLED(NRF_LOG)
|
||||
#include "nrf_log_str_formatter.h"
|
||||
#include "nrf_log_internal.h"
|
||||
#include "nrf_log_ctrl.h"
|
||||
#include "nrf_fprintf.h"
|
||||
#include <ctype.h>
|
||||
|
||||
#define NRF_LOG_COLOR_CODE_DEFAULT "\x1B[0m"
|
||||
#define NRF_LOG_COLOR_CODE_BLACK "\x1B[1;30m"
|
||||
#define NRF_LOG_COLOR_CODE_RED "\x1B[1;31m"
|
||||
#define NRF_LOG_COLOR_CODE_GREEN "\x1B[1;32m"
|
||||
#define NRF_LOG_COLOR_CODE_YELLOW "\x1B[1;33m"
|
||||
#define NRF_LOG_COLOR_CODE_BLUE "\x1B[1;34m"
|
||||
#define NRF_LOG_COLOR_CODE_MAGENTA "\x1B[1;35m"
|
||||
#define NRF_LOG_COLOR_CODE_CYAN "\x1B[1;36m"
|
||||
#define NRF_LOG_COLOR_CODE_WHITE "\x1B[1;37m"
|
||||
|
||||
#define NRF_LOG_CHAR_CODE_MAX 0x7E
|
||||
|
||||
static const char * severity_names[] = {
|
||||
NULL,
|
||||
"error",
|
||||
"warning",
|
||||
"info",
|
||||
"debug"
|
||||
};
|
||||
|
||||
static const char * m_colors[] = {
|
||||
NRF_LOG_COLOR_CODE_DEFAULT,
|
||||
NRF_LOG_COLOR_CODE_BLACK,
|
||||
NRF_LOG_COLOR_CODE_RED,
|
||||
NRF_LOG_COLOR_CODE_GREEN,
|
||||
NRF_LOG_COLOR_CODE_YELLOW,
|
||||
NRF_LOG_COLOR_CODE_BLUE,
|
||||
NRF_LOG_COLOR_CODE_MAGENTA,
|
||||
NRF_LOG_COLOR_CODE_CYAN,
|
||||
NRF_LOG_COLOR_CODE_WHITE,
|
||||
};
|
||||
|
||||
static uint32_t m_freq;
|
||||
static uint32_t m_timestamp_div;
|
||||
|
||||
static void timestamp_print(nrf_fprintf_ctx_t * p_ctx, uint32_t timestamp)
|
||||
{
|
||||
if (NRF_LOG_USES_TIMESTAMP)
|
||||
{
|
||||
if (NRF_LOG_STR_FORMATTER_TIMESTAMP_FORMAT_ENABLED)
|
||||
{
|
||||
timestamp /= m_timestamp_div;
|
||||
uint32_t seconds = timestamp/m_freq;
|
||||
uint32_t hours = seconds/3600;
|
||||
seconds -= hours * 3600;
|
||||
uint32_t mins = seconds/60;
|
||||
seconds -= mins * 60;
|
||||
|
||||
uint32_t reminder = timestamp % m_freq;
|
||||
uint32_t ms = (reminder * 1000)/m_freq;
|
||||
uint32_t us = (1000*(1000*reminder - (ms * m_freq)))/m_freq;
|
||||
|
||||
nrf_fprintf(p_ctx, "[%02d:%02d:%02d.%03d,%03d] ", hours, mins, seconds, ms, us);
|
||||
}
|
||||
else
|
||||
{
|
||||
nrf_fprintf(p_ctx, "[%08lu] ", timestamp);
|
||||
}
|
||||
}
|
||||
}
|
||||
static void prefix_process(nrf_log_str_formatter_entry_params_t * p_params,
|
||||
nrf_fprintf_ctx_t * p_ctx)
|
||||
{
|
||||
if (p_params->dropped)
|
||||
{
|
||||
nrf_fprintf(p_ctx,
|
||||
"%sLogs dropped (%d)%s\r\n",
|
||||
NRF_LOG_COLOR_CODE_RED,
|
||||
p_params->dropped,
|
||||
NRF_LOG_COLOR_CODE_DEFAULT);
|
||||
}
|
||||
|
||||
if (!(p_params->severity == NRF_LOG_SEVERITY_INFO_RAW))
|
||||
{
|
||||
if (p_params->use_colors)
|
||||
{
|
||||
nrf_fprintf(p_ctx, "%s",
|
||||
m_colors[nrf_log_color_id_get( p_params->module_id, p_params->severity)]);
|
||||
}
|
||||
timestamp_print(p_ctx, p_params->timestamp);
|
||||
|
||||
nrf_fprintf(p_ctx, "<%s> %s: ",
|
||||
severity_names[p_params->severity], nrf_log_module_name_get(p_params->module_id, false));
|
||||
}
|
||||
}
|
||||
|
||||
static void postfix_process(nrf_log_str_formatter_entry_params_t * p_params,
|
||||
nrf_fprintf_ctx_t * p_ctx,
|
||||
bool newline)
|
||||
{
|
||||
if (!(p_params->severity == NRF_LOG_SEVERITY_INFO_RAW))
|
||||
{
|
||||
if (p_params->use_colors)
|
||||
{
|
||||
nrf_fprintf(p_ctx, "%s", m_colors[0]);
|
||||
}
|
||||
nrf_fprintf(p_ctx, "\r\n");
|
||||
}
|
||||
else if (newline)
|
||||
{
|
||||
nrf_fprintf(p_ctx, "\r\n");
|
||||
}
|
||||
nrf_fprintf_buffer_flush(p_ctx);
|
||||
}
|
||||
|
||||
void nrf_log_std_entry_process(char const * p_str,
|
||||
uint32_t const * p_args,
|
||||
uint32_t nargs,
|
||||
nrf_log_str_formatter_entry_params_t * p_params,
|
||||
nrf_fprintf_ctx_t * p_ctx)
|
||||
{
|
||||
bool auto_flush = p_ctx->auto_flush;
|
||||
p_ctx->auto_flush = false;
|
||||
|
||||
prefix_process(p_params, p_ctx);
|
||||
|
||||
switch (nargs)
|
||||
{
|
||||
case 0:
|
||||
nrf_fprintf(p_ctx, p_str);
|
||||
break;
|
||||
case 1:
|
||||
nrf_fprintf(p_ctx, p_str, p_args[0]);
|
||||
break;
|
||||
case 2:
|
||||
nrf_fprintf(p_ctx, p_str, p_args[0], p_args[1]);
|
||||
break;
|
||||
case 3:
|
||||
nrf_fprintf(p_ctx, p_str, p_args[0], p_args[1], p_args[2]);
|
||||
break;
|
||||
case 4:
|
||||
nrf_fprintf(p_ctx, p_str, p_args[0], p_args[1], p_args[2], p_args[3]);
|
||||
break;
|
||||
case 5:
|
||||
nrf_fprintf(p_ctx, p_str, p_args[0], p_args[1], p_args[2], p_args[3], p_args[4]);
|
||||
break;
|
||||
case 6:
|
||||
nrf_fprintf(p_ctx, p_str, p_args[0], p_args[1], p_args[2], p_args[3], p_args[4], p_args[5]);
|
||||
break;
|
||||
|
||||
default:
|
||||
break;
|
||||
}
|
||||
|
||||
postfix_process(p_params, p_ctx, false);
|
||||
p_ctx->auto_flush = auto_flush;
|
||||
}
|
||||
|
||||
#define HEXDUMP_BYTES_IN_LINE 8
|
||||
|
||||
void nrf_log_hexdump_entry_process(uint8_t * p_data,
|
||||
uint32_t data_len,
|
||||
nrf_log_str_formatter_entry_params_t * p_params,
|
||||
nrf_fprintf_ctx_t * p_ctx)
|
||||
{
|
||||
if (data_len > HEXDUMP_BYTES_IN_LINE)
|
||||
{
|
||||
return;
|
||||
}
|
||||
bool auto_flush = p_ctx->auto_flush;
|
||||
p_ctx->auto_flush = false;
|
||||
|
||||
prefix_process(p_params, p_ctx);
|
||||
|
||||
uint32_t i;
|
||||
|
||||
for (i = 0; i < HEXDUMP_BYTES_IN_LINE; i++)
|
||||
{
|
||||
if (i < data_len)
|
||||
{
|
||||
nrf_fprintf(p_ctx, " %02x", p_data[i]);
|
||||
}
|
||||
else
|
||||
{
|
||||
nrf_fprintf(p_ctx, " ");
|
||||
}
|
||||
}
|
||||
nrf_fprintf(p_ctx, "|");
|
||||
|
||||
for (i = 0; i < HEXDUMP_BYTES_IN_LINE; i++)
|
||||
{
|
||||
if (i < data_len)
|
||||
{
|
||||
char c = (char)p_data[i];
|
||||
nrf_fprintf(p_ctx, "%c", ((c <= NRF_LOG_CHAR_CODE_MAX) && isprint((int)c)) ? c :'.');
|
||||
}
|
||||
else
|
||||
{
|
||||
nrf_fprintf(p_ctx, " ");
|
||||
}
|
||||
}
|
||||
|
||||
postfix_process(p_params, p_ctx, true);
|
||||
|
||||
p_ctx->auto_flush = auto_flush;
|
||||
}
|
||||
|
||||
void nrf_log_str_formatter_timestamp_freq_set(uint32_t freq)
|
||||
{
|
||||
m_timestamp_div = 1;
|
||||
/* There is no point to have frequency higher than 1MHz (ns are not printed) and too high
|
||||
* frequency leads to overflows in calculations.
|
||||
*/
|
||||
while (freq > 1000000)
|
||||
{
|
||||
freq /= 2;
|
||||
m_timestamp_div *= 2;
|
||||
}
|
||||
m_freq = freq;
|
||||
}
|
||||
#endif //NRF_LOG_ENABLED
|
||||
Reference in New Issue
Block a user