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.
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
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.
16 @par Revision Reference:
17 This Protocol is introduced in UEFI Specification 2.2
21 #ifndef __EFI_TCP6_PROTOCOL_H__
22 #define __EFI_TCP6_PROTOCOL_H__
24 #include <Protocol/ManagedNetwork.h>
25 #include <Protocol/Ip6.h>
27 #define EFI_TCP6_SERVICE_BINDING_PROTOCOL_GUID \
29 0xec20eb79, 0x6c1a, 0x4664, {0x9a, 0x0d, 0xd2, 0xe4, 0xcc, 0x16, 0xd6, 0x64 } \
32 #define EFI_TCP6_PROTOCOL_GUID \
34 0x46e44855, 0xbd60, 0x4ab7, {0xab, 0x0d, 0xa6, 0x79, 0xb9, 0x44, 0x7d, 0x77 } \
38 typedef struct _EFI_TCP6_PROTOCOL EFI_TCP6_PROTOCOL
;
41 /// EFI_TCP6_SERVICE_POINT
45 /// The EFI TCPv6 Protocol instance handle that is using this
46 /// address/port pair.
48 EFI_HANDLE InstanceHandle
;
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.
54 EFI_IPv6_ADDRESS LocalAddress
;
56 /// The local port number in host byte order.
60 /// The remote IPv6 address. It may be 0::/128 if this TCP instance is
61 /// not connected to any remote host.
63 EFI_IPv6_ADDRESS RemoteAddress
;
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.
69 } EFI_TCP6_SERVICE_POINT
;
72 /// EFI_TCP6_VARIABLE_DATA
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
;
81 /// EFI_TCP6_ACCESS_POINT
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
92 EFI_IPv6_ADDRESS StationAddress
;
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.
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.
110 EFI_IPv6_ADDRESS RemoteAddress
;
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.
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.
125 } EFI_TCP6_ACCESS_POINT
;
132 /// The size of the TCP receive buffer.
134 UINT32 ReceiveBufferSize
;
136 /// The size of the TCP send buffer.
138 UINT32 SendBufferSize
;
140 /// The length of incoming connect request queue for a passive
141 /// instance. When set to zero, the value is implementation specific.
143 UINT32 MaxSynBackLog
;
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.
149 UINT32 ConnectionTimeout
;
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.
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.
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.
172 UINT32 TimeWaitTimeout
;
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.
178 UINT32 KeepAliveProbes
;
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.
185 UINT32 KeepAliveTime
;
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.
192 UINT32 KeepAliveInterval
;
194 /// Set it to TRUE to enable the Nagle algorithm as defined in
195 /// RFC896. Set it to FALSE to disable it.
199 /// Set it to TRUE to enable TCP timestamps option as defined in
200 /// RFC1323. Set to FALSE to disable it.
202 BOOLEAN EnableTimeStamp
;
204 /// Set it to TRUE to enable TCP window scale option as defined in
205 /// RFC1323. Set it to FALSE to disable it.
207 BOOLEAN EnableWindowScaling
;
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.
214 BOOLEAN EnableSelectiveAck
;
216 /// Set it to TRUE to enable path MTU discovery as defined in
217 /// RFC 1191. Set to FALSE to disable it.
219 BOOLEAN EnablePathMtuDiscovery
;
223 /// EFI_TCP6_CONFIG_DATA
227 /// TrafficClass field in transmitted IPv6 packets.
231 /// HopLimit field in transmitted IPv6 packets.
235 /// Used to specify TCP communication end settings for a TCP instance.
237 EFI_TCP6_ACCESS_POINT AccessPoint
;
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.
242 EFI_TCP6_OPTION
*ControlOption
;
243 } EFI_TCP6_CONFIG_DATA
;
246 /// EFI_TCP6_CONNECTION_STATE
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
;
263 /// EFI_TCP6_COMPLETION_TOKEN
264 /// is used as a common header for various asynchronous tokens.
268 /// The Event to signal after request is finished and Status field is
269 /// updated by the EFI TCPv6 Protocol driver.
273 /// The result of the completed operation.
276 } EFI_TCP6_COMPLETION_TOKEN
;
279 /// EFI_TCP6_CONNECTION_TOKEN
280 /// will be set if the active open succeeds or an unexpected
285 /// The Status in the CompletionToken will be set to one of
286 /// the following values if the active open succeeds or an unexpected
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.
310 EFI_TCP6_COMPLETION_TOKEN CompletionToken
;
311 } EFI_TCP6_CONNECTION_TOKEN
;
314 /// EFI_TCP6_LISTEN_TOKEN
315 /// returns when list operation finishes.
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.
329 EFI_TCP6_COMPLETION_TOKEN CompletionToken
;
330 EFI_HANDLE NewChildHandle
;
331 } EFI_TCP6_LISTEN_TOKEN
;
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.
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
;
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.
351 /// Whether the data is urgent. When this flag is set, the instance is in
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.
363 /// Number of fragments.
365 UINT32 FragmentCount
;
367 /// An array of fragment descriptors.
369 EFI_TCP6_FRAGMENT_DATA FragmentTable
[1];
370 } EFI_TCP6_RECEIVE_DATA
;
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.
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.
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.
391 /// Length of the data in the fragments.
395 /// Number of fragments.
397 UINT32 FragmentCount
;
399 /// An array of fragment descriptors.
401 EFI_TCP6_FRAGMENT_DATA FragmentTable
[1];
402 } EFI_TCP6_TRANSMIT_DATA
;
405 /// EFI_TCP6_IO_TOKEN
406 /// returns When transmission finishes or meets any unexpected error.
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
437 EFI_TCP6_COMPLETION_TOKEN CompletionToken
;
440 /// When this token is used for receiving, RxData is a pointer to
441 /// EFI_TCP6_RECEIVE_DATA.
443 EFI_TCP6_RECEIVE_DATA
*RxData
;
445 /// When this token is used for transmitting, TxData is a pointer to
446 /// EFI_TCP6_TRANSMIT_DATA.
448 EFI_TCP6_TRANSMIT_DATA
*TxData
;
453 /// EFI_TCP6_CLOSE_TOKEN
454 /// returns when close operation finishes.
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.
464 EFI_TCP6_COMPLETION_TOKEN CompletionToken
;
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.
470 BOOLEAN AbortOnClose
;
471 } EFI_TCP6_CLOSE_TOKEN
;
474 Get the current operational status.
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.
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.
490 @retval EFI_SUCCESS The mode data was read.
491 @retval EFI_NOT_STARTED No configuration data is available because this instance hasn't
493 @retval EFI_INVALID_PARAMETER This is NULL.
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
508 Initialize or brutally reset the operational parameters for this EFI TCPv6 instance.
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.
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.
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.
529 @retval EFI_SUCCESS The operational settings are set, changed, or reset
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
534 @retval EFI_INVALID_PARAMETER One or more of the following conditions are TRUE:
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
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
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
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.
556 (EFIAPI
*EFI_TCP6_CONFIGURE
)(
557 IN EFI_TCP6_PROTOCOL
*This
,
558 IN EFI_TCP6_CONFIG_DATA
*Tcp6ConfigData OPTIONAL
562 Initiate a nonblocking TCP connection request for an active TCP instance.
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.
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.
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:
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.
593 (EFIAPI
*EFI_TCP6_CONNECT
)(
594 IN EFI_TCP6_PROTOCOL
*This
,
595 IN EFI_TCP6_CONNECTION_TOKEN
*ConnectionToken
599 Listen on the passive instance to accept an incoming connection request. This is a
600 nonblocking operation.
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.
609 The ListenToken->CompletionToken.Event will be signaled when a new connection is
610 accepted, user aborts the listen or connection is reset.
612 This function only can be called when current TCP instance is in Tcp6StateListen state.
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.
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:
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.
635 (EFIAPI
*EFI_TCP6_ACCEPT
)(
636 IN EFI_TCP6_PROTOCOL
*This
,
637 IN EFI_TCP6_LISTEN_TOKEN
*ListenToken
641 Queues outgoing data into the transmit queue.
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.
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.
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
655 @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
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
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
674 @retval EFI_NETWORK_UNREACHABLE There is no route to the destination network or address.
679 (EFIAPI
*EFI_TCP6_TRANSMIT
)(
680 IN EFI_TCP6_PROTOCOL
*This
,
681 IN EFI_TCP6_IO_TOKEN
*Token
685 Places an asynchronous receive request into the receiving queue.
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.
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
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:
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.
732 (EFIAPI
*EFI_TCP6_RECEIVE
)(
733 IN EFI_TCP6_PROTOCOL
*This
,
734 IN EFI_TCP6_IO_TOKEN
*Token
738 Disconnecting a TCP connection gracefully or reset a TCP connection. This function is a
739 nonblocking operation.
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.
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.
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:
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.
766 (EFIAPI
*EFI_TCP6_CLOSE
)(
767 IN EFI_TCP6_PROTOCOL
*This
,
768 IN EFI_TCP6_CLOSE_TOKEN
*CloseToken
772 Abort an asynchronous connection, listen, transmission or receive request.
774 The Cancel() function aborts a pending connection, listen, transmit or
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.
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.
784 If Token is NULL all asynchronous token issued by Connect(), Accept(),
785 Transmit() and Receive() will be aborted.
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().
797 @retval EFI_SUCCESS The asynchronous I/O request is aborted and Token->Event
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.
809 (EFIAPI
*EFI_TCP6_CANCEL
)(
810 IN EFI_TCP6_PROTOCOL
*This
,
811 IN EFI_TCP6_COMPLETION_TOKEN
*Token OPTIONAL
815 Poll to receive incoming data and transmit outgoing segments.
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.
821 @param[in] This Pointer to the EFI_TCP6_PROTOCOL instance.
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.
833 (EFIAPI
*EFI_TCP6_POLL
)(
834 IN EFI_TCP6_PROTOCOL
*This
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.
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
;
856 extern EFI_GUID gEfiTcp6ServiceBindingProtocolGuid
;
857 extern EFI_GUID gEfiTcp6ProtocolGuid
;