Atmel Software Framework

lwip-1.3.2/src/api/tcpip.c File Reference

Sequential API Main thread module.

#include "lwip/opt.h"
#include "lwip/sys.h"
#include "lwip/memp.h"
#include "lwip/pbuf.h"
#include "lwip/ip_frag.h"
#include "lwip/tcp.h"
#include "lwip/autoip.h"
#include "lwip/dhcp.h"
#include "lwip/igmp.h"
#include "lwip/dns.h"
#include "lwip/tcpip.h"
#include "lwip/init.h"
#include "netif/etharp.h"
#include "netif/ppp_oe.h"

Functions

err_t mem_free_callback (void *m)
 A simple wrapper function that allows you to free heap memory from interrupt context. More...
 
err_t pbuf_free_callback (struct pbuf *p)
 A simple wrapper function that allows you to free a pbuf from interrupt context. More...
 
static void pbuf_free_int (void *p)
 Simple callback function used with tcpip_callback to free a pbuf (pbuf_free has a wrong signature for tcpip_callback) More...
 
err_t tcpip_callback_with_block (void(*f)(void *ctx), void *ctx, u8_t block)
 Call a specific function in the thread context of tcpip_thread for easy access synchronization. More...
 
void tcpip_init (void(*initfunc)(void *), void *arg)
 Initialize this module: More...
 
err_t tcpip_input (struct pbuf *p, struct netif *inp)
 Pass a received packet to tcpip_thread for input processing. More...
 
static void tcpip_thread (void *arg)
 The main lwIP thread. More...
 
err_t tcpip_timeout (u32_t msecs, sys_timeout_handler h, void *arg)
 call sys_timeout in tcpip_thread More...
 
err_t tcpip_untimeout (sys_timeout_handler h, void *arg)
 call sys_untimeout in tcpip_thread More...
 

Variables

static sys_mbox_t mbox = SYS_MBOX_NULL
 
static void(* tcpip_init_done )(void *arg)
 
static void * tcpip_init_done_arg
 

err_t mem_free_callback ( void *  m)

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

Parameters
mthe heap memory to free
Returns
ERR_OK if callback could be enqueued, an err_t if not

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
pThe pbuf (chain) to be dereferenced.
Returns
ERR_OK if callback could be enqueued, an err_t if not

References pbuf_free_int(), and tcpip_callback_with_block().

static void pbuf_free_int ( void *  p)
static

Simple callback function used with tcpip_callback to free a pbuf (pbuf_free has a wrong signature for tcpip_callback)

Parameters
pThe pbuf (chain) to be dereferenced.

References pbuf_free().

Referenced by pbuf_free_callback().

err_t tcpip_callback_with_block ( void(*)(void *ctx f,
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
fthe function to call
ctxparameter passed to f
block1 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

References tcpip_msg::cb, ctx, ERR_MEM, ERR_OK, ERR_VAL, tcpip_msg::f, memp_free(), memp_malloc(), tcpip_msg::msg, msg, NULL, SYS_MBOX_NULL, sys_mbox_post(), sys_mbox_trypost(), TCPIP_MSG_CALLBACK, and tcpip_msg::type.

void tcpip_init ( void(*)(void *)  initfunc,
void *  arg 
)

Initialize this module:

  • initialize all sub modules
  • start the tcpip_thread
Parameters
initfunca function to call when tcpip_thread is running and finished initializing
argargument to pass to initfunc

References arg, lwip_init(), NULL, sys_mbox_new(), sys_sem_new(), sys_thread_new(), tcpip_init_done, tcpip_init_done_arg, TCPIP_MBOX_SIZE, tcpip_thread(), TCPIP_THREAD_NAME, TCPIP_THREAD_PRIO, and TCPIP_THREAD_STACKSIZE.

err_t tcpip_input ( struct pbuf p,
struct netif inp 
)

Pass a received packet to tcpip_thread for input processing.

Parameters
pthe received packet, p->payload pointing to the Ethernet header or to an IP header (if netif doesn't got NETIF_FLAG_ETHARP flag)
inpthe network interface on which the packet was received

References ERR_MEM, ERR_OK, ERR_VAL, tcpip_msg::inp, memp_free(), memp_malloc(), tcpip_msg::msg, msg, NULL, tcpip_msg::p, SYS_MBOX_NULL, sys_mbox_trypost(), TCPIP_MSG_INPKT, and tcpip_msg::type.

static void tcpip_thread ( void *  arg)
static

The main lwIP thread.

This thread has exclusive access to lwIP core functions (unless access to them is not locked). Other threads communicate with this thread using message boxes.

It also starts all the timers to make sure they are running in the right thread context.

Parameters
argunused argument

References tcpip_msg::cb, tcpip_msg::function, tcpip_msg::inp, LOCK_TCPIP_CORE, LWIP_DEBUGF, LWIP_UNUSED_ARG, memp_free(), tcpip_msg::msg, msg, NETIF_FLAG_ETHARP, NULL, sys_mbox_fetch, sys_timeout(), sys_untimeout(), TCPIP_DEBUG, tcpip_init_done, tcpip_init_done_arg, TCPIP_MSG_CALLBACK, TCPIP_MSG_INPKT, TCPIP_MSG_TIMEOUT, TCPIP_MSG_UNTIMEOUT, tcpip_msg::tmo, and tcpip_msg::type.

Referenced by tcpip_init().

err_t tcpip_timeout ( u32_t  msecs,
sys_timeout_handler  h,
void *  arg 
)

call sys_timeout in tcpip_thread

Parameters
msectime in miliseconds for timeout
hfunction to be called on timeout
argargument to pass to timeout function h
Returns
ERR_MEM on memory error, ERR_OK otherwise

References arg, ERR_MEM, ERR_OK, ERR_VAL, tcpip_msg::h, memp_malloc(), tcpip_msg::msecs, tcpip_msg::msg, msg, NULL, SYS_MBOX_NULL, sys_mbox_post(), TCPIP_MSG_TIMEOUT, tcpip_msg::tmo, and tcpip_msg::type.

err_t tcpip_untimeout ( sys_timeout_handler  h,
void *  arg 
)

call sys_untimeout in tcpip_thread

Parameters
msectime in miliseconds for timeout
hfunction to be called on timeout
argargument to pass to timeout function h
Returns
ERR_MEM on memory error, ERR_OK otherwise

References arg, ERR_MEM, ERR_OK, ERR_VAL, tcpip_msg::h, memp_malloc(), tcpip_msg::msg, msg, NULL, SYS_MBOX_NULL, sys_mbox_post(), TCPIP_MSG_UNTIMEOUT, tcpip_msg::tmo, and tcpip_msg::type.

sys_mbox_t mbox = SYS_MBOX_NULL
static
void(* tcpip_init_done)(void *arg)
static

Referenced by tcpip_init(), and tcpip_thread().

void* tcpip_init_done_arg
static

Referenced by tcpip_init(), and tcpip_thread().