xref: /minix3/minix/lib/liblwip/dist/src/include/lwip/tcp.h (revision 5d5fbe79c1b60734f34c69330aec5496644e8651)
1*5d5fbe79SDavid van Moolenbroek /**
2*5d5fbe79SDavid van Moolenbroek  * @file
3*5d5fbe79SDavid van Moolenbroek  * TCP API (to be used from TCPIP thread)\n
4*5d5fbe79SDavid van Moolenbroek  * See also @ref tcp_raw
5*5d5fbe79SDavid van Moolenbroek  */
6*5d5fbe79SDavid van Moolenbroek 
7*5d5fbe79SDavid van Moolenbroek /*
8*5d5fbe79SDavid van Moolenbroek  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
9*5d5fbe79SDavid van Moolenbroek  * All rights reserved.
10*5d5fbe79SDavid van Moolenbroek  *
11*5d5fbe79SDavid van Moolenbroek  * Redistribution and use in source and binary forms, with or without modification,
12*5d5fbe79SDavid van Moolenbroek  * are permitted provided that the following conditions are met:
13*5d5fbe79SDavid van Moolenbroek  *
14*5d5fbe79SDavid van Moolenbroek  * 1. Redistributions of source code must retain the above copyright notice,
15*5d5fbe79SDavid van Moolenbroek  *    this list of conditions and the following disclaimer.
16*5d5fbe79SDavid van Moolenbroek  * 2. Redistributions in binary form must reproduce the above copyright notice,
17*5d5fbe79SDavid van Moolenbroek  *    this list of conditions and the following disclaimer in the documentation
18*5d5fbe79SDavid van Moolenbroek  *    and/or other materials provided with the distribution.
19*5d5fbe79SDavid van Moolenbroek  * 3. The name of the author may not be used to endorse or promote products
20*5d5fbe79SDavid van Moolenbroek  *    derived from this software without specific prior written permission.
21*5d5fbe79SDavid van Moolenbroek  *
22*5d5fbe79SDavid van Moolenbroek  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
23*5d5fbe79SDavid van Moolenbroek  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
24*5d5fbe79SDavid van Moolenbroek  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
25*5d5fbe79SDavid van Moolenbroek  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26*5d5fbe79SDavid van Moolenbroek  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
27*5d5fbe79SDavid van Moolenbroek  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28*5d5fbe79SDavid van Moolenbroek  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29*5d5fbe79SDavid van Moolenbroek  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
30*5d5fbe79SDavid van Moolenbroek  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
31*5d5fbe79SDavid van Moolenbroek  * OF SUCH DAMAGE.
32*5d5fbe79SDavid van Moolenbroek  *
33*5d5fbe79SDavid van Moolenbroek  * This file is part of the lwIP TCP/IP stack.
34*5d5fbe79SDavid van Moolenbroek  *
35*5d5fbe79SDavid van Moolenbroek  * Author: Adam Dunkels <adam@sics.se>
36*5d5fbe79SDavid van Moolenbroek  *
37*5d5fbe79SDavid van Moolenbroek  */
38*5d5fbe79SDavid van Moolenbroek #ifndef LWIP_HDR_TCP_H
39*5d5fbe79SDavid van Moolenbroek #define LWIP_HDR_TCP_H
40*5d5fbe79SDavid van Moolenbroek 
41*5d5fbe79SDavid van Moolenbroek #include "lwip/opt.h"
42*5d5fbe79SDavid van Moolenbroek 
43*5d5fbe79SDavid van Moolenbroek #if LWIP_TCP /* don't build if not configured for use in lwipopts.h */
44*5d5fbe79SDavid van Moolenbroek 
45*5d5fbe79SDavid van Moolenbroek #include "lwip/mem.h"
46*5d5fbe79SDavid van Moolenbroek #include "lwip/pbuf.h"
47*5d5fbe79SDavid van Moolenbroek #include "lwip/ip.h"
48*5d5fbe79SDavid van Moolenbroek #include "lwip/icmp.h"
49*5d5fbe79SDavid van Moolenbroek #include "lwip/err.h"
50*5d5fbe79SDavid van Moolenbroek #include "lwip/ip6.h"
51*5d5fbe79SDavid van Moolenbroek #include "lwip/ip6_addr.h"
52*5d5fbe79SDavid van Moolenbroek 
53*5d5fbe79SDavid van Moolenbroek #ifdef __cplusplus
54*5d5fbe79SDavid van Moolenbroek extern "C" {
55*5d5fbe79SDavid van Moolenbroek #endif
56*5d5fbe79SDavid van Moolenbroek 
57*5d5fbe79SDavid van Moolenbroek struct tcp_pcb;
58*5d5fbe79SDavid van Moolenbroek 
59*5d5fbe79SDavid van Moolenbroek /** Function prototype for tcp accept callback functions. Called when a new
60*5d5fbe79SDavid van Moolenbroek  * connection can be accepted on a listening pcb.
61*5d5fbe79SDavid van Moolenbroek  *
62*5d5fbe79SDavid van Moolenbroek  * @param arg Additional argument to pass to the callback function (@see tcp_arg())
63*5d5fbe79SDavid van Moolenbroek  * @param newpcb The new connection pcb
64*5d5fbe79SDavid van Moolenbroek  * @param err An error code if there has been an error accepting.
65*5d5fbe79SDavid van Moolenbroek  *            Only return ERR_ABRT if you have called tcp_abort from within the
66*5d5fbe79SDavid van Moolenbroek  *            callback function!
67*5d5fbe79SDavid van Moolenbroek  */
68*5d5fbe79SDavid van Moolenbroek typedef err_t (*tcp_accept_fn)(void *arg, struct tcp_pcb *newpcb, err_t err);
69*5d5fbe79SDavid van Moolenbroek 
70*5d5fbe79SDavid van Moolenbroek /** Function prototype for tcp receive callback functions. Called when data has
71*5d5fbe79SDavid van Moolenbroek  * been received.
72*5d5fbe79SDavid van Moolenbroek  *
73*5d5fbe79SDavid van Moolenbroek  * @param arg Additional argument to pass to the callback function (@see tcp_arg())
74*5d5fbe79SDavid van Moolenbroek  * @param tpcb The connection pcb which received data
75*5d5fbe79SDavid van Moolenbroek  * @param p The received data (or NULL when the connection has been closed!)
76*5d5fbe79SDavid van Moolenbroek  * @param err An error code if there has been an error receiving
77*5d5fbe79SDavid van Moolenbroek  *            Only return ERR_ABRT if you have called tcp_abort from within the
78*5d5fbe79SDavid van Moolenbroek  *            callback function!
79*5d5fbe79SDavid van Moolenbroek  */
80*5d5fbe79SDavid van Moolenbroek typedef err_t (*tcp_recv_fn)(void *arg, struct tcp_pcb *tpcb,
81*5d5fbe79SDavid van Moolenbroek                              struct pbuf *p, err_t err);
82*5d5fbe79SDavid van Moolenbroek 
83*5d5fbe79SDavid van Moolenbroek /** Function prototype for tcp sent callback functions. Called when sent data has
84*5d5fbe79SDavid van Moolenbroek  * been acknowledged by the remote side. Use it to free corresponding resources.
85*5d5fbe79SDavid van Moolenbroek  * This also means that the pcb has now space available to send new data.
86*5d5fbe79SDavid van Moolenbroek  *
87*5d5fbe79SDavid van Moolenbroek  * @param arg Additional argument to pass to the callback function (@see tcp_arg())
88*5d5fbe79SDavid van Moolenbroek  * @param tpcb The connection pcb for which data has been acknowledged
89*5d5fbe79SDavid van Moolenbroek  * @param len The amount of bytes acknowledged
90*5d5fbe79SDavid van Moolenbroek  * @return ERR_OK: try to send some data by calling tcp_output
91*5d5fbe79SDavid van Moolenbroek  *            Only return ERR_ABRT if you have called tcp_abort from within the
92*5d5fbe79SDavid van Moolenbroek  *            callback function!
93*5d5fbe79SDavid van Moolenbroek  */
94*5d5fbe79SDavid van Moolenbroek typedef err_t (*tcp_sent_fn)(void *arg, struct tcp_pcb *tpcb,
95*5d5fbe79SDavid van Moolenbroek                               u16_t len);
96*5d5fbe79SDavid van Moolenbroek 
97*5d5fbe79SDavid van Moolenbroek /** Function prototype for tcp poll callback functions. Called periodically as
98*5d5fbe79SDavid van Moolenbroek  * specified by @see tcp_poll.
99*5d5fbe79SDavid van Moolenbroek  *
100*5d5fbe79SDavid van Moolenbroek  * @param arg Additional argument to pass to the callback function (@see tcp_arg())
101*5d5fbe79SDavid van Moolenbroek  * @param tpcb tcp pcb
102*5d5fbe79SDavid van Moolenbroek  * @return ERR_OK: try to send some data by calling tcp_output
103*5d5fbe79SDavid van Moolenbroek  *            Only return ERR_ABRT if you have called tcp_abort from within the
104*5d5fbe79SDavid van Moolenbroek  *            callback function!
105*5d5fbe79SDavid van Moolenbroek  */
106*5d5fbe79SDavid van Moolenbroek typedef err_t (*tcp_poll_fn)(void *arg, struct tcp_pcb *tpcb);
107*5d5fbe79SDavid van Moolenbroek 
108*5d5fbe79SDavid van Moolenbroek /** Function prototype for tcp error callback functions. Called when the pcb
109*5d5fbe79SDavid van Moolenbroek  * receives a RST or is unexpectedly closed for any other reason.
110*5d5fbe79SDavid van Moolenbroek  *
111*5d5fbe79SDavid van Moolenbroek  * @note The corresponding pcb is already freed when this callback is called!
112*5d5fbe79SDavid van Moolenbroek  *
113*5d5fbe79SDavid van Moolenbroek  * @param arg Additional argument to pass to the callback function (@see tcp_arg())
114*5d5fbe79SDavid van Moolenbroek  * @param err Error code to indicate why the pcb has been closed
115*5d5fbe79SDavid van Moolenbroek  *            ERR_ABRT: aborted through tcp_abort or by a TCP timer
116*5d5fbe79SDavid van Moolenbroek  *            ERR_RST: the connection was reset by the remote host
117*5d5fbe79SDavid van Moolenbroek  */
118*5d5fbe79SDavid van Moolenbroek typedef void  (*tcp_err_fn)(void *arg, err_t err);
119*5d5fbe79SDavid van Moolenbroek 
120*5d5fbe79SDavid van Moolenbroek /** Function prototype for tcp connected callback functions. Called when a pcb
121*5d5fbe79SDavid van Moolenbroek  * is connected to the remote side after initiating a connection attempt by
122*5d5fbe79SDavid van Moolenbroek  * calling tcp_connect().
123*5d5fbe79SDavid van Moolenbroek  *
124*5d5fbe79SDavid van Moolenbroek  * @param arg Additional argument to pass to the callback function (@see tcp_arg())
125*5d5fbe79SDavid van Moolenbroek  * @param tpcb The connection pcb which is connected
126*5d5fbe79SDavid van Moolenbroek  * @param err An unused error code, always ERR_OK currently ;-) @todo!
127*5d5fbe79SDavid van Moolenbroek  *            Only return ERR_ABRT if you have called tcp_abort from within the
128*5d5fbe79SDavid van Moolenbroek  *            callback function!
129*5d5fbe79SDavid van Moolenbroek  *
130*5d5fbe79SDavid van Moolenbroek  * @note When a connection attempt fails, the error callback is currently called!
131*5d5fbe79SDavid van Moolenbroek  */
132*5d5fbe79SDavid van Moolenbroek typedef err_t (*tcp_connected_fn)(void *arg, struct tcp_pcb *tpcb, err_t err);
133*5d5fbe79SDavid van Moolenbroek 
134*5d5fbe79SDavid van Moolenbroek #if LWIP_WND_SCALE
135*5d5fbe79SDavid van Moolenbroek #define RCV_WND_SCALE(pcb, wnd) (((wnd) >> (pcb)->rcv_scale))
136*5d5fbe79SDavid van Moolenbroek #define SND_WND_SCALE(pcb, wnd) (((wnd) << (pcb)->snd_scale))
137*5d5fbe79SDavid van Moolenbroek #define TCPWND16(x)             ((u16_t)LWIP_MIN((x), 0xFFFF))
138*5d5fbe79SDavid van Moolenbroek #define TCP_WND_MAX(pcb)        ((tcpwnd_size_t)(((pcb)->flags & TF_WND_SCALE) ? TCP_WND : TCPWND16(TCP_WND)))
139*5d5fbe79SDavid van Moolenbroek typedef u32_t tcpwnd_size_t;
140*5d5fbe79SDavid van Moolenbroek #else
141*5d5fbe79SDavid van Moolenbroek #define RCV_WND_SCALE(pcb, wnd) (wnd)
142*5d5fbe79SDavid van Moolenbroek #define SND_WND_SCALE(pcb, wnd) (wnd)
143*5d5fbe79SDavid van Moolenbroek #define TCPWND16(x)             (x)
144*5d5fbe79SDavid van Moolenbroek #define TCP_WND_MAX(pcb)        TCP_WND
145*5d5fbe79SDavid van Moolenbroek typedef u16_t tcpwnd_size_t;
146*5d5fbe79SDavid van Moolenbroek #endif
147*5d5fbe79SDavid van Moolenbroek 
148*5d5fbe79SDavid van Moolenbroek #if LWIP_WND_SCALE || TCP_LISTEN_BACKLOG || LWIP_TCP_TIMESTAMPS
149*5d5fbe79SDavid van Moolenbroek typedef u16_t tcpflags_t;
150*5d5fbe79SDavid van Moolenbroek #else
151*5d5fbe79SDavid van Moolenbroek typedef u8_t tcpflags_t;
152*5d5fbe79SDavid van Moolenbroek #endif
153*5d5fbe79SDavid van Moolenbroek 
154*5d5fbe79SDavid van Moolenbroek enum tcp_state {
155*5d5fbe79SDavid van Moolenbroek   CLOSED      = 0,
156*5d5fbe79SDavid van Moolenbroek   LISTEN      = 1,
157*5d5fbe79SDavid van Moolenbroek   SYN_SENT    = 2,
158*5d5fbe79SDavid van Moolenbroek   SYN_RCVD    = 3,
159*5d5fbe79SDavid van Moolenbroek   ESTABLISHED = 4,
160*5d5fbe79SDavid van Moolenbroek   FIN_WAIT_1  = 5,
161*5d5fbe79SDavid van Moolenbroek   FIN_WAIT_2  = 6,
162*5d5fbe79SDavid van Moolenbroek   CLOSE_WAIT  = 7,
163*5d5fbe79SDavid van Moolenbroek   CLOSING     = 8,
164*5d5fbe79SDavid van Moolenbroek   LAST_ACK    = 9,
165*5d5fbe79SDavid van Moolenbroek   TIME_WAIT   = 10
166*5d5fbe79SDavid van Moolenbroek };
167*5d5fbe79SDavid van Moolenbroek 
168*5d5fbe79SDavid van Moolenbroek /**
169*5d5fbe79SDavid van Moolenbroek  * members common to struct tcp_pcb and struct tcp_listen_pcb
170*5d5fbe79SDavid van Moolenbroek  */
171*5d5fbe79SDavid van Moolenbroek #define TCP_PCB_COMMON(type) \
172*5d5fbe79SDavid van Moolenbroek   type *next; /* for the linked list */ \
173*5d5fbe79SDavid van Moolenbroek   void *callback_arg; \
174*5d5fbe79SDavid van Moolenbroek   enum tcp_state state; /* TCP state */ \
175*5d5fbe79SDavid van Moolenbroek   u8_t prio; \
176*5d5fbe79SDavid van Moolenbroek   /* ports are in host byte order */ \
177*5d5fbe79SDavid van Moolenbroek   u16_t local_port
178*5d5fbe79SDavid van Moolenbroek 
179*5d5fbe79SDavid van Moolenbroek 
180*5d5fbe79SDavid van Moolenbroek /** the TCP protocol control block for listening pcbs */
181*5d5fbe79SDavid van Moolenbroek struct tcp_pcb_listen {
182*5d5fbe79SDavid van Moolenbroek /** Common members of all PCB types */
183*5d5fbe79SDavid van Moolenbroek   IP_PCB;
184*5d5fbe79SDavid van Moolenbroek /** Protocol specific PCB members */
185*5d5fbe79SDavid van Moolenbroek   TCP_PCB_COMMON(struct tcp_pcb_listen);
186*5d5fbe79SDavid van Moolenbroek 
187*5d5fbe79SDavid van Moolenbroek #if LWIP_CALLBACK_API
188*5d5fbe79SDavid van Moolenbroek   /* Function to call when a listener has been connected. */
189*5d5fbe79SDavid van Moolenbroek   tcp_accept_fn accept;
190*5d5fbe79SDavid van Moolenbroek #endif /* LWIP_CALLBACK_API */
191*5d5fbe79SDavid van Moolenbroek 
192*5d5fbe79SDavid van Moolenbroek #if TCP_LISTEN_BACKLOG
193*5d5fbe79SDavid van Moolenbroek   u8_t backlog;
194*5d5fbe79SDavid van Moolenbroek   u8_t accepts_pending;
195*5d5fbe79SDavid van Moolenbroek #endif /* TCP_LISTEN_BACKLOG */
196*5d5fbe79SDavid van Moolenbroek };
197*5d5fbe79SDavid van Moolenbroek 
198*5d5fbe79SDavid van Moolenbroek 
199*5d5fbe79SDavid van Moolenbroek /** the TCP protocol control block */
200*5d5fbe79SDavid van Moolenbroek struct tcp_pcb {
201*5d5fbe79SDavid van Moolenbroek /** common PCB members */
202*5d5fbe79SDavid van Moolenbroek   IP_PCB;
203*5d5fbe79SDavid van Moolenbroek /** protocol specific PCB members */
204*5d5fbe79SDavid van Moolenbroek   TCP_PCB_COMMON(struct tcp_pcb);
205*5d5fbe79SDavid van Moolenbroek 
206*5d5fbe79SDavid van Moolenbroek   /* ports are in host byte order */
207*5d5fbe79SDavid van Moolenbroek   u16_t remote_port;
208*5d5fbe79SDavid van Moolenbroek 
209*5d5fbe79SDavid van Moolenbroek   tcpflags_t flags;
210*5d5fbe79SDavid van Moolenbroek #define TF_ACK_DELAY   0x01U   /* Delayed ACK. */
211*5d5fbe79SDavid van Moolenbroek #define TF_ACK_NOW     0x02U   /* Immediate ACK. */
212*5d5fbe79SDavid van Moolenbroek #define TF_INFR        0x04U   /* In fast recovery. */
213*5d5fbe79SDavid van Moolenbroek #define TF_CLOSEPEND   0x08U   /* If this is set, tcp_close failed to enqueue the FIN (retried in tcp_tmr) */
214*5d5fbe79SDavid van Moolenbroek #define TF_RXCLOSED    0x10U   /* rx closed by tcp_shutdown */
215*5d5fbe79SDavid van Moolenbroek #define TF_FIN         0x20U   /* Connection was closed locally (FIN segment enqueued). */
216*5d5fbe79SDavid van Moolenbroek #define TF_NODELAY     0x40U   /* Disable Nagle algorithm */
217*5d5fbe79SDavid van Moolenbroek #define TF_NAGLEMEMERR 0x80U   /* nagle enabled, memerr, try to output to prevent delayed ACK to happen */
218*5d5fbe79SDavid van Moolenbroek #if LWIP_WND_SCALE
219*5d5fbe79SDavid van Moolenbroek #define TF_WND_SCALE   0x0100U /* Window Scale option enabled */
220*5d5fbe79SDavid van Moolenbroek #endif
221*5d5fbe79SDavid van Moolenbroek #if TCP_LISTEN_BACKLOG
222*5d5fbe79SDavid van Moolenbroek #define TF_BACKLOGPEND 0x0200U /* If this is set, a connection pcb has increased the backlog on its listener */
223*5d5fbe79SDavid van Moolenbroek #endif
224*5d5fbe79SDavid van Moolenbroek #if LWIP_TCP_TIMESTAMPS
225*5d5fbe79SDavid van Moolenbroek #define TF_TIMESTAMP   0x0400U   /* Timestamp option enabled */
226*5d5fbe79SDavid van Moolenbroek #endif
227*5d5fbe79SDavid van Moolenbroek 
228*5d5fbe79SDavid van Moolenbroek   /* the rest of the fields are in host byte order
229*5d5fbe79SDavid van Moolenbroek      as we have to do some math with them */
230*5d5fbe79SDavid van Moolenbroek 
231*5d5fbe79SDavid van Moolenbroek   /* Timers */
232*5d5fbe79SDavid van Moolenbroek   u8_t polltmr, pollinterval;
233*5d5fbe79SDavid van Moolenbroek   u8_t last_timer;
234*5d5fbe79SDavid van Moolenbroek   u32_t tmr;
235*5d5fbe79SDavid van Moolenbroek 
236*5d5fbe79SDavid van Moolenbroek   /* receiver variables */
237*5d5fbe79SDavid van Moolenbroek   u32_t rcv_nxt;   /* next seqno expected */
238*5d5fbe79SDavid van Moolenbroek   tcpwnd_size_t rcv_wnd;   /* receiver window available */
239*5d5fbe79SDavid van Moolenbroek   tcpwnd_size_t rcv_ann_wnd; /* receiver window to announce */
240*5d5fbe79SDavid van Moolenbroek   u32_t rcv_ann_right_edge; /* announced right edge of window */
241*5d5fbe79SDavid van Moolenbroek 
242*5d5fbe79SDavid van Moolenbroek   /* Retransmission timer. */
243*5d5fbe79SDavid van Moolenbroek   s16_t rtime;
244*5d5fbe79SDavid van Moolenbroek 
245*5d5fbe79SDavid van Moolenbroek   u16_t mss;   /* maximum segment size */
246*5d5fbe79SDavid van Moolenbroek 
247*5d5fbe79SDavid van Moolenbroek   /* RTT (round trip time) estimation variables */
248*5d5fbe79SDavid van Moolenbroek   u32_t rttest; /* RTT estimate in 500ms ticks */
249*5d5fbe79SDavid van Moolenbroek   u32_t rtseq;  /* sequence number being timed */
250*5d5fbe79SDavid van Moolenbroek   s16_t sa, sv; /* @todo document this */
251*5d5fbe79SDavid van Moolenbroek 
252*5d5fbe79SDavid van Moolenbroek   s16_t rto;    /* retransmission time-out */
253*5d5fbe79SDavid van Moolenbroek   u8_t nrtx;    /* number of retransmissions */
254*5d5fbe79SDavid van Moolenbroek 
255*5d5fbe79SDavid van Moolenbroek   /* fast retransmit/recovery */
256*5d5fbe79SDavid van Moolenbroek   u8_t dupacks;
257*5d5fbe79SDavid van Moolenbroek   u32_t lastack; /* Highest acknowledged seqno. */
258*5d5fbe79SDavid van Moolenbroek 
259*5d5fbe79SDavid van Moolenbroek   /* congestion avoidance/control variables */
260*5d5fbe79SDavid van Moolenbroek   tcpwnd_size_t cwnd;
261*5d5fbe79SDavid van Moolenbroek   tcpwnd_size_t ssthresh;
262*5d5fbe79SDavid van Moolenbroek 
263*5d5fbe79SDavid van Moolenbroek   /* sender variables */
264*5d5fbe79SDavid van Moolenbroek   u32_t snd_nxt;   /* next new seqno to be sent */
265*5d5fbe79SDavid van Moolenbroek   u32_t snd_wl1, snd_wl2; /* Sequence and acknowledgement numbers of last
266*5d5fbe79SDavid van Moolenbroek                              window update. */
267*5d5fbe79SDavid van Moolenbroek   u32_t snd_lbb;       /* Sequence number of next byte to be buffered. */
268*5d5fbe79SDavid van Moolenbroek   tcpwnd_size_t snd_wnd;   /* sender window */
269*5d5fbe79SDavid van Moolenbroek   tcpwnd_size_t snd_wnd_max; /* the maximum sender window announced by the remote host */
270*5d5fbe79SDavid van Moolenbroek 
271*5d5fbe79SDavid van Moolenbroek   tcpwnd_size_t snd_buf;   /* Available buffer space for sending (in bytes). */
272*5d5fbe79SDavid van Moolenbroek #define TCP_SNDQUEUELEN_OVERFLOW (0xffffU-3)
273*5d5fbe79SDavid van Moolenbroek   u16_t snd_queuelen; /* Number of pbufs currently in the send buffer. */
274*5d5fbe79SDavid van Moolenbroek 
275*5d5fbe79SDavid van Moolenbroek #if TCP_OVERSIZE
276*5d5fbe79SDavid van Moolenbroek   /* Extra bytes available at the end of the last pbuf in unsent. */
277*5d5fbe79SDavid van Moolenbroek   u16_t unsent_oversize;
278*5d5fbe79SDavid van Moolenbroek #endif /* TCP_OVERSIZE */
279*5d5fbe79SDavid van Moolenbroek 
280*5d5fbe79SDavid van Moolenbroek   /* These are ordered by sequence number: */
281*5d5fbe79SDavid van Moolenbroek   struct tcp_seg *unsent;   /* Unsent (queued) segments. */
282*5d5fbe79SDavid van Moolenbroek   struct tcp_seg *unacked;  /* Sent but unacknowledged segments. */
283*5d5fbe79SDavid van Moolenbroek #if TCP_QUEUE_OOSEQ
284*5d5fbe79SDavid van Moolenbroek   struct tcp_seg *ooseq;    /* Received out of sequence segments. */
285*5d5fbe79SDavid van Moolenbroek #endif /* TCP_QUEUE_OOSEQ */
286*5d5fbe79SDavid van Moolenbroek 
287*5d5fbe79SDavid van Moolenbroek   struct pbuf *refused_data; /* Data previously received but not yet taken by upper layer */
288*5d5fbe79SDavid van Moolenbroek 
289*5d5fbe79SDavid van Moolenbroek #if LWIP_CALLBACK_API || TCP_LISTEN_BACKLOG
290*5d5fbe79SDavid van Moolenbroek   struct tcp_pcb_listen* listener;
291*5d5fbe79SDavid van Moolenbroek #endif /* LWIP_CALLBACK_API || TCP_LISTEN_BACKLOG */
292*5d5fbe79SDavid van Moolenbroek 
293*5d5fbe79SDavid van Moolenbroek #if LWIP_CALLBACK_API
294*5d5fbe79SDavid van Moolenbroek   /* Function to be called when more send buffer space is available. */
295*5d5fbe79SDavid van Moolenbroek   tcp_sent_fn sent;
296*5d5fbe79SDavid van Moolenbroek   /* Function to be called when (in-sequence) data has arrived. */
297*5d5fbe79SDavid van Moolenbroek   tcp_recv_fn recv;
298*5d5fbe79SDavid van Moolenbroek   /* Function to be called when a connection has been set up. */
299*5d5fbe79SDavid van Moolenbroek   tcp_connected_fn connected;
300*5d5fbe79SDavid van Moolenbroek   /* Function which is called periodically. */
301*5d5fbe79SDavid van Moolenbroek   tcp_poll_fn poll;
302*5d5fbe79SDavid van Moolenbroek   /* Function to be called whenever a fatal error occurs. */
303*5d5fbe79SDavid van Moolenbroek   tcp_err_fn errf;
304*5d5fbe79SDavid van Moolenbroek #endif /* LWIP_CALLBACK_API */
305*5d5fbe79SDavid van Moolenbroek 
306*5d5fbe79SDavid van Moolenbroek #if LWIP_TCP_TIMESTAMPS
307*5d5fbe79SDavid van Moolenbroek   u32_t ts_lastacksent;
308*5d5fbe79SDavid van Moolenbroek   u32_t ts_recent;
309*5d5fbe79SDavid van Moolenbroek #endif /* LWIP_TCP_TIMESTAMPS */
310*5d5fbe79SDavid van Moolenbroek 
311*5d5fbe79SDavid van Moolenbroek   /* idle time before KEEPALIVE is sent */
312*5d5fbe79SDavid van Moolenbroek   u32_t keep_idle;
313*5d5fbe79SDavid van Moolenbroek #if LWIP_TCP_KEEPALIVE
314*5d5fbe79SDavid van Moolenbroek   u32_t keep_intvl;
315*5d5fbe79SDavid van Moolenbroek   u32_t keep_cnt;
316*5d5fbe79SDavid van Moolenbroek #endif /* LWIP_TCP_KEEPALIVE */
317*5d5fbe79SDavid van Moolenbroek 
318*5d5fbe79SDavid van Moolenbroek   /* Persist timer counter */
319*5d5fbe79SDavid van Moolenbroek   u8_t persist_cnt;
320*5d5fbe79SDavid van Moolenbroek   /* Persist timer back-off */
321*5d5fbe79SDavid van Moolenbroek   u8_t persist_backoff;
322*5d5fbe79SDavid van Moolenbroek 
323*5d5fbe79SDavid van Moolenbroek   /* KEEPALIVE counter */
324*5d5fbe79SDavid van Moolenbroek   u8_t keep_cnt_sent;
325*5d5fbe79SDavid van Moolenbroek 
326*5d5fbe79SDavid van Moolenbroek #if LWIP_WND_SCALE
327*5d5fbe79SDavid van Moolenbroek   u8_t snd_scale;
328*5d5fbe79SDavid van Moolenbroek   u8_t rcv_scale;
329*5d5fbe79SDavid van Moolenbroek #endif
330*5d5fbe79SDavid van Moolenbroek };
331*5d5fbe79SDavid van Moolenbroek 
332*5d5fbe79SDavid van Moolenbroek #if LWIP_EVENT_API
333*5d5fbe79SDavid van Moolenbroek 
334*5d5fbe79SDavid van Moolenbroek enum lwip_event {
335*5d5fbe79SDavid van Moolenbroek   LWIP_EVENT_ACCEPT,
336*5d5fbe79SDavid van Moolenbroek   LWIP_EVENT_SENT,
337*5d5fbe79SDavid van Moolenbroek   LWIP_EVENT_RECV,
338*5d5fbe79SDavid van Moolenbroek   LWIP_EVENT_CONNECTED,
339*5d5fbe79SDavid van Moolenbroek   LWIP_EVENT_POLL,
340*5d5fbe79SDavid van Moolenbroek   LWIP_EVENT_ERR
341*5d5fbe79SDavid van Moolenbroek };
342*5d5fbe79SDavid van Moolenbroek 
343*5d5fbe79SDavid van Moolenbroek err_t lwip_tcp_event(void *arg, struct tcp_pcb *pcb,
344*5d5fbe79SDavid van Moolenbroek          enum lwip_event,
345*5d5fbe79SDavid van Moolenbroek          struct pbuf *p,
346*5d5fbe79SDavid van Moolenbroek          u16_t size,
347*5d5fbe79SDavid van Moolenbroek          err_t err);
348*5d5fbe79SDavid van Moolenbroek 
349*5d5fbe79SDavid van Moolenbroek #endif /* LWIP_EVENT_API */
350*5d5fbe79SDavid van Moolenbroek 
351*5d5fbe79SDavid van Moolenbroek /* Application program's interface: */
352*5d5fbe79SDavid van Moolenbroek struct tcp_pcb * tcp_new     (void);
353*5d5fbe79SDavid van Moolenbroek struct tcp_pcb * tcp_new_ip_type (u8_t type);
354*5d5fbe79SDavid van Moolenbroek 
355*5d5fbe79SDavid van Moolenbroek void             tcp_arg     (struct tcp_pcb *pcb, void *arg);
356*5d5fbe79SDavid van Moolenbroek #if LWIP_CALLBACK_API
357*5d5fbe79SDavid van Moolenbroek void             tcp_recv    (struct tcp_pcb *pcb, tcp_recv_fn recv);
358*5d5fbe79SDavid van Moolenbroek void             tcp_sent    (struct tcp_pcb *pcb, tcp_sent_fn sent);
359*5d5fbe79SDavid van Moolenbroek void             tcp_err     (struct tcp_pcb *pcb, tcp_err_fn err);
360*5d5fbe79SDavid van Moolenbroek void             tcp_accept  (struct tcp_pcb *pcb, tcp_accept_fn accept);
361*5d5fbe79SDavid van Moolenbroek #endif /* LWIP_CALLBACK_API */
362*5d5fbe79SDavid van Moolenbroek void             tcp_poll    (struct tcp_pcb *pcb, tcp_poll_fn poll, u8_t interval);
363*5d5fbe79SDavid van Moolenbroek 
364*5d5fbe79SDavid van Moolenbroek #if LWIP_TCP_TIMESTAMPS
365*5d5fbe79SDavid van Moolenbroek #define          tcp_mss(pcb)             (((pcb)->flags & TF_TIMESTAMP) ? ((pcb)->mss - 12)  : (pcb)->mss)
366*5d5fbe79SDavid van Moolenbroek #else /* LWIP_TCP_TIMESTAMPS */
367*5d5fbe79SDavid van Moolenbroek #define          tcp_mss(pcb)             ((pcb)->mss)
368*5d5fbe79SDavid van Moolenbroek #endif /* LWIP_TCP_TIMESTAMPS */
369*5d5fbe79SDavid van Moolenbroek #define          tcp_sndbuf(pcb)          (TCPWND16((pcb)->snd_buf))
370*5d5fbe79SDavid van Moolenbroek #define          tcp_sndqueuelen(pcb)     ((pcb)->snd_queuelen)
371*5d5fbe79SDavid van Moolenbroek /** @ingroup tcp_raw */
372*5d5fbe79SDavid van Moolenbroek #define          tcp_nagle_disable(pcb)   ((pcb)->flags |= TF_NODELAY)
373*5d5fbe79SDavid van Moolenbroek /** @ingroup tcp_raw */
374*5d5fbe79SDavid van Moolenbroek #define          tcp_nagle_enable(pcb)    ((pcb)->flags = (tcpflags_t)((pcb)->flags & ~TF_NODELAY))
375*5d5fbe79SDavid van Moolenbroek /** @ingroup tcp_raw */
376*5d5fbe79SDavid van Moolenbroek #define          tcp_nagle_disabled(pcb)  (((pcb)->flags & TF_NODELAY) != 0)
377*5d5fbe79SDavid van Moolenbroek 
378*5d5fbe79SDavid van Moolenbroek #if TCP_LISTEN_BACKLOG
379*5d5fbe79SDavid van Moolenbroek #define          tcp_backlog_set(pcb, new_backlog) do { \
380*5d5fbe79SDavid van Moolenbroek   LWIP_ASSERT("pcb->state == LISTEN (called for wrong pcb?)", (pcb)->state == LISTEN); \
381*5d5fbe79SDavid van Moolenbroek   ((struct tcp_pcb_listen *)(pcb))->backlog = ((new_backlog) ? (new_backlog) : 1); } while(0)
382*5d5fbe79SDavid van Moolenbroek void             tcp_backlog_delayed(struct tcp_pcb* pcb);
383*5d5fbe79SDavid van Moolenbroek void             tcp_backlog_accepted(struct tcp_pcb* pcb);
384*5d5fbe79SDavid van Moolenbroek #else  /* TCP_LISTEN_BACKLOG */
385*5d5fbe79SDavid van Moolenbroek #define          tcp_backlog_set(pcb, new_backlog)
386*5d5fbe79SDavid van Moolenbroek #define          tcp_backlog_delayed(pcb)
387*5d5fbe79SDavid van Moolenbroek #define          tcp_backlog_accepted(pcb)
388*5d5fbe79SDavid van Moolenbroek #endif /* TCP_LISTEN_BACKLOG */
389*5d5fbe79SDavid van Moolenbroek #define          tcp_accepted(pcb) /* compatibility define, not needed any more */
390*5d5fbe79SDavid van Moolenbroek 
391*5d5fbe79SDavid van Moolenbroek void             tcp_recved  (struct tcp_pcb *pcb, u16_t len);
392*5d5fbe79SDavid van Moolenbroek err_t            tcp_bind    (struct tcp_pcb *pcb, const ip_addr_t *ipaddr,
393*5d5fbe79SDavid van Moolenbroek                               u16_t port);
394*5d5fbe79SDavid van Moolenbroek err_t            tcp_connect (struct tcp_pcb *pcb, const ip_addr_t *ipaddr,
395*5d5fbe79SDavid van Moolenbroek                               u16_t port, tcp_connected_fn connected);
396*5d5fbe79SDavid van Moolenbroek 
397*5d5fbe79SDavid van Moolenbroek struct tcp_pcb * tcp_listen_with_backlog_and_err(struct tcp_pcb *pcb, u8_t backlog, err_t *err);
398*5d5fbe79SDavid van Moolenbroek struct tcp_pcb * tcp_listen_with_backlog(struct tcp_pcb *pcb, u8_t backlog);
399*5d5fbe79SDavid van Moolenbroek /** @ingroup tcp_raw */
400*5d5fbe79SDavid van Moolenbroek #define          tcp_listen(pcb) tcp_listen_with_backlog(pcb, TCP_DEFAULT_LISTEN_BACKLOG)
401*5d5fbe79SDavid van Moolenbroek 
402*5d5fbe79SDavid van Moolenbroek void             tcp_abort (struct tcp_pcb *pcb);
403*5d5fbe79SDavid van Moolenbroek err_t            tcp_close   (struct tcp_pcb *pcb);
404*5d5fbe79SDavid van Moolenbroek err_t            tcp_shutdown(struct tcp_pcb *pcb, int shut_rx, int shut_tx);
405*5d5fbe79SDavid van Moolenbroek 
406*5d5fbe79SDavid van Moolenbroek /* Flags for "apiflags" parameter in tcp_write */
407*5d5fbe79SDavid van Moolenbroek #define TCP_WRITE_FLAG_COPY 0x01
408*5d5fbe79SDavid van Moolenbroek #define TCP_WRITE_FLAG_MORE 0x02
409*5d5fbe79SDavid van Moolenbroek 
410*5d5fbe79SDavid van Moolenbroek err_t            tcp_write   (struct tcp_pcb *pcb, const void *dataptr, u16_t len,
411*5d5fbe79SDavid van Moolenbroek                               u8_t apiflags);
412*5d5fbe79SDavid van Moolenbroek 
413*5d5fbe79SDavid van Moolenbroek void             tcp_setprio (struct tcp_pcb *pcb, u8_t prio);
414*5d5fbe79SDavid van Moolenbroek 
415*5d5fbe79SDavid van Moolenbroek #define TCP_PRIO_MIN    1
416*5d5fbe79SDavid van Moolenbroek #define TCP_PRIO_NORMAL 64
417*5d5fbe79SDavid van Moolenbroek #define TCP_PRIO_MAX    127
418*5d5fbe79SDavid van Moolenbroek 
419*5d5fbe79SDavid van Moolenbroek err_t            tcp_output  (struct tcp_pcb *pcb);
420*5d5fbe79SDavid van Moolenbroek 
421*5d5fbe79SDavid van Moolenbroek 
422*5d5fbe79SDavid van Moolenbroek const char* tcp_debug_state_str(enum tcp_state s);
423*5d5fbe79SDavid van Moolenbroek 
424*5d5fbe79SDavid van Moolenbroek /* for compatibility with older implementation */
425*5d5fbe79SDavid van Moolenbroek #define tcp_new_ip6() tcp_new_ip_type(IPADDR_TYPE_V6)
426*5d5fbe79SDavid van Moolenbroek 
427*5d5fbe79SDavid van Moolenbroek #ifdef __cplusplus
428*5d5fbe79SDavid van Moolenbroek }
429*5d5fbe79SDavid van Moolenbroek #endif
430*5d5fbe79SDavid van Moolenbroek 
431*5d5fbe79SDavid van Moolenbroek #endif /* LWIP_TCP */
432*5d5fbe79SDavid van Moolenbroek 
433*5d5fbe79SDavid van Moolenbroek #endif /* LWIP_HDR_TCP_H */
434