nrfx_log.h 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
  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. // THIS IS A TEMPLATE FILE.
  43. // It should be copied to a suitable location within the host environment into
  44. // which nrfx is integrated, and the following macros should be provided with
  45. // appropriate implementations.
  46. // And this comment should be removed from the customized file.
  47. #ifdef __cplusplus
  48. extern "C" {
  49. #endif
  50. /**
  51. * @defgroup nrfx_log nrfx_log.h
  52. * @{
  53. * @ingroup nrfx
  54. *
  55. * @brief This file contains macros that should be implemented according to
  56. * the needs of the host environment into which @em nrfx is integrated.
  57. */
  58. /**
  59. * @brief Macro for logging a message with the severity level ERROR.
  60. *
  61. * @param format printf-style format string, optionally followed by arguments
  62. * to be formatted and inserted in the resulting string.
  63. */
  64. #define NRFX_LOG_ERROR(format, ...)
  65. /**
  66. * @brief Macro for logging a message with the severity level WARNING.
  67. *
  68. * @param format printf-style format string, optionally followed by arguments
  69. * to be formatted and inserted in the resulting string.
  70. */
  71. #define NRFX_LOG_WARNING(format, ...)
  72. /**
  73. * @brief Macro for logging a message with the severity level INFO.
  74. *
  75. * @param format printf-style format string, optionally followed by arguments
  76. * to be formatted and inserted in the resulting string.
  77. */
  78. #define NRFX_LOG_INFO(format, ...)
  79. /**
  80. * @brief Macro for logging a message with the severity level DEBUG.
  81. *
  82. * @param format printf-style format string, optionally followed by arguments
  83. * to be formatted and inserted in the resulting string.
  84. */
  85. #define NRFX_LOG_DEBUG(format, ...)
  86. /**
  87. * @brief Macro for logging a memory dump with the severity level ERROR.
  88. *
  89. * @param[in] p_memory Pointer to the memory region to be dumped.
  90. * @param[in] length Length of the memory region in bytes.
  91. */
  92. #define NRFX_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. /**
  101. * @brief Macro for logging a memory dump with the severity level INFO.
  102. *
  103. * @param[in] p_memory Pointer to the memory region to be dumped.
  104. * @param[in] length Length of the memory region in bytes.
  105. */
  106. #define NRFX_LOG_HEXDUMP_INFO(p_memory, length)
  107. /**
  108. * @brief Macro for logging a memory dump with the severity level DEBUG.
  109. *
  110. * @param[in] p_memory Pointer to the memory region to be dumped.
  111. * @param[in] length Length of the memory region in bytes.
  112. */
  113. #define NRFX_LOG_HEXDUMP_DEBUG(p_memory, length)
  114. /**
  115. * @brief Macro for getting the textual representation of a given error code.
  116. *
  117. * @param[in] error_code Error code.
  118. *
  119. * @return String containing the textual representation of the error code.
  120. */
  121. #define NRFX_LOG_ERROR_STRING_GET(error_code)
  122. /** @} */
  123. #ifdef __cplusplus
  124. }
  125. #endif
  126. #endif // NRFX_LOG_H__