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