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