Fix a missing doxygen parameter entry.

[mirror_edk2.git] / MdeModulePkg / Universal / Network / Tcp4Dxe / Tcp4Main.c

/** @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
  Tcp4Main.c\r
\r
Abstract:\r
\r
  Implementation of TCP4 protocol services.\r
\r
\r
**/\r
\r
#include "Tcp4Main.h"\r
\r
\r
/**\r
  Check the integrity of the data buffer.\r
\r
  @param  DataLen                  The total length of the data buffer.\r
  @param  FragmentCount            The fragment count of the fragment table.\r
  @param  FragmentTable            Pointer to the fragment table of the data\r
                                   buffer.\r
\r
  @retval EFI_SUCCESS              The integrity check is passed.\r
  @retval EFI_INVALID_PARAMETER    The integrity check is failed.\r
\r
**/\r
EFI_STATUS\r
Tcp4ChkDataBuf (\r
  IN UINT32                 DataLen,\r
  IN UINT32                 FragmentCount,\r
  IN EFI_TCP4_FRAGMENT_DATA *FragmentTable\r
  )\r
{\r
  UINT32 Index;\r
\r
  UINT32 Len;\r
\r
  for (Index = 0, Len = 0; Index < FragmentCount; Index++) {\r
    Len = Len + (UINT32) FragmentTable[Index].FragmentLength;\r
  }\r
\r
  if (DataLen != Len) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Get the current operational status.\r
  \r
  The GetModeData() function copies the current operational settings of this \r
  EFI TCPv4 Protocol instance into user-supplied buffers. This function can \r
  also be used to retrieve the operational setting of underlying drivers \r
  such as IPv4, MNP, or SNP.\r
\r
  @param  This                     Pointer to the EFI_TCP4_PROTOCOL instance.\r
  @param  Tcp4State                Pointer to the buffer to receive the current TCP\r
                                   state.\r
  @param  Tcp4ConfigData           Pointer to the buffer to receive the current TCP\r
                                   configuration.\r
  @param  Ip4ModeData              Pointer to the buffer to receive the current IPv4 \r
                                   configuration data used by the TCPv4 instance.\r
  @param  MnpConfigData            Pointer to the buffer to receive the current MNP\r
                                   configuration data indirectly used by the TCPv4\r
                                   Instance.\r
  @param  SnpModeData              Pointer to the buffer to receive the current SNP\r
                                   configuration data indirectly used by the TCPv4\r
                                   Instance.\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
  @retval EFI_INVALID_PARAMETER    This is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tcp4GetModeData (\r
  IN     CONST EFI_TCP4_PROTOCOL                  *This,\r
     OUT       EFI_TCP4_CONNECTION_STATE          *Tcp4State       OPTIONAL,\r
     OUT       EFI_TCP4_CONFIG_DATA               *Tcp4ConfigData  OPTIONAL,\r
     OUT       EFI_IP4_MODE_DATA                  *Ip4ModeData     OPTIONAL,\r
     OUT       EFI_MANAGED_NETWORK_CONFIG_DATA    *MnpConfigData   OPTIONAL,\r
     OUT       EFI_SIMPLE_NETWORK_MODE            *SnpModeData     OPTIONAL\r
  )\r
{\r
  TCP4_MODE_DATA  TcpMode;\r
  SOCKET          *Sock;\r
\r
  if (NULL == This) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Sock                    = SOCK_FROM_THIS (This);\r
\r
  TcpMode.Tcp4State       = Tcp4State;\r
  TcpMode.Tcp4ConfigData  = Tcp4ConfigData;\r
  TcpMode.Ip4ModeData     = Ip4ModeData;\r
  TcpMode.MnpConfigData   = MnpConfigData;\r
  TcpMode.SnpModeData     = SnpModeData;\r
\r
  return SockGetMode (Sock, &TcpMode);\r
}\r
\r
\r
/**\r
  Initialize or brutally reset the operational parameters for\r
  this EFI TCPv4 instance.\r
  \r
  The Configure() function does the following:\r
  * Initialize this EFI TCPv4 instance, i.e., initialize the communication end \r
  setting, specify active open or passive open for an instance.\r
  * Reset this TCPv4 instance brutally, i.e., cancel all pending asynchronous \r
  tokens, flush transmission and receiving buffer directly without informing \r
  the communication peer.\r
  No other TCPv4 Protocol operation can be executed by this instance \r
  until it is configured properly. For an active TCP4 instance, after a proper \r
  configuration it may call Connect() to initiates the three-way handshake. \r
  For a passive TCP4 instance, its state will transit to Tcp4StateListen after \r
  configuration, and Accept() may be called to listen the incoming TCP connection \r
  request. If TcpConfigData is set to NULL, the instance is reset. Resetting \r
  process will be done brutally, the state machine will be set to Tcp4StateClosed \r
  directly, the receive queue and transmit queue will be flushed, and no traffic is \r
  allowed through this instance.\r
\r
  @param  This                     Pointer to the EFI_TCP4_PROTOCOL instance.\r
  @param  TcpConfigData            Pointer to the configure data to configure the\r
                                   instance.\r
\r
  @retval EFI_SUCCESS              The operational settings are set, changed, or\r
                                   reset successfully.\r
  @retval EFI_NO_MAPPING           When using a default address, configuration\r
                                   (through DHCP, BOOTP, RARP, etc.) is not\r
                                   finished.\r
  @retval EFI_INVALID_PARAMETER    One or more parameters are invalid.\r
  @retval EFI_ACCESS_DENIED        Configuring TCP instance when it is already\r
                                   configured.\r
  @retval EFI_DEVICE_ERROR         An unexpected network or system error occurred.\r
  @retval EFI_UNSUPPORTED          One or more of the control options are not\r
                                   supported in the implementation.\r
  @retval EFI_OUT_OF_RESOURCES     Could not allocate enough system resources.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tcp4Configure (\r
  IN EFI_TCP4_PROTOCOL        *This,\r
  IN EFI_TCP4_CONFIG_DATA     *TcpConfigData     OPTIONAL\r
  )\r
{\r
  EFI_TCP4_OPTION  *Option;\r
  SOCKET           *Sock;\r
  EFI_STATUS       Status;\r
  IP4_ADDR         Ip;\r
  IP4_ADDR         SubnetMask;\r
\r
  if (NULL == This) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Tcp protocol related parameter check will be conducted here\r
  //\r
  if (NULL != TcpConfigData) {\r
\r
    CopyMem (&Ip, &TcpConfigData->AccessPoint.RemoteAddress, sizeof (IP4_ADDR));\r
    if ((Ip != 0) && !Ip4IsUnicast (NTOHL (Ip), 0)) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    if (TcpConfigData->AccessPoint.ActiveFlag &&\r
      (0 == TcpConfigData->AccessPoint.RemotePort || (Ip == 0))) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    if (!TcpConfigData->AccessPoint.UseDefaultAddress) {\r
\r
      CopyMem (&Ip, &TcpConfigData->AccessPoint.StationAddress, sizeof (IP4_ADDR));\r
      CopyMem (&SubnetMask, &TcpConfigData->AccessPoint.SubnetMask, sizeof (IP4_ADDR));\r
      if (!Ip4IsUnicast (NTOHL (Ip), 0) || !IP4_IS_VALID_NETMASK (NTOHL (SubnetMask))) {\r
        return EFI_INVALID_PARAMETER;\r
      }\r
    }\r
\r
    Option = TcpConfigData->ControlOption;\r
    if ((NULL != Option) &&\r
        (Option->EnableSelectiveAck || Option->EnablePathMtuDiscovery)) {\r
      return EFI_UNSUPPORTED;\r
    }\r
  }\r
\r
  Sock = SOCK_FROM_THIS (This);\r
\r
  if (NULL == TcpConfigData) {\r
    return SockFlush (Sock);\r
  }\r
\r
  Status = SockConfigure (Sock, TcpConfigData);\r
\r
  if (EFI_NO_MAPPING == Status) {\r
    Sock->ConfigureState = SO_NO_MAPPING;\r
  }\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Add or delete routing entries.\r
  \r