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