#include "lwip/opt.h"
#include "lwip/err.h"
#include "lwip/timeouts.h"
#include "lwip/netif.h"

Include dependency graph for tcpip.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	LOCK_TCPIP_CORE()

#define	UNLOCK_TCPIP_CORE()

#define	tcpip_callback(f, ctx) tcpip_callback_with_block(f, ctx, 1)

Typedefs
typedef void(*	tcpip_init_done_fn) (void *arg)

typedef void(*	tcpip_callback_fn) (void *ctx)

Functions
void	tcpip_init (tcpip_init_done_fn tcpip_init_done, void *arg)

err_t	tcpip_inpkt (struct pbuf p, struct netif inp, netif_input_fn input_fn)

err_t	tcpip_input (struct pbuf p, struct netif inp)

err_t	tcpip_callback_with_block (tcpip_callback_fn function, void *ctx, u8_t block)

struct tcpip_callback_msg *	tcpip_callbackmsg_new (tcpip_callback_fn function, void *ctx)

void	tcpip_callbackmsg_delete (struct tcpip_callback_msg *msg)

err_t	tcpip_trycallback (struct tcpip_callback_msg *msg)

err_t	pbuf_free_callback (struct pbuf *p)

err_t	mem_free_callback (void *m)

Detailed Description

Functions to sync with TCPIP thread

Definition in file tcpip.h.

Macro Definition Documentation

#define tcpip_callback	(	f,
		ctx
	)	tcpip_callback_with_block(f, ctx, 1)

See also: tcpip_callback_with_block

Definition at line 104 of file tcpip.h.

Typedef Documentation

typedef void(* tcpip_callback_fn) (void *ctx)

Function prototype for functions passed to tcpip_callback()

Definition at line 89 of file tcpip.h.

typedef void(* tcpip_init_done_fn) (void *arg)

Function prototype for the init_done function passed to tcpip_init

Definition at line 87 of file tcpip.h.

Function Documentation

err_t mem_free_callback ( void * m )

A simple wrapper function that allows you to free heap memory from interrupt context.

Parameters

m	the heap memory to free

Returns: ERR_OK if callback could be enqueued, an err_t if not

Definition at line 532 of file tcpip.c.

References mem_free(), and tcpip_callback_with_block().

err_t pbuf_free_callback ( struct pbuf * p )

A simple wrapper function that allows you to free a pbuf from interrupt context.

Parameters

p	The pbuf (chain) to be dereferenced.

Returns: ERR_OK if callback could be enqueued, an err_t if not

Definition at line 519 of file tcpip.c.

References tcpip_callback_with_block().

err_t tcpip_callback_with_block	(	tcpip_callback_fn	function,
		void *	ctx,
		u8_t	block
	)

Call a specific function in the thread context of tcpip_thread for easy access synchronization. A function called in that way may access lwIP core code without fearing concurrent access.

Parameters

function	the function to call
ctx	parameter passed to f
block	1 to block until the request is posted, 0 to non-blocking mode

Returns: ERR_OK if the function was called, another err_t if not

Definition at line 253 of file tcpip.c.

References ERR_MEM, ERR_OK, memp_free(), memp_malloc(), sys_mbox_post(), sys_mbox_trypost(), and sys_mbox_valid_val.

Referenced by mem_free_callback(), netif_set_link_down(), and pbuf_free_callback().

Here is the caller graph for this function:

void tcpip_callbackmsg_delete ( struct tcpip_callback_msg * msg )

Free a callback message allocated by tcpip_callbackmsg_new().

Parameters

msg	the message to free

Definition at line 452 of file tcpip.c.

References memp_free().

struct tcpip_callback_msg* tcpip_callbackmsg_new	(	tcpip_callback_fn	function,
		void *	ctx
	)

Allocate a structure for a static callback message and initialize it. This is intended to be used to send "static" messages from interrupt context.

Parameters

function	the function to call
ctx	parameter passed to function

Returns: a struct pointer to pass to tcpip_trycallback().

Definition at line 434 of file tcpip.c.

References memp_malloc().

void tcpip_init	(	tcpip_init_done_fn	initfunc,
		void *	arg
	)

Initialize this module:

initialize all sub modules
start the tcpip_thread

Parameters

initfunc	a function to call when tcpip_thread is running and finished initializing
arg	argument to pass to initfunc

Definition at line 481 of file tcpip.c.

References ERR_OK, lwip_init(), pbuf_free(), sys_mbox_new(), sys_mutex_new(), sys_thread_new(), TCPIP_MBOX_SIZE, TCPIP_THREAD_NAME, TCPIP_THREAD_PRIO, and TCPIP_THREAD_STACKSIZE.

err_t tcpip_inpkt	(	struct pbuf *	p,
		struct netif *	inp,
		netif_input_fn	input_fn
	)

Pass a received packet to tcpip_thread for input processing

Parameters

p	the received packet
inp	the network interface on which the packet was received
input_fn	input function to call

Definition at line 188 of file tcpip.c.

References ERR_MEM, ERR_OK, LWIP_DEBUGF, memp_free(), memp_malloc(), sys_mbox_trypost(), sys_mbox_valid_val, and TCPIP_DEBUG.

Referenced by tcpip_input().

Here is the caller graph for this function:

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

Pass a received packet to tcpip_thread for input processing with ethernet_input or ip_input. Don't call directly, pass to netif_add() and call netif->input().

Parameters

p	the received packet, p->payload pointing to the Ethernet header or to an IP header (if inp doesn't have NETIF_FLAG_ETHARP or NETIF_FLAG_ETHERNET flags)
inp	the network interface on which the packet was received

Definition at line 231 of file tcpip.c.

References netif::flags, NETIF_FLAG_ETHARP, NETIF_FLAG_ETHERNET, and tcpip_inpkt().

Referenced by NetworkStack::registerDevice().

Here is the caller graph for this function: