ble_evt_app.h 7.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  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_APP_H__
  41. #define BLE_EVT_APP_H__
  42. /**@file
  43. *
  44. * @defgroup ble_evt_app Application event decoders
  45. * @{
  46. * @ingroup ser_app_s130_codecs
  47. *
  48. * @brief Application event decoders.
  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 Decodes the ble_evt_tx_complete event.
  57. *
  58. * If \p p_event is null, the required length of \p p_event is returned in \p p_event_len.
  59. *
  60. * @param[in] p_buf Pointer to the beginning of the event packet.
  61. * @param[in] packet_len Length (in bytes) of the event packet.
  62. * @param[in,out] p_event Pointer to the \ref ble_evt_t buffer where the decoded event will be
  63. * stored. If NULL, the required length will be returned in \p p_event_len.
  64. * @param[in,out] p_event_len \c in: Size (in bytes) of the \p p_event buffer.
  65. * \c out: Length of the decoded contents of \p p_event.
  66. *
  67. * @retval NRF_SUCCESS Decoding success.
  68. * @retval NRF_ERROR_NULL Decoding failure. NULL pointer supplied.
  69. * @retval NRF_ERROR_INVALID_LENGTH Decoding failure. Incorrect buffer length.
  70. * @retval NRF_ERROR_DATA_SIZE Decoding failure. Length of \p p_event is too small to
  71. * hold the decoded event.
  72. */
  73. uint32_t ble_evt_tx_complete_dec(uint8_t const * const p_buf,
  74. uint32_t packet_len,
  75. ble_evt_t * const p_event,
  76. uint32_t * const p_event_len);
  77. #endif
  78. /**
  79. * @brief Decodes the ble_evt_user_mem_request event.
  80. *
  81. * If \p p_event is null, the required length of \p p_event is returned in \p p_event_len.
  82. *
  83. * @param[in] p_buf Pointer to the beginning of the event packet.
  84. * @param[in] packet_len Length (in bytes) of the event packet.
  85. * @param[in,out] p_event Pointer to the \ref ble_evt_t buffer where the decoded event will be
  86. * stored. If NULL, the required length will be returned in \p p_event_len.
  87. * @param[in,out] p_event_len \c in: Size (in bytes) of the \p p_event buffer.
  88. * \c out: Length of the decoded contents of \p p_event.
  89. *
  90. * @retval NRF_SUCCESS Decoding success.
  91. * @retval NRF_ERROR_NULL Decoding failure. NULL pointer supplied.
  92. * @retval NRF_ERROR_INVALID_LENGTH Decoding failure. Incorrect buffer length.
  93. * @retval NRF_ERROR_DATA_SIZE Decoding failure. Length of \p p_event is too small to
  94. * hold the decoded event.
  95. */
  96. uint32_t ble_evt_user_mem_request_dec(uint8_t const * const p_buf,
  97. uint32_t packet_len,
  98. ble_evt_t * const p_event,
  99. uint32_t * const p_event_len);
  100. /**
  101. * @brief Decodes the ble_evt_user_mem_release event.
  102. *
  103. * If \p p_event is null, the required length of \p p_event is returned in \p p_event_len.
  104. *
  105. * @param[in] p_buf Pointer to the beginning of the event packet.
  106. * @param[in] packet_len Length (in bytes) of the event packet.
  107. * @param[in,out] p_event Pointer to the \ref ble_evt_t buffer where the decoded event will be
  108. * stored. If NULL, the required length will be returned in \p p_event_len.
  109. * @param[in,out] p_event_len \c in: Size (in bytes) of the \p p_event buffer.
  110. * \c out: Length of the decoded contents of \p p_event.
  111. *
  112. * @retval NRF_SUCCESS Decoding success.
  113. * @retval NRF_ERROR_NULL Decoding failure. NULL pointer supplied.
  114. * @retval NRF_ERROR_INVALID_LENGTH Decoding failure. Incorrect buffer length.
  115. * @retval NRF_ERROR_DATA_SIZE Decoding failure. Length of \p p_event is too small to
  116. * hold the decoded event.
  117. */
  118. uint32_t ble_evt_user_mem_release_dec(uint8_t const * const p_buf,
  119. uint32_t packet_len,
  120. ble_evt_t * const p_event,
  121. uint32_t * const p_event_len);
  122. #if defined(NRF_SD_BLE_API_VERSION) && NRF_SD_BLE_API_VERSION < 4
  123. /**
  124. * @brief Decodes the ble_evt_data_length_changed event.
  125. *
  126. * If \p p_event is null, the required length of \p p_event is returned in \p p_event_len.
  127. *
  128. * @param[in] p_buf Pointer to the beginning of the event packet.
  129. * @param[in] packet_len Length (in bytes) of the event packet.
  130. * @param[in,out] p_event Pointer to the \ref ble_evt_t buffer where the decoded event will be
  131. * stored. If NULL, the required length will be returned in \p p_event_len.
  132. * @param[in,out] p_event_len \c in: Size (in bytes) of the \p p_event buffer.
  133. * \c out: Length of the decoded contents of \p p_event.
  134. *
  135. * @retval NRF_SUCCESS Decoding success.
  136. * @retval NRF_ERROR_NULL Decoding failure. NULL pointer supplied.
  137. * @retval NRF_ERROR_INVALID_LENGTH Decoding failure. Incorrect buffer length.
  138. * @retval NRF_ERROR_DATA_SIZE Decoding failure. Length of \p p_event is too small to
  139. * hold the decoded event.
  140. */
  141. uint32_t ble_evt_data_length_changed_dec(uint8_t const * const p_buf,
  142. uint32_t packet_len,
  143. ble_evt_t * const p_event,
  144. uint32_t * const p_event_len);
  145. #endif
  146. /** @} */
  147. #ifdef __cplusplus
  148. }
  149. #endif
  150. #endif