[mirror_edk2.git] / NetworkPkg / TcpDxe / TcpProto.h

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