2 This file defines the EFI IPv4 (Internet Protocol version 4)
3 Protocol interface. It is split into the following three main
5 - EFI IPv4 Service Binding Protocol
6 - EFI IPv4 Variable (deprecated in UEFI 2.4B)
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
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.
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.
22 @par Revision Reference:
23 This Protocol is introduced in UEFI Specification 2.0.
27 #ifndef __EFI_IP4_PROTOCOL_H__
28 #define __EFI_IP4_PROTOCOL_H__
30 FILE_LICENCE ( BSD3 );
32 #include <ipxe/efi/Protocol/ManagedNetwork.h>
34 #define EFI_IP4_SERVICE_BINDING_PROTOCOL_GUID \
36 0xc51711e7, 0xb4bf, 0x404a, {0xbf, 0xb8, 0x0a, 0x04, 0x8e, 0xf1, 0xff, 0xe4 } \
39 #define EFI_IP4_PROTOCOL_GUID \
41 0x41d94cd2, 0x35b6, 0x455a, {0x82, 0x58, 0xd4, 0xe5, 0x13, 0x34, 0xaa, 0xdd } \
44 typedef struct _EFI_IP4_PROTOCOL EFI_IP4_PROTOCOL;
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.
51 EFI_HANDLE InstanceHandle;
52 EFI_IPv4_ADDRESS Ip4Address;
53 EFI_IPv4_ADDRESS SubnetMask;
54 } EFI_IP4_ADDRESS_PAIR;
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.
61 EFI_HANDLE DriverHandle;
63 EFI_IP4_ADDRESS_PAIR AddressPairs[1];
64 } EFI_IP4_VARIABLE_DATA;
68 /// The default IPv4 protocol packets to send and receive. Ignored
69 /// when AcceptPromiscuous is TRUE.
71 UINT8 DefaultProtocol;
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.
77 BOOLEAN AcceptAnyProtocol;
79 /// Set to TRUE to receive ICMP error report packets. Ignored when
80 /// AcceptPromiscuous or AcceptAnyProtocol is TRUE.
82 BOOLEAN AcceptIcmpErrors;
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.
88 BOOLEAN AcceptBroadcast;
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
94 BOOLEAN AcceptPromiscuous;
96 /// Set to TRUE to use the default IPv4 address and default routing table.
98 BOOLEAN UseDefaultAddress;
100 /// The station IPv4 address that will be assigned to this EFI IPv4Protocol instance.
102 EFI_IPv4_ADDRESS StationAddress;
104 /// The subnet address mask that is associated with the station address.
106 EFI_IPv4_ADDRESS SubnetMask;
108 /// TypeOfService field in transmitted IPv4 packets.
112 /// TimeToLive field in transmitted IPv4 packets.
116 /// State of the DoNotFragment bit in transmitted IPv4 packets.
118 BOOLEAN DoNotFragment;
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.
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.
129 UINT32 ReceiveTimeout;
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.
135 UINT32 TransmitTimeout;
136 } EFI_IP4_CONFIG_DATA;
140 EFI_IPv4_ADDRESS SubnetAddress;
141 EFI_IPv4_ADDRESS SubnetMask;
142 EFI_IPv4_ADDRESS GatewayAddress;
143 } EFI_IP4_ROUTE_TABLE;
152 /// Set to TRUE after this EFI IPv4 Protocol instance has been successfully configured.
156 /// The maximum packet size, in bytes, of the packet which the upper layer driver could feed.
158 UINT32 MaxPacketSize;
160 /// Current configuration settings.
162 EFI_IP4_CONFIG_DATA ConfigData;
164 /// Set to TRUE when the EFI IPv4 Protocol instance has a station address and subnet mask.
166 BOOLEAN IsConfigured;
168 /// Number of joined multicast groups.
172 /// List of joined multicast group addresses.
174 EFI_IPv4_ADDRESS *GroupTable;
176 /// Number of entries in the routing table.
180 /// Routing table entries.
182 EFI_IP4_ROUTE_TABLE *RouteTable;
184 /// Number of entries in the supported ICMP types list.
186 UINT32 IcmpTypeCount;
188 /// Array of ICMP types and codes that are supported by this EFI IPv4 Protocol driver
190 EFI_IP4_ICMP_TYPE *IcmpTypeList;
196 UINT8 HeaderLength:4;
200 UINT16 Identification;
201 UINT16 Fragmentation;
205 EFI_IPv4_ADDRESS SourceAddress;
206 EFI_IPv4_ADDRESS DestinationAddress;
212 UINT32 FragmentLength;
213 VOID *FragmentBuffer;
214 } EFI_IP4_FRAGMENT_DATA;
219 EFI_EVENT RecycleSignal;
221 EFI_IP4_HEADER *Header;
222 UINT32 OptionsLength;
225 UINT32 FragmentCount;
226 EFI_IP4_FRAGMENT_DATA FragmentTable[1];
227 } EFI_IP4_RECEIVE_DATA;
231 EFI_IPv4_ADDRESS SourceAddress;
232 EFI_IPv4_ADDRESS GatewayAddress;
236 BOOLEAN DoNotFragment;
237 } EFI_IP4_OVERRIDE_DATA;
240 EFI_IPv4_ADDRESS DestinationAddress;
241 EFI_IP4_OVERRIDE_DATA *OverrideData; //OPTIONAL
242 UINT32 OptionsLength; //OPTIONAL
243 VOID *OptionsBuffer; //OPTIONAL
244 UINT32 TotalDataLength;
245 UINT32 FragmentCount;
246 EFI_IP4_FRAGMENT_DATA FragmentTable[1];
247 } EFI_IP4_TRANSMIT_DATA;
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.
258 /// The status that is returned to the caller at the end of the operation
259 /// to indicate whether this operation completed successfully.
264 /// When this token is used for receiving, RxData is a pointer to the EFI_IP4_RECEIVE_DATA.
266 EFI_IP4_RECEIVE_DATA *RxData;
268 /// When this token is used for transmitting, TxData is a pointer to the EFI_IP4_TRANSMIT_DATA.
270 EFI_IP4_TRANSMIT_DATA *TxData;
272 } EFI_IP4_COMPLETION_TOKEN;
275 Gets the current operational settings for this instance of the EFI IPv4 Protocol driver.
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
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.
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.
294 (EFIAPI *EFI_IP4_GET_MODE_DATA)(
295 IN CONST EFI_IP4_PROTOCOL *This,
296 OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL,
297 OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL,
298 OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL
302 Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance.
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.
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
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.
324 @param This The pointer to the EFI_IP4_PROTOCOL instance.
325 @param IpConfigData The pointer to the EFI IPv4 Protocol configuration data structure.
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:
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.
349 (EFIAPI *EFI_IP4_CONFIGURE)(
350 IN EFI_IP4_PROTOCOL *This,
351 IN EFI_IP4_CONFIG_DATA *IpConfigData OPTIONAL
355 Joins and leaves multicast groups.
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.
361 If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.
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.
367 @retval EFI_SUCCESS The operation completed successfully.
368 @retval EFI_INVALID_PARAMETER One or more of the following is TRUE:
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
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.
386 (EFIAPI *EFI_IP4_GROUPS)(
387 IN EFI_IP4_PROTOCOL *This,
389 IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL
393 Adds and deletes routing table entries.
395 The Routes() function adds a route to or deletes a route from the routing table.
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.
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
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).
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.
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.
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:
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).
444 (EFIAPI *EFI_IP4_ROUTES)(
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
453 Places outgoing data packets into the transmit queue.
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.
459 @param This The pointer to the EFI_IP4_PROTOCOL instance.
460 @param Token The pointer to the transmit token.
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
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
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.)
483 (EFIAPI *EFI_IP4_TRANSMIT)(
484 IN EFI_IP4_PROTOCOL *This,
485 IN EFI_IP4_COMPLETION_TOKEN *Token
489 Places a receiving request into the receiving queue.
491 The Receive() function places a completion token into the receive packet queue.
492 This function is always asynchronous.
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
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.
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.)
506 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
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.
522 (EFIAPI *EFI_IP4_RECEIVE)(
523 IN EFI_IP4_PROTOCOL *This,
524 IN EFI_IP4_COMPLETION_TOKEN *Token
528 Abort an asynchronous transmit or receive request.
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.
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().
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().
558 (EFIAPI *EFI_IP4_CANCEL)(
559 IN EFI_IP4_PROTOCOL *This,
560 IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL
564 Polls for incoming data packets and processes outgoing data packets.
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.
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
577 @param This The pointer to the EFI_IP4_PROTOCOL instance.
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.
592 (EFIAPI *EFI_IP4_POLL)(
593 IN EFI_IP4_PROTOCOL *This
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.
600 struct _EFI_IP4_PROTOCOL {
601 EFI_IP4_GET_MODE_DATA GetModeData;
602 EFI_IP4_CONFIGURE Configure;
603 EFI_IP4_GROUPS Groups;
604 EFI_IP4_ROUTES Routes;
605 EFI_IP4_TRANSMIT Transmit;
606 EFI_IP4_RECEIVE Receive;
607 EFI_IP4_CANCEL Cancel;
611 extern EFI_GUID gEfiIp4ServiceBindingProtocolGuid;
612 extern EFI_GUID gEfiIp4ProtocolGuid;