123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320 |
- /*
- * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without modification,
- * are permitted provided that the following conditions are met:
- *
- * 1. Redistributions of source code must retain the above copyright notice,
- * this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright notice,
- * this list of conditions and the following disclaimer in the documentation
- * and/or other materials provided with the distribution.
- * 3. The name of the author may not be used to endorse or promote products
- * derived from this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
- * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
- * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
- * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
- * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
- * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
- * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
- * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
- * OF SUCH DAMAGE.
- *
- * This file is part of the lwIP TCP/IP stack.
- *
- * Author: Adam Dunkels <adam@sics.se>
- *
- */
- #ifndef __LWIP_NETIF_H__
- #define __LWIP_NETIF_H__
- #include "lwip/opt.h"
- #define ENABLE_LOOPBACK (LWIP_NETIF_LOOPBACK || LWIP_HAVE_LOOPIF)
- #include "lwip/err.h"
- #include "lwip/ip_addr.h"
- #include "lwip/def.h"
- #include "lwip/pbuf.h"
- #if LWIP_DHCP
- struct dhcp;
- #endif
- #if LWIP_AUTOIP
- struct autoip;
- #endif
- #ifdef __cplusplus
- extern "C" {
- #endif
- /* Throughout this file, IP addresses are expected to be in
- * the same byte order as in IP_PCB. */
- /** must be the maximum of all used hardware address lengths
- across all types of interfaces in use */
- #define NETIF_MAX_HWADDR_LEN 6U
- /** Whether the network interface is 'up'. This is
- * a software flag used to control whether this network
- * interface is enabled and processes traffic.
- * It is set by the startup code (for static IP configuration) or
- * by dhcp/autoip when an address has been assigned.
- */
- #define NETIF_FLAG_UP 0x01U
- /** If set, the netif has broadcast capability.
- * Set by the netif driver in its init function. */
- #define NETIF_FLAG_BROADCAST 0x02U
- /** If set, the netif is one end of a point-to-point connection.
- * Set by the netif driver in its init function. */
- #define NETIF_FLAG_POINTTOPOINT 0x04U
- /** If set, the interface is configured using DHCP.
- * Set by the DHCP code when starting or stopping DHCP. */
- #define NETIF_FLAG_DHCP 0x08U
- /** If set, the interface has an active link
- * (set by the network interface driver).
- * Either set by the netif driver in its init function (if the link
- * is up at that time) or at a later point once the link comes up
- * (if link detection is supported by the hardware). */
- #define NETIF_FLAG_LINK_UP 0x10U
- /** If set, the netif is an ethernet device using ARP.
- * Set by the netif driver in its init function.
- * Used to check input packet types and use of DHCP. */
- #define NETIF_FLAG_ETHARP 0x20U
- /** If set, the netif is an ethernet device. It might not use
- * ARP or TCP/IP if it is used for PPPoE only.
- */
- #define NETIF_FLAG_ETHERNET 0x40U
- /** If set, the netif has IGMP capability.
- * Set by the netif driver in its init function. */
- #define NETIF_FLAG_IGMP 0x80U
- /** Function prototype for netif init functions. Set up flags and output/linkoutput
- * callback functions in this function.
- *
- * @param netif The netif to initialize
- */
- typedef err_t (*netif_init_fn)(struct netif *netif);
- /** Function prototype for netif->input functions. This function is saved as 'input'
- * callback function in the netif struct. Call it when a packet has been received.
- *
- * @param p The received packet, copied into a pbuf
- * @param inp The netif which received the packet
- */
- typedef err_t (*netif_input_fn)(struct pbuf *p, struct netif *inp);
- /** Function prototype for netif->output functions. Called by lwIP when a packet
- * shall be sent. For ethernet netif, set this to 'etharp_output' and set
- * 'linkoutput'.
- *
- * @param netif The netif which shall send a packet
- * @param p The packet to send (p->payload points to IP header)
- * @param ipaddr The IP address to which the packet shall be sent
- */
- typedef err_t (*netif_output_fn)(struct netif *netif, struct pbuf *p,
- ip_addr_t *ipaddr);
- /** Function prototype for netif->linkoutput functions. Only used for ethernet
- * netifs. This function is called by ARP when a packet shall be sent.
- *
- * @param netif The netif which shall send a packet
- * @param p The packet to send (raw ethernet packet)
- */
- typedef err_t (*netif_linkoutput_fn)(struct netif *netif, struct pbuf *p);
- /** Function prototype for netif status- or link-callback functions. */
- typedef void (*netif_status_callback_fn)(struct netif *netif);
- /** Function prototype for netif igmp_mac_filter functions */
- typedef err_t (*netif_igmp_mac_filter_fn)(struct netif *netif,
- ip_addr_t *group, u8_t action);
- /*add DHCP event processing by LiuHan*/
- typedef void (*dhcp_event_fn)(void);
- /** Generic data structure used for all lwIP network interfaces.
- * The following fields should be filled in by the initialization
- * function for the device driver: hwaddr_len, hwaddr[], mtu, flags */
- struct netif {
- /** pointer to next in linked list */
- struct netif *next;
- /** IP address configuration in network byte order */
- ip_addr_t ip_addr;
- ip_addr_t netmask;
- ip_addr_t gw;
- /** This function is called by the network device driver
- * to pass a packet up the TCP/IP stack. 向IP层输入数据包*/
- netif_input_fn input;
- /** This function is called by the IP module when it wants
- * to send a packet on the interface. This function typically
- * first resolves the hardware address, then sends the packet. 发送IP数据包*/
- netif_output_fn output;
- /** This function is called by the ARP module when it wants
- * to send a packet on the interface. This function outputs
- * the pbuf as-is on the link medium. 底层数据包发送*/
- netif_linkoutput_fn linkoutput;
- #if LWIP_NETIF_STATUS_CALLBACK
- /** This function is called when the netif state is set to up or down
- */
- netif_status_callback_fn status_callback;
- #endif /* LWIP_NETIF_STATUS_CALLBACK */
- #if LWIP_NETIF_LINK_CALLBACK
- /** This function is called when the netif link is set to up or down
- */
- netif_status_callback_fn link_callback;
- #endif /* LWIP_NETIF_LINK_CALLBACK */
- /** This field can be set by the device driver and could point
- * to state information for the device. 自由设置字段,比如指向底层设备相关信息*/
- void *state;
- #if LWIP_DHCP
- /** the DHCP client state information for this netif */
- struct dhcp *dhcp;
- struct udp_pcb *dhcps_pcb; //dhcps
- dhcp_event_fn dhcp_event;
- #endif /* LWIP_DHCP */
- #if LWIP_AUTOIP
- /** the AutoIP client state information for this netif */
- struct autoip *autoip;
- #endif
- #if LWIP_NETIF_HOSTNAME
- /* the hostname for this netif, NULL is a valid value */
- char* hostname;
- #endif /* LWIP_NETIF_HOSTNAME */
- /** maximum transfer unit (in bytes) 该接口允许的最大数据包长度,多是1500*/
- u16_t mtu;
- /** number of bytes used in hwaddr该接口物理地址长度 */
- u8_t hwaddr_len;
- /** link level hardware address of this interface 该接口物理地址*/
- u8_t hwaddr[NETIF_MAX_HWADDR_LEN];
- /** flags (see NETIF_FLAG_ above) 该接口状态、属性字段*/
- u8_t flags;
- /** descriptive abbreviation 该接口的名字*/
- char name[2];
- /** number of this interface 该接口的编号*/
- u8_t num;
- #if LWIP_SNMP
- /** link type (from "snmp_ifType" enum from snmp.h) */
- u8_t link_type;
- /** (estimate) link speed */
- u32_t link_speed;
- /** timestamp at last change made (up/down) */
- u32_t ts;
- /** counters */
- u32_t ifinoctets;
- u32_t ifinucastpkts;
- u32_t ifinnucastpkts;
- u32_t ifindiscards;
- u32_t ifoutoctets;
- u32_t ifoutucastpkts;
- u32_t ifoutnucastpkts;
- u32_t ifoutdiscards;
- #endif /* LWIP_SNMP */
- #if LWIP_IGMP
- /** This function could be called to add or delete a entry in the multicast
- filter table of the ethernet MAC.*/
- netif_igmp_mac_filter_fn igmp_mac_filter;
- #endif /* LWIP_IGMP */
- #if LWIP_NETIF_HWADDRHINT
- u8_t *addr_hint;
- #endif /* LWIP_NETIF_HWADDRHINT */
- #if ENABLE_LOOPBACK
- /* List of packets to be queued for ourselves. 指向发送给自己的数据包的pbuf*/
- struct pbuf *loop_first;//第一个
- struct pbuf *loop_last;//最后一个
- #if LWIP_LOOPBACK_MAX_PBUFS
- u16_t loop_cnt_current;
- #endif /* LWIP_LOOPBACK_MAX_PBUFS */
- #endif /* ENABLE_LOOPBACK */
- };
- #if LWIP_SNMP
- #define NETIF_INIT_SNMP(netif, type, speed) \
- /* use "snmp_ifType" enum from snmp.h for "type", snmp_ifType_ethernet_csmacd by example */ \
- (netif)->link_type = (type); \
- /* your link speed here (units: bits per second) */ \
- (netif)->link_speed = (speed); \
- (netif)->ts = 0; \
- (netif)->ifinoctets = 0; \
- (netif)->ifinucastpkts = 0; \
- (netif)->ifinnucastpkts = 0; \
- (netif)->ifindiscards = 0; \
- (netif)->ifoutoctets = 0; \
- (netif)->ifoutucastpkts = 0; \
- (netif)->ifoutnucastpkts = 0; \
- (netif)->ifoutdiscards = 0
- #else /* LWIP_SNMP */
- #define NETIF_INIT_SNMP(netif, type, speed)
- #endif /* LWIP_SNMP */
- /** The list of network interfaces. */
- extern struct netif *netif_list;
- /** The default network interface. */
- extern struct netif *netif_default;
- void netif_init(void)ICACHE_FLASH_ATTR;
- struct netif *netif_add(struct netif *netif, ip_addr_t *ipaddr, ip_addr_t *netmask,
- ip_addr_t *gw, void *state, netif_init_fn init, netif_input_fn input)ICACHE_FLASH_ATTR;
- void
- netif_set_addr(struct netif *netif, ip_addr_t *ipaddr, ip_addr_t *netmask,
- ip_addr_t *gw)ICACHE_FLASH_ATTR;
- void netif_remove(struct netif * netif)ICACHE_FLASH_ATTR;
- /* Returns a network interface given its name. The name is of the form
- "et0", where the first two letters are the "name" field in the
- netif structure, and the digit is in the num field in the same
- structure. */
- struct netif *netif_find(char *name)ICACHE_FLASH_ATTR;
- void netif_set_default(struct netif *netif)ICACHE_FLASH_ATTR;
- void netif_set_ipaddr(struct netif *netif, ip_addr_t *ipaddr)ICACHE_FLASH_ATTR;
- void netif_set_netmask(struct netif *netif, ip_addr_t *netmask)ICACHE_FLASH_ATTR;
- void netif_set_gw(struct netif *netif, ip_addr_t *gw)ICACHE_FLASH_ATTR;
- void netif_set_up(struct netif *netif)ICACHE_FLASH_ATTR;
- void netif_set_down(struct netif *netif)ICACHE_FLASH_ATTR;
- /** Ask if an interface is up */
- #define netif_is_up(netif) (((netif)->flags & NETIF_FLAG_UP) ? (u8_t)1 : (u8_t)0)
- #if LWIP_NETIF_STATUS_CALLBACK
- void netif_set_status_callback(struct netif *netif, netif_status_callback_fn status_callback)ICACHE_FLASH_ATTR;
- #endif /* LWIP_NETIF_STATUS_CALLBACK */
- void netif_set_link_up(struct netif *netif)ICACHE_FLASH_ATTR;
- void netif_set_link_down(struct netif *netif)ICACHE_FLASH_ATTR;
- /** Ask if a link is up */
- #define netif_is_link_up(netif) (((netif)->flags & NETIF_FLAG_LINK_UP) ? (u8_t)1 : (u8_t)0)
- #if LWIP_NETIF_LINK_CALLBACK
- void netif_set_link_callback(struct netif *netif, netif_status_callback_fn link_callback)ICACHE_FLASH_ATTR;
- #endif /* LWIP_NETIF_LINK_CALLBACK */
- #if LWIP_NETIF_HOSTNAME
- #define netif_set_hostname(netif, name) do { if((netif) != NULL) { (netif)->hostname = name; }}while(0)
- #define netif_get_hostname(netif) (((netif) != NULL) ? ((netif)->hostname) : NULL)
- #endif /* LWIP_NETIF_HOSTNAME */
- #if LWIP_IGMP
- #define netif_set_igmp_mac_filter(netif, function) do { if((netif) != NULL) { (netif)->igmp_mac_filter = function; }}while(0)
- #define netif_get_igmp_mac_filter(netif) (((netif) != NULL) ? ((netif)->igmp_mac_filter) : NULL)
- #endif /* LWIP_IGMP */
- #if ENABLE_LOOPBACK
- err_t netif_loop_output(struct netif *netif, struct pbuf *p, ip_addr_t *dest_ip)ICACHE_FLASH_ATTR;
- void netif_poll(struct netif *netif)ICACHE_FLASH_ATTR;
- #if !LWIP_NETIF_LOOPBACK_MULTITHREADING
- void netif_poll_all(void)ICACHE_FLASH_ATTR;
- #endif /* !LWIP_NETIF_LOOPBACK_MULTITHREADING */
- #endif /* ENABLE_LOOPBACK */
- #ifdef __cplusplus
- }
- #endif
- #endif /* __LWIP_NETIF_H__ */
|