This library is deprecated.
Dependents: HTTPClientStreamingExample HTTPClientExample HTTPServerExample HTTPServerHelloWorld ... more
Diff: LPC1768/lwip/include/lwip/netif.h
- Revision:
- 5:bc7df6da7589
- Parent:
- 0:422060928e37
--- a/LPC1768/lwip/include/lwip/netif.h Fri Jul 09 14:34:26 2010 +0000 +++ b/LPC1768/lwip/include/lwip/netif.h Thu Aug 05 15:09:22 2010 +0000 @@ -56,58 +56,58 @@ /* 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 +/* 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 +/* 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. +/* 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. +/* 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. +/* 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 +/* 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. +/* 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 +/* 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. +/* 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 +/* 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' +/* 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 +/* 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'. * @@ -117,87 +117,87 @@ */ 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 +/* 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. */ +/* 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 */ +/* 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); -/** Generic data structure used for all lwIP network interfaces. +/* 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 */ + /* pointer to next in linked list */ struct netif *next; - /** IP address configuration in network byte order */ + /* 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 + /* This function is called by the network device driver * to pass a packet up the TCP/IP stack. */ netif_input_fn input; - /** This function is called by the IP module when it wants + /* 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. */ netif_output_fn output; - /** This function is called by the ARP module when it wants + /* 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 + /* 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 + /* 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 + /* 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 */ + /* the DHCP client state information for this netif */ struct dhcp *dhcp; #endif /* LWIP_DHCP */ #if LWIP_AUTOIP - /** the AutoIP client state information for this netif */ + /* 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) */ + /* maximum transfer unit (in bytes) */ u16_t mtu; - /** number of bytes used in hwaddr */ + /* number of bytes used in hwaddr */ u8_t hwaddr_len; - /** link level hardware address of this interface */ + /* link level hardware address of this interface */ u8_t hwaddr[NETIF_MAX_HWADDR_LEN]; - /** flags (see NETIF_FLAG_ above) */ + /* flags (see NETIF_FLAG_ above) */ u8_t flags; - /** descriptive abbreviation */ + /* descriptive abbreviation */ char name[2]; - /** number of this interface */ + /* number of this interface */ u8_t num; #if LWIP_SNMP - /** link type (from "snmp_ifType" enum from snmp.h) */ + /* link type (from "snmp_ifType" enum from snmp.h) */ u8_t link_type; - /** (estimate) link speed */ + /* (estimate) link speed */ u32_t link_speed; - /** timestamp at last change made (up/down) */ + /* timestamp at last change made (up/down) */ u32_t ts; - /** counters */ + /* counters */ u32_t ifinoctets; u32_t ifinucastpkts; u32_t ifinnucastpkts; @@ -208,7 +208,7 @@ u32_t ifoutdiscards; #endif /* LWIP_SNMP */ #if LWIP_IGMP - /** This function could be called to add or delete a entry in the multicast + /* 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 */ @@ -245,9 +245,9 @@ #endif /* LWIP_SNMP */ -/** The list of network interfaces. */ +/* The list of network interfaces. */ extern struct netif *netif_list; -/** The default network interface. */ +/* The default network interface. */ extern struct netif *netif_default; void netif_init(void); @@ -274,7 +274,7 @@ void netif_set_up(struct netif *netif); void netif_set_down(struct netif *netif); -/** Ask if an interface is up */ +/* 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 @@ -283,7 +283,7 @@ void netif_set_link_up(struct netif *netif); void netif_set_link_down(struct netif *netif); -/** Ask if a link is up */ +/* 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