Fix the comments to follow UEFI Spec regarding how to check an EFI_HANDLE is valid...

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

/** @file\r
  Implementation of I/O interfaces between TCP and IpIoLib.\r
\r
  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
\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.\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
**/\r
\r
#include "TcpMain.h"\r
\r
/**\r
  Packet receive callback function provided to IP_IO, used to call\r
  the proper function to handle the packet received by IP.\r
\r
  @param[in] Status        Result of the receive request.\r
  @param[in] IcmpErr       Valid when Status is EFI_ICMP_ERROR.\r
  @param[in] NetSession    The IP session for the received packet.\r
  @param[in] Pkt           Packet received.\r
  @param[in] Context       The data provided by the user for the received packet when\r
                           the callback is registered in IP_IO_OPEN_DATA::RcvdContext.\r
                           This is an optional parameter that may be NULL.\r
\r
**/\r
VOID\r
EFIAPI\r
TcpRxCallback (\r
  IN EFI_STATUS                       Status,\r
  IN UINT8                            IcmpErr,\r
  IN EFI_NET_SESSION_DATA             *NetSession,\r
  IN NET_BUF                          *Pkt,\r
  IN VOID                             *Context    OPTIONAL\r
  )\r
{\r
  if (EFI_SUCCESS == Status) {\r
    TcpInput (Pkt, &NetSession->Source, &NetSession->Dest, NetSession->IpVersion);\r
  } else {\r
    TcpIcmpInput (\r
      Pkt,\r
      IcmpErr,\r
      &NetSession->Source,\r
      &NetSession->Dest,\r
      NetSession->IpVersion\r
      );\r
  }\r
}\r
\r
/**\r
  Send the segment to IP via IpIo function.\r
\r
  @param[in]  Tcb                Pointer to the TCP_CB of this TCP instance.\r
  @param[in]  Nbuf               Pointer to the TCP segment to be sent.\r
  @param[in]  Src                Source address of the TCP segment.\r
  @param[in]  Dest               Destination address of the TCP segment.\r
  @param[in]  Version            IP_VERSION_4 or IP_VERSION_6\r
\r
  @retval 0                      The segment was sent out successfully.\r
  @retval -1                     The segment failed to send.\r
\r
**/\r
INTN\r
TcpSendIpPacket (\r
  IN TCP_CB          *Tcb,\r
  IN NET_BUF         *Nbuf,\r
  IN EFI_IP_ADDRESS  *Src,\r
  IN EFI_IP_ADDRESS  *Dest,\r
  IN UINT8           Version\r
  )\r
{\r
  EFI_STATUS       Status;\r
  IP_IO            *IpIo;\r
  IP_IO_OVERRIDE   Override;\r
  SOCKET           *Sock;\r
  VOID             *IpSender;\r
  TCP_PROTO_DATA  *TcpProto;\r
\r
  if (NULL == Tcb) {\r
\r
    IpIo     = NULL;\r
    IpSender = IpIoFindSender (&IpIo, Version, Src);\r
\r
    if (IpSender == NULL) {\r
      DEBUG ((EFI_D_WARN, "TcpSendIpPacket: No appropriate IpSender.\n"));\r
      return -1;\r
    }\r
\r
    if (Version == IP_VERSION_6) {\r
      //\r
      // It's tricky here. EFI IPv6 Spec don't allow an instance overriding the\r
      // destination address if the dest is already specified through the\r
      // configuration data. Here we get the IpIo we need and use the default IP\r
      // instance in this IpIo to send the packet. The dest address is configured\r
      // to be the unspecified address for the default IP instance.\r
      //\r
      IpSender = NULL;\r
    }\r
  } else {\r
\r
    Sock     = Tcb->Sk;\r
    TcpProto = (TCP_PROTO_DATA *) Sock->ProtoReserved;\r
    IpIo     = TcpProto->TcpService->IpIo;\r
    IpSender = Tcb->IpInfo;\r
\r
    if (Version == IP_VERSION_6) {\r
      //\r
      // It's IPv6 and this TCP segment belongs to a solid TCB, in such case\r
      // the destination address can't be overridden, so reset the Dest to NULL.\r
      //\r
      Dest = NULL;\r
    }\r
  }\r
\r
  ASSERT (Version == IpIo->IpVersion);\r
\r
  if (Version == IP_VERSION_4) {\r
    Override.Ip4OverrideData.TypeOfService = 0;\r
    Override.Ip4OverrideData.TimeToLive    = 255;\r
    Override.Ip4OverrideData.DoNotFragment = FALSE;\r
    Override.Ip4OverrideData.Protocol      = EFI_IP_PROTO_TCP;\r
    ZeroMem (&Override.Ip4OverrideData.GatewayAddress, sizeof (EFI_IPv4_ADDRESS));\r
    CopyMem (&Override.Ip4OverrideData.SourceAddress, Src, sizeof (EFI_IPv4_ADDRESS));\r
  } else {\r
    Override.Ip6OverrideData.Protocol  = EFI_IP_PROTO_TCP;\r
    Override.Ip6OverrideData.HopLimit  = 255;\r
    Override.Ip6OverrideData.FlowLabel = 0;\r
  }\r
\r
  Status = IpIoSend (IpIo, Nbuf, IpSender, NULL, NULL, Dest, &Override);\r
\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((EFI_D_ERROR, "TcpSendIpPacket: return %r error\n", Status));\r
    return -1;\r
  }\r
\r
  return 0;\r
}\r
\r
/**\r
  Refresh the remote peer's Neighbor Cache State if already exists.\r
\r
  @param[in]  Tcb                Pointer to the TCP_CB of this TCP instance.\r
  @param[in]  Neighbor           Source address of the TCP segment.\r
  @param[in]  Timeout            Time in 100-ns units that this entry will remain\r
                                 in the neighbor cache. A value of zero means that\r
                                 the entry  is permanent. A value of non-zero means\r
                                 that the entry is dynamic and will be deleted\r
                                 after Timeout.\r
\r
  @retval EFI_SUCCESS            Successfully updated the neighbor relationship.\r
  @retval EFI_NOT_STARTED        The IpIo is not configured.\r
  @retval EFI_INVALID_PARAMETER  Any input parameter is invalid.\r
  @retval EFI_OUT_OF_RESOURCES   Failed to allocate some resources.\r
  @retval EFI_NOT_FOUND          This entry is not in the neighbor table.\r
\r
**/\r
EFI_STATUS\r
Tcp6RefreshNeighbor (\r
  IN TCP_CB          *Tcb,\r
  IN EFI_IP_ADDRESS  *Neighbor,\r
  IN UINT32          Timeout\r
  )\r
{\r
  IP_IO            *IpIo;\r
  SOCKET           *Sock;\r
  TCP_PROTO_DATA  *TcpProto;\r
\r
  if (NULL == Tcb) {\r
    IpIo = NULL;\r
    IpIoFindSender (&IpIo, IP_VERSION_6, Neighbor);\r
\r
    if (IpIo == NULL) {\r
      DEBUG ((EFI_D_WARN, "Tcp6AddNeighbor: No appropriate IpIo.\n"));\r
      return EFI_NOT_STARTED;\r
    }\r
\r
  } else {\r
    Sock     = Tcb->Sk;\r
    TcpProto = (TCP_PROTO_DATA *) Sock->ProtoReserved;\r
    IpIo     = TcpProto->TcpService->IpIo;\r
  }\r
\r
  return IpIoRefreshNeighbor (IpIo, Neighbor, Timeout);\r
}\r
\r