The EFI UDPv6 (User Datagram Protocol version 6) Protocol Definition, which is built upon the EFI IPv6 Protocol and provides simple packet-oriented services to transmit and receive UDP packets. More...

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

Data Structures
struct	EFI_UDP6_SERVICE_POINT
	EFI_UDP6_SERVICE_POINT is deprecated in the UEFI 2.4B and should not be used any more. More...

struct	EFI_UDP6_VARIABLE_DATA
	EFI_UDP6_VARIABLE_DATA is deprecated in the UEFI 2.4B and should not be used any more. More...

struct	EFI_UDP6_FRAGMENT_DATA
	EFI_UDP6_FRAGMENT_DATA allows multiple receive or transmit buffers to be specified. More...

struct	EFI_UDP6_SESSION_DATA
	The EFI_UDP6_SESSION_DATA is used to retrieve the settings when receiving packets or to override the existing settings (only DestinationAddress and DestinationPort can be overridden) of this EFI UDPv6 Protocol instance when sending packets. More...

struct	EFI_UDP6_CONFIG_DATA

struct	EFI_UDP6_TRANSMIT_DATA
	The EFI UDPv6 Protocol client must fill this data structure before sending a packet. More...

struct	EFI_UDP6_RECEIVE_DATA
	EFI_UDP6_RECEIVE_DATA is filled by the EFI UDPv6 Protocol driver when this EFI UDPv6 Protocol instance receives an incoming packet. More...

struct	EFI_UDP6_COMPLETION_TOKEN
	The EFI_UDP6_COMPLETION_TOKEN structures are used for both transmit and receive operations. More...

struct	_EFI_UDP6_PROTOCOL
	The EFI_UDP6_PROTOCOL defines an EFI UDPv6 Protocol session that can be used by any network drivers, applications, or daemons to transmit or receive UDP packets. More...

Macros
#define	EFI_UDP6_SERVICE_BINDING_PROTOCOL_GUID

#define	EFI_UDP6_PROTOCOL_GUID

Typedefs
typedef struct _EFI_UDP6_PROTOCOL	EFI_UDP6_PROTOCOL

typedef EFI_STATUS(EFIAPI *	EFI_UDP6_GET_MODE_DATA) (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)
	Read the current operational settings. More...

typedef EFI_STATUS(EFIAPI *	EFI_UDP6_CONFIGURE) (IN EFI_UDP6_PROTOCOL This, IN EFI_UDP6_CONFIG_DATA UdpConfigData OPTIONAL)
	Initializes, changes, or resets the operational parameters for this instance of the EFI UDPv6 Protocol. More...

typedef EFI_STATUS(EFIAPI *	EFI_UDP6_GROUPS) (IN EFI_UDP6_PROTOCOL This, IN BOOLEAN JoinFlag, IN EFI_IPv6_ADDRESS MulticastAddress OPTIONAL)
	Joins and leaves multicast groups. More...

typedef EFI_STATUS(EFIAPI *	EFI_UDP6_TRANSMIT) (IN EFI_UDP6_PROTOCOL This, IN EFI_UDP6_COMPLETION_TOKEN Token)
	Queues outgoing data packets into the transmit queue. More...

typedef EFI_STATUS(EFIAPI *	EFI_UDP6_RECEIVE) (IN EFI_UDP6_PROTOCOL This, IN EFI_UDP6_COMPLETION_TOKEN Token)
	Places an asynchronous receive request into the receiving queue. More...

typedef EFI_STATUS(EFIAPI *	EFI_UDP6_CANCEL) (IN EFI_UDP6_PROTOCOL This, IN EFI_UDP6_COMPLETION_TOKEN Token OPTIONAL)
	Aborts an asynchronous transmit or receive request. More...

typedef EFI_STATUS(EFIAPI *	EFI_UDP6_POLL) (IN EFI_UDP6_PROTOCOL *This)
	Polls for incoming data packets and processes outgoing data packets. More...

Functions
	FILE_LICENCE (BSD2_PATENT)

Variables
EFI_GUID	gEfiUdp6ServiceBindingProtocolGuid

EFI_GUID	gEfiUdp6ProtocolGuid

Detailed Description

The EFI UDPv6 (User Datagram Protocol version 6) Protocol Definition, which is built upon the EFI IPv6 Protocol and provides simple packet-oriented services to transmit and receive UDP packets.

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

Revision Reference:: This Protocol is introduced in UEFI Specification 2.2

Definition in file Udp6.h.

Macro Definition Documentation

◆ EFI_UDP6_SERVICE_BINDING_PROTOCOL_GUID

#define EFI_UDP6_SERVICE_BINDING_PROTOCOL_GUID

Value:

{ \
    0x66ed4721, 0x3c98, 0x4d3e, {0x81, 0xe3, 0xd0, 0x3d, 0xd3, 0x9a, 0x72, 0x54 } \
  }

Definition at line 21 of file Udp6.h.

◆ EFI_UDP6_PROTOCOL_GUID

#define EFI_UDP6_PROTOCOL_GUID

Value:

{ \
    0x4f948815, 0xb4b9, 0x43cb, {0x8a, 0x33, 0x90, 0xe0, 0x60, 0xb3, 0x49, 0x55 } \
  }

Definition at line 26 of file Udp6.h.

Typedef Documentation

◆ EFI_UDP6_PROTOCOL

typedef struct _EFI_UDP6_PROTOCOL EFI_UDP6_PROTOCOL

Definition at line 81 of file Udp6.h.

◆ EFI_UDP6_GET_MODE_DATA

typedef EFI_STATUS(EFIAPI * EFI_UDP6_GET_MODE_DATA) (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)

Read the current operational settings.

The GetModeData() 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.
[out]	Ip6ModeData	The buffer in which the current EFI IPv6 Protocol mode data is returned.
[out]	MnpConfigData	The buffer in which the current managed network configuration data is returned.
[out]	SnpModeData	The buffer in which the simple network mode data is returned.

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 320 of file Udp6.h.

◆ EFI_UDP6_CONFIGURE

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

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

The Configure() 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.

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_UDP6_PROTOCOL instance.
[in]	UdpConfigData	Pointer to the buffer contained the configuration data.

Return values

EFI_SUCCESS	The configuration settings were set, changed, or reset successfully.
EFI_NO_MAPPING	The underlying 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 following conditions are TRUE: This is NULL. UdpConfigData.StationAddress neither zero nor one of the configured IP addresses in the underlying IPv6 driver. 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 other 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 371 of file Udp6.h.

◆ EFI_UDP6_GROUPS

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

Joins and leaves multicast groups.

The Groups() function is used to join or leave one or more multicast group. If the JoinFlag is FALSE and the MulticastAddress is NULL, then all currently joined groups are left.

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.

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 401 of file Udp6.h.

◆ EFI_UDP6_TRANSMIT

typedef EFI_STATUS(EFIAPI * EFI_UDP6_TRANSMIT) (IN EFI_UDP6_PROTOCOL *This, IN EFI_UDP6_COMPLETION_TOKEN *Token)

Queues outgoing data packets into the transmit queue.

The Transmit() function places a sending request to this instance of the EFI UDPv6 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_UDP6_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 UDPv6 Protocol instance has not been started.
EFI_NO_MAPPING	The underlying 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. Token.Packet.TxData.UdpSessionData.DestinationAddress is not zero and is not valid unicast Ipv6 address if UdpSessionData is not NULL. Token.Packet.TxData.UdpSessionData is NULL and this instance's UdpConfigData.RemoteAddress is unspecified. Token.Packet.TxData.UdpSessionData.DestinationAddress is non-zero when DestinationAddress is configured as non-zero when doing Configure() for this EFI Udp6 protocol instance. Token.Packet.TxData.UdpSesionData.DestinationAddress is zero when DestinationAddress is unspecified when doing Configure() for this EFI Udp6 protocol instance.
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.

Definition at line 458 of file Udp6.h.

◆ EFI_UDP6_RECEIVE

typedef EFI_STATUS(EFIAPI * EFI_UDP6_RECEIVE) (IN EFI_UDP6_PROTOCOL *This, IN EFI_UDP6_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 UDPv6 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_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	The underlying 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 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 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 497 of file Udp6.h.

◆ EFI_UDP6_CANCEL

typedef EFI_STATUS(EFIAPI * EFI_UDP6_CANCEL) (IN EFI_UDP6_PROTOCOL *This, IN EFI_UDP6_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_UDP6_PROTOCOL instance.
[in]	Token	Pointer to a token that has been issued by EFI_UDP6_PROTOCOL.Transmit() or EFI_UDP6_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_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 527 of file Udp6.h.

◆ EFI_UDP6_POLL

typedef EFI_STATUS(EFIAPI * EFI_UDP6_POLL) (IN EFI_UDP6_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_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. Consider increasing the polling rate.

Definition at line 553 of file Udp6.h.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( BSD2_PATENT )

Variable Documentation

◆ gEfiUdp6ServiceBindingProtocolGuid

EFI_GUID gEfiUdp6ServiceBindingProtocolGuid

◆ gEfiUdp6ProtocolGuid

EFI_GUID gEfiUdp6ProtocolGuid

Data Structures

Macros

Typedefs

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ EFI_UDP6_SERVICE_BINDING_PROTOCOL_GUID

◆ EFI_UDP6_PROTOCOL_GUID

Typedef Documentation

◆ EFI_UDP6_PROTOCOL

◆ EFI_UDP6_GET_MODE_DATA

◆ EFI_UDP6_CONFIGURE

◆ EFI_UDP6_GROUPS

◆ EFI_UDP6_TRANSMIT

◆ EFI_UDP6_RECEIVE

◆ EFI_UDP6_CANCEL

◆ EFI_UDP6_POLL

Function Documentation

◆ FILE_LICENCE()

Variable Documentation

◆ gEfiUdp6ServiceBindingProtocolGuid

◆ gEfiUdp6ProtocolGuid