UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

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

/** @file\r
  Tcp option's routine header file.\r
\r
  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _TCP_OPTION_H_\r
#define _TCP_OPTION_H_\r
\r
//\r
// Supported TCP option types and their length.\r
//\r
#define TCP_OPTION_EOP             0  ///< End Of oPtion\r
#define TCP_OPTION_NOP             1  ///< No-Option.\r
#define TCP_OPTION_MSS             2  ///< Maximum Segment Size\r
#define TCP_OPTION_WS              3  ///< Window scale\r
#define TCP_OPTION_TS              8  ///< Timestamp\r
#define TCP_OPTION_MSS_LEN         4  ///< Length of MSS option\r
#define TCP_OPTION_WS_LEN          3  ///< Length of window scale option\r
#define TCP_OPTION_TS_LEN          10 ///< Length of timestamp option\r
#define TCP_OPTION_WS_ALIGNED_LEN  4  ///< Length of window scale option, aligned\r
#define 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
#define 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
#define TCP_OPTION_WS_FAST  ((TCP_OPTION_NOP << 24) |  \\r
                              (TCP_OPTION_WS << 16)  | \\r
                              (TCP_OPTION_WS_LEN << 8))\r
\r
#define TCP_OPTION_MSS_FAST  ((TCP_OPTION_MSS << 24) | (TCP_OPTION_MSS_LEN << 16))\r
\r
//\r
// Other misc definitions\r
//\r
#define TCP_OPTION_RCVD_MSS  0x01\r
#define TCP_OPTION_RCVD_WS   0x02\r
#define TCP_OPTION_RCVD_TS   0x04\r
#define TCP_OPTION_MAX_WS    14            ///< Maximum window scale value\r
#define TCP_OPTION_MAX_WIN   0xffff        ///< Max window size in TCP header\r
\r
///\r
/// The structure to store the parse option value.\r
/// ParseOption only parses the options, doesn't process them.\r
///\r
typedef struct _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
/**\r
  Compute the window scale value according to the given buffer size.\r
\r
  @param[in]  Tcb Pointer to the TCP_CB of this TCP instance.\r
\r
  @return         The scale value.\r
\r
**/\r
UINT8\r
TcpComputeScale (\r
  IN TCP_CB  *Tcb\r
  );\r
\r
/**\r
  Build the TCP option in three-way handshake.\r
\r
  @param[in]  Tcb     Pointer to the TCP_CB of this TCP instance.\r
  @param[in]  Nbuf    Pointer to the buffer to store the options.\r
\r
  @return             The total length of the TCP option field.\r
\r
**/\r
UINT16\r
TcpSynBuildOption (\r
  IN TCP_CB   *Tcb,\r
  IN NET_BUF  *Nbuf\r
  );\r
\r
/**\r
  Build the TCP option in synchronized states.\r
\r
  @param[in]  Tcb     Pointer to the TCP_CB of this TCP instance.\r
  @param[in]  Nbuf    Pointer to the buffer to store the options.\r
\r
  @return             The total length of the TCP option field.\r
\r
**/\r
UINT16\r
TcpBuildOption (\r
  IN TCP_CB   *Tcb,\r
  IN NET_BUF  *Nbuf\r
  );\r
\r
/**\r
  Parse the supported options.\r
\r
  @param[in]       Tcp     Pointer to the TCP_CB of this TCP instance.\r
  @param[in, out]  Option  Pointer to the TCP_OPTION used to store the\r
                           successfully pasrsed options.\r
\r
  @retval          0       The options successfully pasrsed.\r
  @retval          -1      Illegal option was found.\r
\r
**/\r
INTN\r
TcpParseOption (\r
  IN     TCP_HEAD    *Tcp,\r
  IN OUT TCP_OPTION  *Option\r
  );\r
\r
#endif\r