Zephyr API Documentation 4.0.0
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
24#include <zephyr/device.h>
25#include <zephyr/sys/slist.h>
27#include <zephyr/net/net_core.h>
28#include <zephyr/net/hostname.h>
30#include <zephyr/net/net_ip.h>
31#include <zephyr/net/net_l2.h>
34
35#if defined(CONFIG_NET_DHCPV4) && defined(CONFIG_NET_NATIVE_IPV4)
36#include <zephyr/net/dhcpv4.h>
37#endif
38#if defined(CONFIG_NET_DHCPV6) && defined(CONFIG_NET_NATIVE_IPV6)
39#include <zephyr/net/dhcpv6.h>
40#endif
41#if defined(CONFIG_NET_IPV4_AUTO) && defined(CONFIG_NET_NATIVE_IPV4)
43#endif
44
45#ifdef __cplusplus
46extern "C" {
47#endif
48
56 struct net_addr address;
57
62
63#if defined(CONFIG_NET_NATIVE_IPV6)
64 struct net_timeout lifetime;
65#endif
66
69
72
73#if defined(CONFIG_NET_NATIVE_IPV6)
74#if defined(CONFIG_NET_IPV6_PE)
78 uint32_t addr_create_time;
79
82 uint32_t addr_preferred_lifetime;
83
88 int32_t addr_timeout;
89#endif
90#endif /* CONFIG_NET_NATIVE_IPV6 */
91
92 union {
93#if defined(CONFIG_NET_IPV6_DAD)
94 struct {
96 sys_snode_t dad_node;
97 uint32_t dad_start;
98
100 uint8_t dad_count;
101 };
102#endif /* CONFIG_NET_IPV6_DAD */
103#if defined(CONFIG_NET_IPV4_ACD)
104 struct {
106 sys_snode_t acd_node;
107 k_timepoint_t acd_timeout;
108
110 uint8_t acd_count;
111
113 uint8_t acd_state;
114 };
115#endif /* CONFIG_NET_IPV4_ACD */
116 };
117
118#if defined(CONFIG_NET_IPV6_DAD) || defined(CONFIG_NET_IPV4_ACD)
120 uint8_t ifindex;
121#endif
122
125
128
131
136
137 uint8_t _unused : 4;
138};
139
147 struct net_addr address;
148
149#if defined(CONFIG_NET_IPV4_IGMPV3)
151 struct net_addr sources[CONFIG_NET_IF_MCAST_IPV4_SOURCE_COUNT];
152
154 uint16_t sources_len;
155
157 uint8_t record_type;
158#endif
159
162
165
166 uint8_t _unused : 6;
167};
168
177
180
182 struct net_if *iface;
183
186
189
192
193 uint8_t _unused : 6;
194};
195
204
206 struct net_addr address;
207
209 struct net_if *iface;
210
213
216
219
222
225
226 uint8_t _unused : 5;
227};
228
286
297
298#if defined(CONFIG_NET_OFFLOAD)
299struct net_offload;
300#endif /* CONFIG_NET_OFFLOAD */
301
303#if defined(CONFIG_NET_IPV6)
304#define NET_IF_MAX_IPV6_ADDR CONFIG_NET_IF_UNICAST_IPV6_ADDR_COUNT
305#define NET_IF_MAX_IPV6_MADDR CONFIG_NET_IF_MCAST_IPV6_ADDR_COUNT
306#define NET_IF_MAX_IPV6_PREFIX CONFIG_NET_IF_IPV6_PREFIX_COUNT
307#else
308#define NET_IF_MAX_IPV6_ADDR 0
309#define NET_IF_MAX_IPV6_MADDR 0
310#define NET_IF_MAX_IPV6_PREFIX 0
311#endif
312/* @endcond */
313
317 struct net_if_addr unicast[NET_IF_MAX_IPV6_ADDR];
318
320 struct net_if_mcast_addr mcast[NET_IF_MAX_IPV6_MADDR];
321
323 struct net_if_ipv6_prefix prefix[NET_IF_MAX_IPV6_PREFIX];
324
327
330
333
334#if defined(CONFIG_NET_IPV6_PE)
339 uint32_t desync_factor;
340#endif /* CONFIG_NET_IPV6_PE */
341
342#if defined(CONFIG_NET_IPV6_ND) && defined(CONFIG_NET_NATIVE_IPV6)
344 sys_snode_t rs_node;
345
346 /* RS start time */
347 uint32_t rs_start;
348
350 uint8_t rs_count;
351#endif
352
355
358};
359
360#if defined(CONFIG_NET_DHCPV6) && defined(CONFIG_NET_NATIVE_IPV6)
362struct net_if_dhcpv6 {
364 sys_snode_t node;
365
367 struct net_dhcpv6_duid_storage clientid;
368
370 struct net_dhcpv6_duid_storage serverid;
371
373 enum net_dhcpv6_state state;
374
376 struct net_dhcpv6_params params;
377
379 uint64_t timeout;
380
382 uint64_t exchange_start;
383
385 uint64_t t1;
386
388 uint64_t t2;
389
393 uint64_t expire;
394
396 uint32_t addr_iaid;
397
399 uint32_t prefix_iaid;
400
402 uint32_t retransmit_timeout;
403
405 int16_t server_preference;
406
408 uint8_t retransmissions;
409
411 uint8_t tid[DHCPV6_TID_SIZE];
412
414 uint8_t prefix_len;
415
417 struct in6_addr prefix;
418
420 struct in6_addr addr;
421};
422#endif /* defined(CONFIG_NET_DHCPV6) && defined(CONFIG_NET_NATIVE_IPV6) */
423
425#if defined(CONFIG_NET_IPV4)
426#define NET_IF_MAX_IPV4_ADDR CONFIG_NET_IF_UNICAST_IPV4_ADDR_COUNT
427#define NET_IF_MAX_IPV4_MADDR CONFIG_NET_IF_MCAST_IPV4_ADDR_COUNT
428#else
429#define NET_IF_MAX_IPV4_ADDR 0
430#define NET_IF_MAX_IPV4_MADDR 0
431#endif
445
449 struct net_if_addr_ipv4 unicast[NET_IF_MAX_IPV4_ADDR];
450
452 struct net_if_mcast_addr mcast[NET_IF_MAX_IPV4_MADDR];
453
455 struct in_addr gw;
456
459
462
463#if defined(CONFIG_NET_IPV4_ACD)
465 uint8_t conflict_cnt;
466#endif
467};
468
469#if defined(CONFIG_NET_DHCPV4) && defined(CONFIG_NET_NATIVE_IPV4)
470struct net_if_dhcpv4 {
472 sys_snode_t node;
473
475 int64_t timer_start;
476
478 uint32_t request_time;
479
480 uint32_t xid;
481
483 uint32_t lease_time;
484
486 uint32_t renewal_time;
487
489 uint32_t rebinding_time;
490
492 struct in_addr server_id;
493
495 struct in_addr requested_ip;
496
498 struct in_addr netmask;
499
504 enum net_dhcpv4_state state;
505
507 uint8_t attempts;
508
510 struct in_addr request_server_addr;
511
513 struct in_addr response_src_addr;
514
515#ifdef CONFIG_NET_DHCPV4_OPTION_NTP_SERVER
517 struct in_addr ntp_addr;
518#endif
519};
520#endif /* CONFIG_NET_DHCPV4 */
521
522#if defined(CONFIG_NET_IPV4_AUTO) && defined(CONFIG_NET_NATIVE_IPV4)
523struct net_if_ipv4_autoconf {
525 struct net_if *iface;
526
528 struct in_addr requested_ip;
529
533};
534#endif /* CONFIG_NET_IPV4_AUTO */
535
537/* We always need to have at least one IP config */
538#define NET_IF_MAX_CONFIGS 1
544struct net_if_ip {
545#if defined(CONFIG_NET_IPV6)
546 struct net_if_ipv6 *ipv6;
547#endif /* CONFIG_NET_IPV6 */
548
549#if defined(CONFIG_NET_IPV4)
550 struct net_if_ipv4 *ipv4;
551#endif /* CONFIG_NET_IPV4 */
552};
553
558#if defined(CONFIG_NET_IP)
560 struct net_if_ip ip;
561#endif
562
563#if defined(CONFIG_NET_DHCPV4) && defined(CONFIG_NET_NATIVE_IPV4)
564 struct net_if_dhcpv4 dhcpv4;
565#endif /* CONFIG_NET_DHCPV4 */
566
567#if defined(CONFIG_NET_DHCPV6) && defined(CONFIG_NET_NATIVE_IPV6)
568 struct net_if_dhcpv6 dhcpv6;
569#endif /* CONFIG_NET_DHCPV6 */
570
571#if defined(CONFIG_NET_IPV4_AUTO) && defined(CONFIG_NET_NATIVE_IPV4)
572 struct net_if_ipv4_autoconf ipv4auto;
573#endif /* CONFIG_NET_IPV4_AUTO */
574
575#if defined(CONFIG_NET_L2_VIRTUAL)
580 sys_slist_t virtual_interfaces;
581#endif /* CONFIG_NET_L2_VIRTUAL */
582
583#if defined(CONFIG_NET_INTERFACE_NAME)
588 char name[CONFIG_NET_INTERFACE_NAME_LEN + 1];
589#endif
590};
591
611
618typedef int (*net_socket_create_t)(int, int, int);
619
636 const struct device *dev;
637
639 const struct net_l2 * const l2;
640
642 void *l2_data;
643
645 ATOMIC_DEFINE(flags, NET_IF_NUM_FLAGS);
646
649
650#if defined(CONFIG_NET_OFFLOAD)
656 struct net_offload *offload;
657#endif /* CONFIG_NET_OFFLOAD */
658
661
662#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
666 net_socket_create_t socket_offload;
667#endif /* CONFIG_NET_SOCKETS_OFFLOAD */
668
671};
672
680struct net_if {
683
684#if defined(CONFIG_NET_STATISTICS_PER_INTERFACE)
686 struct net_stats stats;
687#endif /* CONFIG_NET_STATISTICS_PER_INTERFACE */
688
691
692#if defined(CONFIG_NET_POWER_MANAGEMENT)
697 int tx_pending;
698#endif
699
701 struct k_mutex lock;
702
705
711
716
718 uint8_t _unused : 6;
719};
720
723static inline void net_if_lock(struct net_if *iface)
724{
725 NET_ASSERT(iface);
726
727 (void)k_mutex_lock(&iface->lock, K_FOREVER);
728}
729
730static inline void net_if_unlock(struct net_if *iface)
731{
732 NET_ASSERT(iface);
733
734 k_mutex_unlock(&iface->lock);
735}
736
737static inline bool net_if_flag_is_set(struct net_if *iface,
738 enum net_if_flag value);
739
740static inline void net_if_tx_lock(struct net_if *iface)
741{
742 NET_ASSERT(iface);
743
745 return;
746 }
747
748 (void)k_mutex_lock(&iface->tx_lock, K_FOREVER);
749}
750
751static inline void net_if_tx_unlock(struct net_if *iface)
752{
753 NET_ASSERT(iface);
754
756 return;
757 }
758
759 k_mutex_unlock(&iface->tx_lock);
760}
761
770static inline void net_if_flag_set(struct net_if *iface,
771 enum net_if_flag value)
772{
773 NET_ASSERT(iface);
774 NET_ASSERT(iface->if_dev);
775
776 atomic_set_bit(iface->if_dev->flags, value);
777}
778
787static inline bool net_if_flag_test_and_set(struct net_if *iface,
788 enum net_if_flag value)
789{
790 NET_ASSERT(iface);
791 NET_ASSERT(iface->if_dev);
792
793 return atomic_test_and_set_bit(iface->if_dev->flags, value);
794}
795
802static inline void net_if_flag_clear(struct net_if *iface,
803 enum net_if_flag value)
804{
805 NET_ASSERT(iface);
806 NET_ASSERT(iface->if_dev);
807
808 atomic_clear_bit(iface->if_dev->flags, value);
809}
810
819static inline bool net_if_flag_test_and_clear(struct net_if *iface,
820 enum net_if_flag value)
821{
822 NET_ASSERT(iface);
823 NET_ASSERT(iface->if_dev);
824
825 return atomic_test_and_clear_bit(iface->if_dev->flags, value);
826}
827
836static inline bool net_if_flag_is_set(struct net_if *iface,
837 enum net_if_flag value)
838{
839 NET_ASSERT(iface);
840 NET_ASSERT(iface->if_dev);
841
842 if (iface == NULL) {
843 return false;
844 }
845
846 return atomic_test_bit(iface->if_dev->flags, value);
847}
848
858 struct net_if *iface, enum net_if_oper_state oper_state)
859{
860 NET_ASSERT(iface);
861 NET_ASSERT(iface->if_dev);
862
863 BUILD_ASSERT((enum net_if_oper_state)(-1) > 0 && NET_IF_OPER_UNKNOWN == 0);
864 if (oper_state <= NET_IF_OPER_UP) {
865 iface->if_dev->oper_state = oper_state;
866 }
867
868 return iface->if_dev->oper_state;
869}
870
878static inline enum net_if_oper_state net_if_oper_state(struct net_if *iface)
879{
880 NET_ASSERT(iface);
881 NET_ASSERT(iface->if_dev);
882
883 return iface->if_dev->oper_state;
884}
885
894enum net_verdict net_if_send_data(struct net_if *iface, struct net_pkt *pkt);
895
903static inline const struct net_l2 *net_if_l2(struct net_if *iface)
904{
905 if (!iface || !iface->if_dev) {
906 return NULL;
907 }
908
909 return iface->if_dev->l2;
910}
911
920enum net_verdict net_if_recv_data(struct net_if *iface, struct net_pkt *pkt);
921
929static inline void *net_if_l2_data(struct net_if *iface)
930{
931 NET_ASSERT(iface);
932 NET_ASSERT(iface->if_dev);
933
934 return iface->if_dev->l2_data;
935}
936
944static inline const struct device *net_if_get_device(struct net_if *iface)
945{
946 NET_ASSERT(iface);
947 NET_ASSERT(iface->if_dev);
948
949 return iface->if_dev->dev;
950}
951
958void net_if_queue_tx(struct net_if *iface, struct net_pkt *pkt);
959
967static inline bool net_if_is_ip_offloaded(struct net_if *iface)
968{
969#if defined(CONFIG_NET_OFFLOAD)
970 return (iface != NULL && iface->if_dev != NULL &&
971 iface->if_dev->offload != NULL);
972#else
973 ARG_UNUSED(iface);
974
975 return false;
976#endif
977}
978
986bool net_if_is_offloaded(struct net_if *iface);
987
995static inline struct net_offload *net_if_offload(struct net_if *iface)
996{
997#if defined(CONFIG_NET_OFFLOAD)
998 NET_ASSERT(iface);
999 NET_ASSERT(iface->if_dev);
1000
1001 return iface->if_dev->offload;
1002#else
1003 ARG_UNUSED(iface);
1004
1005 return NULL;
1006#endif
1007}
1008
1016static inline bool net_if_is_socket_offloaded(struct net_if *iface)
1017{
1018#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
1019 NET_ASSERT(iface);
1020 NET_ASSERT(iface->if_dev);
1021
1022 return (iface->if_dev->socket_offload != NULL);
1023#else
1024 ARG_UNUSED(iface);
1025
1026 return false;
1027#endif
1028}
1029
1036static inline void net_if_socket_offload_set(
1037 struct net_if *iface, net_socket_create_t socket_offload)
1038{
1039#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
1040 NET_ASSERT(iface);
1041 NET_ASSERT(iface->if_dev);
1042
1043 iface->if_dev->socket_offload = socket_offload;
1044#else
1045 ARG_UNUSED(iface);
1046 ARG_UNUSED(socket_offload);
1047#endif
1048}
1049
1058{
1059#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
1060 NET_ASSERT(iface);
1061 NET_ASSERT(iface->if_dev);
1062
1063 return iface->if_dev->socket_offload;
1064#else
1065 ARG_UNUSED(iface);
1066
1067 return NULL;
1068#endif
1069}
1070
1078static inline struct net_linkaddr *net_if_get_link_addr(struct net_if *iface)
1079{
1080 NET_ASSERT(iface);
1081 NET_ASSERT(iface->if_dev);
1082
1083 return &iface->if_dev->link_addr;
1084}
1085
1093static inline struct net_if_config *net_if_get_config(struct net_if *iface)
1094{
1095 NET_ASSERT(iface);
1096
1097 return &iface->config;
1098}
1099
1105#if defined(CONFIG_NET_IPV6_DAD) && defined(CONFIG_NET_NATIVE_IPV6)
1106void net_if_start_dad(struct net_if *iface);
1107#else
1108static inline void net_if_start_dad(struct net_if *iface)
1109{
1110 ARG_UNUSED(iface);
1111}
1112#endif
1113
1119void net_if_start_rs(struct net_if *iface);
1120
1121
1127#if defined(CONFIG_NET_IPV6_ND) && defined(CONFIG_NET_NATIVE_IPV6)
1128void net_if_stop_rs(struct net_if *iface);
1129#else
1130static inline void net_if_stop_rs(struct net_if *iface)
1131{
1132 ARG_UNUSED(iface);
1133}
1134#endif /* CONFIG_NET_IPV6_ND */
1135
1148#if defined(CONFIG_NET_IPV6_ND) && defined(CONFIG_NET_NATIVE_IPV6)
1149void net_if_nbr_reachability_hint(struct net_if *iface, const struct in6_addr *ipv6_addr);
1150#else
1151static inline void net_if_nbr_reachability_hint(struct net_if *iface,
1152 const struct in6_addr *ipv6_addr)
1153{
1154 ARG_UNUSED(iface);
1155 ARG_UNUSED(ipv6_addr);
1156}
1157#endif
1158
1161static inline int net_if_set_link_addr_unlocked(struct net_if *iface,
1162 uint8_t *addr, uint8_t len,
1163 enum net_link_type type)
1164{
1165 if (net_if_flag_is_set(iface, NET_IF_RUNNING)) {
1166 return -EPERM;
1167 }
1168
1169 net_if_get_link_addr(iface)->addr = addr;
1170 net_if_get_link_addr(iface)->len = len;
1171 net_if_get_link_addr(iface)->type = type;
1172
1173 net_hostname_set_postfix(addr, len);
1174
1175 return 0;
1176}
1177
1178int net_if_set_link_addr_locked(struct net_if *iface,
1179 uint8_t *addr, uint8_t len,
1180 enum net_link_type type);
1181
1182#if CONFIG_NET_IF_LOG_LEVEL >= LOG_LEVEL_DBG
1183extern int net_if_addr_unref_debug(struct net_if *iface,
1184 sa_family_t family,
1185 const void *addr,
1186 const char *caller, int line);
1187#define net_if_addr_unref(iface, family, addr) \
1188 net_if_addr_unref_debug(iface, family, addr, __func__, __LINE__)
1189
1190extern struct net_if_addr *net_if_addr_ref_debug(struct net_if *iface,
1191 sa_family_t family,
1192 const void *addr,
1193 const char *caller,
1194 int line);
1195#define net_if_addr_ref(iface, family, addr) \
1196 net_if_addr_ref_debug(iface, family, addr, __func__, __LINE__)
1197#else
1198extern int net_if_addr_unref(struct net_if *iface,
1199 sa_family_t family,
1200 const void *addr);
1201extern struct net_if_addr *net_if_addr_ref(struct net_if *iface,
1202 sa_family_t family,
1203 const void *addr);
1204#endif /* CONFIG_NET_IF_LOG_LEVEL */
1205
1219static inline int net_if_set_link_addr(struct net_if *iface,
1220 uint8_t *addr, uint8_t len,
1221 enum net_link_type type)
1222{
1223#if defined(CONFIG_NET_RAW_MODE)
1224 return net_if_set_link_addr_unlocked(iface, addr, len, type);
1225#else
1226 return net_if_set_link_addr_locked(iface, addr, len, type);
1227#endif
1228}
1229
1237static inline uint16_t net_if_get_mtu(struct net_if *iface)
1238{
1239 if (iface == NULL) {
1240 return 0U;
1241 }
1242
1243 NET_ASSERT(iface->if_dev);
1244
1245 return iface->if_dev->mtu;
1246}
1247
1254static inline void net_if_set_mtu(struct net_if *iface,
1255 uint16_t mtu)
1256{
1257 if (iface == NULL) {
1258 return;
1259 }
1260
1261 NET_ASSERT(iface->if_dev);
1262
1263 iface->if_dev->mtu = mtu;
1264}
1265
1272static inline void net_if_addr_set_lf(struct net_if_addr *ifaddr,
1273 bool is_infinite)
1274{
1275 NET_ASSERT(ifaddr);
1276
1277 ifaddr->is_infinite = is_infinite;
1278}
1279
1288
1296struct net_if *net_if_lookup_by_dev(const struct device *dev);
1297
1305static inline struct net_if_config *net_if_config_get(struct net_if *iface)
1306{
1307 NET_ASSERT(iface);
1308
1309 return &iface->config;
1310}
1311
1317void net_if_router_rm(struct net_if_router *router);
1318
1324void net_if_set_default(struct net_if *iface);
1325
1332
1341struct net_if *net_if_get_first_by_type(const struct net_l2 *l2);
1342
1350
1351#if defined(CONFIG_NET_L2_IEEE802154)
1358static inline struct net_if *net_if_get_ieee802154(void)
1359{
1360 return net_if_get_first_by_type(&NET_L2_GET_NAME(IEEE802154));
1361}
1362#endif /* CONFIG_NET_L2_IEEE802154 */
1363
1375 struct net_if_ipv6 **ipv6);
1376
1385
1395 struct net_if **iface);
1396
1406 struct in6_addr *addr);
1407
1416__syscall int net_if_ipv6_addr_lookup_by_index(const struct in6_addr *addr);
1417
1429 struct in6_addr *addr,
1431 uint32_t vlifetime);
1432
1443__syscall bool net_if_ipv6_addr_add_by_index(int index,
1444 struct in6_addr *addr,
1446 uint32_t vlifetime);
1447
1455 uint32_t vlifetime);
1456
1465bool net_if_ipv6_addr_rm(struct net_if *iface, const struct in6_addr *addr);
1466
1475__syscall bool net_if_ipv6_addr_rm_by_index(int index,
1476 const struct in6_addr *addr);
1477
1486typedef void (*net_if_ip_addr_cb_t)(struct net_if *iface,
1487 struct net_if_addr *addr,
1488 void *user_data);
1489
1499 void *user_data);
1500
1510 const struct in6_addr *addr);
1511
1520bool net_if_ipv6_maddr_rm(struct net_if *iface, const struct in6_addr *addr);
1521
1530typedef void (*net_if_ip_maddr_cb_t)(struct net_if *iface,
1531 struct net_if_mcast_addr *maddr,
1532 void *user_data);
1533
1543 void *user_data);
1544
1556 struct net_if **iface);
1557
1568typedef void (*net_if_mcast_callback_t)(struct net_if *iface,
1569 const struct net_addr *addr,
1570 bool is_joined);
1571
1590
1600 struct net_if *iface,
1602
1609
1617void net_if_mcast_monitor(struct net_if *iface, const struct net_addr *addr,
1618 bool is_joined);
1619
1627 struct net_if_mcast_addr *addr);
1628
1636static inline bool net_if_ipv6_maddr_is_joined(struct net_if_mcast_addr *addr)
1637{
1638 NET_ASSERT(addr);
1639
1640 return addr->is_joined;
1641}
1642
1650 struct net_if_mcast_addr *addr);
1651
1661 const struct in6_addr *addr);
1662
1673 struct in6_addr *addr,
1674 uint8_t len);
1675
1687 struct in6_addr *prefix,
1688 uint8_t len,
1690
1700bool net_if_ipv6_prefix_rm(struct net_if *iface, struct in6_addr *addr,
1701 uint8_t len);
1702
1710 bool is_infinite)
1711{
1712 prefix->is_infinite = is_infinite;
1713}
1714
1723
1730
1741bool net_if_ipv6_addr_onlink(struct net_if **iface, struct in6_addr *addr);
1742
1749#if defined(CONFIG_NET_NATIVE_IPV6)
1750static inline struct in6_addr *net_if_router_ipv6(struct net_if_router *router)
1751{
1752 NET_ASSERT(router);
1753
1754 return &router->address.in6_addr;
1755}
1756#else
1757static inline struct in6_addr *net_if_router_ipv6(struct net_if_router *router)
1758{
1759 static struct in6_addr addr;
1760
1761 ARG_UNUSED(router);
1762
1763 return &addr;
1764}
1765#endif
1766
1777 struct in6_addr *addr);
1778
1789 struct in6_addr *addr);
1790
1799
1810 struct in6_addr *addr,
1811 uint16_t router_lifetime);
1812
1821
1830#if defined(CONFIG_NET_NATIVE_IPV6)
1832#else
1834{
1835 ARG_UNUSED(iface);
1836
1837 return 0;
1838}
1839#endif /* CONFIG_NET_NATIVE_IPV6 */
1840
1847#if defined(CONFIG_NET_NATIVE_IPV6)
1848void net_if_ipv6_set_hop_limit(struct net_if *iface, uint8_t hop_limit);
1849#else
1850static inline void net_if_ipv6_set_hop_limit(struct net_if *iface,
1851 uint8_t hop_limit)
1852{
1853 ARG_UNUSED(iface);
1854 ARG_UNUSED(hop_limit);
1855}
1856#endif /* CONFIG_NET_NATIVE_IPV6 */
1857
1860/* The old hop limit setter function is deprecated because the naming
1861 * of it was incorrect. The API name was missing "_if_" so this function
1862 * should not be used.
1863 */
1864__deprecated
1865static inline void net_ipv6_set_hop_limit(struct net_if *iface,
1866 uint8_t hop_limit)
1867{
1868 net_if_ipv6_set_hop_limit(iface, hop_limit);
1869}
1870
1881#if defined(CONFIG_NET_NATIVE_IPV6)
1883#else
1885{
1886 ARG_UNUSED(iface);
1887
1888 return 0;
1889}
1890#endif /* CONFIG_NET_NATIVE_IPV6 */
1891
1898#if defined(CONFIG_NET_NATIVE_IPV6)
1899void net_if_ipv6_set_mcast_hop_limit(struct net_if *iface, uint8_t hop_limit);
1900#else
1902 uint8_t hop_limit)
1903{
1904 ARG_UNUSED(iface);
1905 ARG_UNUSED(hop_limit);
1906}
1907#endif /* CONFIG_NET_NATIVE_IPV6 */
1908
1916 uint32_t reachable_time)
1917{
1918#if defined(CONFIG_NET_NATIVE_IPV6)
1919 NET_ASSERT(iface);
1920
1921 if (!iface->config.ip.ipv6) {
1922 return;
1923 }
1924
1925 iface->config.ip.ipv6->base_reachable_time = reachable_time;
1926#else
1927 ARG_UNUSED(iface);
1928 ARG_UNUSED(reachable_time);
1929
1930#endif
1931}
1932
1941{
1942#if defined(CONFIG_NET_NATIVE_IPV6)
1943 NET_ASSERT(iface);
1944
1945 if (!iface->config.ip.ipv6) {
1946 return 0;
1947 }
1948
1949 return iface->config.ip.ipv6->reachable_time;
1950#else
1951 ARG_UNUSED(iface);
1952 return 0;
1953#endif
1954}
1955
1964
1971static inline void net_if_ipv6_set_reachable_time(struct net_if_ipv6 *ipv6)
1972{
1973#if defined(CONFIG_NET_NATIVE_IPV6)
1974 if (ipv6 == NULL) {
1975 return;
1976 }
1977
1979#else
1980 ARG_UNUSED(ipv6);
1981#endif
1982}
1983
1990static inline void net_if_ipv6_set_retrans_timer(struct net_if *iface,
1991 uint32_t retrans_timer)
1992{
1993#if defined(CONFIG_NET_NATIVE_IPV6)
1994 NET_ASSERT(iface);
1995
1996 if (!iface->config.ip.ipv6) {
1997 return;
1998 }
1999
2000 iface->config.ip.ipv6->retrans_timer = retrans_timer;
2001#else
2002 ARG_UNUSED(iface);
2003 ARG_UNUSED(retrans_timer);
2004#endif
2005}
2006
2015{
2016#if defined(CONFIG_NET_NATIVE_IPV6)
2017 NET_ASSERT(iface);
2018
2019 if (!iface->config.ip.ipv6) {
2020 return 0;
2021 }
2022
2023 return iface->config.ip.ipv6->retrans_timer;
2024#else
2025 ARG_UNUSED(iface);
2026 return 0;
2027#endif
2028}
2029
2041#if defined(CONFIG_NET_IPV6)
2042const struct in6_addr *net_if_ipv6_select_src_addr(struct net_if *iface,
2043 const struct in6_addr *dst);
2044#else
2045static inline const struct in6_addr *net_if_ipv6_select_src_addr(
2046 struct net_if *iface, const struct in6_addr *dst)
2047{
2048 ARG_UNUSED(iface);
2049 ARG_UNUSED(dst);
2050
2051 return NULL;
2052}
2053#endif
2054
2068#if defined(CONFIG_NET_IPV6)
2069const struct in6_addr *net_if_ipv6_select_src_addr_hint(struct net_if *iface,
2070 const struct in6_addr *dst,
2071 int flags);
2072#else
2073static inline const struct in6_addr *net_if_ipv6_select_src_addr_hint(
2074 struct net_if *iface, const struct in6_addr *dst, int flags)
2075{
2076 ARG_UNUSED(iface);
2077 ARG_UNUSED(dst);
2078 ARG_UNUSED(flags);
2079
2080 return NULL;
2081}
2082#endif
2083
2093#if defined(CONFIG_NET_IPV6)
2094struct net_if *net_if_ipv6_select_src_iface(const struct in6_addr *dst);
2095#else
2097 const struct in6_addr *dst)
2098{
2099 ARG_UNUSED(dst);
2100
2101 return NULL;
2102}
2103#endif
2104
2114struct in6_addr *net_if_ipv6_get_ll(struct net_if *iface,
2115 enum net_addr_state addr_state);
2116
2127 struct net_if **iface);
2128
2136void net_if_ipv6_dad_failed(struct net_if *iface, const struct in6_addr *addr);
2137
2150 struct net_if **iface);
2151
2163 struct net_if_ipv4 **ipv4);
2164
2173
2182
2189void net_if_ipv4_set_ttl(struct net_if *iface, uint8_t ttl);
2190
2199
2207
2217 struct net_if **iface);
2218
2230 struct in_addr *addr,
2232 uint32_t vlifetime);
2233
2242bool net_if_ipv4_addr_rm(struct net_if *iface, const struct in_addr *addr);
2243
2252__syscall int net_if_ipv4_addr_lookup_by_index(const struct in_addr *addr);
2253
2264__syscall bool net_if_ipv4_addr_add_by_index(int index,
2265 struct in_addr *addr,
2267 uint32_t vlifetime);
2268
2277__syscall bool net_if_ipv4_addr_rm_by_index(int index,
2278 const struct in_addr *addr);
2279
2289 void *user_data);
2290
2300 const struct in_addr *addr);
2301
2310bool net_if_ipv4_maddr_rm(struct net_if *iface, const struct in_addr *addr);
2311
2321 void *user_data);
2322
2334 struct net_if **iface);
2335
2343 struct net_if_mcast_addr *addr);
2344
2352static inline bool net_if_ipv4_maddr_is_joined(struct net_if_mcast_addr *addr)
2353{
2354 NET_ASSERT(addr);
2355
2356 return addr->is_joined;
2357}
2358
2366 struct net_if_mcast_addr *addr);
2367
2374#if defined(CONFIG_NET_NATIVE_IPV4)
2375static inline struct in_addr *net_if_router_ipv4(struct net_if_router *router)
2376{
2377 NET_ASSERT(router);
2378
2379 return &router->address.in_addr;
2380}
2381#else
2382static inline struct in_addr *net_if_router_ipv4(struct net_if_router *router)
2383{
2384 static struct in_addr addr;
2385
2386 ARG_UNUSED(router);
2387
2388 return &addr;
2389}
2390#endif
2391
2402 struct in_addr *addr);
2403
2414 struct in_addr *addr);
2426 struct in_addr *addr,
2427 bool is_default,
2428 uint16_t router_lifetime);
2429
2438
2448 const struct in_addr *addr);
2449
2459 const struct in_addr *addr);
2460
2470#if defined(CONFIG_NET_IPV4)
2471struct net_if *net_if_ipv4_select_src_iface(const struct in_addr *dst);
2472#else
2474 const struct in_addr *dst)
2475{
2476 ARG_UNUSED(dst);
2477
2478 return NULL;
2479}
2480#endif
2481
2493#if defined(CONFIG_NET_IPV4)
2494const struct in_addr *net_if_ipv4_select_src_addr(struct net_if *iface,
2495 const struct in_addr *dst);
2496#else
2497static inline const struct in_addr *net_if_ipv4_select_src_addr(
2498 struct net_if *iface, const struct in_addr *dst)
2499{
2500 ARG_UNUSED(iface);
2501 ARG_UNUSED(dst);
2502
2503 return NULL;
2504}
2505#endif
2506
2516struct in_addr *net_if_ipv4_get_ll(struct net_if *iface,
2517 enum net_addr_state addr_state);
2518
2529 enum net_addr_state addr_state);
2530
2541 const struct in_addr *addr);
2542
2552__deprecated struct in_addr net_if_ipv4_get_netmask(struct net_if *iface);
2553
2562__deprecated void net_if_ipv4_set_netmask(struct net_if *iface,
2563 const struct in_addr *netmask);
2564
2575__deprecated __syscall bool net_if_ipv4_set_netmask_by_index(int index,
2576 const struct in_addr *netmask);
2577
2588 const struct in_addr *addr,
2589 const struct in_addr *netmask);
2590
2601 const struct in_addr *addr,
2602 const struct in_addr *netmask);
2603
2611struct in_addr net_if_ipv4_get_gw(struct net_if *iface);
2612
2619void net_if_ipv4_set_gw(struct net_if *iface, const struct in_addr *gw);
2620
2629__syscall bool net_if_ipv4_set_gw_by_index(int index, const struct in_addr *gw);
2630
2641struct net_if *net_if_select_src_iface(const struct sockaddr *dst);
2642
2651typedef void (*net_if_link_callback_t)(struct net_if *iface,
2652 struct net_linkaddr *dst,
2653 int status);
2654
2670
2679
2686
2694void net_if_call_link_cb(struct net_if *iface, struct net_linkaddr *lladdr,
2695 int status);
2696
2699/* used to ensure encoding of checksum support in net_if.h and
2700 * ethernet.h is the same
2701 */
2702#define NET_IF_CHECKSUM_NONE_BIT 0
2703#define NET_IF_CHECKSUM_IPV4_HEADER_BIT BIT(0)
2704#define NET_IF_CHECKSUM_IPV4_ICMP_BIT BIT(1)
2705/* Space for future protocols and restrictions for IPV4 */
2706#define NET_IF_CHECKSUM_IPV6_HEADER_BIT BIT(10)
2707#define NET_IF_CHECKSUM_IPV6_ICMP_BIT BIT(11)
2708/* Space for future protocols and restrictions for IPV6 */
2709#define NET_IF_CHECKSUM_TCP_BIT BIT(21)
2710#define NET_IF_CHECKSUM_UDP_BIT BIT(22)
2711
2719 NET_IF_CHECKSUM_IPV4_HEADER = NET_IF_CHECKSUM_IPV4_HEADER_BIT,
2721 NET_IF_CHECKSUM_IPV4_TCP = NET_IF_CHECKSUM_IPV4_HEADER_BIT |
2722 NET_IF_CHECKSUM_TCP_BIT,
2724 NET_IF_CHECKSUM_IPV4_UDP = NET_IF_CHECKSUM_IPV4_HEADER_BIT |
2725 NET_IF_CHECKSUM_UDP_BIT,
2727 NET_IF_CHECKSUM_IPV4_ICMP = NET_IF_CHECKSUM_IPV4_ICMP_BIT,
2729 NET_IF_CHECKSUM_IPV6_HEADER = NET_IF_CHECKSUM_IPV6_HEADER_BIT,
2731 NET_IF_CHECKSUM_IPV6_TCP = NET_IF_CHECKSUM_IPV6_HEADER_BIT |
2732 NET_IF_CHECKSUM_TCP_BIT,
2734 NET_IF_CHECKSUM_IPV6_UDP = NET_IF_CHECKSUM_IPV6_HEADER_BIT |
2735 NET_IF_CHECKSUM_UDP_BIT,
2737 NET_IF_CHECKSUM_IPV6_ICMP = NET_IF_CHECKSUM_IPV6_ICMP_BIT
2739
2751 enum net_if_checksum_type chksum_type);
2752
2765 enum net_if_checksum_type chksum_type);
2766
2777__syscall struct net_if *net_if_get_by_index(int index);
2778
2786int net_if_get_by_iface(struct net_if *iface);
2787
2795typedef void (*net_if_cb_t)(struct net_if *iface, void *user_data);
2796
2804void net_if_foreach(net_if_cb_t cb, void *user_data);
2805
2813int net_if_up(struct net_if *iface);
2814
2822static inline bool net_if_is_up(struct net_if *iface)
2823{
2824 NET_ASSERT(iface);
2825
2826 return net_if_flag_is_set(iface, NET_IF_UP) &&
2828}
2829
2837int net_if_down(struct net_if *iface);
2838
2846static inline bool net_if_is_admin_up(struct net_if *iface)
2847{
2848 NET_ASSERT(iface);
2849
2850 return net_if_flag_is_set(iface, NET_IF_UP);
2851}
2852
2861void net_if_carrier_on(struct net_if *iface);
2862
2871void net_if_carrier_off(struct net_if *iface);
2872
2880static inline bool net_if_is_carrier_ok(struct net_if *iface)
2881{
2882 NET_ASSERT(iface);
2883
2884 return net_if_flag_is_set(iface, NET_IF_LOWER_UP);
2885}
2886
2897void net_if_dormant_on(struct net_if *iface);
2898
2907void net_if_dormant_off(struct net_if *iface);
2908
2916static inline bool net_if_is_dormant(struct net_if *iface)
2917{
2918 NET_ASSERT(iface);
2919
2920 return net_if_flag_is_set(iface, NET_IF_DORMANT);
2921}
2922
2923#if defined(CONFIG_NET_PKT_TIMESTAMP) && defined(CONFIG_NET_NATIVE)
2931typedef void (*net_if_timestamp_callback_t)(struct net_pkt *pkt);
2932
2941struct net_if_timestamp_cb {
2943 sys_snode_t node;
2944
2948 struct net_pkt *pkt;
2949
2953 struct net_if *iface;
2954
2956 net_if_timestamp_callback_t cb;
2957};
2958
2969void net_if_register_timestamp_cb(struct net_if_timestamp_cb *handle,
2970 struct net_pkt *pkt,
2971 struct net_if *iface,
2972 net_if_timestamp_callback_t cb);
2973
2979void net_if_unregister_timestamp_cb(struct net_if_timestamp_cb *handle);
2980
2986void net_if_call_timestamp_cb(struct net_pkt *pkt);
2987
2988/*
2989 * @brief Add timestamped TX buffer to be handled
2990 *
2991 * @param pkt Timestamped buffer
2992 */
2993void net_if_add_tx_timestamp(struct net_pkt *pkt);
2994#endif /* CONFIG_NET_PKT_TIMESTAMP */
2995
3005#if defined(CONFIG_NET_PROMISCUOUS_MODE)
3006int net_if_set_promisc(struct net_if *iface);
3007#else
3008static inline int net_if_set_promisc(struct net_if *iface)
3009{
3010 ARG_UNUSED(iface);
3011
3012 return -ENOTSUP;
3013}
3014#endif
3015
3021#if defined(CONFIG_NET_PROMISCUOUS_MODE)
3022void net_if_unset_promisc(struct net_if *iface);
3023#else
3024static inline void net_if_unset_promisc(struct net_if *iface)
3025{
3026 ARG_UNUSED(iface);
3027}
3028#endif
3029
3038#if defined(CONFIG_NET_PROMISCUOUS_MODE)
3039bool net_if_is_promisc(struct net_if *iface);
3040#else
3041static inline bool net_if_is_promisc(struct net_if *iface)
3042{
3043 ARG_UNUSED(iface);
3044
3045 return false;
3046}
3047#endif
3048
3058static inline bool net_if_are_pending_tx_packets(struct net_if *iface)
3059{
3060#if defined(CONFIG_NET_POWER_MANAGEMENT)
3061 return !!iface->tx_pending;
3062#else
3063 ARG_UNUSED(iface);
3064
3065 return false;
3066#endif
3067}
3068
3069#ifdef CONFIG_NET_POWER_MANAGEMENT
3077int net_if_suspend(struct net_if *iface);
3078
3086int net_if_resume(struct net_if *iface);
3087
3095bool net_if_is_suspended(struct net_if *iface);
3096#endif /* CONFIG_NET_POWER_MANAGEMENT */
3097
3105bool net_if_is_wifi(struct net_if *iface);
3106
3113
3120
3127
3142int net_if_get_name(struct net_if *iface, char *buf, int len);
3143
3158int net_if_set_name(struct net_if *iface, const char *buf);
3159
3167int net_if_get_by_name(const char *name);
3168
3170struct net_if_api {
3171 void (*init)(struct net_if *iface);
3172};
3173
3174#define NET_IF_DHCPV4_INIT \
3175 IF_ENABLED(UTIL_AND(IS_ENABLED(CONFIG_NET_DHCPV4), \
3176 IS_ENABLED(CONFIG_NET_NATIVE_IPV4)), \
3177 (.dhcpv4.state = NET_DHCPV4_DISABLED,))
3178
3179#define NET_IF_DHCPV6_INIT \
3180 IF_ENABLED(UTIL_AND(IS_ENABLED(CONFIG_NET_DHCPV6), \
3181 IS_ENABLED(CONFIG_NET_NATIVE_IPV6)), \
3182 (.dhcpv6.state = NET_DHCPV6_DISABLED,))
3183
3184#define NET_IF_CONFIG_INIT \
3185 .config = { \
3186 IF_ENABLED(CONFIG_NET_IP, (.ip = {},)) \
3187 NET_IF_DHCPV4_INIT \
3188 NET_IF_DHCPV6_INIT \
3189 }
3190
3191#define NET_IF_GET_NAME(dev_id, sfx) __net_if_##dev_id##_##sfx
3192#define NET_IF_DEV_GET_NAME(dev_id, sfx) __net_if_dev_##dev_id##_##sfx
3193
3194#define NET_IF_GET(dev_id, sfx) \
3195 ((struct net_if *)&NET_IF_GET_NAME(dev_id, sfx))
3196
3197#define NET_IF_INIT(dev_id, sfx, _l2, _mtu, _num_configs) \
3198 static STRUCT_SECTION_ITERABLE(net_if_dev, \
3199 NET_IF_DEV_GET_NAME(dev_id, sfx)) = { \
3200 .dev = &(DEVICE_NAME_GET(dev_id)), \
3201 .l2 = &(NET_L2_GET_NAME(_l2)), \
3202 .l2_data = &(NET_L2_GET_DATA(dev_id, sfx)), \
3203 .mtu = _mtu, \
3204 .flags = {BIT(NET_IF_LOWER_UP)}, \
3205 }; \
3206 static Z_DECL_ALIGN(struct net_if) \
3207 NET_IF_GET_NAME(dev_id, sfx)[_num_configs] \
3208 __used __in_section(_net_if, static, \
3209 dev_id) = { \
3210 [0 ... (_num_configs - 1)] = { \
3211 .if_dev = &(NET_IF_DEV_GET_NAME(dev_id, sfx)), \
3212 NET_IF_CONFIG_INIT \
3213 } \
3214 }
3215
3216#define NET_IF_OFFLOAD_INIT(dev_id, sfx, _mtu) \
3217 static STRUCT_SECTION_ITERABLE(net_if_dev, \
3218 NET_IF_DEV_GET_NAME(dev_id, sfx)) = { \
3219 .dev = &(DEVICE_NAME_GET(dev_id)), \
3220 .mtu = _mtu, \
3221 .l2 = &(NET_L2_GET_NAME(OFFLOADED_NETDEV)), \
3222 .flags = {BIT(NET_IF_LOWER_UP)}, \
3223 }; \
3224 static Z_DECL_ALIGN(struct net_if) \
3225 NET_IF_GET_NAME(dev_id, sfx)[NET_IF_MAX_CONFIGS] \
3226 __used __in_section(_net_if, static, \
3227 dev_id) = { \
3228 [0 ... (NET_IF_MAX_CONFIGS - 1)] = { \
3229 .if_dev = &(NET_IF_DEV_GET_NAME(dev_id, sfx)), \
3230 NET_IF_CONFIG_INIT \
3231 } \
3232 }
3233
3236/* Network device initialization macros */
3237
3238#define Z_NET_DEVICE_INIT_INSTANCE(node_id, dev_id, name, instance, \
3239 init_fn, pm, data, config, prio, \
3240 api, l2, l2_ctx_type, mtu) \
3241 Z_DEVICE_STATE_DEFINE(dev_id); \
3242 Z_DEVICE_DEFINE(node_id, dev_id, name, init_fn, pm, data, \
3243 config, POST_KERNEL, prio, api, \
3244 &Z_DEVICE_STATE_NAME(dev_id)); \
3245 NET_L2_DATA_INIT(dev_id, instance, l2_ctx_type); \
3246 NET_IF_INIT(dev_id, instance, l2, mtu, NET_IF_MAX_CONFIGS)
3247
3248#define Z_NET_DEVICE_INIT(node_id, dev_id, name, init_fn, pm, data, \
3249 config, prio, api, l2, l2_ctx_type, mtu) \
3250 Z_NET_DEVICE_INIT_INSTANCE(node_id, dev_id, name, 0, init_fn, \
3251 pm, data, config, prio, api, l2, \
3252 l2_ctx_type, mtu)
3253
3273#define NET_DEVICE_INIT(dev_id, name, init_fn, pm, data, config, prio, \
3274 api, l2, l2_ctx_type, mtu) \
3275 Z_NET_DEVICE_INIT(DT_INVALID_NODE, dev_id, name, init_fn, pm, \
3276 data, config, prio, api, l2, l2_ctx_type, mtu)
3277
3296#define NET_DEVICE_DT_DEFINE(node_id, init_fn, pm, data, \
3297 config, prio, api, l2, l2_ctx_type, mtu) \
3298 Z_NET_DEVICE_INIT(node_id, Z_DEVICE_DT_DEV_ID(node_id), \
3299 DEVICE_DT_NAME(node_id), init_fn, pm, data, \
3300 config, prio, api, l2, l2_ctx_type, mtu)
3301
3310#define NET_DEVICE_DT_INST_DEFINE(inst, ...) \
3311 NET_DEVICE_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
3312
3336#define NET_DEVICE_INIT_INSTANCE(dev_id, name, instance, init_fn, pm, \
3337 data, config, prio, api, l2, \
3338 l2_ctx_type, mtu) \
3339 Z_NET_DEVICE_INIT_INSTANCE(DT_INVALID_NODE, dev_id, name, \
3340 instance, init_fn, pm, data, config, \
3341 prio, api, l2, l2_ctx_type, mtu)
3342
3365#define NET_DEVICE_DT_DEFINE_INSTANCE(node_id, instance, init_fn, pm, \
3366 data, config, prio, api, l2, \
3367 l2_ctx_type, mtu) \
3368 Z_NET_DEVICE_INIT_INSTANCE(node_id, \
3369 Z_DEVICE_DT_DEV_ID(node_id), \
3370 DEVICE_DT_NAME(node_id), instance, \
3371 init_fn, pm, data, config, prio, \
3372 api, l2, l2_ctx_type, mtu)
3373
3383#define NET_DEVICE_DT_INST_DEFINE_INSTANCE(inst, ...) \
3384 NET_DEVICE_DT_DEFINE_INSTANCE(DT_DRV_INST(inst), __VA_ARGS__)
3385
3386#define Z_NET_DEVICE_OFFLOAD_INIT(node_id, dev_id, name, init_fn, pm, \
3387 data, config, prio, api, mtu) \
3388 Z_DEVICE_STATE_DEFINE(dev_id); \
3389 Z_DEVICE_DEFINE(node_id, dev_id, name, init_fn, pm, data, \
3390 config, POST_KERNEL, prio, api, \
3391 &Z_DEVICE_STATE_NAME(dev_id)); \
3392 NET_IF_OFFLOAD_INIT(dev_id, 0, mtu)
3393
3413#define NET_DEVICE_OFFLOAD_INIT(dev_id, name, init_fn, pm, data, \
3414 config, prio, api, mtu) \
3415 Z_NET_DEVICE_OFFLOAD_INIT(DT_INVALID_NODE, dev_id, name, \
3416 init_fn, pm, data, config, prio, api, \
3417 mtu)
3418
3437#define NET_DEVICE_DT_OFFLOAD_DEFINE(node_id, init_fn, pm, data, \
3438 config, prio, api, mtu) \
3439 Z_NET_DEVICE_OFFLOAD_INIT(node_id, Z_DEVICE_DT_DEV_ID(node_id), \
3440 DEVICE_DT_NAME(node_id), init_fn, pm, \
3441 data, config, prio, api, mtu)
3442
3452#define NET_DEVICE_DT_INST_OFFLOAD_DEFINE(inst, ...) \
3453 NET_DEVICE_DT_OFFLOAD_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
3454
3460#define NET_IFACE_COUNT(_dst) \
3461 do { \
3462 extern struct net_if _net_if_list_start[]; \
3463 extern struct net_if _net_if_list_end[]; \
3464 *(_dst) = ((uintptr_t)_net_if_list_end - \
3465 (uintptr_t)_net_if_list_start) / \
3466 sizeof(struct net_if); \
3467 } while (0)
3468
3469#ifdef __cplusplus
3470}
3471#endif
3472
3473#include <zephyr/syscalls/net_if.h>
3474
3479#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:46
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 get and 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 clear a bit and test it.
Definition atomic.h:147
static bool atomic_test_and_set_bit(atomic_t *target, int bit)
Atomically set a bit and test it.
Definition atomic.h:170
#define K_FOREVER
Generate infinite timeout delay.
Definition kernel.h:1440
unsigned short int sa_family_t
Socket address family type.
Definition net_ip.h:167
net_addr_state
What is the current state of the network address.
Definition net_ip.h:503
net_addr_type
How the network address is assigned to network interface.
Definition net_ip.h:511
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:102
static int net_hostname_set_postfix(const uint8_t *hostname_postfix, int postfix_len)
Set the device hostname postfix.
Definition hostname.h:111
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:2880
static bool net_if_is_admin_up(struct net_if *iface)
Check if interface was brought up by the administrator.
Definition net_if.h:2846
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.
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:1568
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:2651
struct net_if * net_if_get_wifi_sta(void)
Get Wi-Fi network station interface.
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:857
int net_if_down(struct net_if *iface)
Bring interface down.
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:2382
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_mcast_monitor(struct net_if *iface, const struct net_addr *addr, bool is_joined)
Call registered multicast monitors.
static void * net_if_l2_data(struct net_if *iface)
Get a pointer to the interface L2 private data.
Definition net_if.h:929
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:3058
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:787
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:1078
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:2045
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:1151
static struct net_offload * net_if_offload(struct net_if *iface)
Return the IP offload plugin.
Definition net_if.h:995
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:1219
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:770
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.
static uint8_t net_if_ipv6_get_mcast_hop_limit(struct net_if *iface)
Get IPv6 multicast hop limit specified for a given interface.
Definition net_if.h:1884
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 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.
Definition net_if.h:1850
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:2073
int net_if_get_name(struct net_if *iface, char *buf, int len)
Get network interface name.
bool net_if_ipv6_addr_rm(struct net_if *iface, const struct in6_addr *addr)
Remove an IPv6 address from an interface.
static uint8_t net_if_ipv6_get_hop_limit(struct net_if *iface)
Get IPv6 hop limit specified for a given interface.
Definition net_if.h:1833
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:967
static bool net_if_is_dormant(struct net_if *iface)
Check if the interface is dormant.
Definition net_if.h:2916
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.
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:1530
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.
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:1254
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 up and running.
Definition net_if.h:2822
bool net_if_need_calc_rx_checksum(struct net_if *iface, enum net_if_checksum_type chksum_type)
Check if received network packet checksum calculation can be avoided or not.
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:1971
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.
net_if_checksum_type
Type of checksum for which support in the interface will be queried.
Definition net_if.h:2717
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.
bool net_if_need_calc_tx_checksum(struct net_if *iface, enum net_if_checksum_type chksum_type)
Check if network packet checksum calculation can be avoided or not when sending the packet.
static void net_if_start_dad(struct net_if *iface)
Start duplicate address detection procedure.
Definition net_if.h:1108
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:3024
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:1036
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:1940
static bool net_if_is_promisc(struct net_if *iface)
Check if promiscuous mode is set or not.
Definition net_if.h:3041
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:2352
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:1709
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:1130
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:1915
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_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:1486
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:819
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:1636
bool net_if_ipv6_addr_rm_by_index(int index, const struct in6_addr *addr)
Remove an IPv6 address from an interface by index.
void(* net_if_cb_t)(struct net_if *iface, void *user_data)
Callback used while iterating over network interfaces.
Definition net_if.h:2795
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:1237
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:2497
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:1990
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:1757
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:2014
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:288
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:2096
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:836
static struct net_if_config * net_if_config_get(struct net_if *iface)
Get network interface IP config.
Definition net_if.h:1305
static struct net_if_config * net_if_get_config(struct net_if *iface)
Return network configuration for this network interface.
Definition net_if.h:1093
void net_if_ipv4_maddr_join(struct net_if *iface, struct net_if_mcast_addr *addr)
Mark a given multicast address to be joined.
struct in_addr net_if_ipv4_get_gw(struct net_if *iface)
Get IPv4 gateway of an interface.
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:1272
net_if_flag
Network interface flags.
Definition net_if.h:230
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:944
bool net_if_is_offloaded(struct net_if *iface)
Return offload status of a given network interface.
int(* net_socket_create_t)(int, int, int)
A function prototype to create an offloaded socket.
Definition net_if.h:618
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:1016
static 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.
Definition net_if.h:1901
struct net_if * net_if_get_wifi_sap(void)
Get first Wi-Fi network Soft-AP interface.
static int net_if_set_promisc(struct net_if *iface)
Set network interface into promiscuous mode.
Definition net_if.h:3008
static const struct net_l2 * net_if_l2(struct net_if *iface)
Get a pointer to the interface L2.
Definition net_if.h:903
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:1057
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:2473
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:802
@ NET_IF_CHECKSUM_IPV4_ICMP
Interface supports checksum calculation for ICMP4 payload in IPv4.
Definition net_if.h:2727
@ NET_IF_CHECKSUM_IPV6_TCP
Interface supports checksum calculation for TCP payload in IPv6.
Definition net_if.h:2731
@ NET_IF_CHECKSUM_IPV6_UDP
Interface supports checksum calculation for UDP payload in IPv6.
Definition net_if.h:2734
@ NET_IF_CHECKSUM_IPV4_HEADER
Interface supports IP version 4 header checksum calculation.
Definition net_if.h:2719
@ NET_IF_CHECKSUM_IPV4_TCP
Interface supports checksum calculation for TCP payload in IPv4.
Definition net_if.h:2721
@ NET_IF_CHECKSUM_IPV6_HEADER
Interface supports IP version 6 header checksum calculation.
Definition net_if.h:2729
@ NET_IF_CHECKSUM_IPV6_ICMP
Interface supports checksum calculation for ICMP6 payload in IPv6.
Definition net_if.h:2737
@ NET_IF_CHECKSUM_IPV4_UDP
Interface supports checksum calculation for UDP payload in IPv4.
Definition net_if.h:2724
@ NET_IF_OPER_TESTING
Training mode.
Definition net_if.h:293
@ NET_IF_OPER_DORMANT
Waiting external action.
Definition net_if.h:294
@ NET_IF_OPER_UP
Interface is up.
Definition net_if.h:295
@ NET_IF_OPER_NOTPRESENT
Hardware missing.
Definition net_if.h:290
@ NET_IF_OPER_UNKNOWN
Initial (unknown) value.
Definition net_if.h:289
@ NET_IF_OPER_DOWN
Interface is down.
Definition net_if.h:291
@ NET_IF_OPER_LOWERLAYERDOWN
Lower layer interface is down.
Definition net_if.h:292
@ NET_IF_NO_AUTO_START
Do not start the interface immediately after initialization.
Definition net_if.h:246
@ NET_IF_IPV6_NO_MLD
IPv6 Multicast Listener Discovery disabled.
Definition net_if.h:276
@ NET_IF_POINTOPOINT
Interface is pointopoint.
Definition net_if.h:235
@ NET_IF_IPV6_NO_ND
IPv6 Neighbor Discovery disabled.
Definition net_if.h:273
@ NET_IF_FORWARD_MULTICASTS
Flag defines if received multicasts of other interface are forwarded on this interface.
Definition net_if.h:255
@ NET_IF_IPV4
Interface supports IPv4.
Definition net_if.h:258
@ NET_IF_PROMISC
Interface is in promiscuous mode.
Definition net_if.h:238
@ NET_IF_DORMANT
Driver signals dormant.
Definition net_if.h:270
@ NET_IF_SUSPENDED
Power management specific: interface is being suspended.
Definition net_if.h:249
@ NET_IF_IPV6
Interface supports IPv6.
Definition net_if.h:261
@ NET_IF_UP
Interface is admin up.
Definition net_if.h:232
@ NET_IF_LOWER_UP
Driver signals L1 is up.
Definition net_if.h:267
@ NET_IF_RUNNING
Interface up and running (ready to receive and transmit).
Definition net_if.h:264
@ NET_IF_NO_TX_LOCK
Mutex locking on TX data path disabled on the interface.
Definition net_if.h:279
net_link_type
Type of the link address.
Definition net_linkaddr.h:49
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:114
#define EPERM
Not owner.
Definition errno.h:39
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:412
IPv6 address struct.
Definition net_ip.h:142
IPv4 address struct.
Definition net_ip.h:154
Definition kernel.h:2468
Mutex Structure.
Definition kernel.h:2994
Thread Structure.
Definition thread.h:259
Kernel timepoint type.
Definition sys_clock.h:219
DHCPv6 client configuration parameters.
Definition dhcpv6.h:63
Network Interface unicast IPv4 address and netmask.
Definition net_if.h:439
struct net_if_addr ipv4
IPv4 address.
Definition net_if.h:441
struct in_addr netmask
Netmask.
Definition net_if.h:443
Network Interface unicast IP addresses.
Definition net_if.h:54
struct net_addr address
IP address.
Definition net_if.h:56
uint8_t is_mesh_local
Is this IP address usage limited to the subnet (mesh) or not.
Definition net_if.h:130
uint8_t is_temporary
Is this IP address temporary and generated for example by IPv6 privacy extension (RFC 8981)
Definition net_if.h:135
enum net_addr_state addr_state
What is the current state of the address.
Definition net_if.h:71
uint8_t is_infinite
Is the IP address valid forever.
Definition net_if.h:124
atomic_t atomic_ref
Reference counter.
Definition net_if.h:61
enum net_addr_type addr_type
How the IP address was set.
Definition net_if.h:68
uint8_t is_used
Is this IP address used or not.
Definition net_if.h:127
IP and other configuration related data for network interface.
Definition net_if.h:557
Network Interface Device structure.
Definition net_if.h:634
enum net_if_oper_state oper_state
RFC 2863 operational status.
Definition net_if.h:670
const struct net_l2 *const l2
Interface's L2 layer.
Definition net_if.h:639
void * l2_data
Interface's private L2 data pointer.
Definition net_if.h:642
uint16_t mtu
The hardware MTU.
Definition net_if.h:660
const struct device * dev
The actually device driver instance the net_if is related to.
Definition net_if.h:636
struct net_linkaddr link_addr
The hardware link address.
Definition net_if.h:648
atomic_t flags[ATOMIC_BITMAP_SIZE(NET_IF_NUM_FLAGS)]
For internal use.
Definition net_if.h:645
Network interface IP address configuration.
Definition net_if.h:544
IPv4 configuration.
Definition net_if.h:447
uint8_t mcast_ttl
IPv4 time-to-live for multicast packets.
Definition net_if.h:461
struct net_if_addr_ipv4 unicast[NET_IF_MAX_IPV4_ADDR]
Unicast IP addresses.
Definition net_if.h:449
struct in_addr gw
Gateway.
Definition net_if.h:455
uint8_t ttl
IPv4 time-to-live.
Definition net_if.h:458
struct net_if_mcast_addr mcast[NET_IF_MAX_IPV4_MADDR]
Multicast IP addresses.
Definition net_if.h:452
Network Interface IPv6 prefixes.
Definition net_if.h:174
struct net_if * iface
Backpointer to network interface where this prefix is used.
Definition net_if.h:182
uint8_t is_infinite
Is the IP prefix valid forever.
Definition net_if.h:188
uint8_t len
Prefix length.
Definition net_if.h:185
struct in6_addr prefix
IPv6 prefix.
Definition net_if.h:179
uint8_t is_used
Is this prefix used or not.
Definition net_if.h:191
struct net_timeout lifetime
Prefix lifetime.
Definition net_if.h:176
IPv6 configuration.
Definition net_if.h:315
struct net_if_ipv6_prefix prefix[NET_IF_MAX_IPV6_PREFIX]
Prefixes.
Definition net_if.h:323
uint32_t base_reachable_time
Default reachable time (RFC 4861, page 52)
Definition net_if.h:326
uint8_t hop_limit
IPv6 hop limit.
Definition net_if.h:354
struct net_if_mcast_addr mcast[NET_IF_MAX_IPV6_MADDR]
Multicast IP addresses.
Definition net_if.h:320
uint32_t retrans_timer
Retransmit timer (RFC 4861, page 52)
Definition net_if.h:332
struct net_if_addr unicast[NET_IF_MAX_IPV6_ADDR]
Unicast IP addresses.
Definition net_if.h:317
uint8_t mcast_hop_limit
IPv6 multicast hop limit.
Definition net_if.h:357
uint32_t reachable_time
Reachable time (RFC 4861, page 20)
Definition net_if.h:329
Network Interface multicast IP addresses.
Definition net_if.h:145
struct net_addr address
IP address.
Definition net_if.h:147
uint8_t is_joined
Did we join to this group.
Definition net_if.h:164
uint8_t is_used
Is this multicast IP address used or not.
Definition net_if.h:161
Multicast monitor handler struct.
Definition net_if.h:1580
sys_snode_t node
Node information for the slist.
Definition net_if.h:1582
net_if_mcast_callback_t cb
Multicast callback.
Definition net_if.h:1588
struct net_if * iface
Network interface.
Definition net_if.h:1585
Information about routers in the system.
Definition net_if.h:201
struct net_if * iface
Network interface the router is connected to.
Definition net_if.h:209
uint8_t is_default
Is default router.
Definition net_if.h:221
uint16_t lifetime
Router lifetime.
Definition net_if.h:215
uint8_t is_infinite
Is the router valid forever.
Definition net_if.h:224
uint8_t is_used
Is this router used or not.
Definition net_if.h:218
struct net_addr address
IP address.
Definition net_if.h:206
sys_snode_t node
Slist lifetime timer node.
Definition net_if.h:203
uint32_t life_start
Router life timer start.
Definition net_if.h:212
Network Interface structure.
Definition net_if.h:680
struct net_if_dev * if_dev
The net_if_dev instance the net_if is related to.
Definition net_if.h:682
struct net_if_config config
Network interface instance configuration.
Definition net_if.h:690
uint8_t pe_enabled
Network interface specific flags.
Definition net_if.h:710
struct k_mutex lock
Mutex protecting this network interface instance.
Definition net_if.h:701
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:715
struct k_mutex tx_lock
Mutex used when sending data.
Definition net_if.h:704
Network L2 structure.
Definition net_l2.h:57
Hardware link address structure.
Definition net_linkaddr.h:69
uint8_t * addr
The array of byte representing the address.
Definition net_linkaddr.h:71
uint8_t type
What kind of address is this for.
Definition net_linkaddr.h:77
uint8_t len
Length of that address array.
Definition net_linkaddr.h:74
Network packet.
Definition net_pkt.h:91
All network statistics in one struct.
Definition net_stats.h:339
Generic struct for handling network timeouts.
Definition net_timeout.h:57
Network traffic class.
Definition net_if.h:601
k_thread_stack_t * stack
Stack for this handler.
Definition net_if.h:609
struct k_thread handler
Traffic class handler thread.
Definition net_if.h:606
struct k_fifo fifo
Fifo for handling this Tx or Rx packet.
Definition net_if.h:603
Generic sockaddr struct.
Definition net_ip.h:388