Go to the source code of this file.
Macros | |
| #define | LOCK_TCPIP_CORE() |
| #define | tcpip_callback(f, ctx) tcpip_callback_with_block(f, ctx, 1) |
| #define | UNLOCK_TCPIP_CORE() |
Typedefs | |
| typedef void(* | tcpip_callback_fn) (void *ctx) |
| typedef void(* | tcpip_init_done_fn) (void *arg) |
Functions | |
| err_t | mem_free_callback (void *m) |
| err_t | pbuf_free_callback (struct pbuf *p) |
| err_t | tcpip_callback_with_block (tcpip_callback_fn function, void *ctx, u8_t block) |
| void | tcpip_callbackmsg_delete (struct tcpip_callback_msg *msg) |
| struct tcpip_callback_msg * | tcpip_callbackmsg_new (tcpip_callback_fn function, void *ctx) |
| 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_trycallback (struct tcpip_callback_msg *msg) |
Detailed Description
Functions to sync with TCPIP thread
Definition in file tcpip.h.
Macro Definition Documentation
◆ LOCK_TCPIP_CORE
◆ tcpip_callback
| #define tcpip_callback | ( | f, | |
| ctx | |||
| ) | tcpip_callback_with_block(f, ctx, 1) |
- See also
- tcpip_callback_with_block
◆ UNLOCK_TCPIP_CORE
Typedef Documentation
◆ tcpip_callback_fn
| typedef void(* tcpip_callback_fn) (void *ctx) |
Function prototype for functions passed to tcpip_callback()
◆ tcpip_init_done_fn
| typedef void(* tcpip_init_done_fn) (void *arg) |
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 491 of file tcpip.c.
References mem_free(), and tcpip_callback_with_block().
◆ pbuf_free_callback()
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 480 of file tcpip.c.
References tcpip_callback_with_block().
◆ 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 229 of file tcpip.c.
References LWIP_ASSERT, tcpip_msg::msg, and sys_mbox_valid_val.
Referenced by mem_free_callback(), and pbuf_free_callback().
◆ tcpip_callbackmsg_delete()
| 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 421 of file tcpip.c.
References memp_free(), and tcpip_msg::msg.
◆ tcpip_callbackmsg_new()
| 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 405 of file tcpip.c.
References tcpip_msg::ctx, memp_malloc(), tcpip_msg::msg, NULL, and TCPIP_MSG_CALLBACK_STATIC.
◆ tcpip_init()
| 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 446 of file tcpip.c.
References lwip_init().
Referenced by net_init().
◆ 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 161 of file tcpip.c.
References tcpip_msg::inp, tcpip_msg::input_fn, LOCK_TCPIP_CORE, LWIP_ASSERT, LWIP_DEBUGF, tcpip_msg::msg, tcpip_msg::p, sys_mbox_valid_val, TCPIP_DEBUG, and UNLOCK_TCPIP_CORE.
Referenced by tcpip_input().
◆ tcpip_input()
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 204 of file tcpip.c.
References tcpip_msg::inp, NETIF_FLAG_ETHARP, NETIF_FLAG_ETHERNET, tcpip_msg::p, and tcpip_inpkt().
Referenced by net_init(), and netif_init().
◆ tcpip_trycallback()
| err_t tcpip_trycallback | ( | struct tcpip_callback_msg * | msg | ) |
Try to post a callback-message to the tcpip_thread mbox This is intended to be used to send "static" messages from interrupt context.
- Parameters
-
msg pointer to the message to post
- Returns
- sys_mbox_trypost() return code
Definition at line 432 of file tcpip.c.
References LWIP_ASSERT, and sys_mbox_valid_val.
