ant_event.h 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  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_EVENT_H__
  41. #define __ANT_EVENT_H__
  42. #include "ble_serialization.h"
  43. #include "app_util.h"
  44. #include "nrf_sdh_ant.h"
  45. /**
  46. * @addtogroup ser_app_s212_codecs
  47. * @{
  48. */
  49. /**@brief Event decoding dispatcher.
  50. *
  51. * The event decoding dispatcher will route the event packet to the correct decoder, which in turn
  52. * decodes the contents of the event and updates the \p p_event struct.
  53. *
  54. * If \p p_event is null, the required length of \p p_event is returned in \p p_event_len.
  55. *
  56. * @param[in] p_buf Pointer to the beginning of the event packet.
  57. * @param[in] packet_len Length (in bytes) of the event packet.
  58. * @param[in,out] p_event Pointer to the \ref ant_evt_t buffer where the decoded event will be
  59. * stored. If NULL, the required length will be returned in \p p_event_len.
  60. * @param[in,out] p_event_len \c in: Size (in bytes) of \p p_event buffer.
  61. * \c out: Length of the decoded contents of \p p_event.
  62. *
  63. * @retval NRF_SUCCESS Decoding success.
  64. * @retval NRF_ERROR_NULL Decoding failure. NULL pointer supplied.
  65. * @retval NRF_ERROR_INVALID_LENGTH Decoding failure. Incorrect buffer length.
  66. * @retval NRF_ERROR_DATA_SIZE Decoding failure. Length of \p p_event is too small to
  67. * hold the decoded event.
  68. * @retval NRF_ERROR_NOT_FOUND Decoding failure. No event decoder is available.
  69. */
  70. uint32_t ant_event_dec(uint8_t const * const p_buf,
  71. uint32_t packet_len,
  72. ant_evt_t * const p_event,
  73. uint32_t * const p_event_len);
  74. /** @} */
  75. #endif