iPXE
Data Structures | Defines | Typedefs | Functions | Variables
Ip4.h File Reference

This file defines the EFI IPv4 (Internet Protocol version 4) Protocol interface. More...

#include <ipxe/efi/Protocol/ManagedNetwork.h>

Go to the source code of this file.

Data Structures

struct  EFI_IP4_ADDRESS_PAIR
 EFI_IP4_ADDRESS_PAIR is deprecated in the UEFI 2.4B and should not be used any more. More...
struct  EFI_IP4_VARIABLE_DATA
 EFI_IP4_VARIABLE_DATA is deprecated in the UEFI 2.4B and should not be used any more. More...
struct  EFI_IP4_CONFIG_DATA
struct  EFI_IP4_ROUTE_TABLE
struct  EFI_IP4_ICMP_TYPE
struct  EFI_IP4_MODE_DATA
struct  EFI_IP4_HEADER
struct  EFI_IP4_FRAGMENT_DATA
struct  EFI_IP4_RECEIVE_DATA
struct  EFI_IP4_OVERRIDE_DATA
struct  EFI_IP4_TRANSMIT_DATA
struct  EFI_IP4_COMPLETION_TOKEN
struct  _EFI_IP4_PROTOCOL
 The EFI IPv4 Protocol implements a simple packet-oriented interface that can be used by drivers, daemons, and applications to transmit and receive network packets. More...

Defines

#define EFI_IP4_SERVICE_BINDING_PROTOCOL_GUID
#define EFI_IP4_PROTOCOL_GUID

Typedefs

typedef struct _EFI_IP4_PROTOCOL EFI_IP4_PROTOCOL
typedef EFI_STATUS(EFIAPIEFI_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.
typedef EFI_STATUS(EFIAPIEFI_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.
typedef EFI_STATUS(EFIAPIEFI_IP4_GROUPS )(IN EFI_IP4_PROTOCOL *This, IN BOOLEAN JoinFlag, IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL)
 Joins and leaves multicast groups.
typedef EFI_STATUS(EFIAPIEFI_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.
typedef EFI_STATUS(EFIAPIEFI_IP4_TRANSMIT )(IN EFI_IP4_PROTOCOL *This, IN EFI_IP4_COMPLETION_TOKEN *Token)
 Places outgoing data packets into the transmit queue.
typedef EFI_STATUS(EFIAPIEFI_IP4_RECEIVE )(IN EFI_IP4_PROTOCOL *This, IN EFI_IP4_COMPLETION_TOKEN *Token)
 Places a receiving request into the receiving queue.
typedef EFI_STATUS(EFIAPIEFI_IP4_CANCEL )(IN EFI_IP4_PROTOCOL *This, IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL)
 Abort an asynchronous transmit or receive request.
typedef EFI_STATUS(EFIAPIEFI_IP4_POLL )(IN EFI_IP4_PROTOCOL *This)
 Polls for incoming data packets and processes outgoing data packets.

Functions

 FILE_LICENCE (BSD3)

Variables

EFI_GUID gEfiIp4ServiceBindingProtocolGuid
EFI_GUID gEfiIp4ProtocolGuid

Detailed Description

This file defines the EFI IPv4 (Internet Protocol version 4) Protocol interface.

It is split into the following three main sections:

Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Revision Reference:
This Protocol is introduced in UEFI Specification 2.0.

Definition in file Ip4.h.


Define Documentation

Value:
{ \
    0xc51711e7, 0xb4bf, 0x404a, {0xbf, 0xb8, 0x0a, 0x04, 0x8e, 0xf1, 0xff, 0xe4 } \
  }

Definition at line 34 of file Ip4.h.

Value:
{ \
    0x41d94cd2, 0x35b6, 0x455a, {0x82, 0x58, 0xd4, 0xe5, 0x13, 0x34, 0xaa, 0xdd } \
  }

Definition at line 39 of file Ip4.h.


Typedef Documentation

Definition at line 44 of file Ip4.h.

Gets the current operational settings for this instance of the EFI IPv4 Protocol driver.

The GetModeData() function returns the current operational mode data for this driver instance. The data fields in EFI_IP4_MODE_DATA are read only. This function is used optionally to retrieve the operational mode data of underlying networks or drivers.

Parameters:
ThisThe pointer to the EFI_IP4_PROTOCOL instance.
Ip4ModeDataThe pointer to the EFI IPv4 Protocol mode data structure.
MnpConfigDataThe pointer to the managed network configuration data structure.
SnpModeDataThe pointer to the simple network mode data structure.
Return values:
EFI_SUCCESSThe operation completed successfully.
EFI_INVALID_PARAMETERThis is NULL.
EFI_OUT_OF_RESOURCESThe required mode data could not be allocated.

Definition at line 294 of file Ip4.h.

Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance.

The Configure() function is used to set, change, or reset the operational parameters and filter settings for this EFI IPv4 Protocol instance. Until these parameters have been set, no network traffic can be sent or received by this instance. Once the parameters have been reset (by calling this function with IpConfigData set to NULL), no more traffic can be sent or received until these parameters have been set again. Each EFI IPv4 Protocol instance can be started and stopped independently of each other by enabling or disabling their receive filter settings with the Configure() function.

When IpConfigData.UseDefaultAddress is set to FALSE, the new station address will be appended as an alias address into the addresses list in the EFI IPv4 Protocol driver. While set to TRUE, Configure() will trigger the EFI_IP4_CONFIG_PROTOCOL to retrieve the default IPv4 address if it is not available yet. Clients could frequently call GetModeData() to check the status to ensure that the default IPv4 address is ready.

If operational parameters are reset or changed, any pending transmit and receive requests will be cancelled. Their completion token status will be set to EFI_ABORTED and their events will be signaled.

Parameters:
ThisThe pointer to the EFI_IP4_PROTOCOL instance.
IpConfigDataThe pointer to the EFI IPv4 Protocol configuration data structure.
Return values:
EFI_SUCCESSThe driver instance was successfully opened.
EFI_NO_MAPPINGWhen using the default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet.
EFI_INVALID_PARAMETEROne or more of the following conditions is TRUE: This is NULL. IpConfigData.StationAddress is not a unicast IPv4 address. IpConfigData.SubnetMask is not a valid IPv4 subnet
EFI_UNSUPPORTEDOne or more of the following conditions is TRUE: A configuration protocol (DHCP, BOOTP, RARP, etc.) could not be located when clients choose to use the default IPv4 address. This EFI IPv4 Protocol implementation does not support this requested filter or timeout setting.
EFI_OUT_OF_RESOURCESThe EFI IPv4 Protocol driver instance data could not be allocated.
EFI_ALREADY_STARTEDThe interface is already open and must be stopped before the IPv4 address or subnet mask can be changed. The interface must also be stopped when switching to/from raw packet mode.
EFI_DEVICE_ERRORAn unexpected system or network error occurred. The EFI IPv4 Protocol driver instance is not opened.

Definition at line 349 of file Ip4.h.

Joins and leaves multicast groups.

The Groups() function is used to join and leave multicast group sessions. Joining a group will enable reception of matching multicast packets. Leaving a group will disable the multicast packet reception.

If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.

Parameters:
ThisThe pointer to the EFI_IP4_PROTOCOL instance.
JoinFlagSet to TRUE to join the multicast group session and FALSE to leave.
GroupAddressThe pointer to the IPv4 multicast address.
Return values:
EFI_SUCCESSThe operation completed successfully.
EFI_INVALID_PARAMETEROne or more of the following is TRUE:
  • This is NULL.
  • JoinFlag is TRUE and GroupAddress is NULL.
  • GroupAddress is not NULL and *GroupAddress is not a multicast IPv4 address.
EFI_NOT_STARTEDThis instance has not been started.
EFI_NO_MAPPINGWhen using the default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet.
EFI_OUT_OF_RESOURCESSystem resources could not be allocated.
EFI_UNSUPPORTEDThis EFI IPv4 Protocol implementation does not support multicast groups.
EFI_ALREADY_STARTEDThe group address is already in the group table (when JoinFlag is TRUE).
EFI_NOT_FOUNDThe group address is not in the group table (when JoinFlag is FALSE).
EFI_DEVICE_ERRORAn unexpected system or network error occurred.

Definition at line 386 of file Ip4.h.

typedef 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.

The Routes() function adds a route to or deletes a route from the routing table.

Routes are determined by comparing the SubnetAddress with the destination IPv4 address arithmetically AND-ed with the SubnetMask. The gateway address must be on the same subnet as the configured station address.

The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0. The default route matches all destination IPv4 addresses that do not match any other routes.

A GatewayAddress that is zero is a nonroute. Packets are sent to the destination IP address if it can be found in the ARP cache or on the local subnet. One automatic nonroute entry will be inserted into the routing table for outgoing packets that are addressed to a local subnet (gateway address of 0.0.0.0).

Each EFI IPv4 Protocol instance has its own independent routing table. Those EFI IPv4 Protocol instances that use the default IPv4 address will also have copies of the routing table that was provided by the EFI_IP4_CONFIG_PROTOCOL, and these copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its instances. As a result, client modification to the routing table will be lost.

Parameters:
ThisThe pointer to the EFI_IP4_PROTOCOL instance.
DeleteRouteSet to TRUE to delete this route from the routing table. Set to FALSE to add this route to the routing table. SubnetAddress and SubnetMask are used as the key to each route entry.
SubnetAddressThe address of the subnet that needs to be routed.
SubnetMaskThe subnet mask of SubnetAddress.
GatewayAddressThe unicast gateway IPv4 address for this route.
Return values:
EFI_SUCCESSThe operation completed successfully.
EFI_NOT_STARTEDThe driver instance has not been started.
EFI_NO_MAPPINGWhen using the default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet.
EFI_INVALID_PARAMETEROne or more of the following conditions is TRUE:
  • This is NULL.
  • SubnetAddress is NULL.
  • SubnetMask is NULL.
  • GatewayAddress is NULL.
  • *SubnetAddress is not a valid subnet address.
  • *SubnetMask is not a valid subnet mask.
  • *GatewayAddress is not a valid unicast IPv4 address.
EFI_OUT_OF_RESOURCESCould not add the entry to the routing table.
EFI_NOT_FOUNDThis route is not in the routing table (when DeleteRoute is TRUE).
EFI_ACCESS_DENIEDThe route is already defined in the routing table (when DeleteRoute is FALSE).

Definition at line 444 of file Ip4.h.

Places outgoing data packets into the transmit queue.

The Transmit() function places a sending request in the transmit queue of this EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some errors occur, the event in the token will be signaled and the status is updated.

Parameters:
ThisThe pointer to the EFI_IP4_PROTOCOL instance.
TokenThe pointer to the transmit token.
Return values:
EFI_SUCCESSThe data has been queued for transmission.
EFI_NOT_STARTEDThis instance has not been started.
EFI_NO_MAPPINGWhen using the default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet.
EFI_INVALID_PARAMETEROne or more pameters are invalid.
EFI_ACCESS_DENIEDThe transmit completion token with the same Token.Event was already in the transmit queue.
EFI_NOT_READYThe completion token could not be queued because the transmit queue is full.
EFI_NOT_FOUNDNot route is found to destination address.
EFI_OUT_OF_RESOURCESCould not queue the transmit data.
EFI_BUFFER_TOO_SMALLToken.Packet.TxData.TotalDataLength is too short to transmit.
EFI_BAD_BUFFER_SIZEThe length of the IPv4 header + option length + total data length is greater than MTU (or greater than the maximum packet size if Token.Packet.TxData.OverrideData. DoNotFragment is TRUE.)

Definition at line 483 of file Ip4.h.

Places a receiving request into the receiving queue.

The Receive() function places a completion token into the receive packet queue. This function is always asynchronous.

The Token.Event field in the completion token must be filled in by the caller and cannot be NULL. When the receive operation completes, the EFI IPv4 Protocol driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event is signaled.

Parameters:
ThisThe pointer to the EFI_IP4_PROTOCOL instance.
TokenThe pointer to a token that is associated with the receive data descriptor.
Return values:
EFI_SUCCESSThe receive completion token was cached.
EFI_NOT_STARTEDThis EFI IPv4 Protocol instance has not been started.
EFI_NO_MAPPINGWhen using the default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet.
EFI_INVALID_PARAMETEROne or more of the following conditions is TRUE:
  • This is NULL.
  • Token is NULL.
  • Token.Event is NULL.
EFI_OUT_OF_RESOURCESThe receive completion token could not be queued due to a lack of system resources (usually memory).
EFI_DEVICE_ERRORAn unexpected system or network error occurred. The EFI IPv4 Protocol instance has been reset to startup defaults.
EFI_ACCESS_DENIEDThe receive completion token with the same Token.Event was already in the receive queue.
EFI_NOT_READYThe receive request could not be queued because the receive queue is full.
EFI_ICMP_ERRORAn ICMP error packet was received.

Definition at line 522 of file Ip4.h.

Abort an asynchronous transmit or receive request.

The Cancel() function is used to abort a pending transmit or receive request. If the token is in the transmit or receive request queues, after calling this function, Token->Status will be set to EFI_ABORTED and then Token->Event will be signaled. If the token is not in one of the queues, which usually means the asynchronous operation has completed, this function will not signal the token and EFI_NOT_FOUND is returned.

Parameters:
ThisThe pointer to the EFI_IP4_PROTOCOL instance.
TokenThe pointer to a token that has been issued by EFI_IP4_PROTOCOL.Transmit() or EFI_IP4_PROTOCOL.Receive(). If NULL, all pending tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is defined in EFI_IP4_PROTOCOL.Transmit().
Return values:
EFI_SUCCESSThe asynchronous I/O request was aborted and Token->Event was signaled. When Token is NULL, all pending requests were aborted and their events were signaled.
EFI_INVALID_PARAMETERThis is NULL.
EFI_NOT_STARTEDThis instance has not been started.
EFI_NO_MAPPINGWhen using the default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet.
EFI_NOT_FOUNDWhen Token is not NULL, the asynchronous I/O request was not found in the transmit or receive queue. It has either completed or was not issued by Transmit() and Receive().

Definition at line 558 of file Ip4.h.

Polls for incoming data packets and processes outgoing data packets.

The Poll() function polls for incoming data packets and processes outgoing data packets. Network drivers and applications can call the EFI_IP4_PROTOCOL.Poll() function to increase the rate that data packets are moved between the communications device and the transmit and receive queues.

In some systems the periodic timer event may not poll the underlying communications device fast enough to transmit and/or receive all data packets without missing incoming packets or dropping outgoing packets. Drivers and applications that are experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function more often.

Parameters:
ThisThe pointer to the EFI_IP4_PROTOCOL instance.
Return values:
EFI_SUCCESSIncoming or outgoing data was processed.
EFI_NOT_STARTEDThis EFI IPv4 Protocol instance has not been started.
EFI_NO_MAPPINGWhen using the default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet.
EFI_INVALID_PARAMETERThis is NULL.
EFI_DEVICE_ERRORAn unexpected system or network error occurred.
EFI_NOT_READYNo incoming or outgoing data is processed.
EFI_TIMEOUTData was dropped out of the transmit and/or receive queue. Consider increasing the polling rate.

Definition at line 592 of file Ip4.h.


Function Documentation

FILE_LICENCE ( BSD3  )

Variable Documentation