mbed Phone Platform

Dependencies:   ulaw mbed ConfigFile

Committer:
okini3939
Date:
Sun Dec 26 15:49:07 2010 +0000
Revision:
1:0f82c574096f

        

Who changed what in which revision?

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