lib/drivers/lwip/src/include/lwip/tcpip.h

   1 /*
   2  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without modification,
   6  * are permitted provided that the following conditions are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright notice,
   9  *    this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright notice,
  11  *    this list of conditions and the following disclaimer in the documentation
  12  *    and/or other materials provided with the distribution.
  13  * 3. The name of the author may not be used to endorse or promote products
  14  *    derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
  19  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
  21  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  24  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  25  * OF SUCH DAMAGE.
  26  *
  27  * This file is part of the lwIP TCP/IP stack.
  28  *
  29  * Author: Adam Dunkels <adam@sics.se>
  30  *
  31  */
  32 #ifndef __LWIP_TCPIP_H__
  33 #define __LWIP_TCPIP_H__
  34
  35 #include "lwip/opt.h"
  36
  37 #if !NO_SYS /* don't build if not configured for use in lwipopts.h */
  38
  39 #include "lwip/api_msg.h"
  40 #include "lwip/netifapi.h"
  41 #include "lwip/pbuf.h"
  42 #include "lwip/api.h"
  43 #include "lwip/sys.h"
  44 #include "lwip/netif.h"
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 #if LWIP_TCPIP_CORE_LOCKING
  51 /** The global semaphore to lock the stack. */
  52 extern sys_sem_t lock_tcpip_core;
  53 #define LOCK_TCPIP_CORE()     sys_sem_wait(lock_tcpip_core)
  54 #define UNLOCK_TCPIP_CORE()   sys_sem_signal(lock_tcpip_core)
  55 #define TCPIP_APIMSG(m)       tcpip_apimsg_lock(m)
  56 #define TCPIP_APIMSG_ACK(m)
  57 #define TCPIP_NETIFAPI(m)     tcpip_netifapi_lock(m)
  58 #define TCPIP_NETIFAPI_ACK(m)
  59 #else
  60 #define LOCK_TCPIP_CORE()
  61 #define UNLOCK_TCPIP_CORE()
  62 #define TCPIP_APIMSG(m)       tcpip_apimsg(m)
  63 #define TCPIP_APIMSG_ACK(m)   sys_sem_signal(m->conn->op_completed)
  64 #define TCPIP_NETIFAPI(m)     tcpip_netifapi(m)
  65 #define TCPIP_NETIFAPI_ACK(m) sys_sem_signal(m->sem)
  66 #endif /* LWIP_TCPIP_CORE_LOCKING */
  67
  68 void tcpip_init(void (* tcpip_init_done)(void *), void *arg);
  69
  70 #if LWIP_NETCONN
  71 err_t tcpip_apimsg(struct api_msg *apimsg);
  72 #if LWIP_TCPIP_CORE_LOCKING
  73 err_t tcpip_apimsg_lock(struct api_msg *apimsg);
  74 #endif /* LWIP_TCPIP_CORE_LOCKING */
  75 #endif /* LWIP_NETCONN */
  76
  77 err_t tcpip_input(struct pbuf *p, struct netif *inp);
  78
  79 #if LWIP_NETIF_API
  80 err_t tcpip_netifapi(struct netifapi_msg *netifapimsg);
  81 #if LWIP_TCPIP_CORE_LOCKING
  82 err_t tcpip_netifapi_lock(struct netifapi_msg *netifapimsg);
  83 #endif /* LWIP_TCPIP_CORE_LOCKING */
  84 #endif /* LWIP_NETIF_API */
  85
  86 err_t tcpip_callback_with_block(void (*f)(void *ctx), void *ctx, u8_t block);
  87 #define tcpip_callback(f, ctx)              tcpip_callback_with_block(f, ctx, 1)
  88
  89 /* free pbufs or heap memory from another context without blocking */
  90 err_t pbuf_free_callback(struct pbuf *p);
  91 err_t mem_free_callback(void *m);
  92
  93 err_t tcpip_timeout(u32_t msecs, sys_timeout_handler h, void *arg);
  94 err_t tcpip_untimeout(sys_timeout_handler h, void *arg);
  95
  96 enum tcpip_msg_type {
  97 #if LWIP_NETCONN
  98   TCPIP_MSG_API,
  99 #endif /* LWIP_NETCONN */
 100   TCPIP_MSG_INPKT,
 101 #if LWIP_NETIF_API
 102   TCPIP_MSG_NETIFAPI,
 103 #endif /* LWIP_NETIF_API */
 104   TCPIP_MSG_CALLBACK,
 105   TCPIP_MSG_TIMEOUT,
 106   TCPIP_MSG_UNTIMEOUT
 107 };
 108
 109 struct tcpip_msg {
 110   enum tcpip_msg_type type;
 111   sys_sem_t *sem;
 112   union {
 113 #if LWIP_NETCONN
 114     struct api_msg *apimsg;
 115 #endif /* LWIP_NETCONN */
 116 #if LWIP_NETIF_API
 117     struct netifapi_msg *netifapimsg;
 118 #endif /* LWIP_NETIF_API */
 119     struct {
 120       struct pbuf *p;
 121       struct netif *netif;
 122     } inp;
 123     struct {
 124       void (*f)(void *ctx);
 125       void *ctx;
 126     } cb;
 127     struct {
 128       u32_t msecs;
 129       sys_timeout_handler h;
 130       void *arg;
 131     } tmo;
 132   } msg;
 133 };
 134
 135 #ifdef __cplusplus
 136 }
 137 #endif
 138
 139 #endif /* !NO_SYS */
 140
 141 #endif /* __LWIP_TCPIP_H__ */