Pranav Sawant / EthernetNetIf

12Oct2012MbedLab

Dependents:   Lab3_VoiceMeter

Fork of EthernetNetIf by Donatien Garnier

LPC1768/lwip/include/lwip/tcp_impl.h@6:22ce63eddd2b, 2012-10-12 (annotated)

Committer:
psawant9
Date:
Fri Oct 12 16:02:00 2012 +0000
Revision:
6:22ce63eddd2b
Parent:
5:bc7df6da7589 
Done

Who changed what in which revision?

UserRevisionLine numberNew contents of line
psawant9 6:22ce63eddd2b 1 /*
psawant9 6:22ce63eddd2b 2 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
psawant9 6:22ce63eddd2b 3 * All rights reserved.
psawant9 6:22ce63eddd2b 4 *
psawant9 6:22ce63eddd2b 5 * Redistribution and use in source and binary forms, with or without modification,
psawant9 6:22ce63eddd2b 6 * are permitted provided that the following conditions are met:
psawant9 6:22ce63eddd2b 7 *
psawant9 6:22ce63eddd2b 8 * 1. Redistributions of source code must retain the above copyright notice,
psawant9 6:22ce63eddd2b 9 * this list of conditions and the following disclaimer.
psawant9 6:22ce63eddd2b 10 * 2. Redistributions in binary form must reproduce the above copyright notice,
psawant9 6:22ce63eddd2b 11 * this list of conditions and the following disclaimer in the documentation
psawant9 6:22ce63eddd2b 12 * and/or other materials provided with the distribution.
psawant9 6:22ce63eddd2b 13 * 3. The name of the author may not be used to endorse or promote products
psawant9 6:22ce63eddd2b 14 * derived from this software without specific prior written permission.
psawant9 6:22ce63eddd2b 15 *
psawant9 6:22ce63eddd2b 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
psawant9 6:22ce63eddd2b 17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
psawant9 6:22ce63eddd2b 18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
psawant9 6:22ce63eddd2b 19 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
psawant9 6:22ce63eddd2b 20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
psawant9 6:22ce63eddd2b 21 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
psawant9 6:22ce63eddd2b 22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
psawant9 6:22ce63eddd2b 23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
psawant9 6:22ce63eddd2b 24 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
psawant9 6:22ce63eddd2b 25 * OF SUCH DAMAGE.
psawant9 6:22ce63eddd2b 26 *
psawant9 6:22ce63eddd2b 27 * This file is part of the lwIP TCP/IP stack.
psawant9 6:22ce63eddd2b 28 *
psawant9 6:22ce63eddd2b 29 * Author: Adam Dunkels <adam@sics.se>
psawant9 6:22ce63eddd2b 30 *
psawant9 6:22ce63eddd2b 31 */
psawant9 6:22ce63eddd2b 32 #ifndef __LWIP_TCP_IMPL_H__
psawant9 6:22ce63eddd2b 33 #define __LWIP_TCP_IMPL_H__
psawant9 6:22ce63eddd2b 34
psawant9 6:22ce63eddd2b 35 #include "lwip/opt.h"
psawant9 6:22ce63eddd2b 36
psawant9 6:22ce63eddd2b 37 #if LWIP_TCP /* don't build if not configured for use in lwipopts.h */
psawant9 6:22ce63eddd2b 38
psawant9 6:22ce63eddd2b 39 #include "lwip/tcp.h"
psawant9 6:22ce63eddd2b 40 #include "lwip/sys.h"
psawant9 6:22ce63eddd2b 41 #include "lwip/mem.h"
psawant9 6:22ce63eddd2b 42 #include "lwip/pbuf.h"
psawant9 6:22ce63eddd2b 43 #include "lwip/ip.h"
psawant9 6:22ce63eddd2b 44 #include "lwip/icmp.h"
psawant9 6:22ce63eddd2b 45 #include "lwip/err.h"
psawant9 6:22ce63eddd2b 46
psawant9 6:22ce63eddd2b 47 #ifdef __cplusplus
psawant9 6:22ce63eddd2b 48 extern "C" {
psawant9 6:22ce63eddd2b 49 #endif
psawant9 6:22ce63eddd2b 50
psawant9 6:22ce63eddd2b 51 /* Functions for interfacing with TCP: */
psawant9 6:22ce63eddd2b 52
psawant9 6:22ce63eddd2b 53 /* Lower layer interface to TCP: */
psawant9 6:22ce63eddd2b 54 #define tcp_init() /* Compatibility define, no init needed. */
psawant9 6:22ce63eddd2b 55 void tcp_tmr (void); /* Must be called every
psawant9 6:22ce63eddd2b 56 TCP_TMR_INTERVAL
psawant9 6:22ce63eddd2b 57 ms. (Typically 250 ms). */
psawant9 6:22ce63eddd2b 58 /* It is also possible to call these two functions at the right
psawant9 6:22ce63eddd2b 59 intervals (instead of calling tcp_tmr()). */
psawant9 6:22ce63eddd2b 60 void tcp_slowtmr (void);
psawant9 6:22ce63eddd2b 61 void tcp_fasttmr (void);
psawant9 6:22ce63eddd2b 62
psawant9 6:22ce63eddd2b 63
psawant9 6:22ce63eddd2b 64 /* Only used by IP to pass a TCP segment to TCP: */
psawant9 6:22ce63eddd2b 65 void tcp_input (struct pbuf *p, struct netif *inp);
psawant9 6:22ce63eddd2b 66 /* Used within the TCP code only: */
psawant9 6:22ce63eddd2b 67 struct tcp_pcb * tcp_alloc (u8_t prio);
psawant9 6:22ce63eddd2b 68 void tcp_abandon (struct tcp_pcb *pcb, int reset);
psawant9 6:22ce63eddd2b 69 err_t tcp_send_empty_ack(struct tcp_pcb *pcb);
psawant9 6:22ce63eddd2b 70 void tcp_rexmit (struct tcp_pcb *pcb);
psawant9 6:22ce63eddd2b 71 void tcp_rexmit_rto (struct tcp_pcb *pcb);
psawant9 6:22ce63eddd2b 72 void tcp_rexmit_fast (struct tcp_pcb *pcb);
psawant9 6:22ce63eddd2b 73 u32_t tcp_update_rcv_ann_wnd(struct tcp_pcb *pcb);
psawant9 6:22ce63eddd2b 74
psawant9 6:22ce63eddd2b 75 /**
psawant9 6:22ce63eddd2b 76 * This is the Nagle algorithm: try to combine user data to send as few TCP
psawant9 6:22ce63eddd2b 77 * segments as possible. Only send if
psawant9 6:22ce63eddd2b 78 * - no previously transmitted data on the connection remains unacknowledged or
psawant9 6:22ce63eddd2b 79 * - the TF_NODELAY flag is set (nagle algorithm turned off for this pcb) or
psawant9 6:22ce63eddd2b 80 * - the only unsent segment is at least pcb->mss bytes long (or there is more
psawant9 6:22ce63eddd2b 81 * than one unsent segment - with lwIP, this can happen although unsent->len < mss)
psawant9 6:22ce63eddd2b 82 * - or if we are in fast-retransmit (TF_INFR)
psawant9 6:22ce63eddd2b 83 */
psawant9 6:22ce63eddd2b 84 #define tcp_do_output_nagle(tpcb) ((((tpcb)->unacked == NULL) || \
psawant9 6:22ce63eddd2b 85 ((tpcb)->flags & (TF_NODELAY | TF_INFR)) || \
psawant9 6:22ce63eddd2b 86 (((tpcb)->unsent != NULL) && (((tpcb)->unsent->next != NULL) || \
psawant9 6:22ce63eddd2b 87 ((tpcb)->unsent->len >= (tpcb)->mss))) \
psawant9 6:22ce63eddd2b 88 ) ? 1 : 0)
psawant9 6:22ce63eddd2b 89 #define tcp_output_nagle(tpcb) (tcp_do_output_nagle(tpcb) ? tcp_output(tpcb) : ERR_OK)
psawant9 6:22ce63eddd2b 90
psawant9 6:22ce63eddd2b 91
psawant9 6:22ce63eddd2b 92 #define TCP_SEQ_LT(a,b) ((s32_t)((a)-(b)) < 0)
psawant9 6:22ce63eddd2b 93 #define TCP_SEQ_LEQ(a,b) ((s32_t)((a)-(b)) <= 0)
psawant9 6:22ce63eddd2b 94 #define TCP_SEQ_GT(a,b) ((s32_t)((a)-(b)) > 0)
psawant9 6:22ce63eddd2b 95 #define TCP_SEQ_GEQ(a,b) ((s32_t)((a)-(b)) >= 0)
psawant9 6:22ce63eddd2b 96 /* is b<=a<=c? */
psawant9 6:22ce63eddd2b 97 #if 0 /* see bug #10548 */
psawant9 6:22ce63eddd2b 98 #define TCP_SEQ_BETWEEN(a,b,c) ((c)-(b) >= (a)-(b))
psawant9 6:22ce63eddd2b 99 #endif
psawant9 6:22ce63eddd2b 100 #define TCP_SEQ_BETWEEN(a,b,c) (TCP_SEQ_GEQ(a,b) && TCP_SEQ_LEQ(a,c))
psawant9 6:22ce63eddd2b 101 #define TCP_FIN 0x01U
psawant9 6:22ce63eddd2b 102 #define TCP_SYN 0x02U
psawant9 6:22ce63eddd2b 103 #define TCP_RST 0x04U
psawant9 6:22ce63eddd2b 104 #define TCP_PSH 0x08U
psawant9 6:22ce63eddd2b 105 #define TCP_ACK 0x10U
psawant9 6:22ce63eddd2b 106 #define TCP_URG 0x20U
psawant9 6:22ce63eddd2b 107 #define TCP_ECE 0x40U
psawant9 6:22ce63eddd2b 108 #define TCP_CWR 0x80U
psawant9 6:22ce63eddd2b 109
psawant9 6:22ce63eddd2b 110 #define TCP_FLAGS 0x3fU
psawant9 6:22ce63eddd2b 111
psawant9 6:22ce63eddd2b 112 /* Length of the TCP header, excluding options. */
psawant9 6:22ce63eddd2b 113 #define TCP_HLEN 20
psawant9 6:22ce63eddd2b 114
psawant9 6:22ce63eddd2b 115 #ifndef TCP_TMR_INTERVAL
psawant9 6:22ce63eddd2b 116 #define TCP_TMR_INTERVAL 250 /* The TCP timer interval in milliseconds. */
psawant9 6:22ce63eddd2b 117 #endif /* TCP_TMR_INTERVAL */
psawant9 6:22ce63eddd2b 118
psawant9 6:22ce63eddd2b 119 #ifndef TCP_FAST_INTERVAL
psawant9 6:22ce63eddd2b 120 #define TCP_FAST_INTERVAL TCP_TMR_INTERVAL /* the fine grained timeout in milliseconds */
psawant9 6:22ce63eddd2b 121 #endif /* TCP_FAST_INTERVAL */
psawant9 6:22ce63eddd2b 122
psawant9 6:22ce63eddd2b 123 #ifndef TCP_SLOW_INTERVAL
psawant9 6:22ce63eddd2b 124 #define TCP_SLOW_INTERVAL (2*TCP_TMR_INTERVAL) /* the coarse grained timeout in milliseconds */
psawant9 6:22ce63eddd2b 125 #endif /* TCP_SLOW_INTERVAL */
psawant9 6:22ce63eddd2b 126
psawant9 6:22ce63eddd2b 127 #define TCP_FIN_WAIT_TIMEOUT 20000 /* milliseconds */
psawant9 6:22ce63eddd2b 128 #define TCP_SYN_RCVD_TIMEOUT 20000 /* milliseconds */
psawant9 6:22ce63eddd2b 129
psawant9 6:22ce63eddd2b 130 #define TCP_OOSEQ_TIMEOUT 6U /* x RTO */
psawant9 6:22ce63eddd2b 131
psawant9 6:22ce63eddd2b 132 #ifndef TCP_MSL
psawant9 6:22ce63eddd2b 133 #define TCP_MSL 60000UL /* The maximum segment lifetime in milliseconds */
psawant9 6:22ce63eddd2b 134 #endif
psawant9 6:22ce63eddd2b 135
psawant9 6:22ce63eddd2b 136 /* Keepalive values, compliant with RFC 1122. Don't change this unless you know what you're doing */
psawant9 6:22ce63eddd2b 137 #ifndef TCP_KEEPIDLE_DEFAULT
psawant9 6:22ce63eddd2b 138 #define TCP_KEEPIDLE_DEFAULT 7200000UL /* Default KEEPALIVE timer in milliseconds */
psawant9 6:22ce63eddd2b 139 #endif
psawant9 6:22ce63eddd2b 140
psawant9 6:22ce63eddd2b 141 #ifndef TCP_KEEPINTVL_DEFAULT
psawant9 6:22ce63eddd2b 142 #define TCP_KEEPINTVL_DEFAULT 75000UL /* Default Time between KEEPALIVE probes in milliseconds */
psawant9 6:22ce63eddd2b 143 #endif
psawant9 6:22ce63eddd2b 144
psawant9 6:22ce63eddd2b 145 #ifndef TCP_KEEPCNT_DEFAULT
psawant9 6:22ce63eddd2b 146 #define TCP_KEEPCNT_DEFAULT 9U /* Default Counter for KEEPALIVE probes */
psawant9 6:22ce63eddd2b 147 #endif
psawant9 6:22ce63eddd2b 148
psawant9 6:22ce63eddd2b 149 #define TCP_MAXIDLE TCP_KEEPCNT_DEFAULT * TCP_KEEPINTVL_DEFAULT /* Maximum KEEPALIVE probe time */
psawant9 6:22ce63eddd2b 150
psawant9 6:22ce63eddd2b 151 /* Fields are (of course) in network byte order.
psawant9 6:22ce63eddd2b 152 * Some fields are converted to host byte order in tcp_input().
psawant9 6:22ce63eddd2b 153 */
psawant9 6:22ce63eddd2b 154 #ifdef PACK_STRUCT_USE_INCLUDES
psawant9 6:22ce63eddd2b 155 # include "arch/bpstruct.h"
psawant9 6:22ce63eddd2b 156 #endif
psawant9 6:22ce63eddd2b 157 PACK_STRUCT_BEGIN
psawant9 6:22ce63eddd2b 158 struct tcp_hdr {
psawant9 6:22ce63eddd2b 159 PACK_STRUCT_FIELD(u16_t src);
psawant9 6:22ce63eddd2b 160 PACK_STRUCT_FIELD(u16_t dest);
psawant9 6:22ce63eddd2b 161 PACK_STRUCT_FIELD(u32_t seqno);
psawant9 6:22ce63eddd2b 162 PACK_STRUCT_FIELD(u32_t ackno);
psawant9 6:22ce63eddd2b 163 PACK_STRUCT_FIELD(u16_t _hdrlen_rsvd_flags);
psawant9 6:22ce63eddd2b 164 PACK_STRUCT_FIELD(u16_t wnd);
psawant9 6:22ce63eddd2b 165 PACK_STRUCT_FIELD(u16_t chksum);
psawant9 6:22ce63eddd2b 166 PACK_STRUCT_FIELD(u16_t urgp);
psawant9 6:22ce63eddd2b 167 } PACK_STRUCT_STRUCT;
psawant9 6:22ce63eddd2b 168 PACK_STRUCT_END
psawant9 6:22ce63eddd2b 169 #ifdef PACK_STRUCT_USE_INCLUDES
psawant9 6:22ce63eddd2b 170 # include "arch/epstruct.h"
psawant9 6:22ce63eddd2b 171 #endif
psawant9 6:22ce63eddd2b 172
psawant9 6:22ce63eddd2b 173 #define TCPH_OFFSET(phdr) (ntohs((phdr)->_hdrlen_rsvd_flags) >> 8)
psawant9 6:22ce63eddd2b 174 #define TCPH_HDRLEN(phdr) (ntohs((phdr)->_hdrlen_rsvd_flags) >> 12)
psawant9 6:22ce63eddd2b 175 #define TCPH_FLAGS(phdr) (ntohs((phdr)->_hdrlen_rsvd_flags) & TCP_FLAGS)
psawant9 6:22ce63eddd2b 176
psawant9 6:22ce63eddd2b 177 #define TCPH_OFFSET_SET(phdr, offset) (phdr)->_hdrlen_rsvd_flags = htons(((offset) << 8) | TCPH_FLAGS(phdr))
psawant9 6:22ce63eddd2b 178 #define TCPH_HDRLEN_SET(phdr, len) (phdr)->_hdrlen_rsvd_flags = htons(((len) << 12) | TCPH_FLAGS(phdr))
psawant9 6:22ce63eddd2b 179 #define TCPH_FLAGS_SET(phdr, flags) (phdr)->_hdrlen_rsvd_flags = (((phdr)->_hdrlen_rsvd_flags & PP_HTONS((u16_t)(~(u16_t)(TCP_FLAGS)))) | htons(flags))
psawant9 6:22ce63eddd2b 180 #define TCPH_HDRLEN_FLAGS_SET(phdr, len, flags) (phdr)->_hdrlen_rsvd_flags = htons(((len) << 12) | (flags))
psawant9 6:22ce63eddd2b 181
psawant9 6:22ce63eddd2b 182 #define TCPH_SET_FLAG(phdr, flags ) (phdr)->_hdrlen_rsvd_flags = ((phdr)->_hdrlen_rsvd_flags | htons(flags))
psawant9 6:22ce63eddd2b 183 #define TCPH_UNSET_FLAG(phdr, flags) (phdr)->_hdrlen_rsvd_flags = htons(ntohs((phdr)->_hdrlen_rsvd_flags) | (TCPH_FLAGS(phdr) & ~(flags)) )
psawant9 6:22ce63eddd2b 184
psawant9 6:22ce63eddd2b 185 #define TCP_TCPLEN(seg) ((seg)->len + ((TCPH_FLAGS((seg)->tcphdr) & (TCP_FIN | TCP_SYN)) != 0))
psawant9 6:22ce63eddd2b 186
psawant9 6:22ce63eddd2b 187 /** Flags used on input processing, not on pcb->flags
psawant9 6:22ce63eddd2b 188 */
psawant9 6:22ce63eddd2b 189 #define TF_RESET (u8_t)0x08U /* Connection was reset. */
psawant9 6:22ce63eddd2b 190 #define TF_CLOSED (u8_t)0x10U /* Connection was sucessfully closed. */
psawant9 6:22ce63eddd2b 191 #define TF_GOT_FIN (u8_t)0x20U /* Connection was closed by the remote end. */
psawant9 6:22ce63eddd2b 192
psawant9 6:22ce63eddd2b 193
psawant9 6:22ce63eddd2b 194 #if LWIP_EVENT_API
psawant9 6:22ce63eddd2b 195
psawant9 6:22ce63eddd2b 196 #define TCP_EVENT_ACCEPT(pcb,err,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\
psawant9 6:22ce63eddd2b 197 LWIP_EVENT_ACCEPT, NULL, 0, err)
psawant9 6:22ce63eddd2b 198 #define TCP_EVENT_SENT(pcb,space,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\
psawant9 6:22ce63eddd2b 199 LWIP_EVENT_SENT, NULL, space, ERR_OK)
psawant9 6:22ce63eddd2b 200 #define TCP_EVENT_RECV(pcb,p,err,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\
psawant9 6:22ce63eddd2b 201 LWIP_EVENT_RECV, (p), 0, (err))
psawant9 6:22ce63eddd2b 202 #define TCP_EVENT_CLOSED(pcb,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\
psawant9 6:22ce63eddd2b 203 LWIP_EVENT_RECV, NULL, 0, ERR_OK)
psawant9 6:22ce63eddd2b 204 #define TCP_EVENT_CONNECTED(pcb,err,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\
psawant9 6:22ce63eddd2b 205 LWIP_EVENT_CONNECTED, NULL, 0, (err))
psawant9 6:22ce63eddd2b 206 #define TCP_EVENT_POLL(pcb,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\
psawant9 6:22ce63eddd2b 207 LWIP_EVENT_POLL, NULL, 0, ERR_OK)
psawant9 6:22ce63eddd2b 208 #define TCP_EVENT_ERR(errf,arg,err) lwip_tcp_event((arg), NULL, \
psawant9 6:22ce63eddd2b 209 LWIP_EVENT_ERR, NULL, 0, (err))
psawant9 6:22ce63eddd2b 210
psawant9 6:22ce63eddd2b 211 #else /* LWIP_EVENT_API */
psawant9 6:22ce63eddd2b 212
psawant9 6:22ce63eddd2b 213 #define TCP_EVENT_ACCEPT(pcb,err,ret) \
psawant9 6:22ce63eddd2b 214 do { \
psawant9 6:22ce63eddd2b 215 if((pcb)->accept != NULL) \
psawant9 6:22ce63eddd2b 216 (ret) = (pcb)->accept((pcb)->callback_arg,(pcb),(err)); \
psawant9 6:22ce63eddd2b 217 else (ret) = ERR_ARG; \
psawant9 6:22ce63eddd2b 218 } while (0)
psawant9 6:22ce63eddd2b 219
psawant9 6:22ce63eddd2b 220 #define TCP_EVENT_SENT(pcb,space,ret) \
psawant9 6:22ce63eddd2b 221 do { \
psawant9 6:22ce63eddd2b 222 if((pcb)->sent != NULL) \
psawant9 6:22ce63eddd2b 223 (ret) = (pcb)->sent((pcb)->callback_arg,(pcb),(space)); \
psawant9 6:22ce63eddd2b 224 else (ret) = ERR_OK; \
psawant9 6:22ce63eddd2b 225 } while (0)
psawant9 6:22ce63eddd2b 226
psawant9 6:22ce63eddd2b 227 #define TCP_EVENT_RECV(pcb,p,err,ret) \
psawant9 6:22ce63eddd2b 228 do { \
psawant9 6:22ce63eddd2b 229 if((pcb)->recv != NULL) { \
psawant9 6:22ce63eddd2b 230 (ret) = (pcb)->recv((pcb)->callback_arg,(pcb),(p),(err));\
psawant9 6:22ce63eddd2b 231 } else { \
psawant9 6:22ce63eddd2b 232 (ret) = tcp_recv_null(NULL, (pcb), (p), (err)); \
psawant9 6:22ce63eddd2b 233 } \
psawant9 6:22ce63eddd2b 234 } while (0)
psawant9 6:22ce63eddd2b 235
psawant9 6:22ce63eddd2b 236 #define TCP_EVENT_CLOSED(pcb,ret) \
psawant9 6:22ce63eddd2b 237 do { \
psawant9 6:22ce63eddd2b 238 if(((pcb)->recv != NULL)) { \
psawant9 6:22ce63eddd2b 239 (ret) = (pcb)->recv((pcb)->callback_arg,(pcb),NULL,ERR_OK);\
psawant9 6:22ce63eddd2b 240 } else { \
psawant9 6:22ce63eddd2b 241 (ret) = ERR_OK; \
psawant9 6:22ce63eddd2b 242 } \
psawant9 6:22ce63eddd2b 243 } while (0)
psawant9 6:22ce63eddd2b 244
psawant9 6:22ce63eddd2b 245 #define TCP_EVENT_CONNECTED(pcb,err,ret) \
psawant9 6:22ce63eddd2b 246 do { \
psawant9 6:22ce63eddd2b 247 if((pcb)->connected != NULL) \
psawant9 6:22ce63eddd2b 248 (ret) = (pcb)->connected((pcb)->callback_arg,(pcb),(err)); \
psawant9 6:22ce63eddd2b 249 else (ret) = ERR_OK; \
psawant9 6:22ce63eddd2b 250 } while (0)
psawant9 6:22ce63eddd2b 251
psawant9 6:22ce63eddd2b 252 #define TCP_EVENT_POLL(pcb,ret) \
psawant9 6:22ce63eddd2b 253 do { \
psawant9 6:22ce63eddd2b 254 if((pcb)->poll != NULL) \
psawant9 6:22ce63eddd2b 255 (ret) = (pcb)->poll((pcb)->callback_arg,(pcb)); \
psawant9 6:22ce63eddd2b 256 else (ret) = ERR_OK; \
psawant9 6:22ce63eddd2b 257 } while (0)
psawant9 6:22ce63eddd2b 258
psawant9 6:22ce63eddd2b 259 #define TCP_EVENT_ERR(errf,arg,err) \
psawant9 6:22ce63eddd2b 260 do { \
psawant9 6:22ce63eddd2b 261 if((errf) != NULL) \
psawant9 6:22ce63eddd2b 262 (errf)((arg),(err)); \
psawant9 6:22ce63eddd2b 263 } while (0)
psawant9 6:22ce63eddd2b 264
psawant9 6:22ce63eddd2b 265 #endif /* LWIP_EVENT_API */
psawant9 6:22ce63eddd2b 266
psawant9 6:22ce63eddd2b 267 /** Enabled extra-check for TCP_OVERSIZE if LWIP_DEBUG is enabled */
psawant9 6:22ce63eddd2b 268 #if TCP_OVERSIZE && defined(LWIP_DEBUG)
psawant9 6:22ce63eddd2b 269 #define TCP_OVERSIZE_DBGCHECK 1
psawant9 6:22ce63eddd2b 270 #else
psawant9 6:22ce63eddd2b 271 #define TCP_OVERSIZE_DBGCHECK 0
psawant9 6:22ce63eddd2b 272 #endif
psawant9 6:22ce63eddd2b 273
psawant9 6:22ce63eddd2b 274 /** Don't generate checksum on copy if CHECKSUM_GEN_TCP is disabled */
psawant9 6:22ce63eddd2b 275 #define TCP_CHECKSUM_ON_COPY (LWIP_CHECKSUM_ON_COPY && CHECKSUM_GEN_TCP)
psawant9 6:22ce63eddd2b 276
psawant9 6:22ce63eddd2b 277 /* This structure represents a TCP segment on the unsent, unacked and ooseq queues */
psawant9 6:22ce63eddd2b 278 struct tcp_seg {
psawant9 6:22ce63eddd2b 279 struct tcp_seg *next; /* used when putting segements on a queue */
psawant9 6:22ce63eddd2b 280 struct pbuf *p; /* buffer containing data + TCP header */
psawant9 6:22ce63eddd2b 281 void *dataptr; /* pointer to the TCP data in the pbuf */
psawant9 6:22ce63eddd2b 282 u16_t len; /* the TCP length of this segment */
psawant9 6:22ce63eddd2b 283 #if TCP_OVERSIZE_DBGCHECK
psawant9 6:22ce63eddd2b 284 u16_t oversize_left; /* Extra bytes available at the end of the last
psawant9 6:22ce63eddd2b 285 pbuf in unsent (used for asserting vs.
psawant9 6:22ce63eddd2b 286 tcp_pcb.unsent_oversized only) */
psawant9 6:22ce63eddd2b 287 #endif /* TCP_OVERSIZE_DBGCHECK */
psawant9 6:22ce63eddd2b 288 #if TCP_CHECKSUM_ON_COPY
psawant9 6:22ce63eddd2b 289 u16_t chksum;
psawant9 6:22ce63eddd2b 290 u8_t chksum_swapped;
psawant9 6:22ce63eddd2b 291 #endif /* TCP_CHECKSUM_ON_COPY */
psawant9 6:22ce63eddd2b 292 u8_t flags;
psawant9 6:22ce63eddd2b 293 #define TF_SEG_OPTS_MSS (u8_t)0x01U /* Include MSS option. */
psawant9 6:22ce63eddd2b 294 #define TF_SEG_OPTS_TS (u8_t)0x02U /* Include timestamp option. */
psawant9 6:22ce63eddd2b 295 #define TF_SEG_DATA_CHECKSUMMED (u8_t)0x04U /* ALL data (not the header) is
psawant9 6:22ce63eddd2b 296 checksummed into 'chksum' */
psawant9 6:22ce63eddd2b 297 struct tcp_hdr *tcphdr; /* the TCP header */
psawant9 6:22ce63eddd2b 298 };
psawant9 6:22ce63eddd2b 299
psawant9 6:22ce63eddd2b 300 #define LWIP_TCP_OPT_LENGTH(flags) \
psawant9 6:22ce63eddd2b 301 (flags & TF_SEG_OPTS_MSS ? 4 : 0) + \
psawant9 6:22ce63eddd2b 302 (flags & TF_SEG_OPTS_TS ? 12 : 0)
psawant9 6:22ce63eddd2b 303
psawant9 6:22ce63eddd2b 304 /** This returns a TCP header option for MSS in an u32_t */
psawant9 6:22ce63eddd2b 305 #define TCP_BUILD_MSS_OPTION(x) (x) = PP_HTONL(((u32_t)2 << 24) | \
psawant9 6:22ce63eddd2b 306 ((u32_t)4 << 16) | \
psawant9 6:22ce63eddd2b 307 (((u32_t)TCP_MSS / 256) << 8) | \
psawant9 6:22ce63eddd2b 308 (TCP_MSS & 255))
psawant9 6:22ce63eddd2b 309
psawant9 6:22ce63eddd2b 310 /* Global variables: */
psawant9 6:22ce63eddd2b 311 extern struct tcp_pcb *tcp_input_pcb;
psawant9 6:22ce63eddd2b 312 extern u32_t tcp_ticks;
psawant9 6:22ce63eddd2b 313
psawant9 6:22ce63eddd2b 314 /* The TCP PCB lists. */
psawant9 6:22ce63eddd2b 315 union tcp_listen_pcbs_t { /* List of all TCP PCBs in LISTEN state. */
psawant9 6:22ce63eddd2b 316 struct tcp_pcb_listen *listen_pcbs;
psawant9 6:22ce63eddd2b 317 struct tcp_pcb *pcbs;
psawant9 6:22ce63eddd2b 318 };
psawant9 6:22ce63eddd2b 319 extern struct tcp_pcb *tcp_bound_pcbs;
psawant9 6:22ce63eddd2b 320 extern union tcp_listen_pcbs_t tcp_listen_pcbs;
psawant9 6:22ce63eddd2b 321 extern struct tcp_pcb *tcp_active_pcbs; /* List of all TCP PCBs that are in a
psawant9 6:22ce63eddd2b 322 state in which they accept or send
psawant9 6:22ce63eddd2b 323 data. */
psawant9 6:22ce63eddd2b 324 extern struct tcp_pcb *tcp_tw_pcbs; /* List of all TCP PCBs in TIME-WAIT. */
psawant9 6:22ce63eddd2b 325
psawant9 6:22ce63eddd2b 326 extern struct tcp_pcb *tcp_tmp_pcb; /* Only used for temporary storage. */
psawant9 6:22ce63eddd2b 327
psawant9 6:22ce63eddd2b 328 /* Axioms about the above lists:
psawant9 6:22ce63eddd2b 329 1) Every TCP PCB that is not CLOSED is in one of the lists.
psawant9 6:22ce63eddd2b 330 2) A PCB is only in one of the lists.
psawant9 6:22ce63eddd2b 331 3) All PCBs in the tcp_listen_pcbs list is in LISTEN state.
psawant9 6:22ce63eddd2b 332 4) All PCBs in the tcp_tw_pcbs list is in TIME-WAIT state.
psawant9 6:22ce63eddd2b 333 */
psawant9 6:22ce63eddd2b 334 /* Define two macros, TCP_REG and TCP_RMV that registers a TCP PCB
psawant9 6:22ce63eddd2b 335 with a PCB list or removes a PCB from a list, respectively. */
psawant9 6:22ce63eddd2b 336 #ifndef TCP_DEBUG_PCB_LISTS
psawant9 6:22ce63eddd2b 337 #define TCP_DEBUG_PCB_LISTS 0
psawant9 6:22ce63eddd2b 338 #endif
psawant9 6:22ce63eddd2b 339 #if TCP_DEBUG_PCB_LISTS
psawant9 6:22ce63eddd2b 340 #define TCP_REG(pcbs, npcb) do {\
psawant9 6:22ce63eddd2b 341 LWIP_DEBUGF(TCP_DEBUG, ("TCP_REG %p local port %d\n", (npcb), (npcb)->local_port)); \
psawant9 6:22ce63eddd2b 342 for(tcp_tmp_pcb = *(pcbs); \
psawant9 6:22ce63eddd2b 343 tcp_tmp_pcb != NULL; \
psawant9 6:22ce63eddd2b 344 tcp_tmp_pcb = tcp_tmp_pcb->next) { \
psawant9 6:22ce63eddd2b 345 LWIP_ASSERT("TCP_REG: already registered\n", tcp_tmp_pcb != (npcb)); \
psawant9 6:22ce63eddd2b 346 } \
psawant9 6:22ce63eddd2b 347 LWIP_ASSERT("TCP_REG: pcb->state != CLOSED", ((pcbs) == &tcp_bound_pcbs) || ((npcb)->state != CLOSED)); \
psawant9 6:22ce63eddd2b 348 (npcb)->next = *(pcbs); \
psawant9 6:22ce63eddd2b 349 LWIP_ASSERT("TCP_REG: npcb->next != npcb", (npcb)->next != (npcb)); \
psawant9 6:22ce63eddd2b 350 *(pcbs) = (npcb); \
psawant9 6:22ce63eddd2b 351 LWIP_ASSERT("TCP_RMV: tcp_pcbs sane", tcp_pcbs_sane()); \
psawant9 6:22ce63eddd2b 352 tcp_timer_needed(); \
psawant9 6:22ce63eddd2b 353 } while(0)
psawant9 6:22ce63eddd2b 354 #define TCP_RMV(pcbs, npcb) do { \
psawant9 6:22ce63eddd2b 355 LWIP_ASSERT("TCP_RMV: pcbs != NULL", *(pcbs) != NULL); \
psawant9 6:22ce63eddd2b 356 LWIP_DEBUGF(TCP_DEBUG, ("TCP_RMV: removing %p from %p\n", (npcb), *(pcbs))); \
psawant9 6:22ce63eddd2b 357 if(*(pcbs) == (npcb)) { \
psawant9 6:22ce63eddd2b 358 *(pcbs) = (*pcbs)->next; \
psawant9 6:22ce63eddd2b 359 } else for(tcp_tmp_pcb = *(pcbs); tcp_tmp_pcb != NULL; tcp_tmp_pcb = tcp_tmp_pcb->next) { \
psawant9 6:22ce63eddd2b 360 if(tcp_tmp_pcb->next == (npcb)) { \
psawant9 6:22ce63eddd2b 361 tcp_tmp_pcb->next = (npcb)->next; \
psawant9 6:22ce63eddd2b 362 break; \
psawant9 6:22ce63eddd2b 363 } \
psawant9 6:22ce63eddd2b 364 } \
psawant9 6:22ce63eddd2b 365 (npcb)->next = NULL; \
psawant9 6:22ce63eddd2b 366 LWIP_ASSERT("TCP_RMV: tcp_pcbs sane", tcp_pcbs_sane()); \
psawant9 6:22ce63eddd2b 367 LWIP_DEBUGF(TCP_DEBUG, ("TCP_RMV: removed %p from %p\n", (npcb), *(pcbs))); \
psawant9 6:22ce63eddd2b 368 } while(0)
psawant9 6:22ce63eddd2b 369
psawant9 6:22ce63eddd2b 370 #else /* LWIP_DEBUG */
psawant9 6:22ce63eddd2b 371
psawant9 6:22ce63eddd2b 372 #define TCP_REG(pcbs, npcb) \
psawant9 6:22ce63eddd2b 373 do { \
psawant9 6:22ce63eddd2b 374 (npcb)->next = *pcbs; \
psawant9 6:22ce63eddd2b 375 *(pcbs) = (npcb); \
psawant9 6:22ce63eddd2b 376 tcp_timer_needed(); \
psawant9 6:22ce63eddd2b 377 } while (0)
psawant9 6:22ce63eddd2b 378
psawant9 6:22ce63eddd2b 379 #define TCP_RMV(pcbs, npcb) \
psawant9 6:22ce63eddd2b 380 do { \
psawant9 6:22ce63eddd2b 381 if(*(pcbs) == (npcb)) { \
psawant9 6:22ce63eddd2b 382 (*(pcbs)) = (*pcbs)->next; \
psawant9 6:22ce63eddd2b 383 } \
psawant9 6:22ce63eddd2b 384 else { \
psawant9 6:22ce63eddd2b 385 for(tcp_tmp_pcb = *pcbs; \
psawant9 6:22ce63eddd2b 386 tcp_tmp_pcb != NULL; \
psawant9 6:22ce63eddd2b 387 tcp_tmp_pcb = tcp_tmp_pcb->next) { \
psawant9 6:22ce63eddd2b 388 if(tcp_tmp_pcb->next == (npcb)) { \
psawant9 6:22ce63eddd2b 389 tcp_tmp_pcb->next = (npcb)->next; \
psawant9 6:22ce63eddd2b 390 break; \
psawant9 6:22ce63eddd2b 391 } \
psawant9 6:22ce63eddd2b 392 } \
psawant9 6:22ce63eddd2b 393 } \
psawant9 6:22ce63eddd2b 394 (npcb)->next = NULL; \
psawant9 6:22ce63eddd2b 395 } while(0)
psawant9 6:22ce63eddd2b 396
psawant9 6:22ce63eddd2b 397 #endif /* LWIP_DEBUG */
psawant9 6:22ce63eddd2b 398
psawant9 6:22ce63eddd2b 399
psawant9 6:22ce63eddd2b 400 /* Internal functions: */
psawant9 6:22ce63eddd2b 401 struct tcp_pcb *tcp_pcb_copy(struct tcp_pcb *pcb);
psawant9 6:22ce63eddd2b 402 void tcp_pcb_purge(struct tcp_pcb *pcb);
psawant9 6:22ce63eddd2b 403 void tcp_pcb_remove(struct tcp_pcb **pcblist, struct tcp_pcb *pcb);
psawant9 6:22ce63eddd2b 404
psawant9 6:22ce63eddd2b 405 void tcp_segs_free(struct tcp_seg *seg);
psawant9 6:22ce63eddd2b 406 void tcp_seg_free(struct tcp_seg *seg);
psawant9 6:22ce63eddd2b 407 struct tcp_seg *tcp_seg_copy(struct tcp_seg *seg);
psawant9 6:22ce63eddd2b 408
psawant9 6:22ce63eddd2b 409 #define tcp_ack(pcb) \
psawant9 6:22ce63eddd2b 410 do { \
psawant9 6:22ce63eddd2b 411 if((pcb)->flags & TF_ACK_DELAY) { \
psawant9 6:22ce63eddd2b 412 (pcb)->flags &= ~TF_ACK_DELAY; \
psawant9 6:22ce63eddd2b 413 (pcb)->flags |= TF_ACK_NOW; \
psawant9 6:22ce63eddd2b 414 } \
psawant9 6:22ce63eddd2b 415 else { \
psawant9 6:22ce63eddd2b 416 (pcb)->flags |= TF_ACK_DELAY; \
psawant9 6:22ce63eddd2b 417 } \
psawant9 6:22ce63eddd2b 418 } while (0)
psawant9 6:22ce63eddd2b 419
psawant9 6:22ce63eddd2b 420 #define tcp_ack_now(pcb) \
psawant9 6:22ce63eddd2b 421 do { \
psawant9 6:22ce63eddd2b 422 (pcb)->flags |= TF_ACK_NOW; \
psawant9 6:22ce63eddd2b 423 } while (0)
psawant9 6:22ce63eddd2b 424
psawant9 6:22ce63eddd2b 425 err_t tcp_send_fin(struct tcp_pcb *pcb);
psawant9 6:22ce63eddd2b 426 err_t tcp_enqueue_flags(struct tcp_pcb *pcb, u8_t flags);
psawant9 6:22ce63eddd2b 427
psawant9 6:22ce63eddd2b 428 void tcp_rexmit_seg(struct tcp_pcb *pcb, struct tcp_seg *seg);
psawant9 6:22ce63eddd2b 429
psawant9 6:22ce63eddd2b 430 void tcp_rst(u32_t seqno, u32_t ackno,
psawant9 6:22ce63eddd2b 431 ip_addr_t *local_ip, ip_addr_t *remote_ip,
psawant9 6:22ce63eddd2b 432 u16_t local_port, u16_t remote_port);
psawant9 6:22ce63eddd2b 433
psawant9 6:22ce63eddd2b 434 u32_t tcp_next_iss(void);
psawant9 6:22ce63eddd2b 435
psawant9 6:22ce63eddd2b 436 void tcp_keepalive(struct tcp_pcb *pcb);
psawant9 6:22ce63eddd2b 437 void tcp_zero_window_probe(struct tcp_pcb *pcb);
psawant9 6:22ce63eddd2b 438
psawant9 6:22ce63eddd2b 439 #if TCP_CALCULATE_EFF_SEND_MSS
psawant9 6:22ce63eddd2b 440 u16_t tcp_eff_send_mss(u16_t sendmss, ip_addr_t *addr);
psawant9 6:22ce63eddd2b 441 #endif /* TCP_CALCULATE_EFF_SEND_MSS */
psawant9 6:22ce63eddd2b 442
psawant9 6:22ce63eddd2b 443 #if LWIP_CALLBACK_API
psawant9 6:22ce63eddd2b 444 err_t tcp_recv_null(void *arg, struct tcp_pcb *pcb, struct pbuf *p, err_t err);
psawant9 6:22ce63eddd2b 445 #endif /* LWIP_CALLBACK_API */
psawant9 6:22ce63eddd2b 446
psawant9 6:22ce63eddd2b 447 #if TCP_DEBUG || TCP_INPUT_DEBUG || TCP_OUTPUT_DEBUG
psawant9 6:22ce63eddd2b 448 void tcp_debug_print(struct tcp_hdr *tcphdr);
psawant9 6:22ce63eddd2b 449 void tcp_debug_print_flags(u8_t flags);
psawant9 6:22ce63eddd2b 450 void tcp_debug_print_state(enum tcp_state s);
psawant9 6:22ce63eddd2b 451 void tcp_debug_print_pcbs(void);
psawant9 6:22ce63eddd2b 452 s16_t tcp_pcbs_sane(void);
psawant9 6:22ce63eddd2b 453 #else
psawant9 6:22ce63eddd2b 454 # define tcp_debug_print(tcphdr)
psawant9 6:22ce63eddd2b 455 # define tcp_debug_print_flags(flags)
psawant9 6:22ce63eddd2b 456 # define tcp_debug_print_state(s)
psawant9 6:22ce63eddd2b 457 # define tcp_debug_print_pcbs()
psawant9 6:22ce63eddd2b 458 # define tcp_pcbs_sane() 1
psawant9 6:22ce63eddd2b 459 #endif /* TCP_DEBUG */
psawant9 6:22ce63eddd2b 460
psawant9 6:22ce63eddd2b 461 /** External function (implemented in timers.c), called when TCP detects
psawant9 6:22ce63eddd2b 462 * that a timer is needed (i.e. active- or time-wait-pcb found). */
psawant9 6:22ce63eddd2b 463 void tcp_timer_needed(void);
psawant9 6:22ce63eddd2b 464
psawant9 6:22ce63eddd2b 465
psawant9 6:22ce63eddd2b 466 #ifdef __cplusplus
psawant9 6:22ce63eddd2b 467 }
psawant9 6:22ce63eddd2b 468 #endif
psawant9 6:22ce63eddd2b 469
psawant9 6:22ce63eddd2b 470 #endif /* LWIP_TCP */
psawant9 6:22ce63eddd2b 471
psawant9 6:22ce63eddd2b 472 #endif /* __LWIP_TCP_H__ */