conn_mw.h 3.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  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 _CONN_MW_H
  41. #define _CONN_MW_H
  42. /**
  43. * @addtogroup sercon_mw_s132 Connectivity middleware codecs for S132 and S140 (connectivity side)
  44. * @{
  45. * @ingroup ser_codecs_mw
  46. */
  47. #include <stdint.h>
  48. #ifdef __cplusplus
  49. extern "C" {
  50. #endif
  51. /**@brief Connectivity Middleware dispatcher function
  52. *
  53. * @details It handles decoding of the opcode from the RX buffer and based on the opcode, it searches
  54. * for registered handler. Handler is called once it is found.
  55. *
  56. * @param[in] p_rx_buf Pointer to input buffer.
  57. * @param[in] rx_buf_len Size of @p p_rx_buf.
  58. * @param[out] p_tx_buf Pointer to output buffer.
  59. * @param[in,out] p_tx_buf_len \c in: size of \p p_tx_buf buffer.
  60. * \c out: Length of valid data in \p p_tx_buf.
  61. *
  62. * @retval NRF_SUCCESS Handler success.
  63. * @retval NRF_ERROR_NULL Handler failure. NULL pointer supplied.
  64. * @retval NRF_ERROR_INVALID_LENGTH Handler failure. Incorrect buffer length.
  65. * @retval NRF_ERROR_INVALID_PARAM Handler failure. Invalid operation type.
  66. * @retval NRF_ERROR_NOT_SUPPORTED Handler failure. Opcode not supported.
  67. */
  68. uint32_t conn_mw_handler (uint8_t const * const p_rx_buf,
  69. uint32_t rx_buf_len,
  70. uint8_t * const p_tx_buf,
  71. uint32_t * const p_tx_buf_len);
  72. #ifdef __cplusplus
  73. }
  74. #endif
  75. /** @} */
  76. #endif //_CONN_MW_H