/** @file\r
- \r
-Copyright (c) 2005 - 2006, Intel Corporation<BR>\r
-All rights reserved. This program and the accompanying materials\r
+ Tcp Protocol header file.\r
+\r
+Copyright (c) 2005 - 2010, 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
/// Tcp states, Don't change their order, it is used as\r
/// index to mTcpOutFlag and other macros\r
///\r
-typedef enum {\r
- TCP_CLOSED = 0,\r
- TCP_LISTEN,\r
- TCP_SYN_SENT,\r
- TCP_SYN_RCVD,\r
- TCP_ESTABLISHED,\r
- TCP_FIN_WAIT_1,\r
- TCP_FIN_WAIT_2,\r
- TCP_CLOSING,\r
- TCP_TIME_WAIT,\r
- TCP_CLOSE_WAIT,\r
- TCP_LAST_ACK\r
-} TCP_STATES;\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
-typedef enum {\r
-\r
- TCP_FLG_FIN = 0x01,\r
- TCP_FLG_SYN = 0x02,\r
- TCP_FLG_RST = 0x04,\r
- TCP_FLG_PSH = 0x08,\r
- TCP_FLG_ACK = 0x10,\r
- TCP_FLG_URG = 0x20,\r
- \r
- //\r
- // mask for all the flags\r
- //\r
- TCP_FLG_FLAG = 0x3F \r
-} TCP_HEADER_FLAG;\r
-\r
-typedef enum {\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
- TCP_CONNECT_REFUSED = -1, ///< TCP error status\r
- TCP_CONNECT_RESET = -2, ///< TCP error status\r
- TCP_CONNECT_CLOSED = -3, ///< TCP error status\r
-\r
- //\r
- // Current congestion status as suggested by RFC3782.\r
- //\r
- TCP_CONGEST_RECOVER = 1, ///< During the NewReno fast recovery\r
- TCP_CONGEST_LOSS = 2, ///< Retxmit because of retxmit time out\r
- TCP_CONGEST_OPEN = 3, ///< TCP is opening its congestion window\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
- TCP_CTRL_NO_NAGLE = 0x0001, ///< Disable Nagle algorithm\r
- TCP_CTRL_NO_KEEPALIVE = 0x0002, ///< Disable keepalive timer\r
- TCP_CTRL_NO_WS = 0x0004, ///< Disable window scale option\r
- TCP_CTRL_RCVD_WS = 0x0008, ///< Received a wnd scale option in syn\r
- TCP_CTRL_NO_TS = 0x0010, ///< Disable Timestamp option\r
- TCP_CTRL_RCVD_TS = 0x0020, ///< Received a Timestamp option in syn\r
- TCP_CTRL_SND_TS = 0x0040, ///< Send Timestamp option to remote\r
- TCP_CTRL_SND_URG = 0x0080, ///< In urgent send mode\r
- TCP_CTRL_RCVD_URG = 0x0100, ///< In urgent receive mode\r
- TCP_CTRL_SND_PSH = 0x0200, ///< In PUSH send mode\r
- TCP_CTRL_FIN_SENT = 0x0400, ///< FIN is sent\r
- TCP_CTRL_FIN_ACKED = 0x0800, ///< FIN is ACKed.\r
- TCP_CTRL_TIMER_ON = 0x1000, ///< At least one of the timer is on\r
- TCP_CTRL_RTT_ON = 0x2000, ///< The RTT measurement is on\r
- TCP_CTRL_ACK_NOW = 0x4000, ///< Send the ACK now, don't delay\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
- TCP_TIMER_CONNECT = 0, ///< Connection establishment timer\r
- TCP_TIMER_REXMIT = 1, ///< Retransmit timer\r
- TCP_TIMER_PROBE = 2, ///< Window probe timer\r
- TCP_TIMER_KEEPALIVE = 3, ///< Keepalive timer\r
- TCP_TIMER_FINWAIT2 = 4, ///< FIN_WAIT_2 timer\r
- TCP_TIMER_2MSL = 5, ///< TIME_WAIT tiemr\r
- TCP_TIMER_NUMBER = 6, ///< The total number of TCP timer.\r
- TCP_TICK = 200, ///< Every TCP tick is 200ms\r
- TCP_TICK_HZ = 5, ///< The frequence of TCP tick\r
- TCP_RTT_SHIFT = 3, ///< SRTT & RTTVAR scaled by 8\r
- TCP_RTO_MIN = TCP_TICK_HZ, ///< The minium value of RTO\r
- TCP_RTO_MAX = (TCP_TICK_HZ * 60), ///< The maxium value of RTO\r
- TCP_FOLD_RTT = 4, ///< Timeout threshod to fold RTT\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
- TCP_MAX_LOSS = 12, ///< Default max times to retxmit\r
- TCP_KEEPALIVE_IDLE_MIN = (TCP_TICK_HZ * 60 * 60 * 2), ///< First keep alive\r
- TCP_KEEPALIVE_PERIOD = (TCP_TICK_HZ * 60),\r
- TCP_MAX_KEEPALIVE = 8,\r
- TCP_FIN_WAIT2_TIME = (2 * TCP_TICK_HZ),\r
- TCP_TIME_WAIT_TIME = (2 * TCP_TICK_HZ),\r
- TCP_PAWS_24DAY = (24 * 24 * 60 * 60 * TCP_TICK_HZ),\r
- TCP_CONNECT_TIME = (75 * TCP_TICK_HZ),\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
- TCP_MAX_HEAD = 192,\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
- TCP_RCV_BUF_SIZE = (2 * 1024 * 1024),\r
- TCP_RCV_BUF_SIZE_MIN = (8 * 1024),\r
- TCP_SND_BUF_SIZE = (2 * 1024 * 1024),\r
- TCP_SND_BUF_SIZE_MIN = (8 * 1024),\r
- TCP_BACKLOG = 10,\r
- TCP_BACKLOG_MIN = 5,\r
- TCP_MAX_LOSS_MIN = 6,\r
- TCP_CONNECT_TIME_MIN = (60 * TCP_TICK_HZ),\r
- TCP_MAX_KEEPALIVE_MIN = 4,\r
- TCP_KEEPALIVE_IDLE_MAX = (TCP_TICK_HZ * 60 * 60 * 4),\r
- TCP_KEEPALIVE_PERIOD_MIN= (TCP_TICK_HZ * 30),\r
- TCP_FIN_WAIT2_TIME_MAX = (4 * TCP_TICK_HZ),\r
- TCP_TIME_WAIT_TIME_MAX = (60 * TCP_TICK_HZ)\r
-} TCP_MISC_VALUES;\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
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
// configuration for tcp provided by user\r
//\r
BOOLEAN UseDefaultAddr;\r
- UINT8 TOS;\r
- UINT8 TTL;\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
#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
+// 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
+// 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
typedef\r
VOID\r
(*TCP_TIMER_HANDLER) (\r
- IN TCP_CB *Tcb\r
+ IN OUT TCP_CB *Tcb\r
);\r
\r
-#include "Tcp4Func.h"\r
#endif\r
projects / mirror_edk2.git / blobdiff