ZG2100 Network interface source

Committer:
donatien
Date:
Fri Jul 09 15:37:23 2010 +0000
Revision:
0:b802fc31f1db
Child:
1:3a7c15057192

        

Who changed what in which revision?

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