iPXE
Tcp4.h
Go to the documentation of this file.
1 /** @file
2  EFI TCPv4(Transmission Control Protocol version 4) Protocol Definition
3  The EFI TCPv4 Service Binding Protocol is used to locate EFI TCPv4 Protocol drivers to create
4  and destroy child of the driver to communicate with other host using TCP protocol.
5  The EFI TCPv4 Protocol provides services to send and receive data stream.
6 
7 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
8 SPDX-License-Identifier: BSD-2-Clause-Patent
9 
10  @par Revision Reference:
11  This Protocol is introduced in UEFI Specification 2.0.
12 
13 **/
14 
15 #ifndef __EFI_TCP4_PROTOCOL_H__
16 #define __EFI_TCP4_PROTOCOL_H__
17 
18 FILE_LICENCE ( BSD2_PATENT );
19 FILE_SECBOOT ( PERMITTED );
20 
21 #include <ipxe/efi/Protocol/Ip4.h>
22 
23 #define EFI_TCP4_SERVICE_BINDING_PROTOCOL_GUID \
24  { \
25  0x00720665, 0x67EB, 0x4a99, {0xBA, 0xF7, 0xD3, 0xC3, 0x3A, 0x1C, 0x7C, 0xC9 } \
26  }
27 
28 #define EFI_TCP4_PROTOCOL_GUID \
29  { \
30  0x65530BC7, 0xA359, 0x410f, {0xB0, 0x10, 0x5A, 0xAD, 0xC7, 0xEC, 0x2B, 0x62 } \
31  }
32 
34 
35 ///
36 /// EFI_TCP4_SERVICE_POINT is deprecated in the UEFI 2.4B and should not be used any more.
37 /// The definition in here is only present to provide backwards compatability.
38 ///
39 typedef struct {
46 
47 ///
48 /// EFI_TCP4_VARIABLE_DATA is deprecated in the UEFI 2.4B and should not be used any more.
49 /// The definition in here is only present to provide backwards compatability.
50 ///
51 typedef struct {
56 
57 typedef struct {
66 
67 typedef struct {
84 
85 typedef struct {
86  //
87  // I/O parameters
88  //
91 
92  //
93  // Access Point
94  //
96 
97  //
98  // TCP Control Options
99  //
102 
103 ///
104 /// TCP4 connnection state
105 ///
106 typedef enum {
119 
120 typedef struct {
124 
125 typedef struct {
126  ///
127  /// The Status in the CompletionToken will be set to one of
128  /// the following values if the active open succeeds or an unexpected
129  /// error happens:
130  /// EFI_SUCCESS: The active open succeeds and the instance's
131  /// state is Tcp4StateEstablished.
132  /// EFI_CONNECTION_RESET: The connect fails because the connection is reset
133  /// either by instance itself or the communication peer.
134  /// EFI_CONNECTION_REFUSED: The connect fails because this connection is initiated with
135  /// an active open and the connection is refused.
136  /// EFI_ABORTED: The active open is aborted.
137  /// EFI_TIMEOUT: The connection establishment timer expires and
138  /// no more specific information is available.
139  /// EFI_NETWORK_UNREACHABLE: The active open fails because
140  /// an ICMP network unreachable error is received.
141  /// EFI_HOST_UNREACHABLE: The active open fails because an
142  /// ICMP host unreachable error is received.
143  /// EFI_PROTOCOL_UNREACHABLE: The active open fails
144  /// because an ICMP protocol unreachable error is received.
145  /// EFI_PORT_UNREACHABLE: The connection establishment
146  /// timer times out and an ICMP port unreachable error is received.
147  /// EFI_ICMP_ERROR: The connection establishment timer timeout and some other ICMP
148  /// error is received.
149  /// EFI_DEVICE_ERROR: An unexpected system or network error occurred.
150  /// EFI_NO_MEDIA: There was a media error.
151  ///
154 
155 typedef struct {
159 
160 typedef struct {
164 
165 typedef struct {
169  EFI_TCP4_FRAGMENT_DATA FragmentTable[1];
171 
172 typedef struct {
177  EFI_TCP4_FRAGMENT_DATA FragmentTable[1];
179 
180 typedef struct {
181  ///
182  /// When transmission finishes or meets any unexpected error it will
183  /// be set to one of the following values:
184  /// EFI_SUCCESS: The receiving or transmission operation
185  /// completes successfully.
186  /// EFI_CONNECTION_FIN: The receiving operation fails because the communication peer
187  /// has closed the connection and there is no more data in the
188  /// receive buffer of the instance.
189  /// EFI_CONNECTION_RESET: The receiving or transmission operation fails
190  /// because this connection is reset either by instance
191  /// itself or the communication peer.
192  /// EFI_ABORTED: The receiving or transmission is aborted.
193  /// EFI_TIMEOUT: The transmission timer expires and no more
194  /// specific information is available.
195  /// EFI_NETWORK_UNREACHABLE: The transmission fails
196  /// because an ICMP network unreachable error is received.
197  /// EFI_HOST_UNREACHABLE: The transmission fails because an
198  /// ICMP host unreachable error is received.
199  /// EFI_PROTOCOL_UNREACHABLE: The transmission fails
200  /// because an ICMP protocol unreachable error is received.
201  /// EFI_PORT_UNREACHABLE: The transmission fails and an
202  /// ICMP port unreachable error is received.
203  /// EFI_ICMP_ERROR: The transmission fails and some other
204  /// ICMP error is received.
205  /// EFI_DEVICE_ERROR: An unexpected system or network error occurs.
206  /// EFI_NO_MEDIA: There was a media error.
207  ///
209  union {
210  ///
211  /// When this token is used for receiving, RxData is a pointer to EFI_TCP4_RECEIVE_DATA.
212  ///
214  ///
215  /// When this token is used for transmitting, TxData is a pointer to EFI_TCP4_TRANSMIT_DATA.
216  ///
218  } Packet;
220 
221 typedef struct {
225 
226 //
227 // Interface definition for TCP4 protocol
228 //
229 
230 /**
231  Get the current operational status.
232 
233  @param This The pointer to the EFI_TCP4_PROTOCOL instance.
234  @param Tcp4State The pointer to the buffer to receive the current TCP state.
235  @param Tcp4ConfigData The pointer to the buffer to receive the current TCP configuration.
236  @param Ip4ModeData The pointer to the buffer to receive the current IPv4 configuration
237  data used by the TCPv4 instance.
238  @param MnpConfigData The pointer to the buffer to receive the current MNP configuration
239  data used indirectly by the TCPv4 instance.
240  @param SnpModeData The pointer to the buffer to receive the current SNP configuration
241  data used indirectly by the TCPv4 instance.
242 
243  @retval EFI_SUCCESS The mode data was read.
244  @retval EFI_INVALID_PARAMETER This is NULL.
245  @retval EFI_NOT_STARTED No configuration data is available because this instance hasn't
246  been started.
247 
248 **/
249 typedef
252  IN EFI_TCP4_PROTOCOL *This,
254  OUT EFI_TCP4_CONFIG_DATA *Tcp4ConfigData OPTIONAL,
255  OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL,
258  );
259 
260 /**
261  Initialize or brutally reset the operational parameters for this EFI TCPv4 instance.
262 
263  @param This The pointer to the EFI_TCP4_PROTOCOL instance.
264  @param Tcp4ConfigData The pointer to the configure data to configure the instance.
265 
266  @retval EFI_SUCCESS The operational settings are set, changed, or reset
267  successfully.
268  @retval EFI_INVALID_PARAMETER Some parameter is invalid.
269  @retval EFI_NO_MAPPING When using a default address, configuration (through
270  DHCP, BOOTP, RARP, etc.) is not finished yet.
271  @retval EFI_ACCESS_DENIED Configuring TCP instance when it is configured without
272  calling Configure() with NULL to reset it.
273  @retval EFI_DEVICE_ERROR An unexpected network or system error occurred.
274  @retval EFI_UNSUPPORTED One or more of the control options are not supported in
275  the implementation.
276  @retval EFI_OUT_OF_RESOURCES Could not allocate enough system resources when
277  executing Configure().
278 
279 **/
280 typedef
283  IN EFI_TCP4_PROTOCOL *This,
284  IN EFI_TCP4_CONFIG_DATA *TcpConfigData OPTIONAL
285  );
286 
287 /**
288  Add or delete a route entry to the route table
289 
290  @param This The pointer to the EFI_TCP4_PROTOCOL instance.
291  @param DeleteRoute Set it to TRUE to delete this route from the routing table. Set it to
292  FALSE to add this route to the routing table.
293  DestinationAddress and SubnetMask are used as the
294  keywords to search route entry.
295  @param SubnetAddress The destination network.
296  @param SubnetMask The subnet mask of the destination network.
297  @param GatewayAddress The gateway address for this route. It must be on the same
298  subnet with the station address unless a direct route is specified.
299 
300  @retval EFI_SUCCESS The operation completed successfully.
301  @retval EFI_NOT_STARTED The EFI TCPv4 Protocol instance has not been configured.
302  @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
303  RARP, etc.) is not finished yet.
304  @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
305  - This is NULL.
306  - SubnetAddress is NULL.
307  - SubnetMask is NULL.
308  - GatewayAddress is NULL.
309  - *SubnetAddress is not NULL a valid subnet address.
310  - *SubnetMask is not a valid subnet mask.
311  - *GatewayAddress is not a valid unicast IP address or it
312  is not in the same subnet.
313  @retval EFI_OUT_OF_RESOURCES Could not allocate enough resources to add the entry to the
314  routing table.
315  @retval EFI_NOT_FOUND This route is not in the routing table.
316  @retval EFI_ACCESS_DENIED The route is already defined in the routing table.
317  @retval EFI_UNSUPPORTED The TCP driver does not support this operation.
318 
319 **/
320 typedef
323  IN EFI_TCP4_PROTOCOL *This,
324  IN BOOLEAN DeleteRoute,
325  IN EFI_IPv4_ADDRESS *SubnetAddress,
326  IN EFI_IPv4_ADDRESS *SubnetMask,
327  IN EFI_IPv4_ADDRESS *GatewayAddress
328  );
329 
330 /**
331  Initiate a nonblocking TCP connection request for an active TCP instance.
332 
333  @param This The pointer to the EFI_TCP4_PROTOCOL instance.
334  @param ConnectionToken The pointer to the connection token to return when the TCP three
335  way handshake finishes.
336 
337  @retval EFI_SUCCESS The connection request is successfully initiated and the state
338  of this TCPv4 instance has been changed to Tcp4StateSynSent.
339  @retval EFI_NOT_STARTED This EFI TCPv4 Protocol instance has not been configured.
340  @retval EFI_ACCESS_DENIED One or more of the following conditions are TRUE:
341  - This instance is not configured as an active one.
342  - This instance is not in Tcp4StateClosed state.
343  @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
344  - This is NULL.
345  - ConnectionToken is NULL.
346  - ConnectionToken->CompletionToken.Event is NULL.
347  @retval EFI_OUT_OF_RESOURCES The driver can't allocate enough resource to initiate the activ eopen.
348  @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
349 
350 **/
351 typedef
354  IN EFI_TCP4_PROTOCOL *This,
355  IN EFI_TCP4_CONNECTION_TOKEN *ConnectionToken
356  );
357 
358 /**
359  Listen on the passive instance to accept an incoming connection request. This is a nonblocking operation.
360 
361  @param This The pointer to the EFI_TCP4_PROTOCOL instance.
362  @param ListenToken The pointer to the listen token to return when operation finishes.
363 
364  @retval EFI_SUCCESS The listen token has been queued successfully.
365  @retval EFI_NOT_STARTED This EFI TCPv4 Protocol instance has not been configured.
366  @retval EFI_ACCESS_DENIED One or more of the following are TRUE:
367  - This instance is not a passive instance.
368  - This instance is not in Tcp4StateListen state.
369  - The same listen token has already existed in the listen
370  token queue of this TCP instance.
371  @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
372  - This is NULL.
373  - ListenToken is NULL.
374  - ListentToken->CompletionToken.Event is NULL.
375  @retval EFI_OUT_OF_RESOURCES Could not allocate enough resource to finish the operation.
376  @retval EFI_DEVICE_ERROR Any unexpected and not belonged to above category error.
377 
378 **/
379 typedef
382  IN EFI_TCP4_PROTOCOL *This,
383  IN EFI_TCP4_LISTEN_TOKEN *ListenToken
384  );
385 
386 /**
387  Queues outgoing data into the transmit queue.
388 
389  @param This The pointer to the EFI_TCP4_PROTOCOL instance.
390  @param Token The pointer to the completion token to queue to the transmit queue.
391 
392  @retval EFI_SUCCESS The data has been queued for transmission.
393  @retval EFI_NOT_STARTED This EFI TCPv4 Protocol instance has not been configured.
394  @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
395  RARP, etc.) is not finished yet.
396  @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
397  - This is NULL.
398  - Token is NULL.
399  - Token->CompletionToken.Event is NULL.
400  - Token->Packet.TxData is NULL L.
401  - Token->Packet.FragmentCount is zero.
402  - Token->Packet.DataLength is not equal to the sum of fragment lengths.
403  @retval EFI_ACCESS_DENIED One or more of the following conditions is TRUE:
404  - A transmit completion token with the same Token->CompletionToken.Event
405  was already in the transmission queue.
406  - The current instance is in Tcp4StateClosed state.
407  - The current instance is a passive one and it is in
408  Tcp4StateListen state.
409  - User has called Close() to disconnect this connection.
410  @retval EFI_NOT_READY The completion token could not be queued because the
411  transmit queue is full.
412  @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data because of resource
413  shortage.
414  @retval EFI_NETWORK_UNREACHABLE There is no route to the destination network or address.
415 
416 **/
417 typedef
420  IN EFI_TCP4_PROTOCOL *This,
421  IN EFI_TCP4_IO_TOKEN *Token
422  );
423 
424 /**
425  Places an asynchronous receive request into the receiving queue.
426 
427  @param This The pointer to the EFI_TCP4_PROTOCOL instance.
428  @param Token The pointer to a token that is associated with the receive data
429  descriptor.
430 
431  @retval EFI_SUCCESS The receive completion token was cached.
432  @retval EFI_NOT_STARTED This EFI TCPv4 Protocol instance has not been configured.
433  @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, RARP,
434  etc.) is not finished yet.
435  @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
436  - This is NULL.
437  - Token is NULL.
438  - Token->CompletionToken.Event is NULL.
439  - Token->Packet.RxData is NULL.
440  - Token->Packet.RxData->DataLength is 0.
441  - The Token->Packet.RxData->DataLength is not
442  the sum of all FragmentBuffer length in FragmentTable.
443  @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of
444  system resources (usually memory).
445  @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
446  @retval EFI_ACCESS_DENIED One or more of the following conditions is TRUE:
447  - A receive completion token with the same Token-
448  >CompletionToken.Event was already in the receive
449  queue.
450  - The current instance is in Tcp4StateClosed state.
451  - The current instance is a passive one and it is in
452  Tcp4StateListen state.
453  - User has called Close() to disconnect this connection.
454  @retval EFI_CONNECTION_FIN The communication peer has closed the connection and there is
455  no any buffered data in the receive buffer of this instance.
456  @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.
457 
458 **/
459 typedef
462  IN EFI_TCP4_PROTOCOL *This,
463  IN EFI_TCP4_IO_TOKEN *Token
464  );
465 
466 /**
467  Disconnecting a TCP connection gracefully or reset a TCP connection. This function is a
468  nonblocking operation.
469 
470  @param This The pointer to the EFI_TCP4_PROTOCOL instance.
471  @param CloseToken The pointer to the close token to return when operation finishes.
472 
473  @retval EFI_SUCCESS The Close() is called successfully.
474  @retval EFI_NOT_STARTED This EFI TCPv4 Protocol instance has not been configured.
475  @retval EFI_ACCESS_DENIED One or more of the following are TRUE:
476  - Configure() has been called with
477  TcpConfigData set to NULL and this function has
478  not returned.
479  - Previous Close() call on this instance has not
480  finished.
481  @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
482  - This is NULL.
483  - CloseToken is NULL.
484  - CloseToken->CompletionToken.Event is NULL.
485  @retval EFI_OUT_OF_RESOURCES Could not allocate enough resource to finish the operation.
486  @retval EFI_DEVICE_ERROR Any unexpected and not belonged to above category error.
487 
488 **/
489 typedef
492  IN EFI_TCP4_PROTOCOL *This,
493  IN EFI_TCP4_CLOSE_TOKEN *CloseToken
494  );
495 
496 /**
497  Abort an asynchronous connection, listen, transmission or receive request.
498 
499  @param This The pointer to the EFI_TCP4_PROTOCOL instance.
500  @param Token The pointer to a token that has been issued by
501  EFI_TCP4_PROTOCOL.Connect(),
502  EFI_TCP4_PROTOCOL.Accept(),
503  EFI_TCP4_PROTOCOL.Transmit() or
504  EFI_TCP4_PROTOCOL.Receive(). If NULL, all pending
505  tokens issued by above four functions will be aborted. Type
506  EFI_TCP4_COMPLETION_TOKEN is defined in
507  EFI_TCP4_PROTOCOL.Connect().
508 
509  @retval EFI_SUCCESS The asynchronous I/O request is aborted and Token->Event
510  is signaled.
511  @retval EFI_INVALID_PARAMETER This is NULL.
512  @retval EFI_NOT_STARTED This instance hasn't been configured.
513  @retval EFI_NO_MAPPING When using the default address, configuration
514  (DHCP, BOOTP,RARP, etc.) hasn't finished yet.
515  @retval EFI_NOT_FOUND The asynchronous I/O request isn't found in the
516  transmission or receive queue. It has either
517  completed or wasn't issued by Transmit() and Receive().
518  @retval EFI_UNSUPPORTED The implementation does not support this function.
519 
520 **/
521 typedef
524  IN EFI_TCP4_PROTOCOL *This,
526  );
527 
528 /**
529  Poll to receive incoming data and transmit outgoing segments.
530 
531  @param This The pointer to the EFI_TCP4_PROTOCOL instance.
532 
533  @retval EFI_SUCCESS Incoming or outgoing data was processed.
534  @retval EFI_INVALID_PARAMETER This is NULL.
535  @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
536  @retval EFI_NOT_READY No incoming or outgoing data is processed.
537  @retval EFI_TIMEOUT Data was dropped out of the transmission or receive queue.
538  Consider increasing the polling rate.
539 
540 **/
541 typedef
544  IN EFI_TCP4_PROTOCOL *This
545  );
546 
547 ///
548 /// The EFI_TCP4_PROTOCOL defines the EFI TCPv4 Protocol child to be used by
549 /// any network drivers or applications to send or receive data stream.
550 /// It can either listen on a specified port as a service or actively connected
551 /// to remote peer as a client. Each instance has its own independent settings,
552 /// such as the routing table.
553 ///
565 };
566 
569 
570 #endif
#define OPTIONAL
Passing the datum to the function is optional, and a NULL is passed if the value is not supplied.
Definition: Base.h:293
EFI_HANDLE NewChildHandle
Definition: Tcp4.h:157
BOOLEAN EnableWindowScaling
Definition: Tcp4.h:80
EFI_STATUS(EFIAPI * EFI_TCP4_RECEIVE)(IN EFI_TCP4_PROTOCOL *This, IN EFI_TCP4_IO_TOKEN *Token)
Places an asynchronous receive request into the receiving queue.
Definition: Tcp4.h:461
EFI_TCP4_COMPLETION_TOKEN CompletionToken
The Status in the CompletionToken will be set to one of the following values if the active open succe...
Definition: Tcp4.h:152
EFI_TCP4_COMPLETION_TOKEN CompletionToken
Definition: Tcp4.h:156
BOOLEAN EnableNagle
Definition: Tcp4.h:78
UINT32 DataLength
Definition: Tcp4.h:167
128 bit buffer containing a unique identifier value.
Definition: Base.h:216
EFI_IPv4_ADDRESS StationAddress
Definition: Tcp4.h:59
Definition: efi.h:63
EFI_TCP4_CONNECT Connect
Definition: Tcp4.h:558
UINT16 LocalPort
Definition: Tcp4.h:42
unsigned char BOOLEAN
UINT32 ReceiveBufferSize
Definition: Tcp4.h:68
UINT16 RemotePort
Definition: Tcp4.h:63
UINT32 FragmentCount
Definition: Tcp4.h:168
EFI_HANDLE InstanceHandle
Definition: Tcp4.h:40
unsigned int UINT32
Definition: ProcessorBind.h:99
EFI_STATUS(EFIAPI * EFI_TCP4_ACCEPT)(IN EFI_TCP4_PROTOCOL *This, IN EFI_TCP4_LISTEN_TOKEN *ListenToken)
Listen on the passive instance to accept an incoming connection request.
Definition: Tcp4.h:381
BOOLEAN AbortOnClose
Definition: Tcp4.h:223
EFI_HANDLE DriverHandle
Definition: Tcp4.h:52
unsigned char UINT8
BOOLEAN EnablePathMtuDiscovery
Definition: Tcp4.h:82
EFI_TCP4_ACCESS_POINT AccessPoint
Definition: Tcp4.h:95
EFI_TCP4_CANCEL Cancel
Definition: Tcp4.h:563
VOID * FragmentBuffer
Definition: Tcp4.h:162
UINT32 ConnectionTimeout
Definition: Tcp4.h:71
BOOLEAN ActiveFlag
Definition: Tcp4.h:64
UINT32 KeepAliveInterval
Definition: Tcp4.h:77
#define OUT
Definition: mlx_utils.h:29
This file defines the EFI IPv4 (Internet Protocol version 4) Protocol interface.
EFI_STATUS Status
Definition: Tcp4.h:122
EFI_STATUS(EFIAPI * EFI_TCP4_CONNECT)(IN EFI_TCP4_PROTOCOL *This, IN EFI_TCP4_CONNECTION_TOKEN *ConnectionToken)
Initiate a nonblocking TCP connection request for an active TCP instance.
Definition: Tcp4.h:353
4-byte buffer.
Definition: Base.h:226
EFI_TCP4_OPTION * ControlOption
Definition: Tcp4.h:100
UINT16 RemotePort
Definition: Tcp4.h:44
EFI_STATUS(EFIAPI * EFI_TCP4_POLL)(IN EFI_TCP4_PROTOCOL *This)
Poll to receive incoming data and transmit outgoing segments.
Definition: Tcp4.h:543
UINT32 FragmentLength
Definition: Tcp4.h:161
unsigned short UINT16
EFI_GUID gEfiTcp4ServiceBindingProtocolGuid
EFI_STATUS(EFIAPI * EFI_TCP4_TRANSMIT)(IN EFI_TCP4_PROTOCOL *This, IN EFI_TCP4_IO_TOKEN *Token)
Queues outgoing data into the transmit queue.
Definition: Tcp4.h:419
#define EFIAPI
FILE_LICENCE(BSD2_PATENT)
UINT32 FragmentCount
Definition: Tcp4.h:176
EFI_GUID gEfiTcp4ProtocolGuid
BOOLEAN UrgentFlag
Definition: Tcp4.h:166
EFI_TCP4_RECEIVE Receive
Definition: Tcp4.h:561
UINT32 MaxSynBackLog
Definition: Tcp4.h:70
FILE_SECBOOT(PERMITTED)
UINT8 TypeOfService
Definition: Tcp4.h:89
#define VOID
Undeclared type.
Definition: Base.h:272
#define IN
Definition: mlx_utils.h:28
EFI_TCP4_COMPLETION_TOKEN CompletionToken
When transmission finishes or meets any unexpected error it will be set to one of the following value...
Definition: Tcp4.h:208
EFI_TCP4_CLOSE Close
Definition: Tcp4.h:562
EFI_STATUS(EFIAPI * EFI_TCP4_ROUTES)(IN EFI_TCP4_PROTOCOL *This, IN BOOLEAN DeleteRoute, IN EFI_IPv4_ADDRESS *SubnetAddress, IN EFI_IPv4_ADDRESS *SubnetMask, IN EFI_IPv4_ADDRESS *GatewayAddress)
Add or delete a route entry to the route table.
Definition: Tcp4.h:322
EFI_STATUS(EFIAPI * EFI_TCP4_CONFIGURE)(IN EFI_TCP4_PROTOCOL *This, IN EFI_TCP4_CONFIG_DATA *TcpConfigData OPTIONAL)
Initialize or brutally reset the operational parameters for this EFI TCPv4 instance.
Definition: Tcp4.h:282
UINT32 FinTimeout
Definition: Tcp4.h:73
UINT32 SendBufferSize
Definition: Tcp4.h:69
UINT16 StationPort
Definition: Tcp4.h:61
BOOLEAN EnableTimeStamp
Definition: Tcp4.h:79
UINT32 ServiceCount
Definition: Tcp4.h:53
EFI_TCP4_TRANSMIT_DATA * TxData
When this token is used for transmitting, TxData is a pointer to EFI_TCP4_TRANSMIT_DATA.
Definition: Tcp4.h:217
EFI_STATUS(EFIAPI * EFI_TCP4_CLOSE)(IN EFI_TCP4_PROTOCOL *This, IN EFI_TCP4_CLOSE_TOKEN *CloseToken)
Disconnecting a TCP connection gracefully or reset a TCP connection.
Definition: Tcp4.h:491
EFI_TCP4_POLL Poll
Definition: Tcp4.h:564
EFI_TCP4_CONFIGURE Configure
Definition: Tcp4.h:556
RETURN_STATUS EFI_STATUS
Function return status for EFI API.
Definition: UefiBaseType.h:32
EFI_TCP4_VARIABLE_DATA is deprecated in the UEFI 2.4B and should not be used any more.
Definition: Tcp4.h:51
EFI_TCP4_RECEIVE_DATA * RxData
When this token is used for receiving, RxData is a pointer to EFI_TCP4_RECEIVE_DATA.
Definition: Tcp4.h:213
EFI_TCP4_CONNECTION_STATE
TCP4 connnection state.
Definition: Tcp4.h:106
UINT32 KeepAliveProbes
Definition: Tcp4.h:75
BOOLEAN UseDefaultAddress
Definition: Tcp4.h:58
EFI_IPv4_ADDRESS LocalAddress
Definition: Tcp4.h:41
UINT8 TimeToLive
Definition: Tcp4.h:90
EFI_TCP4_ROUTES Routes
Definition: Tcp4.h:557
EFI_STATUS(EFIAPI * EFI_TCP4_GET_MODE_DATA)(IN EFI_TCP4_PROTOCOL *This, OUT EFI_TCP4_CONNECTION_STATE *Tcp4State OPTIONAL, OUT EFI_TCP4_CONFIG_DATA *Tcp4ConfigData OPTIONAL, OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL, OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL, OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL)
Get the current operational status.
Definition: Tcp4.h:251
EFI_TCP4_COMPLETION_TOKEN CompletionToken
Definition: Tcp4.h:222
EFI_IPv4_ADDRESS SubnetMask
Definition: Tcp4.h:60
UINT32 KeepAliveTime
Definition: Tcp4.h:76
EFI_IPv4_ADDRESS RemoteAddress
Definition: Tcp4.h:62
EFI_TCP4_GET_MODE_DATA GetModeData
Definition: Tcp4.h:555
BOOLEAN EnableSelectiveAck
Definition: Tcp4.h:81
EFI_TCP4_ACCEPT Accept
Definition: Tcp4.h:559
EFI_IPv4_ADDRESS RemoteAddress
Definition: Tcp4.h:43
Definition: efi.h:62
EFI_TCP4_TRANSMIT Transmit
Definition: Tcp4.h:560
EFI_TCP4_SERVICE_POINT is deprecated in the UEFI 2.4B and should not be used any more.
Definition: Tcp4.h:39
The EFI_TCP4_PROTOCOL defines the EFI TCPv4 Protocol child to be used by any network drivers or appli...
Definition: Tcp4.h:554
UINT32 TimeWaitTimeout
Definition: Tcp4.h:74
EFI_STATUS(EFIAPI * EFI_TCP4_CANCEL)(IN EFI_TCP4_PROTOCOL *This, IN EFI_TCP4_COMPLETION_TOKEN *Token OPTIONAL)
Abort an asynchronous connection, listen, transmission or receive request.
Definition: Tcp4.h:523
UINT32 DataRetries
Definition: Tcp4.h:72