git.sur5r.net Git - freertos/blob - Demo/Common/ethernet/lwIP/include/lwip/tcp.h

   1 /*\r
   2  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.\r
   3  * All rights reserved. \r
   4  * \r
   5  * Redistribution and use in source and binary forms, with or without modification, \r
   6  * are permitted provided that the following conditions are met:\r
   7  *\r
   8  * 1. Redistributions of source code must retain the above copyright notice,\r
   9  *    this list of conditions and the following disclaimer.\r
  10  * 2. Redistributions in binary form must reproduce the above copyright notice,\r
  11  *    this list of conditions and the following disclaimer in the documentation\r
  12  *    and/or other materials provided with the distribution.\r
  13  * 3. The name of the author may not be used to endorse or promote products\r
  14  *    derived from this software without specific prior written permission. \r
  15  *\r
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED \r
  17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF \r
  18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT \r
  19  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, \r
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT \r
  21  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS \r
  22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN \r
  23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING \r
  24  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY \r
  25  * OF SUCH DAMAGE.\r
  26  *\r
  27  * This file is part of the lwIP TCP/IP stack.\r
  28  * \r
  29  * Author: Adam Dunkels <adam@sics.se>\r
  30  *\r
  31  */\r
  32 #ifndef __LWIP_TCP_H__\r
  33 #define __LWIP_TCP_H__\r
  34 \r
  35 #include "lwip/sys.h"\r
  36 #include "lwip/mem.h"\r
  37 \r
  38 #include "lwip/pbuf.h"\r
  39 #include "lwip/opt.h"\r
  40 #include "lwip/ip.h"\r
  41 #include "lwip/icmp.h"\r
  42 \r
  43 #include "lwip/err.h"\r
  44 \r
  45 struct tcp_pcb;\r
  46 \r
  47 /* Functions for interfacing with TCP: */\r
  48 \r
  49 /* Lower layer interface to TCP: */\r
  50 void             tcp_init    (void);  /* Must be called first to\r
  51            initialize TCP. */\r
  52 void             tcp_tmr     (void);  /* Must be called every\r
  53            TCP_TMR_INTERVAL\r
  54            ms. (Typically 250 ms). */\r
  55 /* Application program's interface: */\r
  56 struct tcp_pcb * tcp_new     (void);\r
  57 struct tcp_pcb * tcp_alloc   (u8_t prio);\r
  58 \r
  59 void             tcp_arg     (struct tcp_pcb *pcb, void *arg);\r
  60 void             tcp_accept  (struct tcp_pcb *pcb,\r
  61             err_t (* accept)(void *arg, struct tcp_pcb *newpcb,\r
  62                  err_t err));\r
  63 void             tcp_recv    (struct tcp_pcb *pcb,\r
  64             err_t (* recv)(void *arg, struct tcp_pcb *tpcb,\r
  65           struct pbuf *p, err_t err));\r
  66 void             tcp_sent    (struct tcp_pcb *pcb,\r
  67             err_t (* sent)(void *arg, struct tcp_pcb *tpcb,\r
  68                u16_t len));\r
  69 void             tcp_poll    (struct tcp_pcb *pcb,\r
  70             err_t (* poll)(void *arg, struct tcp_pcb *tpcb),\r
  71             u8_t interval);\r
  72 void             tcp_err     (struct tcp_pcb *pcb,\r
  73             void (* err)(void *arg, err_t err));\r
  74 \r
  75 #define          tcp_mss(pcb)      ((pcb)->mss)\r
  76 #define          tcp_sndbuf(pcb)   ((pcb)->snd_buf)\r
  77 \r
  78 void             tcp_recved  (struct tcp_pcb *pcb, u16_t len);\r
  79 err_t            tcp_bind    (struct tcp_pcb *pcb, struct ip_addr *ipaddr,\r
  80             u16_t port);\r
  81 err_t            tcp_connect (struct tcp_pcb *pcb, struct ip_addr *ipaddr,\r
  82             u16_t port, err_t (* connected)(void *arg,\r
  83                     struct tcp_pcb *tpcb,\r
  84                     err_t err));\r
  85 struct tcp_pcb * tcp_listen  (struct tcp_pcb *pcb);\r
  86 void             tcp_abort   (struct tcp_pcb *pcb);\r
  87 err_t            tcp_close   (struct tcp_pcb *pcb);\r
  88 err_t            tcp_write   (struct tcp_pcb *pcb, const void *dataptr, u16_t len,\r
  89             u8_t copy);\r
  90 \r
  91 void             tcp_setprio (struct tcp_pcb *pcb, u8_t prio);\r
  92 \r
  93 #define TCP_PRIO_MIN    1\r
  94 #define TCP_PRIO_NORMAL 64\r
  95 #define TCP_PRIO_MAX    127\r
  96 \r
  97 /* It is also possible to call these two functions at the right\r
  98    intervals (instead of calling tcp_tmr()). */\r
  99 void             tcp_slowtmr (void);\r
 100 void             tcp_fasttmr (void);\r
 101 \r
 102 \r
 103 /* Only used by IP to pass a TCP segment to TCP: */\r
 104 void             tcp_input   (struct pbuf *p, struct netif *inp);\r
 105 /* Used within the TCP code only: */\r
 106 err_t            tcp_output  (struct tcp_pcb *pcb);\r
 107 void             tcp_rexmit  (struct tcp_pcb *pcb);\r
 108 void             tcp_rexmit_rto  (struct tcp_pcb *pcb);\r
 109 \r
 110 \r
 111 \r
 112 #define TCP_SEQ_LT(a,b)     ((s32_t)((a)-(b)) < 0)\r
 113 #define TCP_SEQ_LEQ(a,b)    ((s32_t)((a)-(b)) <= 0)\r
 114 #define TCP_SEQ_GT(a,b)     ((s32_t)((a)-(b)) > 0)\r
 115 #define TCP_SEQ_GEQ(a,b)    ((s32_t)((a)-(b)) >= 0)\r
 116 /* is b<=a<=c? */\r
 117 #if 0 /* see bug #10548 */\r
 118 #define TCP_SEQ_BETWEEN(a,b,c) ((c)-(b) >= (a)-(b))\r
 119 #endif\r
 120 #define TCP_SEQ_BETWEEN(a,b,c) (TCP_SEQ_GEQ(a,b) && TCP_SEQ_LEQ(a,c))\r
 121 #define TCP_FIN 0x01U\r
 122 #define TCP_SYN 0x02U\r
 123 #define TCP_RST 0x04U\r
 124 #define TCP_PSH 0x08U\r
 125 #define TCP_ACK 0x10U\r
 126 #define TCP_URG 0x20U\r
 127 #define TCP_ECE 0x40U\r
 128 #define TCP_CWR 0x80U\r
 129 \r
 130 #define TCP_FLAGS 0x3fU\r
 131 \r
 132 /* Length of the TCP header, excluding options. */\r
 133 #define TCP_HLEN 20\r
 134 \r
 135 #ifndef TCP_TMR_INTERVAL\r
 136 #define TCP_TMR_INTERVAL       250  /* The TCP timer interval in\r
 137                                        milliseconds. */\r
 138 #endif /* TCP_TMR_INTERVAL */\r
 139 \r
 140 #ifndef TCP_FAST_INTERVAL\r
 141 #define TCP_FAST_INTERVAL      TCP_TMR_INTERVAL /* the fine grained timeout in\r
 142                                        milliseconds */\r
 143 #endif /* TCP_FAST_INTERVAL */\r
 144 \r
 145 #ifndef TCP_SLOW_INTERVAL\r
 146 #define TCP_SLOW_INTERVAL      (2*TCP_TMR_INTERVAL)  /* the coarse grained timeout in\r
 147                                        milliseconds */\r
 148 #endif /* TCP_SLOW_INTERVAL */\r
 149 \r
 150 #define TCP_FIN_WAIT_TIMEOUT 20000 /* milliseconds */\r
 151 #define TCP_SYN_RCVD_TIMEOUT 20000 /* milliseconds */\r
 152 \r
 153 #define TCP_OOSEQ_TIMEOUT        6U /* x RTO */\r
 154 \r
 155 #define TCP_MSL 60000  /* The maximum segment lifetime in microseconds */\r
 156 \r
 157 /*\r
 158  * User-settable options (used with setsockopt).\r
 159  */\r
 160 #define TCP_NODELAY    0x01    /* don't delay send to coalesce packets */\r
 161 #define TCP_KEEPALIVE  0x02    /* send KEEPALIVE probes when idle for pcb->keepalive miliseconds */\r
 162 \r
 163 /* Keepalive values */\r
 164 #define  TCP_KEEPDEFAULT   7200000                       /* KEEPALIVE timer in miliseconds */\r
 165 #define  TCP_KEEPINTVL     75000                         /* Time between KEEPALIVE probes in miliseconds */\r
 166 #define  TCP_KEEPCNT       9                             /* Counter for KEEPALIVE probes */\r
 167 #define  TCP_MAXIDLE       TCP_KEEPCNT * TCP_KEEPINTVL   /* Maximum KEEPALIVE probe time */\r
 168 \r
 169 \r
 170 #ifdef PACK_STRUCT_USE_INCLUDES\r
 171 #  include "arch/bpstruct.h"\r
 172 #endif\r
 173 PACK_STRUCT_BEGIN\r
 174 struct tcp_hdr {\r
 175   PACK_STRUCT_FIELD(u16_t src);\r
 176   PACK_STRUCT_FIELD(u16_t dest);\r
 177   PACK_STRUCT_FIELD(u32_t seqno);\r
 178   PACK_STRUCT_FIELD(u32_t ackno);\r
 179   PACK_STRUCT_FIELD(u16_t _hdrlen_rsvd_flags);\r
 180   PACK_STRUCT_FIELD(u16_t wnd);\r
 181   PACK_STRUCT_FIELD(u16_t chksum);\r
 182   PACK_STRUCT_FIELD(u16_t urgp);\r
 183 } PACK_STRUCT_STRUCT;\r
 184 PACK_STRUCT_END\r
 185 #ifdef PACK_STRUCT_USE_INCLUDES\r
 186 #  include "arch/epstruct.h"\r
 187 #endif\r
 188 \r
 189 #define TCPH_OFFSET(phdr) (ntohs((phdr)->_hdrlen_rsvd_flags) >> 8)\r
 190 #define TCPH_HDRLEN(phdr) (ntohs((phdr)->_hdrlen_rsvd_flags) >> 12)\r
 191 #define TCPH_FLAGS(phdr)  (ntohs((phdr)->_hdrlen_rsvd_flags) & TCP_FLAGS)\r
 192 \r
 193 #define TCPH_OFFSET_SET(phdr, offset) (phdr)->_hdrlen_rsvd_flags = htons(((offset) << 8) | TCPH_FLAGS(phdr))\r
 194 #define TCPH_HDRLEN_SET(phdr, len) (phdr)->_hdrlen_rsvd_flags = htons(((len) << 12) | TCPH_FLAGS(phdr))\r
 195 #define TCPH_FLAGS_SET(phdr, flags) (phdr)->_hdrlen_rsvd_flags = htons((ntohs((phdr)->_hdrlen_rsvd_flags) & ~TCP_FLAGS) | (flags))\r
 196 #define TCPH_SET_FLAG(phdr, flags ) (phdr)->_hdrlen_rsvd_flags = htons(ntohs((phdr)->_hdrlen_rsvd_flags) | (flags))\r
 197 #define TCPH_UNSET_FLAG(phdr, flags) (phdr)->_hdrlen_rsvd_flags = htons(ntohs((phdr)->_hdrlen_rsvd_flags) | (TCPH_FLAGS(phdr) & ~(flags)) )\r
 198 \r
 199 #define TCP_TCPLEN(seg) ((seg)->len + ((TCPH_FLAGS((seg)->tcphdr) & TCP_FIN || \\r
 200           TCPH_FLAGS((seg)->tcphdr) & TCP_SYN)? 1: 0))\r
 201 \r
 202 enum tcp_state {\r
 203   CLOSED      = 0,\r
 204   LISTEN      = 1,\r
 205   SYN_SENT    = 2,\r
 206   SYN_RCVD    = 3,\r
 207   ESTABLISHED = 4,\r
 208   FIN_WAIT_1  = 5,\r
 209   FIN_WAIT_2  = 6,\r
 210   CLOSE_WAIT  = 7,\r
 211   CLOSING     = 8,\r
 212   LAST_ACK    = 9,\r
 213   TIME_WAIT   = 10\r
 214 };\r
 215 \r
 216 /* the TCP protocol control block */\r
 217 struct tcp_pcb {\r
 218 /** common PCB members */\r
 219   IP_PCB;\r
 220 /** protocol specific PCB members */\r
 221   struct tcp_pcb *next; /* for the linked list */\r
 222   enum tcp_state state; /* TCP state */\r
 223   u8_t prio;\r
 224   void *callback_arg;\r
 225 \r
 226   u16_t local_port;\r
 227   u16_t remote_port;\r
 228   \r
 229   u8_t flags;\r
 230 #define TF_ACK_DELAY (u8_t)0x01U   /* Delayed ACK. */\r
 231 #define TF_ACK_NOW   (u8_t)0x02U   /* Immediate ACK. */\r
 232 #define TF_INFR      (u8_t)0x04U   /* In fast recovery. */\r
 233 #define TF_RESET     (u8_t)0x08U   /* Connection was reset. */\r
 234 #define TF_CLOSED    (u8_t)0x10U   /* Connection was sucessfully closed. */\r
 235 #define TF_GOT_FIN   (u8_t)0x20U   /* Connection was closed by the remote end. */\r
 236 #define TF_NODELAY   (u8_t)0x40U   /* Disable Nagle algorithm */\r
 237 \r
 238   /* receiver variables */\r
 239   u32_t rcv_nxt;   /* next seqno expected */\r
 240   u16_t rcv_wnd;   /* receiver window */\r
 241   \r
 242   /* Timers */\r
 243   u32_t tmr;\r
 244   u8_t polltmr, pollinterval;\r
 245   \r
 246   /* Retransmission timer. */\r
 247   u16_t rtime;\r
 248   \r
 249   u16_t mss;   /* maximum segment size */\r
 250   \r
 251   /* RTT (round trip time) estimation variables */\r
 252   u32_t rttest; /* RTT estimate in 500ms ticks */\r
 253   u32_t rtseq;  /* sequence number being timed */\r
 254   s16_t sa, sv; /* @todo document this */\r
 255 \r
 256   u16_t rto;    /* retransmission time-out */\r
 257   u8_t nrtx;    /* number of retransmissions */\r
 258 \r
 259   /* fast retransmit/recovery */\r
 260   u32_t lastack; /* Highest acknowledged seqno. */\r
 261   u8_t dupacks;\r
 262   \r
 263   /* congestion avoidance/control variables */\r
 264   u16_t cwnd;  \r
 265   u16_t ssthresh;\r
 266 \r
 267   /* sender variables */\r
 268   u32_t snd_nxt,       /* next seqno to be sent */\r
 269     snd_max,       /* Highest seqno sent. */\r
 270     snd_wnd,       /* sender window */\r
 271     snd_wl1, snd_wl2, /* Sequence and acknowledgement numbers of last\r
 272        window update. */\r
 273     snd_lbb;       /* Sequence number of next byte to be buffered. */\r
 274 \r
 275   u16_t acked;\r
 276   \r
 277   u16_t snd_buf;   /* Available buffer space for sending (in bytes). */\r
 278   u8_t snd_queuelen; /* Available buffer space for sending (in tcp_segs). */\r
 279   \r
 280   \r
 281   /* These are ordered by sequence number: */\r
 282   struct tcp_seg *unsent;   /* Unsent (queued) segments. */\r
 283   struct tcp_seg *unacked;  /* Sent but unacknowledged segments. */\r
 284 #if TCP_QUEUE_OOSEQ  \r
 285   struct tcp_seg *ooseq;    /* Received out of sequence segments. */\r
 286 #endif /* TCP_QUEUE_OOSEQ */\r
 287 \r
 288 #if LWIP_CALLBACK_API\r
 289   /* Function to be called when more send buffer space is available. */\r
 290   err_t (* sent)(void *arg, struct tcp_pcb *pcb, u16_t space);\r
 291   \r
 292   /* Function to be called when (in-sequence) data has arrived. */\r
 293   err_t (* recv)(void *arg, struct tcp_pcb *pcb, struct pbuf *p, err_t err);\r
 294 \r
 295   /* Function to be called when a connection has been set up. */\r
 296   err_t (* connected)(void *arg, struct tcp_pcb *pcb, err_t err);\r
 297 \r
 298   /* Function to call when a listener has been connected. */\r
 299   err_t (* accept)(void *arg, struct tcp_pcb *newpcb, err_t err);\r
 300 \r
 301   /* Function which is called periodically. */\r
 302   err_t (* poll)(void *arg, struct tcp_pcb *pcb);\r
 303 \r
 304   /* Function to be called whenever a fatal error occurs. */\r
 305   void (* errf)(void *arg, err_t err);\r
 306 #endif /* LWIP_CALLBACK_API */\r
 307 \r
 308   /* idle time before KEEPALIVE is sent */\r
 309   u32_t keepalive;\r
 310   \r
 311   /* KEEPALIVE counter */\r
 312   u8_t keep_cnt;\r
 313 };\r
 314 \r
 315 struct tcp_pcb_listen {  \r
 316 /* Common members of all PCB types */\r
 317   IP_PCB;\r
 318 \r
 319 /* Protocol specific PCB members */\r
 320   struct tcp_pcb_listen *next;   /* for the linked list */\r
 321   \r
 322   /* Even if state is obviously LISTEN this is here for\r
 323    * field compatibility with tpc_pcb to which it is cast sometimes\r
 324    * Until a cleaner solution emerges this is here.FIXME\r
 325    */ \r
 326   enum tcp_state state;   /* TCP state */\r
 327 \r
 328   u8_t prio;\r
 329   void *callback_arg;\r
 330   \r
 331   u16_t local_port; \r
 332 \r
 333 #if LWIP_CALLBACK_API\r
 334   /* Function to call when a listener has been connected. */\r
 335   err_t (* accept)(void *arg, struct tcp_pcb *newpcb, err_t err);\r
 336 #endif /* LWIP_CALLBACK_API */\r
 337 };\r
 338 \r
 339 #if LWIP_EVENT_API\r
 340 \r
 341 enum lwip_event {\r
 342   LWIP_EVENT_ACCEPT,\r
 343   LWIP_EVENT_SENT,\r
 344   LWIP_EVENT_RECV,\r
 345   LWIP_EVENT_CONNECTED,\r
 346   LWIP_EVENT_POLL,\r
 347   LWIP_EVENT_ERR\r
 348 };\r
 349 \r
 350 err_t lwip_tcp_event(void *arg, struct tcp_pcb *pcb,\r
 351          enum lwip_event,\r
 352          struct pbuf *p,\r
 353          u16_t size,\r
 354          err_t err);\r
 355 \r
 356 #define TCP_EVENT_ACCEPT(pcb,err,ret)    ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\\r
 357                 LWIP_EVENT_ACCEPT, NULL, 0, err)\r
 358 #define TCP_EVENT_SENT(pcb,space,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\\r
 359                    LWIP_EVENT_SENT, NULL, space, ERR_OK)\r
 360 #define TCP_EVENT_RECV(pcb,p,err,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\\r
 361                 LWIP_EVENT_RECV, (p), 0, (err))\r
 362 #define TCP_EVENT_CONNECTED(pcb,err,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\\r
 363                 LWIP_EVENT_CONNECTED, NULL, 0, (err))\r
 364 #define TCP_EVENT_POLL(pcb,ret)       ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\\r
 365                 LWIP_EVENT_POLL, NULL, 0, ERR_OK)\r
 366 #define TCP_EVENT_ERR(errf,arg,err)  lwip_tcp_event((arg), NULL, \\r
 367                 LWIP_EVENT_ERR, NULL, 0, (err))\r
 368 #else /* LWIP_EVENT_API */\r
 369 #define TCP_EVENT_ACCEPT(pcb,err,ret)     \\r
 370                         if((pcb)->accept != NULL) \\r
 371                         (ret = (pcb)->accept((pcb)->callback_arg,(pcb),(err)))\r
 372 #define TCP_EVENT_SENT(pcb,space,ret) \\r
 373                         if((pcb)->sent != NULL) \\r
 374                         (ret = (pcb)->sent((pcb)->callback_arg,(pcb),(space)))\r
 375 #define TCP_EVENT_RECV(pcb,p,err,ret) \\r
 376                         if((pcb)->recv != NULL) \\r
 377                         { ret = (pcb)->recv((pcb)->callback_arg,(pcb),(p),(err)); } else { \\r
 378                           if (p) pbuf_free(p); }\r
 379 #define TCP_EVENT_CONNECTED(pcb,err,ret) \\r
 380                         if((pcb)->connected != NULL) \\r
 381                         (ret = (pcb)->connected((pcb)->callback_arg,(pcb),(err)))\r
 382 #define TCP_EVENT_POLL(pcb,ret) \\r
 383                         if((pcb)->poll != NULL) \\r
 384                         (ret = (pcb)->poll((pcb)->callback_arg,(pcb)))\r
 385 #define TCP_EVENT_ERR(errf,arg,err) \\r
 386                         if((errf) != NULL) \\r
 387                         (errf)((arg),(err))\r
 388 #endif /* LWIP_EVENT_API */\r
 389 \r
 390 /* This structure represents a TCP segment on the unsent and unacked queues */\r
 391 struct tcp_seg {\r
 392   struct tcp_seg *next;    /* used when putting segements on a queue */\r
 393   struct pbuf *p;          /* buffer containing data + TCP header */\r
 394   void *dataptr;           /* pointer to the TCP data in the pbuf */\r
 395   u16_t len;               /* the TCP length of this segment */\r
 396   struct tcp_hdr *tcphdr;  /* the TCP header */\r
 397 };\r
 398 \r
 399 /* Internal functions and global variables: */\r
 400 struct tcp_pcb *tcp_pcb_copy(struct tcp_pcb *pcb);\r
 401 void tcp_pcb_purge(struct tcp_pcb *pcb);\r
 402 void tcp_pcb_remove(struct tcp_pcb **pcblist, struct tcp_pcb *pcb);\r
 403 \r
 404 u8_t tcp_segs_free(struct tcp_seg *seg);\r
 405 u8_t tcp_seg_free(struct tcp_seg *seg);\r
 406 struct tcp_seg *tcp_seg_copy(struct tcp_seg *seg);\r
 407 \r
 408 #define tcp_ack(pcb)     if((pcb)->flags & TF_ACK_DELAY) { \\r
 409                             (pcb)->flags &= ~TF_ACK_DELAY; \\r
 410                             (pcb)->flags |= TF_ACK_NOW; \\r
 411                             tcp_output(pcb); \\r
 412                          } else { \\r
 413                             (pcb)->flags |= TF_ACK_DELAY; \\r
 414                          }\r
 415 \r
 416 #define tcp_ack_now(pcb) (pcb)->flags |= TF_ACK_NOW; \\r
 417                          tcp_output(pcb)\r
 418 \r
 419 err_t tcp_send_ctrl(struct tcp_pcb *pcb, u8_t flags);\r
 420 err_t tcp_enqueue(struct tcp_pcb *pcb, void *dataptr, u16_t len,\r
 421     u8_t flags, u8_t copy,\r
 422                 u8_t *optdata, u8_t optlen);\r
 423 \r
 424 void tcp_rexmit_seg(struct tcp_pcb *pcb, struct tcp_seg *seg);\r
 425 \r
 426 void tcp_rst(u32_t seqno, u32_t ackno,\r
 427        struct ip_addr *local_ip, struct ip_addr *remote_ip,\r
 428        u16_t local_port, u16_t remote_port);\r
 429 \r
 430 u32_t tcp_next_iss(void);\r
 431 \r
 432 void tcp_keepalive(struct tcp_pcb *pcb);\r
 433 \r
 434 extern struct tcp_pcb *tcp_input_pcb;\r
 435 extern u32_t tcp_ticks;\r
 436 \r
 437 #if TCP_DEBUG || TCP_INPUT_DEBUG || TCP_OUTPUT_DEBUG\r
 438 void tcp_debug_print(struct tcp_hdr *tcphdr);\r
 439 void tcp_debug_print_flags(u8_t flags);\r
 440 void tcp_debug_print_state(enum tcp_state s);\r
 441 void tcp_debug_print_pcbs(void);\r
 442 s16_t tcp_pcbs_sane(void);\r
 443 #else\r
 444 #  define tcp_debug_print(tcphdr)\r
 445 #  define tcp_debug_print_flags(flags)\r
 446 #  define tcp_debug_print_state(s)\r
 447 #  define tcp_debug_print_pcbs()\r
 448 #  define tcp_pcbs_sane() 1\r
 449 #endif /* TCP_DEBUG */\r
 450 \r
 451 #if NO_SYS\r
 452 #define tcp_timer_needed()\r
 453 #else\r
 454 void tcp_timer_needed(void);\r
 455 #endif\r
 456 \r
 457 /* The TCP PCB lists. */\r
 458 union tcp_listen_pcbs_t { /* List of all TCP PCBs in LISTEN state. */\r
 459   struct tcp_pcb_listen *listen_pcbs; \r
 460   struct tcp_pcb *pcbs;\r
 461 };\r
 462 extern union tcp_listen_pcbs_t tcp_listen_pcbs;\r
 463 extern struct tcp_pcb *tcp_active_pcbs;  /* List of all TCP PCBs that are in a\r
 464               state in which they accept or send\r
 465               data. */\r
 466 extern struct tcp_pcb *tcp_tw_pcbs;      /* List of all TCP PCBs in TIME-WAIT. */\r
 467 \r
 468 extern struct tcp_pcb *tcp_tmp_pcb;      /* Only used for temporary storage. */\r
 469 \r
 470 /* Axioms about the above lists:   \r
 471    1) Every TCP PCB that is not CLOSED is in one of the lists.\r
 472    2) A PCB is only in one of the lists.\r
 473    3) All PCBs in the tcp_listen_pcbs list is in LISTEN state.\r
 474    4) All PCBs in the tcp_tw_pcbs list is in TIME-WAIT state.\r
 475 */\r
 476 \r
 477 /* Define two macros, TCP_REG and TCP_RMV that registers a TCP PCB\r
 478    with a PCB list or removes a PCB from a list, respectively. */\r
 479 #if 0\r
 480 #define TCP_REG(pcbs, npcb) do {\\r
 481                             LWIP_DEBUGF(TCP_DEBUG, ("TCP_REG %p local port %d\n", npcb, npcb->local_port)); \\r
 482                             for(tcp_tmp_pcb = *pcbs; \\r
 483           tcp_tmp_pcb != NULL; \\r
 484         tcp_tmp_pcb = tcp_tmp_pcb->next) { \\r
 485                                 LWIP_ASSERT("TCP_REG: already registered\n", tcp_tmp_pcb != npcb); \\r
 486                             } \\r
 487                             LWIP_ASSERT("TCP_REG: pcb->state != CLOSED", npcb->state != CLOSED); \\r
 488                             npcb->next = *pcbs; \\r
 489                             LWIP_ASSERT("TCP_REG: npcb->next != npcb", npcb->next != npcb); \\r
 490                             *(pcbs) = npcb; \\r
 491                             LWIP_ASSERT("TCP_RMV: tcp_pcbs sane", tcp_pcbs_sane()); \\r
 492               tcp_timer_needed(); \\r
 493                             } while(0)\r
 494 #define TCP_RMV(pcbs, npcb) do { \\r
 495                             LWIP_ASSERT("TCP_RMV: pcbs != NULL", *pcbs != NULL); \\r
 496                             LWIP_DEBUGF(TCP_DEBUG, ("TCP_RMV: removing %p from %p\n", npcb, *pcbs)); \\r
 497                             if(*pcbs == npcb) { \\r
 498                                *pcbs = (*pcbs)->next; \\r
 499                             } else for(tcp_tmp_pcb = *pcbs; tcp_tmp_pcb != NULL; tcp_tmp_pcb = tcp_tmp_pcb->next) { \\r
 500                                if(tcp_tmp_pcb->next != NULL && tcp_tmp_pcb->next == npcb) { \\r
 501                                   tcp_tmp_pcb->next = npcb->next; \\r
 502                                   break; \\r
 503                                } \\r
 504                             } \\r
 505                             npcb->next = NULL; \\r
 506                             LWIP_ASSERT("TCP_RMV: tcp_pcbs sane", tcp_pcbs_sane()); \\r
 507                             LWIP_DEBUGF(TCP_DEBUG, ("TCP_RMV: removed %p from %p\n", npcb, *pcbs)); \\r
 508                             } while(0)\r
 509 \r
 510 #else /* LWIP_DEBUG */\r
 511 #define TCP_REG(pcbs, npcb) do { \\r
 512                             npcb->next = *pcbs; \\r
 513                             *(pcbs) = npcb; \\r
 514               tcp_timer_needed(); \\r
 515                             } while(0)\r
 516 #define TCP_RMV(pcbs, npcb) do { \\r
 517                             if(*(pcbs) == npcb) { \\r
 518                                (*(pcbs)) = (*pcbs)->next; \\r
 519                             } else for(tcp_tmp_pcb = *pcbs; tcp_tmp_pcb != NULL; tcp_tmp_pcb = tcp_tmp_pcb->next) { \\r
 520                                if(tcp_tmp_pcb->next != NULL && tcp_tmp_pcb->next == npcb) { \\r
 521                                   tcp_tmp_pcb->next = npcb->next; \\r
 522                                   break; \\r
 523                                } \\r
 524                             } \\r
 525                             npcb->next = NULL; \\r
 526                             } while(0)\r
 527 #endif /* LWIP_DEBUG */\r
 528 #endif /* __LWIP_TCP_H__ */\r
 529 \r
 530 \r
 531 \r