1 /* 2 * Copyright (c) 2020 - 2023, Nordic Semiconductor ASA 3 * All rights reserved. 4 * 5 * SPDX-License-Identifier: BSD-3-Clause 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions are met: 9 * 10 * 1. Redistributions of source code must retain the above copyright notice, this 11 * list of conditions and the following disclaimer. 12 * 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its 18 * contributors may be used to endorse or promote products derived from this 19 * software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 25 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 31 * POSSIBILITY OF SUCH DAMAGE. 32 * 33 */ 34 35 /** 36 * @defgroup nrf_802154_spinel_serialization 37 * 802.15.4 radio driver spinel serialization 38 * @{ 39 * 40 */ 41 42 #ifndef NRF_802154_SPINEL_H_ 43 #define NRF_802154_SPINEL_H_ 44 45 #include "nrf_802154_serialization_error.h" 46 #include "nrf_802154_buffer_mgr_dst.h" 47 #include "nrf_802154_buffer_mgr_src.h" 48 49 #ifdef __cplusplus 50 extern "C" { 51 #endif 52 53 #ifndef CONFIG_NRF_802154_SER_DEFAULT_RESPONSE_TIMEOUT 54 /** 55 * @brief Default response timeout in us for response to serialized request. 56 */ 57 #define CONFIG_NRF_802154_SER_DEFAULT_RESPONSE_TIMEOUT 500 58 #endif /* CONFIG_NRF_802154_SER_DEFAULT_RESPONSE_TIMEOUT */ 59 60 /** 61 * @brief Maximal size of a Spinel frame in 802.15.4 serialization. 62 */ 63 #define NRF_802154_SPINEL_FRAME_MAX_SIZE 296 64 65 /** 66 * @brief Buffer size for Spinel frame in 802.15.4 serialization. 67 * 68 * This macro can used as a replacement for @ref SPINEL_FRAME_BUFFER_SIZE in 802.15.4 serialization 69 * to reduce memory required for Spinel frame processing. 70 */ 71 #define NRF_802154_SPINEL_FRAME_BUFFER_SIZE (NRF_802154_SPINEL_FRAME_MAX_SIZE + \ 72 SPINEL_ENCRYPTER_EXTRA_DATA_SIZE) 73 74 /** 75 * @brief Serializes data according to format string and sends it over spinel backend. 76 * 77 * @param[in] p_fmt Pointer to a format string describing data types to be serialized. 78 * Format string should conform to spinel specification. 79 * @param[in] ... Data to be serialized and sent according to @ref p_fmt format string. 80 * 81 * @returns number of bytes sent or negative error value on failure. 82 * 83 */ 84 nrf_802154_ser_err_t nrf_802154_spinel_send(const char * p_fmt, ...); 85 86 /** 87 * @brief Gets buffer manager for transactions originated by the remote serialization peer. 88 * 89 * @returns Pointer to the destination frame buffer manager. 90 */ 91 nrf_802154_buffer_mgr_dst_t * nrf_802154_spinel_dst_buffer_mgr_get(void); 92 93 /** 94 * @brief Gets buffer manager for transactions originated by the local serialization peer. 95 * 96 * @returns Pointer to the source frame buffer manager. 97 */ 98 nrf_802154_buffer_mgr_src_t * nrf_802154_spinel_src_buffer_mgr_get(void); 99 100 #ifdef __cplusplus 101 } 102 #endif 103 104 #endif /* NRF_802154_SPINEL_H_ */ 105 106 /** @} */ 107
