ipv6.h
Go to the documentation of this file.
1 /**
2  * @file ipv6.h
3  * @brief IPv6 (Internet Protocol Version 6)
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2022 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneTCP Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.1.4
29  **/
30 
31 #ifndef _IPV6_H
32 #define _IPV6_H
33 
34 //Forward declaration of structures
35 struct _Ipv6Header;
36 #define Ipv6Header struct _Ipv6Header
37 
38 struct _Ipv6FragmentHeader;
39 #define Ipv6FragmentHeader struct _Ipv6FragmentHeader
40 
41 struct _Ipv6PseudoHeader;
42 #define Ipv6PseudoHeader struct _Ipv6PseudoHeader
43 
44 //Dependencies
45 #include <string.h>
46 #include "core/net.h"
47 #include "core/ethernet.h"
48 #include "ipv6/ipv6_frag.h"
49 
50 //IPv6 support
51 #ifndef IPV6_SUPPORT
52  #define IPV6_SUPPORT DISABLED
53 #elif (IPV6_SUPPORT != ENABLED && IPV6_SUPPORT != DISABLED)
54  #error IPV6_SUPPORT parameter is not valid
55 #endif
56 
57 //Default IPv6 Hop Limit field
58 #ifndef IPV6_DEFAULT_HOP_LIMIT
59  #define IPV6_DEFAULT_HOP_LIMIT 64
60 #elif (IPV6_DEFAULT_HOP_LIMIT < 1)
61  #error IPV6_DEFAULT_HOP_LIMIT parameter is not valid
62 #endif
63 
64 //Maximum number of IPv6 unicast addresses
65 #ifndef IPV6_ADDR_LIST_SIZE
66  #define IPV6_ADDR_LIST_SIZE 3
67 #elif (IPV6_ADDR_LIST_SIZE < 2)
68  #error IPV6_ADDR_LIST_SIZE parameter is not valid
69 #endif
70 
71 //Maximum number of IPv6 anycast addresses
72 #ifndef IPV6_ANYCAST_ADDR_LIST_SIZE
73  #define IPV6_ANYCAST_ADDR_LIST_SIZE 1
74 #elif (IPV6_ANYCAST_ADDR_LIST_SIZE < 1)
75  #error IPV6_ANYCAST_ADDR_LIST_SIZE parameter is not valid
76 #endif
77 
78 //Size of the prefix list
79 #ifndef IPV6_PREFIX_LIST_SIZE
80  #define IPV6_PREFIX_LIST_SIZE 2
81 #elif (IPV6_PREFIX_LIST_SIZE < 1)
82  #error IPV6_PREFIX_LIST_SIZE parameter is not valid
83 #endif
84 
85 //Maximum number number of default routers
86 #ifndef IPV6_ROUTER_LIST_SIZE
87  #define IPV6_ROUTER_LIST_SIZE 2
88 #elif (IPV6_ROUTER_LIST_SIZE < 1)
89  #error IPV6_ROUTER_LIST_SIZE parameter is not valid
90 #endif
91 
92 //Maximum number of DNS servers
93 #ifndef IPV6_DNS_SERVER_LIST_SIZE
94  #define IPV6_DNS_SERVER_LIST_SIZE 2
95 #elif (IPV6_DNS_SERVER_LIST_SIZE < 1)
96  #error IPV6_DNS_SERVER_LIST_SIZE parameter is not valid
97 #endif
98 
99 //Size of the IPv6 multicast filter
100 #ifndef IPV6_MULTICAST_FILTER_SIZE
101  #define IPV6_MULTICAST_FILTER_SIZE 8
102 #elif (IPV6_MULTICAST_FILTER_SIZE < 1)
103  #error IPV6_MULTICAST_FILTER_SIZE parameter is not valid
104 #endif
105 
106 //Version number for IPv6
107 #define IPV6_VERSION 6
108 //Minimum MTU that routers and physical links are required to handle
109 #define IPV6_DEFAULT_MTU 1280
110 
111 //Macro used for defining an IPv6 address
112 #define IPV6_ADDR(a, b, c, d, e, f, g, h) {{{ \
113  MSB(a), LSB(a), MSB(b), LSB(b), MSB(c), LSB(c), MSB(d), LSB(d), \
114  MSB(e), LSB(e), MSB(f), LSB(f), MSB(g), LSB(g), MSB(h), LSB(h)}}}
115 
116 //Copy IPv6 address
117 #define ipv6CopyAddr(destIpAddr, srcIpAddr) \
118  osMemcpy(destIpAddr, srcIpAddr, sizeof(Ipv6Addr))
119 
120 //Compare IPv6 addresses
121 #define ipv6CompAddr(ipAddr1, ipAddr2) \
122  (!osMemcmp(ipAddr1, ipAddr2, sizeof(Ipv6Addr)))
123 
124 //Determine whether an IPv6 address is a link-local unicast address
125 #define ipv6IsLinkLocalUnicastAddr(ipAddr) \
126  ((ipAddr)->b[0] == 0xFE && ((ipAddr)->b[1] & 0xC0) == 0x80)
127 
128 //Determine whether an IPv6 address is a site-local unicast address
129 #define ipv6IsSiteLocalUnicastAddr(ipAddr) \
130  ((ipAddr)->b[0] == 0xFE && ((ipAddr)->b[1] & 0xC0) == 0xC0)
131 
132 //Determine whether an IPv6 address is a multicast address
133 #define ipv6IsMulticastAddr(ipAddr) \
134  ((ipAddr)->b[0] == 0xFF)
135 
136 //Determine whether an IPv6 address is a solicited-node address
137 #define ipv6IsSolicitedNodeAddr(ipAddr) \
138  ipv6CompPrefix(ipAddr, &IPV6_SOLICITED_NODE_ADDR_PREFIX, 104)
139 
140 //C++ guard
141 #ifdef __cplusplus
142 extern "C" {
143 #endif
144 
145 
146 /**
147  * @brief IPv6 address scopes
148  **/
149 
150 typedef enum
151 {
159 
160 
161 /**
162  * @brief IPv6 address state
163  **/
164 
165 typedef enum
166 {
167  IPV6_ADDR_STATE_INVALID = 0, ///<An address that is not assigned to any interface
168  IPV6_ADDR_STATE_TENTATIVE = 1, ///<An address whose uniqueness on a link is being verified
169  IPV6_ADDR_STATE_PREFERRED = 2, ///<An address assigned to an interface whose use is unrestricted
170  IPV6_ADDR_STATE_DEPRECATED = 3 ///<An address assigned to an interface whose use is discouraged
172 
173 
174 /**
175  * @brief IPv6 Next Header types
176  **/
177 
178 typedef enum
179 {
191 
192 
193 /**
194  * @brief IPv6 fragment offset field
195  **/
196 
197 typedef enum
198 {
200  IPV6_FLAG_RES1 = 0x0004,
201  IPV6_FLAG_RES2 = 0x0002,
202  IPV6_FLAG_M = 0x0001
204 
205 
206 /**
207  * @brief IPv6 option types
208  **/
209 
210 typedef enum
211 {
214  IPV6_OPTION_TYPE_PADN = 0x01
216 
217 
218 /**
219  * @brief Actions to be taken for unrecognized options
220  **/
221 
222 typedef enum
223 {
230 
231 
232 //CodeWarrior or Win32 compiler?
233 #if defined(__CWCC__) || defined(_WIN32)
234  #pragma pack(push, 1)
235 #endif
236 
237 
238 /**
239  * @brief IPv6 network address
240  **/
241 
242 typedef __start_packed struct
243 {
244  __start_packed union
245  {
246  uint8_t b[16];
247  uint16_t w[8];
248  uint32_t dw[4];
249  };
251 
252 
253 /**
254  * @brief IPv6 header
255  **/
256 
257 __start_packed struct _Ipv6Header
258 {
259 #if defined(_CPU_BIG_ENDIAN) && !defined(__ICCRX__)
260  uint8_t version : 4; //0
261  uint8_t trafficClassH : 4;
262  uint8_t trafficClassL : 4; //1
263  uint8_t flowLabelH : 4;
264 #else
265  uint8_t trafficClassH : 4; //0
266  uint8_t version : 4;
267  uint8_t flowLabelH : 4; //1
268  uint8_t trafficClassL : 4;
269 #endif
270  uint16_t flowLabelL; //2-3
271  uint16_t payloadLen; //4-5
272  uint8_t nextHeader; //6
273  uint8_t hopLimit; //7
276  uint8_t payload[]; //40
278 
279 
280 /**
281  * @brief IPv6 Hop-by-Hop Options header
282  **/
283 
284 typedef __start_packed struct
285 {
286  uint8_t nextHeader; //0
287  uint8_t hdrExtLen; //1
288  uint8_t options[]; //2
290 
291 
292 /**
293  * @brief IPv6 Destination Options header
294  **/
295 
296 typedef __start_packed struct
297 {
298  uint8_t nextHeader; //0
299  uint8_t hdrExtLen; //1
300  uint8_t options[]; //2
302 
303 
304 /**
305  * @brief IPv6 Type 0 Routing header
306  **/
307 
308 typedef __start_packed struct
309 {
310  uint8_t nextHeader; //0
311  uint8_t hdrExtLen; //1
312  uint8_t routingType; //2
313  uint8_t segmentsLeft; //3
314  uint32_t reserved; //4-7
317 
318 
319 /**
320  * @brief IPv6 Fragment header
321  **/
322 
323 __start_packed struct _Ipv6FragmentHeader
324 {
325  uint8_t nextHeader; //0
326  uint8_t reserved; //1
327  uint16_t fragmentOffset; //2-3
328  uint32_t identification; //4-7
329 } __end_packed;
330 
331 
332 /**
333  * @brief IPv6 Authentication header
334  **/
335 
336 typedef __start_packed struct
337 {
338  uint8_t nextHeader; //0
339  uint8_t payloadLen; //1
340  uint16_t reserved; //2-3
341  uint32_t securityParamIndex; //4-7
342  uint32_t sequenceNumber; //8-11
343  uint8_t authData[]; //12
345 
346 
347 /**
348  * @brief IPv6 Encapsulating Security Payload header
349  **/
350 
351 typedef __start_packed struct
352 {
353  uint32_t securityParamIndex; //0-3
354  uint32_t sequenceNumber; //4-7
355  uint8_t payloadData[]; //8
357 
358 
359 /**
360  * @brief IPv6 option
361  **/
362 
363 typedef __start_packed struct
364 {
365  uint8_t type; //0
366  uint8_t length; //1
367  uint8_t data[]; //2
369 
370 
371 /**
372  * @brief IPv6 pseudo header
373  **/
374 
375 __start_packed struct _Ipv6PseudoHeader
376 {
379  uint32_t length; //32-35
380  uint8_t reserved[3]; //36-38
381  uint8_t nextHeader; //39
382 } __end_packed;
383 
384 
385 //CodeWarrior or Win32 compiler?
386 #if defined(__CWCC__) || defined(_WIN32)
387  #pragma pack(pop)
388 #endif
389 
390 
391 /**
392  * @brief IPv6 address entry
393  **/
394 
395 typedef struct
396 {
397  Ipv6Addr addr; ///<IPv6 address
398  Ipv6AddrState state; ///<IPv6 address state
399  bool_t duplicate; ///<The address is a duplicate
400  systime_t validLifetime; ///<Valid lifetime
401  systime_t preferredLifetime; ///<Preferred lifetime
402  bool_t permanent; ///<Permanently assigned address
403  systime_t timestamp; ///<Timestamp to manage entry lifetime
404  systime_t dadTimeout; ///<Timeout value for Duplicate Address Detection
405  uint_t dadRetransmitCount; ///<Retransmission counter for Duplicate Address Detection
406 } Ipv6AddrEntry;
407 
408 
409 /**
410  * @brief Prefix list entry
411  **/
412 
413 typedef struct
414 {
415  Ipv6Addr prefix; ///<IPv6 prefix information
416  uint8_t prefixLen; ///<IPv6 prefix length
417  bool_t onLinkFlag; ///<On-link flag
418  bool_t autonomousFlag; ///<Autonomous flag
419  systime_t validLifetime; ///<Valid lifetime
420  systime_t preferredLifetime; ///<Preferred lifetime
421  bool_t permanent; ///<Permanently assigned prefix
422  systime_t timestamp; ///<Timestamp to manage entry lifetime
424 
425 
426 /**
427  * @brief Default router list entry
428  **/
429 
430 typedef struct
431 {
432  Ipv6Addr addr; ///<Router address
433  systime_t lifetime; ///<Router lifetime
434  uint8_t preference; ///<Preference value
435  bool_t permanent; ///<Permanently assigned router
436  systime_t timestamp; ///<Timestamp to manage entry lifetime
438 
439 
440 /**
441  * @brief IPv6 multicast filter entry
442  **/
443 
444 typedef struct
445 {
446  Ipv6Addr addr; ///<Multicast address
447  uint_t refCount; ///<Reference count for the current entry
448  uint_t state; ///<MLD node state
449  bool_t flag; ///<MLD flag
450  systime_t timer; ///<Delay timer
452 
453 
454 /**
455  * @brief IPv6 context
456  **/
457 
458 typedef struct
459 {
460  size_t linkMtu; ///<Maximum transmission unit
461  bool_t isRouter; ///<A flag indicating whether routing is enabled on this interface
462  uint8_t curHopLimit; ///<Default value for the Hop Limit field
463  bool_t enableMulticastEchoReq; ///<Support for multicast ICMPv6 Echo Request messages
464  Ipv6AddrEntry addrList[IPV6_ADDR_LIST_SIZE]; ///<IPv6 unicast address list
465  Ipv6Addr anycastAddrList[IPV6_ANYCAST_ADDR_LIST_SIZE]; ///<IPv6 anycast address list
466  Ipv6PrefixEntry prefixList[IPV6_PREFIX_LIST_SIZE]; ///<Prefix list
467  Ipv6RouterEntry routerList[IPV6_ROUTER_LIST_SIZE]; ///<Default router list
468  Ipv6Addr dnsServerList[IPV6_DNS_SERVER_LIST_SIZE]; ///<DNS servers
469  Ipv6FilterEntry multicastFilter[IPV6_MULTICAST_FILTER_SIZE]; ///<Multicast filter table
470 #if (IPV6_FRAG_SUPPORT == ENABLED)
471  uint32_t identification; ///<IPv6 fragment identification field
472  Ipv6FragDesc fragQueue[IPV6_MAX_FRAG_DATAGRAMS]; ///<IPv6 fragment reassembly queue
473 #endif
474 } Ipv6Context;
475 
476 
477 //IPv6 related constants
478 extern const Ipv6Addr IPV6_UNSPECIFIED_ADDR;
479 extern const Ipv6Addr IPV6_LOOPBACK_ADDR;
484 
485 //IPv6 related functions
486 error_t ipv6Init(NetInterface *interface);
487 
488 error_t ipv6SetMtu(NetInterface *interface, size_t mtu);
489 error_t ipv6GetMtu(NetInterface *interface, size_t *mtu);
490 
494 
495 error_t ipv6SetGlobalAddr(NetInterface *interface, uint_t index, const Ipv6Addr *addr);
498 
499 error_t ipv6SetAnycastAddr(NetInterface *interface, uint_t index, const Ipv6Addr *addr);
501 
503  uint_t index, const Ipv6Addr *prefix, uint_t length);
504 
506  uint_t index, Ipv6Addr *prefix, uint_t *length);
507 
508 error_t ipv6SetDefaultRouter(NetInterface *interface, uint_t index, const Ipv6Addr *addr);
510 
511 error_t ipv6SetDnsServer(NetInterface *interface, uint_t index, const Ipv6Addr *addr);
513 
514 void ipv6LinkChangeEvent(NetInterface *interface);
515 
517  size_t ipPacketOffset, NetRxAncillary *ancillary);
518 
520  size_t ipPacketOffset, size_t *headerOffset, size_t *nextHeaderOffset);
521 
523  size_t ipPacketOffset, size_t *headerOffset, size_t *nextHeaderOffset);
524 
526  size_t ipPacketOffset, size_t *headerOffset, size_t *nextHeaderOffset);
527 
529  size_t ipPacketOffset, size_t *headerOffset, size_t *nextHeaderOffset);
530 
532  size_t ipPacketOffset, size_t *headerOffset, size_t *nextHeaderOffset);
533 
535  size_t ipPacketOffset, size_t optionOffset, size_t optionLen);
536 
537 error_t ipv6SendDatagram(NetInterface *interface, Ipv6PseudoHeader *pseudoHeader,
538  NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary);
539 
540 error_t ipv6SendPacket(NetInterface *interface, Ipv6PseudoHeader *pseudoHeader,
541  uint32_t fragId, size_t fragOffset, NetBuffer *buffer, size_t offset,
542  NetTxAncillary *ancillary);
543 
546 
549 
550 void ipv6DumpHeader(const Ipv6Header *ipHeader);
551 
552 //C++ guard
553 #ifdef __cplusplus
554 }
555 #endif
556 
557 #endif
unsigned int uint_t
Definition: compiler_port.h:45
char char_t
Definition: compiler_port.h:43
int bool_t
Definition: compiler_port.h:48
Ipv6Addr prefix
uint8_t fragOffset[3]
Definition: dtls_misc.h:189
error_t
Error codes.
Definition: error.h:43
Ethernet.
uint32_t mtu
Definition: icmpv6.h:173
Ipv4Addr groupAddr
Definition: igmp_common.h:169
__start_packed struct @79 Ipv6DestOptHeader
IPv6 Destination Options header.
error_t ipv6SendDatagram(NetInterface *interface, Ipv6PseudoHeader *pseudoHeader, NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
Send an IPv6 datagram.
Definition: ipv6.c:1637
__start_packed struct @80 Ipv6RoutingHeader
IPv6 Type 0 Routing header.
const Ipv6Addr IPV6_SOLICITED_NODE_ADDR_PREFIX
Definition: ipv6.c:87
error_t ipv6GetAnycastAddr(NetInterface *interface, uint_t index, Ipv6Addr *addr)
Retrieve anycast address.
Definition: ipv6.c:520
error_t ipv6GetGlobalAddr(NetInterface *interface, uint_t index, Ipv6Addr *addr)
Retrieve global address.
Definition: ipv6.c:364
error_t ipv6SetPrefix(NetInterface *interface, uint_t index, const Ipv6Addr *prefix, uint_t length)
Configure IPv6 prefix.
Definition: ipv6.c:555
error_t ipv6ParseDestOptHeader(NetInterface *interface, const NetBuffer *ipPacket, size_t ipPacketOffset, size_t *headerOffset, size_t *nextHeaderOffset)
Parse Destination Options header.
Definition: ipv6.c:1337
uint16_t w[8]
Definition: ipv6.h:247
Ipv6Addr address[]
Definition: ipv6.h:315
uint8_t type
Definition: ipv6.h:365
error_t ipv6ParseEspHeader(NetInterface *interface, const NetBuffer *ipPacket, size_t ipPacketOffset, size_t *headerOffset, size_t *nextHeaderOffset)
Parse Encapsulating Security Payload header.
Definition: ipv6.c:1491
error_t ipv6SendPacket(NetInterface *interface, Ipv6PseudoHeader *pseudoHeader, uint32_t fragId, size_t fragOffset, NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
Send an IPv6 packet.
Definition: ipv6.c:1706
__start_packed struct @83 Ipv6Option
IPv6 option.
uint32_t sequenceNumber
Definition: ipv6.h:342
error_t ipv6GetPrefix(NetInterface *interface, uint_t index, Ipv6Addr *prefix, uint_t *length)
Retrieve IPv6 prefix.
Definition: ipv6.c:619
void ipv6ProcessPacket(NetInterface *interface, NetBuffer *ipPacket, size_t ipPacketOffset, NetRxAncillary *ancillary)
Incoming IPv6 packet processing.
Definition: ipv6.c:940
uint32_t dw[4]
Definition: ipv6.h:248
error_t ipv6SetGlobalAddr(NetInterface *interface, uint_t index, const Ipv6Addr *addr)
Assign global address.
Definition: ipv6.c:325
uint8_t payloadData[]
Definition: ipv6.h:355
uint8_t hdrExtLen
Definition: ipv6.h:287
__start_packed struct @82 Ipv6EspHeader
IPv6 Encapsulating Security Payload header.
error_t ipv6Init(NetInterface *interface)
IPv6 related initialization.
Definition: ipv6.c:97
Ipv6NextHeaderType
IPv6 Next Header types.
Definition: ipv6.h:179
@ IPV6_ROUTING_HEADER
Definition: ipv6.h:183
@ IPV6_ICMPV6_HEADER
Definition: ipv6.h:187
@ IPV6_UDP_HEADER
Definition: ipv6.h:182
@ IPV6_DEST_OPT_HEADER
Definition: ipv6.h:189
@ IPV6_HOP_BY_HOP_OPT_HEADER
Definition: ipv6.h:180
@ IPV6_TCP_HEADER
Definition: ipv6.h:181
@ IPV6_ESP_HEADER
Definition: ipv6.h:185
@ IPV6_FRAGMENT_HEADER
Definition: ipv6.h:184
@ IPV6_NO_NEXT_HEADER
Definition: ipv6.h:188
@ IPV6_AH_HEADER
Definition: ipv6.h:186
uint32_t reserved
Definition: ipv6.h:314
uint8_t data[]
Definition: ipv6.h:367
error_t ipv6GetMtu(NetInterface *interface, size_t *mtu)
Retrieve the MTU for the specified interface.
Definition: ipv6.c:194
#define Ipv6PseudoHeader
Definition: ipv6.h:42
__start_packed struct @78 Ipv6HopByHopOptHeader
IPv6 Hop-by-Hop Options header.
Ipv6AddrState ipv6GetGlobalAddrState(NetInterface *interface, uint_t index)
Get the state of the specified global address.
Definition: ipv6.c:415
uint8_t routingType
Definition: ipv6.h:312
uint8_t nextHeader
Definition: ipv6.h:286
#define IPV6_MULTICAST_FILTER_SIZE
Definition: ipv6.h:101
__start_packed struct @81 Ipv6AuthHeader
IPv6 Authentication header.
uint8_t options[]
Definition: ipv6.h:288
uint8_t authData[]
Definition: ipv6.h:343
error_t ipv6GetDefaultRouter(NetInterface *interface, uint_t index, Ipv6Addr *addr)
Retrieve default router.
Definition: ipv6.c:731
#define IPV6_DNS_SERVER_LIST_SIZE
Definition: ipv6.h:94
error_t ipv6LeaveMulticastGroup(NetInterface *interface, const Ipv6Addr *groupAddr)
Leave an IPv6 multicast group.
Definition: ipv6.c:2112
error_t ipv6StringToAddr(const char_t *str, Ipv6Addr *ipAddr)
Convert a string representation of an IPv6 address to a binary IPv6 address.
Definition: ipv6.c:2188
Ipv6AddrScope
IPv6 address scopes.
Definition: ipv6.h:151
@ IPV6_ADDR_SCOPE_LINK_LOCAL
Definition: ipv6.h:153
@ IPV6_ADDR_SCOPE_INTERFACE_LOCAL
Definition: ipv6.h:152
@ IPV6_ADDR_SCOPE_ORGANIZATION_LOCAL
Definition: ipv6.h:156
@ IPV6_ADDR_SCOPE_ADMIN_LOCAL
Definition: ipv6.h:154
@ IPV6_ADDR_SCOPE_SITE_LOCAL
Definition: ipv6.h:155
@ IPV6_ADDR_SCOPE_GLOBAL
Definition: ipv6.h:157
const Ipv6Addr IPV6_LINK_LOCAL_ALL_NODES_ADDR
Definition: ipv6.c:75
Ipv6OptionType
IPv6 option types.
Definition: ipv6.h:211
@ IPV6_OPTION_TYPE_PAD1
Definition: ipv6.h:213
@ IPV6_OPTION_TYPE_MASK
Definition: ipv6.h:212
@ IPV6_OPTION_TYPE_PADN
Definition: ipv6.h:214
Ipv6Actions
Actions to be taken for unrecognized options.
Definition: ipv6.h:223
@ IPV6_ACTION_DISCARD_PACKET
Definition: ipv6.h:226
@ IPV6_ACTION_SEND_ICMP_ERROR_UNI
Definition: ipv6.h:228
@ IPV6_ACTION_SKIP_OPTION
Definition: ipv6.h:225
@ IPV6_ACTION_SEND_ICMP_ERROR_ALL
Definition: ipv6.h:227
@ IPV6_ACTION_MASK
Definition: ipv6.h:224
#define IPV6_PREFIX_LIST_SIZE
Definition: ipv6.h:80
error_t ipv6SetLinkLocalAddr(NetInterface *interface, const Ipv6Addr *addr)
Assign link-local address.
Definition: ipv6.c:219
char_t * ipv6AddrToString(const Ipv6Addr *ipAddr, char_t *str)
Convert a binary IPv6 address to a string representation.
Definition: ipv6.c:2334
error_t ipv6ParseRoutingHeader(NetInterface *interface, const NetBuffer *ipPacket, size_t ipPacketOffset, size_t *headerOffset, size_t *nextHeaderOffset)
Parse Routing header.
Definition: ipv6.c:1400
const Ipv6Addr IPV6_LINK_LOCAL_ADDR_PREFIX
Definition: ipv6.c:83
error_t ipv6ParseOptions(NetInterface *interface, const NetBuffer *ipPacket, size_t ipPacketOffset, size_t optionOffset, size_t optionLen)
Parse IPv6 options.
Definition: ipv6.c:1511
const Ipv6Addr IPV6_UNSPECIFIED_ADDR
Definition: ipv6.c:67
const Ipv6Addr IPV6_LINK_LOCAL_ALL_ROUTERS_ADDR
Definition: ipv6.c:79
#define IPV6_ADDR_LIST_SIZE
Definition: ipv6.h:66
error_t ipv6SetMtu(NetInterface *interface, size_t mtu)
Change the MTU of a network interface.
Definition: ipv6.c:149
error_t ipv6SetDefaultRouter(NetInterface *interface, uint_t index, const Ipv6Addr *addr)
Configure default router.
Definition: ipv6.c:674
#define IPV6_ANYCAST_ADDR_LIST_SIZE
Definition: ipv6.h:73
uint8_t length
Definition: ipv6.h:366
uint8_t b[16]
Definition: ipv6.h:246
error_t ipv6ParseAuthHeader(NetInterface *interface, const NetBuffer *ipPacket, size_t ipPacketOffset, size_t *headerOffset, size_t *nextHeaderOffset)
Parse Authentication header.
Definition: ipv6.c:1471
uint8_t segmentsLeft
Definition: ipv6.h:313
error_t ipv6JoinMulticastGroup(NetInterface *interface, const Ipv6Addr *groupAddr)
Join an IPv6 multicast group.
Definition: ipv6.c:2002
Ipv6FragmentOffset
IPv6 fragment offset field.
Definition: ipv6.h:198
@ IPV6_FLAG_RES2
Definition: ipv6.h:201
@ IPV6_OFFSET_MASK
Definition: ipv6.h:199
@ IPV6_FLAG_RES1
Definition: ipv6.h:200
@ IPV6_FLAG_M
Definition: ipv6.h:202
error_t ipv6SetDnsServer(NetInterface *interface, uint_t index, const Ipv6Addr *addr)
Configure DNS server.
Definition: ipv6.c:782
void ipv6LinkChangeEvent(NetInterface *interface)
Callback function for link change event.
Definition: ipv6.c:848
Ipv6AddrState
IPv6 address state.
Definition: ipv6.h:166
@ IPV6_ADDR_STATE_DEPRECATED
An address assigned to an interface whose use is discouraged.
Definition: ipv6.h:170
@ IPV6_ADDR_STATE_PREFERRED
An address assigned to an interface whose use is unrestricted.
Definition: ipv6.h:169
@ IPV6_ADDR_STATE_INVALID
An address that is not assigned to any interface.
Definition: ipv6.h:167
@ IPV6_ADDR_STATE_TENTATIVE
An address whose uniqueness on a link is being verified.
Definition: ipv6.h:168
const Ipv6Addr IPV6_LOOPBACK_ADDR
Definition: ipv6.c:71
void ipv6DumpHeader(const Ipv6Header *ipHeader)
Dump IPv6 header for debugging purpose.
Definition: ipv6.c:2403
#define Ipv6Header
Definition: ipv6.h:36
error_t ipv6GetLinkLocalAddr(NetInterface *interface, Ipv6Addr *addr)
Retrieve link-local address.
Definition: ipv6.c:257
error_t ipv6ParseHopByHopOptHeader(NetInterface *interface, const NetBuffer *ipPacket, size_t ipPacketOffset, size_t *headerOffset, size_t *nextHeaderOffset)
Parse Hop-by-Hop Options header.
Definition: ipv6.c:1259
error_t ipv6GetDnsServer(NetInterface *interface, uint_t index, Ipv6Addr *addr)
Retrieve DNS server.
Definition: ipv6.c:816
Ipv6AddrState ipv6GetLinkLocalAddrState(NetInterface *interface)
Get the state of the link-local address.
Definition: ipv6.c:298
uint8_t payloadLen
Definition: ipv6.h:339
__start_packed struct _Ipv6Header __end_packed
error_t ipv6SetAnycastAddr(NetInterface *interface, uint_t index, const Ipv6Addr *addr)
Assign anycast address.
Definition: ipv6.c:442
#define IPV6_ROUTER_LIST_SIZE
Definition: ipv6.h:87
__start_packed struct @77 Ipv6Addr
IPv6 network address.
uint32_t securityParamIndex
Definition: ipv6.h:341
IPv6 fragmentation and reassembly.
#define IPV6_MAX_FRAG_DATAGRAMS
Definition: ipv6_frag.h:62
uint8_t ipAddr[4]
Definition: mib_common.h:187
Ipv4Addr addr
Definition: nbns_common.h:121
uint8_t ipPacket[]
Definition: ndp.h:429
TCP/IP stack core.
#define NetInterface
Definition: net.h:36
#define NetRxAncillary
Definition: net_misc.h:40
#define NetTxAncillary
Definition: net_misc.h:36
uint32_t systime_t
System time.
IPv6 Fragment header.
Definition: ipv6.h:324
uint32_t identification
Definition: ipv6.h:328
uint8_t nextHeader
Definition: ipv6.h:325
uint8_t reserved
Definition: ipv6.h:326
uint16_t fragmentOffset
Definition: ipv6.h:327
IPv6 header.
Definition: ipv6.h:258
uint8_t flowLabelH
Definition: ipv6.h:267
uint8_t hopLimit
Definition: ipv6.h:273
uint16_t payloadLen
Definition: ipv6.h:271
uint16_t flowLabelL
Definition: ipv6.h:270
uint8_t trafficClassL
Definition: ipv6.h:268
uint8_t payload[]
Definition: ipv6.h:276
uint8_t nextHeader
Definition: ipv6.h:272
uint8_t trafficClassH
Definition: ipv6.h:265
Ipv6Addr destAddr
Definition: ipv6.h:275
uint8_t version
Definition: ipv6.h:266
Ipv6Addr srcAddr
Definition: ipv6.h:274
IPv6 pseudo header.
Definition: ipv6.h:376
uint8_t reserved[3]
Definition: ipv6.h:380
uint8_t nextHeader
Definition: ipv6.h:381
Ipv6Addr destAddr
Definition: ipv6.h:378
Ipv6Addr srcAddr
Definition: ipv6.h:377
uint32_t length
Definition: ipv6.h:379
IPv6 address entry.
Definition: ipv6.h:396
systime_t timestamp
Timestamp to manage entry lifetime.
Definition: ipv6.h:403
bool_t permanent
Permanently assigned address.
Definition: ipv6.h:402
bool_t duplicate
The address is a duplicate.
Definition: ipv6.h:399
Ipv6AddrState state
IPv6 address state.
Definition: ipv6.h:398
systime_t preferredLifetime
Preferred lifetime.
Definition: ipv6.h:401
systime_t validLifetime
Valid lifetime.
Definition: ipv6.h:400
uint_t dadRetransmitCount
Retransmission counter for Duplicate Address Detection.
Definition: ipv6.h:405
systime_t dadTimeout
Timeout value for Duplicate Address Detection.
Definition: ipv6.h:404
Ipv6Addr addr
IPv6 address.
Definition: ipv6.h:397
IPv6 context.
Definition: ipv6.h:459
bool_t isRouter
A flag indicating whether routing is enabled on this interface.
Definition: ipv6.h:461
uint32_t identification
IPv6 fragment identification field.
Definition: ipv6.h:471
uint8_t curHopLimit
Default value for the Hop Limit field.
Definition: ipv6.h:462
bool_t enableMulticastEchoReq
Support for multicast ICMPv6 Echo Request messages.
Definition: ipv6.h:463
size_t linkMtu
Maximum transmission unit.
Definition: ipv6.h:460
IPv6 multicast filter entry.
Definition: ipv6.h:445
uint_t state
MLD node state.
Definition: ipv6.h:448
bool_t flag
MLD flag.
Definition: ipv6.h:449
systime_t timer
Delay timer.
Definition: ipv6.h:450
uint_t refCount
Reference count for the current entry.
Definition: ipv6.h:447
Ipv6Addr addr
Multicast address.
Definition: ipv6.h:446
Fragmented packet descriptor.
Definition: ipv6_frag.h:131
Prefix list entry.
Definition: ipv6.h:414
systime_t timestamp
Timestamp to manage entry lifetime.
Definition: ipv6.h:422
bool_t permanent
Permanently assigned prefix.
Definition: ipv6.h:421
systime_t preferredLifetime
Preferred lifetime.
Definition: ipv6.h:420
systime_t validLifetime
Valid lifetime.
Definition: ipv6.h:419
Ipv6Addr prefix
IPv6 prefix information.
Definition: ipv6.h:415
bool_t onLinkFlag
On-link flag.
Definition: ipv6.h:417
uint8_t prefixLen
IPv6 prefix length.
Definition: ipv6.h:416
bool_t autonomousFlag
Autonomous flag.
Definition: ipv6.h:418
Default router list entry.
Definition: ipv6.h:431
systime_t timestamp
Timestamp to manage entry lifetime.
Definition: ipv6.h:436
bool_t permanent
Permanently assigned router.
Definition: ipv6.h:435
systime_t lifetime
Router lifetime.
Definition: ipv6.h:433
uint8_t preference
Preference value.
Definition: ipv6.h:434
Ipv6Addr addr
Router address.
Definition: ipv6.h:432
Structure describing a buffer that spans multiple chunks.
Definition: net_mem.h:89