Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 | /* * Copyright (c) 2016 Intel Corporation. * * SPDX-License-Identifier: Apache-2.0 */ /** * @file * @brief Public API for network interface */ #ifndef ZEPHYR_INCLUDE_NET_NET_IF_H_ #define ZEPHYR_INCLUDE_NET_NET_IF_H_ /** * @brief Network Interface abstraction layer * @defgroup net_if Network Interface abstraction layer * @ingroup networking * @{ */ #include <device.h> #include <sys/slist.h> #include <net/net_core.h> #include <net/hostname.h> #include <net/net_linkaddr.h> #include <net/net_ip.h> #include <net/net_l2.h> #include <net/net_stats.h> #include <net/net_timeout.h> #if defined(CONFIG_NET_DHCPV4) && defined(CONFIG_NET_NATIVE_IPV4) #include <net/dhcpv4.h> #endif #if defined(CONFIG_NET_IPV4_AUTO) && defined(CONFIG_NET_NATIVE_IPV4) #include <net/ipv4_autoconf.h> #endif #ifdef __cplusplus extern "C" { #endif /** * @brief Network Interface unicast IP addresses * * Stores the unicast IP addresses assigned to this network interface. */ struct net_if_addr { /** IP address */ struct net_addr address; #if defined(CONFIG_NET_NATIVE_IPV6) struct net_timeout lifetime; #endif #if defined(CONFIG_NET_IPV6_DAD) && defined(CONFIG_NET_NATIVE_IPV6) /** Duplicate address detection (DAD) timer */ sys_snode_t dad_node; u32_t dad_start; #endif /** How the IP address was set */ enum net_addr_type addr_type; /** What is the current state of the address */ enum net_addr_state addr_state; #if defined(CONFIG_NET_IPV6_DAD) && defined(CONFIG_NET_NATIVE_IPV6) /** How many times we have done DAD */ u8_t dad_count; #endif /** Is the IP address valid forever */ u8_t is_infinite : 1; /** Is this IP address used or not */ u8_t is_used : 1; /** Is this IP address usage limited to the subnet (mesh) or not */ u8_t is_mesh_local : 1; u8_t _unused : 5; }; /** * @brief Network Interface multicast IP addresses * * Stores the multicast IP addresses assigned to this network interface. */ struct net_if_mcast_addr { /** IP address */ struct net_addr address; /** Is this multicast IP address used or not */ u8_t is_used : 1; /** Did we join to this group */ u8_t is_joined : 1; u8_t _unused : 6; }; /** * @brief Network Interface IPv6 prefixes * * Stores the multicast IP addresses assigned to this network interface. */ struct net_if_ipv6_prefix { /** Prefix lifetime */ struct net_timeout lifetime; /** IPv6 prefix */ struct in6_addr prefix; /** Backpointer to network interface where this prefix is used */ struct net_if *iface; /** Prefix length */ u8_t len; /** Is the IP prefix valid forever */ u8_t is_infinite : 1; /** Is this prefix used or not */ u8_t is_used : 1; u8_t _unused : 6; }; /** * @brief Information about routers in the system. * * Stores the router information. */ struct net_if_router { /** Slist lifetime timer node */ sys_snode_t node; /** IP address */ struct net_addr address; /** Network interface the router is connected to */ struct net_if *iface; /** Router life timer start */ u32_t life_start; /** Router lifetime */ u16_t lifetime; /** Is this router used or not */ u8_t is_used : 1; /** Is default router */ u8_t is_default : 1; /** Is the router valid forever */ u8_t is_infinite : 1; u8_t _unused : 5; }; /* * Special alignment is needed for net_if which is stored in * a net_if linker section if there are more than one network * interface in the system. If there is only one network interface, * then this alignment is not needed, unfortunately this cannot be * known beforehand. * * The net_if struct needs to be aligned to 32 byte boundary, * otherwise the __net_if_end will point to wrong location and net_if * initialization done in net_if_init() will not find proper values * for the second interface. * * So this alignment is a workaround and should eventually be removed. */ #define __net_if_align __aligned(32) enum net_if_flag { /** Interface is up/ready to receive and transmit */ NET_IF_UP, /** Interface is pointopoint */ NET_IF_POINTOPOINT, /** Interface is in promiscuous mode */ NET_IF_PROMISC, /** Do not start the interface immediately after initialization. * This requires that either the device driver or some other entity * will need to manually take the interface up when needed. * For example for Ethernet this will happen when the driver calls * the net_eth_carrier_on() function. */ NET_IF_NO_AUTO_START, /** @cond INTERNAL_HIDDEN */ /* Total number of flags - must be at the end of the enum */ NET_IF_NUM_FLAGS /** @endcond */ }; #if defined(CONFIG_NET_OFFLOAD) struct net_offload; #endif /* CONFIG_NET_OFFLOAD */ /** @cond INTERNAL_HIDDEN */ #if defined(CONFIG_NET_NATIVE_IPV6) #define NET_IF_MAX_IPV6_ADDR CONFIG_NET_IF_UNICAST_IPV6_ADDR_COUNT #define NET_IF_MAX_IPV6_MADDR CONFIG_NET_IF_MCAST_IPV6_ADDR_COUNT #define NET_IF_MAX_IPV6_PREFIX CONFIG_NET_IF_IPV6_PREFIX_COUNT #else #define NET_IF_MAX_IPV6_ADDR 0 #define NET_IF_MAX_IPV6_MADDR 0 #define NET_IF_MAX_IPV6_PREFIX 0 #endif /* @endcond */ struct net_if_ipv6 { /** Unicast IP addresses */ struct net_if_addr unicast[NET_IF_MAX_IPV6_ADDR]; /** Multicast IP addresses */ struct net_if_mcast_addr mcast[NET_IF_MAX_IPV6_MADDR]; /** Prefixes */ struct net_if_ipv6_prefix prefix[NET_IF_MAX_IPV6_PREFIX]; /** Default reachable time (RFC 4861, page 52) */ u32_t base_reachable_time; /** Reachable time (RFC 4861, page 20) */ u32_t reachable_time; /** Retransmit timer (RFC 4861, page 52) */ u32_t retrans_timer; #if defined(CONFIG_NET_IPV6_ND) && defined(CONFIG_NET_NATIVE_IPV6) /** Router solicitation timer node */ sys_snode_t rs_node; /* RS start time */ u32_t rs_start; /** RS count */ u8_t rs_count; #endif /** IPv6 hop limit */ u8_t hop_limit; }; /** @cond INTERNAL_HIDDEN */ #if defined(CONFIG_NET_NATIVE_IPV4) #define NET_IF_MAX_IPV4_ADDR CONFIG_NET_IF_UNICAST_IPV4_ADDR_COUNT #define NET_IF_MAX_IPV4_MADDR CONFIG_NET_IF_MCAST_IPV4_ADDR_COUNT #else #define NET_IF_MAX_IPV4_ADDR 0 #define NET_IF_MAX_IPV4_MADDR 0 #endif /** @endcond */ struct net_if_ipv4 { /** Unicast IP addresses */ struct net_if_addr unicast[NET_IF_MAX_IPV4_ADDR]; /** Multicast IP addresses */ struct net_if_mcast_addr mcast[NET_IF_MAX_IPV4_MADDR]; /** Gateway */ struct in_addr gw; /** Netmask */ struct in_addr netmask; /** IPv4 time-to-live */ u8_t ttl; }; #if defined(CONFIG_NET_DHCPV4) && defined(CONFIG_NET_NATIVE_IPV4) struct net_if_dhcpv4 { /** Used for timer lists */ sys_snode_t node; /** Timer start */ s64_t timer_start; /** Time for INIT, DISCOVER, REQUESTING, RENEWAL */ u32_t request_time; u32_t xid; /** IP address Lease time */ u32_t lease_time; /** IP address Renewal time */ u32_t renewal_time; /** IP address Rebinding time */ u32_t rebinding_time; /** Server ID */ struct in_addr server_id; /** Requested IP addr */ struct in_addr requested_ip; /** * DHCPv4 client state in the process of network * address allocation. */ enum net_dhcpv4_state state; /** Number of attempts made for REQUEST and RENEWAL messages */ u8_t attempts; }; #endif /* CONFIG_NET_DHCPV4 */ #if defined(CONFIG_NET_IPV4_AUTO) && defined(CONFIG_NET_NATIVE_IPV4) struct net_if_ipv4_autoconf { /** Used for timer lists */ sys_snode_t node; /** Backpointer to correct network interface */ struct net_if *iface; /** Timer start */ s64_t timer_start; /** Time for INIT, DISCOVER, REQUESTING, RENEWAL */ u32_t timer_timeout; /** Current IP addr */ struct in_addr current_ip; /** Requested IP addr */ struct in_addr requested_ip; /** IPV4 Autoconf state in the process of network address allocation. */ enum net_ipv4_autoconf_state state; /** Number of sent probe requests */ u8_t probe_cnt; /** Number of sent announcements */ u8_t announce_cnt; /** Incoming conflict count */ u8_t conflict_cnt; }; #endif /* CONFIG_NET_IPV4_AUTO */ /** @cond INTERNAL_HIDDEN */ /* We always need to have at least one IP config */ #define NET_IF_MAX_CONFIGS 1 /** @endcond */ /** * @brief Network interface IP address configuration. */ struct net_if_ip { #if defined(CONFIG_NET_NATIVE_IPV6) struct net_if_ipv6 *ipv6; #endif /* CONFIG_NET_IPV6 */ #if defined(CONFIG_NET_NATIVE_IPV4) struct net_if_ipv4 *ipv4; #endif /* CONFIG_NET_IPV4 */ }; /** * @brief IP and other configuration related data for network interface. */ struct net_if_config { /** IP address configuration setting */ struct net_if_ip ip; #if defined(CONFIG_NET_DHCPV4) && defined(CONFIG_NET_NATIVE_IPV4) struct net_if_dhcpv4 dhcpv4; #endif /* CONFIG_NET_DHCPV4 */ #if defined(CONFIG_NET_IPV4_AUTO) && defined(CONFIG_NET_NATIVE_IPV4) struct net_if_ipv4_autoconf ipv4auto; #endif /* CONFIG_NET_IPV4_AUTO */ }; /** * @brief Network traffic class. * * Traffic classes are used when sending or receiving data that is classified * with different priorities. So some traffic can be marked as high priority * and it will be sent or received first. There is always at least one work * queue in the system for Rx and Tx. Each network packet that is transmitted * or received goes through a work queue thread that will transmit it. */ struct net_traffic_class { /** Work queue for handling this Tx or Rx packet */ struct k_work_q work_q; /** Stack for this work queue */ k_thread_stack_t *stack; /** Traffic class value */ int tc; }; /** * @brief Network Interface Device structure * * Used to handle a network interface on top of a device driver instance. * There can be many net_if_dev instance against the same device. * * Such interface is mainly to be used by the link layer, but is also tight * to a network context: it then makes the relation with a network context * and the network device. * * Because of the strong relationship between a device driver and such * network interface, each net_if_dev should be instantiated by */ struct net_if_dev { /** The actually device driver instance the net_if is related to */ struct device *dev; /** Interface's L2 layer */ const struct net_l2 * const l2; /** Interface's private L2 data pointer */ void *l2_data; /* For internal use */ ATOMIC_DEFINE(flags, NET_IF_NUM_FLAGS); /** The hardware link address */ struct net_linkaddr link_addr; #if defined(CONFIG_NET_OFFLOAD) /** TCP/IP Offload functions. * If non-NULL, then the TCP/IP stack is located * in the communication chip that is accessed via this * network interface. */ struct net_offload *offload; #endif /* CONFIG_NET_OFFLOAD */ /** The hardware MTU */ u16_t mtu; #if defined(CONFIG_NET_SOCKETS_OFFLOAD) /** Indicate whether interface is offloaded at socket level. */ bool offloaded; #endif /* CONFIG_NET_SOCKETS_OFFLOAD */ }; /** * @brief Network Interface structure * * Used to handle a network interface on top of a net_if_dev instance. * There can be many net_if instance against the same net_if_dev instance. * */ struct net_if { /** The net_if_dev instance the net_if is related to */ struct net_if_dev *if_dev; #if defined(CONFIG_NET_STATISTICS_PER_INTERFACE) /** Network statistics related to this network interface */ struct net_stats stats; #endif /* CONFIG_NET_STATISTICS_PER_INTERFACE */ /** Network interface instance configuration */ struct net_if_config config; } __net_if_align; /** * @brief Set a value in network interface flags * * @param iface Pointer to network interface * @param value Flag value */ static inline void net_if_flag_set(struct net_if *iface, enum net_if_flag value) { NET_ASSERT(iface); atomic_set_bit(iface->if_dev->flags, value); } /** * @brief Test and set a value in network interface flags * * @param iface Pointer to network interface * @param value Flag value * * @return true if the bit was set, false if it wasn't. */ static inline bool net_if_flag_test_and_set(struct net_if *iface, enum net_if_flag value) { NET_ASSERT(iface); return atomic_test_and_set_bit(iface->if_dev->flags, value); } /** * @brief Clear a value in network interface flags * * @param iface Pointer to network interface * @param value Flag value */ static inline void net_if_flag_clear(struct net_if *iface, enum net_if_flag value) { NET_ASSERT(iface); atomic_clear_bit(iface->if_dev->flags, value); } /** * @brief Check if a value in network interface flags is set * * @param iface Pointer to network interface * @param value Flag value * * @return True if the value is set, false otherwise */ static inline bool net_if_flag_is_set(struct net_if *iface, enum net_if_flag value) { NET_ASSERT(iface); return atomic_test_bit(iface->if_dev->flags, value); } /** * @brief Send a packet through a net iface * * @param iface Pointer to a network interface structure * @param pkt Pointer to a net packet to send * * return verdict about the packet */ enum net_verdict net_if_send_data(struct net_if *iface, struct net_pkt *pkt); /** * @brief Get a pointer to the interface L2 * * @param iface a valid pointer to a network interface structure * * @return a pointer to the iface L2 */ static inline const struct net_l2 * const net_if_l2(struct net_if *iface) { return iface->if_dev->l2; } /** * @brief Input a packet through a net iface * * @param iface Pointer to a network interface structure * @param pkt Pointer to a net packet to input * * @return verdict about the packet */ enum net_verdict net_if_recv_data(struct net_if *iface, struct net_pkt *pkt); /** * @brief Get a pointer to the interface L2 private data * * @param iface a valid pointer to a network interface structure * * @return a pointer to the iface L2 data */ static inline void *net_if_l2_data(struct net_if *iface) { return iface->if_dev->l2_data; } /** * @brief Get an network interface's device * * @param iface Pointer to a network interface structure * * @return a pointer to the device driver instance */ static inline struct device *net_if_get_device(struct net_if *iface) { return iface->if_dev->dev; } /** * @brief Queue a packet to the net interface TX queue * * @param iface Pointer to a network interface structure * @param pkt Pointer to a net packet to queue */ void net_if_queue_tx(struct net_if *iface, struct net_pkt *pkt); /** * @brief Return the IP offload status * * @param iface Network interface * * @return True if IP offlining is active, false otherwise. */ static inline bool net_if_is_ip_offloaded(struct net_if *iface) { #if defined(CONFIG_NET_OFFLOAD) return (iface->if_dev->offload != NULL); #else ARG_UNUSED(iface); return false; #endif } /** * @brief Return the IP offload plugin * * @param iface Network interface * * @return NULL if there is no offload plugin defined, valid pointer otherwise */ static inline struct net_offload *net_if_offload(struct net_if *iface) { #if defined(CONFIG_NET_OFFLOAD) return iface->if_dev->offload; #else return NULL; #endif } /** * @brief Return the socket offload status * * @param iface Network interface * * @return True if socket offloading is active, false otherwise. */ static inline bool net_if_is_socket_offloaded(struct net_if *iface) { #if defined(CONFIG_NET_SOCKETS_OFFLOAD) return iface->if_dev->offloaded; #else ARG_UNUSED(iface); return false; #endif } /** * @brief Get an network interface's link address * * @param iface Pointer to a network interface structure * * @return a pointer to the network link address */ static inline struct net_linkaddr *net_if_get_link_addr(struct net_if *iface) { return &iface->if_dev->link_addr; } /** * @brief Return network configuration for this network interface * * @param iface Pointer to a network interface structure * * @return Pointer to configuration */ static inline struct net_if_config *net_if_get_config(struct net_if *iface) { return &iface->config; } /** * @brief Start duplicate address detection procedure. * * @param iface Pointer to a network interface structure */ #if defined(CONFIG_NET_IPV6_DAD) && defined(CONFIG_NET_NATIVE_IPV6) void net_if_start_dad(struct net_if *iface); #else static inline void net_if_start_dad(struct net_if *iface) { ARG_UNUSED(iface); } #endif /** * @brief Start neighbor discovery and send router solicitation message. * * @param iface Pointer to a network interface structure */ void net_if_start_rs(struct net_if *iface); /** * @brief Stop neighbor discovery. * * @param iface Pointer to a network interface structure */ #if defined(CONFIG_NET_IPV6_ND) && defined(CONFIG_NET_NATIVE_IPV6) void net_if_stop_rs(struct net_if *iface); #else static inline void net_if_stop_rs(struct net_if *iface) { ARG_UNUSED(iface); } #endif /* CONFIG_NET_IPV6_ND */ /** * @brief Set a network interface's link address * * @param iface Pointer to a network interface structure * @param addr A pointer to a u8_t buffer representing the address. The buffer * must remain valid throughout interface lifetime. * @param len length of the address buffer * @param type network bearer type of this link address * * @return 0 on success */ static inline int net_if_set_link_addr(struct net_if *iface, u8_t *addr, u8_t len, enum net_link_type type) { if (net_if_flag_is_set(iface, NET_IF_UP)) { return -EPERM; } net_if_get_link_addr(iface)->addr = addr; net_if_get_link_addr(iface)->len = len; net_if_get_link_addr(iface)->type = type; net_hostname_set_postfix(addr, len); return 0; } /** * @brief Get an network interface's MTU * * @param iface Pointer to a network interface structure * * @return the MTU */ static inline u16_t net_if_get_mtu(struct net_if *iface) { return iface->if_dev->mtu; } /** * @brief Set an network interface's MTU * * @param iface Pointer to a network interface structure * @param mtu New MTU, note that we store only 16 bit mtu value. */ static inline void net_if_set_mtu(struct net_if *iface, u16_t mtu) { iface->if_dev->mtu = mtu; } /** * @brief Set the infinite status of the network interface address * * @param ifaddr IP address for network interface * @param is_infinite Infinite status */ static inline void net_if_addr_set_lf(struct net_if_addr *ifaddr, bool is_infinite) { ifaddr->is_infinite = is_infinite; } /** * @brief Get an interface according to link layer address. * * @param ll_addr Link layer address. * * @return Network interface or NULL if not found. */ struct net_if *net_if_get_by_link_addr(struct net_linkaddr *ll_addr); /** * @brief Find an interface from it's related device * * @param dev A valid struct device pointer to relate with an interface * * @return a valid struct net_if pointer on success, NULL otherwise */ struct net_if *net_if_lookup_by_dev(struct device *dev); /** * @brief Get network interface IP config * * @param iface Interface to use. * * @return NULL if not found or pointer to correct config settings. */ static inline struct net_if_config *net_if_config_get(struct net_if *iface) { return &iface->config; } /** * @brief Remove a router from the system * * @param router Pointer to existing router */ static inline void net_if_router_rm(struct net_if_router *router) { router->is_used = false; /* FIXME - remove timer */ } /** * @brief Get the default network interface. * * @return Default interface or NULL if no interfaces are configured. */ struct net_if *net_if_get_default(void); /** * @brief Get the first network interface according to its type. * * @param l2 Layer 2 type of the network interface. * * @return First network interface of a given type or NULL if no such * interfaces was found. */ struct net_if *net_if_get_first_by_type(const struct net_l2 *l2); #if defined(CONFIG_NET_L2_IEEE802154) /** * @brief Get the first IEEE 802.15.4 network interface. * * @return First IEEE 802.15.4 network interface or NULL if no such * interfaces was found. */ static inline struct net_if *net_if_get_ieee802154(void) { return net_if_get_first_by_type(&NET_L2_GET_NAME(IEEE802154)); } #endif /* CONFIG_NET_L2_IEEE802154 */ /** * @brief Allocate network interface IPv6 config. * * @details This function will allocate new IPv6 config. * * @param iface Interface to use. * @param ipv6 Pointer to allocated IPv6 struct is returned to caller. * * @return 0 if ok, <0 if error */ int net_if_config_ipv6_get(struct net_if *iface, struct net_if_ipv6 **ipv6); /** * @brief Release network interface IPv6 config. * * @param iface Interface to use. * * @return 0 if ok, <0 if error */ int net_if_config_ipv6_put(struct net_if *iface); /** * @brief Check if this IPv6 address belongs to one of the interfaces. * * @param addr IPv6 address * @param iface Pointer to interface is returned * * @return Pointer to interface address, NULL if not found. */ struct net_if_addr *net_if_ipv6_addr_lookup(const struct in6_addr *addr, struct net_if **iface); /** * @brief Check if this IPv6 address belongs to this specific interfaces. * * @param iface Network interface * @param addr IPv6 address * * @return Pointer to interface address, NULL if not found. */ struct net_if_addr *net_if_ipv6_addr_lookup_by_iface(struct net_if *iface, struct in6_addr *addr); /** * @brief Check if this IPv6 address belongs to one of the interface indices. * * @param addr IPv6 address * * @return >0 if address was found in given network interface index, * all other values mean address was not found */ __syscall int net_if_ipv6_addr_lookup_by_index(const struct in6_addr *addr); /** * @brief Add a IPv6 address to an interface * * @param iface Network interface * @param addr IPv6 address * @param addr_type IPv6 address type * @param vlifetime Validity time for this address * * @return Pointer to interface address, NULL if cannot be added */ struct net_if_addr *net_if_ipv6_addr_add(struct net_if *iface, struct in6_addr *addr, enum net_addr_type addr_type, u32_t vlifetime); /** * @brief Add a IPv6 address to an interface by index * * @param index Network interface index * @param addr IPv6 address * @param addr_type IPv6 address type * @param vlifetime Validity time for this address * * @return True if ok, false if address could not be added */ __syscall bool net_if_ipv6_addr_add_by_index(int index, struct in6_addr *addr, enum net_addr_type addr_type, u32_t vlifetime); /** * @brief Update validity lifetime time of an IPv6 address. * * @param ifaddr Network IPv6 address * @param vlifetime Validity time for this address */ void net_if_ipv6_addr_update_lifetime(struct net_if_addr *ifaddr, u32_t vlifetime); /** * @brief Remove an IPv6 address from an interface * * @param iface Network interface * @param addr IPv6 address * * @return True if successfully removed, false otherwise */ bool net_if_ipv6_addr_rm(struct net_if *iface, const struct in6_addr *addr); /** * @brief Remove an IPv6 address from an interface by index * * @param index Network interface index * @param addr IPv6 address * * @return True if successfully removed, false otherwise */ __syscall bool net_if_ipv6_addr_rm_by_index(int index, const struct in6_addr *addr); /** * @brief Add a IPv6 multicast address to an interface * * @param iface Network interface * @param addr IPv6 multicast address * * @return Pointer to interface multicast address, NULL if cannot be added */ struct net_if_mcast_addr *net_if_ipv6_maddr_add(struct net_if *iface, const struct in6_addr *addr); /** * @brief Remove an IPv6 multicast address from an interface * * @param iface Network interface * @param addr IPv6 multicast address * * @return True if successfully removed, false otherwise */ bool net_if_ipv6_maddr_rm(struct net_if *iface, const struct in6_addr *addr); /** * @brief Check if this IPv6 multicast address belongs to a specific interface * or one of the interfaces. * * @param addr IPv6 address * @param iface If *iface is null, then pointer to interface is returned, * otherwise the *iface value needs to be matched. * * @return Pointer to interface multicast address, NULL if not found. */ struct net_if_mcast_addr *net_if_ipv6_maddr_lookup(const struct in6_addr *addr, struct net_if **iface); /** * @typedef net_if_mcast_callback_t * @brief Define callback that is called whenever IPv6 multicast address group * is joined or left. * @param "struct net_if *iface" A pointer to a struct net_if to which the * multicast address is attached. * @param "const struct in6_addr *addr" IPv6 multicast address. * @param "bool is_joined" True if the address is joined, false if left. */ typedef void (*net_if_mcast_callback_t)(struct net_if *iface, const struct in6_addr *addr, bool is_joined); /** * @brief Multicast monitor handler struct. * * Stores the multicast callback information. Caller must make sure that * the variable pointed by this is valid during the lifetime of * registration. Typically this means that the variable cannot be * allocated from stack. */ struct net_if_mcast_monitor { /** Node information for the slist. */ sys_snode_t node; /** Network interface */ struct net_if *iface; /** Multicast callback */ net_if_mcast_callback_t cb; }; /** * @brief Register a multicast monitor * * @param mon Monitor handle. This is a pointer to a monitor storage structure * which should be allocated by caller, but does not need to be initialized. * @param iface Network interface * @param cb Monitor callback */ void net_if_mcast_mon_register(struct net_if_mcast_monitor *mon, struct net_if *iface, net_if_mcast_callback_t cb); /** * @brief Unregister a multicast monitor * * @param mon Monitor handle */ void net_if_mcast_mon_unregister(struct net_if_mcast_monitor *mon); /** * @brief Call registered multicast monitors * * @param iface Network interface * @param addr Multicast address * @param is_joined Is this multicast address joined (true) or not (false) */ void net_if_mcast_monitor(struct net_if *iface, const struct in6_addr *addr, bool is_joined); /** * @brief Mark a given multicast address to be joined. * * @param addr IPv6 multicast address */ static inline void net_if_ipv6_maddr_join(struct net_if_mcast_addr *addr) { NET_ASSERT(addr); addr->is_joined = true; } /** * @brief Check if given multicast address is joined or not. * * @param addr IPv6 multicast address * * @return True if address is joined, False otherwise. */ static inline bool net_if_ipv6_maddr_is_joined(struct net_if_mcast_addr *addr) { NET_ASSERT(addr); return addr->is_joined; } /** * @brief Mark a given multicast address to be left. * * @param addr IPv6 multicast address */ static inline void net_if_ipv6_maddr_leave(struct net_if_mcast_addr *addr) { NET_ASSERT(addr); addr->is_joined = false; } /** * @brief Return prefix that corresponds to this IPv6 address. * * @param iface Network interface * @param addr IPv6 address * * @return Pointer to prefix, NULL if not found. */ struct net_if_ipv6_prefix *net_if_ipv6_prefix_get(struct net_if *iface, struct in6_addr *addr); /** * @brief Check if this IPv6 prefix belongs to this interface * * @param iface Network interface * @param addr IPv6 address * @param len Prefix length * * @return Pointer to prefix, NULL if not found. */ struct net_if_ipv6_prefix *net_if_ipv6_prefix_lookup(struct net_if *iface, struct in6_addr *addr, u8_t len); /** * @brief Add a IPv6 prefix to an network interface. * * @param iface Network interface * @param prefix IPv6 address * @param len Prefix length * @param lifetime Prefix lifetime in seconds * * @return Pointer to prefix, NULL if the prefix was not added. */ struct net_if_ipv6_prefix *net_if_ipv6_prefix_add(struct net_if *iface, struct in6_addr *prefix, u8_t len, u32_t lifetime); /** * @brief Remove an IPv6 prefix from an interface * * @param iface Network interface * @param addr IPv6 prefix address * @param len Prefix length * * @return True if successfully removed, false otherwise */ bool net_if_ipv6_prefix_rm(struct net_if *iface, struct in6_addr *addr, u8_t len); /** * @brief Set the infinite status of the prefix * * @param prefix IPv6 address * @param is_infinite Infinite status */ static inline void net_if_ipv6_prefix_set_lf(struct net_if_ipv6_prefix *prefix, bool is_infinite) { prefix->is_infinite = is_infinite; } /** * @brief Set the prefix lifetime timer. * * @param prefix IPv6 address * @param lifetime Prefix lifetime in seconds */ void net_if_ipv6_prefix_set_timer(struct net_if_ipv6_prefix *prefix, u32_t lifetime); /** * @brief Unset the prefix lifetime timer. * * @param prefix IPv6 address */ void net_if_ipv6_prefix_unset_timer(struct net_if_ipv6_prefix *prefix); /** * @brief Check if this IPv6 address is part of the subnet of our * network interface. * * @param iface Network interface. This is returned to the caller. * The iface can be NULL in which case we check all the interfaces. * @param addr IPv6 address * * @return True if address is part of our subnet, false otherwise */ bool net_if_ipv6_addr_onlink(struct net_if **iface, struct in6_addr *addr); /** * @brief Get the IPv6 address of the given router * @param router a network router * * @return pointer to the IPv6 address, or NULL if none */ #if defined(CONFIG_NET_NATIVE_IPV6) static inline struct in6_addr *net_if_router_ipv6(struct net_if_router *router) { return &router->address.in6_addr; } #else static inline struct in6_addr *net_if_router_ipv6(struct net_if_router *router) { static struct in6_addr addr; ARG_UNUSED(router); return &addr; } #endif /** * @brief Check if IPv6 address is one of the routers configured * in the system. * * @param iface Network interface * @param addr IPv6 address * * @return Pointer to router information, NULL if cannot be found */ struct net_if_router *net_if_ipv6_router_lookup(struct net_if *iface, struct in6_addr *addr); /** * @brief Find default router for this IPv6 address. * * @param iface Network interface. This can be NULL in which case we * go through all the network interfaces to find a suitable router. * @param addr IPv6 address * * @return Pointer to router information, NULL if cannot be found */ struct net_if_router *net_if_ipv6_router_find_default(struct net_if *iface, struct in6_addr *addr); /** * @brief Update validity lifetime time of a router. * * @param router Network IPv6 address * @param lifetime Lifetime of this router. */ void net_if_ipv6_router_update_lifetime(struct net_if_router *router, u16_t lifetime); /** * @brief Add IPv6 router to the system. * * @param iface Network interface * @param addr IPv6 address * @param router_lifetime Lifetime of the router * * @return Pointer to router information, NULL if could not be added */ struct net_if_router *net_if_ipv6_router_add(struct net_if *iface, struct in6_addr *addr, u16_t router_lifetime); /** * @brief Remove IPv6 router from the system. * * @param router Router information. * * @return True if successfully removed, false otherwise */ bool net_if_ipv6_router_rm(struct net_if_router *router); /** * @brief Get IPv6 hop limit specified for a given interface. This is the * default value but can be overridden by the user. * * @param iface Network interface * * @return Hop limit */ static inline u8_t net_if_ipv6_get_hop_limit(struct net_if *iface) { #if defined(CONFIG_NET_NATIVE_IPV6) if (!iface->config.ip.ipv6) { return 0; } return iface->config.ip.ipv6->hop_limit; #else return 0; #endif } /** * @brief Set the default IPv6 hop limit of a given interface. * * @param iface Network interface * @param hop_limit New hop limit */ static inline void net_ipv6_set_hop_limit(struct net_if *iface, u8_t hop_limit) { #if defined(CONFIG_NET_NATIVE_IPV6) if (!iface->config.ip.ipv6) { return; } iface->config.ip.ipv6->hop_limit = hop_limit; #endif } /** * @brief Set IPv6 reachable time for a given interface * * @param iface Network interface * @param reachable_time New reachable time */ static inline void net_if_ipv6_set_base_reachable_time(struct net_if *iface, u32_t reachable_time) { #if defined(CONFIG_NET_NATIVE_IPV6) if (!iface->config.ip.ipv6) { return; } iface->config.ip.ipv6->base_reachable_time = reachable_time; #endif } /** * @brief Get IPv6 reachable timeout specified for a given interface * * @param iface Network interface * * @return Reachable timeout */ static inline u32_t net_if_ipv6_get_reachable_time(struct net_if *iface) { #if defined(CONFIG_NET_NATIVE_IPV6) if (!iface->config.ip.ipv6) { return 0; } return iface->config.ip.ipv6->reachable_time; #else return 0; #endif } /** * @brief Calculate next reachable time value for IPv6 reachable time * * @param ipv6 IPv6 address configuration * * @return Reachable time */ u32_t net_if_ipv6_calc_reachable_time(struct net_if_ipv6 *ipv6); /** * @brief Set IPv6 reachable time for a given interface. This requires * that base reachable time is set for the interface. * * @param ipv6 IPv6 address configuration */ static inline void net_if_ipv6_set_reachable_time(struct net_if_ipv6 *ipv6) { #if defined(CONFIG_NET_NATIVE_IPV6) ipv6->reachable_time = net_if_ipv6_calc_reachable_time(ipv6); #endif } /** * @brief Set IPv6 retransmit timer for a given interface * * @param iface Network interface * @param retrans_timer New retransmit timer */ static inline void net_if_ipv6_set_retrans_timer(struct net_if *iface, u32_t retrans_timer) { #if defined(CONFIG_NET_NATIVE_IPV6) if (!iface->config.ip.ipv6) { return; } iface->config.ip.ipv6->retrans_timer = retrans_timer; #endif } /** * @brief Get IPv6 retransmit timer specified for a given interface * * @param iface Network interface * * @return Retransmit timer */ static inline u32_t net_if_ipv6_get_retrans_timer(struct net_if *iface) { #if defined(CONFIG_NET_NATIVE_IPV6) if (!iface->config.ip.ipv6) { return 0; } return iface->config.ip.ipv6->retrans_timer; #else return 0; #endif } /** * @brief Get a IPv6 source address that should be used when sending * network data to destination. * * @param iface Interface that was used when packet was received. * If the interface is not known, then NULL can be given. * @param dst IPv6 destination address * * @return Pointer to IPv6 address to use, NULL if no IPv6 address * could be found. */ #if defined(CONFIG_NET_NATIVE_IPV6) const struct in6_addr *net_if_ipv6_select_src_addr(struct net_if *iface, const struct in6_addr *dst); #else static inline const struct in6_addr *net_if_ipv6_select_src_addr( struct net_if *iface, const struct in6_addr *dst) { ARG_UNUSED(iface); ARG_UNUSED(dst); return NULL; } #endif /** * @brief Get a network interface that should be used when sending * IPv6 network data to destination. * * @param dst IPv6 destination address * * @return Pointer to network interface to use, NULL if no suitable interface * could be found. */ #if defined(CONFIG_NET_NATIVE_IPV6) struct net_if *net_if_ipv6_select_src_iface(const struct in6_addr *dst); #else static inline struct net_if *net_if_ipv6_select_src_iface( const struct in6_addr *dst) { ARG_UNUSED(dst); return NULL; } #endif /** * @brief Get a IPv6 link local address in a given state. * * @param iface Interface to use. Must be a valid pointer to an interface. * @param addr_state IPv6 address state (preferred, tentative, deprecated) * * @return Pointer to link local IPv6 address, NULL if no proper IPv6 address * could be found. */ struct in6_addr *net_if_ipv6_get_ll(struct net_if *iface, enum net_addr_state addr_state); /** * @brief Return link local IPv6 address from the first interface that has * a link local address matching give state. * * @param state IPv6 address state (ANY, TENTATIVE, PREFERRED, DEPRECATED) * @param iface Pointer to interface is returned * * @return Pointer to IPv6 address, NULL if not found. */ struct in6_addr *net_if_ipv6_get_ll_addr(enum net_addr_state state, struct net_if **iface); /** * @brief Stop IPv6 Duplicate Address Detection (DAD) procedure if * we find out that our IPv6 address is already in use. * * @param iface Interface where the DAD was running. * @param addr IPv6 address that failed DAD */ void net_if_ipv6_dad_failed(struct net_if *iface, const struct in6_addr *addr); /** * @brief Return global IPv6 address from the first interface that has * a global IPv6 address matching the given state. * * @param state IPv6 address state (ANY, TENTATIVE, PREFERRED, DEPRECATED) * @param iface Caller can give an interface to check. If iface is set to NULL, * then all the interfaces are checked. Pointer to interface where the IPv6 * address is defined is returned to the caller. * * @return Pointer to IPv6 address, NULL if not found. */ struct in6_addr *net_if_ipv6_get_global_addr(enum net_addr_state state, struct net_if **iface); /** * @brief Allocate network interface IPv4 config. * * @details This function will allocate new IPv4 config. * * @param iface Interface to use. * @param ipv4 Pointer to allocated IPv4 struct is returned to caller. * * @return 0 if ok, <0 if error */ int net_if_config_ipv4_get(struct net_if *iface, struct net_if_ipv4 **ipv4); /** * @brief Release network interface IPv4 config. * * @param iface Interface to use. * * @return 0 if ok, <0 if error */ int net_if_config_ipv4_put(struct net_if *iface); /** * @brief Get IPv4 time-to-live value specified for a given interface * * @param iface Network interface * * @return Time-to-live */ static inline u8_t net_if_ipv4_get_ttl(struct net_if *iface) { #if defined(CONFIG_NET_NATIVE_IPV4) if (!iface->config.ip.ipv4) { return 0; } return iface->config.ip.ipv4->ttl; #else return 0; #endif } /** * @brief Check if this IPv4 address belongs to one of the interfaces. * * @param addr IPv4 address * @param iface Interface is returned * * @return Pointer to interface address, NULL if not found. */ struct net_if_addr *net_if_ipv4_addr_lookup(const struct in_addr *addr, struct net_if **iface); /** * @brief Add a IPv4 address to an interface * * @param iface Network interface * @param addr IPv4 address * @param addr_type IPv4 address type * @param vlifetime Validity time for this address * * @return Pointer to interface address, NULL if cannot be added */ struct net_if_addr *net_if_ipv4_addr_add(struct net_if *iface, struct in_addr *addr, enum net_addr_type addr_type, u32_t vlifetime); /** * @brief Remove a IPv4 address from an interface * * @param iface Network interface * @param addr IPv4 address * * @return True if successfully removed, false otherwise */ bool net_if_ipv4_addr_rm(struct net_if *iface, const struct in_addr *addr); /** * @brief Check if this IPv4 address belongs to one of the interface indices. * * @param addr IPv4 address * * @return >0 if address was found in given network interface index, * all other values mean address was not found */ __syscall int net_if_ipv4_addr_lookup_by_index(const struct in_addr *addr); /** * @brief Add a IPv4 address to an interface by network interface index * * @param index Network interface index * @param addr IPv4 address * @param addr_type IPv4 address type * @param vlifetime Validity time for this address * * @return True if ok, false if the address could not be added */ __syscall bool net_if_ipv4_addr_add_by_index(int index, struct in_addr *addr, enum net_addr_type addr_type, u32_t vlifetime); /** * @brief Remove a IPv4 address from an interface by interface index * * @param index Network interface index * @param addr IPv4 address * * @return True if successfully removed, false otherwise */ __syscall bool net_if_ipv4_addr_rm_by_index(int index, const struct in_addr *addr); /** * @brief Add a IPv4 multicast address to an interface * * @param iface Network interface * @param addr IPv4 multicast address * * @return Pointer to interface multicast address, NULL if cannot be added */ struct net_if_mcast_addr *net_if_ipv4_maddr_add(struct net_if *iface, const struct in_addr *addr); /** * @brief Remove an IPv4 multicast address from an interface * * @param iface Network interface * @param addr IPv4 multicast address * * @return True if successfully removed, false otherwise */ bool net_if_ipv4_maddr_rm(struct net_if *iface, const struct in_addr *addr); /** * @brief Check if this IPv4 multicast address belongs to a specific interface * or one of the interfaces. * * @param addr IPv4 address * @param iface If *iface is null, then pointer to interface is returned, * otherwise the *iface value needs to be matched. * * @return Pointer to interface multicast address, NULL if not found. */ struct net_if_mcast_addr *net_if_ipv4_maddr_lookup(const struct in_addr *addr, struct net_if **iface); /** * @brief Get the IPv4 address of the given router * @param router a network router * * @return pointer to the IPv4 address, or NULL if none */ #if defined(CONFIG_NET_NATIVE_IPV4) static inline struct in_addr *net_if_router_ipv4(struct net_if_router *router) { return &router->address.in_addr; } #else static inline struct in_addr *net_if_router_ipv4(struct net_if_router *router) { static struct in_addr addr; ARG_UNUSED(router); return &addr; } #endif /** * @brief Check if IPv4 address is one of the routers configured * in the system. * * @param iface Network interface * @param addr IPv4 address * * @return Pointer to router information, NULL if cannot be found */ struct net_if_router *net_if_ipv4_router_lookup(struct net_if *iface, struct in_addr *addr); /** * @brief Find default router for this IPv4 address. * * @param iface Network interface. This can be NULL in which case we * go through all the network interfaces to find a suitable router. * @param addr IPv4 address * * @return Pointer to router information, NULL if cannot be found */ struct net_if_router *net_if_ipv4_router_find_default(struct net_if *iface, struct in_addr *addr); /** * @brief Add IPv4 router to the system. * * @param iface Network interface * @param addr IPv4 address * @param is_default Is this router the default one * @param router_lifetime Lifetime of the router * * @return Pointer to router information, NULL if could not be added */ struct net_if_router *net_if_ipv4_router_add(struct net_if *iface, struct in_addr *addr, bool is_default, u16_t router_lifetime); /** * @brief Remove IPv4 router from the system. * * @param router Router information. * * @return True if successfully removed, false otherwise */ bool net_if_ipv4_router_rm(struct net_if_router *router); /** * @brief Check if the given IPv4 address belongs to local subnet. * * @param iface Interface to use. Must be a valid pointer to an interface. * @param addr IPv4 address * * @return True if address is part of local subnet, false otherwise. */ bool net_if_ipv4_addr_mask_cmp(struct net_if *iface, const struct in_addr *addr); /** * @brief Check if the given IPv4 address is a broadcast address. * * @param iface Interface to use. Must be a valid pointer to an interface. * @param addr IPv4 address, this should be in network byte order * * @return True if address is a broadcast address, false otherwise. */ bool net_if_ipv4_is_addr_bcast(struct net_if *iface, const struct in_addr *addr); /** * @brief Get a network interface that should be used when sending * IPv4 network data to destination. * * @param dst IPv4 destination address * * @return Pointer to network interface to use, NULL if no suitable interface * could be found. */ #if defined(CONFIG_NET_NATIVE_IPV4) struct net_if *net_if_ipv4_select_src_iface(const struct in_addr *dst); #else static inline struct net_if *net_if_ipv4_select_src_iface( const struct in_addr *dst) { ARG_UNUSED(dst); return NULL; } #endif /** * @brief Get a IPv4 source address that should be used when sending * network data to destination. * * @param iface Interface to use when sending the packet. * If the interface is not known, then NULL can be given. * @param dst IPv4 destination address * * @return Pointer to IPv4 address to use, NULL if no IPv4 address * could be found. */ #if defined(CONFIG_NET_NATIVE_IPV4) const struct in_addr *net_if_ipv4_select_src_addr(struct net_if *iface, const struct in_addr *dst); #else static inline const struct in_addr *net_if_ipv4_select_src_addr( struct net_if *iface, const struct in_addr *dst) { ARG_UNUSED(iface); ARG_UNUSED(dst); return NULL; } #endif /** * @brief Get a IPv4 link local address in a given state. * * @param iface Interface to use. Must be a valid pointer to an interface. * @param addr_state IPv4 address state (preferred, tentative, deprecated) * * @return Pointer to link local IPv4 address, NULL if no proper IPv4 address * could be found. */ struct in_addr *net_if_ipv4_get_ll(struct net_if *iface, enum net_addr_state addr_state); /** * @brief Get a IPv4 global address in a given state. * * @param iface Interface to use. Must be a valid pointer to an interface. * @param addr_state IPv4 address state (preferred, tentative, deprecated) * * @return Pointer to link local IPv4 address, NULL if no proper IPv4 address * could be found. */ struct in_addr *net_if_ipv4_get_global_addr(struct net_if *iface, enum net_addr_state addr_state); /** * @brief Set IPv4 netmask for an interface. * * @param iface Interface to use. * @param netmask IPv4 netmask */ void net_if_ipv4_set_netmask(struct net_if *iface, const struct in_addr *netmask); /** * @brief Set IPv4 netmask for an interface index. * * @param index Network interface index * @param netmask IPv4 netmask * * @return True if netmask was added, false otherwise. */ __syscall bool net_if_ipv4_set_netmask_by_index(int index, const struct in_addr *netmask); /** * @brief Set IPv4 gateway for an interface. * * @param iface Interface to use. * @param gw IPv4 address of an gateway */ void net_if_ipv4_set_gw(struct net_if *iface, const struct in_addr *gw); /** * @brief Set IPv4 gateway for an interface index. * * @param index Network interface index * @param gw IPv4 address of an gateway * * @return True if gateway was added, false otherwise. */ __syscall bool net_if_ipv4_set_gw_by_index(int index, const struct in_addr *gw); /** * @brief Get a network interface that should be used when sending * IPv6 or IPv4 network data to destination. * * @param dst IPv6 or IPv4 destination address * * @return Pointer to network interface to use. Note that the function * will return the default network interface if the best network interface * is not found. */ struct net_if *net_if_select_src_iface(const struct sockaddr *dst); /** * @typedef net_if_link_callback_t * @brief Define callback that is called after a network packet * has been sent. * @param "struct net_if *iface" A pointer to a struct net_if to which the * the net_pkt was sent to. * @param "struct net_linkaddr *dst" Link layer address of the destination * where the network packet was sent. * @param "int status" Send status, 0 is ok, < 0 error. */ typedef void (*net_if_link_callback_t)(struct net_if *iface, struct net_linkaddr *dst, int status); /** * @brief Link callback handler struct. * * Stores the link callback information. Caller must make sure that * the variable pointed by this is valid during the lifetime of * registration. Typically this means that the variable cannot be * allocated from stack. */ struct net_if_link_cb { /** Node information for the slist. */ sys_snode_t node; /** Link callback */ net_if_link_callback_t cb; }; /** * @brief Register a link callback. * * @param link Caller specified handler for the callback. * @param cb Callback to register. */ void net_if_register_link_cb(struct net_if_link_cb *link, net_if_link_callback_t cb); /** * @brief Unregister a link callback. * * @param link Caller specified handler for the callback. */ void net_if_unregister_link_cb(struct net_if_link_cb *link); /** * @brief Call a link callback function. * * @param iface Network interface. * @param lladdr Destination link layer address * @param status 0 is ok, < 0 error */ void net_if_call_link_cb(struct net_if *iface, struct net_linkaddr *lladdr, int status); /** * @brief Check if received network packet checksum calculation can be avoided * or not. For example many ethernet devices support network packet offloading * in which case the IP stack does not need to calculate the checksum. * * @param iface Network interface * * @return True if checksum needs to be calculated, false otherwise. */ bool net_if_need_calc_rx_checksum(struct net_if *iface); /** * @brief Check if network packet checksum calculation can be avoided or not * when sending the packet. For example many ethernet devices support network * packet offloading in which case the IP stack does not need to calculate the * checksum. * * @param iface Network interface * * @return True if checksum needs to be calculated, false otherwise. */ bool net_if_need_calc_tx_checksum(struct net_if *iface); /** * @brief Get interface according to index * * @param index Interface index * * @return Pointer to interface or NULL if not found. */ struct net_if *net_if_get_by_index(int index); /** * @brief Get interface index according to pointer * * @param iface Pointer to network interface * * @return Interface index */ int net_if_get_by_iface(struct net_if *iface); /** * @typedef net_if_cb_t * @brief Callback used while iterating over network interfaces * * @param iface Pointer to current network interface * @param user_data A valid pointer to user data or NULL */ typedef void (*net_if_cb_t)(struct net_if *iface, void *user_data); /** * @brief Go through all the network interfaces and call callback * for each interface. * * @param cb User-supplied callback function to call * @param user_data User specified data */ void net_if_foreach(net_if_cb_t cb, void *user_data); /** * @brief Bring interface up * * @param iface Pointer to network interface * * @return 0 on success */ int net_if_up(struct net_if *iface); /** * @brief Check if interface is up. * * @param iface Pointer to network interface * * @return True if interface is up, False if it is down. */ static inline bool net_if_is_up(struct net_if *iface) { NET_ASSERT(iface); return net_if_flag_is_set(iface, NET_IF_UP); } /** * @brief Bring interface down * * @param iface Pointer to network interface * * @return 0 on success */ int net_if_down(struct net_if *iface); #if defined(CONFIG_NET_PKT_TIMESTAMP) && defined(CONFIG_NET_NATIVE) /** * @typedef net_if_timestamp_callback_t * @brief Define callback that is called after a network packet * has been timestamped. * @param "struct net_pkt *pkt" A pointer on a struct net_pkt which has * been timestamped after being sent. */ typedef void (*net_if_timestamp_callback_t)(struct net_pkt *pkt); /** * @brief Timestamp callback handler struct. * * Stores the timestamp callback information. Caller must make sure that * the variable pointed by this is valid during the lifetime of * registration. Typically this means that the variable cannot be * allocated from stack. */ struct net_if_timestamp_cb { /** Node information for the slist. */ sys_snode_t node; /** Packet for which the callback is needed. * A NULL value means all packets. */ struct net_pkt *pkt; /** Net interface for which the callback is needed. * A NULL value means all interfaces. */ struct net_if *iface; /** Timestamp callback */ net_if_timestamp_callback_t cb; }; /** * @brief Register a timestamp callback. * * @param handle Caller specified handler for the callback. * @param pkt Net packet for which the callback is registered. NULL for all * packets. * @param iface Net interface for which the callback is. NULL for all * interfaces. * @param cb Callback to register. */ 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); /** * @brief Unregister a timestamp callback. * * @param handle Caller specified handler for the callback. */ void net_if_unregister_timestamp_cb(struct net_if_timestamp_cb *handle); /** * @brief Call a timestamp callback function. * * @param pkt Network buffer. */ void net_if_call_timestamp_cb(struct net_pkt *pkt); /* * @brief Add timestamped TX buffer to be handled * * @param pkt Timestamped buffer */ void net_if_add_tx_timestamp(struct net_pkt *pkt); #endif /* CONFIG_NET_PKT_TIMESTAMP */ /** * @brief Set network interface into promiscuous mode * * @details Note that not all network technologies will support this. * * @param iface Pointer to network interface * * @return 0 on success, <0 if error */ int net_if_set_promisc(struct net_if *iface); /** * @brief Set network interface into normal mode * * @param iface Pointer to network interface */ void net_if_unset_promisc(struct net_if *iface); /** * @brief Check if promiscuous mode is set or not. * * @param iface Pointer to network interface * * @return True if interface is in promisc mode, * False if interface is not in in promiscuous mode. */ bool net_if_is_promisc(struct net_if *iface); /** @cond INTERNAL_HIDDEN */ struct net_if_api { void (*init)(struct net_if *iface); }; #if defined(CONFIG_NET_DHCPV4) && defined(CONFIG_NET_NATIVE_IPV4) #define NET_IF_DHCPV4_INIT .dhcpv4.state = NET_DHCPV4_DISABLED, #else #define NET_IF_DHCPV4_INIT #endif #define NET_IF_CONFIG_INIT \ .config = { \ .ip = { \ }, \ NET_IF_DHCPV4_INIT \ } #define NET_IF_GET_NAME(dev_name, sfx) (__net_if_##dev_name##_##sfx) #define NET_IF_DEV_GET_NAME(dev_name, sfx) (__net_if_dev_##dev_name##_##sfx) #define NET_IF_GET(dev_name, sfx) \ ((struct net_if *)&NET_IF_GET_NAME(dev_name, sfx)) #define NET_IF_INIT(dev_name, sfx, _l2, _mtu, _num_configs) \ static struct net_if_dev (NET_IF_DEV_GET_NAME(dev_name, sfx)) \ __used __attribute__((__section__(".net_if_dev.data"))) = { \ .dev = &(DEVICE_NAME_GET(dev_name)), \ .l2 = &(NET_L2_GET_NAME(_l2)), \ .l2_data = &(NET_L2_GET_DATA(dev_name, sfx)), \ .mtu = _mtu, \ }; \ static struct net_if \ (NET_IF_GET_NAME(dev_name, sfx))[_num_configs] __used \ __attribute__((__section__(".net_if.data"))) = { \ [0 ... (_num_configs - 1)] = { \ .if_dev = &(NET_IF_DEV_GET_NAME(dev_name, sfx)), \ NET_IF_CONFIG_INIT \ } \ } #define NET_IF_OFFLOAD_INIT(dev_name, sfx, _mtu) \ static struct net_if_dev (NET_IF_DEV_GET_NAME(dev_name, sfx)) __used \ __attribute__((__section__(".net_if_dev.data"))) = { \ .dev = &(__device_##dev_name), \ .mtu = _mtu, \ }; \ static struct net_if \ (NET_IF_GET_NAME(dev_name, sfx))[NET_IF_MAX_CONFIGS] __used \ __attribute__((__section__(".net_if.data"))) = { \ [0 ... (NET_IF_MAX_CONFIGS - 1)] = { \ .if_dev = &(NET_IF_DEV_GET_NAME(dev_name, sfx)), \ NET_IF_CONFIG_INIT \ } \ } /** @endcond */ /* Network device initialization macros */ /** * @def NET_DEVICE_INIT * * @brief Create a network interface and bind it to network device. * * @param dev_name Network device name. * @param drv_name The name this instance of the driver exposes to * the system. * @param init_fn Address to the init function of the driver. * @param data Pointer to the device's configuration data. * @param cfg_info The address to the structure containing the * configuration information for this instance of the driver. * @param prio The initialization level at which configuration occurs. * @param api Provides an initial pointer to the API function struct * used by the driver. Can be NULL. * @param l2 Network L2 layer for this network interface. * @param l2_ctx_type Type of L2 context data. * @param mtu Maximum transfer unit in bytes for this network interface. */ #define NET_DEVICE_INIT(dev_name, drv_name, init_fn, \ data, cfg_info, prio, api, l2, \ l2_ctx_type, mtu) \ DEVICE_AND_API_INIT(dev_name, drv_name, init_fn, data, \ cfg_info, POST_KERNEL, prio, api); \ NET_L2_DATA_INIT(dev_name, 0, l2_ctx_type); \ NET_IF_INIT(dev_name, 0, l2, mtu, NET_IF_MAX_CONFIGS) /** * @def NET_DEVICE_INIT_INSTANCE * * @brief Create multiple network interfaces and bind them to network device. * If your network device needs more than one instance of a network interface, * use this macro below and provide a different instance suffix each time * (0, 1, 2, ... or a, b, c ... whatever works for you) * * @param dev_name Network device name. * @param drv_name The name this instance of the driver exposes to * the system. * @param instance Instance identifier. * @param init_fn Address to the init function of the driver. * @param data Pointer to the device's configuration data. * @param cfg_info The address to the structure containing the * configuration information for this instance of the driver. * @param prio The initialization level at which configuration occurs. * @param api Provides an initial pointer to the API function struct * used by the driver. Can be NULL. * @param l2 Network L2 layer for this network interface. * @param l2_ctx_type Type of L2 context data. * @param mtu Maximum transfer unit in bytes for this network interface. */ #define NET_DEVICE_INIT_INSTANCE(dev_name, drv_name, instance, init_fn, \ data, cfg_info, prio, api, l2, \ l2_ctx_type, mtu) \ DEVICE_AND_API_INIT(dev_name, drv_name, init_fn, data, \ cfg_info, POST_KERNEL, prio, api); \ NET_L2_DATA_INIT(dev_name, instance, l2_ctx_type); \ NET_IF_INIT(dev_name, instance, l2, mtu, NET_IF_MAX_CONFIGS) /** * @def NET_DEVICE_OFFLOAD_INIT * * @brief Create a offloaded network interface and bind it to network device. * The offloaded network interface is implemented by a device vendor HAL or * similar. * * @param dev_name Network device name. * @param drv_name The name this instance of the driver exposes to * the system. * @param init_fn Address to the init function of the driver. * @param data Pointer to the device's configuration data. * @param cfg_info The address to the structure containing the * configuration information for this instance of the driver. * @param prio The initialization level at which configuration occurs. * @param api Provides an initial pointer to the API function struct * used by the driver. Can be NULL. * @param mtu Maximum transfer unit in bytes for this network interface. */ #define NET_DEVICE_OFFLOAD_INIT(dev_name, drv_name, init_fn, \ data, cfg_info, prio, api, mtu) \ DEVICE_AND_API_INIT(dev_name, drv_name, init_fn, data, \ cfg_info, POST_KERNEL, prio, api); \ NET_IF_OFFLOAD_INIT(dev_name, 0, mtu) #ifdef __cplusplus } #endif #include <syscalls/net_if.h> /** * @} */ #endif /* ZEPHYR_INCLUDE_NET_NET_IF_H_ */ |