Zephyr API Documentation 4.0.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
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
46
47#ifdef __cplusplus
48extern "C" {
49#endif
50
58 struct net_addr address;
59
64
65#if defined(CONFIG_NET_NATIVE_IPV6)
66 struct net_timeout lifetime;
67#endif
68
71
74
75#if defined(CONFIG_NET_NATIVE_IPV6)
76#if defined(CONFIG_NET_IPV6_PE)
80 uint32_t addr_create_time;
81
84 uint32_t addr_preferred_lifetime;
85
90 int32_t addr_timeout;
91#endif
92#endif /* CONFIG_NET_NATIVE_IPV6 */
93
94 union {
95#if defined(CONFIG_NET_IPV6_DAD)
96 struct {
98 sys_snode_t dad_node;
99 uint32_t dad_start;
100
102 uint8_t dad_count;
103 };
104#endif /* CONFIG_NET_IPV6_DAD */
105#if defined(CONFIG_NET_IPV4_ACD)
106 struct {
108 sys_snode_t acd_node;
109 k_timepoint_t acd_timeout;
110
112 uint8_t acd_count;
113
115 uint8_t acd_state;
116 };
117#endif /* CONFIG_NET_IPV4_ACD */
118 };
119
120#if defined(CONFIG_NET_IPV6_DAD) || defined(CONFIG_NET_IPV4_ACD)
122 uint8_t ifindex;
123#endif
124
127
130
133
138
139 uint8_t _unused : 4;
140};
141
149 struct net_addr address;
150
151#if defined(CONFIG_NET_IPV4_IGMPV3)
153 struct net_addr sources[CONFIG_NET_IF_MCAST_IPV4_SOURCE_COUNT];
154
156 uint16_t sources_len;
157
159 uint8_t record_type;
160#endif
161
164
167
168 uint8_t _unused : 6;
169};
170
179
182
184 struct net_if *iface;
185
188
191
194
195 uint8_t _unused : 6;
196};
197
206
208 struct net_addr address;
209
211 struct net_if *iface;
212
215
218
221
224
227
228 uint8_t _unused : 5;
229};
230
288
299
300#if defined(CONFIG_NET_OFFLOAD)
301struct net_offload;
302#endif /* CONFIG_NET_OFFLOAD */
303
305#if defined(CONFIG_NET_IPV6)
306#define NET_IF_MAX_IPV6_ADDR CONFIG_NET_IF_UNICAST_IPV6_ADDR_COUNT
307#define NET_IF_MAX_IPV6_MADDR CONFIG_NET_IF_MCAST_IPV6_ADDR_COUNT
308#define NET_IF_MAX_IPV6_PREFIX CONFIG_NET_IF_IPV6_PREFIX_COUNT
309#else
310#define NET_IF_MAX_IPV6_ADDR 0
311#define NET_IF_MAX_IPV6_MADDR 0
312#define NET_IF_MAX_IPV6_PREFIX 0
313#endif
314/* @endcond */
315
319 struct net_if_addr unicast[NET_IF_MAX_IPV6_ADDR];
320
322 struct net_if_mcast_addr mcast[NET_IF_MAX_IPV6_MADDR];
323
325 struct net_if_ipv6_prefix prefix[NET_IF_MAX_IPV6_PREFIX];
326
329
332
335
336#if defined(CONFIG_NET_IPV6_IID_STABLE)
338 struct net_if_addr *iid;
339
343 uint32_t network_counter;
344#endif /* CONFIG_NET_IPV6_IID_STABLE */
345
346#if defined(CONFIG_NET_IPV6_PE)
351 uint32_t desync_factor;
352#endif /* CONFIG_NET_IPV6_PE */
353
354#if defined(CONFIG_NET_IPV6_ND) && defined(CONFIG_NET_NATIVE_IPV6)
356 sys_snode_t rs_node;
357
358 /* RS start time */
359 uint32_t rs_start;
360
362 uint8_t rs_count;
363#endif
364
367
370};
371
372#if defined(CONFIG_NET_DHCPV6) && defined(CONFIG_NET_NATIVE_IPV6)
374struct net_if_dhcpv6 {
376 sys_snode_t node;
377
379 struct net_dhcpv6_duid_storage clientid;
380
382 struct net_dhcpv6_duid_storage serverid;
383
385 enum net_dhcpv6_state state;
386
388 struct net_dhcpv6_params params;
389
391 uint64_t timeout;
392
394 uint64_t exchange_start;
395
397 uint64_t t1;
398
400 uint64_t t2;
401
405 uint64_t expire;
406
408 uint32_t addr_iaid;
409
411 uint32_t prefix_iaid;
412
414 uint32_t retransmit_timeout;
415
417 int16_t server_preference;
418
420 uint8_t retransmissions;
421
423 uint8_t tid[DHCPV6_TID_SIZE];
424
426 uint8_t prefix_len;
427
429 struct in6_addr prefix;
430
432 struct in6_addr addr;
433};
434#endif /* defined(CONFIG_NET_DHCPV6) && defined(CONFIG_NET_NATIVE_IPV6) */
435
437#if defined(CONFIG_NET_IPV4)
438#define NET_IF_MAX_IPV4_ADDR CONFIG_NET_IF_UNICAST_IPV4_ADDR_COUNT
439#define NET_IF_MAX_IPV4_MADDR CONFIG_NET_IF_MCAST_IPV4_ADDR_COUNT
440#else
441#define NET_IF_MAX_IPV4_ADDR 0
442#define NET_IF_MAX_IPV4_MADDR 0
443#endif
457
461 struct net_if_addr_ipv4 unicast[NET_IF_MAX_IPV4_ADDR];
462
464 struct net_if_mcast_addr mcast[NET_IF_MAX_IPV4_MADDR];
465
467 struct in_addr gw;
468
471
474
475#if defined(CONFIG_NET_IPV4_ACD)
477 uint8_t conflict_cnt;
478#endif
479};
480
481#if defined(CONFIG_NET_DHCPV4) && defined(CONFIG_NET_NATIVE_IPV4)
482struct net_if_dhcpv4 {
484 sys_snode_t node;
485
487 int64_t timer_start;
488
490 uint32_t request_time;
491
492 uint32_t xid;
493
495 uint32_t lease_time;
496
498 uint32_t renewal_time;
499
501 uint32_t rebinding_time;
502
504 struct in_addr server_id;
505
507 struct in_addr requested_ip;
508
510 struct in_addr netmask;
511
516 enum net_dhcpv4_state state;
517
519 uint8_t attempts;
520
522 struct in_addr request_server_addr;
523
525 struct in_addr response_src_addr;
526
527#ifdef CONFIG_NET_DHCPV4_OPTION_NTP_SERVER
529 struct in_addr ntp_addr;
530#endif
531};
532#endif /* CONFIG_NET_DHCPV4 */
533
534#if defined(CONFIG_NET_IPV4_AUTO) && defined(CONFIG_NET_NATIVE_IPV4)
535struct net_if_ipv4_autoconf {
537 struct net_if *iface;
538
540 struct in_addr requested_ip;
541
545};
546#endif /* CONFIG_NET_IPV4_AUTO */
547
549/* We always need to have at least one IP config */
550#define NET_IF_MAX_CONFIGS 1
556struct net_if_ip {
557#if defined(CONFIG_NET_IPV6)
558 struct net_if_ipv6 *ipv6;
559#endif /* CONFIG_NET_IPV6 */
560
561#if defined(CONFIG_NET_IPV4)
562 struct net_if_ipv4 *ipv4;
563#endif /* CONFIG_NET_IPV4 */
564};
565
570#if defined(CONFIG_NET_IP)
572 struct net_if_ip ip;
573#endif
574
575#if defined(CONFIG_NET_DHCPV4) && defined(CONFIG_NET_NATIVE_IPV4)
576 struct net_if_dhcpv4 dhcpv4;
577#endif /* CONFIG_NET_DHCPV4 */
578
579#if defined(CONFIG_NET_DHCPV6) && defined(CONFIG_NET_NATIVE_IPV6)
580 struct net_if_dhcpv6 dhcpv6;
581#endif /* CONFIG_NET_DHCPV6 */
582
583#if defined(CONFIG_NET_IPV4_AUTO) && defined(CONFIG_NET_NATIVE_IPV4)
584 struct net_if_ipv4_autoconf ipv4auto;
585#endif /* CONFIG_NET_IPV4_AUTO */
586
587#if defined(CONFIG_NET_L2_VIRTUAL)
592 sys_slist_t virtual_interfaces;
593#endif /* CONFIG_NET_L2_VIRTUAL */
594
595#if defined(CONFIG_NET_INTERFACE_NAME)
600 char name[CONFIG_NET_INTERFACE_NAME_LEN + 1];
601#endif
602};
603
623
630typedef int (*net_socket_create_t)(int, int, int);
631
648 const struct device *dev;
649
651 const struct net_l2 * const l2;
652
654 void *l2_data;
655
657 ATOMIC_DEFINE(flags, NET_IF_NUM_FLAGS);
658
661
662#if defined(CONFIG_NET_OFFLOAD)
668 struct net_offload *offload;
669#endif /* CONFIG_NET_OFFLOAD */
670
673
674#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
678 net_socket_create_t socket_offload;
679#endif /* CONFIG_NET_SOCKETS_OFFLOAD */
680
683};
684
692struct net_if {
695
696#if defined(CONFIG_NET_STATISTICS_PER_INTERFACE)
698 struct net_stats stats;
699
701 IF_ENABLED(CONFIG_NET_STATISTICS_VIA_PROMETHEUS,
702 (struct prometheus_collector *collector);)
703#endif /* CONFIG_NET_STATISTICS_PER_INTERFACE */
704
707
708#if defined(CONFIG_NET_POWER_MANAGEMENT)
713 int tx_pending;
714#endif
715
717 struct k_mutex lock;
718
721
727
732
734 uint8_t _unused : 6;
735};
736
739static inline void net_if_lock(struct net_if *iface)
740{
741 NET_ASSERT(iface);
742
743 (void)k_mutex_lock(&iface->lock, K_FOREVER);
744}
745
746static inline void net_if_unlock(struct net_if *iface)
747{
748 NET_ASSERT(iface);
749
750 k_mutex_unlock(&iface->lock);
751}
752
753static inline bool net_if_flag_is_set(struct net_if *iface,
754 enum net_if_flag value);
755
756static inline void net_if_tx_lock(struct net_if *iface)
757{
758 NET_ASSERT(iface);
759
761 return;
762 }
763
764 (void)k_mutex_lock(&iface->tx_lock, K_FOREVER);
765}
766
767static inline void net_if_tx_unlock(struct net_if *iface)
768{
769 NET_ASSERT(iface);
770
772 return;
773 }
774
775 k_mutex_unlock(&iface->tx_lock);
776}
777
786static inline void net_if_flag_set(struct net_if *iface,
787 enum net_if_flag value)
788{
789 if (iface == NULL || iface->if_dev == NULL) {
790 return;
791 }
792
793 atomic_set_bit(iface->if_dev->flags, value);
794}
795
804static inline bool net_if_flag_test_and_set(struct net_if *iface,
805 enum net_if_flag value)
806{
807 if (iface == NULL || iface->if_dev == NULL) {
808 return false;
809 }
810
811 return atomic_test_and_set_bit(iface->if_dev->flags, value);
812}
813
820static inline void net_if_flag_clear(struct net_if *iface,
821 enum net_if_flag value)
822{
823 if (iface == NULL || iface->if_dev == NULL) {
824 return;
825 }
826
827 atomic_clear_bit(iface->if_dev->flags, value);
828}
829
838static inline bool net_if_flag_test_and_clear(struct net_if *iface,
839 enum net_if_flag value)
840{
841 if (iface == NULL || iface->if_dev == NULL) {
842 return false;
843 }
844
845 return atomic_test_and_clear_bit(iface->if_dev->flags, value);
846}
847
856static inline bool net_if_flag_is_set(struct net_if *iface,
857 enum net_if_flag value)
858{
859 if (iface == NULL || iface->if_dev == NULL) {
860 return false;
861 }
862
863 return atomic_test_bit(iface->if_dev->flags, value);
864}
865
875 struct net_if *iface, enum net_if_oper_state oper_state)
876{
877 if (iface == NULL || iface->if_dev == NULL) {
878 return NET_IF_OPER_UNKNOWN;
879 }
880
881 BUILD_ASSERT((enum net_if_oper_state)(-1) > 0 && NET_IF_OPER_UNKNOWN == 0);
882 if (oper_state <= NET_IF_OPER_UP) {
883 iface->if_dev->oper_state = oper_state;
884 }
885
886 return iface->if_dev->oper_state;
887}
888
896static inline enum net_if_oper_state net_if_oper_state(struct net_if *iface)
897{
898 if (iface == NULL || iface->if_dev == NULL) {
899 return NET_IF_OPER_UNKNOWN;
900 }
901
902 return iface->if_dev->oper_state;
903}
904
913enum net_verdict net_if_send_data(struct net_if *iface, struct net_pkt *pkt);
914
922static inline const struct net_l2 *net_if_l2(struct net_if *iface)
923{
924 if (iface == NULL || iface->if_dev == NULL) {
925 return NULL;
926 }
927
928 return iface->if_dev->l2;
929}
930
939enum net_verdict net_if_recv_data(struct net_if *iface, struct net_pkt *pkt);
940
948static inline void *net_if_l2_data(struct net_if *iface)
949{
950 if (iface == NULL || iface->if_dev == NULL) {
951 return NULL;
952 }
953
954 return iface->if_dev->l2_data;
955}
956
964static inline const struct device *net_if_get_device(struct net_if *iface)
965{
966 if (iface == NULL || iface->if_dev == NULL) {
967 return NULL;
968 }
969
970 return iface->if_dev->dev;
971}
972
979void net_if_queue_tx(struct net_if *iface, struct net_pkt *pkt);
980
988static inline bool net_if_is_ip_offloaded(struct net_if *iface)
989{
990#if defined(CONFIG_NET_OFFLOAD)
991 return (iface != NULL && iface->if_dev != NULL &&
992 iface->if_dev->offload != NULL);
993#else
994 ARG_UNUSED(iface);
995
996 return false;
997#endif
998}
999
1007bool net_if_is_offloaded(struct net_if *iface);
1008
1016static inline struct net_offload *net_if_offload(struct net_if *iface)
1017{
1018#if defined(CONFIG_NET_OFFLOAD)
1019 if (iface == NULL || iface->if_dev == NULL) {
1020 return NULL;
1021 }
1022
1023 return iface->if_dev->offload;
1024#else
1025 ARG_UNUSED(iface);
1026
1027 return NULL;
1028#endif
1029}
1030
1038static inline bool net_if_is_socket_offloaded(struct net_if *iface)
1039{
1040#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
1041 if (iface == NULL || iface->if_dev == NULL) {
1042 return false;
1043 }
1044
1045 return (iface->if_dev->socket_offload != NULL);
1046#else
1047 ARG_UNUSED(iface);
1048
1049 return false;
1050#endif
1051}
1052
1059static inline void net_if_socket_offload_set(
1060 struct net_if *iface, net_socket_create_t socket_offload)
1061{
1062#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
1063 if (iface == NULL || iface->if_dev == NULL) {
1064 return;
1065 }
1066
1067 iface->if_dev->socket_offload = socket_offload;
1068#else
1069 ARG_UNUSED(iface);
1070 ARG_UNUSED(socket_offload);
1071#endif
1072}
1073
1082{
1083#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
1084 if (iface == NULL || iface->if_dev == NULL) {
1085 return NULL;
1086 }
1087
1088 return iface->if_dev->socket_offload;
1089#else
1090 ARG_UNUSED(iface);
1091
1092 return NULL;
1093#endif
1094}
1095
1103static inline struct net_linkaddr *net_if_get_link_addr(struct net_if *iface)
1104{
1105 if (iface == NULL || iface->if_dev == NULL) {
1106 return NULL;
1107 }
1108
1109 return &iface->if_dev->link_addr;
1110}
1111
1119static inline struct net_if_config *net_if_get_config(struct net_if *iface)
1120{
1121 if (iface == NULL) {
1122 return NULL;
1123 }
1124
1125 return &iface->config;
1126}
1127
1133#if defined(CONFIG_NET_IPV6_DAD) && defined(CONFIG_NET_NATIVE_IPV6)
1134void net_if_start_dad(struct net_if *iface);
1135#else
1136static inline void net_if_start_dad(struct net_if *iface)
1137{
1138 ARG_UNUSED(iface);
1139}
1140#endif
1141
1147void net_if_start_rs(struct net_if *iface);
1148
1149
1155#if defined(CONFIG_NET_IPV6_ND) && defined(CONFIG_NET_NATIVE_IPV6)
1156void net_if_stop_rs(struct net_if *iface);
1157#else
1158static inline void net_if_stop_rs(struct net_if *iface)
1159{
1160 ARG_UNUSED(iface);
1161}
1162#endif /* CONFIG_NET_IPV6_ND */
1163
1176#if defined(CONFIG_NET_IPV6_ND) && defined(CONFIG_NET_NATIVE_IPV6)
1177void net_if_nbr_reachability_hint(struct net_if *iface, const struct in6_addr *ipv6_addr);
1178#else
1179static inline void net_if_nbr_reachability_hint(struct net_if *iface,
1180 const struct in6_addr *ipv6_addr)
1181{
1182 ARG_UNUSED(iface);
1183 ARG_UNUSED(ipv6_addr);
1184}
1185#endif
1186
1189static inline int net_if_set_link_addr_unlocked(struct net_if *iface,
1190 uint8_t *addr, uint8_t len,
1191 enum net_link_type type)
1192{
1193 if (net_if_flag_is_set(iface, NET_IF_RUNNING)) {
1194 return -EPERM;
1195 }
1196
1197 net_if_get_link_addr(iface)->addr = addr;
1198 net_if_get_link_addr(iface)->len = len;
1199 net_if_get_link_addr(iface)->type = type;
1200
1201 net_hostname_set_postfix(addr, len);
1202
1203 return 0;
1204}
1205
1206int net_if_set_link_addr_locked(struct net_if *iface,
1207 uint8_t *addr, uint8_t len,
1208 enum net_link_type type);
1209
1210#if CONFIG_NET_IF_LOG_LEVEL >= LOG_LEVEL_DBG
1211extern int net_if_addr_unref_debug(struct net_if *iface,
1212 sa_family_t family,
1213 const void *addr,
1214 const char *caller, int line);
1215#define net_if_addr_unref(iface, family, addr) \
1216 net_if_addr_unref_debug(iface, family, addr, __func__, __LINE__)
1217
1218extern struct net_if_addr *net_if_addr_ref_debug(struct net_if *iface,
1219 sa_family_t family,
1220 const void *addr,
1221 const char *caller,
1222 int line);
1223#define net_if_addr_ref(iface, family, addr) \
1224 net_if_addr_ref_debug(iface, family, addr, __func__, __LINE__)
1225#else
1226extern int net_if_addr_unref(struct net_if *iface,
1227 sa_family_t family,
1228 const void *addr);
1229extern struct net_if_addr *net_if_addr_ref(struct net_if *iface,
1230 sa_family_t family,
1231 const void *addr);
1232#endif /* CONFIG_NET_IF_LOG_LEVEL */
1233
1247static inline int net_if_set_link_addr(struct net_if *iface,
1248 uint8_t *addr, uint8_t len,
1249 enum net_link_type type)
1250{
1251#if defined(CONFIG_NET_RAW_MODE)
1252 return net_if_set_link_addr_unlocked(iface, addr, len, type);
1253#else
1254 return net_if_set_link_addr_locked(iface, addr, len, type);
1255#endif
1256}
1257
1265static inline uint16_t net_if_get_mtu(struct net_if *iface)
1266{
1267 if (iface == NULL || iface->if_dev == NULL) {
1268 return 0U;
1269 }
1270
1271 return iface->if_dev->mtu;
1272}
1273
1280static inline void net_if_set_mtu(struct net_if *iface,
1281 uint16_t mtu)
1282{
1283 if (iface == NULL || iface->if_dev == NULL) {
1284 return;
1285 }
1286
1287 iface->if_dev->mtu = mtu;
1288}
1289
1296static inline void net_if_addr_set_lf(struct net_if_addr *ifaddr,
1297 bool is_infinite)
1298{
1299 if (ifaddr == NULL) {
1300 return;
1301 }
1302
1303 ifaddr->is_infinite = is_infinite;
1304}
1305
1314
1322struct net_if *net_if_lookup_by_dev(const struct device *dev);
1323
1331static inline struct net_if_config *net_if_config_get(struct net_if *iface)
1332{
1333 if (iface == NULL) {
1334 return NULL;
1335 }
1336
1337 return &iface->config;
1338}
1339
1345void net_if_router_rm(struct net_if_router *router);
1346
1352void net_if_set_default(struct net_if *iface);
1353
1360
1369struct net_if *net_if_get_first_by_type(const struct net_l2 *l2);
1370
1378
1379#if defined(CONFIG_NET_L2_IEEE802154)
1386static inline struct net_if *net_if_get_ieee802154(void)
1387{
1388 return net_if_get_first_by_type(&NET_L2_GET_NAME(IEEE802154));
1389}
1390#endif /* CONFIG_NET_L2_IEEE802154 */
1391
1403 struct net_if_ipv6 **ipv6);
1404
1413
1423 struct net_if **iface);
1424
1434 struct in6_addr *addr);
1435
1444__syscall int net_if_ipv6_addr_lookup_by_index(const struct in6_addr *addr);
1445
1457 struct in6_addr *addr,
1459 uint32_t vlifetime);
1460
1471__syscall bool net_if_ipv6_addr_add_by_index(int index,
1472 struct in6_addr *addr,
1474 uint32_t vlifetime);
1475
1483 uint32_t vlifetime);
1484
1493bool net_if_ipv6_addr_rm(struct net_if *iface, const struct in6_addr *addr);
1494
1503__syscall bool net_if_ipv6_addr_rm_by_index(int index,
1504 const struct in6_addr *addr);
1505
1514typedef void (*net_if_ip_addr_cb_t)(struct net_if *iface,
1515 struct net_if_addr *addr,
1516 void *user_data);
1517
1527 void *user_data);
1528
1538 const struct in6_addr *addr);
1539
1548bool net_if_ipv6_maddr_rm(struct net_if *iface, const struct in6_addr *addr);
1549
1558typedef void (*net_if_ip_maddr_cb_t)(struct net_if *iface,
1559 struct net_if_mcast_addr *maddr,
1560 void *user_data);
1561
1571 void *user_data);
1572
1584 struct net_if **iface);
1585
1596typedef void (*net_if_mcast_callback_t)(struct net_if *iface,
1597 const struct net_addr *addr,
1598 bool is_joined);
1599
1618
1628 struct net_if *iface,
1630
1637
1645void net_if_mcast_monitor(struct net_if *iface, const struct net_addr *addr,
1646 bool is_joined);
1647
1655 struct net_if_mcast_addr *addr);
1656
1664static inline bool net_if_ipv6_maddr_is_joined(struct net_if_mcast_addr *addr)
1665{
1666 if (addr == NULL) {
1667 return false;
1668 }
1669
1670 return addr->is_joined;
1671}
1672
1680 struct net_if_mcast_addr *addr);
1681
1691 const struct in6_addr *addr);
1692
1703 struct in6_addr *addr,
1704 uint8_t len);
1705
1717 struct in6_addr *prefix,
1718 uint8_t len,
1720
1730bool net_if_ipv6_prefix_rm(struct net_if *iface, struct in6_addr *addr,
1731 uint8_t len);
1732
1740 bool is_infinite)
1741{
1742 prefix->is_infinite = is_infinite;
1743}
1744
1753
1760
1771bool net_if_ipv6_addr_onlink(struct net_if **iface, struct in6_addr *addr);
1772
1779#if defined(CONFIG_NET_NATIVE_IPV6)
1780static inline struct in6_addr *net_if_router_ipv6(struct net_if_router *router)
1781{
1782 if (router == NULL) {
1783 return NULL;
1784 }
1785
1786 return &router->address.in6_addr;
1787}
1788#else
1789static inline struct in6_addr *net_if_router_ipv6(struct net_if_router *router)
1790{
1791 static struct in6_addr addr;
1792
1793 ARG_UNUSED(router);
1794
1795 return &addr;
1796}
1797#endif
1798
1809 struct in6_addr *addr);
1810
1821 struct in6_addr *addr);
1822
1831
1842 struct in6_addr *addr,
1843 uint16_t router_lifetime);
1844
1853
1862#if defined(CONFIG_NET_NATIVE_IPV6)
1864#else
1866{
1867 ARG_UNUSED(iface);
1868
1869 return 0;
1870}
1871#endif /* CONFIG_NET_NATIVE_IPV6 */
1872
1879#if defined(CONFIG_NET_NATIVE_IPV6)
1880void net_if_ipv6_set_hop_limit(struct net_if *iface, uint8_t hop_limit);
1881#else
1882static inline void net_if_ipv6_set_hop_limit(struct net_if *iface,
1883 uint8_t hop_limit)
1884{
1885 ARG_UNUSED(iface);
1886 ARG_UNUSED(hop_limit);
1887}
1888#endif /* CONFIG_NET_NATIVE_IPV6 */
1889
1892/* The old hop limit setter function is deprecated because the naming
1893 * of it was incorrect. The API name was missing "_if_" so this function
1894 * should not be used.
1895 */
1896__deprecated
1897static inline void net_ipv6_set_hop_limit(struct net_if *iface,
1898 uint8_t hop_limit)
1899{
1900 net_if_ipv6_set_hop_limit(iface, hop_limit);
1901}
1902
1913#if defined(CONFIG_NET_NATIVE_IPV6)
1915#else
1917{
1918 ARG_UNUSED(iface);
1919
1920 return 0;
1921}
1922#endif /* CONFIG_NET_NATIVE_IPV6 */
1923
1930#if defined(CONFIG_NET_NATIVE_IPV6)
1931void net_if_ipv6_set_mcast_hop_limit(struct net_if *iface, uint8_t hop_limit);
1932#else
1934 uint8_t hop_limit)
1935{
1936 ARG_UNUSED(iface);
1937 ARG_UNUSED(hop_limit);
1938}
1939#endif /* CONFIG_NET_NATIVE_IPV6 */
1940
1948 uint32_t reachable_time)
1949{
1950#if defined(CONFIG_NET_NATIVE_IPV6)
1951 if (iface == NULL) {
1952 return;
1953 }
1954
1955 if (!iface->config.ip.ipv6) {
1956 return;
1957 }
1958
1959 iface->config.ip.ipv6->base_reachable_time = reachable_time;
1960#else
1961 ARG_UNUSED(iface);
1962 ARG_UNUSED(reachable_time);
1963
1964#endif
1965}
1966
1975{
1976#if defined(CONFIG_NET_NATIVE_IPV6)
1977 if (iface == NULL) {
1978 return 0;
1979 }
1980
1981 if (!iface->config.ip.ipv6) {
1982 return 0;
1983 }
1984
1985 return iface->config.ip.ipv6->reachable_time;
1986#else
1987 ARG_UNUSED(iface);
1988 return 0;
1989#endif
1990}
1991
2000
2007static inline void net_if_ipv6_set_reachable_time(struct net_if_ipv6 *ipv6)
2008{
2009#if defined(CONFIG_NET_NATIVE_IPV6)
2010 if (ipv6 == NULL) {
2011 return;
2012 }
2013
2015#else
2016 ARG_UNUSED(ipv6);
2017#endif
2018}
2019
2026static inline void net_if_ipv6_set_retrans_timer(struct net_if *iface,
2027 uint32_t retrans_timer)
2028{
2029#if defined(CONFIG_NET_NATIVE_IPV6)
2030 if (iface == NULL) {
2031 return;
2032 }
2033
2034 if (!iface->config.ip.ipv6) {
2035 return;
2036 }
2037
2038 iface->config.ip.ipv6->retrans_timer = retrans_timer;
2039#else
2040 ARG_UNUSED(iface);
2041 ARG_UNUSED(retrans_timer);
2042#endif
2043}
2044
2053{
2054#if defined(CONFIG_NET_NATIVE_IPV6)
2055 if (iface == NULL) {
2056 return 0;
2057 }
2058
2059 if (!iface->config.ip.ipv6) {
2060 return 0;
2061 }
2062
2063 return iface->config.ip.ipv6->retrans_timer;
2064#else
2065 ARG_UNUSED(iface);
2066 return 0;
2067#endif
2068}
2069
2081#if defined(CONFIG_NET_IPV6)
2082const struct in6_addr *net_if_ipv6_select_src_addr(struct net_if *iface,
2083 const struct in6_addr *dst);
2084#else
2085static inline const struct in6_addr *net_if_ipv6_select_src_addr(
2086 struct net_if *iface, const struct in6_addr *dst)
2087{
2088 ARG_UNUSED(iface);
2089 ARG_UNUSED(dst);
2090
2091 return NULL;
2092}
2093#endif
2094
2108#if defined(CONFIG_NET_IPV6)
2109const struct in6_addr *net_if_ipv6_select_src_addr_hint(struct net_if *iface,
2110 const struct in6_addr *dst,
2111 int flags);
2112#else
2113static inline const struct in6_addr *net_if_ipv6_select_src_addr_hint(
2114 struct net_if *iface, const struct in6_addr *dst, int flags)
2115{
2116 ARG_UNUSED(iface);
2117 ARG_UNUSED(dst);
2118 ARG_UNUSED(flags);
2119
2120 return NULL;
2121}
2122#endif
2123
2133#if defined(CONFIG_NET_IPV6)
2134struct net_if *net_if_ipv6_select_src_iface(const struct in6_addr *dst);
2135#else
2137 const struct in6_addr *dst)
2138{
2139 ARG_UNUSED(dst);
2140
2141 return NULL;
2142}
2143#endif
2144
2154struct in6_addr *net_if_ipv6_get_ll(struct net_if *iface,
2155 enum net_addr_state addr_state);
2156
2167 struct net_if **iface);
2168
2176void net_if_ipv6_dad_failed(struct net_if *iface, const struct in6_addr *addr);
2177
2190 struct net_if **iface);
2191
2203 struct net_if_ipv4 **ipv4);
2204
2213
2222
2229void net_if_ipv4_set_ttl(struct net_if *iface, uint8_t ttl);
2230
2239
2247
2257 struct net_if **iface);
2258
2270 struct in_addr *addr,
2272 uint32_t vlifetime);
2273
2282bool net_if_ipv4_addr_rm(struct net_if *iface, const struct in_addr *addr);
2283
2292__syscall int net_if_ipv4_addr_lookup_by_index(const struct in_addr *addr);
2293
2304__syscall bool net_if_ipv4_addr_add_by_index(int index,
2305 struct in_addr *addr,
2307 uint32_t vlifetime);
2308
2317__syscall bool net_if_ipv4_addr_rm_by_index(int index,
2318 const struct in_addr *addr);
2319
2329 void *user_data);
2330
2340 const struct in_addr *addr);
2341
2350bool net_if_ipv4_maddr_rm(struct net_if *iface, const struct in_addr *addr);
2351
2361 void *user_data);
2362
2374 struct net_if **iface);
2375
2383 struct net_if_mcast_addr *addr);
2384
2392static inline bool net_if_ipv4_maddr_is_joined(struct net_if_mcast_addr *addr)
2393{
2394 if (addr == NULL) {
2395 return false;
2396 }
2397
2398 return addr->is_joined;
2399}
2400
2408 struct net_if_mcast_addr *addr);
2409
2416#if defined(CONFIG_NET_NATIVE_IPV4)
2417static inline struct in_addr *net_if_router_ipv4(struct net_if_router *router)
2418{
2419 if (router == NULL) {
2420 return NULL;
2421 }
2422
2423 return &router->address.in_addr;
2424}
2425#else
2426static inline struct in_addr *net_if_router_ipv4(struct net_if_router *router)
2427{
2428 static struct in_addr addr;
2429
2430 ARG_UNUSED(router);
2431
2432 return &addr;
2433}
2434#endif
2435
2446 struct in_addr *addr);
2447
2458 struct in_addr *addr);
2470 struct in_addr *addr,
2471 bool is_default,
2472 uint16_t router_lifetime);
2473
2482
2492 const struct in_addr *addr);
2493
2503 const struct in_addr *addr);
2504
2514#if defined(CONFIG_NET_IPV4)
2515struct net_if *net_if_ipv4_select_src_iface(const struct in_addr *dst);
2516#else
2518 const struct in_addr *dst)
2519{
2520 ARG_UNUSED(dst);
2521
2522 return NULL;
2523}
2524#endif
2525
2537#if defined(CONFIG_NET_IPV4)
2538const struct in_addr *net_if_ipv4_select_src_addr(struct net_if *iface,
2539 const struct in_addr *dst);
2540#else
2541static inline const struct in_addr *net_if_ipv4_select_src_addr(
2542 struct net_if *iface, const struct in_addr *dst)
2543{
2544 ARG_UNUSED(iface);
2545 ARG_UNUSED(dst);
2546
2547 return NULL;
2548}
2549#endif
2550
2560struct in_addr *net_if_ipv4_get_ll(struct net_if *iface,
2561 enum net_addr_state addr_state);
2562
2573 enum net_addr_state addr_state);
2574
2585 const struct in_addr *addr);
2586
2596__deprecated struct in_addr net_if_ipv4_get_netmask(struct net_if *iface);
2597
2606__deprecated void net_if_ipv4_set_netmask(struct net_if *iface,
2607 const struct in_addr *netmask);
2608
2619__deprecated __syscall bool net_if_ipv4_set_netmask_by_index(int index,
2620 const struct in_addr *netmask);
2621
2632 const struct in_addr *addr,
2633 const struct in_addr *netmask);
2634
2645 const struct in_addr *addr,
2646 const struct in_addr *netmask);
2647
2655struct in_addr net_if_ipv4_get_gw(struct net_if *iface);
2656
2663void net_if_ipv4_set_gw(struct net_if *iface, const struct in_addr *gw);
2664
2673__syscall bool net_if_ipv4_set_gw_by_index(int index, const struct in_addr *gw);
2674
2685struct net_if *net_if_select_src_iface(const struct sockaddr *dst);
2686
2695typedef void (*net_if_link_callback_t)(struct net_if *iface,
2696 struct net_linkaddr *dst,
2697 int status);
2698
2714
2723
2730
2738void net_if_call_link_cb(struct net_if *iface, struct net_linkaddr *lladdr,
2739 int status);
2740
2743/* used to ensure encoding of checksum support in net_if.h and
2744 * ethernet.h is the same
2745 */
2746#define NET_IF_CHECKSUM_NONE_BIT 0
2747#define NET_IF_CHECKSUM_IPV4_HEADER_BIT BIT(0)
2748#define NET_IF_CHECKSUM_IPV4_ICMP_BIT BIT(1)
2749/* Space for future protocols and restrictions for IPV4 */
2750#define NET_IF_CHECKSUM_IPV6_HEADER_BIT BIT(10)
2751#define NET_IF_CHECKSUM_IPV6_ICMP_BIT BIT(11)
2752/* Space for future protocols and restrictions for IPV6 */
2753#define NET_IF_CHECKSUM_TCP_BIT BIT(21)
2754#define NET_IF_CHECKSUM_UDP_BIT BIT(22)
2755
2763 NET_IF_CHECKSUM_IPV4_HEADER = NET_IF_CHECKSUM_IPV4_HEADER_BIT,
2765 NET_IF_CHECKSUM_IPV4_TCP = NET_IF_CHECKSUM_IPV4_HEADER_BIT |
2766 NET_IF_CHECKSUM_TCP_BIT,
2768 NET_IF_CHECKSUM_IPV4_UDP = NET_IF_CHECKSUM_IPV4_HEADER_BIT |
2769 NET_IF_CHECKSUM_UDP_BIT,
2771 NET_IF_CHECKSUM_IPV4_ICMP = NET_IF_CHECKSUM_IPV4_ICMP_BIT,
2773 NET_IF_CHECKSUM_IPV6_HEADER = NET_IF_CHECKSUM_IPV6_HEADER_BIT,
2775 NET_IF_CHECKSUM_IPV6_TCP = NET_IF_CHECKSUM_IPV6_HEADER_BIT |
2776 NET_IF_CHECKSUM_TCP_BIT,
2778 NET_IF_CHECKSUM_IPV6_UDP = NET_IF_CHECKSUM_IPV6_HEADER_BIT |
2779 NET_IF_CHECKSUM_UDP_BIT,
2781 NET_IF_CHECKSUM_IPV6_ICMP = NET_IF_CHECKSUM_IPV6_ICMP_BIT
2783
2795 enum net_if_checksum_type chksum_type);
2796
2809 enum net_if_checksum_type chksum_type);
2810
2821__syscall struct net_if *net_if_get_by_index(int index);
2822
2830int net_if_get_by_iface(struct net_if *iface);
2831
2839typedef void (*net_if_cb_t)(struct net_if *iface, void *user_data);
2840
2848void net_if_foreach(net_if_cb_t cb, void *user_data);
2849
2857int net_if_up(struct net_if *iface);
2858
2866static inline bool net_if_is_up(struct net_if *iface)
2867{
2868 if (iface == NULL) {
2869 return false;
2870 }
2871
2872 return net_if_flag_is_set(iface, NET_IF_UP) &&
2874}
2875
2883int net_if_down(struct net_if *iface);
2884
2892static inline bool net_if_is_admin_up(struct net_if *iface)
2893{
2894 if (iface == NULL) {
2895 return false;
2896 }
2897
2898 return net_if_flag_is_set(iface, NET_IF_UP);
2899}
2900
2909void net_if_carrier_on(struct net_if *iface);
2910
2919void net_if_carrier_off(struct net_if *iface);
2920
2928static inline bool net_if_is_carrier_ok(struct net_if *iface)
2929{
2930 if (iface == NULL) {
2931 return false;
2932 }
2933
2934 return net_if_flag_is_set(iface, NET_IF_LOWER_UP);
2935}
2936
2947void net_if_dormant_on(struct net_if *iface);
2948
2957void net_if_dormant_off(struct net_if *iface);
2958
2966static inline bool net_if_is_dormant(struct net_if *iface)
2967{
2968 if (iface == NULL) {
2969 return false;
2970 }
2971
2972 return net_if_flag_is_set(iface, NET_IF_DORMANT);
2973}
2974
2975#if defined(CONFIG_NET_PKT_TIMESTAMP) && defined(CONFIG_NET_NATIVE)
2983typedef void (*net_if_timestamp_callback_t)(struct net_pkt *pkt);
2984
2993struct net_if_timestamp_cb {
2995 sys_snode_t node;
2996
3000 struct net_pkt *pkt;
3001
3005 struct net_if *iface;
3006
3008 net_if_timestamp_callback_t cb;
3009};
3010
3021void net_if_register_timestamp_cb(struct net_if_timestamp_cb *handle,
3022 struct net_pkt *pkt,
3023 struct net_if *iface,
3024 net_if_timestamp_callback_t cb);
3025
3031void net_if_unregister_timestamp_cb(struct net_if_timestamp_cb *handle);
3032
3038void net_if_call_timestamp_cb(struct net_pkt *pkt);
3039
3040/*
3041 * @brief Add timestamped TX buffer to be handled
3042 *
3043 * @param pkt Timestamped buffer
3044 */
3045void net_if_add_tx_timestamp(struct net_pkt *pkt);
3046#endif /* CONFIG_NET_PKT_TIMESTAMP */
3047
3057#if defined(CONFIG_NET_PROMISCUOUS_MODE)
3058int net_if_set_promisc(struct net_if *iface);
3059#else
3060static inline int net_if_set_promisc(struct net_if *iface)
3061{
3062 ARG_UNUSED(iface);
3063
3064 return -ENOTSUP;
3065}
3066#endif
3067
3073#if defined(CONFIG_NET_PROMISCUOUS_MODE)
3074void net_if_unset_promisc(struct net_if *iface);
3075#else
3076static inline void net_if_unset_promisc(struct net_if *iface)
3077{
3078 ARG_UNUSED(iface);
3079}
3080#endif
3081
3090#if defined(CONFIG_NET_PROMISCUOUS_MODE)
3091bool net_if_is_promisc(struct net_if *iface);
3092#else
3093static inline bool net_if_is_promisc(struct net_if *iface)
3094{
3095 ARG_UNUSED(iface);
3096
3097 return false;
3098}
3099#endif
3100
3110static inline bool net_if_are_pending_tx_packets(struct net_if *iface)
3111{
3112#if defined(CONFIG_NET_POWER_MANAGEMENT)
3113 return !!iface->tx_pending;
3114#else
3115 ARG_UNUSED(iface);
3116
3117 return false;
3118#endif
3119}
3120
3121#ifdef CONFIG_NET_POWER_MANAGEMENT
3129int net_if_suspend(struct net_if *iface);
3130
3138int net_if_resume(struct net_if *iface);
3139
3147bool net_if_is_suspended(struct net_if *iface);
3148#endif /* CONFIG_NET_POWER_MANAGEMENT */
3149
3157bool net_if_is_wifi(struct net_if *iface);
3158
3165
3172
3179
3194int net_if_get_name(struct net_if *iface, char *buf, int len);
3195
3210int net_if_set_name(struct net_if *iface, const char *buf);
3211
3219int net_if_get_by_name(const char *name);
3220
3222struct net_if_api {
3223 void (*init)(struct net_if *iface);
3224};
3225
3226#define NET_IF_DHCPV4_INIT \
3227 IF_ENABLED(UTIL_AND(IS_ENABLED(CONFIG_NET_DHCPV4), \
3228 IS_ENABLED(CONFIG_NET_NATIVE_IPV4)), \
3229 (.dhcpv4.state = NET_DHCPV4_DISABLED,))
3230
3231#define NET_IF_DHCPV6_INIT \
3232 IF_ENABLED(UTIL_AND(IS_ENABLED(CONFIG_NET_DHCPV6), \
3233 IS_ENABLED(CONFIG_NET_NATIVE_IPV6)), \
3234 (.dhcpv6.state = NET_DHCPV6_DISABLED,))
3235
3236#define NET_IF_CONFIG_INIT \
3237 .config = { \
3238 IF_ENABLED(CONFIG_NET_IP, (.ip = {},)) \
3239 NET_IF_DHCPV4_INIT \
3240 NET_IF_DHCPV6_INIT \
3241 }
3242
3243#define NET_PROMETHEUS_GET_COLLECTOR_NAME(dev_id, sfx) \
3244 net_stats_##dev_id##_##sfx##_collector
3245#define NET_PROMETHEUS_INIT(dev_id, sfx) \
3246 IF_ENABLED(CONFIG_NET_STATISTICS_VIA_PROMETHEUS, \
3247 (.collector = &NET_PROMETHEUS_GET_COLLECTOR_NAME(dev_id, sfx),))
3248
3249#define NET_IF_GET_NAME(dev_id, sfx) __net_if_##dev_id##_##sfx
3250#define NET_IF_DEV_GET_NAME(dev_id, sfx) __net_if_dev_##dev_id##_##sfx
3251
3252#define NET_IF_GET(dev_id, sfx) \
3253 ((struct net_if *)&NET_IF_GET_NAME(dev_id, sfx))
3254
3255#if defined(CONFIG_NET_STATISTICS_VIA_PROMETHEUS)
3256extern int net_stats_prometheus_scrape(struct prometheus_collector *collector,
3257 struct prometheus_metric *metric,
3258 void *user_data);
3259#endif /* CONFIG_NET_STATISTICS_VIA_PROMETHEUS */
3260
3261#define NET_IF_INIT(dev_id, sfx, _l2, _mtu, _num_configs) \
3262 static STRUCT_SECTION_ITERABLE(net_if_dev, \
3263 NET_IF_DEV_GET_NAME(dev_id, sfx)) = { \
3264 .dev = &(DEVICE_NAME_GET(dev_id)), \
3265 .l2 = &(NET_L2_GET_NAME(_l2)), \
3266 .l2_data = &(NET_L2_GET_DATA(dev_id, sfx)), \
3267 .mtu = _mtu, \
3268 .flags = {BIT(NET_IF_LOWER_UP)}, \
3269 }; \
3270 static Z_DECL_ALIGN(struct net_if) \
3271 NET_IF_GET_NAME(dev_id, sfx)[_num_configs] \
3272 __used __in_section(_net_if, static, \
3273 dev_id) = { \
3274 [0 ... (_num_configs - 1)] = { \
3275 .if_dev = &(NET_IF_DEV_GET_NAME(dev_id, sfx)), \
3276 NET_IF_CONFIG_INIT \
3277 } \
3278 }; \
3279 IF_ENABLED(CONFIG_NET_STATISTICS_VIA_PROMETHEUS, \
3280 (static PROMETHEUS_COLLECTOR_DEFINE( \
3281 NET_PROMETHEUS_GET_COLLECTOR_NAME(dev_id, \
3282 sfx), \
3283 net_stats_prometheus_scrape, \
3284 NET_IF_GET(dev_id, sfx)); \
3285 NET_STATS_PROMETHEUS(NET_IF_GET(dev_id, sfx), \
3286 dev_id, sfx);))
3287
3288#define NET_IF_OFFLOAD_INIT(dev_id, sfx, _mtu) \
3289 static STRUCT_SECTION_ITERABLE(net_if_dev, \
3290 NET_IF_DEV_GET_NAME(dev_id, sfx)) = { \
3291 .dev = &(DEVICE_NAME_GET(dev_id)), \
3292 .mtu = _mtu, \
3293 .l2 = &(NET_L2_GET_NAME(OFFLOADED_NETDEV)), \
3294 .flags = {BIT(NET_IF_LOWER_UP)}, \
3295 }; \
3296 static Z_DECL_ALIGN(struct net_if) \
3297 NET_IF_GET_NAME(dev_id, sfx)[NET_IF_MAX_CONFIGS] \
3298 __used __in_section(_net_if, static, \
3299 dev_id) = { \
3300 [0 ... (NET_IF_MAX_CONFIGS - 1)] = { \
3301 .if_dev = &(NET_IF_DEV_GET_NAME(dev_id, sfx)), \
3302 NET_IF_CONFIG_INIT \
3303 } \
3304 }; \
3305 IF_ENABLED(CONFIG_NET_STATISTICS_VIA_PROMETHEUS, \
3306 (static PROMETHEUS_COLLECTOR_DEFINE( \
3307 NET_PROMETHEUS_GET_COLLECTOR_NAME(dev_id, \
3308 sfx), \
3309 net_stats_prometheus_scrape, \
3310 NET_IF_GET(dev_id, sfx)); \
3311 NET_STATS_PROMETHEUS(NET_IF_GET(dev_id, sfx), \
3312 dev_id, sfx);))
3313
3314
3317/* Network device initialization macros */
3318
3319#define Z_NET_DEVICE_INIT_INSTANCE(node_id, dev_id, name, instance, \
3320 init_fn, pm, data, config, prio, \
3321 api, l2, l2_ctx_type, mtu) \
3322 Z_DEVICE_STATE_DEFINE(dev_id); \
3323 Z_DEVICE_DEFINE(node_id, dev_id, name, init_fn, pm, data, \
3324 config, POST_KERNEL, prio, api, \
3325 &Z_DEVICE_STATE_NAME(dev_id)); \
3326 NET_L2_DATA_INIT(dev_id, instance, l2_ctx_type); \
3327 NET_IF_INIT(dev_id, instance, l2, mtu, NET_IF_MAX_CONFIGS)
3328
3329#define Z_NET_DEVICE_INIT(node_id, dev_id, name, init_fn, pm, data, \
3330 config, prio, api, l2, l2_ctx_type, mtu) \
3331 Z_NET_DEVICE_INIT_INSTANCE(node_id, dev_id, name, 0, init_fn, \
3332 pm, data, config, prio, api, l2, \
3333 l2_ctx_type, mtu)
3334
3354#define NET_DEVICE_INIT(dev_id, name, init_fn, pm, data, config, prio, \
3355 api, l2, l2_ctx_type, mtu) \
3356 Z_NET_DEVICE_INIT(DT_INVALID_NODE, dev_id, name, init_fn, pm, \
3357 data, config, prio, api, l2, l2_ctx_type, mtu)
3358
3377#define NET_DEVICE_DT_DEFINE(node_id, init_fn, pm, data, \
3378 config, prio, api, l2, l2_ctx_type, mtu) \
3379 Z_NET_DEVICE_INIT(node_id, Z_DEVICE_DT_DEV_ID(node_id), \
3380 DEVICE_DT_NAME(node_id), init_fn, pm, data, \
3381 config, prio, api, l2, l2_ctx_type, mtu)
3382
3391#define NET_DEVICE_DT_INST_DEFINE(inst, ...) \
3392 NET_DEVICE_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
3393
3417#define NET_DEVICE_INIT_INSTANCE(dev_id, name, instance, init_fn, pm, \
3418 data, config, prio, api, l2, \
3419 l2_ctx_type, mtu) \
3420 Z_NET_DEVICE_INIT_INSTANCE(DT_INVALID_NODE, dev_id, name, \
3421 instance, init_fn, pm, data, config, \
3422 prio, api, l2, l2_ctx_type, mtu)
3423
3446#define NET_DEVICE_DT_DEFINE_INSTANCE(node_id, instance, init_fn, pm, \
3447 data, config, prio, api, l2, \
3448 l2_ctx_type, mtu) \
3449 Z_NET_DEVICE_INIT_INSTANCE(node_id, \
3450 Z_DEVICE_DT_DEV_ID(node_id), \
3451 DEVICE_DT_NAME(node_id), instance, \
3452 init_fn, pm, data, config, prio, \
3453 api, l2, l2_ctx_type, mtu)
3454
3464#define NET_DEVICE_DT_INST_DEFINE_INSTANCE(inst, ...) \
3465 NET_DEVICE_DT_DEFINE_INSTANCE(DT_DRV_INST(inst), __VA_ARGS__)
3466
3467#define Z_NET_DEVICE_OFFLOAD_INIT(node_id, dev_id, name, init_fn, pm, \
3468 data, config, prio, api, mtu) \
3469 Z_DEVICE_STATE_DEFINE(dev_id); \
3470 Z_DEVICE_DEFINE(node_id, dev_id, name, init_fn, pm, data, \
3471 config, POST_KERNEL, prio, api, \
3472 &Z_DEVICE_STATE_NAME(dev_id)); \
3473 NET_IF_OFFLOAD_INIT(dev_id, 0, mtu)
3474
3494#define NET_DEVICE_OFFLOAD_INIT(dev_id, name, init_fn, pm, data, \
3495 config, prio, api, mtu) \
3496 Z_NET_DEVICE_OFFLOAD_INIT(DT_INVALID_NODE, dev_id, name, \
3497 init_fn, pm, data, config, prio, api, \
3498 mtu)
3499
3518#define NET_DEVICE_DT_OFFLOAD_DEFINE(node_id, init_fn, pm, data, \
3519 config, prio, api, mtu) \
3520 Z_NET_DEVICE_OFFLOAD_INIT(node_id, Z_DEVICE_DT_DEV_ID(node_id), \
3521 DEVICE_DT_NAME(node_id), init_fn, pm, \
3522 data, config, prio, api, mtu)
3523
3533#define NET_DEVICE_DT_INST_OFFLOAD_DEFINE(inst, ...) \
3534 NET_DEVICE_DT_OFFLOAD_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
3535
3541#define NET_IFACE_COUNT(_dst) \
3542 do { \
3543 extern struct net_if _net_if_list_start[]; \
3544 extern struct net_if _net_if_list_end[]; \
3545 *(_dst) = ((uintptr_t)_net_if_list_end - \
3546 (uintptr_t)_net_if_list_start) / \
3547 sizeof(struct net_if); \
3548 } while (0)
3549
3550#ifdef __cplusplus
3551}
3552#endif
3553
3554#include <zephyr/syscalls/net_if.h>
3555
3560#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
Prometheus collector APIs.
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:1446
unsigned short int sa_family_t
Socket address family type.
Definition net_ip.h:168
net_addr_state
What is the current state of the network address.
Definition net_ip.h:526
net_addr_type
How the network address is assigned to network interface.
Definition net_ip.h:534
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:2928
static bool net_if_is_admin_up(struct net_if *iface)
Check if interface was brought up by the administrator.
Definition net_if.h:2892
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:1596
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:2695
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:874
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:2426
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:948
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:3110
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:804
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:1103
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:2085
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:1179
static struct net_offload * net_if_offload(struct net_if *iface)
Return the IP offload plugin.
Definition net_if.h:1016
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:1247
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:786
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:1916
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:1882
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:2113
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:1865
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:988
static bool net_if_is_dormant(struct net_if *iface)
Check if the interface is dormant.
Definition net_if.h:2966
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:1558
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:1280
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:2866
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:2007
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:2761
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:1136
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:3076
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:1059
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:1974
static bool net_if_is_promisc(struct net_if *iface)
Check if promiscuous mode is set or not.
Definition net_if.h:3093
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:2392
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:1739
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:1158
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:1947
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:1514
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:838
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:1664
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:2839
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:1265
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:2541
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:2026
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:1789
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:2052
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:290
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:2136
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:856
static struct net_if_config * net_if_config_get(struct net_if *iface)
Get network interface IP config.
Definition net_if.h:1331
static struct net_if_config * net_if_get_config(struct net_if *iface)
Return network configuration for this network interface.
Definition net_if.h:1119
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:1296
net_if_flag
Network interface flags.
Definition net_if.h:232
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:964
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:630
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:1038
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:1933
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:3060
static const struct net_l2 * net_if_l2(struct net_if *iface)
Get a pointer to the interface L2.
Definition net_if.h:922
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:1081
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:2517
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:820
@ NET_IF_CHECKSUM_IPV4_ICMP
Interface supports checksum calculation for ICMP4 payload in IPv4.
Definition net_if.h:2771
@ NET_IF_CHECKSUM_IPV6_TCP
Interface supports checksum calculation for TCP payload in IPv6.
Definition net_if.h:2775
@ NET_IF_CHECKSUM_IPV6_UDP
Interface supports checksum calculation for UDP payload in IPv6.
Definition net_if.h:2778
@ NET_IF_CHECKSUM_IPV4_HEADER
Interface supports IP version 4 header checksum calculation.
Definition net_if.h:2763
@ NET_IF_CHECKSUM_IPV4_TCP
Interface supports checksum calculation for TCP payload in IPv4.
Definition net_if.h:2765
@ NET_IF_CHECKSUM_IPV6_HEADER
Interface supports IP version 6 header checksum calculation.
Definition net_if.h:2773
@ NET_IF_CHECKSUM_IPV6_ICMP
Interface supports checksum calculation for ICMP6 payload in IPv6.
Definition net_if.h:2781
@ NET_IF_CHECKSUM_IPV4_UDP
Interface supports checksum calculation for UDP payload in IPv4.
Definition net_if.h:2768
@ NET_IF_OPER_TESTING
Training mode.
Definition net_if.h:295
@ NET_IF_OPER_DORMANT
Waiting external action.
Definition net_if.h:296
@ NET_IF_OPER_UP
Interface is up.
Definition net_if.h:297
@ NET_IF_OPER_NOTPRESENT
Hardware missing.
Definition net_if.h:292
@ NET_IF_OPER_UNKNOWN
Initial (unknown) value.
Definition net_if.h:291
@ NET_IF_OPER_DOWN
Interface is down.
Definition net_if.h:293
@ NET_IF_OPER_LOWERLAYERDOWN
Lower layer interface is down.
Definition net_if.h:294
@ NET_IF_NO_AUTO_START
Do not start the interface immediately after initialization.
Definition net_if.h:248
@ NET_IF_IPV6_NO_MLD
IPv6 Multicast Listener Discovery disabled.
Definition net_if.h:278
@ NET_IF_POINTOPOINT
Interface is pointopoint.
Definition net_if.h:237
@ NET_IF_IPV6_NO_ND
IPv6 Neighbor Discovery disabled.
Definition net_if.h:275
@ NET_IF_FORWARD_MULTICASTS
Flag defines if received multicasts of other interface are forwarded on this interface.
Definition net_if.h:257
@ NET_IF_IPV4
Interface supports IPv4.
Definition net_if.h:260
@ NET_IF_PROMISC
Interface is in promiscuous mode.
Definition net_if.h:240
@ NET_IF_DORMANT
Driver signals dormant.
Definition net_if.h:272
@ NET_IF_SUSPENDED
Power management specific: interface is being suspended.
Definition net_if.h:251
@ NET_IF_IPV6
Interface supports IPv6.
Definition net_if.h:263
@ NET_IF_UP
Interface is admin up.
Definition net_if.h:234
@ NET_IF_LOWER_UP
Driver signals L1 is up.
Definition net_if.h:269
@ NET_IF_RUNNING
Interface up and running (ready to receive and transmit).
Definition net_if.h:266
@ NET_IF_NO_TX_LOCK
Mutex locking on TX data path disabled on the interface.
Definition net_if.h:281
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 IF_ENABLED(_flag, _code)
Insert code if _flag is defined and equals 1.
Definition util_macro.h:239
#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:411
IPv6 address struct.
Definition net_ip.h:143
IPv4 address struct.
Definition net_ip.h:155
Definition kernel.h:2474
Mutex Structure.
Definition kernel.h:3004
Thread Structure.
Definition thread.h:259
Kernel timepoint type.
Definition sys_clock.h:225
DHCPv6 client configuration parameters.
Definition dhcpv6.h:63
Network Interface unicast IPv4 address and netmask.
Definition net_if.h:451
struct net_if_addr ipv4
IPv4 address.
Definition net_if.h:453
struct in_addr netmask
Netmask.
Definition net_if.h:455
Network Interface unicast IP addresses.
Definition net_if.h:56
struct net_addr address
IP address.
Definition net_if.h:58
uint8_t is_mesh_local
Is this IP address usage limited to the subnet (mesh) or not.
Definition net_if.h:132
uint8_t is_temporary
Is this IP address temporary and generated for example by IPv6 privacy extension (RFC 8981)
Definition net_if.h:137
enum net_addr_state addr_state
What is the current state of the address.
Definition net_if.h:73
uint8_t is_infinite
Is the IP address valid forever.
Definition net_if.h:126
atomic_t atomic_ref
Reference counter.
Definition net_if.h:63
enum net_addr_type addr_type
How the IP address was set.
Definition net_if.h:70
uint8_t is_used
Is this IP address used or not.
Definition net_if.h:129
IP and other configuration related data for network interface.
Definition net_if.h:569
Network Interface Device structure.
Definition net_if.h:646
enum net_if_oper_state oper_state
RFC 2863 operational status.
Definition net_if.h:682
const struct net_l2 *const l2
Interface's L2 layer.
Definition net_if.h:651
void * l2_data
Interface's private L2 data pointer.
Definition net_if.h:654
uint16_t mtu
The hardware MTU.
Definition net_if.h:672
const struct device * dev
The actually device driver instance the net_if is related to.
Definition net_if.h:648
struct net_linkaddr link_addr
The hardware link address.
Definition net_if.h:660
atomic_t flags[ATOMIC_BITMAP_SIZE(NET_IF_NUM_FLAGS)]
For internal use.
Definition net_if.h:657
Network interface IP address configuration.
Definition net_if.h:556
IPv4 configuration.
Definition net_if.h:459
uint8_t mcast_ttl
IPv4 time-to-live for multicast packets.
Definition net_if.h:473
struct net_if_addr_ipv4 unicast[NET_IF_MAX_IPV4_ADDR]
Unicast IP addresses.
Definition net_if.h:461
struct in_addr gw
Gateway.
Definition net_if.h:467
uint8_t ttl
IPv4 time-to-live.
Definition net_if.h:470
struct net_if_mcast_addr mcast[NET_IF_MAX_IPV4_MADDR]
Multicast IP addresses.
Definition net_if.h:464
Network Interface IPv6 prefixes.
Definition net_if.h:176
struct net_if * iface
Backpointer to network interface where this prefix is used.
Definition net_if.h:184
uint8_t is_infinite
Is the IP prefix valid forever.
Definition net_if.h:190
uint8_t len
Prefix length.
Definition net_if.h:187
struct in6_addr prefix
IPv6 prefix.
Definition net_if.h:181
uint8_t is_used
Is this prefix used or not.
Definition net_if.h:193
struct net_timeout lifetime
Prefix lifetime.
Definition net_if.h:178
IPv6 configuration.
Definition net_if.h:317
struct net_if_ipv6_prefix prefix[NET_IF_MAX_IPV6_PREFIX]
Prefixes.
Definition net_if.h:325
uint32_t base_reachable_time
Default reachable time (RFC 4861, page 52)
Definition net_if.h:328
uint8_t hop_limit
IPv6 hop limit.
Definition net_if.h:366
struct net_if_mcast_addr mcast[NET_IF_MAX_IPV6_MADDR]
Multicast IP addresses.
Definition net_if.h:322
uint32_t retrans_timer
Retransmit timer (RFC 4861, page 52)
Definition net_if.h:334
struct net_if_addr unicast[NET_IF_MAX_IPV6_ADDR]
Unicast IP addresses.
Definition net_if.h:319
uint8_t mcast_hop_limit
IPv6 multicast hop limit.
Definition net_if.h:369
uint32_t reachable_time
Reachable time (RFC 4861, page 20)
Definition net_if.h:331
Network Interface multicast IP addresses.
Definition net_if.h:147
struct net_addr address
IP address.
Definition net_if.h:149
uint8_t is_joined
Did we join to this group.
Definition net_if.h:166
uint8_t is_used
Is this multicast IP address used or not.
Definition net_if.h:163
Multicast monitor handler struct.
Definition net_if.h:1608
sys_snode_t node
Node information for the slist.
Definition net_if.h:1610
net_if_mcast_callback_t cb
Multicast callback.
Definition net_if.h:1616
struct net_if * iface
Network interface.
Definition net_if.h:1613
Information about routers in the system.
Definition net_if.h:203
struct net_if * iface
Network interface the router is connected to.
Definition net_if.h:211
uint8_t is_default
Is default router.
Definition net_if.h:223
uint16_t lifetime
Router lifetime.
Definition net_if.h:217
uint8_t is_infinite
Is the router valid forever.
Definition net_if.h:226
uint8_t is_used
Is this router used or not.
Definition net_if.h:220
struct net_addr address
IP address.
Definition net_if.h:208
sys_snode_t node
Slist lifetime timer node.
Definition net_if.h:205
uint32_t life_start
Router life timer start.
Definition net_if.h:214
Network Interface structure.
Definition net_if.h:692
struct net_if_dev * if_dev
The net_if_dev instance the net_if is related to.
Definition net_if.h:694
struct net_if_config config
Network interface instance configuration.
Definition net_if.h:706
uint8_t pe_enabled
Network interface specific flags.
Definition net_if.h:726
struct k_mutex lock
Mutex protecting this network interface instance.
Definition net_if.h:717
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:731
struct k_mutex tx_lock
Mutex used when sending data.
Definition net_if.h:720
Network L2 structure.
Definition net_l2.h:58
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:374
Generic struct for handling network timeouts.
Definition net_timeout.h:57
Network traffic class.
Definition net_if.h:613
k_thread_stack_t * stack
Stack for this handler.
Definition net_if.h:621
struct k_thread handler
Traffic class handler thread.
Definition net_if.h:618
struct k_fifo fifo
Fifo for handling this Tx or Rx packet.
Definition net_if.h:615
Prometheus collector definition.
Definition collector.h:50
Type used to represent a Prometheus metric base.
Definition metric.h:47
Generic sockaddr struct.
Definition net_ip.h:408