3 * lwIP network interface abstraction
8 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
11 * Redistribution and use in source and binary forms, with or without modification,
12 * are permitted provided that the following conditions are met:
14 * 1. Redistributions of source code must retain the above copyright notice,
15 * this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright notice,
17 * this list of conditions and the following disclaimer in the documentation
18 * and/or other materials provided with the distribution.
19 * 3. The name of the author may not be used to endorse or promote products
20 * derived from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
23 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
24 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
25 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
27 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
30 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
33 * This file is part of the lwIP TCP/IP stack.
35 * Author: Adam Dunkels <adam@sics.se>
42 #include "lwip/ip_addr.h"
43 #include "lwip/netif.h"
45 #include "lwip/snmp.h"
46 #include "lwip/igmp.h"
47 #include "netif/etharp.h"
50 #if LWIP_NETIF_LOOPBACK_MULTITHREADING
51 #include "lwip/tcpip.h"
52 #endif /* LWIP_NETIF_LOOPBACK_MULTITHREADING */
53 #endif /* ENABLE_LOOPBACK */
56 #include "lwip/autoip.h"
57 #endif /* LWIP_AUTOIP */
59 #include "lwip/dhcp.h"
60 #endif /* LWIP_DHCP */
62 #if LWIP_NETIF_STATUS_CALLBACK
63 #define NETIF_STATUS_CALLBACK(n) { if (n->status_callback) (n->status_callback)(n); }
65 #define NETIF_STATUS_CALLBACK(n) { /* NOP */ }
66 #endif /* LWIP_NETIF_STATUS_CALLBACK */
68 #if LWIP_NETIF_LINK_CALLBACK
69 #define NETIF_LINK_CALLBACK(n) { if (n->link_callback) (n->link_callback)(n); }
71 #define NETIF_LINK_CALLBACK(n) { /* NOP */ }
72 #endif /* LWIP_NETIF_LINK_CALLBACK */
74 struct netif *netif_list;
75 struct netif *netif_default;
78 * Add a network interface to the list of lwIP netifs.
80 * @param netif a pre-allocated netif structure
81 * @param ipaddr IP address for the new netif
82 * @param netmask network mask for the new netif
83 * @param gw default gateway IP address for the new netif
84 * @param state opaque data passed to the new netif
85 * @param init callback function that initializes the interface
86 * @param input callback function that is called to pass
87 * ingress packets up in the protocol layer stack.
89 * @return netif, or NULL if failed.
92 netif_add(struct netif *netif, struct ip_addr *ipaddr, struct ip_addr *netmask,
93 struct ip_addr *gw, void *state, netif_init_fn init, netif_input_fn input)
95 static u8_t netifnum = 0;
97 LWIP_ASSERT("No init function given", init != NULL);
99 /* reset new interface configuration state */
100 netif->ip_addr.addr = 0;
101 netif->netmask.addr = 0;
105 /* netif not under DHCP control by default */
107 #endif /* LWIP_DHCP */
109 /* netif not under AutoIP control by default */
110 netif->autoip = NULL;
111 #endif /* LWIP_AUTOIP */
112 #if LWIP_NETIF_STATUS_CALLBACK
113 netif->status_callback = NULL;
114 #endif /* LWIP_NETIF_STATUS_CALLBACK */
115 #if LWIP_NETIF_LINK_CALLBACK
116 netif->link_callback = NULL;
117 #endif /* LWIP_NETIF_LINK_CALLBACK */
119 netif->igmp_mac_filter = NULL;
120 #endif /* LWIP_IGMP */
122 netif->loop_first = NULL;
123 netif->loop_last = NULL;
124 #endif /* ENABLE_LOOPBACK */
126 /* remember netif specific state information data */
127 netif->state = state;
128 netif->num = netifnum++;
129 netif->input = input;
130 #if LWIP_NETIF_HWADDRHINT
131 netif->addr_hint = NULL;
132 #endif /* LWIP_NETIF_HWADDRHINT*/
133 #if ENABLE_LOOPBACK && LWIP_LOOPBACK_MAX_PBUFS
134 netif->loop_cnt_current = 0;
135 #endif /* ENABLE_LOOPBACK && LWIP_LOOPBACK_MAX_PBUFS */
137 netif_set_addr(netif, ipaddr, netmask, gw);
139 /* call user specified initialization function for netif */
140 if (init(netif) != ERR_OK) {
144 /* add this netif to the list */
145 netif->next = netif_list;
150 /* start IGMP processing */
151 if (netif->flags & NETIF_FLAG_IGMP) {
154 #endif /* LWIP_IGMP */
156 LWIP_DEBUGF(NETIF_DEBUG, ("netif: added interface %c%c IP addr ",
157 netif->name[0], netif->name[1]));
158 ip_addr_debug_print(NETIF_DEBUG, ipaddr);
159 LWIP_DEBUGF(NETIF_DEBUG, (" netmask "));
160 ip_addr_debug_print(NETIF_DEBUG, netmask);
161 LWIP_DEBUGF(NETIF_DEBUG, (" gw "));
162 ip_addr_debug_print(NETIF_DEBUG, gw);
163 LWIP_DEBUGF(NETIF_DEBUG, ("\n"));
168 * Change IP address configuration for a network interface (including netmask
169 * and default gateway).
171 * @param netif the network interface to change
172 * @param ipaddr the new IP address
173 * @param netmask the new netmask
174 * @param gw the new default gateway
177 netif_set_addr(struct netif *netif, struct ip_addr *ipaddr, struct ip_addr *netmask,
180 netif_set_ipaddr(netif, ipaddr);
181 netif_set_netmask(netif, netmask);
182 netif_set_gw(netif, gw);
186 * Remove a network interface from the list of lwIP netifs.
188 * @param netif the network interface to remove
191 netif_remove(struct netif *netif)
198 /* stop IGMP processing */
199 if (netif->flags & NETIF_FLAG_IGMP) {
202 #endif /* LWIP_IGMP */
203 if (netif_is_up(netif)) {
204 /* set netif down before removing (call callback function) */
205 netif_set_down(netif);
208 snmp_delete_ipaddridx_tree(netif);
210 /* is it the first netif? */
211 if (netif_list == netif) {
212 netif_list = netif->next;
214 /* look for netif further down the list */
215 struct netif * tmpNetif;
216 for (tmpNetif = netif_list; tmpNetif != NULL; tmpNetif = tmpNetif->next) {
217 if (tmpNetif->next == netif) {
218 tmpNetif->next = netif->next;
222 if (tmpNetif == NULL)
223 return; /* we didn't find any netif today */
226 /* this netif is default? */
227 if (netif_default == netif) {
228 /* reset default netif */
229 netif_set_default(NULL);
231 LWIP_DEBUGF( NETIF_DEBUG, ("netif_remove: removed netif\n") );
235 * Find a network interface by searching for its name
237 * @param name the name of the netif (like netif->name) plus concatenated number
238 * in ascii representation (e.g. 'en0')
241 netif_find(char *name)
252 for(netif = netif_list; netif != NULL; netif = netif->next) {
253 if (num == netif->num &&
254 name[0] == netif->name[0] &&
255 name[1] == netif->name[1]) {
256 LWIP_DEBUGF(NETIF_DEBUG, ("netif_find: found %c%c\n", name[0], name[1]));
260 LWIP_DEBUGF(NETIF_DEBUG, ("netif_find: didn't find %c%c\n", name[0], name[1]));
265 * Change the IP address of a network interface
267 * @param netif the network interface to change
268 * @param ipaddr the new IP address
270 * @note call netif_set_addr() if you also want to change netmask and
274 netif_set_ipaddr(struct netif *netif, struct ip_addr *ipaddr)
276 /* TODO: Handling of obsolete pcbs */
277 /* See: http://mail.gnu.org/archive/html/lwip-users/2003-03/msg00118.html */
280 struct tcp_pcb_listen *lpcb;
282 /* address is actually being changed? */
283 if ((ip_addr_cmp(ipaddr, &(netif->ip_addr))) == 0) {
284 /* extern struct tcp_pcb *tcp_active_pcbs; defined by tcp.h */
285 LWIP_DEBUGF(NETIF_DEBUG | LWIP_DBG_STATE, ("netif_set_ipaddr: netif address being changed\n"));
286 pcb = tcp_active_pcbs;
287 while (pcb != NULL) {
288 /* PCB bound to current local interface address? */
289 if (ip_addr_cmp(&(pcb->local_ip), &(netif->ip_addr))) {
290 /* this connection must be aborted */
291 struct tcp_pcb *next = pcb->next;
292 LWIP_DEBUGF(NETIF_DEBUG | LWIP_DBG_STATE, ("netif_set_ipaddr: aborting TCP pcb %p\n", (void *)pcb));
299 for (lpcb = tcp_listen_pcbs.listen_pcbs; lpcb != NULL; lpcb = lpcb->next) {
300 /* PCB bound to current local interface address? */
301 if ((!(ip_addr_isany(&(lpcb->local_ip)))) &&
302 (ip_addr_cmp(&(lpcb->local_ip), &(netif->ip_addr)))) {
303 /* The PCB is listening to the old ipaddr and
304 * is set to listen to the new one instead */
305 ip_addr_set(&(lpcb->local_ip), ipaddr);
310 snmp_delete_ipaddridx_tree(netif);
311 snmp_delete_iprteidx_tree(0,netif);
312 /* set new IP address to netif */
313 ip_addr_set(&(netif->ip_addr), ipaddr);
314 snmp_insert_ipaddridx_tree(netif);
315 snmp_insert_iprteidx_tree(0,netif);
317 LWIP_DEBUGF(NETIF_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("netif: IP address of interface %c%c set to %"U16_F".%"U16_F".%"U16_F".%"U16_F"\n",
318 netif->name[0], netif->name[1],
319 ip4_addr1(&netif->ip_addr),
320 ip4_addr2(&netif->ip_addr),
321 ip4_addr3(&netif->ip_addr),
322 ip4_addr4(&netif->ip_addr)));
326 * Change the default gateway for a network interface
328 * @param netif the network interface to change
329 * @param gw the new default gateway
331 * @note call netif_set_addr() if you also want to change ip address and netmask
334 netif_set_gw(struct netif *netif, struct ip_addr *gw)
336 ip_addr_set(&(netif->gw), gw);
337 LWIP_DEBUGF(NETIF_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("netif: GW address of interface %c%c set to %"U16_F".%"U16_F".%"U16_F".%"U16_F"\n",
338 netif->name[0], netif->name[1],
339 ip4_addr1(&netif->gw),
340 ip4_addr2(&netif->gw),
341 ip4_addr3(&netif->gw),
342 ip4_addr4(&netif->gw)));
346 * Change the netmask of a network interface
348 * @param netif the network interface to change
349 * @param netmask the new netmask
351 * @note call netif_set_addr() if you also want to change ip address and
355 netif_set_netmask(struct netif *netif, struct ip_addr *netmask)
357 snmp_delete_iprteidx_tree(0, netif);
358 /* set new netmask to netif */
359 ip_addr_set(&(netif->netmask), netmask);
360 snmp_insert_iprteidx_tree(0, netif);
361 LWIP_DEBUGF(NETIF_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("netif: netmask of interface %c%c set to %"U16_F".%"U16_F".%"U16_F".%"U16_F"\n",
362 netif->name[0], netif->name[1],
363 ip4_addr1(&netif->netmask),
364 ip4_addr2(&netif->netmask),
365 ip4_addr3(&netif->netmask),
366 ip4_addr4(&netif->netmask)));
370 * Set a network interface as the default network interface
371 * (used to output all packets for which no specific route is found)
373 * @param netif the default network interface
376 netif_set_default(struct netif *netif)
379 /* remove default route */
380 snmp_delete_iprteidx_tree(1, netif);
382 /* install default route */
383 snmp_insert_iprteidx_tree(1, netif);
385 netif_default = netif;
386 LWIP_DEBUGF(NETIF_DEBUG, ("netif: setting default interface %c%c\n",
387 netif ? netif->name[0] : '\'', netif ? netif->name[1] : '\''));
391 * Bring an interface up, available for processing
394 * @note: Enabling DHCP on a down interface will make it come
395 * up once configured.
399 void netif_set_up(struct netif *netif)
401 if (!(netif->flags & NETIF_FLAG_UP)) {
402 netif->flags |= NETIF_FLAG_UP;
405 snmp_get_sysuptime(&netif->ts);
406 #endif /* LWIP_SNMP */
408 NETIF_LINK_CALLBACK(netif);
409 NETIF_STATUS_CALLBACK(netif);
412 /* For Ethernet network interfaces, we would like to send a "gratuitous ARP" */
413 if (netif->flags & NETIF_FLAG_ETHARP) {
414 etharp_gratuitous(netif);
416 #endif /* LWIP_ARP */
419 /* resend IGMP memberships */
420 if (netif->flags & NETIF_FLAG_IGMP) {
421 igmp_report_groups( netif);
423 #endif /* LWIP_IGMP */
428 * Bring an interface down, disabling any traffic processing.
430 * @note: Enabling DHCP on a down interface will make it come
431 * up once configured.
435 void netif_set_down(struct netif *netif)
437 if (netif->flags & NETIF_FLAG_UP) {
438 netif->flags &= ~NETIF_FLAG_UP;
440 snmp_get_sysuptime(&netif->ts);
443 NETIF_LINK_CALLBACK(netif);
444 NETIF_STATUS_CALLBACK(netif);
448 #if LWIP_NETIF_STATUS_CALLBACK
450 * Set callback to be called when interface is brought up/down
452 void netif_set_status_callback(struct netif *netif, netif_status_callback_fn status_callback)
455 netif->status_callback = status_callback;
458 #endif /* LWIP_NETIF_STATUS_CALLBACK */
460 #if LWIP_NETIF_LINK_CALLBACK
462 * Called by a driver when its link goes up
464 void netif_set_link_up(struct netif *netif )
466 netif->flags |= NETIF_FLAG_LINK_UP;
470 dhcp_network_changed(netif);
472 #endif /* LWIP_DHCP */
476 autoip_network_changed(netif);
478 #endif /* LWIP_AUTOIP */
480 if (netif->flags & NETIF_FLAG_UP) {
482 /* For Ethernet network interfaces, we would like to send a "gratuitous ARP" */
483 if (netif->flags & NETIF_FLAG_ETHARP) {
484 etharp_gratuitous(netif);
486 #endif /* LWIP_ARP */
489 /* resend IGMP memberships */
490 if (netif->flags & NETIF_FLAG_IGMP) {
491 igmp_report_groups( netif);
493 #endif /* LWIP_IGMP */
495 NETIF_LINK_CALLBACK(netif);
499 * Called by a driver when its link goes down
501 void netif_set_link_down(struct netif *netif )
503 netif->flags &= ~NETIF_FLAG_LINK_UP;
504 NETIF_LINK_CALLBACK(netif);
508 * Set callback to be called when link is brought up/down
510 void netif_set_link_callback(struct netif *netif, netif_status_callback_fn link_callback)
513 netif->link_callback = link_callback;
516 #endif /* LWIP_NETIF_LINK_CALLBACK */
520 * Send an IP packet to be received on the same netif (loopif-like).
521 * The pbuf is simply copied and handed back to netif->input.
522 * In multithreaded mode, this is done directly since netif->input must put
523 * the packet on a queue.
524 * In callback mode, the packet is put on an internal queue and is fed to
525 * netif->input by netif_poll().
527 * @param netif the lwip network interface structure
528 * @param p the (IP) packet to 'send'
529 * @param ipaddr the ip address to send the packet to (not used)
530 * @return ERR_OK if the packet has been sent
531 * ERR_MEM if the pbuf used to copy the packet couldn't be allocated
534 netif_loop_output(struct netif *netif, struct pbuf *p,
535 struct ip_addr *ipaddr)
540 #if LWIP_LOOPBACK_MAX_PBUFS
542 #endif /* LWIP_LOOPBACK_MAX_PBUFS */
543 SYS_ARCH_DECL_PROTECT(lev);
544 LWIP_UNUSED_ARG(ipaddr);
546 /* Allocate a new pbuf */
547 r = pbuf_alloc(PBUF_LINK, p->tot_len, PBUF_RAM);
551 #if LWIP_LOOPBACK_MAX_PBUFS
553 /* check for overflow or too many pbuf on queue */
554 if(((netif->loop_cnt_current + clen) < netif->loop_cnt_current) ||
555 ((netif->loop_cnt_current + clen) > LWIP_LOOPBACK_MAX_PBUFS)) {
560 netif->loop_cnt_current += clen;
561 #endif /* LWIP_LOOPBACK_MAX_PBUFS */
563 /* Copy the whole pbuf queue p into the single pbuf r */
564 if ((err = pbuf_copy(r, p)) != ERR_OK) {
570 /* Put the packet on a linked list which gets emptied through calling
573 /* let last point to the last pbuf in chain r */
574 for (last = r; last->next != NULL; last = last->next);
576 SYS_ARCH_PROTECT(lev);
577 if(netif->loop_first != NULL) {
578 LWIP_ASSERT("if first != NULL, last must also be != NULL", netif->loop_last != NULL);
579 netif->loop_last->next = r;
580 netif->loop_last = last;
582 netif->loop_first = r;
583 netif->loop_last = last;
585 SYS_ARCH_UNPROTECT(lev);
587 #if LWIP_NETIF_LOOPBACK_MULTITHREADING
588 /* For multithreading environment, schedule a call to netif_poll */
589 tcpip_callback((tcpip_callback_fn)netif_poll, netif);
590 #endif /* LWIP_NETIF_LOOPBACK_MULTITHREADING */
596 * Call netif_poll() in the main loop of your application. This is to prevent
597 * reentering non-reentrant functions like tcp_input(). Packets passed to
598 * netif_loop_output() are put on a list that is passed to netif->input() by
602 netif_poll(struct netif *netif)
605 SYS_ARCH_DECL_PROTECT(lev);
608 /* Get a packet from the list. With SYS_LIGHTWEIGHT_PROT=1, this is protected */
609 SYS_ARCH_PROTECT(lev);
610 in = netif->loop_first;
612 struct pbuf *in_end = in;
613 #if LWIP_LOOPBACK_MAX_PBUFS
614 u8_t clen = pbuf_clen(in);
615 /* adjust the number of pbufs on queue */
616 LWIP_ASSERT("netif->loop_cnt_current underflow",
617 ((netif->loop_cnt_current - clen) < netif->loop_cnt_current));
618 netif->loop_cnt_current -= clen;
619 #endif /* LWIP_LOOPBACK_MAX_PBUFS */
620 while (in_end->len != in_end->tot_len) {
621 LWIP_ASSERT("bogus pbuf: len != tot_len but next == NULL!", in_end->next != NULL);
622 in_end = in_end->next;
624 /* 'in_end' now points to the last pbuf from 'in' */
625 if (in_end == netif->loop_last) {
626 /* this was the last pbuf in the list */
627 netif->loop_first = netif->loop_last = NULL;
629 /* pop the pbuf off the list */
630 netif->loop_first = in_end->next;
631 LWIP_ASSERT("should not be null since first != last!", netif->loop_first != NULL);
633 /* De-queue the pbuf from its successors on the 'loop_' list. */
636 SYS_ARCH_UNPROTECT(lev);
639 /* loopback packets are always IP packets! */
640 if (ip_input(in, netif) != ERR_OK) {
643 /* Don't reference the packet any more! */
646 /* go on while there is a packet on the list */
647 } while (netif->loop_first != NULL);
650 #if !LWIP_NETIF_LOOPBACK_MULTITHREADING
652 * Calls netif_poll() for every netif on the netif_list.
657 struct netif *netif = netif_list;
658 /* loop through netifs */
659 while (netif != NULL) {
661 /* proceed to next network interface */
665 #endif /* !LWIP_NETIF_LOOPBACK_MULTITHREADING */
666 #endif /* ENABLE_LOOPBACK */