This library is deprecated.

Dependents:   HTTPClientStreamingExample HTTPClientExample HTTPServerExample HTTPServerHelloWorld ... more

Committer:
donatien
Date:
Thu Aug 05 15:09:22 2010 +0000
Revision:
5:bc7df6da7589
Parent:
0:422060928e37

        

Who changed what in which revision?

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