#include "Udp4Impl.h"

Functions
EFI_STATUS EFIAPI	Udp4GetModeData (IN EFI_UDP4_PROTOCOL This, OUT EFI_UDP4_CONFIG_DATA Udp4ConfigData OPTIONAL, 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	Udp4Configure (IN EFI_UDP4_PROTOCOL This, IN EFI_UDP4_CONFIG_DATA UdpConfigData OPTIONAL)

EFI_STATUS EFIAPI	Udp4Groups (IN EFI_UDP4_PROTOCOL This, IN BOOLEAN JoinFlag, IN EFI_IPv4_ADDRESS MulticastAddress OPTIONAL)

EFI_STATUS EFIAPI	Udp4Routes (IN EFI_UDP4_PROTOCOL This, IN BOOLEAN DeleteRoute, IN EFI_IPv4_ADDRESS SubnetAddress, IN EFI_IPv4_ADDRESS SubnetMask, IN EFI_IPv4_ADDRESS GatewayAddress)

EFI_STATUS EFIAPI	Udp4Transmit (IN EFI_UDP4_PROTOCOL This, IN EFI_UDP4_COMPLETION_TOKEN Token)

EFI_STATUS EFIAPI	Udp4Receive (IN EFI_UDP4_PROTOCOL This, IN EFI_UDP4_COMPLETION_TOKEN Token)

EFI_STATUS EFIAPI	Udp4Cancel (IN EFI_UDP4_PROTOCOL This, IN EFI_UDP4_COMPLETION_TOKEN Token OPTIONAL)

EFI_STATUS EFIAPI	Udp4Poll (IN EFI_UDP4_PROTOCOL *This)

Variables
EFI_UDP4_PROTOCOL	mUdp4Protocol

Detailed Description

(C) Copyright 2014 Hewlett-Packard Development Company, L.P.
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file Udp4Main.c.

Function Documentation

◆ Udp4Cancel()

EFI_STATUS EFIAPI Udp4Cancel	(	IN EFI_UDP4_PROTOCOL *	This,
		IN EFI_UDP4_COMPLETION_TOKEN *Token	OPTIONAL
	)

Aborts 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 that 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_UDP4_PROTOCOL instance.
[in]	Token	Pointer to a token that has been issued by EFI_UDP4_PROTOCOL.Transmit() or EFI_UDP4_PROTOCOL.Receive().If NULL, all pending tokens are aborted.

Return values

EFI_SUCCESS	The asynchronous I/O request was aborted and Token.Event was signaled. When Token is NULL, all pending requests are aborted and their events are 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 813 of file Udp4Main.c.

◆ Udp4Configure()

EFI_STATUS EFIAPI Udp4Configure	(	IN EFI_UDP4_PROTOCOL *	This,
		IN EFI_UDP4_CONFIG_DATA *UdpConfigData	OPTIONAL
	)

Initializes, changes, or resets the operational parameters for this instance of the EFI UDPv4 Protocol.

The Configure() function is used to do the following: Initialize and start this instance of the EFI UDPv4 Protocol. Change the filtering rules and operational parameters. Reset this instance of the EFI UDPv4 Protocol. Until these parameters are initialized, no network traffic can be sent or received by this instance. This instance can be also reset by calling Configure() with UdpConfigData set to NULL. Once reset, the receiving queue and transmitting queue are flushed and no traffic is allowed through this instance. With different parameters in UdpConfigData, Configure() can be used to bind this instance to specified port.

Parameters

[in]	This	Pointer to the EFI_UDP4_PROTOCOL instance.
[in]	UdpConfigData	Pointer to the buffer to receive the current configuration data.

Return values

EFI_SUCCESS	The configuration settings were set, changed, or reset successfully.
EFI_NO_MAPPING	When using a default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet.
EFI_INVALID_PARAMETER	One or more following conditions are TRUE:
EFI_ALREADY_STARTED	The EFI UDPv4 Protocol instance is already started/configured and must be stopped/reset before it can be reconfigured.
EFI_ACCESS_DENIED	UdpConfigData. AllowDuplicatePort is FALSE and UdpConfigData.StationPort is already used by other instance.
EFI_OUT_OF_RESOURCES	The EFI UDPv4 Protocol driver cannot allocate memory for this EFI UDPv4 Protocol instance.
EFI_DEVICE_ERROR	An unexpected network or system error occurred and this instance was not opened.

Definition at line 123 of file Udp4Main.c.

◆ Udp4GetModeData()

EFI_STATUS EFIAPI Udp4GetModeData	(	IN EFI_UDP4_PROTOCOL *	This,
		OUT EFI_UDP4_CONFIG_DATA *Udp4ConfigData	OPTIONAL,
		OUT EFI_IP4_MODE_DATA *Ip4ModeData	OPTIONAL,
		OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData	OPTIONAL,
		OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData	OPTIONAL
	)

Reads the current operational settings.

The GetModeData() function copies the current operational settings of this EFI UDPv4 Protocol instance into user-supplied buffers. This function is used optionally to retrieve the operational mode data of underlying networks or drivers.

Parameters

[in]	This	Pointer to the EFI_UDP4_PROTOCOL instance.
[out]	Udp4ConfigData	Pointer to the buffer to receive the current configuration data.
[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 mode data was read.
EFI_NOT_STARTED	When Udp4ConfigData is queried, no configuration data is available because this instance has not been started.
EFI_INVALID_PARAMETER	This is NULL.

Definition at line 44 of file Udp4Main.c.

◆ Udp4Groups()

EFI_STATUS EFIAPI Udp4Groups	(	IN EFI_UDP4_PROTOCOL *	This,
		IN BOOLEAN	JoinFlag,
		IN EFI_IPv4_ADDRESS *MulticastAddress	OPTIONAL
	)

Joins and leaves multicast groups.

The Groups() function is used to enable and disable the multicast group filtering. If the JoinFlag is FALSE and the MulticastAddress is NULL, then all currently joined groups are left.

Parameters

[in]	This	Pointer to the EFI_UDP4_PROTOCOL instance.
[in]	JoinFlag	Set to TRUE to join a multicast group. Set to FALSE to leave one or all multicast groups.
[in]	MulticastAddress	Pointer to multicast group address to join or leave.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_NOT_STARTED	The EFI UDPv4 Protocol instance has not been started.
EFI_NO_MAPPING	When using a default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet.
EFI_OUT_OF_RESOURCES	Could not allocate resources to join the group.
EFI_INVALID_PARAMETER	One or more of the following conditions is TRUE: This is NULL. JoinFlag is TRUE and MulticastAddress is NULL. JoinFlag is TRUE and *MulticastAddress is not a valid multicast address.
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 314 of file Udp4Main.c.

◆ Udp4Poll()

EFI_STATUS EFIAPI Udp4Poll ( IN EFI_UDP4_PROTOCOL * This )

Polls for incoming data packets and processes outgoing data packets.

The Poll() function can be used by network drivers and applications 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 in the managed network driver 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 Poll() function more often.

Parameters

[in] This Pointer to the EFI_UDP4_PROTOCOL instance.

Return values

EFI_SUCCESS	Incoming or outgoing data was processed.
EFI_INVALID_PARAMETER	This is NULL.
EFI_DEVICE_ERROR	An unexpected system or network error occurred.
EFI_TIMEOUT	Data was dropped out of the transmit and/or receive queue.

Definition at line 875 of file Udp4Main.c.

◆ Udp4Receive()

EFI_STATUS EFIAPI Udp4Receive	(	IN EFI_UDP4_PROTOCOL *	This,
		IN EFI_UDP4_COMPLETION_TOKEN *	Token
	)

Places an asynchronous receive request into the receiving queue.

The Receive() function places a completion token into the receive packet queue. This function is always asynchronous. The caller must fill in the Token.Event field in the completion token, and this field cannot be NULL. When the receive operation completes, the EFI UDPv4 Protocol driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event is signaled. Providing a proper notification function and context for the event will enable the user to receive the notification and receiving status. That notification function is guaranteed to not be re-entered.

Parameters

[in]	This	Pointer to the EFI_UDP4_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 UDPv4 Protocol instance has not been started.
EFI_NO_MAPPING	When using a default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet.
EFI_INVALID_PARAMETER	One or more of the following conditions is TRUE:
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.
EFI_ACCESS_DENIED	A 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.

Definition at line 714 of file Udp4Main.c.

◆ Udp4Routes()

EFI_STATUS EFIAPI Udp4Routes	(	IN EFI_UDP4_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 IP address and arithmetically AND-ing it 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 IP addresses that do not match any other routes. A zero GatewayAddress is a nonroute. Packets are sent to the destination IP address if it can be found in the Address Resolution Protocol (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 instance of the EFI UDPv4 Protocol has its own independent routing table. Instances of the EFI UDPv4 Protocol that use the default IP address will also have copies of the routing table provided by the EFI_IP4_CONFIG_PROTOCOL. These copies will be updated automatically whenever the IP driver reconfigures its instances; as a result, the previous modification to these copies will be lost.

Parameters

[in]	This	Pointer to the EFI_UDP4_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.
[in]	SubnetAddress	The destination network address that needs to be routed.
[in]	SubnetMask	The subnet mask of SubnetAddress.
[in]	GatewayAddress	The gateway IP address for this route.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_NOT_STARTED	The EFI UDPv4 Protocol instance has not been started.
EFI_NO_MAPPING	When using a default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet.
EFI_INVALID_PARAMETER	One or more parameters are invalid.
EFI_OUT_OF_RESOURCES	Could not add the entry to the routing table.
EFI_NOT_FOUND	This route is not in the routing table.
EFI_ACCESS_DENIED	The route is already defined in the routing table.

Definition at line 421 of file Udp4Main.c.

◆ Udp4Transmit()

EFI_STATUS EFIAPI Udp4Transmit	(	IN EFI_UDP4_PROTOCOL *	This,
		IN EFI_UDP4_COMPLETION_TOKEN *	Token
	)

Queues outgoing data packets into the transmit queue.

The Transmit() function places a sending request to this instance of the EFI UDPv4 Protocol, alongside the transmit data that was filled by the user. Whenever the packet in the token is sent out or some errors occur, the Token.Event will be signaled and Token.Status is updated. Providing a proper notification function and context for the event will enable the user to receive the notification and transmitting status.

Parameters

[in]	This	Pointer to the EFI_UDP4_PROTOCOL instance.
[in]	Token	Pointer to the completion token that will be placed into the transmit queue.

Return values

EFI_SUCCESS	The data has been queued for transmission.
EFI_NOT_STARTED	This EFI UDPv4 Protocol instance has not been started.
EFI_NO_MAPPING	When using a 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_OUT_OF_RESOURCES	Could not queue the transmit data.
EFI_NOT_FOUND	There is no route to the destination network or address.
EFI_BAD_BUFFER_SIZE	The data length is greater than the maximum UDP packet size. Or the length of the IP header + UDP header + data length is greater than MTU if DoNotFragment is TRUE.

Definition at line 486 of file Udp4Main.c.

Variable Documentation

◆ mUdp4Protocol

EFI_UDP4_PROTOCOL mUdp4Protocol

Initial value:

= {
  Udp4GetModeData,
  Udp4Configure,
  Udp4Groups,
  Udp4Routes,
  Udp4Transmit,
  Udp4Receive,
  Udp4Cancel,
  Udp4Poll
}

Definition at line 11 of file Udp4Main.c.

Functions

Variables

Detailed Description

Function Documentation

◆ Udp4Cancel()

◆ Udp4Configure()

◆ Udp4GetModeData()

◆ Udp4Groups()

◆ Udp4Poll()

◆ Udp4Receive()

◆ Udp4Routes()

◆ Udp4Transmit()

Variable Documentation

◆ mUdp4Protocol