Zephyr API Documentation  3.6.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
net_if.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2016 Intel Corporation.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
12#ifndef ZEPHYR_INCLUDE_NET_NET_IF_H_
13#define ZEPHYR_INCLUDE_NET_NET_IF_H_
14
22#include <zephyr/device.h>
23#include <zephyr/sys/slist.h>
25#include <zephyr/net/net_core.h>
26#include <zephyr/net/hostname.h>
28#include <zephyr/net/net_ip.h>
29#include <zephyr/net/net_l2.h>
32
33#if defined(CONFIG_NET_DHCPV4) && defined(CONFIG_NET_NATIVE_IPV4)
34#include <zephyr/net/dhcpv4.h>
35#endif
36#if defined(CONFIG_NET_DHCPV6) && defined(CONFIG_NET_NATIVE_IPV6)
37#include <zephyr/net/dhcpv6.h>
38#endif
39#if defined(CONFIG_NET_IPV4_AUTO) && defined(CONFIG_NET_NATIVE_IPV4)
41#endif
42
43#ifdef __cplusplus
44extern "C" {
45#endif
46
54 struct net_addr address;
55
60
61#if defined(CONFIG_NET_NATIVE_IPV6)
62 struct net_timeout lifetime;
63#endif
64
65#if defined(CONFIG_NET_IPV6_DAD) && defined(CONFIG_NET_NATIVE_IPV6)
67 sys_snode_t dad_node;
68 uint32_t dad_start;
69#endif
72
75
76#if defined(CONFIG_NET_NATIVE_IPV6)
77#if defined(CONFIG_NET_IPV6_PE)
81 uint32_t addr_create_time;
82
85 uint32_t addr_preferred_lifetime;
86
91 int32_t addr_timeout;
92#endif
93
94#if defined(CONFIG_NET_IPV6_DAD)
96 uint8_t dad_count;
97 /* What interface the DAD is running */
98 uint8_t ifindex;
99#endif
100#endif /* CONFIG_NET_NATIVE_IPV6 */
101
104
107
110
115
116 uint8_t _unused : 4;
117};
118
126 struct net_addr address;
127
128#if defined(CONFIG_NET_IPV4_IGMPV3)
130 struct net_addr sources[CONFIG_NET_IF_MCAST_IPV4_SOURCE_COUNT];
131
133 uint16_t sources_len;
134
136 uint8_t record_type;
137#endif
138
141
144
145 uint8_t _unused : 6;
146};
147
156
159
161 struct net_if *iface;
162
165
168
171
172 uint8_t _unused : 6;
173};
174
183
185 struct net_addr address;
186
188 struct net_if *iface;
189
192
195
198
201
204
205 uint8_t _unused : 5;
206};
207
212
215
218
226
229
235
238
241
244
247
250
253
256
259
261 /* Total number of flags - must be at the end of the enum */
262 NET_IF_NUM_FLAGS
264};
265
275} __packed;
276
277#if defined(CONFIG_NET_OFFLOAD)
278struct net_offload;
279#endif /* CONFIG_NET_OFFLOAD */
280
282#if defined(CONFIG_NET_NATIVE_IPV6)
283#define NET_IF_MAX_IPV6_ADDR CONFIG_NET_IF_UNICAST_IPV6_ADDR_COUNT
284#define NET_IF_MAX_IPV6_MADDR CONFIG_NET_IF_MCAST_IPV6_ADDR_COUNT
285#define NET_IF_MAX_IPV6_PREFIX CONFIG_NET_IF_IPV6_PREFIX_COUNT
286#else
287#define NET_IF_MAX_IPV6_ADDR 0
288#define NET_IF_MAX_IPV6_MADDR 0
289#define NET_IF_MAX_IPV6_PREFIX 0
290#endif
291/* @endcond */
292
296 struct net_if_addr unicast[NET_IF_MAX_IPV6_ADDR];
297
299 struct net_if_mcast_addr mcast[NET_IF_MAX_IPV6_MADDR];
300
302 struct net_if_ipv6_prefix prefix[NET_IF_MAX_IPV6_PREFIX];
303
306
309
312
313#if defined(CONFIG_NET_IPV6_PE)
318 uint32_t desync_factor;
319#endif /* CONFIG_NET_IPV6_PE */
320
321#if defined(CONFIG_NET_IPV6_ND) && defined(CONFIG_NET_NATIVE_IPV6)
323 sys_snode_t rs_node;
324
325 /* RS start time */
326 uint32_t rs_start;
327
329 uint8_t rs_count;
330#endif
331
334
337};
338
339#if defined(CONFIG_NET_DHCPV6) && defined(CONFIG_NET_NATIVE_IPV6)
341struct net_if_dhcpv6 {
343 sys_snode_t node;
344
346 struct net_dhcpv6_duid_storage clientid;
347
349 struct net_dhcpv6_duid_storage serverid;
350
352 enum net_dhcpv6_state state;
353
355 struct net_dhcpv6_params params;
356
358 uint64_t timeout;
359
361 uint64_t exchange_start;
362
364 uint64_t t1;
365
367 uint64_t t2;
368
372 uint64_t expire;
373
375 uint32_t addr_iaid;
376
378 uint32_t prefix_iaid;
379
381 uint32_t retransmit_timeout;
382
384 int16_t server_preference;
385
387 uint8_t retransmissions;
388
390 uint8_t tid[DHCPV6_TID_SIZE];
391
393 uint8_t prefix_len;
394
396 struct in6_addr prefix;
397
399 struct in6_addr addr;
400};
401#endif /* defined(CONFIG_NET_DHCPV6) && defined(CONFIG_NET_NATIVE_IPV6) */
402
404#if defined(CONFIG_NET_NATIVE_IPV4)
405#define NET_IF_MAX_IPV4_ADDR CONFIG_NET_IF_UNICAST_IPV4_ADDR_COUNT
406#define NET_IF_MAX_IPV4_MADDR CONFIG_NET_IF_MCAST_IPV4_ADDR_COUNT
407#else
408#define NET_IF_MAX_IPV4_ADDR 0
409#define NET_IF_MAX_IPV4_MADDR 0
410#endif
423};
424
428 struct net_if_addr_ipv4 unicast[NET_IF_MAX_IPV4_ADDR];
429
431 struct net_if_mcast_addr mcast[NET_IF_MAX_IPV4_MADDR];
432
434 struct in_addr gw;
435
438
441};
442
443#if defined(CONFIG_NET_DHCPV4) && defined(CONFIG_NET_NATIVE_IPV4)
444struct net_if_dhcpv4 {
446 sys_snode_t node;
447
449 int64_t timer_start;
450
452 uint32_t request_time;
453
454 uint32_t xid;
455
457 uint32_t lease_time;
458
460 uint32_t renewal_time;
461
463 uint32_t rebinding_time;
464
466 struct in_addr server_id;
467
469 struct in_addr requested_ip;
470
472 struct in_addr netmask;
473
478 enum net_dhcpv4_state state;
479
481 uint8_t attempts;
482
484 struct in_addr request_server_addr;
485
487 struct in_addr response_src_addr;
488
489#ifdef CONFIG_NET_DHCPV4_OPTION_NTP_SERVER
491 struct in_addr ntp_addr;
492#endif
493};
494#endif /* CONFIG_NET_DHCPV4 */
495
496#if defined(CONFIG_NET_IPV4_AUTO) && defined(CONFIG_NET_NATIVE_IPV4)
497struct net_if_ipv4_autoconf {
499 sys_snode_t node;
500
502 struct net_if *iface;
503
505 int64_t timer_start;
506
508 uint32_t timer_timeout;
509
511 struct in_addr current_ip;
512
514 struct in_addr requested_ip;
515
519
521 uint8_t probe_cnt;
522
524 uint8_t announce_cnt;
525
527 uint8_t conflict_cnt;
528};
529#endif /* CONFIG_NET_IPV4_AUTO */
530
532/* We always need to have at least one IP config */
533#define NET_IF_MAX_CONFIGS 1
539struct net_if_ip {
540#if defined(CONFIG_NET_NATIVE_IPV6)
541 struct net_if_ipv6 *ipv6;
542#endif /* CONFIG_NET_IPV6 */
543
544#if defined(CONFIG_NET_NATIVE_IPV4)
545 struct net_if_ipv4 *ipv4;
546#endif /* CONFIG_NET_IPV4 */
547};
548
553#if defined(CONFIG_NET_IP)
555 struct net_if_ip ip;
556#endif
557
558#if defined(CONFIG_NET_DHCPV4) && defined(CONFIG_NET_NATIVE_IPV4)
559 struct net_if_dhcpv4 dhcpv4;
560#endif /* CONFIG_NET_DHCPV4 */
561
562#if defined(CONFIG_NET_DHCPV6) && defined(CONFIG_NET_NATIVE_IPV6)
563 struct net_if_dhcpv6 dhcpv6;
564#endif /* CONFIG_NET_DHCPV6 */
565
566#if defined(CONFIG_NET_IPV4_AUTO) && defined(CONFIG_NET_NATIVE_IPV4)
567 struct net_if_ipv4_autoconf ipv4auto;
568#endif /* CONFIG_NET_IPV4_AUTO */
569
570#if defined(CONFIG_NET_L2_VIRTUAL)
575 sys_slist_t virtual_interfaces;
576#endif /* CONFIG_NET_L2_VIRTUAL */
577
578#if defined(CONFIG_NET_INTERFACE_NAME)
583 char name[CONFIG_NET_INTERFACE_NAME_LEN + 1];
584#endif
585};
586
598 struct k_fifo fifo;
599
602
605};
606
613typedef int (*net_socket_create_t)(int, int, int);
614
631 const struct device *dev;
632
634 const struct net_l2 * const l2;
635
637 void *l2_data;
638
640 ATOMIC_DEFINE(flags, NET_IF_NUM_FLAGS);
641
644
645#if defined(CONFIG_NET_OFFLOAD)
651 struct net_offload *offload;
652#endif /* CONFIG_NET_OFFLOAD */
653
656
657#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
661 net_socket_create_t socket_offload;
662#endif /* CONFIG_NET_SOCKETS_OFFLOAD */
663
666};
667
675struct net_if {
678
679#if defined(CONFIG_NET_STATISTICS_PER_INTERFACE)
681 struct net_stats stats;
682#endif /* CONFIG_NET_STATISTICS_PER_INTERFACE */
683
686
687#if defined(CONFIG_NET_POWER_MANAGEMENT)
692 int tx_pending;
693#endif
694
696 struct k_mutex lock;
697
700
706
711
713 uint8_t _unused : 6;
714};
715
718static inline void net_if_lock(struct net_if *iface)
719{
720 NET_ASSERT(iface);
721
722 (void)k_mutex_lock(&iface->lock, K_FOREVER);
723}
724
725static inline void net_if_unlock(struct net_if *iface)
726{
727 NET_ASSERT(iface);
728
729 k_mutex_unlock(&iface->lock);
730}
731
732static inline bool net_if_flag_is_set(struct net_if *iface,
733 enum net_if_flag value);
734
735static inline void net_if_tx_lock(struct net_if *iface)
736{
737 NET_ASSERT(iface);
738
740 return;
741 }
742
743 (void)k_mutex_lock(&iface->tx_lock, K_FOREVER);
744}
745
746static inline void net_if_tx_unlock(struct net_if *iface)
747{
748 NET_ASSERT(iface);
749
751 return;
752 }
753
754 k_mutex_unlock(&iface->tx_lock);
755}
756
765static inline void net_if_flag_set(struct net_if *iface,
766 enum net_if_flag value)
767{
768 NET_ASSERT(iface);
769 NET_ASSERT(iface->if_dev);
770
771 atomic_set_bit(iface->if_dev->flags, value);
772}
773
782static inline bool net_if_flag_test_and_set(struct net_if *iface,
783 enum net_if_flag value)
784{
785 NET_ASSERT(iface);
786 NET_ASSERT(iface->if_dev);
787
788 return atomic_test_and_set_bit(iface->if_dev->flags, value);
789}
790
797static inline void net_if_flag_clear(struct net_if *iface,
798 enum net_if_flag value)
799{
800 NET_ASSERT(iface);
801 NET_ASSERT(iface->if_dev);
802
803 atomic_clear_bit(iface->if_dev->flags, value);
804}
805
814static inline bool net_if_flag_test_and_clear(struct net_if *iface,
815 enum net_if_flag value)
816{
817 NET_ASSERT(iface);
818 NET_ASSERT(iface->if_dev);
819
820 return atomic_test_and_clear_bit(iface->if_dev->flags, value);
821}
822
831static inline bool net_if_flag_is_set(struct net_if *iface,
832 enum net_if_flag value)
833{
834 NET_ASSERT(iface);
835 NET_ASSERT(iface->if_dev);
836
837 if (iface == NULL) {
838 return false;
839 }
840
841 return atomic_test_bit(iface->if_dev->flags, value);
842}
843
853 struct net_if *iface, enum net_if_oper_state oper_state)
854{
855 NET_ASSERT(iface);
856 NET_ASSERT(iface->if_dev);
857
858 if (oper_state >= NET_IF_OPER_UNKNOWN && oper_state <= NET_IF_OPER_UP) {
859 iface->if_dev->oper_state = oper_state;
860 }
861
862 return iface->if_dev->oper_state;
863}
864
872static inline enum net_if_oper_state net_if_oper_state(struct net_if *iface)
873{
874 NET_ASSERT(iface);
875 NET_ASSERT(iface->if_dev);
876
877 return iface->if_dev->oper_state;
878}
879
888enum net_verdict net_if_send_data(struct net_if *iface, struct net_pkt *pkt);
889
897static inline const struct net_l2 *net_if_l2(struct net_if *iface)
898{
899 if (!iface || !iface->if_dev) {
900 return NULL;
901 }
902
903 return iface->if_dev->l2;
904}
905
914enum net_verdict net_if_recv_data(struct net_if *iface, struct net_pkt *pkt);
915
923static inline void *net_if_l2_data(struct net_if *iface)
924{
925 NET_ASSERT(iface);
926 NET_ASSERT(iface->if_dev);
927
928 return iface->if_dev->l2_data;
929}
930
938static inline const struct device *net_if_get_device(struct net_if *iface)
939{
940 NET_ASSERT(iface);
941 NET_ASSERT(iface->if_dev);
942
943 return iface->if_dev->dev;
944}
945
952void net_if_queue_tx(struct net_if *iface, struct net_pkt *pkt);
953
961static inline bool net_if_is_ip_offloaded(struct net_if *iface)
962{
963#if defined(CONFIG_NET_OFFLOAD)
964 return (iface != NULL && iface->if_dev != NULL &&
965 iface->if_dev->offload != NULL);
966#else
967 ARG_UNUSED(iface);
968
969 return false;
970#endif
971}
972
980bool net_if_is_offloaded(struct net_if *iface);
981
989static inline struct net_offload *net_if_offload(struct net_if *iface)
990{
991#if defined(CONFIG_NET_OFFLOAD)
992 NET_ASSERT(iface);
993 NET_ASSERT(iface->if_dev);
994
995 return iface->if_dev->offload;
996#else
997 ARG_UNUSED(iface);
998
999 return NULL;
1000#endif
1001}
1002
1010static inline bool net_if_is_socket_offloaded(struct net_if *iface)
1011{
1012#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
1013 NET_ASSERT(iface);
1014 NET_ASSERT(iface->if_dev);
1015
1016 return (iface->if_dev->socket_offload != NULL);
1017#else
1018 ARG_UNUSED(iface);
1019
1020 return false;
1021#endif
1022}
1023
1030static inline void net_if_socket_offload_set(
1031 struct net_if *iface, net_socket_create_t socket_offload)
1032{
1033#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
1034 NET_ASSERT(iface);
1035 NET_ASSERT(iface->if_dev);
1036
1037 iface->if_dev->socket_offload = socket_offload;
1038#else
1039 ARG_UNUSED(iface);
1040 ARG_UNUSED(socket_offload);
1041#endif
1042}
1043
1052{
1053#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
1054 NET_ASSERT(iface);
1055 NET_ASSERT(iface->if_dev);
1056
1057 return iface->if_dev->socket_offload;
1058#else
1059 ARG_UNUSED(iface);
1060
1061 return NULL;
1062#endif
1063}
1064
1072static inline struct net_linkaddr *net_if_get_link_addr(struct net_if *iface)
1073{
1074 NET_ASSERT(iface);
1075 NET_ASSERT(iface->if_dev);
1076
1077 return &iface->if_dev->link_addr;
1078}
1079
1087static inline struct net_if_config *net_if_get_config(struct net_if *iface)
1088{
1089 NET_ASSERT(iface);
1090
1091 return &iface->config;
1092}
1093
1099#if defined(CONFIG_NET_IPV6_DAD) && defined(CONFIG_NET_NATIVE_IPV6)
1100void net_if_start_dad(struct net_if *iface);
1101#else
1102static inline void net_if_start_dad(struct net_if *iface)
1103{
1104 ARG_UNUSED(iface);
1105}
1106#endif
1107
1113void net_if_start_rs(struct net_if *iface);
1114
1115
1121#if defined(CONFIG_NET_IPV6_ND) && defined(CONFIG_NET_NATIVE_IPV6)
1122void net_if_stop_rs(struct net_if *iface);
1123#else
1124static inline void net_if_stop_rs(struct net_if *iface)
1125{
1126 ARG_UNUSED(iface);
1127}
1128#endif /* CONFIG_NET_IPV6_ND */
1129
1142#if defined(CONFIG_NET_IPV6_ND) && defined(CONFIG_NET_NATIVE_IPV6)
1143void net_if_nbr_reachability_hint(struct net_if *iface, const struct in6_addr *ipv6_addr);
1144#else
1145static inline void net_if_nbr_reachability_hint(struct net_if *iface,
1146 const struct in6_addr *ipv6_addr)
1147{
1148 ARG_UNUSED(iface);
1149 ARG_UNUSED(ipv6_addr);
1150}
1151#endif
1152
1155static inline int net_if_set_link_addr_unlocked(struct net_if *iface,
1156 uint8_t *addr, uint8_t len,
1157 enum net_link_type type)
1158{
1159 if (net_if_flag_is_set(iface, NET_IF_RUNNING)) {
1160 return -EPERM;
1161 }
1162
1163 net_if_get_link_addr(iface)->addr = addr;
1164 net_if_get_link_addr(iface)->len = len;
1165 net_if_get_link_addr(iface)->type = type;
1166
1167 net_hostname_set_postfix(addr, len);
1168
1169 return 0;
1170}
1171
1172int net_if_set_link_addr_locked(struct net_if *iface,
1173 uint8_t *addr, uint8_t len,
1174 enum net_link_type type);
1175
1176#if CONFIG_NET_IF_LOG_LEVEL >= LOG_LEVEL_DBG
1177extern int net_if_addr_unref_debug(struct net_if *iface,
1178 sa_family_t family,
1179 const void *addr,
1180 const char *caller, int line);
1181#define net_if_addr_unref(iface, family, addr) \
1182 net_if_addr_unref_debug(iface, family, addr, __func__, __LINE__)
1183
1184extern struct net_if_addr *net_if_addr_ref_debug(struct net_if *iface,
1185 sa_family_t family,
1186 const void *addr,
1187 const char *caller,
1188 int line);
1189#define net_if_addr_ref(iface, family, addr) \
1190 net_if_addr_ref_debug(iface, family, addr, __func__, __LINE__)
1191#else
1192extern int net_if_addr_unref(struct net_if *iface,
1193 sa_family_t family,
1194 const void *addr);
1195extern struct net_if_addr *net_if_addr_ref(struct net_if *iface,
1196 sa_family_t family,
1197 const void *addr);
1198#endif /* CONFIG_NET_IF_LOG_LEVEL */
1199
1213static inline int net_if_set_link_addr(struct net_if *iface,
1214 uint8_t *addr, uint8_t len,
1215 enum net_link_type type)
1216{
1217#if defined(CONFIG_NET_RAW_MODE)
1218 return net_if_set_link_addr_unlocked(iface, addr, len, type);
1219#else
1220 return net_if_set_link_addr_locked(iface, addr, len, type);
1221#endif
1222}
1223
1231static inline uint16_t net_if_get_mtu(struct net_if *iface)
1232{
1233 if (iface == NULL) {
1234 return 0U;
1235 }
1236
1237 NET_ASSERT(iface->if_dev);
1238
1239 return iface->if_dev->mtu;
1240}
1241
1248static inline void net_if_set_mtu(struct net_if *iface,
1249 uint16_t mtu)
1250{
1251 if (iface == NULL) {
1252 return;
1253 }
1254
1255 NET_ASSERT(iface->if_dev);
1256
1257 iface->if_dev->mtu = mtu;
1258}
1259
1266static inline void net_if_addr_set_lf(struct net_if_addr *ifaddr,
1267 bool is_infinite)
1268{
1269 NET_ASSERT(ifaddr);
1270
1271 ifaddr->is_infinite = is_infinite;
1272}
1273
1282
1290struct net_if *net_if_lookup_by_dev(const struct device *dev);
1291
1299static inline struct net_if_config *net_if_config_get(struct net_if *iface)
1300{
1301 NET_ASSERT(iface);
1302
1303 return &iface->config;
1304}
1305
1311void net_if_router_rm(struct net_if_router *router);
1312
1318void net_if_set_default(struct net_if *iface);
1319
1326
1335struct net_if *net_if_get_first_by_type(const struct net_l2 *l2);
1336
1344
1345#if defined(CONFIG_NET_L2_IEEE802154)
1352static inline struct net_if *net_if_get_ieee802154(void)
1353{
1354 return net_if_get_first_by_type(&NET_L2_GET_NAME(IEEE802154));
1355}
1356#endif /* CONFIG_NET_L2_IEEE802154 */
1357
1369 struct net_if_ipv6 **ipv6);
1370
1379
1389 struct net_if **iface);
1390
1400 struct in6_addr *addr);
1401
1410__syscall int net_if_ipv6_addr_lookup_by_index(const struct in6_addr *addr);
1411
1423 struct in6_addr *addr,
1425 uint32_t vlifetime);
1426
1437__syscall bool net_if_ipv6_addr_add_by_index(int index,
1438 struct in6_addr *addr,
1440 uint32_t vlifetime);
1441
1449 uint32_t vlifetime);
1450
1459bool net_if_ipv6_addr_rm(struct net_if *iface, const struct in6_addr *addr);
1460
1469__syscall bool net_if_ipv6_addr_rm_by_index(int index,
1470 const struct in6_addr *addr);
1471
1480typedef void (*net_if_ip_addr_cb_t)(struct net_if *iface,
1481 struct net_if_addr *addr,
1482 void *user_data);
1483
1493 void *user_data);
1494
1504 const struct in6_addr *addr);
1505
1514bool net_if_ipv6_maddr_rm(struct net_if *iface, const struct in6_addr *addr);
1515
1524typedef void (*net_if_ip_maddr_cb_t)(struct net_if *iface,
1525 struct net_if_mcast_addr *maddr,
1526 void *user_data);
1527
1537 void *user_data);
1538
1550 struct net_if **iface);
1551
1562typedef void (*net_if_mcast_callback_t)(struct net_if *iface,
1563 const struct net_addr *addr,
1564 bool is_joined);
1565
1577
1579 struct net_if *iface;
1580
1583};
1584
1594 struct net_if *iface,
1596
1603
1611void net_if_mcast_monitor(struct net_if *iface, const struct net_addr *addr,
1612 bool is_joined);
1613
1621 struct net_if_mcast_addr *addr);
1622
1630static inline bool net_if_ipv6_maddr_is_joined(struct net_if_mcast_addr *addr)
1631{
1632 NET_ASSERT(addr);
1633
1634 return addr->is_joined;
1635}
1636
1644 struct net_if_mcast_addr *addr);
1645
1655 const struct in6_addr *addr);
1656
1667 struct in6_addr *addr,
1668 uint8_t len);
1669
1681 struct in6_addr *prefix,
1682 uint8_t len,
1684
1694bool net_if_ipv6_prefix_rm(struct net_if *iface, struct in6_addr *addr,
1695 uint8_t len);
1696
1704 bool is_infinite)
1705{
1706 prefix->is_infinite = is_infinite;
1707}
1708
1717
1724
1735bool net_if_ipv6_addr_onlink(struct net_if **iface, struct in6_addr *addr);
1736
1743#if defined(CONFIG_NET_NATIVE_IPV6)
1744static inline struct in6_addr *net_if_router_ipv6(struct net_if_router *router)
1745{
1746 NET_ASSERT(router);
1747
1748 return &router->address.in6_addr;
1749}
1750#else
1751static inline struct in6_addr *net_if_router_ipv6(struct net_if_router *router)
1752{
1753 static struct in6_addr addr;
1754
1755 ARG_UNUSED(router);
1756
1757 return &addr;
1758}
1759#endif
1760
1771 struct in6_addr *addr);
1772
1783 struct in6_addr *addr);
1784
1793
1804 struct in6_addr *addr,
1805 uint16_t router_lifetime);
1806
1815
1825
1833
1836/* The old hop limit setter function is deprecated because the naming
1837 * of it was incorrect. The API name was missing "_if_" so this function
1838 * should not be used.
1839 */
1840__deprecated
1841static inline void net_ipv6_set_hop_limit(struct net_if *iface,
1842 uint8_t hop_limit)
1843{
1844 net_if_ipv6_set_hop_limit(iface, hop_limit);
1845}
1846
1858
1866
1874 uint32_t reachable_time)
1875{
1876#if defined(CONFIG_NET_NATIVE_IPV6)
1877 NET_ASSERT(iface);
1878
1879 if (!iface->config.ip.ipv6) {
1880 return;
1881 }
1882
1883 iface->config.ip.ipv6->base_reachable_time = reachable_time;
1884#else
1885 ARG_UNUSED(iface);
1886 ARG_UNUSED(reachable_time);
1887
1888#endif
1889}
1890
1899{
1900#if defined(CONFIG_NET_NATIVE_IPV6)
1901 NET_ASSERT(iface);
1902
1903 if (!iface->config.ip.ipv6) {
1904 return 0;
1905 }
1906
1907 return iface->config.ip.ipv6->reachable_time;
1908#else
1909 ARG_UNUSED(iface);
1910 return 0;
1911#endif
1912}
1913
1922
1929static inline void net_if_ipv6_set_reachable_time(struct net_if_ipv6 *ipv6)
1930{
1931#if defined(CONFIG_NET_NATIVE_IPV6)
1932 if (ipv6 == NULL) {
1933 return;
1934 }
1935
1937#else
1938 ARG_UNUSED(ipv6);
1939#endif
1940}
1941
1948static inline void net_if_ipv6_set_retrans_timer(struct net_if *iface,
1949 uint32_t retrans_timer)
1950{
1951#if defined(CONFIG_NET_NATIVE_IPV6)
1952 NET_ASSERT(iface);
1953
1954 if (!iface->config.ip.ipv6) {
1955 return;
1956 }
1957
1958 iface->config.ip.ipv6->retrans_timer = retrans_timer;
1959#else
1960 ARG_UNUSED(iface);
1961 ARG_UNUSED(retrans_timer);
1962#endif
1963}
1964
1973{
1974#if defined(CONFIG_NET_NATIVE_IPV6)
1975 NET_ASSERT(iface);
1976
1977 if (!iface->config.ip.ipv6) {
1978 return 0;
1979 }
1980
1981 return iface->config.ip.ipv6->retrans_timer;
1982#else
1983 ARG_UNUSED(iface);
1984 return 0;
1985#endif
1986}
1987
1999#if defined(CONFIG_NET_NATIVE_IPV6)
2000const struct in6_addr *net_if_ipv6_select_src_addr(struct net_if *iface,
2001 const struct in6_addr *dst);
2002#else
2003static inline const struct in6_addr *net_if_ipv6_select_src_addr(
2004 struct net_if *iface, const struct in6_addr *dst)
2005{
2006 ARG_UNUSED(iface);
2007 ARG_UNUSED(dst);
2008
2009 return NULL;
2010}
2011#endif
2012
2026#if defined(CONFIG_NET_NATIVE_IPV6)
2027const struct in6_addr *net_if_ipv6_select_src_addr_hint(struct net_if *iface,
2028 const struct in6_addr *dst,
2029 int flags);
2030#else
2031static inline const struct in6_addr *net_if_ipv6_select_src_addr_hint(
2032 struct net_if *iface, const struct in6_addr *dst, int flags)
2033{
2034 ARG_UNUSED(iface);
2035 ARG_UNUSED(dst);
2036 ARG_UNUSED(flags);
2037
2038 return NULL;
2039}
2040#endif
2041
2051#if defined(CONFIG_NET_NATIVE_IPV6)
2052struct net_if *net_if_ipv6_select_src_iface(const struct in6_addr *dst);
2053#else
2055 const struct in6_addr *dst)
2056{
2057 ARG_UNUSED(dst);
2058
2059 return NULL;
2060}
2061#endif
2062
2072struct in6_addr *net_if_ipv6_get_ll(struct net_if *iface,
2073 enum net_addr_state addr_state);
2074
2085 struct net_if **iface);
2086
2094void net_if_ipv6_dad_failed(struct net_if *iface, const struct in6_addr *addr);
2095
2108 struct net_if **iface);
2109
2121 struct net_if_ipv4 **ipv4);
2122
2131
2140
2147void net_if_ipv4_set_ttl(struct net_if *iface, uint8_t ttl);
2148
2157
2165
2175 struct net_if **iface);
2176
2188 struct in_addr *addr,
2190 uint32_t vlifetime);
2191
2200bool net_if_ipv4_addr_rm(struct net_if *iface, const struct in_addr *addr);
2201
2210__syscall int net_if_ipv4_addr_lookup_by_index(const struct in_addr *addr);
2211
2222__syscall bool net_if_ipv4_addr_add_by_index(int index,
2223 struct in_addr *addr,
2225 uint32_t vlifetime);
2226
2235__syscall bool net_if_ipv4_addr_rm_by_index(int index,
2236 const struct in_addr *addr);
2237
2247 void *user_data);
2248
2258 const struct in_addr *addr);
2259
2268bool net_if_ipv4_maddr_rm(struct net_if *iface, const struct in_addr *addr);
2269
2279 void *user_data);
2280
2292 struct net_if **iface);
2293
2301 struct net_if_mcast_addr *addr);
2302
2310static inline bool net_if_ipv4_maddr_is_joined(struct net_if_mcast_addr *addr)
2311{
2312 NET_ASSERT(addr);
2313
2314 return addr->is_joined;
2315}
2316
2324 struct net_if_mcast_addr *addr);
2325
2332#if defined(CONFIG_NET_NATIVE_IPV4)
2333static inline struct in_addr *net_if_router_ipv4(struct net_if_router *router)
2334{
2335 NET_ASSERT(router);
2336
2337 return &router->address.in_addr;
2338}
2339#else
2340static inline struct in_addr *net_if_router_ipv4(struct net_if_router *router)
2341{
2342 static struct in_addr addr;
2343
2344 ARG_UNUSED(router);
2345
2346 return &addr;
2347}
2348#endif
2349
2360 struct in_addr *addr);
2361
2372 struct in_addr *addr);
2384 struct in_addr *addr,
2385 bool is_default,
2386 uint16_t router_lifetime);
2387
2396
2406 const struct in_addr *addr);
2407
2417 const struct in_addr *addr);
2418
2428#if defined(CONFIG_NET_NATIVE_IPV4)
2429struct net_if *net_if_ipv4_select_src_iface(const struct in_addr *dst);
2430#else
2432 const struct in_addr *dst)
2433{
2434 ARG_UNUSED(dst);
2435
2436 return NULL;
2437}
2438#endif
2439
2451#if defined(CONFIG_NET_NATIVE_IPV4)
2452const struct in_addr *net_if_ipv4_select_src_addr(struct net_if *iface,
2453 const struct in_addr *dst);
2454#else
2455static inline const struct in_addr *net_if_ipv4_select_src_addr(
2456 struct net_if *iface, const struct in_addr *dst)
2457{
2458 ARG_UNUSED(iface);
2459 ARG_UNUSED(dst);
2460
2461 return NULL;
2462}
2463#endif
2464
2474struct in_addr *net_if_ipv4_get_ll(struct net_if *iface,
2475 enum net_addr_state addr_state);
2476
2487 enum net_addr_state addr_state);
2488
2499 const struct in_addr *addr);
2500
2510__deprecated struct in_addr net_if_ipv4_get_netmask(struct net_if *iface);
2511
2520__deprecated void net_if_ipv4_set_netmask(struct net_if *iface,
2521 const struct in_addr *netmask);
2522
2533__deprecated __syscall bool net_if_ipv4_set_netmask_by_index(int index,
2534 const struct in_addr *netmask);
2535
2546 const struct in_addr *addr,
2547 const struct in_addr *netmask);
2548
2559 const struct in_addr *addr,
2560 const struct in_addr *netmask);
2561
2568void net_if_ipv4_set_gw(struct net_if *iface, const struct in_addr *gw);
2569
2578__syscall bool net_if_ipv4_set_gw_by_index(int index, const struct in_addr *gw);
2579
2590struct net_if *net_if_select_src_iface(const struct sockaddr *dst);
2591
2600typedef void (*net_if_link_callback_t)(struct net_if *iface,
2601 struct net_linkaddr *dst,
2602 int status);
2603
2615
2618};
2619
2628
2635
2643void net_if_call_link_cb(struct net_if *iface, struct net_linkaddr *lladdr,
2644 int status);
2645
2656
2668
2679__syscall struct net_if *net_if_get_by_index(int index);
2680
2688int net_if_get_by_iface(struct net_if *iface);
2689
2697typedef void (*net_if_cb_t)(struct net_if *iface, void *user_data);
2698
2706void net_if_foreach(net_if_cb_t cb, void *user_data);
2707
2715int net_if_up(struct net_if *iface);
2716
2724static inline bool net_if_is_up(struct net_if *iface)
2725{
2726 NET_ASSERT(iface);
2727
2728 return net_if_flag_is_set(iface, NET_IF_UP) &&
2730}
2731
2739int net_if_down(struct net_if *iface);
2740
2748static inline bool net_if_is_admin_up(struct net_if *iface)
2749{
2750 NET_ASSERT(iface);
2751
2752 return net_if_flag_is_set(iface, NET_IF_UP);
2753}
2754
2763void net_if_carrier_on(struct net_if *iface);
2764
2773void net_if_carrier_off(struct net_if *iface);
2774
2782static inline bool net_if_is_carrier_ok(struct net_if *iface)
2783{
2784 NET_ASSERT(iface);
2785
2786 return net_if_flag_is_set(iface, NET_IF_LOWER_UP);
2787}
2788
2799void net_if_dormant_on(struct net_if *iface);
2800
2809void net_if_dormant_off(struct net_if *iface);
2810
2818static inline bool net_if_is_dormant(struct net_if *iface)
2819{
2820 NET_ASSERT(iface);
2821
2822 return net_if_flag_is_set(iface, NET_IF_DORMANT);
2823}
2824
2825#if defined(CONFIG_NET_PKT_TIMESTAMP) && defined(CONFIG_NET_NATIVE)
2833typedef void (*net_if_timestamp_callback_t)(struct net_pkt *pkt);
2834
2843struct net_if_timestamp_cb {
2845 sys_snode_t node;
2846
2850 struct net_pkt *pkt;
2851
2855 struct net_if *iface;
2856
2858 net_if_timestamp_callback_t cb;
2859};
2860
2871void net_if_register_timestamp_cb(struct net_if_timestamp_cb *handle,
2872 struct net_pkt *pkt,
2873 struct net_if *iface,
2874 net_if_timestamp_callback_t cb);
2875
2881void net_if_unregister_timestamp_cb(struct net_if_timestamp_cb *handle);
2882
2888void net_if_call_timestamp_cb(struct net_pkt *pkt);
2889
2890/*
2891 * @brief Add timestamped TX buffer to be handled
2892 *
2893 * @param pkt Timestamped buffer
2894 */
2895void net_if_add_tx_timestamp(struct net_pkt *pkt);
2896#endif /* CONFIG_NET_PKT_TIMESTAMP */
2897
2907#if defined(CONFIG_NET_PROMISCUOUS_MODE)
2908int net_if_set_promisc(struct net_if *iface);
2909#else
2910static inline int net_if_set_promisc(struct net_if *iface)
2911{
2912 ARG_UNUSED(iface);
2913
2914 return -ENOTSUP;
2915}
2916#endif
2917
2923#if defined(CONFIG_NET_PROMISCUOUS_MODE)
2924void net_if_unset_promisc(struct net_if *iface);
2925#else
2926static inline void net_if_unset_promisc(struct net_if *iface)
2927{
2928 ARG_UNUSED(iface);
2929}
2930#endif
2931
2940#if defined(CONFIG_NET_PROMISCUOUS_MODE)
2941bool net_if_is_promisc(struct net_if *iface);
2942#else
2943static inline bool net_if_is_promisc(struct net_if *iface)
2944{
2945 ARG_UNUSED(iface);
2946
2947 return false;
2948}
2949#endif
2950
2960static inline bool net_if_are_pending_tx_packets(struct net_if *iface)
2961{
2962#if defined(CONFIG_NET_POWER_MANAGEMENT)
2963 return !!iface->tx_pending;
2964#else
2965 ARG_UNUSED(iface);
2966
2967 return false;
2968#endif
2969}
2970
2971#ifdef CONFIG_NET_POWER_MANAGEMENT
2979int net_if_suspend(struct net_if *iface);
2980
2988int net_if_resume(struct net_if *iface);
2989
2997bool net_if_is_suspended(struct net_if *iface);
2998#endif /* CONFIG_NET_POWER_MANAGEMENT */
2999
3007bool net_if_is_wifi(struct net_if *iface);
3008
3015
3030int net_if_get_name(struct net_if *iface, char *buf, int len);
3031
3046int net_if_set_name(struct net_if *iface, const char *buf);
3047
3055int net_if_get_by_name(const char *name);
3056
3058struct net_if_api {
3059 void (*init)(struct net_if *iface);
3060};
3061
3062#define NET_IF_DHCPV4_INIT \
3063 IF_ENABLED(UTIL_AND(IS_ENABLED(CONFIG_NET_DHCPV4), \
3064 IS_ENABLED(CONFIG_NET_NATIVE_IPV4)), \
3065 (.dhcpv4.state = NET_DHCPV4_DISABLED,))
3066
3067#define NET_IF_DHCPV6_INIT \
3068 IF_ENABLED(UTIL_AND(IS_ENABLED(CONFIG_NET_DHCPV6), \
3069 IS_ENABLED(CONFIG_NET_NATIVE_IPV6)), \
3070 (.dhcpv6.state = NET_DHCPV6_DISABLED,))
3071
3072#define NET_IF_CONFIG_INIT \
3073 .config = { \
3074 IF_ENABLED(CONFIG_NET_IP, (.ip = {},)) \
3075 NET_IF_DHCPV4_INIT \
3076 NET_IF_DHCPV6_INIT \
3077 }
3078
3079#define NET_IF_GET_NAME(dev_id, sfx) __net_if_##dev_id##_##sfx
3080#define NET_IF_DEV_GET_NAME(dev_id, sfx) __net_if_dev_##dev_id##_##sfx
3081
3082#define NET_IF_GET(dev_id, sfx) \
3083 ((struct net_if *)&NET_IF_GET_NAME(dev_id, sfx))
3084
3085#define NET_IF_INIT(dev_id, sfx, _l2, _mtu, _num_configs) \
3086 static STRUCT_SECTION_ITERABLE(net_if_dev, \
3087 NET_IF_DEV_GET_NAME(dev_id, sfx)) = { \
3088 .dev = &(DEVICE_NAME_GET(dev_id)), \
3089 .l2 = &(NET_L2_GET_NAME(_l2)), \
3090 .l2_data = &(NET_L2_GET_DATA(dev_id, sfx)), \
3091 .mtu = _mtu, \
3092 .flags = {BIT(NET_IF_LOWER_UP)}, \
3093 }; \
3094 static Z_DECL_ALIGN(struct net_if) \
3095 NET_IF_GET_NAME(dev_id, sfx)[_num_configs] \
3096 __used __in_section(_net_if, static, \
3097 dev_id) = { \
3098 [0 ... (_num_configs - 1)] = { \
3099 .if_dev = &(NET_IF_DEV_GET_NAME(dev_id, sfx)), \
3100 NET_IF_CONFIG_INIT \
3101 } \
3102 }
3103
3104#define NET_IF_OFFLOAD_INIT(dev_id, sfx, _mtu) \
3105 static STRUCT_SECTION_ITERABLE(net_if_dev, \
3106 NET_IF_DEV_GET_NAME(dev_id, sfx)) = { \
3107 .dev = &(DEVICE_NAME_GET(dev_id)), \
3108 .mtu = _mtu, \
3109 .l2 = &(NET_L2_GET_NAME(OFFLOADED_NETDEV)), \
3110 .flags = {BIT(NET_IF_LOWER_UP)}, \
3111 }; \
3112 static Z_DECL_ALIGN(struct net_if) \
3113 NET_IF_GET_NAME(dev_id, sfx)[NET_IF_MAX_CONFIGS] \
3114 __used __in_section(_net_if, static, \
3115 dev_id) = { \
3116 [0 ... (NET_IF_MAX_CONFIGS - 1)] = { \
3117 .if_dev = &(NET_IF_DEV_GET_NAME(dev_id, sfx)), \
3118 NET_IF_CONFIG_INIT \
3119 } \
3120 }
3121
3124/* Network device initialization macros */
3125
3126#define Z_NET_DEVICE_INIT_INSTANCE(node_id, dev_id, name, instance, \
3127 init_fn, pm, data, config, prio, \
3128 api, l2, l2_ctx_type, mtu) \
3129 Z_DEVICE_STATE_DEFINE(dev_id); \
3130 Z_DEVICE_DEFINE(node_id, dev_id, name, init_fn, pm, data, \
3131 config, POST_KERNEL, prio, api, \
3132 &Z_DEVICE_STATE_NAME(dev_id)); \
3133 NET_L2_DATA_INIT(dev_id, instance, l2_ctx_type); \
3134 NET_IF_INIT(dev_id, instance, l2, mtu, NET_IF_MAX_CONFIGS)
3135
3136#define Z_NET_DEVICE_INIT(node_id, dev_id, name, init_fn, pm, data, \
3137 config, prio, api, l2, l2_ctx_type, mtu) \
3138 Z_NET_DEVICE_INIT_INSTANCE(node_id, dev_id, name, 0, init_fn, \
3139 pm, data, config, prio, api, l2, \
3140 l2_ctx_type, mtu)
3141
3161#define NET_DEVICE_INIT(dev_id, name, init_fn, pm, data, config, prio, \
3162 api, l2, l2_ctx_type, mtu) \
3163 Z_NET_DEVICE_INIT(DT_INVALID_NODE, dev_id, name, init_fn, pm, \
3164 data, config, prio, api, l2, l2_ctx_type, mtu)
3165
3184#define NET_DEVICE_DT_DEFINE(node_id, init_fn, pm, data, \
3185 config, prio, api, l2, l2_ctx_type, mtu) \
3186 Z_NET_DEVICE_INIT(node_id, Z_DEVICE_DT_DEV_ID(node_id), \
3187 DEVICE_DT_NAME(node_id), init_fn, pm, data, \
3188 config, prio, api, l2, l2_ctx_type, mtu)
3189
3198#define NET_DEVICE_DT_INST_DEFINE(inst, ...) \
3199 NET_DEVICE_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
3200
3224#define NET_DEVICE_INIT_INSTANCE(dev_id, name, instance, init_fn, pm, \
3225 data, config, prio, api, l2, \
3226 l2_ctx_type, mtu) \
3227 Z_NET_DEVICE_INIT_INSTANCE(DT_INVALID_NODE, dev_id, name, \
3228 instance, init_fn, pm, data, config, \
3229 prio, api, l2, l2_ctx_type, mtu)
3230
3253#define NET_DEVICE_DT_DEFINE_INSTANCE(node_id, instance, init_fn, pm, \
3254 data, config, prio, api, l2, \
3255 l2_ctx_type, mtu) \
3256 Z_NET_DEVICE_INIT_INSTANCE(node_id, \
3257 Z_DEVICE_DT_DEV_ID(node_id), \
3258 DEVICE_DT_NAME(node_id), instance, \
3259 init_fn, pm, data, config, prio, \
3260 api, l2, l2_ctx_type, mtu)
3261
3271#define NET_DEVICE_DT_INST_DEFINE_INSTANCE(inst, ...) \
3272 NET_DEVICE_DT_DEFINE_INSTANCE(DT_DRV_INST(inst), __VA_ARGS__)
3273
3274#define Z_NET_DEVICE_OFFLOAD_INIT(node_id, dev_id, name, init_fn, pm, \
3275 data, config, prio, api, mtu) \
3276 Z_DEVICE_STATE_DEFINE(dev_id); \
3277 Z_DEVICE_DEFINE(node_id, dev_id, name, init_fn, pm, data, \
3278 config, POST_KERNEL, prio, api, \
3279 &Z_DEVICE_STATE_NAME(dev_id)); \
3280 NET_IF_OFFLOAD_INIT(dev_id, 0, mtu)
3281
3301#define NET_DEVICE_OFFLOAD_INIT(dev_id, name, init_fn, pm, data, \
3302 config, prio, api, mtu) \
3303 Z_NET_DEVICE_OFFLOAD_INIT(DT_INVALID_NODE, dev_id, name, \
3304 init_fn, pm, data, config, prio, api, \
3305 mtu)
3306
3325#define NET_DEVICE_DT_OFFLOAD_DEFINE(node_id, init_fn, pm, data, \
3326 config, prio, api, mtu) \
3327 Z_NET_DEVICE_OFFLOAD_INIT(node_id, Z_DEVICE_DT_DEV_ID(node_id), \
3328 DEVICE_DT_NAME(node_id), init_fn, pm, \
3329 data, config, prio, api, mtu)
3330
3340#define NET_DEVICE_DT_INST_OFFLOAD_DEFINE(inst, ...) \
3341 NET_DEVICE_DT_OFFLOAD_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
3342
3348#define NET_IFACE_COUNT(_dst) \
3349 do { \
3350 extern struct net_if _net_if_list_start[]; \
3351 extern struct net_if _net_if_list_end[]; \
3352 *(_dst) = ((uintptr_t)_net_if_list_end - \
3353 (uintptr_t)_net_if_list_start) / \
3354 sizeof(struct net_if); \
3355 } while (0)
3356
3357#ifdef __cplusplus
3358}
3359#endif
3360
3361#include <syscalls/net_if.h>
3362
3367#endif /* ZEPHYR_INCLUDE_NET_NET_IF_H_ */
struct z_thread_stack_element k_thread_stack_t
Typedef of struct z_thread_stack_element.
Definition: arch_interface.h:45
long atomic_t
Definition: atomic_types.h:15
DHCPv4 Client Handler.
DHCPv6 client.
static void atomic_set_bit(atomic_t *target, int bit)
Atomically set a bit.
Definition: atomic.h:209
static bool atomic_test_bit(const atomic_t *target, int bit)
Atomically test a bit.
Definition: atomic.h:127
static void atomic_clear_bit(atomic_t *target, int bit)
Atomically clear a bit.
Definition: atomic.h:191
#define ATOMIC_DEFINE(name, num_bits)
Define an array of atomic variables.
Definition: atomic.h:111
static bool atomic_test_and_clear_bit(atomic_t *target, int bit)
Atomically test and clear a bit.
Definition: atomic.h:147
static bool atomic_test_and_set_bit(atomic_t *target, int bit)
Atomically set a bit.
Definition: atomic.h:170
#define K_FOREVER
Generate infinite timeout delay.
Definition: kernel.h:1363
unsigned short int sa_family_t
Socket address family type.
Definition: net_ip.h:164
net_addr_state
What is the current state of the network address.
Definition: net_ip.h:500
net_addr_type
How the network address is assigned to network interface.
Definition: net_ip.h:508
int k_mutex_unlock(struct k_mutex *mutex)
Unlock a mutex.
int k_mutex_lock(struct k_mutex *mutex, k_timeout_t timeout)
Lock a mutex.
net_verdict
Net Verdict.
Definition: net_core.h:100
static int net_hostname_set_postfix(const uint8_t *hostname_postfix, int postfix_len)
Set the device hostname postfix.
Definition: hostname.h:108
struct net_if * net_if_select_src_iface(const struct sockaddr *dst)
Get a network interface that should be used when sending IPv6 or IPv4 network data to destination.
struct net_if_router * net_if_ipv4_router_lookup(struct net_if *iface, struct in_addr *addr)
Check if IPv4 address is one of the routers configured in the system.
int net_if_get_by_iface(struct net_if *iface)
Get interface index according to pointer.
int net_if_up(struct net_if *iface)
Bring interface up.
struct net_if * net_if_get_first_up(void)
Get the first network interface which is up.
struct net_if_addr * net_if_ipv4_addr_lookup(const struct in_addr *addr, struct net_if **iface)
Check if this IPv4 address belongs to one of the interfaces.
int net_if_set_name(struct net_if *iface, const char *buf)
Set network interface name.
static bool net_if_is_carrier_ok(struct net_if *iface)
Check if carrier is present on network device.
Definition: net_if.h:2782
static bool net_if_is_admin_up(struct net_if *iface)
Check if interface was brought up by the administrator.
Definition: net_if.h:2748
void net_if_set_default(struct net_if *iface)
Set the default network interface.
int net_if_ipv4_addr_lookup_by_index(const struct in_addr *addr)
Check if this IPv4 address belongs to one of the interface indices.
int(* net_socket_create_t)(int, int, int)
A function prototype to create an offloaded socket.
Definition: net_if.h:613
struct net_if_addr * net_if_ipv6_addr_lookup(const struct in6_addr *addr, struct net_if **iface)
Check if this IPv6 address belongs to one of the interfaces.
void net_if_ipv4_maddr_leave(struct net_if *iface, struct net_if_mcast_addr *addr)
Mark a given multicast address to be left.
int net_if_ipv6_addr_lookup_by_index(const struct in6_addr *addr)
Check if this IPv6 address belongs to one of the interface indices.
int net_if_get_by_name(const char *name)
Get interface index according to its name.
struct net_if * net_if_get_by_link_addr(struct net_linkaddr *ll_addr)
Get an interface according to link layer address.
void net_if_dormant_off(struct net_if *iface)
Mark interface as not dormant.
bool net_if_ipv6_router_rm(struct net_if_router *router)
Remove IPv6 router from the system.
bool net_if_ipv4_maddr_rm(struct net_if *iface, const struct in_addr *addr)
Remove an IPv4 multicast address from an interface.
void net_if_ipv6_dad_failed(struct net_if *iface, const struct in6_addr *addr)
Stop IPv6 Duplicate Address Detection (DAD) procedure if we find out that our IPv6 address is already...
static enum net_if_oper_state net_if_oper_state_set(struct net_if *iface, enum net_if_oper_state oper_state)
Set an operational state on an interface.
Definition: net_if.h:852
int net_if_down(struct net_if *iface)
Bring interface down.
bool net_if_need_calc_tx_checksum(struct net_if *iface)
Check if network packet checksum calculation can be avoided or not when sending the packet.
struct net_if_router * net_if_ipv4_router_find_default(struct net_if *iface, struct in_addr *addr)
Find default router for this IPv4 address.
bool net_if_ipv6_addr_onlink(struct net_if **iface, struct in6_addr *addr)
Check if this IPv6 address is part of the subnet of our network interface.
static struct in_addr * net_if_router_ipv4(struct net_if_router *router)
Get the IPv4 address of the given router.
Definition: net_if.h:2340
void net_if_ipv6_prefix_unset_timer(struct net_if_ipv6_prefix *prefix)
Unset the prefix lifetime timer.
struct net_if_ipv6_prefix * net_if_ipv6_prefix_add(struct net_if *iface, struct in6_addr *prefix, uint8_t len, uint32_t lifetime)
Add a IPv6 prefix to an network interface.
void net_if_ipv4_set_gw(struct net_if *iface, const struct in_addr *gw)
Set IPv4 gateway for an interface.
int net_if_config_ipv4_get(struct net_if *iface, struct net_if_ipv4 **ipv4)
Allocate network interface IPv4 config.
void net_if_carrier_on(struct net_if *iface)
Underlying network device has detected the carrier (cable connected).
struct net_if_router * net_if_ipv6_router_find_default(struct net_if *iface, struct in6_addr *addr)
Find default router for this IPv6 address.
bool net_if_ipv6_prefix_rm(struct net_if *iface, struct in6_addr *addr, uint8_t len)
Remove an IPv6 prefix from an interface.
void net_if_ipv6_set_mcast_hop_limit(struct net_if *iface, uint8_t hop_limit)
Set the default IPv6 multicast hop limit of a given interface.
void net_if_ipv6_set_hop_limit(struct net_if *iface, uint8_t hop_limit)
Set the default IPv6 hop limit of a given interface.
void(* net_if_link_callback_t)(struct net_if *iface, struct net_linkaddr *dst, int status)
Define callback that is called after a network packet has been sent.
Definition: net_if.h:2600
static void * net_if_l2_data(struct net_if *iface)
Get a pointer to the interface L2 private data.
Definition: net_if.h:923
static bool net_if_are_pending_tx_packets(struct net_if *iface)
Check if there are any pending TX network data for a given network interface.
Definition: net_if.h:2960
struct in_addr net_if_ipv4_get_netmask(struct net_if *iface)
Get IPv4 netmask of an interface.
static bool net_if_flag_test_and_set(struct net_if *iface, enum net_if_flag value)
Test and set a value in network interface flags.
Definition: net_if.h:782
bool net_if_ipv4_addr_rm(struct net_if *iface, const struct in_addr *addr)
Remove a IPv4 address from an interface.
struct net_if_router * net_if_ipv4_router_add(struct net_if *iface, struct in_addr *addr, bool is_default, uint16_t router_lifetime)
Add IPv4 router to the system.
static struct net_linkaddr * net_if_get_link_addr(struct net_if *iface)
Get an network interface's link address.
Definition: net_if.h:1072
void net_if_ipv6_maddr_join(struct net_if *iface, struct net_if_mcast_addr *addr)
Mark a given multicast address to be joined.
static const struct in6_addr * net_if_ipv6_select_src_addr(struct net_if *iface, const struct in6_addr *dst)
Get a IPv6 source address that should be used when sending network data to destination.
Definition: net_if.h:2003
static void net_if_nbr_reachability_hint(struct net_if *iface, const struct in6_addr *ipv6_addr)
Provide a reachability hint for IPv6 Neighbor Discovery.
Definition: net_if.h:1145
static struct net_offload * net_if_offload(struct net_if *iface)
Return the IP offload plugin.
Definition: net_if.h:989
static int net_if_set_link_addr(struct net_if *iface, uint8_t *addr, uint8_t len, enum net_link_type type)
Set a network interface's link address.
Definition: net_if.h:1213
static void net_if_flag_set(struct net_if *iface, enum net_if_flag value)
Set a value in network interface flags.
Definition: net_if.h:765
uint8_t net_if_ipv6_get_hop_limit(struct net_if *iface)
Get IPv6 hop limit specified for a given interface.
struct net_if * net_if_get_default(void)
Get the default network interface.
void net_if_ipv4_set_ttl(struct net_if *iface, uint8_t ttl)
Set IPv4 time-to-live value specified to a given interface.
bool net_if_ipv4_addr_mask_cmp(struct net_if *iface, const struct in_addr *addr)
Check if the given IPv4 address belongs to local subnet.
void net_if_queue_tx(struct net_if *iface, struct net_pkt *pkt)
Queue a packet to the net interface TX queue.
int net_if_config_ipv6_get(struct net_if *iface, struct net_if_ipv6 **ipv6)
Allocate network interface IPv6 config.
void net_if_ipv6_addr_foreach(struct net_if *iface, net_if_ip_addr_cb_t cb, void *user_data)
Go through all IPv6 addresses on a network interface and call callback for each used address.
static const struct in6_addr * net_if_ipv6_select_src_addr_hint(struct net_if *iface, const struct in6_addr *dst, int flags)
Get a IPv6 source address that should be used when sending network data to destination.
Definition: net_if.h:2031
int net_if_get_name(struct net_if *iface, char *buf, int len)
Get network interface name.
void(* net_if_ip_maddr_cb_t)(struct net_if *iface, struct net_if_mcast_addr *maddr, void *user_data)
Callback used while iterating over network interface multicast IP addresses.
Definition: net_if.h:1524
bool net_if_ipv6_addr_rm(struct net_if *iface, const struct in6_addr *addr)
Remove an IPv6 address from an interface.
void net_if_carrier_off(struct net_if *iface)
Underlying network device has lost the carrier (cable disconnected).
void net_if_ipv6_prefix_set_timer(struct net_if_ipv6_prefix *prefix, uint32_t lifetime)
Set the prefix lifetime timer.
void net_if_unregister_link_cb(struct net_if_link_cb *link)
Unregister a link callback.
bool net_if_ipv4_router_rm(struct net_if_router *router)
Remove IPv4 router from the system.
static bool net_if_is_ip_offloaded(struct net_if *iface)
Return the IP offload status.
Definition: net_if.h:961
static bool net_if_is_dormant(struct net_if *iface)
Check if the interface is dormant.
Definition: net_if.h:2818
struct net_if * net_if_get_first_wifi(void)
Get first Wi-Fi network interface.
struct net_if_addr * net_if_ipv4_addr_add(struct net_if *iface, struct in_addr *addr, enum net_addr_type addr_type, uint32_t vlifetime)
Add a IPv4 address to an interface.
uint8_t net_if_ipv4_get_mcast_ttl(struct net_if *iface)
Get IPv4 multicast time-to-live value specified for a given interface.
struct net_if * net_if_get_by_index(int index)
Get interface according to index.
enum net_verdict net_if_recv_data(struct net_if *iface, struct net_pkt *pkt)
Input a packet through a net iface.
void(* net_if_mcast_callback_t)(struct net_if *iface, const struct net_addr *addr, bool is_joined)
Define a callback that is called whenever a IPv6 or IPv4 multicast address group is joined or left.
Definition: net_if.h:1562
struct net_if * net_if_get_first_by_type(const struct net_l2 *l2)
Get the first network interface according to its type.
static void net_if_set_mtu(struct net_if *iface, uint16_t mtu)
Set an network interface's MTU.
Definition: net_if.h:1248
bool net_if_need_calc_rx_checksum(struct net_if *iface)
Check if received network packet checksum calculation can be avoided or not.
struct net_if_mcast_addr * net_if_ipv6_maddr_add(struct net_if *iface, const struct in6_addr *addr)
Add a IPv6 multicast address to an interface.
bool net_if_ipv4_set_netmask_by_addr(struct net_if *iface, const struct in_addr *addr, const struct in_addr *netmask)
Set IPv4 netmask for an interface index for a given address.
uint8_t net_if_ipv4_get_ttl(struct net_if *iface)
Get IPv4 time-to-live value specified for a given interface.
static bool net_if_is_up(struct net_if *iface)
Check if interface is is up and running.
Definition: net_if.h:2724
static void net_if_ipv6_set_reachable_time(struct net_if_ipv6 *ipv6)
Set IPv6 reachable time for a given interface.
Definition: net_if.h:1929
struct in6_addr * net_if_ipv6_get_ll_addr(enum net_addr_state state, struct net_if **iface)
Return link local IPv6 address from the first interface that has a link local address matching give s...
int net_if_config_ipv4_put(struct net_if *iface)
Release network interface IPv4 config.
bool net_if_ipv4_set_netmask_by_addr_by_index(int index, const struct in_addr *addr, const struct in_addr *netmask)
Set IPv4 netmask for an interface index for a given address.
void net_if_dormant_on(struct net_if *iface)
Mark interface as dormant.
int net_if_config_ipv6_put(struct net_if *iface)
Release network interface IPv6 config.
bool net_if_ipv4_is_addr_bcast(struct net_if *iface, const struct in_addr *addr)
Check if the given IPv4 address is a broadcast address.
void net_if_mcast_mon_register(struct net_if_mcast_monitor *mon, struct net_if *iface, net_if_mcast_callback_t cb)
Register a multicast monitor.
void net_if_ipv4_set_mcast_ttl(struct net_if *iface, uint8_t ttl)
Set IPv4 multicast time-to-live value specified to a given interface.
bool net_if_ipv4_set_netmask_by_index(int index, const struct in_addr *netmask)
Set IPv4 netmask for an interface index.
uint8_t net_if_ipv6_get_mcast_hop_limit(struct net_if *iface)
Get IPv6 multicast hop limit specified for a given interface.
static void net_if_start_dad(struct net_if *iface)
Start duplicate address detection procedure.
Definition: net_if.h:1102
void net_if_foreach(net_if_cb_t cb, void *user_data)
Go through all the network interfaces and call callback for each interface.
bool net_if_ipv6_addr_add_by_index(int index, struct in6_addr *addr, enum net_addr_type addr_type, uint32_t vlifetime)
Add a IPv6 address to an interface by index.
struct net_if_router * net_if_ipv6_router_add(struct net_if *iface, struct in6_addr *addr, uint16_t router_lifetime)
Add IPv6 router to the system.
static void net_if_unset_promisc(struct net_if *iface)
Set network interface into normal mode.
Definition: net_if.h:2926
static void net_if_socket_offload_set(struct net_if *iface, net_socket_create_t socket_offload)
Set the function to create an offloaded socket.
Definition: net_if.h:1030
static uint32_t net_if_ipv6_get_reachable_time(struct net_if *iface)
Get IPv6 reachable timeout specified for a given interface.
Definition: net_if.h:1898
static bool net_if_is_promisc(struct net_if *iface)
Check if promiscuous mode is set or not.
Definition: net_if.h:2943
static bool net_if_ipv4_maddr_is_joined(struct net_if_mcast_addr *addr)
Check if given multicast address is joined or not.
Definition: net_if.h:2310
static void net_if_ipv6_prefix_set_lf(struct net_if_ipv6_prefix *prefix, bool is_infinite)
Set the infinite status of the prefix.
Definition: net_if.h:1703
struct net_if_mcast_addr * net_if_ipv4_maddr_add(struct net_if *iface, const struct in_addr *addr)
Add a IPv4 multicast address to an interface.
bool net_if_is_wifi(struct net_if *iface)
Check if the network interface supports Wi-Fi.
void net_if_register_link_cb(struct net_if_link_cb *link, net_if_link_callback_t cb)
Register a link callback.
void net_if_call_link_cb(struct net_if *iface, struct net_linkaddr *lladdr, int status)
Call a link callback function.
void net_if_ipv6_router_update_lifetime(struct net_if_router *router, uint16_t lifetime)
Update validity lifetime time of a router.
void net_if_ipv4_addr_foreach(struct net_if *iface, net_if_ip_addr_cb_t cb, void *user_data)
Go through all IPv4 addresses on a network interface and call callback for each used address.
struct net_if_ipv6_prefix * net_if_ipv6_prefix_lookup(struct net_if *iface, struct in6_addr *addr, uint8_t len)
Check if this IPv6 prefix belongs to this interface.
static void net_if_stop_rs(struct net_if *iface)
Stop neighbor discovery.
Definition: net_if.h:1124
uint32_t net_if_ipv6_calc_reachable_time(struct net_if_ipv6 *ipv6)
Calculate next reachable time value for IPv6 reachable time.
static void net_if_ipv6_set_base_reachable_time(struct net_if *iface, uint32_t reachable_time)
Set IPv6 reachable time for a given interface.
Definition: net_if.h:1873
struct net_if_addr * net_if_ipv6_addr_lookup_by_iface(struct net_if *iface, struct in6_addr *addr)
Check if this IPv6 address belongs to this specific interfaces.
void net_if_ipv6_maddr_foreach(struct net_if *iface, net_if_ip_maddr_cb_t cb, void *user_data)
Go through all IPv6 multicast addresses on a network interface and call callback for each used addres...
static bool net_if_flag_test_and_clear(struct net_if *iface, enum net_if_flag value)
Test and clear a value in network interface flags.
Definition: net_if.h:814
void net_if_start_rs(struct net_if *iface)
Start neighbor discovery and send router solicitation message.
static bool net_if_ipv6_maddr_is_joined(struct net_if_mcast_addr *addr)
Check if given multicast address is joined or not.
Definition: net_if.h:1630
bool net_if_ipv6_addr_rm_by_index(int index, const struct in6_addr *addr)
Remove an IPv6 address from an interface by index.
bool net_if_ipv4_addr_rm_by_index(int index, const struct in_addr *addr)
Remove a IPv4 address from an interface by interface index.
struct in6_addr * net_if_ipv6_get_global_addr(enum net_addr_state state, struct net_if **iface)
Return global IPv6 address from the first interface that has a global IPv6 address matching the given...
static uint16_t net_if_get_mtu(struct net_if *iface)
Get an network interface's MTU.
Definition: net_if.h:1231
struct net_if_router * net_if_ipv6_router_lookup(struct net_if *iface, struct in6_addr *addr)
Check if IPv6 address is one of the routers configured in the system.
bool net_if_ipv4_addr_add_by_index(int index, struct in_addr *addr, enum net_addr_type addr_type, uint32_t vlifetime)
Add a IPv4 address to an interface by network interface index.
void net_if_ipv6_maddr_leave(struct net_if *iface, struct net_if_mcast_addr *addr)
Mark a given multicast address to be left.
struct in_addr * net_if_ipv4_get_ll(struct net_if *iface, enum net_addr_state addr_state)
Get a IPv4 link local address in a given state.
void net_if_mcast_mon_unregister(struct net_if_mcast_monitor *mon)
Unregister a multicast monitor.
void net_if_ipv4_set_netmask(struct net_if *iface, const struct in_addr *netmask)
Set IPv4 netmask for an interface.
static const struct in_addr * net_if_ipv4_select_src_addr(struct net_if *iface, const struct in_addr *dst)
Get a IPv4 source address that should be used when sending network data to destination.
Definition: net_if.h:2455
struct in6_addr * net_if_ipv6_get_ll(struct net_if *iface, enum net_addr_state addr_state)
Get a IPv6 link local address in a given state.
static void net_if_ipv6_set_retrans_timer(struct net_if *iface, uint32_t retrans_timer)
Set IPv6 retransmit timer for a given interface.
Definition: net_if.h:1948
struct in_addr * net_if_ipv4_get_global_addr(struct net_if *iface, enum net_addr_state addr_state)
Get a IPv4 global address in a given state.
enum net_verdict net_if_send_data(struct net_if *iface, struct net_pkt *pkt)
Send a packet through a net iface.
struct net_if_mcast_addr * net_if_ipv6_maddr_lookup(const struct in6_addr *addr, struct net_if **iface)
Check if this IPv6 multicast address belongs to a specific interface or one of the interfaces.
struct net_if * net_if_lookup_by_dev(const struct device *dev)
Find an interface from it's related device.
static struct in6_addr * net_if_router_ipv6(struct net_if_router *router)
Get the IPv6 address of the given router.
Definition: net_if.h:1751
struct net_if_mcast_addr * net_if_ipv4_maddr_lookup(const struct in_addr *addr, struct net_if **iface)
Check if this IPv4 multicast address belongs to a specific interface or one of the interfaces.
void net_if_router_rm(struct net_if_router *router)
Remove a router from the system.
static uint32_t net_if_ipv6_get_retrans_timer(struct net_if *iface)
Get IPv6 retransmit timer specified for a given interface.
Definition: net_if.h:1972
void(* net_if_ip_addr_cb_t)(struct net_if *iface, struct net_if_addr *addr, void *user_data)
Callback used while iterating over network interface IP addresses.
Definition: net_if.h:1480
bool net_if_ipv4_set_gw_by_index(int index, const struct in_addr *gw)
Set IPv4 gateway for an interface index.
struct in_addr net_if_ipv4_get_netmask_by_addr(struct net_if *iface, const struct in_addr *addr)
Get IPv4 netmask related to an address of an interface.
net_if_oper_state
Network interface operational status (RFC 2863).
Definition: net_if.h:267
struct net_if_addr * net_if_ipv6_addr_add(struct net_if *iface, struct in6_addr *addr, enum net_addr_type addr_type, uint32_t vlifetime)
Add a IPv6 address to an interface.
static struct net_if * net_if_ipv6_select_src_iface(const struct in6_addr *dst)
Get a network interface that should be used when sending IPv6 network data to destination.
Definition: net_if.h:2054
static bool net_if_flag_is_set(struct net_if *iface, enum net_if_flag value)
Check if a value in network interface flags is set.
Definition: net_if.h:831
static struct net_if_config * net_if_config_get(struct net_if *iface)
Get network interface IP config.
Definition: net_if.h:1299
static struct net_if_config * net_if_get_config(struct net_if *iface)
Return network configuration for this network interface.
Definition: net_if.h:1087
void net_if_ipv4_maddr_join(struct net_if *iface, struct net_if_mcast_addr *addr)
Mark a given multicast address to be joined.
static void net_if_addr_set_lf(struct net_if_addr *ifaddr, bool is_infinite)
Set the infinite status of the network interface address.
Definition: net_if.h:1266
net_if_flag
Network interface flags.
Definition: net_if.h:209
void net_if_ipv4_maddr_foreach(struct net_if *iface, net_if_ip_maddr_cb_t cb, void *user_data)
Go through all IPv4 multicast addresses on a network interface and call callback for each used addres...
struct net_if_ipv6_prefix * net_if_ipv6_prefix_get(struct net_if *iface, const struct in6_addr *addr)
Return prefix that corresponds to this IPv6 address.
static const struct device * net_if_get_device(struct net_if *iface)
Get an network interface's device.
Definition: net_if.h:938
void(* net_if_cb_t)(struct net_if *iface, void *user_data)
Callback used while iterating over network interfaces.
Definition: net_if.h:2697
bool net_if_is_offloaded(struct net_if *iface)
Return offload status of a given network interface.
void net_if_ipv6_addr_update_lifetime(struct net_if_addr *ifaddr, uint32_t vlifetime)
Update validity lifetime time of an IPv6 address.
bool net_if_ipv6_maddr_rm(struct net_if *iface, const struct in6_addr *addr)
Remove an IPv6 multicast address from an interface.
static bool net_if_is_socket_offloaded(struct net_if *iface)
Return the socket offload status.
Definition: net_if.h:1010
static int net_if_set_promisc(struct net_if *iface)
Set network interface into promiscuous mode.
Definition: net_if.h:2910
static const struct net_l2 * net_if_l2(struct net_if *iface)
Get a pointer to the interface L2.
Definition: net_if.h:897
static net_socket_create_t net_if_socket_offload(struct net_if *iface)
Return the function to create an offloaded socket.
Definition: net_if.h:1051
static struct net_if * net_if_ipv4_select_src_iface(const struct in_addr *dst)
Get a network interface that should be used when sending IPv4 network data to destination.
Definition: net_if.h:2431
static void net_if_flag_clear(struct net_if *iface, enum net_if_flag value)
Clear a value in network interface flags.
Definition: net_if.h:797
@ NET_IF_OPER_TESTING
Training mode.
Definition: net_if.h:272
@ NET_IF_OPER_DORMANT
Waiting external action.
Definition: net_if.h:273
@ NET_IF_OPER_UP
Interface is up.
Definition: net_if.h:274
@ NET_IF_OPER_NOTPRESENT
Hardware missing.
Definition: net_if.h:269
@ NET_IF_OPER_UNKNOWN
Initial (unknown) value.
Definition: net_if.h:268
@ NET_IF_OPER_DOWN
Interface is down.
Definition: net_if.h:270
@ NET_IF_OPER_LOWERLAYERDOWN
Lower layer interface is down.
Definition: net_if.h:271
@ NET_IF_NO_AUTO_START
Do not start the interface immediately after initialization.
Definition: net_if.h:225
@ NET_IF_IPV6_NO_MLD
IPv6 Multicast Listener Discovery disabled.
Definition: net_if.h:255
@ NET_IF_POINTOPOINT
Interface is pointopoint.
Definition: net_if.h:214
@ NET_IF_IPV6_NO_ND
IPv6 Neighbor Discovery disabled.
Definition: net_if.h:252
@ NET_IF_FORWARD_MULTICASTS
Flag defines if received multicasts of other interface are forwarded on this interface.
Definition: net_if.h:234
@ NET_IF_IPV4
Interface supports IPv4.
Definition: net_if.h:237
@ NET_IF_PROMISC
Interface is in promiscuous mode.
Definition: net_if.h:217
@ NET_IF_DORMANT
Driver signals dormant.
Definition: net_if.h:249
@ NET_IF_SUSPENDED
Power management specific: interface is being suspended.
Definition: net_if.h:228
@ NET_IF_IPV6
Interface supports IPv6.
Definition: net_if.h:240
@ NET_IF_UP
Interface is admin up.
Definition: net_if.h:211
@ NET_IF_LOWER_UP
Driver signals L1 is up.
Definition: net_if.h:246
@ NET_IF_RUNNING
Interface up and running (ready to receive and transmit).
Definition: net_if.h:243
@ NET_IF_NO_TX_LOCK
Mutex locking on TX data path disabled on the interface.
Definition: net_if.h:258
net_link_type
Type of the link address.
Definition: net_linkaddr.h:47
struct _slist sys_slist_t
Single-linked list structure.
Definition: slist.h:49
struct _snode sys_snode_t
Single-linked list node structure.
Definition: slist.h:39
#define ENOTSUP
Unsupported value.
Definition: errno.h:115
#define EPERM
Not owner.
Definition: errno.h:40
Hostname configuration definitions.
IPv4 Autoconfiguration.
net_ipv4_autoconf_state
Current state of IPv4 Autoconfiguration.
Definition: ipv4_autoconf.h:15
Network core definitions.
IPv6 and IPv4 definitions.
Public API for network L2 interface.
Public API for network link address.
Network statistics.
Network timer with wrap around.
flags
Definition: parser.h:96
state
Definition: parser_state.h:29
__UINT32_TYPE__ uint32_t
Definition: stdint.h:90
__INT32_TYPE__ int32_t
Definition: stdint.h:74
__UINT64_TYPE__ uint64_t
Definition: stdint.h:91
__UINT8_TYPE__ uint8_t
Definition: stdint.h:88
__UINT16_TYPE__ uint16_t
Definition: stdint.h:89
__INT64_TYPE__ int64_t
Definition: stdint.h:75
__INT16_TYPE__ int16_t
Definition: stdint.h:73
Runtime device structure (in ROM) per driver instance.
Definition: device.h:399
IPv6 address struct.
Definition: net_ip.h:139
IPv4 address struct.
Definition: net_ip.h:151
Definition: kernel.h:2388
Mutex Structure.
Definition: kernel.h:2914
Thread Structure.
Definition: thread.h:259
DHCPv6 client configuration parameters.
Definition: dhcpv6.h:61
Network Interface unicast IPv4 address and netmask.
Definition: net_if.h:418
struct net_if_addr ipv4
IPv4 address.
Definition: net_if.h:420
struct in_addr netmask
Netmask.
Definition: net_if.h:422
Network Interface unicast IP addresses.
Definition: net_if.h:52
struct net_addr address
IP address.
Definition: net_if.h:54
uint8_t is_mesh_local
Is this IP address usage limited to the subnet (mesh) or not.
Definition: net_if.h:109
uint8_t is_temporary
Is this IP address temporary and generated for example by IPv6 privacy extension (RFC 8981)
Definition: net_if.h:114
enum net_addr_state addr_state
What is the current state of the address.
Definition: net_if.h:74
uint8_t is_infinite
Is the IP address valid forever.
Definition: net_if.h:103
atomic_t atomic_ref
Reference counter.
Definition: net_if.h:59
enum net_addr_type addr_type
How the IP address was set.
Definition: net_if.h:71
uint8_t is_used
Is this IP address used or not.
Definition: net_if.h:106
IP and other configuration related data for network interface.
Definition: net_if.h:552
Network Interface Device structure.
Definition: net_if.h:629
enum net_if_oper_state oper_state
RFC 2863 operational status.
Definition: net_if.h:665
const struct net_l2 *const l2
Interface's L2 layer.
Definition: net_if.h:634
void * l2_data
Interface's private L2 data pointer.
Definition: net_if.h:637
uint16_t mtu
The hardware MTU.
Definition: net_if.h:655
const struct device * dev
The actually device driver instance the net_if is related to.
Definition: net_if.h:631
struct net_linkaddr link_addr
The hardware link address.
Definition: net_if.h:643
atomic_t flags[ATOMIC_BITMAP_SIZE(NET_IF_NUM_FLAGS)]
For internal use.
Definition: net_if.h:640
Network interface IP address configuration.
Definition: net_if.h:539
IPv4 configuration.
Definition: net_if.h:426
uint8_t mcast_ttl
IPv4 time-to-live for multicast packets.
Definition: net_if.h:440
struct net_if_addr_ipv4 unicast[NET_IF_MAX_IPV4_ADDR]
Unicast IP addresses.
Definition: net_if.h:428
struct in_addr gw
Gateway.
Definition: net_if.h:434
uint8_t ttl
IPv4 time-to-live.
Definition: net_if.h:437
struct net_if_mcast_addr mcast[NET_IF_MAX_IPV4_MADDR]
Multicast IP addresses.
Definition: net_if.h:431
Network Interface IPv6 prefixes.
Definition: net_if.h:153
struct net_if * iface
Backpointer to network interface where this prefix is used.
Definition: net_if.h:161
uint8_t is_infinite
Is the IP prefix valid forever.
Definition: net_if.h:167
uint8_t len
Prefix length.
Definition: net_if.h:164
struct in6_addr prefix
IPv6 prefix.
Definition: net_if.h:158
uint8_t is_used
Is this prefix used or not.
Definition: net_if.h:170
struct net_timeout lifetime
Prefix lifetime.
Definition: net_if.h:155
IPv6 configuration.
Definition: net_if.h:294
struct net_if_ipv6_prefix prefix[NET_IF_MAX_IPV6_PREFIX]
Prefixes.
Definition: net_if.h:302
uint32_t base_reachable_time
Default reachable time (RFC 4861, page 52)
Definition: net_if.h:305
uint8_t hop_limit
IPv6 hop limit.
Definition: net_if.h:333
struct net_if_mcast_addr mcast[NET_IF_MAX_IPV6_MADDR]
Multicast IP addresses.
Definition: net_if.h:299
uint32_t retrans_timer
Retransmit timer (RFC 4861, page 52)
Definition: net_if.h:311
struct net_if_addr unicast[NET_IF_MAX_IPV6_ADDR]
Unicast IP addresses.
Definition: net_if.h:296
uint8_t mcast_hop_limit
IPv6 multicast hop limit.
Definition: net_if.h:336
uint32_t reachable_time
Reachable time (RFC 4861, page 20)
Definition: net_if.h:308
Network Interface multicast IP addresses.
Definition: net_if.h:124
struct net_addr address
IP address.
Definition: net_if.h:126
uint8_t is_joined
Did we join to this group.
Definition: net_if.h:143
uint8_t is_used
Is this multicast IP address used or not.
Definition: net_if.h:140
Multicast monitor handler struct.
Definition: net_if.h:1574
sys_snode_t node
Node information for the slist.
Definition: net_if.h:1576
net_if_mcast_callback_t cb
Multicast callback.
Definition: net_if.h:1582
struct net_if * iface
Network interface.
Definition: net_if.h:1579
Information about routers in the system.
Definition: net_if.h:180
struct net_if * iface
Network interface the router is connected to.
Definition: net_if.h:188
uint8_t is_default
Is default router.
Definition: net_if.h:200
uint16_t lifetime
Router lifetime.
Definition: net_if.h:194
uint8_t is_infinite
Is the router valid forever.
Definition: net_if.h:203
uint8_t is_used
Is this router used or not.
Definition: net_if.h:197
struct net_addr address
IP address.
Definition: net_if.h:185
sys_snode_t node
Slist lifetime timer node.
Definition: net_if.h:182
uint32_t life_start
Router life timer start.
Definition: net_if.h:191
Network Interface structure.
Definition: net_if.h:675
struct net_if_dev * if_dev
The net_if_dev instance the net_if is related to.
Definition: net_if.h:677
struct net_if_config config
Network interface instance configuration.
Definition: net_if.h:685
uint8_t pe_enabled
Network interface specific flags.
Definition: net_if.h:705
struct k_mutex lock
Mutex protecting this network interface instance.
Definition: net_if.h:696
uint8_t pe_prefer_public
If PE is enabled, then this tells whether public addresses are preferred over temporary ones for this...
Definition: net_if.h:710
struct k_mutex tx_lock
Mutex used when sending data.
Definition: net_if.h:699
Network L2 structure.
Definition: net_l2.h:55
Hardware link address structure.
Definition: net_linkaddr.h:67
uint8_t * addr
The array of byte representing the address.
Definition: net_linkaddr.h:69
uint8_t type
What kind of address is this for.
Definition: net_linkaddr.h:75
uint8_t len
Length of that address array.
Definition: net_linkaddr.h:72
Network packet.
Definition: net_pkt.h:67
All network statistics in one struct.
Definition: net_stats.h:323
Generic struct for handling network timeouts.
Definition: net_timeout.h:55
Network traffic class.
Definition: net_if.h:596
k_thread_stack_t * stack
Stack for this handler.
Definition: net_if.h:604
struct k_thread handler
Traffic class handler thread.
Definition: net_if.h:601
struct k_fifo fifo
Fifo for handling this Tx or Rx packet.
Definition: net_if.h:598
Generic sockaddr struct.
Definition: net_ip.h:385