ble_dtm_conn.h 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  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_CONN_H__
  41. #define BLE_DTM_CONN_H__
  42. /**
  43. * @addtogroup ser_codecs_conn Connectivity codecs
  44. * @ingroup ser_codecs
  45. */
  46. /**
  47. * @addtogroup ser_conn_common_codecs Connectivity common codecs
  48. * @ingroup ser_codecs_conn
  49. */
  50. /**@file
  51. *
  52. * @defgroup ble_dtm_conn DTM Connectivity command request decoder and command response encoder
  53. * @{
  54. * @ingroup ser_conn_common_codecs
  55. *
  56. * @brief DTM Connectivity command request decoder and command response encoder.
  57. */
  58. #include "dtm_uart.h"
  59. #ifdef __cplusplus
  60. extern "C" {
  61. #endif
  62. /**@brief Decodes @ref ble_dtm_init command request.
  63. *
  64. * @sa @ref encoding_data for packet format,
  65. * @ref ble_dtm_init_rsp_enc for response encoding.
  66. *
  67. * @param[in] p_buf Pointer to beginning of command request packet.
  68. * @param[in] packet_len Length (in bytes) of request packet.
  69. * @param[in] p_comm_params Pointer to the structure with DTM UART configuration.
  70. *
  71. * @retval NRF_SUCCESS Decoding success.
  72. * @retval NRF_ERROR_NULL Decoding failure. NULL pointer supplied.
  73. * @retval NRF_ERROR_INVALID_LENGTH Decoding failure. Incorrect buffer length.
  74. */
  75. uint32_t ble_dtm_init_req_dec(uint8_t const * const p_buf,
  76. uint16_t packet_len,
  77. app_uart_stream_comm_params_t * p_comm_params);
  78. /**@brief Encodes @ref ble_dtm_init command response.
  79. *
  80. * @sa @ref encoding_data for packet format.
  81. * @ref ble_dtm_init_req_dec for request decoding.
  82. *
  83. * @param[in] return_code Return code indicating if command was successful or not.
  84. * @param[out] p_buf Pointer to buffer where encoded data command response will be
  85. * returned.
  86. * @param[in,out] p_buf_len \c in: size of \p p_buf buffer.
  87. * \c out: Length of encoded command response packet.
  88. *
  89. * @retval NRF_SUCCESS Encoding success.
  90. * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
  91. * @retval NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
  92. */
  93. uint32_t ble_dtm_init_rsp_enc(uint32_t return_code,
  94. uint8_t * const p_buf,
  95. uint32_t * const p_buf_len);
  96. /** @} */
  97. #ifdef __cplusplus
  98. }
  99. #endif
  100. #endif // BLE_DTM_CONN_H__