tcpip.h File Reference

#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:

Go to the source code of this file.

Macros
#define	LOCK_TCPIP_CORE()
#define	UNLOCK_TCPIP_CORE()
#define	tcpip_callback_with_block(function, ctx, block)   ((block != 0)? tcpip_callback(function, ctx) : tcpip_try_callback(function, ctx))

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_try_callback (tcpip_callback_fn function, void *ctx)
err_t	tcpip_callback (tcpip_callback_fn function, void *ctx)
err_t	tcpip_callback_wait (tcpip_callback_fn function, void *ctx)
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_callbackmsg_trycallback (struct tcpip_callback_msg *msg)
err_t	tcpip_callbackmsg_trycallback_fromisr (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

LOCK_TCPIP_CORE

#define LOCK_TCPIP_CORE

(

)

Definition at line 62 of file tcpip.h.

UNLOCK_TCPIP_CORE

#define UNLOCK_TCPIP_CORE

(

)

Definition at line 63 of file tcpip.h.

Typedef Documentation

tcpip_callback_fn

typedef void(* tcpip_callback_fn) (void *ctx)

Function prototype for functions passed to tcpip_callback()

Definition at line 72 of file tcpip.h.

tcpip_init_done_fn

typedef void(* tcpip_init_done_fn) (void *arg)

Function prototype for the init_done function passed to tcpip_init

Definition at line 70 of file tcpip.h.

Function Documentation

mem_free_callback()

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 701 of file tcpip.c.

{
  return tcpip_try_callback(mem_free, m);
}

pbuf_free_callback()

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 688 of file tcpip.c.

{
  return tcpip_try_callback(pbuf_free_int, p);
}

Referenced by LibTCPGetDataFromConnectionQueue().

tcpip_callback_wait()

err_t tcpip_callback_wait	(	tcpip_callback_fn	function,
		void *	ctx
	)

Sends a message to TCPIP thread to call a function. Caller thread blocks until the function returns. It is recommended to use LWIP_TCPIP_CORE_LOCKING (preferred) or LWIP_NETCONN_SEM_PER_THREAD. If not, a semaphore is created and destroyed on every call which is usually an expensive/slow operation.

Parameters

function	the function to call
ctx	parameter passed to f

Returns

ERR_OK if the function was called, another err_t if not

Definition at line 610 of file tcpip.c.

{
#if LWIP_TCPIP_CORE_LOCKING
  LOCK_TCPIP_CORE();
  function(ctx);
  UNLOCK_TCPIP_CORE();
  return ERR_OK;
#else /* LWIP_TCPIP_CORE_LOCKING */
  err_t err;
  sys_sem_t sem;
  struct tcpip_msg msg;
 
  LWIP_ASSERT("Invalid mbox", sys_mbox_valid_val(tcpip_mbox));
 
  err = sys_sem_new(&sem, 0);
  if (err != ERR_OK) {
    return err;
  }
 
  msg.type = TCPIP_MSG_CALLBACK_STATIC_WAIT;
  msg.msg.cb_wait.function = function;
  msg.msg.cb_wait.ctx = ctx;
  msg.msg.cb_wait.sem = &sem;
  sys_mbox_post(&tcpip_mbox, &msg);
  sys_arch_sem_wait(&sem, 0);
  sys_sem_free(&sem);
  return ERR_OK;
#endif /* LWIP_TCPIP_CORE_LOCKING */
}

tcpip_inpkt()

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 245 of file tcpip.c.

{
#if LWIP_TCPIP_CORE_LOCKING_INPUT
  err_t ret;
  LWIP_DEBUGF(TCPIP_DEBUG, ("tcpip_inpkt: PACKET %p/%p\n", (void *)p, (void *)inp));
  LOCK_TCPIP_CORE();
  ret = input_fn(p, inp);
  UNLOCK_TCPIP_CORE();
  return ret;
#else /* LWIP_TCPIP_CORE_LOCKING_INPUT */
  struct tcpip_msg *msg;
 
  LWIP_ASSERT("Invalid mbox", sys_mbox_valid_val(tcpip_mbox));
 
  msg = (struct tcpip_msg *)memp_malloc(MEMP_TCPIP_MSG_INPKT);
  if (msg == NULL) {
    return ERR_MEM;
  }
 
  msg->type = TCPIP_MSG_INPKT;
  msg->msg.inp.p = p;
  msg->msg.inp.netif = inp;
  msg->msg.inp.input_fn = input_fn;
  if (sys_mbox_trypost(&tcpip_mbox, msg) != ERR_OK) {
    memp_free(MEMP_TCPIP_MSG_INPKT, msg);
    return ERR_MEM;
  }
  return ERR_OK;
#endif /* LWIP_TCPIP_CORE_LOCKING_INPUT */
}

Referenced by tcpip_input().