1 /*
2  *  Copyright (c) 2020, The OpenThread Authors.
3  *  All rights reserved.
4  *
5  *  Redistribution and use in source and binary forms, with or without
6  *  modification, are permitted provided that the following conditions are met:
7  *  1. Redistributions of source code must retain the above copyright
8  *     notice, this list of conditions and the following disclaimer.
9  *  2. Redistributions in binary form must reproduce the above copyright
10  *     notice, this list of conditions and the following disclaimer in the
11  *     documentation and/or other materials provided with the distribution.
12  *  3. Neither the name of the copyright holder nor the
13  *     names of its contributors may be used to endorse or promote products
14  *     derived from this software without specific prior written permission.
15  *
16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  *  POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /**
30  * @file
31  * @brief
32  *  This file defines the OpenThread Multi Radio Link APIs.
33  */
34 
35 #ifndef OPENTHREAD_MULTI_RADIO_H_
36 #define OPENTHREAD_MULTI_RADIO_H_
37 
38 #include <openthread/platform/radio.h>
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 /**
45  * @addtogroup api-multi-radio
46  *
47  * @brief
48  *   This module includes definitions and functions for multi radio link.
49  *
50  * @{
51  *
52  */
53 
54 /**
55  * This type represents information associated with a radio link.
56  *
57  */
58 typedef struct otRadioLinkInfo
59 {
60     uint8_t mPreference; ///< Preference level of radio link
61 } otRadioLinkInfo;
62 
63 /**
64  * This type represents multi radio link information associated with a neighbor.
65  *
66  */
67 typedef struct otMultiRadioNeighborInfo
68 {
69     bool            mSupportsIeee802154 : 1; ///< Neighbor supports IEEE 802.15.4 radio link
70     bool            mSupportsTrelUdp6 : 1;   ///< Neighbor supports Thread Radio Encapsulation Link (TREL) radio link.
71     otRadioLinkInfo mIeee802154Info;         ///< Additional info for 15.4 radio link (applicable when supported).
72     otRadioLinkInfo mTrelUdp6Info;           ///< Additional info for TREL radio link (applicable when supported).
73 } otMultiRadioNeighborInfo;
74 
75 /**
76  * This function gets the multi radio link information associated with a neighbor with a given Extended Address.
77  *
78  * This function requires the multi radio link feature to be enabled (please see `config/radio_link.h`).
79  *
80  * @param[in]  aInstance      A pointer to an OpenThread instance.
81  * @param[in]  aExtAddress    The Extended Address of neighbor.
82  * @param[out] aNeighborInfo  A pointer to `otMultiRadioNeighborInfo` to output the neighbor info (on success).
83  *
84  * @retval OT_ERROR_NONE        Neighbor was found and @p aNeighborInfo was updated successfully.
85  * @retval OT_ERROR_NOT_FOUND   Could not find a neighbor with @p aExtAddress.
86  *
87  */
88 otError otMultiRadioGetNeighborInfo(otInstance *              aInstance,
89                                     const otExtAddress *      aExtAddress,
90                                     otMultiRadioNeighborInfo *aNeighborInfo);
91 
92 /**
93  * @}
94  *
95  */
96 
97 #ifdef __cplusplus
98 } // extern "C"
99 #endif
100 
101 #endif // OPENTHREAD_MULTI_RADIO_H_
102