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

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

/** @file\r
  The function declaration that provided for Socket Interface.\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 _SOCK_IMPL_H_\r
#define _SOCK_IMPL_H_\r
\r
#include "Socket.h"\r
#include "TcpMain.h"\r
\r
/**\r
  Signal a event with the given status.\r
\r
  @param[in] Token        The token's event is to be signaled.\r
  @param[in] TokenStatus  The status to be sent with the event.\r
\r
**/\r
#define SIGNAL_TOKEN(Token, TokenStatus) \\r
  do { \\r
    (Token)->Status = (TokenStatus); \\r
    gBS->SignalEvent ((Token)->Event); \\r
  } while (0)\r
\r
#define SOCK_HEADER_SPACE  (60 + 60 + 72)\r
\r
/**\r
  Process the TCP send data, buffer the tcp txdata and append\r
  the buffer to socket send buffer, then try to send it.\r
\r
  @param[in]  Sock              Pointer to the socket.\r
  @param[in]  TcpTxData         Pointer to the application provided send buffer.\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
SockProcessTcpSndData (\r
  IN SOCKET  *Sock,\r
  IN VOID    *TcpTxData\r
  );\r
\r
/**\r
  Get received data from the socket layer to the receive token.\r
\r
  @param[in, out]  Sock       Pointer to the socket.\r
  @param[in, out]  RcvToken   Pointer to the application provided receive token.\r
\r
  @return The length of data received in this token.\r
\r
**/\r
UINT32\r
SockProcessRcvToken (\r
  IN OUT SOCKET         *Sock,\r
  IN OUT SOCK_IO_TOKEN  *RcvToken\r
  );\r
\r
/**\r
  Flush the sndBuffer and rcvBuffer of socket.\r
\r
  @param[in, out]  Sock                  Pointer to the socket.\r
\r
**/\r
VOID\r
SockConnFlush (\r
  IN OUT SOCKET  *Sock\r
  );\r
\r
/**\r
  Cancel the tokens in the specific token list.\r
\r
  @param[in]       Token                 Pointer to the Token. If NULL, all tokens\r
                                         in SpecifiedTokenList will be canceled.\r
  @param[in, out]  SpecifiedTokenList    Pointer to the token list to be checked.\r
\r
  @retval EFI_SUCCESS          Cancel the tokens in the specific token listsuccessfully.\r
  @retval EFI_NOT_FOUND        The Token is not found in SpecifiedTokenList.\r
\r
**/\r
EFI_STATUS\r
SockCancelToken (\r
  IN     SOCK_COMPLETION_TOKEN  *Token,\r
  IN OUT LIST_ENTRY             *SpecifiedTokenList\r
  );\r
\r
/**\r
  Create a socket with initial data SockInitData.\r
\r
  @param[in]  SockInitData          Pointer to the initial data of the socket.\r
\r
  @return Pointer to the newly created socket, return NULL when exception occurred.\r
\r
**/\r
SOCKET *\r
SockCreate (\r
  IN SOCK_INIT_DATA  *SockInitData\r
  );\r
\r
/**\r
  Destroy a socket.\r
\r
  @param[in, out]  Sock                  Pointer to the socket.\r
\r
**/\r
VOID\r
SockDestroy (\r
  IN OUT SOCKET  *Sock\r
  );\r
\r
#endif\r