CK Sin / Mbed 2 deprecated Ethernetwebsocket

Ethernetwebsoc

Dependencies:   C12832_lcd LM75B WebSocketClient mbed-rtos mbed Socket lwip-eth lwip-sys lwip

EthernetInterface/lwip/include/lwip/tcp_impl.h@0:0ed2a7c7190c, 2013-05-31 (annotated)

Committer:
GordonSin
Date:
Fri May 31 04:09:54 2013 +0000
Revision:
0:0ed2a7c7190c
31/5/2013;

Who changed what in which revision?

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