#include "Udp6Impl.h"

Functions
EFI_STATUS EFIAPI	Udp6GetModeData (IN EFI_UDP6_PROTOCOL This, OUT EFI_UDP6_CONFIG_DATA Udp6ConfigData OPTIONAL, OUT EFI_IP6_MODE_DATA Ip6ModeData OPTIONAL, OUT EFI_MANAGED_NETWORK_CONFIG_DATA MnpConfigData OPTIONAL, OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL)

EFI_STATUS EFIAPI	Udp6Configure (IN EFI_UDP6_PROTOCOL This, IN EFI_UDP6_CONFIG_DATA UdpConfigData OPTIONAL)

EFI_STATUS EFIAPI	Udp6Groups (IN EFI_UDP6_PROTOCOL This, IN BOOLEAN JoinFlag, IN EFI_IPv6_ADDRESS MulticastAddress OPTIONAL)

EFI_STATUS EFIAPI	Udp6Transmit (IN EFI_UDP6_PROTOCOL This, IN EFI_UDP6_COMPLETION_TOKEN Token)

EFI_STATUS EFIAPI	Udp6Receive (IN EFI_UDP6_PROTOCOL This, IN EFI_UDP6_COMPLETION_TOKEN Token)

EFI_STATUS EFIAPI	Udp6Cancel (IN EFI_UDP6_PROTOCOL This, IN EFI_UDP6_COMPLETION_TOKEN Token OPTIONAL)

EFI_STATUS EFIAPI	Udp6Poll (IN EFI_UDP6_PROTOCOL *This)

Variables
EFI_UDP6_PROTOCOL	mUdp6Protocol

Detailed Description

Contains all EFI_UDP6_PROTOCOL interfaces.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file Udp6Main.c.

Function Documentation

◆ Udp6Cancel()

EFI_STATUS EFIAPI Udp6Cancel	(	IN EFI_UDP6_PROTOCOL *	This,
		IN EFI_UDP6_COMPLETION_TOKEN *Token	OPTIONAL
	)

This function is used to abort a pending transmit or receive request.

Parameters

[in]	This	Pointer to the EFI_UDP6_PROTOCOL instance.
[in]	Token	Pointer to a token that has been issued by EFI_UDP6_PROTOCOL.Transmit() or EFI_UDP6_PROTOCOL.Receive(). This parameter is optional and may be NULL.

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 is not found in the transmit or receive queue. It is either completed or not issued by Transmit() or Receive().

Definition at line 779 of file Udp6Main.c.

◆ Udp6Configure()

EFI_STATUS EFIAPI Udp6Configure	(	IN EFI_UDP6_PROTOCOL *	This,
		IN EFI_UDP6_CONFIG_DATA *UdpConfigData	OPTIONAL
	)

This function is used to do the following: Initialize and start this instance of the EFI UDPv6 Protocol. Change the filtering rules and operational parameters. Reset this instance of the EFI UDPv6 Protocol.

Parameters

[in]	This	Pointer to the EFI_UDP6_PROTOCOL instance.
[in]	UdpConfigData	Pointer to the buffer to set the configuration data. This parameter is optional and may be NULL.

Return values

EFI_SUCCESS	The configuration settings were set, changed, or reset successfully.
EFI_NO_MAPPING	When the UdpConfigData.UseAnyStationAddress is set to true and there is no address available for the IP6 driver to bind a source address to this instance.
EFI_INVALID_PARAMETER	One or more following conditions are TRUE: This is NULL. UdpConfigData.StationAddress is not a valid unicast IPv6 address. UdpConfigData.RemoteAddress is not a valid unicast IPv6 address if it is not zero.
EFI_ALREADY_STARTED	The EFI UDPv6 Protocol instance is already started/configured and must be stopped/reset before it can be reconfigured. Only TrafficClass, HopLimit, ReceiveTimeout, and TransmitTimeout can be reconfigured without stopping the current instance of the EFI UDPv6 Protocol.
EFI_ACCESS_DENIED	UdpConfigData.AllowDuplicatePort is FALSE and UdpConfigData.StationPort is already used by another instance.
EFI_OUT_OF_RESOURCES	The EFI UDPv6 Protocol driver cannot allocate memory for this EFI UDPv6 Protocol instance.
EFI_DEVICE_ERROR	An unexpected network or system error occurred, and this instance was not opened.

Definition at line 131 of file Udp6Main.c.

◆ Udp6GetModeData()

EFI_STATUS EFIAPI Udp6GetModeData	(	IN EFI_UDP6_PROTOCOL *	This,
		OUT EFI_UDP6_CONFIG_DATA *Udp6ConfigData	OPTIONAL,
		OUT EFI_IP6_MODE_DATA *Ip6ModeData	OPTIONAL,
		OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData	OPTIONAL,
		OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData	OPTIONAL
	)

This function copies the current operational settings of this EFI UDPv6 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_UDP6_PROTOCOL instance.
[out]	Udp6ConfigData	The buffer in which the current UDP configuration data is returned. This parameter is optional and may be NULL.
[out]	Ip6ModeData	The buffer in which the current EFI IPv6 Protocol mode data is returned. This parameter is optional and may be NULL.
[out]	MnpConfigData	The buffer in which the current managed network configuration data is returned. This parameter is optional and may be NULL.
[out]	SnpModeData	The buffer in which the simple network mode data is returned. This parameter is optional and may be NULL.

Return values

EFI_SUCCESS	The mode data was read.
EFI_NOT_STARTED	When Udp6ConfigData is queried, no configuration data is available because this instance has not been started.
EFI_INVALID_PARAMETER	This is NULL.

Definition at line 49 of file Udp6Main.c.

◆ Udp6Groups()

EFI_STATUS EFIAPI Udp6Groups	(	IN EFI_UDP6_PROTOCOL *	This,
		IN BOOLEAN	JoinFlag,
		IN EFI_IPv6_ADDRESS *MulticastAddress	OPTIONAL
	)

This function is used to enable and disable the multicast group filtering.

Parameters

[in]	This	Pointer to the EFI_UDP6_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. This parameter is optional and may be NULL.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_NOT_STARTED	The EFI UDPv6 Protocol instance has not been started.
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 Udp6Main.c.

◆ Udp6Poll()

EFI_STATUS EFIAPI Udp6Poll ( IN EFI_UDP6_PROTOCOL * This )

This 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/receive queues.

Parameters

[in] This Pointer to the EFI_UDP6_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 830 of file Udp6Main.c.

◆ Udp6Receive()

EFI_STATUS EFIAPI Udp6Receive	(	IN EFI_UDP6_PROTOCOL *	This,
		IN EFI_UDP6_COMPLETION_TOKEN *	Token
	)

This function places a completion token into the receive packet queue. This function is always asynchronous.

Parameters

[in]	This	Pointer to the EFI_UDP6_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 UDPv6 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: 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 UDPv6 Protocol instance has been reset to startup defaults.
EFI_ACCESS_DENIED	A receive completion token with the same Token.Event is already in the receive queue.
EFI_NOT_READY	The receive request could not be queued because the receive queue is full.

Definition at line 688 of file Udp6Main.c.

◆ Udp6Transmit()

EFI_STATUS EFIAPI Udp6Transmit	(	IN EFI_UDP6_PROTOCOL *	This,
		IN EFI_UDP6_COMPLETION_TOKEN *	Token
	)

This function places a sending request to this instance of the EFI UDPv6 Protocol, alongside the transmit data that was filled by the user.

Parameters

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

Return values

EFI_SUCCESS	The data was queued for transmission.
EFI_NOT_STARTED	This EFI UDPv6 Protocol instance has not been started.
EFI_NO_MAPPING	The under-layer IPv6 driver was responsible for choosing a source address for this instance, but no source address was available for use.
EFI_INVALID_PARAMETER	One or more of the following are TRUE: This is NULL. Token is NULL. Token.Event is NULL. Token.Packet.TxData is NULL. Token.Packet.TxData.FragmentCount is zero. Token.Packet.TxData.DataLength is not equal to the sum of fragment lengths. One or more of the Token.Packet.TxData.FragmentTable[].FragmentLength fields is zero. One or more of the Token.Packet.TxData.FragmentTable[].FragmentBuffer fields is NULL. One or more of the Token.Packet.TxData.UdpSessionData.DestinationAddress are not valid unicast IPv6 addresses if the UdpSessionData is not NULL. Token.Packet.TxData.UdpSessionData. DestinationAddress is NULL Token.Packet.TxData.UdpSessionData. DestinationPort is zero. Token.Packet.TxData.UdpSessionData is NULL and this instance's UdpConfigData.RemoteAddress is unspecified.
EFI_ACCESS_DENIED	The transmit completion token with the same Token.Event is 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 445 of file Udp6Main.c.

Variable Documentation

◆ mUdp6Protocol

EFI_UDP6_PROTOCOL mUdp6Protocol

Initial value:

= {
  Udp6GetModeData,
  Udp6Configure,
  Udp6Groups,
  Udp6Transmit,
  Udp6Receive,
  Udp6Cancel,
  Udp6Poll
}

Definition at line 12 of file Udp6Main.c.

Functions

Variables

Detailed Description

Function Documentation

◆ Udp6Cancel()

◆ Udp6Configure()

◆ Udp6GetModeData()

◆ Udp6Groups()

◆ Udp6Poll()

◆ Udp6Receive()

◆ Udp6Transmit()

Variable Documentation

◆ mUdp6Protocol