hal_trace_interface.h 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. /**
  2. * Copyright (c) 2016 - 2020 Nordic Semiconductor ASA and Luxoft Global Operations Gmbh.
  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. *
  10. * 1. Redistributions of source code must retain the above copyright notice, this
  11. * list of conditions and the following disclaimer.
  12. *
  13. * 2. Redistributions in binary form, except as embedded into a Nordic
  14. * Semiconductor ASA integrated circuit in a product or a software update for
  15. * such product, must reproduce the above copyright notice, this list of
  16. * conditions and the following disclaimer in the documentation and/or other
  17. * materials provided with the distribution.
  18. *
  19. * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
  20. * contributors may be used to endorse or promote products derived from this
  21. * software without specific prior written permission.
  22. *
  23. * 4. This software, with or without modification, must only be used with a
  24. * Nordic Semiconductor ASA integrated circuit.
  25. *
  26. * 5. Any software provided in binary form under this license must not be reverse
  27. * engineered, decompiled, modified and/or disassembled.
  28. *
  29. *
  30. * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  31. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  32. * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  33. * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  34. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  35. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  36. * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  37. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  38. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  39. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40. *
  41. */
  42. #ifndef HAL_TRACE_INTERFACE_H_INCLUDED
  43. #define HAL_TRACE_INTERFACE_H_INCLUDED
  44. /**
  45. * @defgroup hal_trace_interface HAL Trace Interface
  46. * @ingroup hal_15_4
  47. * @{
  48. * @brief Module to declare HAL Trace Interface
  49. */
  50. #ifdef CONFIG_TRACE
  51. #include "hal_uart.h"
  52. #define HAL_TRACE_INTERFACE_REUSE(p_uart_desc) hal_trace_reuse(p_uart_desc)
  53. #define HAL_TRACE_INTERFACE_INIT() hal_trace_init()
  54. #define HAL_TRACE_INTERFACE_PUTS(s) hal_trace_puts(s)
  55. #define HAL_TRACE_INTERFACE_FINALIZE() hal_trace_finalize()
  56. /**
  57. * @brief Trace interface initialization
  58. */
  59. void hal_trace_init(void);
  60. /**
  61. * @brief Initializes trace interface, using already initialized UART.
  62. *
  63. * @param[in] p_uart_desc UART descriptor, which has been already initialized.
  64. */
  65. void hal_trace_reuse(hal_uart_descriptor_t * p_uart_desc);
  66. /**
  67. * @brief Sends a null-terminated string to the debug interface
  68. *
  69. * @details send debug data using debug interface
  70. *
  71. * @param[in] p_data null-terminated string.
  72. */
  73. void hal_trace_puts(const char * p_data);
  74. /**
  75. * @brief Finalizes buffered trace data output to UART,
  76. * before commencing non-buffered assertion output
  77. */
  78. void hal_trace_finalize(void);
  79. #else
  80. /* If debug is disabled, these macros are just a stub.*/
  81. #define HAL_TRACE_INTERFACE_REUSE(p_uart_desc)
  82. #define HAL_TRACE_INTERFACE_INIT()
  83. #define HAL_TRACE_INTERFACE_PUTS(s)
  84. #define HAL_TRACE_INTERFACE_FINALIZE()
  85. #endif // CONFIG_DEBUG
  86. /** @} */
  87. #endif // HAL_TRACE_INTERFACE_H_INCLUDED