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
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
|
/***************************************************************************/
/* Copyright (c) 2024 Microsoft Corporation */
/* Copyright (c) 2026 Eclipse ThreadX contributors */
/* */
/* This program and the accompanying materials are made available under */
/* the terms of the MIT License which is available at */
/* https://opensource.org/licenses/MIT. */
/* */
/* SPDX-License-Identifier: MIT */
/***************************************************************************/
/* This demo tests the nx_ppp_restart() function. To simulate a link down in the middle of the IPCP
negotiation, the thread_0/PPP_0 promotes the PPP 1 instance to LCP complete, and its IPCP state to STARTED.
Then the PPP0 instance is suspended as part of simulating link down.
PPP_1 should go into a FAILED state after the max number of retries, and call the link down callback.
NetX PPP has a restart function which reinitializes the PPP instance so it can restart the PPP
protocol using nx_ppp_restart().
The process is started again, PPP 0 is resumed, and thread 0 promotes the PPP 1 instance ahead
to the LCP complete state, and ICP start state. After the second link down event, the test is complete.
This test verifies that the NetX PPP properly clears and restarts a PPP instance, including resetting
the PPP state to restart the IPCP negotiation.
*/
#include "tx_api.h"
#include "nx_api.h"
#include "nx_ppp.h"
extern void test_control_return(UINT status);
#if !defined(NX_DISABLE_IPV4)
/* Define demo stack size. */
#define DEMO_STACK_SIZE 2048
/* Define the ThreadX and NetX object control blocks... */
static TX_THREAD thread_0;
static TX_THREAD thread_1;
static NX_PACKET_POOL pool_0;
static NX_PACKET_POOL pool_1;
static NX_IP ip_0;
static NX_IP ip_1;
static NX_PPP ppp_0;
static NX_PPP ppp_1;
/* Define the counters used in the demo application... */
static ULONG ppp_0_link_up_counter;
static ULONG ppp_0_link_down_counter;
static ULONG ppp_1_link_up_counter;
static ULONG ppp_1_link_down_counter;
static ULONG error_counter = 0;
static UINT suspend_thread = NX_TRUE;
/* Define thread prototypes. */
static void thread_0_entry(ULONG thread_input);
static void thread_1_entry(ULONG thread_input);
static void link_up_callback(NX_PPP *ppp_ptr);
static void link_down_callback(NX_PPP *ppp_ptr);
static void ppp_0_serial_byte_output(UCHAR byte);
static void ppp_1_serial_byte_output(UCHAR byte);
static void invalid_packet_handler(NX_PACKET *packet_ptr);
/* Define what the initial system looks like. */
#ifdef CTEST
VOID test_application_define(void *first_unused_memory)
#else
void netx_ppp_IPCP_timeout_test_application_define(void *first_unused_memory)
#endif
{
CHAR *pointer;
UINT status;
/* Setup the working pointer. */
pointer = (CHAR *) first_unused_memory;
/* Create the thread 0. */
tx_thread_create(&thread_0, "thread 0", thread_0_entry, 0,
pointer, DEMO_STACK_SIZE,
5, 5, TX_NO_TIME_SLICE, TX_AUTO_START);
pointer = pointer + DEMO_STACK_SIZE;
/* Create the thread 1. */
tx_thread_create(&thread_1, "thread 1", thread_1_entry, 0,
pointer, DEMO_STACK_SIZE,
5, 5, TX_NO_TIME_SLICE, TX_AUTO_START);
pointer = pointer + DEMO_STACK_SIZE;
/* Initialize the NetX system. */
nx_system_initialize();
/* Create a packet pool. */
status = nx_packet_pool_create(&pool_0, "NetX Main Packet Pool", 1024, pointer, 8192);
pointer = pointer + 8192;
status += nx_packet_pool_create(&pool_1, "NetX Main Packet Pool", NX_PPP_MIN_PACKET_PAYLOAD, pointer, 4096);
pointer = pointer + 4096;
/* Check for pool creation error. */
if (status)
error_counter++;
/* Create the first PPP instance. */
status = nx_ppp_create(&ppp_0, "PPP0", &ip_0, pointer, 2048, 1, &pool_0, invalid_packet_handler, ppp_0_serial_byte_output);
pointer = pointer + 2048;
/* Check for PPP create error. */
if (status)
error_counter++;
/* Define the IP addresses. This PPP instance is effectively the server since it has both IP addresses. */
status = nx_ppp_ip_address_assign(&ppp_0, IP_ADDRESS(1, 2, 3, 4), IP_ADDRESS(1, 2, 3, 5));
/* Check for PPP IP address assign error. */
if (status)
error_counter++;
/* Create an IP instance. */
status = nx_ip_create(&ip_0, "NetX IP Instance 0", IP_ADDRESS(0, 0, 0, 0), 0xFFFFF000UL, &pool_0, nx_ppp_driver,
pointer, 2048, 1);
pointer = pointer + 2048;
/* Check for IP create error. */
if (status)
error_counter++;
/* Register the link up/down callbacks. */
status = nx_ppp_link_up_notify(&ppp_0, link_up_callback);
status += nx_ppp_link_down_notify(&ppp_0, link_down_callback);
/* Check for PPP link up/down callback registration error(s). */
if (status)
error_counter++;
/* Create the next PPP instance. */
status = nx_ppp_create(&ppp_1, "PPP1", &ip_1, pointer, 2048, 1, &pool_1, invalid_packet_handler, ppp_1_serial_byte_output);
pointer = pointer + 2048;
/* Check for PPP create error. */
if (status)
error_counter++;
/* Define IP address. This PPP instance is effectively the client since it doesn't have any IP addresses. */
status = nx_ppp_ip_address_assign(&ppp_1, IP_ADDRESS(0, 0, 0, 0), IP_ADDRESS(0, 0, 0, 0));
/* Check for PPP IP address assign error. */
if (status)
error_counter++;
/* Create another IP instance. */
status += nx_ip_create(&ip_1, "NetX IP Instance 1", IP_ADDRESS(0, 0, 0, 0), 0xFFFFF000UL, &pool_1, nx_ppp_driver,
pointer, 2048, 1);
pointer = pointer + 2048;
/* Check for IP create error. */
if (status)
error_counter++;
/* Register the link up/down callbacks. */
status = nx_ppp_link_up_notify(&ppp_1, link_up_callback);
status += nx_ppp_link_down_notify(&ppp_1, link_down_callback);
/* Check for PPP link up/down callback registration error(s). */
if (status)
error_counter++;
/* Enable UDP traffic. */
nx_udp_enable(&ip_0);
nx_udp_enable(&ip_1);
/* Enable ICMP traffic. */
nx_icmp_enable(&ip_0);
nx_icmp_enable(&ip_1);
}
/* Define the test threads. */
static void thread_0_entry(ULONG thread_input)
{
UINT status;
ULONG ip_status;
/* Print out test information banner. */
printf("NetX Test: PPP IPCP Timeout/Restart Test.............................");
if (error_counter)
{
printf("ERROR!\n");
test_control_return(1);
}
do
{
if (suspend_thread)
{
if (ppp_1.nx_ppp_lcp_state >= 2)
{
suspend_thread = NX_FALSE;
/* PPP_1 is in the LCP completed state. Suspend PPP_0 thread so PPP_1 will not be able
to complete the IPCP protocol. */
tx_thread_suspend(&(ppp_0.nx_ppp_thread));
ppp_1.nx_ppp_timeout = NX_PPP_PROTOCOL_TIMEOUT;
ppp_1.nx_ppp_lcp_state = NX_PPP_LCP_COMPLETED_STATE;
ppp_1.nx_ppp_ipcp_state = NX_PPP_IPCP_START_STATE;
}
}
/* Determine if the two or more restarts have occurred */
if (ppp_1_link_down_counter >= 2)
{
break;
}
/* Wait for the link to come up (this should not happen if we are
testing the link down callback. */
status = nx_ip_status_check(&ip_0, NX_IP_LINK_ENABLED, &ip_status, NX_IP_PERIODIC_RATE/2);
} while (status != NX_SUCCESS) ;
/* Determine if the test completed successfully. */
if ((error_counter == 0) && (ppp_0_link_down_counter == 0) && (ppp_1_link_down_counter >= 2))
{
printf("SUCCESS!\n");
test_control_return(0);
}
else
{
printf("ERROR!\n");
test_control_return(1);
}
}
static void thread_1_entry(ULONG thread_input)
{
UINT status;
ULONG ip_status;
tx_thread_sleep(20);
do
{
/* If this is the second restart, the test is complete. */
if (ppp_1_link_down_counter > 1)
{
return;
}
/* Wait for the link to come up. */
status = nx_ip_status_check(&ip_1, NX_IP_LINK_ENABLED, &ip_status, NX_IP_PERIODIC_RATE/2);
} while (status != NX_SUCCESS);
}
/* Define serial output routines. Normally these routines would
map to physical UART routines and the nx_ppp_byte_receive call
would be made from a UART receive interrupt. */
static void ppp_0_serial_byte_output(UCHAR byte)
{
/* Just feed the PPP 1 input routine. */
nx_ppp_byte_receive(&ppp_1, byte);
}
static void ppp_1_serial_byte_output(UCHAR byte)
{
/* Just feed the PPP 0 input routine. */
nx_ppp_byte_receive(&ppp_0, byte);
}
static void invalid_packet_handler(NX_PACKET *packet_ptr)
{
error_counter++;
nx_packet_release(packet_ptr);
}
static void link_up_callback(NX_PPP *ppp_ptr)
{
/* Just increment the link up counter. */
if (ppp_ptr == &ppp_0)
ppp_0_link_up_counter++;
else
ppp_1_link_up_counter++;
}
static void link_down_callback(NX_PPP *ppp_ptr)
{
/* Just increment the link down counter. */
if (ppp_ptr == &ppp_0)
ppp_0_link_down_counter++;
else
ppp_1_link_down_counter++;
if (ppp_ptr -> nx_ppp_ipcp_state != NX_PPP_IPCP_FAILED_STATE)
{
/* Error test should only restart from the IPCP FAILED state */
error_counter++;
return;
}
/* If this is the second restart, the test is complete. */
if (ppp_1_link_down_counter > 1)
{
/* Success. Restart test is complete */
return;
}
/* Restart PPP 1. */
nx_ppp_restart(ppp_ptr);
if (ppp_1_link_down_counter == 1)
{
/* First restart. Wait for second restart to verify first restart succeeds */
suspend_thread = NX_TRUE;
}
return;
}
#else
#ifdef CTEST
VOID test_application_define(void *first_unused_memory)
#else
void netx_ppp_IPCP_timeout_test_application_define(void *first_unused_memory)
#endif
{
/* Print out test information banner. */
printf("NetX Test: PPP IPCP Timeout/Restart Test.............................N/A\n");
test_control_return(3);
}
#endif
|
