Nut/OS  4.10.3
API Reference
tcp.h
Go to the documentation of this file.
00001 #ifndef _NETINET_TCP_H_
00002 #define _NETINET_TCP_H_
00003 
00004 /*
00005  * Copyright (C) 2001-2003 by egnite Software GmbH. All rights reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  * 2. Redistributions in binary form must reproduce the above copyright
00014  *    notice, this list of conditions and the following disclaimer in the
00015  *    documentation and/or other materials provided with the distribution.
00016  * 3. Neither the name of the copyright holders nor the names of
00017  *    contributors may be used to endorse or promote products derived
00018  *    from this software without specific prior written permission.
00019  *
00020  * THIS SOFTWARE IS PROVIDED BY EGNITE SOFTWARE GMBH AND CONTRIBUTORS
00021  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00022  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00023  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL EGNITE
00024  * SOFTWARE GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00025  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00026  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
00027  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
00028  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00029  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
00030  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00031  * SUCH DAMAGE.
00032  *
00033  * For additional information see http://www.ethernut.de/
00034  *
00035  * -
00036  * Portions Copyright (C) 2000 David J. Hudson <dave@humbug.demon.co.uk>
00037  *
00038  * This file is distributed in the hope that it will be useful, but WITHOUT
00039  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00040  * FITNESS FOR A PARTICULAR PURPOSE.
00041  *
00042  * You can redistribute this file and/or modify it under the terms of the GNU
00043  * General Public License (GPL) as published by the Free Software Foundation;
00044  * either version 2 of the License, or (at your discretion) any later version.
00045  * See the accompanying file "copying-gpl.txt" for more details.
00046  *
00047  * As a special exception to the GPL, permission is granted for additional
00048  * uses of the text contained in this file.  See the accompanying file
00049  * "copying-liquorice.txt" for details.
00050  * -
00051  * Portions Copyright (c) 1983, 1993 by
00052  *  The Regents of the University of California.  All rights reserved.
00053  *
00054  * Redistribution and use in source and binary forms, with or without
00055  * modification, are permitted provided that the following conditions
00056  * are met:
00057  * 1. Redistributions of source code must retain the above copyright
00058  *    notice, this list of conditions and the following disclaimer.
00059  * 2. Redistributions in binary form must reproduce the above copyright
00060  *    notice, this list of conditions and the following disclaimer in the
00061  *    documentation and/or other materials provided with the distribution.
00062  * 3. Neither the name of the University nor the names of its contributors
00063  *    may be used to endorse or promote products derived from this software
00064  *    without specific prior written permission.
00065  *
00066  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
00067  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00068  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00069  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
00070  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00071  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
00072  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00073  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00074  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
00075  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00076  * SUCH DAMAGE.
00077  */
00078 
00079 /*
00080  * $Log$
00081  * Revision 1.6  2008/08/11 07:00:23  haraldkipp
00082  * BSD types replaced by stdint types (feature request #1282721).
00083  *
00084  * Revision 1.5  2006/03/21 21:22:18  drsung
00085  * Enhancement made to TCP state machine. Now TCP options
00086  * are read from peer and at least the maximum segment size is stored.
00087  *
00088  * Revision 1.4  2005/08/02 17:46:49  haraldkipp
00089  * Major API documentation update.
00090  *
00091  * Revision 1.3  2005/04/05 17:38:45  haraldkipp
00092  * ARM7 memory alignment bugs fixed.
00093  *
00094  * Revision 1.2  2004/03/16 16:48:28  haraldkipp
00095  * Added Jan Dubiec's H8/300 port.
00096  *
00097  * Revision 1.1.1.1  2003/05/09 14:41:16  haraldkipp
00098  * Initial using 3.2.1
00099  *
00100  * Revision 1.7  2003/02/04 18:00:46  harald
00101  * Version 3 released
00102  *
00103  * Revision 1.6  2002/09/03 17:49:58  harald
00104  * *** empty log message ***
00105  *
00106  * Revision 1.5  2002/08/16 17:53:36  harald
00107  * Larger window size for better MP3 stream results
00108  *
00109  * Revision 1.4  2002/06/26 17:29:22  harald
00110  * First pre-release with 2.4 stack
00111  *
00112  */
00113 
00114 #include <sys/types.h>
00115 #include <stdint.h>
00116 
00122 #ifdef __cplusplus
00123 extern "C" {
00124 #endif
00125 
00126 #define TH_FIN  0x01    
00127 #define TH_SYN  0x02    
00128 #define TH_RST  0x04    
00129 #define TH_PUSH 0x08    
00130 #define TH_ACK  0x10    
00131 #define TH_URG  0x20    
00134 #define TH_FLAGS (TH_FIN | TH_SYN | TH_RST | TH_ACK | TH_URG)
00135 
00144 typedef struct __attribute__ ((packed)) tcphdr {
00145     uint16_t th_sport;       
00146     uint16_t th_dport;       
00147     uint32_t  th_seq;         
00148     uint32_t  th_ack;         
00149 #ifndef __BIG_ENDIAN__
00150 #ifdef __IMAGECRAFT__
00151     unsigned th_x2:4,
00152              th_off:4;
00153 #else /* #ifndef __BIG_ENDIAN__ */
00154     uint8_t  th_x2:4,        
00155             th_off:4;       
00156 #endif
00157 #else /* #ifndef __BIG_ENDIAN__ */
00158     uint8_t  th_off:4,       
00159             th_x2:4;        
00160 #endif
00161     uint8_t  th_flags;       
00162     uint16_t th_win;         
00163     uint16_t th_sum;         
00164     uint16_t th_urp;         
00165 } TCPHDR;
00166 
00167 #define TCPOPT_EOL                  0   
00168 #define TCPOPT_NOP                  1   
00169 #define TCPOPT_MAXSEG               2   
00170 #define TCPOLEN_MAXSEG              4   
00171 #define TCPOPT_WINDOW               3   
00172 #define TCPOLEN_WINDOW              3   
00182 typedef struct _TCPPSEUDOHDR {
00183     uint32_t  tph_src;    
00184     uint32_t  tph_dst;    
00185     uint8_t  tph_mbz;    
00186     uint8_t  tph_p;      
00187     uint16_t tph_len;    
00188     uint16_t tph_sum;    
00189 } TCPPSEUDOHDR;
00190 
00191 
00192 #define TCP_MSS             536     
00200 #define TCP_WINSIZE         3216    
00206 #define TCP_MAXWIN          65535   
00207 #define TTCP_CLIENT_SND_WND 4096    
00209 #define TCP_MAX_WINSHIFT    14      
00211 #define TCP_MAXHLEN         (0xf<<2)    
00212 #define TCP_MAXOLEN         (TCP_MAXHLEN - sizeof(struct tcphdr))   
00214 /*
00215  * User-settable options.
00216  */
00217 #define TCP_NODELAY 0x01    
00218 #define TCP_MAXSEG  0x02    
00219 #define TCP_NOPUSH  0x04    
00220 #define TCP_NOOPT   0x08    
00222 #ifdef __cplusplus
00223 }
00224 #endif
00225 
00226 #endif