1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
/*
* Copyright (c) 2017, The OpenThread Authors.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/**
* @file
* This file includes definitions for NCP service.
*/
#ifndef OTBR_AGENT_NCP_OPENTHREAD_HPP_
#define OTBR_AGENT_NCP_OPENTHREAD_HPP_
#include <chrono>
#include <memory>
#include <assert.h>
#include <openthread/backbone_router_ftd.h>
#include <openthread/cli.h>
#include <openthread/instance.h>
#include <openthread/openthread-system.h>
#include "common/mainloop.hpp"
#include "common/task_runner.hpp"
#include "common/types.hpp"
#include "utils/thread_helper.hpp"
namespace otbr {
namespace Ncp {
/**
* This interface defines NCP Controller functionality.
*
*/
class ControllerOpenThread : public MainloopProcessor
{
public:
using ThreadStateChangedCallback = std::function<void(otChangedFlags aFlags)>;
/**
* This constructor initializes this object.
*
* @param[in] aInterfaceName A string of the NCP interface name.
* @param[in] aRadioUrls The radio URLs (can be IEEE802.15.4 or TREL radio).
* @param[in] aBackboneInterfaceName The Backbone network interface name.
* @param[in] aDryRun TRUE to indicate dry-run mode. FALSE otherwise.
*
*/
ControllerOpenThread(const char * aInterfaceName,
const std::vector<const char *> &aRadioUrls,
const char * aBackboneInterfaceName,
bool aDryRun);
/**
* This method initialize the NCP controller.
*
*/
void Init(void);
/**
* This method deinitialize the NCP controller.
*
*/
void Deinit(void);
/**
* This method get mInstance pointer.
*
* @retval The pointer of mInstance.
*
*/
otInstance *GetInstance(void)
{
assert(mInstance != nullptr);
return mInstance;
}
/**
* This method gets the thread functionality helper.
*
* @retval The pointer to the helper object.
*
*/
otbr::agent::ThreadHelper *GetThreadHelper(void)
{
assert(mThreadHelper != nullptr);
return mThreadHelper.get();
}
void Update(MainloopContext &aMainloop) override;
void Process(const MainloopContext &aMainloop) override;
/**
* This method posts a task to the timer
*
* @param[in] aDelay The delay in milliseconds before executing the task.
* @param[in] aTask The task function.
*
*/
void PostTimerTask(Milliseconds aDelay, TaskRunner::Task<void> aTask);
/**
* This method registers a reset handler.
*
* @param[in] aHandler The handler function.
*
*/
void RegisterResetHandler(std::function<void(void)> aHandler);
/**
* This method adds a event listener for Thread state changes.
*
* @param[in] aCallback The callback to receive Thread state changed events.
*
*/
void AddThreadStateChangedCallback(ThreadStateChangedCallback aCallback);
/**
* This method resets the OpenThread instance.
*
*/
void Reset(void);
/**
* This method returns the Thread protocol version as a string.
*
* @returns A pointer to the Thread version string.
*
*/
static const char *GetThreadVersion(void);
/**
* This method returns the Thread network interface name.
*
* @returns A pointer to the Thread network interface name string.
*
*/
const char *GetInterfaceName(void) const { return mConfig.mInterfaceName; }
static otbrLogLevel ConvertToOtbrLogLevel(otLogLevel aLogLevel);
~ControllerOpenThread(void) override;
private:
static void HandleStateChanged(otChangedFlags aFlags, void *aContext)
{
static_cast<ControllerOpenThread *>(aContext)->HandleStateChanged(aFlags);
}
void HandleStateChanged(otChangedFlags aFlags);
static void HandleBackboneRouterDomainPrefixEvent(void * aContext,
otBackboneRouterDomainPrefixEvent aEvent,
const otIp6Prefix * aDomainPrefix);
void HandleBackboneRouterDomainPrefixEvent(otBackboneRouterDomainPrefixEvent aEvent,
const otIp6Prefix * aDomainPrefix);
#if OTBR_ENABLE_DUA_ROUTING
static void HandleBackboneRouterNdProxyEvent(void * aContext,
otBackboneRouterNdProxyEvent aEvent,
const otIp6Address * aAddress);
void HandleBackboneRouterNdProxyEvent(otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aAddress);
#endif
static bool IsAutoAttachEnabled(void);
static void DisableAutoAttach(void);
static otLogLevel ConvertToOtLogLevel(otbrLogLevel aLevel);
otInstance *mInstance;
otPlatformConfig mConfig;
std::unique_ptr<otbr::agent::ThreadHelper> mThreadHelper;
std::vector<std::function<void(void)>> mResetHandlers;
TaskRunner mTaskRunner;
std::vector<ThreadStateChangedCallback> mThreadStateChangedCallbacks;
};
} // namespace Ncp
} // namespace otbr
#endif // OTBR_AGENT_NCP_OPENTHREAD_HPP_
|
