ble_gatts_evt_conn.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208
  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_GATTS_EVT_CONN_H__
  41. #define BLE_GATTS_EVT_CONN_H__
  42. /**@file
  43. *
  44. * @defgroup ble_gatts_evt_conn GATTS Connectivity event encoders
  45. * @{
  46. * @ingroup ser_conn_s130_codecs
  47. *
  48. * @brief GATTS Connectivity event encoders.
  49. */
  50. #include "ble.h"
  51. #ifdef __cplusplus
  52. extern "C" {
  53. #endif
  54. /**
  55. * @brief Encodes @ref BLE_GATTS_EVT_HVC event.
  56. *
  57. * @param[in] p_event Pointer to the \ref ble_evt_t buffer that shall be encoded.
  58. * @param[in] event_len Size (in bytes) of \p p_event buffer.
  59. * @param[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
  60. * @param[in,out] p_buf_len \c in: Size (in bytes) of \p p_buf buffer.
  61. * \c out: Length of encoded contents in \p p_buf.
  62. *
  63. * @retval NRF_SUCCESS Encoding success.
  64. * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
  65. * @retval NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
  66. */
  67. uint32_t ble_gatts_evt_hvc_enc(ble_evt_t const * const p_event,
  68. uint32_t event_len,
  69. uint8_t * const p_buf,
  70. uint32_t * const p_buf_len);
  71. /**
  72. * @brief Encodes @ref BLE_GATTS_EVT_RW_AUTHORIZE_REQUEST event.
  73. *
  74. * @param[in] p_event Pointer to the \ref ble_evt_t buffer that shall be encoded.
  75. * @param[in] event_len Size (in bytes) of \p p_event buffer.
  76. * @param[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
  77. * @param[in,out] p_buf_len \c in: Size (in bytes) of \p p_buf buffer.
  78. * \c out: Length of encoded contents in \p p_buf.
  79. *
  80. * @retval NRF_SUCCESS Encoding success.
  81. * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
  82. * @retval NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
  83. */
  84. uint32_t ble_gatts_evt_rw_authorize_request_enc(ble_evt_t const * const p_event,
  85. uint32_t event_len,
  86. uint8_t * const p_buf,
  87. uint32_t * const p_buf_len);
  88. /**
  89. * @brief Encodes @ref BLE_GATTS_EVT_SC_CONFIRM event.
  90. *
  91. * @param[in] p_event Pointer to the \ref ble_evt_t buffer that shall be encoded.
  92. * @param[in] event_len Size (in bytes) of \p p_event buffer.
  93. * @param[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
  94. * @param[in,out] p_buf_len \c in: Size (in bytes) of \p p_buf buffer.
  95. * \c out: Length of encoded contents in \p p_buf.
  96. *
  97. * @retval NRF_SUCCESS Encoding success.
  98. * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
  99. * @retval NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
  100. */
  101. uint32_t ble_gatts_evt_sc_confirm_enc(ble_evt_t const * const p_event,
  102. uint32_t event_len,
  103. uint8_t * const p_buf,
  104. uint32_t * const p_buf_len);
  105. /**
  106. * @brief Encodes @ref BLE_GATTS_EVT_SYS_ATTR_MISSING event.
  107. *
  108. * @param[in] p_event Pointer to the \ref ble_evt_t buffer that shall be encoded.
  109. * @param[in] event_len Size (in bytes) of \p p_event buffer.
  110. * @param[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
  111. * @param[in,out] p_buf_len \c in: Size (in bytes) of \p p_buf buffer.
  112. * \c out: Length of encoded contents in \p p_buf.
  113. *
  114. * @retval NRF_SUCCESS Encoding success.
  115. * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
  116. * @retval NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
  117. */
  118. uint32_t ble_gatts_evt_sys_attr_missing_enc(ble_evt_t const * const p_event,
  119. uint32_t event_len,
  120. uint8_t * const p_buf,
  121. uint32_t * const p_buf_len);
  122. /**
  123. * @brief Encodes @ref BLE_GATTS_EVT_TIMEOUT event.
  124. *
  125. * @param[in] p_event Pointer to the \ref ble_evt_t buffer that shall be encoded.
  126. * @param[in] event_len Size (in bytes) of \p p_event buffer.
  127. * @param[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
  128. * @param[in,out] p_buf_len \c in: Size (in bytes) of \p p_buf buffer.
  129. * \c out: Length of encoded contents in \p p_buf.
  130. *
  131. * @retval NRF_SUCCESS Encoding success.
  132. * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
  133. * @retval NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
  134. */
  135. uint32_t ble_gatts_evt_timeout_enc(ble_evt_t const * const p_event,
  136. uint32_t event_len,
  137. uint8_t * const p_buf,
  138. uint32_t * const p_buf_len);
  139. /**
  140. * @brief Encodes @ref BLE_GATTS_EVT_WRITE event.
  141. *
  142. * @param[in] p_event Pointer to the \ref ble_evt_t buffer that shall be encoded.
  143. * @param[in] event_len Size (in bytes) of \p p_event buffer.
  144. * @param[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
  145. * @param[in,out] p_buf_len \c in: Size (in bytes) of \p p_buf buffer.
  146. * \c out: Length of encoded contents in \p p_buf.
  147. *
  148. * @retval NRF_SUCCESS Encoding success.
  149. * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
  150. * @retval NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
  151. */
  152. uint32_t ble_gatts_evt_write_enc(ble_evt_t const * const p_event,
  153. uint32_t event_len,
  154. uint8_t * const p_buf,
  155. uint32_t * const p_buf_len);
  156. /**
  157. * @brief Encodes @ref BLE_GATTS_EVT_EXCHANGE_MTU_REQUEST event.
  158. *
  159. * @param[in] p_event Pointer to the \ref ble_evt_t buffer that shall be encoded.
  160. * @param[in] event_len Size (in bytes) of \p p_event buffer.
  161. * @param[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
  162. * @param[in,out] p_buf_len \c in: Size (in bytes) of \p p_buf buffer.
  163. * \c out: Length of encoded contents in \p p_buf.
  164. *
  165. * @retval NRF_SUCCESS Encoding success.
  166. * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
  167. * @retval NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
  168. */
  169. uint32_t ble_gatts_evt_exchange_mtu_request_enc(ble_evt_t const * const p_event,
  170. uint32_t event_len,
  171. uint8_t * const p_buf,
  172. uint32_t * const p_buf_len);
  173. #if NRF_SD_BLE_API_VERSION >= 4
  174. /**
  175. * @brief Encodes @ref BLE_GATTS_EVT_HVN_TX_COMPLETE event.
  176. *
  177. * @param[in] p_event Pointer to the \ref ble_evt_t buffer that shall be encoded.
  178. * @param[in] event_len Size (in bytes) of \p p_event buffer.
  179. * @param[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
  180. * @param[in,out] p_buf_len \c in: Size (in bytes) of \p p_buf buffer.
  181. * \c out: Length of encoded contents in \p p_buf.
  182. *
  183. * @retval NRF_SUCCESS Encoding success.
  184. * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
  185. * @retval NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
  186. */
  187. uint32_t ble_gatts_evt_hvn_tx_complete_enc(ble_evt_t const * const p_event,
  188. uint32_t event_len,
  189. uint8_t * const p_buf,
  190. uint32_t * const p_buf_len);
  191. #endif
  192. /** @} */
  193. #ifdef __cplusplus
  194. }
  195. #endif
  196. #endif