nrfx_log.h 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152
  1. /**
  2. * Copyright (c) 2017 - 2018, Nordic Semiconductor ASA
  3. *
  4. * All rights reserved.
  5. *
  6. * Redistribution and use in source and binary forms, with or without modification,
  7. * are permitted provided that the following conditions are met:
  8. *
  9. * 1. Redistributions of source code must retain the above copyright notice, this
  10. * list of conditions and the following disclaimer.
  11. *
  12. * 2. Redistributions in binary form, except as embedded into a Nordic
  13. * Semiconductor ASA integrated circuit in a product or a software update for
  14. * such product, must reproduce the above copyright notice, this list of
  15. * conditions and the following disclaimer in the documentation and/or other
  16. * materials provided with the distribution.
  17. *
  18. * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
  19. * contributors may be used to endorse or promote products derived from this
  20. * software without specific prior written permission.
  21. *
  22. * 4. This software, with or without modification, must only be used with a
  23. * Nordic Semiconductor ASA integrated circuit.
  24. *
  25. * 5. Any software provided in binary form under this license must not be reverse
  26. * engineered, decompiled, modified and/or disassembled.
  27. *
  28. * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  29. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  30. * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  31. * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  32. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  34. * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  37. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38. *
  39. */
  40. #ifndef NRFX_LOG_H__
  41. #define NRFX_LOG_H__
  42. #ifdef __cplusplus
  43. extern "C" {
  44. #endif
  45. #if defined(NRFX_LOG_MODULE)
  46. #define NRF_LOG_MODULE_NAME NRFX_LOG_MODULE
  47. #define NRFX_CONFIG_ENTRY(x) CONCAT_3(NRFX_, NRFX_LOG_MODULE, x)
  48. #if NRFX_CHECK(NRFX_CONFIG_ENTRY(_CONFIG_LOG_ENABLED))
  49. #define NRF_LOG_LEVEL NRFX_CONFIG_ENTRY(_CONFIG_LOG_LEVEL)
  50. #define NRF_LOG_INFO_COLOR NRFX_CONFIG_ENTRY(_CONFIG_INFO_COLOR)
  51. #define NRF_LOG_DEBUG_COLOR NRFX_CONFIG_ENTRY(_CONFIG_DEBUG_COLOR)
  52. #else
  53. #define NRF_LOG_LEVEL 0
  54. #endif
  55. #endif // defined(NRFX_LOG_MODULE)
  56. #include <nrf_log.h>
  57. #if defined(NRFX_LOG_MODULE)
  58. NRF_LOG_MODULE_REGISTER();
  59. #endif
  60. #define TEST_MACRO_INFO(...) NRF_LOG_INFO(__VA_ARGS__)
  61. /**
  62. * @defgroup nrfx_log nrfx_log.h
  63. * @{
  64. * @ingroup nrfx
  65. *
  66. * @brief This file contains macros that should be implemented according to
  67. * the needs of the host environment into which @em nrfx is integrated.
  68. */
  69. /**
  70. * @brief Macro for logging a message with the severity level ERROR.
  71. */
  72. #define NRFX_LOG_ERROR(...) NRF_LOG_ERROR(__VA_ARGS__)
  73. /**
  74. * @brief Macro for logging a message with the severity level WARNING.
  75. */
  76. #define NRFX_LOG_WARNING(...) NRF_LOG_WARNING(__VA_ARGS__)
  77. /**
  78. * @brief Macro for logging a message with the severity level INFO.
  79. */
  80. #define NRFX_LOG_INFO(...) TEST_MACRO_INFO(__VA_ARGS__)
  81. /**
  82. * @brief Macro for logging a message with the severity level DEBUG.
  83. */
  84. #define NRFX_LOG_DEBUG(...) NRF_LOG_DEBUG(__VA_ARGS__)
  85. /**
  86. * @brief Macro for logging a memory dump with the severity level ERROR.
  87. *
  88. * @param[in] p_memory Pointer to the memory region to be dumped.
  89. * @param[in] length Length of the memory region in bytes.
  90. */
  91. #define NRFX_LOG_HEXDUMP_ERROR(p_memory, length) \
  92. NRF_LOG_HEXDUMP_ERROR(p_memory, length)
  93. /**
  94. * @brief Macro for logging a memory dump with the severity level WARNING.
  95. *
  96. * @param[in] p_memory Pointer to the memory region to be dumped.
  97. * @param[in] length Length of the memory region in bytes.
  98. */
  99. #define NRFX_LOG_HEXDUMP_WARNING(p_memory, length) \
  100. NRF_LOG_HEXDUMP_WARNING(p_memory, length)
  101. /**
  102. * @brief Macro for logging a memory dump with the severity level INFO.
  103. *
  104. * @param[in] p_memory Pointer to the memory region to be dumped.
  105. * @param[in] length Length of the memory region in bytes.
  106. */
  107. #define NRFX_LOG_HEXDUMP_INFO(p_memory, length) \
  108. NRF_LOG_HEXDUMP_INFO(p_memory, length)
  109. /**
  110. * @brief Macro for logging a memory dump with the severity level DEBUG.
  111. *
  112. * @param[in] p_memory Pointer to the memory region to be dumped.
  113. * @param[in] length Length of the memory region in bytes.
  114. */
  115. #define NRFX_LOG_HEXDUMP_DEBUG(p_memory, length) \
  116. NRF_LOG_HEXDUMP_DEBUG(p_memory, length)
  117. /**
  118. * @brief Macro for getting the textual representation of a given error code.
  119. *
  120. * @param[in] error_code Error code.
  121. *
  122. * @return String containing the textual representation of the error code.
  123. */
  124. #define NRFX_LOG_ERROR_STRING_GET(error_code) \
  125. NRF_LOG_ERROR_STRING_GET(error_code)
  126. /** @} */
  127. #ifdef __cplusplus
  128. }
  129. #endif
  130. #endif // NRFX_LOG_H__