summaryrefslogtreecommitdiff
path: root/test/regression/netxduo_test/netx_icmpv6_echo_request_test.c
blob: 6915ac977f696828c4f6a8c369e2d18f0708309e (plain)
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
/***************************************************************************/
/* 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 NetX test to test the ICMPv6 Echo request process.  */

#include    "tx_api.h"
#include    "nx_api.h"
extern void    test_control_return(UINT status);

#if defined(FEATURE_NX_IPV6) && !defined(NX_DISABLE_ICMP_INFO) && !defined(NX_DISABLE_IPV6_DAD)
#include    "nx_tcp.h"
#include    "nx_ip.h"
#include    "nx_ipv6.h"    
#include    "nx_icmpv6.h"
#include    "nx_ram_network_driver_test_1500.h"

#define     DEMO_STACK_SIZE    2048
#define     TEST_INTERFACE     1

/* Define the ThreadX and NetX object control blocks...  */

static TX_THREAD               thread_0;

static NX_PACKET_POOL          pool_0;
static NX_IP                   ip_0;

/* Define the counters used in the demo application...  */

static ULONG                   error_counter;           


/* Define thread prototypes.  */
static void    thread_0_entry(ULONG thread_input);
extern void    test_control_return(UINT status);
extern void    _nx_ram_network_driver_256(struct NX_IP_DRIVER_STRUCT *driver_req);
static void    icmp_checksum_compute(NX_PACKET *packet_ptr);

/* Frame (68 bytes) */
static const unsigned char pkt1[68] = {
0x00, 0x11, 0x22, 0x33, 0x44, 0x56, 0x00, 0x00, /* .."3DV.. */
0x00, 0x00, 0x01, 0x00, 0x86, 0xdd, 0x60, 0x00, /* ......`. */
0x00, 0x00, 0x00, 0x0e, 0x3a, 0x40, 0xfe, 0x80, /* ....:@.. */
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0x00, /* ........ */
0x00, 0xff, 0xfe, 0x00, 0x01, 0x00, 0xfe, 0x80, /* ........ */
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0x11, /* ........ */
0x22, 0xff, 0xfe, 0x33, 0x44, 0x56, 0x80, 0x00, /* "..3DV.. */
0x19, 0x1b, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, /* ........ */
0xff, 0xff, 0xff, 0xff                          /* .... */
};

/* Define what the initial system looks like.  */

#ifdef CTEST
VOID test_application_define(void *first_unused_memory)
#else
void           netx_icmpv6_echo_request_test_application_define(void *first_unused_memory)
#endif
{
    CHAR       *pointer;
    UINT       status;

    /* Setup the working pointer.  */
    pointer = (CHAR *) first_unused_memory;

    error_counter = 0;

    /* Create the main thread.  */
    tx_thread_create(&thread_0, "thread 0", thread_0_entry, 0,  
        pointer, DEMO_STACK_SIZE, 
        4, 4, 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", 1536, pointer, 1536*4);
    pointer = pointer + 1536*4;

    if(status)
        error_counter++;

    /* Create an IP instance.  */
    status = _nx_ip_create(&ip_0, "NetX IP Instance 0", IP_ADDRESS(1,2,3,4), 0xFFFFFF00UL, &pool_0, _nx_ram_network_driver_256,
        pointer, 2048, 1);
    pointer = pointer + 2048;
                
    /* Check ARP enable status.  */
    if(status)
        error_counter++;

    /* Enable IPv6 */
    status = nxd_ipv6_enable(&ip_0);
                 
    /* Check IPv6 enable status.  */
    if(status)
        error_counter++;

    /* Enable ICMP for IP Instance 0 and 1.  */
    status = nxd_icmp_enable(&ip_0);

    /* Check icmp enable status.  */
    if(status)
        error_counter++;

}

/* Define the test threads.  */

static void    thread_0_entry(ULONG thread_input)
{

UINT             status;
NX_PACKET        *my_packet;   
NX_IPV6_HEADER   *ip_header_ptr;
    
    /* Print out test information banner.  */
    printf("NetX Test:   ICMPv6 Echo Request Test..................................");

    /* Check for earlier error.  */
    if (error_counter)
    {

        printf("ERROR!\n");
        test_control_return(1);
    }

    /* Set the linklocal address*/
    status = nxd_ipv6_address_set(&ip_0, 0, NX_NULL, 10, NX_NULL);
       
    /* Check the status.  */
    if (status)
    {
        printf("ERROR!\n");
        test_control_return(1);
    }                        

    /* Before DAD complete.  */
                                             
    /* Allocate one packet.  */
    status = nx_packet_allocate(&pool_0, &my_packet, NX_IPv6_PACKET, 5 * NX_IP_PERIODIC_RATE);
               
    /* Write data into the packet payload, ignore the physical header!  */
    memcpy(my_packet -> nx_packet_prepend_ptr, &pkt1[14], 54);

    /* Adjust the write pointer.  */
    my_packet -> nx_packet_length = 54;
    my_packet -> nx_packet_append_ptr =  my_packet -> nx_packet_prepend_ptr + 54;

    /* Set the interface.  */
    my_packet -> nx_packet_address.nx_packet_interface_ptr = &ip_0.nx_ip_interface[0]; 

    /* Calculate the ICMP checksum. */
    icmp_checksum_compute(my_packet);

    /* Call the _nx_ip_packet_receive function directly receive the ICMPv6 Echo Request.  */
    _nx_ip_packet_receive(&ip_0, my_packet);
  
    /* Check the value.  */    
    if ((ip_0.nx_ip_pings_received != 0) || (ip_0.nx_ip_pings_responded_to != 0))  
    {
        printf("ERROR!\n");
        test_control_return(1);
    }                   
    
    /* Waiting for DAD.  */
    tx_thread_sleep(5 * NX_IP_PERIODIC_RATE);
                        
    /* Allocate one packet.  */
    status = nx_packet_allocate(&pool_0, &my_packet, NX_IPv6_PACKET, 5 * NX_IP_PERIODIC_RATE);
               
    /* Write data into the packet payload, ignore the physical header!  */
    memcpy(my_packet -> nx_packet_prepend_ptr, &pkt1[14], 54);

    /* Adjust the write pointer.  */
    my_packet -> nx_packet_length = 54;

    /* Set the error append pointer.  */
    my_packet -> nx_packet_append_ptr =  my_packet -> nx_packet_prepend_ptr + 54;
                               
    /* Points to the base of IPv6 header. */
    ip_header_ptr = (NX_IPV6_HEADER*)my_packet -> nx_packet_prepend_ptr;
                       
    /* Modified the source address as invalid.  */ 
    ip_header_ptr -> nx_ip_header_source_ip[0] = 0;  
    ip_header_ptr -> nx_ip_header_source_ip[1] = 0;
    ip_header_ptr -> nx_ip_header_source_ip[2] = 0;
    ip_header_ptr -> nx_ip_header_source_ip[3] = 0;

    /* Set the interface.  */
    my_packet -> nx_packet_address.nx_packet_interface_ptr = &ip_0.nx_ip_interface[0]; 

    /* Calculate the ICMP checksum. */
    icmp_checksum_compute(my_packet);

    /* Call the _nx_ip_packet_receive function directly receive the ICMPv6 Echo Request with error source address.  */
    _nx_ip_packet_receive(&ip_0, my_packet);
 
    /* Check the value.  */    
    if ((ip_0.nx_ip_pings_received != 0) || (ip_0.nx_ip_pings_responded_to != 0))  
    {
        printf("ERROR!\n");
        test_control_return(1);
    }                                                    
                                              
    /* Allocate one packet.  */
    status = nx_packet_allocate(&pool_0, &my_packet, NX_IPv6_PACKET, 5 * NX_IP_PERIODIC_RATE);
               
    /* Write data into the packet payload, ignore the physical header!  */
    memcpy(my_packet -> nx_packet_prepend_ptr, &pkt1[14], 54);

    /* Adjust the write pointer.  */
    my_packet -> nx_packet_length = 54;
    my_packet -> nx_packet_append_ptr =  my_packet -> nx_packet_prepend_ptr + 54;

    /* Set the interface.  */
    my_packet -> nx_packet_address.nx_packet_interface_ptr = &ip_0.nx_ip_interface[0]; 

    /* Calculate the ICMP checksum. */
    icmp_checksum_compute(my_packet);

    /* Call the _nx_ip_packet_receive function directly receive the valid ICMPv6 Echo Request.  */
    _nx_ip_packet_receive(&ip_0, my_packet);
  
    /* Check the value.  */    
    if ((ip_0.nx_ip_pings_received != 1) || (ip_0.nx_ip_pings_responded_to != 1))  
    {
        printf("ERROR!\n");
        test_control_return(1);
    }  

    /* Out successful.  */
    printf("SUCCESS!\n");    
    test_control_return(0);
}                  

static void    icmp_checksum_compute(NX_PACKET *packet_ptr)
{
NX_ICMPV6_HEADER   *header_ptr;   
ULONG              *source_ip, *dest_ip;
ULONG               checksum;

    /* Set packet version. */
    packet_ptr -> nx_packet_ip_version = NX_IP_VERSION_V6;

    /* Skip IPv6 header. */
    packet_ptr -> nx_packet_prepend_ptr += sizeof(NX_IPV6_HEADER);
    packet_ptr -> nx_packet_length -= sizeof(NX_IPV6_HEADER);

    /* Get IPv6 addresses. */
    source_ip = (ULONG *)(packet_ptr -> nx_packet_prepend_ptr - 32);
    dest_ip = (ULONG *)(packet_ptr -> nx_packet_prepend_ptr - 16);
    NX_IPV6_ADDRESS_CHANGE_ENDIAN(source_ip);
    NX_IPV6_ADDRESS_CHANGE_ENDIAN(dest_ip);

    header_ptr = (NX_ICMPV6_HEADER *)(packet_ptr -> nx_packet_prepend_ptr);

    /* Calculate the ICMP checksum.  */
    header_ptr -> nx_icmpv6_header_checksum = 0;

    /* Calculate the checksum.  */
    checksum = _nx_ip_checksum_compute(packet_ptr, NX_PROTOCOL_ICMPV6,
                                       packet_ptr -> nx_packet_length,
                                       source_ip, dest_ip);
    checksum = ~checksum & NX_LOWER_16_MASK;
    header_ptr -> nx_icmpv6_header_checksum = checksum;
    NX_CHANGE_USHORT_ENDIAN(header_ptr -> nx_icmpv6_header_checksum);

    /* Recover IPv6 header. */
    NX_IPV6_ADDRESS_CHANGE_ENDIAN(source_ip);
    NX_IPV6_ADDRESS_CHANGE_ENDIAN(dest_ip);
    packet_ptr -> nx_packet_prepend_ptr -= sizeof(NX_IPV6_HEADER);
    packet_ptr -> nx_packet_length += sizeof(NX_IPV6_HEADER);
}

#else

#ifdef CTEST
VOID test_application_define(void *first_unused_memory)
#else
void           netx_icmpv6_echo_request_test_application_define(void *first_unused_memory)
#endif
{

    /* Print out test information banner.  */
    printf("NetX Test:   ICMPv6 Echo Request Test..................................N/A\n");

    test_control_return(3);         
}
#endif