Zephyr API Documentation 4.4.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
11
12#ifndef ZEPHYR_INCLUDE_NET_NET_IF_H_
13#define ZEPHYR_INCLUDE_NET_NET_IF_H_
14
23
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
169
172
173#if defined(CONFIG_NET_IPV4_IGMPV3)
175 struct net_addr sources[CONFIG_NET_IF_MCAST_IPV4_SOURCE_COUNT];
176
178 uint16_t sources_len;
179
181 uint8_t record_type;
182#endif
183
186
189
190 uint8_t _unused : 6;
191};
192
201
204
206 struct net_if *iface;
207
210
213
216
217 uint8_t _unused : 6;
218};
219
228
230 struct net_addr address;
231
233 struct net_if *iface;
234
237
240
243
246
249
250 uint8_t _unused : 5;
251};
252
310
321
322#if defined(CONFIG_NET_OFFLOAD)
323struct net_offload;
324#endif /* CONFIG_NET_OFFLOAD */
325
327#if defined(CONFIG_NET_IPV6)
328#define NET_IF_MAX_IPV6_ADDR CONFIG_NET_IF_UNICAST_IPV6_ADDR_COUNT
329#define NET_IF_MAX_IPV6_MADDR CONFIG_NET_IF_MCAST_IPV6_ADDR_COUNT
330#define NET_IF_MAX_IPV6_PREFIX CONFIG_NET_IF_IPV6_PREFIX_COUNT
331#else
332#define NET_IF_MAX_IPV6_ADDR 0
333#define NET_IF_MAX_IPV6_MADDR 0
334#define NET_IF_MAX_IPV6_PREFIX 0
335#endif
336/* @endcond */
337
341 struct net_if_addr unicast[NET_IF_MAX_IPV6_ADDR];
342
344 struct net_if_mcast_addr mcast[NET_IF_MAX_IPV6_MADDR];
345
347 struct net_if_ipv6_prefix prefix[NET_IF_MAX_IPV6_PREFIX];
348
351
354
357
358#if defined(CONFIG_NET_IPV6_IID_STABLE)
360 struct net_if_addr *iid;
361
365 uint32_t network_counter;
366#endif /* CONFIG_NET_IPV6_IID_STABLE */
367
368#if defined(CONFIG_NET_IPV6_PE)
373 uint32_t desync_factor;
374#endif /* CONFIG_NET_IPV6_PE */
375
376#if defined(CONFIG_NET_IPV6_ND) && defined(CONFIG_NET_NATIVE_IPV6)
378 sys_snode_t rs_node;
379
380 /* RS start time */
381 uint32_t rs_start;
382
384 uint8_t rs_count;
385#endif
386
389
392};
393
394#if defined(CONFIG_NET_DHCPV6) && defined(CONFIG_NET_NATIVE_IPV6)
396struct net_if_dhcpv6 {
398 sys_snode_t node;
399
401 struct net_dhcpv6_duid_storage clientid;
402
404 struct net_dhcpv6_duid_storage serverid;
405
407 enum net_dhcpv6_state state;
408
410 struct net_dhcpv6_params params;
411
413 uint64_t timeout;
414
416 uint64_t exchange_start;
417
419 uint64_t t1;
420
422 uint64_t t2;
423
427 uint64_t expire;
428
430 uint32_t addr_iaid;
431
433 uint32_t prefix_iaid;
434
436 uint32_t retransmit_timeout;
437
439 int16_t server_preference;
440
442 uint8_t retransmissions;
443
445 uint8_t tid[DHCPV6_TID_SIZE];
446
448 uint8_t prefix_len;
449
451 struct net_in6_addr prefix;
452
454 struct net_in6_addr addr;
455};
456#endif /* defined(CONFIG_NET_DHCPV6) && defined(CONFIG_NET_NATIVE_IPV6) */
457
459#if defined(CONFIG_NET_IPV4)
460#define NET_IF_MAX_IPV4_ADDR CONFIG_NET_IF_UNICAST_IPV4_ADDR_COUNT
461#define NET_IF_MAX_IPV4_MADDR CONFIG_NET_IF_MCAST_IPV4_ADDR_COUNT
462#else
463#define NET_IF_MAX_IPV4_ADDR 0
464#define NET_IF_MAX_IPV4_MADDR 0
465#endif
467
479
483 struct net_if_addr_ipv4 unicast[NET_IF_MAX_IPV4_ADDR];
484
486 struct net_if_mcast_addr mcast[NET_IF_MAX_IPV4_MADDR];
487
490
493
496
497#if defined(CONFIG_NET_IPV4_ACD)
499 uint8_t conflict_cnt;
500#endif
501};
502
503#if defined(CONFIG_NET_DHCPV4) && defined(CONFIG_NET_NATIVE_IPV4)
504struct net_if_dhcpv4 {
506 sys_snode_t node;
507
509 int64_t timer_start;
510
512 uint32_t request_time;
513
514 uint32_t xid;
515
517 uint32_t lease_time;
518
520 uint32_t renewal_time;
521
523 uint32_t rebinding_time;
524
526 struct net_in_addr server_id;
527
529 struct net_in_addr requested_ip;
530
532 struct net_in_addr netmask;
533
538 enum net_dhcpv4_state state;
539
541 uint8_t attempts;
542
544 struct net_in_addr request_server_addr;
545
547 struct net_in_addr response_src_addr;
548
549#ifdef CONFIG_NET_DHCPV4_OPTION_NTP_SERVER
551 struct net_in_addr ntp_addr;
552#endif
553};
554#endif /* CONFIG_NET_DHCPV4 */
555
556#if defined(CONFIG_NET_IPV4_AUTO) && defined(CONFIG_NET_NATIVE_IPV4)
557struct net_if_ipv4_autoconf {
559 struct net_if *iface;
560
562 struct net_in_addr requested_ip;
563
567};
568#endif /* CONFIG_NET_IPV4_AUTO */
569
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
676 const struct device *dev;
677
679 const struct net_l2 * const l2;
680
682 void *l2_data;
683
685 ATOMIC_DEFINE(flags, NET_IF_NUM_FLAGS);
686
688 struct net_linkaddr link_addr;
689
690#if defined(CONFIG_NET_OFFLOAD)
696 struct net_offload *offload;
697#endif /* CONFIG_NET_OFFLOAD */
698
700 uint16_t mtu;
701
702#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
706 net_socket_create_t socket_offload;
707#endif /* CONFIG_NET_SOCKETS_OFFLOAD */
708
710 enum net_if_oper_state oper_state;
711
721 int64_t oper_state_change_time;
725};
726
735struct net_if {
740 struct net_if_dev *if_dev;
741
742#if defined(CONFIG_NET_STATISTICS_PER_INTERFACE)
744 struct net_stats stats;
745
747 IF_ENABLED(CONFIG_NET_STATISTICS_VIA_PROMETHEUS,
748 (struct prometheus_collector *collector);)
749#endif /* CONFIG_NET_STATISTICS_PER_INTERFACE */
750
752 struct net_if_config config;
753
754#if defined(CONFIG_NET_POWER_MANAGEMENT)
759 int tx_pending;
760#endif
761
763 struct k_mutex lock;
764
766 struct k_mutex tx_lock;
767
772 uint8_t pe_enabled : 1;
773
777 uint8_t pe_prefer_public : 1;
778
780 uint8_t _unused : 6;
784};
785
787
788static inline void net_if_lock(struct net_if *iface)
789{
790 NET_ASSERT(iface);
791
792 (void)k_mutex_lock(&iface->lock, K_FOREVER);
793}
794
795static inline void net_if_unlock(struct net_if *iface)
796{
797 NET_ASSERT(iface);
798
799 k_mutex_unlock(&iface->lock);
800}
801
802static inline bool net_if_flag_is_set(struct net_if *iface,
803 enum net_if_flag value);
804
805static inline void net_if_tx_lock(struct net_if *iface)
806{
807 NET_ASSERT(iface);
808
810 return;
811 }
812
813 (void)k_mutex_lock(&iface->tx_lock, K_FOREVER);
814}
815
816static inline void net_if_tx_unlock(struct net_if *iface)
817{
818 NET_ASSERT(iface);
819
821 return;
822 }
823
824 k_mutex_unlock(&iface->tx_lock);
825}
826
828
835static inline void net_if_flag_set(struct net_if *iface,
836 enum net_if_flag value)
837{
838 if (iface == NULL) {
839 return;
840 }
841
842 NET_ASSERT(iface->if_dev != NULL);
843
844 atomic_set_bit(iface->if_dev->flags, value);
845}
846
855static inline bool net_if_flag_test_and_set(struct net_if *iface,
856 enum net_if_flag value)
857{
858 if (iface == NULL) {
859 return false;
860 }
861
862 NET_ASSERT(iface->if_dev != NULL);
863
864 return atomic_test_and_set_bit(iface->if_dev->flags, value);
865}
866
873static inline void net_if_flag_clear(struct net_if *iface,
874 enum net_if_flag value)
875{
876 if (iface == NULL) {
877 return;
878 }
879
880 NET_ASSERT(iface->if_dev != NULL);
881
882 atomic_clear_bit(iface->if_dev->flags, value);
883}
884
893static inline bool net_if_flag_test_and_clear(struct net_if *iface,
894 enum net_if_flag value)
895{
896 if (iface == NULL) {
897 return false;
898 }
899
900 NET_ASSERT(iface->if_dev != NULL);
901
902 return atomic_test_and_clear_bit(iface->if_dev->flags, value);
903}
904
913static inline bool net_if_flag_is_set(struct net_if *iface,
914 enum net_if_flag value)
915{
916 if (iface == NULL) {
917 return false;
918 }
919
920 NET_ASSERT(iface->if_dev != NULL);
921
922 return atomic_test_bit(iface->if_dev->flags, value);
923}
924
934 struct net_if *iface, enum net_if_oper_state oper_state)
935{
936 if (iface == NULL) {
937 return NET_IF_OPER_UNKNOWN;
938 }
939
940 NET_ASSERT(iface->if_dev != NULL);
941
942 if (oper_state <= NET_IF_OPER_UP) {
943 iface->if_dev->oper_state = oper_state;
944 }
945
946 net_if_lock(iface);
947
948 iface->if_dev->oper_state_change_time = k_uptime_get();
949
950 net_if_unlock(iface);
951
952 return iface->if_dev->oper_state;
953}
954
962static inline enum net_if_oper_state net_if_oper_state(struct net_if *iface)
963{
964 if (iface == NULL) {
965 return NET_IF_OPER_UNKNOWN;
966 }
967
968 NET_ASSERT(iface->if_dev != NULL);
969
970 return iface->if_dev->oper_state;
971}
972
985static inline int net_if_oper_state_change_time(struct net_if *iface,
986 int64_t *change_time)
987{
988 if (iface == NULL || change_time == NULL) {
989 return -EINVAL;
990 }
991
992 NET_ASSERT(iface->if_dev != NULL);
993
994 net_if_lock(iface);
995
996 *change_time = iface->if_dev->oper_state_change_time;
997
998 net_if_unlock(iface);
999
1000 return 0;
1001}
1002
1013 struct net_pkt *pkt, k_timeout_t timeout);
1014
1024static inline enum net_verdict net_if_send_data(struct net_if *iface,
1025 struct net_pkt *pkt)
1026{
1028
1029 return net_if_try_send_data(iface, pkt, timeout);
1030}
1031
1039static inline const struct net_l2 *net_if_l2(struct net_if *iface)
1040{
1041 if (iface == NULL) {
1042 return NULL;
1043 }
1044
1045 NET_ASSERT(iface->if_dev != NULL);
1046
1047 return iface->if_dev->l2;
1048}
1049
1058enum net_verdict net_if_recv_data(struct net_if *iface, struct net_pkt *pkt);
1059
1067static inline void *net_if_l2_data(struct net_if *iface)
1068{
1069 if (iface == NULL) {
1070 return NULL;
1071 }
1072
1073 NET_ASSERT(iface->if_dev != NULL);
1074
1075 return iface->if_dev->l2_data;
1076}
1077
1085static inline const struct device *net_if_get_device(struct net_if *iface)
1086{
1087 if (iface == NULL) {
1088 return NULL;
1089 }
1090
1091 NET_ASSERT(iface->if_dev != NULL);
1092
1093 return iface->if_dev->dev;
1094}
1095
1103void net_if_try_queue_tx(struct net_if *iface, struct net_pkt *pkt, k_timeout_t timeout);
1104
1112static inline void net_if_queue_tx(struct net_if *iface, struct net_pkt *pkt)
1113{
1115
1116 net_if_try_queue_tx(iface, pkt, timeout);
1117}
1118
1126static inline bool net_if_is_ip_offloaded(struct net_if *iface)
1127{
1128#if defined(CONFIG_NET_OFFLOAD)
1129 __ASSERT_NO_MSG(iface == NULL || iface->if_dev != NULL);
1130 return (iface != NULL && iface->if_dev->offload != NULL);
1131#else
1132 ARG_UNUSED(iface);
1133
1134 return false;
1135#endif
1136}
1137
1145bool net_if_is_offloaded(struct net_if *iface);
1146
1154static inline struct net_offload *net_if_offload(struct net_if *iface)
1155{
1156#if defined(CONFIG_NET_OFFLOAD)
1157 if (iface == NULL) {
1158 return NULL;
1159 }
1160
1161 NET_ASSERT(iface->if_dev != NULL);
1162
1163 return iface->if_dev->offload;
1164#else
1165 ARG_UNUSED(iface);
1166
1167 return NULL;
1168#endif
1169}
1170
1177static inline void net_if_offload_set(struct net_if *iface, struct net_offload *offload)
1178{
1179#if defined(CONFIG_NET_OFFLOAD)
1180 if (iface == NULL) {
1181 return;
1182 }
1183
1184 NET_ASSERT(iface->if_dev != NULL);
1185
1186 iface->if_dev->offload = offload;
1187#else
1188 ARG_UNUSED(iface);
1189 ARG_UNUSED(offload);
1190#endif
1191}
1192
1200static inline bool net_if_is_socket_offloaded(struct net_if *iface)
1201{
1202#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
1203 if (iface == NULL) {
1204 return false;
1205 }
1206
1207 NET_ASSERT(iface->if_dev != NULL);
1208
1209 return (iface->if_dev->socket_offload != NULL);
1210#else
1211 ARG_UNUSED(iface);
1212
1213 return false;
1214#endif
1215}
1216
1223static inline void net_if_socket_offload_set(
1224 struct net_if *iface, net_socket_create_t socket_offload)
1225{
1226#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
1227 if (iface == NULL) {
1228 return;
1229 }
1230
1231 NET_ASSERT(iface->if_dev != NULL);
1232
1233 iface->if_dev->socket_offload = socket_offload;
1234#else
1235 ARG_UNUSED(iface);
1236 ARG_UNUSED(socket_offload);
1237#endif
1238}
1239
1248{
1249#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
1250 if (iface == NULL) {
1251 return NULL;
1252 }
1253
1254 NET_ASSERT(iface->if_dev != NULL);
1255
1256 return iface->if_dev->socket_offload;
1257#else
1258 ARG_UNUSED(iface);
1259
1260 return NULL;
1261#endif
1262}
1263
1271static inline struct net_linkaddr *net_if_get_link_addr(struct net_if *iface)
1272{
1273 if (iface == NULL) {
1274 return NULL;
1275 }
1276
1277 NET_ASSERT(iface->if_dev != NULL);
1278
1279 return &iface->if_dev->link_addr;
1280}
1281
1289static inline struct net_if_config *net_if_get_config(struct net_if *iface)
1290{
1291 if (iface == NULL) {
1292 return NULL;
1293 }
1294
1295 return &iface->config;
1296}
1297
1303#if defined(CONFIG_NET_IPV6_DAD) && defined(CONFIG_NET_NATIVE_IPV6)
1304void net_if_start_dad(struct net_if *iface);
1305#else
1306static inline void net_if_start_dad(struct net_if *iface)
1307{
1308 ARG_UNUSED(iface);
1309}
1310#endif
1311
1317void net_if_start_rs(struct net_if *iface);
1318
1319
1325#if defined(CONFIG_NET_IPV6_ND) && defined(CONFIG_NET_NATIVE_IPV6)
1326void net_if_stop_rs(struct net_if *iface);
1327#else
1328static inline void net_if_stop_rs(struct net_if *iface)
1329{
1330 ARG_UNUSED(iface);
1331}
1332#endif /* CONFIG_NET_IPV6_ND */
1333
1346#if defined(CONFIG_NET_IPV6_ND) && defined(CONFIG_NET_NATIVE_IPV6)
1347void net_if_nbr_reachability_hint(struct net_if *iface, const struct net_in6_addr *ipv6_addr);
1348#else
1349static inline void net_if_nbr_reachability_hint(struct net_if *iface,
1350 const struct net_in6_addr *ipv6_addr)
1351{
1352 ARG_UNUSED(iface);
1353 ARG_UNUSED(ipv6_addr);
1354}
1355#endif
1356
1358
1359static inline int net_if_set_link_addr_unlocked(struct net_if *iface,
1360 const uint8_t *addr, uint8_t len,
1361 enum net_link_type type)
1362{
1363 int ret;
1364
1365 if (net_if_flag_is_set(iface, NET_IF_RUNNING)) {
1366 return -EPERM;
1367 }
1368
1369 if (len > sizeof(net_if_get_link_addr(iface)->addr)) {
1370 return -EINVAL;
1371 }
1372
1373 ret = net_linkaddr_create(net_if_get_link_addr(iface), addr, len, type);
1374 if (ret < 0) {
1375 return ret;
1376 }
1377
1378 net_hostname_set_postfix(addr, len);
1379
1380 return 0;
1381}
1382
1383int net_if_set_link_addr_locked(struct net_if *iface,
1384 const uint8_t *addr, uint8_t len,
1385 enum net_link_type type);
1386
1387#if CONFIG_NET_IF_LOG_LEVEL >= LOG_LEVEL_DBG
1388extern int net_if_addr_unref_debug(struct net_if *iface,
1389 net_sa_family_t family,
1390 const void *addr,
1391 struct net_if_addr **ifaddr,
1392 const char *caller, int line);
1393#define net_if_addr_unref(iface, family, addr, ifaddr) \
1394 net_if_addr_unref_debug(iface, family, addr, ifaddr, __func__, __LINE__)
1395
1396extern struct net_if_addr *net_if_addr_ref_debug(struct net_if *iface,
1397 net_sa_family_t family,
1398 const void *addr,
1399 const char *caller,
1400 int line);
1401#define net_if_addr_ref(iface, family, addr) \
1402 net_if_addr_ref_debug(iface, family, addr, __func__, __LINE__)
1403#else
1404extern int net_if_addr_unref(struct net_if *iface,
1405 net_sa_family_t family,
1406 const void *addr,
1407 struct net_if_addr **ifaddr);
1408extern struct net_if_addr *net_if_addr_ref(struct net_if *iface,
1409 net_sa_family_t family,
1410 const void *addr);
1411#endif /* CONFIG_NET_IF_LOG_LEVEL */
1412
1414
1425static inline int net_if_set_link_addr(struct net_if *iface,
1426 const uint8_t *addr, uint8_t len,
1427 enum net_link_type type)
1428{
1429#if defined(CONFIG_NET_RAW_MODE)
1430 return net_if_set_link_addr_unlocked(iface, addr, len, type);
1431#else
1432 return net_if_set_link_addr_locked(iface, addr, len, type);
1433#endif
1434}
1435
1443static inline uint16_t net_if_get_mtu(struct net_if *iface)
1444{
1445 if (iface == NULL) {
1446 return 0U;
1447 }
1448
1449 NET_ASSERT(iface->if_dev != NULL);
1450
1451 return iface->if_dev->mtu;
1452}
1453
1460static inline void net_if_set_mtu(struct net_if *iface,
1461 uint16_t mtu)
1462{
1463 if (iface == NULL) {
1464 return;
1465 }
1466
1467 NET_ASSERT(iface->if_dev != NULL);
1468
1469 iface->if_dev->mtu = mtu;
1470}
1471
1478static inline void net_if_addr_set_lf(struct net_if_addr *ifaddr,
1479 bool is_infinite)
1480{
1481 if (ifaddr == NULL) {
1482 return;
1483 }
1484
1485 ifaddr->is_infinite = is_infinite;
1486}
1487
1496
1504struct net_if *net_if_lookup_by_dev(const struct device *dev);
1505
1513static inline struct net_if_config *net_if_config_get(struct net_if *iface)
1514{
1515 if (iface == NULL) {
1516 return NULL;
1517 }
1518
1519 return &iface->config;
1520}
1521
1527void net_if_router_rm(struct net_if_router *router);
1528
1534void net_if_set_default(struct net_if *iface);
1535
1542
1551struct net_if *net_if_get_first_by_type(const struct net_l2 *l2);
1552
1560
1561#if defined(CONFIG_NET_L2_IEEE802154)
1568static inline struct net_if *net_if_get_ieee802154(void)
1569{
1570 return net_if_get_first_by_type(&NET_L2_GET_NAME(IEEE802154));
1571}
1572#endif /* CONFIG_NET_L2_IEEE802154 */
1573
1585 struct net_if_ipv6 **ipv6);
1586
1595
1596
1598struct net_if_addr *net_if_ipv6_addr_lookup_raw(const uint8_t *addr,
1599 struct net_if **ret);
1601
1611 struct net_if **iface);
1612
1614struct net_if_addr *net_if_ipv6_addr_lookup_by_iface_raw(struct net_if *iface,
1615 const uint8_t *addr);
1617
1627 const struct net_in6_addr *addr);
1628
1637__syscall int net_if_ipv6_addr_lookup_by_index(const struct net_in6_addr *addr);
1638
1650 const struct net_in6_addr *addr,
1652 uint32_t vlifetime);
1653
1664__syscall bool net_if_ipv6_addr_add_by_index(int index,
1665 const struct net_in6_addr *addr,
1667 uint32_t vlifetime);
1668
1676 uint32_t vlifetime);
1677
1686bool net_if_ipv6_addr_rm(struct net_if *iface, const struct net_in6_addr *addr);
1687
1696__syscall bool net_if_ipv6_addr_rm_by_index(int index,
1697 const struct net_in6_addr *addr);
1698
1707typedef void (*net_if_ip_addr_cb_t)(struct net_if *iface,
1708 struct net_if_addr *addr,
1709 void *user_data);
1710
1720 void *user_data);
1721
1731 const struct net_in6_addr *addr);
1732
1741bool net_if_ipv6_maddr_rm(struct net_if *iface, const struct net_in6_addr *addr);
1742
1751typedef void (*net_if_ip_maddr_cb_t)(struct net_if *iface,
1752 struct net_if_mcast_addr *maddr,
1753 void *user_data);
1754
1764 void *user_data);
1765
1766
1768struct net_if_mcast_addr *net_if_ipv6_maddr_lookup_raw(const uint8_t *maddr,
1769 struct net_if **ret);
1771
1783 struct net_if **iface);
1784
1795typedef void (*net_if_mcast_callback_t)(struct net_if *iface,
1796 const struct net_addr *addr,
1797 bool is_joined);
1798
1817
1827 struct net_if *iface,
1829
1836
1844void net_if_mcast_monitor(struct net_if *iface, const struct net_addr *addr,
1845 bool is_joined);
1846
1854 struct net_if_mcast_addr *addr);
1855
1863static inline bool net_if_ipv6_maddr_is_joined(struct net_if_mcast_addr *addr)
1864{
1865 if (addr == NULL) {
1866 return false;
1867 }
1868
1869 return addr->is_joined;
1870}
1871
1879 struct net_if_mcast_addr *addr);
1880
1890 const struct net_in6_addr *addr);
1891
1902 const struct net_in6_addr *addr,
1903 uint8_t len);
1904
1916 const struct net_in6_addr *prefix,
1917 uint8_t len,
1919
1929bool net_if_ipv6_prefix_rm(struct net_if *iface, const struct net_in6_addr *addr,
1930 uint8_t len);
1931
1939 bool is_infinite)
1940{
1941 prefix->is_infinite = is_infinite;
1942}
1943
1952
1959
1970bool net_if_ipv6_addr_onlink(struct net_if **iface, const struct net_in6_addr *addr);
1971
1978#if defined(CONFIG_NET_NATIVE_IPV6)
1979static inline struct net_in6_addr *net_if_router_ipv6(struct net_if_router *router)
1980{
1981 if (router == NULL) {
1982 return NULL;
1983 }
1984
1985 return &router->address.in6_addr;
1986}
1987#else
1988static inline struct net_in6_addr *net_if_router_ipv6(struct net_if_router *router)
1989{
1990 static struct net_in6_addr addr;
1991
1992 ARG_UNUSED(router);
1993
1994 return &addr;
1995}
1996#endif
1997
2008 const struct net_in6_addr *addr);
2009
2020 const struct net_in6_addr *addr);
2021
2030
2042 const struct net_in6_addr *addr,
2043 bool is_default,
2044 uint16_t router_lifetime);
2045
2054
2063#if defined(CONFIG_NET_NATIVE_IPV6)
2065#else
2067{
2068 ARG_UNUSED(iface);
2069
2070 return 0;
2071}
2072#endif /* CONFIG_NET_NATIVE_IPV6 */
2073
2080#if defined(CONFIG_NET_NATIVE_IPV6)
2081void net_if_ipv6_set_hop_limit(struct net_if *iface, uint8_t hop_limit);
2082#else
2083static inline void net_if_ipv6_set_hop_limit(struct net_if *iface,
2084 uint8_t hop_limit)
2085{
2086 ARG_UNUSED(iface);
2087 ARG_UNUSED(hop_limit);
2088}
2089#endif /* CONFIG_NET_NATIVE_IPV6 */
2090
2099#if defined(CONFIG_NET_NATIVE_IPV6)
2101#else
2103{
2104 ARG_UNUSED(iface);
2105
2106 return 0;
2107}
2108#endif /* CONFIG_NET_NATIVE_IPV6 */
2109
2116#if defined(CONFIG_NET_NATIVE_IPV6)
2117void net_if_ipv6_set_mcast_hop_limit(struct net_if *iface, uint8_t hop_limit);
2118#else
2120 uint8_t hop_limit)
2121{
2122 ARG_UNUSED(iface);
2123 ARG_UNUSED(hop_limit);
2124}
2125#endif /* CONFIG_NET_NATIVE_IPV6 */
2126
2134 uint32_t reachable_time)
2135{
2136#if defined(CONFIG_NET_NATIVE_IPV6)
2137 if (iface == NULL) {
2138 return;
2139 }
2140
2141 if (!iface->config.ip.ipv6) {
2142 return;
2143 }
2144
2145 iface->config.ip.ipv6->base_reachable_time = reachable_time;
2146#else
2147 ARG_UNUSED(iface);
2148 ARG_UNUSED(reachable_time);
2149
2150#endif
2151}
2152
2161{
2162#if defined(CONFIG_NET_NATIVE_IPV6)
2163 if (iface == NULL) {
2164 return 0;
2165 }
2166
2167 if (!iface->config.ip.ipv6) {
2168 return 0;
2169 }
2170
2171 return iface->config.ip.ipv6->reachable_time;
2172#else
2173 ARG_UNUSED(iface);
2174 return 0;
2175#endif
2176}
2177
2186
2193static inline void net_if_ipv6_set_reachable_time(struct net_if_ipv6 *ipv6)
2194{
2195#if defined(CONFIG_NET_NATIVE_IPV6)
2196 if (ipv6 == NULL) {
2197 return;
2198 }
2199
2201#else
2202 ARG_UNUSED(ipv6);
2203#endif
2204}
2205
2212static inline void net_if_ipv6_set_retrans_timer(struct net_if *iface,
2213 uint32_t retrans_timer)
2214{
2215#if defined(CONFIG_NET_NATIVE_IPV6)
2216 if (iface == NULL) {
2217 return;
2218 }
2219
2220 if (!iface->config.ip.ipv6) {
2221 return;
2222 }
2223
2224 iface->config.ip.ipv6->retrans_timer = retrans_timer;
2225#else
2226 ARG_UNUSED(iface);
2227 ARG_UNUSED(retrans_timer);
2228#endif
2229}
2230
2239{
2240#if defined(CONFIG_NET_NATIVE_IPV6)
2241 if (iface == NULL) {
2242 return 0;
2243 }
2244
2245 if (!iface->config.ip.ipv6) {
2246 return 0;
2247 }
2248
2249 return iface->config.ip.ipv6->retrans_timer;
2250#else
2251 ARG_UNUSED(iface);
2252 return 0;
2253#endif
2254}
2255
2267#if defined(CONFIG_NET_IPV6)
2268const struct net_in6_addr *net_if_ipv6_select_src_addr(struct net_if *iface,
2269 const struct net_in6_addr *dst);
2270#else
2271static inline const struct net_in6_addr *net_if_ipv6_select_src_addr(
2272 struct net_if *iface, const struct net_in6_addr *dst)
2273{
2274 ARG_UNUSED(iface);
2275 ARG_UNUSED(dst);
2276
2277 return NULL;
2278}
2279#endif
2280
2294#if defined(CONFIG_NET_IPV6)
2295const struct net_in6_addr *net_if_ipv6_select_src_addr_hint(struct net_if *iface,
2296 const struct net_in6_addr *dst,
2297 int flags);
2298#else
2300 struct net_if *iface, const struct net_in6_addr *dst, int flags)
2301{
2302 ARG_UNUSED(iface);
2303 ARG_UNUSED(dst);
2304 ARG_UNUSED(flags);
2305
2306 return NULL;
2307}
2308#endif
2309
2319#if defined(CONFIG_NET_IPV6)
2320struct net_if *net_if_ipv6_select_src_iface(const struct net_in6_addr *dst);
2321#else
2323 const struct net_in6_addr *dst)
2324{
2325 ARG_UNUSED(dst);
2326
2327 return NULL;
2328}
2329#endif
2330
2343#if defined(CONFIG_NET_IPV6)
2344struct net_if *net_if_ipv6_select_src_iface_addr(const struct net_in6_addr *dst,
2345 const struct net_in6_addr **src_addr);
2346#else
2348 const struct net_in6_addr *dst, const struct net_in6_addr **src_addr)
2349{
2350 ARG_UNUSED(dst);
2351 ARG_UNUSED(src_addr);
2352
2353 return NULL;
2354}
2355#endif /* CONFIG_NET_IPV6 */
2356
2367 enum net_addr_state addr_state);
2368
2379 struct net_if **iface);
2380
2388void net_if_ipv6_dad_failed(struct net_if *iface, const struct net_in6_addr *addr);
2389
2402 struct net_if **iface);
2403
2415 struct net_if_ipv4 **ipv4);
2416
2425
2434
2441void net_if_ipv4_set_ttl(struct net_if *iface, uint8_t ttl);
2442
2451
2459
2469 struct net_if **iface);
2470
2482 const struct net_in_addr *addr,
2484 uint32_t vlifetime);
2485
2494bool net_if_ipv4_addr_rm(struct net_if *iface, const struct net_in_addr *addr);
2495
2504__syscall int net_if_ipv4_addr_lookup_by_index(const struct net_in_addr *addr);
2505
2516__syscall bool net_if_ipv4_addr_add_by_index(int index,
2517 const struct net_in_addr *addr,
2519 uint32_t vlifetime);
2520
2529__syscall bool net_if_ipv4_addr_rm_by_index(int index,
2530 const struct net_in_addr *addr);
2531
2541 void *user_data);
2542
2552 const struct net_in_addr *addr);
2553
2562bool net_if_ipv4_maddr_rm(struct net_if *iface, const struct net_in_addr *addr);
2563
2573 void *user_data);
2574
2586 struct net_if **iface);
2587
2595 struct net_if_mcast_addr *addr);
2596
2604static inline bool net_if_ipv4_maddr_is_joined(struct net_if_mcast_addr *addr)
2605{
2606 if (addr == NULL) {
2607 return false;
2608 }
2609
2610 return addr->is_joined;
2611}
2612
2620 struct net_if_mcast_addr *addr);
2621
2628#if defined(CONFIG_NET_NATIVE_IPV4)
2629static inline struct net_in_addr *net_if_router_ipv4(struct net_if_router *router)
2630{
2631 if (router == NULL) {
2632 return NULL;
2633 }
2634
2635 return &router->address.in_addr;
2636}
2637#else
2638static inline struct net_in_addr *net_if_router_ipv4(struct net_if_router *router)
2639{
2640 static struct net_in_addr addr;
2641
2642 ARG_UNUSED(router);
2643
2644 return &addr;
2645}
2646#endif
2647
2658 const struct net_in_addr *addr);
2659
2670 const struct net_in_addr *addr);
2682 const struct net_in_addr *addr,
2683 bool is_default,
2684 uint16_t router_lifetime);
2685
2694
2704 const struct net_in_addr *addr);
2705
2715 const struct net_in_addr *addr);
2716
2726#if defined(CONFIG_NET_IPV4)
2727struct net_if *net_if_ipv4_select_src_iface(const struct net_in_addr *dst);
2728#else
2730 const struct net_in_addr *dst)
2731{
2732 ARG_UNUSED(dst);
2733
2734 return NULL;
2735}
2736#endif
2737
2750#if defined(CONFIG_NET_IPV4)
2751struct net_if *net_if_ipv4_select_src_iface_addr(const struct net_in_addr *dst,
2752 const struct net_in_addr **src_addr);
2753#else
2755 const struct net_in_addr *dst, const struct net_in_addr **src_addr)
2756{
2757 ARG_UNUSED(dst);
2758 ARG_UNUSED(src_addr);
2759
2760 return NULL;
2761}
2762#endif /* CONFIG_NET_IPV4 */
2763
2775#if defined(CONFIG_NET_IPV4)
2776const struct net_in_addr *net_if_ipv4_select_src_addr(struct net_if *iface,
2777 const struct net_in_addr *dst);
2778#else
2779static inline const struct net_in_addr *net_if_ipv4_select_src_addr(
2780 struct net_if *iface, const struct net_in_addr *dst)
2781{
2782 ARG_UNUSED(iface);
2783 ARG_UNUSED(dst);
2784
2785 return NULL;
2786}
2787#endif
2788
2799 enum net_addr_state addr_state);
2800
2811 enum net_addr_state addr_state);
2812
2823 const struct net_in_addr *addr);
2824
2835 const struct net_in_addr *addr,
2836 const struct net_in_addr *netmask);
2837
2848 const struct net_in_addr *addr,
2849 const struct net_in_addr *netmask);
2850
2859
2866void net_if_ipv4_set_gw(struct net_if *iface, const struct net_in_addr *gw);
2867
2876__syscall bool net_if_ipv4_set_gw_by_index(int index, const struct net_in_addr *gw);
2877
2889
2898typedef void (*net_if_link_callback_t)(struct net_if *iface,
2899 struct net_linkaddr *dst,
2900 int status);
2901
2917
2926
2933
2941void net_if_call_link_cb(struct net_if *iface, struct net_linkaddr *lladdr,
2942 int status);
2943
2945
2946/* used to ensure encoding of checksum support in net_if.h and
2947 * ethernet.h is the same
2948 */
2949#define NET_IF_CHECKSUM_NONE_BIT 0
2950#define NET_IF_CHECKSUM_IPV4_HEADER_BIT BIT(0)
2951#define NET_IF_CHECKSUM_IPV4_ICMP_BIT BIT(1)
2952/* Space for future protocols and restrictions for IPV4 */
2953#define NET_IF_CHECKSUM_IPV6_HEADER_BIT BIT(10)
2954#define NET_IF_CHECKSUM_IPV6_ICMP_BIT BIT(11)
2955/* Space for future protocols and restrictions for IPV6 */
2956#define NET_IF_CHECKSUM_TCP_BIT BIT(21)
2957#define NET_IF_CHECKSUM_UDP_BIT BIT(22)
2958
2960
2966 NET_IF_CHECKSUM_IPV4_HEADER = NET_IF_CHECKSUM_IPV4_HEADER_BIT,
2968 NET_IF_CHECKSUM_IPV4_TCP = NET_IF_CHECKSUM_IPV4_HEADER_BIT |
2969 NET_IF_CHECKSUM_TCP_BIT,
2971 NET_IF_CHECKSUM_IPV4_UDP = NET_IF_CHECKSUM_IPV4_HEADER_BIT |
2972 NET_IF_CHECKSUM_UDP_BIT,
2974 NET_IF_CHECKSUM_IPV4_ICMP = NET_IF_CHECKSUM_IPV4_ICMP_BIT,
2976 NET_IF_CHECKSUM_IPV6_HEADER = NET_IF_CHECKSUM_IPV6_HEADER_BIT,
2978 NET_IF_CHECKSUM_IPV6_TCP = NET_IF_CHECKSUM_IPV6_HEADER_BIT |
2979 NET_IF_CHECKSUM_TCP_BIT,
2981 NET_IF_CHECKSUM_IPV6_UDP = NET_IF_CHECKSUM_IPV6_HEADER_BIT |
2982 NET_IF_CHECKSUM_UDP_BIT,
2984 NET_IF_CHECKSUM_IPV6_ICMP = NET_IF_CHECKSUM_IPV6_ICMP_BIT
2985};
2986
2997#if defined(CONFIG_NET_CHECKSUM_OFFLOAD)
2998bool net_if_need_calc_rx_checksum(struct net_if *iface,
2999 enum net_if_checksum_type chksum_type);
3000#else /* CONFIG_NET_CHECKSUM_OFFLOAD */
3001static inline bool net_if_need_calc_rx_checksum(struct net_if *iface,
3002 enum net_if_checksum_type chksum_type)
3003{
3004 ARG_UNUSED(iface);
3005 ARG_UNUSED(chksum_type);
3006 return true;
3007}
3008#endif /* CONFIG_NET_CHECKSUM_OFFLOAD */
3009
3021#if defined(CONFIG_NET_CHECKSUM_OFFLOAD)
3022bool net_if_need_calc_tx_checksum(struct net_if *iface,
3023 enum net_if_checksum_type chksum_type);
3024#else /* CONFIG_NET_CHECKSUM_OFFLOAD */
3025static inline bool net_if_need_calc_tx_checksum(struct net_if *iface,
3026 enum net_if_checksum_type chksum_type)
3027{
3028 ARG_UNUSED(iface);
3029 ARG_UNUSED(chksum_type);
3030 return true;
3031}
3032#endif /* CONFIG_NET_CHECKSUM_OFFLOAD */
3033
3044__syscall struct net_if *net_if_get_by_index(int index);
3045
3053int net_if_get_by_iface(struct net_if *iface);
3054
3062typedef void (*net_if_cb_t)(struct net_if *iface, void *user_data);
3063
3071void net_if_foreach(net_if_cb_t cb, void *user_data);
3072
3080int net_if_up(struct net_if *iface);
3081
3089static inline bool net_if_is_up(struct net_if *iface)
3090{
3091 if (iface == NULL) {
3092 return false;
3093 }
3094
3095 return net_if_flag_is_set(iface, NET_IF_UP) &&
3097}
3098
3106int net_if_down(struct net_if *iface);
3107
3115static inline bool net_if_is_admin_up(struct net_if *iface)
3116{
3117 if (iface == NULL) {
3118 return false;
3119 }
3120
3121 return net_if_flag_is_set(iface, NET_IF_UP);
3122}
3123
3132void net_if_carrier_on(struct net_if *iface);
3133
3142void net_if_carrier_off(struct net_if *iface);
3143
3151static inline bool net_if_is_carrier_ok(struct net_if *iface)
3152{
3153 if (iface == NULL) {
3154 return false;
3155 }
3156
3157 return net_if_flag_is_set(iface, NET_IF_LOWER_UP);
3158}
3159
3170void net_if_dormant_on(struct net_if *iface);
3171
3180void net_if_dormant_off(struct net_if *iface);
3181
3189static inline bool net_if_is_dormant(struct net_if *iface)
3190{
3191 if (iface == NULL) {
3192 return false;
3193 }
3194
3195 return net_if_flag_is_set(iface, NET_IF_DORMANT);
3196}
3197
3198#if defined(CONFIG_NET_PKT_TIMESTAMP_THREAD) || defined(__DOXYGEN__)
3206typedef void (*net_if_timestamp_callback_t)(struct net_pkt *pkt);
3207
3233
3245 struct net_pkt *pkt,
3246 struct net_if *iface,
3248
3255
3262
3263/*
3264 * @brief Add timestamped TX buffer to be handled
3265 *
3266 * @param pkt Timestamped buffer
3267 */
3269#endif /* CONFIG_NET_PKT_TIMESTAMP_THREAD */
3270
3280#if defined(CONFIG_NET_PROMISCUOUS_MODE)
3281int net_if_set_promisc(struct net_if *iface);
3282#else
3283static inline int net_if_set_promisc(struct net_if *iface)
3284{
3285 ARG_UNUSED(iface);
3286
3287 return -ENOTSUP;
3288}
3289#endif
3290
3296#if defined(CONFIG_NET_PROMISCUOUS_MODE)
3297void net_if_unset_promisc(struct net_if *iface);
3298#else
3299static inline void net_if_unset_promisc(struct net_if *iface)
3300{
3301 ARG_UNUSED(iface);
3302}
3303#endif
3304
3313#if defined(CONFIG_NET_PROMISCUOUS_MODE)
3314bool net_if_is_promisc(struct net_if *iface);
3315#else
3316static inline bool net_if_is_promisc(struct net_if *iface)
3317{
3318 ARG_UNUSED(iface);
3319
3320 return false;
3321}
3322#endif
3323
3333static inline bool net_if_are_pending_tx_packets(struct net_if *iface)
3334{
3335#if defined(CONFIG_NET_POWER_MANAGEMENT)
3336 return !!iface->tx_pending;
3337#else
3338 ARG_UNUSED(iface);
3339
3340 return false;
3341#endif
3342}
3343
3344#ifdef CONFIG_NET_POWER_MANAGEMENT
3352int net_if_suspend(struct net_if *iface);
3353
3361int net_if_resume(struct net_if *iface);
3362
3370bool net_if_is_suspended(struct net_if *iface);
3371#endif /* CONFIG_NET_POWER_MANAGEMENT */
3372
3380bool net_if_is_ethernet(struct net_if *iface);
3381
3388
3396bool net_if_is_wifi(struct net_if *iface);
3397
3404
3411
3418
3433int net_if_get_name(struct net_if *iface, char *buf, int len);
3434
3449int net_if_set_name(struct net_if *iface, const char *buf);
3450
3458int net_if_get_by_name(const char *name);
3459
3461struct net_if_api {
3462 void (*init)(struct net_if *iface);
3463};
3464
3465#define NET_IF_DHCPV4_INIT \
3466 IF_ENABLED(UTIL_AND(IS_ENABLED(CONFIG_NET_DHCPV4), \
3467 IS_ENABLED(CONFIG_NET_NATIVE_IPV4)), \
3468 (.dhcpv4.state = NET_DHCPV4_DISABLED,))
3469
3470#define NET_IF_DHCPV6_INIT \
3471 IF_ENABLED(UTIL_AND(IS_ENABLED(CONFIG_NET_DHCPV6), \
3472 IS_ENABLED(CONFIG_NET_NATIVE_IPV6)), \
3473 (.dhcpv6.state = NET_DHCPV6_DISABLED,))
3474
3475#define NET_IF_CONFIG_INIT \
3476 .config = { \
3477 IF_ENABLED(CONFIG_NET_IP, (.ip = {},)) \
3478 NET_IF_DHCPV4_INIT \
3479 NET_IF_DHCPV6_INIT \
3480 }
3481
3482#define NET_PROMETHEUS_GET_COLLECTOR_NAME(dev_id, sfx) \
3483 net_stats_##dev_id##_##sfx##_collector
3484#define NET_PROMETHEUS_INIT(dev_id, sfx) \
3485 IF_ENABLED(CONFIG_NET_STATISTICS_VIA_PROMETHEUS, \
3486 (.collector = &NET_PROMETHEUS_GET_COLLECTOR_NAME(dev_id, sfx),))
3487
3488#define NET_IF_GET_NAME(dev_id, sfx) __net_if_##dev_id##_##sfx
3489#define NET_IF_DEV_GET_NAME(dev_id, sfx) __net_if_dev_##dev_id##_##sfx
3490
3491#define NET_IF_GET(dev_id, sfx) \
3492 ((struct net_if *)&NET_IF_GET_NAME(dev_id, sfx))
3493
3494#if defined(CONFIG_NET_STATISTICS_VIA_PROMETHEUS)
3495extern int net_stats_prometheus_scrape(struct prometheus_collector *collector,
3496 struct prometheus_metric *metric,
3497 void *user_data);
3498#endif /* CONFIG_NET_STATISTICS_VIA_PROMETHEUS */
3499
3500#define NET_IF_INIT(dev_id, sfx, _l2, _mtu) \
3501 static STRUCT_SECTION_ITERABLE(net_if_dev, \
3502 NET_IF_DEV_GET_NAME(dev_id, sfx)) = { \
3503 .dev = &(DEVICE_NAME_GET(dev_id)), \
3504 .l2 = &(NET_L2_GET_NAME(_l2)), \
3505 .l2_data = &(NET_L2_GET_DATA(dev_id, sfx)), \
3506 .mtu = _mtu, \
3507 .flags = {BIT(NET_IF_LOWER_UP)}, \
3508 }; \
3509 static STRUCT_SECTION_ITERABLE(net_if, \
3510 NET_IF_GET_NAME(dev_id, sfx)) = { \
3511 .if_dev = &(NET_IF_DEV_GET_NAME(dev_id, sfx)), \
3512 NET_IF_CONFIG_INIT \
3513 }; \
3514 IF_ENABLED(CONFIG_NET_STATISTICS_VIA_PROMETHEUS, \
3515 (static PROMETHEUS_COLLECTOR_DEFINE( \
3516 NET_PROMETHEUS_GET_COLLECTOR_NAME(dev_id, \
3517 sfx), \
3518 net_stats_prometheus_scrape, \
3519 NET_IF_GET(dev_id, sfx)); \
3520 NET_STATS_PROMETHEUS(NET_IF_GET(dev_id, sfx), \
3521 dev_id, sfx);))
3522
3523#define NET_IF_OFFLOAD_INIT(dev_id, sfx, _mtu) \
3524 static STRUCT_SECTION_ITERABLE(net_if_dev, \
3525 NET_IF_DEV_GET_NAME(dev_id, sfx)) = { \
3526 .dev = &(DEVICE_NAME_GET(dev_id)), \
3527 .mtu = _mtu, \
3528 .l2 = &(NET_L2_GET_NAME(OFFLOADED_NETDEV)), \
3529 .flags = {BIT(NET_IF_LOWER_UP)}, \
3530 }; \
3531 static STRUCT_SECTION_ITERABLE(net_if, \
3532 NET_IF_GET_NAME(dev_id, sfx)) = { \
3533 .if_dev = &(NET_IF_DEV_GET_NAME(dev_id, sfx)), \
3534 NET_IF_CONFIG_INIT \
3535 }; \
3536 IF_ENABLED(CONFIG_NET_STATISTICS_VIA_PROMETHEUS, \
3537 (static PROMETHEUS_COLLECTOR_DEFINE( \
3538 NET_PROMETHEUS_GET_COLLECTOR_NAME(dev_id, \
3539 sfx), \
3540 net_stats_prometheus_scrape, \
3541 NET_IF_GET(dev_id, sfx)); \
3542 NET_STATS_PROMETHEUS(NET_IF_GET(dev_id, sfx), \
3543 dev_id, sfx);))
3544
3545
3547
3548/* Network device initialization macros */
3549
3557#define NET_IF_DECLARE(dev_id, inst) \
3558 static struct net_if NET_IF_GET_NAME(dev_id, inst)
3559
3560#define Z_NET_DEVICE_IF_INIT_INSTANCE(dev_id, instance, l2, \
3561 l2_ctx_type, mtu) \
3562 NET_L2_DATA_INIT(dev_id, instance, l2_ctx_type); \
3563 NET_IF_INIT(dev_id, instance, l2, mtu)
3564
3565#define Z_NET_DEVICE_INIT_INSTANCE(node_id, dev_id, name, instance, \
3566 init_fn, pm, data, config, prio, \
3567 api, l2, l2_ctx_type, mtu) \
3568 Z_DEVICE_STATE_DEFINE(dev_id); \
3569 Z_DEVICE_DEFINE(node_id, dev_id, name, init_fn, NULL, \
3570 Z_DEVICE_DT_FLAGS(node_id), pm, data, \
3571 config, POST_KERNEL, prio, api, \
3572 &Z_DEVICE_STATE_NAME(dev_id)); \
3573 Z_NET_DEVICE_IF_INIT_INSTANCE(dev_id, instance, l2, \
3574 l2_ctx_type, mtu)
3575
3576#define Z_NET_DEVICE_INIT(node_id, dev_id, name, init_fn, pm, data, \
3577 config, prio, api, l2, l2_ctx_type, mtu) \
3578 Z_NET_DEVICE_INIT_INSTANCE(node_id, dev_id, name, 0, init_fn, \
3579 pm, data, config, prio, api, l2, \
3580 l2_ctx_type, mtu)
3581
3588#define NET_IF_DT_DECLARE(node_id, instance) \
3589 NET_IF_DECLARE(Z_DEVICE_DT_DEV_ID(node_id), instance)
3590
3598#define NET_IF_DT_INST_DECLARE(inst, ...) NET_IF_DT_DECLARE(DT_DRV_INST(inst), __VA_ARGS__)
3599
3607#define NET_IF_DT_GET(node_id, instance) NET_IF_GET(Z_DEVICE_DT_DEV_ID(node_id), instance)
3608
3617#define NET_IF_DT_INST_GET(inst, ...) NET_IF_DT_GET(DT_DRV_INST(inst), __VA_ARGS__)
3618
3638#define NET_DEVICE_INIT(dev_id, name, init_fn, pm, data, config, prio, \
3639 api, l2, l2_ctx_type, mtu) \
3640 Z_NET_DEVICE_INIT(DT_INVALID_NODE, dev_id, name, init_fn, pm, \
3641 data, config, prio, api, l2, l2_ctx_type, mtu)
3642
3654#define NET_DEVICE_DT_ADD_IFACE(node_id, l2, l2_ctx_type, mtu, instance) \
3655 Z_NET_DEVICE_IF_INIT_INSTANCE(Z_DEVICE_DT_DEV_ID(node_id), instance, l2, l2_ctx_type, mtu)
3656
3665#define NET_DEVICE_DT_INST_ADD_IFACE(inst, ...) \
3666 NET_DEVICE_DT_ADD_IFACE(DT_DRV_INST(inst), __VA_ARGS__)
3667
3686#define NET_DEVICE_DT_DEFINE(node_id, init_fn, pm, data, \
3687 config, prio, api, l2, l2_ctx_type, mtu) \
3688 Z_NET_DEVICE_INIT(node_id, Z_DEVICE_DT_DEV_ID(node_id), \
3689 DEVICE_DT_NAME(node_id), init_fn, pm, data, \
3690 config, prio, api, l2, l2_ctx_type, mtu)
3691
3700#define NET_DEVICE_DT_INST_DEFINE(inst, ...) \
3701 NET_DEVICE_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
3702
3726#define NET_DEVICE_INIT_INSTANCE(dev_id, name, instance, init_fn, pm, \
3727 data, config, prio, api, l2, \
3728 l2_ctx_type, mtu) \
3729 Z_NET_DEVICE_INIT_INSTANCE(DT_INVALID_NODE, dev_id, name, \
3730 instance, init_fn, pm, data, config, \
3731 prio, api, l2, l2_ctx_type, mtu)
3732
3755#define NET_DEVICE_DT_DEFINE_INSTANCE(node_id, instance, init_fn, pm, \
3756 data, config, prio, api, l2, \
3757 l2_ctx_type, mtu) \
3758 Z_NET_DEVICE_INIT_INSTANCE(node_id, \
3759 Z_DEVICE_DT_DEV_ID(node_id), \
3760 DEVICE_DT_NAME(node_id), instance, \
3761 init_fn, pm, data, config, prio, \
3762 api, l2, l2_ctx_type, mtu)
3763
3773#define NET_DEVICE_DT_INST_DEFINE_INSTANCE(inst, ...) \
3774 NET_DEVICE_DT_DEFINE_INSTANCE(DT_DRV_INST(inst), __VA_ARGS__)
3775
3776#define Z_NET_DEVICE_OFFLOAD_INIT(node_id, dev_id, name, init_fn, pm, \
3777 data, config, prio, api, mtu) \
3778 Z_DEVICE_STATE_DEFINE(dev_id); \
3779 Z_DEVICE_DEFINE(node_id, dev_id, name, init_fn, NULL, \
3780 Z_DEVICE_DT_FLAGS(node_id), pm, data, \
3781 config, POST_KERNEL, prio, api, \
3782 &Z_DEVICE_STATE_NAME(dev_id)); \
3783 NET_IF_OFFLOAD_INIT(dev_id, 0, mtu)
3784
3804#define NET_DEVICE_OFFLOAD_INIT(dev_id, name, init_fn, pm, data, \
3805 config, prio, api, mtu) \
3806 Z_NET_DEVICE_OFFLOAD_INIT(DT_INVALID_NODE, dev_id, name, \
3807 init_fn, pm, data, config, prio, api, \
3808 mtu)
3809
3828#define NET_DEVICE_DT_OFFLOAD_DEFINE(node_id, init_fn, pm, data, \
3829 config, prio, api, mtu) \
3830 Z_NET_DEVICE_OFFLOAD_INIT(node_id, Z_DEVICE_DT_DEV_ID(node_id), \
3831 DEVICE_DT_NAME(node_id), init_fn, pm, \
3832 data, config, prio, api, mtu)
3833
3843#define NET_DEVICE_DT_INST_OFFLOAD_DEFINE(inst, ...) \
3844 NET_DEVICE_DT_OFFLOAD_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
3845
3851#define NET_IFACE_COUNT(_dst) \
3852 do { \
3853 extern struct net_if _net_if_list_start[]; \
3854 extern struct net_if _net_if_list_end[]; \
3855 *(_dst) = ((uintptr_t)_net_if_list_end - \
3856 (uintptr_t)_net_if_list_start) / \
3857 sizeof(struct net_if); \
3858 } while (0)
3859
3860#ifdef __cplusplus
3861}
3862#endif
3863
3864#include <zephyr/syscalls/net_if.h>
3865
3869
3870#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 _Bool atomic_test_and_set_bit(atomic_t *target, int bit)
Atomically set a bit and test it.
Definition atomic.h:172
static _Bool atomic_test_bit(const atomic_t *target, int bit)
Atomically get and test a bit.
Definition atomic.h:129
static void atomic_set_bit(atomic_t *target, int bit)
Atomically set a bit.
Definition atomic.h:211
static void atomic_clear_bit(atomic_t *target, int bit)
Atomically clear a bit.
Definition atomic.h:193
#define ATOMIC_DEFINE(name, num_bits)
Define an array of atomic variables.
Definition atomic.h:113
static _Bool atomic_test_and_clear_bit(atomic_t *target, int bit)
Atomically clear a bit and test it.
Definition atomic.h:149
#define K_FOREVER
Generate infinite timeout delay.
Definition kernel.h:1664
#define K_NO_WAIT
Generate null timeout delay.
Definition kernel.h:1554
static int64_t k_uptime_get(void)
Get system uptime.
Definition kernel.h:2147
net_addr_state
What is the current state of the network address.
Definition net_ip.h:577
unsigned short int net_sa_family_t
Socket address family type.
Definition net_ip.h:169
net_addr_type
How the network address is assigned to network interface.
Definition net_ip.h:585
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:84
static int net_hostname_set_postfix(const uint8_t *hostname_postfix, int postfix_len)
Set the device hostname postfix.
Definition hostname.h:118
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.
int net_if_set_name(struct net_if *iface, const char *buf)
Set network interface name.
struct net_if_router * net_if_ipv4_router_add(struct net_if *iface, const struct net_in_addr *addr, bool is_default, uint16_t router_lifetime)
Add IPv4 router to the system.
void net_if_ipv4_set_gw(struct net_if *iface, const struct net_in_addr *gw)
Set IPv4 gateway for an interface.
static bool net_if_is_carrier_ok(struct net_if *iface)
Check if carrier is present on network device.
Definition net_if.h:3151
static bool net_if_is_admin_up(struct net_if *iface)
Check if interface was brought up by the administrator.
Definition net_if.h:3115
void net_if_set_default(struct net_if *iface)
Set the default network interface.
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:1795
static 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.
Definition net_if.h:3025
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:2898
struct net_if * net_if_get_wifi_sta(void)
Get Wi-Fi network station interface.
struct net_in_addr net_if_ipv4_get_gw(struct net_if *iface)
Get IPv4 gateway of an interface.
void net_if_add_tx_timestamp(struct net_pkt *pkt)
void net_if_ipv4_maddr_leave(struct net_if *iface, struct net_if_mcast_addr *addr)
Mark a given multicast address to be left.
struct net_if_mcast_addr * net_if_ipv6_maddr_add(struct net_if *iface, const struct net_in6_addr *addr)
Add a IPv6 multicast address to an interface.
int net_if_get_by_name(const char *name)
Get interface index according to its name.
static struct net_in6_addr * net_if_router_ipv6(struct net_if_router *router)
Get the IPv6 address of the given router.
Definition net_if.h:1988
void net_if_register_timestamp_cb(struct net_if_timestamp_cb *handle, struct net_pkt *pkt, struct net_if *iface, net_if_timestamp_callback_t cb)
Register a timestamp callback.
struct net_if * net_if_get_by_link_addr(struct net_linkaddr *ll_addr)
Get an interface according to link layer address.
bool net_if_ipv4_addr_rm_by_index(int index, const struct net_in_addr *addr)
Remove a IPv4 address from an interface by interface index.
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.
static struct net_if * net_if_ipv4_select_src_iface(const struct net_in_addr *dst)
Get a network interface that should be used when sending IPv4 network data to destination.
Definition net_if.h:2729
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:933
int net_if_down(struct net_if *iface)
Bring interface down.
struct net_if_ipv6_prefix * net_if_ipv6_prefix_add(struct net_if *iface, const struct net_in6_addr *prefix, uint8_t len, uint32_t lifetime)
Add a IPv6 prefix to an network interface.
bool net_if_ipv4_addr_rm(struct net_if *iface, const struct net_in_addr *addr)
Remove a IPv4 address from an interface.
static struct net_if * net_if_ipv4_select_src_iface_addr(const struct net_in_addr *dst, const struct net_in_addr **src_addr)
Get a network interface that should be used when sending IPv4 network data to destination.
Definition net_if.h:2754
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:1112
void net_if_ipv6_prefix_unset_timer(struct net_if_ipv6_prefix *prefix)
Unset the prefix lifetime timer.
bool net_if_ipv4_addr_add_by_index(int index, const struct net_in_addr *addr, enum net_addr_type addr_type, uint32_t vlifetime)
Add a IPv4 address to an interface by network interface index.
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.
static struct net_if * net_if_ipv6_select_src_iface(const struct net_in6_addr *dst)
Get a network interface that should be used when sending IPv6 network data to destination.
Definition net_if.h:2322
void net_if_mcast_monitor(struct net_if *iface, const struct net_addr *addr, bool is_joined)
Call registered multicast monitors.
static int net_if_set_link_addr(struct net_if *iface, const uint8_t *addr, uint8_t len, enum net_link_type type)
Set a network interface's link address.
Definition net_if.h:1425
struct net_if_addr * net_if_ipv6_addr_add(struct net_if *iface, const struct net_in6_addr *addr, enum net_addr_type addr_type, uint32_t vlifetime)
Add a IPv6 address to an interface.
static void * net_if_l2_data(struct net_if *iface)
Get a pointer to the interface L2 private data.
Definition net_if.h:1067
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:3333
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:855
struct net_if_addr * net_if_ipv6_addr_lookup(const struct net_in6_addr *addr, struct net_if **iface)
Check if this IPv6 address belongs to one of the interfaces.
bool net_if_ipv4_is_addr_bcast(struct net_if *iface, const struct net_in_addr *addr)
Check if the given IPv4 address is a broadcast address.
static struct net_linkaddr * net_if_get_link_addr(struct net_if *iface)
Get an network interface's link address.
Definition net_if.h:1271
void net_if_ipv6_maddr_join(struct net_if *iface, struct net_if_mcast_addr *addr)
Mark a given multicast address to be joined.
struct net_if_router * net_if_ipv4_router_lookup(struct net_if *iface, const struct net_in_addr *addr)
Check if IPv4 address is one of the routers configured in the system.
bool net_if_ipv6_prefix_rm(struct net_if *iface, const struct net_in6_addr *addr, uint8_t len)
Remove an IPv6 prefix from an interface.
static struct net_in_addr * net_if_router_ipv4(struct net_if_router *router)
Get the IPv4 address of the given router.
Definition net_if.h:2638
static struct net_offload * net_if_offload(struct net_if *iface)
Return the IP offload plugin.
Definition net_if.h:1154
struct net_if * net_if_get_first_ethernet(void)
Get first Cabled Ethernet network interface.
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:835
bool net_if_ipv6_addr_onlink(struct net_if **iface, const struct net_in6_addr *addr)
Check if this IPv6 address is part of the subnet of our network interface.
struct net_if_addr * net_if_ipv4_addr_lookup(const struct net_in_addr *addr, struct net_if **iface)
Check if this IPv4 address belongs to one of the interfaces.
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.
static const struct net_in6_addr * net_if_ipv6_select_src_addr_hint(struct net_if *iface, const struct net_in6_addr *dst, int flags)
Get a IPv6 source address that should be used when sending network data to destination.
Definition net_if.h:2299
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:2102
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:2083
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.
static const struct net_in6_addr * net_if_ipv6_select_src_addr(struct net_if *iface, const struct net_in6_addr *dst)
Get a IPv6 source address that should be used when sending network data to destination.
Definition net_if.h:2271
static void net_if_nbr_reachability_hint(struct net_if *iface, const struct net_in6_addr *ipv6_addr)
Provide a reachability hint for IPv6 Neighbor Discovery.
Definition net_if.h:1349
void(* net_if_timestamp_callback_t)(struct net_pkt *pkt)
Define callback that is called after a network packet has been timestamped.
Definition net_if.h:3206
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:2066
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:1126
bool net_if_ipv6_maddr_rm(struct net_if *iface, const struct net_in6_addr *addr)
Remove an IPv6 multicast address from an interface.
static bool net_if_is_dormant(struct net_if *iface)
Check if the interface is dormant.
Definition net_if.h:3189
struct net_if * net_if_get_first_wifi(void)
Get first Wi-Fi network interface.
struct net_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.
bool net_if_is_ethernet(struct net_if *iface)
Check if the network interface is cabled ethernet.
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_mcast_addr * net_if_ipv4_maddr_add(struct net_if *iface, const struct net_in_addr *addr)
Add a IPv4 multicast address to an 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:1751
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.
struct net_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.
static void net_if_set_mtu(struct net_if *iface, uint16_t mtu)
Set an network interface's MTU.
Definition net_if.h:1460
struct net_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.
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:3089
struct net_if_addr * net_if_ipv4_addr_add(struct net_if *iface, const struct net_in_addr *addr, enum net_addr_type addr_type, uint32_t vlifetime)
Add a IPv4 address to an interface.
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:2193
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:1024
bool net_if_ipv4_set_gw_by_index(int index, const struct net_in_addr *gw)
Set IPv4 gateway for an interface index.
int net_if_config_ipv4_put(struct net_if *iface)
Release network interface IPv4 config.
void net_if_dormant_on(struct net_if *iface)
Mark interface as dormant.
struct net_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_ipv6_put(struct net_if *iface)
Release network interface IPv6 config.
static struct net_if * net_if_ipv6_select_src_iface_addr(const struct net_in6_addr *dst, const struct net_in6_addr **src_addr)
Get a network interface that should be used when sending IPv6 network data to destination.
Definition net_if.h:2347
struct net_if_router * net_if_ipv6_router_add(struct net_if *iface, const struct net_in6_addr *addr, bool is_default, uint16_t router_lifetime)
Add IPv6 router to the system.
net_if_checksum_type
Type of checksum for which support in the interface will be queried.
Definition net_if.h:2964
void net_if_ipv6_dad_failed(struct net_if *iface, const struct net_in6_addr *addr)
Stop IPv6 Duplicate Address Detection (DAD) procedure if we find out that our IPv6 address is already...
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.
bool net_if_ipv4_addr_mask_cmp(struct net_if *iface, const struct net_in_addr *addr)
Check if the given IPv4 address belongs to local subnet.
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.
static void net_if_start_dad(struct net_if *iface)
Start duplicate address detection procedure.
Definition net_if.h:1306
void net_if_foreach(net_if_cb_t cb, void *user_data)
Go through all the network interfaces and call callback for each interface.
struct net_if_ipv6_prefix * net_if_ipv6_prefix_lookup(struct net_if *iface, const struct net_in6_addr *addr, uint8_t len)
Check if this IPv6 prefix belongs to this interface.
struct net_if_ipv6_prefix * net_if_ipv6_prefix_get(struct net_if *iface, const struct net_in6_addr *addr)
Return prefix that corresponds to this IPv6 address.
static void net_if_unset_promisc(struct net_if *iface)
Set network interface into normal mode.
Definition net_if.h:3299
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:1223
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:2160
static bool net_if_is_promisc(struct net_if *iface)
Check if promiscuous mode is set or not.
Definition net_if.h:3316
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:2604
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:1938
bool net_if_ipv4_set_netmask_by_addr(struct net_if *iface, const struct net_in_addr *addr, const struct net_in_addr *netmask)
Set IPv4 netmask for an interface index for a given address.
bool net_if_is_wifi(struct net_if *iface)
Check if the network interface supports Wi-Fi.
bool net_if_ipv4_set_netmask_by_addr_by_index(int index, const struct net_in_addr *addr, const struct net_in_addr *netmask)
Set IPv4 netmask for an interface index for a given address.
void net_if_unregister_timestamp_cb(struct net_if_timestamp_cb *handle)
Unregister a timestamp callback.
bool net_if_ipv4_maddr_rm(struct net_if *iface, const struct net_in_addr *addr)
Remove an IPv4 multicast address from an interface.
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.
int net_if_ipv6_addr_lookup_by_index(const struct net_in6_addr *addr)
Check if this IPv6 address belongs to one of the interface indices.
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_in_addr net_if_ipv4_get_netmask_by_addr(struct net_if *iface, const struct net_in_addr *addr)
Get IPv4 netmask related to an address of an interface.
static void net_if_stop_rs(struct net_if *iface)
Stop neighbor discovery.
Definition net_if.h:1328
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:2133
struct net_if * net_if_select_src_iface(const struct net_sockaddr *dst)
Get a network interface that should be used when sending IPv6 or IPv4 network data to destination.
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:1707
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...
struct net_if_mcast_addr * net_if_ipv4_maddr_lookup(const struct net_in_addr *addr, struct net_if **iface)
Check if this IPv4 multicast address belongs to a specific interface or one of the interfaces.
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:893
void net_if_start_rs(struct net_if *iface)
Start neighbor discovery and send router solicitation message.
static int net_if_oper_state_change_time(struct net_if *iface, int64_t *change_time)
Get an operational state change time of an interface.
Definition net_if.h:985
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:1863
struct net_if_router * net_if_ipv6_router_find_default(struct net_if *iface, const struct net_in6_addr *addr)
Find default router for this IPv6 address.
static 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.
Definition net_if.h:3001
void(* net_if_cb_t)(struct net_if *iface, void *user_data)
Callback used while iterating over network interfaces.
Definition net_if.h:3062
struct net_if_router * net_if_ipv6_router_lookup(struct net_if *iface, const struct net_in6_addr *addr)
Check if IPv6 address is one of the routers configured in the system.
static uint16_t net_if_get_mtu(struct net_if *iface)
Get an network interface's MTU.
Definition net_if.h:1443
bool net_if_ipv6_addr_rm(struct net_if *iface, const struct net_in6_addr *addr)
Remove an IPv6 address from an interface.
void net_if_ipv6_maddr_leave(struct net_if *iface, struct net_if_mcast_addr *addr)
Mark a given multicast address to be left.
void net_if_mcast_mon_unregister(struct net_if_mcast_monitor *mon)
Unregister a multicast monitor.
struct net_if_mcast_addr * net_if_ipv6_maddr_lookup(const struct net_in6_addr *addr, struct net_if **iface)
Check if this IPv6 multicast address belongs to a specific interface or one of the interfaces.
bool net_if_ipv6_addr_add_by_index(int index, const struct net_in6_addr *addr, enum net_addr_type addr_type, uint32_t vlifetime)
Add a IPv6 address to an interface by index.
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:2212
void net_if_call_timestamp_cb(struct net_pkt *pkt)
Call a timestamp callback function.
struct net_if * net_if_lookup_by_dev(const struct device *dev)
Find an interface from it's related device.
bool net_if_ipv6_addr_rm_by_index(int index, const struct net_in6_addr *addr)
Remove an IPv6 address from an interface by index.
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:2238
net_if_oper_state
Network interface operational status (RFC 2863).
Definition net_if.h:312
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:913
static struct net_if_config * net_if_config_get(struct net_if *iface)
Get network interface IP config.
Definition net_if.h:1513
static struct net_if_config * net_if_get_config(struct net_if *iface)
Return network configuration for this network interface.
Definition net_if.h:1289
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 net_if_addr * net_if_ipv6_addr_lookup_by_iface(struct net_if *iface, const struct net_in6_addr *addr)
Check if this IPv6 address belongs to this specific interfaces.
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:1478
net_if_flag
Network interface flags.
Definition net_if.h:254
int net_if_ipv4_addr_lookup_by_index(const struct net_in_addr *addr)
Check if this IPv4 address belongs to one of the interface indices.
static const struct net_in_addr * net_if_ipv4_select_src_addr(struct net_if *iface, const struct net_in_addr *dst)
Get a IPv4 source address that should be used when sending network data to destination.
Definition net_if.h:2779
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...
static const struct device * net_if_get_device(struct net_if *iface)
Get an network interface's device.
Definition net_if.h:1085
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:653
void net_if_ipv6_addr_update_lifetime(struct net_if_addr *ifaddr, uint32_t vlifetime)
Update validity lifetime time of an IPv6 address.
static void net_if_offload_set(struct net_if *iface, struct net_offload *offload)
Set the IP offload plugin.
Definition net_if.h:1177
static bool net_if_is_socket_offloaded(struct net_if *iface)
Return the socket offload status.
Definition net_if.h:1200
struct net_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 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:2119
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:3283
static const struct net_l2 * net_if_l2(struct net_if *iface)
Get a pointer to the interface L2.
Definition net_if.h:1039
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:1247
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:873
struct net_if_router * net_if_ipv4_router_find_default(struct net_if *iface, const struct net_in_addr *addr)
Find default router for this IPv4 address.
@ NET_IF_CHECKSUM_IPV4_ICMP
Interface supports checksum calculation for ICMP4 payload in IPv4.
Definition net_if.h:2974
@ NET_IF_CHECKSUM_IPV6_TCP
Interface supports checksum calculation for TCP payload in IPv6.
Definition net_if.h:2978
@ NET_IF_CHECKSUM_IPV6_UDP
Interface supports checksum calculation for UDP payload in IPv6.
Definition net_if.h:2981
@ NET_IF_CHECKSUM_IPV4_HEADER
Interface supports IP version 4 header checksum calculation.
Definition net_if.h:2966
@ NET_IF_CHECKSUM_IPV4_TCP
Interface supports checksum calculation for TCP payload in IPv4.
Definition net_if.h:2968
@ NET_IF_CHECKSUM_IPV6_HEADER
Interface supports IP version 6 header checksum calculation.
Definition net_if.h:2976
@ NET_IF_CHECKSUM_IPV6_ICMP
Interface supports checksum calculation for ICMP6 payload in IPv6.
Definition net_if.h:2984
@ NET_IF_CHECKSUM_IPV4_UDP
Interface supports checksum calculation for UDP payload in IPv4.
Definition net_if.h:2971
@ NET_IF_OPER_TESTING
Training mode.
Definition net_if.h:317
@ NET_IF_OPER_DORMANT
Waiting external action.
Definition net_if.h:318
@ NET_IF_OPER_UP
Interface is up.
Definition net_if.h:319
@ NET_IF_OPER_NOTPRESENT
Hardware missing.
Definition net_if.h:314
@ NET_IF_OPER_UNKNOWN
Initial (unknown) value.
Definition net_if.h:313
@ NET_IF_OPER_DOWN
Interface is down.
Definition net_if.h:315
@ NET_IF_OPER_LOWERLAYERDOWN
Lower layer interface is down.
Definition net_if.h:316
@ NET_IF_NO_AUTO_START
Do not start the interface immediately after initialization.
Definition net_if.h:270
@ NET_IF_IPV6_NO_MLD
IPv6 Multicast Listener Discovery disabled.
Definition net_if.h:300
@ NET_IF_POINTOPOINT
Interface is pointopoint.
Definition net_if.h:259
@ NET_IF_IPV6_NO_ND
IPv6 Neighbor Discovery disabled.
Definition net_if.h:297
@ NET_IF_FORWARD_MULTICASTS
Flag defines if received multicasts of other interface are forwarded on this interface.
Definition net_if.h:279
@ NET_IF_IPV4
Interface supports IPv4.
Definition net_if.h:282
@ NET_IF_PROMISC
Interface is in promiscuous mode.
Definition net_if.h:262
@ NET_IF_DORMANT
Driver signals dormant.
Definition net_if.h:294
@ NET_IF_SUSPENDED
Power management specific: interface is being suspended.
Definition net_if.h:273
@ NET_IF_IPV6
Interface supports IPv6.
Definition net_if.h:285
@ NET_IF_UP
Interface is admin up.
Definition net_if.h:256
@ NET_IF_LOWER_UP
Driver signals L1 is up.
Definition net_if.h:291
@ NET_IF_RUNNING
Interface up and running (ready to receive and transmit).
Definition net_if.h:288
@ NET_IF_NO_TX_LOCK
Mutex locking on TX data path disabled on the interface.
Definition net_if.h:303
net_link_type
Type of the link address.
Definition net_linkaddr.h:58
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:179
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:278
#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:513
Kernel FIFO structure.
Definition kernel.h:2895
Kernel mutex structure.
Definition kernel.h:3437
Semaphore structure.
Definition kernel.h:3663
Thread Structure.
Definition thread.h:259
Kernel timeout type.
Definition clock.h:65
Kernel timepoint type.
Definition clock.h:291
DHCPv6 client configuration parameters.
Definition dhcpv6.h:63
Network Interface unicast IPv4 address and netmask.
Definition net_if.h:473
struct net_in_addr netmask
Netmask.
Definition net_if.h:477
struct net_if_addr ipv4
IPv4 address.
Definition net_if.h:475
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:671
Network interface IP address configuration.
Definition net_if.h:573
IPv4 configuration.
Definition net_if.h:481
uint8_t mcast_ttl
IPv4 time-to-live for multicast packets.
Definition net_if.h:495
struct net_if_addr_ipv4 unicast[NET_IF_MAX_IPV4_ADDR]
Unicast IP addresses.
Definition net_if.h:483
struct net_in_addr gw
Gateway.
Definition net_if.h:489
uint8_t ttl
IPv4 time-to-live.
Definition net_if.h:492
struct net_if_mcast_addr mcast[NET_IF_MAX_IPV4_MADDR]
Multicast IP addresses.
Definition net_if.h:486
Network Interface IPv6 prefixes.
Definition net_if.h:198
struct net_if * iface
Backpointer to network interface where this prefix is used.
Definition net_if.h:206
uint8_t is_infinite
Is the IP prefix valid forever.
Definition net_if.h:212
uint8_t len
Prefix length.
Definition net_if.h:209
uint8_t is_used
Is this prefix used or not.
Definition net_if.h:215
struct net_timeout lifetime
Prefix lifetime.
Definition net_if.h:200
struct net_in6_addr prefix
IPv6 prefix.
Definition net_if.h:203
IPv6 configuration.
Definition net_if.h:339
struct net_if_ipv6_prefix prefix[NET_IF_MAX_IPV6_PREFIX]
Prefixes.
Definition net_if.h:347
uint32_t base_reachable_time
Default reachable time (RFC 4861, page 52).
Definition net_if.h:350
uint8_t hop_limit
IPv6 hop limit.
Definition net_if.h:388
struct net_if_mcast_addr mcast[NET_IF_MAX_IPV6_MADDR]
Multicast IP addresses.
Definition net_if.h:344
uint32_t retrans_timer
Retransmit timer (RFC 4861, page 52).
Definition net_if.h:356
struct net_if_addr unicast[NET_IF_MAX_IPV6_ADDR]
Unicast IP addresses.
Definition net_if.h:341
uint8_t mcast_hop_limit
IPv6 multicast hop limit.
Definition net_if.h:391
uint32_t reachable_time
Reachable time (RFC 4861, page 20).
Definition net_if.h:353
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:188
sys_snode_t rejoin_node
Rejoining multicast groups list node.
Definition net_if.h:171
atomic_t atomic_ref
Reference counter.
Definition net_if.h:168
uint8_t is_used
Is this multicast IP address used or not.
Definition net_if.h:185
Multicast monitor handler struct.
Definition net_if.h:1807
sys_snode_t node
Node information for the slist.
Definition net_if.h:1809
net_if_mcast_callback_t cb
Multicast callback.
Definition net_if.h:1815
struct net_if * iface
Network interface.
Definition net_if.h:1812
Information about routers in the system.
Definition net_if.h:225
struct net_if * iface
Network interface the router is connected to.
Definition net_if.h:233
uint8_t is_default
Is default router.
Definition net_if.h:245
uint16_t lifetime
Router lifetime.
Definition net_if.h:239
uint8_t is_infinite
Is the router valid forever.
Definition net_if.h:248
uint8_t is_used
Is this router used or not.
Definition net_if.h:242
struct net_addr address
IP address.
Definition net_if.h:230
sys_snode_t node
Slist lifetime timer node.
Definition net_if.h:227
uint32_t life_start
Router life timer start.
Definition net_if.h:236
Timestamp callback handler struct.
Definition net_if.h:3216
sys_snode_t node
Node information for the slist.
Definition net_if.h:3218
struct net_if * iface
Net interface for which the callback is needed.
Definition net_if.h:3228
struct net_pkt * pkt
Packet for which the callback is needed.
Definition net_if.h:3223
net_if_timestamp_callback_t cb
Timestamp callback.
Definition net_if.h:3231
Network Interface structure.
Definition net_if.h:735
IPv6 address struct.
Definition net_ip.h:144
IPv4 address struct.
Definition net_ip.h:156
Network L2 structure.
Definition net_l2.h:58
Hardware link address structure.
Definition net_linkaddr.h:83
Network packet.
Definition net_pkt.h:95
Generic sockaddr struct.
Definition net_ip.h:449
All network statistics in one struct.
Definition net_stats.h:423
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