app_ble_user_mem.h 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  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 _APP_BLE_USER_MEM_H
  41. #define _APP_BLE_USER_MEM_H
  42. /**@file
  43. *
  44. * @defgroup app_ble_user_mem Functions for managing memory for user memory request in the application device.
  45. * @{
  46. * @ingroup ser_app_s130_codecs
  47. *
  48. * @brief Application auxiliary functions for synchronizing user memory with the one stored in the connectivity device.
  49. */
  50. #include "ble.h"
  51. #include "ser_config.h"
  52. #include <stdint.h>
  53. #ifdef __cplusplus
  54. extern "C" {
  55. #endif
  56. /**@brief Connection - user memory mapping structure.
  57. *
  58. * @note This structure is used to map user memory to connection instances and store it in a static table.
  59. */
  60. //lint -esym(452,ser_ble_user_mem_t)
  61. typedef struct
  62. {
  63. uint16_t conn_handle; /**< Connection handle. */
  64. uint8_t conn_active; /**< Indication that user memory for this connection is used by the SoftDevice. 0: memory used; 1: memory not used. */
  65. ble_user_mem_block_t mem_block; /**< User memory block structure, see @ref ble_user_mem_block_t. */
  66. } ser_ble_user_mem_t;
  67. /**@brief Allocates instance in m_user_mem_table[] for storage.
  68. *
  69. * @param[in] conn_handle conn_handle
  70. * @param[out] p_index Pointer to the index of the allocated instance.
  71. *
  72. * @retval NRF_SUCCESS Context allocated.
  73. * @retval NRF_ERROR_NO_MEM No free instance available.
  74. */
  75. uint32_t app_ble_user_mem_context_create(uint16_t conn_handle, uint32_t *p_index);
  76. /**@brief Release instance identified by a connection handle.
  77. *
  78. * @param[in] conn_handle conn_handle
  79. *
  80. * @retval NRF_SUCCESS Context released.
  81. * @retval NRF_ERROR_NOT_FOUND Instance with conn_handle not found.
  82. */
  83. uint32_t app_ble_user_mem_context_destroy(uint16_t conn_handle);
  84. /**@brief Finds index of the instance identified by a connection handle in m_user_mem_table[].
  85. *
  86. * @param[in] conn_handle conn_handle
  87. *
  88. * @param[out] p_index Pointer to the index of the entry in the context table corresponding to the given conn_handle.
  89. *
  90. * @retval NRF_SUCCESS Context found.
  91. * @retval NRF_ERROR_NOT_FOUND Instance with conn_handle not found.
  92. */
  93. uint32_t app_ble_user_mem_context_find(uint16_t conn_handle, uint32_t *p_index);
  94. /** @} */
  95. #ifdef __cplusplus
  96. }
  97. #endif
  98. #endif //_APP_BLE_USER_MEM_H