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_CONNECTION_REFUSED:   The receiving or transmission operation fails because this
 293   ///                           connection is refused.
 294   /// EFI_ABORTED:              The active open is aborted.
 295   /// EFI_TIMEOUT:              The connection establishment timer expires and
 296   ///                           no more specific information is available.
 297   /// EFI_NETWORK_UNREACHABLE:  The active open fails because
 298   ///                           an ICMP network unreachable error is received.
 299   /// EFI_HOST_UNREACHABLE:     The active open fails because an
 300   ///                           ICMP host unreachable error is received.
 301   /// EFI_PROTOCOL_UNREACHABLE: The active open fails
 302   ///                           because an ICMP protocol unreachable error is received.
 303   /// EFI_PORT_UNREACHABLE:     The connection establishment
 304   ///                           timer times out and an ICMP port unreachable error is received.
 305   /// EFI_ICMP_ERROR:           The connection establishment timer times
 306   ///                           out and some other ICMP error is received.
 307   /// EFI_DEVICE_ERROR:         An unexpected system or network error occurred.
 308   /// EFI_SECURITY_VIOLATION:   The active open was failed because of IPSec policy check.
 309   ///
 310   EFI_TCP6_COMPLETION_TOKEN CompletionToken;
 311 } EFI_TCP6_CONNECTION_TOKEN;
 312
 313 ///
 314 /// EFI_TCP6_LISTEN_TOKEN
 315 /// returns when list operation finishes.
 316 ///
 317 typedef struct {
 318   ///
 319   /// The Status in CompletionToken will be set to the
 320   /// following value if accept finishes:
 321   /// EFI_SUCCESS:            A remote peer has successfully established a
 322   ///                         connection to this instance. A new TCP instance has also been
 323   ///                         created for the connection.
 324   /// EFI_CONNECTION_RESET:   The accept fails because the connection is reset either
 325   ///                         by instance itself or communication peer.
 326   /// EFI_ABORTED:            The accept request has been aborted.
 327   /// EFI_SECURITY_VIOLATION: The accept operation was failed because of IPSec policy check.
 328   ///
 329   EFI_TCP6_COMPLETION_TOKEN CompletionToken;
 330   EFI_HANDLE                NewChildHandle;
 331 } EFI_TCP6_LISTEN_TOKEN;
 332
 333 ///
 334 /// EFI_TCP6_FRAGMENT_DATA
 335 /// allows multiple receive or transmit buffers to be specified. The
 336 /// purpose of this structure is to provide scattered read and write.
 337 ///
 338 typedef struct {
 339   UINT32 FragmentLength;   ///< Length of data buffer in the fragment.
 340   VOID   *FragmentBuffer;  ///< Pointer to the data buffer in the fragment.
 341 } EFI_TCP6_FRAGMENT_DATA;
 342
 343 ///
 344 /// EFI_TCP6_RECEIVE_DATA
 345 /// When TCPv6 driver wants to deliver received data to the application,
 346 /// it will pick up the first queued receiving token, update its
 347 /// Token->Packet.RxData then signal the Token->CompletionToken.Event.
 348 ///
 349 typedef struct {
 350   ///
 351   /// Whether the data is urgent. When this flag is set, the instance is in
 352   /// urgent mode.
 353   ///
 354   BOOLEAN                 UrgentFlag;
 355   ///
 356   /// When calling Receive() function, it is the byte counts of all
 357   /// Fragmentbuffer in FragmentTable allocated by user.
 358   /// When the token is signaled by TCPv6 driver it is the length of
 359   /// received data in the fragments.
 360   ///
 361   UINT32                  DataLength;
 362   ///
 363   /// Number of fragments.
 364   ///
 365   UINT32                  FragmentCount;
 366   ///
 367   /// An array of fragment descriptors.
 368   ///
 369   EFI_TCP6_FRAGMENT_DATA  FragmentTable[1];
 370 } EFI_TCP6_RECEIVE_DATA;
 371
 372 ///
 373 /// EFI_TCP6_TRANSMIT_DATA
 374 /// The EFI TCPv6 Protocol user must fill this data structure before sending a packet.
 375 /// The packet may contain multiple buffers in non-continuous memory locations.
 376 ///
 377 typedef struct {
 378   ///
 379   /// Push If TRUE, data must be transmitted promptly, and the PUSH bit in
 380   /// the last TCP segment created will be set. If FALSE, data
 381   /// transmission may be delayed to combine with data from
 382   /// subsequent Transmit()s for efficiency.
 383   ///
 384   BOOLEAN                 Push;
 385   ///
 386   /// The data in the fragment table are urgent and urgent point is in
 387   /// effect if TRUE. Otherwise those data are NOT considered urgent.
 388   ///
 389   BOOLEAN                 Urgent;
 390   ///
 391   /// Length of the data in the fragments.
 392   ///
 393   UINT32                  DataLength;
 394   ///
 395   /// Number of fragments.
 396   ///
 397   UINT32                  FragmentCount;
 398   ///
 399   /// An array of fragment descriptors.
 400   ///
 401   EFI_TCP6_FRAGMENT_DATA  FragmentTable[1];
 402 } EFI_TCP6_TRANSMIT_DATA;
 403
 404 ///
 405 /// EFI_TCP6_IO_TOKEN
 406 /// returns When transmission finishes or meets any unexpected error.
 407 ///
 408 typedef struct {
 409   ///
 410   /// When transmission finishes or meets any unexpected error it will
 411   /// be set to one of the following values:
 412   /// EFI_SUCCESS:              The receiving or transmission operation
 413   ///                           completes successfully.
 414   /// EFI_CONNECTION_FIN:       The receiving operation fails because the communication peer
 415   ///                           has closed the connection and there is no more data in the
 416   ///                           receive buffer of the instance.
 417   /// EFI_CONNECTION_RESET:     The receiving or transmission operation fails
 418   ///                           because this connection is reset either by instance
 419   ///                           itself or the communication peer.
 420   /// EFI_ABORTED:              The receiving or transmission is aborted.
 421   /// EFI_TIMEOUT:              The transmission timer expires and no more
 422   ///                           specific information is available.
 423   /// EFI_NETWORK_UNREACHABLE:  The transmission fails
 424   ///                           because an ICMP network unreachable error is received.
 425   /// EFI_HOST_UNREACHABLE:     The transmission fails because an
 426   ///                           ICMP host unreachable error is received.
 427   /// EFI_PROTOCOL_UNREACHABLE: The transmission fails
 428   ///                           because an ICMP protocol unreachable error is received.
 429   /// EFI_PORT_UNREACHABLE:     The transmission fails and an
 430   ///                           ICMP port unreachable error is received.
 431   /// EFI_ICMP_ERROR:           The transmission fails and some other
 432   ///                           ICMP error is received.
 433   /// EFI_DEVICE_ERROR:         An unexpected system or network error occurs.
 434   /// EFI_SECURITY_VIOLATION:   The receiving or transmission
 435   ///                           operation was failed because of IPSec policy check
 436   ///
 437   EFI_TCP6_COMPLETION_TOKEN CompletionToken;
 438   union {
 439     ///
 440     /// When this token is used for receiving, RxData is a pointer to
 441     /// EFI_TCP6_RECEIVE_DATA.
 442     ///
 443     EFI_TCP6_RECEIVE_DATA   *RxData;
 444     ///
 445     /// When this token is used for transmitting, TxData is a pointer to
 446     /// EFI_TCP6_TRANSMIT_DATA.
 447     ///
 448     EFI_TCP6_TRANSMIT_DATA  *TxData;
 449   } Packet;
 450 } EFI_TCP6_IO_TOKEN;
 451
 452 ///
 453 /// EFI_TCP6_CLOSE_TOKEN
 454 /// returns when close operation finishes.
 455 ///
 456 typedef struct {
 457   ///
 458   /// When close finishes or meets any unexpected error it will be set
 459   /// to one of the following values:
 460   /// EFI_SUCCESS:            The close operation completes successfully.
 461   /// EFI_ABORTED:            User called configure with NULL without close stopping.
 462   /// EFI_SECURITY_VIOLATION: The close operation was failed because of IPSec policy check.
 463   ///
 464   EFI_TCP6_COMPLETION_TOKEN CompletionToken;
 465   ///
 466   /// Abort the TCP connection on close instead of the standard TCP
 467   /// close process when it is set to TRUE. This option can be used to
 468   /// satisfy a fast disconnect.
 469   ///
 470   BOOLEAN                   AbortOnClose;
 471 } EFI_TCP6_CLOSE_TOKEN;
 472
 473 /**
 474   Get the current operational status.
 475
 476   The GetModeData() function copies the current operational settings of this EFI TCPv6
 477   Protocol instance into user-supplied buffers. This function can also be used to retrieve
 478   the operational setting of underlying drivers such as IPv6, MNP, or SNP.
 479
 480   @param[in]  This              Pointer to the EFI_TCP6_PROTOCOL instance.
 481   @param[out] Tcp6State         The buffer in which the current TCP state is returned.
 482   @param[out] Tcp6ConfigData    The buffer in which the current TCP configuration is returned.
 483   @param[out] Ip6ModeData       The buffer in which the current IPv6 configuration data used by
 484                                 the TCP instance is returned.
 485   @param[out] MnpConfigData     The buffer in which the current MNP configuration data used
 486                                 indirectly by the TCP instance is returned.
 487   @param[out] SnpModeData       The buffer in which the current SNP mode data used indirectly by
 488                                 the TCP instance is returned.
 489
 490   @retval EFI_SUCCESS           The mode data was read.
 491   @retval EFI_NOT_STARTED       No configuration data is available because this instance hasn't
 492                                 been started.
 493   @retval EFI_INVALID_PARAMETER This is NULL.
 494
 495 **/
 496 typedef
 497 EFI_STATUS
 498 (EFIAPI *EFI_TCP6_GET_MODE_DATA)(
 499   IN  EFI_TCP6_PROTOCOL                  *This,
 500   OUT EFI_TCP6_CONNECTION_STATE          *Tcp6State OPTIONAL,
 501   OUT EFI_TCP6_CONFIG_DATA               *Tcp6ConfigData OPTIONAL,
 502   OUT EFI_IP6_MODE_DATA                  *Ip6ModeData OPTIONAL,
 503   OUT EFI_MANAGED_NETWORK_CONFIG_DATA    *MnpConfigData OPTIONAL,
 504   OUT EFI_SIMPLE_NETWORK_MODE            *SnpModeData OPTIONAL
 505   );
 506
 507 /**
 508   Initialize or brutally reset the operational parameters for this EFI TCPv6 instance.
 509
 510   The Configure() function does the following:
 511   - Initialize this TCP instance, i.e., initialize the communication end settings and
 512     specify active open or passive open for an instance.
 513   - Reset this TCP instance brutally, i.e., cancel all pending asynchronous tokens, flush
 514     transmission and receiving buffer directly without informing the communication peer.
 515
 516   No other TCPv6 Protocol operation except Poll() can be executed by this instance until
 517   it is configured properly. For an active TCP instance, after a proper configuration it
 518   may call Connect() to initiates the three-way handshake. For a passive TCP instance,
 519   its state will transit to Tcp6StateListen after configuration, and Accept() may be
 520   called to listen the incoming TCP connection requests. If Tcp6ConfigData is set to NULL,
 521   the instance is reset. Resetting process will be done brutally, the state machine will
 522   be set to Tcp6StateClosed directly, the receive queue and transmit queue will be flushed,
 523   and no traffic is allowed through this instance.
 524
 525   @param[in] This               Pointer to the EFI_TCP6_PROTOCOL instance.
 526   @param[in] Tcp6ConfigData     Pointer to the configure data to configure the instance.
 527                                 If Tcp6ConfigData is set to NULL, the instance is reset.
 528
 529   @retval EFI_SUCCESS           The operational settings are set, changed, or reset
 530                                 successfully.
 531   @retval EFI_NO_MAPPING        The underlying IPv6 driver was responsible for choosing a source
 532                                 address for this instance, but no source address was available for
 533                                 use.
 534   @retval EFI_INVALID_PARAMETER One or more of the following conditions are TRUE:
 535                                 - This is NULL.
 536                                 - Tcp6ConfigData->AccessPoint.StationAddress is neither zero nor
 537                                   one of the configured IP addresses in the underlying IPv6 driver.
 538                                 - Tcp6ConfigData->AccessPoint.RemoteAddress isn't a valid unicast
 539                                   IPv6 address.
 540                                 - Tcp6ConfigData->AccessPoint.RemoteAddress is zero or
 541                                   Tcp6ConfigData->AccessPoint.RemotePort is zero when
 542                                   Tcp6ConfigData->AccessPoint.ActiveFlag is TRUE.
 543                                 - A same access point has been configured in other TCP
 544                                   instance properly.
 545   @retval EFI_ACCESS_DENIED     Configuring TCP instance when it is configured without
 546                                 calling Configure() with NULL to reset it.
 547   @retval EFI_UNSUPPORTED       One or more of the control options are not supported in
 548                                 the implementation.
 549   @retval EFI_OUT_OF_RESOURCES  Could not allocate enough system resources when
 550                                 executing Configure().
 551   @retval EFI_DEVICE_ERROR      An unexpected network or system error occurred.
 552
 553 **/
 554 typedef
 555 EFI_STATUS
 556 (EFIAPI *EFI_TCP6_CONFIGURE)(
 557   IN EFI_TCP6_PROTOCOL        *This,
 558   IN EFI_TCP6_CONFIG_DATA     *Tcp6ConfigData OPTIONAL
 559   );
 560
 561 /**
 562   Initiate a nonblocking TCP connection request for an active TCP instance.
 563
 564   The Connect() function will initiate an active open to the remote peer configured
 565   in current TCP instance if it is configured active. If the connection succeeds or
 566   fails due to any error, the ConnectionToken->CompletionToken.Event will be signaled
 567   and ConnectionToken->CompletionToken.Status will be updated accordingly. This
 568   function can only be called for the TCP instance in Tcp6StateClosed state. The
 569   instance will transfer into Tcp6StateSynSent if the function returns EFI_SUCCESS.
 570   If TCP three-way handshake succeeds, its state will become Tcp6StateEstablished,
 571   otherwise, the state will return to Tcp6StateClosed.
 572
 573   @param[in] This                Pointer to the EFI_TCP6_PROTOCOL instance.
 574   @param[in] ConnectionToken     Pointer to the connection token to return when the TCP three
 575                                  way handshake finishes.
 576
 577   @retval EFI_SUCCESS            The connection request is successfully initiated and the state of
 578                                  this TCP instance has been changed to Tcp6StateSynSent.
 579   @retval EFI_NOT_STARTED        This EFI TCPv6 Protocol instance has not been configured.
 580   @retval EFI_ACCESS_DENIED      One or more of the following conditions are TRUE:
 581                                  - This instance is not configured as an active one.
 582                                  - This instance is not in Tcp6StateClosed state.
 583   @retval EFI_INVALID_PARAMETER  One or more of the following are TRUE:
 584                                  - This is NULL.
 585                                  - ConnectionToken is NULL.
 586                                  - ConnectionToken->CompletionToken.Event is NULL.
 587   @retval EFI_OUT_OF_RESOURCES   The driver can't allocate enough resource to initiate the active open.
 588   @retval EFI_DEVICE_ERROR       An unexpected system or network error occurred.
 589
 590 **/
 591 typedef
 592 EFI_STATUS
 593 (EFIAPI *EFI_TCP6_CONNECT)(
 594   IN EFI_TCP6_PROTOCOL           *This,
 595   IN EFI_TCP6_CONNECTION_TOKEN   *ConnectionToken
 596   );
 597
 598 /**
 599   Listen on the passive instance to accept an incoming connection request. This is a
 600   nonblocking operation.
 601
 602   The Accept() function initiates an asynchronous accept request to wait for an incoming
 603   connection on the passive TCP instance. If a remote peer successfully establishes a
 604   connection with this instance, a new TCP instance will be created and its handle will
 605   be returned in ListenToken->NewChildHandle. The newly created instance is configured
 606   by inheriting the passive instance's configuration and is ready for use upon return.
 607   The new instance is in the Tcp6StateEstablished state.
 608
 609   The ListenToken->CompletionToken.Event will be signaled when a new connection is
 610   accepted, user aborts the listen or connection is reset.
 611
 612   This function only can be called when current TCP instance is in Tcp6StateListen state.
 613
 614   @param[in] This                Pointer to the EFI_TCP6_PROTOCOL instance.
 615   @param[in] ListenToken         Pointer to the listen token to return when operation finishes.
 616
 617
 618   @retval EFI_SUCCESS            The listen token has been queued successfully.
 619   @retval EFI_NOT_STARTED        This EFI TCPv6 Protocol instance has not been configured.
 620   @retval EFI_ACCESS_DENIED      One or more of the following are TRUE:
 621                                  - This instance is not a passive instance.
 622                                  - This instance is not in Tcp6StateListen state.
 623                                  - The same listen token has already existed in the listen
 624                                    token queue of this TCP instance.
 625   @retval EFI_INVALID_PARAMETER  One or more of the following are TRUE:
 626                                  - This is NULL.
 627                                  - ListenToken is NULL.
 628                                  - ListentToken->CompletionToken.Event is NULL.
 629   @retval EFI_OUT_OF_RESOURCES   Could not allocate enough resource to finish the operation.
 630   @retval EFI_DEVICE_ERROR       Any unexpected and not belonged to above category error.
 631
 632 **/
 633 typedef
 634 EFI_STATUS
 635 (EFIAPI *EFI_TCP6_ACCEPT)(
 636   IN EFI_TCP6_PROTOCOL             *This,
 637   IN EFI_TCP6_LISTEN_TOKEN         *ListenToken
 638   );
 639
 640 /**
 641   Queues outgoing data into the transmit queue.
 642
 643   The Transmit() function queues a sending request to this TCP instance along with the
 644   user data. The status of the token is updated and the event in the token will be
 645   signaled once the data is sent out or some error occurs.
 646
 647   @param[in] This                 Pointer to the EFI_TCP6_PROTOCOL instance.
 648   @param[in] Token                Pointer to the completion token to queue to the transmit queue.
 649
 650   @retval EFI_SUCCESS             The data has been queued for transmission.
 651   @retval EFI_NOT_STARTED         This EFI TCPv6 Protocol instance has not been configured.
 652   @retval EFI_NO_MAPPING          The underlying IPv6 driver was responsible for choosing a
 653                                   source address for this instance, but no source address was
 654                                   available for use.
 655   @retval EFI_INVALID_PARAMETER   One or more of the following are TRUE:
 656                                   - This is NULL.
 657                                   - Token is NULL.
 658                                   - Token->CompletionToken.Event is NULL.
 659                                   - Token->Packet.TxData is NULL.
 660                                   - Token->Packet.FragmentCount is zero.
 661                                   - Token->Packet.DataLength is not equal to the sum of fragment lengths.
 662   @retval EFI_ACCESS_DENIED       One or more of the following conditions are TRUE:
 663                                   - A transmit completion token with the same Token->
 664                                     CompletionToken.Event was already in the
 665                                     transmission queue.
 666                                   - The current instance is in Tcp6StateClosed state.
 667                                   - The current instance is a passive one and it is in
 668                                     Tcp6StateListen state.
 669                                   - User has called Close() to disconnect this connection.
 670   @retval EFI_NOT_READY           The completion token could not be queued because the
 671                                   transmit queue is full.
 672   @retval EFI_OUT_OF_RESOURCES    Could not queue the transmit data because of resource
 673                                   shortage.
 674   @retval EFI_NETWORK_UNREACHABLE There is no route to the destination network or address.
 675
 676 **/
 677 typedef
 678 EFI_STATUS
 679 (EFIAPI *EFI_TCP6_TRANSMIT)(
 680   IN EFI_TCP6_PROTOCOL            *This,
 681   IN EFI_TCP6_IO_TOKEN            *Token
 682   );
 683
 684 /**
 685   Places an asynchronous receive request into the receiving queue.
 686
 687   The Receive() function places a completion token into the receive packet queue. This
 688   function is always asynchronous. The caller must allocate the Token->CompletionToken.Event
 689   and the FragmentBuffer used to receive data. The caller also must fill the DataLength which
 690   represents the whole length of all FragmentBuffer. When the receive operation completes, the
 691   EFI TCPv6 Protocol driver updates the Token->CompletionToken.Status and Token->Packet.RxData
 692   fields and the Token->CompletionToken.Event is signaled. If got data the data and its length
 693   will be copied into the FragmentTable, at the same time the full length of received data will
 694   be recorded in the DataLength fields. Providing a proper notification function and context
 695   for the event will enable the user to receive the notification and receiving status. That
 696   notification function is guaranteed to not be re-entered.
 697
 698   @param[in] This               Pointer to the EFI_TCP6_PROTOCOL instance.
 699   @param[in] Token              Pointer to a token that is associated with the receive data
 700                                 descriptor.
 701
 702   @retval EFI_SUCCESS            The receive completion token was cached.
 703   @retval EFI_NOT_STARTED        This EFI TCPv6 Protocol instance has not been configured.
 704   @retval EFI_NO_MAPPING         The underlying IPv6 driver was responsible for choosing a source
 705                                  address for this instance, but no source address was available for use.
 706   @retval EFI_INVALID_PARAMETER  One or more of the following conditions is TRUE:
 707                                  - This is NULL.
 708                                  - Token is NULL.
 709                                  - Token->CompletionToken.Event is NULL.
 710                                  - Token->Packet.RxData is NULL.
 711                                  - Token->Packet.RxData->DataLength is 0.
 712                                  - The Token->Packet.RxData->DataLength is not the
 713                                    sum of all FragmentBuffer length in FragmentTable.
 714   @retval EFI_OUT_OF_RESOURCES   The receive completion token could not be queued due to a lack of
 715                                  system resources (usually memory).
 716   @retval EFI_DEVICE_ERROR       An unexpected system or network error occurred.
 717                                  The EFI TCPv6 Protocol instance has been reset to startup defaults.
 718   @retval EFI_ACCESS_DENIED      One or more of the following conditions is TRUE:
 719                                  - A receive completion token with the same Token->CompletionToken.Event
 720                                    was already in the receive queue.
 721                                  - The current instance is in Tcp6StateClosed state.
 722                                  - The current instance is a passive one and it is in
 723                                    Tcp6StateListen state.
 724                                  - User has called Close() to disconnect this connection.
 725   @retval EFI_CONNECTION_FIN     The communication peer has closed the connection and there is no
 726                                  any buffered data in the receive buffer of this instance
 727   @retval EFI_NOT_READY          The receive request could not be queued because the receive queue is full.
 728
 729 **/
 730 typedef
 731 EFI_STATUS
 732 (EFIAPI *EFI_TCP6_RECEIVE)(
 733   IN EFI_TCP6_PROTOCOL           *This,
 734   IN EFI_TCP6_IO_TOKEN           *Token
 735   );
 736
 737 /**
 738   Disconnecting a TCP connection gracefully or reset a TCP connection. This function is a
 739   nonblocking operation.
 740
 741   Initiate an asynchronous close token to TCP driver. After Close() is called, any buffered
 742   transmission data will be sent by TCP driver and the current instance will have a graceful close
 743   working flow described as RFC 793 if AbortOnClose is set to FALSE, otherwise, a rest packet
 744   will be sent by TCP driver to fast disconnect this connection. When the close operation completes
 745   successfully the TCP instance is in Tcp6StateClosed state, all pending asynchronous
 746   operations are signaled and any buffers used for TCP network traffic are flushed.
 747
 748   @param[in] This                Pointer to the EFI_TCP6_PROTOCOL instance.
 749   @param[in] CloseToken          Pointer to the close token to return when operation finishes.
 750
 751   @retval EFI_SUCCESS            The Close() is called successfully.
 752   @retval EFI_NOT_STARTED        This EFI TCPv6 Protocol instance has not been configured.
 753   @retval EFI_ACCESS_DENIED      One or more of the following are TRUE:
 754                                  - CloseToken or CloseToken->CompletionToken.Event is already in use.
 755                                  - Previous Close() call on this instance has not finished.
 756   @retval EFI_INVALID_PARAMETER  One or more of the following are TRUE:
 757                                  - This is NULL.
 758                                  - CloseToken is NULL.
 759                                  - CloseToken->CompletionToken.Event is NULL.
 760   @retval EFI_OUT_OF_RESOURCES   Could not allocate enough resource to finish the operation.
 761   @retval EFI_DEVICE_ERROR       Any unexpected and not belonged to above category error.
 762
 763 **/
 764 typedef
 765 EFI_STATUS
 766 (EFIAPI *EFI_TCP6_CLOSE)(
 767   IN EFI_TCP6_PROTOCOL           *This,
 768   IN EFI_TCP6_CLOSE_TOKEN        *CloseToken
 769   );
 770
 771 /**
 772   Abort an asynchronous connection, listen, transmission or receive request.
 773
 774   The Cancel() function aborts a pending connection, listen, transmit or
 775   receive request.
 776
 777   If Token is not NULL and the token is in the connection, listen, transmission
 778   or receive queue when it is being cancelled, its Token->Status will be set
 779   to EFI_ABORTED and then Token->Event will be signaled.
 780
 781   If the token is not in one of the queues, which usually means that the
 782   asynchronous operation has completed, EFI_NOT_FOUND is returned.
 783
 784   If Token is NULL all asynchronous token issued by Connect(), Accept(),
 785   Transmit() and Receive() will be aborted.
 786
 787   @param[in] This                Pointer to the EFI_TCP6_PROTOCOL instance.
 788   @param[in] Token               Pointer to a token that has been issued by
 789                                  EFI_TCP6_PROTOCOL.Connect(),
 790                                  EFI_TCP6_PROTOCOL.Accept(),
 791                                  EFI_TCP6_PROTOCOL.Transmit() or
 792                                  EFI_TCP6_PROTOCOL.Receive(). If NULL, all pending
 793                                  tokens issued by above four functions will be aborted. Type
 794                                  EFI_TCP6_COMPLETION_TOKEN is defined in
 795                                  EFI_TCP_PROTOCOL.Connect().
 796
 797   @retval EFI_SUCCESS            The asynchronous I/O request is aborted and Token->Event
 798                                  is signaled.
 799   @retval EFI_INVALID_PARAMETER  This is NULL.
 800   @retval EFI_NOT_STARTED        This instance hasn't been configured.
 801   @retval EFI_NOT_FOUND          The asynchronous I/O request isn't found in the transmission or
 802                                  receive queue. It has either completed or wasn't issued by
 803                                  Transmit() and Receive().
 804   @retval EFI_UNSUPPORTED        The implementation does not support this function.
 805
 806 **/
 807 typedef
 808 EFI_STATUS
 809 (EFIAPI *EFI_TCP6_CANCEL)(
 810   IN EFI_TCP6_PROTOCOL           *This,
 811   IN EFI_TCP6_COMPLETION_TOKEN   *Token OPTIONAL
 812   );
 813
 814 /**
 815   Poll to receive incoming data and transmit outgoing segments.
 816
 817   The Poll() function increases the rate that data is moved between the network
 818   and application and can be called when the TCP instance is created successfully.
 819   Its use is optional.
 820
 821   @param[in] This                Pointer to the EFI_TCP6_PROTOCOL instance.
 822
 823   @retval EFI_SUCCESS            Incoming or outgoing data was processed.
 824   @retval EFI_INVALID_PARAMETER  This is NULL.
 825   @retval EFI_DEVICE_ERROR       An unexpected system or network error occurred.
 826   @retval EFI_NOT_READY          No incoming or outgoing data is processed.
 827   @retval EFI_TIMEOUT            Data was dropped out of the transmission or receive queue.
 828                                  Consider increasing the polling rate.
 829
 830 **/
 831 typedef
 832 EFI_STATUS
 833 (EFIAPI *EFI_TCP6_POLL)(
 834   IN EFI_TCP6_PROTOCOL        *This
 835   );
 836
 837 ///
 838 /// EFI_TCP6_PROTOCOL
 839 /// defines the EFI TCPv6 Protocol child to be used by any network drivers or
 840 /// applications to send or receive data stream. It can either listen on a
 841 /// specified port as a service or actively connect to remote peer as a client.
 842 /// Each instance has its own independent settings.
 843 ///
 844 struct _EFI_TCP6_PROTOCOL {
 845   EFI_TCP6_GET_MODE_DATA  GetModeData;
 846   EFI_TCP6_CONFIGURE      Configure;
 847   EFI_TCP6_CONNECT        Connect;
 848   EFI_TCP6_ACCEPT         Accept;
 849   EFI_TCP6_TRANSMIT       Transmit;
 850   EFI_TCP6_RECEIVE        Receive;
 851   EFI_TCP6_CLOSE          Close;
 852   EFI_TCP6_CANCEL         Cancel;
 853   EFI_TCP6_POLL           Poll;
 854 };
 855
 856 extern EFI_GUID gEfiTcp6ServiceBindingProtocolGuid;
 857 extern EFI_GUID gEfiTcp6ProtocolGuid;
 858
 859 #endif
 860