#include <Uefi.h>
#include <Protocol/Ip6.h>
#include <Protocol/Udp6.h>
#include <Library/IpIoLib.h>
#include <Library/DebugLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/BaseLib.h>
#include <Library/UefiLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/DpcLib.h>
#include <Library/PrintLib.h>
#include "Udp6Driver.h"

Data Structures
struct	_UDP6_SERVICE_DATA

struct	_UDP6_INSTANCE_DATA

struct	_UDP6_RXDATA_WRAP

struct	UDP6_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT

Macros
#define	UDP6_TIMEOUT_INTERVAL (50 * TICKS_PER_MS)

#define	UDP6_HEADER_SIZE sizeof (EFI_UDP_HEADER)

#define	UDP6_MAX_DATA_SIZE 65507

#define	UDP6_PORT_KNOWN 1024

#define	UDP6_SERVICE_DATA_SIGNATURE SIGNATURE_32 ('U', 'd', 'p', '6')

#define	UDP6_INSTANCE_DATA_SIGNATURE SIGNATURE_32 ('U', 'd', 'p', 'S')

#define	UDP6_SERVICE_DATA_FROM_THIS(a)

#define	UDP6_INSTANCE_DATA_FROM_THIS(a)

Typedefs
typedef struct _UDP6_SERVICE_DATA	UDP6_SERVICE_DATA

typedef struct _UDP6_INSTANCE_DATA	UDP6_INSTANCE_DATA

typedef struct _UDP6_RXDATA_WRAP	UDP6_RXDATA_WRAP

Functions
VOID	Udp6CleanService (IN OUT UDP6_SERVICE_DATA *Udp6Service)

EFI_STATUS	Udp6CreateService (IN UDP6_SERVICE_DATA *Udp6Service, IN EFI_HANDLE ImageHandle, IN EFI_HANDLE ControllerHandle)

VOID	Udp6CleanInstance (IN OUT UDP6_INSTANCE_DATA *Instance)

VOID	Udp6InitInstance (IN UDP6_SERVICE_DATA Udp6Service, IN OUT UDP6_INSTANCE_DATA Instance)

VOID	Udp6ReportIcmpError (IN UDP6_INSTANCE_DATA *Instance)

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	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)

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

EFI_STATUS	Udp6Bind (IN LIST_ENTRY InstanceList, IN EFI_UDP6_CONFIG_DATA ConfigData)

VOID	Udp6BuildIp6ConfigData (IN EFI_UDP6_CONFIG_DATA Udp6ConfigData, IN OUT EFI_IP6_CONFIG_DATA Ip6ConfigData)

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

EFI_STATUS	Udp6RemoveToken (IN NET_MAP TokenMap, IN EFI_UDP6_COMPLETION_TOKEN Token)

BOOLEAN	Udp6IsReconfigurable (IN EFI_UDP6_CONFIG_DATA OldConfigData, IN EFI_UDP6_CONFIG_DATA NewConfigData)

EFI_STATUS EFIAPI	Udp6LeaveGroup (IN NET_MAP Map, IN NET_MAP_ITEM Item, IN VOID *Arg OPTIONAL)

EFI_STATUS	Udp6ValidateTxToken (IN UDP6_INSTANCE_DATA Instance, IN EFI_UDP6_COMPLETION_TOKEN TxToken)

VOID EFIAPI	Udp6NetVectorExtFree (IN VOID *Context)

UINT16	Udp6Checksum (IN NET_BUF *Packet, IN UINT16 HeadSum)

VOID	Udp6InstanceDeliverDgram (IN UDP6_INSTANCE_DATA *Instance)

EFI_STATUS	Udp6InstanceCancelToken (IN UDP6_INSTANCE_DATA Instance, IN EFI_UDP6_COMPLETION_TOKEN Token OPTIONAL)

VOID	Udp6FlushRcvdDgram (IN UDP6_INSTANCE_DATA *Instance)

Variables
EFI_COMPONENT_NAME2_PROTOCOL	gUdp6ComponentName2

EFI_COMPONENT_NAME_PROTOCOL	gUdp6ComponentName

EFI_UNICODE_STRING_TABLE *	gUdp6ControllerNameTable

EFI_SERVICE_BINDING_PROTOCOL	mUdp6ServiceBinding

EFI_UDP6_PROTOCOL	mUdp6Protocol

UINT16	mUdp6RandomPort

Detailed Description

Udp6 driver's whole implementation and internal data structures.

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

Definition in file Udp6Impl.h.

Macro Definition Documentation

◆ UDP6_HEADER_SIZE

#define UDP6_HEADER_SIZE sizeof (EFI_UDP_HEADER)

Definition at line 42 of file Udp6Impl.h.

◆ UDP6_INSTANCE_DATA_FROM_THIS

#define UDP6_INSTANCE_DATA_FROM_THIS ( a )

Value:

  CR ( \
  (a), \
  UDP6_INSTANCE_DATA, \
  Udp6Proto, \
  UDP6_INSTANCE_DATA_SIGNATURE \
  )

Definition at line 57 of file Udp6Impl.h.

◆ UDP6_INSTANCE_DATA_SIGNATURE

#define UDP6_INSTANCE_DATA_SIGNATURE SIGNATURE_32 ('U', 'd', 'p', 'S')

Definition at line 47 of file Udp6Impl.h.

◆ UDP6_MAX_DATA_SIZE

#define UDP6_MAX_DATA_SIZE 65507

Definition at line 43 of file Udp6Impl.h.

◆ UDP6_PORT_KNOWN

#define UDP6_PORT_KNOWN 1024

Definition at line 44 of file Udp6Impl.h.

◆ UDP6_SERVICE_DATA_FROM_THIS

#define UDP6_SERVICE_DATA_FROM_THIS ( a )

Value:

  CR ( \
  (a), \
  UDP6_SERVICE_DATA, \
  ServiceBinding, \
  UDP6_SERVICE_DATA_SIGNATURE \
  )

Definition at line 49 of file Udp6Impl.h.

◆ UDP6_SERVICE_DATA_SIGNATURE

#define UDP6_SERVICE_DATA_SIGNATURE SIGNATURE_32 ('U', 'd', 'p', '6')

Definition at line 46 of file Udp6Impl.h.

◆ UDP6_TIMEOUT_INTERVAL

#define UDP6_TIMEOUT_INTERVAL (50 * TICKS_PER_MS)

Definition at line 41 of file Udp6Impl.h.

Function Documentation

◆ Udp6Bind()

EFI_STATUS Udp6Bind	(	IN LIST_ENTRY *	InstanceList,
		IN EFI_UDP6_CONFIG_DATA *	ConfigData
	)

This function tries to bind the udp instance according to the configured port allocation strategy.

Parameters

[in]	InstanceList	Pointer to the head of the list linking the udp instances.
[in]	ConfigData	Pointer to the ConfigData of the instance to be bound.

Return values

EFI_SUCCESS	The bound operation completed successfully.
EFI_ACCESS_DENIED	The <Address, Port> specified by the ConfigData is already used by another instance.
EFI_OUT_OF_RESOURCES	No available port resources.

This function tries to bind the udp instance according to the configured port allocation strategy.

Parameters

[in]	InstanceList	Pointer to the head of the list linking the udp instances.
[in]	ConfigData	Pointer to the ConfigData of the instance to be bound.

Return values

EFI_SUCCESS	The bound operation completed successfully.
EFI_ACCESS_DENIED	The <Address, Port> specified by the ConfigData is already used by other instance.
EFI_OUT_OF_RESOURCES	No available port resources.

Definition at line 587 of file Udp6Impl.c.

◆ Udp6BuildIp6ConfigData()

VOID Udp6BuildIp6ConfigData	(	IN EFI_UDP6_CONFIG_DATA *	Udp6ConfigData,
		IN OUT EFI_IP6_CONFIG_DATA *	Ip6ConfigData
	)

This function builds the Ip6 configdata from the Udp6ConfigData.

Parameters

[in]	Udp6ConfigData	Pointer to the EFI_UDP6_CONFIG_DATA.
[in,out]	Ip6ConfigData	Pointer to the EFI_IP6_CONFIG_DATA.

Definition at line 726 of file Udp6Impl.c.

◆ 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 is aborted and Token.Event is 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 either completed or was not issued by Transmit() or Receive().

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.

◆ Udp6Checksum()

UINT16 Udp6Checksum	(	IN NET_BUF *	Packet,
		IN UINT16	HeadSum
	)

This function calculates the checksum for the Packet, utilizing the pre-calculated pseudo header to reduce overhead.

Parameters

[in]	Packet	Pointer to the NET_BUF contains the udp datagram.
[in]	HeadSum	Checksum of the pseudo header execpt the length field.

Returns: The 16-bit checksum of this udp datagram.

This function calculates the checksum for the Packet, utilizing the pre-calculated pseudo HeadSum to reduce some overhead.

Parameters

[in]	Packet	Pointer to the NET_BUF contains the udp datagram.
[in]	HeadSum	Checksum of the pseudo header, except the length field.

Returns: The 16-bit checksum of this udp datagram.

Definition at line 916 of file Udp6Impl.c.

◆ Udp6CleanInstance()

VOID Udp6CleanInstance ( IN OUT UDP6_INSTANCE_DATA * Instance )

This function cleans the udp instance.

Parameters

[in,out] Instance Pointer to the UDP6_INSTANCE_DATA to clean.

Definition at line 507 of file Udp6Impl.c.

◆ Udp6CleanService()

VOID Udp6CleanService ( IN OUT UDP6_SERVICE_DATA * Udp6Service )

Clean the Udp service context data.

Parameters

[in,out] Udp6Service Pointer to the UDP6_SERVICE_DATA.

Definition at line 380 of file Udp6Impl.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 IP6 driver to binding 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.

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.

◆ Udp6CreateService()

EFI_STATUS Udp6CreateService	(	IN UDP6_SERVICE_DATA *	Udp6Service,
		IN EFI_HANDLE	ImageHandle,
		IN EFI_HANDLE	ControllerHandle
	)

Create the Udp service context data.

Parameters

[in]	Udp6Service	Pointer to the UDP6_SERVICE_DATA.
[in]	ImageHandle	The image handle of this udp6 driver.
[in]	ControllerHandle	The controller handle this udp6 driver binds on.

Return values

EFI_SUCCESS	The udp6 service context data was created and initialized.
EFI_OUT_OF_RESOURCES	Cannot allocate memory.
Others	An error condition occurred.

Definition at line 285 of file Udp6Impl.c.

◆ Udp6FlushRcvdDgram()

VOID Udp6FlushRcvdDgram ( IN UDP6_INSTANCE_DATA * Instance )

This function removes all the Wrap datas in the RcvdDgramQue.

Parameters

[in] Instance Pointer to the Udp6 Instance.

Definition at line 1180 of file Udp6Impl.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.

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.

◆ Udp6InitInstance()

VOID Udp6InitInstance	(	IN UDP6_SERVICE_DATA *	Udp6Service,
		IN OUT UDP6_INSTANCE_DATA *	Instance
	)

This function initializes the new created udp instance.

Parameters

[in]	Udp6Service	Pointer to the UDP6_SERVICE_DATA.
[in,out]	Instance	Pointer to the un-initialized UDP6_INSTANCE_DATA.

Definition at line 465 of file Udp6Impl.c.

◆ Udp6InstanceCancelToken()

EFI_STATUS Udp6InstanceCancelToken	(	IN UDP6_INSTANCE_DATA *	Instance,
		IN EFI_UDP6_COMPLETION_TOKEN *Token	OPTIONAL
	)

Cancel Udp6 tokens from the Udp6 instance.

Parameters

[in]	Instance	Pointer to the udp instance context data.
[in]	Token	Pointer to the token to be canceled. If NULL, all tokens in this instance will be cancelled. This parameter is optional and may be NULL.

Return values

EFI_SUCCESS	The Token is cancelled.
EFI_NOT_FOUND	The Token is not found.

Definition at line 1212 of file Udp6Impl.c.

◆ Udp6InstanceDeliverDgram()

VOID Udp6InstanceDeliverDgram ( IN UDP6_INSTANCE_DATA * Instance )

This function delivers the received datagrams to the specified instance.

Parameters

[in] Instance Pointer to the instance context data.

Definition at line 1487 of file Udp6Impl.c.

◆ Udp6IsReconfigurable()

BOOLEAN Udp6IsReconfigurable	(	IN EFI_UDP6_CONFIG_DATA *	OldConfigData,
		IN EFI_UDP6_CONFIG_DATA *	NewConfigData
	)

This function is used to check whether the NewConfigData has any un-reconfigurable parameters changed compared to the OldConfigData.

Parameters

[in]	OldConfigData	Pointer to the current ConfigData the udp instance uses.
[in]	NewConfigData	Pointer to the new ConfigData.

Return values

TRUE	The instance is reconfigurable according to NewConfigData.
FALSE	The instance is not reconfigurable according to NewConfigData.

This function is used to check whether the NewConfigData has any un-reconfigurable parameters changed compared to the OldConfigData.

Parameters

[in]	OldConfigData	Pointer to the current ConfigData the udp instance uses.
[in]	NewConfigData	Pointer to the new ConfigData.

Return values

TRUE	The instance is reconfigurable according to the NewConfigData.
FALSE	Otherwise.

Definition at line 662 of file Udp6Impl.c.

◆ Udp6LeaveGroup()

EFI_STATUS EFIAPI Udp6LeaveGroup	(	IN NET_MAP *	Map,
		IN NET_MAP_ITEM *	Item,
		IN VOID *Arg	OPTIONAL
	)

This function removes the multicast group specified by Arg from the Map.

Parameters

[in]	Map	Pointer to the NET_MAP.
[in]	Item	Pointer to the NET_MAP_ITEM.
[in]	Arg	Pointer to the Arg. It is the pointer to a multicast IPv6 Address. This parameter is optional and may be NULL.

Return values

EFI_SUCCESS	The multicast address is removed.
EFI_ABORTED	The specified multicast address is removed, and the Arg is not NULL.

This function removes the multicast group specified by Arg from the Map.

Parameters

[in]	Map	Pointer to the NET_MAP.
[in]	Item	Pointer to the NET_MAP_ITEM.
[in]	Arg	Pointer to the Arg, it's the pointer to a multicast IPv6 Address. This parameter is optional and may be NULL.

Return values

EFI_SUCCESS	The multicast address is removed.
EFI_ABORTED	The specified multicast address is removed, and the Arg is not NULL.

Definition at line 1074 of file Udp6Impl.c.

◆ Udp6NetVectorExtFree()

VOID EFIAPI Udp6NetVectorExtFree ( IN VOID * Context )

This function is a dummy ext-free function for the NET_BUF created for the output udp datagram.

Parameters

[in] Context Pointer to the context data.

Definition at line 1949 of file Udp6Impl.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 is 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.

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.

◆ Udp6RemoveToken()

EFI_STATUS Udp6RemoveToken	(	IN NET_MAP *	TokenMap,
		IN EFI_UDP6_COMPLETION_TOKEN *	Token
	)

This function removes the specified Token from the TokenMap.

Parameters

[in]	TokenMap	Pointer to the NET_MAP containing the tokens.
[in]	Token	Pointer to the Token to be removed.

Return values

EFI_SUCCESS	The specified Token is removed from the TokenMap.
EFI_NOT_FOUND	The specified Token is not found in the TokenMap.

Definition at line 942 of file Udp6Impl.c.

◆ Udp6ReportIcmpError()

VOID Udp6ReportIcmpError ( IN UDP6_INSTANCE_DATA * Instance )

This function reports the received ICMP error.

Parameters

[in] Instance Pointer to the udp instance context data.

Definition at line 1906 of file Udp6Impl.c.

◆ Udp6TokenExist()

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

This function checks whether the specified Token duplicates with the one in the Map.

Parameters

[in]	Map	Pointer to the NET_MAP.
[in]	Item	Pointer to the NET_MAP_ITEM contain the pointer to the Token.
[in]	Context	Pointer to the Token to be checked.

Return values

EFI_SUCCESS	The Token specified by Context differs from the one in the Item.
EFI_ACCESS_DENIED	The Token duplicates with the one in the Item.

This function checks whether the specified Token duplicates the one in the Map.

Parameters

[in]	Map	Pointer to the NET_MAP.
[in]	Item	Pointer to the NET_MAP_ITEM contain the pointer to the Token.
[in]	Context	Pointer to the Token to be checked.

Return values

EFI_SUCCESS	The Token specified by Context differs from the one in the Item.
EFI_ACCESS_DENIED	The Token duplicates with the one in the Item.

Definition at line 881 of file Udp6Impl.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 has been 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.

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.

◆ Udp6ValidateTxToken()

EFI_STATUS Udp6ValidateTxToken	(	IN UDP6_INSTANCE_DATA *	Instance,
		IN EFI_UDP6_COMPLETION_TOKEN *	TxToken
	)

This function validates the TxToken, it returns the error code according to the spec.

Parameters

[in]	Instance	Pointer to the udp instance context data.
[in]	TxToken	Pointer to the token to be checked.

Return values

EFI_SUCCESS	The TxToken is valid.
EFI_INVALID_PARAMETER	One or more of the following are TRUE: 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. UdpSessionData.DestinationAddress are not valid unicast IPv6 addresses if the UdpSessionData is not NULL. UdpSessionData.DestinationPort and ConfigData.RemotePort are all zero if the UdpSessionData is not NULL.
EFI_BAD_BUFFER_SIZE	The data length is greater than the maximum UDP packet size.

This function validates the TxToken. It returns the error code according to the spec.

Parameters

[in]	Instance	Pointer to the udp instance context data.
[in]	TxToken	Pointer to the token to be checked.

Return values

EFI_SUCCESS	The TxToken is valid.
EFI_INVALID_PARAMETER	One or more of the following are TRUE: 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; UdpSessionData.DestinationAddress are not valid unicast IPv6 addresses if the UdpSessionData is not NULL; UdpSessionData.DestinationPort and ConfigData.RemotePort are all zero if the UdpSessionData is not NULL.
EFI_BAD_BUFFER_SIZE	The data length is greater than the maximum UDP packet size.

Definition at line 776 of file Udp6Impl.c.

Variable Documentation

◆ gUdp6ComponentName

EFI_COMPONENT_NAME_PROTOCOL gUdp6ComponentName

extern

Definition at line 144 of file ComponentName.c.

◆ gUdp6ComponentName2

EFI_COMPONENT_NAME2_PROTOCOL gUdp6ComponentName2

extern

Definition at line 153 of file ComponentName.c.

◆ gUdp6ControllerNameTable

EFI_UNICODE_STRING_TABLE* gUdp6ControllerNameTable

extern

Definition at line 170 of file ComponentName.c.

◆ mUdp6Protocol

EFI_UDP6_PROTOCOL mUdp6Protocol

extern

Definition at line 12 of file Udp6Main.c.

◆ mUdp6RandomPort

UINT16 mUdp6RandomPort

extern

Definition at line 12 of file Udp6Impl.c.

◆ mUdp6ServiceBinding

EFI_SERVICE_BINDING_PROTOCOL mUdp6ServiceBinding

extern

Definition at line 21 of file Udp6Driver.c.

Data Structures

Macros

Typedefs

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ UDP6_HEADER_SIZE

◆ UDP6_INSTANCE_DATA_FROM_THIS

◆ UDP6_INSTANCE_DATA_SIGNATURE

◆ UDP6_MAX_DATA_SIZE

◆ UDP6_PORT_KNOWN

◆ UDP6_SERVICE_DATA_FROM_THIS

◆ UDP6_SERVICE_DATA_SIGNATURE

◆ UDP6_TIMEOUT_INTERVAL

Function Documentation

◆ Udp6Bind()

◆ Udp6BuildIp6ConfigData()

◆ Udp6Cancel()

◆ Udp6Checksum()

◆ Udp6CleanInstance()

◆ Udp6CleanService()

◆ Udp6Configure()

◆ Udp6CreateService()

◆ Udp6FlushRcvdDgram()

◆ Udp6GetModeData()

◆ Udp6Groups()

◆ Udp6InitInstance()

◆ Udp6InstanceCancelToken()

◆ Udp6InstanceDeliverDgram()

◆ Udp6IsReconfigurable()

◆ Udp6LeaveGroup()

◆ Udp6NetVectorExtFree()

◆ Udp6Poll()

◆ Udp6Receive()

◆ Udp6RemoveToken()

◆ Udp6ReportIcmpError()

◆ Udp6TokenExist()

◆ Udp6Transmit()

◆ Udp6ValidateTxToken()

Variable Documentation

◆ gUdp6ComponentName

◆ gUdp6ComponentName2

◆ gUdp6ControllerNameTable

◆ mUdp6Protocol

◆ mUdp6RandomPort

◆ mUdp6ServiceBinding