#include "Ip4Impl.h"

Functions
EFI_STATUS EFIAPI	EfiIp4GetModeData (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)

EFI_STATUS EFIAPI	EfiIp4Configure (IN EFI_IP4_PROTOCOL This, IN EFI_IP4_CONFIG_DATA IpConfigData OPTIONAL)

EFI_STATUS EFIAPI	EfiIp4Groups (IN EFI_IP4_PROTOCOL This, IN BOOLEAN JoinFlag, IN EFI_IPv4_ADDRESS GroupAddress OPTIONAL)

EFI_STATUS EFIAPI	EfiIp4Routes (IN EFI_IP4_PROTOCOL This, IN BOOLEAN DeleteRoute, IN EFI_IPv4_ADDRESS SubnetAddress, IN EFI_IPv4_ADDRESS SubnetMask, IN EFI_IPv4_ADDRESS GatewayAddress)

EFI_STATUS EFIAPI	EfiIp4Transmit (IN EFI_IP4_PROTOCOL This, IN EFI_IP4_COMPLETION_TOKEN Token)

EFI_STATUS EFIAPI	EfiIp4Receive (IN EFI_IP4_PROTOCOL This, IN EFI_IP4_COMPLETION_TOKEN Token)

EFI_STATUS EFIAPI	EfiIp4Cancel (IN EFI_IP4_PROTOCOL This, IN EFI_IP4_COMPLETION_TOKEN Token OPTIONAL)

EFI_STATUS EFIAPI	EfiIp4Poll (IN EFI_IP4_PROTOCOL *This)

EFI_STATUS	Ip4ServiceConfigMnp (IN IP4_SERVICE *IpSb, IN BOOLEAN Force)

VOID	Ip4InitProtocol (IN IP4_SERVICE IpSb, IN OUT IP4_PROTOCOL IpInstance)

EFI_STATUS	Ip4ConfigProtocol (IN OUT IP4_PROTOCOL IpInstance, IN EFI_IP4_CONFIG_DATA Config)

EFI_STATUS	Ip4CleanProtocol (IN IP4_PROTOCOL *IpInstance)

EFI_STATUS	Ip4Groups (IN IP4_PROTOCOL IpInstance, IN BOOLEAN JoinFlag, IN EFI_IPv4_ADDRESS GroupAddress OPTIONAL)

EFI_STATUS EFIAPI	Ip4TokenExist (IN NET_MAP Map, IN NET_MAP_ITEM Item, IN VOID *Context)

EFI_STATUS	Ip4TxTokenValid (IN EFI_IP4_COMPLETION_TOKEN Token, IN IP4_INTERFACE IpIf, IN BOOLEAN RawData)

VOID EFIAPI	Ip4FreeTxToken (IN VOID *Context)

VOID	Ip4OnPacketSent (IP4_PROTOCOL Ip4Instance, NET_BUF Packet, EFI_STATUS IoStatus, UINT32 Flag, VOID *Context)

EFI_STATUS EFIAPI	Ip4CancelTxTokens (IN NET_MAP Map, IN NET_MAP_ITEM Item, IN VOID *Context)

EFI_STATUS EFIAPI	Ip4CancelRxTokens (IN NET_MAP Map, IN NET_MAP_ITEM Item, IN VOID *Context)

EFI_STATUS	Ip4Cancel (IN IP4_PROTOCOL IpInstance, IN EFI_IP4_COMPLETION_TOKEN Token OPTIONAL)

EFI_STATUS EFIAPI	Ip4SentPacketTicking (IN NET_MAP Map, IN NET_MAP_ITEM Item, IN VOID *Context)

VOID EFIAPI	Ip4TimerTicking (IN EFI_EVENT Event, IN VOID *Context)

VOID EFIAPI	Ip4TimerReconfigChecking (IN EFI_EVENT Event, IN VOID *Context)

Variables
EFI_IPSEC2_PROTOCOL *	mIpSec = NULL

EFI_IP4_PROTOCOL	mEfiIp4ProtocolTemplete

Detailed Description

Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file Ip4Impl.c.

Function Documentation

◆ EfiIp4Cancel()

EFI_STATUS EFIAPI EfiIp4Cancel	(	IN EFI_IP4_PROTOCOL *	This,
		IN EFI_IP4_COMPLETION_TOKEN *Token	OPTIONAL
	)

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

[in]	This	Pointer to the EFI_IP4_PROTOCOL instance.
[in]	Token	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_SUCCESS	The 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_PARAMETER	This is NULL.
EFI_NOT_STARTED	This instance has not been started.
EFI_NO_MAPPING	When using the default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet.
EFI_NOT_FOUND	When 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 2108 of file Ip4Impl.c.

◆ EfiIp4Configure()

EFI_STATUS EFIAPI EfiIp4Configure	(	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.

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

[in]	This	Pointer to the EFI_IP4_PROTOCOL instance.
[in]	IpConfigData	Pointer to the EFI IPv4 Protocol configuration data structure.

Return values

EFI_SUCCESS	The driver instance was successfully opened.
EFI_NO_MAPPING	When using the default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet.
EFI_INVALID_PARAMETER	One or more of the following conditions is TRUE:
EFI_UNSUPPORTED	One 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_RESOURCES	The EFI IPv4 Protocol driver instance data could not be allocated.
EFI_ALREADY_STARTED	The 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_ERROR	An unexpected system or network error occurred. The EFI IPv4 Protocol driver instance is not opened.

Definition at line 868 of file Ip4Impl.c.

◆ EfiIp4GetModeData()

EFI_STATUS EFIAPI EfiIp4GetModeData	(	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.

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

[in]	This	Pointer to the EFI_IP4_PROTOCOL instance.
[out]	Ip4ModeData	Pointer to the EFI IPv4 Protocol mode data structure.
[out]	MnpConfigData	Pointer to the managed network configuration data structure.
[out]	SnpModeData	Pointer to the simple network mode data structure.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_INVALID_PARAMETER	This is NULL.
EFI_OUT_OF_RESOURCES	The required mode data could not be allocated.

Definition at line 363 of file Ip4Impl.c.

◆ EfiIp4Groups()

EFI_STATUS EFIAPI EfiIp4Groups	(	IN EFI_IP4_PROTOCOL *	This,
		IN BOOLEAN	JoinFlag,
		IN EFI_IPv4_ADDRESS *GroupAddress	OPTIONAL
	)

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

[in]	This	Pointer to the EFI_IP4_PROTOCOL instance.
[in]	JoinFlag	Set to TRUE to join the multicast group session and FALSE to leave.
[in]	GroupAddress	Pointer to the IPv4 multicast address.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_INVALID_PARAMETER	One 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_STARTED	This instance has not been started.
EFI_NO_MAPPING	When using the default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet.
EFI_OUT_OF_RESOURCES	System resources could not be allocated.
EFI_UNSUPPORTED	This EFI IPv4 Protocol implementation does not support multicast groups.
EFI_ALREADY_STARTED	The group address is already in the group table (when JoinFlag is TRUE).
EFI_NOT_FOUND	The group address is not in the group table (when JoinFlag is FALSE).
EFI_DEVICE_ERROR	An unexpected system or network error occurred.

Definition at line 1099 of file Ip4Impl.c.

◆ EfiIp4Poll()

EFI_STATUS EFIAPI EfiIp4Poll ( IN EFI_IP4_PROTOCOL * This )

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

[in] This Pointer to the EFI_IP4_PROTOCOL instance.

Return values

EFI_SUCCESS	Incoming or outgoing data was processed.
EFI_NOT_STARTED	This EFI IPv4 Protocol instance has not been started.
EFI_NO_MAPPING	When using the default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet.
EFI_INVALID_PARAMETER	This is NULL.
EFI_DEVICE_ERROR	An unexpected system or network error occurred.
EFI_NOT_READY	No incoming or outgoing data is processed.
EFI_TIMEOUT	Data was dropped out of the transmit and/or receive queue. Consider increasing the polling rate.

Definition at line 2171 of file Ip4Impl.c.

◆ EfiIp4Receive()

EFI_STATUS EFIAPI EfiIp4Receive	(	IN EFI_IP4_PROTOCOL *	This,
		IN EFI_IP4_COMPLETION_TOKEN *	Token
	)

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

[in]	This	Pointer to the EFI_IP4_PROTOCOL instance.
[in]	Token	Pointer to a token that is associated with the receive data descriptor.

Return values

EFI_SUCCESS	The receive completion token was cached.
EFI_NOT_STARTED	This EFI IPv4 Protocol instance has not been started.
EFI_NO_MAPPING	When using the default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet.
EFI_INVALID_PARAMETER	One or more of the following conditions is TRUE: This is NULL. Token is NULL. Token.Event is NULL.
EFI_OUT_OF_RESOURCES	The receive completion token could not be queued due to a lack of system resources (usually memory).
EFI_DEVICE_ERROR	An unexpected system or network error occurred. The EFI IPv4 Protocol instance has been reset to startup defaults. EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already in the receive queue.
EFI_NOT_READY	The receive request could not be queued because the receive queue is full.
EFI_ICMP_ERROR	An ICMP error packet was received.

Definition at line 1842 of file Ip4Impl.c.

◆ EfiIp4Routes()

EFI_STATUS EFIAPI EfiIp4Routes	(	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

[in]	This	Pointer to the EFI_IP4_PROTOCOL instance.
[in]	DeleteRoute	Set 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.
[in]	SubnetAddress	The address of the subnet that needs to be routed.
[in]	SubnetMask	The subnet mask of SubnetAddress.
[in]	GatewayAddress	The unicast gateway IPv4 address for this route.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_NOT_STARTED	The driver instance has not been started.
EFI_NO_MAPPING	When using the default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet.
EFI_INVALID_PARAMETER	One 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_RESOURCES	Could not add the entry to the routing table.
EFI_NOT_FOUND	This route is not in the routing table (when DeleteRoute is TRUE).
EFI_ACCESS_DENIED	The route is already defined in the routing table (when DeleteRoute is FALSE).

Definition at line 1194 of file Ip4Impl.c.

◆ EfiIp4Transmit()

EFI_STATUS EFIAPI EfiIp4Transmit	(	IN EFI_IP4_PROTOCOL *	This,
		IN EFI_IP4_COMPLETION_TOKEN *	Token
	)

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

[in]	This	Pointer to the EFI_IP4_PROTOCOL instance.
[in]	Token	Pointer to the transmit token.

Return values

EFI_SUCCESS	The data has been queued for transmission.
EFI_NOT_STARTED	This instance has not been started.
EFI_NO_MAPPING	When using the default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet.
EFI_INVALID_PARAMETER	One or more parameters are invalid.
EFI_ACCESS_DENIED	The transmit completion token with the same Token.Event was already in the transmit queue.
EFI_NOT_READY	The completion token could not be queued because the transmit queue is full.
EFI_NOT_FOUND	Not route is found to destination address.
EFI_OUT_OF_RESOURCES	Could not queue the transmit data.
EFI_BUFFER_TOO_SMALL	Token.Packet.TxData.TotalDataLength is too short to transmit.
EFI_BAD_BUFFER_SIZE	The 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.)

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

[in]	This	Pointer to the EFI_IP4_PROTOCOL instance.
[in]	Token	Pointer to the transmit token.

Return values

EFI_SUCCESS	The data has been queued for transmission.
EFI_NOT_STARTED	This instance has not been started.
EFI_NO_MAPPING	When using the default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet.
EFI_INVALID_PARAMETER	One or more parameters are invalid.
EFI_ACCESS_DENIED	The transmit completion token with the same Token.Event was already in the transmit queue.
EFI_NOT_READY	The completion token could not be queued because the transmit queue is full.
EFI_NOT_FOUND	Not route is found to destination address.
EFI_OUT_OF_RESOURCES	Could not queue the transmit data.
EFI_BUFFER_TOO_SMALL	Token.Packet.TxData.TotalDataLength is too short to transmit.
EFI_BAD_BUFFER_SIZE	The 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 1564 of file Ip4Impl.c.

◆ Ip4Cancel()

EFI_STATUS Ip4Cancel	(	IN IP4_PROTOCOL *	IpInstance,
		IN EFI_IP4_COMPLETION_TOKEN *Token	OPTIONAL
	)

Cancel the user's receive/transmit request.

Parameters

[in]	IpInstance	The IP4 child.
[in]	Token	The token to cancel. If NULL, all token will be cancelled.

Return values

EFI_SUCCESS	The token is cancelled.
EFI_NOT_FOUND	The token isn't found on either the transmit/receive queue.
EFI_DEVICE_ERROR	Not all token is cancelled when Token is NULL.

Definition at line 2016 of file Ip4Impl.c.

◆ Ip4CancelRxTokens()

EFI_STATUS EFIAPI Ip4CancelRxTokens	(	IN NET_MAP *	Map,
		IN NET_MAP_ITEM *	Item,
		IN VOID *	Context
	)

Cancel the receive request. This is quiet simple, because it is only enqueued in our local receive map.

Parameters

[in]	Map	The IP4 child's receive queue.
[in]	Item	Current receive request to cancel.
[in]	Context	The user's token to cancel.

Return values

EFI_SUCCESS	Continue to check the next receive request on the queue.
EFI_ABORTED	The user's token (token != NULL) has been cancelled.

Definition at line 1973 of file Ip4Impl.c.

◆ Ip4CancelTxTokens()

EFI_STATUS EFIAPI Ip4CancelTxTokens	(	IN NET_MAP *	Map,
		IN NET_MAP_ITEM *	Item,
		IN VOID *	Context
	)

Cancel the transmitted but not recycled packet. If a matching token is found, it will call Ip4CancelPacket to cancel the packet. Ip4CancelPacket will cancel all the fragments of the packet. When all the fragments are freed, the IP4_TXTOKEN_WRAP will be deleted from the Map, and user's event signalled. Because Ip4CancelPacket and other functions are all called in line, so, after Ip4CancelPacket returns, the Item has been freed.

Parameters

[in]	Map	The IP4 child's transmit queue.
[in]	Item	The current transmitted packet to test.
[in]	Context	The user's token to cancel.

Return values

EFI_SUCCESS	Continue to check the next Item.
EFI_ABORTED	The user's Token (Token != NULL) is cancelled.

Definition at line 1918 of file Ip4Impl.c.

◆ Ip4CleanProtocol()

EFI_STATUS Ip4CleanProtocol ( IN IP4_PROTOCOL * IpInstance )

Clean up the IP4 child, release all the resources used by it.

Parameters

[in] IpInstance The IP4 child to clean up.

Return values

EFI_SUCCESS	The IP4 child is cleaned up.
EFI_DEVICE_ERROR	Some resources failed to be released.

Definition at line 760 of file Ip4Impl.c.

◆ Ip4ConfigProtocol()

EFI_STATUS Ip4ConfigProtocol	(	IN OUT IP4_PROTOCOL *	IpInstance,
		IN EFI_IP4_CONFIG_DATA *	Config
	)

Configure the IP4 child. If the child is already configured, change the configuration parameter. Otherwise configure it for the first time. The caller should validate the configuration before deliver them to it. It also don't do configure NULL.

Parameters

[in,out]	IpInstance	The IP4 child to configure.
[in]	Config	The configure data.

Return values

EFI_SUCCESS	The IP4 child is successfully configured.
EFI_DEVICE_ERROR	Failed to free the pending transive or to configure underlying MNP or other errors.
EFI_NO_MAPPING	The IP4 child is configured to use default address, but the default address hasn't been configured. The IP4 child doesn't need to be reconfigured when default address is configured.
EFI_OUT_OF_RESOURCES	No more memory space is available.
other	Other error occurs.

Definition at line 578 of file Ip4Impl.c.

◆ Ip4FreeTxToken()

VOID EFIAPI Ip4FreeTxToken ( IN VOID * Context )

The callback function for the net buffer which wraps the user's transmit token. Although it seems this function is pretty simple, there are some subtle things. When user requests the IP to transmit a packet by passing it a token, the token is wrapped in an IP4_TXTOKEN_WRAP and the data is wrapped in an net buffer. the net buffer's Free function is set to Ip4FreeTxToken. The Token and token wrap are added to the IP child's TxToken map. Then the buffer is passed to Ip4Output for transmission. If something error happened before that, the buffer is freed, which in turn will free the token wrap. The wrap may have been added to the TxToken map or not, and the user's event shouldn't be fired because we are still in the EfiIp4Transmit. If the buffer has been sent by Ip4Output, it should be removed from the TxToken map and user's event signaled. The token wrap and buffer are bound together. Check the comments in Ip4Output for information about IP fragmentation.

Parameters

[in] Context The token's wrap.

Definition at line 1455 of file Ip4Impl.c.

◆ Ip4Groups()

EFI_STATUS Ip4Groups	(	IN IP4_PROTOCOL *	IpInstance,
		IN BOOLEAN	JoinFlag,
		IN EFI_IPv4_ADDRESS *GroupAddress	OPTIONAL
	)

Change the IP4 child's multicast setting. The caller should make sure that the parameters is valid.

Parameters

[in]	IpInstance	The IP4 child to change the setting.
[in]	JoinFlag	TRUE to join the group, otherwise leave it.
[in]	GroupAddress	The target group address.

Return values

EFI_ALREADY_STARTED	Want to join the group, but already a member of it.
EFI_OUT_OF_RESOURCES	Failed to allocate some resources.
EFI_DEVICE_ERROR	Failed to set the group configuration.
EFI_SUCCESS	Successfully updated the group setting.
EFI_NOT_FOUND	Try to leave the group which it isn't a member.

Definition at line 986 of file Ip4Impl.c.

◆ Ip4InitProtocol()

VOID Ip4InitProtocol	(	IN IP4_SERVICE *	IpSb,
		IN OUT IP4_PROTOCOL *	IpInstance
	)

Initialize the IP4_PROTOCOL structure to the unconfigured states.

Parameters

IpSb	The IP4 service instance.
IpInstance	The IP4 child instance.

Definition at line 532 of file Ip4Impl.c.

◆ Ip4OnPacketSent()

VOID Ip4OnPacketSent	(	IP4_PROTOCOL *	Ip4Instance,
		NET_BUF *	Packet,
		EFI_STATUS	IoStatus,
		UINT32	Flag,
		VOID *	Context
	)

The callback function to Ip4Output to update the transmit status.

Parameters

Ip4Instance	The Ip4Instance that request the transmit.
Packet	The user's transmit request.
IoStatus	The result of the transmission.
Flag	Not used during transmission.
Context	The token's wrap.

Definition at line 1504 of file Ip4Impl.c.

◆ Ip4SentPacketTicking()

EFI_STATUS EFIAPI Ip4SentPacketTicking	(	IN NET_MAP *	Map,
		IN NET_MAP_ITEM *	Item,
		IN VOID *	Context
	)

Decrease the life of the transmitted packets. If it is decreased to zero, cancel the packet. This function is called by Ip4PacketTimerTicking which time out both the received-but-not-delivered and transmitted-but-not-recycle packets.

Parameters

[in]	Map	The IP4 child's transmit map.
[in]	Item	Current transmitted packet.
[in]	Context	Not used.

Return values

EFI_SUCCESS Always returns EFI_SUCCESS.

Definition at line 2213 of file Ip4Impl.c.

◆ Ip4ServiceConfigMnp()

EFI_STATUS Ip4ServiceConfigMnp	(	IN IP4_SERVICE *	IpSb,
		IN BOOLEAN	Force
	)

Config the MNP parameter used by IP. The IP driver use one MNP child to transmit/receive frames. By default, it configures MNP to receive unicast/multicast/broadcast. And it will enable/disable the promiscous receive according to whether there is IP child enable that or not. If Force is FALSE, it will iterate through all the IP children to check whether the promiscuous receive setting has been changed. If it hasn't been changed, it won't reconfigure the MNP. If Force is TRUE, the MNP is configured no matter whether that is changed or not.

Parameters

[in]	IpSb	The IP4 service instance that is to be changed.
[in]	Force	Force the configuration or not.

Return values

EFI_SUCCESS	The MNP is successfully configured/reconfigured.
Others	Configuration failed.

Definition at line 465 of file Ip4Impl.c.

◆ Ip4TimerReconfigChecking()

VOID EFIAPI Ip4TimerReconfigChecking	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

This dedicated timer is used to poll underlying network media status. In case of cable swap or wireless network switch, a new round auto configuration will be initiated. The timer will signal the IP4 to run DHCP configuration again. IP4 driver will free old IP address related resource, such as route table and Interface, then initiate a DHCP process to acquire new IP, eventually create route table for new IP address.

Parameters

[in]	Event	The IP4 service instance's heart beat timer.
[in]	Context	The IP4 service instance.

Definition at line 2270 of file Ip4Impl.c.

◆ Ip4TimerTicking()

VOID EFIAPI Ip4TimerTicking	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

This heart beat timer of IP4 service instance times out all of its IP4 children's received-but-not-delivered and transmitted-but-not-recycle packets, and provides time input for its IGMP protocol.

Parameters

[in]	Event	The IP4 service instance's heart beat timer.
[in]	Context	The IP4 service instance.

Definition at line 2242 of file Ip4Impl.c.

◆ Ip4TokenExist()

EFI_STATUS EFIAPI Ip4TokenExist	(	IN NET_MAP *	Map,
		IN NET_MAP_ITEM *	Item,
		IN VOID *	Context
	)

Check whether the user's token or event has already been enqueued on IP4's list.

Parameters

[in]	Map	The container of either user's transmit or receive token.
[in]	Item	Current item to check against.
[in]	Context	The Token to check against.

Return values

EFI_ACCESS_DENIED	The token or event has already been enqueued in IP.
EFI_SUCCESS	The current item isn't the same token/event as the context.

Definition at line 1285 of file Ip4Impl.c.

◆ Ip4TxTokenValid()

EFI_STATUS Ip4TxTokenValid	(	IN EFI_IP4_COMPLETION_TOKEN *	Token,
		IN IP4_INTERFACE *	IpIf,
		IN BOOLEAN	RawData
	)

Validate the user's token against current station address.

Parameters

[in]	Token	User's token to validate.
[in]	IpIf	The IP4 child's interface.
[in]	RawData	Set to TRUE to send unformatted packets.

Return values

EFI_INVALID_PARAMETER	Some parameters are invalid.
EFI_BAD_BUFFER_SIZE	The user's option/data is too long.
EFI_SUCCESS	The token is valid.

Definition at line 1317 of file Ip4Impl.c.

Variable Documentation

◆ mEfiIp4ProtocolTemplete

EFI_IP4_PROTOCOL mEfiIp4ProtocolTemplete

Initial value:

= {
  EfiIp4GetModeData,
  EfiIp4Configure,
  EfiIp4Groups,
  EfiIp4Routes,
  EfiIp4Transmit,
  EfiIp4Receive,
  EfiIp4Cancel,
  EfiIp4Poll
}

Definition at line 332 of file Ip4Impl.c.

◆ mIpSec

EFI_IPSEC2_PROTOCOL* mIpSec = NULL

Definition at line 10 of file Ip4Impl.c.

Functions

Variables

Detailed Description

Function Documentation

◆ EfiIp4Cancel()

◆ EfiIp4Configure()

◆ EfiIp4GetModeData()

◆ EfiIp4Groups()

◆ EfiIp4Poll()

◆ EfiIp4Receive()

◆ EfiIp4Routes()

◆ EfiIp4Transmit()

◆ Ip4Cancel()

◆ Ip4CancelRxTokens()

◆ Ip4CancelTxTokens()

◆ Ip4CleanProtocol()

◆ Ip4ConfigProtocol()

◆ Ip4FreeTxToken()

◆ Ip4Groups()

◆ Ip4InitProtocol()

◆ Ip4OnPacketSent()

◆ Ip4SentPacketTicking()

◆ Ip4ServiceConfigMnp()

◆ Ip4TimerReconfigChecking()

◆ Ip4TimerTicking()

◆ Ip4TokenExist()

◆ Ip4TxTokenValid()

Variable Documentation

◆ mEfiIp4ProtocolTemplete

◆ mIpSec