Zephyr API Documentation 4.0.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
net_if.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2016 Intel Corporation.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
12#ifndef ZEPHYR_INCLUDE_NET_NET_IF_H_
13#define ZEPHYR_INCLUDE_NET_NET_IF_H_
14
24#include <zephyr/device.h>
25#include <zephyr/sys/slist.h>
27#include <zephyr/net/net_core.h>
28#include <zephyr/net/hostname.h>
30#include <zephyr/net/net_ip.h>
31#include <zephyr/net/net_l2.h>
34
35#if defined(CONFIG_NET_DHCPV4) && defined(CONFIG_NET_NATIVE_IPV4)
36#include <zephyr/net/dhcpv4.h>
37#endif
38#if defined(CONFIG_NET_DHCPV6) && defined(CONFIG_NET_NATIVE_IPV6)
39#include <zephyr/net/dhcpv6.h>
40#endif
41#if defined(CONFIG_NET_IPV4_AUTO) && defined(CONFIG_NET_NATIVE_IPV4)
43#endif
44
45#ifdef __cplusplus
46extern "C" {
47#endif
48
56 struct net_addr address;
57
62
63#if defined(CONFIG_NET_NATIVE_IPV6)
64 struct net_timeout lifetime;
65#endif
66
69
72
73#if defined(CONFIG_NET_NATIVE_IPV6)
74#if defined(CONFIG_NET_IPV6_PE)
78 uint32_t addr_create_time;
79
82 uint32_t addr_preferred_lifetime;
83
88 int32_t addr_timeout;
89#endif
90#endif /* CONFIG_NET_NATIVE_IPV6 */
91
92 union {
93#if defined(CONFIG_NET_IPV6_DAD)
94 struct {
96 sys_snode_t dad_node;
97 uint32_t dad_start;
98
100 uint8_t dad_count;
101 };
102#endif /* CONFIG_NET_IPV6_DAD */
103#if defined(CONFIG_NET_IPV4_ACD)
104 struct {
106 sys_snode_t acd_node;
107 k_timepoint_t acd_timeout;
108
110 uint8_t acd_count;
111
113 uint8_t acd_state;
114 };
115#endif /* CONFIG_NET_IPV4_ACD */
116 };
117
118#if defined(CONFIG_NET_IPV6_DAD) || defined(CONFIG_NET_IPV4_ACD)
120 uint8_t ifindex;
121#endif
122
125
128
131
136
137 uint8_t _unused : 4;
138};
139
147 struct net_addr address;
148
149#if defined(CONFIG_NET_IPV4_IGMPV3)
151 struct net_addr sources[CONFIG_NET_IF_MCAST_IPV4_SOURCE_COUNT];
152
154 uint16_t sources_len;
155
157 uint8_t record_type;
158#endif
159
162
165
166 uint8_t _unused : 6;
167};
168
177
180
182 struct net_if *iface;
183
186
189
192
193 uint8_t _unused : 6;
194};
195
204
206 struct net_addr address;
207
209 struct net_if *iface;
210
213
216
219
222
225
226 uint8_t _unused : 5;
227};
228
286
297
298#if defined(CONFIG_NET_OFFLOAD)
299struct net_offload;
300#endif /* CONFIG_NET_OFFLOAD */
301
303#if defined(CONFIG_NET_IPV6)
304#define NET_IF_MAX_IPV6_ADDR CONFIG_NET_IF_UNICAST_IPV6_ADDR_COUNT
305#define NET_IF_MAX_IPV6_MADDR CONFIG_NET_IF_MCAST_IPV6_ADDR_COUNT
306#define NET_IF_MAX_IPV6_PREFIX CONFIG_NET_IF_IPV6_PREFIX_COUNT
307#else
308#define NET_IF_MAX_IPV6_ADDR 0
309#define NET_IF_MAX_IPV6_MADDR 0
310#define NET_IF_MAX_IPV6_PREFIX 0
311#endif
312/* @endcond */
313
317 struct net_if_addr unicast[NET_IF_MAX_IPV6_ADDR];
318
320 struct net_if_mcast_addr mcast[NET_IF_MAX_IPV6_MADDR];
321
323 struct net_if_ipv6_prefix prefix[NET_IF_MAX_IPV6_PREFIX];
324
327
330
333
334#if defined(CONFIG_NET_IPV6_IID_STABLE)
336 struct net_if_addr *iid;
337
341 uint32_t network_counter;
342#endif /* CONFIG_NET_IPV6_IID_STABLE */
343
344#if defined(CONFIG_NET_IPV6_PE)
349 uint32_t desync_factor;
350#endif /* CONFIG_NET_IPV6_PE */
351
352#if defined(CONFIG_NET_IPV6_ND) && defined(CONFIG_NET_NATIVE_IPV6)
354 sys_snode_t rs_node;
355
356 /* RS start time */
357 uint32_t rs_start;
358
360 uint8_t rs_count;
361#endif
362
365
368};
369
370#if defined(CONFIG_NET_DHCPV6) && defined(CONFIG_NET_NATIVE_IPV6)
372struct net_if_dhcpv6 {
374 sys_snode_t node;
375
377 struct net_dhcpv6_duid_storage clientid;
378
380 struct net_dhcpv6_duid_storage serverid;
381
383 enum net_dhcpv6_state state;
384
386 struct net_dhcpv6_params params;
387
389 uint64_t timeout;
390
392 uint64_t exchange_start;
393
395 uint64_t t1;
396
398 uint64_t t2;
399
403 uint64_t expire;
404
406 uint32_t addr_iaid;
407
409 uint32_t prefix_iaid;
410
412 uint32_t retransmit_timeout;
413
415 int16_t server_preference;
416
418 uint8_t retransmissions;
419
421 uint8_t tid[DHCPV6_TID_SIZE];
422
424 uint8_t prefix_len;
425
427 struct in6_addr prefix;
428
430 struct in6_addr addr;
431};
432#endif /* defined(CONFIG_NET_DHCPV6) && defined(CONFIG_NET_NATIVE_IPV6) */
433
435#if defined(CONFIG_NET_IPV4)
436#define NET_IF_MAX_IPV4_ADDR CONFIG_NET_IF_UNICAST_IPV4_ADDR_COUNT
437#define NET_IF_MAX_IPV4_MADDR CONFIG_NET_IF_MCAST_IPV4_ADDR_COUNT
438#else
439#define NET_IF_MAX_IPV4_ADDR 0
440#define NET_IF_MAX_IPV4_MADDR 0
441#endif
455
459 struct net_if_addr_ipv4 unicast[NET_IF_MAX_IPV4_ADDR];
460
462 struct net_if_mcast_addr mcast[NET_IF_MAX_IPV4_MADDR];
463
465 struct in_addr gw;
466
469
472
473#if defined(CONFIG_NET_IPV4_ACD)
475 uint8_t conflict_cnt;
476#endif
477};
478
479#if defined(CONFIG_NET_DHCPV4) && defined(CONFIG_NET_NATIVE_IPV4)
480struct net_if_dhcpv4 {
482 sys_snode_t node;
483
485 int64_t timer_start;
486
488 uint32_t request_time;
489
490 uint32_t xid;
491
493 uint32_t lease_time;
494
496 uint32_t renewal_time;
497
499 uint32_t rebinding_time;
500
502 struct in_addr server_id;
503
505 struct in_addr requested_ip;
506
508 struct in_addr netmask;
509
514 enum net_dhcpv4_state state;
515
517 uint8_t attempts;
518
520 struct in_addr request_server_addr;
521
523 struct in_addr response_src_addr;
524
525#ifdef CONFIG_NET_DHCPV4_OPTION_NTP_SERVER
527 struct in_addr ntp_addr;
528#endif
529};
530#endif /* CONFIG_NET_DHCPV4 */
531
532#if defined(CONFIG_NET_IPV4_AUTO) && defined(CONFIG_NET_NATIVE_IPV4)
533struct net_if_ipv4_autoconf {
535 struct net_if *iface;
536
538 struct in_addr requested_ip;
539
543};
544#endif /* CONFIG_NET_IPV4_AUTO */
545
547/* We always need to have at least one IP config */
548#define NET_IF_MAX_CONFIGS 1
554struct net_if_ip {
555#if defined(CONFIG_NET_IPV6)
556 struct net_if_ipv6 *ipv6;
557#endif /* CONFIG_NET_IPV6 */
558
559#if defined(CONFIG_NET_IPV4)
560 struct net_if_ipv4 *ipv4;
561#endif /* CONFIG_NET_IPV4 */
562};
563
568#if defined(CONFIG_NET_IP)
570 struct net_if_ip ip;
571#endif
572
573#if defined(CONFIG_NET_DHCPV4) && defined(CONFIG_NET_NATIVE_IPV4)
574 struct net_if_dhcpv4 dhcpv4;
575#endif /* CONFIG_NET_DHCPV4 */
576
577#if defined(CONFIG_NET_DHCPV6) && defined(CONFIG_NET_NATIVE_IPV6)
578 struct net_if_dhcpv6 dhcpv6;
579#endif /* CONFIG_NET_DHCPV6 */
580
581#if defined(CONFIG_NET_IPV4_AUTO) && defined(CONFIG_NET_NATIVE_IPV4)
582 struct net_if_ipv4_autoconf ipv4auto;
583#endif /* CONFIG_NET_IPV4_AUTO */
584
585#if defined(CONFIG_NET_L2_VIRTUAL)
590 sys_slist_t virtual_interfaces;
591#endif /* CONFIG_NET_L2_VIRTUAL */
592
593#if defined(CONFIG_NET_INTERFACE_NAME)
598 char name[CONFIG_NET_INTERFACE_NAME_LEN + 1];
599#endif
600};
601
621
628typedef int (*net_socket_create_t)(int, int, int);
629
646 const struct device *dev;
647
649 const struct net_l2 * const l2;
650
652 void *l2_data;
653
655 ATOMIC_DEFINE(flags, NET_IF_NUM_FLAGS);
656
659
660#if defined(CONFIG_NET_OFFLOAD)
666 struct net_offload *offload;
667#endif /* CONFIG_NET_OFFLOAD */
668
671
672#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
676 net_socket_create_t socket_offload;
677#endif /* CONFIG_NET_SOCKETS_OFFLOAD */
678
681};
682
690struct net_if {
693
694#if defined(CONFIG_NET_STATISTICS_PER_INTERFACE)
696 struct net_stats stats;
697#endif /* CONFIG_NET_STATISTICS_PER_INTERFACE */
698
701
702#if defined(CONFIG_NET_POWER_MANAGEMENT)
707 int tx_pending;
708#endif
709
711 struct k_mutex lock;
712
715
721
726
728 uint8_t _unused : 6;
729};
730
733static inline void net_if_lock(struct net_if *iface)
734{
735 NET_ASSERT(iface);
736
737 (void)k_mutex_lock(&iface->lock, K_FOREVER);
738}
739
740static inline void net_if_unlock(struct net_if *iface)
741{
742 NET_ASSERT(iface);
743
744 k_mutex_unlock(&iface->lock);
745}
746
747static inline bool net_if_flag_is_set(struct net_if *iface,
748 enum net_if_flag value);
749
750static inline void net_if_tx_lock(struct net_if *iface)
751{
752 NET_ASSERT(iface);
753
755 return;
756 }
757
758 (void)k_mutex_lock(&iface->tx_lock, K_FOREVER);
759}
760
761static inline void net_if_tx_unlock(struct net_if *iface)
762{
763 NET_ASSERT(iface);
764
766 return;
767 }
768
769 k_mutex_unlock(&iface->tx_lock);
770}
771
780static inline void net_if_flag_set(struct net_if *iface,
781 enum net_if_flag value)
782{
783 NET_ASSERT(iface);
784 NET_ASSERT(iface->if_dev);
785
786 atomic_set_bit(iface->if_dev->flags, value);
787}
788
797static inline bool net_if_flag_test_and_set(struct net_if *iface,
798 enum net_if_flag value)
799{
800 NET_ASSERT(iface);
801 NET_ASSERT(iface->if_dev);
802
803 return atomic_test_and_set_bit(iface->if_dev->flags, value);
804}
805
812static inline void net_if_flag_clear(struct net_if *iface,
813 enum net_if_flag value)
814{
815 NET_ASSERT(iface);
816 NET_ASSERT(iface->if_dev);
817
818 atomic_clear_bit(iface->if_dev->flags, value);
819}
820
829static inline bool net_if_flag_test_and_clear(struct net_if *iface,
830 enum net_if_flag value)
831{
832 NET_ASSERT(iface);
833 NET_ASSERT(iface->if_dev);
834
835 return atomic_test_and_clear_bit(iface->if_dev->flags, value);
836}
837
846static inline bool net_if_flag_is_set(struct net_if *iface,
847 enum net_if_flag value)
848{
849 NET_ASSERT(iface);
850 NET_ASSERT(iface->if_dev);
851
852 if (iface == NULL) {
853 return false;
854 }
855
856 return atomic_test_bit(iface->if_dev->flags, value);
857}
858
868 struct net_if *iface, enum net_if_oper_state oper_state)
869{
870 NET_ASSERT(iface);
871 NET_ASSERT(iface->if_dev);
872
873 BUILD_ASSERT((enum net_if_oper_state)(-1) > 0 && NET_IF_OPER_UNKNOWN == 0);
874 if (oper_state <= NET_IF_OPER_UP) {
875 iface->if_dev->oper_state = oper_state;
876 }
877
878 return iface->if_dev->oper_state;
879}
880
888static inline enum net_if_oper_state net_if_oper_state(struct net_if *iface)
889{
890 NET_ASSERT(iface);
891 NET_ASSERT(iface->if_dev);
892
893 return iface->if_dev->oper_state;
894}
895
904enum net_verdict net_if_send_data(struct net_if *iface, struct net_pkt *pkt);
905
913static inline const struct net_l2 *net_if_l2(struct net_if *iface)
914{
915 if (!iface || !iface->if_dev) {
916 return NULL;
917 }
918
919 return iface->if_dev->l2;
920}
921
930enum net_verdict net_if_recv_data(struct net_if *iface, struct net_pkt *pkt);
931
939static inline void *net_if_l2_data(struct net_if *iface)
940{
941 NET_ASSERT(iface);
942 NET_ASSERT(iface->if_dev);
943
944 return iface->if_dev->l2_data;
945}
946
954static inline const struct device *net_if_get_device(struct net_if *iface)
955{
956 NET_ASSERT(iface);
957 NET_ASSERT(iface->if_dev);
958
959 return iface->if_dev->dev;
960}
961
968void net_if_queue_tx(struct net_if *iface, struct net_pkt *pkt);
969
977static inline bool net_if_is_ip_offloaded(struct net_if *iface)
978{
979#if defined(CONFIG_NET_OFFLOAD)
980 return (iface != NULL && iface->if_dev != NULL &&
981 iface->if_dev->offload != NULL);
982#else
983 ARG_UNUSED(iface);
984
985 return false;
986#endif
987}
988
996bool net_if_is_offloaded(struct net_if *iface);
997
1005static inline struct net_offload *net_if_offload(struct net_if *iface)
1006{
1007#if defined(CONFIG_NET_OFFLOAD)
1008 NET_ASSERT(iface);
1009 NET_ASSERT(iface->if_dev);
1010
1011 return iface->if_dev->offload;
1012#else
1013 ARG_UNUSED(iface);
1014
1015 return NULL;
1016#endif
1017}
1018
1026static inline bool net_if_is_socket_offloaded(struct net_if *iface)
1027{
1028#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
1029 NET_ASSERT(iface);
1030 NET_ASSERT(iface->if_dev);
1031
1032 return (iface->if_dev->socket_offload != NULL);
1033#else
1034 ARG_UNUSED(iface);
1035
1036 return false;
1037#endif
1038}
1039
1046static inline void net_if_socket_offload_set(
1047 struct net_if *iface, net_socket_create_t socket_offload)
1048{
1049#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
1050 NET_ASSERT(iface);
1051 NET_ASSERT(iface->if_dev);
1052
1053 iface->if_dev->socket_offload = socket_offload;
1054#else
1055 ARG_UNUSED(iface);
1056 ARG_UNUSED(socket_offload);
1057#endif
1058}
1059
1068{
1069#if defined(CONFIG_NET_SOCKETS_OFFLOAD)
1070 NET_ASSERT(iface);
1071 NET_ASSERT(iface->if_dev);
1072
1073 return iface->if_dev->socket_offload;
1074#else
1075 ARG_UNUSED(iface);
1076
1077 return NULL;
1078#endif
1079}
1080
1088static inline struct net_linkaddr *net_if_get_link_addr(struct net_if *iface)
1089{
1090 NET_ASSERT(iface);
1091 NET_ASSERT(iface->if_dev);
1092
1093 return &iface->if_dev->link_addr;
1094}
1095
1103static inline struct net_if_config *net_if_get_config(struct net_if *iface)
1104{
1105 NET_ASSERT(iface);
1106
1107 return &iface->config;
1108}
1109
1115#if defined(CONFIG_NET_IPV6_DAD) && defined(CONFIG_NET_NATIVE_IPV6)
1116void net_if_start_dad(struct net_if *iface);
1117#else
1118static inline void net_if_start_dad(struct net_if *iface)
1119{
1120 ARG_UNUSED(iface);
1121}
1122#endif
1123
1129void net_if_start_rs(struct net_if *iface);
1130
1131
1137#if defined(CONFIG_NET_IPV6_ND) && defined(CONFIG_NET_NATIVE_IPV6)
1138void net_if_stop_rs(struct net_if *iface);
1139#else
1140static inline void net_if_stop_rs(struct net_if *iface)
1141{
1142 ARG_UNUSED(iface);
1143}
1144#endif /* CONFIG_NET_IPV6_ND */
1145
1158#if defined(CONFIG_NET_IPV6_ND) && defined(CONFIG_NET_NATIVE_IPV6)
1159void net_if_nbr_reachability_hint(struct net_if *iface, const struct in6_addr *ipv6_addr);
1160#else
1161static inline void net_if_nbr_reachability_hint(struct net_if *iface,
1162 const struct in6_addr *ipv6_addr)
1163{
1164 ARG_UNUSED(iface);
1165 ARG_UNUSED(ipv6_addr);
1166}
1167#endif
1168
1171static inline int net_if_set_link_addr_unlocked(struct net_if *iface,
1172 uint8_t *addr, uint8_t len,
1173 enum net_link_type type)
1174{
1175 if (net_if_flag_is_set(iface, NET_IF_RUNNING)) {
1176 return -EPERM;
1177 }
1178
1179 net_if_get_link_addr(iface)->addr = addr;
1180 net_if_get_link_addr(iface)->len = len;
1181 net_if_get_link_addr(iface)->type = type;
1182
1183 net_hostname_set_postfix(addr, len);
1184
1185 return 0;
1186}
1187
1188int net_if_set_link_addr_locked(struct net_if *iface,
1189 uint8_t *addr, uint8_t len,
1190 enum net_link_type type);
1191
1192#if CONFIG_NET_IF_LOG_LEVEL >= LOG_LEVEL_DBG
1193extern int net_if_addr_unref_debug(struct net_if *iface,
1194 sa_family_t family,
1195 const void *addr,
1196 const char *caller, int line);
1197#define net_if_addr_unref(iface, family, addr) \
1198 net_if_addr_unref_debug(iface, family, addr, __func__, __LINE__)
1199
1200extern struct net_if_addr *net_if_addr_ref_debug(struct net_if *iface,
1201 sa_family_t family,
1202 const void *addr,
1203 const char *caller,
1204 int line);
1205#define net_if_addr_ref(iface, family, addr) \
1206 net_if_addr_ref_debug(iface, family, addr, __func__, __LINE__)
1207#else
1208extern int net_if_addr_unref(struct net_if *iface,
1209 sa_family_t family,
1210 const void *addr);
1211extern struct net_if_addr *net_if_addr_ref(struct net_if *iface,
1212 sa_family_t family,
1213 const void *addr);
1214#endif /* CONFIG_NET_IF_LOG_LEVEL */
1215
1229static inline int net_if_set_link_addr(struct net_if *iface,
1230 uint8_t *addr, uint8_t len,
1231 enum net_link_type type)
1232{
1233#if defined(CONFIG_NET_RAW_MODE)
1234 return net_if_set_link_addr_unlocked(iface, addr, len, type);
1235#else
1236 return net_if_set_link_addr_locked(iface, addr, len, type);
1237#endif
1238}
1239
1247static inline uint16_t net_if_get_mtu(struct net_if *iface)
1248{
1249 if (iface == NULL) {
1250 return 0U;
1251 }
1252
1253 NET_ASSERT(iface->if_dev);
1254
1255 return iface->if_dev->mtu;
1256}
1257
1264static inline void net_if_set_mtu(struct net_if *iface,
1265 uint16_t mtu)
1266{
1267 if (iface == NULL) {
1268 return;
1269 }
1270
1271 NET_ASSERT(iface->if_dev);
1272
1273 iface->if_dev->mtu = mtu;
1274}
1275
1282static inline void net_if_addr_set_lf(struct net_if_addr *ifaddr,
1283 bool is_infinite)
1284{
1285 NET_ASSERT(ifaddr);
1286
1287 ifaddr->is_infinite = is_infinite;
1288}
1289
1298
1306struct net_if *net_if_lookup_by_dev(const struct device *dev);
1307
1315static inline struct net_if_config *net_if_config_get(struct net_if *iface)
1316{
1317 NET_ASSERT(iface);
1318
1319 return &iface->config;
1320}
1321
1327void net_if_router_rm(struct net_if_router *router);
1328
1334void net_if_set_default(struct net_if *iface);
1335
1342
1351struct net_if *net_if_get_first_by_type(const struct net_l2 *l2);
1352
1360
1361#if defined(CONFIG_NET_L2_IEEE802154)
1368static inline struct net_if *net_if_get_ieee802154(void)
1369{
1370 return net_if_get_first_by_type(&NET_L2_GET_NAME(IEEE802154));
1371}
1372#endif /* CONFIG_NET_L2_IEEE802154 */
1373
1385 struct net_if_ipv6 **ipv6);
1386
1395
1405 struct net_if **iface);
1406
1416 struct in6_addr *addr);
1417
1426__syscall int net_if_ipv6_addr_lookup_by_index(const struct in6_addr *addr);
1427
1439 struct in6_addr *addr,
1441 uint32_t vlifetime);
1442
1453__syscall bool net_if_ipv6_addr_add_by_index(int index,
1454 struct in6_addr *addr,
1456 uint32_t vlifetime);
1457
1465 uint32_t vlifetime);
1466
1475bool net_if_ipv6_addr_rm(struct net_if *iface, const struct in6_addr *addr);
1476
1485__syscall bool net_if_ipv6_addr_rm_by_index(int index,
1486 const struct in6_addr *addr);
1487
1496typedef void (*net_if_ip_addr_cb_t)(struct net_if *iface,
1497 struct net_if_addr *addr,
1498 void *user_data);
1499
1509 void *user_data);
1510
1520 const struct in6_addr *addr);
1521
1530bool net_if_ipv6_maddr_rm(struct net_if *iface, const struct in6_addr *addr);
1531
1540typedef void (*net_if_ip_maddr_cb_t)(struct net_if *iface,
1541 struct net_if_mcast_addr *maddr,
1542 void *user_data);
1543
1553 void *user_data);
1554
1566 struct net_if **iface);
1567
1578typedef void (*net_if_mcast_callback_t)(struct net_if *iface,
1579 const struct net_addr *addr,
1580 bool is_joined);
1581
1600
1610 struct net_if *iface,
1612
1619
1627void net_if_mcast_monitor(struct net_if *iface, const struct net_addr *addr,
1628 bool is_joined);
1629
1637 struct net_if_mcast_addr *addr);
1638
1646static inline bool net_if_ipv6_maddr_is_joined(struct net_if_mcast_addr *addr)
1647{
1648 NET_ASSERT(addr);
1649
1650 return addr->is_joined;
1651}
1652
1660 struct net_if_mcast_addr *addr);
1661
1671 const struct in6_addr *addr);
1672
1683 struct in6_addr *addr,
1684 uint8_t len);
1685
1697 struct in6_addr *prefix,
1698 uint8_t len,
1700
1710bool net_if_ipv6_prefix_rm(struct net_if *iface, struct in6_addr *addr,
1711 uint8_t len);
1712
1720 bool is_infinite)
1721{
1722 prefix->is_infinite = is_infinite;
1723}
1724
1733
1740
1751bool net_if_ipv6_addr_onlink(struct net_if **iface, struct in6_addr *addr);
1752
1759#if defined(CONFIG_NET_NATIVE_IPV6)
1760static inline struct in6_addr *net_if_router_ipv6(struct net_if_router *router)
1761{
1762 NET_ASSERT(router);
1763
1764 return &router->address.in6_addr;
1765}
1766#else
1767static inline struct in6_addr *net_if_router_ipv6(struct net_if_router *router)
1768{
1769 static struct in6_addr addr;
1770
1771 ARG_UNUSED(router);
1772
1773 return &addr;
1774}
1775#endif
1776
1787 struct in6_addr *addr);
1788
1799 struct in6_addr *addr);
1800
1809
1820 struct in6_addr *addr,
1821 uint16_t router_lifetime);
1822
1831
1840#if defined(CONFIG_NET_NATIVE_IPV6)
1842#else
1844{
1845 ARG_UNUSED(iface);
1846
1847 return 0;
1848}
1849#endif /* CONFIG_NET_NATIVE_IPV6 */
1850
1857#if defined(CONFIG_NET_NATIVE_IPV6)
1858void net_if_ipv6_set_hop_limit(struct net_if *iface, uint8_t hop_limit);
1859#else
1860static inline void net_if_ipv6_set_hop_limit(struct net_if *iface,
1861 uint8_t hop_limit)
1862{
1863 ARG_UNUSED(iface);
1864 ARG_UNUSED(hop_limit);
1865}
1866#endif /* CONFIG_NET_NATIVE_IPV6 */
1867
1870/* The old hop limit setter function is deprecated because the naming
1871 * of it was incorrect. The API name was missing "_if_" so this function
1872 * should not be used.
1873 */
1874__deprecated
1875static inline void net_ipv6_set_hop_limit(struct net_if *iface,
1876 uint8_t hop_limit)
1877{
1878 net_if_ipv6_set_hop_limit(iface, hop_limit);
1879}
1880
1891#if defined(CONFIG_NET_NATIVE_IPV6)
1893#else
1895{
1896 ARG_UNUSED(iface);
1897
1898 return 0;
1899}
1900#endif /* CONFIG_NET_NATIVE_IPV6 */
1901
1908#if defined(CONFIG_NET_NATIVE_IPV6)
1909void net_if_ipv6_set_mcast_hop_limit(struct net_if *iface, uint8_t hop_limit);
1910#else
1912 uint8_t hop_limit)
1913{
1914 ARG_UNUSED(iface);
1915 ARG_UNUSED(hop_limit);
1916}
1917#endif /* CONFIG_NET_NATIVE_IPV6 */
1918
1926 uint32_t reachable_time)
1927{
1928#if defined(CONFIG_NET_NATIVE_IPV6)
1929 NET_ASSERT(iface);
1930
1931 if (!iface->config.ip.ipv6) {
1932 return;
1933 }
1934
1935 iface->config.ip.ipv6->base_reachable_time = reachable_time;
1936#else
1937 ARG_UNUSED(iface);
1938 ARG_UNUSED(reachable_time);
1939
1940#endif
1941}
1942
1951{
1952#if defined(CONFIG_NET_NATIVE_IPV6)
1953 NET_ASSERT(iface);
1954
1955 if (!iface->config.ip.ipv6) {
1956 return 0;
1957 }
1958
1959 return iface->config.ip.ipv6->reachable_time;
1960#else
1961 ARG_UNUSED(iface);
1962 return 0;
1963#endif
1964}
1965
1974
1981static inline void net_if_ipv6_set_reachable_time(struct net_if_ipv6 *ipv6)
1982{
1983#if defined(CONFIG_NET_NATIVE_IPV6)
1984 if (ipv6 == NULL) {
1985 return;
1986 }
1987
1989#else
1990 ARG_UNUSED(ipv6);
1991#endif
1992}
1993
2000static inline void net_if_ipv6_set_retrans_timer(struct net_if *iface,
2001 uint32_t retrans_timer)
2002{
2003#if defined(CONFIG_NET_NATIVE_IPV6)
2004 NET_ASSERT(iface);
2005
2006 if (!iface->config.ip.ipv6) {
2007 return;
2008 }
2009
2010 iface->config.ip.ipv6->retrans_timer = retrans_timer;
2011#else
2012 ARG_UNUSED(iface);
2013 ARG_UNUSED(retrans_timer);
2014#endif
2015}
2016
2025{
2026#if defined(CONFIG_NET_NATIVE_IPV6)
2027 NET_ASSERT(iface);
2028
2029 if (!iface->config.ip.ipv6) {
2030 return 0;
2031 }
2032
2033 return iface->config.ip.ipv6->retrans_timer;
2034#else
2035 ARG_UNUSED(iface);
2036 return 0;
2037#endif
2038}
2039
2051#if defined(CONFIG_NET_IPV6)
2052const struct in6_addr *net_if_ipv6_select_src_addr(struct net_if *iface,
2053 const struct in6_addr *dst);
2054#else
2055static inline const struct in6_addr *net_if_ipv6_select_src_addr(
2056 struct net_if *iface, const struct in6_addr *dst)
2057{
2058 ARG_UNUSED(iface);
2059 ARG_UNUSED(dst);
2060
2061 return NULL;
2062}
2063#endif
2064
2078#if defined(CONFIG_NET_IPV6)
2079const struct in6_addr *net_if_ipv6_select_src_addr_hint(struct net_if *iface,
2080 const struct in6_addr *dst,
2081 int flags);
2082#else
2083static inline const struct in6_addr *net_if_ipv6_select_src_addr_hint(
2084 struct net_if *iface, const struct in6_addr *dst, int flags)
2085{
2086 ARG_UNUSED(iface);
2087 ARG_UNUSED(dst);
2088 ARG_UNUSED(flags);
2089
2090 return NULL;
2091}
2092#endif
2093
2103#if defined(CONFIG_NET_IPV6)
2104struct net_if *net_if_ipv6_select_src_iface(const struct in6_addr *dst);
2105#else
2107 const struct in6_addr *dst)
2108{
2109 ARG_UNUSED(dst);
2110
2111 return NULL;
2112}
2113#endif
2114
2124struct in6_addr *net_if_ipv6_get_ll(struct net_if *iface,
2125 enum net_addr_state addr_state);
2126
2137 struct net_if **iface);
2138
2146void net_if_ipv6_dad_failed(struct net_if *iface, const struct in6_addr *addr);
2147
2160 struct net_if **iface);
2161
2173 struct net_if_ipv4 **ipv4);
2174
2183
2192
2199void net_if_ipv4_set_ttl(struct net_if *iface, uint8_t ttl);
2200
2209
2217
2227 struct net_if **iface);
2228
2240 struct in_addr *addr,
2242 uint32_t vlifetime);
2243
2252bool net_if_ipv4_addr_rm(struct net_if *iface, const struct in_addr *addr);
2253
2262__syscall int net_if_ipv4_addr_lookup_by_index(const struct in_addr *addr);
2263
2274__syscall bool net_if_ipv4_addr_add_by_index(int index,
2275 struct in_addr *addr,
2277 uint32_t vlifetime);
2278
2287__syscall bool net_if_ipv4_addr_rm_by_index(int index,
2288 const struct in_addr *addr);
2289
2299 void *user_data);
2300
2310 const struct in_addr *addr);
2311
2320bool net_if_ipv4_maddr_rm(struct net_if *iface, const struct in_addr *addr);
2321
2331 void *user_data);
2332
2344 struct net_if **iface);
2345
2353 struct net_if_mcast_addr *addr);
2354
2362static inline bool net_if_ipv4_maddr_is_joined(struct net_if_mcast_addr *addr)
2363{
2364 NET_ASSERT(addr);
2365
2366 return addr->is_joined;
2367}
2368
2376 struct net_if_mcast_addr *addr);
2377
2384#if defined(CONFIG_NET_NATIVE_IPV4)
2385static inline struct in_addr *net_if_router_ipv4(struct net_if_router *router)
2386{
2387 NET_ASSERT(router);
2388
2389 return &router->address.in_addr;
2390}
2391#else
2392static inline struct in_addr *net_if_router_ipv4(struct net_if_router *router)
2393{
2394 static struct in_addr addr;
2395
2396 ARG_UNUSED(router);
2397
2398 return &addr;
2399}
2400#endif
2401
2412 struct in_addr *addr);
2413
2424 struct in_addr *addr);
2436 struct in_addr *addr,
2437 bool is_default,
2438 uint16_t router_lifetime);
2439
2448
2458 const struct in_addr *addr);
2459
2469 const struct in_addr *addr);
2470
2480#if defined(CONFIG_NET_IPV4)
2481struct net_if *net_if_ipv4_select_src_iface(const struct in_addr *dst);
2482#else
2484 const struct in_addr *dst)
2485{
2486 ARG_UNUSED(dst);
2487
2488 return NULL;
2489}
2490#endif
2491
2503#if defined(CONFIG_NET_IPV4)
2504const struct in_addr *net_if_ipv4_select_src_addr(struct net_if *iface,
2505 const struct in_addr *dst);
2506#else
2507static inline const struct in_addr *net_if_ipv4_select_src_addr(
2508 struct net_if *iface, const struct in_addr *dst)
2509{
2510 ARG_UNUSED(iface);
2511 ARG_UNUSED(dst);
2512
2513 return NULL;
2514}
2515#endif
2516
2526struct in_addr *net_if_ipv4_get_ll(struct net_if *iface,
2527 enum net_addr_state addr_state);
2528
2539 enum net_addr_state addr_state);
2540
2551 const struct in_addr *addr);
2552
2562__deprecated struct in_addr net_if_ipv4_get_netmask(struct net_if *iface);
2563
2572__deprecated void net_if_ipv4_set_netmask(struct net_if *iface,
2573 const struct in_addr *netmask);
2574
2585__deprecated __syscall bool net_if_ipv4_set_netmask_by_index(int index,
2586 const struct in_addr *netmask);
2587
2598 const struct in_addr *addr,
2599 const struct in_addr *netmask);
2600
2611 const struct in_addr *addr,
2612 const struct in_addr *netmask);
2613
2621struct in_addr net_if_ipv4_get_gw(struct net_if *iface);
2622
2629void net_if_ipv4_set_gw(struct net_if *iface, const struct in_addr *gw);
2630
2639__syscall bool net_if_ipv4_set_gw_by_index(int index, const struct in_addr *gw);
2640
2651struct net_if *net_if_select_src_iface(const struct sockaddr *dst);
2652
2661typedef void (*net_if_link_callback_t)(struct net_if *iface,
2662 struct net_linkaddr *dst,
2663 int status);
2664
2680
2689
2696
2704void net_if_call_link_cb(struct net_if *iface, struct net_linkaddr *lladdr,
2705 int status);
2706
2709/* used to ensure encoding of checksum support in net_if.h and
2710 * ethernet.h is the same
2711 */
2712#define NET_IF_CHECKSUM_NONE_BIT 0
2713#define NET_IF_CHECKSUM_IPV4_HEADER_BIT BIT(0)
2714#define NET_IF_CHECKSUM_IPV4_ICMP_BIT BIT(1)
2715/* Space for future protocols and restrictions for IPV4 */
2716#define NET_IF_CHECKSUM_IPV6_HEADER_BIT BIT(10)
2717#define NET_IF_CHECKSUM_IPV6_ICMP_BIT BIT(11)
2718/* Space for future protocols and restrictions for IPV6 */
2719#define NET_IF_CHECKSUM_TCP_BIT BIT(21)
2720#define NET_IF_CHECKSUM_UDP_BIT BIT(22)
2721
2729 NET_IF_CHECKSUM_IPV4_HEADER = NET_IF_CHECKSUM_IPV4_HEADER_BIT,
2731 NET_IF_CHECKSUM_IPV4_TCP = NET_IF_CHECKSUM_IPV4_HEADER_BIT |
2732 NET_IF_CHECKSUM_TCP_BIT,
2734 NET_IF_CHECKSUM_IPV4_UDP = NET_IF_CHECKSUM_IPV4_HEADER_BIT |
2735 NET_IF_CHECKSUM_UDP_BIT,
2737 NET_IF_CHECKSUM_IPV4_ICMP = NET_IF_CHECKSUM_IPV4_ICMP_BIT,
2739 NET_IF_CHECKSUM_IPV6_HEADER = NET_IF_CHECKSUM_IPV6_HEADER_BIT,
2741 NET_IF_CHECKSUM_IPV6_TCP = NET_IF_CHECKSUM_IPV6_HEADER_BIT |
2742 NET_IF_CHECKSUM_TCP_BIT,
2744 NET_IF_CHECKSUM_IPV6_UDP = NET_IF_CHECKSUM_IPV6_HEADER_BIT |
2745 NET_IF_CHECKSUM_UDP_BIT,
2747 NET_IF_CHECKSUM_IPV6_ICMP = NET_IF_CHECKSUM_IPV6_ICMP_BIT
2749
2761 enum net_if_checksum_type chksum_type);
2762
2775 enum net_if_checksum_type chksum_type);
2776
2787__syscall struct net_if *net_if_get_by_index(int index);
2788
2796int net_if_get_by_iface(struct net_if *iface);
2797
2805typedef void (*net_if_cb_t)(struct net_if *iface, void *user_data);
2806
2814void net_if_foreach(net_if_cb_t cb, void *user_data);
2815
2823int net_if_up(struct net_if *iface);
2824
2832static inline bool net_if_is_up(struct net_if *iface)
2833{
2834 NET_ASSERT(iface);
2835
2836 return net_if_flag_is_set(iface, NET_IF_UP) &&
2838}
2839
2847int net_if_down(struct net_if *iface);
2848
2856static inline bool net_if_is_admin_up(struct net_if *iface)
2857{
2858 NET_ASSERT(iface);
2859
2860 return net_if_flag_is_set(iface, NET_IF_UP);
2861}
2862
2871void net_if_carrier_on(struct net_if *iface);
2872
2881void net_if_carrier_off(struct net_if *iface);
2882
2890static inline bool net_if_is_carrier_ok(struct net_if *iface)
2891{
2892 NET_ASSERT(iface);
2893
2894 return net_if_flag_is_set(iface, NET_IF_LOWER_UP);
2895}
2896
2907void net_if_dormant_on(struct net_if *iface);
2908
2917void net_if_dormant_off(struct net_if *iface);
2918
2926static inline bool net_if_is_dormant(struct net_if *iface)
2927{
2928 NET_ASSERT(iface);
2929
2930 return net_if_flag_is_set(iface, NET_IF_DORMANT);
2931}
2932
2933#if defined(CONFIG_NET_PKT_TIMESTAMP) && defined(CONFIG_NET_NATIVE)
2941typedef void (*net_if_timestamp_callback_t)(struct net_pkt *pkt);
2942
2951struct net_if_timestamp_cb {
2953 sys_snode_t node;
2954
2958 struct net_pkt *pkt;
2959
2963 struct net_if *iface;
2964
2966 net_if_timestamp_callback_t cb;
2967};
2968
2979void net_if_register_timestamp_cb(struct net_if_timestamp_cb *handle,
2980 struct net_pkt *pkt,
2981 struct net_if *iface,
2982 net_if_timestamp_callback_t cb);
2983
2989void net_if_unregister_timestamp_cb(struct net_if_timestamp_cb *handle);
2990
2996void net_if_call_timestamp_cb(struct net_pkt *pkt);
2997
2998/*
2999 * @brief Add timestamped TX buffer to be handled
3000 *
3001 * @param pkt Timestamped buffer
3002 */
3003void net_if_add_tx_timestamp(struct net_pkt *pkt);
3004#endif /* CONFIG_NET_PKT_TIMESTAMP */
3005
3015#if defined(CONFIG_NET_PROMISCUOUS_MODE)
3016int net_if_set_promisc(struct net_if *iface);
3017#else
3018static inline int net_if_set_promisc(struct net_if *iface)
3019{
3020 ARG_UNUSED(iface);
3021
3022 return -ENOTSUP;
3023}
3024#endif
3025
3031#if defined(CONFIG_NET_PROMISCUOUS_MODE)
3032void net_if_unset_promisc(struct net_if *iface);
3033#else
3034static inline void net_if_unset_promisc(struct net_if *iface)
3035{
3036 ARG_UNUSED(iface);
3037}
3038#endif
3039
3048#if defined(CONFIG_NET_PROMISCUOUS_MODE)
3049bool net_if_is_promisc(struct net_if *iface);
3050#else
3051static inline bool net_if_is_promisc(struct net_if *iface)
3052{
3053 ARG_UNUSED(iface);
3054
3055 return false;
3056}
3057#endif
3058
3068static inline bool net_if_are_pending_tx_packets(struct net_if *iface)
3069{
3070#if defined(CONFIG_NET_POWER_MANAGEMENT)
3071 return !!iface->tx_pending;
3072#else
3073 ARG_UNUSED(iface);
3074
3075 return false;
3076#endif
3077}
3078
3079#ifdef CONFIG_NET_POWER_MANAGEMENT
3087int net_if_suspend(struct net_if *iface);
3088
3096int net_if_resume(struct net_if *iface);
3097
3105bool net_if_is_suspended(struct net_if *iface);
3106#endif /* CONFIG_NET_POWER_MANAGEMENT */
3107
3115bool net_if_is_wifi(struct net_if *iface);
3116
3123
3130
3137
3152int net_if_get_name(struct net_if *iface, char *buf, int len);
3153
3168int net_if_set_name(struct net_if *iface, const char *buf);
3169
3177int net_if_get_by_name(const char *name);
3178
3180struct net_if_api {
3181 void (*init)(struct net_if *iface);
3182};
3183
3184#define NET_IF_DHCPV4_INIT \
3185 IF_ENABLED(UTIL_AND(IS_ENABLED(CONFIG_NET_DHCPV4), \
3186 IS_ENABLED(CONFIG_NET_NATIVE_IPV4)), \
3187 (.dhcpv4.state = NET_DHCPV4_DISABLED,))
3188
3189#define NET_IF_DHCPV6_INIT \
3190 IF_ENABLED(UTIL_AND(IS_ENABLED(CONFIG_NET_DHCPV6), \
3191 IS_ENABLED(CONFIG_NET_NATIVE_IPV6)), \
3192 (.dhcpv6.state = NET_DHCPV6_DISABLED,))
3193
3194#define NET_IF_CONFIG_INIT \
3195 .config = { \
3196 IF_ENABLED(CONFIG_NET_IP, (.ip = {},)) \
3197 NET_IF_DHCPV4_INIT \
3198 NET_IF_DHCPV6_INIT \
3199 }
3200
3201#define NET_IF_GET_NAME(dev_id, sfx) __net_if_##dev_id##_##sfx
3202#define NET_IF_DEV_GET_NAME(dev_id, sfx) __net_if_dev_##dev_id##_##sfx
3203
3204#define NET_IF_GET(dev_id, sfx) \
3205 ((struct net_if *)&NET_IF_GET_NAME(dev_id, sfx))
3206
3207#define NET_IF_INIT(dev_id, sfx, _l2, _mtu, _num_configs) \
3208 static STRUCT_SECTION_ITERABLE(net_if_dev, \
3209 NET_IF_DEV_GET_NAME(dev_id, sfx)) = { \
3210 .dev = &(DEVICE_NAME_GET(dev_id)), \
3211 .l2 = &(NET_L2_GET_NAME(_l2)), \
3212 .l2_data = &(NET_L2_GET_DATA(dev_id, sfx)), \
3213 .mtu = _mtu, \
3214 .flags = {BIT(NET_IF_LOWER_UP)}, \
3215 }; \
3216 static Z_DECL_ALIGN(struct net_if) \
3217 NET_IF_GET_NAME(dev_id, sfx)[_num_configs] \
3218 __used __in_section(_net_if, static, \
3219 dev_id) = { \
3220 [0 ... (_num_configs - 1)] = { \
3221 .if_dev = &(NET_IF_DEV_GET_NAME(dev_id, sfx)), \
3222 NET_IF_CONFIG_INIT \
3223 } \
3224 }
3225
3226#define NET_IF_OFFLOAD_INIT(dev_id, sfx, _mtu) \
3227 static STRUCT_SECTION_ITERABLE(net_if_dev, \
3228 NET_IF_DEV_GET_NAME(dev_id, sfx)) = { \
3229 .dev = &(DEVICE_NAME_GET(dev_id)), \
3230 .mtu = _mtu, \
3231 .l2 = &(NET_L2_GET_NAME(OFFLOADED_NETDEV)), \
3232 .flags = {BIT(NET_IF_LOWER_UP)}, \
3233 }; \
3234 static Z_DECL_ALIGN(struct net_if) \
3235 NET_IF_GET_NAME(dev_id, sfx)[NET_IF_MAX_CONFIGS] \
3236 __used __in_section(_net_if, static, \
3237 dev_id) = { \
3238 [0 ... (NET_IF_MAX_CONFIGS - 1)] = { \
3239 .if_dev = &(NET_IF_DEV_GET_NAME(dev_id, sfx)), \
3240 NET_IF_CONFIG_INIT \
3241 } \
3242 }
3243
3246/* Network device initialization macros */
3247
3248#define Z_NET_DEVICE_INIT_INSTANCE(node_id, dev_id, name, instance, \
3249 init_fn, pm, data, config, prio, \
3250 api, l2, l2_ctx_type, mtu) \
3251 Z_DEVICE_STATE_DEFINE(dev_id); \
3252 Z_DEVICE_DEFINE(node_id, dev_id, name, init_fn, pm, data, \
3253 config, POST_KERNEL, prio, api, \
3254 &Z_DEVICE_STATE_NAME(dev_id)); \
3255 NET_L2_DATA_INIT(dev_id, instance, l2_ctx_type); \
3256 NET_IF_INIT(dev_id, instance, l2, mtu, NET_IF_MAX_CONFIGS)
3257
3258#define Z_NET_DEVICE_INIT(node_id, dev_id, name, init_fn, pm, data, \
3259 config, prio, api, l2, l2_ctx_type, mtu) \
3260 Z_NET_DEVICE_INIT_INSTANCE(node_id, dev_id, name, 0, init_fn, \
3261 pm, data, config, prio, api, l2, \
3262 l2_ctx_type, mtu)
3263
3283#define NET_DEVICE_INIT(dev_id, name, init_fn, pm, data, config, prio, \
3284 api, l2, l2_ctx_type, mtu) \
3285 Z_NET_DEVICE_INIT(DT_INVALID_NODE, dev_id, name, init_fn, pm, \
3286 data, config, prio, api, l2, l2_ctx_type, mtu)
3287
3306#define NET_DEVICE_DT_DEFINE(node_id, init_fn, pm, data, \
3307 config, prio, api, l2, l2_ctx_type, mtu) \
3308 Z_NET_DEVICE_INIT(node_id, Z_DEVICE_DT_DEV_ID(node_id), \
3309 DEVICE_DT_NAME(node_id), init_fn, pm, data, \
3310 config, prio, api, l2, l2_ctx_type, mtu)
3311
3320#define NET_DEVICE_DT_INST_DEFINE(inst, ...) \
3321 NET_DEVICE_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
3322
3346#define NET_DEVICE_INIT_INSTANCE(dev_id, name, instance, init_fn, pm, \
3347 data, config, prio, api, l2, \
3348 l2_ctx_type, mtu) \
3349 Z_NET_DEVICE_INIT_INSTANCE(DT_INVALID_NODE, dev_id, name, \
3350 instance, init_fn, pm, data, config, \
3351 prio, api, l2, l2_ctx_type, mtu)
3352
3375#define NET_DEVICE_DT_DEFINE_INSTANCE(node_id, instance, init_fn, pm, \
3376 data, config, prio, api, l2, \
3377 l2_ctx_type, mtu) \
3378 Z_NET_DEVICE_INIT_INSTANCE(node_id, \
3379 Z_DEVICE_DT_DEV_ID(node_id), \
3380 DEVICE_DT_NAME(node_id), instance, \
3381 init_fn, pm, data, config, prio, \
3382 api, l2, l2_ctx_type, mtu)
3383
3393#define NET_DEVICE_DT_INST_DEFINE_INSTANCE(inst, ...) \
3394 NET_DEVICE_DT_DEFINE_INSTANCE(DT_DRV_INST(inst), __VA_ARGS__)
3395
3396#define Z_NET_DEVICE_OFFLOAD_INIT(node_id, dev_id, name, init_fn, pm, \
3397 data, config, prio, api, mtu) \
3398 Z_DEVICE_STATE_DEFINE(dev_id); \
3399 Z_DEVICE_DEFINE(node_id, dev_id, name, init_fn, pm, data, \
3400 config, POST_KERNEL, prio, api, \
3401 &Z_DEVICE_STATE_NAME(dev_id)); \
3402 NET_IF_OFFLOAD_INIT(dev_id, 0, mtu)
3403
3423#define NET_DEVICE_OFFLOAD_INIT(dev_id, name, init_fn, pm, data, \
3424 config, prio, api, mtu) \
3425 Z_NET_DEVICE_OFFLOAD_INIT(DT_INVALID_NODE, dev_id, name, \
3426 init_fn, pm, data, config, prio, api, \
3427 mtu)
3428
3447#define NET_DEVICE_DT_OFFLOAD_DEFINE(node_id, init_fn, pm, data, \
3448 config, prio, api, mtu) \
3449 Z_NET_DEVICE_OFFLOAD_INIT(node_id, Z_DEVICE_DT_DEV_ID(node_id), \
3450 DEVICE_DT_NAME(node_id), init_fn, pm, \
3451 data, config, prio, api, mtu)
3452
3462#define NET_DEVICE_DT_INST_OFFLOAD_DEFINE(inst, ...) \
3463 NET_DEVICE_DT_OFFLOAD_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
3464
3470#define NET_IFACE_COUNT(_dst) \
3471 do { \
3472 extern struct net_if _net_if_list_start[]; \
3473 extern struct net_if _net_if_list_end[]; \
3474 *(_dst) = ((uintptr_t)_net_if_list_end - \
3475 (uintptr_t)_net_if_list_start) / \
3476 sizeof(struct net_if); \
3477 } while (0)
3478
3479#ifdef __cplusplus
3480}
3481#endif
3482
3483#include <zephyr/syscalls/net_if.h>
3484
3489#endif /* ZEPHYR_INCLUDE_NET_NET_IF_H_ */
struct z_thread_stack_element k_thread_stack_t
Typedef of struct z_thread_stack_element.
Definition arch_interface.h:46
long atomic_t
Definition atomic_types.h:15
DHCPv4 Client Handler.
DHCPv6 client.
static void atomic_set_bit(atomic_t *target, int bit)
Atomically set a bit.
Definition atomic.h:209
static bool atomic_test_bit(const atomic_t *target, int bit)
Atomically get and test a bit.
Definition atomic.h:127
static void atomic_clear_bit(atomic_t *target, int bit)
Atomically clear a bit.
Definition atomic.h:191
#define ATOMIC_DEFINE(name, num_bits)
Define an array of atomic variables.
Definition atomic.h:111
static bool atomic_test_and_clear_bit(atomic_t *target, int bit)
Atomically clear a bit and test it.
Definition atomic.h:147
static bool atomic_test_and_set_bit(atomic_t *target, int bit)
Atomically set a bit and test it.
Definition atomic.h:170
#define K_FOREVER
Generate infinite timeout delay.
Definition kernel.h:1440
unsigned short int sa_family_t
Socket address family type.
Definition net_ip.h:168
net_addr_state
What is the current state of the network address.
Definition net_ip.h:526
net_addr_type
How the network address is assigned to network interface.
Definition net_ip.h:534
int k_mutex_unlock(struct k_mutex *mutex)
Unlock a mutex.
int k_mutex_lock(struct k_mutex *mutex, k_timeout_t timeout)
Lock a mutex.
net_verdict
Net Verdict.
Definition net_core.h:102
static int net_hostname_set_postfix(const uint8_t *hostname_postfix, int postfix_len)
Set the device hostname postfix.
Definition hostname.h:111
struct net_if * net_if_select_src_iface(const struct sockaddr *dst)
Get a network interface that should be used when sending IPv6 or IPv4 network data to destination.
struct net_if_router * net_if_ipv4_router_lookup(struct net_if *iface, struct in_addr *addr)
Check if IPv4 address is one of the routers configured in the system.
int net_if_get_by_iface(struct net_if *iface)
Get interface index according to pointer.
int net_if_up(struct net_if *iface)
Bring interface up.
struct net_if * net_if_get_first_up(void)
Get the first network interface which is up.
struct net_if_addr * net_if_ipv4_addr_lookup(const struct in_addr *addr, struct net_if **iface)
Check if this IPv4 address belongs to one of the interfaces.
int net_if_set_name(struct net_if *iface, const char *buf)
Set network interface name.
static bool net_if_is_carrier_ok(struct net_if *iface)
Check if carrier is present on network device.
Definition net_if.h:2890
static bool net_if_is_admin_up(struct net_if *iface)
Check if interface was brought up by the administrator.
Definition net_if.h:2856
void net_if_set_default(struct net_if *iface)
Set the default network interface.
int net_if_ipv4_addr_lookup_by_index(const struct in_addr *addr)
Check if this IPv4 address belongs to one of the interface indices.
void(* net_if_mcast_callback_t)(struct net_if *iface, const struct net_addr *addr, bool is_joined)
Define a callback that is called whenever a IPv6 or IPv4 multicast address group is joined or left.
Definition net_if.h:1578
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:2661
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:867
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:2392
void net_if_ipv6_prefix_unset_timer(struct net_if_ipv6_prefix *prefix)
Unset the prefix lifetime timer.
struct net_if_ipv6_prefix * net_if_ipv6_prefix_add(struct net_if *iface, struct in6_addr *prefix, uint8_t len, uint32_t lifetime)
Add a IPv6 prefix to an network interface.
void net_if_ipv4_set_gw(struct net_if *iface, const struct in_addr *gw)
Set IPv4 gateway for an interface.
int net_if_config_ipv4_get(struct net_if *iface, struct net_if_ipv4 **ipv4)
Allocate network interface IPv4 config.
void net_if_carrier_on(struct net_if *iface)
Underlying network device has detected the carrier (cable connected).
struct net_if_router * net_if_ipv6_router_find_default(struct net_if *iface, struct in6_addr *addr)
Find default router for this IPv6 address.
bool net_if_ipv6_prefix_rm(struct net_if *iface, struct in6_addr *addr, uint8_t len)
Remove an IPv6 prefix from an interface.
void net_if_mcast_monitor(struct net_if *iface, const struct net_addr *addr, bool is_joined)
Call registered multicast monitors.
static void * net_if_l2_data(struct net_if *iface)
Get a pointer to the interface L2 private data.
Definition net_if.h:939
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:3068
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:797
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:1088
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:2055
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:1161
static struct net_offload * net_if_offload(struct net_if *iface)
Return the IP offload plugin.
Definition net_if.h:1005
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:1229
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:780
struct net_if * net_if_get_default(void)
Get the default network interface.
void net_if_ipv4_set_ttl(struct net_if *iface, uint8_t ttl)
Set IPv4 time-to-live value specified to a given interface.
bool net_if_ipv4_addr_mask_cmp(struct net_if *iface, const struct in_addr *addr)
Check if the given IPv4 address belongs to local subnet.
void net_if_queue_tx(struct net_if *iface, struct net_pkt *pkt)
Queue a packet to the net interface TX queue.
int net_if_config_ipv6_get(struct net_if *iface, struct net_if_ipv6 **ipv6)
Allocate network interface IPv6 config.
static uint8_t net_if_ipv6_get_mcast_hop_limit(struct net_if *iface)
Get IPv6 multicast hop limit specified for a given interface.
Definition net_if.h:1894
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:1860
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:2083
int net_if_get_name(struct net_if *iface, char *buf, int len)
Get network interface name.
bool net_if_ipv6_addr_rm(struct net_if *iface, const struct in6_addr *addr)
Remove an IPv6 address from an interface.
static uint8_t net_if_ipv6_get_hop_limit(struct net_if *iface)
Get IPv6 hop limit specified for a given interface.
Definition net_if.h:1843
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:977
static bool net_if_is_dormant(struct net_if *iface)
Check if the interface is dormant.
Definition net_if.h:2926
struct net_if * net_if_get_first_wifi(void)
Get first Wi-Fi network interface.
struct net_if_addr * net_if_ipv4_addr_add(struct net_if *iface, struct in_addr *addr, enum net_addr_type addr_type, uint32_t vlifetime)
Add a IPv4 address to an interface.
uint8_t net_if_ipv4_get_mcast_ttl(struct net_if *iface)
Get IPv4 multicast time-to-live value specified for a given interface.
void(* net_if_ip_maddr_cb_t)(struct net_if *iface, struct net_if_mcast_addr *maddr, void *user_data)
Callback used while iterating over network interface multicast IP addresses.
Definition net_if.h:1540
struct net_if * net_if_get_by_index(int index)
Get interface according to index.
enum net_verdict net_if_recv_data(struct net_if *iface, struct net_pkt *pkt)
Input a packet through a net iface.
struct net_if * net_if_get_first_by_type(const struct net_l2 *l2)
Get the first network interface according to its type.
static void net_if_set_mtu(struct net_if *iface, uint16_t mtu)
Set an network interface's MTU.
Definition net_if.h:1264
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:2832
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:1981
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:2727
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:1118
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:3034
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:1046
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:1950
static bool net_if_is_promisc(struct net_if *iface)
Check if promiscuous mode is set or not.
Definition net_if.h:3051
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:2362
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:1719
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:1140
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:1925
struct net_if_addr * net_if_ipv6_addr_lookup_by_iface(struct net_if *iface, struct in6_addr *addr)
Check if this IPv6 address belongs to this specific interfaces.
void(* net_if_ip_addr_cb_t)(struct net_if *iface, struct net_if_addr *addr, void *user_data)
Callback used while iterating over network interface IP addresses.
Definition net_if.h:1496
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:829
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:1646
bool net_if_ipv6_addr_rm_by_index(int index, const struct in6_addr *addr)
Remove an IPv6 address from an interface by index.
void(* net_if_cb_t)(struct net_if *iface, void *user_data)
Callback used while iterating over network interfaces.
Definition net_if.h:2805
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:1247
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:2507
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:2000
struct in_addr * net_if_ipv4_get_global_addr(struct net_if *iface, enum net_addr_state addr_state)
Get a IPv4 global address in a given state.
enum net_verdict net_if_send_data(struct net_if *iface, struct net_pkt *pkt)
Send a packet through a net iface.
struct net_if_mcast_addr * net_if_ipv6_maddr_lookup(const struct in6_addr *addr, struct net_if **iface)
Check if this IPv6 multicast address belongs to a specific interface or one of the interfaces.
struct net_if * net_if_lookup_by_dev(const struct device *dev)
Find an interface from it's related device.
static struct in6_addr * net_if_router_ipv6(struct net_if_router *router)
Get the IPv6 address of the given router.
Definition net_if.h:1767
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:2024
bool net_if_ipv4_set_gw_by_index(int index, const struct in_addr *gw)
Set IPv4 gateway for an interface index.
struct in_addr net_if_ipv4_get_netmask_by_addr(struct net_if *iface, const struct in_addr *addr)
Get IPv4 netmask related to an address of an interface.
net_if_oper_state
Network interface operational status (RFC 2863).
Definition net_if.h:288
struct net_if_addr * net_if_ipv6_addr_add(struct net_if *iface, struct in6_addr *addr, enum net_addr_type addr_type, uint32_t vlifetime)
Add a IPv6 address to an interface.
static struct net_if * net_if_ipv6_select_src_iface(const struct in6_addr *dst)
Get a network interface that should be used when sending IPv6 network data to destination.
Definition net_if.h:2106
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:846
static struct net_if_config * net_if_config_get(struct net_if *iface)
Get network interface IP config.
Definition net_if.h:1315
static struct net_if_config * net_if_get_config(struct net_if *iface)
Return network configuration for this network interface.
Definition net_if.h:1103
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:1282
net_if_flag
Network interface flags.
Definition net_if.h:230
void net_if_ipv4_maddr_foreach(struct net_if *iface, net_if_ip_maddr_cb_t cb, void *user_data)
Go through all IPv4 multicast addresses on a network interface and call callback for each used addres...
struct net_if_ipv6_prefix * net_if_ipv6_prefix_get(struct net_if *iface, const struct in6_addr *addr)
Return prefix that corresponds to this IPv6 address.
static const struct device * net_if_get_device(struct net_if *iface)
Get an network interface's device.
Definition net_if.h:954
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:628
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:1026
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:1911
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:3018
static const struct net_l2 * net_if_l2(struct net_if *iface)
Get a pointer to the interface L2.
Definition net_if.h:913
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:1067
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:2483
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:812
@ NET_IF_CHECKSUM_IPV4_ICMP
Interface supports checksum calculation for ICMP4 payload in IPv4.
Definition net_if.h:2737
@ NET_IF_CHECKSUM_IPV6_TCP
Interface supports checksum calculation for TCP payload in IPv6.
Definition net_if.h:2741
@ NET_IF_CHECKSUM_IPV6_UDP
Interface supports checksum calculation for UDP payload in IPv6.
Definition net_if.h:2744
@ NET_IF_CHECKSUM_IPV4_HEADER
Interface supports IP version 4 header checksum calculation.
Definition net_if.h:2729
@ NET_IF_CHECKSUM_IPV4_TCP
Interface supports checksum calculation for TCP payload in IPv4.
Definition net_if.h:2731
@ NET_IF_CHECKSUM_IPV6_HEADER
Interface supports IP version 6 header checksum calculation.
Definition net_if.h:2739
@ NET_IF_CHECKSUM_IPV6_ICMP
Interface supports checksum calculation for ICMP6 payload in IPv6.
Definition net_if.h:2747
@ NET_IF_CHECKSUM_IPV4_UDP
Interface supports checksum calculation for UDP payload in IPv4.
Definition net_if.h:2734
@ NET_IF_OPER_TESTING
Training mode.
Definition net_if.h:293
@ NET_IF_OPER_DORMANT
Waiting external action.
Definition net_if.h:294
@ NET_IF_OPER_UP
Interface is up.
Definition net_if.h:295
@ NET_IF_OPER_NOTPRESENT
Hardware missing.
Definition net_if.h:290
@ NET_IF_OPER_UNKNOWN
Initial (unknown) value.
Definition net_if.h:289
@ NET_IF_OPER_DOWN
Interface is down.
Definition net_if.h:291
@ NET_IF_OPER_LOWERLAYERDOWN
Lower layer interface is down.
Definition net_if.h:292
@ NET_IF_NO_AUTO_START
Do not start the interface immediately after initialization.
Definition net_if.h:246
@ NET_IF_IPV6_NO_MLD
IPv6 Multicast Listener Discovery disabled.
Definition net_if.h:276
@ NET_IF_POINTOPOINT
Interface is pointopoint.
Definition net_if.h:235
@ NET_IF_IPV6_NO_ND
IPv6 Neighbor Discovery disabled.
Definition net_if.h:273
@ NET_IF_FORWARD_MULTICASTS
Flag defines if received multicasts of other interface are forwarded on this interface.
Definition net_if.h:255
@ NET_IF_IPV4
Interface supports IPv4.
Definition net_if.h:258
@ NET_IF_PROMISC
Interface is in promiscuous mode.
Definition net_if.h:238
@ NET_IF_DORMANT
Driver signals dormant.
Definition net_if.h:270
@ NET_IF_SUSPENDED
Power management specific: interface is being suspended.
Definition net_if.h:249
@ NET_IF_IPV6
Interface supports IPv6.
Definition net_if.h:261
@ NET_IF_UP
Interface is admin up.
Definition net_if.h:232
@ NET_IF_LOWER_UP
Driver signals L1 is up.
Definition net_if.h:267
@ NET_IF_RUNNING
Interface up and running (ready to receive and transmit).
Definition net_if.h:264
@ NET_IF_NO_TX_LOCK
Mutex locking on TX data path disabled on the interface.
Definition net_if.h:279
net_link_type
Type of the link address.
Definition net_linkaddr.h:49
struct _slist sys_slist_t
Single-linked list structure.
Definition slist.h:49
struct _snode sys_snode_t
Single-linked list node structure.
Definition slist.h:39
#define ENOTSUP
Unsupported value.
Definition errno.h:114
#define EPERM
Not owner.
Definition errno.h:39
Hostname configuration definitions.
IPv4 Autoconfiguration.
net_ipv4_autoconf_state
Current state of IPv4 Autoconfiguration.
Definition ipv4_autoconf.h:15
Network core definitions.
IPv6 and IPv4 definitions.
Public API for network L2 interface.
Public API for network link address.
Network statistics.
Network timer with wrap around.
flags
Definition parser.h:96
state
Definition parser_state.h:29
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__INT32_TYPE__ int32_t
Definition stdint.h:74
__UINT64_TYPE__ uint64_t
Definition stdint.h:91
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
__INT64_TYPE__ int64_t
Definition stdint.h:75
__INT16_TYPE__ int16_t
Definition stdint.h:73
Runtime device structure (in ROM) per driver instance.
Definition device.h:412
IPv6 address struct.
Definition net_ip.h:143
IPv4 address struct.
Definition net_ip.h:155
Definition kernel.h:2468
Mutex Structure.
Definition kernel.h:2994
Thread Structure.
Definition thread.h:259
Kernel timepoint type.
Definition sys_clock.h:225
DHCPv6 client configuration parameters.
Definition dhcpv6.h:63
Network Interface unicast IPv4 address and netmask.
Definition net_if.h:449
struct net_if_addr ipv4
IPv4 address.
Definition net_if.h:451
struct in_addr netmask
Netmask.
Definition net_if.h:453
Network Interface unicast IP addresses.
Definition net_if.h:54
struct net_addr address
IP address.
Definition net_if.h:56
uint8_t is_mesh_local
Is this IP address usage limited to the subnet (mesh) or not.
Definition net_if.h:130
uint8_t is_temporary
Is this IP address temporary and generated for example by IPv6 privacy extension (RFC 8981)
Definition net_if.h:135
enum net_addr_state addr_state
What is the current state of the address.
Definition net_if.h:71
uint8_t is_infinite
Is the IP address valid forever.
Definition net_if.h:124
atomic_t atomic_ref
Reference counter.
Definition net_if.h:61
enum net_addr_type addr_type
How the IP address was set.
Definition net_if.h:68
uint8_t is_used
Is this IP address used or not.
Definition net_if.h:127
IP and other configuration related data for network interface.
Definition net_if.h:567
Network Interface Device structure.
Definition net_if.h:644
enum net_if_oper_state oper_state
RFC 2863 operational status.
Definition net_if.h:680
const struct net_l2 *const l2
Interface's L2 layer.
Definition net_if.h:649
void * l2_data
Interface's private L2 data pointer.
Definition net_if.h:652
uint16_t mtu
The hardware MTU.
Definition net_if.h:670
const struct device * dev
The actually device driver instance the net_if is related to.
Definition net_if.h:646
struct net_linkaddr link_addr
The hardware link address.
Definition net_if.h:658
atomic_t flags[ATOMIC_BITMAP_SIZE(NET_IF_NUM_FLAGS)]
For internal use.
Definition net_if.h:655
Network interface IP address configuration.
Definition net_if.h:554
IPv4 configuration.
Definition net_if.h:457
uint8_t mcast_ttl
IPv4 time-to-live for multicast packets.
Definition net_if.h:471
struct net_if_addr_ipv4 unicast[NET_IF_MAX_IPV4_ADDR]
Unicast IP addresses.
Definition net_if.h:459
struct in_addr gw
Gateway.
Definition net_if.h:465
uint8_t ttl
IPv4 time-to-live.
Definition net_if.h:468
struct net_if_mcast_addr mcast[NET_IF_MAX_IPV4_MADDR]
Multicast IP addresses.
Definition net_if.h:462
Network Interface IPv6 prefixes.
Definition net_if.h:174
struct net_if * iface
Backpointer to network interface where this prefix is used.
Definition net_if.h:182
uint8_t is_infinite
Is the IP prefix valid forever.
Definition net_if.h:188
uint8_t len
Prefix length.
Definition net_if.h:185
struct in6_addr prefix
IPv6 prefix.
Definition net_if.h:179
uint8_t is_used
Is this prefix used or not.
Definition net_if.h:191
struct net_timeout lifetime
Prefix lifetime.
Definition net_if.h:176
IPv6 configuration.
Definition net_if.h:315
struct net_if_ipv6_prefix prefix[NET_IF_MAX_IPV6_PREFIX]
Prefixes.
Definition net_if.h:323
uint32_t base_reachable_time
Default reachable time (RFC 4861, page 52)
Definition net_if.h:326
uint8_t hop_limit
IPv6 hop limit.
Definition net_if.h:364
struct net_if_mcast_addr mcast[NET_IF_MAX_IPV6_MADDR]
Multicast IP addresses.
Definition net_if.h:320
uint32_t retrans_timer
Retransmit timer (RFC 4861, page 52)
Definition net_if.h:332
struct net_if_addr unicast[NET_IF_MAX_IPV6_ADDR]
Unicast IP addresses.
Definition net_if.h:317
uint8_t mcast_hop_limit
IPv6 multicast hop limit.
Definition net_if.h:367
uint32_t reachable_time
Reachable time (RFC 4861, page 20)
Definition net_if.h:329
Network Interface multicast IP addresses.
Definition net_if.h:145
struct net_addr address
IP address.
Definition net_if.h:147
uint8_t is_joined
Did we join to this group.
Definition net_if.h:164
uint8_t is_used
Is this multicast IP address used or not.
Definition net_if.h:161
Multicast monitor handler struct.
Definition net_if.h:1590
sys_snode_t node
Node information for the slist.
Definition net_if.h:1592
net_if_mcast_callback_t cb
Multicast callback.
Definition net_if.h:1598
struct net_if * iface
Network interface.
Definition net_if.h:1595
Information about routers in the system.
Definition net_if.h:201
struct net_if * iface
Network interface the router is connected to.
Definition net_if.h:209
uint8_t is_default
Is default router.
Definition net_if.h:221
uint16_t lifetime
Router lifetime.
Definition net_if.h:215
uint8_t is_infinite
Is the router valid forever.
Definition net_if.h:224
uint8_t is_used
Is this router used or not.
Definition net_if.h:218
struct net_addr address
IP address.
Definition net_if.h:206
sys_snode_t node
Slist lifetime timer node.
Definition net_if.h:203
uint32_t life_start
Router life timer start.
Definition net_if.h:212
Network Interface structure.
Definition net_if.h:690
struct net_if_dev * if_dev
The net_if_dev instance the net_if is related to.
Definition net_if.h:692
struct net_if_config config
Network interface instance configuration.
Definition net_if.h:700
uint8_t pe_enabled
Network interface specific flags.
Definition net_if.h:720
struct k_mutex lock
Mutex protecting this network interface instance.
Definition net_if.h:711
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:725
struct k_mutex tx_lock
Mutex used when sending data.
Definition net_if.h:714
Network L2 structure.
Definition net_l2.h:57
Hardware link address structure.
Definition net_linkaddr.h:69
uint8_t * addr
The array of byte representing the address.
Definition net_linkaddr.h:71
uint8_t type
What kind of address is this for.
Definition net_linkaddr.h:77
uint8_t len
Length of that address array.
Definition net_linkaddr.h:74
Network packet.
Definition net_pkt.h:91
All network statistics in one struct.
Definition net_stats.h:367
Generic struct for handling network timeouts.
Definition net_timeout.h:57
Network traffic class.
Definition net_if.h:611
k_thread_stack_t * stack
Stack for this handler.
Definition net_if.h:619
struct k_thread handler
Traffic class handler thread.
Definition net_if.h:616
struct k_fifo fifo
Fifo for handling this Tx or Rx packet.
Definition net_if.h:613
Generic sockaddr struct.
Definition net_ip.h:408