nrf_soc_conn.h 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  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 NRF_SOC_CONN_H__
  41. #define NRF_SOC_CONN_H__
  42. /**@file
  43. *
  44. * @defgroup soc_conn SOC Connectivity command request decoders and command response encoders
  45. * @{
  46. * @ingroup ser_conn_s130_codecs
  47. *
  48. * @brief SOC Connectivity command request decoders and command response encoders.
  49. */
  50. #include "nrf_soc.h"
  51. #ifdef __cplusplus
  52. extern "C" {
  53. #endif
  54. /**@brief Decodes @ref sd_power_system_off command request.
  55. *
  56. * @param[in] p_buf Pointer to buffer where encoded data command will be returned.
  57. * @param[in] packet_len Length (in bytes) of request packet.
  58. *
  59. * @retval NRF_SUCCESS Encoding success.
  60. * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
  61. * @retval NRF_ERROR_INVALID_PARAM Encoding failure. Incorrect parameter.
  62. */
  63. uint32_t power_system_off_req_dec(uint8_t const * const p_buf, uint16_t packet_len);
  64. /**@brief Decodes @ref sd_temp_get command request.
  65. *
  66. * @sa @ref temp_get_rsp_enc for response encoding.
  67. *
  68. * @param[in] p_buf Pointer to buffer where encoded data command will be returned.
  69. * @param[in] packet_len Length (in bytes) of request packet.
  70. * @param[out] pp_temp Pointer to pointer to result of temperature measurement.
  71. *
  72. * @retval NRF_SUCCESS Encoding success.
  73. * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
  74. * @retval NRF_ERROR_INVALID_PARAM Encoding failure. Incorrect parameter.
  75. */
  76. uint32_t temp_get_req_dec(uint8_t const * const p_buf,
  77. uint32_t packet_len,
  78. int32_t * * const pp_temp);
  79. /**@brief Encodes @ref sd_temp_get command response.
  80. *
  81. * @sa @ref temp_get_req_dec for request decoding.
  82. *
  83. * @param[in] return_code Return code indicating if command was successful or not.
  84. * @param[out] p_buf Pointer to buffer where encoded data command response will be
  85. * returned.
  86. * @param[in,out] p_buf_len \c in: size of \p p_buf buffer.
  87. * \c out: Length of encoded command response packet.
  88. * @param[in] p_temp Pointer to result of temperature measurement.
  89. *
  90. * @retval NRF_SUCCESS Encoding success.
  91. * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
  92. * @retval NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
  93. */
  94. uint32_t temp_get_rsp_enc(uint32_t return_code,
  95. uint8_t * const p_buf,
  96. uint32_t * const p_buf_len,
  97. int32_t * const p_temp);
  98. /**@brief Decodes @ref sd_ecb_block_encrypt command request.
  99. *
  100. * @sa @ref ecb_block_encrypt_rsp_enc for response encoding.
  101. *
  102. * @param[in] p_buf Pointer to buffer where encoded data command will be returned.
  103. * @param[in] packet_len Length (in bytes) of request packet.
  104. * @param[out] pp_ecb_data Pointer to pointer to ECB data.
  105. *
  106. * @retval NRF_SUCCESS Encoding success.
  107. * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied
  108. * @retval NRF_ERROR_INVALID_PARAM Encoding failure. Incorrect parameter.
  109. */
  110. uint32_t ecb_block_encrypt_req_dec(uint8_t const * const p_buf,
  111. uint32_t packet_len,
  112. nrf_ecb_hal_data_t * * const pp_ecb_data);
  113. /**@brief Encodes @ref sd_ecb_block_encrypt command response.
  114. *
  115. * @sa @ref ecb_block_encrypt_req_dec for request decoding.
  116. *
  117. * @param[in] return_code Return code indicating if command was successful or not.
  118. * @param[out] p_buf Pointer to buffer where encoded data command response will be
  119. * returned.
  120. * @param[in,out] p_buf_len \c in: size of \p p_buf buffer.
  121. * \c out: Length of encoded command response packet.
  122. * @param[in] p_ecb_data Pointer to ECB data.
  123. *
  124. * @retval NRF_SUCCESS Encoding success.
  125. * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
  126. * @retval NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
  127. */
  128. uint32_t ecb_block_encrypt_rsp_enc(uint32_t return_code,
  129. uint8_t * const p_buf,
  130. uint32_t * const p_buf_len,
  131. nrf_ecb_hal_data_t * const p_ecb_data);
  132. /** @} */
  133. #ifdef __cplusplus
  134. }
  135. #endif
  136. #endif