Jinu Andrews / nRF51

lib/codecs/inc/nrf_soc_app.h@0:6ba9b94b8997, 2017-02-09 (annotated)

Committer:
jinu
Date:
Thu Feb 09 06:08:17 2017 +0000
Revision:
0:6ba9b94b8997
NRF51 serialization libraries for mDot

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jinu 0:6ba9b94b8997 1 /* Copyright (c) Nordic Semiconductor ASA
jinu 0:6ba9b94b8997 2 * All rights reserved.
jinu 0:6ba9b94b8997 3 *
jinu 0:6ba9b94b8997 4 * Redistribution and use in source and binary forms, with or without modification,
jinu 0:6ba9b94b8997 5 * are permitted provided that the following conditions are met:
jinu 0:6ba9b94b8997 6 *
jinu 0:6ba9b94b8997 7 * 1. Redistributions of source code must retain the above copyright notice, this
jinu 0:6ba9b94b8997 8 * list of conditions and the following disclaimer.
jinu 0:6ba9b94b8997 9 *
jinu 0:6ba9b94b8997 10 * 2. Redistributions in binary form must reproduce the above copyright notice, this
jinu 0:6ba9b94b8997 11 * list of conditions and the following disclaimer in the documentation and/or
jinu 0:6ba9b94b8997 12 * other materials provided with the distribution.
jinu 0:6ba9b94b8997 13 *
jinu 0:6ba9b94b8997 14 * 3. Neither the name of Nordic Semiconductor ASA nor the names of other
jinu 0:6ba9b94b8997 15 * contributors to this software may be used to endorse or promote products
jinu 0:6ba9b94b8997 16 * derived from this software without specific prior written permission.
jinu 0:6ba9b94b8997 17 *
jinu 0:6ba9b94b8997 18 * 4. This software must only be used in a processor manufactured by Nordic
jinu 0:6ba9b94b8997 19 * Semiconductor ASA, or in a processor manufactured by a third party that
jinu 0:6ba9b94b8997 20 * is used in combination with a processor manufactured by Nordic Semiconductor.
jinu 0:6ba9b94b8997 21 *
jinu 0:6ba9b94b8997 22 *
jinu 0:6ba9b94b8997 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
jinu 0:6ba9b94b8997 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
jinu 0:6ba9b94b8997 25 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
jinu 0:6ba9b94b8997 26 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
jinu 0:6ba9b94b8997 27 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
jinu 0:6ba9b94b8997 28 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
jinu 0:6ba9b94b8997 29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
jinu 0:6ba9b94b8997 30 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
jinu 0:6ba9b94b8997 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
jinu 0:6ba9b94b8997 32 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
jinu 0:6ba9b94b8997 33 */
jinu 0:6ba9b94b8997 34
jinu 0:6ba9b94b8997 35 /**@file
jinu 0:6ba9b94b8997 36 *
jinu 0:6ba9b94b8997 37 * @defgroup soc_app SOC Application command request encoders and command response decoders
jinu 0:6ba9b94b8997 38 * @{
jinu 0:6ba9b94b8997 39 * @ingroup ble_sdk_lib_serialization
jinu 0:6ba9b94b8997 40 *
jinu 0:6ba9b94b8997 41 * @brief SOC Application command request encoders and command response decoders.
jinu 0:6ba9b94b8997 42 */
jinu 0:6ba9b94b8997 43
jinu 0:6ba9b94b8997 44 #ifndef NRF_SOC_APP_H__
jinu 0:6ba9b94b8997 45 #define NRF_SOC_APP_H__
jinu 0:6ba9b94b8997 46
jinu 0:6ba9b94b8997 47 #include <stdint.h>
jinu 0:6ba9b94b8997 48
jinu 0:6ba9b94b8997 49 /**@brief Encodes @ref sd_power_system_off command request.
jinu 0:6ba9b94b8997 50 *
jinu 0:6ba9b94b8997 51 * @sa @ref nrf51_sd_power_off for packet format.
jinu 0:6ba9b94b8997 52 *
jinu 0:6ba9b94b8997 53 * @param[in] p_buf Pointer to buffer where encoded data command will be returned.
jinu 0:6ba9b94b8997 54 * @param[in,out] p_buf_len \c in: size of p_buf buffer. \c out: Length of encoded command packet.
jinu 0:6ba9b94b8997 55 *
jinu 0:6ba9b94b8997 56 * @retval NRF_SUCCESS Encoding success.
jinu 0:6ba9b94b8997 57 * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
jinu 0:6ba9b94b8997 58 * @retval NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
jinu 0:6ba9b94b8997 59 */
jinu 0:6ba9b94b8997 60 uint32_t power_system_off_req_enc(uint8_t * const p_buf, uint32_t * const p_buf_len);
jinu 0:6ba9b94b8997 61
jinu 0:6ba9b94b8997 62
jinu 0:6ba9b94b8997 63 /**@brief Encodes @ref sd_temp_get command request.
jinu 0:6ba9b94b8997 64 *
jinu 0:6ba9b94b8997 65 * @sa @ref nrf51_sd_temp_get for packet format.
jinu 0:6ba9b94b8997 66 @ref temp_get_rsp_dec for command response decoder.
jinu 0:6ba9b94b8997 67 *
jinu 0:6ba9b94b8997 68 * @param[in] p_temp Pointer to result of temperature measurement.
jinu 0:6ba9b94b8997 69 * @param[in] p_buf Pointer to buffer where encoded data command will be returned.
jinu 0:6ba9b94b8997 70 * @param[in,out] p_buf_len \c in: size of p_buf buffer. \c out: Length of encoded command packet.
jinu 0:6ba9b94b8997 71 *
jinu 0:6ba9b94b8997 72 * @retval NRF_SUCCESS Encoding success.
jinu 0:6ba9b94b8997 73 * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
jinu 0:6ba9b94b8997 74 * @retval NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
jinu 0:6ba9b94b8997 75 */
jinu 0:6ba9b94b8997 76 uint32_t temp_get_req_enc(int32_t const * const p_temp,
jinu 0:6ba9b94b8997 77 uint8_t * const p_buf,
jinu 0:6ba9b94b8997 78 uint32_t * const p_buf_len);
jinu 0:6ba9b94b8997 79
jinu 0:6ba9b94b8997 80 /**@brief Decodes response to @ref sd_temp_get command.
jinu 0:6ba9b94b8997 81 *
jinu 0:6ba9b94b8997 82 * @sa @ref nrf51_temp_get_encoding for packet format,
jinu 0:6ba9b94b8997 83 * @ref temp_get_req_enc for command request encoder.
jinu 0:6ba9b94b8997 84 *
jinu 0:6ba9b94b8997 85 * @param[in] p_buf Pointer to beginning of command response packet.
jinu 0:6ba9b94b8997 86 * @param[in] packet_len Length (in bytes) of response packet.
jinu 0:6ba9b94b8997 87 * @param[out] p_result_code Command result code.
jinu 0:6ba9b94b8997 88 * @param[out] p_temp Pointer to result of temperature measurement.
jinu 0:6ba9b94b8997 89 *
jinu 0:6ba9b94b8997 90 * @return NRF_SUCCESS Version information stored successfully.
jinu 0:6ba9b94b8997 91 * @retval NRF_ERROR_INVALID_LENGTH Decoding failure. Incorrect buffer length.
jinu 0:6ba9b94b8997 92 * @retval NRF_ERROR_DATA_SIZE Decoding failure. Length of \p p_event is too small to
jinu 0:6ba9b94b8997 93 * hold decoded event.
jinu 0:6ba9b94b8997 94 */
jinu 0:6ba9b94b8997 95 uint32_t temp_get_rsp_dec(uint8_t const * const p_buf,
jinu 0:6ba9b94b8997 96 uint32_t packet_len,
jinu 0:6ba9b94b8997 97 uint32_t * const p_result_code,
jinu 0:6ba9b94b8997 98 int32_t * const p_temp);
jinu 0:6ba9b94b8997 99
jinu 0:6ba9b94b8997 100 /** @} */
jinu 0:6ba9b94b8997 101
jinu 0:6ba9b94b8997 102 #endif // NRF_SOC_APP_H__
jinu 0:6ba9b94b8997 103