Macros
#define	DHCP6_10_BIT_MASK 0x3ff

#define	DHCP6_DAD_ADDITIONAL_DELAY 30000000

Functions
EFI_DHCP6_DUID *	Dhcp6GenerateClientId (IN EFI_SIMPLE_NETWORK_MODE *Mode)

EFI_STATUS	Dhcp6CopyConfigData (IN EFI_DHCP6_CONFIG_DATA DstCfg, IN EFI_DHCP6_CONFIG_DATA SorCfg)

VOID	Dhcp6CleanupConfigData (IN OUT EFI_DHCP6_CONFIG_DATA *CfgData)

VOID	Dhcp6CleanupModeData (IN OUT EFI_DHCP6_MODE_DATA *ModeData)

UINT32	Dhcp6CalculateExpireTime (IN UINT32 Base, IN BOOLEAN IsFirstRt, IN BOOLEAN NeedSigned)

VOID	Dhcp6CalculateLeaseTime (IN DHCP6_IA_CB *IaCb)

EFI_STATUS	Dhcp6CheckAddress (IN EFI_DHCP6_IA Ia, IN UINT32 AddressCount, IN EFI_IPv6_ADDRESS Addresses)

EFI_DHCP6_IA *	Dhcp6DepriveAddress (IN EFI_DHCP6_IA Ia, IN UINT32 AddressCount, IN EFI_IPv6_ADDRESS Addresses)

VOID EFIAPI	Dhcp6DummyExtFree (IN VOID *Arg)

VOID EFIAPI	Dhcp6OnTransmitted (IN NET_BUF Wrap, IN UDP_END_POINT EndPoint, IN EFI_STATUS IoStatus, IN VOID *Context)

EFI_STATUS	Dhcp6AppendOption (IN OUT EFI_DHCP6_PACKET Packet, IN OUT UINT8 PacketCursor, IN UINT16 OptType, IN UINT16 OptLen, IN UINT8 Data)

EFI_STATUS	Dhcp6AppendIaOption (IN OUT EFI_DHCP6_PACKET Packet, IN OUT UINT8 PacketCursor, IN EFI_DHCP6_IA Ia, IN UINT32 T1, IN UINT32 T2, IN UINT32 MessageType)

EFI_STATUS	Dhcp6AppendETOption (IN OUT EFI_DHCP6_PACKET Packet, IN OUT UINT8 PacketCursor, IN DHCP6_INSTANCE Instance, OUT UINT16 **Elapsed)

VOID	SetElapsedTime (IN UINT16 Elapsed, IN DHCP6_INSTANCE Instance)

UINT8 *	Dhcp6SeekOption (IN UINT8 *Buf, IN UINT32 SeekLen, IN UINT16 OptType)

UINT8 *	Dhcp6SeekIaOption (IN UINT8 Buf, IN UINT32 SeekLen, IN EFI_DHCP6_IA_DESCRIPTOR IaDesc)

VOID	Dhcp6ParseAddrOption (IN EFI_DHCP6_IA CurrentIa, IN UINT8 IaInnerOpt, IN UINT16 IaInnerLen, OUT UINT32 AddrNum, IN OUT EFI_DHCP6_IA_ADDRESS AddrBuf)

EFI_STATUS	Dhcp6GenerateIaCb (IN DHCP6_INSTANCE Instance, IN UINT8 IaInnerOpt, IN UINT16 IaInnerLen, IN UINT32 T1, IN UINT32 T2)

EFI_STATUS	Dhcp6CacheIa (IN DHCP6_INSTANCE *Instance)

VOID	Dhcp6AppendCacheIa (IN DHCP6_INSTANCE *Instance)

EFI_STATUS	Dhcp6GetMappingTimeOut (IN EFI_IP6_CONFIG_PROTOCOL Ip6Cfg, OUT UINTN TimeOut)

Detailed Description

Dhcp6 support functions declaration.

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

Definition in file Dhcp6Utility.h.

Macro Definition Documentation

◆ DHCP6_10_BIT_MASK

#define DHCP6_10_BIT_MASK 0x3ff

Definition at line 13 of file Dhcp6Utility.h.

◆ DHCP6_DAD_ADDITIONAL_DELAY

#define DHCP6_DAD_ADDITIONAL_DELAY 30000000

Definition at line 14 of file Dhcp6Utility.h.

Function Documentation

◆ Dhcp6AppendCacheIa()

VOID Dhcp6AppendCacheIa ( IN DHCP6_INSTANCE * Instance )

Append CacheIa to the current IA. Meanwhile, clear CacheIa.ValidLifetime to 0.

Parameters

[in] Instance The pointer to DHCP6 instance.

Definition at line 1440 of file Dhcp6Utility.c.

◆ Dhcp6AppendETOption()

EFI_STATUS Dhcp6AppendETOption	(	IN OUT EFI_DHCP6_PACKET *	Packet,
		IN OUT UINT8 **	PacketCursor,
		IN DHCP6_INSTANCE *	Instance,
		OUT UINT16 **	Elapsed
	)

Append the appointed Elapsed time option to Buf, and move Buf to the end.

Parameters

[in,out]	Packet	A pointer to the packet, on success Packet->Length
[in,out]	PacketCursor	The pointer in the packet, on success PacketCursor will be moved to the end of the option.
[in]	Instance	The pointer to the Dhcp6 instance.
[out]	Elapsed	The pointer to the elapsed time value in the generated packet.

Return values

EFI_INVALID_PARAMETER	An argument provided to the function was invalid
EFI_BUFFER_TOO_SMALL	The buffer is too small to append the option.
EFI_SUCCESS	The option is appended successfully.

Append the appointed Elapsed time option to Buf, and move Buf to the end.

Parameters

[in,out]	Packet	A pointer to the packet, on success Packet->Length will be updated.
[in,out]	PacketCursor	The pointer in the packet, on success PacketCursor will be moved to the end of the option.
[in]	Instance	The pointer to the Dhcp6 instance.
[out]	Elapsed	The pointer to the elapsed time value in the generated packet.

Return values

EFI_INVALID_PARAMETER	An argument provided to the function was invalid
EFI_BUFFER_TOO_SMALL	The buffer is too small to append the option.
EFI_SUCCESS	The option is appended successfully.

Definition at line 968 of file Dhcp6Utility.c.

◆ Dhcp6AppendIaOption()

EFI_STATUS Dhcp6AppendIaOption	(	IN OUT EFI_DHCP6_PACKET *	Packet,
		IN OUT UINT8 **	PacketCursor,
		IN EFI_DHCP6_IA *	Ia,
		IN UINT32	T1,
		IN UINT32	T2,
		IN UINT32	MessageType
	)

Append the appointed Ia option to Buf, update the Ia option length, and move Buf to the end of the option.

Parameters

[in,out]	Packet	A pointer to the packet, on success Packet->Length will be updated.
[in,out]	PacketCursor	The pointer in the packet, on success PacketCursor will be moved to the end of the option.
[in]	Ia	The pointer to the Ia.
[in]	T1	The time of T1.
[in]	T2	The time of T2.
[in]	MessageType	Message type of DHCP6 package.

Return values

EFI_INVALID_PARAMETER	An argument provided to the function was invalid
EFI_BUFFER_TOO_SMALL	The buffer is too small to append the option.
EFI_SUCCESS	The option is appended successfully.

Append the appointed Ia option to Buf, and move Buf to the end.

Parameters

[in,out]	Packet	A pointer to the packet, on success Packet->Length will be updated.
[in,out]	PacketCursor	The pointer in the packet, on success PacketCursor will be moved to the end of the option.
[in]	Ia	The pointer to the Ia.
[in]	T1	The time of T1.
[in]	T2	The time of T2.
[in]	MessageType	Message type of DHCP6 package.

Return values

EFI_INVALID_PARAMETER	An argument provided to the function was invalid
EFI_BUFFER_TOO_SMALL	The buffer is too small to append the option.
EFI_SUCCESS	The option is appended successfully.

Definition at line 824 of file Dhcp6Utility.c.

◆ Dhcp6AppendOption()

EFI_STATUS Dhcp6AppendOption	(	IN OUT EFI_DHCP6_PACKET *	Packet,
		IN OUT UINT8 **	PacketCursor,
		IN UINT16	OptType,
		IN UINT16	OptLen,
		IN UINT8 *	Data
	)

Append the option to Buf, update the length of packet, and move Buf to the end.

Parameters

[in,out]	Packet	A pointer to the packet, on success Packet->Length will be updated.
[in,out]	PacketCursor	The pointer in the packet, on success PacketCursor will be moved to the end of the option.
[in]	OptType	The option type.
[in]	OptLen	The length of option contents.
[in]	Data	The pointer to the option content.

Return values

EFI_INVALID_PARAMETER	An argument provided to the function was invalid
EFI_BUFFER_TOO_SMALL	The buffer is too small to append the option.
EFI_SUCCESS	The option is appended successfully.

Definition at line 606 of file Dhcp6Utility.c.

◆ Dhcp6CacheIa()

EFI_STATUS Dhcp6CacheIa ( IN DHCP6_INSTANCE * Instance )

Cache the current IA configuration information.

Parameters

[in] Instance The pointer to DHCP6 Instance.

Return values

EFI_SUCCESS	Cache the current IA successfully.
EFI_OUT_OF_RESOURCES	Required system resources could not be allocated.

Definition at line 1407 of file Dhcp6Utility.c.

◆ Dhcp6CalculateExpireTime()

UINT32 Dhcp6CalculateExpireTime	(	IN UINT32	Base,
		IN BOOLEAN	IsFirstRt,
		IN BOOLEAN	NeedSigned
	)

Calculate the expire time by the algorithm defined in rfc.

Parameters

[in]	Base	The base value of the time.
[in]	IsFirstRt	If TRUE, it is the first time to calculate expire time.
[in]	NeedSigned	If TRUE, the signed factor is needed.

Returns: Expire The calculated result for the new expire time.

Definition at line 321 of file Dhcp6Utility.c.

◆ Dhcp6CalculateLeaseTime()

VOID Dhcp6CalculateLeaseTime ( IN DHCP6_IA_CB * IaCb )

Calculate the lease time by the algorithm defined in rfc.

Parameters

[in] IaCb The pointer to the Ia control block.

Definition at line 372 of file Dhcp6Utility.c.

◆ Dhcp6CheckAddress()

EFI_STATUS Dhcp6CheckAddress	(	IN EFI_DHCP6_IA *	Ia,
		IN UINT32	AddressCount,
		IN EFI_IPv6_ADDRESS *	Addresses
	)

Check whether the addresses are all included by the configured Ia.

Parameters

[in]	Ia	The pointer to the Ia.
[in]	AddressCount	The number of addresses.
[in]	Addresses	The pointer to the addresses buffer.

Return values

EFI_SUCCESS	The addresses are all included by the configured IA.
EFI_NOT_FOUND	The addresses are not included by the configured IA.

Definition at line 416 of file Dhcp6Utility.c.

◆ Dhcp6CleanupConfigData()

VOID Dhcp6CleanupConfigData ( IN OUT EFI_DHCP6_CONFIG_DATA * CfgData )

Clean up the configure data.

Parameters

[in,out] CfgData The pointer to the configure data.

Definition at line 251 of file Dhcp6Utility.c.

◆ Dhcp6CleanupModeData()

VOID Dhcp6CleanupModeData ( IN OUT EFI_DHCP6_MODE_DATA * ModeData )

Clean up the mode data.

Parameters

[in,out] ModeData The pointer to the mode data.

Definition at line 286 of file Dhcp6Utility.c.

◆ Dhcp6CopyConfigData()

EFI_STATUS Dhcp6CopyConfigData	(	IN EFI_DHCP6_CONFIG_DATA *	DstCfg,
		IN EFI_DHCP6_CONFIG_DATA *	SorCfg
	)

Copy the Dhcp6 configure data.

Parameters

[in]	DstCfg	The pointer to the destination configure data.
[in]	SorCfg	The pointer to the source configure data.

Return values

EFI_SUCCESS	Copy the content from SorCfg from DstCfg successfully.
EFI_OUT_OF_RESOURCES	Required system resources could not be allocated.

Definition at line 180 of file Dhcp6Utility.c.

◆ Dhcp6DepriveAddress()

EFI_DHCP6_IA * Dhcp6DepriveAddress	(	IN EFI_DHCP6_IA *	Ia,
		IN UINT32	AddressCount,
		IN EFI_IPv6_ADDRESS *	Addresses
	)

Deprive the addresses from current Ia, and generate another eliminated Ia.

Parameters

[in]	Ia	The pointer to the Ia.
[in]	AddressCount	The number of addresses.
[in]	Addresses	The pointer to the addresses buffer.

Return values

NULL	If failed to generate the deprived Ia.
others	The pointer to the deprived Ia.

Deprive the addresses from current Ia, and generate another eliminated Ia.

Parameters

[in]	Ia	The pointer to the Ia.
[in]	AddressCount	The number of addresses.
[in]	Addresses	The pointer to the addresses buffer.

Return values

NULL	If it failed to generate the deprived Ia.
others	The pointer to the deprived Ia.

Definition at line 465 of file Dhcp6Utility.c.

◆ Dhcp6DummyExtFree()

VOID EFIAPI Dhcp6DummyExtFree ( IN VOID * Arg )

The dummy ext buffer free callback routine.

Parameters

[in] Arg The pointer to the parameter.

Definition at line 562 of file Dhcp6Utility.c.

◆ Dhcp6GenerateClientId()

EFI_DHCP6_DUID * Dhcp6GenerateClientId ( IN EFI_SIMPLE_NETWORK_MODE * Mode )

Generate client Duid in the format of Duid-llt.

Parameters

[in] Mode The pointer to the mode of SNP.

Return values

NULL	if failed to generate client Id.
Others	The pointer to the new client id.

Generate client Duid in the format of Duid-llt.

Parameters

[in] Mode The pointer to the mode of SNP.

Return values

NULL	If it failed to generate a client Id.
others	The pointer to the new client id.

Definition at line 33 of file Dhcp6Utility.c.

◆ Dhcp6GenerateIaCb()

EFI_STATUS Dhcp6GenerateIaCb	(	IN DHCP6_INSTANCE *	Instance,
		IN UINT8 *	IaInnerOpt,
		IN UINT16	IaInnerLen,
		IN UINT32	T1,
		IN UINT32	T2
	)

Create a control block for the Ia according to the corresponding options.

Parameters

[in]	Instance	The pointer to DHCP6 Instance.
[in]	IaInnerOpt	The pointer to the inner options in the Ia option.
[in]	IaInnerLen	The length of all the inner options in the Ia option.
[in]	T1	T1 time in the Ia option.
[in]	T2	T2 time in the Ia option.

Return values

EFI_NOT_FOUND	No valid IA option is found.
EFI_SUCCESS	Create an IA control block successfully.
EFI_OUT_OF_RESOURCES	Required system resources could not be allocated.
EFI_DEVICE_ERROR	An unexpected error.

Definition at line 1326 of file Dhcp6Utility.c.

◆ Dhcp6GetMappingTimeOut()

EFI_STATUS Dhcp6GetMappingTimeOut	(	IN EFI_IP6_CONFIG_PROTOCOL *	Ip6Cfg,
		OUT UINTN *	TimeOut
	)

Calculate the Dhcp6 get mapping timeout by adding additional delay to the IP6 DAD transmits count.

Parameters

[in]	Ip6Cfg	The pointer to Ip6 config protocol.
[out]	TimeOut	The time out value in 100ns units.

Return values

EFI_INVALID_PARAMETER	Input parameters are invalid.
EFI_SUCCESS	Calculate the time out value successfully.

Definition at line 1499 of file Dhcp6Utility.c.

◆ Dhcp6OnTransmitted()

VOID EFIAPI Dhcp6OnTransmitted	(	IN NET_BUF *	Wrap,
		IN UDP_END_POINT *	EndPoint,
		IN EFI_STATUS	IoStatus,
		IN VOID *	Context
	)

The callback routine once message transmitted.

Parameters

[in]	Wrap	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 579 of file Dhcp6Utility.c.

◆ Dhcp6ParseAddrOption()

VOID Dhcp6ParseAddrOption	(	IN EFI_DHCP6_IA *	CurrentIa,
		IN UINT8 *	IaInnerOpt,
		IN UINT16	IaInnerLen,
		OUT UINT32 *	AddrNum,
		IN OUT EFI_DHCP6_IA_ADDRESS *	AddrBuf
	)

Parse the address option and update the address info.

Parameters

[in]	CurrentIa	The pointer to the Ia Address in control block.
[in]	IaInnerOpt	The pointer to the buffer.
[in]	IaInnerLen	The length to parse.
[out]	AddrNum	The number of addresses.
[in,out]	AddrBuf	The pointer to the address buffer.

Parse the address option and update the address information.

Parameters

[in]	CurrentIa	The pointer to the Ia Address in control block.
[in]	IaInnerOpt	The pointer to the buffer.
[in]	IaInnerLen	The length to parse.
[out]	AddrNum	The number of addresses.
[in,out]	AddrBuf	The pointer to the address buffer.

Definition at line 1235 of file Dhcp6Utility.c.

◆ Dhcp6SeekIaOption()

UINT8 * Dhcp6SeekIaOption	(	IN UINT8 *	Buf,
		IN UINT32	SeekLen,
		IN EFI_DHCP6_IA_DESCRIPTOR *	IaDesc
	)

Seek the address of the first byte of the Ia option header.

Parameters

[in]	Buf	The pointer to the buffer.
[in]	SeekLen	The length to seek.
[in]	IaDesc	The pointer to the Ia descriptor.

Return values

NULL	If failed to seek the Ia option.
others	The position to the Ia option.

Seek the address of the first byte of the Ia option header.

Parameters

[in]	Buf	The pointer to the buffer.
[in]	SeekLen	The length to seek.
[in]	IaDesc	The pointer to the Ia descriptor.

Return values

NULL	If it failed to seek the Ia option.
others	The position to the Ia option.

Definition at line 1161 of file Dhcp6Utility.c.

◆ Dhcp6SeekOption()

UINT8 * Dhcp6SeekOption	(	IN UINT8 *	Buf,
		IN UINT32	SeekLen,
		IN UINT16	OptType
	)

Seek the address of the first byte of the option header.

Parameters

[in]	Buf	The pointer to buffer.
[in]	SeekLen	The length to seek.
[in]	OptType	The option type.

Return values

NULL	If failed to seek the option.
others	The position to the option.

Seek the address of the first byte of the option header.

Parameters

[in]	Buf	The pointer to the buffer.
[in]	SeekLen	The length to seek.
[in]	OptType	The option type.

Return values

NULL	If it failed to seek the option.
others	The position to the option.

Definition at line 1118 of file Dhcp6Utility.c.

◆ SetElapsedTime()

VOID SetElapsedTime	(	IN UINT16 *	Elapsed,
		IN DHCP6_INSTANCE *	Instance
	)

Set the elapsed time based on the given instance and the pointer to the elapsed time option.

Return values

EFI_INVALID_PARAMETER	An argument provided to the function was invalid
EFI_BUFFER_TOO_SMALL	The buffer is too small to append the option.
EFI_SUCCESS	The option is appended successfully.

Set the elapsed time based on the given instance and the pointer to the elapsed time option.

Parameters

[in]	Elapsed	The pointer to the position to append.
[in]	Instance	The pointer to the Dhcp6 instance.

Definition at line 1062 of file Dhcp6Utility.c.

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ DHCP6_10_BIT_MASK

◆ DHCP6_DAD_ADDITIONAL_DELAY

Function Documentation

◆ Dhcp6AppendCacheIa()

◆ Dhcp6AppendETOption()

◆ Dhcp6AppendIaOption()

◆ Dhcp6AppendOption()

◆ Dhcp6CacheIa()

◆ Dhcp6CalculateExpireTime()

◆ Dhcp6CalculateLeaseTime()

◆ Dhcp6CheckAddress()

◆ Dhcp6CleanupConfigData()

◆ Dhcp6CleanupModeData()

◆ Dhcp6CopyConfigData()

◆ Dhcp6DepriveAddress()

◆ Dhcp6DummyExtFree()

◆ Dhcp6GenerateClientId()

◆ Dhcp6GenerateIaCb()

◆ Dhcp6GetMappingTimeOut()

◆ Dhcp6OnTransmitted()

◆ Dhcp6ParseAddrOption()

◆ Dhcp6SeekIaOption()

◆ Dhcp6SeekOption()

◆ SetElapsedTime()