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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
|
/*------------------------------------------------------------------------------------------------*/
/* UNICENS V2.1.0-3491 */
/* Copyright (c) 2017 Microchip Technology Germany II GmbH & Co. KG. */
/* */
/* This program is free software: you can redistribute it and/or modify */
/* it under the terms of the GNU General Public License as published by */
/* the Free Software Foundation, either version 2 of the License, or */
/* (at your option) any later version. */
/* */
/* This program is distributed in the hope that it will be useful, */
/* but WITHOUT ANY WARRANTY; without even the implied warranty of */
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* along with this program. If not, see <http://www.gnu.org/licenses/>. */
/* */
/* You may also obtain this software under a propriety license from Microchip. */
/* Please contact Microchip for further information. */
/*------------------------------------------------------------------------------------------------*/
/*!
* \file
* \brief Implementation of CNodeObserver class
*
* \cond UCS_INTERNAL_DOC
* \addtogroup G_NODEOBSERVER
* @{
*/
/*------------------------------------------------------------------------------------------------*/
/* Includes */
/*------------------------------------------------------------------------------------------------*/
#include "ucs_nodeobserver.h"
#include "ucs_misc.h"
#include "ucs_trace.h"
/*------------------------------------------------------------------------------------------------*/
/* Internal constants */
/*------------------------------------------------------------------------------------------------*/
#define NOBS_ADDR_ADMIN_MIN 0xF80U /*!< \brief Start of address range to park unknown devices */
#define NOBS_ADDR_ADMIN_MAX 0xFDFU /*!< \brief End of address range to park unknown devices */
#define NOBS_ADDR_RANGE1_MIN 0x200U /*!< \brief Start of first static address range */
#define NOBS_ADDR_RANGE1_MAX 0x2FFU /*!< \brief End of first static address range */
#define NOBS_ADDR_RANGE2_MIN 0x500U /*!< \brief Start of second static address range */
#define NOBS_ADDR_RANGE2_MAX 0xEFFU /*!< \brief End of second static address range */
#define NOSB_JOIN_NO 0x00U
#define NOSB_JOIN_WAIT 0x01U
#define NOSB_JOIN_YES 0x02U
#define NOBS_WAIT_TIME 200U /*!< \brief Wait time between node not_available -> available */
/*------------------------------------------------------------------------------------------------*/
/* Internal prototypes */
/*------------------------------------------------------------------------------------------------*/
static void Nobs_OnInitComplete(void *self, void *error_code_ptr);
static void Nobs_OnWakeupTimer(void *self);
static bool Nobs_CheckAddrRange(CNodeObserver *self, Ucs_Signature_t *signature_ptr);
static void Nobs_InitAllNodes(CNodeObserver *self);
static void Nobs_InvalidateAllNodes(CNodeObserver *self);
static void Nobs_InvalidateNode(CNodeObserver *self, Ucs_Rm_Node_t *node_ptr);
static Ucs_Rm_Node_t* Nobs_GetNodeBySignature(CNodeObserver *self, Ucs_Signature_t *signature_ptr);
static void Nobs_NotifyApp(CNodeObserver *self, Ucs_MgrReport_t code, uint16_t node_address, Ucs_Rm_Node_t *node_ptr);
/*------------------------------------------------------------------------------------------------*/
/* Class methods */
/*------------------------------------------------------------------------------------------------*/
/*! \brief Constructor of NodeObserver class
* \param self The instance
* \param base_ptr Reference to base component
* \param nd_ptr Reference to NodeDiscovery component
* \param rtm_ptr Reference to RoutingManagement component
* \param init_ptr Reference to initialization data
*/
void Nobs_Ctor(CNodeObserver *self, CBase *base_ptr, CNodeDiscovery *nd_ptr, CRouteManagement *rtm_ptr, Ucs_Mgr_InitData_t *init_ptr)
{
MISC_MEM_SET(self, 0, sizeof(*self));
self->base_ptr = base_ptr;
self->nd_ptr = nd_ptr;
self->rtm_ptr = rtm_ptr;
if (init_ptr != NULL)
{
self->init_data = *init_ptr;
}
Nobs_InitAllNodes(self);
T_Ctor(&self->wakeup_timer);
Mobs_Ctor(&self->event_observer, self, EH_E_INIT_SUCCEEDED, &Nobs_OnInitComplete);
Eh_AddObsrvInternalEvent(&self->base_ptr->eh, &self->event_observer);
}
/*! \brief Callback function which is invoked if the initialization is complete
* \param self The instance
* \param error_code_ptr Reference to the error code
*/
static void Nobs_OnInitComplete(void *self, void *error_code_ptr)
{
CNodeObserver *self_ = (CNodeObserver*)self;
MISC_UNUSED(error_code_ptr);
(void)Nd_Start(self_->nd_ptr);
(void)Rtm_StartProcess(self_->rtm_ptr, self_->init_data.routes_list_ptr, self_->init_data.routes_list_size);
}
/*------------------------------------------------------------------------------------------------*/
/* Callback Methods */
/*------------------------------------------------------------------------------------------------*/
Ucs_Nd_CheckResult_t Nobs_OnNdEvaluate(void *self, Ucs_Signature_t *signature_ptr)
{
CNodeObserver *self_ = (CNodeObserver*)self;
Ucs_Rm_Node_t *node_ptr = NULL;
Ucs_Nd_CheckResult_t ret = UCS_ND_CHK_UNKNOWN; /* ignore by default */
if (signature_ptr != NULL)
{
if (Nobs_CheckAddrRange(self_, signature_ptr) != false)
{
node_ptr = Nobs_GetNodeBySignature(self_, signature_ptr);
if (node_ptr != NULL)
{
if (node_ptr->internal_infos.mgr_joined == NOSB_JOIN_NO)
{
ret = UCS_ND_CHK_WELCOME; /* welcome new node */
}
else if (node_ptr->internal_infos.mgr_joined == NOSB_JOIN_YES)
{
ret = UCS_ND_CHK_UNIQUE; /* node already available - check for reset */
}
/* else if (node_ptr->internal_infos.mgr_joined == NOSB_JOIN_WAIT) --> ignore waiting nodes */
/* future version compare node position to improve handling */
}
}
self_->eval_signature = *signature_ptr;
TR_INFO((self_->base_ptr->ucs_user_ptr, "[NOBS]", "Nobs_OnNdEvaluate(): node=0x%03X, node_pos=0x%03X, ret=0x%02X", 2U, signature_ptr->node_address, signature_ptr->node_pos_addr, ret));
}
else
{
MISC_MEM_SET(&self_->eval_signature, 0, sizeof(self_->eval_signature)); /* reset signature */
TR_FAILED_ASSERT(self_->base_ptr->ucs_user_ptr, "[NOBS]"); /* signature missing - it is evident for evaluation */
}
self_->eval_node_ptr = node_ptr;
self_->eval_action = ret;
if ((ret == UCS_ND_CHK_UNKNOWN) && (signature_ptr != NULL)) /* notify unknown node */
{
Nobs_NotifyApp(self_, UCS_MGR_REP_IGNORED_UNKNOWN, signature_ptr->node_address, NULL);
}
return ret;
}
void Nobs_OnNdReport(void *self, Ucs_Nd_ResCode_t code, Ucs_Signature_t *signature_ptr)
{
CNodeObserver *self_ = (CNodeObserver*)self;
Ucs_Rm_Node_t *node_ptr = NULL;
if (signature_ptr != NULL)
{
TR_INFO((self_->base_ptr->ucs_user_ptr, "[NOBS]", "Nobs_OnNdReport(): code=0x%02X, node=0x%03X, node_pos=0x%03X", 3U, code, signature_ptr->node_address, signature_ptr->node_pos_addr));
node_ptr = Nobs_GetNodeBySignature(self_, signature_ptr);
if (node_ptr != self_->eval_node_ptr) /* if signature available -> expecting the same node_ptr as previously announced in Nobs_OnNdEvaluate */
{
TR_ERROR((self_->base_ptr->ucs_user_ptr, "[NOBS]", "Nobs_OnNdReport(): sanity check failed node_ptr=%p, eval_node_ptr=%p", 2U, node_ptr, self_->eval_node_ptr));
node_ptr = NULL; /* do not handle node */
}
}
else
{
TR_INFO((self_->base_ptr->ucs_user_ptr, "[NOBS]", "Nobs_OnNdReport(): code=0x%02X", 1U, code));
}
if (code == UCS_ND_RES_NETOFF)
{
Nobs_InvalidateAllNodes(self_);
}
else if (node_ptr == NULL)
{
/* no not handle events with unspecified node */
}
else if ((code == UCS_ND_RES_WELCOME_SUCCESS) && (self_->eval_action == UCS_ND_CHK_WELCOME)) /* is new node? */
{
TR_INFO((self_->base_ptr->ucs_user_ptr, "[NOBS]", "Nobs_OnNdReport(): welcome of new node=0x%03X", 1U, signature_ptr->node_address));
node_ptr->internal_infos.mgr_joined = NOSB_JOIN_YES;
(void)Rtm_SetNodeAvailable(self_->rtm_ptr, node_ptr, true);
Nobs_NotifyApp(self_, UCS_MGR_REP_AVAILABLE, signature_ptr->node_address, node_ptr);
}
else if ((code == UCS_ND_RES_WELCOME_SUCCESS) && (self_->eval_action == UCS_ND_CHK_UNIQUE)) /* is node that previously joined */
{
TR_INFO((self_->base_ptr->ucs_user_ptr, "[NOBS]", "Nobs_OnNdReport(): welcome of existing node=0x%03X (RESET -> not_available)", 1U, signature_ptr->node_address));
node_ptr->internal_infos.mgr_joined = NOSB_JOIN_WAIT;
(void)Rtm_SetNodeAvailable(self_->rtm_ptr, node_ptr, false);
Nobs_NotifyApp(self_, UCS_MGR_REP_NOT_AVAILABLE, signature_ptr->node_address, node_ptr);
(void)Nd_Stop(self_->nd_ptr); /* stop node discovery and restart after timeout, */
Tm_SetTimer(&self_->base_ptr->tm, &self_->wakeup_timer, &Nobs_OnWakeupTimer, /* transition from node not_available -> available */
self, /* needs some time and no callback is provided. */
NOBS_WAIT_TIME,
0U
);
}
else if ((code == UCS_ND_RES_MULTI) && (self_->eval_action == UCS_ND_CHK_UNIQUE)) /* is node that causes address conflict */
{
/* just ignore */
TR_INFO((self_->base_ptr->ucs_user_ptr, "[NOBS]", "Nobs_OnNdReport(): ignoring duplicate node=0x%03X", 1U, signature_ptr->node_address));
Nobs_NotifyApp(self_, UCS_MGR_REP_IGNORED_DUPLICATE, signature_ptr->node_address, NULL);
}
else if (code == UCS_ND_RES_UNKNOWN)
{
/* just ignore */
TR_INFO((self_->base_ptr->ucs_user_ptr, "[NOBS]", "Nobs_OnNdReport(): ignoring unknown node=0x%03X", 1U, signature_ptr->node_address));
}
else
{
/* just ignore */
TR_INFO((self_->base_ptr->ucs_user_ptr, "[NOBS]", "Nobs_OnNdReport(): ignoring node in unexpected, node=0x%03X, code=0x02X ", 2U, signature_ptr->node_address, code));
}
}
static void Nobs_OnWakeupTimer(void *self)
{
CNodeObserver *self_ = (CNodeObserver*)self;
if (self_->eval_node_ptr != NULL)
{
if (self_->eval_node_ptr->internal_infos.mgr_joined == NOSB_JOIN_WAIT)
{
TR_INFO((self_->base_ptr->ucs_user_ptr, "[NOBS]", "Nobs_OnWakeupTimer(): welcome of existing node 0x%03X (RESET -> available)", 1U, self_->eval_node_ptr->signature_ptr->node_address));
self_->eval_node_ptr->internal_infos.mgr_joined = NOSB_JOIN_YES;
(void)Rtm_SetNodeAvailable(self_->rtm_ptr, self_->eval_node_ptr, true);
Nobs_NotifyApp(self_, UCS_MGR_REP_AVAILABLE, self_->eval_signature.node_address, self_->eval_node_ptr);
}
}
(void)Nd_Start(self_->nd_ptr);
}
/*------------------------------------------------------------------------------------------------*/
/* Helper Methods */
/*------------------------------------------------------------------------------------------------*/
/*! \brief Checks if the node address in signature is in supported address range
* \param self The instance
* \param signature_ptr Reference to the nodes signature
* \return Returns \c true if the address in signature is supported, otherwise \c false.
*/
static bool Nobs_CheckAddrRange(CNodeObserver *self, Ucs_Signature_t *signature_ptr)
{
bool ret = false;
if (((signature_ptr->node_address >= NOBS_ADDR_RANGE1_MIN) && (signature_ptr->node_address <= NOBS_ADDR_RANGE1_MAX)) ||
((signature_ptr->node_address >= NOBS_ADDR_RANGE2_MIN) && (signature_ptr->node_address <= NOBS_ADDR_RANGE2_MAX)))
{
ret = true;
}
MISC_UNUSED(self);
return ret;
}
static void Nobs_InitAllNodes(CNodeObserver *self)
{
if (self->init_data.nodes_list_ptr != NULL)
{
uint32_t cnt = 0U;
for (cnt = 0U; cnt < self->init_data.nodes_list_size; cnt++)
{
self->init_data.nodes_list_ptr[cnt].internal_infos.available = 0U;
self->init_data.nodes_list_ptr[cnt].internal_infos.mgr_joined = NOSB_JOIN_NO;
}
}
}
static void Nobs_InvalidateAllNodes(CNodeObserver *self)
{
if (self->init_data.nodes_list_ptr != NULL)
{
uint32_t cnt = 0U;
for (cnt = 0U; cnt < self->init_data.nodes_list_size; cnt++)
{
Nobs_InvalidateNode(self, &self->init_data.nodes_list_ptr[cnt]);
}
}
}
static void Nobs_InvalidateNode(CNodeObserver *self, Ucs_Rm_Node_t *node_ptr)
{
if (node_ptr->internal_infos.mgr_joined == NOSB_JOIN_YES) /* notify welcomed nodes as invalid */
{
Nobs_NotifyApp(self, UCS_MGR_REP_NOT_AVAILABLE, node_ptr->signature_ptr->node_address, node_ptr);
}
node_ptr->internal_infos.mgr_joined = NOSB_JOIN_NO;
/* RoutingManagement individually cares for network-not-available event */
/* (void)Rtm_SetNodeAvailable(self->rtm_ptr, &self->init_data.nodes_list_ptr[cnt], false); */
}
static Ucs_Rm_Node_t* Nobs_GetNodeBySignature(CNodeObserver *self, Ucs_Signature_t *signature_ptr)
{
Ucs_Rm_Node_t* ret = NULL;
if ((signature_ptr != NULL) && (self->init_data.nodes_list_ptr != NULL))
{
uint32_t cnt = 0U;
uint16_t node_addr = signature_ptr->node_address;
for (cnt = 0U; cnt < self->init_data.nodes_list_size; cnt++)
{
if (node_addr == self->init_data.nodes_list_ptr[cnt].signature_ptr->node_address)
{
ret = &self->init_data.nodes_list_ptr[cnt];
break;
}
}
}
return ret;
}
static void Nobs_NotifyApp(CNodeObserver *self, Ucs_MgrReport_t code, uint16_t node_address, Ucs_Rm_Node_t *node_ptr)
{
if (self->init_data.report_fptr != NULL)
{
self->init_data.report_fptr(code, node_address, node_ptr, self->base_ptr->ucs_user_ptr);
}
}
/*!
* @}
* \endcond
*/
/*------------------------------------------------------------------------------------------------*/
/* End of file */
/*------------------------------------------------------------------------------------------------*/
|
