MdePkg/Include/Protocol/Tcp6.h

   1 /** @file
   2   EFI TCPv6(Transmission Control Protocol version 6) Protocol Definition
   3   The EFI TCPv6 Service Binding Protocol is used to locate EFI TCPv6 Protocol drivers to create
   4   and destroy child of the driver to communicate with other host using TCP protocol.
   5   The EFI TCPv6 Protocol provides services to send and receive data stream.
   6
   7   Copyright (c) 2008 - 2009, Intel Corporation
   8   All rights reserved. This program and the accompanying materials
   9   are licensed and made available under the terms and conditions of the BSD License
  10   which accompanies this distribution.  The full text of the license may be found at
  11   http://opensource.org/licenses/bsd-license.php
  12
  13   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  14   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  15
  16   @par Revision Reference:
  17   This Protocol is introduced in UEFI Specification 2.2
  18
  19 **/
  20
  21 #ifndef __EFI_TCP6_PROTOCOL_H__
  22 #define __EFI_TCP6_PROTOCOL_H__
  23
  24 #include <Protocol/ManagedNetwork.h>
  25 #include <Protocol/Ip6.h>
  26
  27 #define EFI_TCP6_SERVICE_BINDING_PROTOCOL_GUID \
  28   { \
  29     0xec20eb79, 0x6c1a, 0x4664, {0x9a, 0x0d, 0xd2, 0xe4, 0xcc, 0x16, 0xd6, 0x64 } \
  30   }
  31
  32 #define EFI_TCP6_PROTOCOL_GUID \
  33   { \
  34     0x46e44855, 0xbd60, 0x4ab7, {0xab, 0x0d, 0xa6, 0x79, 0xb9, 0x44, 0x7d, 0x77 } \
  35   }
  36
  37
  38 typedef struct _EFI_TCP6_PROTOCOL EFI_TCP6_PROTOCOL;
  39
  40 ///
  41 /// EFI_TCP6_SERVICE_POINT
  42 ///
  43 typedef struct {
  44   ///
  45   /// The EFI TCPv6 Protocol instance handle that is using this
  46   /// address/port pair.
  47   ///
  48   EFI_HANDLE        InstanceHandle;
  49   ///
  50   /// The local IPv6 address to which this TCP instance is bound. Set
  51   /// to 0::/128, if this TCP instance is configured to listen on all
  52   /// available source addresses.
  53   ///
  54   EFI_IPv6_ADDRESS  LocalAddress;
  55   ///
  56   /// The local port number in host byte order.
  57   ///
  58   UINT16            LocalPort;
  59   ///
  60   /// The remote IPv6 address. It may be 0::/128 if this TCP instance is
  61   /// not connected to any remote host.
  62   ///
  63   EFI_IPv6_ADDRESS  RemoteAddress;
  64   ///
  65   /// The remote port number in host byte order. It may be zero if this
  66   /// TCP instance is not connected to any remote host.
  67   ///
  68   UINT16            RemotePort;
  69 } EFI_TCP6_SERVICE_POINT;
  70
  71 ///
  72 /// EFI_TCP6_VARIABLE_DATA
  73 ///
  74 typedef struct {
  75   EFI_HANDLE             DriverHandle; ///< The handle of the driver that creates this entry.
  76   UINT32                 ServiceCount; ///< The number of address/port pairs following this data structure.
  77   EFI_TCP6_SERVICE_POINT Services[1];  ///< List of address/port pairs that are currently in use.
  78 } EFI_TCP6_VARIABLE_DATA;
  79
  80 ///
  81 /// EFI_TCP6_ACCESS_POINT
  82 ///
  83 typedef struct {
  84   ///
  85   /// The local IP address assigned to this TCP instance. The EFI
  86   /// TCPv6 driver will only deliver incoming packets whose
  87   /// destination addresses exactly match the IP address. Set to zero to
  88   /// let the underlying IPv6 driver choose a source address. If not zero
  89   /// it must be one of the configured IP addresses in the underlying
  90   /// IPv6 driver.
  91   ///
  92   EFI_IPv6_ADDRESS  StationAddress;
  93   ///
  94   /// The local port number to which this EFI TCPv6 Protocol instance
  95   /// is bound. If the instance doesn't care the local port number, set
  96   /// StationPort to zero to use an ephemeral port.
  97   ///
  98   UINT16            StationPort;
  99   ///
 100   /// The remote IP address to which this EFI TCPv6 Protocol instance
 101   /// is connected. If ActiveFlag is FALSE (i.e. a passive TCPv6
 102   /// instance), the instance only accepts connections from the
 103   /// RemoteAddress. If ActiveFlag is TRUE the instance will
 104   /// connect to the RemoteAddress, i.e., outgoing segments will be
 105   /// sent to this address and only segments from this address will be
 106   /// delivered to the application. When ActiveFlag is FALSE, it
 107   /// can be set to zero and means that incoming connection requests
 108   /// from any address will be accepted.
 109   ///
 110   EFI_IPv6_ADDRESS  RemoteAddress;
 111   ///
 112   /// The remote port to which this EFI TCPv6 Protocol instance
 113   /// connects or from which connection request will be accepted by
 114   /// this EFI TCPv6 Protocol instance. If ActiveFlag is FALSE it
 115   /// can be zero and means that incoming connection request from
 116   /// any port will be accepted. Its value can not be zero when
 117   /// ActiveFlag is TRUE.
 118   ///
 119   UINT16            RemotePort;
 120   ///
 121   /// Set it to TRUE to initiate an active open. Set it to FALSE to
 122   /// initiate a passive open to act as a server.
 123   ///
 124   BOOLEAN           ActiveFlag;
 125 } EFI_TCP6_ACCESS_POINT;
 126
 127 ///
 128 /// EFI_TCP6_OPTION
 129 ///
 130 typedef struct {
 131   ///
 132   /// The size of the TCP receive buffer.
 133   ///
 134   UINT32   ReceiveBufferSize;
 135   ///
 136   /// The size of the TCP send buffer.
 137   ///
 138   UINT32   SendBufferSize;
 139   ///
 140   /// The length of incoming connect request queue for a passive
 141   /// instance. When set to zero, the value is implementation specific.
 142   ///
 143   UINT32   MaxSynBackLog;
 144   ///
 145   /// The maximum seconds a TCP instance will wait for before a TCP
 146   /// connection established. When set to zero, the value is
 147   /// implementation specific.
 148   ///
 149   UINT32   ConnectionTimeout;
 150   ///
 151   ///The number of times TCP will attempt to retransmit a packet on
 152   ///an established connection. When set to zero, the value is
 153   ///implementation specific.
 154   ///
 155   UINT32   DataRetries;
 156   ///
 157   /// How many seconds to wait in the FIN_WAIT_2 states for a final
 158   /// FIN flag before the TCP instance is closed. This timeout is in
 159   /// effective only if the application has called Close() to
 160   /// disconnect the connection completely. It is also called
 161   /// FIN_WAIT_2 timer in other implementations. When set to zero,
 162   /// it should be disabled because the FIN_WAIT_2 timer itself is
 163   /// against the standard. The default value is 60.
 164   ///
 165   UINT32   FinTimeout;
 166   ///
 167   /// How many seconds to wait in TIME_WAIT state before the TCP
 168   /// instance is closed. The timer is disabled completely to provide a
 169   /// method to close the TCP connection quickly if it is set to zero. It
 170   /// is against the related RFC documents.
 171   ///
 172   UINT32   TimeWaitTimeout;
 173   ///
 174   /// The maximum number of TCP keep-alive probes to send before
 175   /// giving up and resetting the connection if no response from the
 176   /// other end. Set to zero to disable keep-alive probe.
 177   ///
 178   UINT32   KeepAliveProbes;
 179   ///
 180   /// The number of seconds a connection needs to be idle before TCP
 181   /// sends out periodical keep-alive probes. When set to zero, the
 182   /// value is implementation specific. It should be ignored if keep-
 183   /// alive probe is disabled.
 184   ///
 185   UINT32   KeepAliveTime;
 186   ///
 187   /// The number of seconds between TCP keep-alive probes after the
 188   /// periodical keep-alive probe if no response. When set to zero, the
 189   /// value is implementation specific. It should be ignored if keep-
 190   /// alive probe is disabled.
 191   ///
 192   UINT32   KeepAliveInterval;
 193   ///
 194   /// Set it to TRUE to enable the Nagle algorithm as defined in
 195   /// RFC896. Set it to FALSE to disable it.
 196   ///
 197   BOOLEAN  EnableNagle;
 198   ///
 199   /// Set it to TRUE to enable TCP timestamps option as defined in
 200   /// RFC1323. Set to FALSE to disable it.
 201   ///
 202   BOOLEAN  EnableTimeStamp;
 203   ///
 204   /// Set it to TRUE to enable TCP window scale option as defined in
 205   /// RFC1323. Set it to FALSE to disable it.
 206   ///
 207   BOOLEAN  EnableWindowScaling;
 208   ///
 209   /// Set it to TRUE to enable selective acknowledge mechanism
 210   /// described in RFC 2018. Set it to FALSE to disable it.
 211   /// Implementation that supports SACK can optionally support
 212   /// DSAK as defined in RFC 2883.
 213   ///
 214   BOOLEAN  EnableSelectiveAck;
 215   ///
 216   /// Set it to TRUE to enable path MTU discovery as defined in
 217   /// RFC 1191. Set to FALSE to disable it.
 218   ///
 219   BOOLEAN  EnablePathMtuDiscovery;
 220 } EFI_TCP6_OPTION;
 221
 222 ///
 223 /// EFI_TCP6_CONFIG_DATA
 224 ///
 225 typedef struct {
 226   ///
 227   /// TrafficClass field in transmitted IPv6 packets.
 228   ///
 229   UINT8                 TrafficClass;
 230   ///
 231   /// HopLimit field in transmitted IPv6 packets.
 232   ///
 233   UINT8                 HopLimit;
 234   ///
 235   /// Used to specify TCP communication end settings for a TCP instance.
 236   ///
 237   EFI_TCP6_ACCESS_POINT AccessPoint;
 238   ///
 239   /// Used to configure the advance TCP option for a connection. If set
 240   /// to NULL, implementation specific options for TCP connection will be used.
 241   ///
 242   EFI_TCP6_OPTION       *ControlOption;
 243 } EFI_TCP6_CONFIG_DATA;
 244
 245 ///
 246 /// EFI_TCP6_CONNECTION_STATE
 247 ///
 248 typedef enum {
 249   Tcp6StateClosed      = 0,
 250   Tcp6StateListen      = 1,
 251   Tcp6StateSynSent     = 2,
 252   Tcp6StateSynReceived = 3,
 253   Tcp6StateEstablished = 4,
 254   Tcp6StateFinWait1    = 5,
 255   Tcp6StateFinWait2    = 6,
 256   Tcp6StateClosing     = 7,
 257   Tcp6StateTimeWait    = 8,
 258   Tcp6StateCloseWait   = 9,
 259   Tcp6StateLastAck     = 10
 260 } EFI_TCP6_CONNECTION_STATE;
 261
 262 ///
 263 /// EFI_TCP6_COMPLETION_TOKEN
 264 /// is used as a common header for various asynchronous tokens.
 265 ///
 266 typedef struct {
 267   ///
 268   /// The Event to signal after request is finished and Status field is
 269   /// updated by the EFI TCPv6 Protocol driver.
 270   ///
 271   EFI_EVENT   Event;
 272   ///
 273   /// The result of the completed operation.
 274   ///
 275   EFI_STATUS  Status;
 276 } EFI_TCP6_COMPLETION_TOKEN;
 277
 278 ///
 279 /// EFI_TCP6_CONNECTION_TOKEN
 280 /// will be set if the active open succeeds or an unexpected
 281 /// error happens.
 282 ///
 283 typedef struct {
 284   ///
 285   /// The Status in the CompletionToken will be set to one of
 286   /// the following values if the active open succeeds or an unexpected
 287   /// error happens:
 288   /// EFI_SUCCESS:              The active open succeeds and the instance's
 289   ///                           state is Tcp6StateEstablished.
 290   /// EFI_CONNECTION_RESET:     The connect fails because the connection is reset
 291   ///                           either by instance itself or the communication peer.
 292   /// EFI_ABORTED:              The active open is aborted.
 293   /// EFI_TIMEOUT:              The connection establishment timer expires and
 294   ///                           no more specific information is available.
 295   /// EFI_NETWORK_UNREACHABLE:  The active open fails because
 296   ///                           an ICMP network unreachable error is received.
 297   /// EFI_HOST_UNREACHABLE:     The active open fails because an
 298   ///                           ICMP host unreachable error is received.
 299   /// EFI_PROTOCOL_UNREACHABLE: The active open fails
 300   ///                           because an ICMP protocol unreachable error is received.
 301   /// EFI_PORT_UNREACHABLE:     The connection establishment
 302   ///                           timer times out and an ICMP port unreachable error is received.
 303   /// EFI_ICMP_ERROR:           The connection establishment timer times
 304   ///                           out and some other ICMP error is received.
 305   /// EFI_DEVICE_ERROR:         An unexpected system or network error occurred.
 306   /// EFI_SECURITY_VIOLATION:   The active open was failed because of IPSec policy check.
 307   ///
 308   EFI_TCP6_COMPLETION_TOKEN CompletionToken;
 309 } EFI_TCP6_CONNECTION_TOKEN;
 310
 311 ///
 312 /// EFI_TCP6_LISTEN_TOKEN
 313 /// returns when list operation finishes.
 314 ///
 315 typedef struct {
 316   ///
 317   /// The Status in CompletionToken will be set to the
 318   /// following value if accept finishes:
 319   /// EFI_SUCCESS:            A remote peer has successfully established a
 320   ///                         connection to this instance. A new TCP instance has also been
 321   ///                         created for the connection.
 322   /// EFI_CONNECTION_RESET:   The accept fails because the connection is reset either
 323   ///                         by instance itself or communication peer.
 324   /// EFI_ABORTED:            The accept request has been aborted.
 325   /// EFI_SECURITY_VIOLATION: The accept operation was failed because of IPSec policy check.
 326   ///
 327   EFI_TCP6_COMPLETION_TOKEN CompletionToken;
 328   EFI_HANDLE                NewChildHandle;
 329 } EFI_TCP6_LISTEN_TOKEN;
 330
 331 ///
 332 /// EFI_TCP6_FRAGMENT_DATA
 333 /// allows multiple receive or transmit buffers to be specified. The
 334 /// purpose of this structure is to provide scattered read and write.
 335 ///
 336 typedef struct {
 337   UINT32 FragmentLength;   ///< Length of data buffer in the fragment.
 338   VOID   *FragmentBuffer;  ///< Pointer to the data buffer in the fragment.
 339 } EFI_TCP6_FRAGMENT_DATA;
 340
 341 ///
 342 /// EFI_TCP6_RECEIVE_DATA
 343 /// When TCPv6 driver wants to deliver received data to the application,
 344 /// it will pick up the first queued receiving token, update its
 345 /// Token->Packet.RxData then signal the Token->CompletionToken.Event.
 346 ///
 347 typedef struct {
 348   ///
 349   /// Whether the data is urgent. When this flag is set, the instance is in
 350   /// urgent mode.
 351   ///
 352   BOOLEAN                 UrgentFlag;
 353   ///
 354   /// When calling Receive() function, it is the byte counts of all
 355   /// Fragmentbuffer in FragmentTable allocated by user.
 356   /// When the token is signaled by TCPv6 driver it is the length of
 357   /// received data in the fragments.
 358   ///
 359   UINT32                  DataLength;
 360   ///
 361   /// Number of fragments.
 362   ///
 363   UINT32                  FragmentCount;
 364   ///
 365   /// An array of fragment descriptors.
 366   ///
 367   EFI_TCP6_FRAGMENT_DATA  FragmentTable[1];
 368 } EFI_TCP6_RECEIVE_DATA;
 369
 370 ///
 371 /// EFI_TCP6_TRANSMIT_DATA
 372 /// The EFI TCPv6 Protocol user must fill this data structure before sending a packet.
 373 /// The packet may contain multiple buffers in non-continuous memory locations.
 374 ///
 375 typedef struct {
 376   ///
 377   /// Push If TRUE, data must be transmitted promptly, and the PUSH bit in
 378   /// the last TCP segment created will be set. If FALSE, data
 379   /// transmission may be delayed to combine with data from
 380   /// subsequent Transmit()s for efficiency.
 381   ///
 382   BOOLEAN                 Push;
 383   ///
 384   /// The data in the fragment table are urgent and urgent point is in
 385   /// effect if TRUE. Otherwise those data are NOT considered urgent.
 386   ///
 387   BOOLEAN                 Urgent;
 388   ///
 389   /// Length of the data in the fragments.
 390   ///
 391   UINT32                  DataLength;
 392   ///
 393   /// Number of fragments.
 394   ///
 395   UINT32                  FragmentCount;
 396   ///
 397   /// An array of fragment descriptors.
 398   ///
 399   EFI_TCP6_FRAGMENT_DATA  FragmentTable[1];
 400 } EFI_TCP6_TRANSMIT_DATA;
 401
 402 ///
 403 /// EFI_TCP6_IO_TOKEN
 404 /// returns When transmission finishes or meets any unexpected error.
 405 ///
 406 typedef struct {
 407   ///
 408   /// When transmission finishes or meets any unexpected error it will
 409   /// be set to one of the following values:
 410   /// EFI_SUCCESS:              The receiving or transmission operation
 411   ///                           completes successfully.
 412   /// EFI_CONNECTION_RESET:     The receiving or transmission operation fails
 413   ///                           because this connection is reset either by instance
 414   ///                           itself or the communication peer.
 415   /// EFI_ABORTED:              The receiving or transmission is aborted.
 416   /// EFI_TIMEOUT:              The transmission timer expires and no more
 417   ///                           specific information is available.
 418   /// EFI_NETWORK_UNREACHABLE:  The transmission fails
 419   ///                           because an ICMP network unreachable error is received.
 420   /// EFI_HOST_UNREACHABLE:     The transmission fails because an
 421   ///                           ICMP host unreachable error is received.
 422   /// EFI_PROTOCOL_UNREACHABLE: The transmission fails
 423   ///                           because an ICMP protocol unreachable error is received.
 424   /// EFI_PORT_UNREACHABLE:     The transmission fails and an
 425   ///                           ICMP port unreachable error is received.
 426   /// EFI_ICMP_ERROR:           The transmission fails and some other
 427   ///                           ICMP error is received.
 428   /// EFI_DEVICE_ERROR:         An unexpected system or network error occurs.
 429   /// EFI_SECURITY_VIOLATION:   The receiving or transmission
 430   ///                           operation was failed because of IPSec policy check
 431   ///
 432   EFI_TCP6_COMPLETION_TOKEN CompletionToken;
 433   union {
 434     ///
 435     /// When this token is used for receiving, RxData is a pointer to
 436     /// EFI_TCP6_RECEIVE_DATA.
 437     ///
 438     EFI_TCP6_RECEIVE_DATA   *RxData;
 439     ///
 440     /// When this token is used for transmitting, TxData is a pointer to
 441     /// EFI_TCP6_TRANSMIT_DATA.
 442     ///
 443     EFI_TCP6_TRANSMIT_DATA  *TxData;
 444   } Packet;
 445 } EFI_TCP6_IO_TOKEN;
 446
 447 ///
 448 /// EFI_TCP6_CLOSE_TOKEN
 449 /// returns when close operation finishes.
 450 ///
 451 typedef struct {
 452   ///
 453   /// When close finishes or meets any unexpected error it will be set
 454   /// to one of the following values:
 455   /// EFI_SUCCESS:            The close operation completes successfully.
 456   /// EFI_ABORTED:            User called configure with NULL without close stopping.
 457   /// EFI_SECURITY_VIOLATION: The close operation was failed because of IPSec policy check.
 458   ///
 459   EFI_TCP6_COMPLETION_TOKEN CompletionToken;
 460   ///
 461   /// Abort the TCP connection on close instead of the standard TCP
 462   /// close process when it is set to TRUE. This option can be used to
 463   /// satisfy a fast disconnect.
 464   ///
 465   BOOLEAN                   AbortOnClose;
 466 } EFI_TCP6_CLOSE_TOKEN;
 467
 468 /**
 469   Get the current operational status.
 470
 471   The GetModeData() function copies the current operational settings of this EFI TCPv6
 472   Protocol instance into user-supplied buffers. This function can also be used to retrieve
 473   the operational setting of underlying drivers such as IPv6, MNP, or SNP.
 474
 475   @param[in]  This              Pointer to the EFI_TCP6_PROTOCOL instance.
 476   @param[out] Tcp6State         The buffer in which the current TCP state is returned.
 477   @param[out] Tcp6ConfigData    The buffer in which the current TCP configuration is returned.
 478   @param[out] Ip6ModeData       The buffer in which the current IPv6 configuration data used by
 479                                 the TCP instance is returned.
 480   @param[out] MnpConfigData     The buffer in which the current MNP configuration data used
 481                                 indirectly by the TCP instance is returned.
 482   @param[out] SnpModeData       The buffer in which the current SNP mode data used indirectly by
 483                                 the TCP instance is returned.
 484
 485   @retval EFI_SUCCESS           The mode data was read.
 486   @retval EFI_NOT_STARTED       No configuration data is available because this instance hasn't
 487                                 been started.
 488   @retval EFI_INVALID_PARAMETER This is NULL.
 489
 490 **/
 491 typedef
 492 EFI_STATUS
 493 (EFIAPI *EFI_TCP6_GET_MODE_DATA)(
 494   IN  EFI_TCP6_PROTOCOL                  *This,
 495   OUT EFI_TCP6_CONNECTION_STATE          *Tcp6State OPTIONAL,
 496   OUT EFI_TCP6_CONFIG_DATA               *Tcp6ConfigData OPTIONAL,
 497   OUT EFI_IP6_MODE_DATA                  *Ip6ModeData OPTIONAL,
 498   OUT EFI_MANAGED_NETWORK_CONFIG_DATA    *MnpConfigData OPTIONAL,
 499   OUT EFI_SIMPLE_NETWORK_MODE            *SnpModeData OPTIONAL
 500   );
 501
 502 /**
 503   Initialize or brutally reset the operational parameters for this EFI TCPv6 instance.
 504
 505   The Configure() function does the following:
 506   - Initialize this TCP instance, i.e., initialize the communication end settings and
 507     specify active open or passive open for an instance.
 508   - Reset this TCP instance brutally, i.e., cancel all pending asynchronous tokens, flush
 509     transmission and receiving buffer directly without informing the communication peer.
 510
 511   No other TCPv6 Protocol operation except Poll() can be executed by this instance until
 512   it is configured properly. For an active TCP instance, after a proper configuration it
 513   may call Connect() to initiates the three-way handshake. For a passive TCP instance,
 514   its state will transit to Tcp6StateListen after configuration, and Accept() may be
 515   called to listen the incoming TCP connection requests. If Tcp6ConfigData is set to NULL,
 516   the instance is reset. Resetting process will be done brutally, the state machine will
 517   be set to Tcp6StateClosed directly, the receive queue and transmit queue will be flushed,
 518   and no traffic is allowed through this instance.
 519
 520   @param[in] This               Pointer to the EFI_TCP6_PROTOCOL instance.
 521   @param[in] Tcp6ConfigData     Pointer to the configure data to configure the instance.
 522                                 If Tcp6ConfigData is set to NULL, the instance is reset.
 523
 524   @retval EFI_SUCCESS           The operational settings are set, changed, or reset
 525                                 successfully.
 526   @retval EFI_NO_MAPPING        The underlying IPv6 driver was responsible for choosing a source
 527                                 address for this instance, but no source address was available for
 528                                 use.
 529   @retval EFI_INVALID_PARAMETER One or more of the following conditions are TRUE:
 530                                 - This is NULL.
 531                                 - Tcp6ConfigData->AccessPoint.StationAddress is neither zero nor
 532                                   one of the configured IP addresses in the underlying IPv6 driver.
 533                                 - Tcp6ConfigData->AccessPoint.RemoteAddress isn't a valid unicast
 534                                   IPv6 address.
 535                                 - Tcp6ConfigData->AccessPoint.RemoteAddress is zero or
 536                                   Tcp6ConfigData->AccessPoint.RemotePort is zero when
 537                                   Tcp6ConfigData->AccessPoint.ActiveFlag is TRUE.
 538                                 - A same access point has been configured in other TCP
 539                                   instance properly.
 540   @retval EFI_ACCESS_DENIED     Configuring TCP instance when it is configured without
 541                                 calling Configure() with NULL to reset it.
 542   @retval EFI_UNSUPPORTED       One or more of the control options are not supported in
 543                                 the implementation.
 544   @retval EFI_OUT_OF_RESOURCES  Could not allocate enough system resources when
 545                                 executing Configure().
 546   @retval EFI_DEVICE_ERROR      An unexpected network or system error occurred.
 547
 548 **/
 549 typedef
 550 EFI_STATUS
 551 (EFIAPI *EFI_TCP6_CONFIGURE)(
 552   IN EFI_TCP6_PROTOCOL        *This,
 553   IN EFI_TCP6_CONFIG_DATA     *Tcp6ConfigData OPTIONAL
 554   );
 555
 556 /**
 557   Initiate a nonblocking TCP connection request for an active TCP instance.
 558
 559   The Connect() function will initiate an active open to the remote peer configured
 560   in current TCP instance if it is configured active. If the connection succeeds or
 561   fails due to any error, the ConnectionToken->CompletionToken.Event will be signaled
 562   and ConnectionToken->CompletionToken.Status will be updated accordingly. This
 563   function can only be called for the TCP instance in Tcp6StateClosed state. The
 564   instance will transfer into Tcp6StateSynSent if the function returns EFI_SUCCESS.
 565   If TCP three-way handshake succeeds, its state will become Tcp6StateEstablished,
 566   otherwise, the state will return to Tcp6StateClosed.
 567
 568   @param[in] This                Pointer to the EFI_TCP6_PROTOCOL instance.
 569   @param[in] ConnectionToken     Pointer to the connection token to return when the TCP three
 570                                  way handshake finishes.
 571
 572   @retval EFI_SUCCESS            The connection request is successfully initiated and the state of
 573                                  this TCP instance has been changed to Tcp6StateSynSent.
 574   @retval EFI_NOT_STARTED        This EFI TCPv6 Protocol instance has not been configured.
 575   @retval EFI_ACCESS_DENIED      One or more of the following conditions are TRUE:
 576                                  - This instance is not configured as an active one.
 577                                  - This instance is not in Tcp6StateClosed state.
 578   @retval EFI_INVALID_PARAMETER  One or more of the following are TRUE:
 579                                  - This is NULL.
 580                                  - ConnectionToken is NULL.
 581                                  - ConnectionToken->CompletionToken.Event is NULL.
 582   @retval EFI_OUT_OF_RESOURCES   The driver can't allocate enough resource to initiate the active open.
 583   @retval EFI_DEVICE_ERROR       An unexpected system or network error occurred.
 584
 585 **/
 586 typedef
 587 EFI_STATUS
 588 (EFIAPI *EFI_TCP6_CONNECT)(
 589   IN EFI_TCP6_PROTOCOL           *This,
 590   IN EFI_TCP6_CONNECTION_TOKEN   *ConnectionToken
 591   );
 592
 593 /**
 594   Listen on the passive instance to accept an incoming connection request. This is a
 595   nonblocking operation.
 596
 597   The Accept() function initiates an asynchronous accept request to wait for an incoming
 598   connection on the passive TCP instance. If a remote peer successfully establishes a
 599   connection with this instance, a new TCP instance will be created and its handle will
 600   be returned in ListenToken->NewChildHandle. The newly created instance is configured
 601   by inheriting the passive instance's configuration and is ready for use upon return.
 602   The new instance is in the Tcp6StateEstablished state.
 603
 604   The ListenToken->CompletionToken.Event will be signaled when a new connection is
 605   accepted, user aborts the listen or connection is reset.
 606
 607   This function only can be called when current TCP instance is in Tcp6StateListen state.
 608
 609   @param[in] This                Pointer to the EFI_TCP6_PROTOCOL instance.
 610   @param[in] ListenToken         Pointer to the listen token to return when operation finishes.
 611
 612
 613   @retval EFI_SUCCESS            The listen token has been queued successfully.
 614   @retval EFI_NOT_STARTED        This EFI TCPv6 Protocol instance has not been configured.
 615   @retval EFI_ACCESS_DENIED      One or more of the following are TRUE:
 616                                  - This instance is not a passive instance.
 617                                  - This instance is not in Tcp6StateListen state.
 618                                  - The same listen token has already existed in the listen
 619                                    token queue of this TCP instance.
 620   @retval EFI_INVALID_PARAMETER  One or more of the following are TRUE:
 621                                  - This is NULL.
 622                                  - ListenToken is NULL.
 623                                  - ListentToken->CompletionToken.Event is NULL.
 624   @retval EFI_OUT_OF_RESOURCES   Could not allocate enough resource to finish the operation.
 625   @retval EFI_DEVICE_ERROR       Any unexpected and not belonged to above category error.
 626
 627 **/
 628 typedef
 629 EFI_STATUS
 630 (EFIAPI *EFI_TCP6_ACCEPT)(
 631   IN EFI_TCP6_PROTOCOL             *This,
 632   IN EFI_TCP6_LISTEN_TOKEN         *ListenToken
 633   );
 634
 635 /**
 636   Queues outgoing data into the transmit queue.
 637
 638   The Transmit() function queues a sending request to this TCP instance along with the
 639   user data. The status of the token is updated and the event in the token will be
 640   signaled once the data is sent out or some error occurs.
 641
 642   @param[in] This                 Pointer to the EFI_TCP6_PROTOCOL instance.
 643   @param[in] Token                Pointer to the completion token to queue to the transmit queue.
 644
 645   @retval EFI_SUCCESS             The data has been queued for transmission.
 646   @retval EFI_NOT_STARTED         This EFI TCPv6 Protocol instance has not been configured.
 647   @retval EFI_NO_MAPPING          The underlying IPv6 driver was responsible for choosing a
 648                                   source address for this instance, but no source address was
 649                                   available for use.
 650   @retval EFI_INVALID_PARAMETER   One or more of the following are TRUE:
 651                                   - This is NULL.
 652                                   - Token is NULL.
 653                                   - Token->CompletionToken.Event is NULL.
 654                                   - Token->Packet.TxData is NULL.
 655                                   - Token->Packet.FragmentCount is zero.
 656                                   - Token->Packet.DataLength is not equal to the sum of fragment lengths.
 657   @retval EFI_ACCESS_DENIED       One or more of the following conditions are TRUE:
 658                                   - A transmit completion token with the same Token->
 659                                     CompletionToken.Event was already in the
 660                                     transmission queue.
 661                                   - The current instance is in Tcp6StateClosed state.
 662                                   - The current instance is a passive one and it is in
 663                                     Tcp6StateListen state.
 664                                   - User has called Close() to disconnect this connection.
 665   @retval EFI_NOT_READY           The completion token could not be queued because the
 666                                   transmit queue is full.
 667   @retval EFI_OUT_OF_RESOURCES    Could not queue the transmit data because of resource
 668                                   shortage.
 669   @retval EFI_NETWORK_UNREACHABLE There is no route to the destination network or address.
 670
 671 **/
 672 typedef
 673 EFI_STATUS
 674 (EFIAPI *EFI_TCP6_TRANSMIT)(
 675   IN EFI_TCP6_PROTOCOL            *This,
 676   IN EFI_TCP6_IO_TOKEN            *Token
 677   );
 678
 679 /**
 680   Places an asynchronous receive request into the receiving queue.
 681
 682   The Receive() function places a completion token into the receive packet queue. This
 683   function is always asynchronous. The caller must allocate the Token->CompletionToken.Event
 684   and the FragmentBuffer used to receive data. The caller also must fill the DataLength which
 685   represents the whole length of all FragmentBuffer. When the receive operation completes, the
 686   EFI TCPv6 Protocol driver updates the Token->CompletionToken.Status and Token->Packet.RxData
 687   fields and the Token->CompletionToken.Event is signaled. If got data the data and its length
 688   will be copied into the FragmentTable, at the same time the full length of received data will
 689   be recorded in the DataLength fields. Providing a proper notification function and context
 690   for the event will enable the user to receive the notification and receiving status. That
 691   notification function is guaranteed to not be re-entered.
 692
 693   @param[in] This               Pointer to the EFI_TCP6_PROTOCOL instance.
 694   @param[in] Token              Pointer to a token that is associated with the receive data
 695                                 descriptor.
 696
 697   @retval EFI_SUCCESS            The receive completion token was cached.
 698   @retval EFI_NOT_STARTED        This EFI TCPv6 Protocol instance has not been configured.
 699   @retval EFI_NO_MAPPING         The underlying IPv6 driver was responsible for choosing a source
 700                                  address for this instance, but no source address was available for use.
 701   @retval EFI_INVALID_PARAMETER  One or more of the following conditions is TRUE:
 702                                  - This is NULL.
 703                                  - Token is NULL.
 704                                  - Token->CompletionToken.Event is NULL.
 705                                  - Token->Packet.RxData is NULL.
 706                                  - Token->Packet.RxData->DataLength is 0.
 707                                  - The Token->Packet.RxData->DataLength is not the
 708                                    sum of all FragmentBuffer length in FragmentTable.
 709   @retval EFI_OUT_OF_RESOURCES   The receive completion token could not be queued due to a lack of
 710                                  system resources (usually memory).
 711   @retval EFI_DEVICE_ERROR       An unexpected system or network error occurred.
 712                                  The EFI TCPv6 Protocol instance has been reset to startup defaults.
 713   @retval EFI_ACCESS_DENIED      One or more of the following conditions is TRUE:
 714                                  - A receive completion token with the same Token->CompletionToken.Event
 715                                    was already in the receive queue.
 716                                  - The current instance is in Tcp6StateClosed state.
 717                                  - The current instance is a passive one and it is in
 718                                    Tcp6StateListen state.
 719                                  - User has called Close() to disconnect this connection.
 720   @retval EFI_CONNECTION_FIN     The communication peer has closed the connection and there is no
 721                                  any buffered data in the receive buffer of this instance
 722   @retval EFI_NOT_READY          The receive request could not be queued because the receive queue is full.
 723
 724 **/
 725 typedef
 726 EFI_STATUS
 727 (EFIAPI *EFI_TCP6_RECEIVE)(
 728   IN EFI_TCP6_PROTOCOL           *This,
 729   IN EFI_TCP6_IO_TOKEN           *Token
 730   );
 731
 732 /**
 733   Disconnecting a TCP connection gracefully or reset a TCP connection. This function is a
 734   nonblocking operation.
 735
 736   Initiate an asynchronous close token to TCP driver. After Close() is called, any buffered
 737   transmission data will be sent by TCP driver and the current instance will have a graceful close
 738   working flow described as RFC 793 if AbortOnClose is set to FALSE, otherwise, a rest packet
 739   will be sent by TCP driver to fast disconnect this connection. When the close operation completes
 740   successfully the TCP instance is in Tcp6StateClosed state, all pending asynchronous
 741   operations are signaled and any buffers used for TCP network traffic are flushed.
 742
 743   @param[in] This                Pointer to the EFI_TCP6_PROTOCOL instance.
 744   @param[in] CloseToken          Pointer to the close token to return when operation finishes.
 745
 746   @retval EFI_SUCCESS            The Close() is called successfully.
 747   @retval EFI_NOT_STARTED        This EFI TCPv6 Protocol instance has not been configured.
 748   @retval EFI_ACCESS_DENIED      One or more of the following are TRUE:
 749                                  - CloseToken or CloseToken->CompletionToken.Event is already in use.
 750                                  - Previous Close() call on this instance has not finished.
 751   @retval EFI_INVALID_PARAMETER  One or more of the following are TRUE:
 752                                  - This is NULL.
 753                                  - CloseToken is NULL.
 754                                  - CloseToken->CompletionToken.Event is NULL.
 755   @retval EFI_OUT_OF_RESOURCES   Could not allocate enough resource to finish the operation.
 756   @retval EFI_DEVICE_ERROR       Any unexpected and not belonged to above category error.
 757
 758 **/
 759 typedef
 760 EFI_STATUS
 761 (EFIAPI *EFI_TCP6_CLOSE)(
 762   IN EFI_TCP6_PROTOCOL           *This,
 763   IN EFI_TCP6_CLOSE_TOKEN        *CloseToken
 764   );
 765
 766 /**
 767   Abort an asynchronous connection, listen, transmission or receive request.
 768
 769   The Cancel() function aborts a pending connection, listen, transmit or
 770   receive request.
 771
 772   If Token is not NULL and the token is in the connection, listen, transmission
 773   or receive queue when it is being cancelled, its Token->Status will be set
 774   to EFI_ABORTED and then Token->Event will be signaled.
 775
 776   If the token is not in one of the queues, which usually means that the
 777   asynchronous operation has completed, EFI_NOT_FOUND is returned.
 778
 779   If Token is NULL all asynchronous token issued by Connect(), Accept(),
 780   Transmit() and Receive() will be aborted.
 781
 782   @param[in] This                Pointer to the EFI_TCP6_PROTOCOL instance.
 783   @param[in] Token               Pointer to a token that has been issued by
 784                                  EFI_TCP6_PROTOCOL.Connect(),
 785                                  EFI_TCP6_PROTOCOL.Accept(),
 786                                  EFI_TCP6_PROTOCOL.Transmit() or
 787                                  EFI_TCP6_PROTOCOL.Receive(). If NULL, all pending
 788                                  tokens issued by above four functions will be aborted. Type
 789                                  EFI_TCP6_COMPLETION_TOKEN is defined in
 790                                  EFI_TCP_PROTOCOL.Connect().
 791
 792   @retval EFI_SUCCESS            The asynchronous I/O request is aborted and Token->Event
 793                                  is signaled.
 794   @retval EFI_INVALID_PARAMETER  This is NULL.
 795   @retval EFI_NOT_STARTED        This instance hasn't been configured.
 796   @retval EFI_NOT_FOUND          The asynchronous I/O request isn't found in the transmission or
 797                                  receive queue. It has either completed or wasn't issued by
 798                                  Transmit() and Receive().
 799
 800 **/
 801 typedef
 802 EFI_STATUS
 803 (EFIAPI *EFI_TCP6_CANCEL)(
 804   IN EFI_TCP6_PROTOCOL           *This,
 805   IN EFI_TCP6_COMPLETION_TOKEN   *Token OPTIONAL
 806   );
 807
 808 /**
 809   Poll to receive incoming data and transmit outgoing segments.
 810
 811   The Poll() function increases the rate that data is moved between the network
 812   and application and can be called when the TCP instance is created successfully.
 813   Its use is optional.
 814
 815   @param[in] This                Pointer to the EFI_TCP6_PROTOCOL instance.
 816
 817   @retval EFI_SUCCESS            Incoming or outgoing data was processed.
 818   @retval EFI_INVALID_PARAMETER  This is NULL.
 819   @retval EFI_DEVICE_ERROR       An unexpected system or network error occurred.
 820   @retval EFI_NOT_READY          No incoming or outgoing data is processed.
 821   @retval EFI_TIMEOUT            Data was dropped out of the transmission or receive queue.
 822                                  Consider increasing the polling rate.
 823
 824 **/
 825 typedef
 826 EFI_STATUS
 827 (EFIAPI *EFI_TCP6_POLL)(
 828   IN EFI_TCP6_PROTOCOL        *This
 829   );
 830
 831 ///
 832 /// EFI_TCP6_PROTOCOL
 833 /// defines the EFI TCPv6 Protocol child to be used by any network drivers or
 834 /// applications to send or receive data stream. It can either listen on a
 835 /// specified port as a service or actively connect to remote peer as a client.
 836 /// Each instance has its own independent settings.
 837 ///
 838 struct _EFI_TCP6_PROTOCOL {
 839   EFI_TCP6_GET_MODE_DATA  GetModeData;
 840   EFI_TCP6_CONFIGURE      Configure;
 841   EFI_TCP6_CONNECT        Connect;
 842   EFI_TCP6_ACCEPT         Accept;
 843   EFI_TCP6_TRANSMIT       Transmit;
 844   EFI_TCP6_RECEIVE        Receive;
 845   EFI_TCP6_CLOSE          Close;
 846   EFI_TCP6_CANCEL         Cancel;
 847   EFI_TCP6_POLL           Poll;
 848 };
 849
 850 extern EFI_GUID gEfiTcp6ServiceBindingProtocolGuid;
 851 extern EFI_GUID gEfiTcp6ProtocolGuid;
 852
 853 #endif
 854