ble_dtm_app.h 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  1. /**
  2. * Copyright (c) 2014 - 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. #ifndef BLE_DTM_APP_H__
  41. #define BLE_DTM_APP_H__
  42. /**
  43. * @addtogroup ser_codecs Serialization codecs
  44. * @ingroup ble_sdk_lib_serialization
  45. * @brief Application and Connectivity codecs.
  46. */
  47. /**
  48. * @addtogroup ser_codecs_app Application codecs
  49. * @ingroup ser_codecs
  50. */
  51. /**
  52. * @addtogroup ser_app_common_codecs Application common codecs
  53. * @ingroup ser_codecs_app
  54. */
  55. /**@file
  56. *
  57. * @defgroup ble_dtm_app DTM Application command request encoders and command response decoders
  58. * @{
  59. * @ingroup ser_app_common_codecs
  60. *
  61. * @brief DTM Application command request encoders and command response decoders.
  62. */
  63. #include "dtm_uart_params.h"
  64. #ifdef __cplusplus
  65. extern "C" {
  66. #endif
  67. /**@brief Encodes the @ref ble_dtm_init command request.
  68. *
  69. * @sa @ref encoding_data for packet format,
  70. * @ref ble_dtm_init_rsp_dec for command response decoder.
  71. *
  72. * @param[in] p_uart_comm_params Pointer to the UART configuration parameters.
  73. * @param[in] p_buf Pointer to the buffer where encoded data command will be returned.
  74. * @param[in,out] p_buf_len \c in: Size of \p p_buf buffer.
  75. * \c out: Length of the encoded command packet.
  76. *
  77. * @retval NRF_SUCCESS Encoding success.
  78. * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
  79. * @retval NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
  80. */
  81. uint32_t ble_dtm_init_req_enc(app_uart_stream_comm_params_t const * const p_uart_comm_params,
  82. uint8_t * const p_buf,
  83. uint32_t * const p_buf_len);
  84. /**@brief Decodes the response @ref ble_dtm_init command.
  85. *
  86. * @sa @ref encoding_data for packet format,
  87. * @ref ble_dtm_init_req_enc for command request encoder.
  88. *
  89. * @param[in] p_buf Pointer to the beginning of a command response packet.
  90. * @param[in] packet_len Length (in bytes) of the response packet.
  91. * @param[out] p_result_code Command result code.
  92. *
  93. * @retval NRF_SUCCESS Decoding success.
  94. * @retval NRF_ERROR_NULL Decoding failure. NULL pointer supplied.
  95. * @retval NRF_ERROR_INVALID_LENGTH Decoding failure. Incorrect buffer length.
  96. */
  97. uint32_t ble_dtm_init_rsp_dec(uint8_t const * const p_buf,
  98. uint32_t packet_len,
  99. uint32_t * const p_result_code);
  100. /**@brief Function to initializing the DTM mode.
  101. *
  102. * @param[in] p_uart_comm_params Pointer to the DTM UART configuration parameters.
  103. *
  104. * @retval NRF_SUCCESS Encoding success.
  105. * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
  106. */
  107. uint32_t ble_dtm_init(app_uart_stream_comm_params_t * p_uart_comm_params);
  108. /** @} */
  109. #ifdef __cplusplus
  110. }
  111. #endif
  112. #endif // BLE_DTM_APP_H__