NetworkPkg/TcpDxe/TcpMain.h File Reference


Data Structures

union  TCP_CONFIG_DATA
union  TCP_ACCESS_POINT
struct  _TCP4_MODE_DATA
struct  _TCP6_MODE_DATA
struct  _TCP4_ROUTE_INFO
struct  TCP_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT

Defines

#define TCP6_KEEP_NEIGHBOR_TIME   30
#define TCP6_REFRESH_NEIGHBOR_TICK   25
#define TCP_EXPIRE_TIME   65535
#define TCP_BASE_ISS   0x4d7e980b
#define TCP_ISS_INCREMENT_1   2048
#define TCP_ISS_INCREMENT_2   100

Typedefs

typedef struct _TCP4_MODE_DATA TCP4_MODE_DATA
typedef struct _TCP6_MODE_DATA TCP6_MODE_DATA
typedef struct _TCP4_ROUTE_INFO TCP4_ROUTE_INFO

Functions

EFI_STATUS EFIAPI Tcp4GetModeData (IN EFI_TCP4_PROTOCOL *This, OUT EFI_TCP4_CONNECTION_STATE *Tcp4State, OUT EFI_TCP4_CONFIG_DATA *Tcp4ConfigData, OUT EFI_IP4_MODE_DATA *Ip4ModeData, OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData, OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData)
EFI_STATUS EFIAPI Tcp4Configure (IN EFI_TCP4_PROTOCOL *This, IN EFI_TCP4_CONFIG_DATA *TcpConfigData)
EFI_STATUS EFIAPI Tcp4Routes (IN EFI_TCP4_PROTOCOL *This, IN BOOLEAN DeleteRoute, IN EFI_IPv4_ADDRESS *SubnetAddress, IN EFI_IPv4_ADDRESS *SubnetMask, IN EFI_IPv4_ADDRESS *GatewayAddress)
EFI_STATUS EFIAPI Tcp4Connect (IN EFI_TCP4_PROTOCOL *This, IN EFI_TCP4_CONNECTION_TOKEN *ConnectionToken)
EFI_STATUS EFIAPI Tcp4Accept (IN EFI_TCP4_PROTOCOL *This, IN EFI_TCP4_LISTEN_TOKEN *ListenToken)
EFI_STATUS EFIAPI Tcp4Transmit (IN EFI_TCP4_PROTOCOL *This, IN EFI_TCP4_IO_TOKEN *Token)
EFI_STATUS EFIAPI Tcp4Receive (IN EFI_TCP4_PROTOCOL *This, IN EFI_TCP4_IO_TOKEN *Token)
EFI_STATUS EFIAPI Tcp4Close (IN EFI_TCP4_PROTOCOL *This, IN EFI_TCP4_CLOSE_TOKEN *CloseToken)
EFI_STATUS EFIAPI Tcp4Cancel (IN EFI_TCP4_PROTOCOL *This, IN EFI_TCP4_COMPLETION_TOKEN *Token)
EFI_STATUS EFIAPI Tcp4Poll (IN EFI_TCP4_PROTOCOL *This)
EFI_STATUS EFIAPI Tcp6GetModeData (IN EFI_TCP6_PROTOCOL *This, OUT EFI_TCP6_CONNECTION_STATE *Tcp6State, OUT EFI_TCP6_CONFIG_DATA *Tcp6ConfigData, OUT EFI_IP6_MODE_DATA *Ip6ModeData, OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData, OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData)
EFI_STATUS EFIAPI Tcp6Configure (IN EFI_TCP6_PROTOCOL *This, IN EFI_TCP6_CONFIG_DATA *Tcp6ConfigData)
EFI_STATUS EFIAPI Tcp6Connect (IN EFI_TCP6_PROTOCOL *This, IN EFI_TCP6_CONNECTION_TOKEN *ConnectionToken)
EFI_STATUS EFIAPI Tcp6Accept (IN EFI_TCP6_PROTOCOL *This, IN EFI_TCP6_LISTEN_TOKEN *ListenToken)
EFI_STATUS EFIAPI Tcp6Transmit (IN EFI_TCP6_PROTOCOL *This, IN EFI_TCP6_IO_TOKEN *Token)
EFI_STATUS EFIAPI Tcp6Receive (IN EFI_TCP6_PROTOCOL *This, IN EFI_TCP6_IO_TOKEN *Token)
EFI_STATUS EFIAPI Tcp6Close (IN EFI_TCP6_PROTOCOL *This, IN EFI_TCP6_CLOSE_TOKEN *CloseToken)
EFI_STATUS EFIAPI Tcp6Cancel (IN EFI_TCP6_PROTOCOL *This, IN EFI_TCP6_COMPLETION_TOKEN *Token)
EFI_STATUS EFIAPI Tcp6Poll (IN EFI_TCP6_PROTOCOL *This)

Variables

UINT16 mTcp4RandomPort
UINT16 mTcp6RandomPort
CHAR16 * mTcpStateName []
EFI_COMPONENT_NAME_PROTOCOL gTcpComponentName
EFI_COMPONENT_NAME2_PROTOCOL gTcpComponentName2
EFI_UNICODE_STRING_TABLE * gTcpControllerNameTable
LIST_ENTRY mTcpRunQue
LIST_ENTRY mTcpListenQue
TCP_SEQNO mTcpGlobalIss
UINT32 mTcpTick

Detailed Description

Declaration of protocol interfaces in EFI_TCP4_PROTOCOL and EFI_TCP6_PROTOCOL. It is the common head file for all Tcp*.c in TCP driver.

Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.

This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Define Documentation

#define TCP6_KEEP_NEIGHBOR_TIME   30

30 seconds.

Referenced by TcpInput().

#define TCP6_REFRESH_NEIGHBOR_TICK   25

5 seconds, since 1 tick equals 200ms.

Referenced by TcpConfigurePcb(), and TcpInput().

#define TCP_BASE_ISS   0x4d7e980b

The implementation selects the initial send sequence number and the unit to be added when it is increased.

#define TCP_EXPIRE_TIME   65535

Referenced by TcpUpdateTimer().

#define TCP_ISS_INCREMENT_1   2048

Referenced by TcpGetIss().

#define TCP_ISS_INCREMENT_2   100

Referenced by TcpTickingDpc().


Typedef Documentation


Function Documentation

EFI_STATUS EFIAPI Tcp4Accept ( IN EFI_TCP4_PROTOCOL *  This,
IN EFI_TCP4_LISTEN_TOKEN *  ListenToken 
)

Listen on the passive instance to accept an incoming connection request.

Parameters:
[in] This Pointer to the EFI_TCP4_PROTOCOL instance.
[in] ListenToken Pointer to the listen token to return when operation finishes.
Return values:
EFI_SUCCESS The listen token has been queued successfully.
EFI_NOT_STARTED The EFI_TCP4_PROTOCOL instance hasn't been configured.
EFI_ACCESS_DENIED The instatnce is not a passive one or it is not in Tcp4StateListen state, or a same listen token has already existed in the listen token queue of this TCP instance.
EFI_INVALID_PARAMETER One or more parameters are invalid.
EFI_OUT_OF_RESOURCES Could not allocate enough resources to finish the operation.
EFI_DEVICE_ERROR An unexpected system or network error occurred.
Listen on the passive instance to accept an incoming connection request.

Parameters:
[in] This Pointer to the EFI_TCP4_PROTOCOL instance.
[in] ListenToken Pointer to the listen token to return when operation finishes.
Return values:
EFI_SUCCESS The listen token was queued successfully.
EFI_NOT_STARTED The EFI_TCP4_PROTOCOL instance hasn't been configured.
EFI_ACCESS_DENIED The instatnce is not a passive one or it is not in Tcp4StateListen state or a same listen token has already existed in the listen token queue of this TCP instance.
EFI_INVALID_PARAMETER One or more parameters are invalid.
EFI_OUT_OF_RESOURCES Could not allocate enough resources to finish the operation.
EFI_DEVICE_ERROR An unexpected system or network error occurred.

References SOCK_FROM_THIS, and SockAccept().

EFI_STATUS EFIAPI Tcp4Cancel ( IN EFI_TCP4_PROTOCOL *  This,
IN EFI_TCP4_COMPLETION_TOKEN *  Token 
)

Abort an asynchronous connection, listen, transmission or receive request.

Parameters:
[in] This Pointer to the EFI_TCP4_PROTOCOL instance.
[in] Token Pointer to a token that has been issued by Connect(), Accept(), Transmit() or Receive(). If NULL, all pending tokens issued by the above four functions will be aborted.
Return values:
EFI_UNSUPPORTED The operation is not supported in the current implementation.
Abort an asynchronous connection, listen, transmission or receive request.

Parameters:
[in] This Pointer to the EFI_TCP4_PROTOCOL instance.
[in] Token Pointer to a token that has been issued by Connect(), Accept(), Transmit() or Receive(). If NULL, all pending tokens issued by the four functions listed above will be aborted.
Return values:
EFI_UNSUPPORTED The operation is not supported in the current implementation.

EFI_STATUS EFIAPI Tcp4Close ( IN EFI_TCP4_PROTOCOL *  This,
IN EFI_TCP4_CLOSE_TOKEN *  CloseToken 
)

Disconnecting a TCP connection gracefully or reset a TCP connection.

Parameters:
[in] This Pointer to the EFI_TCP4_PROTOCOL instance.
[in] CloseToken Pointer to the close token to return when operation finishes.
Return values:
EFI_SUCCESS The operation completed successfully.
EFI_NOT_STARTED The EFI_TCP4_PROTOCOL instance hasn't been configured.
EFI_ACCESS_DENIED One or more of the following are TRUE: * Configure() has been called with TcpConfigData set to NULL and this function has not returned. Previous Close() call on this instance has not finished.
EFI_INVALID_PARAMETER One ore more parameters are invalid.
EFI_OUT_OF_RESOURCES Could not allocate enough resources to finish the operation.
EFI_DEVICE_ERROR Any unexpected error not belonging to the error categories given above.
Disconnecting a TCP connection gracefully or reset a TCP connection.

Parameters:
[in] This Pointer to the EFI_TCP4_PROTOCOL instance.
[in] CloseToken Pointer to the close token to return when operation finishes.
Return values:
EFI_SUCCESS The operation completed successfully.
EFI_NOT_STARTED The EFI_TCP4_PROTOCOL instance hasn't been configured.
EFI_ACCESS_DENIED One or more of the following are TRUE: * Configure() has been called with TcpConfigData set to NULL, and this function has not returned. Previous Close() call on this instance has not finished.
EFI_INVALID_PARAMETER One ore more parameters are invalid.
EFI_OUT_OF_RESOURCES Could not allocate enough resources to finish the operation.
EFI_DEVICE_ERROR Any unexpected category error not belonging to those listed above.

References SOCK_FROM_THIS, and SockClose().

EFI_STATUS EFIAPI Tcp4Configure ( IN EFI_TCP4_PROTOCOL *  This,
IN EFI_TCP4_CONFIG_DATA *  TcpConfigData 
)

Initialize or brutally reset the operational parameters for this EFI TCPv4 instance.

Parameters:
[in] This Pointer to the EFI_TCP4_PROTOCOL instance.
[in] TcpConfigData Pointer to the configure data to configure the instance. Optional parameter that may be NULL.
Return values:
EFI_SUCCESS The operational settings are set, changed, or reset successfully.
EFI_NO_MAPPING When using a default address, configuration (through DHCP, BOOTP, RARP, etc.) is not finished.
EFI_INVALID_PARAMETER One or more parameters are invalid.
EFI_ACCESS_DENIED Configuring the TCP instance when it is already configured.
EFI_DEVICE_ERROR An unexpected network or system error occurred.
EFI_UNSUPPORTED One or more of the control options are not supported in the implementation.
EFI_OUT_OF_RESOURCES Could not allocate enough system resources.
Initialize or brutally reset the operational parameters for this EFI TCPv4 instance.

Parameters:
[in] This Pointer to the EFI_TCP4_PROTOCOL instance.
[in] TcpConfigData Pointer to the configure data to configure the instance. Optional parameter that may be NULL.
Return values:
EFI_SUCCESS The operational settings were set, changed, or reset successfully.
EFI_NO_MAPPING When using a default address, configuration (through DHCP, BOOTP, RARP, etc.) is not finished.
EFI_INVALID_PARAMETER One or more parameters are invalid.
EFI_ACCESS_DENIED Configuring TCP instance when it is already configured.
EFI_DEVICE_ERROR An unexpected network or system error occurred.
EFI_UNSUPPORTED One or more of the control options are not supported in the implementation.
EFI_OUT_OF_RESOURCES Could not allocate enough system resources.

References _TCP_SOCKET::ConfigureState, SO_NO_MAPPING, SOCK_FROM_THIS, SockConfigure(), and SockFlush().

EFI_STATUS EFIAPI Tcp4Connect ( IN EFI_TCP4_PROTOCOL *  This,
IN EFI_TCP4_CONNECTION_TOKEN *  ConnectionToken 
)

Initiate a nonblocking TCP connection request for an active TCP instance.

Parameters:
[in] This Pointer to the EFI_TCP4_PROTOCOL instance.
[in] ConnectionToken Pointer to the connection token to return when the TCP three way handshake finishes.
Return values:
EFI_SUCCESS The connection request is successfully initiated.
EFI_NOT_STARTED This EFI_TCP4_PROTOCOL instance hasn't been configured.
EFI_ACCESS_DENIED The instance is not configured as an active one or it is not in Tcp4StateClosed state.
EFI_INVALID_PARAMETER One or more parameters are invalid.
EFI_OUT_OF_RESOURCES The driver can't allocate enough resources to initiate the active open.
EFI_DEVICE_ERROR An unexpected system or network error occurred.
Initiate a non-blocking TCP connection request for an active TCP instance.

Parameters:
[in] This Pointer to the EFI_TCP4_PROTOCOL instance.
[in] ConnectionToken Pointer to the connection token to return when the TCP three way handshake finishes.
Return values:
EFI_SUCCESS The connection request successfully initiated.
EFI_NOT_STARTED This EFI_TCP4_PROTOCOL instance hasn't been configured.
EFI_ACCESS_DENIED The instance is not configured as an active one, or it is not in Tcp4StateClosed state.
EFI_INVALID_PARAMETER One or more parameters are invalid.
EFI_OUT_OF_RESOURCES The driver can't allocate enough resources to initiate the active open.
EFI_DEVICE_ERROR An unexpected system or network error occurred.

References SOCK_FROM_THIS, and SockConnect().

EFI_STATUS EFIAPI Tcp4GetModeData ( IN EFI_TCP4_PROTOCOL *  This,
OUT EFI_TCP4_CONNECTION_STATE *  Tcp4State,
OUT EFI_TCP4_CONFIG_DATA *  Tcp4ConfigData,
OUT EFI_IP4_MODE_DATA *  Ip4ModeData,
OUT EFI_MANAGED_NETWORK_CONFIG_DATA *  MnpConfigData,
OUT EFI_SIMPLE_NETWORK_MODE *  SnpModeData 
)

Get the current operational status.

Parameters:
[in] This Pointer to the EFI_TCP4_PROTOCOL instance.
[out] Tcp4State Pointer to the buffer to receive the current TCP state. Optional parameter that may be NULL.
[out] Tcp4ConfigData Pointer to the buffer to receive the current TCP configuration. Optional parameter that may be NULL.
[out] Ip4ModeData Pointer to the buffer to receive the current IPv4 configuration. Optional parameter that may be NULL.
[out] MnpConfigData Pointer to the buffer to receive the current MNP configuration data indirectly used by the TCPv4 Instance. Optional parameter that may be NULL.
[out] SnpModeData Pointer to the buffer to receive the current SNP configuration data indirectly used by the TCPv4 Instance. Optional parameter that may be NULL.
Return values:
EFI_SUCCESS The mode data was read.
EFI_NOT_STARTED No configuration data is available because this instance hasn't been started.
EFI_INVALID_PARAMETER This is NULL.

References _TCP4_MODE_DATA::Ip4ModeData, _TCP4_MODE_DATA::MnpConfigData, _TCP4_MODE_DATA::SnpModeData, SOCK_FROM_THIS, SockGetMode(), _TCP4_MODE_DATA::Tcp4ConfigData, and _TCP4_MODE_DATA::Tcp4State.

EFI_STATUS EFIAPI Tcp4Poll ( IN EFI_TCP4_PROTOCOL *  This  ) 

Poll to receive incoming data and transmit outgoing segments.

Parameters:
[in] This Pointer to the EFI_TCP4_PROTOCOL instance.
Return values:
EFI_SUCCESS Incoming or outgoing data was processed.
EFI_INVALID_PARAMETER This is NULL.
EFI_DEVICE_ERROR An unexpected system or network error occurred.
EFI_NOT_READY No incoming or outgoing data was processed.
EFI_TIMEOUT Data was dropped out of the transmission or receive queue. Consider increasing the polling rate.

References _TCP_SOCKET::ProtoHandler, SOCK_FROM_THIS, and SOCK_POLL.

EFI_STATUS EFIAPI Tcp4Receive ( IN EFI_TCP4_PROTOCOL *  This,
IN EFI_TCP4_IO_TOKEN *  Token 
)

Place an asynchronous receive request into the receiving queue.

Parameters:
[in] This Pointer to the EFI_TCP4_PROTOCOL instance.
[in] Token Pointer to a token that is associated with the receive data descriptor.
Return values:
EFI_SUCCESS The receive completion token was cached.
EFI_NOT_STARTED The EFI_TCP4_PROTOCOL instance hasn't been configured.
EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet.
EFI_INVALID_PARAMETER One or more parameters are invalid.
EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system resources.
EFI_DEVICE_ERROR An unexpected system or network error occurred.
EFI_ACCESS_DENIED One or more of the following conditions is TRUE: A receive completion token with the same Token->CompletionToken.Event was already in the receive queue. * The current instance is in Tcp4StateClosed state. * The current instance is a passive one and it is in Tcp4StateListen state. * User has called Close() to disconnect this connection.
EFI_CONNECTION_FIN The communication peer has closed the connection and there is no buffered data in the receive buffer of this instance.
EFI_NOT_READY The receive request could not be queued because the receive queue is full.
Place an asynchronous receive request into the receiving queue.

Parameters:
[in] This Pointer to the EFI_TCP4_PROTOCOL instance.
[in] Token Pointer to a token that is associated with the receive data descriptor.
Return values:
EFI_SUCCESS The receive completion token was cached
EFI_NOT_STARTED The EFI_TCP4_PROTOCOL instance hasn't been configured.
EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet.
EFI_INVALID_PARAMETER One or more parameters are invalid.
EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system resources.
EFI_DEVICE_ERROR An unexpected system or network error occurred.
EFI_ACCESS_DENIED One or more of the following conditions is TRUE: A receive completion token with the same Token->CompletionToken.Event was already in the receive queue. * The current instance is in Tcp4StateClosed state. * The current instance is a passive one and it is in Tcp4StateListen state. * User has called Close() to disconnect this connection.
EFI_CONNECTION_FIN The communication peer has closed the connection, and there is no any buffered data in the receive buffer of this instance.
EFI_NOT_READY The receive request could not be queued because the receive queue is full.

References SOCK_FROM_THIS, SockRcv(), and TcpChkDataBuf().

EFI_STATUS EFIAPI Tcp4Routes ( IN EFI_TCP4_PROTOCOL *  This,
IN BOOLEAN  DeleteRoute,
IN EFI_IPv4_ADDRESS *  SubnetAddress,
IN EFI_IPv4_ADDRESS *  SubnetMask,
IN EFI_IPv4_ADDRESS *  GatewayAddress 
)

Add or delete routing entries.

Parameters:
[in] This Pointer to the EFI_TCP4_PROTOCOL instance.
[in] DeleteRoute If TRUE, delete the specified route from routing table; if FALSE, add the specified route to routing table.
[in] SubnetAddress The destination network.
[in] SubnetMask The subnet mask for the destination network.
[in] GatewayAddress The gateway address for this route.
Return values:
EFI_SUCCESS The operation completed successfully.
EFI_NOT_STARTED The EFI_TCP4_PROTOCOL instance has not been configured.
EFI_NO_MAPPING When using a default address, configuration (through DHCP, BOOTP, RARP, etc.) is not finished.
EFI_INVALID_PARAMETER One or more parameters are invalid.
EFI_OUT_OF_RESOURCES Could not allocate enough resources to add the entry to the routing table.
EFI_NOT_FOUND This route is not in the routing table.
EFI_ACCESS_DENIED This route is already in the routing table.
EFI_UNSUPPORTED The TCP driver does not support this operation.

References _TCP4_ROUTE_INFO::DeleteRoute, _TCP4_ROUTE_INFO::GatewayAddress, SOCK_FROM_THIS, SockRoute(), _TCP4_ROUTE_INFO::SubnetAddress, and _TCP4_ROUTE_INFO::SubnetMask.

EFI_STATUS EFIAPI Tcp4Transmit ( IN EFI_TCP4_PROTOCOL *  This,
IN EFI_TCP4_IO_TOKEN *  Token 
)

Queues outgoing data into the transmit queue

Parameters:
[in] This Pointer to the EFI_TCP4_PROTOCOL instance
[in] Token Pointer to the completion token to queue to the transmit queue
Return values:
EFI_SUCCESS The data has been queued for transmission
EFI_NOT_STARTED The EFI_TCP4_PROTOCOL instance hasn't been configured.
EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet.
EFI_INVALID_PARAMETER One or more parameters are invalid
EFI_ACCESS_DENIED One or more of the following conditions is TRUE: A transmit completion token with the same Token-> CompletionToken.Event was already in the transmission queue. * The current instance is in Tcp4StateClosed state * The current instance is a passive one and it is in Tcp4StateListen state. * User has called Close() to disconnect this connection.
EFI_NOT_READY The completion token could not be queued because the transmit queue is full.
EFI_OUT_OF_RESOURCES Could not queue the transmit data because of a resource shortage.
EFI_NETWORK_UNREACHABLE There is no route to the destination network or address.
Queues outgoing data into the transmit queue

Parameters:
[in] This Pointer to the EFI_TCP4_PROTOCOL instance.
[in] Token Pointer to the completion token to queue to the transmit queue.
Return values:
EFI_SUCCESS The data has been queued for transmission.
EFI_NOT_STARTED The EFI_TCP4_PROTOCOL instance hasn't been configured.
EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet.
EFI_INVALID_PARAMETER One or more parameters are invalid
EFI_ACCESS_DENIED One or more of the following conditions is TRUE: A transmit completion token with the same Token-> CompletionToken.Event was already in the transmission queue. * The current instance is in Tcp4StateClosed state. * The current instance is a passive one and it is in Tcp4StateListen state. * User has called Close() to disconnect this connection.
EFI_NOT_READY The completion token could not be queued because the transmit queue is full.
EFI_OUT_OF_RESOURCES Could not queue the transmit data because of a resource shortage.
EFI_NETWORK_UNREACHABLE There is no route to the destination network or address.

References SOCK_FROM_THIS, SockSend(), and TcpChkDataBuf().

EFI_STATUS EFIAPI Tcp6Accept ( IN EFI_TCP6_PROTOCOL *  This,
IN EFI_TCP6_LISTEN_TOKEN *  ListenToken 
)

Listen on the passive instance to accept an incoming connection request. This is a nonblocking operation.

The Accept() function initiates an asynchronous accept request to wait for an incoming connection on the passive TCP instance. If a remote peer successfully establishes a connection with this instance, a new TCP instance will be created and its handle will be returned in ListenToken->NewChildHandle. The newly created instance is configured by inheriting the passive instance's configuration, and is ready for use upon return. The new instance is in the Tcp6StateEstablished state.

The ListenToken->CompletionToken.Event will be signaled when a new connection is accepted, user aborts the listen or connection is reset.

This function only can be called when the current TCP instance is in Tcp6StateListen state.

Parameters:
[in] This Pointer to the EFI_TCP6_PROTOCOL instance.
[in] ListenToken Pointer to the listen token to return when the operation finishes.
Return values:
EFI_SUCCESS The listen token was been queued successfully.
EFI_NOT_STARTED This EFI TCPv6 Protocol instance has not been configured.
EFI_ACCESS_DENIED One or more of the following are TRUE:
  • This instance is not a passive instance.
  • This instance is not in Tcp6StateListen state.
  • The same listen token has already existed in the listen token queue of this TCP instance.
EFI_INVALID_PARAMETER One or more of the following are TRUE:
  • This is NULL.
  • ListenToken is NULL.
  • ListentToken->CompletionToken.Event is NULL.
EFI_OUT_OF_RESOURCES Could not allocate enough resources to finish the operation.
EFI_DEVICE_ERROR Any unexpected error not belonging to the error categories given above.
Listen on the passive instance to accept an incoming connection request. This is a nonblocking operation.

The Accept() function initiates an asynchronous accept request to wait for an incoming connection on the passive TCP instance. If a remote peer successfully establishes a connection with this instance, a new TCP instance will be created and its handle will be returned in ListenToken->NewChildHandle. The newly created instance is configured by inheriting the passive instance's configuration and is ready for use upon return. The new instance is in the Tcp6StateEstablished state.

The ListenToken->CompletionToken.Event will be signaled when a new connection is accepted, when a user aborts the listen or when a connection is reset.

This function only can be called when a current TCP instance is in Tcp6StateListen state.

Parameters:
[in] This Pointer to the EFI_TCP6_PROTOCOL instance.
[in] ListenToken Pointer to the listen token to return when operation finishes.
Return values:
EFI_SUCCESS The listen token queued successfully.
EFI_NOT_STARTED This EFI TCPv6 Protocol instance has not been configured.
EFI_ACCESS_DENIED One or more of the following are TRUE:
  • This instance is not a passive instance.
  • This instance is not in Tcp6StateListen state.
  • The same listen token has already existed in the listen token queue of this TCP instance.
EFI_INVALID_PARAMETER One or more of the following are TRUE:
  • This is NULL.
  • ListenToken is NULL.
  • ListentToken->CompletionToken.Event is NULL.
EFI_OUT_OF_RESOURCES Could not allocate enough resource to finish the operation.
EFI_DEVICE_ERROR Any unexpected error not belonging to a category listed above.

References SOCK_FROM_THIS, and SockAccept().

EFI_STATUS EFIAPI Tcp6Cancel ( IN EFI_TCP6_PROTOCOL *  This,
IN EFI_TCP6_COMPLETION_TOKEN *  Token 
)

Abort an asynchronous connection, listen, transmission or receive request.

The Cancel() function aborts a pending connection, listen, transmit or receive request.

If Token is not NULL and the token is in the connection, listen, transmission or receive queue when it is being cancelled, its Token->Status will be set to EFI_ABORTED and then Token->Event will be signaled.

If the token is not in one of the queues, which usually means that the asynchronous operation has completed, EFI_NOT_FOUND is returned.

If Token is NULL all asynchronous token issued by Connect(), Accept(), Transmit() and Receive() will be aborted.

Parameters:
[in] This Pointer to the EFI_TCP6_PROTOCOL instance.
[in] Token Pointer to a token that has been issued by EFI_TCP6_PROTOCOL.Connect(), EFI_TCP6_PROTOCOL.Accept(), EFI_TCP6_PROTOCOL.Transmit() or EFI_TCP6_PROTOCOL.Receive(). If NULL, all pending tokens issued by above four functions will be aborted. Type EFI_TCP6_COMPLETION_TOKEN is defined in EFI_TCP_PROTOCOL.Connect().
Return values:
EFI_UNSUPPORTED The implementation does not support this function.
Abort an asynchronous connection, listen, transmission, or receive request.

The Cancel() function aborts a pending connection, listen, transmit, or receive request.

If Token is not NULL and the token is in the connection, listen, transmission, or receive queue when it is being cancelled, its Token->Status will be set to EFI_ABORTED, and then Token->Event will be signaled.

If the token is not in one of the queues, which usually means that the asynchronous operation has completed, EFI_NOT_FOUND is returned.

If Token is NULL all asynchronous token issued by Connect(), Accept(), Transmit(), and Receive() will be aborted.

Parameters:
[in] This Pointer to the EFI_TCP6_PROTOCOL instance.
[in] Token Pointer to a token that has been issued by EFI_TCP6_PROTOCOL.Connect(), EFI_TCP6_PROTOCOL.Accept(), EFI_TCP6_PROTOCOL.Transmit() or EFI_TCP6_PROTOCOL.Receive(). If NULL, all pending tokens issued by above four functions will be aborted. Type EFI_TCP6_COMPLETION_TOKEN is defined in EFI_TCP_PROTOCOL.Connect().
Return values:
EFI_UNSUPPORTED The implementation does not support this function.

EFI_STATUS EFIAPI Tcp6Close ( IN EFI_TCP6_PROTOCOL *  This,
IN EFI_TCP6_CLOSE_TOKEN *  CloseToken 
)

Disconnecting a TCP connection gracefully or reset a TCP connection. This function is a nonblocking operation.

Initiate an asynchronous close token to the TCP driver. After Close() is called, any buffered transmission data will be sent by the TCP driver, and the current instance will have a graceful close working flow described as RFC 793 if AbortOnClose is set to FALSE, otherwise, a rest packet will be sent by TCP driver to fast disconnect this connection. When the close operation completes successfully the TCP instance is in Tcp6StateClosed state, all pending asynchronous operations are signaled, and any buffers used for TCP network traffic are flushed.

Parameters:
[in] This Pointer to the EFI_TCP6_PROTOCOL instance.
[in] CloseToken Pointer to the close token to return when operation finishes.
Return values:
EFI_SUCCESS The Close() was called successfully.
EFI_NOT_STARTED This EFI TCPv6 Protocol instance has not been configured.
EFI_ACCESS_DENIED One or more of the following are TRUE:
  • CloseToken or CloseToken->CompletionToken.Event is already in use.
  • Previous Close() call on this instance has not finished.
EFI_INVALID_PARAMETER One or more of the following are TRUE:
  • This is NULL.
  • CloseToken is NULL.
  • CloseToken->CompletionToken.Event is NULL.
EFI_OUT_OF_RESOURCES Could not allocate enough resources to finish the operation.
EFI_DEVICE_ERROR Any unexpected error not belonging to the error categories given above.
Disconnecting a TCP connection gracefully or reset a TCP connection. This function is a nonblocking operation.

Initiate an asynchronous close token to the TCP driver. After Close() is called, any buffered transmission data will be sent by the TCP driver, and the current instance will have a graceful close working flow described as RFC 793 if AbortOnClose is set to FALSE. Otherwise, a rest packet will be sent by TCP driver to fast disconnect this connection. When the close operation completes successfully the TCP instance is in Tcp6StateClosed state, all pending asynchronous operations are signaled, and any buffers used for TCP network traffic are flushed.

Parameters:
[in] This Pointer to the EFI_TCP6_PROTOCOL instance.
[in] CloseToken Pointer to the close token to return when operation finishes.
Return values:
EFI_SUCCESS The Close() was called successfully.
EFI_NOT_STARTED This EFI TCPv6 Protocol instance has not been configured.
EFI_ACCESS_DENIED One or more of the following are TRUE:
  • CloseToken or CloseToken->CompletionToken.Event is already in use.
  • Previous Close() call on this instance has not finished.
EFI_INVALID_PARAMETER One or more of the following are TRUE:
  • This is NULL.
  • CloseToken is NULL.
  • CloseToken->CompletionToken.Event is NULL.
EFI_OUT_OF_RESOURCES Could not allocate enough resource to finish the operation.
EFI_DEVICE_ERROR Any unexpected error not belonging to error categories given above.

References SOCK_FROM_THIS, and SockClose().

EFI_STATUS EFIAPI Tcp6Configure ( IN EFI_TCP6_PROTOCOL *  This,
IN EFI_TCP6_CONFIG_DATA *  Tcp6ConfigData 
)

Initialize or brutally reset the operational parameters for this EFI TCPv6 instance.

The Configure() function does the following:

  • Initialize this TCP instance, i.e., initialize the communication end settings and specify active open or passive open for an instance.
  • Reset this TCP instance brutally, i.e., cancel all pending asynchronous tokens, flush transmission and receiving buffer directly without informing the communication peer.

No other TCPv6 Protocol operation except Poll() can be executed by this instance until it is configured properly. For an active TCP instance, after a proper configuration it may call Connect() to initiates the three-way handshake. For a passive TCP instance, its state will transit to Tcp6StateListen after configuration, and Accept() may be called to listen the incoming TCP connection requests. If Tcp6ConfigData is set to NULL, the instance is reset. Resetting process will be done brutally, the state machine will be set to Tcp6StateClosed directly, the receive queue and transmit queue will be flushed, and no traffic is allowed through this instance.

Parameters:
[in] This Pointer to the EFI_TCP6_PROTOCOL instance.
[in] Tcp6ConfigData Pointer to the configure data to configure the instance. If Tcp6ConfigData is set to NULL, the instance is reset.
Return values:
EFI_SUCCESS The operational settings were set, changed, or reset successfully.
EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source address for this instance, but no source address was available for use.
EFI_INVALID_PARAMETER One or more of the following conditions are TRUE:
  • This is NULL.
  • Tcp6ConfigData->AccessPoint.StationAddress is neither zero nor one of the configured IP addresses in the underlying IPv6 driver.
  • Tcp6ConfigData->AccessPoint.RemoteAddress isn't a valid unicast IPv6 address.
  • Tcp6ConfigData->AccessPoint.RemoteAddress is zero or Tcp6ConfigData->AccessPoint.RemotePort is zero when Tcp6ConfigData->AccessPoint.ActiveFlag is TRUE.
  • A same access point has been configured in other TCP instance properly.
EFI_ACCESS_DENIED Configuring TCP instance when it is configured without calling Configure() with NULL to reset it.
EFI_UNSUPPORTED One or more of the control options are not supported in the implementation.
EFI_OUT_OF_RESOURCES Could not allocate enough system resources when executing Configure().
EFI_DEVICE_ERROR An unexpected network or system error occurred.
Initialize or brutally reset the operational parameters for this EFI TCPv6 instance.

The Configure() function does the following:

  • Initialize this TCP instance, i.e., initialize the communication end settings and specify active open or passive open for an instance.
  • Reset this TCP instance brutally, i.e., cancel all pending asynchronous tokens, flush transmission and receiving buffer directly without informing the communication peer.

No other TCPv6 Protocol operation except Poll() can be executed by this instance until it is configured properly. For an active TCP instance, after a proper configuration it may call Connect() to initiate a three-way handshake. For a passive TCP instance, its state transits to Tcp6StateListen after configuration, and Accept() may be called to listen the incoming TCP connection requests. If Tcp6ConfigData is set to NULL, the instance is reset. The resetting process will be done brutally, the state machine will be set to Tcp6StateClosed directly, the receive queue and transmit queue will be flushed, and no traffic is allowed through this instance.

Parameters:
[in] This Pointer to the EFI_TCP6_PROTOCOL instance.
[in] Tcp6ConfigData Pointer to the configure data to configure the instance. If Tcp6ConfigData is set to NULL, the instance is reset.
Return values:
EFI_SUCCESS The operational settings were set, changed, or reset successfully.
EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source address for this instance, but no source address was available for use.
EFI_INVALID_PARAMETER One or more of the following conditions are TRUE:
  • This is NULL.
  • Tcp6ConfigData->AccessPoint.StationAddress is neither zero nor one of the configured IP addresses in the underlying IPv6 driver.
  • Tcp6ConfigData->AccessPoint.RemoteAddress isn't a valid unicast IPv6 address.
  • Tcp6ConfigData->AccessPoint.RemoteAddress is zero or Tcp6ConfigData->AccessPoint.RemotePort is zero when Tcp6ConfigData->AccessPoint.ActiveFlag is TRUE.
  • A same access point has been configured in other TCP instance properly.
EFI_ACCESS_DENIED Configuring a TCP instance when it is configured without calling Configure() with NULL to reset it.
EFI_UNSUPPORTED One or more of the control options are not supported in the implementation.
EFI_OUT_OF_RESOURCES Could not allocate enough system resources when executing Configure().
EFI_DEVICE_ERROR An unexpected network or system error occurred.

References _TCP_SOCKET::ConfigureState, SO_NO_MAPPING, SOCK_FROM_THIS, SockConfigure(), and SockFlush().

EFI_STATUS EFIAPI Tcp6Connect ( IN EFI_TCP6_PROTOCOL *  This,
IN EFI_TCP6_CONNECTION_TOKEN *  ConnectionToken 
)

Initiate a nonblocking TCP connection request for an active TCP instance.

The Connect() function will initiate an active open to the remote peer configured in current TCP instance if it is configured active. If the connection succeeds or fails due to an error, the ConnectionToken->CompletionToken.Event will be signaled, and ConnectionToken->CompletionToken.Status will be updated accordingly. This function can only be called for the TCP instance in Tcp6StateClosed state. The instance will transfer into Tcp6StateSynSent if the function returns EFI_SUCCESS. If TCP three-way handshake succeeds, its state will become Tcp6StateEstablished; otherwise, the state will return to Tcp6StateClosed.

Parameters:
[in] This Pointer to the EFI_TCP6_PROTOCOL instance.
[in] ConnectionToken Pointer to the connection token to return when the TCP three-way handshake finishes.
Return values:
EFI_SUCCESS The connection request successfully initiated and the state of this TCP instance has been changed to Tcp6StateSynSent.
EFI_NOT_STARTED This EFI TCPv6 Protocol instance has not been configured.
EFI_ACCESS_DENIED One or more of the following conditions are TRUE:
  • This instance is not configured as an active instance.
  • This instance is not in Tcp6StateClosed state.
EFI_INVALID_PARAMETER One or more of the following are TRUE:
  • This is NULL.
  • ConnectionToken is NULL.
  • ConnectionToken->CompletionToken.Event is NULL.
EFI_OUT_OF_RESOURCES The driver can't allocate enough resources to initiate the active open.
EFI_DEVICE_ERROR An unexpected system or network error occurred.
Initiate a nonblocking TCP connection request for an active TCP instance.

The Connect() function will initiate an active open to the remote peer configured in a current TCP instance if it is configured active. If the connection succeeds or fails due to any error, the ConnectionToken->CompletionToken.Event will be signaled and ConnectionToken->CompletionToken.Status will be updated accordingly. This function can only be called for the TCP instance in the Tcp6StateClosed state. The instance will transfer into Tcp6StateSynSent if the function returns EFI_SUCCESS. If a TCP three-way handshake succeeds, its state will become Tcp6StateEstablished. Otherwise, the state will return to Tcp6StateClosed.

Parameters:
[in] This Pointer to the EFI_TCP6_PROTOCOL instance.
[in] ConnectionToken Pointer to the connection token to return when the TCP three way handshake finishes.
Return values:
EFI_SUCCESS The connection request successfully initiated and the state of this TCP instance has been changed to Tcp6StateSynSent.
EFI_NOT_STARTED This EFI TCPv6 Protocol instance has not been configured.
EFI_ACCESS_DENIED One or more of the following conditions are TRUE:
  • This instance is not configured as an active one.
  • This instance is not in Tcp6StateClosed state.
EFI_INVALID_PARAMETER One or more of the following are TRUE:
  • This is NULL.
  • ConnectionToken is NULL.
  • ConnectionToken->CompletionToken.Event is NULL.
EFI_OUT_OF_RESOURCES The driver can't allocate enough resources to initiate the active open.
EFI_DEVICE_ERROR An unexpected system or network error occurred.

References SOCK_FROM_THIS, and SockConnect().

EFI_STATUS EFIAPI Tcp6GetModeData ( IN EFI_TCP6_PROTOCOL *  This,
OUT EFI_TCP6_CONNECTION_STATE *  Tcp6State,
OUT EFI_TCP6_CONFIG_DATA *  Tcp6ConfigData,
OUT EFI_IP6_MODE_DATA *  Ip6ModeData,
OUT EFI_MANAGED_NETWORK_CONFIG_DATA *  MnpConfigData,
OUT EFI_SIMPLE_NETWORK_MODE *  SnpModeData 
)

Get the current operational status.

The GetModeData() function copies the current operational settings of this EFI TCPv6 Protocol instance into user-supplied buffers. This function can also be used to retrieve the operational setting of underlying drivers such as IPv6, MNP, or SNP.

Parameters:
[in] This Pointer to the EFI_TCP6_PROTOCOL instance.
[out] Tcp6State The buffer in which the current TCP state is returned. Optional parameter that may be NULL.
[out] Tcp6ConfigData The buffer in which the current TCP configuration is returned. Optional parameter that may be NULL.
[out] Ip6ModeData The buffer in which the current IPv6 configuration data used by the TCP instance is returned. Optional parameter that may be NULL.
[out] MnpConfigData The buffer in which the current MNP configuration data used indirectly by the TCP instance is returned. Optional parameter that may be NULL.
[out] SnpModeData The buffer in which the current SNP mode data used indirectly by the TCP instance is returned. Optional parameter that may be NULL.
Return values:
EFI_SUCCESS The mode data was read.
EFI_NOT_STARTED No configuration data is available because this instance hasn't been started.
EFI_INVALID_PARAMETER This is NULL.
Get the current operational status.

The GetModeData() function copies the current operational settings of this EFI TCPv6 Protocol instance into user-supplied buffers. This function can also be used to retrieve the operational setting of underlying drivers such as IPv6, MNP, or SNP.

Parameters:
[in] This Pointer to the EFI_TCP6_PROTOCOL instance.
[out] Tcp6State The buffer in which the current TCP state is returned. Optional parameter that may be NULL.
[out] Tcp6ConfigData The buffer in which the current TCP configuration is returned. Optional parameter that may be NULL.
[out] Ip6ModeData The buffer in which the current IPv6 configuration data used by the TCP instance is returned. Optional parameter that may be NULL.
[out] MnpConfigData The buffer in which the current MNP configuration data indirectly used by the TCP instance is returned. Optional parameter that may be NULL.
[out] SnpModeData The buffer in which the current SNP mode data indirectly used by the TCP instance is returned. Optional parameter that may be NULL.
Return values:
EFI_SUCCESS The mode data was read.
EFI_NOT_STARTED No configuration data is available because this instance hasn't been started.
EFI_INVALID_PARAMETER This is NULL.

References _TCP6_MODE_DATA::Ip6ModeData, _TCP6_MODE_DATA::MnpConfigData, _TCP6_MODE_DATA::SnpModeData, SOCK_FROM_THIS, SockGetMode(), _TCP6_MODE_DATA::Tcp6ConfigData, and _TCP6_MODE_DATA::Tcp6State.

EFI_STATUS EFIAPI Tcp6Poll ( IN EFI_TCP6_PROTOCOL *  This  ) 

Poll to receive incoming data and transmit outgoing segments.

The Poll() function increases the rate that data is moved between the network and application and can be called when the TCP instance is created successfully. Its use is optional.

Parameters:
[in] This Pointer to the EFI_TCP6_PROTOCOL instance.
Return values:
EFI_SUCCESS Incoming or outgoing data was processed.
EFI_INVALID_PARAMETER This is NULL.
EFI_DEVICE_ERROR An unexpected system or network error occurred.
EFI_NOT_READY No incoming or outgoing data is processed.
EFI_TIMEOUT Data was dropped out of the transmission or receive queue. Consider increasing the polling rate.
Poll to receive incoming data and transmit outgoing segments.

The Poll() function increases the rate that data is moved between the network and application, and can be called when the TCP instance is created successfully. Its use is optional.

Parameters:
[in] This Pointer to the EFI_TCP6_PROTOCOL instance.
Return values:
EFI_SUCCESS Incoming or outgoing data was processed.
EFI_INVALID_PARAMETER This is NULL.
EFI_DEVICE_ERROR An unexpected system or network error occurred.
EFI_NOT_READY No incoming or outgoing data is processed.
EFI_TIMEOUT Data was dropped out of the transmission or receive queue. Consider increasing the polling rate.

References _TCP_SOCKET::ProtoHandler, SOCK_FROM_THIS, and SOCK_POLL.

EFI_STATUS EFIAPI Tcp6Receive ( IN EFI_TCP6_PROTOCOL *  This,
IN EFI_TCP6_IO_TOKEN *  Token 
)

Places an asynchronous receive request into the receiving queue.

The Receive() function places a completion token into the receive packet queue. This function is always asynchronous. The caller must allocate the Token->CompletionToken.Event and the FragmentBuffer used to receive data. The caller also must fill the DataLength, which represents the whole length of all FragmentBuffer. When the receive operation completes, the EFI TCPv6 Protocol driver updates the Token->CompletionToken.Status and Token->Packet.RxData fields, and the Token->CompletionToken.Event is signaled. If data is obtained, the data and its length will be copied into the FragmentTable. At the same time the full length of received data will be recorded in the DataLength fields. Providing a proper notification function and context for the event enables the user to receive the notification and receiving status. That notification function is guaranteed to not be re-entered.

Parameters:
[in] This Pointer to the EFI_TCP6_PROTOCOL instance.
[in] Token Pointer to a token that is associated with the receive data descriptor.
Return values:
EFI_SUCCESS The receive completion token was cached.
EFI_NOT_STARTED This EFI TCPv6 Protocol instance has not been configured.
EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source address for this instance, but no source address was available for use.
EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
  • This is NULL.
  • Token is NULL.
  • Token->CompletionToken.Event is NULL.
  • Token->Packet.RxData is NULL.
  • Token->Packet.RxData->DataLength is 0.
  • The Token->Packet.RxData->DataLength is not the sum of all FragmentBuffer length in FragmentTable.
EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system resources (usually memory).
EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI TCPv6 Protocol instance has been reset to startup defaults.
EFI_ACCESS_DENIED One or more of the following conditions is TRUE:
  • A receive completion token with the same Token->CompletionToken.Event was already in the receive queue.
  • The current instance is in Tcp6StateClosed state.
  • The current instance is a passive one and it is in Tcp6StateListen state.
  • The user has called Close() to disconnect this connection.
EFI_CONNECTION_FIN The communication peer has closed the connection, and there is no buffered data in the receive buffer of this instance.
EFI_NOT_READY The receive request could not be queued because the receive queue is full.
Places an asynchronous receive request into the receiving queue.

The Receive() function places a completion token into the receive packet queue. This function is always asynchronous. The caller must allocate the Token->CompletionToken.Event and the FragmentBuffer used to receive data. The caller also must fill the DataLength that represents the whole length of all FragmentBuffer. When the receive operation completes, the EFI TCPv6 Protocol driver updates the Token->CompletionToken.Status and Token->Packet.RxData fields, and the Token->CompletionToken.Event is signaled. If data obtained, the data and its length will be copied into the FragmentTable; at the same time the full length of received data will be recorded in the DataLength fields. Providing a proper notification function and context for the event enables the user to receive the notification and receiving status. That notification function is guaranteed to not be re-entered.

Parameters:
[in] This Pointer to the EFI_TCP6_PROTOCOL instance.
[in] Token Pointer to a token that is associated with the receive data descriptor.
Return values:
EFI_SUCCESS The receive completion token was cached.
EFI_NOT_STARTED This EFI TCPv6 Protocol instance has not been configured.
EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source address for this instance, but no source address was available for use.
EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
  • This is NULL.
  • Token is NULL.
  • Token->CompletionToken.Event is NULL.
  • Token->Packet.RxData is NULL.
  • Token->Packet.RxData->DataLength is 0.
  • The Token->Packet.RxData->DataLength is not the sum of all FragmentBuffer length in FragmentTable.
EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system resources (usually memory).
EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI TCPv6 Protocol instance has been reset to startup defaults.
EFI_ACCESS_DENIED One or more of the following conditions is TRUE:
  • A receive completion token with the same Token->CompletionToken.Event was already in the receive queue.
  • The current instance is in Tcp6StateClosed state.
  • The current instance is a passive one and it is in Tcp6StateListen state.
  • User has called Close() to disconnect this connection.
EFI_CONNECTION_FIN The communication peer has closed the connection and there is no buffered data in the receive buffer of this instance.
EFI_NOT_READY The receive request could not be queued because the receive queue is full.

References SOCK_FROM_THIS, SockRcv(), and TcpChkDataBuf().

EFI_STATUS EFIAPI Tcp6Transmit ( IN EFI_TCP6_PROTOCOL *  This,
IN EFI_TCP6_IO_TOKEN *  Token 
)

Queues outgoing data into the transmit queue.

The Transmit() function queues a sending request to this TCP instance along with the user data. The status of the token is updated and the event in the token will be signaled once the data is sent out or some error occurs.

Parameters:
[in] This Pointer to the EFI_TCP6_PROTOCOL instance.
[in] Token Pointer to the completion token to queue to the transmit queue.
Return values:
EFI_SUCCESS The data has been queued for transmission.
EFI_NOT_STARTED This EFI TCPv6 Protocol instance has not been configured.
EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source address for this instance, but no source address was available for use.
EFI_INVALID_PARAMETER One or more of the following are TRUE:
  • This is NULL.
  • Token is NULL.
  • Token->CompletionToken.Event is NULL.
  • Token->Packet.TxData is NULL.
  • Token->Packet.FragmentCount is zero.
  • Token->Packet.DataLength is not equal to the sum of fragment lengths.
EFI_ACCESS_DENIED One or more of the following conditions are TRUE:
  • A transmit completion token with the same Token-> CompletionToken.Event was already in the transmission queue.
  • The current instance is in Tcp6StateClosed state.
  • The current instance is a passive one and it is in Tcp6StateListen state.
  • User has called Close() to disconnect this connection.
EFI_NOT_READY The completion token could not be queued because the transmit queue is full.
EFI_OUT_OF_RESOURCES Could not queue the transmit data because of a resource shortage.
EFI_NETWORK_UNREACHABLE There is no route to the destination network or address.
Queues outgoing data into the transmit queue.

The Transmit() function queues a sending request to this TCP instance along with the user data. The status of the token is updated and the event in the token will be signaled once the data is sent out or an error occurs.

Parameters:
[in] This Pointer to the EFI_TCP6_PROTOCOL instance.
[in] Token Pointer to the completion token to queue to the transmit queue.
Return values:
EFI_SUCCESS The data has been queued for transmission.
EFI_NOT_STARTED This EFI TCPv6 Protocol instance has not been configured.
EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source address for this instance, but no source address was available for use.
EFI_INVALID_PARAMETER One or more of the following are TRUE:
  • This is NULL.
  • Token is NULL.
  • Token->CompletionToken.Event is NULL.
  • Token->Packet.TxData is NULL.
  • Token->Packet.FragmentCount is zero.
  • Token->Packet.DataLength is not equal to the sum of fragment lengths.
EFI_ACCESS_DENIED One or more of the following conditions are TRUE:
  • A transmit completion token with the same Token-> CompletionToken.Event was already in the transmission queue.
  • The current instance is in Tcp6StateClosed state.
  • The current instance is a passive one and it is in Tcp6StateListen state.
  • User has called Close() to disconnect this connection.
EFI_NOT_READY The completion token could not be queued because the transmit queue is full.
EFI_OUT_OF_RESOURCES Could not queue the transmit data because of resource shortage.
EFI_NETWORK_UNREACHABLE There is no route to the destination network or address.

References SOCK_FROM_THIS, SockSend(), and TcpChkDataBuf().


Variable Documentation

EFI_COMPONENT_NAME_PROTOCOL gTcpComponentName

EFI_COMPONENT_NAME2_PROTOCOL gTcpComponentName2

EFI Component Name 2 Protocol

Referenced by TcpDriverEntryPoint(), UpdateTcp4Name(), and UpdateTcp6Name().

EFI_UNICODE_STRING_TABLE* gTcpControllerNameTable

Referenced by TcpBind(), and TcpDriverEntryPoint().

Referenced by TcpBind(), and TcpDriverEntryPoint().

TCP_SEQNO mTcpGlobalIss

LIST_ENTRY mTcpListenQue

LIST_ENTRY mTcpRunQue

CHAR16* mTcpStateName[]

Referenced by TcpSetState(), and TcpToSendData().

UINT32 mTcpTick


Generated on Mon Sep 28 08:49:06 2015 for NetworkPkg[ALL] by  doxygen 1.5.7.1