[mirror_edk2.git] / NetworkPkg / TcpDxe / TcpDispatcher.c

/** @file\r
  The implementation of a dispatch routine for processing TCP requests.\r
\r
  (C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>\r
  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "TcpMain.h"\r
\r
/**\r
  Add or remove a route entry in the IP route table associated with this TCP instance.\r
\r
  @param[in]  Tcb               Pointer to the TCP_CB of this TCP instance.\r
  @param[in]  RouteInfo         Pointer to the route information to be processed.\r
\r
  @retval EFI_SUCCESS           The operation completed successfully.\r
  @retval EFI_NOT_STARTED       The driver instance has not been started.\r
  @retval EFI_NO_MAPPING        When using the default address, configuration(DHCP,\r
                                BOOTP, RARP, etc.) is not finished yet.\r
  @retval EFI_OUT_OF_RESOURCES  Could not add the entry to the routing table.\r
  @retval EFI_NOT_FOUND         This route is not in the routing table\r
                                (when RouteInfo->DeleteRoute is TRUE).\r
  @retval EFI_ACCESS_DENIED     The route is already defined in the routing table\r
                                (when RouteInfo->DeleteRoute is FALSE).\r
**/\r
EFI_STATUS\r
Tcp4Route (\r
  IN TCP_CB           *Tcb,\r
  IN TCP4_ROUTE_INFO  *RouteInfo\r
  )\r
{\r
  IP_IO_IP_PROTOCOL  Ip;\r
\r
  Ip = Tcb->IpInfo->Ip;\r
\r
  ASSERT (Ip.Ip4 != NULL);\r
\r
  return Ip.Ip4->Routes (\r
                   Ip.Ip4,\r
                   RouteInfo->DeleteRoute,\r
                   RouteInfo->SubnetAddress,\r
                   RouteInfo->SubnetMask,\r
                   RouteInfo->GatewayAddress\r
                   );\r
}\r
\r
/**\r
  Get the operational settings of this TCPv4 instance.\r
\r
  @param[in]       Tcb           Pointer to the TCP_CB of this TCP instance.\r
  @param[in, out]  Mode          Pointer to the buffer to store the operational\r
                                 settings.\r
\r
  @retval EFI_SUCCESS            The mode data was read.\r
  @retval EFI_NOT_STARTED        No configuration data is available because this\r
                                 instance hasn't been started.\r
\r
**/\r
EFI_STATUS\r
Tcp4GetMode (\r
  IN     TCP_CB          *Tcb,\r
  IN OUT TCP4_MODE_DATA  *Mode\r
  )\r
{\r
  SOCKET                 *Sock;\r
  EFI_TCP4_CONFIG_DATA   *ConfigData;\r
  EFI_TCP4_ACCESS_POINT  *AccessPoint;\r
  EFI_TCP4_OPTION        *Option;\r
  EFI_IP4_PROTOCOL       *Ip;\r
\r
  Sock = Tcb->Sk;\r
\r
  if (!SOCK_IS_CONFIGURED (Sock) && (Mode->Tcp4ConfigData != NULL)) {\r
    return EFI_NOT_STARTED;\r
  }\r
\r
  if (Mode->Tcp4State != NULL) {\r
    *(Mode->Tcp4State) = (EFI_TCP4_CONNECTION_STATE)Tcb->State;\r
  }\r
\r
  if (Mode->Tcp4ConfigData != NULL) {\r
    ConfigData  = Mode->Tcp4ConfigData;\r
    AccessPoint = &(ConfigData->AccessPoint);\r
    Option      = ConfigData->ControlOption;\r
\r
    ConfigData->TypeOfService = Tcb->Tos;\r
    ConfigData->TimeToLive    = Tcb->Ttl;\r
\r
    AccessPoint->UseDefaultAddress = Tcb->UseDefaultAddr;\r
\r
    IP4_COPY_ADDRESS (&AccessPoint->StationAddress, &Tcb->LocalEnd.Ip);\r
\r
    IP4_COPY_ADDRESS (&AccessPoint->SubnetMask, &Tcb->SubnetMask);\r
    AccessPoint->StationPort = NTOHS (Tcb->LocalEnd.Port);\r
\r
    IP4_COPY_ADDRESS (&AccessPoint->RemoteAddress, &Tcb->RemoteEnd.Ip);\r
\r
    AccessPoint->RemotePort = NTOHS (Tcb->RemoteEnd.Port);\r
    AccessPoint->ActiveFlag = (BOOLEAN)(Tcb->State != TCP_LISTEN);\r
\r
    if (Option != NULL) {\r
      Option->ReceiveBufferSize = GET_RCV_BUFFSIZE (Tcb->Sk);\r
      Option->SendBufferSize    = GET_SND_BUFFSIZE (Tcb->Sk);\r
      Option->MaxSynBackLog     = GET_BACKLOG (Tcb->Sk);\r
\r
      Option->ConnectionTimeout = Tcb->ConnectTimeout / TCP_TICK_HZ;\r
      Option->DataRetries       = Tcb->MaxRexmit;\r
      Option->FinTimeout        = Tcb->FinWait2Timeout / TCP_TICK_HZ;\r
      Option->TimeWaitTimeout   = Tcb->TimeWaitTimeout / TCP_TICK_HZ;\r
      Option->KeepAliveProbes   = Tcb->MaxKeepAlive;\r
      Option->KeepAliveTime     = Tcb->KeepAliveIdle / TCP_TICK_HZ;\r
      Option->KeepAliveInterval = Tcb->KeepAlivePeriod / TCP_TICK_HZ;\r
\r
      Option->EnableNagle         = (BOOLEAN)(!TCP_FLG_ON (Tcb->CtrlFlag, TCP_CTRL_NO_NAGLE));\r
      Option->EnableTimeStamp     = (BOOLEAN)(!TCP_FLG_ON (Tcb->CtrlFlag, TCP_CTRL_NO_TS));\r
      Option->EnableWindowScaling = (BOOLEAN)(!TCP_FLG_ON (Tcb->CtrlFlag, TCP_CTRL_NO_WS));\r
\r
      Option->EnableSelectiveAck     = FALSE;\r
      Option->EnablePathMtuDiscovery = FALSE;\r
    }\r
  }\r
\r
  Ip = Tcb->IpInfo->Ip.Ip4;\r
  ASSERT (Ip != NULL);\r
\r
  return Ip->GetModeData (Ip, Mode->Ip4ModeData, Mode->MnpConfigData, Mode->SnpModeData);\r
}\r
\r
/**\r
  Get the operational settings of this TCPv6 instance.\r
\r
  @param[in]       Tcb           Pointer to the TCP_CB of this TCP instance.\r
  @param[in, out]  Mode          Pointer to the buffer to store the operational\r
                                 settings.\r
\r
  @retval EFI_SUCCESS            The mode data was read.\r
  @retval EFI_NOT_STARTED        No configuration data is available because this\r
                                 instance hasn't been started.\r
\r
**/\r
EFI_STATUS\r
Tcp6GetMode (\r
  IN     TCP_CB          *Tcb,\r
  IN OUT TCP6_MODE_DATA  *Mode\r
  )\r
{\r
  SOCKET                 *Sock;\r
  EFI_TCP6_CONFIG_DATA   *ConfigData;\r
  EFI_TCP6_ACCESS_POINT  *AccessPoint;\r
  EFI_TCP6_OPTION        *Option;\r
  EFI_IP6_PROTOCOL       *Ip;\r
\r
  Sock = Tcb->Sk;\r
\r
  if (!SOCK_IS_CONFIGURED (Sock) && (Mode->Tcp6ConfigData != NULL)) {\r
    return EFI_NOT_STARTED;\r
  }\r
\r
  if (Mode->Tcp6State != NULL) {\r
    *(Mode->Tcp6State) = (EFI_TCP6_CONNECTION_STATE)(Tcb->State);\r
  }\r
\r
  if (Mode->Tcp6ConfigData != NULL) {\r
    ConfigData  = Mode->Tcp6ConfigData;\r
    AccessPoint = &(ConfigData->AccessPoint);\r
    Option      = ConfigData->ControlOption;\r
\r
    ConfigData->TrafficClass = Tcb->Tos;\r
    ConfigData->HopLimit     = Tcb->Ttl;\r
\r
    AccessPoint->StationPort = NTOHS (Tcb->LocalEnd.Port);\r
    AccessPoint->RemotePort  = NTOHS (Tcb->RemoteEnd.Port);\r
    AccessPoint->ActiveFlag  = (BOOLEAN)(Tcb->State != TCP_LISTEN);\r
\r
    IP6_COPY_ADDRESS (&AccessPoint->StationAddress, &Tcb->LocalEnd.Ip);\r
    IP6_COPY_ADDRESS (&AccessPoint->RemoteAddress, &Tcb->RemoteEnd.Ip);\r
\r
    if (Option != NULL) {\r
      Option->ReceiveBufferSize = GET_RCV_BUFFSIZE (Tcb->Sk);\r
      Option->SendBufferSize    = GET_SND_BUFFSIZE (Tcb->Sk);\r
      Option->MaxSynBackLog     = GET_BACKLOG (Tcb->Sk);\r
\r
      Option->ConnectionTimeout = Tcb->ConnectTimeout / TCP_TICK_HZ;\r
      Option->DataRetries       = Tcb->MaxRexmit;\r
      Option->FinTimeout        = Tcb->FinWait2Timeout / TCP_TICK_HZ;\r
      Option->TimeWaitTimeout   = Tcb->TimeWaitTimeout / TCP_TICK_HZ;\r
      Option->KeepAliveProbes   = Tcb->MaxKeepAlive;\r
      Option->KeepAliveTime     = Tcb->KeepAliveIdle / TCP_TICK_HZ;\r
      Option->KeepAliveInterval = Tcb->KeepAlivePeriod / TCP_TICK_HZ;\r
\r
      Option->EnableNagle         = (BOOLEAN)(!TCP_FLG_ON (Tcb->CtrlFlag, TCP_CTRL_NO_NAGLE));\r
      Option->EnableTimeStamp     = (BOOLEAN)(!TCP_FLG_ON (Tcb->CtrlFlag, TCP_CTRL_NO_TS));\r
      Option->EnableWindowScaling = (BOOLEAN)(!TCP_FLG_ON (Tcb->CtrlFlag, TCP_CTRL_NO_WS));\r
\r
      Option->EnableSelectiveAck     = FALSE;\r
      Option->EnablePathMtuDiscovery = FALSE;\r
    }\r
  }\r
\r
  Ip = Tcb->IpInfo->Ip.Ip6;\r
  ASSERT (Ip != NULL);\r
\r
  return Ip->GetModeData (Ip, Mode->Ip6ModeData, Mode->MnpConfigData, Mode->SnpModeData);\r
}\r
\r
/**\r
  If TcpAp->StationPort isn't zero, check whether the access point\r
  is registered, else generate a random station port for this\r
  access point.\r
\r
  @param[in]  TcpAp              Pointer to the access point.\r
  @param[in]  IpVersion          IP_VERSION_4 or IP_VERSION_6\r
\r
  @retval EFI_SUCCESS            The check passed or the port is assigned.\r
  @retval EFI_INVALID_PARAMETER  The non-zero station port is already used.\r
  @retval EFI_OUT_OF_RESOURCES   No port can be allocated.\r
\r
**/\r
EFI_STATUS\r
TcpBind (\r
  IN TCP_ACCESS_POINT  *TcpAp,\r
  IN UINT8             IpVersion\r
  )\r
{\r
  BOOLEAN         Cycle;\r
  EFI_IP_ADDRESS  Local;\r
  UINT16          *Port;\r
  UINT16          *RandomPort;\r
\r
  if (IpVersion == IP_VERSION_4) {\r
    IP4_COPY_ADDRESS (&Local, &TcpAp->Tcp4Ap.StationAddress);\r
    Port       = &TcpAp->Tcp4Ap.StationPort;\r
    RandomPort = &mTcp4RandomPort;\r
  } else {\r
    IP6_COPY_ADDRESS (&Local, &TcpAp->Tcp6Ap.StationAddress);\r
    Port       = &TcpAp->Tcp6Ap.StationPort;\r
    RandomPort = &mTcp6RandomPort;\r
  }\r
\r
  if (0 != *Port) {\r
    //\r
    // Check if a same endpoing is bound.\r
    //\r
    if (TcpFindTcbByPeer (&Local, *Port, IpVersion)) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
  } else {\r
    //\r
    // generate a random port\r
    //\r
    Cycle = FALSE;\r
\r
    if (TCP_PORT_USER_RESERVED == *RandomPort) {\r
      *RandomPort = TCP_PORT_KNOWN;\r
    }\r
\r
    (*RandomPort)++;\r
\r
    while (TcpFindTcbByPeer (&Local, *RandomPort, IpVersion)) {\r
      (*RandomPort)++;\r
\r
      if (*RandomPort <= TCP_PORT_KNOWN) {\r
        if (Cycle) {\r
          DEBUG (\r
            (DEBUG_ERROR,\r
             "TcpBind: no port can be allocated for this pcb\n")\r
            );\r
          return EFI_OUT_OF_RESOURCES;\r
        }\r
\r
        *RandomPort = TCP_PORT_KNOWN + 1;\r
\r
        Cycle = TRUE;\r
      }\r
    }\r
\r
    *Port = *RandomPort;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Flush the Tcb add its associated protocols.\r
\r
  @param[in, out]  Tcb      Pointer to the TCP_CB to be flushed.\r
\r
**/\r
VOID\r
TcpFlushPcb (\r
  IN OUT TCP_CB  *Tcb\r
  )\r
{\r
  SOCKET  *Sock;\r
\r
  IpIoConfigIp (Tcb->IpInfo, NULL);\r
\r
  Sock = Tcb->Sk;\r
\r
  if (SOCK_IS_CONFIGURED (Sock)) {\r
    RemoveEntryList (&Tcb->List);\r
\r
    if (Sock->DevicePath != NULL) {\r
      //\r
      // Uninstall the device path protocol.\r
      //\r
      gBS->UninstallProtocolInterface (\r
             Sock->SockHandle,\r
             &gEfiDevicePathProtocolGuid,\r
             Sock->DevicePath\r
             );\r
\r
      FreePool (Sock->DevicePath);\r
      Sock->DevicePath = NULL;\r
    }\r
  }\r
\r
  NetbufFreeList (&Tcb->SndQue);\r
  NetbufFreeList (&Tcb->RcvQue);\r
  Tcb->State        = TCP_CLOSED;\r
  Tcb->RemoteIpZero = FALSE;\r
}\r
\r
/**\r
  Attach a Pcb to the socket.\r
\r
  @param[in]  Sk                 Pointer to the socket of this TCP instance.\r
\r
  @retval EFI_SUCCESS            The operation completed successfully.\r
  @retval EFI_OUT_OF_RESOURCES   Failed due to resource limits.\r
\r
**/\r
EFI_STATUS\r
TcpAttachPcb (\r
  IN SOCKET  *Sk\r
  )\r
{\r
  TCP_CB          *Tcb;\r
  TCP_PROTO_DATA  *ProtoData;\r
  IP_IO           *IpIo;\r
  EFI_STATUS      Status;\r
  VOID            *Ip;\r
  EFI_GUID        *IpProtocolGuid;\r
\r
  if (Sk->IpVersion == IP_VERSION_4) {\r
    IpProtocolGuid = &gEfiIp4ProtocolGuid;\r
  } else {\r
    IpProtocolGuid = &gEfiIp6ProtocolGuid;\r
  }\r
\r
  Tcb = AllocateZeroPool (sizeof (TCP_CB));\r
\r
  if (Tcb == NULL) {\r
    DEBUG ((DEBUG_ERROR, "TcpConfigurePcb: failed to allocate a TCB\n"));\r
\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  ProtoData = (TCP_PROTO_DATA *)Sk->ProtoReserved;\r
  IpIo      = ProtoData->TcpService->IpIo;\r
\r
  //\r
  // Create an IpInfo for this Tcb.\r
  //\r
  Tcb->IpInfo = IpIoAddIp (IpIo);\r
  if (Tcb->IpInfo == NULL) {\r
    FreePool (Tcb);\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  //\r
  // Open the new created IP instance BY_CHILD.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Tcb->IpInfo->ChildHandle,\r
                  IpProtocolGuid,\r
                  &Ip,\r
                  IpIo->Image,\r
                  Sk->SockHandle,\r
                  EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    IpIoRemoveIp (IpIo, Tcb->IpInfo);\r
    FreePool (Tcb);\r
    return Status;\r
  }\r
\r
  InitializeListHead (&Tcb->List);\r
  InitializeListHead (&Tcb->SndQue);\r
  InitializeListHead (&Tcb->RcvQue);\r
\r
  Tcb->State        = TCP_CLOSED;\r
  Tcb->Sk           = Sk;\r
  ProtoData->TcpPcb = Tcb;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Detach the Pcb of the socket.\r
\r
  @param[in, out]  Sk           Pointer to the socket of this TCP instance.\r
\r
**/\r
VOID\r
TcpDetachPcb (\r
  IN OUT SOCKET  *Sk\r
  )\r
{\r
  TCP_PROTO_DATA  *ProtoData;\r
  TCP_CB          *Tcb;\r
\r
  ProtoData = (TCP_PROTO_DATA *)Sk->ProtoReserved;\r
  Tcb       = ProtoData->TcpPcb;\r
\r
  ASSERT (Tcb != NULL);\r
\r
  TcpFlushPcb (Tcb);\r
\r
  IpIoRemoveIp (ProtoData->TcpService->IpIo, Tcb->IpInfo);\r
\r
  FreePool (Tcb);\r
\r
  ProtoData->TcpPcb = NULL;\r
}\r
\r
/**\r
  Configure the Pcb using CfgData.\r
\r
  @param[in]  Sk                 Pointer to the socket of this TCP instance.\r
  @param[in]  CfgData            Pointer to the TCP configuration data.\r
\r
  @retval EFI_SUCCESS            The operation completed successfully.\r
  @retval EFI_INVALID_PARAMETER  A same access point has been configured in\r
                                 another TCP instance.\r
  @retval EFI_OUT_OF_RESOURCES   Failed due to resource limits.\r
\r
**/\r
EFI_STATUS\r
TcpConfigurePcb (\r
  IN SOCKET           *Sk,\r
  IN TCP_CONFIG_DATA  *CfgData\r
  )\r
{\r
  IP_IO_IP_CONFIG_DATA  IpCfgData;\r
  EFI_STATUS            Status;\r
  EFI_TCP4_OPTION       *Option;\r
  TCP_PROTO_DATA        *TcpProto;\r
  TCP_CB                *Tcb;\r
  TCP_ACCESS_POINT      *TcpAp;\r
\r
  ASSERT ((CfgData != NULL) && (Sk != NULL) && (Sk->SockHandle != NULL));\r
\r
  TcpProto = (TCP_PROTO_DATA *)Sk->ProtoReserved;\r
  Tcb      = TcpProto->TcpPcb;\r
\r
  ASSERT (Tcb != NULL);\r
\r
  if (Sk->IpVersion == IP_VERSION_4) {\r
    //\r
    // Add Ip for send pkt to the peer\r
    //\r
    CopyMem (&IpCfgData.Ip4CfgData, &mIp4IoDefaultIpConfigData, sizeof (EFI_IP4_CONFIG_DATA));\r
    IpCfgData.Ip4CfgData.DefaultProtocol   = EFI_IP_PROTO_TCP;\r
    IpCfgData.Ip4CfgData.TypeOfService     = CfgData->Tcp4CfgData.TypeOfService;\r
    IpCfgData.Ip4CfgData.TimeToLive        = CfgData->Tcp4CfgData.TimeToLive;\r
    IpCfgData.Ip4CfgData.UseDefaultAddress = CfgData->Tcp4CfgData.AccessPoint.UseDefaultAddress;\r
    IP4_COPY_ADDRESS (\r
      &IpCfgData.Ip4CfgData.SubnetMask,\r
      &CfgData->Tcp4CfgData.AccessPoint.SubnetMask\r
      );\r
    IpCfgData.Ip4CfgData.ReceiveTimeout = (UINT32)(-1);\r
    IP4_COPY_ADDRESS (\r
      &IpCfgData.Ip4CfgData.StationAddress,\r
      &CfgData->Tcp4CfgData.AccessPoint.StationAddress\r
      );\r
  } else {\r
    ASSERT (Sk->IpVersion == IP_VERSION_6);\r
\r
    CopyMem (&IpCfgData.Ip6CfgData, &mIp6IoDefaultIpConfigData, sizeof (EFI_IP6_CONFIG_DATA));\r
    IpCfgData.Ip6CfgData.DefaultProtocol = EFI_IP_PROTO_TCP;\r
    IpCfgData.Ip6CfgData.TrafficClass    = CfgData->Tcp6CfgData.TrafficClass;\r
    IpCfgData.Ip6CfgData.HopLimit        = CfgData->Tcp6CfgData.HopLimit;\r
    IpCfgData.Ip6CfgData.ReceiveTimeout  = (UINT32)(-1);\r
    IP6_COPY_ADDRESS (\r
      &IpCfgData.Ip6CfgData.StationAddress,\r
      &CfgData->Tcp6CfgData.AccessPoint.StationAddress\r
      );\r
    IP6_COPY_ADDRESS (\r
      &IpCfgData.Ip6CfgData.DestinationAddress,\r
      &CfgData->Tcp6CfgData.AccessPoint.RemoteAddress\r
      );\r
  }\r
\r
  //\r
  // Configure the IP instance this Tcb consumes.\r
  //\r
  Status = IpIoConfigIp (Tcb->IpInfo, &IpCfgData);\r
  if (EFI_ERROR (Status)) {\r
    goto OnExit;\r
  }\r
\r
  if (Sk->IpVersion == IP_VERSION_4) {\r
    //\r
    // Get the default address information if the instance is configured to use default address.\r
    //\r
    IP4_COPY_ADDRESS (\r
      &CfgData->Tcp4CfgData.AccessPoint.StationAddress,\r
      &IpCfgData.Ip4CfgData.StationAddress\r
      );\r
    IP4_COPY_ADDRESS (\r
      &CfgData->Tcp4CfgData.AccessPoint.SubnetMask,\r
      &IpCfgData.Ip4CfgData.SubnetMask\r
      );\r
\r
    TcpAp = (TCP_ACCESS_POINT *)&CfgData->Tcp4CfgData.AccessPoint;\r
  } else {\r
    IP6_COPY_ADDRESS (\r
      &CfgData->Tcp6CfgData.AccessPoint.StationAddress,\r
      &IpCfgData.Ip6CfgData.StationAddress\r
      );\r
\r
    TcpAp = (TCP_ACCESS_POINT *)&CfgData->Tcp6CfgData.AccessPoint;\r
  }\r
\r
  //\r
  // check if we can bind this endpoint in CfgData\r
  //\r
  Status = TcpBind (TcpAp, Sk->IpVersion);\r
\r
  if (EFI_ERROR (Status)) {\r
    DEBUG (\r
      (DEBUG_ERROR,\r
       "TcpConfigurePcb: Bind endpoint failed with %r\n",\r
       Status)\r
      );\r
\r
    goto OnExit;\r
  }\r
\r
  //\r
  // Initialize the operating information in this Tcb\r
  //\r
  ASSERT (\r
    Tcb->State == TCP_CLOSED &&\r
    IsListEmpty (&Tcb->SndQue) &&\r
    IsListEmpty (&Tcb->RcvQue)\r
    );\r
\r
  TCP_SET_FLG (Tcb->CtrlFlag, TCP_CTRL_NO_KEEPALIVE);\r
  Tcb->State = TCP_CLOSED;\r
\r
  Tcb->SndMss = 536;\r
  Tcb->RcvMss = TcpGetRcvMss (Sk);\r
\r
  Tcb->SRtt = 0;\r
  Tcb->Rto  = 3 * TCP_TICK_HZ;\r
\r
  Tcb->CWnd     = Tcb->SndMss;\r
  Tcb->Ssthresh = 0xffffffff;\r
\r
  Tcb->CongestState = TCP_CONGEST_OPEN;\r
\r
  Tcb->KeepAliveIdle   = TCP_KEEPALIVE_IDLE_MIN;\r
  Tcb->KeepAlivePeriod = TCP_KEEPALIVE_PERIOD;\r
  Tcb->MaxKeepAlive    = TCP_MAX_KEEPALIVE;\r
  Tcb->MaxRexmit       = TCP_MAX_LOSS;\r
  Tcb->FinWait2Timeout = TCP_FIN_WAIT2_TIME;\r
  Tcb->TimeWaitTimeout = TCP_TIME_WAIT_TIME;\r
  Tcb->ConnectTimeout  = TCP_CONNECT_TIME;\r
\r
  if (Sk->IpVersion == IP_VERSION_4) {\r
    //\r
    // initialize Tcb in the light of CfgData\r
    //\r
    Tcb->Ttl = CfgData->Tcp4CfgData.TimeToLive;\r
    Tcb->Tos = CfgData->Tcp4CfgData.TypeOfService;\r
\r
    Tcb->UseDefaultAddr = CfgData->Tcp4CfgData.AccessPoint.UseDefaultAddress;\r
\r
    CopyMem (&Tcb->LocalEnd.Ip, &CfgData->Tcp4CfgData.AccessPoint.StationAddress, sizeof (IP4_ADDR));\r
    Tcb->LocalEnd.Port = HTONS (CfgData->Tcp4CfgData.AccessPoint.StationPort);\r
    IP4_COPY_ADDRESS (&Tcb->SubnetMask, &CfgData->Tcp4CfgData.AccessPoint.SubnetMask);\r
\r
    CopyMem (&Tcb->RemoteEnd.Ip, &CfgData->Tcp4CfgData.AccessPoint.RemoteAddress, sizeof (IP4_ADDR));\r
    Tcb->RemoteEnd.Port = HTONS (CfgData->Tcp4CfgData.AccessPoint.RemotePort);\r
\r
    Option = CfgData->Tcp4CfgData.ControlOption;\r
  } else {\r
    Tcb->Ttl = CfgData->Tcp6CfgData.HopLimit;\r
    Tcb->Tos = CfgData->Tcp6CfgData.TrafficClass;\r
\r
    IP6_COPY_ADDRESS (&Tcb->LocalEnd.Ip, &CfgData->Tcp6CfgData.AccessPoint.StationAddress);\r
    Tcb->LocalEnd.Port = HTONS (CfgData->Tcp6CfgData.AccessPoint.StationPort);\r
\r
    IP6_COPY_ADDRESS (&Tcb->RemoteEnd.Ip, &CfgData->Tcp6CfgData.AccessPoint.RemoteAddress);\r
    Tcb->RemoteEnd.Port = HTONS (CfgData->Tcp6CfgData.AccessPoint.RemotePort);\r
\r
    //\r
    // Type EFI_TCP4_OPTION and EFI_TCP6_OPTION are the same.\r
    //\r
    Option = (EFI_TCP4_OPTION *)CfgData->Tcp6CfgData.ControlOption;\r
  }\r
\r
  if (Option != NULL) {\r
    SET_RCV_BUFFSIZE (\r
      Sk,\r
      (UINT32)(TCP_COMP_VAL (\r
                 TCP_RCV_BUF_SIZE_MIN,\r
                 TCP_RCV_BUF_SIZE,\r
                 TCP_RCV_BUF_SIZE,\r
                 Option->ReceiveBufferSize\r
                 )\r
               )\r
      );\r
    SET_SND_BUFFSIZE (\r
      Sk,\r
      (UINT32)(TCP_COMP_VAL (\r
                 TCP_SND_BUF_SIZE_MIN,\r
                 TCP_SND_BUF_SIZE,\r
                 TCP_SND_BUF_SIZE,\r
                 Option->SendBufferSize\r
                 )\r
               )\r
      );\r
\r
    SET_BACKLOG (\r
      Sk,\r
      (UINT32)(TCP_COMP_VAL (\r
                 TCP_BACKLOG_MIN,\r
                 TCP_BACKLOG,\r
                 TCP_BACKLOG,\r
                 Option->MaxSynBackLog\r
                 )\r
               )\r
      );\r
\r
    Tcb->MaxRexmit = (UINT16)TCP_COMP_VAL (\r
                               TCP_MAX_LOSS_MIN,\r
                               TCP_MAX_LOSS,\r
                               TCP_MAX_LOSS,\r
                               Option->DataRetries\r
                               );\r
    Tcb->FinWait2Timeout = TCP_COMP_VAL (\r
                             TCP_FIN_WAIT2_TIME,\r
                             TCP_FIN_WAIT2_TIME_MAX,\r
                             TCP_FIN_WAIT2_TIME,\r
                             (UINT32)(Option->FinTimeout * TCP_TICK_HZ)\r
                             );\r
\r
    if (Option->TimeWaitTimeout != 0) {\r
      Tcb->TimeWaitTimeout = TCP_COMP_VAL (\r
                               TCP_TIME_WAIT_TIME,\r
                               TCP_TIME_WAIT_TIME_MAX,\r
                               TCP_TIME_WAIT_TIME,\r
                               (UINT32)(Option->TimeWaitTimeout * TCP_TICK_HZ)\r
                               );\r
    } else {\r
      Tcb->TimeWaitTimeout = 0;\r
    }\r
\r
    if (Option->KeepAliveProbes != 0) {\r
      TCP_CLEAR_FLG (Tcb->CtrlFlag, TCP_CTRL_NO_KEEPALIVE);\r
\r
      Tcb->MaxKeepAlive = (UINT8)TCP_COMP_VAL (\r
                                   TCP_MAX_KEEPALIVE_MIN,\r
                                   TCP_MAX_KEEPALIVE,\r
                                   TCP_MAX_KEEPALIVE,\r
                                   Option->KeepAliveProbes\r
                                   );\r
      Tcb->KeepAliveIdle = TCP_COMP_VAL (\r
                             TCP_KEEPALIVE_IDLE_MIN,\r
                             TCP_KEEPALIVE_IDLE_MAX,\r
                             TCP_KEEPALIVE_IDLE_MIN,\r
                             (UINT32)(Option->KeepAliveTime * TCP_TICK_HZ)\r
                             );\r
      Tcb->KeepAlivePeriod = TCP_COMP_VAL (\r
                               TCP_KEEPALIVE_PERIOD_MIN,\r
                               TCP_KEEPALIVE_PERIOD,\r
                               TCP_KEEPALIVE_PERIOD,\r
                               (UINT32)(Option->KeepAliveInterval * TCP_TICK_HZ)\r
                               );\r
    }\r
\r
    Tcb->ConnectTimeout = TCP_COMP_VAL (\r
                            TCP_CONNECT_TIME_MIN,\r
                            TCP_CONNECT_TIME,\r
                            TCP_CONNECT_TIME,\r
                            (UINT32)(Option->ConnectionTimeout * TCP_TICK_HZ)\r
                            );\r
\r
    if (!Option->EnableNagle) {\r
      TCP_SET_FLG (Tcb->CtrlFlag, TCP_CTRL_NO_NAGLE);\r
    }\r
\r
    if (!Option->EnableTimeStamp) {\r
      TCP_SET_FLG (Tcb->CtrlFlag, TCP_CTRL_NO_TS);\r
    }\r
\r
    if (!Option->EnableWindowScaling) {\r
      TCP_SET_FLG (Tcb->CtrlFlag, TCP_CTRL_NO_WS);\r
    }\r
  }\r
\r
  //\r
  // The socket is bound, the <SrcIp, SrcPort, DstIp, DstPort> is\r
  // determined, construct the IP device path and install it.\r
  //\r
  Status = TcpInstallDevicePath (Sk);\r
  if (EFI_ERROR (Status)) {\r
    goto OnExit;\r
  }\r
\r
  //\r
  // update state of Tcb and socket\r
  //\r
  if (((Sk->IpVersion == IP_VERSION_4) && !CfgData->Tcp4CfgData.AccessPoint.ActiveFlag) ||\r
      ((Sk->IpVersion == IP_VERSION_6) && !CfgData->Tcp6CfgData.AccessPoint.ActiveFlag)\r
      )\r
  {\r
    TcpSetState (Tcb, TCP_LISTEN);\r
    SockSetState (Sk, SO_LISTENING);\r
\r
    Sk->ConfigureState = SO_CONFIGURED_PASSIVE;\r
  } else {\r
    Sk->ConfigureState = SO_CONFIGURED_ACTIVE;\r
  }\r
\r
  if (Sk->IpVersion == IP_VERSION_6) {\r
    Tcb->Tick = TCP6_REFRESH_NEIGHBOR_TICK;\r
\r
    if (NetIp6IsUnspecifiedAddr (&Tcb->RemoteEnd.Ip.v6)) {\r
      Tcb->RemoteIpZero = TRUE;\r
    }\r
  }\r
\r
  TcpInsertTcb (Tcb);\r
\r
OnExit:\r
\r
  return Status;\r
}\r
\r
/**\r
  The protocol handler provided to the socket layer, which is used to\r
  dispatch the socket level requests by calling the corresponding\r
  TCP layer functions.\r
\r
  @param[in]  Sock               Pointer to the socket of this TCP instance.\r
  @param[in]  Request            The code of this operation request.\r
  @param[in]  Data               Pointer to the operation specific data passed in\r
                                 together with the operation request. This is an\r
                                 optional parameter that may be NULL.\r
\r
  @retval EFI_SUCCESS            The socket request completed successfully.\r
  @retval other                  The error status returned by the corresponding TCP\r
                                 layer function.\r
\r
**/\r
EFI_STATUS\r
TcpDispatcher (\r
  IN SOCKET  *Sock,\r
  IN UINT8   Request,\r
  IN VOID    *Data    OPTIONAL\r
  )\r
{\r
  TCP_CB          *Tcb;\r
  TCP_PROTO_DATA  *ProtoData;\r
\r
  ProtoData = (TCP_PROTO_DATA *)Sock->ProtoReserved;\r
  Tcb       = ProtoData->TcpPcb;\r
\r
  switch (Request) {\r
    case SOCK_POLL:\r
      if (Tcb->Sk->IpVersion == IP_VERSION_4) {\r
        ProtoData->TcpService->IpIo->Ip.Ip4->Poll (ProtoData->TcpService->IpIo->Ip.Ip4);\r
      } else {\r
        ProtoData->TcpService->IpIo->Ip.Ip6->Poll (ProtoData->TcpService->IpIo->Ip.Ip6);\r
      }\r
\r
      break;\r
\r
    case SOCK_CONSUMED:\r
      //\r
      // After user received data from socket buffer, socket will\r
      // notify TCP using this message to give it a chance to send out\r
      // window update information\r
      //\r
      ASSERT (Tcb != NULL);\r
      TcpOnAppConsume (Tcb);\r
      break;\r
\r
    case SOCK_SND:\r
\r
      ASSERT (Tcb != NULL);\r
      TcpOnAppSend (Tcb);\r
      break;\r
\r
    case SOCK_CLOSE:\r
\r
      TcpOnAppClose (Tcb);\r
\r
      break;\r
\r
    case SOCK_ABORT:\r
\r
      TcpOnAppAbort (Tcb);\r
\r
      break;\r
\r
    case SOCK_SNDPUSH:\r
      Tcb->SndPsh = TcpGetMaxSndNxt (Tcb) + GET_SND_DATASIZE (Tcb->Sk);\r
      TCP_SET_FLG (Tcb->CtrlFlag, TCP_CTRL_SND_PSH);\r
\r
      break;\r
\r
    case SOCK_SNDURG:\r
      Tcb->SndUp = TcpGetMaxSndNxt (Tcb) + GET_SND_DATASIZE (Tcb->Sk) - 1;\r
      TCP_SET_FLG (Tcb->CtrlFlag, TCP_CTRL_SND_URG);\r
\r
      break;\r
\r
    case SOCK_CONNECT:\r
\r
      TcpOnAppConnect (Tcb);\r
\r
      break;\r
\r
    case SOCK_ATTACH:\r
\r
      return TcpAttachPcb (Sock);\r
\r
      break;\r
\r
    case SOCK_FLUSH:\r
\r
      TcpFlushPcb (Tcb);\r
\r
      break;\r
\r
    case SOCK_DETACH:\r
\r
      TcpDetachPcb (Sock);\r
\r
      break;\r
\r
    case SOCK_CONFIGURE:\r
\r
      return TcpConfigurePcb (\r
               Sock,\r
               (TCP_CONFIG_DATA *)Data\r
               );\r
\r
      break;\r
\r
    case SOCK_MODE:\r
\r
      ASSERT ((Data != NULL) && (Tcb != NULL));\r
\r
      if (Tcb->Sk->IpVersion == IP_VERSION_4) {\r
        return Tcp4GetMode (Tcb, (TCP4_MODE_DATA *)Data);\r
      } else {\r
        return Tcp6GetMode (Tcb, (TCP6_MODE_DATA *)Data);\r
      }\r
\r
      break;\r
\r
    case SOCK_ROUTE:\r
\r
      ASSERT ((Data != NULL) && (Tcb != NULL) && (Tcb->Sk->IpVersion == IP_VERSION_4));\r
\r
      return Tcp4Route (Tcb, (TCP4_ROUTE_INFO *)Data);\r
\r
    default:\r
\r
      return EFI_UNSUPPORTED;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r