iPXE
Ip4.h
Go to the documentation of this file.
1 /** @file
2  This file defines the EFI IPv4 (Internet Protocol version 4)
3  Protocol interface. It is split into the following three main
4  sections:
5  - EFI IPv4 Service Binding Protocol
6  - EFI IPv4 Variable (deprecated in UEFI 2.4B)
7  - EFI IPv4 Protocol.
8  The EFI IPv4 Protocol provides basic network IPv4 packet I/O services,
9  which includes support foR a subset of the Internet Control Message
10  Protocol (ICMP) and may include support for the Internet Group Management
11  Protocol (IGMP).
12 
13 Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
14 This program and the accompanying materials are licensed and made available under
15 the terms and conditions of the BSD License that accompanies this distribution.
16 The full text of the license may be found at
17 http://opensource.org/licenses/bsd-license.php.
18 
19 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
20 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
21 
22  @par Revision Reference:
23  This Protocol is introduced in UEFI Specification 2.0.
24 
25 **/
26 
27 #ifndef __EFI_IP4_PROTOCOL_H__
28 #define __EFI_IP4_PROTOCOL_H__
29 
30 FILE_LICENCE ( BSD3 );
31 
33 
34 #define EFI_IP4_SERVICE_BINDING_PROTOCOL_GUID \
35  { \
36  0xc51711e7, 0xb4bf, 0x404a, {0xbf, 0xb8, 0x0a, 0x04, 0x8e, 0xf1, 0xff, 0xe4 } \
37  }
38 
39 #define EFI_IP4_PROTOCOL_GUID \
40  { \
41  0x41d94cd2, 0x35b6, 0x455a, {0x82, 0x58, 0xd4, 0xe5, 0x13, 0x34, 0xaa, 0xdd } \
42  }
43 
45 
46 ///
47 /// EFI_IP4_ADDRESS_PAIR 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 ///
57 /// EFI_IP4_VARIABLE_DATA is deprecated in the UEFI 2.4B and should not be used any more.
58 /// The definition in here is only present to provide backwards compatability.
59 ///
60 typedef struct {
63  EFI_IP4_ADDRESS_PAIR AddressPairs[1];
65 
66 typedef struct {
67  ///
68  /// The default IPv4 protocol packets to send and receive. Ignored
69  /// when AcceptPromiscuous is TRUE.
70  ///
72  ///
73  /// Set to TRUE to receive all IPv4 packets that get through the receive filters.
74  /// Set to FALSE to receive only the DefaultProtocol IPv4
75  /// packets that get through the receive filters.
76  ///
78  ///
79  /// Set to TRUE to receive ICMP error report packets. Ignored when
80  /// AcceptPromiscuous or AcceptAnyProtocol is TRUE.
81  ///
83  ///
84  /// Set to TRUE to receive broadcast IPv4 packets. Ignored when
85  /// AcceptPromiscuous is TRUE.
86  /// Set to FALSE to stop receiving broadcast IPv4 packets.
87  ///
89  ///
90  /// Set to TRUE to receive all IPv4 packets that are sent to any
91  /// hardware address or any protocol address.
92  /// Set to FALSE to stop receiving all promiscuous IPv4 packets
93  ///
95  ///
96  /// Set to TRUE to use the default IPv4 address and default routing table.
97  ///
99  ///
100  /// The station IPv4 address that will be assigned to this EFI IPv4Protocol instance.
101  ///
103  ///
104  /// The subnet address mask that is associated with the station address.
105  ///
107  ///
108  /// TypeOfService field in transmitted IPv4 packets.
109  ///
111  ///
112  /// TimeToLive field in transmitted IPv4 packets.
113  ///
115  ///
116  /// State of the DoNotFragment bit in transmitted IPv4 packets.
117  ///
119  ///
120  /// Set to TRUE to send and receive unformatted packets. The other
121  /// IPv4 receive filters are still applied. Fragmentation is disabled for RawData mode.
122  ///
124  ///
125  /// The timer timeout value (number of microseconds) for the
126  /// receive timeout event to be associated with each assembled
127  /// packet. Zero means do not drop assembled packets.
128  ///
130  ///
131  /// The timer timeout value (number of microseconds) for the
132  /// transmit timeout event to be associated with each outgoing
133  /// packet. Zero means do not drop outgoing packets.
134  ///
137 
138 
139 typedef struct {
144 
145 typedef struct {
149 
150 typedef struct {
151  ///
152  /// Set to TRUE after this EFI IPv4 Protocol instance has been successfully configured.
153  ///
155  ///
156  /// The maximum packet size, in bytes, of the packet which the upper layer driver could feed.
157  ///
159  ///
160  /// Current configuration settings.
161  ///
163  ///
164  /// Set to TRUE when the EFI IPv4 Protocol instance has a station address and subnet mask.
165  ///
167  ///
168  /// Number of joined multicast groups.
169  ///
171  ///
172  /// List of joined multicast group addresses.
173  ///
175  ///
176  /// Number of entries in the routing table.
177  ///
179  ///
180  /// Routing table entries.
181  ///
183  ///
184  /// Number of entries in the supported ICMP types list.
185  ///
187  ///
188  /// Array of ICMP types and codes that are supported by this EFI IPv4 Protocol driver
189  ///
192 
193 #pragma pack(1)
194 
195 typedef struct {
208 #pragma pack()
209 
210 
211 typedef struct {
215 
216 
217 typedef struct {
226  EFI_IP4_FRAGMENT_DATA FragmentTable[1];
228 
229 
230 typedef struct {
238 
239 typedef struct {
242  UINT32 OptionsLength; //OPTIONAL
243  VOID *OptionsBuffer; //OPTIONAL
246  EFI_IP4_FRAGMENT_DATA FragmentTable[1];
248 
249 typedef struct {
250  ///
251  /// This Event will be signaled after the Status field is updated
252  /// by the EFI IPv4 Protocol driver. The type of Event must be
253  /// EFI_NOTIFY_SIGNAL. The Task Priority Level (TPL) of
254  /// Event must be lower than or equal to TPL_CALLBACK.
255  ///
257  ///
258  /// The status that is returned to the caller at the end of the operation
259  /// to indicate whether this operation completed successfully.
260  ///
262  union {
263  ///
264  /// When this token is used for receiving, RxData is a pointer to the EFI_IP4_RECEIVE_DATA.
265  ///
267  ///
268  /// When this token is used for transmitting, TxData is a pointer to the EFI_IP4_TRANSMIT_DATA.
269  ///
271  } Packet;
273 
274 /**
275  Gets the current operational settings for this instance of the EFI IPv4 Protocol driver.
276 
277  The GetModeData() function returns the current operational mode data for this
278  driver instance. The data fields in EFI_IP4_MODE_DATA are read only. This
279  function is used optionally to retrieve the operational mode data of underlying
280  networks or drivers.
281 
282  @param This The pointer to the EFI_IP4_PROTOCOL instance.
283  @param Ip4ModeData The pointer to the EFI IPv4 Protocol mode data structure.
284  @param MnpConfigData The pointer to the managed network configuration data structure.
285  @param SnpModeData The pointer to the simple network mode data structure.
286 
287  @retval EFI_SUCCESS The operation completed successfully.
288  @retval EFI_INVALID_PARAMETER This is NULL.
289  @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated.
290 
291 **/
292 typedef
295  IN CONST EFI_IP4_PROTOCOL *This,
296  OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL,
299  );
300 
301 /**
302  Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance.
303 
304  The Configure() function is used to set, change, or reset the operational
305  parameters and filter settings for this EFI IPv4 Protocol instance. Until these
306  parameters have been set, no network traffic can be sent or received by this
307  instance. Once the parameters have been reset (by calling this function with
308  IpConfigData set to NULL), no more traffic can be sent or received until these
309  parameters have been set again. Each EFI IPv4 Protocol instance can be started
310  and stopped independently of each other by enabling or disabling their receive
311  filter settings with the Configure() function.
312 
313  When IpConfigData.UseDefaultAddress is set to FALSE, the new station address will
314  be appended as an alias address into the addresses list in the EFI IPv4 Protocol
315  driver. While set to TRUE, Configure() will trigger the EFI_IP4_CONFIG_PROTOCOL
316  to retrieve the default IPv4 address if it is not available yet. Clients could
317  frequently call GetModeData() to check the status to ensure that the default IPv4
318  address is ready.
319 
320  If operational parameters are reset or changed, any pending transmit and receive
321  requests will be cancelled. Their completion token status will be set to EFI_ABORTED
322  and their events will be signaled.
323 
324  @param This The pointer to the EFI_IP4_PROTOCOL instance.
325  @param IpConfigData The pointer to the EFI IPv4 Protocol configuration data structure.
326 
327  @retval EFI_SUCCESS The driver instance was successfully opened.
328  @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
329  RARP, etc.) is not finished yet.
330  @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
331  This is NULL.
332  IpConfigData.StationAddress is not a unicast IPv4 address.
333  IpConfigData.SubnetMask is not a valid IPv4 subnet
334  @retval EFI_UNSUPPORTED One or more of the following conditions is TRUE:
335  A configuration protocol (DHCP, BOOTP, RARP, etc.) could
336  not be located when clients choose to use the default IPv4
337  address. This EFI IPv4 Protocol implementation does not
338  support this requested filter or timeout setting.
339  @retval EFI_OUT_OF_RESOURCES The EFI IPv4 Protocol driver instance data could not be allocated.
340  @retval EFI_ALREADY_STARTED The interface is already open and must be stopped before the
341  IPv4 address or subnet mask can be changed. The interface must
342  also be stopped when switching to/from raw packet mode.
343  @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI IPv4
344  Protocol driver instance is not opened.
345 
346 **/
347 typedef
350  IN EFI_IP4_PROTOCOL *This,
351  IN EFI_IP4_CONFIG_DATA *IpConfigData OPTIONAL
352  );
353 
354 /**
355  Joins and leaves multicast groups.
356 
357  The Groups() function is used to join and leave multicast group sessions. Joining
358  a group will enable reception of matching multicast packets. Leaving a group will
359  disable the multicast packet reception.
360 
361  If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.
362 
363  @param This The pointer to the EFI_IP4_PROTOCOL instance.
364  @param JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.
365  @param GroupAddress The pointer to the IPv4 multicast address.
366 
367  @retval EFI_SUCCESS The operation completed successfully.
368  @retval EFI_INVALID_PARAMETER One or more of the following is TRUE:
369  - This is NULL.
370  - JoinFlag is TRUE and GroupAddress is NULL.
371  - GroupAddress is not NULL and *GroupAddress is
372  not a multicast IPv4 address.
373  @retval EFI_NOT_STARTED This instance has not been started.
374  @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
375  RARP, etc.) is not finished yet.
376  @retval EFI_OUT_OF_RESOURCES System resources could not be allocated.
377  @retval EFI_UNSUPPORTED This EFI IPv4 Protocol implementation does not support multicast groups.
378  @retval EFI_ALREADY_STARTED The group address is already in the group table (when
379  JoinFlag is TRUE).
380  @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is FALSE).
381  @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
382 
383 **/
384 typedef
387  IN EFI_IP4_PROTOCOL *This,
388  IN BOOLEAN JoinFlag,
389  IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL
390  );
391 
392 /**
393  Adds and deletes routing table entries.
394 
395  The Routes() function adds a route to or deletes a route from the routing table.
396 
397  Routes are determined by comparing the SubnetAddress with the destination IPv4
398  address arithmetically AND-ed with the SubnetMask. The gateway address must be
399  on the same subnet as the configured station address.
400 
401  The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0.
402  The default route matches all destination IPv4 addresses that do not match any
403  other routes.
404 
405  A GatewayAddress that is zero is a nonroute. Packets are sent to the destination
406  IP address if it can be found in the ARP cache or on the local subnet. One automatic
407  nonroute entry will be inserted into the routing table for outgoing packets that
408  are addressed to a local subnet (gateway address of 0.0.0.0).
409 
410  Each EFI IPv4 Protocol instance has its own independent routing table. Those EFI
411  IPv4 Protocol instances that use the default IPv4 address will also have copies
412  of the routing table that was provided by the EFI_IP4_CONFIG_PROTOCOL, and these
413  copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its
414  instances. As a result, client modification to the routing table will be lost.
415 
416  @param This The pointer to the EFI_IP4_PROTOCOL instance.
417  @param DeleteRoute Set to TRUE to delete this route from the routing table. Set to
418  FALSE to add this route to the routing table. SubnetAddress
419  and SubnetMask are used as the key to each route entry.
420  @param SubnetAddress The address of the subnet that needs to be routed.
421  @param SubnetMask The subnet mask of SubnetAddress.
422  @param GatewayAddress The unicast gateway IPv4 address for this route.
423 
424  @retval EFI_SUCCESS The operation completed successfully.
425  @retval EFI_NOT_STARTED The driver instance has not been started.
426  @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
427  RARP, etc.) is not finished yet.
428  @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
429  - This is NULL.
430  - SubnetAddress is NULL.
431  - SubnetMask is NULL.
432  - GatewayAddress is NULL.
433  - *SubnetAddress is not a valid subnet address.
434  - *SubnetMask is not a valid subnet mask.
435  - *GatewayAddress is not a valid unicast IPv4 address.
436  @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table.
437  @retval EFI_NOT_FOUND This route is not in the routing table (when DeleteRoute is TRUE).
438  @retval EFI_ACCESS_DENIED The route is already defined in the routing table (when
439  DeleteRoute is FALSE).
440 
441 **/
442 typedef
445  IN EFI_IP4_PROTOCOL *This,
446  IN BOOLEAN DeleteRoute,
447  IN EFI_IPv4_ADDRESS *SubnetAddress,
448  IN EFI_IPv4_ADDRESS *SubnetMask,
449  IN EFI_IPv4_ADDRESS *GatewayAddress
450  );
451 
452 /**
453  Places outgoing data packets into the transmit queue.
454 
455  The Transmit() function places a sending request in the transmit queue of this
456  EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some
457  errors occur, the event in the token will be signaled and the status is updated.
458 
459  @param This The pointer to the EFI_IP4_PROTOCOL instance.
460  @param Token The pointer to the transmit token.
461 
462  @retval EFI_SUCCESS The data has been queued for transmission.
463  @retval EFI_NOT_STARTED This instance has not been started.
464  @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
465  RARP, etc.) is not finished yet.
466  @retval EFI_INVALID_PARAMETER One or more pameters are invalid.
467  @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event
468  was already in the transmit queue.
469  @retval EFI_NOT_READY The completion token could not be queued because the transmit
470  queue is full.
471  @retval EFI_NOT_FOUND Not route is found to destination address.
472  @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data.
473  @retval EFI_BUFFER_TOO_SMALL Token.Packet.TxData.TotalDataLength is too
474  short to transmit.
475  @retval EFI_BAD_BUFFER_SIZE The length of the IPv4 header + option length + total data length is
476  greater than MTU (or greater than the maximum packet size if
477  Token.Packet.TxData.OverrideData.
478  DoNotFragment is TRUE.)
479 
480 **/
481 typedef
484  IN EFI_IP4_PROTOCOL *This,
486  );
487 
488 /**
489  Places a receiving request into the receiving queue.
490 
491  The Receive() function places a completion token into the receive packet queue.
492  This function is always asynchronous.
493 
494  The Token.Event field in the completion token must be filled in by the caller
495  and cannot be NULL. When the receive operation completes, the EFI IPv4 Protocol
496  driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event
497  is signaled.
498 
499  @param This The pointer to the EFI_IP4_PROTOCOL instance.
500  @param Token The pointer to a token that is associated with the receive data descriptor.
501 
502  @retval EFI_SUCCESS The receive completion token was cached.
503  @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.
504  @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, RARP, etc.)
505  is not finished yet.
506  @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
507  - This is NULL.
508  - Token is NULL.
509  - Token.Event is NULL.
510  @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system
511  resources (usually memory).
512  @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
513  The EFI IPv4 Protocol instance has been reset to startup defaults.
514  @retval EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already
515  in the receive queue.
516  @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.
517  @retval EFI_ICMP_ERROR An ICMP error packet was received.
518 
519 **/
520 typedef
523  IN EFI_IP4_PROTOCOL *This,
525  );
526 
527 /**
528  Abort an asynchronous transmit or receive request.
529 
530  The Cancel() function is used to abort a pending transmit or receive request.
531  If the token is in the transmit or receive request queues, after calling this
532  function, Token->Status will be set to EFI_ABORTED and then Token->Event will
533  be signaled. If the token is not in one of the queues, which usually means the
534  asynchronous operation has completed, this function will not signal the token
535  and EFI_NOT_FOUND is returned.
536 
537  @param This The pointer to the EFI_IP4_PROTOCOL instance.
538  @param Token The pointer to a token that has been issued by
539  EFI_IP4_PROTOCOL.Transmit() or
540  EFI_IP4_PROTOCOL.Receive(). If NULL, all pending
541  tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is
542  defined in EFI_IP4_PROTOCOL.Transmit().
543 
544  @retval EFI_SUCCESS The asynchronous I/O request was aborted and
545  Token->Event was signaled. When Token is NULL, all
546  pending requests were aborted and their events were signaled.
547  @retval EFI_INVALID_PARAMETER This is NULL.
548  @retval EFI_NOT_STARTED This instance has not been started.
549  @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
550  RARP, etc.) is not finished yet.
551  @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was
552  not found in the transmit or receive queue. It has either completed
553  or was not issued by Transmit() and Receive().
554 
555 **/
556 typedef
559  IN EFI_IP4_PROTOCOL *This,
561  );
562 
563 /**
564  Polls for incoming data packets and processes outgoing data packets.
565 
566  The Poll() function polls for incoming data packets and processes outgoing data
567  packets. Network drivers and applications can call the EFI_IP4_PROTOCOL.Poll()
568  function to increase the rate that data packets are moved between the communications
569  device and the transmit and receive queues.
570 
571  In some systems the periodic timer event may not poll the underlying communications
572  device fast enough to transmit and/or receive all data packets without missing
573  incoming packets or dropping outgoing packets. Drivers and applications that are
574  experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function
575  more often.
576 
577  @param This The pointer to the EFI_IP4_PROTOCOL instance.
578 
579  @retval EFI_SUCCESS Incoming or outgoing data was processed.
580  @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.
581  @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
582  RARP, etc.) is not finished yet.
583  @retval EFI_INVALID_PARAMETER This is NULL.
584  @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
585  @retval EFI_NOT_READY No incoming or outgoing data is processed.
586  @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.
587  Consider increasing the polling rate.
588 
589 **/
590 typedef
593  IN EFI_IP4_PROTOCOL *This
594  );
595 
596 ///
597 /// The EFI IPv4 Protocol implements a simple packet-oriented interface that can be
598 /// used by drivers, daemons, and applications to transmit and receive network packets.
599 ///
609 };
610 
613 
614 #endif
EFI_IP4_CONFIG_DATA ConfigData
Current configuration settings.
Definition: Ip4.h:162
EFI_IP4_ADDRESS_PAIR is deprecated in the UEFI 2.4B and should not be used any more.
Definition: Ip4.h:50
#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_IP4_TRANSMIT_DATA * TxData
When this token is used for transmitting, TxData is a pointer to the EFI_IP4_TRANSMIT_DATA.
Definition: Ip4.h:270
EFI_IPv4_ADDRESS DestinationAddress
Definition: Ip4.h:240
EFI_IP4_ROUTES Routes
Definition: Ip4.h:604
EFI_IPv4_ADDRESS SubnetMask
Definition: Ip4.h:53
UINT32 FragmentLength
Definition: Ip4.h:212
UINT8 TypeOfService
Definition: Ip4.h:198
EFI_IP4_GROUPS Groups
Definition: Ip4.h:603
EFI_IPv4_ADDRESS * GroupTable
List of joined multicast group addresses.
Definition: Ip4.h:174
EFI_GUID gEfiIp4ProtocolGuid
BOOLEAN AcceptPromiscuous
Set to TRUE to receive all IPv4 packets that are sent to any hardware address or any protocol address...
Definition: Ip4.h:94
128 bit buffer containing a unique identifier value.
Definition: Base.h:263
EFI_STATUS(EFIAPI * EFI_IP4_CANCEL)(IN EFI_IP4_PROTOCOL *This, IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL)
Abort an asynchronous transmit or receive request.
Definition: Ip4.h:558
UINT8 HeaderLength
Definition: Ip4.h:196
VOID * EFI_EVENT
Handle to an event structure.
Definition: UefiBaseType.h:43
unsigned char BOOLEAN
Definition: ProcessorBind.h:61
BOOLEAN UseDefaultAddress
Set to TRUE to use the default IPv4 address and default routing table.
Definition: Ip4.h:98
EFI_IP4_HEADER * Header
Definition: Ip4.h:221
unsigned int UINT32
Definition: ProcessorBind.h:56
UINT16 Checksum
Definition: Ip4.h:204
EFI_IP4_ROUTE_TABLE * RouteTable
Routing table entries.
Definition: Ip4.h:182
UINT8 TimeToLive
Definition: Ip4.h:235
EFI_IPv4_ADDRESS Ip4Address
Definition: Ip4.h:52
EFI_IP4_TRANSMIT Transmit
Definition: Ip4.h:605
EFI_HANDLE InstanceHandle
Definition: Ip4.h:51
EFI_IPv4_ADDRESS DestinationAddress
Definition: Ip4.h:206
unsigned char UINT8
Definition: ProcessorBind.h:62
UINT32 TotalDataLength
Definition: Ip4.h:244
UINT32 GroupCount
Number of joined multicast groups.
Definition: Ip4.h:170
UINT32 DataLength
Definition: Ip4.h:224
EFI_STATUS(EFIAPI * EFI_IP4_TRANSMIT)(IN EFI_IP4_PROTOCOL *This, IN EFI_IP4_COMPLETION_TOKEN *Token)
Places outgoing data packets into the transmit queue.
Definition: Ip4.h:483
UINT16 TotalLength
Definition: Ip4.h:199
EFI_STATUS(EFIAPI * EFI_IP4_POLL)(IN EFI_IP4_PROTOCOL *This)
Polls for incoming data packets and processes outgoing data packets.
Definition: Ip4.h:592
EFI_GUID gEfiIp4ServiceBindingProtocolGuid
BOOLEAN IsStarted
Set to TRUE after this EFI IPv4 Protocol instance has been successfully configured.
Definition: Ip4.h:154
UINT32 ReceiveTimeout
The timer timeout value (number of microseconds) for the receive timeout event to be associated with ...
Definition: Ip4.h:129
EFI_IP4_ICMP_TYPE * IcmpTypeList
Array of ICMP types and codes that are supported by this EFI IPv4 Protocol driver.
Definition: Ip4.h:190
BOOLEAN AcceptAnyProtocol
Set to TRUE to receive all IPv4 packets that get through the receive filters.
Definition: Ip4.h:77
EFI_IPv4_ADDRESS SubnetAddress
Definition: Ip4.h:140
#define OUT
Definition: mlx_utils.h:29
EFI_IPv4_ADDRESS GatewayAddress
Definition: Ip4.h:142
EFI_IP4_POLL Poll
Definition: Ip4.h:608
UINT16 Identification
Definition: Ip4.h:200
EFI_EVENT RecycleSignal
Definition: Ip4.h:219
FILE_LICENCE(BSD3)
UINT32 OptionsLength
Definition: Ip4.h:242
EFI_IPv4_ADDRESS GatewayAddress
Definition: Ip4.h:232
EFI_IPv4_ADDRESS SourceAddress
Definition: Ip4.h:205
UINT8 DefaultProtocol
The default IPv4 protocol packets to send and receive.
Definition: Ip4.h:71
EFI_TIME TimeStamp
Definition: Ip4.h:218
EFI_IPv4_ADDRESS SourceAddress
Definition: Ip4.h:231
UINT8 TimeToLive
TimeToLive field in transmitted IPv4 packets.
Definition: Ip4.h:114
4-byte buffer.
Definition: Base.h:273
BOOLEAN DoNotFragment
State of the DoNotFragment bit in transmitted IPv4 packets.
Definition: Ip4.h:118
The EFI IPv4 Protocol implements a simple packet-oriented interface that can be used by drivers,...
Definition: Ip4.h:600
UINT32 FragmentCount
Definition: Ip4.h:245
EFI_EVENT Event
This Event will be signaled after the Status field is updated by the EFI IPv4 Protocol driver.
Definition: Ip4.h:256
EFI_STATUS(EFIAPI * EFI_IP4_GROUPS)(IN EFI_IP4_PROTOCOL *This, IN BOOLEAN JoinFlag, IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL)
Joins and leaves multicast groups.
Definition: Ip4.h:386
EFI_IP4_OVERRIDE_DATA * OverrideData
Definition: Ip4.h:241
UINT16 Fragmentation
Definition: Ip4.h:201
UINT8 Version
Definition: Ip4.h:197
unsigned short UINT16
Definition: ProcessorBind.h:58
UINT8 Type
Definition: Ip4.h:146
UINT32 TransmitTimeout
The timer timeout value (number of microseconds) for the transmit timeout event to be associated with...
Definition: Ip4.h:135
#define EFIAPI
EFI_STATUS Status
The status that is returned to the caller at the end of the operation to indicate whether this operat...
Definition: Ip4.h:261
EFI_IP4_RECEIVE Receive
Definition: Ip4.h:606
UINT32 RouteCount
Number of entries in the routing table.
Definition: Ip4.h:178
EFI_IPv4_ADDRESS StationAddress
The station IPv4 address that will be assigned to this EFI IPv4Protocol instance.
Definition: Ip4.h:102
UINT8 TypeOfService
Definition: Ip4.h:234
UINT32 AddressCount
Definition: Ip4.h:62
EFI_IP4_CANCEL Cancel
Definition: Ip4.h:607
VOID * OptionsBuffer
Definition: Ip4.h:243
#define VOID
Undeclared type.
Definition: Base.h:319
EFI_HANDLE DriverHandle
Definition: Ip4.h:61
EFI_STATUS(EFIAPI * EFI_IP4_RECEIVE)(IN EFI_IP4_PROTOCOL *This, IN EFI_IP4_COMPLETION_TOKEN *Token)
Places a receiving request into the receiving queue.
Definition: Ip4.h:522
UINT8 TypeOfService
TypeOfService field in transmitted IPv4 packets.
Definition: Ip4.h:110
EFI_IP4_RECEIVE_DATA * RxData
When this token is used for receiving, RxData is a pointer to the EFI_IP4_RECEIVE_DATA.
Definition: Ip4.h:266
VOID * FragmentBuffer
Definition: Ip4.h:213
EFI Time Abstraction: Year: 1900 - 9999 Month: 1 - 12 Day: 1 - 31 Hour: 0 - 23 Minute: 0 - 59 Second:...
Definition: UefiBaseType.h:74
#define IN
Definition: mlx_utils.h:28
EFI_STATUS(EFIAPI * EFI_IP4_ROUTES)(IN EFI_IP4_PROTOCOL *This, IN BOOLEAN DeleteRoute, IN EFI_IPv4_ADDRESS *SubnetAddress, IN EFI_IPv4_ADDRESS *SubnetMask, IN EFI_IPv4_ADDRESS *GatewayAddress)
Adds and deletes routing table entries.
Definition: Ip4.h:444
EFI_STATUS(EFIAPI * EFI_IP4_GET_MODE_DATA)(IN CONST EFI_IP4_PROTOCOL *This, OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL, OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL, OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL)
Gets the current operational settings for this instance of the EFI IPv4 Protocol driver.
Definition: Ip4.h:294
BOOLEAN IsConfigured
Set to TRUE when the EFI IPv4 Protocol instance has a station address and subnet mask.
Definition: Ip4.h:166
EFI_STATUS(EFIAPI * EFI_IP4_CONFIGURE)(IN EFI_IP4_PROTOCOL *This, IN EFI_IP4_CONFIG_DATA *IpConfigData OPTIONAL)
Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance.
Definition: Ip4.h:349
EFI_MANAGED_NETWORK_SERVICE_BINDING_PROTOCOL as defined in UEFI 2.0.
UINT32 HeaderLength
Definition: Ip4.h:220
#define CONST
Datum is read-only.
Definition: Base.h:309
BOOLEAN RawData
Set to TRUE to send and receive unformatted packets.
Definition: Ip4.h:123
RETURN_STATUS EFI_STATUS
Function return status for EFI API.
Definition: UefiBaseType.h:35
BOOLEAN DoNotFragment
Definition: Ip4.h:236
UINT32 FragmentCount
Definition: Ip4.h:225
EFI_IPv4_ADDRESS SubnetMask
Definition: Ip4.h:141
BOOLEAN AcceptBroadcast
Set to TRUE to receive broadcast IPv4 packets.
Definition: Ip4.h:88
UINT32 OptionsLength
Definition: Ip4.h:222
EFI_IP4_CONFIGURE Configure
Definition: Ip4.h:602
UINT8 Protocol
Definition: Ip4.h:203
UINT32 IcmpTypeCount
Number of entries in the supported ICMP types list.
Definition: Ip4.h:186
EFI_IPv4_ADDRESS SubnetMask
The subnet address mask that is associated with the station address.
Definition: Ip4.h:106
VOID * Options
Definition: Ip4.h:223
EFI_IP4_GET_MODE_DATA GetModeData
Definition: Ip4.h:601
EFI_IP4_VARIABLE_DATA is deprecated in the UEFI 2.4B and should not be used any more.
Definition: Ip4.h:60
BOOLEAN AcceptIcmpErrors
Set to TRUE to receive ICMP error report packets.
Definition: Ip4.h:82
UINT8 TimeToLive
Definition: Ip4.h:202
UINT32 MaxPacketSize
The maximum packet size, in bytes, of the packet which the upper layer driver could feed.
Definition: Ip4.h:158
Definition: efi.h:55
UINT8 Code
Definition: Ip4.h:147