nrf_soc_app.h 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. /**
  2. * Copyright (c) 2013 - 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. /**@file
  41. *
  42. * @defgroup soc_app SOC Application command request encoders and command response decoders
  43. * @{
  44. * @ingroup ser_app_s130_codecs
  45. *
  46. * @brief SOC Application command request encoders and command response decoders.
  47. */
  48. #ifndef NRF_SOC_APP_H__
  49. #define NRF_SOC_APP_H__
  50. #include <stdint.h>
  51. #include "nrf_soc.h"
  52. #ifdef __cplusplus
  53. extern "C" {
  54. #endif
  55. /**@brief Encodes @ref sd_power_system_off command request.
  56. *
  57. *
  58. * @param[in] p_buf Pointer to buffer where encoded data command will be returned.
  59. * @param[in,out] p_buf_len \c in: size of p_buf buffer. \c out: Length of encoded command packet.
  60. *
  61. * @retval NRF_SUCCESS Encoding success.
  62. * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
  63. * @retval NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
  64. */
  65. uint32_t power_system_off_req_enc(uint8_t * const p_buf, uint32_t * const p_buf_len);
  66. /**@brief Encodes @ref sd_temp_get command request.
  67. *
  68. * @sa @ref temp_get_rsp_dec for command response decoder.
  69. *
  70. * @param[in] p_temp Pointer to result of temperature measurement.
  71. * @param[in] p_buf Pointer to buffer where encoded data command will be returned.
  72. * @param[in,out] p_buf_len \c in: size of p_buf buffer. \c out: Length of encoded command packet.
  73. *
  74. * @retval NRF_SUCCESS Encoding success.
  75. * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
  76. * @retval NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
  77. */
  78. uint32_t temp_get_req_enc(int32_t const * const p_temp,
  79. uint8_t * const p_buf,
  80. uint32_t * const p_buf_len);
  81. /**@brief Decodes response to @ref sd_temp_get command.
  82. *
  83. * @sa @ref temp_get_req_enc for command request encoder.
  84. *
  85. * @param[in] p_buf Pointer to beginning of command response packet.
  86. * @param[in] packet_len Length (in bytes) of response packet.
  87. * @param[out] p_result_code Command result code.
  88. * @param[out] pp_temp Pointer to result of temperature measurement.
  89. *
  90. * @retval NRF_SUCCESS Version information stored successfully.
  91. * @retval NRF_ERROR_INVALID_LENGTH Decoding failure. Incorrect buffer length.
  92. * @retval NRF_ERROR_DATA_SIZE Decoding failure. Length of \p p_event is too small to
  93. * hold decoded event.
  94. */
  95. uint32_t temp_get_rsp_dec(uint8_t const * const p_buf,
  96. uint32_t packet_len,
  97. uint32_t * const p_result_code,
  98. int32_t * * const pp_temp);
  99. /**@brief Encodes @ref sd_ecb_block_encrypt command request.
  100. *
  101. * @sa @ref ecb_block_encrypt_rsp_dec for command response decoder.
  102. *
  103. * @param[in] p_ecb_data Pointer to ECB data.
  104. * @param[in] p_buf Pointer to buffer where encoded data command will be returned.
  105. * @param[in,out] p_buf_len \c in: size of p_buf buffer. \c out: Length of encoded command packet.
  106. *
  107. * @retval NRF_SUCCESS Encoding success.
  108. * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
  109. * @retval NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
  110. */
  111. uint32_t ecb_block_encrypt_req_enc(nrf_ecb_hal_data_t * p_ecb_data,
  112. uint8_t * const p_buf,
  113. uint32_t * const p_buf_len);
  114. /**@brief Decodes response to @ref sd_ecb_block_encrypt command.
  115. *
  116. * @sa @ref ecb_block_encrypt_req_enc for command request encoder.
  117. *
  118. * @param[in] p_buf Pointer to beginning of command response packet.
  119. * @param[in] packet_len Length (in bytes) of response packet.
  120. * @param[out] p_ecb_data Pointer to ECB data.
  121. * @param[out] p_result_code Command result code.
  122. *
  123. * @retval NRF_SUCCESS Version information stored successfully.
  124. * @retval NRF_ERROR_INVALID_LENGTH Decoding failure. Incorrect buffer length.
  125. * @retval NRF_ERROR_DATA_SIZE Decoding failure. Length of \p p_event is too small to
  126. * hold decoded event.
  127. */
  128. uint32_t ecb_block_encrypt_rsp_dec(uint8_t const * const p_buf,
  129. uint32_t packet_len,
  130. nrf_ecb_hal_data_t * * const p_ecb_data,
  131. uint32_t * const p_result_code);
  132. /** @} */
  133. #ifdef __cplusplus
  134. }
  135. #endif
  136. #endif // NRF_SOC_APP_H__