Zephyr Project API 4.1.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
101 sys_snode_t dad_need_node;
102
104 uint32_t dad_start;
105
107 uint8_t dad_count;
108 };
109#endif /* CONFIG_NET_IPV6_DAD */
110#if defined(CONFIG_NET_IPV4_ACD)
111 struct {
113 sys_snode_t acd_node;
114
116 sys_snode_t acd_need_node;
117
119 k_timepoint_t acd_timeout;
120
122 uint8_t acd_count;
123
125 uint8_t acd_state;
126 };
127#endif /* CONFIG_NET_IPV4_ACD */
128 uint8_t _dummy;
129 };
130
131#if defined(CONFIG_NET_IPV6_DAD) || defined(CONFIG_NET_IPV4_ACD)
133 uint8_t ifindex;
134#endif
135
138
141
144
149
152
153 uint8_t _unused : 3;
154};
155
163 struct net_addr address;
164
167
168#if defined(CONFIG_NET_IPV4_IGMPV3)
170 struct net_addr sources[CONFIG_NET_IF_MCAST_IPV4_SOURCE_COUNT];
171
173 uint16_t sources_len;
174
176 uint8_t record_type;
177#endif
178
181
184
185 uint8_t _unused : 6;
186};
187
196
199
201 struct net_if *iface;
202
205
208
211
212 uint8_t _unused : 6;
213};
214
223
225 struct net_addr address;
226
228 struct net_if *iface;
229
232
235
238
241
244
245 uint8_t _unused : 5;
246};
247
305
316
317#if defined(CONFIG_NET_OFFLOAD)
318struct net_offload;
319#endif /* CONFIG_NET_OFFLOAD */
320
322#if defined(CONFIG_NET_IPV6)
323#define NET_IF_MAX_IPV6_ADDR CONFIG_NET_IF_UNICAST_IPV6_ADDR_COUNT
324#define NET_IF_MAX_IPV6_MADDR CONFIG_NET_IF_MCAST_IPV6_ADDR_COUNT
325#define NET_IF_MAX_IPV6_PREFIX CONFIG_NET_IF_IPV6_PREFIX_COUNT
326#else
327#define NET_IF_MAX_IPV6_ADDR 0
328#define NET_IF_MAX_IPV6_MADDR 0
329#define NET_IF_MAX_IPV6_PREFIX 0
330#endif
331/* @endcond */
332
336 struct net_if_addr unicast[NET_IF_MAX_IPV6_ADDR];
337
339 struct net_if_mcast_addr mcast[NET_IF_MAX_IPV6_MADDR];
340
342 struct net_if_ipv6_prefix prefix[NET_IF_MAX_IPV6_PREFIX];
343
346
349
352
353#if defined(CONFIG_NET_IPV6_IID_STABLE)
355 struct net_if_addr *iid;
356
360 uint32_t network_counter;
361#endif /* CONFIG_NET_IPV6_IID_STABLE */
362
363#if defined(CONFIG_NET_IPV6_PE)
368 uint32_t desync_factor;
369#endif /* CONFIG_NET_IPV6_PE */
370
371#if defined(CONFIG_NET_IPV6_ND) && defined(CONFIG_NET_NATIVE_IPV6)
373 sys_snode_t rs_node;
374
375 /* RS start time */
376 uint32_t rs_start;
377
379 uint8_t rs_count;
380#endif
381
384
387};
388
389#if defined(CONFIG_NET_DHCPV6) && defined(CONFIG_NET_NATIVE_IPV6)
391struct net_if_dhcpv6 {
393 sys_snode_t node;
394
396 struct net_dhcpv6_duid_storage clientid;
397
399 struct net_dhcpv6_duid_storage serverid;
400
402 enum net_dhcpv6_state state;
403
405 struct net_dhcpv6_params params;
406
408 uint64_t timeout;
409
411 uint64_t exchange_start;
412
414 uint64_t t1;
415
417 uint64_t t2;
418
422 uint64_t expire;
423
425 uint32_t addr_iaid;
426
428 uint32_t prefix_iaid;
429
431 uint32_t retransmit_timeout;
432
434 int16_t server_preference;
435
437 uint8_t retransmissions;
438
440 uint8_t tid[DHCPV6_TID_SIZE];
441
443 uint8_t prefix_len;
444
446 struct in6_addr prefix;
447
449 struct in6_addr addr;
450};
451#endif /* defined(CONFIG_NET_DHCPV6) && defined(CONFIG_NET_NATIVE_IPV6) */
452
454#if defined(CONFIG_NET_IPV4)
455#define NET_IF_MAX_IPV4_ADDR CONFIG_NET_IF_UNICAST_IPV4_ADDR_COUNT
456#define NET_IF_MAX_IPV4_MADDR CONFIG_NET_IF_MCAST_IPV4_ADDR_COUNT
457#else
458#define NET_IF_MAX_IPV4_ADDR 0
459#define NET_IF_MAX_IPV4_MADDR 0
460#endif
474
478 struct net_if_addr_ipv4 unicast[NET_IF_MAX_IPV4_ADDR];
479
481 struct net_if_mcast_addr mcast[NET_IF_MAX_IPV4_MADDR];
482
484 struct in_addr gw;
485
488
491
492#if defined(CONFIG_NET_IPV4_ACD)
494 uint8_t conflict_cnt;
495#endif
496};
497
498#if defined(CONFIG_NET_DHCPV4) && defined(CONFIG_NET_NATIVE_IPV4)
499struct net_if_dhcpv4 {
501 sys_snode_t node;
502
504 int64_t timer_start;
505
507 uint32_t request_time;
508
509 uint32_t xid;
510
512 uint32_t lease_time;
513
515 uint32_t renewal_time;
516
518 uint32_t rebinding_time;
519
521 struct in_addr server_id;
522
524 struct in_addr requested_ip;
525
527 struct in_addr netmask;
528
533 enum net_dhcpv4_state state;
534
536 uint8_t attempts;
537
539 struct in_addr request_server_addr;
540
542 struct in_addr response_src_addr;
543
544#ifdef CONFIG_NET_DHCPV4_OPTION_NTP_SERVER
546 struct in_addr ntp_addr;
547#endif
548};
549#endif /* CONFIG_NET_DHCPV4 */
550
551#if defined(CONFIG_NET_IPV4_AUTO) && defined(CONFIG_NET_NATIVE_IPV4)
552struct net_if_ipv4_autoconf {
554 struct net_if *iface;
555
557 struct in_addr requested_ip;
558
562};
563#endif /* CONFIG_NET_IPV4_AUTO */
564
566/* We always need to have at least one IP config */
567#define NET_IF_MAX_CONFIGS 1
573struct net_if_ip {
574#if defined(CONFIG_NET_IPV6)
575 struct net_if_ipv6 *ipv6;
576#endif /* CONFIG_NET_IPV6 */
577
578#if defined(CONFIG_NET_IPV4)
579 struct net_if_ipv4 *ipv4;
580#endif /* CONFIG_NET_IPV4 */
581};
582
587#if defined(CONFIG_NET_IP)
589 struct net_if_ip ip;
590#endif
591
592#if defined(CONFIG_NET_DHCPV4) && defined(CONFIG_NET_NATIVE_IPV4)
593 struct net_if_dhcpv4 dhcpv4;
594#endif /* CONFIG_NET_DHCPV4 */
595
596#if defined(CONFIG_NET_DHCPV6) && defined(CONFIG_NET_NATIVE_IPV6)
597 struct net_if_dhcpv6 dhcpv6;
598#endif /* CONFIG_NET_DHCPV6 */
599
600#if defined(CONFIG_NET_IPV4_AUTO) && defined(CONFIG_NET_NATIVE_IPV4)
601 struct net_if_ipv4_autoconf ipv4auto;
602#endif /* CONFIG_NET_IPV4_AUTO */
603
604#if defined(CONFIG_NET_L2_VIRTUAL)
609 sys_slist_t virtual_interfaces;
610#endif /* CONFIG_NET_L2_VIRTUAL */
611
612#if defined(CONFIG_NET_INTERFACE_NAME)
617 char name[CONFIG_NET_INTERFACE_NAME_LEN + 1];
618#endif
619};
620
632 struct k_fifo fifo;
633
634#if NET_TC_COUNT > 1 || defined(CONFIG_NET_TC_TX_SKIP_FOR_HIGH_PRIO) \
635 || defined(CONFIG_NET_TC_RX_SKIP_FOR_HIGH_PRIO)
637 struct k_sem fifo_slot;
638#endif
639
642
645};
646
653typedef int (*net_socket_create_t)(int, int, int);
654
671 const struct device *dev;
672
674 const struct net_l2 * const l2;
675
677 void *l2_data;
678
680 ATOMIC_DEFINE(flags, NET_IF_NUM_FLAGS);
681
684
685#if defined(CONFIG_NET_OFFLOAD)
691 struct net_offload *offload;
692#endif /* CONFIG_NET_OFFLOAD */
693
696
697#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
701 net_socket_create_t socket_offload;
702#endif /* CONFIG_NET_SOCKETS_OFFLOAD */
703
706};
707
715struct net_if {
718
719#if defined(CONFIG_NET_STATISTICS_PER_INTERFACE)
721 struct net_stats stats;
722
724 IF_ENABLED(CONFIG_NET_STATISTICS_VIA_PROMETHEUS,
725 (struct prometheus_collector *collector);)
726#endif /* CONFIG_NET_STATISTICS_PER_INTERFACE */
727
730
731#if defined(CONFIG_NET_POWER_MANAGEMENT)
736 int tx_pending;
737#endif
738
740 struct k_mutex lock;
741
744
750
755
757 uint8_t _unused : 6;
758};
759
762static inline void net_if_lock(struct net_if *iface)
763{
764 NET_ASSERT(iface);
765
766 (void)k_mutex_lock(&iface->lock, K_FOREVER);
767}
768
769static inline void net_if_unlock(struct net_if *iface)
770{
771 NET_ASSERT(iface);
772
773 k_mutex_unlock(&iface->lock);
774}
775
776static inline bool net_if_flag_is_set(struct net_if *iface,
777 enum net_if_flag value);
778
779static inline void net_if_tx_lock(struct net_if *iface)
780{
781 NET_ASSERT(iface);
782
784 return;
785 }
786
787 (void)k_mutex_lock(&iface->tx_lock, K_FOREVER);
788}
789
790static inline void net_if_tx_unlock(struct net_if *iface)
791{
792 NET_ASSERT(iface);
793
795 return;
796 }
797
798 k_mutex_unlock(&iface->tx_lock);
799}
800
809static inline void net_if_flag_set(struct net_if *iface,
810 enum net_if_flag value)
811{
812 if (iface == NULL || iface->if_dev == NULL) {
813 return;
814 }
815
816 atomic_set_bit(iface->if_dev->flags, value);
817}
818
827static inline bool net_if_flag_test_and_set(struct net_if *iface,
828 enum net_if_flag value)
829{
830 if (iface == NULL || iface->if_dev == NULL) {
831 return false;
832 }
833
834 return atomic_test_and_set_bit(iface->if_dev->flags, value);
835}
836
843static inline void net_if_flag_clear(struct net_if *iface,
844 enum net_if_flag value)
845{
846 if (iface == NULL || iface->if_dev == NULL) {
847 return;
848 }
849
850 atomic_clear_bit(iface->if_dev->flags, value);
851}
852
861static inline bool net_if_flag_test_and_clear(struct net_if *iface,
862 enum net_if_flag value)
863{
864 if (iface == NULL || iface->if_dev == NULL) {
865 return false;
866 }
867
868 return atomic_test_and_clear_bit(iface->if_dev->flags, value);
869}
870
879static inline bool net_if_flag_is_set(struct net_if *iface,
880 enum net_if_flag value)
881{
882 if (iface == NULL || iface->if_dev == NULL) {
883 return false;
884 }
885
886 return atomic_test_bit(iface->if_dev->flags, value);
887}
888
898 struct net_if *iface, enum net_if_oper_state oper_state)
899{
900 if (iface == NULL || iface->if_dev == NULL) {
901 return NET_IF_OPER_UNKNOWN;
902 }
903
904 BUILD_ASSERT((enum net_if_oper_state)(-1) > 0 && NET_IF_OPER_UNKNOWN == 0);
905 if (oper_state <= NET_IF_OPER_UP) {
906 iface->if_dev->oper_state = oper_state;
907 }
908
909 return iface->if_dev->oper_state;
910}
911
919static inline enum net_if_oper_state net_if_oper_state(struct net_if *iface)
920{
921 if (iface == NULL || iface->if_dev == NULL) {
922 return NET_IF_OPER_UNKNOWN;
923 }
924
925 return iface->if_dev->oper_state;
926}
927
938 struct net_pkt *pkt, k_timeout_t timeout);
939
949static inline enum net_verdict net_if_send_data(struct net_if *iface,
950 struct net_pkt *pkt)
951{
953
954 return net_if_try_send_data(iface, pkt, timeout);
955}
956
964static inline const struct net_l2 *net_if_l2(struct net_if *iface)
965{
966 if (iface == NULL || iface->if_dev == NULL) {
967 return NULL;
968 }
969
970 return iface->if_dev->l2;
971}
972
981enum net_verdict net_if_recv_data(struct net_if *iface, struct net_pkt *pkt);
982
990static inline void *net_if_l2_data(struct net_if *iface)
991{
992 if (iface == NULL || iface->if_dev == NULL) {
993 return NULL;
994 }
995
996 return iface->if_dev->l2_data;
997}
998
1006static inline const struct device *net_if_get_device(struct net_if *iface)
1007{
1008 if (iface == NULL || iface->if_dev == NULL) {
1009 return NULL;
1010 }
1011
1012 return iface->if_dev->dev;
1013}
1014
1022void net_if_try_queue_tx(struct net_if *iface, struct net_pkt *pkt, k_timeout_t timeout);
1023
1031static inline void net_if_queue_tx(struct net_if *iface, struct net_pkt *pkt)
1032{
1034
1035 net_if_try_queue_tx(iface, pkt, timeout);
1036}
1037
1045static inline bool net_if_is_ip_offloaded(struct net_if *iface)
1046{
1047#if defined(CONFIG_NET_OFFLOAD)
1048 return (iface != NULL && iface->if_dev != NULL &&
1049 iface->if_dev->offload != NULL);
1050#else
1051 ARG_UNUSED(iface);
1052
1053 return false;
1054#endif
1055}
1056
1064bool net_if_is_offloaded(struct net_if *iface);
1065
1073static inline struct net_offload *net_if_offload(struct net_if *iface)
1074{
1075#if defined(CONFIG_NET_OFFLOAD)
1076 if (iface == NULL || iface->if_dev == NULL) {
1077 return NULL;
1078 }
1079
1080 return iface->if_dev->offload;
1081#else
1082 ARG_UNUSED(iface);
1083
1084 return NULL;
1085#endif
1086}
1087
1095static inline bool net_if_is_socket_offloaded(struct net_if *iface)
1096{
1097#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
1098 if (iface == NULL || iface->if_dev == NULL) {
1099 return false;
1100 }
1101
1102 return (iface->if_dev->socket_offload != NULL);
1103#else
1104 ARG_UNUSED(iface);
1105
1106 return false;
1107#endif
1108}
1109
1116static inline void net_if_socket_offload_set(
1117 struct net_if *iface, net_socket_create_t socket_offload)
1118{
1119#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
1120 if (iface == NULL || iface->if_dev == NULL) {
1121 return;
1122 }
1123
1124 iface->if_dev->socket_offload = socket_offload;
1125#else
1126 ARG_UNUSED(iface);
1127 ARG_UNUSED(socket_offload);
1128#endif
1129}
1130
1139{
1140#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
1141 if (iface == NULL || iface->if_dev == NULL) {
1142 return NULL;
1143 }
1144
1145 return iface->if_dev->socket_offload;
1146#else
1147 ARG_UNUSED(iface);
1148
1149 return NULL;
1150#endif
1151}
1152
1160static inline struct net_linkaddr *net_if_get_link_addr(struct net_if *iface)
1161{
1162 if (iface == NULL || iface->if_dev == NULL) {
1163 return NULL;
1164 }
1165
1166 return &iface->if_dev->link_addr;
1167}
1168
1176static inline struct net_if_config *net_if_get_config(struct net_if *iface)
1177{
1178 if (iface == NULL) {
1179 return NULL;
1180 }
1181
1182 return &iface->config;
1183}
1184
1190#if defined(CONFIG_NET_IPV6_DAD) && defined(CONFIG_NET_NATIVE_IPV6)
1191void net_if_start_dad(struct net_if *iface);
1192#else
1193static inline void net_if_start_dad(struct net_if *iface)
1194{
1195 ARG_UNUSED(iface);
1196}
1197#endif
1198
1204void net_if_start_rs(struct net_if *iface);
1205
1206
1212#if defined(CONFIG_NET_IPV6_ND) && defined(CONFIG_NET_NATIVE_IPV6)
1213void net_if_stop_rs(struct net_if *iface);
1214#else
1215static inline void net_if_stop_rs(struct net_if *iface)
1216{
1217 ARG_UNUSED(iface);
1218}
1219#endif /* CONFIG_NET_IPV6_ND */
1220
1233#if defined(CONFIG_NET_IPV6_ND) && defined(CONFIG_NET_NATIVE_IPV6)
1234void net_if_nbr_reachability_hint(struct net_if *iface, const struct in6_addr *ipv6_addr);
1235#else
1236static inline void net_if_nbr_reachability_hint(struct net_if *iface,
1237 const struct in6_addr *ipv6_addr)
1238{
1239 ARG_UNUSED(iface);
1240 ARG_UNUSED(ipv6_addr);
1241}
1242#endif
1243
1246static inline int net_if_set_link_addr_unlocked(struct net_if *iface,
1247 uint8_t *addr, uint8_t len,
1248 enum net_link_type type)
1249{
1250 int ret;
1251
1252 if (net_if_flag_is_set(iface, NET_IF_RUNNING)) {
1253 return -EPERM;
1254 }
1255
1256 if (len > sizeof(net_if_get_link_addr(iface)->addr)) {
1257 return -EINVAL;
1258 }
1259
1260 ret = net_linkaddr_create(net_if_get_link_addr(iface), addr, len, type);
1261 if (ret < 0) {
1262 return ret;
1263 }
1264
1265 net_hostname_set_postfix(addr, len);
1266
1267 return 0;
1268}
1269
1270int net_if_set_link_addr_locked(struct net_if *iface,
1271 uint8_t *addr, uint8_t len,
1272 enum net_link_type type);
1273
1274#if CONFIG_NET_IF_LOG_LEVEL >= LOG_LEVEL_DBG
1275extern int net_if_addr_unref_debug(struct net_if *iface,
1276 sa_family_t family,
1277 const void *addr,
1278 struct net_if_addr **ifaddr,
1279 const char *caller, int line);
1280#define net_if_addr_unref(iface, family, addr, ifaddr) \
1281 net_if_addr_unref_debug(iface, family, addr, ifaddr, __func__, __LINE__)
1282
1283extern struct net_if_addr *net_if_addr_ref_debug(struct net_if *iface,
1284 sa_family_t family,
1285 const void *addr,
1286 const char *caller,
1287 int line);
1288#define net_if_addr_ref(iface, family, addr) \
1289 net_if_addr_ref_debug(iface, family, addr, __func__, __LINE__)
1290#else
1291extern int net_if_addr_unref(struct net_if *iface,
1292 sa_family_t family,
1293 const void *addr,
1294 struct net_if_addr **ifaddr);
1295extern struct net_if_addr *net_if_addr_ref(struct net_if *iface,
1296 sa_family_t family,
1297 const void *addr);
1298#endif /* CONFIG_NET_IF_LOG_LEVEL */
1299
1313static inline int net_if_set_link_addr(struct net_if *iface,
1314 uint8_t *addr, uint8_t len,
1315 enum net_link_type type)
1316{
1317#if defined(CONFIG_NET_RAW_MODE)
1318 return net_if_set_link_addr_unlocked(iface, addr, len, type);
1319#else
1320 return net_if_set_link_addr_locked(iface, addr, len, type);
1321#endif
1322}
1323
1331static inline uint16_t net_if_get_mtu(struct net_if *iface)
1332{
1333 if (iface == NULL || iface->if_dev == NULL) {
1334 return 0U;
1335 }
1336
1337 return iface->if_dev->mtu;
1338}
1339
1346static inline void net_if_set_mtu(struct net_if *iface,
1347 uint16_t mtu)
1348{
1349 if (iface == NULL || iface->if_dev == NULL) {
1350 return;
1351 }
1352
1353 iface->if_dev->mtu = mtu;
1354}
1355
1362static inline void net_if_addr_set_lf(struct net_if_addr *ifaddr,
1363 bool is_infinite)
1364{
1365 if (ifaddr == NULL) {
1366 return;
1367 }
1368
1369 ifaddr->is_infinite = is_infinite;
1370}
1371
1380
1388struct net_if *net_if_lookup_by_dev(const struct device *dev);
1389
1397static inline struct net_if_config *net_if_config_get(struct net_if *iface)
1398{
1399 if (iface == NULL) {
1400 return NULL;
1401 }
1402
1403 return &iface->config;
1404}
1405
1411void net_if_router_rm(struct net_if_router *router);
1412
1418void net_if_set_default(struct net_if *iface);
1419
1426
1435struct net_if *net_if_get_first_by_type(const struct net_l2 *l2);
1436
1444
1445#if defined(CONFIG_NET_L2_IEEE802154)
1452static inline struct net_if *net_if_get_ieee802154(void)
1453{
1454 return net_if_get_first_by_type(&NET_L2_GET_NAME(IEEE802154));
1455}
1456#endif /* CONFIG_NET_L2_IEEE802154 */
1457
1469 struct net_if_ipv6 **ipv6);
1470
1479
1489 struct net_if **iface);
1490
1500 struct in6_addr *addr);
1501
1510__syscall int net_if_ipv6_addr_lookup_by_index(const struct in6_addr *addr);
1511
1523 struct in6_addr *addr,
1525 uint32_t vlifetime);
1526
1537__syscall bool net_if_ipv6_addr_add_by_index(int index,
1538 struct in6_addr *addr,
1540 uint32_t vlifetime);
1541
1549 uint32_t vlifetime);
1550
1559bool net_if_ipv6_addr_rm(struct net_if *iface, const struct in6_addr *addr);
1560
1569__syscall bool net_if_ipv6_addr_rm_by_index(int index,
1570 const struct in6_addr *addr);
1571
1580typedef void (*net_if_ip_addr_cb_t)(struct net_if *iface,
1581 struct net_if_addr *addr,
1582 void *user_data);
1583
1593 void *user_data);
1594
1604 const struct in6_addr *addr);
1605
1614bool net_if_ipv6_maddr_rm(struct net_if *iface, const struct in6_addr *addr);
1615
1624typedef void (*net_if_ip_maddr_cb_t)(struct net_if *iface,
1625 struct net_if_mcast_addr *maddr,
1626 void *user_data);
1627
1637 void *user_data);
1638
1650 struct net_if **iface);
1651
1662typedef void (*net_if_mcast_callback_t)(struct net_if *iface,
1663 const struct net_addr *addr,
1664 bool is_joined);
1665
1684
1694 struct net_if *iface,
1696
1703
1711void net_if_mcast_monitor(struct net_if *iface, const struct net_addr *addr,
1712 bool is_joined);
1713
1721 struct net_if_mcast_addr *addr);
1722
1730static inline bool net_if_ipv6_maddr_is_joined(struct net_if_mcast_addr *addr)
1731{
1732 if (addr == NULL) {
1733 return false;
1734 }
1735
1736 return addr->is_joined;
1737}
1738
1746 struct net_if_mcast_addr *addr);
1747
1757 const struct in6_addr *addr);
1758
1769 struct in6_addr *addr,
1770 uint8_t len);
1771
1783 struct in6_addr *prefix,
1784 uint8_t len,
1786
1796bool net_if_ipv6_prefix_rm(struct net_if *iface, struct in6_addr *addr,
1797 uint8_t len);
1798
1806 bool is_infinite)
1807{
1808 prefix->is_infinite = is_infinite;
1809}
1810
1819
1826
1837bool net_if_ipv6_addr_onlink(struct net_if **iface, struct in6_addr *addr);
1838
1845#if defined(CONFIG_NET_NATIVE_IPV6)
1846static inline struct in6_addr *net_if_router_ipv6(struct net_if_router *router)
1847{
1848 if (router == NULL) {
1849 return NULL;
1850 }
1851
1852 return &router->address.in6_addr;
1853}
1854#else
1855static inline struct in6_addr *net_if_router_ipv6(struct net_if_router *router)
1856{
1857 static struct in6_addr addr;
1858
1859 ARG_UNUSED(router);
1860
1861 return &addr;
1862}
1863#endif
1864
1875 struct in6_addr *addr);
1876
1887 struct in6_addr *addr);
1888
1897
1908 struct in6_addr *addr,
1909 uint16_t router_lifetime);
1910
1919
1928#if defined(CONFIG_NET_NATIVE_IPV6)
1930#else
1932{
1933 ARG_UNUSED(iface);
1934
1935 return 0;
1936}
1937#endif /* CONFIG_NET_NATIVE_IPV6 */
1938
1945#if defined(CONFIG_NET_NATIVE_IPV6)
1946void net_if_ipv6_set_hop_limit(struct net_if *iface, uint8_t hop_limit);
1947#else
1948static inline void net_if_ipv6_set_hop_limit(struct net_if *iface,
1949 uint8_t hop_limit)
1950{
1951 ARG_UNUSED(iface);
1952 ARG_UNUSED(hop_limit);
1953}
1954#endif /* CONFIG_NET_NATIVE_IPV6 */
1955
1958/* The old hop limit setter function is deprecated because the naming
1959 * of it was incorrect. The API name was missing "_if_" so this function
1960 * should not be used.
1961 */
1962__deprecated
1963static inline void net_ipv6_set_hop_limit(struct net_if *iface,
1964 uint8_t hop_limit)
1965{
1966 net_if_ipv6_set_hop_limit(iface, hop_limit);
1967}
1968
1979#if defined(CONFIG_NET_NATIVE_IPV6)
1981#else
1983{
1984 ARG_UNUSED(iface);
1985
1986 return 0;
1987}
1988#endif /* CONFIG_NET_NATIVE_IPV6 */
1989
1996#if defined(CONFIG_NET_NATIVE_IPV6)
1997void net_if_ipv6_set_mcast_hop_limit(struct net_if *iface, uint8_t hop_limit);
1998#else
2000 uint8_t hop_limit)
2001{
2002 ARG_UNUSED(iface);
2003 ARG_UNUSED(hop_limit);
2004}
2005#endif /* CONFIG_NET_NATIVE_IPV6 */
2006
2014 uint32_t reachable_time)
2015{
2016#if defined(CONFIG_NET_NATIVE_IPV6)
2017 if (iface == NULL) {
2018 return;
2019 }
2020
2021 if (!iface->config.ip.ipv6) {
2022 return;
2023 }
2024
2025 iface->config.ip.ipv6->base_reachable_time = reachable_time;
2026#else
2027 ARG_UNUSED(iface);
2028 ARG_UNUSED(reachable_time);
2029
2030#endif
2031}
2032
2041{
2042#if defined(CONFIG_NET_NATIVE_IPV6)
2043 if (iface == NULL) {
2044 return 0;
2045 }
2046
2047 if (!iface->config.ip.ipv6) {
2048 return 0;
2049 }
2050
2051 return iface->config.ip.ipv6->reachable_time;
2052#else
2053 ARG_UNUSED(iface);
2054 return 0;
2055#endif
2056}
2057
2066
2073static inline void net_if_ipv6_set_reachable_time(struct net_if_ipv6 *ipv6)
2074{
2075#if defined(CONFIG_NET_NATIVE_IPV6)
2076 if (ipv6 == NULL) {
2077 return;
2078 }
2079
2081#else
2082 ARG_UNUSED(ipv6);
2083#endif
2084}
2085
2092static inline void net_if_ipv6_set_retrans_timer(struct net_if *iface,
2093 uint32_t retrans_timer)
2094{
2095#if defined(CONFIG_NET_NATIVE_IPV6)
2096 if (iface == NULL) {
2097 return;
2098 }
2099
2100 if (!iface->config.ip.ipv6) {
2101 return;
2102 }
2103
2104 iface->config.ip.ipv6->retrans_timer = retrans_timer;
2105#else
2106 ARG_UNUSED(iface);
2107 ARG_UNUSED(retrans_timer);
2108#endif
2109}
2110
2119{
2120#if defined(CONFIG_NET_NATIVE_IPV6)
2121 if (iface == NULL) {
2122 return 0;
2123 }
2124
2125 if (!iface->config.ip.ipv6) {
2126 return 0;
2127 }
2128
2129 return iface->config.ip.ipv6->retrans_timer;
2130#else
2131 ARG_UNUSED(iface);
2132 return 0;
2133#endif
2134}
2135
2147#if defined(CONFIG_NET_IPV6)
2148const struct in6_addr *net_if_ipv6_select_src_addr(struct net_if *iface,
2149 const struct in6_addr *dst);
2150#else
2151static inline const struct in6_addr *net_if_ipv6_select_src_addr(
2152 struct net_if *iface, const struct in6_addr *dst)
2153{
2154 ARG_UNUSED(iface);
2155 ARG_UNUSED(dst);
2156
2157 return NULL;
2158}
2159#endif
2160
2174#if defined(CONFIG_NET_IPV6)
2175const struct in6_addr *net_if_ipv6_select_src_addr_hint(struct net_if *iface,
2176 const struct in6_addr *dst,
2177 int flags);
2178#else
2179static inline const struct in6_addr *net_if_ipv6_select_src_addr_hint(
2180 struct net_if *iface, const struct in6_addr *dst, int flags)
2181{
2182 ARG_UNUSED(iface);
2183 ARG_UNUSED(dst);
2184 ARG_UNUSED(flags);
2185
2186 return NULL;
2187}
2188#endif
2189
2199#if defined(CONFIG_NET_IPV6)
2200struct net_if *net_if_ipv6_select_src_iface(const struct in6_addr *dst);
2201#else
2203 const struct in6_addr *dst)
2204{
2205 ARG_UNUSED(dst);
2206
2207 return NULL;
2208}
2209#endif
2210
2223#if defined(CONFIG_NET_IPV6)
2224struct net_if *net_if_ipv6_select_src_iface_addr(const struct in6_addr *dst,
2225 const struct in6_addr **src_addr);
2226#else
2228 const struct in6_addr *dst, const struct in6_addr **src_addr)
2229{
2230 ARG_UNUSED(dst);
2231 ARG_UNUSED(src_addr);
2232
2233 return NULL;
2234}
2235#endif /* CONFIG_NET_IPV6 */
2236
2246struct in6_addr *net_if_ipv6_get_ll(struct net_if *iface,
2247 enum net_addr_state addr_state);
2248
2259 struct net_if **iface);
2260
2268void net_if_ipv6_dad_failed(struct net_if *iface, const struct in6_addr *addr);
2269
2282 struct net_if **iface);
2283
2295 struct net_if_ipv4 **ipv4);
2296
2305
2314
2321void net_if_ipv4_set_ttl(struct net_if *iface, uint8_t ttl);
2322
2331
2339
2349 struct net_if **iface);
2350
2362 struct in_addr *addr,
2364 uint32_t vlifetime);
2365
2374bool net_if_ipv4_addr_rm(struct net_if *iface, const struct in_addr *addr);
2375
2384__syscall int net_if_ipv4_addr_lookup_by_index(const struct in_addr *addr);
2385
2396__syscall bool net_if_ipv4_addr_add_by_index(int index,
2397 struct in_addr *addr,
2399 uint32_t vlifetime);
2400
2409__syscall bool net_if_ipv4_addr_rm_by_index(int index,
2410 const struct in_addr *addr);
2411
2421 void *user_data);
2422
2432 const struct in_addr *addr);
2433
2442bool net_if_ipv4_maddr_rm(struct net_if *iface, const struct in_addr *addr);
2443
2453 void *user_data);
2454
2466 struct net_if **iface);
2467
2475 struct net_if_mcast_addr *addr);
2476
2484static inline bool net_if_ipv4_maddr_is_joined(struct net_if_mcast_addr *addr)
2485{
2486 if (addr == NULL) {
2487 return false;
2488 }
2489
2490 return addr->is_joined;
2491}
2492
2500 struct net_if_mcast_addr *addr);
2501
2508#if defined(CONFIG_NET_NATIVE_IPV4)
2509static inline struct in_addr *net_if_router_ipv4(struct net_if_router *router)
2510{
2511 if (router == NULL) {
2512 return NULL;
2513 }
2514
2515 return &router->address.in_addr;
2516}
2517#else
2518static inline struct in_addr *net_if_router_ipv4(struct net_if_router *router)
2519{
2520 static struct in_addr addr;
2521
2522 ARG_UNUSED(router);
2523
2524 return &addr;
2525}
2526#endif
2527
2538 struct in_addr *addr);
2539
2550 struct in_addr *addr);
2562 struct in_addr *addr,
2563 bool is_default,
2564 uint16_t router_lifetime);
2565
2574
2584 const struct in_addr *addr);
2585
2595 const struct in_addr *addr);
2596
2606#if defined(CONFIG_NET_IPV4)
2607struct net_if *net_if_ipv4_select_src_iface(const struct in_addr *dst);
2608#else
2610 const struct in_addr *dst)
2611{
2612 ARG_UNUSED(dst);
2613
2614 return NULL;
2615}
2616#endif
2617
2630#if defined(CONFIG_NET_IPV4)
2631struct net_if *net_if_ipv4_select_src_iface_addr(const struct in_addr *dst,
2632 const struct in_addr **src_addr);
2633#else
2635 const struct in_addr *dst, const struct in_addr **src_addr)
2636{
2637 ARG_UNUSED(dst);
2638 ARG_UNUSED(src_addr);
2639
2640 return NULL;
2641}
2642#endif /* CONFIG_NET_IPV4 */
2643
2655#if defined(CONFIG_NET_IPV4)
2656const struct in_addr *net_if_ipv4_select_src_addr(struct net_if *iface,
2657 const struct in_addr *dst);
2658#else
2659static inline const struct in_addr *net_if_ipv4_select_src_addr(
2660 struct net_if *iface, const struct in_addr *dst)
2661{
2662 ARG_UNUSED(iface);
2663 ARG_UNUSED(dst);
2664
2665 return NULL;
2666}
2667#endif
2668
2678struct in_addr *net_if_ipv4_get_ll(struct net_if *iface,
2679 enum net_addr_state addr_state);
2680
2691 enum net_addr_state addr_state);
2692
2703 const struct in_addr *addr);
2704
2714__deprecated struct in_addr net_if_ipv4_get_netmask(struct net_if *iface);
2715
2724__deprecated void net_if_ipv4_set_netmask(struct net_if *iface,
2725 const struct in_addr *netmask);
2726
2737__deprecated __syscall bool net_if_ipv4_set_netmask_by_index(int index,
2738 const struct in_addr *netmask);
2739
2750 const struct in_addr *addr,
2751 const struct in_addr *netmask);
2752
2763 const struct in_addr *addr,
2764 const struct in_addr *netmask);
2765
2773struct in_addr net_if_ipv4_get_gw(struct net_if *iface);
2774
2781void net_if_ipv4_set_gw(struct net_if *iface, const struct in_addr *gw);
2782
2791__syscall bool net_if_ipv4_set_gw_by_index(int index, const struct in_addr *gw);
2792
2803struct net_if *net_if_select_src_iface(const struct sockaddr *dst);
2804
2813typedef void (*net_if_link_callback_t)(struct net_if *iface,
2814 struct net_linkaddr *dst,
2815 int status);
2816
2832
2841
2848
2856void net_if_call_link_cb(struct net_if *iface, struct net_linkaddr *lladdr,
2857 int status);
2858
2861/* used to ensure encoding of checksum support in net_if.h and
2862 * ethernet.h is the same
2863 */
2864#define NET_IF_CHECKSUM_NONE_BIT 0
2865#define NET_IF_CHECKSUM_IPV4_HEADER_BIT BIT(0)
2866#define NET_IF_CHECKSUM_IPV4_ICMP_BIT BIT(1)
2867/* Space for future protocols and restrictions for IPV4 */
2868#define NET_IF_CHECKSUM_IPV6_HEADER_BIT BIT(10)
2869#define NET_IF_CHECKSUM_IPV6_ICMP_BIT BIT(11)
2870/* Space for future protocols and restrictions for IPV6 */
2871#define NET_IF_CHECKSUM_TCP_BIT BIT(21)
2872#define NET_IF_CHECKSUM_UDP_BIT BIT(22)
2873
2881 NET_IF_CHECKSUM_IPV4_HEADER = NET_IF_CHECKSUM_IPV4_HEADER_BIT,
2883 NET_IF_CHECKSUM_IPV4_TCP = NET_IF_CHECKSUM_IPV4_HEADER_BIT |
2884 NET_IF_CHECKSUM_TCP_BIT,
2886 NET_IF_CHECKSUM_IPV4_UDP = NET_IF_CHECKSUM_IPV4_HEADER_BIT |
2887 NET_IF_CHECKSUM_UDP_BIT,
2889 NET_IF_CHECKSUM_IPV4_ICMP = NET_IF_CHECKSUM_IPV4_ICMP_BIT,
2891 NET_IF_CHECKSUM_IPV6_HEADER = NET_IF_CHECKSUM_IPV6_HEADER_BIT,
2893 NET_IF_CHECKSUM_IPV6_TCP = NET_IF_CHECKSUM_IPV6_HEADER_BIT |
2894 NET_IF_CHECKSUM_TCP_BIT,
2896 NET_IF_CHECKSUM_IPV6_UDP = NET_IF_CHECKSUM_IPV6_HEADER_BIT |
2897 NET_IF_CHECKSUM_UDP_BIT,
2899 NET_IF_CHECKSUM_IPV6_ICMP = NET_IF_CHECKSUM_IPV6_ICMP_BIT
2901
2913 enum net_if_checksum_type chksum_type);
2914
2927 enum net_if_checksum_type chksum_type);
2928
2939__syscall struct net_if *net_if_get_by_index(int index);
2940
2948int net_if_get_by_iface(struct net_if *iface);
2949
2957typedef void (*net_if_cb_t)(struct net_if *iface, void *user_data);
2958
2966void net_if_foreach(net_if_cb_t cb, void *user_data);
2967
2975int net_if_up(struct net_if *iface);
2976
2984static inline bool net_if_is_up(struct net_if *iface)
2985{
2986 if (iface == NULL) {
2987 return false;
2988 }
2989
2990 return net_if_flag_is_set(iface, NET_IF_UP) &&
2992}
2993
3001int net_if_down(struct net_if *iface);
3002
3010static inline bool net_if_is_admin_up(struct net_if *iface)
3011{
3012 if (iface == NULL) {
3013 return false;
3014 }
3015
3016 return net_if_flag_is_set(iface, NET_IF_UP);
3017}
3018
3027void net_if_carrier_on(struct net_if *iface);
3028
3037void net_if_carrier_off(struct net_if *iface);
3038
3046static inline bool net_if_is_carrier_ok(struct net_if *iface)
3047{
3048 if (iface == NULL) {
3049 return false;
3050 }
3051
3052 return net_if_flag_is_set(iface, NET_IF_LOWER_UP);
3053}
3054
3065void net_if_dormant_on(struct net_if *iface);
3066
3075void net_if_dormant_off(struct net_if *iface);
3076
3084static inline bool net_if_is_dormant(struct net_if *iface)
3085{
3086 if (iface == NULL) {
3087 return false;
3088 }
3089
3090 return net_if_flag_is_set(iface, NET_IF_DORMANT);
3091}
3092
3093#if defined(CONFIG_NET_PKT_TIMESTAMP) && defined(CONFIG_NET_NATIVE)
3101typedef void (*net_if_timestamp_callback_t)(struct net_pkt *pkt);
3102
3111struct net_if_timestamp_cb {
3113 sys_snode_t node;
3114
3118 struct net_pkt *pkt;
3119
3123 struct net_if *iface;
3124
3126 net_if_timestamp_callback_t cb;
3127};
3128
3139void net_if_register_timestamp_cb(struct net_if_timestamp_cb *handle,
3140 struct net_pkt *pkt,
3141 struct net_if *iface,
3142 net_if_timestamp_callback_t cb);
3143
3149void net_if_unregister_timestamp_cb(struct net_if_timestamp_cb *handle);
3150
3156void net_if_call_timestamp_cb(struct net_pkt *pkt);
3157
3158/*
3159 * @brief Add timestamped TX buffer to be handled
3160 *
3161 * @param pkt Timestamped buffer
3162 */
3163void net_if_add_tx_timestamp(struct net_pkt *pkt);
3164#endif /* CONFIG_NET_PKT_TIMESTAMP */
3165
3175#if defined(CONFIG_NET_PROMISCUOUS_MODE)
3176int net_if_set_promisc(struct net_if *iface);
3177#else
3178static inline int net_if_set_promisc(struct net_if *iface)
3179{
3180 ARG_UNUSED(iface);
3181
3182 return -ENOTSUP;
3183}
3184#endif
3185
3191#if defined(CONFIG_NET_PROMISCUOUS_MODE)
3192void net_if_unset_promisc(struct net_if *iface);
3193#else
3194static inline void net_if_unset_promisc(struct net_if *iface)
3195{
3196 ARG_UNUSED(iface);
3197}
3198#endif
3199
3208#if defined(CONFIG_NET_PROMISCUOUS_MODE)
3209bool net_if_is_promisc(struct net_if *iface);
3210#else
3211static inline bool net_if_is_promisc(struct net_if *iface)
3212{
3213 ARG_UNUSED(iface);
3214
3215 return false;
3216}
3217#endif
3218
3228static inline bool net_if_are_pending_tx_packets(struct net_if *iface)
3229{
3230#if defined(CONFIG_NET_POWER_MANAGEMENT)
3231 return !!iface->tx_pending;
3232#else
3233 ARG_UNUSED(iface);
3234
3235 return false;
3236#endif
3237}
3238
3239#ifdef CONFIG_NET_POWER_MANAGEMENT
3247int net_if_suspend(struct net_if *iface);
3248
3256int net_if_resume(struct net_if *iface);
3257
3265bool net_if_is_suspended(struct net_if *iface);
3266#endif /* CONFIG_NET_POWER_MANAGEMENT */
3267
3275bool net_if_is_wifi(struct net_if *iface);
3276
3283
3290
3297
3312int net_if_get_name(struct net_if *iface, char *buf, int len);
3313
3328int net_if_set_name(struct net_if *iface, const char *buf);
3329
3337int net_if_get_by_name(const char *name);
3338
3340struct net_if_api {
3341 void (*init)(struct net_if *iface);
3342};
3343
3344#define NET_IF_DHCPV4_INIT \
3345 IF_ENABLED(UTIL_AND(IS_ENABLED(CONFIG_NET_DHCPV4), \
3346 IS_ENABLED(CONFIG_NET_NATIVE_IPV4)), \
3347 (.dhcpv4.state = NET_DHCPV4_DISABLED,))
3348
3349#define NET_IF_DHCPV6_INIT \
3350 IF_ENABLED(UTIL_AND(IS_ENABLED(CONFIG_NET_DHCPV6), \
3351 IS_ENABLED(CONFIG_NET_NATIVE_IPV6)), \
3352 (.dhcpv6.state = NET_DHCPV6_DISABLED,))
3353
3354#define NET_IF_CONFIG_INIT \
3355 .config = { \
3356 IF_ENABLED(CONFIG_NET_IP, (.ip = {},)) \
3357 NET_IF_DHCPV4_INIT \
3358 NET_IF_DHCPV6_INIT \
3359 }
3360
3361#define NET_PROMETHEUS_GET_COLLECTOR_NAME(dev_id, sfx) \
3362 net_stats_##dev_id##_##sfx##_collector
3363#define NET_PROMETHEUS_INIT(dev_id, sfx) \
3364 IF_ENABLED(CONFIG_NET_STATISTICS_VIA_PROMETHEUS, \
3365 (.collector = &NET_PROMETHEUS_GET_COLLECTOR_NAME(dev_id, sfx),))
3366
3367#define NET_IF_GET_NAME(dev_id, sfx) __net_if_##dev_id##_##sfx
3368#define NET_IF_DEV_GET_NAME(dev_id, sfx) __net_if_dev_##dev_id##_##sfx
3369
3370#define NET_IF_GET(dev_id, sfx) \
3371 ((struct net_if *)&NET_IF_GET_NAME(dev_id, sfx))
3372
3373#if defined(CONFIG_NET_STATISTICS_VIA_PROMETHEUS)
3374extern int net_stats_prometheus_scrape(struct prometheus_collector *collector,
3375 struct prometheus_metric *metric,
3376 void *user_data);
3377#endif /* CONFIG_NET_STATISTICS_VIA_PROMETHEUS */
3378
3379#define NET_IF_INIT(dev_id, sfx, _l2, _mtu, _num_configs) \
3380 static STRUCT_SECTION_ITERABLE(net_if_dev, \
3381 NET_IF_DEV_GET_NAME(dev_id, sfx)) = { \
3382 .dev = &(DEVICE_NAME_GET(dev_id)), \
3383 .l2 = &(NET_L2_GET_NAME(_l2)), \
3384 .l2_data = &(NET_L2_GET_DATA(dev_id, sfx)), \
3385 .mtu = _mtu, \
3386 .flags = {BIT(NET_IF_LOWER_UP)}, \
3387 }; \
3388 static Z_DECL_ALIGN(struct net_if) \
3389 NET_IF_GET_NAME(dev_id, sfx)[_num_configs] \
3390 __used __noasan __in_section(_net_if, static, \
3391 dev_id) = { \
3392 [0 ... (_num_configs - 1)] = { \
3393 .if_dev = &(NET_IF_DEV_GET_NAME(dev_id, sfx)), \
3394 NET_IF_CONFIG_INIT \
3395 } \
3396 }; \
3397 IF_ENABLED(CONFIG_NET_STATISTICS_VIA_PROMETHEUS, \
3398 (static PROMETHEUS_COLLECTOR_DEFINE( \
3399 NET_PROMETHEUS_GET_COLLECTOR_NAME(dev_id, \
3400 sfx), \
3401 net_stats_prometheus_scrape, \
3402 NET_IF_GET(dev_id, sfx)); \
3403 NET_STATS_PROMETHEUS(NET_IF_GET(dev_id, sfx), \
3404 dev_id, sfx);))
3405
3406#define NET_IF_OFFLOAD_INIT(dev_id, sfx, _mtu) \
3407 static STRUCT_SECTION_ITERABLE(net_if_dev, \
3408 NET_IF_DEV_GET_NAME(dev_id, sfx)) = { \
3409 .dev = &(DEVICE_NAME_GET(dev_id)), \
3410 .mtu = _mtu, \
3411 .l2 = &(NET_L2_GET_NAME(OFFLOADED_NETDEV)), \
3412 .flags = {BIT(NET_IF_LOWER_UP)}, \
3413 }; \
3414 static Z_DECL_ALIGN(struct net_if) \
3415 NET_IF_GET_NAME(dev_id, sfx)[NET_IF_MAX_CONFIGS] \
3416 __used __in_section(_net_if, static, \
3417 dev_id) = { \
3418 [0 ... (NET_IF_MAX_CONFIGS - 1)] = { \
3419 .if_dev = &(NET_IF_DEV_GET_NAME(dev_id, sfx)), \
3420 NET_IF_CONFIG_INIT \
3421 } \
3422 }; \
3423 IF_ENABLED(CONFIG_NET_STATISTICS_VIA_PROMETHEUS, \
3424 (static PROMETHEUS_COLLECTOR_DEFINE( \
3425 NET_PROMETHEUS_GET_COLLECTOR_NAME(dev_id, \
3426 sfx), \
3427 net_stats_prometheus_scrape, \
3428 NET_IF_GET(dev_id, sfx)); \
3429 NET_STATS_PROMETHEUS(NET_IF_GET(dev_id, sfx), \
3430 dev_id, sfx);))
3431
3432
3435/* Network device initialization macros */
3436
3437#define Z_NET_DEVICE_INIT_INSTANCE(node_id, dev_id, name, instance, \
3438 init_fn, pm, data, config, prio, \
3439 api, l2, l2_ctx_type, mtu) \
3440 Z_DEVICE_STATE_DEFINE(dev_id); \
3441 Z_DEVICE_DEFINE(node_id, dev_id, name, init_fn, NULL, \
3442 Z_DEVICE_DT_FLAGS(node_id), pm, data, \
3443 config, POST_KERNEL, prio, api, \
3444 &Z_DEVICE_STATE_NAME(dev_id)); \
3445 NET_L2_DATA_INIT(dev_id, instance, l2_ctx_type); \
3446 NET_IF_INIT(dev_id, instance, l2, mtu, NET_IF_MAX_CONFIGS)
3447
3448#define Z_NET_DEVICE_INIT(node_id, dev_id, name, init_fn, pm, data, \
3449 config, prio, api, l2, l2_ctx_type, mtu) \
3450 Z_NET_DEVICE_INIT_INSTANCE(node_id, dev_id, name, 0, init_fn, \
3451 pm, data, config, prio, api, l2, \
3452 l2_ctx_type, mtu)
3453
3473#define NET_DEVICE_INIT(dev_id, name, init_fn, pm, data, config, prio, \
3474 api, l2, l2_ctx_type, mtu) \
3475 Z_NET_DEVICE_INIT(DT_INVALID_NODE, dev_id, name, init_fn, pm, \
3476 data, config, prio, api, l2, l2_ctx_type, mtu)
3477
3496#define NET_DEVICE_DT_DEFINE(node_id, init_fn, pm, data, \
3497 config, prio, api, l2, l2_ctx_type, mtu) \
3498 Z_NET_DEVICE_INIT(node_id, Z_DEVICE_DT_DEV_ID(node_id), \
3499 DEVICE_DT_NAME(node_id), init_fn, pm, data, \
3500 config, prio, api, l2, l2_ctx_type, mtu)
3501
3510#define NET_DEVICE_DT_INST_DEFINE(inst, ...) \
3511 NET_DEVICE_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
3512
3536#define NET_DEVICE_INIT_INSTANCE(dev_id, name, instance, init_fn, pm, \
3537 data, config, prio, api, l2, \
3538 l2_ctx_type, mtu) \
3539 Z_NET_DEVICE_INIT_INSTANCE(DT_INVALID_NODE, dev_id, name, \
3540 instance, init_fn, pm, data, config, \
3541 prio, api, l2, l2_ctx_type, mtu)
3542
3565#define NET_DEVICE_DT_DEFINE_INSTANCE(node_id, instance, init_fn, pm, \
3566 data, config, prio, api, l2, \
3567 l2_ctx_type, mtu) \
3568 Z_NET_DEVICE_INIT_INSTANCE(node_id, \
3569 Z_DEVICE_DT_DEV_ID(node_id), \
3570 DEVICE_DT_NAME(node_id), instance, \
3571 init_fn, pm, data, config, prio, \
3572 api, l2, l2_ctx_type, mtu)
3573
3583#define NET_DEVICE_DT_INST_DEFINE_INSTANCE(inst, ...) \
3584 NET_DEVICE_DT_DEFINE_INSTANCE(DT_DRV_INST(inst), __VA_ARGS__)
3585
3586#define Z_NET_DEVICE_OFFLOAD_INIT(node_id, dev_id, name, init_fn, pm, \
3587 data, config, prio, api, mtu) \
3588 Z_DEVICE_STATE_DEFINE(dev_id); \
3589 Z_DEVICE_DEFINE(node_id, dev_id, name, init_fn, NULL, \
3590 Z_DEVICE_DT_FLAGS(node_id), pm, data, \
3591 config, POST_KERNEL, prio, api, \
3592 &Z_DEVICE_STATE_NAME(dev_id)); \
3593 NET_IF_OFFLOAD_INIT(dev_id, 0, mtu)
3594
3614#define NET_DEVICE_OFFLOAD_INIT(dev_id, name, init_fn, pm, data, \
3615 config, prio, api, mtu) \
3616 Z_NET_DEVICE_OFFLOAD_INIT(DT_INVALID_NODE, dev_id, name, \
3617 init_fn, pm, data, config, prio, api, \
3618 mtu)
3619
3638#define NET_DEVICE_DT_OFFLOAD_DEFINE(node_id, init_fn, pm, data, \
3639 config, prio, api, mtu) \
3640 Z_NET_DEVICE_OFFLOAD_INIT(node_id, Z_DEVICE_DT_DEV_ID(node_id), \
3641 DEVICE_DT_NAME(node_id), init_fn, pm, \
3642 data, config, prio, api, mtu)
3643
3653#define NET_DEVICE_DT_INST_OFFLOAD_DEFINE(inst, ...) \
3654 NET_DEVICE_DT_OFFLOAD_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
3655
3661#define NET_IFACE_COUNT(_dst) \
3662 do { \
3663 extern struct net_if _net_if_list_start[]; \
3664 extern struct net_if _net_if_list_end[]; \
3665 *(_dst) = ((uintptr_t)_net_if_list_end - \
3666 (uintptr_t)_net_if_list_start) / \
3667 sizeof(struct net_if); \
3668 } while (0)
3669
3670#ifdef __cplusplus
3671}
3672#endif
3673
3674#include <zephyr/syscalls/net_if.h>
3675
3680#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:1481
#define K_NO_WAIT
Generate null timeout delay.
Definition kernel.h:1371
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:530
net_addr_type
How the network address is assigned to network interface.
Definition net_ip.h:538
bool k_is_in_isr(void)
Determine if code is running at interrupt level.
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:103
static int net_hostname_set_postfix(const uint8_t *hostname_postfix, int postfix_len)
Set the device hostname postfix.
Definition hostname.h:113
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 struct net_if * net_if_ipv4_select_src_iface_addr(const struct in_addr *dst, const struct in_addr **src_addr)
Get a network interface that should be used when sending IPv4 network data to destination.
Definition net_if.h:2634
static bool net_if_is_carrier_ok(struct net_if *iface)
Check if carrier is present on network device.
Definition net_if.h:3046
static bool net_if_is_admin_up(struct net_if *iface)
Check if interface was brought up by the administrator.
Definition net_if.h:3010
void net_if_set_default(struct net_if *iface)
Set the default network interface.
int net_if_ipv4_addr_lookup_by_index(const struct in_addr *addr)
Check if this IPv4 address belongs to one of the interface indices.
int(* net_socket_create_t)(int, int, int)
A function prototype to create an offloaded socket.
Definition net_if.h:653
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:897
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:2518
static void net_if_queue_tx(struct net_if *iface, struct net_pkt *pkt)
Queue a packet to the net interface TX queue.
Definition net_if.h:1031
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).
void net_if_try_queue_tx(struct net_if *iface, struct net_pkt *pkt, k_timeout_t timeout)
Try enqueuing a packet to the net interface TX queue.
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_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:2813
static void * net_if_l2_data(struct net_if *iface)
Get a pointer to the interface L2 private data.
Definition net_if.h:990
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:3228
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:827
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:1160
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:2151
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:1236
static struct net_offload * net_if_offload(struct net_if *iface)
Return the IP offload plugin.
Definition net_if.h:1073
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:1313
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:809
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.
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:1982
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:1948
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:2179
enum net_verdict net_if_try_send_data(struct net_if *iface, struct net_pkt *pkt, k_timeout_t timeout)
Try sending a packet through a net iface.
int net_if_get_name(struct net_if *iface, char *buf, int len)
Get network interface name.
void(* net_if_ip_maddr_cb_t)(struct net_if *iface, struct net_if_mcast_addr *maddr, void *user_data)
Callback used while iterating over network interface multicast IP addresses.
Definition net_if.h:1624
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:1931
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:1045
static bool net_if_is_dormant(struct net_if *iface)
Check if the interface is dormant.
Definition net_if.h:3084
struct net_if * net_if_get_first_wifi(void)
Get first Wi-Fi network interface.
struct net_if_addr * net_if_ipv4_addr_add(struct net_if *iface, struct in_addr *addr, enum net_addr_type addr_type, uint32_t vlifetime)
Add a IPv4 address to an interface.
uint8_t net_if_ipv4_get_mcast_ttl(struct net_if *iface)
Get IPv4 multicast time-to-live value specified for a given interface.
struct net_if * net_if_get_by_index(int index)
Get interface according to index.
enum net_verdict net_if_recv_data(struct net_if *iface, struct net_pkt *pkt)
Input a packet through a net iface.
void(* net_if_mcast_callback_t)(struct net_if *iface, const struct net_addr *addr, bool is_joined)
Define a callback that is called whenever a IPv6 or IPv4 multicast address group is joined or left.
Definition net_if.h:1662
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:1346
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:2984
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:2073
static enum net_verdict net_if_send_data(struct net_if *iface, struct net_pkt *pkt)
Send a packet through a net iface.
Definition net_if.h:949
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:2879
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:1193
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:3194
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:1116
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:2040
static bool net_if_is_promisc(struct net_if *iface)
Check if promiscuous mode is set or not.
Definition net_if.h:3211
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:2484
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:1805
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:1215
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:2013
struct net_if_addr * net_if_ipv6_addr_lookup_by_iface(struct net_if *iface, struct in6_addr *addr)
Check if this IPv6 address belongs to this specific interfaces.
void net_if_ipv6_maddr_foreach(struct net_if *iface, net_if_ip_maddr_cb_t cb, void *user_data)
Go through all IPv6 multicast addresses on a network interface and call callback for each used addres...
static bool net_if_flag_test_and_clear(struct net_if *iface, enum net_if_flag value)
Test and clear a value in network interface flags.
Definition net_if.h:861
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:1730
bool net_if_ipv6_addr_rm_by_index(int index, const struct in6_addr *addr)
Remove an IPv6 address from an interface by index.
bool net_if_ipv4_addr_rm_by_index(int index, const struct in_addr *addr)
Remove a IPv4 address from an interface by interface index.
struct in6_addr * net_if_ipv6_get_global_addr(enum net_addr_state state, struct net_if **iface)
Return global IPv6 address from the first interface that has a global IPv6 address matching the given...
static uint16_t net_if_get_mtu(struct net_if *iface)
Get an network interface's MTU.
Definition net_if.h:1331
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:2659
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:2092
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.
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:1855
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:2118
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:1580
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:307
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_addr(const struct in6_addr *dst, const struct in6_addr **src_addr)
Get a network interface that should be used when sending IPv6 network data to destination.
Definition net_if.h:2227
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:2202
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:879
static struct net_if_config * net_if_config_get(struct net_if *iface)
Get network interface IP config.
Definition net_if.h:1397
static struct net_if_config * net_if_get_config(struct net_if *iface)
Return network configuration for this network interface.
Definition net_if.h:1176
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:1362
net_if_flag
Network interface flags.
Definition net_if.h:249
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:1006
void(* net_if_cb_t)(struct net_if *iface, void *user_data)
Callback used while iterating over network interfaces.
Definition net_if.h:2957
bool net_if_is_offloaded(struct net_if *iface)
Return offload status of a given network interface.
void net_if_ipv6_addr_update_lifetime(struct net_if_addr *ifaddr, uint32_t vlifetime)
Update validity lifetime time of an IPv6 address.
bool net_if_ipv6_maddr_rm(struct net_if *iface, const struct in6_addr *addr)
Remove an IPv6 multicast address from an interface.
static bool net_if_is_socket_offloaded(struct net_if *iface)
Return the socket offload status.
Definition net_if.h:1095
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:1999
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:3178
static const struct net_l2 * net_if_l2(struct net_if *iface)
Get a pointer to the interface L2.
Definition net_if.h:964
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:1138
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:2609
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:843
@ NET_IF_CHECKSUM_IPV4_ICMP
Interface supports checksum calculation for ICMP4 payload in IPv4.
Definition net_if.h:2889
@ NET_IF_CHECKSUM_IPV6_TCP
Interface supports checksum calculation for TCP payload in IPv6.
Definition net_if.h:2893
@ NET_IF_CHECKSUM_IPV6_UDP
Interface supports checksum calculation for UDP payload in IPv6.
Definition net_if.h:2896
@ NET_IF_CHECKSUM_IPV4_HEADER
Interface supports IP version 4 header checksum calculation.
Definition net_if.h:2881
@ NET_IF_CHECKSUM_IPV4_TCP
Interface supports checksum calculation for TCP payload in IPv4.
Definition net_if.h:2883
@ NET_IF_CHECKSUM_IPV6_HEADER
Interface supports IP version 6 header checksum calculation.
Definition net_if.h:2891
@ NET_IF_CHECKSUM_IPV6_ICMP
Interface supports checksum calculation for ICMP6 payload in IPv6.
Definition net_if.h:2899
@ NET_IF_CHECKSUM_IPV4_UDP
Interface supports checksum calculation for UDP payload in IPv4.
Definition net_if.h:2886
@ NET_IF_OPER_TESTING
Training mode.
Definition net_if.h:312
@ NET_IF_OPER_DORMANT
Waiting external action.
Definition net_if.h:313
@ NET_IF_OPER_UP
Interface is up.
Definition net_if.h:314
@ NET_IF_OPER_NOTPRESENT
Hardware missing.
Definition net_if.h:309
@ NET_IF_OPER_UNKNOWN
Initial (unknown) value.
Definition net_if.h:308
@ NET_IF_OPER_DOWN
Interface is down.
Definition net_if.h:310
@ NET_IF_OPER_LOWERLAYERDOWN
Lower layer interface is down.
Definition net_if.h:311
@ NET_IF_NO_AUTO_START
Do not start the interface immediately after initialization.
Definition net_if.h:265
@ NET_IF_IPV6_NO_MLD
IPv6 Multicast Listener Discovery disabled.
Definition net_if.h:295
@ NET_IF_POINTOPOINT
Interface is pointopoint.
Definition net_if.h:254
@ NET_IF_IPV6_NO_ND
IPv6 Neighbor Discovery disabled.
Definition net_if.h:292
@ NET_IF_FORWARD_MULTICASTS
Flag defines if received multicasts of other interface are forwarded on this interface.
Definition net_if.h:274
@ NET_IF_IPV4
Interface supports IPv4.
Definition net_if.h:277
@ NET_IF_PROMISC
Interface is in promiscuous mode.
Definition net_if.h:257
@ NET_IF_DORMANT
Driver signals dormant.
Definition net_if.h:289
@ NET_IF_SUSPENDED
Power management specific: interface is being suspended.
Definition net_if.h:268
@ NET_IF_IPV6
Interface supports IPv6.
Definition net_if.h:280
@ NET_IF_UP
Interface is admin up.
Definition net_if.h:251
@ NET_IF_LOWER_UP
Driver signals L1 is up.
Definition net_if.h:286
@ NET_IF_RUNNING
Interface up and running (ready to receive and transmit).
Definition net_if.h:283
@ NET_IF_NO_TX_LOCK
Mutex locking on TX data path disabled on the interface.
Definition net_if.h:298
net_link_type
Type of the link address.
Definition net_linkaddr.h:45
static int net_linkaddr_create(struct net_linkaddr *lladdr, const uint8_t *addr, uint8_t len, enum net_link_type type)
Create a link address structure.
Definition net_linkaddr.h:166
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:247
#define EINVAL
Invalid argument.
Definition errno.h:60
#define ENOTSUP
Unsupported value.
Definition errno.h:114
#define EPERM
Not owner.
Definition errno.h:39
Hostname configuration definitions.
#define NULL
Definition iar_missing_defs.h:20
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:97
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:510
IPv6 address struct.
Definition net_ip.h:143
IPv4 address struct.
Definition net_ip.h:155
Definition kernel.h:2540
Mutex Structure.
Definition kernel.h:3070
Semaphore structure.
Definition kernel.h:3275
Thread Structure.
Definition thread.h:262
Kernel timeout type.
Definition sys_clock.h:65
Kernel timepoint type.
Definition sys_clock.h:236
DHCPv6 client configuration parameters.
Definition dhcpv6.h:63
Network Interface unicast IPv4 address and netmask.
Definition net_if.h:468
struct net_if_addr ipv4
IPv4 address.
Definition net_if.h:470
struct in_addr netmask
Netmask.
Definition net_if.h:472
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:143
uint8_t is_temporary
Is this IP address temporary and generated for example by IPv6 privacy extension (RFC 8981)
Definition net_if.h:148
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:137
atomic_t atomic_ref
Reference counter.
Definition net_if.h:63
uint8_t is_added
Was this address added or not.
Definition net_if.h:151
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:140
IP and other configuration related data for network interface.
Definition net_if.h:586
Network Interface Device structure.
Definition net_if.h:669
enum net_if_oper_state oper_state
RFC 2863 operational status.
Definition net_if.h:705
const struct net_l2 *const l2
Interface's L2 layer.
Definition net_if.h:674
void * l2_data
Interface's private L2 data pointer.
Definition net_if.h:677
uint16_t mtu
The hardware MTU.
Definition net_if.h:695
const struct device * dev
The actually device driver instance the net_if is related to.
Definition net_if.h:671
struct net_linkaddr link_addr
The hardware link address.
Definition net_if.h:683
atomic_t flags[ATOMIC_BITMAP_SIZE(NET_IF_NUM_FLAGS)]
For internal use.
Definition net_if.h:680
Network interface IP address configuration.
Definition net_if.h:573
IPv4 configuration.
Definition net_if.h:476
uint8_t mcast_ttl
IPv4 time-to-live for multicast packets.
Definition net_if.h:490
struct net_if_addr_ipv4 unicast[NET_IF_MAX_IPV4_ADDR]
Unicast IP addresses.
Definition net_if.h:478
struct in_addr gw
Gateway.
Definition net_if.h:484
uint8_t ttl
IPv4 time-to-live.
Definition net_if.h:487
struct net_if_mcast_addr mcast[NET_IF_MAX_IPV4_MADDR]
Multicast IP addresses.
Definition net_if.h:481
Network Interface IPv6 prefixes.
Definition net_if.h:193
struct net_if * iface
Backpointer to network interface where this prefix is used.
Definition net_if.h:201
uint8_t is_infinite
Is the IP prefix valid forever.
Definition net_if.h:207
uint8_t len
Prefix length.
Definition net_if.h:204
struct in6_addr prefix
IPv6 prefix.
Definition net_if.h:198
uint8_t is_used
Is this prefix used or not.
Definition net_if.h:210
struct net_timeout lifetime
Prefix lifetime.
Definition net_if.h:195
IPv6 configuration.
Definition net_if.h:334
struct net_if_ipv6_prefix prefix[NET_IF_MAX_IPV6_PREFIX]
Prefixes.
Definition net_if.h:342
uint32_t base_reachable_time
Default reachable time (RFC 4861, page 52)
Definition net_if.h:345
uint8_t hop_limit
IPv6 hop limit.
Definition net_if.h:383
struct net_if_mcast_addr mcast[NET_IF_MAX_IPV6_MADDR]
Multicast IP addresses.
Definition net_if.h:339
uint32_t retrans_timer
Retransmit timer (RFC 4861, page 52)
Definition net_if.h:351
struct net_if_addr unicast[NET_IF_MAX_IPV6_ADDR]
Unicast IP addresses.
Definition net_if.h:336
uint8_t mcast_hop_limit
IPv6 multicast hop limit.
Definition net_if.h:386
uint32_t reachable_time
Reachable time (RFC 4861, page 20)
Definition net_if.h:348
Network Interface multicast IP addresses.
Definition net_if.h:161
struct net_addr address
IP address.
Definition net_if.h:163
uint8_t is_joined
Did we join to this group.
Definition net_if.h:183
sys_snode_t rejoin_node
Rejoining multicast groups list node.
Definition net_if.h:166
uint8_t is_used
Is this multicast IP address used or not.
Definition net_if.h:180
Multicast monitor handler struct.
Definition net_if.h:1674
sys_snode_t node
Node information for the slist.
Definition net_if.h:1676
net_if_mcast_callback_t cb
Multicast callback.
Definition net_if.h:1682
struct net_if * iface
Network interface.
Definition net_if.h:1679
Information about routers in the system.
Definition net_if.h:220
struct net_if * iface
Network interface the router is connected to.
Definition net_if.h:228
uint8_t is_default
Is default router.
Definition net_if.h:240
uint16_t lifetime
Router lifetime.
Definition net_if.h:234
uint8_t is_infinite
Is the router valid forever.
Definition net_if.h:243
uint8_t is_used
Is this router used or not.
Definition net_if.h:237
struct net_addr address
IP address.
Definition net_if.h:225
sys_snode_t node
Slist lifetime timer node.
Definition net_if.h:222
uint32_t life_start
Router life timer start.
Definition net_if.h:231
Network Interface structure.
Definition net_if.h:715
struct net_if_dev * if_dev
The net_if_dev instance the net_if is related to.
Definition net_if.h:717
struct net_if_config config
Network interface instance configuration.
Definition net_if.h:729
uint8_t pe_enabled
Network interface specific flags.
Definition net_if.h:749
struct k_mutex lock
Mutex protecting this network interface instance.
Definition net_if.h:740
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:754
struct k_mutex tx_lock
Mutex used when sending data.
Definition net_if.h:743
Network L2 structure.
Definition net_l2.h:58
Hardware link address structure.
Definition net_linkaddr.h:70
Network packet.
Definition net_pkt.h:91
All network statistics in one struct.
Definition net_stats.h:406
Generic struct for handling network timeouts.
Definition net_timeout.h:57
Network traffic class.
Definition net_if.h:630
k_thread_stack_t * stack
Stack for this handler.
Definition net_if.h:644
struct k_thread handler
Traffic class handler thread.
Definition net_if.h:641
struct k_fifo fifo
Fifo for handling this Tx or Rx packet.
Definition net_if.h:632
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