Sync the latest version from R8.

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

/** @file\r
\r
Copyright (c) 2005 - 2006, Intel Corporation\r
All rights reserved. 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\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
Module Name:\r
\r
  Tcp4Option.h\r
\r
Abstract:\r
\r
\r
**/\r
\r
#ifndef _TCP4_OPTION_H_\r
#define _TCP4_OPTION_H_\r
\r
//\r
// The structure to store the parse option value.\r
// ParseOption only parse the options, don't process them.\r
//\r
typedef struct s_TCP_OPTION {\r
  UINT8   Flag;     // flag such as TCP_OPTION_RCVD_MSS\r
  UINT8   WndScale; // the WndScale received\r
  UINT16  Mss;      // the Mss received\r
  UINT32  TSVal;    // the TSVal field in a timestamp option\r
  UINT32  TSEcr;    // the TSEcr field in a timestamp option\r
} TCP_OPTION;\r
\r
enum {\r
\r
  //\r
  // supported TCP option type and their length\r
  //\r
  TCP_OPTION_EOP            = 0,  // End Of oPtion\r
  TCP_OPTION_NOP            = 1,  // No-Option.\r
  TCP_OPTION_MSS            = 2,  // Maximum Segment Size\r
  TCP_OPTION_WS             = 3,  // Window scale\r
  TCP_OPTION_TS             = 8,  // Timestamp\r
  TCP_OPTION_MSS_LEN        = 4,  // length of MSS option\r
  TCP_OPTION_WS_LEN         = 3,  // length of window scale option\r
  TCP_OPTION_TS_LEN         = 10, // length of timestamp option\r
  TCP_OPTION_WS_ALIGNED_LEN = 4,  // length of window scale option, aligned\r
  TCP_OPTION_TS_ALIGNED_LEN = 12, // length of timestamp option, aligned\r
\r
  //\r
  // recommend format of timestamp window scale\r
  // option for fast process.\r
  //\r
  TCP_OPTION_TS_FAST = ((TCP_OPTION_NOP << 24) |\r
                        (TCP_OPTION_NOP << 16) |\r
                        (TCP_OPTION_TS << 8) |\r
                        TCP_OPTION_TS_LEN),\r
\r
  TCP_OPTION_WS_FAST = ((TCP_OPTION_NOP << 24) |\r
                        (TCP_OPTION_WS << 16) |\r
                        (TCP_OPTION_WS_LEN << 8)),\r
\r
  TCP_OPTION_MSS_FAST = ((TCP_OPTION_MSS << 24) |\r
                         (TCP_OPTION_MSS_LEN << 16)),\r
\r
  //\r
  // Other misc definations\r
  //\r
  TCP_OPTION_MAX_WS         = 14,     // Maxium window scale value\r
  TCP_OPTION_MAX_WIN        = 0xffff, // max window size in TCP header\r
  TCP_OPTION_RCVD_MSS       = 0x01,\r
  TCP_OPTION_RCVD_WS        = 0x02,\r
  TCP_OPTION_RCVD_TS        = 0x04\r
};\r
\r
UINT8\r
TcpComputeScale (\r
  IN TCP_CB *Tcb\r
  );\r
\r
UINT16\r
TcpSynBuildOption (\r
  IN TCP_CB  *Tcb,\r
  IN NET_BUF *Buf\r
  );\r
\r
UINT16\r
TcpBuildOption (\r
  IN TCP_CB  *Tcb,\r
  IN NET_BUF *Buf\r
  );\r
\r
INTN\r
TcpParseOption (\r
  IN TCP_HEAD   *Tcp,\r
  IN TCP_OPTION *Option\r
  );\r
\r
UINT32\r
TcpPawsOK (\r
  IN TCP_CB *Tcb,\r
  IN UINT32 TSVal\r
  );\r
\r
#endif\r