STM32F769IDiscovery  1.00
uDANTE Audio Networking with STM32F7 DISCO board
ip6_addr.h
Go to the documentation of this file.
1 
7 /*
8  * Copyright (c) 2010 Inico Technologies Ltd.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without modification,
12  * are permitted provided that the following conditions are met:
13  *
14  * 1. Redistributions of source code must retain the above copyright notice,
15  * this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright notice,
17  * this list of conditions and the following disclaimer in the documentation
18  * and/or other materials provided with the distribution.
19  * 3. The name of the author may not be used to endorse or promote products
20  * derived from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
23  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
24  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
25  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
27  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
30  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
31  * OF SUCH DAMAGE.
32  *
33  * This file is part of the lwIP TCP/IP stack.
34  *
35  * Author: Ivan Delamer <delamer@inicotech.com>
36  *
37  * Structs and macros for handling IPv6 addresses.
38  *
39  * Please coordinate changes and requests with Ivan Delamer
40  * <delamer@inicotech.com>
41  */
42 #ifndef LWIP_HDR_IP6_ADDR_H
43 #define LWIP_HDR_IP6_ADDR_H
44 
45 #include "lwip/opt.h"
46 
47 #if LWIP_IPV6 /* don't build if not configured for use in lwipopts.h */
48 
49 
50 #ifdef __cplusplus
51 extern "C" {
52 #endif
53 
54 
55 /* This is the aligned version of ip6_addr_t,
56  used as local variable, on the stack, etc. */
57 struct ip6_addr {
58  u32_t addr[4];
59 };
60 
61 /* This is the packed version of ip6_addr_t,
62  used in network headers that are itself packed */
63 #ifdef PACK_STRUCT_USE_INCLUDES
64 # include "arch/bpstruct.h"
65 #endif
66 PACK_STRUCT_BEGIN
67 struct ip6_addr_packed {
68  PACK_STRUCT_FIELD(u32_t addr[4]);
69 } PACK_STRUCT_STRUCT;
70 PACK_STRUCT_END
71 #ifdef PACK_STRUCT_USE_INCLUDES
72 # include "arch/epstruct.h"
73 #endif
74 
75 typedef struct ip6_addr ip6_addr_t;
76 typedef struct ip6_addr_packed ip6_addr_p_t;
77 
78 
79 #if BYTE_ORDER == BIG_ENDIAN
80 
81 #define IP6_ADDR_PART(ip6addr, index, a,b,c,d) \
82  (ip6addr)->addr[index] = ((u32_t)((a) & 0xff) << 24) | \
83  ((u32_t)((b) & 0xff) << 16) | \
84  ((u32_t)((c) & 0xff) << 8) | \
85  (u32_t)((d) & 0xff)
86 #else
87 
89 #define IP6_ADDR_PART(ip6addr, index, a,b,c,d) \
90  (ip6addr)->addr[index] = ((u32_t)((d) & 0xff) << 24) | \
91  ((u32_t)((c) & 0xff) << 16) | \
92  ((u32_t)((b) & 0xff) << 8) | \
93  (u32_t)((a) & 0xff)
94 #endif
95 
98 #define IP6_ADDR(ip6addr, idx0, idx1, idx2, idx3) do { \
99  (ip6addr)->addr[0] = idx0; \
100  (ip6addr)->addr[1] = idx1; \
101  (ip6addr)->addr[2] = idx2; \
102  (ip6addr)->addr[3] = idx3; } while(0)
103 
105 #define IP6_ADDR_BLOCK1(ip6addr) ((u16_t)(htonl((ip6addr)->addr[0]) >> 16) & 0xffff)
106 #define IP6_ADDR_BLOCK2(ip6addr) ((u16_t)(htonl((ip6addr)->addr[0])) & 0xffff)
107 #define IP6_ADDR_BLOCK3(ip6addr) ((u16_t)(htonl((ip6addr)->addr[1]) >> 16) & 0xffff)
108 #define IP6_ADDR_BLOCK4(ip6addr) ((u16_t)(htonl((ip6addr)->addr[1])) & 0xffff)
109 #define IP6_ADDR_BLOCK5(ip6addr) ((u16_t)(htonl((ip6addr)->addr[2]) >> 16) & 0xffff)
110 #define IP6_ADDR_BLOCK6(ip6addr) ((u16_t)(htonl((ip6addr)->addr[2])) & 0xffff)
111 #define IP6_ADDR_BLOCK7(ip6addr) ((u16_t)(htonl((ip6addr)->addr[3]) >> 16) & 0xffff)
112 #define IP6_ADDR_BLOCK8(ip6addr) ((u16_t)(htonl((ip6addr)->addr[3])) & 0xffff)
113 
115 #define ip6_addr_copy(dest, src) do{(dest).addr[0] = (src).addr[0]; \
116  (dest).addr[1] = (src).addr[1]; \
117  (dest).addr[2] = (src).addr[2]; \
118  (dest).addr[3] = (src).addr[3];}while(0)
119 
120 #define ip6_addr_set(dest, src) do{(dest)->addr[0] = (src) == NULL ? 0 : (src)->addr[0]; \
121  (dest)->addr[1] = (src) == NULL ? 0 : (src)->addr[1]; \
122  (dest)->addr[2] = (src) == NULL ? 0 : (src)->addr[2]; \
123  (dest)->addr[3] = (src) == NULL ? 0 : (src)->addr[3];}while(0)
124 
126 #define ip6_addr_set_zero(ip6addr) do{(ip6addr)->addr[0] = 0; \
127  (ip6addr)->addr[1] = 0; \
128  (ip6addr)->addr[2] = 0; \
129  (ip6addr)->addr[3] = 0;}while(0)
130 
132 #define ip6_addr_set_any(ip6addr) ip6_addr_set_zero(ip6addr)
133 
134 #define ip6_addr_set_loopback(ip6addr) do{(ip6addr)->addr[0] = 0; \
135  (ip6addr)->addr[1] = 0; \
136  (ip6addr)->addr[2] = 0; \
137  (ip6addr)->addr[3] = PP_HTONL(0x00000001UL);}while(0)
138 
140 #define ip6_addr_set_hton(dest, src) do{(dest)->addr[0] = (src) == NULL ? 0 : htonl((src)->addr[0]); \
141  (dest)->addr[1] = (src) == NULL ? 0 : htonl((src)->addr[1]); \
142  (dest)->addr[2] = (src) == NULL ? 0 : htonl((src)->addr[2]); \
143  (dest)->addr[3] = (src) == NULL ? 0 : htonl((src)->addr[3]);}while(0)
144 
145 
153 #define ip6_addr_netcmp(addr1, addr2) (((addr1)->addr[0] == (addr2)->addr[0]) && \
154  ((addr1)->addr[1] == (addr2)->addr[1]))
155 
156 #define ip6_addr_cmp(addr1, addr2) (((addr1)->addr[0] == (addr2)->addr[0]) && \
157  ((addr1)->addr[1] == (addr2)->addr[1]) && \
158  ((addr1)->addr[2] == (addr2)->addr[2]) && \
159  ((addr1)->addr[3] == (addr2)->addr[3]))
160 
161 #define ip6_get_subnet_id(ip6addr) (htonl((ip6addr)->addr[2]) & 0x0000ffffUL)
162 
163 #define ip6_addr_isany_val(ip6addr) (((ip6addr).addr[0] == 0) && \
164  ((ip6addr).addr[1] == 0) && \
165  ((ip6addr).addr[2] == 0) && \
166  ((ip6addr).addr[3] == 0))
167 #define ip6_addr_isany(ip6addr) (((ip6addr) == NULL) || ip6_addr_isany_val(*(ip6addr)))
168 
169 #define ip6_addr_isloopback(ip6addr) (((ip6addr)->addr[0] == 0UL) && \
170  ((ip6addr)->addr[1] == 0UL) && \
171  ((ip6addr)->addr[2] == 0UL) && \
172  ((ip6addr)->addr[3] == PP_HTONL(0x00000001UL)))
173 
174 #define ip6_addr_isglobal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xe0000000UL)) == PP_HTONL(0x20000000UL))
175 
176 #define ip6_addr_islinklocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xffc00000UL)) == PP_HTONL(0xfe800000UL))
177 
178 #define ip6_addr_issitelocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xffc00000UL)) == PP_HTONL(0xfec00000UL))
179 
180 #define ip6_addr_isuniquelocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xfe000000UL)) == PP_HTONL(0xfc000000UL))
181 
182 #define ip6_addr_ismulticast(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff000000UL)) == PP_HTONL(0xff000000UL))
183 #define ip6_addr_multicast_transient_flag(ip6addr) ((ip6addr)->addr[0] & PP_HTONL(0x00100000UL))
184 #define ip6_addr_multicast_prefix_flag(ip6addr) ((ip6addr)->addr[0] & PP_HTONL(0x00200000UL))
185 #define ip6_addr_multicast_rendezvous_flag(ip6addr) ((ip6addr)->addr[0] & PP_HTONL(0x00400000UL))
186 #define ip6_addr_multicast_scope(ip6addr) ((htonl((ip6addr)->addr[0]) >> 16) & 0xf)
187 #define IP6_MULTICAST_SCOPE_RESERVED 0x0
188 #define IP6_MULTICAST_SCOPE_RESERVED0 0x0
189 #define IP6_MULTICAST_SCOPE_INTERFACE_LOCAL 0x1
190 #define IP6_MULTICAST_SCOPE_LINK_LOCAL 0x2
191 #define IP6_MULTICAST_SCOPE_RESERVED3 0x3
192 #define IP6_MULTICAST_SCOPE_ADMIN_LOCAL 0x4
193 #define IP6_MULTICAST_SCOPE_SITE_LOCAL 0x5
194 #define IP6_MULTICAST_SCOPE_ORGANIZATION_LOCAL 0x8
195 #define IP6_MULTICAST_SCOPE_GLOBAL 0xe
196 #define IP6_MULTICAST_SCOPE_RESERVEDF 0xf
197 #define ip6_addr_ismulticast_iflocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff010000UL))
198 #define ip6_addr_ismulticast_linklocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff020000UL))
199 #define ip6_addr_ismulticast_adminlocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff040000UL))
200 #define ip6_addr_ismulticast_sitelocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff050000UL))
201 #define ip6_addr_ismulticast_orglocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff080000UL))
202 #define ip6_addr_ismulticast_global(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff0e0000UL))
203 
204 /* TODO define get/set for well-know multicast addresses, e.g. ff02::1 */
205 #define ip6_addr_isallnodes_iflocal(ip6addr) (((ip6addr)->addr[0] == PP_HTONL(0xff010000UL)) && \
206  ((ip6addr)->addr[1] == 0UL) && \
207  ((ip6addr)->addr[2] == 0UL) && \
208  ((ip6addr)->addr[3] == PP_HTONL(0x00000001UL)))
209 
210 #define ip6_addr_isallnodes_linklocal(ip6addr) (((ip6addr)->addr[0] == PP_HTONL(0xff020000UL)) && \
211  ((ip6addr)->addr[1] == 0UL) && \
212  ((ip6addr)->addr[2] == 0UL) && \
213  ((ip6addr)->addr[3] == PP_HTONL(0x00000001UL)))
214 #define ip6_addr_set_allnodes_linklocal(ip6addr) do{(ip6addr)->addr[0] = PP_HTONL(0xff020000UL); \
215  (ip6addr)->addr[1] = 0; \
216  (ip6addr)->addr[2] = 0; \
217  (ip6addr)->addr[3] = PP_HTONL(0x00000001UL);}while(0)
218 
219 #define ip6_addr_isallrouters_linklocal(ip6addr) (((ip6addr)->addr[0] == PP_HTONL(0xff020000UL)) && \
220  ((ip6addr)->addr[1] == 0UL) && \
221  ((ip6addr)->addr[2] == 0UL) && \
222  ((ip6addr)->addr[3] == PP_HTONL(0x00000002UL)))
223 #define ip6_addr_set_allrouters_linklocal(ip6addr) do{(ip6addr)->addr[0] = PP_HTONL(0xff020000UL); \
224  (ip6addr)->addr[1] = 0; \
225  (ip6addr)->addr[2] = 0; \
226  (ip6addr)->addr[3] = PP_HTONL(0x00000002UL);}while(0)
227 
228 #define ip6_addr_issolicitednode(ip6addr) ( ((ip6addr)->addr[0] == PP_HTONL(0xff020000UL)) && \
229  ((ip6addr)->addr[2] == PP_HTONL(0x00000001UL)) && \
230  (((ip6addr)->addr[3] & PP_HTONL(0xff000000UL)) == PP_HTONL(0xff000000UL)) )
231 
232 #define ip6_addr_set_solicitednode(ip6addr, if_id) do{(ip6addr)->addr[0] = PP_HTONL(0xff020000UL); \
233  (ip6addr)->addr[1] = 0; \
234  (ip6addr)->addr[2] = PP_HTONL(0x00000001UL); \
235  (ip6addr)->addr[3] = (PP_HTONL(0xff000000UL) | (if_id));}while(0)
236 
237 #define ip6_addr_cmp_solicitednode(ip6addr, sn_addr) (((ip6addr)->addr[0] == PP_HTONL(0xff020000UL)) && \
238  ((ip6addr)->addr[1] == 0) && \
239  ((ip6addr)->addr[2] == PP_HTONL(0x00000001UL)) && \
240  ((ip6addr)->addr[3] == (PP_HTONL(0xff000000UL) | (sn_addr)->addr[3])))
241 
242 /* IPv6 address states. */
243 #define IP6_ADDR_INVALID 0x00
244 #define IP6_ADDR_TENTATIVE 0x08
245 #define IP6_ADDR_TENTATIVE_1 0x09 /* 1 probe sent */
246 #define IP6_ADDR_TENTATIVE_2 0x0a /* 2 probes sent */
247 #define IP6_ADDR_TENTATIVE_3 0x0b /* 3 probes sent */
248 #define IP6_ADDR_TENTATIVE_4 0x0c /* 4 probes sent */
249 #define IP6_ADDR_TENTATIVE_5 0x0d /* 5 probes sent */
250 #define IP6_ADDR_TENTATIVE_6 0x0e /* 6 probes sent */
251 #define IP6_ADDR_TENTATIVE_7 0x0f /* 7 probes sent */
252 #define IP6_ADDR_VALID 0x10
253 #define IP6_ADDR_PREFERRED 0x30
254 #define IP6_ADDR_DEPRECATED 0x50
255 
256 #define ip6_addr_isinvalid(addr_state) (addr_state == IP6_ADDR_INVALID)
257 #define ip6_addr_istentative(addr_state) (addr_state & IP6_ADDR_TENTATIVE)
258 #define ip6_addr_isvalid(addr_state) (addr_state & IP6_ADDR_VALID) /* Include valid, preferred, and deprecated. */
259 #define ip6_addr_ispreferred(addr_state) (addr_state == IP6_ADDR_PREFERRED)
260 #define ip6_addr_isdeprecated(addr_state) (addr_state == IP6_ADDR_DEPRECATED)
261 
262 #define ip6_addr_debug_print_parts(debug, a, b, c, d, e, f, g, h) \
263  LWIP_DEBUGF(debug, ("%" X16_F ":%" X16_F ":%" X16_F ":%" X16_F ":%" X16_F ":%" X16_F ":%" X16_F ":%" X16_F, \
264  a, b, c, d, e, f, g, h))
265 #define ip6_addr_debug_print(debug, ipaddr) \
266  ip6_addr_debug_print_parts(debug, \
267  (ipaddr) != NULL ? IP6_ADDR_BLOCK1(ipaddr) : 0, \
268  (ipaddr) != NULL ? IP6_ADDR_BLOCK2(ipaddr) : 0, \
269  (ipaddr) != NULL ? IP6_ADDR_BLOCK3(ipaddr) : 0, \
270  (ipaddr) != NULL ? IP6_ADDR_BLOCK4(ipaddr) : 0, \
271  (ipaddr) != NULL ? IP6_ADDR_BLOCK5(ipaddr) : 0, \
272  (ipaddr) != NULL ? IP6_ADDR_BLOCK6(ipaddr) : 0, \
273  (ipaddr) != NULL ? IP6_ADDR_BLOCK7(ipaddr) : 0, \
274  (ipaddr) != NULL ? IP6_ADDR_BLOCK8(ipaddr) : 0)
275 #define ip6_addr_debug_print_val(debug, ipaddr) \
276  ip6_addr_debug_print_parts(debug, \
277  IP6_ADDR_BLOCK1(&(ipaddr)), \
278  IP6_ADDR_BLOCK2(&(ipaddr)), \
279  IP6_ADDR_BLOCK3(&(ipaddr)), \
280  IP6_ADDR_BLOCK4(&(ipaddr)), \
281  IP6_ADDR_BLOCK5(&(ipaddr)), \
282  IP6_ADDR_BLOCK6(&(ipaddr)), \
283  IP6_ADDR_BLOCK7(&(ipaddr)), \
284  IP6_ADDR_BLOCK8(&(ipaddr)))
285 
286 #define IP6ADDR_STRLEN_MAX 46
287 
288 int ip6addr_aton(const char *cp, ip6_addr_t *addr);
290 char *ip6addr_ntoa(const ip6_addr_t *addr);
291 char *ip6addr_ntoa_r(const ip6_addr_t *addr, char *buf, int buflen);
292 
293 
294 
295 #ifdef __cplusplus
296 }
297 #endif
298 
299 #endif /* LWIP_IPV6 */
300 
301 #endif /* LWIP_HDR_IP6_ADDR_H */
302 
PACK_STRUCT_STRUCT
#define PACK_STRUCT_STRUCT
Definition: arch.h:68
PACK_STRUCT_FIELD
#define PACK_STRUCT_FIELD(x)
Definition: arch.h:72
u32_t
unsigned long u32_t
Definition: cc.h:42
PACK_STRUCT_BEGIN
#define PACK_STRUCT_BEGIN
Definition: arch.h:60
PACK_STRUCT_END
#define PACK_STRUCT_END
Definition: arch.h:64
Generated by   doxygen 1.8.11