Outline ![]()
Files ![]()
loading...
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
/**************************************************************************/
/* */
/* Copyright (c) Microsoft Corporation. All rights reserved. */
/* */
/* This software is licensed under the Microsoft Software License */
/* Terms for Microsoft Azure RTOS. Full text of the license can be */
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
/* and in the root directory of this software. */
/* */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** NetX Component */
/** */
/** Internet Protocol (IP) */
/** */
/**************************************************************************/
/**************************************************************************/
#define NX_SOURCE_CODE
/* Include necessary system files. */
#include "nx_api.h"
#include "nx_ipv6.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxd_ipv6_address_set PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function sets the IP address and the prefix length for the */
/* supplied IP instance. */
/* */
/* For the IPv6 address, an application is only allowed to change the */
/* global IP address. The link local address is generated through the */
/* underlying interface address, therefore cannot be reconfigured by */
/* user level applications. */
/* */
/* INPUT */
/* */
/* ip_ptr IP control block pointer */
/* interface_index The index to the physical */
/* interface this address */
/* belongs to */
/* ip_address Pointer to IP address */
/* structure */
/* prefix_length Prefix length */
/* address_index Index to the IPv6 address */
/* table */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Completion status */
/* */
/* CALLS */
/* */
/* _nx_ipv6_multicast_join Multicast group join service */
/* [ipv6_address_change_notify] User callback function */
/* tx_mutex_get Get protection mutex */
/* tx_mutex_put Put protection mutex */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxd_ipv6_address_set(NX_IP *ip_ptr, UINT interface_index, NXD_ADDRESS *ip_address, ULONG prefix_length, UINT *address_index)
{
#ifdef FEATURE_NX_IPV6
TX_INTERRUPT_SAVE_AREA
#ifdef NX_ENABLE_IPV6_ADDRESS_CHANGE_NOTIFY
VOID (*address_change_notify)(NX_IP *, UINT, UINT, UINT, ULONG *);
#endif /* NX_ENABLE_IPV6_ADDRESS_CHANGE_NOTIFY */
NXD_IPV6_ADDRESS *ipv6_addr;
NXD_IPV6_ADDRESS *interface_ipv6_address;
UINT index = (UINT)0xFFFFFFFF;
UINT i;
ULONG multicast_address[4];
/* Place protection while the IPv6 address is modified. */
tx_mutex_get(&(ip_ptr -> nx_ip_protection), TX_WAIT_FOREVER);
if (ip_address)
{
/* Perform duplicate address detection. */
for (i = 0; i < NX_MAX_IPV6_ADDRESSES; i++)
{
if ((ip_ptr -> nx_ipv6_address[i].nxd_ipv6_address_valid) &&
(ip_ptr -> nx_ipv6_address[i].nxd_ipv6_address[0] == ip_address -> nxd_ip_address.v6[0]) &&
(ip_ptr -> nx_ipv6_address[i].nxd_ipv6_address[1] == ip_address -> nxd_ip_address.v6[1]) &&
(ip_ptr -> nx_ipv6_address[i].nxd_ipv6_address[2] == ip_address -> nxd_ip_address.v6[2]) &&
(ip_ptr -> nx_ipv6_address[i].nxd_ipv6_address[3] == ip_address -> nxd_ip_address.v6[3]))
{
/* The IPv6 address already exists. */
tx_mutex_put(&(ip_ptr -> nx_ip_protection));
return(NX_DUPLICATED_ENTRY);
}
}
}
/* Find an avaiable IPv6 address structure. */
for (i = 0; i < NX_MAX_IPV6_ADDRESSES; i++)
{
/* Look for invalid entries. */
if (!ip_ptr -> nx_ipv6_address[i].nxd_ipv6_address_valid)
{
/* An available entry is found. */
index = i;
break;
}
}
if (index == (UINT)0xFFFFFFFF)
{
tx_mutex_put(&(ip_ptr -> nx_ip_protection));
return(NX_NO_MORE_ENTRIES);
}
if (address_index)
{
*address_index = index;
}
/* Pointer to the IPv6 address that needs to be modified. */
ipv6_addr = &(ip_ptr -> nx_ipv6_address[index]);
/* The address is null. */
if ((!ip_address) && (prefix_length == 10))
{
/* No address supplied. Assume it is link local address, constructed from the physical interface. */
ULONG word2, word3;
/* Construct Interface Identifier, following RFC2464, page 3 */
/* Assign link local address.
LL address is constructed by:
0xFE80::{64 bit interface ID}. See RFC 4291 */
word2 = ip_ptr -> nx_ip_interface[interface_index].nx_interface_physical_address_msw << 16 |
((ip_ptr -> nx_ip_interface[interface_index].nx_interface_physical_address_lsw & 0xFF000000) >> 16) | 0xFF;
/* Fix the 2nd lower-order bit of the 1st byte, RFC2464, page 3 */
word2 = (word2 & 0xFDFFFFFF) | (~(word2 | 0xFDFFFFFF));
word3 = (ip_ptr -> nx_ip_interface[interface_index].nx_interface_physical_address_lsw & 0x00FFFFFF) | 0xFE000000;
/* Point to interface link list head */
interface_ipv6_address = ip_ptr -> nx_ip_interface[interface_index].nxd_interface_ipv6_address_list_head;
/* Perform link local duplicate address detection. */
while (interface_ipv6_address)
{
if ((interface_ipv6_address -> nxd_ipv6_address[0] == 0xFE800000) &&
(interface_ipv6_address -> nxd_ipv6_address[1] == 0x00000000) &&
(interface_ipv6_address -> nxd_ipv6_address[2] == word2) &&
(interface_ipv6_address -> nxd_ipv6_address[3] == word3))
{
/* The IPv6 address already exists. */
tx_mutex_put(&(ip_ptr -> nx_ip_protection));
return(NX_DUPLICATED_ENTRY);
}
/* Walk down the list. */
interface_ipv6_address = interface_ipv6_address -> nxd_ipv6_address_next;
}
/* Set up the link local address. */
ipv6_addr -> nxd_ipv6_address[0] = 0xFE800000;
ipv6_addr -> nxd_ipv6_address[1] = 0x00000000;
ipv6_addr -> nxd_ipv6_address[2] = word2;
ipv6_addr -> nxd_ipv6_address[3] = word3;
}
else if (ip_address != NX_NULL)
{
ipv6_addr -> nxd_ipv6_address[0] = ip_address -> nxd_ip_address.v6[0];
ipv6_addr -> nxd_ipv6_address[1] = ip_address -> nxd_ip_address.v6[1];
ipv6_addr -> nxd_ipv6_address[2] = ip_address -> nxd_ip_address.v6[2];
ipv6_addr -> nxd_ipv6_address[3] = ip_address -> nxd_ip_address.v6[3];
}
else
{
tx_mutex_put(&(ip_ptr -> nx_ip_protection));
return(NX_IP_ADDRESS_ERROR);
}
ipv6_addr -> nxd_ipv6_address_valid = NX_TRUE;
ipv6_addr -> nxd_ipv6_address_type = NX_IP_VERSION_V6;
ipv6_addr -> nxd_ipv6_address_prefix_length = (UCHAR)(prefix_length & 0xFF);
ipv6_addr -> nxd_ipv6_address_next = NX_NULL;
/* Attach to the interface. */
ipv6_addr -> nxd_ipv6_address_attached = &ip_ptr -> nx_ip_interface[interface_index];
/* Point to interface link list head */
interface_ipv6_address = ip_ptr -> nx_ip_interface[interface_index].nxd_interface_ipv6_address_list_head;
/* Walk to the end of the list. */
while (interface_ipv6_address)
{
/* If the next entry does not exist, we already reach the end of the list.
Add the IPv6 address towards the end. */
if (interface_ipv6_address -> nxd_ipv6_address_next)
{
interface_ipv6_address = interface_ipv6_address -> nxd_ipv6_address_next;
}
else
{
interface_ipv6_address -> nxd_ipv6_address_next = ipv6_addr;
break;
}
}
/* Check whether the head is NULL */
if (interface_ipv6_address == NX_NULL)
{
/* This interface does not have IPv6 addresses yet. */
ip_ptr -> nx_ip_interface[interface_index].nxd_interface_ipv6_address_list_head = ipv6_addr;
}
/* If trace is enabled, insert this event into the trace buffer. */
NX_TRACE_IN_LINE_INSERT(NXD_TRACE_IPV6_INTERFACE_ADDRESS_SET, ip_ptr, ipv6_addr -> nxd_ipv6_address[3], prefix_length, index, NX_TRACE_IP_EVENTS, 0, 0);
/* Set the configuration type to manual. */
ipv6_addr -> nxd_ipv6_address_ConfigurationMethod = NX_IPV6_ADDRESS_MANUAL_CONFIG;
/* Release the IP protection. nx_ipv6_multicast_join would need to obtain the mutex. */
tx_mutex_put(&(ip_ptr -> nx_ip_protection));
/* Join the solicited-node multicast group */
/* FF02::1:FFXX:XXXX */
SET_SOLICITED_NODE_MULTICAST_ADDRESS(multicast_address, ipv6_addr -> nxd_ipv6_address);
_nx_ipv6_multicast_join(ip_ptr, &multicast_address[0], ipv6_addr -> nxd_ipv6_address_attached);
/* Obtain the IP protection again. */
tx_mutex_get(&(ip_ptr -> nx_ip_protection), TX_WAIT_FOREVER);
TX_DISABLE
#ifndef NX_DISABLE_IPV6_DAD
/* If ICMPv6 is enabled, mark the address as tentative, per RFC2462.
If DAD is not enabled, start the address in VALID state. */
if (ip_ptr -> nx_ip_icmpv6_packet_process)
{
/* Start DAD */
ipv6_addr -> nxd_ipv6_address_state = NX_IPV6_ADDR_STATE_TENTATIVE;
ipv6_addr -> nxd_ipv6_address_DupAddrDetectTransmit = NX_IPV6_DAD_TRANSMITS;
/* If trace is enabled, log the start of DAD process. */
NX_TRACE_IN_LINE_INSERT(NXD_TRACE_IPV6_INITIATE_DAD_PROCESS, ip_ptr, 0, 0, 0, NX_TRACE_INTERNAL_EVENTS, 0, 0);
}
else
{
/* If ICMPv6 is not enabled on this interface, the DAD process is eliminated,
so mark the input IP address directly as valid. */
ipv6_addr -> nxd_ipv6_address_state = NX_IPV6_ADDR_STATE_VALID;
ipv6_addr -> nxd_ipv6_address_DupAddrDetectTransmit = 0;
}
#else
/* Set the input address as valid. */
ipv6_addr -> nxd_ipv6_address_state = NX_IPV6_ADDR_STATE_VALID;
#endif
/* Restore interrupts. */
TX_RESTORE
#ifdef NX_ENABLE_IPV6_ADDRESS_CHANGE_NOTIFY
/* Pickup the current notification callback and additional information pointers. */
address_change_notify = ip_ptr -> nx_ipv6_address_change_notify;
#endif /* NX_ENABLE_IPV6_ADDRESS_CHANGE_NOTIFY */
/* Release the protection while the IPv6 address is modified. */
tx_mutex_put(&(ip_ptr -> nx_ip_protection));
#ifdef NX_ENABLE_IPV6_ADDRESS_CHANGE_NOTIFY
/* Is the application configured for notification of address changes and/or
prefix_length change? */
if (address_change_notify)
{
/* Yes, call the application's address change notify function. */
(address_change_notify)(ip_ptr, NX_IPV6_ADDRESS_MANUAL_CONFIG, interface_index, index, &ipv6_addr -> nxd_ipv6_address[0]);
}
#endif /* NX_ENABLE_IPV6_ADDRESS_CHANGE_NOTIFY */
/* Return completion status. */
return(NX_SUCCESS);
#else /* !FEATURE_NX_IPV6 */
NX_PARAMETER_NOT_USED(ip_ptr);
NX_PARAMETER_NOT_USED(interface_index);
NX_PARAMETER_NOT_USED(ip_address);
NX_PARAMETER_NOT_USED(prefix_length);
NX_PARAMETER_NOT_USED(address_index);
return(NX_NOT_SUPPORTED);
#endif /* FEATURE_NX_IPV6 */
}
Details ![]()
Show: from Types: Columns: ![]( "Show Project Names")
![]( "Show Locations")
![]( "Show Referring Symbols")
![]( "Show Scope")
This file uses the notable symbols shown below. Click anywhere in the file to view more details.