#include "UefiShellNetwork2CommandsLib.h"

Go to the source code of this file.

Data Structures
struct	_IFCONFIG6_INTERFACE_CB

struct	_ARG_LIST

struct	_IFCONFIG6_PRIVATE_DATA

struct	_VAR_CHECK_ITEM

Macros
#define	MACADDRMAXSIZE 32

#define	PREFIXMAXLEN 16

Typedefs
typedef struct _IFCONFIG6_INTERFACE_CB	IFCONFIG6_INTERFACE_CB

typedef struct _ARG_LIST	ARG_LIST

typedef struct _IFCONFIG6_PRIVATE_DATA	IFCONFIG6_PRIVATE_DATA

typedef struct _VAR_CHECK_ITEM	VAR_CHECK_ITEM

Enumerations
enum	{ IfConfig6OpList = 1 , IfConfig6OpSet = 2 , IfConfig6OpClear = 3 }

enum	VAR_CHECK_CODE { VarCheckReserved = -1 , VarCheckOk = 0 , VarCheckDuplicate , VarCheckConflict , VarCheckUnknown , VarCheckLackValue , VarCheckOutOfMem , VarCheckReserved = -1 , VarCheckOk = 0 , VarCheckDuplicate , VarCheckConflict , VarCheckUnknown , VarCheckLackValue , VarCheckOutOfMem }

enum	VAR_CHECK_FLAG_TYPE { FlagTypeSingle = 0 , FlagTypeNeedVar , FlagTypeNeedSet , FlagTypeSkipUnknown , FlagTypeSingle = 0 , FlagTypeNeedVar , FlagTypeNeedSet , FlagTypeSkipUnknown }

Functions
VOID	IfConfig6FreeArgList (ARG_LIST *List)

ARG_LIST *	IfConfig6SplitStrToList (IN CONST CHAR16 *String, IN CHAR16 Separator)

VAR_CHECK_CODE	IfConfig6RetriveCheckListByName (IN VAR_CHECK_ITEM CheckList, IN CHAR16 Name, IN BOOLEAN Init)

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

VOID	IfConfig6PrintMacAddr (IN UINT8 *Node, IN UINT32 Size)

VOID	IfConfig6PrintIpAddr (IN EFI_IPv6_ADDRESS Ip, IN UINT8 PrefixLen)

EFI_STATUS	IfConfig6ParseManualAddressList (IN OUT ARG_LIST Arg, OUT EFI_IP6_CONFIG_MANUAL_ADDRESS Buf, OUT UINTN *BufSize)

EFI_STATUS	IfConfig6ParseGwDnsAddressList (IN OUT ARG_LIST Arg, OUT EFI_IPv6_ADDRESS Buf, OUT UINTN *BufSize)

EFI_STATUS	IfConfig6ParseInterfaceId (IN OUT ARG_LIST Arg, OUT EFI_IP6_CONFIG_INTERFACE_ID IfId)

EFI_STATUS	IfConfig6ParseDadXmits (IN OUT ARG_LIST *Arg, OUT UINT32 Xmits)

EFI_STATUS	IfConfig6GetInterfaceInfo (IN EFI_HANDLE ImageHandle, IN CHAR16 IfName, IN LIST_ENTRY IfList)

SHELL_STATUS	IfConfig6ShowInterfaceInfo (IN LIST_ENTRY *IfList)

SHELL_STATUS	IfConfig6ClearInterfaceInfo (IN LIST_ENTRY IfList, IN CHAR16 IfName)

SHELL_STATUS	IfConfig6SetInterfaceInfo (IN LIST_ENTRY IfList, IN ARG_LIST VarArg)

SHELL_STATUS	IfConfig6 (IN IFCONFIG6_PRIVATE_DATA *Private)

VOID	IfConfig6Cleanup (IN IFCONFIG6_PRIVATE_DATA *Private)

SHELL_STATUS EFIAPI	ShellCommandRunIfconfig6 (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables
SHELL_PARAM_ITEM	mIfConfig6CheckList []

VAR_CHECK_ITEM	mIfConfig6SetCheckList []

Detailed Description

The implementation for Shell command IfConfig6.

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

Definition in file Ifconfig6.c.

Macro Definition Documentation

◆ MACADDRMAXSIZE

#define MACADDRMAXSIZE 32

Definition at line 35 of file Ifconfig6.c.

◆ PREFIXMAXLEN

#define PREFIXMAXLEN 16

Definition at line 36 of file Ifconfig6.c.

Typedef Documentation

◆ ARG_LIST

typedef struct _ARG_LIST ARG_LIST

Definition at line 50 of file Ifconfig6.c.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Definition at line 12 of file Ifconfig6.c.

◆ VAR_CHECK_CODE

enum VAR_CHECK_CODE

Definition at line 18 of file Ifconfig6.c.

◆ VAR_CHECK_FLAG_TYPE

enum VAR_CHECK_FLAG_TYPE

Definition at line 28 of file Ifconfig6.c.

Function Documentation

◆ IfConfig6()

SHELL_STATUS IfConfig6 ( IN IFCONFIG6_PRIVATE_DATA * Private )

The IfConfig6 main process.

Parameters

[in] Private The pointer of IFCONFIG6_PRIVATE_DATA.

Return values

SHELL_SUCCESS	IfConfig6 processed successfully.
others	The IfConfig6 process failed.

Definition at line 1661 of file Ifconfig6.c.

◆ IfConfig6Cleanup()

VOID IfConfig6Cleanup ( IN IFCONFIG6_PRIVATE_DATA * Private )

The IfConfig6 cleanup process, free the allocated memory.

Parameters

[in] Private The pointer of IFCONFIG6_PRIVATE_DATA.

Definition at line 1713 of file Ifconfig6.c.

◆ IfConfig6ClearInterfaceInfo()

SHELL_STATUS IfConfig6ClearInterfaceInfo	(	IN LIST_ENTRY *	IfList,
		IN CHAR16 *	IfName
	)

The clean process of the IfConfig6 application.

Parameters

[in]	IfList	The pointer of IfList(interface list).
[in]	IfName	The pointer of interface name.

Return values

SHELL_SUCCESS	The IfConfig6 clean processed successfully.
others	The IfConfig6 clean process failed.

Definition at line 1106 of file Ifconfig6.c.

◆ IfConfig6FreeArgList()

VOID IfConfig6FreeArgList ( ARG_LIST * List )

Free the ARG_LIST.

Parameters

List	Pointer to ARG_LIST to free.

Definition at line 157 of file Ifconfig6.c.

◆ IfConfig6GetInterfaceInfo()

EFI_STATUS IfConfig6GetInterfaceInfo	(	IN EFI_HANDLE	ImageHandle,
		IN CHAR16 *	IfName,
		IN LIST_ENTRY *	IfList
	)

The get current status of all handles.

Parameters

[in]	ImageHandle	The handle of ImageHandle.
[in]	IfName	The pointer of IfName(interface name).
[in]	IfList	The pointer of IfList(interface list).

Return values

EFI_SUCCESS	The get status processed successfully.
others	The get status process failed.

Definition at line 726 of file Ifconfig6.c.

◆ IfConfig6ManualAddressNotify()

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

The notify function of create event when performing a manual config.

Parameters

[in]	Event	The event this notify function registered to.
[in]	Context	Pointer to the context data registered to the event.

Definition at line 318 of file Ifconfig6.c.

◆ IfConfig6ParseDadXmits()

EFI_STATUS IfConfig6ParseDadXmits	(	IN OUT ARG_LIST **	Arg,
		OUT UINT32 *	Xmits
	)

Parse dad in string format from Args with the "-s" option and convert it to UINT32 format.

Parameters

[in,out]	Arg	The pointer of the address of ARG_LIST that saves Args with the "-s" option.
[out]	Xmits	The pointer of Xmits.

Return values

EFI_SUCCESS	The get status processed successfully.
others	The get status process failed.

Definition at line 686 of file Ifconfig6.c.

◆ IfConfig6ParseGwDnsAddressList()

EFI_STATUS IfConfig6ParseGwDnsAddressList	(	IN OUT ARG_LIST **	Arg,
		OUT EFI_IPv6_ADDRESS **	Buf,
		OUT UINTN *	BufSize
	)

Pick up gw/dns IPv6 address in string format from Args with "-s" option and convert it to EFI_IPv6_ADDRESS format.

Parameters

[in,out]	Arg	The pointer of the address of ARG_LIST that save Args with the "-s" option.
[out]	Buf	The pointer of the address of EFI_IPv6_ADDRESS.
[out]	BufSize	The pointer of BufSize that describes the size of Buf in bytes.

Return values

EFI_SUCCESS	The conversion is successful.
Others	Doesn't find the host address, or it is an invalid IPv6 address in string format.

Definition at line 534 of file Ifconfig6.c.

◆ IfConfig6ParseInterfaceId()

EFI_STATUS IfConfig6ParseInterfaceId	(	IN OUT ARG_LIST **	Arg,
		OUT EFI_IP6_CONFIG_INTERFACE_ID **	IfId
	)

Parse InterfaceId in string format from Args with the "-s" option and convert it to EFI_IP6_CONFIG_INTERFACE_ID format.

Parameters

[in,out]	Arg	The pointer of the address of ARG_LIST that saves Args with the "-s" option.
[out]	IfId	The pointer of EFI_IP6_CONFIG_INTERFACE_ID.

Return values

EFI_SUCCESS	The get status processed successfullly.
EFI_INVALID_PARAMETER	The get status process failed.

Definition at line 628 of file Ifconfig6.c.

◆ IfConfig6ParseManualAddressList()

EFI_STATUS IfConfig6ParseManualAddressList	(	IN OUT ARG_LIST **	Arg,
		OUT EFI_IP6_CONFIG_MANUAL_ADDRESS **	Buf,
		OUT UINTN *	BufSize
	)

Pick up host IPv6 address in string format from Args with "-s" option and convert it to EFI_IP6_CONFIG_MANUAL_ADDRESS format.

Parameters

[in,out]	Arg	The pointer of the address of ARG_LIST which save Args with the "-s" option.
[out]	Buf	The pointer of the address of EFI_IP6_CONFIG_MANUAL_ADDRESS.
[out]	BufSize	The pointer of BufSize that describes the size of Buf in bytes.

Return values

EFI_SUCCESS	The convertion is successful.
Others	Does't find the host address, or it is an invalid IPv6 address in string format.

Definition at line 429 of file Ifconfig6.c.

◆ IfConfig6PrintIpAddr()

VOID IfConfig6PrintIpAddr	(	IN EFI_IPv6_ADDRESS *	Ip,
		IN UINT8 *	PrefixLen
	)

Print IPv6 address.

Parameters

[in]	Ip	The pointer of Ip bufffer in EFI_IPv6_ADDRESS format.
[in]	PrefixLen	The pointer of PrefixLen that describes the size Prefix.

Definition at line 361 of file Ifconfig6.c.

◆ IfConfig6PrintMacAddr()

VOID IfConfig6PrintMacAddr	(	IN UINT8 *	Node,
		IN UINT32	Size
	)

Print MAC address.

Parameters

[in]	Node	The pointer of MAC address buffer.
[in]	Size	The size of MAC address buffer.

Definition at line 334 of file Ifconfig6.c.

◆ IfConfig6RetriveCheckListByName()

VAR_CHECK_CODE IfConfig6RetriveCheckListByName	(	IN VAR_CHECK_ITEM *	CheckList,
		IN CHAR16 *	Name,
		IN BOOLEAN	Init
	)

Check the correctness of input Args with '-s' option.

Parameters

[in]	CheckList	The pointer of VAR_CHECK_ITEM array.
[in]	Name	The pointer of input arg.
[in]	Init	The switch to execute the check.

Returns: The value of VAR_CHECK_CODE.

Definition at line 257 of file Ifconfig6.c.

◆ IfConfig6SetInterfaceInfo()

SHELL_STATUS IfConfig6SetInterfaceInfo	(	IN LIST_ENTRY *	IfList,
		IN ARG_LIST *	VarArg
	)

The set process of the IfConfig6 application.

Parameters

[in]	IfList	The pointer of IfList(interface list).
[in]	VarArg	The pointer of ARG_LIST(Args with "-s" option).

Return values

SHELL_SUCCESS	The IfConfig6 set processed successfully.
others	The IfConfig6 set process failed.

Definition at line 1180 of file Ifconfig6.c.

◆ IfConfig6ShowInterfaceInfo()

SHELL_STATUS IfConfig6ShowInterfaceInfo ( IN LIST_ENTRY * IfList )

The list process of the IfConfig6 application.

Parameters

[in] IfList The pointer of IfList(interface list).

Return values

SHELL_SUCCESS	The IfConfig6 list processed successfully.
others	The IfConfig6 list process failed.

Definition at line 978 of file Ifconfig6.c.

◆ IfConfig6SplitStrToList()

ARG_LIST * IfConfig6SplitStrToList	(	IN CONST CHAR16 *	String,
		IN CHAR16	Separator
	)

Split a string with specified separator and save the substring to a list.

Parameters

[in]	String	The pointer of the input string.
[in]	Separator	The specified separator.

Returns: The pointer of headnode of ARG_LIST.

Definition at line 182 of file Ifconfig6.c.

◆ ShellCommandRunIfconfig6()

SHELL_STATUS EFIAPI ShellCommandRunIfconfig6	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Function for 'ifconfig6' command.

Parameters

[in]	ImageHandle	Handle to the Image (NULL if Internal).
[in]	SystemTable	Pointer to the System Table (NULL if Internal).

Return values

SHELL_SUCCESS	ifconfig6 command processed successfully.
others	The ifconfig6 command process failed.

Definition at line 1774 of file Ifconfig6.c.

Variable Documentation

◆ mIfConfig6CheckList

SHELL_PARAM_ITEM mIfConfig6CheckList[]

Initial value:

= {
  {
    L"-b",
    TypeFlag
  },
  {
    L"-s",
    TypeMaxValue
  },
  {
    L"-l",
    TypeValue
  },
  {
    L"-r",
    TypeValue
  },
  {
    L"-?",
    TypeFlag
  },
  {
    NULL,
    TypeMax
  },
}

Definition at line 73 of file Ifconfig6.c.

◆ mIfConfig6SetCheckList

VAR_CHECK_ITEM mIfConfig6SetCheckList[]

Definition at line 100 of file Ifconfig6.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ MACADDRMAXSIZE

◆ PREFIXMAXLEN

Typedef Documentation

◆ ARG_LIST

Enumeration Type Documentation

◆ anonymous enum

◆ VAR_CHECK_CODE

◆ VAR_CHECK_FLAG_TYPE

Function Documentation

◆ IfConfig6()

◆ IfConfig6Cleanup()

◆ IfConfig6ClearInterfaceInfo()

◆ IfConfig6FreeArgList()

◆ IfConfig6GetInterfaceInfo()

◆ IfConfig6ManualAddressNotify()

◆ IfConfig6ParseDadXmits()

◆ IfConfig6ParseGwDnsAddressList()

◆ IfConfig6ParseInterfaceId()

◆ IfConfig6ParseManualAddressList()

◆ IfConfig6PrintIpAddr()

◆ IfConfig6PrintMacAddr()

◆ IfConfig6RetriveCheckListByName()

◆ IfConfig6SetInterfaceInfo()

◆ IfConfig6ShowInterfaceInfo()

◆ IfConfig6SplitStrToList()

◆ ShellCommandRunIfconfig6()

Variable Documentation

◆ mIfConfig6CheckList

◆ mIfConfig6SetCheckList