4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI TCPv4(Transmission Control Protocol version 4) Protocol Definition
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The EFI TCPv4 Service Binding Protocol is used to locate EFI TCPv4 Protocol drivers to create
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and destroy child of the driver to communicate with other host using TCP protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The EFI TCPv4 Protocol provides services to send and receive data stream.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed and made available under
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncthe terms and conditions of the BSD License that accompanies this distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThe full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @par Revision Reference:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This Protocol is introduced in UEFI Specification 2.0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x00720665, 0x67EB, 0x4a99, {0xBA, 0xF7, 0xD3, 0xC3, 0x3A, 0x1C, 0x7C, 0xC9 } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x65530BC7, 0xA359, 0x410f, {0xB0, 0x10, 0x5A, 0xAD, 0xC7, 0xEC, 0x2B, 0x62 } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_TCP4_PROTOCOL EFI_TCP4_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // I/O parameters
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Access Point
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // TCP Control Options
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// TCP4 connnection state
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The Status in the CompletionToken will be set to one of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the following values if the active open succeeds or an unexpected
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// error happens:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_SUCCESS: The active open succeeds and the instance's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// state is Tcp4StateEstablished.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_CONNECTION_RESET: The connect fails because the connection is reset
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// either by instance itself or the communication peer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_CONNECTION_REFUSED: The connect fails because this connection is initiated with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// an active open and the connection is refused.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_ABORTED: The active open is aborted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_TIMEOUT: The connection establishment timer expires and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// no more specific information is available.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_NETWORK_UNREACHABLE: The active open fails because
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// an ICMP network unreachable error is received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_HOST_UNREACHABLE: The active open fails because an
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// ICMP host unreachable error is received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_PROTOCOL_UNREACHABLE: The active open fails
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// because an ICMP protocol unreachable error is received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_PORT_UNREACHABLE: The connection establishment
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// timer times out and an ICMP port unreachable error is received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_ICMP_ERROR: The connection establishment timer timeout and some other ICMP
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// error is received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_DEVICE_ERROR: An unexpected system or network error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_NO_MEDIA: There was a media error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// When transmission finishes or meets any unexpected error it will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// be set to one of the following values:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_SUCCESS: The receiving or transmission operation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// completes successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_CONNECTION_FIN: The receiving operation fails because the communication peer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// has closed the connection and there is no more data in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// receive buffer of the instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_CONNECTION_RESET: The receiving or transmission operation fails
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// because this connection is reset either by instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// itself or the communication peer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_ABORTED: The receiving or transmission is aborted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_TIMEOUT: The transmission timer expires and no more
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// specific information is available.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_NETWORK_UNREACHABLE: The transmission fails
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// because an ICMP network unreachable error is received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_HOST_UNREACHABLE: The transmission fails because an
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// ICMP host unreachable error is received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_PROTOCOL_UNREACHABLE: The transmission fails
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// because an ICMP protocol unreachable error is received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_PORT_UNREACHABLE: The transmission fails and an
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// ICMP port unreachable error is received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_ICMP_ERROR: The transmission fails and some other
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// ICMP error is received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_DEVICE_ERROR: An unexpected system or network error occurs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_NO_MEDIA: There was a media error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// When this token is used for receiving, RxData is a pointer to EFI_TCP4_RECEIVE_DATA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// When this token is used for transmitting, TxData is a pointer to EFI_TCP4_TRANSMIT_DATA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Interface definition for TCP4 protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Get the current operational status.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_TCP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Tcp4State The pointer to the buffer to receive the current TCP state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Tcp4ConfigData The pointer to the buffer to receive the current TCP configuration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Ip4ModeData The pointer to the buffer to receive the current IPv4 configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync data used by the TCPv4 instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MnpConfigData The pointer to the buffer to receive the current MNP configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync data used indirectly by the TCPv4 instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SnpModeData The pointer to the buffer to receive the current SNP configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync data used indirectly by the TCPv4 instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The mode data was read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED No configuration data is available because this instance hasn't
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Initialize or brutally reset the operational parameters for this EFI TCPv4 instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_TCP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Tcp4ConfigData The pointer to the configure data to configure the instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operational settings are set, changed, or reset
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Some parameter is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING When using a default address, configuration (through
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DHCP, BOOTP, RARP, etc.) is not finished yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED Configuring TCP instance when it is configured without
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync calling Configure() with NULL to reset it.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected network or system error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED One or more of the control options are not supported in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the implementation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Could not allocate enough system resources when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync executing Configure().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Add or delete a route entry to the route table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_TCP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DeleteRoute Set it to TRUE to delete this route from the routing table. Set it to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FALSE to add this route to the routing table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DestinationAddress and SubnetMask are used as the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync keywords to search route entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SubnetAddress The destination network.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SubnetMask The subnet mask of the destination network.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param GatewayAddress The gateway address for this route. It must be on the same
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync subnet with the station address unless a direct route is specified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The EFI TCPv4 Protocol instance has not been configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RARP, etc.) is not finished yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - SubnetAddress is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - SubnetMask is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - GatewayAddress is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - *SubnetAddress is not NULL a valid subnet address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - *SubnetMask is not a valid subnet mask.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - *GatewayAddress is not a valid unicast IP address or it
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is not in the same subnet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Could not allocate enough resources to add the entry to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync routing table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND This route is not in the routing table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The route is already defined in the routing table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The TCP driver does not support this operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Initiate a nonblocking TCP connection request for an active TCP instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_TCP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ConnectionToken The pointer to the connection token to return when the TCP three
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync way handshake finishes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The connection request is successfully initiated and the state
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of this TCPv4 instance has been changed to Tcp4StateSynSent.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED This EFI TCPv4 Protocol instance has not been configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED One or more of the following conditions are TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This instance is not configured as an active one.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This instance is not in Tcp4StateClosed state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - ConnectionToken is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - ConnectionToken->CompletionToken.Event is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The driver can't allocate enough resource to initiate the activ eopen.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Listen on the passive instance to accept an incoming connection request. This is a nonblocking operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_TCP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ListenToken The pointer to the listen token to return when operation finishes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The listen token has been queued successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED This EFI TCPv4 Protocol instance has not been configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED One or more of the following are TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This instance is not a passive instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This instance is not in Tcp4StateListen state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - The same listen token has already existed in the listen
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync token queue of this TCP instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - ListenToken is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - ListentToken->CompletionToken.Event is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Could not allocate enough resource to finish the operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR Any unexpected and not belonged to above category error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Queues outgoing data into the transmit queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_TCP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Token The pointer to the completion token to queue to the transmit queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The data has been queued for transmission.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED This EFI TCPv4 Protocol instance has not been configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RARP, etc.) is not finished yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token->CompletionToken.Event is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token->Packet.TxData is NULL L.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token->Packet.FragmentCount is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token->Packet.DataLength is not equal to the sum of fragment lengths.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED One or more of the following conditions is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - A transmit completion token with the same Token->CompletionToken.Event
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync was already in the transmission queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - The current instance is in Tcp4StateClosed state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - The current instance is a passive one and it is in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Tcp4StateListen state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - User has called Close() to disconnect this connection.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The completion token could not be queued because the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync transmit queue is full.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data because of resource
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NETWORK_UNREACHABLE There is no route to the destination network or address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Places an asynchronous receive request into the receiving queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_TCP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Token The pointer to a token that is associated with the receive data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync descriptor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The receive completion token was cached.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED This EFI TCPv4 Protocol instance has not been configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, RARP,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync etc.) is not finished yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token->CompletionToken.Event is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token->Packet.RxData is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token->Packet.RxData->DataLength is 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - The Token->Packet.RxData->DataLength is not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the sum of all FragmentBuffer length in FragmentTable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync system resources (usually memory).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED One or more of the following conditions is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - A receive completion token with the same Token-
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync >CompletionToken.Event was already in the receive
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - The current instance is in Tcp4StateClosed state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - The current instance is a passive one and it is in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Tcp4StateListen state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - User has called Close() to disconnect this connection.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_CONNECTION_FIN The communication peer has closed the connection and there is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync no any buffered data in the receive buffer of this instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Disconnecting a TCP connection gracefully or reset a TCP connection. This function is a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync nonblocking operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_TCP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CloseToken The pointer to the close token to return when operation finishes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The Close() is called successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED This EFI TCPv4 Protocol instance has not been configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED One or more of the following are TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Configure() has been called with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TcpConfigData set to NULL and this function has
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Previous Close() call on this instance has not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - CloseToken is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - CloseToken->CompletionToken.Event is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Could not allocate enough resource to finish the operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR Any unexpected and not belonged to above category error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Abort an asynchronous connection, listen, transmission or receive request.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_TCP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Token The pointer to a token that has been issued by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_TCP4_PROTOCOL.Connect(),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_TCP4_PROTOCOL.Accept(),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_TCP4_PROTOCOL.Transmit() or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_TCP4_PROTOCOL.Receive(). If NULL, all pending
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync tokens issued by above four functions will be aborted. Type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_TCP4_COMPLETION_TOKEN is defined in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_TCP4_PROTOCOL.Connect().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The asynchronous I/O request is aborted and Token->Event
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is signaled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED This instance hasn't been configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING When using the default address, configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (DHCP, BOOTP,RARP, etc.) hasn't finished yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The asynchronous I/O request isn't found in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync transmission or receive queue. It has either
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync completed or wasn't issued by Transmit() and Receive().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The implementation does not support this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Poll to receive incoming data and transmit outgoing segments.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_TCP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Incoming or outgoing data was processed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY No incoming or outgoing data is processed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT Data was dropped out of the transmission or receive queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Consider increasing the polling rate.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The EFI_TCP4_PROTOCOL defines the EFI TCPv4 Protocol child to be used by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// any network drivers or applications to send or receive data stream.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// It can either listen on a specified port as a service or actively connected
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// to remote peer as a client. Each instance has its own independent settings,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// such as the routing table.