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