Brandon Fictorie / Mbed 2 deprecated BF_Websocket

Dependencies:   mbed

Committer:
bfictorie
Date:
Sun Mar 25 17:26:30 2012 +0000
Revision:
0:8cdad1c73e8e

        

Who changed what in which revision?

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