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