ip4.h File Reference

#include "lwip/opt.h"
#include "lwip/def.h"
#include "lwip/pbuf.h"
#include "lwip/ip4_addr.h"
#include "lwip/err.h"
#include "lwip/netif.h"
#include "lwip/prot/ip4.h"

Macros
#define	IP_OPTIONS_SEND   (LWIP_IPV4 && LWIP_IGMP)

Functions
struct netif *	ip4_route (const ip4_addr_t *dest)
struct netif *	ip4_route_src (const ip4_addr_t *src, const ip4_addr_t *dest)
err_t	ip4_input (struct pbuf *p, struct netif *inp)
err_t	ip4_output (struct pbuf *p, const ip4_addr_t *src, const ip4_addr_t *dest, u8_t ttl, u8_t tos, u8_t proto)
err_t	ip4_output_if (struct pbuf *p, const ip4_addr_t *src, const ip4_addr_t *dest, u8_t ttl, u8_t tos, u8_t proto, struct netif *netif)
err_t	ip4_output_if_src (struct pbuf *p, const ip4_addr_t *src, const ip4_addr_t *dest, u8_t ttl, u8_t tos, u8_t proto, struct netif *netif)
err_t	ip4_output_if_opt (struct pbuf *p, const ip4_addr_t *src, const ip4_addr_t *dest, u8_t ttl, u8_t tos, u8_t proto, struct netif *netif, void *ip_options, u16_t optlen)
err_t	ip4_output_if_opt_src (struct pbuf *p, const ip4_addr_t *src, const ip4_addr_t *dest, u8_t ttl, u8_t tos, u8_t proto, struct netif *netif, void *ip_options, u16_t optlen)
void	ip4_set_default_multicast_netif (struct netif *default_multicast_netif)

Detailed Description

IPv4 API

Macro Definition Documentation

IP_OPTIONS_SEND

#define IP_OPTIONS_SEND   (LWIP_IPV4 && LWIP_IGMP)

Currently, the function ip_output_if_opt() is only used with IGMP

Function Documentation

ip4_input()

err_t ip4_input	(	struct pbuf *	p,
		struct netif *	inp
	)

This function is called by the network interface device driver when an IP packet is received. The function does the basic checks of the IP header such as packet size being at least larger than the header size etc. If the packet was not destined for us, the packet is forwarded (using ip_forward). The IP checksum is always checked.

Finally, the packet is sent to the upper layer protocol input function.

Parameters

p	the received IP packet (p->payload points to IP header)
inp	the netif on which this packet was received

Returns

ERR_OK if the packet was processed (could return ERR_* if it wasn't processed, but currently always returns ERR_OK)

ip4_output()

err_t ip4_output	(	struct pbuf *	p,
		const ip4_addr_t *	src,
		const ip4_addr_t *	dest,
		u8_t	ttl,
		u8_t	tos,
		u8_t	proto
	)

Simple interface to ip_output_if. It finds the outgoing network interface and calls upon ip_output_if to do the actual work.

Parameters

p	the packet to send (p->payload points to the data, e.g. next protocol header; if dest == LWIP_IP_HDRINCL, p already includes an IP header and p->payload points to that IP header)
src	the source IP address to send from (if src == IP4_ADDR_ANY, the IP address of the netif used to send is used as source address)
dest	the destination IP address to send the packet to
ttl	the TTL value to be set in the IP header
tos	the TOS value to be set in the IP header
proto	the PROTOCOL to be set in the IP header

Returns

ERR_RTE if no route is found see ip_output_if() for more return values

ip4_output_if()

err_t ip4_output_if	(	struct pbuf *	p,
		const ip4_addr_t *	src,
		const ip4_addr_t *	dest,
		u8_t	ttl,
		u8_t	tos,
		u8_t	proto,
		struct netif *	netif
	)

Sends an IP packet on a network interface. This function constructs the IP header and calculates the IP header checksum. If the source IP address is NULL, the IP address of the outgoing network interface is filled in as source address. If the destination IP address is LWIP_IP_HDRINCL, p is assumed to already include an IP header and p->payload points to it instead of the data.

Parameters

p	the packet to send (p->payload points to the data, e.g. next protocol header; if dest == LWIP_IP_HDRINCL, p already includes an IP header and p->payload points to that IP header)
src	the source IP address to send from (if src == IP4_ADDR_ANY, the IP address of the netif used to send is used as source address)
dest	the destination IP address to send the packet to
ttl	the TTL value to be set in the IP header
tos	the TOS value to be set in the IP header
proto	the PROTOCOL to be set in the IP header
netif	the netif on which to send this packet

Returns

ERR_OK if the packet was sent OK ERR_BUF if p doesn't have enough space for IP/LINK headers returns errors returned by netif->output

Note

ip_id: RFC791 "some host may be able to simply use unique identifiers independent of destination"

ip4_output_if_opt()

err_t ip4_output_if_opt	(	struct pbuf *	p,
		const ip4_addr_t *	src,
		const ip4_addr_t *	dest,
		u8_t	ttl,
		u8_t	tos,
		u8_t	proto,
		struct netif *	netif,
		void *	ip_options,
		u16_t	optlen
	)

Same as ip_output_if() but with the possibility to include IP options:

@ param ip_options pointer to the IP options, copied into the IP header @ param optlen length of ip_options

ip4_output_if_opt_src()

err_t ip4_output_if_opt_src	(	struct pbuf *	p,
		const ip4_addr_t *	src,
		const ip4_addr_t *	dest,
		u8_t	ttl,
		u8_t	tos,
		u8_t	proto,
		struct netif *	netif,
		void *	ip_options,
		u16_t	optlen
	)

Same as ip_output_if_opt() but 'src' address is not replaced by netif address when it is 'any'.

ip4_output_if_src()

err_t ip4_output_if_src	(	struct pbuf *	p,
		const ip4_addr_t *	src,
		const ip4_addr_t *	dest,
		u8_t	ttl,
		u8_t	tos,
		u8_t	proto,
		struct netif *	netif
	)

Same as ip_output_if() but 'src' address is not replaced by netif address when it is 'any'.

ip4_route()

struct netif* ip4_route

(

const ip4_addr_t *

dest

)

Finds the appropriate network interface for a given IP address. It searches the list of network interfaces linearly. A match is found if the masked IP address of the network interface equals the masked IP address given to the function.

Parameters

dest	the destination IP address for which to find the route

Returns

the netif on which to send to reach dest

ip4_route_src()

struct netif* ip4_route_src	(	const ip4_addr_t *	src,
		const ip4_addr_t *	dest
	)

Source based IPv4 routing must be fully implemented in LWIP_HOOK_IP4_ROUTE_SRC(). This function only provides the parameters.