1 /*
2  * Copyright (c) 2020, 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_decoder
37  * 802.15.4 radio driver spinel serialization decoder
38  * @{
39  *
40  */
41 
42 #ifndef NRF_802154_SPINEL_DEC_H_
43 #define NRF_802154_SPINEL_DEC_H_
44 
45 #include <stddef.h>
46 
47 #include "nrf_802154_serialization_error.h"
48 
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52 
53 /**
54  * @brief Decode and dispatch spinel command.
55  *
56  * @param[in]  p_packet_data    Pointer to a buffer that contains spinel packet to be decoded.
57  * @param[in]  packet_data_len  Size of the @ref p_packet_data buffer.
58  *
59  * @returns zero on success or negative error value on failure.
60  *
61  */
62 nrf_802154_ser_err_t nrf_802154_spinel_decode_cmd(const void * p_packet_data,
63                                                   size_t       packet_data_len);
64 
65 /**
66  * @brief Dispatches spinel command.
67  *
68  * @note Implementation of this function differs for an application core and
69  * for network core.
70  *
71  * @param[in]  cmd       Spinel command received
72  * @param[in]  p_data    Pointer to a buffer that contains data to be decoded.
73  * @param[in]  data_len  Size of the @ref p_data buffer.
74  *
75  * @returns zero on success or negative error value on failure.
76  */
77 extern nrf_802154_ser_err_t nrf_802154_spinel_dispatch_cmd(spinel_command_t cmd,
78                                                            const void     * p_cmd_data,
79                                                            size_t           cmd_data_len);
80 
81 #ifdef __cplusplus
82 }
83 #endif
84 
85 #endif /* NRF_802154_SPINEL_DEC_H_ */
86 
87 /** @} */
88