Fix a bug about the iSCSI DHCP dependency issue.

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

/** @file\r
  Declaration of external functions shared in TCP driver.\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
#ifndef _TCP_FUNC_H_\r
#define _TCP_FUNC_H_\r
\r
#include "TcpOption.h"\r
\r
#define TCP_COMP_VAL(Min, Max, Default, Val) \\r
  ((((Val) <= (Max)) && ((Val) >= (Min))) ? (Val) : (Default))\r
\r
/**\r
  Timeout handler prototype.\r
\r
  @param[in, out]  Tcb      Pointer to the TCP_CB of this TCP instance.\r
\r
**/\r
typedef\r
VOID\r
(*TCP_TIMER_HANDLER) (\r
  IN OUT TCP_CB *Tcb\r
  );\r
\r
//\r
// Functions in TcpMisc.c\r
//\r
\r
/**\r
  Initialize the Tcb locally related members.\r
\r
  @param[in, out]  Tcb               Pointer to the TCP_CB of this TCP instance.\r
\r
**/\r
VOID\r
TcpInitTcbLocal (\r
  IN OUT TCP_CB *Tcb\r
  );\r
\r
/**\r
  Initialize the peer related members.\r
\r
  @param[in, out]  Tcb    Pointer to the TCP_CB of this TCP instance.\r
  @param[in]       Seg    Pointer to the segment that contains the peer's intial information.\r
  @param[in]       Opt    Pointer to the options announced by the peer.\r
\r
**/\r
VOID\r
TcpInitTcbPeer (\r
  IN OUT TCP_CB     *Tcb,\r
  IN     TCP_SEG    *Seg,\r
  IN     TCP_OPTION *Opt\r
  );\r
\r
/**\r
  Try to find one Tcb whose <Ip, Port> equals to <IN Addr, IN Port>.\r
\r
  @param[in]  Addr     Pointer to the IP address needs to match.\r
  @param[in]  Port     The port number needs to match.\r
  @param[in]  Version  IP_VERSION_4 indicates TCP is running on IP4 stack.\r
                       IP_VERSION_6 indicates TCP is running on IP6 stack.\r
\r
\r
  @retval     TRUE     The Tcb which matches the <Addr Port> pairs exists.\r
  @retval     FALSE    Otherwise\r
\r
**/\r
BOOLEAN\r
TcpFindTcbByPeer (\r
  IN EFI_IP_ADDRESS  *Addr,\r
  IN TCP_PORTNO      Port,\r
  IN UINT8           Version\r
  );\r
\r
/**\r
  Locate the TCP_CB related to the socket pair.\r
\r
  @param[in]  LocalPort      The local port number.\r
  @param[in]  LocalIp        The local IP address.\r
  @param[in]  RemotePort     The remote port number.\r
  @param[in]  RemoteIp       The remote IP address.\r
  @param[in]  Version        IP_VERSION_4 indicates TCP is running on IP4 stack,\r
                             IP_VERSION_6 indicates TCP is running on IP6 stack.\r
  @param[in]  Syn            If TRUE, the listen sockets are searched.\r
\r
  @return Pointer to the related TCP_CB. If NULL, no match is found.\r
\r
**/\r
TCP_CB *\r
TcpLocateTcb (\r
  IN TCP_PORTNO      LocalPort,\r
  IN EFI_IP_ADDRESS  *LocalIp,\r
  IN TCP_PORTNO      RemotePort,\r
  IN EFI_IP_ADDRESS  *RemoteIp,\r
  IN UINT8           Version,\r
  IN BOOLEAN         Syn\r
  );\r
\r
/**\r
  Insert a Tcb into the proper queue.\r
\r
  @param[in]  Tcb               Pointer to the TCP_CB to be inserted.\r
\r
  @retval 0                     The Tcb was inserted successfully.\r
  @retval -1                    An error condition occurred.\r
\r
**/\r
INTN\r
TcpInsertTcb (\r
  IN TCP_CB *Tcb\r
  );\r
\r
/**\r
  Clone a TCP_CB from Tcb.\r
\r
  @param[in]  Tcb                   Pointer to the TCP_CB to be cloned.\r
\r
  @return Pointer to the new cloned TCP_CB. If NULL, an error condition occurred.\r
\r
**/\r
TCP_CB *\r
TcpCloneTcb (\r
  IN TCP_CB *Tcb\r
  );\r
\r
/**\r
  Compute an ISS to be used by a new connection.\r
\r
  @return The result ISS.\r
\r
**/\r
TCP_SEQNO\r
TcpGetIss (\r
  VOID\r
  );\r
\r
/**\r
  Get the local mss.\r
\r
  @param[in]  Sock        Pointer to the socket to get mss.\r
\r
  @return The mss size.\r
\r
**/\r
UINT16\r
TcpGetRcvMss (\r
  IN SOCKET  *Sock\r
  );\r
\r
/**\r
  Set the Tcb's state.\r
\r
  @param[in]  Tcb                   Pointer to the TCP_CB of this TCP instance.\r
  @param[in]  State                 The state to be set.\r
\r
**/\r
VOID\r
TcpSetState (\r
  IN TCP_CB *Tcb,\r
  IN UINT8  State\r
  );\r
\r
/**\r
  Compute the TCP segment's checksum.\r
\r
  @param[in]  Nbuf       Pointer to the buffer that contains the TCP segment.\r
  @param[in]  HeadSum    The checksum value of the fixed part of pseudo header.\r
\r
  @return The checksum value.\r
\r
**/\r
UINT16\r
TcpChecksum (\r
  IN NET_BUF *Nbuf,\r
  IN UINT16  HeadSum\r
  );\r
\r
/**\r
  Translate the information from the head of the received TCP\r
  segment Nbuf contains, and fill it into a TCP_SEG structure.\r
\r
  @param[in]       Tcb           Pointer to the TCP_CB of this TCP instance.\r
  @param[in, out]  Nbuf          Pointer to the buffer contains the TCP segment.\r
\r
  @return Pointer to the TCP_SEG that contains the translated TCP head information.\r
\r
**/\r
TCP_SEG *\r
TcpFormatNetbuf (\r
  IN     TCP_CB  *Tcb,\r
  IN OUT NET_BUF *Nbuf\r
  );\r
\r
/**\r
  Initialize an active connection,\r
\r
  @param[in, out]  Tcb          Pointer to the TCP_CB that wants to initiate a\r
                                connection.\r
\r
**/\r
VOID\r
TcpOnAppConnect (\r
  IN OUT TCP_CB  *Tcb\r
  );\r
\r
/**\r
  Application has consumed some data, check whether\r
  to send a window update ack or a delayed ack.\r
\r
  @param[in]  Tcb        Pointer to the TCP_CB of this TCP instance.\r
\r
**/\r
VOID\r
TcpOnAppConsume (\r
  IN TCP_CB *Tcb\r
  );\r
\r
/**\r
  Initiate the connection close procedure, called when\r
  applications want to close the connection.\r
\r
  @param[in, out]  Tcb          Pointer to the TCP_CB of this TCP instance.\r
\r
**/\r
VOID\r
TcpOnAppClose (\r
  IN OUT TCP_CB *Tcb\r
  );\r
\r
/**\r
  Check whether the application's newly delivered data can be sent out.\r
\r
  @param[in, out]  Tcb          Pointer to the TCP_CB of this TCP instance.\r
\r
  @retval 0                     The data has been sent out successfully.\r
  @retval -1                    The Tcb is not in a state that data is permitted to\r
                                be sent out.\r
\r
**/\r
INTN\r
TcpOnAppSend (\r
  IN OUT TCP_CB *Tcb\r
  );\r
\r
/**\r
  Abort the connection by sending a reset segment: called\r
  when the application wants to abort the connection.\r
\r
  @param[in]  Tcb                   Pointer to the TCP_CB of the TCP instance.\r
\r
**/\r
VOID\r
TcpOnAppAbort (\r
  IN TCP_CB *Tcb\r
  );\r
\r
/**\r
  Reset the connection related with Tcb.\r
\r
  @param[in]  Tcb         Pointer to the TCP_CB of the connection to be reset.\r
\r
**/\r
VOID\r
TcpResetConnection (\r
  IN TCP_CB *Tcb\r
  );\r
\r
/**\r
  Set the Tcp variable data.\r
\r
  @param[in]  TcpService        Tcp service data.\r
\r
  @retval EFI_OUT_OF_RESOURCES  There are not enough resources to set the variable.\r
  @retval other                 Set variable failed.\r
\r
**/\r
EFI_STATUS\r
TcpSetVariableData (\r
  IN TCP_SERVICE_DATA  *TcpService\r
  );\r
\r
/**\r
  Clear the variable and free the resource.\r
\r
  @param[in]  TcpService            Tcp service data.\r
\r
**/\r
VOID\r
TcpClearVariableData (\r
  IN TCP_SERVICE_DATA  *TcpService\r
  );\r
\r
/**\r
  Install the device path protocol on the TCP instance.\r
\r
  @param[in]  Sock          Pointer to the socket representing the TCP instance.\r
\r
  @retval EFI_SUCCESS           The device path protocol installed.\r
  @retval other                 Failed to install the device path protocol.\r
\r
**/\r
EFI_STATUS\r
TcpInstallDevicePath (\r
  IN SOCKET *Sock\r
  );\r
\r
\r
//\r
// Functions in TcpOutput.c\r
//\r
\r
/**\r
  Compute the sequence space left in the old receive window.\r
\r
  @param[in]  Tcb     Pointer to the TCP_CB of this TCP instance.\r
\r
  @return The sequence space left in the old receive window.\r
\r
**/\r
UINT32\r
TcpRcvWinOld (\r
  IN TCP_CB *Tcb\r
  );\r
\r
/**\r
  Compute the current receive window.\r
\r
  @param[in]  Tcb     Pointer to the TCP_CB of this TCP instance.\r
\r
  @return The size of the current receive window, in bytes.\r
\r
**/\r
UINT32\r
TcpRcvWinNow (\r
  IN TCP_CB *Tcb\r
  );\r
\r
/**\r
  Get the maximum SndNxt.\r
\r
  @param[in]  Tcb     Pointer to the TCP_CB of this TCP instance.\r
\r
  @return The sequence number of the maximum SndNxt.\r
\r
**/\r
TCP_SEQNO\r
TcpGetMaxSndNxt (\r
  IN TCP_CB *Tcb\r
  );\r
\r
/**\r
  Compute how much data to send.\r
\r
  @param[in]  Tcb     Pointer to the TCP_CB of this TCP instance.\r
  @param[in]  Force   If TRUE, ignore the sender's SWS avoidance algorithm\r
                      and send out data by force.\r
\r
  @return The length of the data that can be sent. If 0, no data can be sent.\r
\r
**/\r
UINT32\r
TcpDataToSend (\r
  IN TCP_CB *Tcb,\r
  IN INTN   Force\r
  );\r
\r
/**\r
  Retransmit the segment from sequence Seq.\r
\r
  @param[in]  Tcb     Pointer to the TCP_CB of this TCP instance.\r
  @param[in]  Seq     The sequence number of the segment to be retransmitted.\r
\r
  @retval 0       The retransmission succeeded.\r
  @retval -1      An error condition occurred.\r
\r
**/\r
INTN\r
TcpRetransmit (\r
  IN TCP_CB    *Tcb,\r
  IN TCP_SEQNO Seq\r
  );\r
\r
/**\r
  Check whether to send data/SYN/FIN and piggyback an ACK.\r
\r
  @param[in, out]  Tcb     Pointer to the TCP_CB of this TCP instance.\r
  @param[in]       Force   If TRUE, ignore the sender's SWS avoidance algorithm\r
                           and send out data by force.\r
\r
  @return The number of bytes sent.\r
\r
**/\r
INTN\r
TcpToSendData (\r
  IN OUT TCP_CB *Tcb,\r
  IN     INTN   Force\r
  );\r
\r
/**\r
  Check whether to send an ACK or delayed ACK.\r
\r
  @param[in, out]  Tcb     Pointer to the TCP_CB of this TCP instance.\r
\r
**/\r
VOID\r
TcpToSendAck (\r
  IN OUT TCP_CB *Tcb\r
  );\r
\r
/**\r
  Send an ACK immediately.\r
\r
  @param[in, out]  Tcb     Pointer to the TCP_CB of this TCP instance.\r
\r
**/\r
VOID\r
TcpSendAck (\r
  IN OUT TCP_CB *Tcb\r
  );\r
\r
/**\r
  Send a zero probe segment. It can be used by keepalive and zero window probe.\r
\r
  @param[in, out]  Tcb     Pointer to the TCP_CB of this TCP instance.\r
\r
  @retval 0       The zero probe segment was sent out successfully.\r
  @retval other   An error condition occurred.\r
\r
**/\r
INTN\r
TcpSendZeroProbe (\r
  IN OUT TCP_CB *Tcb\r
  );\r
\r
/**\r
  Send a RESET segment in response to the segment received.\r
\r
  @param[in]  Tcb     Pointer to the TCP_CB of this TCP instance, may be NULL.\r
  @param[in]  Head    TCP header of the segment that triggers the reset.\r
  @param[in]  Len     Length of the segment that triggers the reset.\r
  @param[in]  Local   Local IP address.\r
  @param[in]  Remote  Remote peer's IP address.\r
  @param[in]  Version IP_VERSION_4 indicates TCP is running on IP4 stack,\r
                      IP_VERSION_6 indicates TCP is running on IP6 stack.\r
\r
  @retval     0       A reset is sent or no need to send it.\r
  @retval     -1      No reset is sent.\r
\r
**/\r
INTN\r
TcpSendReset (\r
  IN TCP_CB          *Tcb,\r
  IN TCP_HEAD        *Head,\r
  IN INT32           Len,\r
  IN EFI_IP_ADDRESS  *Local,\r
  IN EFI_IP_ADDRESS  *Remote,\r
  IN UINT8           Version\r
  );\r
\r
/**\r
  Verify that the segment is in good shape.\r
\r
  @param[in]  Nbuf    Buffer that contains the segment to be checked.\r
\r
  @retval     0       The segment is broken.\r
  @retval     1       The segment is in good shape.\r
\r
**/\r
INTN\r
TcpVerifySegment (\r
  IN NET_BUF *Nbuf\r
  );\r
\r
//\r
// Functions from TcpInput.c\r
//\r
\r
/**\r
  Process the received ICMP error messages for TCP.\r
\r
  @param[in]  Nbuf     Buffer that contains part of the TCP segment without IP header\r
                       truncated from the ICMP error packet.\r
  @param[in]  IcmpErr  The ICMP error code interpreted from an ICMP error packet.\r
  @param[in]  Src      Source address of the ICMP error message.\r
  @param[in]  Dst      Destination address of the ICMP error message.\r
  @param[in]  Version  IP_VERSION_4 indicates IP4 stack, IP_VERSION_6 indicates\r
                       IP6 stack.\r
\r
**/\r
VOID\r
TcpIcmpInput (\r
  IN NET_BUF         *Nbuf,\r
  IN UINT8           IcmpErr,\r
  IN EFI_IP_ADDRESS  *Src,\r
  IN EFI_IP_ADDRESS  *Dst,\r
  IN UINT8           Version\r
  );\r
\r
/**\r
  Process the received TCP segments.\r
\r
  @param[in]  Nbuf     Buffer that contains received TCP segment without an IP header.\r
  @param[in]  Src      Source address of the segment, or the peer's IP address.\r
  @param[in]  Dst      Destination address of the segment, or the local end's IP\r
                       address.\r
  @param[in]  Version  IP_VERSION_4 indicates IP4 stack, IP_VERSION_6 indicates\r
                       IP6 stack.\r
\r
  @retval 0        The segment processed successfully. It is either accepted or\r
                   discarded. But no connection is reset by the segment.\r
  @retval -1       A connection is reset by the segment.\r
\r
**/\r
INTN\r
TcpInput (\r
  IN NET_BUF         *Nbuf,\r
  IN EFI_IP_ADDRESS  *Src,\r
  IN EFI_IP_ADDRESS  *Dst,\r
  IN UINT8           Version\r
  );\r
\r
//\r
// Functions in TcpTimer.c\r
//\r
\r
/**\r
  Close the TCP connection.\r
\r
  @param[in, out]  Tcb      Pointer to the TCP_CB of this TCP instance.\r
\r
**/\r
VOID\r
TcpClose (\r
  IN OUT TCP_CB *Tcb\r
  );\r
\r
/**\r
  Heart beat timer handler, queues the DPC at TPL_CALLBACK.\r
\r
  @param[in]  Event    Timer event signaled, ignored.\r
  @param[in]  Context  Context of the timer event, ignored.\r
\r
**/\r
VOID\r
EFIAPI\r
TcpTicking (\r
  IN EFI_EVENT Event,\r
  IN VOID      *Context\r
  );\r
\r
/**\r
  Enable a TCP timer.\r
\r
  @param[in, out]  Tcb      Pointer to the TCP_CB of this TCP instance.\r
  @param[in]       Timer    The index of the timer to be enabled.\r
  @param[in]       TimeOut  The timeout value of this timer.\r
\r
**/\r
VOID\r
TcpSetTimer (\r
  IN OUT TCP_CB *Tcb,\r
  IN     UINT16 Timer,\r
  IN     UINT32 TimeOut\r
  );\r
\r
/**\r
  Clear one TCP timer.\r
\r
  @param[in, out]  Tcb      Pointer to the TCP_CB of this TCP instance.\r
  @param[in]       Timer    The index of the timer to be cleared.\r
\r
**/\r
VOID\r
TcpClearTimer (\r
  IN OUT TCP_CB *Tcb,\r
  IN     UINT16 Timer\r
  );\r
\r
/**\r
  Clear all TCP timers.\r
\r
  @param[in, out]  Tcb      Pointer to the TCP_CB of this TCP instance.\r
\r
**/\r
VOID\r
TcpClearAllTimer (\r
  IN OUT TCP_CB *Tcb\r
  );\r
\r
/**\r
  Enable the window prober timer and set the timeout value.\r
\r
  @param[in, out]  Tcb      Pointer to the TCP_CB of this TCP instance.\r
\r
**/\r
VOID\r
TcpSetProbeTimer (\r
  IN OUT TCP_CB *Tcb\r
  );\r
\r
/**\r
  Enable the keepalive timer and set the timeout value.\r
\r
  @param[in, out]  Tcb      Pointer to the TCP_CB of this TCP instance.\r
\r
**/\r
VOID\r
TcpSetKeepaliveTimer (\r
  IN OUT TCP_CB *Tcb\r
  );\r
\r
//\r
// Functions in TcpIo.c\r
//\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
/**\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 be sent.\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
/**\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
//\r
// Functions in TcpDispatcher.c\r
//\r
\r
/**\r
  The procotol handler provided to the socket layer, 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
#endif\r