Go to the documentation of this file.
1 /**
2  * @file ipv6_misc.h
3  * @brief Helper functions for IPv6
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2023 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
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.2.2
29  **/
31 #ifndef _IPV6_MISC_H
32 #define _IPV6_MISC_H
34 //Dependencies
35 #include "core/net.h"
36 #include "ipv6/ipv6.h"
38 //C++ guard
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
43 //IPv6 related functions
46 error_t ipv6SetAddr(NetInterface *interface, uint_t index,
50 void ipv6AddAddr(NetInterface *interface, const Ipv6Addr *addr,
51  uint32_t validLifetime, uint32_t preferredLifetime);
53 void ipv6RemoveAddr(NetInterface *interface, const Ipv6Addr *addr);
55 void ipv6AddPrefix(NetInterface *interface, const Ipv6Addr *prefix,
56  uint_t length, bool_t onLinkFlag, bool_t autonomousFlag,
57  uint32_t validLifetime, uint32_t preferredLifetime);
59 void ipv6RemovePrefix(NetInterface *interface, const Ipv6Addr *prefix,
60  uint_t length);
62 void ipv6AddDefaultRouter(NetInterface *interface, const Ipv6Addr *addr,
63  uint16_t lifetime, uint8_t preference);
65 void ipv6RemoveDefaultRouter(NetInterface *interface, const Ipv6Addr *addr);
67 void ipv6FlushAddrList(NetInterface *interface);
68 void ipv6FlushPrefixList(NetInterface *interface);
70 void ipv6FlushDnsServerList(NetInterface *interface);
78 bool_t ipv6IsOnLink(NetInterface *interface, const Ipv6Addr *ipAddr);
83 bool_t ipv6CompPrefix(const Ipv6Addr *ipAddr1, const Ipv6Addr *ipAddr2,
84  size_t length);
90  const Ipv6Addr *ipAddr2);
93  Ipv6Addr *solicitedNodeAddr);
99 void ipv6UpdateInStats(NetInterface *interface, const Ipv6Addr *destIpAddr,
100  size_t length);
102 void ipv6UpdateOutStats(NetInterface *interface, const Ipv6Addr *destIpAddr,
103  size_t length);
105 //C++ guard
106 #ifdef __cplusplus
107 }
108 #endif
110 #endif
__start_packed struct @1 Eui64
EUI-64 identifier.
uint8_t length
Definition: coap_common.h:193
IPv6 (Internet Protocol Version 6)
int bool_t
Definition: compiler_port.h:53
MacAddr srcAddr
Definition: ethernet.h:218
void ipv6AddAddr(NetInterface *interface, const Ipv6Addr *addr, uint32_t validLifetime, uint32_t preferredLifetime)
Add a new entry to the list of IPv6 addresses.
Definition: ipv6_misc.c:220
bool_t ipv6IsLocalHostAddr(const Ipv6Addr *ipAddr)
Check whether the specified IPv6 is assigned to the host.
Definition: ipv6_misc.c:1145
uint32_t preferredLifetime
void ipv6AddDefaultRouter(NetInterface *interface, const Ipv6Addr *addr, uint16_t lifetime, uint8_t preference)
Add a new entry to the Default Router List.
Definition: ipv6_misc.c:521
bool_t ipv6IsAnycastAddr(NetInterface *interface, const Ipv6Addr *ipAddr)
Check whether an IPv6 address is an anycast address.
Definition: ipv6_misc.c:1073
error_t ipv6SelectSourceAddr(NetInterface **interface, const Ipv6Addr *destAddr, Ipv6Addr *srcAddr)
IPv6 source address selection.
Definition: ipv6_misc.c:879
error_t ipv6SetAddr(NetInterface *interface, uint_t index, const Ipv6Addr *addr, Ipv6AddrState state, systime_t validLifetime, systime_t preferredLifetime, bool_t permanent)
Set IPv6 address and address state.
Definition: ipv6_misc.c:95
uint_t ipv6GetAddrScope(const Ipv6Addr *ipAddr)
Retrieve the scope of an IPv6 address.
Definition: ipv6_misc.c:1250
uint32_t lifetime
Definition: ndp.h:478
Ipv6Addr prefix
MacAddr destAddr
Definition: ethernet.h:217
__start_packed struct @0 MacAddr
MAC address.
IPv6 address state.
Definition: ipv6.h:166
Error codes.
Definition: error.h:43
error_t ipv6ComputeSolicitedNodeAddr(const Ipv6Addr *ipAddr, Ipv6Addr *solicitedNodeAddr)
Form a solicited-node address from an IPv6 address.
Definition: ipv6_misc.c:1374
bool_t ipv6IsTentativeAddr(NetInterface *interface, const Ipv6Addr *ipAddr)
Check whether an IPv6 address is a tentative address.
Definition: ipv6_misc.c:1109
#define NetInterface
Definition: net.h:36
uint_t ipv6GetMulticastAddrScope(const Ipv6Addr *ipAddr)
Retrieve the scope of an IPv6 multicast address.
Definition: ipv6_misc.c:1297
void ipv6UpdateOutStats(NetInterface *interface, const Ipv6Addr *destIpAddr, size_t length)
Update IPv6 output statistics.
Definition: ipv6_misc.c:1502
bool_t ipv6IsOnLink(NetInterface *interface, const Ipv6Addr *ipAddr)
Check whether an IPv6 address is on-link.
Definition: ipv6_misc.c:1029
void ipv6UpdateInStats(NetInterface *interface, const Ipv6Addr *destIpAddr, size_t length)
Update IPv6 input statistics.
Definition: ipv6_misc.c:1474
Eui64 interfaceId
Definition: ipv6cp.h:69
uint32_t systime_t
System time.
void ipv6FlushPrefixList(NetInterface *interface)
Flush the Prefix List.
Definition: ipv6_misc.c:671
void ipv6RemoveAddr(NetInterface *interface, const Ipv6Addr *addr)
Remove an entry from the list of IPv6 addresses.
Definition: ipv6_misc.c:330
void ipv6GenerateLinkLocalAddr(const Eui64 *interfaceId, Ipv6Addr *ipAddr)
Generate a IPv6 link-local address from an interface identifier.
Definition: ipv6_misc.c:1452
bool_t ipv6CompPrefix(const Ipv6Addr *ipAddr1, const Ipv6Addr *ipAddr2, size_t length)
Compare IPv6 address prefixes.
Definition: ipv6_misc.c:1205
void ipv6FlushDefaultRouterList(NetInterface *interface)
Flush the Default Router List.
Definition: ipv6_misc.c:703
void ipv6FlushAddrList(NetInterface *interface)
Flush the list of IPv6 addresses.
Definition: ipv6_misc.c:640
error_t ipv6CheckSourceAddr(NetInterface *interface, const Ipv6Addr *ipAddr)
Source IPv6 address filtering.
Definition: ipv6_misc.c:750
void ipv6FlushDnsServerList(NetInterface *interface)
Flush the list of DNS servers.
Definition: ipv6_misc.c:735
error_t ipv6MapMulticastAddrToMac(const Ipv6Addr *ipAddr, MacAddr *macAddr)
Map an IPv6 multicast address to a MAC-layer multicast address.
Definition: ipv6_misc.c:1412
uint32_t validLifetime
Ipv4Addr addr
Definition: nbns_common.h:121
error_t ipv6CheckDestAddr(NetInterface *interface, const Ipv6Addr *ipAddr)
Destination IPv6 address filtering.
Definition: ipv6_misc.c:773
unsigned int uint_t
Definition: compiler_port.h:50
TCP/IP stack core.
Ipv6AddrState ipv6GetAddrState(NetInterface *interface, const Ipv6Addr *addr)
Get the state of the specified IPv6 address.
Definition: ipv6_misc.c:55
void ipv6AddPrefix(NetInterface *interface, const Ipv6Addr *prefix, uint_t length, bool_t onLinkFlag, bool_t autonomousFlag, uint32_t validLifetime, uint32_t preferredLifetime)
Add a new entry to the Prefix List.
Definition: ipv6_misc.c:371
uint_t ipv6GetCommonPrefixLength(const Ipv6Addr *ipAddr1, const Ipv6Addr *ipAddr2)
Compute the length of the longest common prefix.
Definition: ipv6_misc.c:1324
__start_packed struct @0 Ipv6Addr
IPv6 network address.
uint8_t ipAddr[4]
Definition: mib_common.h:187
void ipv6RemovePrefix(NetInterface *interface, const Ipv6Addr *prefix, uint_t length)
Remove an entry from the Prefix List.
Definition: ipv6_misc.c:476
void ipv6RemoveDefaultRouter(NetInterface *interface, const Ipv6Addr *addr)
Remove an entry from the Default Router List.
Definition: ipv6_misc.c:586
Ipv4Addr destIpAddr
Definition: ipcp.h:78