Functions
VOID	Dhcp6CleanupRetry (IN DHCP6_INSTANCE *Instance, IN UINT32 Scope)

VOID	Dhcp6CleanupSession (IN OUT DHCP6_INSTANCE *Instance, IN EFI_STATUS Status)

EFI_STATUS	Dhcp6SendSolicitMsg (IN DHCP6_INSTANCE *Instance)

EFI_STATUS	Dhcp6SendRequestMsg (IN DHCP6_INSTANCE *Instance)

EFI_STATUS	Dhcp6SendRenewRebindMsg (IN DHCP6_INSTANCE *Instance, IN BOOLEAN RebindRequest)

EFI_STATUS	Dhcp6SendDeclineMsg (IN DHCP6_INSTANCE Instance, IN EFI_DHCP6_IA DecIa)

EFI_STATUS	Dhcp6SendReleaseMsg (IN DHCP6_INSTANCE Instance, IN EFI_DHCP6_IA RelIa)

EFI_STATUS	Dhcp6StartInfoRequest (IN DHCP6_INSTANCE Instance, IN BOOLEAN SendClientId, IN EFI_DHCP6_PACKET_OPTION OptionRequest, IN UINT32 OptionCount, IN EFI_DHCP6_PACKET_OPTION OptionList[] OPTIONAL, IN EFI_DHCP6_RETRANSMISSION Retransmission, IN EFI_EVENT TimeoutEvent OPTIONAL, IN EFI_DHCP6_INFO_CALLBACK ReplyCallback, IN VOID *CallbackContext OPTIONAL)

EFI_STATUS	Dhcp6SendInfoRequestMsg (IN DHCP6_INSTANCE Instance, IN DHCP6_INF_CB InfCb, IN BOOLEAN SendClientId, IN EFI_DHCP6_PACKET_OPTION OptionRequest, IN UINT32 OptionCount, IN EFI_DHCP6_PACKET_OPTION OptionList[], IN EFI_DHCP6_RETRANSMISSION *Retransmission)

VOID EFIAPI	Dhcp6ReceivePacket (IN NET_BUF Udp6Wrap, IN UDP_END_POINT EndPoint, IN EFI_STATUS IoStatus, IN VOID *Context)

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

EFI_STATUS	Dhcp6SeekInnerOptionSafe (IN UINT16 IaType, IN UINT8 Option, IN UINT32 OptionLen, OUT UINT8 IaInnerOpt, OUT UINT16 IaInnerLen)

Detailed Description

Dhcp6 internal functions declaration.

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

Definition in file Dhcp6Io.h.

Function Documentation

◆ Dhcp6CleanupRetry()

VOID Dhcp6CleanupRetry	(	IN DHCP6_INSTANCE *	Instance,
		IN UINT32	Scope
	)

Clean up the specific nodes in the retry list.

Parameters

[in]	Instance	The pointer to the Dhcp6 instance.
[in]	Scope	The scope of cleanup nodes.

Definition at line 292 of file Dhcp6Io.c.

◆ Dhcp6CleanupSession()

VOID Dhcp6CleanupSession	(	IN OUT DHCP6_INSTANCE *	Instance,
		IN EFI_STATUS	Status
	)

Clean up the session of the instance stateful exchange.

Parameters

[in,out]	Instance	The pointer to the Dhcp6 instance.
[in]	Status	The return status from udp.

Definition at line 387 of file Dhcp6Io.c.

◆ Dhcp6OnTimerTick()

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

The timer routine of the Dhcp6 instance for each second.

Parameters

[in]	Event	The timer event.
[in]	Context	The opaque parameter to the function.

Definition at line 3194 of file Dhcp6Io.c.

◆ Dhcp6ReceivePacket()

VOID EFIAPI Dhcp6ReceivePacket	(	IN NET_BUF *	Udp6Wrap,
		IN UDP_END_POINT *	EndPoint,
		IN EFI_STATUS	IoStatus,
		IN VOID *	Context
	)

The receive callback function for the Dhcp6 exchange process.

Parameters

[in]	Udp6Wrap	The pointer to the received net buffer.
[in]	EndPoint	The pointer to the udp end point.
[in]	IoStatus	The return status from udp io.
[in]	Context	The opaque parameter to the function.

The receive callback function for Dhcp6 exchange process.

Parameters

[in]	Udp6Wrap	The pointer to the received net buffer.
[in]	EndPoint	The pointer to the udp end point.
[in]	IoStatus	The return status from udp io.
[in]	Context	The opaque parameter to the function.

Definition at line 3007 of file Dhcp6Io.c.

◆ Dhcp6SeekInnerOptionSafe()

EFI_STATUS Dhcp6SeekInnerOptionSafe	(	IN UINT16	IaType,
		IN UINT8 *	Option,
		IN UINT32	OptionLen,
		OUT UINT8 **	IaInnerOpt,
		OUT UINT16 *	IaInnerLen
	)

Seeks the Inner Options from a DHCP6 Option

Parameters

[in]	IaType	The type of the IA option.
[in]	Option	The pointer to the DHCP6 Option.
[in]	OptionLen	The length of the DHCP6 Option.
[out]	IaInnerOpt	The pointer to the IA inner option.
[out]	IaInnerLen	The length of the IA inner option.

Return values

EFI_SUCCESS	Seek the inner option successfully.
EFI_DEVICE_ERROR	The OptionLen is invalid. On Error, the pointers are not modified

Definition at line 705 of file Dhcp6Io.c.

◆ Dhcp6SendDeclineMsg()

EFI_STATUS Dhcp6SendDeclineMsg	(	IN DHCP6_INSTANCE *	Instance,
		IN EFI_DHCP6_IA *	DecIa
	)

Create the decline message and send it.

Parameters

[in]	Instance	The pointer to the Dhcp6 instance.
[in]	DecIa	The pointer to the decline Ia.

Return values

EFI_SUCCESS	Create and send the decline message successfully.
EFI_OUT_OF_RESOURCES	Required system resources could not be allocated.
EFI_DEVICE_ERROR	An unexpected error.
Others	Failed to send the decline message.

Create the decline message and send it.

Parameters

[in]	Instance	The pointer to the Dhcp6 instance.
[in]	DecIa	The pointer to the decline Ia.

Return values

EFI_SUCCESS	Created and sent the decline message successfully.
EFI_OUT_OF_RESOURCES	Required system resources could not be allocated.
EFI_DEVICE_ERROR	An unexpected error.
Others	Failed to send the decline message.

Definition at line 1367 of file Dhcp6Io.c.

◆ Dhcp6SendInfoRequestMsg()

EFI_STATUS Dhcp6SendInfoRequestMsg	(	IN DHCP6_INSTANCE *	Instance,
		IN DHCP6_INF_CB *	InfCb,
		IN BOOLEAN	SendClientId,
		IN EFI_DHCP6_PACKET_OPTION *	OptionRequest,
		IN UINT32	OptionCount,
		IN EFI_DHCP6_PACKET_OPTION *	OptionList[],
		IN EFI_DHCP6_RETRANSMISSION *	Retransmission
	)

Create the information request message and send it.

Parameters

[in]	Instance	The pointer to the Dhcp6 instance.
[in]	InfCb	The pointer to the information request control block.
[in]	SendClientId	If TRUE, the client identifier option will be included in information request message. Otherwise, the client identifier option will not be included.
[in]	OptionRequest	The pointer to the option request option.
[in]	OptionCount	The number options in the OptionList.
[in]	OptionList	The array pointers to the appended options.
[in]	Retransmission	The pointer to the retransmission control.

Return values

EFI_SUCCESS	Create and send the info-request message successfully.
EFI_OUT_OF_RESOURCES	Required system resources could not be allocated.
Others	Failed to send the info-request message.

Create the information request message and send it.

Parameters

[in]	Instance	The pointer to the Dhcp6 instance.
[in]	InfCb	The pointer to the information request control block.
[in]	SendClientId	If TRUE, the client identifier option will be included in information request message. Otherwise, the client identifier option will not be included.
[in]	OptionRequest	The pointer to the option request option.
[in]	OptionCount	The number options in the OptionList.
[in]	OptionList	The array pointers to the appended options.
[in]	Retransmission	The pointer to the retransmission control.

Return values

EFI_SUCCESS	Created and sent the info-request message successfully.
EFI_OUT_OF_RESOURCES	Required system resources could not be allocated.
Others	Failed to send the info-request message.

Definition at line 1987 of file Dhcp6Io.c.

◆ Dhcp6SendReleaseMsg()

EFI_STATUS Dhcp6SendReleaseMsg	(	IN DHCP6_INSTANCE *	Instance,
		IN EFI_DHCP6_IA *	RelIa
	)

Create the release message and send it.

Parameters

[in]	Instance	The pointer to the Dhcp6 instance.
[in]	RelIa	The pointer to the release Ia.

Return values

EFI_SUCCESS	Create and send the release message successfully.
EFI_OUT_OF_RESOURCES	Required system resources could not be allocated.
EFI_DEVICE_ERROR	An unexpected error.
Others	Failed to send the release message.

Create the release message and send it.

Parameters

[in]	Instance	The pointer to the Dhcp6 instance.
[in]	RelIa	The pointer to the release Ia.

Return values

EFI_SUCCESS	Created and sent the release message successfully.
EFI_OUT_OF_RESOURCES	Required system resources could not be allocated.
EFI_DEVICE_ERROR	An unexpected error.
Others	Failed to send the release message.

Definition at line 1527 of file Dhcp6Io.c.

◆ Dhcp6SendRenewRebindMsg()

EFI_STATUS Dhcp6SendRenewRebindMsg	(	IN DHCP6_INSTANCE *	Instance,
		IN BOOLEAN	RebindRequest
	)

Create the renew/rebind message and send it.

Parameters

[in]	Instance	The pointer to the Dhcp6 instance.
[in]	RebindRequest	If TRUE, it is a Rebind type message. Otherwise, it is a Renew type message.

Return values

EFI_SUCCESS	Create and send the renew/rebind message successfully.
EFI_OUT_OF_RESOURCES	Required system resources could not be allocated.
EFI_DEVICE_ERROR	An unexpected error.
Others	Failed to send the renew/rebind message.

Create the renew/rebind message and send it.

Parameters

[in]	Instance	The pointer to the Dhcp6 instance.
[in]	RebindRequest	If TRUE, it is a Rebind type message. Otherwise, it is a Renew type message.

Return values

EFI_SUCCESS	Created and sent the renew/rebind message successfully.
EFI_OUT_OF_RESOURCES	Required system resources could not be allocated.
EFI_DEVICE_ERROR	An unexpected error.
Others	Failed to send the renew/rebind message.

Definition at line 1683 of file Dhcp6Io.c.

◆ Dhcp6SendRequestMsg()

EFI_STATUS Dhcp6SendRequestMsg ( IN DHCP6_INSTANCE * Instance )

Create the request message and send it.

Parameters

[in] Instance The pointer to the Dhcp6 instance.

Return values

EFI_SUCCESS	Create and send the request message successfully.
EFI_OUT_OF_RESOURCES	Required system resources could not be allocated.
EFI_DEVICE_ERROR	An unexpected error.
Others	Failed to send the request message.

Create the request message and send it.

Parameters

[in] Instance The pointer to the Dhcp6 instance.

Return values

EFI_SUCCESS	Created and sent the request message successfully.
EFI_OUT_OF_RESOURCES	Required system resources could not be allocated.
EFI_DEVICE_ERROR	An unexpected error.
Others	Failed to send the request message.

Definition at line 1183 of file Dhcp6Io.c.

◆ Dhcp6SendSolicitMsg()

EFI_STATUS Dhcp6SendSolicitMsg ( IN DHCP6_INSTANCE * Instance )

Create the solicit message and send it.

Parameters

[in] Instance The pointer to Dhcp6 instance.

Return values

EFI_SUCCESS	Create and send the solicit message successfully.
EFI_OUT_OF_RESOURCES	Required system resources could not be allocated.
Others	Failed to send the solicit message.

Create the solicit message and send it.

Parameters

[in] Instance The pointer to the Dhcp6 instance.

Return values

EFI_SUCCESS	Created and sent the solicit message successfully.
EFI_OUT_OF_RESOURCES	Required system resources could not be allocated.
Others	Failed to send the solicit message.

Definition at line 1005 of file Dhcp6Io.c.

◆ Dhcp6StartInfoRequest()

EFI_STATUS Dhcp6StartInfoRequest	(	IN DHCP6_INSTANCE *	Instance,
		IN BOOLEAN	SendClientId,
		IN EFI_DHCP6_PACKET_OPTION *	OptionRequest,
		IN UINT32	OptionCount,
		IN EFI_DHCP6_PACKET_OPTION *OptionList[]	OPTIONAL,
		IN EFI_DHCP6_RETRANSMISSION *	Retransmission,
		IN EFI_EVENT TimeoutEvent	OPTIONAL,
		IN EFI_DHCP6_INFO_CALLBACK	ReplyCallback,
		IN VOID *CallbackContext	OPTIONAL
	)

Start the information request process.

Parameters

[in]	Instance	The pointer to the Dhcp6 instance.
[in]	SendClientId	If TRUE, the client identifier option will be included in information request message. Otherwise, the client identifier option will not be included.
[in]	OptionRequest	The pointer to the option request option.
[in]	OptionCount	The number options in the OptionList.
[in]	OptionList	The array pointers to the appended options.
[in]	Retransmission	The pointer to the retransmission control.
[in]	TimeoutEvent	The event of timeout.
[in]	ReplyCallback	The callback function when the reply was received.
[in]	CallbackContext	The pointer to the parameter passed to the callback.

Return values

EFI_SUCCESS	Start the info-request process successfully.
EFI_OUT_OF_RESOURCES	Required system resources could not be allocated.
EFI_NO_MAPPING	No source address is available for use.
Others	Failed to start the info-request process.

Definition at line 1889 of file Dhcp6Io.c.

Functions

Detailed Description

Function Documentation

◆ Dhcp6CleanupRetry()

◆ Dhcp6CleanupSession()

◆ Dhcp6OnTimerTick()

◆ Dhcp6ReceivePacket()

◆ Dhcp6SeekInnerOptionSafe()

◆ Dhcp6SendDeclineMsg()

◆ Dhcp6SendInfoRequestMsg()

◆ Dhcp6SendReleaseMsg()

◆ Dhcp6SendRenewRebindMsg()

◆ Dhcp6SendRequestMsg()

◆ Dhcp6SendSolicitMsg()

◆ Dhcp6StartInfoRequest()