[mirror_edk2.git] / MdeModulePkg / Universal / Network / Tcp4Dxe / Tcp4Proto.h

/** @file\r
  Tcp Protocol header file.\r
\r
Copyright (c) 2005 - 2017, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php<BR>\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef _TCP4_PROTO_H_\r
#define _TCP4_PROTO_H_\r
\r
typedef struct _TCP_CB  TCP_CB;\r
\r
#include "Tcp4Driver.h"\r
#include "Socket.h"\r
#include "Tcp4Option.h"\r
\r
\r
\r
///\r
/// Tcp states, Don't change their order, it is used as\r
/// index to mTcpOutFlag and other macros\r
///\r
#define TCP_CLOSED       0\r
#define TCP_LISTEN       1\r
#define TCP_SYN_SENT     2\r
#define TCP_SYN_RCVD     3\r
#define TCP_ESTABLISHED  4\r
#define TCP_FIN_WAIT_1   5\r
#define TCP_FIN_WAIT_2   6\r
#define TCP_CLOSING      7\r
#define TCP_TIME_WAIT    8\r
#define TCP_CLOSE_WAIT   9\r
#define TCP_LAST_ACK     10\r
\r
\r
///\r
/// Flags in the TCP header\r
///\r
#define TCP_FLG_FIN      0x01\r
#define TCP_FLG_SYN      0x02\r
#define TCP_FLG_RST      0x04\r
#define TCP_FLG_PSH      0x08\r
#define TCP_FLG_ACK      0x10\r
#define TCP_FLG_URG      0x20\r
 \r
 //\r
 // mask for all the flags\r
 //\r
#define TCP_FLG_FLAG     0x3F  \r
\r
\r
#define TCP_CONNECT_REFUSED      (-1) ///< TCP error status\r
#define TCP_CONNECT_RESET        (-2) ///< TCP error status\r
#define TCP_CONNECT_CLOSED       (-3) ///< TCP error status\r
\r
//\r
// Current congestion status as suggested by RFC3782.\r
//\r
#define TCP_CONGEST_RECOVER      1  ///< During the NewReno fast recovery\r
#define TCP_CONGEST_LOSS         2  ///< Retxmit because of retxmit time out\r
#define TCP_CONGEST_OPEN         3  ///< TCP is opening its congestion window\r
\r
//\r
// TCP control flags\r
//\r
#define TCP_CTRL_NO_NAGLE        0x0001 ///< Disable Nagle algorithm\r
#define TCP_CTRL_NO_KEEPALIVE    0x0002 ///< Disable keepalive timer\r
#define TCP_CTRL_NO_WS           0x0004 ///< Disable window scale option\r
#define TCP_CTRL_RCVD_WS         0x0008 ///< Received a wnd scale option in syn\r
#define TCP_CTRL_NO_TS           0x0010 ///< Disable Timestamp option\r
#define TCP_CTRL_RCVD_TS         0x0020 ///< Received a Timestamp option in syn\r
#define TCP_CTRL_SND_TS          0x0040 ///< Send Timestamp option to remote\r
#define TCP_CTRL_SND_URG         0x0080 ///< In urgent send mode\r
#define TCP_CTRL_RCVD_URG        0x0100 ///< In urgent receive mode\r
#define TCP_CTRL_SND_PSH         0x0200 ///< In PUSH send mode\r
#define TCP_CTRL_FIN_SENT        0x0400 ///< FIN is sent\r
#define TCP_CTRL_FIN_ACKED       0x0800 ///< FIN is ACKed.\r
#define TCP_CTRL_TIMER_ON        0x1000 ///< At least one of the timer is on\r
#define TCP_CTRL_RTT_ON          0x2000 ///< The RTT measurement is on\r
#define TCP_CTRL_ACK_NOW         0x4000 ///< Send the ACK now, don't delay\r
\r
//\r
// Timer related values\r
//\r
#define TCP_TIMER_CONNECT        0                  ///< Connection establishment timer\r
#define TCP_TIMER_REXMIT         1                  ///< Retransmit timer\r
#define TCP_TIMER_PROBE          2                  ///< Window probe timer\r
#define TCP_TIMER_KEEPALIVE      3                  ///< Keepalive timer\r
#define TCP_TIMER_FINWAIT2       4                  ///< FIN_WAIT_2 timer\r
#define TCP_TIMER_2MSL           5                  ///< TIME_WAIT tiemr\r
#define TCP_TIMER_NUMBER         6                  ///< The total number of TCP timer.\r
#define TCP_TICK                 200                ///< Every TCP tick is 200ms\r
#define TCP_TICK_HZ              5                  ///< The frequence of TCP tick\r
#define TCP_RTT_SHIFT            3                  ///< SRTT & RTTVAR scaled by 8\r
#define TCP_RTO_MIN              TCP_TICK_HZ        ///< The minium value of RTO\r
#define TCP_RTO_MAX              (TCP_TICK_HZ * 60) ///< The maxium value of RTO\r
#define TCP_FOLD_RTT             4                  ///< Timeout threshod to fold RTT\r
\r
//\r
// Default values for some timers\r
//\r
#define TCP_MAX_LOSS             12                          ///< Default max times to retxmit\r
#define TCP_KEEPALIVE_IDLE_MIN   (TCP_TICK_HZ * 60 * 60 * 2) ///< First keep alive\r
#define TCP_KEEPALIVE_PERIOD     (TCP_TICK_HZ * 60)\r
#define TCP_MAX_KEEPALIVE        8\r
#define TCP_FIN_WAIT2_TIME       (2 * TCP_TICK_HZ)\r
#define TCP_TIME_WAIT_TIME       (2 * TCP_TICK_HZ)\r
#define TCP_PAWS_24DAY           (24 * 24 * 60 * 60 * TCP_TICK_HZ)\r
#define TCP_CONNECT_TIME         (75 * TCP_TICK_HZ)\r
\r
//\r
// The header space to be reserved before TCP data to accomodate :\r
// 60byte IP head + 60byte TCP head + link layer head\r
//\r
#define TCP_MAX_HEAD             192\r
\r
//\r
// Value ranges for some control option\r
//\r
#define TCP_RCV_BUF_SIZE         (2 * 1024 * 1024)\r
#define TCP_RCV_BUF_SIZE_MIN     (8 * 1024)\r
#define TCP_SND_BUF_SIZE         (2 * 1024 * 1024)\r
#define TCP_SND_BUF_SIZE_MIN     (8 * 1024)\r
#define TCP_BACKLOG              10\r
#define TCP_BACKLOG_MIN          5\r
#define TCP_MAX_LOSS_MIN         6\r
#define TCP_CONNECT_TIME_MIN     (60 * TCP_TICK_HZ)\r
#define TCP_MAX_KEEPALIVE_MIN    4\r
#define TCP_KEEPALIVE_IDLE_MAX   (TCP_TICK_HZ * 60 * 60 * 4)\r
#define TCP_KEEPALIVE_PERIOD_MIN (TCP_TICK_HZ * 30)\r
#define TCP_FIN_WAIT2_TIME_MAX   (4 * TCP_TICK_HZ)\r
#define TCP_TIME_WAIT_TIME_MAX   (60 * TCP_TICK_HZ)\r
\r
///\r
/// TCP segmentation data\r
///\r
typedef struct _TCP_SEG {\r
  TCP_SEQNO Seq;  ///< Starting sequence number\r
  TCP_SEQNO End;  ///< The sequence of the last byte + 1, include SYN/FIN. End-Seq = SEG.LEN\r
  TCP_SEQNO Ack;  ///< ACK field in the segment\r
  UINT8     Flag; ///< TCP header flags\r
  UINT16    Urg;  ///< Valid if URG flag is set.\r
  UINT32    Wnd;  ///< TCP window size field\r
} TCP_SEG;\r
\r
///\r
/// Network endpoint, IP+Port structure\r
///\r
typedef struct _TCP_PEER {\r
  UINT32      Ip;   ///< IP address, network byte order\r
  TCP_PORTNO  Port; ///< Port number, network byte order\r
} TCP_PEER;\r
\r
///\r
/// TCP control block, it includes various states\r
///\r
struct _TCP_CB {\r
  LIST_ENTRY        List;     ///< Back and forward link entry\r
  TCP_CB            *Parent;  ///< The parent TCP_CB structure\r
\r
  SOCKET            *Sk;      ///< The socket it controled.\r
  TCP_PEER          LocalEnd; ///< Local endpoint\r
  TCP_PEER          RemoteEnd;///< Remote endpoint\r
\r
  LIST_ENTRY        SndQue;   ///< Retxmission queue\r
  LIST_ENTRY        RcvQue;   ///< Reassemble queue\r
  UINT32            CtrlFlag; ///< Control flags, such as NO_NAGLE\r
  INT32             Error;    ///< Soft error status, such as TCP_CONNECT_RESET\r
\r
  //\r
  // RFC793 and RFC1122 defined variables\r
  //\r
  UINT8             State;      ///< TCP state, such as SYN_SENT, LISTEN\r
  UINT8             DelayedAck; ///< Number of delayed ACKs\r
  UINT16            HeadSum;    ///< Checksum of the fixed parts of pesudo\r
                                ///< header: Src IP, Dst IP, 0, Protocol,\r
                                ///< not include the TCP length.\r
\r
  TCP_SEQNO         Iss;        ///< Initial Sending Sequence\r
  TCP_SEQNO         SndUna;     ///< First unacknowledged data\r
  TCP_SEQNO         SndNxt;     ///< Next data sequence to send.\r
  TCP_SEQNO         SndPsh;     ///< Send PUSH point\r
  TCP_SEQNO         SndUp;      ///< Send urgent point\r
  UINT32            SndWnd;     ///< Window advertised by the remote peer\r
  UINT32            SndWndMax;  ///< Max send window advertised by the peer\r
  TCP_SEQNO         SndWl1;     ///< Seq number used for last window update\r
  TCP_SEQNO         SndWl2;     ///< Ack no of last window update\r
  UINT16            SndMss;     ///< Max send segment size\r
  TCP_SEQNO         RcvNxt;     ///< Next sequence no to receive\r
  UINT32            RcvWnd;     ///< Window advertised by the local peer\r
  TCP_SEQNO         RcvWl2;     ///< The RcvNxt (or ACK) of last window update.\r
                                ///< It is necessary because of delayed ACK\r
\r
  TCP_SEQNO         RcvUp;                   ///< Urgent point;\r
  TCP_SEQNO         Irs;                     ///< Initial Receiving Sequence\r
  UINT16            RcvMss;                  ///< Max receive segment size\r
  UINT16            EnabledTimer;            ///< Which timer is currently enabled\r
  UINT32            Timer[TCP_TIMER_NUMBER]; ///< When the timer will expire\r
  INT32             NextExpire;  ///< Count down offset for the nearest timer\r
  UINT32            Idle;        ///< How long the connection is in idle\r
  UINT32            ProbeTime;   ///< The time out value for current window prober\r
  BOOLEAN           ProbeTimerOn;///< If TRUE, the probe time is on.\r
\r
  //\r
  // RFC1323 defined variables, about window scale,\r
  // timestamp and PAWS\r
  //\r
  UINT8             SndWndScale;  ///< Wndscale received from the peer\r
  UINT8             RcvWndScale;  ///< Wndscale used to scale local buffer\r
  UINT32            TsRecent;     ///< TsRecent to echo to the remote peer\r
  UINT32            TsRecentAge;  ///< When this TsRecent is updated\r
\r
  //\r
  // RFC2988 defined variables. about RTT measurement\r
  //\r
  TCP_SEQNO         RttSeq;     ///< The seq of measured segment now\r
  UINT32            RttMeasure; ///< Currently measured RTT in heart beats\r
  UINT32            SRtt;       ///< Smoothed RTT, scaled by 8\r
  UINT32            RttVar;     ///< RTT variance, scaled by 8\r
  UINT32            Rto;        ///< Current RTO, not scaled\r
\r
  //\r
  // RFC2581, and 3782 variables.\r
  // Congestion control + NewReno fast recovery.\r
  //\r
  UINT32            CWnd;         ///< Sender's congestion window\r
  UINT32            Ssthresh;     ///< Slow start threshold.\r
  TCP_SEQNO         Recover;      ///< Recover point for NewReno\r
  UINT16            DupAck;       ///< Number of duplicate ACKs\r
  UINT8             CongestState; ///< The current congestion state(RFC3782)\r
  UINT8             LossTimes;    ///< Number of retxmit timeouts in a row\r
  TCP_SEQNO         LossRecover;  ///< Recover point for retxmit\r
\r
  //\r
  // configuration parameters, for EFI_TCP4_PROTOCOL specification\r
  //\r
  UINT32            KeepAliveIdle;   ///< Idle time before sending first probe\r
  UINT32            KeepAlivePeriod; ///< Interval for subsequent keep alive probe\r
  UINT8             MaxKeepAlive;    ///< Maxium keep alive probe times.\r
  UINT8             KeepAliveProbes; ///< The number of keep alive probe.\r
  UINT16            MaxRexmit;       ///< The maxium number of retxmit before abort\r
  UINT32            FinWait2Timeout; ///< The FIN_WAIT_2 time out\r
  UINT32            TimeWaitTimeout; ///< The TIME_WAIT time out\r
  UINT32            ConnectTimeout;  ///< The connect establishment time out\r
\r
  //\r
  // RFC7323\r
  // Addressing Window Retraction for TCP Window Scale Option.\r
  //\r
  TCP_SEQNO         RetxmitSeqMax;       ///< Max Seq number in previous retransmission.\r
\r
  //\r
  // configuration for tcp provided by user\r
  //\r
  BOOLEAN           UseDefaultAddr;\r
  UINT8             Tos;\r
  UINT8             Ttl;\r
  EFI_IPv4_ADDRESS  SubnetMask;\r
\r
  IP_IO_IP_INFO     *IpInfo;        ///<pointer reference to Ip used to send pkt\r
};\r
\r
extern LIST_ENTRY     mTcpRunQue;\r
extern LIST_ENTRY     mTcpListenQue;\r
extern TCP_SEQNO      mTcpGlobalIss;\r
extern UINT32         mTcpTick;\r
\r
///\r
/// TCP_CONNECTED: both ends have synchronized their ISN.\r
///\r
#define TCP_CONNECTED(state)  ((state) > TCP_SYN_RCVD)\r
\r
#define TCP_FIN_RCVD(State) \\r
    (((State) == TCP_CLOSE_WAIT) || \\r
    ((State) == TCP_LAST_ACK) || \\r
    ((State) == TCP_CLOSING) || \\r
    ((State) == TCP_TIME_WAIT))\r
\r
#define TCP_LOCAL_CLOSED(State) \\r
      (((State) == TCP_FIN_WAIT_1) || \\r
      ((State) == TCP_FIN_WAIT_2) || \\r
      ((State) == TCP_CLOSING) || \\r
      ((State) == TCP_TIME_WAIT) || \\r
      ((State) == TCP_LAST_ACK))\r
\r
//\r
// Get the TCP_SEG point from a net buffer's ProtoData\r
//\r
#define TCPSEG_NETBUF(NBuf) ((TCP_SEG *) ((NBuf)->ProtoData))\r
\r
//\r
// macros to compare sequence no\r
//\r
#define TCP_SEQ_LT(SeqA, SeqB)  ((INT32) ((SeqA) - (SeqB)) < 0)\r
#define TCP_SEQ_LEQ(SeqA, SeqB) ((INT32) ((SeqA) - (SeqB)) <= 0)\r
#define TCP_SEQ_GT(SeqA, SeqB)  ((INT32) ((SeqB) - (SeqA)) < 0)\r
#define TCP_SEQ_GEQ(SeqA, SeqB) ((INT32) ((SeqB) - (SeqA)) <= 0)\r
\r
//\r
// TCP_SEQ_BETWEEN return whether b <= m <= e\r
//\r
#define TCP_SEQ_BETWEEN(b, m, e)  ((e) - (b) >= (m) - (b))\r
\r
//\r
// TCP_SUB_SEQ returns Seq1 - Seq2. Make sure Seq1 >= Seq2\r
//\r
#define TCP_SUB_SEQ(Seq1, Seq2)     ((UINT32) ((Seq1) - (Seq2)))\r
\r
//\r
// Check whether Flag is on\r
//\r
#define TCP_FLG_ON(Value, Flag)     ((BOOLEAN) (((Value) & (Flag)) != 0))\r
\r
//\r
// Set and Clear operation on a Flag\r
//\r
#define TCP_SET_FLG(Value, Flag)    ((Value) |= (Flag))\r
#define TCP_CLEAR_FLG(Value, Flag)  ((Value) &= ~(Flag))\r
\r
//\r
// Test whether two peers are equal\r
//\r
#define TCP_PEER_EQUAL(Pa, Pb) \\r
  (((Pa)->Ip == (Pb)->Ip) && ((Pa)->Port == (Pb)->Port))\r
\r
//\r
// Test whether Pa matches Pb, or Pa is more specific\r
// than pb. Zero means wildcard.\r
//\r
#define TCP_PEER_MATCH(Pa, Pb) \\r
    ((((Pb)->Ip == 0) || ((Pb)->Ip == (Pa)->Ip)) && \\r
    (((Pb)->Port == 0) || ((Pb)->Port == (Pa)->Port)))\r
\r
#define TCP_TIMER_ON(Flag, Timer)     ((Flag) & (1 << (Timer)))\r
#define TCP_SET_TIMER(Flag, Timer)    ((Flag) = (UINT16) ((Flag) | (1 << (Timer))))\r
#define TCP_CLEAR_TIMER(Flag, Timer)  ((Flag) = (UINT16) ((Flag) & (~(1 << (Timer)))))\r
\r
#define TCP_TIME_LT(Ta, Tb)           ((INT32) ((Ta) - (Tb)) < 0)\r
#define TCP_TIME_LEQ(Ta, Tb)          ((INT32) ((Ta) - (Tb)) <= 0)\r
#define TCP_SUB_TIME(Ta, Tb)          ((UINT32) ((Ta) - (Tb)))\r
\r
#define TCP_MAX_WIN                   0xFFFFU\r
\r
typedef\r
VOID\r
(*TCP_TIMER_HANDLER) (\r
  IN OUT TCP_CB *Tcb\r
  );\r
\r
#endif\r
Commit	Line	Data
83cbd279	1	/** @file\r
dab714aa	2	Tcp Protocol header file.\r
dab714aa	3	\r
ca12a0c8	4	Copyright (c) 2005 - 2017, Intel Corporation. All rights reserved.<BR>\r
e5eed7d3	5	This program and the accompanying materials\r
83cbd279	6	are licensed and made available under the terms and conditions of the BSD License\r
83cbd279	7	which accompanies this distribution. The full text of the license may be found at\r
dfc1f033	8	http://opensource.org/licenses/bsd-license.php<BR>\r
83cbd279	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	\r
83cbd279	13	**/\r
	14	\r
	15	#ifndef _TCP4_PROTO_H_\r
	16	#define _TCP4_PROTO_H_\r
	17	\r
	18	typedef struct _TCP_CB TCP_CB;\r
	19	\r
	20	#include "Tcp4Driver.h"\r
	21	#include "Socket.h"\r
	22	#include "Tcp4Option.h"\r
	23	\r
dfc1f033	24	\r
	25	\r
	26	///\r
	27	/// Tcp states, Don't change their order, it is used as\r
	28	/// index to mTcpOutFlag and other macros\r
	29	///\r
f6b7393c	30	#define TCP_CLOSED 0\r
	31	#define TCP_LISTEN 1\r
	32	#define TCP_SYN_SENT 2\r
	33	#define TCP_SYN_RCVD 3\r
	34	#define TCP_ESTABLISHED 4\r
	35	#define TCP_FIN_WAIT_1 5\r
	36	#define TCP_FIN_WAIT_2 6\r
	37	#define TCP_CLOSING 7\r
	38	#define TCP_TIME_WAIT 8\r
	39	#define TCP_CLOSE_WAIT 9\r
	40	#define TCP_LAST_ACK 10\r
	41	\r
83cbd279	42	\r
dfc1f033	43	///\r
	44	/// Flags in the TCP header\r
	45	///\r
f6b7393c	46	#define TCP_FLG_FIN 0x01\r
	47	#define TCP_FLG_SYN 0x02\r
	48	#define TCP_FLG_RST 0x04\r
	49	#define TCP_FLG_PSH 0x08\r
	50	#define TCP_FLG_ACK 0x10\r
	51	#define TCP_FLG_URG 0x20\r
	52	\r
	53	//\r
	54	// mask for all the flags\r
	55	//\r
	56	#define TCP_FLG_FLAG 0x3F \r
	57	\r
	58	\r
	59	#define TCP_CONNECT_REFUSED (-1) ///< TCP error status\r
	60	#define TCP_CONNECT_RESET (-2) ///< TCP error status\r
	61	#define TCP_CONNECT_CLOSED (-3) ///< TCP error status\r
	62	\r
	63	//\r
	64	// Current congestion status as suggested by RFC3782.\r
	65	//\r
	66	#define TCP_CONGEST_RECOVER 1 ///< During the NewReno fast recovery\r
	67	#define TCP_CONGEST_LOSS 2 ///< Retxmit because of retxmit time out\r
	68	#define TCP_CONGEST_OPEN 3 ///< TCP is opening its congestion window\r
	69	\r
	70	//\r
	71	// TCP control flags\r
	72	//\r
	73	#define TCP_CTRL_NO_NAGLE 0x0001 ///< Disable Nagle algorithm\r
	74	#define TCP_CTRL_NO_KEEPALIVE 0x0002 ///< Disable keepalive timer\r
	75	#define TCP_CTRL_NO_WS 0x0004 ///< Disable window scale option\r
	76	#define TCP_CTRL_RCVD_WS 0x0008 ///< Received a wnd scale option in syn\r
	77	#define TCP_CTRL_NO_TS 0x0010 ///< Disable Timestamp option\r
	78	#define TCP_CTRL_RCVD_TS 0x0020 ///< Received a Timestamp option in syn\r
	79	#define TCP_CTRL_SND_TS 0x0040 ///< Send Timestamp option to remote\r
	80	#define TCP_CTRL_SND_URG 0x0080 ///< In urgent send mode\r
	81	#define TCP_CTRL_RCVD_URG 0x0100 ///< In urgent receive mode\r
	82	#define TCP_CTRL_SND_PSH 0x0200 ///< In PUSH send mode\r
	83	#define TCP_CTRL_FIN_SENT 0x0400 ///< FIN is sent\r
	84	#define TCP_CTRL_FIN_ACKED 0x0800 ///< FIN is ACKed.\r
	85	#define TCP_CTRL_TIMER_ON 0x1000 ///< At least one of the timer is on\r
	86	#define TCP_CTRL_RTT_ON 0x2000 ///< The RTT measurement is on\r
	87	#define TCP_CTRL_ACK_NOW 0x4000 ///< Send the ACK now, don't delay\r
	88	\r
	89	//\r
	90	// Timer related values\r
	91	//\r
	92	#define TCP_TIMER_CONNECT 0 ///< Connection establishment timer\r
	93	#define TCP_TIMER_REXMIT 1 ///< Retransmit timer\r
	94	#define TCP_TIMER_PROBE 2 ///< Window probe timer\r
	95	#define TCP_TIMER_KEEPALIVE 3 ///< Keepalive timer\r
	96	#define TCP_TIMER_FINWAIT2 4 ///< FIN_WAIT_2 timer\r
	97	#define TCP_TIMER_2MSL 5 ///< TIME_WAIT tiemr\r
	98	#define TCP_TIMER_NUMBER 6 ///< The total number of TCP timer.\r
	99	#define TCP_TICK 200 ///< Every TCP tick is 200ms\r
	100	#define TCP_TICK_HZ 5 ///< The frequence of TCP tick\r
	101	#define TCP_RTT_SHIFT 3 ///< SRTT & RTTVAR scaled by 8\r
	102	#define TCP_RTO_MIN TCP_TICK_HZ ///< The minium value of RTO\r
	103	#define TCP_RTO_MAX (TCP_TICK_HZ * 60) ///< The maxium value of RTO\r
	104	#define TCP_FOLD_RTT 4 ///< Timeout threshod to fold RTT\r
	105	\r
	106	//\r
	107	// Default values for some timers\r
	108	//\r
	109	#define TCP_MAX_LOSS 12 ///< Default max times to retxmit\r
110	#define TCP_KEEPALIVE_IDLE_MIN (TCP_TICK_HZ * 60 * 60 * 2) ///< First keep alive\r
111	#define TCP_KEEPALIVE_PERIOD (TCP_TICK_HZ * 60)\r
112	#define TCP_MAX_KEEPALIVE 8\r
113	#define TCP_FIN_WAIT2_TIME (2 * TCP_TICK_HZ)\r
114	#define TCP_TIME_WAIT_TIME (2 * TCP_TICK_HZ)\r
115	#define TCP_PAWS_24DAY (24 * 24 * 60 * 60 * TCP_TICK_HZ)\r
116	#define TCP_CONNECT_TIME (75 * TCP_TICK_HZ)\r
117	\r
118	//\r
119	// The header space to be reserved before TCP data to accomodate :\r
120	// 60byte IP head + 60byte TCP head + link layer head\r
121	//\r
122	#define TCP_MAX_HEAD 192\r
123	\r
124	//\r
125	// Value ranges for some control option\r
126	//\r
127	#define TCP_RCV_BUF_SIZE (2 * 1024 * 1024)\r
128	#define TCP_RCV_BUF_SIZE_MIN (8 * 1024)\r
129	#define TCP_SND_BUF_SIZE (2 * 1024 * 1024)\r
130	#define TCP_SND_BUF_SIZE_MIN (8 * 1024)\r
131	#define TCP_BACKLOG 10\r
132	#define TCP_BACKLOG_MIN 5\r
133	#define TCP_MAX_LOSS_MIN 6\r
134	#define TCP_CONNECT_TIME_MIN (60 * TCP_TICK_HZ)\r
135	#define TCP_MAX_KEEPALIVE_MIN 4\r
136	#define TCP_KEEPALIVE_IDLE_MAX (TCP_TICK_HZ * 60 * 60 * 4)\r
137	#define TCP_KEEPALIVE_PERIOD_MIN (TCP_TICK_HZ * 30)\r
138	#define TCP_FIN_WAIT2_TIME_MAX (4 * TCP_TICK_HZ)\r
139	#define TCP_TIME_WAIT_TIME_MAX (60 * TCP_TICK_HZ)\r
83cbd279	140	\r
dfc1f033	141	///\r
	142	/// TCP segmentation data\r
	143	///\r
83cbd279	144	typedef struct _TCP_SEG {\r
dfc1f033	145	TCP_SEQNO Seq; ///< Starting sequence number\r
	146	TCP_SEQNO End; ///< The sequence of the last byte + 1, include SYN/FIN. End-Seq = SEG.LEN\r
	147	TCP_SEQNO Ack; ///< ACK field in the segment\r
	148	UINT8 Flag; ///< TCP header flags\r
	149	UINT16 Urg; ///< Valid if URG flag is set.\r
	150	UINT32 Wnd; ///< TCP window size field\r
83cbd279	151	} TCP_SEG;\r
83cbd279	152	\r
dfc1f033	153	///\r
	154	/// Network endpoint, IP+Port structure\r
	155	///\r
83cbd279	156	typedef struct _TCP_PEER {\r
dfc1f033	157	UINT32 Ip; ///< IP address, network byte order\r
dfc1f033	158	TCP_PORTNO Port; ///< Port number, network byte order\r
83cbd279	159	} TCP_PEER;\r
83cbd279	160	\r
dfc1f033	161	///\r
	162	/// TCP control block, it includes various states\r
	163	///\r
83cbd279	164	struct _TCP_CB {\r
dfc1f033	165	LIST_ENTRY List; ///< Back and forward link entry\r
dfc1f033	166	TCP_CB *Parent; ///< The parent TCP_CB structure\r
83cbd279	167	\r
dfc1f033	168	SOCKET *Sk; ///< The socket it controled.\r
	169	TCP_PEER LocalEnd; ///< Local endpoint\r
	170	TCP_PEER RemoteEnd;///< Remote endpoint\r
83cbd279	171	\r
dfc1f033	172	LIST_ENTRY SndQue; ///< Retxmission queue\r
	173	LIST_ENTRY RcvQue; ///< Reassemble queue\r
	174	UINT32 CtrlFlag; ///< Control flags, such as NO_NAGLE\r
	175	INT32 Error; ///< Soft error status, such as TCP_CONNECT_RESET\r
83cbd279	176	\r
	177	//\r
	178	// RFC793 and RFC1122 defined variables\r
	179	//\r
276dcc1b	180	UINT8 State; ///< TCP state, such as SYN_SENT, LISTEN\r
dfc1f033	181	UINT8 DelayedAck; ///< Number of delayed ACKs\r
	182	UINT16 HeadSum; ///< Checksum of the fixed parts of pesudo\r
	183	///< header: Src IP, Dst IP, 0, Protocol,\r
	184	///< not include the TCP length.\r
	185	\r
	186	TCP_SEQNO Iss; ///< Initial Sending Sequence\r
	187	TCP_SEQNO SndUna; ///< First unacknowledged data\r
	188	TCP_SEQNO SndNxt; ///< Next data sequence to send.\r
	189	TCP_SEQNO SndPsh; ///< Send PUSH point\r
	190	TCP_SEQNO SndUp; ///< Send urgent point\r
	191	UINT32 SndWnd; ///< Window advertised by the remote peer\r
	192	UINT32 SndWndMax; ///< Max send window advertised by the peer\r
	193	TCP_SEQNO SndWl1; ///< Seq number used for last window update\r
	194	TCP_SEQNO SndWl2; ///< Ack no of last window update\r
	195	UINT16 SndMss; ///< Max send segment size\r
	196	TCP_SEQNO RcvNxt; ///< Next sequence no to receive\r
	197	UINT32 RcvWnd; ///< Window advertised by the local peer\r
	198	TCP_SEQNO RcvWl2; ///< The RcvNxt (or ACK) of last window update.\r
	199	///< It is necessary because of delayed ACK\r
	200	\r
	201	TCP_SEQNO RcvUp; ///< Urgent point;\r
	202	TCP_SEQNO Irs; ///< Initial Receiving Sequence\r
	203	UINT16 RcvMss; ///< Max receive segment size\r
	204	UINT16 EnabledTimer; ///< Which timer is currently enabled\r
	205	UINT32 Timer[TCP_TIMER_NUMBER]; ///< When the timer will expire\r
	206	INT32 NextExpire; ///< Count down offset for the nearest timer\r
	207	UINT32 Idle; ///< How long the connection is in idle\r
	208	UINT32 ProbeTime; ///< The time out value for current window prober\r
ac8cca2a	209	BOOLEAN ProbeTimerOn;///< If TRUE, the probe time is on.\r
83cbd279	210	\r
	211	//\r
	212	// RFC1323 defined variables, about window scale,\r
	213	// timestamp and PAWS\r
	214	//\r
dfc1f033	215	UINT8 SndWndScale; ///< Wndscale received from the peer\r
	216	UINT8 RcvWndScale; ///< Wndscale used to scale local buffer\r
	217	UINT32 TsRecent; ///< TsRecent to echo to the remote peer\r
	218	UINT32 TsRecentAge; ///< When this TsRecent is updated\r
83cbd279	219	\r
	220	//\r
	221	// RFC2988 defined variables. about RTT measurement\r
	222	//\r
dfc1f033	223	TCP_SEQNO RttSeq; ///< The seq of measured segment now\r
	224	UINT32 RttMeasure; ///< Currently measured RTT in heart beats\r
	225	UINT32 SRtt; ///< Smoothed RTT, scaled by 8\r
	226	UINT32 RttVar; ///< RTT variance, scaled by 8\r
	227	UINT32 Rto; ///< Current RTO, not scaled\r
83cbd279	228	\r
	229	//\r
	230	// RFC2581, and 3782 variables.\r
	231	// Congestion control + NewReno fast recovery.\r
	232	//\r
dfc1f033	233	UINT32 CWnd; ///< Sender's congestion window\r
	234	UINT32 Ssthresh; ///< Slow start threshold.\r
	235	TCP_SEQNO Recover; ///< Recover point for NewReno\r
	236	UINT16 DupAck; ///< Number of duplicate ACKs\r
	237	UINT8 CongestState; ///< The current congestion state(RFC3782)\r
	238	UINT8 LossTimes; ///< Number of retxmit timeouts in a row\r
	239	TCP_SEQNO LossRecover; ///< Recover point for retxmit\r
83cbd279	240	\r
	241	//\r
	242	// configuration parameters, for EFI_TCP4_PROTOCOL specification\r
	243	//\r
dfc1f033	244	UINT32 KeepAliveIdle; ///< Idle time before sending first probe\r
	245	UINT32 KeepAlivePeriod; ///< Interval for subsequent keep alive probe\r
	246	UINT8 MaxKeepAlive; ///< Maxium keep alive probe times.\r
	247	UINT8 KeepAliveProbes; ///< The number of keep alive probe.\r
	248	UINT16 MaxRexmit; ///< The maxium number of retxmit before abort\r
	249	UINT32 FinWait2Timeout; ///< The FIN_WAIT_2 time out\r
	250	UINT32 TimeWaitTimeout; ///< The TIME_WAIT time out\r
	251	UINT32 ConnectTimeout; ///< The connect establishment time out\r
83cbd279	252	\r
ca12a0c8 FS	253	//\r
	254	// RFC7323\r
	255	// Addressing Window Retraction for TCP Window Scale Option.\r
	256	//\r
	257	TCP_SEQNO RetxmitSeqMax; ///< Max Seq number in previous retransmission.\r
	258	\r
83cbd279	259	//\r
	260	// configuration for tcp provided by user\r
	261	//\r
	262	BOOLEAN UseDefaultAddr;\r
a78d176c	263	UINT8 Tos;\r
a78d176c	264	UINT8 Ttl;\r
83cbd279	265	EFI_IPv4_ADDRESS SubnetMask;\r
83cbd279	266	\r
dfc1f033	267	IP_IO_IP_INFO *IpInfo; ///<pointer reference to Ip used to send pkt\r
83cbd279	268	};\r
83cbd279	269	\r
e48e37fc	270	extern LIST_ENTRY mTcpRunQue;\r
e48e37fc	271	extern LIST_ENTRY mTcpListenQue;\r
83cbd279	272	extern TCP_SEQNO mTcpGlobalIss;\r
	273	extern UINT32 mTcpTick;\r
	274	\r
dfc1f033	275	///\r
	276	/// TCP_CONNECTED: both ends have synchronized their ISN.\r
	277	///\r
83cbd279	278	#define TCP_CONNECTED(state) ((state) > TCP_SYN_RCVD)\r
	279	\r
	280	#define TCP_FIN_RCVD(State) \\r
	281	(((State) == TCP_CLOSE_WAIT) \|\| \\r
	282	((State) == TCP_LAST_ACK) \|\| \\r
	283	((State) == TCP_CLOSING) \|\| \\r
	284	((State) == TCP_TIME_WAIT))\r
	285	\r
	286	#define TCP_LOCAL_CLOSED(State) \\r
	287	(((State) == TCP_FIN_WAIT_1) \|\| \\r
	288	((State) == TCP_FIN_WAIT_2) \|\| \\r
	289	((State) == TCP_CLOSING) \|\| \\r
	290	((State) == TCP_TIME_WAIT) \|\| \\r
	291	((State) == TCP_LAST_ACK))\r
	292	\r
	293	//\r
	294	// Get the TCP_SEG point from a net buffer's ProtoData\r
	295	//\r
	296	#define TCPSEG_NETBUF(NBuf) ((TCP_SEG *) ((NBuf)->ProtoData))\r
	297	\r
	298	//\r
	299	// macros to compare sequence no\r
	300	//\r
	301	#define TCP_SEQ_LT(SeqA, SeqB) ((INT32) ((SeqA) - (SeqB)) < 0)\r
	302	#define TCP_SEQ_LEQ(SeqA, SeqB) ((INT32) ((SeqA) - (SeqB)) <= 0)\r
	303	#define TCP_SEQ_GT(SeqA, SeqB) ((INT32) ((SeqB) - (SeqA)) < 0)\r
	304	#define TCP_SEQ_GEQ(SeqA, SeqB) ((INT32) ((SeqB) - (SeqA)) <= 0)\r
	305	\r
	306	//\r
	307	// TCP_SEQ_BETWEEN return whether b <= m <= e\r
	308	//\r
	309	#define TCP_SEQ_BETWEEN(b, m, e) ((e) - (b) >= (m) - (b))\r
	310	\r
	311	//\r
	312	// TCP_SUB_SEQ returns Seq1 - Seq2. Make sure Seq1 >= Seq2\r
	313	//\r
	314	#define TCP_SUB_SEQ(Seq1, Seq2) ((UINT32) ((Seq1) - (Seq2)))\r
	315	\r
dab714aa	316	//\r
	317	// Check whether Flag is on\r
	318	//\r
83cbd279	319	#define TCP_FLG_ON(Value, Flag) ((BOOLEAN) (((Value) & (Flag)) != 0))\r
dab714aa	320	\r
	321	//\r
	322	// Set and Clear operation on a Flag\r
	323	//\r
83cbd279	324	#define TCP_SET_FLG(Value, Flag) ((Value) \|= (Flag))\r
	325	#define TCP_CLEAR_FLG(Value, Flag) ((Value) &= ~(Flag))\r
	326	\r
	327	//\r
dab714aa	328	// Test whether two peers are equal\r
83cbd279	329	//\r
	330	#define TCP_PEER_EQUAL(Pa, Pb) \\r
	331	(((Pa)->Ip == (Pb)->Ip) && ((Pa)->Port == (Pb)->Port))\r
	332	\r
	333	//\r
dab714aa	334	// Test whether Pa matches Pb, or Pa is more specific\r
83cbd279	335	// than pb. Zero means wildcard.\r
	336	//\r
	337	#define TCP_PEER_MATCH(Pa, Pb) \\r
	338	((((Pb)->Ip == 0) \|\| ((Pb)->Ip == (Pa)->Ip)) && \\r
	339	(((Pb)->Port == 0) \|\| ((Pb)->Port == (Pa)->Port)))\r
	340	\r
	341	#define TCP_TIMER_ON(Flag, Timer) ((Flag) & (1 << (Timer)))\r
	342	#define TCP_SET_TIMER(Flag, Timer) ((Flag) = (UINT16) ((Flag) \| (1 << (Timer))))\r
	343	#define TCP_CLEAR_TIMER(Flag, Timer) ((Flag) = (UINT16) ((Flag) & (~(1 << (Timer)))))\r
	344	\r
	345	#define TCP_TIME_LT(Ta, Tb) ((INT32) ((Ta) - (Tb)) < 0)\r
	346	#define TCP_TIME_LEQ(Ta, Tb) ((INT32) ((Ta) - (Tb)) <= 0)\r
	347	#define TCP_SUB_TIME(Ta, Tb) ((UINT32) ((Ta) - (Tb)))\r
	348	\r
	349	#define TCP_MAX_WIN 0xFFFFU\r
	350	\r
	351	typedef\r
	352	VOID\r
	353	(*TCP_TIMER_HANDLER) (\r
dab714aa	354	IN OUT TCP_CB *Tcb\r
83cbd279	355	);\r
83cbd279	356	\r
83cbd279	357	#endif\r