nrf_log_str_formatter.h 3.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. /**
  2. * Copyright (c) 2016 - 2020, 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. /**@file
  41. *
  42. * @defgroup nrf_log_str_formatter String formatter for the logger messages
  43. * @{
  44. * @ingroup nrf_log
  45. */
  46. #ifndef NRF_LOG_STR_FORMATTER_H
  47. #define NRF_LOG_STR_FORMATTER_H
  48. #include <stdint.h>
  49. #include "nrf_fprintf.h"
  50. #include "nrf_log_ctrl.h"
  51. #ifdef __cplusplus
  52. extern "C" {
  53. #endif
  54. typedef struct
  55. {
  56. uint32_t timestamp;
  57. uint16_t module_id;
  58. uint16_t dropped;
  59. nrf_log_severity_t severity;
  60. uint8_t use_colors;
  61. } nrf_log_str_formatter_entry_params_t;
  62. void nrf_log_std_entry_process(char const * p_str,
  63. uint32_t const * p_args,
  64. uint32_t nargs,
  65. nrf_log_str_formatter_entry_params_t * p_params,
  66. nrf_fprintf_ctx_t * p_ctx);
  67. void nrf_log_hexdump_entry_process(uint8_t * p_data,
  68. uint32_t data_len,
  69. nrf_log_str_formatter_entry_params_t * p_params,
  70. nrf_fprintf_ctx_t * p_ctx);
  71. void nrf_log_str_formatter_timestamp_freq_set(uint32_t freq);
  72. #ifdef __cplusplus
  73. }
  74. #endif
  75. #endif //NRF_LOG_STR_FORMATTER_H
  76. /** @} */