Donatien Garnier
NetServices Stack source
Dependents: HelloWorld ServoInterfaceBoardExample1 4180_Lab4
lwip/include/lwip/netif.h@5:dd63a1e02b1b, 2010-07-27 (annotated)
- Committer:
- donatien
- Date:
- Tue Jul 27 15:59:42 2010 +0000
- Revision:
- 5:dd63a1e02b1b
- Parent:
- 0:632c9925f013
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| donatien | 0:632c9925f013 | 1 | /* |
| donatien | 0:632c9925f013 | 2 | * Copyright (c) 2001-2004 Swedish Institute of Computer Science. |
| donatien | 0:632c9925f013 | 3 | * All rights reserved. |
| donatien | 0:632c9925f013 | 4 | * |
| donatien | 0:632c9925f013 | 5 | * Redistribution and use in source and binary forms, with or without modification, |
| donatien | 0:632c9925f013 | 6 | * are permitted provided that the following conditions are met: |
| donatien | 0:632c9925f013 | 7 | * |
| donatien | 0:632c9925f013 | 8 | * 1. Redistributions of source code must retain the above copyright notice, |
| donatien | 0:632c9925f013 | 9 | * this list of conditions and the following disclaimer. |
| donatien | 0:632c9925f013 | 10 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
| donatien | 0:632c9925f013 | 11 | * this list of conditions and the following disclaimer in the documentation |
| donatien | 0:632c9925f013 | 12 | * and/or other materials provided with the distribution. |
| donatien | 0:632c9925f013 | 13 | * 3. The name of the author may not be used to endorse or promote products |
| donatien | 0:632c9925f013 | 14 | * derived from this software without specific prior written permission. |
| donatien | 0:632c9925f013 | 15 | * |
| donatien | 0:632c9925f013 | 16 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED |
| donatien | 0:632c9925f013 | 17 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
| donatien | 0:632c9925f013 | 18 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT |
| donatien | 0:632c9925f013 | 19 | * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
| donatien | 0:632c9925f013 | 20 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT |
| donatien | 0:632c9925f013 | 21 | * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| donatien | 0:632c9925f013 | 22 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| donatien | 0:632c9925f013 | 23 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING |
| donatien | 0:632c9925f013 | 24 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY |
| donatien | 0:632c9925f013 | 25 | * OF SUCH DAMAGE. |
| donatien | 0:632c9925f013 | 26 | * |
| donatien | 0:632c9925f013 | 27 | * This file is part of the lwIP TCP/IP stack. |
| donatien | 0:632c9925f013 | 28 | * |
| donatien | 0:632c9925f013 | 29 | * Author: Adam Dunkels <adam@sics.se> |
| donatien | 0:632c9925f013 | 30 | * |
| donatien | 0:632c9925f013 | 31 | */ |
| donatien | 0:632c9925f013 | 32 | #ifndef __LWIP_NETIF_H__ |
| donatien | 0:632c9925f013 | 33 | #define __LWIP_NETIF_H__ |
| donatien | 0:632c9925f013 | 34 | |
| donatien | 0:632c9925f013 | 35 | #include "lwip/opt.h" |
| donatien | 0:632c9925f013 | 36 | |
| donatien | 0:632c9925f013 | 37 | #define ENABLE_LOOPBACK (LWIP_NETIF_LOOPBACK || LWIP_HAVE_LOOPIF) |
| donatien | 0:632c9925f013 | 38 | |
| donatien | 0:632c9925f013 | 39 | #include "lwip/err.h" |
| donatien | 0:632c9925f013 | 40 | |
| donatien | 0:632c9925f013 | 41 | #include "lwip/ip_addr.h" |
| donatien | 0:632c9925f013 | 42 | |
| donatien | 0:632c9925f013 | 43 | #include "lwip/def.h" |
| donatien | 0:632c9925f013 | 44 | #include "lwip/pbuf.h" |
| donatien | 0:632c9925f013 | 45 | #if LWIP_DHCP |
| donatien | 0:632c9925f013 | 46 | struct dhcp; |
| donatien | 0:632c9925f013 | 47 | #endif |
| donatien | 0:632c9925f013 | 48 | #if LWIP_AUTOIP |
| donatien | 0:632c9925f013 | 49 | struct autoip; |
| donatien | 0:632c9925f013 | 50 | #endif |
| donatien | 0:632c9925f013 | 51 | |
| donatien | 0:632c9925f013 | 52 | #ifdef __cplusplus |
| donatien | 0:632c9925f013 | 53 | extern "C" { |
| donatien | 0:632c9925f013 | 54 | #endif |
| donatien | 0:632c9925f013 | 55 | |
| donatien | 0:632c9925f013 | 56 | /* Throughout this file, IP addresses are expected to be in |
| donatien | 0:632c9925f013 | 57 | * the same byte order as in IP_PCB. */ |
| donatien | 0:632c9925f013 | 58 | |
| donatien | 5:dd63a1e02b1b | 59 | /* must be the maximum of all used hardware address lengths |
| donatien | 0:632c9925f013 | 60 | across all types of interfaces in use */ |
| donatien | 0:632c9925f013 | 61 | #define NETIF_MAX_HWADDR_LEN 6U |
| donatien | 0:632c9925f013 | 62 | |
| donatien | 5:dd63a1e02b1b | 63 | /* Whether the network interface is 'up'. This is |
| donatien | 0:632c9925f013 | 64 | * a software flag used to control whether this network |
| donatien | 0:632c9925f013 | 65 | * interface is enabled and processes traffic. |
| donatien | 0:632c9925f013 | 66 | * It is set by the startup code (for static IP configuration) or |
| donatien | 0:632c9925f013 | 67 | * by dhcp/autoip when an address has been assigned. |
| donatien | 0:632c9925f013 | 68 | */ |
| donatien | 0:632c9925f013 | 69 | #define NETIF_FLAG_UP 0x01U |
| donatien | 5:dd63a1e02b1b | 70 | /* If set, the netif has broadcast capability. |
| donatien | 0:632c9925f013 | 71 | * Set by the netif driver in its init function. */ |
| donatien | 0:632c9925f013 | 72 | #define NETIF_FLAG_BROADCAST 0x02U |
| donatien | 5:dd63a1e02b1b | 73 | /* If set, the netif is one end of a point-to-point connection. |
| donatien | 0:632c9925f013 | 74 | * Set by the netif driver in its init function. */ |
| donatien | 0:632c9925f013 | 75 | #define NETIF_FLAG_POINTTOPOINT 0x04U |
| donatien | 5:dd63a1e02b1b | 76 | /* If set, the interface is configured using DHCP. |
| donatien | 0:632c9925f013 | 77 | * Set by the DHCP code when starting or stopping DHCP. */ |
| donatien | 0:632c9925f013 | 78 | #define NETIF_FLAG_DHCP 0x08U |
| donatien | 5:dd63a1e02b1b | 79 | /* If set, the interface has an active link |
| donatien | 0:632c9925f013 | 80 | * (set by the network interface driver). |
| donatien | 0:632c9925f013 | 81 | * Either set by the netif driver in its init function (if the link |
| donatien | 0:632c9925f013 | 82 | * is up at that time) or at a later point once the link comes up |
| donatien | 0:632c9925f013 | 83 | * (if link detection is supported by the hardware). */ |
| donatien | 0:632c9925f013 | 84 | #define NETIF_FLAG_LINK_UP 0x10U |
| donatien | 5:dd63a1e02b1b | 85 | /* If set, the netif is an ethernet device using ARP. |
| donatien | 0:632c9925f013 | 86 | * Set by the netif driver in its init function. |
| donatien | 0:632c9925f013 | 87 | * Used to check input packet types and use of DHCP. */ |
| donatien | 0:632c9925f013 | 88 | #define NETIF_FLAG_ETHARP 0x20U |
| donatien | 5:dd63a1e02b1b | 89 | /* If set, the netif is an ethernet device. It might not use |
| donatien | 0:632c9925f013 | 90 | * ARP or TCP/IP if it is used for PPPoE only. |
| donatien | 0:632c9925f013 | 91 | */ |
| donatien | 0:632c9925f013 | 92 | #define NETIF_FLAG_ETHERNET 0x40U |
| donatien | 5:dd63a1e02b1b | 93 | /* If set, the netif has IGMP capability. |
| donatien | 0:632c9925f013 | 94 | * Set by the netif driver in its init function. */ |
| donatien | 0:632c9925f013 | 95 | #define NETIF_FLAG_IGMP 0x80U |
| donatien | 0:632c9925f013 | 96 | |
| donatien | 5:dd63a1e02b1b | 97 | /* Function prototype for netif init functions. Set up flags and output/linkoutput |
| donatien | 0:632c9925f013 | 98 | * callback functions in this function. |
| donatien | 0:632c9925f013 | 99 | * |
| donatien | 0:632c9925f013 | 100 | * @param netif The netif to initialize |
| donatien | 0:632c9925f013 | 101 | */ |
| donatien | 0:632c9925f013 | 102 | typedef err_t (*netif_init_fn)(struct netif *netif); |
| donatien | 5:dd63a1e02b1b | 103 | /* Function prototype for netif->input functions. This function is saved as 'input' |
| donatien | 0:632c9925f013 | 104 | * callback function in the netif struct. Call it when a packet has been received. |
| donatien | 0:632c9925f013 | 105 | * |
| donatien | 0:632c9925f013 | 106 | * @param p The received packet, copied into a pbuf |
| donatien | 0:632c9925f013 | 107 | * @param inp The netif which received the packet |
| donatien | 0:632c9925f013 | 108 | */ |
| donatien | 0:632c9925f013 | 109 | typedef err_t (*netif_input_fn)(struct pbuf *p, struct netif *inp); |
| donatien | 5:dd63a1e02b1b | 110 | /* Function prototype for netif->output functions. Called by lwIP when a packet |
| donatien | 0:632c9925f013 | 111 | * shall be sent. For ethernet netif, set this to 'etharp_output' and set |
| donatien | 0:632c9925f013 | 112 | * 'linkoutput'. |
| donatien | 0:632c9925f013 | 113 | * |
| donatien | 0:632c9925f013 | 114 | * @param netif The netif which shall send a packet |
| donatien | 0:632c9925f013 | 115 | * @param p The packet to send (p->payload points to IP header) |
| donatien | 0:632c9925f013 | 116 | * @param ipaddr The IP address to which the packet shall be sent |
| donatien | 0:632c9925f013 | 117 | */ |
| donatien | 0:632c9925f013 | 118 | typedef err_t (*netif_output_fn)(struct netif *netif, struct pbuf *p, |
| donatien | 0:632c9925f013 | 119 | ip_addr_t *ipaddr); |
| donatien | 5:dd63a1e02b1b | 120 | /* Function prototype for netif->linkoutput functions. Only used for ethernet |
| donatien | 0:632c9925f013 | 121 | * netifs. This function is called by ARP when a packet shall be sent. |
| donatien | 0:632c9925f013 | 122 | * |
| donatien | 0:632c9925f013 | 123 | * @param netif The netif which shall send a packet |
| donatien | 0:632c9925f013 | 124 | * @param p The packet to send (raw ethernet packet) |
| donatien | 0:632c9925f013 | 125 | */ |
| donatien | 0:632c9925f013 | 126 | typedef err_t (*netif_linkoutput_fn)(struct netif *netif, struct pbuf *p); |
| donatien | 5:dd63a1e02b1b | 127 | /* Function prototype for netif status- or link-callback functions. */ |
| donatien | 0:632c9925f013 | 128 | typedef void (*netif_status_callback_fn)(struct netif *netif); |
| donatien | 5:dd63a1e02b1b | 129 | /* Function prototype for netif igmp_mac_filter functions */ |
| donatien | 0:632c9925f013 | 130 | typedef err_t (*netif_igmp_mac_filter_fn)(struct netif *netif, |
| donatien | 0:632c9925f013 | 131 | ip_addr_t *group, u8_t action); |
| donatien | 0:632c9925f013 | 132 | |
| donatien | 5:dd63a1e02b1b | 133 | /* Generic data structure used for all lwIP network interfaces. |
| donatien | 0:632c9925f013 | 134 | * The following fields should be filled in by the initialization |
| donatien | 0:632c9925f013 | 135 | * function for the device driver: hwaddr_len, hwaddr[], mtu, flags */ |
| donatien | 0:632c9925f013 | 136 | struct netif { |
| donatien | 5:dd63a1e02b1b | 137 | /* pointer to next in linked list */ |
| donatien | 0:632c9925f013 | 138 | struct netif *next; |
| donatien | 0:632c9925f013 | 139 | |
| donatien | 5:dd63a1e02b1b | 140 | /* IP address configuration in network byte order */ |
| donatien | 0:632c9925f013 | 141 | ip_addr_t ip_addr; |
| donatien | 0:632c9925f013 | 142 | ip_addr_t netmask; |
| donatien | 0:632c9925f013 | 143 | ip_addr_t gw; |
| donatien | 0:632c9925f013 | 144 | |
| donatien | 5:dd63a1e02b1b | 145 | /* This function is called by the network device driver |
| donatien | 0:632c9925f013 | 146 | * to pass a packet up the TCP/IP stack. */ |
| donatien | 0:632c9925f013 | 147 | netif_input_fn input; |
| donatien | 5:dd63a1e02b1b | 148 | /* This function is called by the IP module when it wants |
| donatien | 0:632c9925f013 | 149 | * to send a packet on the interface. This function typically |
| donatien | 0:632c9925f013 | 150 | * first resolves the hardware address, then sends the packet. */ |
| donatien | 0:632c9925f013 | 151 | netif_output_fn output; |
| donatien | 5:dd63a1e02b1b | 152 | /* This function is called by the ARP module when it wants |
| donatien | 0:632c9925f013 | 153 | * to send a packet on the interface. This function outputs |
| donatien | 0:632c9925f013 | 154 | * the pbuf as-is on the link medium. */ |
| donatien | 0:632c9925f013 | 155 | netif_linkoutput_fn linkoutput; |
| donatien | 0:632c9925f013 | 156 | #if LWIP_NETIF_STATUS_CALLBACK |
| donatien | 5:dd63a1e02b1b | 157 | /* This function is called when the netif state is set to up or down |
| donatien | 0:632c9925f013 | 158 | */ |
| donatien | 0:632c9925f013 | 159 | netif_status_callback_fn status_callback; |
| donatien | 0:632c9925f013 | 160 | #endif /* LWIP_NETIF_STATUS_CALLBACK */ |
| donatien | 0:632c9925f013 | 161 | #if LWIP_NETIF_LINK_CALLBACK |
| donatien | 5:dd63a1e02b1b | 162 | /* This function is called when the netif link is set to up or down |
| donatien | 0:632c9925f013 | 163 | */ |
| donatien | 0:632c9925f013 | 164 | netif_status_callback_fn link_callback; |
| donatien | 0:632c9925f013 | 165 | #endif /* LWIP_NETIF_LINK_CALLBACK */ |
| donatien | 5:dd63a1e02b1b | 166 | /* This field can be set by the device driver and could point |
| donatien | 0:632c9925f013 | 167 | * to state information for the device. */ |
| donatien | 0:632c9925f013 | 168 | void *state; |
| donatien | 0:632c9925f013 | 169 | #if LWIP_DHCP |
| donatien | 5:dd63a1e02b1b | 170 | /* the DHCP client state information for this netif */ |
| donatien | 0:632c9925f013 | 171 | struct dhcp *dhcp; |
| donatien | 0:632c9925f013 | 172 | #endif /* LWIP_DHCP */ |
| donatien | 0:632c9925f013 | 173 | #if LWIP_AUTOIP |
| donatien | 5:dd63a1e02b1b | 174 | /* the AutoIP client state information for this netif */ |
| donatien | 0:632c9925f013 | 175 | struct autoip *autoip; |
| donatien | 0:632c9925f013 | 176 | #endif |
| donatien | 0:632c9925f013 | 177 | #if LWIP_NETIF_HOSTNAME |
| donatien | 0:632c9925f013 | 178 | /* the hostname for this netif, NULL is a valid value */ |
| donatien | 0:632c9925f013 | 179 | char* hostname; |
| donatien | 0:632c9925f013 | 180 | #endif /* LWIP_NETIF_HOSTNAME */ |
| donatien | 5:dd63a1e02b1b | 181 | /* maximum transfer unit (in bytes) */ |
| donatien | 0:632c9925f013 | 182 | u16_t mtu; |
| donatien | 5:dd63a1e02b1b | 183 | /* number of bytes used in hwaddr */ |
| donatien | 0:632c9925f013 | 184 | u8_t hwaddr_len; |
| donatien | 5:dd63a1e02b1b | 185 | /* link level hardware address of this interface */ |
| donatien | 0:632c9925f013 | 186 | u8_t hwaddr[NETIF_MAX_HWADDR_LEN]; |
| donatien | 5:dd63a1e02b1b | 187 | /* flags (see NETIF_FLAG_ above) */ |
| donatien | 0:632c9925f013 | 188 | u8_t flags; |
| donatien | 5:dd63a1e02b1b | 189 | /* descriptive abbreviation */ |
| donatien | 0:632c9925f013 | 190 | char name[2]; |
| donatien | 5:dd63a1e02b1b | 191 | /* number of this interface */ |
| donatien | 0:632c9925f013 | 192 | u8_t num; |
| donatien | 0:632c9925f013 | 193 | #if LWIP_SNMP |
| donatien | 5:dd63a1e02b1b | 194 | /* link type (from "snmp_ifType" enum from snmp.h) */ |
| donatien | 0:632c9925f013 | 195 | u8_t link_type; |
| donatien | 5:dd63a1e02b1b | 196 | /* (estimate) link speed */ |
| donatien | 0:632c9925f013 | 197 | u32_t link_speed; |
| donatien | 5:dd63a1e02b1b | 198 | /* timestamp at last change made (up/down) */ |
| donatien | 0:632c9925f013 | 199 | u32_t ts; |
| donatien | 5:dd63a1e02b1b | 200 | /* counters */ |
| donatien | 0:632c9925f013 | 201 | u32_t ifinoctets; |
| donatien | 0:632c9925f013 | 202 | u32_t ifinucastpkts; |
| donatien | 0:632c9925f013 | 203 | u32_t ifinnucastpkts; |
| donatien | 0:632c9925f013 | 204 | u32_t ifindiscards; |
| donatien | 0:632c9925f013 | 205 | u32_t ifoutoctets; |
| donatien | 0:632c9925f013 | 206 | u32_t ifoutucastpkts; |
| donatien | 0:632c9925f013 | 207 | u32_t ifoutnucastpkts; |
| donatien | 0:632c9925f013 | 208 | u32_t ifoutdiscards; |
| donatien | 0:632c9925f013 | 209 | #endif /* LWIP_SNMP */ |
| donatien | 0:632c9925f013 | 210 | #if LWIP_IGMP |
| donatien | 5:dd63a1e02b1b | 211 | /* This function could be called to add or delete a entry in the multicast |
| donatien | 0:632c9925f013 | 212 | filter table of the ethernet MAC.*/ |
| donatien | 0:632c9925f013 | 213 | netif_igmp_mac_filter_fn igmp_mac_filter; |
| donatien | 0:632c9925f013 | 214 | #endif /* LWIP_IGMP */ |
| donatien | 0:632c9925f013 | 215 | #if LWIP_NETIF_HWADDRHINT |
| donatien | 0:632c9925f013 | 216 | u8_t *addr_hint; |
| donatien | 0:632c9925f013 | 217 | #endif /* LWIP_NETIF_HWADDRHINT */ |
| donatien | 0:632c9925f013 | 218 | #if ENABLE_LOOPBACK |
| donatien | 0:632c9925f013 | 219 | /* List of packets to be queued for ourselves. */ |
| donatien | 0:632c9925f013 | 220 | struct pbuf *loop_first; |
| donatien | 0:632c9925f013 | 221 | struct pbuf *loop_last; |
| donatien | 0:632c9925f013 | 222 | #if LWIP_LOOPBACK_MAX_PBUFS |
| donatien | 0:632c9925f013 | 223 | u16_t loop_cnt_current; |
| donatien | 0:632c9925f013 | 224 | #endif /* LWIP_LOOPBACK_MAX_PBUFS */ |
| donatien | 0:632c9925f013 | 225 | #endif /* ENABLE_LOOPBACK */ |
| donatien | 0:632c9925f013 | 226 | }; |
| donatien | 0:632c9925f013 | 227 | |
| donatien | 0:632c9925f013 | 228 | #if LWIP_SNMP |
| donatien | 0:632c9925f013 | 229 | #define NETIF_INIT_SNMP(netif, type, speed) \ |
| donatien | 0:632c9925f013 | 230 | /* use "snmp_ifType" enum from snmp.h for "type", snmp_ifType_ethernet_csmacd by example */ \ |
| donatien | 0:632c9925f013 | 231 | (netif)->link_type = (type); \ |
| donatien | 0:632c9925f013 | 232 | /* your link speed here (units: bits per second) */ \ |
| donatien | 0:632c9925f013 | 233 | (netif)->link_speed = (speed); \ |
| donatien | 0:632c9925f013 | 234 | (netif)->ts = 0; \ |
| donatien | 0:632c9925f013 | 235 | (netif)->ifinoctets = 0; \ |
| donatien | 0:632c9925f013 | 236 | (netif)->ifinucastpkts = 0; \ |
| donatien | 0:632c9925f013 | 237 | (netif)->ifinnucastpkts = 0; \ |
| donatien | 0:632c9925f013 | 238 | (netif)->ifindiscards = 0; \ |
| donatien | 0:632c9925f013 | 239 | (netif)->ifoutoctets = 0; \ |
| donatien | 0:632c9925f013 | 240 | (netif)->ifoutucastpkts = 0; \ |
| donatien | 0:632c9925f013 | 241 | (netif)->ifoutnucastpkts = 0; \ |
| donatien | 0:632c9925f013 | 242 | (netif)->ifoutdiscards = 0 |
| donatien | 0:632c9925f013 | 243 | #else /* LWIP_SNMP */ |
| donatien | 0:632c9925f013 | 244 | #define NETIF_INIT_SNMP(netif, type, speed) |
| donatien | 0:632c9925f013 | 245 | #endif /* LWIP_SNMP */ |
| donatien | 0:632c9925f013 | 246 | |
| donatien | 0:632c9925f013 | 247 | |
| donatien | 5:dd63a1e02b1b | 248 | /* The list of network interfaces. */ |
| donatien | 0:632c9925f013 | 249 | extern struct netif *netif_list; |
| donatien | 5:dd63a1e02b1b | 250 | /* The default network interface. */ |
| donatien | 0:632c9925f013 | 251 | extern struct netif *netif_default; |
| donatien | 0:632c9925f013 | 252 | |
| donatien | 0:632c9925f013 | 253 | void netif_init(void); |
| donatien | 0:632c9925f013 | 254 | |
| donatien | 0:632c9925f013 | 255 | struct netif *netif_add(struct netif *netif, ip_addr_t *ipaddr, ip_addr_t *netmask, |
| donatien | 0:632c9925f013 | 256 | ip_addr_t *gw, void *state, netif_init_fn init, netif_input_fn input); |
| donatien | 0:632c9925f013 | 257 | |
| donatien | 0:632c9925f013 | 258 | void |
| donatien | 0:632c9925f013 | 259 | netif_set_addr(struct netif *netif, ip_addr_t *ipaddr, ip_addr_t *netmask, |
| donatien | 0:632c9925f013 | 260 | ip_addr_t *gw); |
| donatien | 0:632c9925f013 | 261 | void netif_remove(struct netif * netif); |
| donatien | 0:632c9925f013 | 262 | |
| donatien | 0:632c9925f013 | 263 | /* Returns a network interface given its name. The name is of the form |
| donatien | 0:632c9925f013 | 264 | "et0", where the first two letters are the "name" field in the |
| donatien | 0:632c9925f013 | 265 | netif structure, and the digit is in the num field in the same |
| donatien | 0:632c9925f013 | 266 | structure. */ |
| donatien | 0:632c9925f013 | 267 | struct netif *netif_find(char *name); |
| donatien | 0:632c9925f013 | 268 | |
| donatien | 0:632c9925f013 | 269 | void netif_set_default(struct netif *netif); |
| donatien | 0:632c9925f013 | 270 | |
| donatien | 0:632c9925f013 | 271 | void netif_set_ipaddr(struct netif *netif, ip_addr_t *ipaddr); |
| donatien | 0:632c9925f013 | 272 | void netif_set_netmask(struct netif *netif, ip_addr_t *netmask); |
| donatien | 0:632c9925f013 | 273 | void netif_set_gw(struct netif *netif, ip_addr_t *gw); |
| donatien | 0:632c9925f013 | 274 | |
| donatien | 0:632c9925f013 | 275 | void netif_set_up(struct netif *netif); |
| donatien | 0:632c9925f013 | 276 | void netif_set_down(struct netif *netif); |
| donatien | 5:dd63a1e02b1b | 277 | /* Ask if an interface is up */ |
| donatien | 0:632c9925f013 | 278 | #define netif_is_up(netif) (((netif)->flags & NETIF_FLAG_UP) ? (u8_t)1 : (u8_t)0) |
| donatien | 0:632c9925f013 | 279 | |
| donatien | 0:632c9925f013 | 280 | #if LWIP_NETIF_STATUS_CALLBACK |
| donatien | 0:632c9925f013 | 281 | void netif_set_status_callback(struct netif *netif, netif_status_callback_fn status_callback); |
| donatien | 0:632c9925f013 | 282 | #endif /* LWIP_NETIF_STATUS_CALLBACK */ |
| donatien | 0:632c9925f013 | 283 | |
| donatien | 0:632c9925f013 | 284 | void netif_set_link_up(struct netif *netif); |
| donatien | 0:632c9925f013 | 285 | void netif_set_link_down(struct netif *netif); |
| donatien | 5:dd63a1e02b1b | 286 | /* Ask if a link is up */ |
| donatien | 0:632c9925f013 | 287 | #define netif_is_link_up(netif) (((netif)->flags & NETIF_FLAG_LINK_UP) ? (u8_t)1 : (u8_t)0) |
| donatien | 0:632c9925f013 | 288 | |
| donatien | 0:632c9925f013 | 289 | #if LWIP_NETIF_LINK_CALLBACK |
| donatien | 0:632c9925f013 | 290 | void netif_set_link_callback(struct netif *netif, netif_status_callback_fn link_callback); |
| donatien | 0:632c9925f013 | 291 | #endif /* LWIP_NETIF_LINK_CALLBACK */ |
| donatien | 0:632c9925f013 | 292 | |
| donatien | 0:632c9925f013 | 293 | #if LWIP_NETIF_HOSTNAME |
| donatien | 0:632c9925f013 | 294 | #define netif_set_hostname(netif, name) do { if((netif) != NULL) { (netif)->hostname = name; }}while(0) |
| donatien | 0:632c9925f013 | 295 | #define netif_get_hostname(netif) (((netif) != NULL) ? ((netif)->hostname) : NULL) |
| donatien | 0:632c9925f013 | 296 | #endif /* LWIP_NETIF_HOSTNAME */ |
| donatien | 0:632c9925f013 | 297 | |
| donatien | 0:632c9925f013 | 298 | #if LWIP_IGMP |
| donatien | 0:632c9925f013 | 299 | #define netif_set_igmp_mac_filter(netif, function) do { if((netif) != NULL) { (netif)->igmp_mac_filter = function; }}while(0) |
| donatien | 0:632c9925f013 | 300 | #define netif_get_igmp_mac_filter(netif) (((netif) != NULL) ? ((netif)->igmp_mac_filter) : NULL) |
| donatien | 0:632c9925f013 | 301 | #endif /* LWIP_IGMP */ |
| donatien | 0:632c9925f013 | 302 | |
| donatien | 0:632c9925f013 | 303 | #if ENABLE_LOOPBACK |
| donatien | 0:632c9925f013 | 304 | err_t netif_loop_output(struct netif *netif, struct pbuf *p, ip_addr_t *dest_ip); |
| donatien | 0:632c9925f013 | 305 | void netif_poll(struct netif *netif); |
| donatien | 0:632c9925f013 | 306 | #if !LWIP_NETIF_LOOPBACK_MULTITHREADING |
| donatien | 0:632c9925f013 | 307 | void netif_poll_all(void); |
| donatien | 0:632c9925f013 | 308 | #endif /* !LWIP_NETIF_LOOPBACK_MULTITHREADING */ |
| donatien | 0:632c9925f013 | 309 | #endif /* ENABLE_LOOPBACK */ |
| donatien | 0:632c9925f013 | 310 | |
| donatien | 0:632c9925f013 | 311 | #ifdef __cplusplus |
| donatien | 0:632c9925f013 | 312 | } |
| donatien | 0:632c9925f013 | 313 | #endif |
| donatien | 0:632c9925f013 | 314 | |
| donatien | 0:632c9925f013 | 315 | #endif /* __LWIP_NETIF_H__ */ |