1 /** 2 * @file 3 * netif API (to be used from TCPIP thread) 4 */ 5 6 /* 7 * Copyright (c) 2001-2004 Swedish Institute of Computer Science. 8 * All rights reserved. 9 * 10 * Redistribution and use in source and binary forms, with or without modification, 11 * are permitted provided that the following conditions are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright notice, 14 * this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright notice, 16 * this list of conditions and the following disclaimer in the documentation 17 * and/or other materials provided with the distribution. 18 * 3. The name of the author may not be used to endorse or promote products 19 * derived from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 22 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 23 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 24 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 26 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 29 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 30 * OF SUCH DAMAGE. 31 * 32 * This file is part of the lwIP TCP/IP stack. 33 * 34 * Author: Adam Dunkels <adam@sics.se> 35 * 36 */ 37 #ifndef LWIP_HDR_NETIF_H 38 #define LWIP_HDR_NETIF_H 39 40 #include "lwip/opt.h" 41 42 #define ENABLE_LOOPBACK (LWIP_NETIF_LOOPBACK || LWIP_HAVE_LOOPIF) 43 44 #include "lwip/err.h" 45 46 #include "lwip/ip_addr.h" 47 48 #include "lwip/def.h" 49 #include "lwip/pbuf.h" 50 #include "lwip/stats.h" 51 52 #ifdef __cplusplus 53 extern "C" { 54 #endif 55 56 /* Throughout this file, IP addresses are expected to be in 57 * the same byte order as in IP_PCB. */ 58 59 /** Must be the maximum of all used hardware address lengths 60 across all types of interfaces in use. 61 This does not have to be changed, normally. */ 62 #ifndef NETIF_MAX_HWADDR_LEN 63 #define NETIF_MAX_HWADDR_LEN 6U 64 #endif 65 66 /** The size of a fully constructed netif name which the 67 * netif can be identified by in APIs. Composed of 68 * 2 chars, 3 (max) digits, and 1 \0 69 */ 70 #define NETIF_NAMESIZE 6 71 72 /** 73 * @defgroup netif_flags Flags 74 * @ingroup netif 75 * @{ 76 */ 77 78 /** Whether the network interface is 'up'. This is 79 * a software flag used to control whether this network 80 * interface is enabled and processes traffic. 81 * It must be set by the startup code before this netif can be used 82 * (also for dhcp/autoip). 83 */ 84 #define NETIF_FLAG_UP 0x01U 85 /** If set, the netif has broadcast capability. 86 * Set by the netif driver in its init function. */ 87 #define NETIF_FLAG_BROADCAST 0x02U 88 /** If set, the interface has an active link 89 * (set by the network interface driver). 90 * Either set by the netif driver in its init function (if the link 91 * is up at that time) or at a later point once the link comes up 92 * (if link detection is supported by the hardware). */ 93 #define NETIF_FLAG_LINK_UP 0x04U 94 /** If set, the netif is an ethernet device using ARP. 95 * Set by the netif driver in its init function. 96 * Used to check input packet types and use of DHCP. */ 97 #define NETIF_FLAG_ETHARP 0x08U 98 /** If set, the netif is an ethernet device. It might not use 99 * ARP or TCP/IP if it is used for PPPoE only. 100 */ 101 #define NETIF_FLAG_ETHERNET 0x10U 102 /** If set, the netif has IGMP capability. 103 * Set by the netif driver in its init function. */ 104 #define NETIF_FLAG_IGMP 0x20U 105 /** If set, the netif has MLD6 capability. 106 * Set by the netif driver in its init function. */ 107 #define NETIF_FLAG_MLD6 0x40U 108 109 /** 110 * @} 111 */ 112 113 enum lwip_internal_netif_client_data_index 114 { 115 #if LWIP_IPV4 116 #if LWIP_DHCP 117 LWIP_NETIF_CLIENT_DATA_INDEX_DHCP, 118 #endif 119 #if LWIP_AUTOIP 120 LWIP_NETIF_CLIENT_DATA_INDEX_AUTOIP, 121 #endif 122 #if LWIP_ACD 123 LWIP_NETIF_CLIENT_DATA_INDEX_ACD, 124 #endif 125 #if LWIP_IGMP 126 LWIP_NETIF_CLIENT_DATA_INDEX_IGMP, 127 #endif 128 #endif /* LWIP_IPV4 */ 129 #if LWIP_IPV6 130 #if LWIP_IPV6_DHCP6 131 LWIP_NETIF_CLIENT_DATA_INDEX_DHCP6, 132 #endif 133 #if LWIP_IPV6_MLD 134 LWIP_NETIF_CLIENT_DATA_INDEX_MLD6, 135 #endif 136 #endif /* LWIP_IPV6 */ 137 LWIP_NETIF_CLIENT_DATA_INDEX_MAX 138 }; 139 140 #if LWIP_CHECKSUM_CTRL_PER_NETIF 141 #define NETIF_CHECKSUM_GEN_IP 0x0001 142 #define NETIF_CHECKSUM_GEN_UDP 0x0002 143 #define NETIF_CHECKSUM_GEN_TCP 0x0004 144 #define NETIF_CHECKSUM_GEN_ICMP 0x0008 145 #define NETIF_CHECKSUM_GEN_ICMP6 0x0010 146 #define NETIF_CHECKSUM_CHECK_IP 0x0100 147 #define NETIF_CHECKSUM_CHECK_UDP 0x0200 148 #define NETIF_CHECKSUM_CHECK_TCP 0x0400 149 #define NETIF_CHECKSUM_CHECK_ICMP 0x0800 150 #define NETIF_CHECKSUM_CHECK_ICMP6 0x1000 151 #define NETIF_CHECKSUM_ENABLE_ALL 0xFFFF 152 #define NETIF_CHECKSUM_DISABLE_ALL 0x0000 153 #endif /* LWIP_CHECKSUM_CTRL_PER_NETIF */ 154 155 struct netif; 156 157 /** MAC Filter Actions, these are passed to a netif's igmp_mac_filter or 158 * mld_mac_filter callback function. */ 159 enum netif_mac_filter_action { 160 /** Delete a filter entry */ 161 NETIF_DEL_MAC_FILTER = 0, 162 /** Add a filter entry */ 163 NETIF_ADD_MAC_FILTER = 1 164 }; 165 166 /** Function prototype for netif init functions. Set up flags and output/linkoutput 167 * callback functions in this function. 168 * 169 * @param netif The netif to initialize 170 */ 171 typedef err_t (*netif_init_fn)(struct netif *netif); 172 /** Function prototype for netif->input functions. This function is saved as 'input' 173 * callback function in the netif struct. Call it when a packet has been received. 174 * 175 * @param p The received packet, copied into a pbuf 176 * @param inp The netif which received the packet 177 * @return ERR_OK if the packet was handled 178 * != ERR_OK is the packet was NOT handled, in this case, the caller has 179 * to free the pbuf 180 */ 181 typedef err_t (*netif_input_fn)(struct pbuf *p, struct netif *inp); 182 183 #if LWIP_IPV4 184 /** Function prototype for netif->output functions. Called by lwIP when a packet 185 * shall be sent. For ethernet netif, set this to 'etharp_output' and set 186 * 'linkoutput'. 187 * 188 * @param netif The netif which shall send a packet 189 * @param p The packet to send (p->payload points to IP header) 190 * @param ipaddr The IP address to which the packet shall be sent 191 */ 192 typedef err_t (*netif_output_fn)(struct netif *netif, struct pbuf *p, 193 const ip4_addr_t *ipaddr); 194 #endif /* LWIP_IPV4*/ 195 196 #if LWIP_IPV6 197 /** Function prototype for netif->output_ip6 functions. Called by lwIP when a packet 198 * shall be sent. For ethernet netif, set this to 'ethip6_output' and set 199 * 'linkoutput'. 200 * 201 * @param netif The netif which shall send a packet 202 * @param p The packet to send (p->payload points to IP header) 203 * @param ipaddr The IPv6 address to which the packet shall be sent 204 */ 205 typedef err_t (*netif_output_ip6_fn)(struct netif *netif, struct pbuf *p, 206 const ip6_addr_t *ipaddr); 207 #endif /* LWIP_IPV6 */ 208 209 /** Function prototype for netif->linkoutput functions. Only used for ethernet 210 * netifs. This function is called by ARP when a packet shall be sent. 211 * 212 * @param netif The netif which shall send a packet 213 * @param p The packet to send (raw ethernet packet) 214 */ 215 typedef err_t (*netif_linkoutput_fn)(struct netif *netif, struct pbuf *p); 216 /** Function prototype for netif status- or link-callback functions. */ 217 typedef void (*netif_status_callback_fn)(struct netif *netif); 218 #if LWIP_IPV4 && LWIP_IGMP 219 /** Function prototype for netif igmp_mac_filter functions */ 220 typedef err_t (*netif_igmp_mac_filter_fn)(struct netif *netif, 221 const ip4_addr_t *group, enum netif_mac_filter_action action); 222 #endif /* LWIP_IPV4 && LWIP_IGMP */ 223 #if LWIP_IPV6 && LWIP_IPV6_MLD 224 /** Function prototype for netif mld_mac_filter functions */ 225 typedef err_t (*netif_mld_mac_filter_fn)(struct netif *netif, 226 const ip6_addr_t *group, enum netif_mac_filter_action action); 227 #endif /* LWIP_IPV6 && LWIP_IPV6_MLD */ 228 229 #if LWIP_DHCP || LWIP_AUTOIP || LWIP_IGMP || LWIP_IPV6_MLD || LWIP_IPV6_DHCP6 || (LWIP_NUM_NETIF_CLIENT_DATA > 0) 230 #if LWIP_NUM_NETIF_CLIENT_DATA > 0 231 u8_t netif_alloc_client_data_id(void); 232 #endif 233 /** @ingroup netif_cd 234 * Set client data. Obtain ID from netif_alloc_client_data_id(). 235 */ 236 #define netif_set_client_data(netif, id, data) netif_get_client_data(netif, id) = (data) 237 /** @ingroup netif_cd 238 * Get client data. Obtain ID from netif_alloc_client_data_id(). 239 */ 240 #define netif_get_client_data(netif, id) (netif)->client_data[(id)] 241 #endif 242 243 #if (LWIP_IPV4 && LWIP_ARP && (ARP_TABLE_SIZE > 0x7f)) || (LWIP_IPV6 && (LWIP_ND6_NUM_DESTINATIONS > 0x7f)) 244 typedef u16_t netif_addr_idx_t; 245 #define NETIF_ADDR_IDX_MAX 0x7FFF 246 #else 247 typedef u8_t netif_addr_idx_t; 248 #define NETIF_ADDR_IDX_MAX 0x7F 249 #endif 250 251 #if LWIP_NETIF_HWADDRHINT || LWIP_VLAN_PCP 252 #define LWIP_NETIF_USE_HINTS 1 253 struct netif_hint { 254 #if LWIP_NETIF_HWADDRHINT 255 u8_t addr_hint; 256 #endif 257 #if LWIP_VLAN_PCP 258 /** VLAN hader is set if this is >= 0 (but must be <= 0xFFFF) */ 259 s32_t tci; 260 #endif 261 }; 262 #else /* LWIP_NETIF_HWADDRHINT || LWIP_VLAN_PCP */ 263 #define LWIP_NETIF_USE_HINTS 0 264 #endif /* LWIP_NETIF_HWADDRHINT || LWIP_VLAN_PCP*/ 265 266 /** Generic data structure used for all lwIP network interfaces. 267 * The following fields should be filled in by the initialization 268 * function for the device driver: hwaddr_len, hwaddr[], mtu, flags */ 269 struct netif { 270 #if !LWIP_SINGLE_NETIF 271 /** pointer to next in linked list */ 272 struct netif *next; 273 #endif 274 275 #if LWIP_IPV4 276 /** IP address configuration in network byte order */ 277 ip_addr_t ip_addr; 278 ip_addr_t netmask; 279 ip_addr_t gw; 280 #endif /* LWIP_IPV4 */ 281 #if LWIP_IPV6 282 /** Array of IPv6 addresses for this netif. */ 283 ip_addr_t ip6_addr[LWIP_IPV6_NUM_ADDRESSES]; 284 /** The state of each IPv6 address (Tentative, Preferred, etc). 285 * @see ip6_addr.h */ 286 u8_t ip6_addr_state[LWIP_IPV6_NUM_ADDRESSES]; 287 #if LWIP_IPV6_ADDRESS_LIFETIMES 288 /** Remaining valid and preferred lifetime of each IPv6 address, in seconds. 289 * For valid lifetimes, the special value of IP6_ADDR_LIFE_STATIC (0) 290 * indicates the address is static and has no lifetimes. */ 291 u32_t ip6_addr_valid_life[LWIP_IPV6_NUM_ADDRESSES]; 292 u32_t ip6_addr_pref_life[LWIP_IPV6_NUM_ADDRESSES]; 293 #endif /* LWIP_IPV6_ADDRESS_LIFETIMES */ 294 #endif /* LWIP_IPV6 */ 295 /** This function is called by the network device driver 296 * to pass a packet up the TCP/IP stack. */ 297 netif_input_fn input; 298 #if LWIP_IPV4 299 /** This function is called by the IP module when it wants 300 * to send a packet on the interface. This function typically 301 * first resolves the hardware address, then sends the packet. 302 * For ethernet physical layer, this is usually etharp_output() */ 303 netif_output_fn output; 304 #endif /* LWIP_IPV4 */ 305 /** This function is called by ethernet_output() when it wants 306 * to send a packet on the interface. This function outputs 307 * the pbuf as-is on the link medium. */ 308 netif_linkoutput_fn linkoutput; 309 #if LWIP_IPV6 310 /** This function is called by the IPv6 module when it wants 311 * to send a packet on the interface. This function typically 312 * first resolves the hardware address, then sends the packet. 313 * For ethernet physical layer, this is usually ethip6_output() */ 314 netif_output_ip6_fn output_ip6; 315 #endif /* LWIP_IPV6 */ 316 #if LWIP_NETIF_STATUS_CALLBACK 317 /** This function is called when the netif state is set to up or down 318 */ 319 netif_status_callback_fn status_callback; 320 #endif /* LWIP_NETIF_STATUS_CALLBACK */ 321 #if LWIP_NETIF_LINK_CALLBACK 322 /** This function is called when the netif link is set to up or down 323 */ 324 netif_status_callback_fn link_callback; 325 #endif /* LWIP_NETIF_LINK_CALLBACK */ 326 #if LWIP_NETIF_REMOVE_CALLBACK 327 /** This function is called when the netif has been removed */ 328 netif_status_callback_fn remove_callback; 329 #endif /* LWIP_NETIF_REMOVE_CALLBACK */ 330 /** This field can be set by the device driver and could point 331 * to state information for the device. */ 332 void *state; 333 #ifdef netif_get_client_data 334 void* client_data[LWIP_NETIF_CLIENT_DATA_INDEX_MAX + LWIP_NUM_NETIF_CLIENT_DATA]; 335 #endif 336 #if LWIP_NETIF_HOSTNAME 337 /* the hostname for this netif, NULL is a valid value */ 338 const char* hostname; 339 #endif /* LWIP_NETIF_HOSTNAME */ 340 #if LWIP_CHECKSUM_CTRL_PER_NETIF 341 u16_t chksum_flags; 342 #endif /* LWIP_CHECKSUM_CTRL_PER_NETIF*/ 343 /** maximum transfer unit (in bytes) */ 344 u16_t mtu; 345 #if LWIP_IPV6 && LWIP_ND6_ALLOW_RA_UPDATES 346 /** maximum transfer unit (in bytes), updated by RA */ 347 u16_t mtu6; 348 #endif /* LWIP_IPV6 && LWIP_ND6_ALLOW_RA_UPDATES */ 349 /** link level hardware address of this interface */ 350 u8_t hwaddr[NETIF_MAX_HWADDR_LEN]; 351 /** number of bytes used in hwaddr */ 352 u8_t hwaddr_len; 353 /** flags (@see @ref netif_flags) */ 354 u8_t flags; 355 /** descriptive abbreviation */ 356 char name[2]; 357 /** number of this interface. Used for @ref if_api and @ref netifapi_netif, 358 * as well as for IPv6 zones */ 359 u8_t num; 360 #if LWIP_IPV6_AUTOCONFIG 361 /** is this netif enabled for IPv6 autoconfiguration */ 362 u8_t ip6_autoconfig_enabled; 363 #endif /* LWIP_IPV6_AUTOCONFIG */ 364 #if LWIP_IPV6_SEND_ROUTER_SOLICIT 365 /** Number of Router Solicitation messages that remain to be sent. */ 366 u8_t rs_count; 367 #endif /* LWIP_IPV6_SEND_ROUTER_SOLICIT */ 368 #if MIB2_STATS 369 /** link type (from "snmp_ifType" enum from snmp_mib2.h) */ 370 u8_t link_type; 371 /** (estimate) link speed */ 372 u32_t link_speed; 373 /** timestamp at last change made (up/down) */ 374 u32_t ts; 375 /** counters */ 376 struct stats_mib2_netif_ctrs mib2_counters; 377 #endif /* MIB2_STATS */ 378 #if LWIP_IPV4 && LWIP_IGMP 379 /** This function could be called to add or delete an entry in the multicast 380 filter table of the ethernet MAC.*/ 381 netif_igmp_mac_filter_fn igmp_mac_filter; 382 #endif /* LWIP_IPV4 && LWIP_IGMP */ 383 #if LWIP_IPV6 && LWIP_IPV6_MLD 384 /** This function could be called to add or delete an entry in the IPv6 multicast 385 filter table of the ethernet MAC. */ 386 netif_mld_mac_filter_fn mld_mac_filter; 387 #endif /* LWIP_IPV6 && LWIP_IPV6_MLD */ 388 #if LWIP_ACD 389 struct acd *acd_list; 390 #endif /* LWIP_ACD */ 391 #if LWIP_NETIF_USE_HINTS 392 struct netif_hint *hints; 393 #endif /* LWIP_NETIF_USE_HINTS */ 394 #if ENABLE_LOOPBACK 395 /* List of packets to be queued for ourselves. */ 396 struct pbuf *loop_first; 397 struct pbuf *loop_last; 398 #if LWIP_LOOPBACK_MAX_PBUFS 399 u16_t loop_cnt_current; 400 #endif /* LWIP_LOOPBACK_MAX_PBUFS */ 401 #if LWIP_NETIF_LOOPBACK_MULTITHREADING 402 /* Used if the original scheduling failed. */ 403 u8_t reschedule_poll; 404 #endif /* LWIP_NETIF_LOOPBACK_MULTITHREADING */ 405 #endif /* ENABLE_LOOPBACK */ 406 }; 407 408 #if LWIP_CHECKSUM_CTRL_PER_NETIF 409 #define NETIF_SET_CHECKSUM_CTRL(netif, chksumflags) do { \ 410 (netif)->chksum_flags = chksumflags; } while(0) 411 #define NETIF_CHECKSUM_ENABLED(netif, chksumflag) (((netif) == NULL) || (((netif)->chksum_flags & (chksumflag)) != 0)) 412 #define IF__NETIF_CHECKSUM_ENABLED(netif, chksumflag) if NETIF_CHECKSUM_ENABLED(netif, chksumflag) 413 #else /* LWIP_CHECKSUM_CTRL_PER_NETIF */ 414 #define NETIF_CHECKSUM_ENABLED(netif, chksumflag) 0 415 #define NETIF_SET_CHECKSUM_CTRL(netif, chksumflags) 416 #define IF__NETIF_CHECKSUM_ENABLED(netif, chksumflag) 417 #endif /* LWIP_CHECKSUM_CTRL_PER_NETIF */ 418 419 #if LWIP_SINGLE_NETIF 420 #define NETIF_FOREACH(netif) if (((netif) = netif_default) != NULL) 421 #else /* LWIP_SINGLE_NETIF */ 422 /** The list of network interfaces. */ 423 extern struct netif *netif_list; 424 #define NETIF_FOREACH(netif) for ((netif) = netif_list; (netif) != NULL; (netif) = (netif)->next) 425 #endif /* LWIP_SINGLE_NETIF */ 426 /** The default network interface. */ 427 extern struct netif *netif_default; 428 429 void netif_init(void); 430 431 struct netif *netif_add_noaddr(struct netif *netif, void *state, netif_init_fn init, netif_input_fn input); 432 433 #if LWIP_IPV4 434 struct netif *netif_add(struct netif *netif, 435 const ip4_addr_t *ipaddr, const ip4_addr_t *netmask, const ip4_addr_t *gw, 436 void *state, netif_init_fn init, netif_input_fn input); 437 void netif_set_addr(struct netif *netif, const ip4_addr_t *ipaddr, const ip4_addr_t *netmask, 438 const ip4_addr_t *gw); 439 #else /* LWIP_IPV4 */ 440 struct netif *netif_add(struct netif *netif, void *state, netif_init_fn init, netif_input_fn input); 441 #endif /* LWIP_IPV4 */ 442 void netif_remove(struct netif * netif); 443 444 /* Returns a network interface given its name. The name is of the form 445 "et0", where the first two letters are the "name" field in the 446 netif structure, and the digit is in the num field in the same 447 structure. */ 448 struct netif *netif_find(const char *name); 449 450 void netif_set_default(struct netif *netif); 451 452 #if LWIP_IPV4 453 void netif_set_ipaddr(struct netif *netif, const ip4_addr_t *ipaddr); 454 void netif_set_netmask(struct netif *netif, const ip4_addr_t *netmask); 455 void netif_set_gw(struct netif *netif, const ip4_addr_t *gw); 456 /** @ingroup netif_ip4 */ 457 #define netif_ip4_addr(netif) ((const ip4_addr_t*)ip_2_ip4(&((netif)->ip_addr))) 458 /** @ingroup netif_ip4 */ 459 #define netif_ip4_netmask(netif) ((const ip4_addr_t*)ip_2_ip4(&((netif)->netmask))) 460 /** @ingroup netif_ip4 */ 461 #define netif_ip4_gw(netif) ((const ip4_addr_t*)ip_2_ip4(&((netif)->gw))) 462 /** @ingroup netif_ip4 */ 463 #define netif_ip_addr4(netif) ((const ip_addr_t*)&((netif)->ip_addr)) 464 /** @ingroup netif_ip4 */ 465 #define netif_ip_netmask4(netif) ((const ip_addr_t*)&((netif)->netmask)) 466 /** @ingroup netif_ip4 */ 467 #define netif_ip_gw4(netif) ((const ip_addr_t*)&((netif)->gw)) 468 #endif /* LWIP_IPV4 */ 469 470 #define netif_set_flags(netif, set_flags) do { (netif)->flags = (u8_t)((netif)->flags | (set_flags)); } while(0) 471 #define netif_clear_flags(netif, clr_flags) do { (netif)->flags = (u8_t)((netif)->flags & (u8_t)(~(clr_flags) & 0xff)); } while(0) 472 #define netif_is_flag_set(netif, flag) (((netif)->flags & (flag)) != 0) 473 474 void netif_set_up(struct netif *netif); 475 void netif_set_down(struct netif *netif); 476 /** @ingroup netif 477 * Ask if an interface is up 478 */ 479 #define netif_is_up(netif) (((netif)->flags & NETIF_FLAG_UP) ? (u8_t)1 : (u8_t)0) 480 481 #if LWIP_NETIF_STATUS_CALLBACK 482 void netif_set_status_callback(struct netif *netif, netif_status_callback_fn status_callback); 483 #endif /* LWIP_NETIF_STATUS_CALLBACK */ 484 #if LWIP_NETIF_REMOVE_CALLBACK 485 void netif_set_remove_callback(struct netif *netif, netif_status_callback_fn remove_callback); 486 #endif /* LWIP_NETIF_REMOVE_CALLBACK */ 487 488 void netif_set_link_up(struct netif *netif); 489 void netif_set_link_down(struct netif *netif); 490 /** Ask if a link is up */ 491 #define netif_is_link_up(netif) (((netif)->flags & NETIF_FLAG_LINK_UP) ? (u8_t)1 : (u8_t)0) 492 493 #if LWIP_NETIF_LINK_CALLBACK 494 void netif_set_link_callback(struct netif *netif, netif_status_callback_fn link_callback); 495 #endif /* LWIP_NETIF_LINK_CALLBACK */ 496 497 #if LWIP_NETIF_HOSTNAME 498 /** @ingroup netif */ 499 #define netif_set_hostname(netif, name) do { if((netif) != NULL) { (netif)->hostname = name; }}while(0) 500 /** @ingroup netif */ 501 #define netif_get_hostname(netif) (((netif) != NULL) ? ((netif)->hostname) : NULL) 502 #endif /* LWIP_NETIF_HOSTNAME */ 503 504 #if LWIP_IGMP 505 /** @ingroup netif 506 * Set igmp mac filter function for a netif. */ 507 #define netif_set_igmp_mac_filter(netif, function) do { if((netif) != NULL) { (netif)->igmp_mac_filter = function; }}while(0) 508 /** Get the igmp mac filter function for a netif. */ 509 #define netif_get_igmp_mac_filter(netif) (((netif) != NULL) ? ((netif)->igmp_mac_filter) : NULL) 510 #endif /* LWIP_IGMP */ 511 512 #if LWIP_IPV6 && LWIP_IPV6_MLD 513 /** @ingroup netif 514 * Set mld mac filter function for a netif. */ 515 #define netif_set_mld_mac_filter(netif, function) do { if((netif) != NULL) { (netif)->mld_mac_filter = function; }}while(0) 516 /** Get the mld mac filter function for a netif. */ 517 #define netif_get_mld_mac_filter(netif) (((netif) != NULL) ? ((netif)->mld_mac_filter) : NULL) 518 #define netif_mld_mac_filter(netif, addr, action) do { if((netif) && (netif)->mld_mac_filter) { (netif)->mld_mac_filter((netif), (addr), (action)); }}while(0) 519 #endif /* LWIP_IPV6 && LWIP_IPV6_MLD */ 520 521 #if ENABLE_LOOPBACK 522 err_t netif_loop_output(struct netif *netif, struct pbuf *p); 523 void netif_poll(struct netif *netif); 524 #if !LWIP_NETIF_LOOPBACK_MULTITHREADING 525 void netif_poll_all(void); 526 #endif /* !LWIP_NETIF_LOOPBACK_MULTITHREADING */ 527 #endif /* ENABLE_LOOPBACK */ 528 529 err_t netif_input(struct pbuf *p, struct netif *inp); 530 531 #if LWIP_IPV6 532 /** @ingroup netif_ip6 */ 533 #define netif_ip_addr6(netif, i) ((const ip_addr_t*)(&((netif)->ip6_addr[i]))) 534 /** @ingroup netif_ip6 */ 535 #define netif_ip6_addr(netif, i) ((const ip6_addr_t*)ip_2_ip6(&((netif)->ip6_addr[i]))) 536 void netif_ip6_addr_set(struct netif *netif, s8_t addr_idx, const ip6_addr_t *addr6); 537 void netif_ip6_addr_set_parts(struct netif *netif, s8_t addr_idx, u32_t i0, u32_t i1, u32_t i2, u32_t i3); 538 #define netif_ip6_addr_state(netif, i) ((netif)->ip6_addr_state[i]) 539 void netif_ip6_addr_set_state(struct netif* netif, s8_t addr_idx, u8_t state); 540 s8_t netif_get_ip6_addr_match(struct netif *netif, const ip6_addr_t *ip6addr); 541 void netif_create_ip6_linklocal_address(struct netif *netif, u8_t from_mac_48bit); 542 err_t netif_add_ip6_address(struct netif *netif, const ip6_addr_t *ip6addr, s8_t *chosen_idx); 543 #define netif_set_ip6_autoconfig_enabled(netif, action) do { if(netif) { (netif)->ip6_autoconfig_enabled = (action); }}while(0) 544 #if LWIP_IPV6_ADDRESS_LIFETIMES 545 #define netif_ip6_addr_valid_life(netif, i) \ 546 (((netif) != NULL) ? ((netif)->ip6_addr_valid_life[i]) : IP6_ADDR_LIFE_STATIC) 547 #define netif_ip6_addr_set_valid_life(netif, i, secs) \ 548 do { if (netif != NULL) { (netif)->ip6_addr_valid_life[i] = (secs); }} while (0) 549 #define netif_ip6_addr_pref_life(netif, i) \ 550 (((netif) != NULL) ? ((netif)->ip6_addr_pref_life[i]) : IP6_ADDR_LIFE_STATIC) 551 #define netif_ip6_addr_set_pref_life(netif, i, secs) \ 552 do { if (netif != NULL) { (netif)->ip6_addr_pref_life[i] = (secs); }} while (0) 553 #define netif_ip6_addr_isstatic(netif, i) \ 554 (netif_ip6_addr_valid_life((netif), (i)) == IP6_ADDR_LIFE_STATIC) 555 #else /* !LWIP_IPV6_ADDRESS_LIFETIMES */ 556 #define netif_ip6_addr_isstatic(netif, i) (1) /* all addresses are static */ 557 #endif /* !LWIP_IPV6_ADDRESS_LIFETIMES */ 558 #if LWIP_ND6_ALLOW_RA_UPDATES 559 #define netif_mtu6(netif) ((netif)->mtu6) 560 #else /* LWIP_ND6_ALLOW_RA_UPDATES */ 561 #define netif_mtu6(netif) ((netif)->mtu) 562 #endif /* LWIP_ND6_ALLOW_RA_UPDATES */ 563 #endif /* LWIP_IPV6 */ 564 565 #if LWIP_NETIF_USE_HINTS 566 #define NETIF_SET_HINTS(netif, netifhint) (netif)->hints = (netifhint) 567 #define NETIF_RESET_HINTS(netif) (netif)->hints = NULL 568 #else /* LWIP_NETIF_USE_HINTS */ 569 #define NETIF_SET_HINTS(netif, netifhint) 570 #define NETIF_RESET_HINTS(netif) 571 #endif /* LWIP_NETIF_USE_HINTS */ 572 573 u8_t netif_name_to_index(const char *name); 574 char * netif_index_to_name(u8_t idx, char *name); 575 struct netif* netif_get_by_index(u8_t idx); 576 577 /* Interface indexes always start at 1 per RFC 3493, section 4, num starts at 0 (internal index is 0..254)*/ 578 #define netif_get_index(netif) ((u8_t)((netif)->num + 1)) 579 #define NETIF_NO_INDEX (0) 580 581 /** 582 * @ingroup netif 583 * Extended netif status callback (NSC) reasons flags. 584 * May be extended in the future! 585 */ 586 typedef u16_t netif_nsc_reason_t; 587 588 /* used for initialization only */ 589 #define LWIP_NSC_NONE 0x0000 590 /** netif was added. arg: NULL. Called AFTER netif was added. */ 591 #define LWIP_NSC_NETIF_ADDED 0x0001 592 /** netif was removed. arg: NULL. Called BEFORE netif is removed. */ 593 #define LWIP_NSC_NETIF_REMOVED 0x0002 594 /** link changed */ 595 #define LWIP_NSC_LINK_CHANGED 0x0004 596 /** netif administrative status changed.<br> 597 * up is called AFTER netif is set up.<br> 598 * down is called BEFORE the netif is actually set down. */ 599 #define LWIP_NSC_STATUS_CHANGED 0x0008 600 /** IPv4 address has changed */ 601 #define LWIP_NSC_IPV4_ADDRESS_CHANGED 0x0010 602 /** IPv4 gateway has changed */ 603 #define LWIP_NSC_IPV4_GATEWAY_CHANGED 0x0020 604 /** IPv4 netmask has changed */ 605 #define LWIP_NSC_IPV4_NETMASK_CHANGED 0x0040 606 /** called AFTER IPv4 address/gateway/netmask changes have been applied */ 607 #define LWIP_NSC_IPV4_SETTINGS_CHANGED 0x0080 608 /** IPv6 address was added */ 609 #define LWIP_NSC_IPV6_SET 0x0100 610 /** IPv6 address state has changed */ 611 #define LWIP_NSC_IPV6_ADDR_STATE_CHANGED 0x0200 612 /** IPv4 settings: valid address set, application may start to communicate */ 613 #define LWIP_NSC_IPV4_ADDR_VALID 0x0400 614 615 /** @ingroup netif 616 * Argument supplied to netif_ext_callback_fn. 617 */ 618 typedef union 619 { 620 /** Args to LWIP_NSC_LINK_CHANGED callback */ 621 struct link_changed_s 622 { 623 /** 1: up; 0: down */ 624 u8_t state; 625 } link_changed; 626 /** Args to LWIP_NSC_STATUS_CHANGED callback */ 627 struct status_changed_s 628 { 629 /** 1: up; 0: down */ 630 u8_t state; 631 } status_changed; 632 /** Args to LWIP_NSC_IPV4_ADDRESS_CHANGED|LWIP_NSC_IPV4_GATEWAY_CHANGED|LWIP_NSC_IPV4_NETMASK_CHANGED|LWIP_NSC_IPV4_SETTINGS_CHANGED callback */ 633 struct ipv4_changed_s 634 { 635 /** Old IPv4 address */ 636 const ip_addr_t* old_address; 637 const ip_addr_t* old_netmask; 638 const ip_addr_t* old_gw; 639 } ipv4_changed; 640 /** Args to LWIP_NSC_IPV6_SET callback */ 641 struct ipv6_set_s 642 { 643 /** Index of changed IPv6 address */ 644 s8_t addr_index; 645 /** Old IPv6 address */ 646 const ip_addr_t* old_address; 647 } ipv6_set; 648 /** Args to LWIP_NSC_IPV6_ADDR_STATE_CHANGED callback */ 649 struct ipv6_addr_state_changed_s 650 { 651 /** Index of affected IPv6 address */ 652 s8_t addr_index; 653 /** Old IPv6 address state */ 654 u8_t old_state; 655 /** Affected IPv6 address */ 656 const ip_addr_t* address; 657 } ipv6_addr_state_changed; 658 } netif_ext_callback_args_t; 659 660 /** 661 * @ingroup netif 662 * Function used for extended netif status callbacks 663 * Note: When parsing reason argument, keep in mind that more reasons may be added in the future! 664 * @param netif netif that is affected by change 665 * @param reason change reason 666 * @param args depends on reason, see reason description 667 */ 668 typedef void (*netif_ext_callback_fn)(struct netif* netif, netif_nsc_reason_t reason, const netif_ext_callback_args_t* args); 669 670 #if LWIP_NETIF_EXT_STATUS_CALLBACK 671 struct netif_ext_callback; 672 typedef struct netif_ext_callback 673 { 674 netif_ext_callback_fn callback_fn; 675 struct netif_ext_callback* next; 676 } netif_ext_callback_t; 677 678 #define NETIF_DECLARE_EXT_CALLBACK(name) static netif_ext_callback_t name; 679 void netif_add_ext_callback(netif_ext_callback_t* callback, netif_ext_callback_fn fn); 680 void netif_remove_ext_callback(netif_ext_callback_t* callback); 681 void netif_invoke_ext_callback(struct netif* netif, netif_nsc_reason_t reason, const netif_ext_callback_args_t* args); 682 #else 683 #define NETIF_DECLARE_EXT_CALLBACK(name) 684 #define netif_add_ext_callback(callback, fn) 685 #define netif_remove_ext_callback(callback) 686 #define netif_invoke_ext_callback(netif, reason, args) 687 #endif 688 689 #if LWIP_TESTMODE && LWIP_HAVE_LOOPIF 690 struct netif* netif_get_loopif(void); 691 #endif 692 693 694 #ifdef __cplusplus 695 } 696 #endif 697 698 #endif /* LWIP_HDR_NETIF_H */ 699