ble_evt_conn.h 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138
  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_EVT_CONN_H__
  41. #define BLE_EVT_CONN_H__
  42. /**@file
  43. *
  44. * @defgroup ble_evt_conn Connectivity event encoders
  45. * @{
  46. * @ingroup ser_conn_s130_codecs
  47. *
  48. * @brief Connectivity event encoders.
  49. */
  50. #include "ble.h"
  51. #ifdef __cplusplus
  52. extern "C" {
  53. #endif
  54. #if defined(NRF_SD_BLE_API_VERSION) && NRF_SD_BLE_API_VERSION < 4
  55. /**
  56. * @brief Encodes ble_evt_tx_complete event.
  57. *
  58. * @param[in] p_event Pointer to the \ref ble_evt_t buffer that will be encoded.
  59. * @param[in] event_len Size (in bytes) of \p p_event buffer.
  60. * @param[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
  61. * @param[in,out] p_buf_len \c in: Size (in bytes) of \p p_buf buffer.
  62. * \c out: Length of encoded contents in \p p_buf.
  63. *
  64. * @retval NRF_SUCCESS Encoding success.
  65. * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
  66. * @retval NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
  67. */
  68. uint32_t ble_evt_tx_complete_enc(ble_evt_t const * const p_event,
  69. uint32_t event_len,
  70. uint8_t * const p_buf,
  71. uint32_t * const p_buf_len);
  72. #endif
  73. /**
  74. * @brief Encodes ble_evt_user_mem_release event.
  75. *
  76. * @param[in] p_event Pointer to the \ref ble_evt_t buffer that shall be encoded.
  77. * @param[in] event_len Size (in bytes) of \p p_event buffer.
  78. * @param[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
  79. * @param[in,out] p_buf_len \c in: Size (in bytes) of \p p_buf buffer.
  80. * \c out: Length of encoded contents in \p p_buf.
  81. *
  82. * @retval NRF_SUCCESS Encoding success.
  83. * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
  84. * @retval NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
  85. */
  86. uint32_t ble_evt_user_mem_release_enc(ble_evt_t const * const p_event,
  87. uint32_t event_len,
  88. uint8_t * const p_buf,
  89. uint32_t * const p_buf_len);
  90. /**
  91. * @brief Encodes ble_evt_user_mem_request event.
  92. *
  93. * @param[in] p_event Pointer to the \ref ble_evt_t buffer that will be encoded.
  94. * @param[in] event_len Size (in bytes) of \p p_event buffer.
  95. * @param[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
  96. * @param[in,out] p_buf_len \c in: Size (in bytes) of \p p_buf buffer.
  97. * \c out: Length of encoded contents in \p p_buf.
  98. *
  99. * @retval NRF_SUCCESS Encoding success.
  100. * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
  101. * @retval NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
  102. */
  103. uint32_t ble_evt_user_mem_request_enc(ble_evt_t const * const p_event,
  104. uint32_t event_len,
  105. uint8_t * const p_buf,
  106. uint32_t * const p_buf_len);
  107. #if defined(NRF_SD_BLE_API_VERSION) && NRF_SD_BLE_API_VERSION < 4
  108. /**
  109. * @brief Encodes ble_evt_data_length_changed event.
  110. *
  111. * @param[in] p_event Pointer to the \ref ble_evt_t buffer that will be encoded.
  112. * @param[in] event_len Size (in bytes) of \p p_event buffer.
  113. * @param[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
  114. * @param[in,out] p_buf_len \c in: Size (in bytes) of \p p_buf buffer.
  115. * \c out: Length of encoded contents in \p p_buf.
  116. *
  117. * @retval NRF_SUCCESS Encoding success.
  118. * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
  119. * @retval NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
  120. */
  121. uint32_t ble_evt_data_length_changed_enc(ble_evt_t const * const p_event,
  122. uint32_t event_len,
  123. uint8_t * const p_buf,
  124. uint32_t * const p_buf_len);
  125. #endif
  126. /** @} */
  127. #ifdef __cplusplus
  128. }
  129. #endif
  130. #endif