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 * This file implements the OpenThread Link Metrics API.
32 */
33
34 #include "openthread-core-config.h"
35
36 #if OPENTHREAD_CONFIG_MLE_LINK_METRICS_INITIATOR_ENABLE || OPENTHREAD_CONFIG_MLE_LINK_METRICS_SUBJECT_ENABLE
37
38 #include <openthread/link_metrics.h>
39
40 #include "common/as_core_type.hpp"
41 #include "common/locator_getters.hpp"
42
43 using namespace ot;
44
otLinkMetricsQuery(otInstance * aInstance,const otIp6Address * aDestination,uint8_t aSeriesId,const otLinkMetrics * aLinkMetricsFlags,otLinkMetricsReportCallback aCallback,void * aCallbackContext)45 otError otLinkMetricsQuery(otInstance * aInstance,
46 const otIp6Address * aDestination,
47 uint8_t aSeriesId,
48 const otLinkMetrics * aLinkMetricsFlags,
49 otLinkMetricsReportCallback aCallback,
50 void * aCallbackContext)
51 {
52 OT_ASSERT(aDestination != nullptr);
53
54 AsCoreType(aInstance).Get<LinkMetrics::LinkMetrics>().SetReportCallback(aCallback, aCallbackContext);
55
56 return AsCoreType(aInstance).Get<LinkMetrics::LinkMetrics>().Query(AsCoreType(aDestination), aSeriesId,
57 AsCoreTypePtr(aLinkMetricsFlags));
58 }
59
otLinkMetricsConfigForwardTrackingSeries(otInstance * aInstance,const otIp6Address * aDestination,uint8_t aSeriesId,const otLinkMetricsSeriesFlags aSeriesFlags,const otLinkMetrics * aLinkMetricsFlags,otLinkMetricsMgmtResponseCallback aCallback,void * aCallbackContext)60 otError otLinkMetricsConfigForwardTrackingSeries(otInstance * aInstance,
61 const otIp6Address * aDestination,
62 uint8_t aSeriesId,
63 const otLinkMetricsSeriesFlags aSeriesFlags,
64 const otLinkMetrics * aLinkMetricsFlags,
65 otLinkMetricsMgmtResponseCallback aCallback,
66 void * aCallbackContext)
67 {
68 OT_ASSERT(aDestination != nullptr);
69
70 LinkMetrics::LinkMetrics &linkMetrics = AsCoreType(aInstance).Get<LinkMetrics::LinkMetrics>();
71
72 linkMetrics.SetMgmtResponseCallback(aCallback, aCallbackContext);
73
74 return linkMetrics.SendMgmtRequestForwardTrackingSeries(AsCoreType(aDestination), aSeriesId, aSeriesFlags,
75 AsCoreTypePtr(aLinkMetricsFlags));
76 }
77
78 #if OPENTHREAD_CONFIG_MLE_LINK_METRICS_INITIATOR_ENABLE
otLinkMetricsConfigEnhAckProbing(otInstance * aInstance,const otIp6Address * aDestination,otLinkMetricsEnhAckFlags aEnhAckFlags,const otLinkMetrics * aLinkMetricsFlags,otLinkMetricsMgmtResponseCallback aCallback,void * aCallbackContext,otLinkMetricsEnhAckProbingIeReportCallback aEnhAckCallback,void * aEnhAckCallbackContext)79 otError otLinkMetricsConfigEnhAckProbing(otInstance * aInstance,
80 const otIp6Address * aDestination,
81 otLinkMetricsEnhAckFlags aEnhAckFlags,
82 const otLinkMetrics * aLinkMetricsFlags,
83 otLinkMetricsMgmtResponseCallback aCallback,
84 void * aCallbackContext,
85 otLinkMetricsEnhAckProbingIeReportCallback aEnhAckCallback,
86 void * aEnhAckCallbackContext)
87 {
88 OT_ASSERT(aDestination != nullptr);
89
90 LinkMetrics::LinkMetrics &linkMetrics = AsCoreType(aInstance).Get<LinkMetrics::LinkMetrics>();
91
92 linkMetrics.SetMgmtResponseCallback(aCallback, aCallbackContext);
93 linkMetrics.SetEnhAckProbingCallback(aEnhAckCallback, aEnhAckCallbackContext);
94
95 return linkMetrics.SendMgmtRequestEnhAckProbing(AsCoreType(aDestination), MapEnum(aEnhAckFlags),
96 AsCoreTypePtr(aLinkMetricsFlags));
97 }
98
otLinkMetricsSendLinkProbe(otInstance * aInstance,const otIp6Address * aDestination,uint8_t aSeriesId,uint8_t aLength)99 otError otLinkMetricsSendLinkProbe(otInstance * aInstance,
100 const otIp6Address *aDestination,
101 uint8_t aSeriesId,
102 uint8_t aLength)
103 {
104 OT_ASSERT(aDestination != nullptr);
105 LinkMetrics::LinkMetrics &linkMetrics = AsCoreType(aInstance).Get<LinkMetrics::LinkMetrics>();
106
107 return linkMetrics.SendLinkProbe(AsCoreType(aDestination), aSeriesId, aLength);
108 }
109 #endif
110
111 #endif // OPENTHREAD_CONFIG_MLE_LINK_METRICS_INITIATOR_ENABLE || OPENTHREAD_CONFIG_MLE_LINK_METRICS_SUBJECT_ENABLE
112