nrf_ble_qwr.c 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488
  1. /**
  2. * Copyright (c) 2016 - 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. #include "sdk_common.h"
  41. #if NRF_MODULE_ENABLED(NRF_BLE_QWR)
  42. #include <stdlib.h>
  43. #include "nrf_ble_qwr.h"
  44. #include "ble.h"
  45. #include "ble_srv_common.h"
  46. #define NRF_BLE_QWR_INITIALIZED 0xDE // Non-zero value used to make sure the given structure has been initialized by the module.
  47. #define MODULE_INITIALIZED (p_qwr->initialized == NRF_BLE_QWR_INITIALIZED)
  48. #include "sdk_macros.h"
  49. ret_code_t nrf_ble_qwr_init(nrf_ble_qwr_t * p_qwr,
  50. nrf_ble_qwr_init_t const * p_qwr_init)
  51. {
  52. VERIFY_PARAM_NOT_NULL(p_qwr);
  53. VERIFY_PARAM_NOT_NULL(p_qwr_init);
  54. if (MODULE_INITIALIZED)
  55. {
  56. return NRF_ERROR_INVALID_STATE;
  57. }
  58. p_qwr->error_handler = p_qwr_init->error_handler;
  59. p_qwr->initialized = NRF_BLE_QWR_INITIALIZED;
  60. p_qwr->conn_handle = BLE_CONN_HANDLE_INVALID;
  61. #if (NRF_BLE_QWR_MAX_ATTR > 0)
  62. memset(p_qwr->attr_handles, 0, sizeof(p_qwr->attr_handles));
  63. p_qwr->nb_registered_attr = 0;
  64. p_qwr->is_user_mem_reply_pending = false;
  65. p_qwr->mem_buffer = p_qwr_init->mem_buffer;
  66. p_qwr->callback = p_qwr_init->callback;
  67. p_qwr->nb_written_handles = 0;
  68. #endif
  69. return NRF_SUCCESS;
  70. }
  71. #if (NRF_BLE_QWR_MAX_ATTR > 0)
  72. ret_code_t nrf_ble_qwr_attr_register(nrf_ble_qwr_t * p_qwr, uint16_t attr_handle)
  73. {
  74. VERIFY_PARAM_NOT_NULL(p_qwr);
  75. VERIFY_MODULE_INITIALIZED();
  76. if ((p_qwr->nb_registered_attr == NRF_BLE_QWR_MAX_ATTR)
  77. || (p_qwr->mem_buffer.p_mem == NULL)
  78. || (p_qwr->mem_buffer.len == 0))
  79. {
  80. return (NRF_ERROR_NO_MEM);
  81. }
  82. if (attr_handle == BLE_GATT_HANDLE_INVALID)
  83. {
  84. return NRF_ERROR_INVALID_PARAM;
  85. }
  86. p_qwr->attr_handles[p_qwr->nb_registered_attr] = attr_handle;
  87. p_qwr->nb_registered_attr++;
  88. return NRF_SUCCESS;
  89. }
  90. ret_code_t nrf_ble_qwr_value_get(nrf_ble_qwr_t * p_qwr,
  91. uint16_t attr_handle,
  92. uint8_t * p_mem,
  93. uint16_t * p_len)
  94. {
  95. VERIFY_PARAM_NOT_NULL(p_qwr);
  96. VERIFY_PARAM_NOT_NULL(p_mem);
  97. VERIFY_PARAM_NOT_NULL(p_len);
  98. VERIFY_MODULE_INITIALIZED();
  99. uint16_t i = 0;
  100. uint16_t handle = BLE_GATT_HANDLE_INVALID;
  101. uint16_t val_len = 0;
  102. uint16_t val_offset = 0;
  103. uint32_t cur_len = 0;
  104. do
  105. {
  106. handle = uint16_decode(&(p_qwr->mem_buffer.p_mem[i]));
  107. if (handle == BLE_GATT_HANDLE_INVALID)
  108. {
  109. break;
  110. }
  111. i += sizeof(uint16_t);
  112. val_offset = uint16_decode(&(p_qwr->mem_buffer.p_mem[i]));
  113. i += sizeof(uint16_t);
  114. val_len = uint16_decode(&(p_qwr->mem_buffer.p_mem[i]));
  115. i += sizeof(uint16_t);
  116. if (handle == attr_handle)
  117. {
  118. cur_len = val_offset + val_len;
  119. if (cur_len <= *p_len)
  120. {
  121. memcpy((p_mem + val_offset), &(p_qwr->mem_buffer.p_mem[i]), val_len);
  122. }
  123. else
  124. {
  125. return NRF_ERROR_NO_MEM;
  126. }
  127. }
  128. i += val_len;
  129. }
  130. while (i < p_qwr->mem_buffer.len);
  131. *p_len = cur_len;
  132. return NRF_SUCCESS;
  133. }
  134. #endif
  135. ret_code_t nrf_ble_qwr_conn_handle_assign(nrf_ble_qwr_t * p_qwr,
  136. uint16_t conn_handle)
  137. {
  138. VERIFY_PARAM_NOT_NULL(p_qwr);
  139. VERIFY_MODULE_INITIALIZED();
  140. p_qwr->conn_handle = conn_handle;
  141. return NRF_SUCCESS;
  142. }
  143. /**@brief checks if a user_mem_reply is pending, if so attempts to send it.
  144. *
  145. * @param[in] p_qwr QWR structure.
  146. */
  147. static void user_mem_reply(nrf_ble_qwr_t * p_qwr)
  148. {
  149. if (p_qwr->is_user_mem_reply_pending)
  150. {
  151. ret_code_t err_code;
  152. #if (NRF_BLE_QWR_MAX_ATTR == 0)
  153. err_code = sd_ble_user_mem_reply(p_qwr->conn_handle, NULL);
  154. #else
  155. err_code = sd_ble_user_mem_reply(p_qwr->conn_handle, &p_qwr->mem_buffer);
  156. #endif
  157. if (err_code == NRF_SUCCESS)
  158. {
  159. p_qwr->is_user_mem_reply_pending = false;
  160. }
  161. else if (err_code == NRF_ERROR_BUSY)
  162. {
  163. p_qwr->is_user_mem_reply_pending = true;
  164. }
  165. else
  166. {
  167. p_qwr->error_handler(err_code);
  168. }
  169. }
  170. }
  171. /**@brief Handle a user memory request event.
  172. *
  173. * @param[in] p_qwr QWR structure.
  174. * @param[in] p_common_evt User_mem_request event to be handled.
  175. */
  176. static void on_user_mem_request(nrf_ble_qwr_t * p_qwr,
  177. ble_common_evt_t const * p_common_evt)
  178. {
  179. if ((p_common_evt->params.user_mem_request.type == BLE_USER_MEM_TYPE_GATTS_QUEUED_WRITES) &&
  180. (p_common_evt->conn_handle == p_qwr->conn_handle))
  181. {
  182. p_qwr->is_user_mem_reply_pending = true;
  183. user_mem_reply(p_qwr);
  184. }
  185. }
  186. /**@brief Handle a user memory release event.
  187. *
  188. * @param[in] p_qwr QWR structure.
  189. * @param[in] p_common_evt User_mem_release event to be handled.
  190. */
  191. static void on_user_mem_release(nrf_ble_qwr_t * p_qwr,
  192. ble_common_evt_t const * p_common_evt)
  193. {
  194. #if (NRF_BLE_QWR_MAX_ATTR > 0)
  195. if ((p_common_evt->params.user_mem_release.type == BLE_USER_MEM_TYPE_GATTS_QUEUED_WRITES) &&
  196. (p_common_evt->conn_handle == p_qwr->conn_handle))
  197. {
  198. // Cancel the current operation.
  199. p_qwr->nb_written_handles = 0;
  200. }
  201. #endif
  202. }
  203. #if (NRF_BLE_QWR_MAX_ATTR > 0)
  204. /**@brief Handle a prepare write event.
  205. *
  206. * @param[in] p_qwr QWR structure.
  207. * @param[in] p_evt_write WRITE event to be handled.
  208. */
  209. static void on_prepare_write(nrf_ble_qwr_t * p_qwr,
  210. ble_gatts_evt_write_t const * p_evt_write)
  211. {
  212. uint32_t err_code;
  213. ble_gatts_rw_authorize_reply_params_t auth_reply;
  214. memset(&auth_reply, 0, sizeof(auth_reply));
  215. auth_reply.params.write.gatt_status = NRF_BLE_QWR_REJ_REQUEST_ERR_CODE;
  216. auth_reply.type = BLE_GATTS_AUTHORIZE_TYPE_WRITE;
  217. uint32_t i;
  218. for (i = 0; i < p_qwr->nb_written_handles; i++)
  219. {
  220. if (p_qwr->written_attr_handles[i] == p_evt_write->handle)
  221. {
  222. auth_reply.params.write.gatt_status = BLE_GATT_STATUS_SUCCESS;
  223. break;
  224. }
  225. }
  226. if (auth_reply.params.write.gatt_status != BLE_GATT_STATUS_SUCCESS)
  227. {
  228. for (i = 0; i < p_qwr->nb_registered_attr; i++)
  229. {
  230. if (p_qwr->attr_handles[i] == p_evt_write->handle)
  231. {
  232. auth_reply.params.write.gatt_status = BLE_GATT_STATUS_SUCCESS;
  233. p_qwr->written_attr_handles[p_qwr->nb_written_handles++] = p_evt_write->handle;
  234. break;
  235. }
  236. }
  237. }
  238. err_code = sd_ble_gatts_rw_authorize_reply(p_qwr->conn_handle, &auth_reply);
  239. if (err_code != NRF_SUCCESS)
  240. {
  241. // Cancel the current operation.
  242. p_qwr->nb_written_handles = 0;
  243. // Report error to application.
  244. p_qwr->error_handler(err_code);
  245. }
  246. }
  247. /**@brief Handle an execute write event.
  248. *
  249. * @param[in] p_qwr QWR structure.
  250. * @param[in] p_evt_write EXEC WRITE event to be handled.
  251. */
  252. static void on_execute_write(nrf_ble_qwr_t * p_qwr,
  253. ble_gatts_evt_write_t const * p_evt_write)
  254. {
  255. uint32_t err_code;
  256. ble_gatts_rw_authorize_reply_params_t auth_reply;
  257. memset(&auth_reply, 0, sizeof(auth_reply));
  258. auth_reply.params.write.gatt_status = BLE_GATT_STATUS_SUCCESS;
  259. auth_reply.type = BLE_GATTS_AUTHORIZE_TYPE_WRITE;
  260. if (p_qwr->nb_written_handles == 0)
  261. {
  262. auth_reply.params.write.gatt_status = NRF_BLE_QWR_REJ_REQUEST_ERR_CODE;
  263. err_code = sd_ble_gatts_rw_authorize_reply(p_qwr->conn_handle, &auth_reply);
  264. if (err_code != NRF_SUCCESS)
  265. {
  266. // Report error to application.
  267. p_qwr->error_handler(err_code);
  268. }
  269. return;
  270. }
  271. for (uint16_t i = 0; i < p_qwr->nb_written_handles; i++)
  272. {
  273. nrf_ble_qwr_evt_t evt;
  274. uint16_t ret_val;
  275. evt.evt_type = NRF_BLE_QWR_EVT_AUTH_REQUEST;
  276. evt.attr_handle = p_qwr->written_attr_handles[i];
  277. ret_val = p_qwr->callback(p_qwr, &evt);
  278. if (ret_val != BLE_GATT_STATUS_SUCCESS)
  279. {
  280. auth_reply.params.write.gatt_status = ret_val;
  281. }
  282. }
  283. err_code = sd_ble_gatts_rw_authorize_reply(p_qwr->conn_handle, &auth_reply);
  284. if (err_code != NRF_SUCCESS)
  285. {
  286. // Report error to application.
  287. p_qwr->error_handler(err_code);
  288. }
  289. // If the execute has not been rejected by any of the registered applications, propagate execute write event to all written handles. */
  290. if (auth_reply.params.write.gatt_status == BLE_GATT_STATUS_SUCCESS)
  291. {
  292. for (uint16_t i = 0; i < p_qwr->nb_written_handles; i++)
  293. {
  294. nrf_ble_qwr_evt_t evt;
  295. evt.evt_type = NRF_BLE_QWR_EVT_EXECUTE_WRITE;
  296. evt.attr_handle = p_qwr->written_attr_handles[i];
  297. /*lint -e534 -save "Ignoring return value of function" */
  298. p_qwr->callback(p_qwr, &evt);
  299. /*lint -restore*/
  300. auth_reply.params.write.gatt_status = BLE_GATT_STATUS_SUCCESS;
  301. }
  302. }
  303. p_qwr->nb_written_handles = 0;
  304. }
  305. /**@brief Handle a cancel write event.
  306. *
  307. * @param[in] p_qwr QWR structure.
  308. * @param[in] p_evt_write EXEC WRITE event to be handled.
  309. */
  310. static void on_cancel_write(nrf_ble_qwr_t * p_qwr,
  311. ble_gatts_evt_write_t const * p_evt_write)
  312. {
  313. uint32_t err_code;
  314. ble_gatts_rw_authorize_reply_params_t auth_reply;
  315. memset(&auth_reply, 0, sizeof(auth_reply));
  316. auth_reply.type = BLE_GATTS_AUTHORIZE_TYPE_WRITE;
  317. auth_reply.params.write.gatt_status = BLE_GATT_STATUS_SUCCESS;
  318. err_code = sd_ble_gatts_rw_authorize_reply(p_qwr->conn_handle, &auth_reply);
  319. if (err_code != NRF_SUCCESS)
  320. {
  321. // Report error to application.
  322. p_qwr->error_handler(err_code);
  323. }
  324. p_qwr->nb_written_handles = 0;
  325. }
  326. #endif
  327. /**@brief Handle a rw_authorize_request event.
  328. *
  329. * @param[in] p_qwr QWR structure.
  330. * @param[in] p_gatts_evt RW_authorize_request event to be handled.
  331. */
  332. static void on_rw_authorize_request(nrf_ble_qwr_t * p_qwr,
  333. ble_gatts_evt_t const * p_gatts_evt)
  334. {
  335. if (p_gatts_evt->conn_handle != p_qwr->conn_handle)
  336. {
  337. return;
  338. }
  339. ble_gatts_evt_rw_authorize_request_t const * p_auth_req = &p_gatts_evt->params.authorize_request;
  340. if (p_auth_req->type != BLE_GATTS_AUTHORIZE_TYPE_WRITE)
  341. {
  342. return;
  343. }
  344. #if (NRF_BLE_QWR_MAX_ATTR == 0)
  345. // Handle only queued write related operations.
  346. if ((p_auth_req->request.write.op != BLE_GATTS_OP_PREP_WRITE_REQ) &&
  347. (p_auth_req->request.write.op != BLE_GATTS_OP_EXEC_WRITE_REQ_NOW) &&
  348. (p_auth_req->request.write.op != BLE_GATTS_OP_EXEC_WRITE_REQ_CANCEL))
  349. {
  350. return;
  351. }
  352. // Prepare the response.
  353. ble_gatts_rw_authorize_reply_params_t auth_reply = {0};
  354. auth_reply.type = BLE_GATTS_AUTHORIZE_TYPE_WRITE;
  355. auth_reply.params.write.gatt_status = NRF_BLE_QWR_REJ_REQUEST_ERR_CODE;
  356. if (p_auth_req->request.write.op == BLE_GATTS_OP_EXEC_WRITE_REQ_CANCEL)
  357. {
  358. auth_reply.params.write.gatt_status = BLE_GATT_STATUS_SUCCESS;
  359. }
  360. ret_code_t err_code = sd_ble_gatts_rw_authorize_reply(p_gatts_evt->conn_handle, &auth_reply);
  361. if (err_code != NRF_SUCCESS)
  362. {
  363. // Report error to application.
  364. p_qwr->error_handler(err_code);
  365. }
  366. #else
  367. switch (p_auth_req->request.write.op)
  368. {
  369. case BLE_GATTS_OP_PREP_WRITE_REQ:
  370. on_prepare_write(p_qwr, &p_auth_req->request.write);
  371. break; // BLE_GATTS_OP_PREP_WRITE_REQ
  372. case BLE_GATTS_OP_EXEC_WRITE_REQ_NOW:
  373. on_execute_write(p_qwr, &p_auth_req->request.write);
  374. break; // BLE_GATTS_OP_EXEC_WRITE_REQ_NOW
  375. case BLE_GATTS_OP_EXEC_WRITE_REQ_CANCEL:
  376. on_cancel_write(p_qwr, &p_auth_req->request.write);
  377. break; // BLE_GATTS_OP_EXEC_WRITE_REQ_CANCEL
  378. default:
  379. // No implementation needed.
  380. break;
  381. }
  382. #endif
  383. }
  384. void nrf_ble_qwr_on_ble_evt(ble_evt_t const * p_ble_evt, void * p_context)
  385. {
  386. VERIFY_PARAM_NOT_NULL_VOID(p_context);
  387. VERIFY_PARAM_NOT_NULL_VOID(p_ble_evt);
  388. nrf_ble_qwr_t * p_qwr = (nrf_ble_qwr_t *)p_context;
  389. VERIFY_MODULE_INITIALIZED_VOID();
  390. if (p_ble_evt->evt.common_evt.conn_handle == p_qwr->conn_handle)
  391. {
  392. user_mem_reply(p_qwr);
  393. }
  394. switch (p_ble_evt->header.evt_id)
  395. {
  396. case BLE_EVT_USER_MEM_REQUEST:
  397. on_user_mem_request(p_qwr, &p_ble_evt->evt.common_evt);
  398. break; // BLE_EVT_USER_MEM_REQUEST
  399. case BLE_EVT_USER_MEM_RELEASE:
  400. on_user_mem_release(p_qwr, &p_ble_evt->evt.common_evt);
  401. break; // BLE_EVT_USER_MEM_REQUEST
  402. case BLE_GATTS_EVT_RW_AUTHORIZE_REQUEST:
  403. on_rw_authorize_request(p_qwr, &p_ble_evt->evt.gatts_evt);
  404. break; // BLE_GATTS_EVT_RW_AUTHORIZE_REQUEST
  405. case BLE_GAP_EVT_DISCONNECTED:
  406. if (p_ble_evt->evt.gap_evt.conn_handle == p_qwr->conn_handle)
  407. {
  408. p_qwr->conn_handle = BLE_CONN_HANDLE_INVALID;
  409. #if (NRF_BLE_QWR_MAX_ATTR > 0)
  410. p_qwr->nb_written_handles = 0;
  411. #endif
  412. }
  413. break; // BLE_GAP_EVT_DISCONNECTED
  414. default:
  415. break;
  416. }
  417. }
  418. #endif // NRF_MODULE_ENABLED(NRF_BLE_QWR)