ant_struct_serialization.h 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
  1. /**
  2. * Copyright (c) 2017 - 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 _ANT_STRUCT_SERIALIZATION_
  41. #define _ANT_STRUCT_SERIALIZATION_
  42. /**@brief Function for safe encoding of an ANT_ENABLE struct.
  43. *
  44. * Safe decoding of an ANT_ENABLE struct. Range checks will be done if @ref SER_ASSERTS_ENABLED is set.
  45. *
  46. * @param[in] p_void_enable_params An ANT_ENABLE struct to be encoded.
  47. * @param[out] p_buf Buffer containing the struct.
  48. * @param[in] buf_len Size of the buffer.
  49. * @param[in,out] p_index \c in: Index to the start of the ANT_ENABLE struct in the buffer.
  50. * \c out: Index in the buffer to the first byte after the decoded struct.
  51. *
  52. * @return NRF_SUCCESS Fields decoded successfully.
  53. * @retval NRF_ERROR_INVALID_LENGTH Decoding failure. Incorrect buffer length.
  54. */
  55. uint32_t ANT_ENABLE_enc( void const * const p_void_enable_params,
  56. uint8_t * const p_buf,
  57. uint32_t buf_len,
  58. uint32_t * const p_index);
  59. /**@brief Function for safe decoding of an ANT_ENABLE struct.
  60. *
  61. * Safe decoding of a ANT_ENABLE struct. Range checks will be done if @ref SER_ASSERTS_ENABLED is set.
  62. *
  63. * @param[in] p_buf Buffer containing the struct.
  64. * @param[in] buf_len Size of the buffer.
  65. * @param[in,out] p_index \c in: Index to the start of the ANT_ENABLE struct in the buffer.
  66. * \c out: Index in the buffer to the first byte after the decoded struct.
  67. * @param[out] p_void_enable_params Decoded ANT_ENABLE struct.
  68. */
  69. uint32_t ANT_ENABLE_dec( uint8_t const * const p_buf,
  70. uint32_t buf_len,
  71. uint32_t * const p_index,
  72. void * const p_void_enable_params);
  73. /**@brief Function for safe encoding of an ant_evt_t struct.
  74. *
  75. * Safe decoding of an ant_evt_t struct. Range checks will be done if @ref SER_ASSERTS_ENABLED is set.
  76. *
  77. * @param[in] p_void_ant_evt An ant_evt_t struct to be encoded.
  78. * @param[out] p_buf Buffer containing the struct.
  79. * @param[in] buf_len Size of the buffer.
  80. * @param[in,out] p_index \c in: Index to the start of the ant_evt_t struct in the buffer.
  81. * \c out: Index in the buffer to the first byte after the decoded struct.
  82. *
  83. * @return NRF_SUCCESS Fields decoded successfully.
  84. * @retval NRF_ERROR_INVALID_LENGTH Decoding failure. Incorrect buffer length.
  85. */
  86. uint32_t ant_evt_t_enc( void const * const p_void_ant_evt,
  87. uint8_t * const p_buf,
  88. uint32_t buf_len,
  89. uint32_t * const p_index);
  90. /**@brief Function for safe decoding of an ant_evt_t struct.
  91. *
  92. * Safe decoding of a ant_evt_t struct. Range checks will be done if @ref SER_ASSERTS_ENABLED is set.
  93. *
  94. * @param[in] p_buf Buffer containing the struct.
  95. * @param[in] buf_len Size of the buffer.
  96. * @param[in,out] p_index \c in: Index to the start of the ant_evt_t struct in the buffer.
  97. * \c out: Index in the buffer to the first byte after the decoded struct.
  98. * @param[out] p_void_ant_evt Decoded ant_evt_t struct.
  99. */
  100. uint32_t ant_evt_t_dec( uint8_t const * const p_buf,
  101. uint32_t buf_len,
  102. uint32_t * const p_index,
  103. void * const p_void_ant_evt);
  104. #endif