2 The implementation for Shell command ifconfig based on IP4Config2 protocol.
4 (C) Copyright 2013-2015 Hewlett-Packard Development Company, L.P.<BR>
5 Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php.
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include "UefiShellNetwork1CommandsLib.h"
26 VarCheckReserved
= -1,
40 } VAR_CHECK_FLAG_TYPE
;
42 #define MACADDRMAXSIZE 32
44 typedef struct _IFCONFIG_INTERFACE_CB
{
47 EFI_IP4_CONFIG2_PROTOCOL
*IfCfg
;
48 EFI_IP4_CONFIG2_INTERFACE_INFO
*IfInfo
;
49 EFI_IP4_CONFIG2_POLICY Policy
;
51 EFI_IPv4_ADDRESS DnsAddr
[1];
52 } IFCONFIG_INTERFACE_CB
;
54 typedef struct _ARG_LIST ARG_LIST
;
61 typedef struct _IFCONFIG4_PRIVATE_DATA
{
67 } IFCONFIG_PRIVATE_DATA
;
69 typedef struct _VAR_CHECK_ITEM
{
73 VAR_CHECK_FLAG_TYPE FlagType
;
76 SHELL_PARAM_ITEM mIfConfigCheckList
[] = {
103 VAR_CHECK_ITEM mSetCheckList
[] = {
130 STATIC CONST CHAR16 PermanentString
[10] = L
"PERMANENT";
135 @param List Pointer to ARG_LIST to free.
143 while (List
->Next
!= NULL
) {
153 Split a string with specified separator and save the substring to a list.
155 @param[in] String The pointer of the input string.
156 @param[in] Separator The specified separator.
158 @return The pointer of headnode of ARG_LIST.
163 IN CONST CHAR16
*String
,
172 if (*String
== L
'\0') {
177 // Copy the CONST string to a local copy.
179 Str
= AllocateCopyPool (StrSize (String
), String
);
186 // init a node for the list head.
188 ArgNode
= (ARG_LIST
*) AllocateZeroPool (sizeof (ARG_LIST
));
189 if (ArgNode
== NULL
) {
195 // Split the local copy and save in the list node.
197 while (*Str
!= L
'\0') {
198 if (*Str
== Separator
) {
200 ArgNode
->Arg
= ArgStr
;
202 ArgNode
->Next
= (ARG_LIST
*) AllocateZeroPool (sizeof (ARG_LIST
));
203 if (ArgNode
->Next
== NULL
) {
205 // Free the local copy of string stored in the first node
207 FreePool (ArgList
->Arg
);
208 FreeArgList (ArgList
);
211 ArgNode
= ArgNode
->Next
;
217 ArgNode
->Arg
= ArgStr
;
218 ArgNode
->Next
= NULL
;
224 Check the correctness of input Args with '-s' option.
226 @param[in] CheckList The pointer of VAR_CHECK_ITEM array.
227 @param[in] Name The pointer of input arg.
228 @param[in] Init The switch to execute the check.
230 @return VarCheckOk Valid parameter or Initialize check successfully.
231 @return VarCheckDuplicate Duplicated parameter happened.
232 @return VarCheckConflict Conflicted parameter happened
233 @return VarCheckUnknown Unknown parameter.
237 IfConfigRetriveCheckListByName(
238 IN VAR_CHECK_ITEM
*CheckList
,
243 STATIC UINT32 CheckDuplicate
;
244 STATIC UINT32 CheckConflict
;
245 VAR_CHECK_CODE RtCode
;
257 Arg
= CheckList
[Index
];
260 // Check the Duplicated/Conflicted/Unknown input Args.
262 while (Arg
.FlagStr
!= NULL
) {
263 if (StrCmp (Arg
.FlagStr
, Name
) == 0) {
265 if (CheckDuplicate
& Arg
.FlagID
) {
266 RtCode
= VarCheckDuplicate
;
270 if (CheckConflict
& Arg
.ConflictMask
) {
271 RtCode
= VarCheckConflict
;
275 CheckDuplicate
|= Arg
.FlagID
;
276 CheckConflict
|= Arg
.ConflictMask
;
280 Arg
= CheckList
[++Index
];
283 if (Arg
.FlagStr
== NULL
) {
284 RtCode
= VarCheckUnknown
;
291 The notify function of create event when performing a manual config.
293 @param[in] Event The event this notify function registered to.
294 @param[in] Context Pointer to the context data registered to the event.
299 IfConfigManualAddressNotify (
304 *((BOOLEAN
*) Context
) = TRUE
;
310 @param[in] Node The pointer of MAC address buffer.
311 @param[in] Size The size of MAC address buffer.
315 IfConfigPrintMacAddr (
322 ASSERT (Size
<= MACADDRMAXSIZE
);
324 for (Index
= 0; Index
< Size
; Index
++) {
325 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_MAC_ADDR_BODY
), gShellNetwork1HiiHandle
, Node
[Index
]);
326 if (Index
+ 1 < Size
) {
327 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_COLON
), gShellNetwork1HiiHandle
);
331 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_NEWLINE
), gShellNetwork1HiiHandle
);
336 The get current status of all handles.
338 @param[in] IfName The pointer of IfName(interface name).
339 @param[in] IfList The pointer of IfList(interface list).
341 @retval EFI_SUCCESS The get status processed successfully.
342 @retval others The get status process failed.
346 IfConfigGetInterfaceInfo (
348 IN LIST_ENTRY
*IfList
354 EFI_HANDLE
*HandleBuffer
;
355 EFI_IP4_CONFIG2_PROTOCOL
*Ip4Cfg2
;
356 EFI_IP4_CONFIG2_INTERFACE_INFO
*IfInfo
;
357 IFCONFIG_INTERFACE_CB
*IfCb
;
367 // Locate all the handles with ip4 service binding protocol.
369 Status
= gBS
->LocateHandleBuffer (
371 &gEfiIp4ServiceBindingProtocolGuid
,
376 if (EFI_ERROR (Status
) || (HandleNum
== 0)) {
381 // Enumerate all handles that installed with ip4 service binding protocol.
383 for (HandleIndex
= 0; HandleIndex
< HandleNum
; HandleIndex
++) {
389 // Ip4config protocol and ip4 service binding protocol are installed
390 // on the same handle.
392 ASSERT (HandleBuffer
!= NULL
);
393 Status
= gBS
->HandleProtocol (
394 HandleBuffer
[HandleIndex
],
395 &gEfiIp4Config2ProtocolGuid
,
399 if (EFI_ERROR (Status
)) {
404 // Get the interface information size.
406 Status
= Ip4Cfg2
->GetData (
408 Ip4Config2DataTypeInterfaceInfo
,
413 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
417 IfInfo
= AllocateZeroPool (DataSize
);
419 if (IfInfo
== NULL
) {
420 Status
= EFI_OUT_OF_RESOURCES
;
425 // Get the interface info.
427 Status
= Ip4Cfg2
->GetData (
429 Ip4Config2DataTypeInterfaceInfo
,
434 if (EFI_ERROR (Status
)) {
439 // Check the interface name if required.
441 if ((IfName
!= NULL
) && (StrCmp (IfName
, IfInfo
->Name
) != 0)) {
449 // Get the size of dns server list.
451 Status
= Ip4Cfg2
->GetData (
453 Ip4Config2DataTypeDnsServer
,
458 if ((Status
!= EFI_BUFFER_TOO_SMALL
) && (Status
!= EFI_NOT_FOUND
)) {
462 IfCb
= AllocateZeroPool (sizeof (IFCONFIG_INTERFACE_CB
) + DataSize
);
465 Status
= EFI_OUT_OF_RESOURCES
;
469 IfCb
->NicHandle
= HandleBuffer
[HandleIndex
];
470 IfCb
->IfInfo
= IfInfo
;
471 IfCb
->IfCfg
= Ip4Cfg2
;
472 IfCb
->DnsCnt
= (UINT32
) (DataSize
/ sizeof (EFI_IPv4_ADDRESS
));
475 // Get the dns server list if has.
478 Status
= Ip4Cfg2
->GetData (
480 Ip4Config2DataTypeDnsServer
,
485 if (EFI_ERROR (Status
)) {
491 // Get the config policy.
493 DataSize
= sizeof (EFI_IP4_CONFIG2_POLICY
);
494 Status
= Ip4Cfg2
->GetData (
496 Ip4Config2DataTypePolicy
,
501 if (EFI_ERROR (Status
)) {
505 InsertTailList (IfList
, &IfCb
->Link
);
507 if ((IfName
!= NULL
) && (StrCmp (IfName
, IfInfo
->Name
) == 0)) {
509 // Only need the appointed interface, keep the allocated buffer.
517 if (HandleBuffer
!= NULL
) {
518 FreePool (HandleBuffer
);
525 if (IfInfo
!= NULL
) {
537 The list process of the ifconfig command.
539 @param[in] IfList The pointer of IfList(interface list).
541 @retval SHELL_SUCCESS The ifconfig command list processed successfully.
542 @retval others The ifconfig command list process failed.
546 IfConfigShowInterfaceInfo (
547 IN LIST_ENTRY
*IfList
552 IFCONFIG_INTERFACE_CB
*IfCb
;
553 EFI_STATUS MediaStatus
;
554 EFI_IPv4_ADDRESS Gateway
;
557 MediaStatus
= EFI_SUCCESS
;
559 if (IsListEmpty (IfList
)) {
560 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INVALID_INTERFACE
), gShellNetwork1HiiHandle
);
564 // Go through the interface list.
566 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, IfList
) {
567 IfCb
= NET_LIST_USER_STRUCT (Entry
, IFCONFIG_INTERFACE_CB
, Link
);
569 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_BREAK
), gShellNetwork1HiiHandle
);
572 // Print interface name.
574 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_IF_NAME
), gShellNetwork1HiiHandle
, IfCb
->IfInfo
->Name
);
579 if (EFI_SUCCESS
== NetLibDetectMediaWaitTimeout (IfCb
->NicHandle
, 0, &MediaStatus
)) {
580 if (MediaStatus
!= EFI_SUCCESS
) {
581 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_MEDIA_STATE
), gShellNetwork1HiiHandle
, L
"Media disconnected");
583 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_MEDIA_STATE
), gShellNetwork1HiiHandle
, L
"Media present");
586 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_MEDIA_STATE
), gShellNetwork1HiiHandle
, L
"Media state unknown");
590 // Print interface config policy.
592 if (IfCb
->Policy
== Ip4Config2PolicyDhcp
) {
593 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_POLICY_DHCP
), gShellNetwork1HiiHandle
);
595 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_POLICY_MAN
), gShellNetwork1HiiHandle
);
599 // Print mac address of the interface.
601 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_MAC_ADDR_HEAD
), gShellNetwork1HiiHandle
);
603 IfConfigPrintMacAddr (
604 IfCb
->IfInfo
->HwAddress
.Addr
,
605 IfCb
->IfInfo
->HwAddressSize
609 // Print IPv4 address list of the interface.
611 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_IP_ADDR_HEAD
), gShellNetwork1HiiHandle
);
617 STRING_TOKEN (STR_IFCONFIG_INFO_IP_ADDR_BODY
),
618 gShellNetwork1HiiHandle
,
619 (UINTN
)IfCb
->IfInfo
->StationAddress
.Addr
[0],
620 (UINTN
)IfCb
->IfInfo
->StationAddress
.Addr
[1],
621 (UINTN
)IfCb
->IfInfo
->StationAddress
.Addr
[2],
622 (UINTN
)IfCb
->IfInfo
->StationAddress
.Addr
[3]
626 // Print subnet mask list of the interface.
628 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_SUBNET_MASK_HEAD
), gShellNetwork1HiiHandle
);
634 STRING_TOKEN (STR_IFCONFIG_INFO_IP_ADDR_BODY
),
635 gShellNetwork1HiiHandle
,
636 (UINTN
)IfCb
->IfInfo
->SubnetMask
.Addr
[0],
637 (UINTN
)IfCb
->IfInfo
->SubnetMask
.Addr
[1],
638 (UINTN
)IfCb
->IfInfo
->SubnetMask
.Addr
[2],
639 (UINTN
)IfCb
->IfInfo
->SubnetMask
.Addr
[3]
643 // Print default gateway of the interface.
645 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_GATEWAY_HEAD
), gShellNetwork1HiiHandle
);
647 ZeroMem (&Gateway
, sizeof (EFI_IPv4_ADDRESS
));
649 for (Index
= 0; Index
< IfCb
->IfInfo
->RouteTableSize
; Index
++) {
650 if ((CompareMem (&IfCb
->IfInfo
->RouteTable
[Index
].SubnetAddress
, &mZeroIp4Addr
, sizeof (EFI_IPv4_ADDRESS
)) == 0) &&
651 (CompareMem (&IfCb
->IfInfo
->RouteTable
[Index
].SubnetMask
, &mZeroIp4Addr
, sizeof (EFI_IPv4_ADDRESS
)) == 0) ){
652 CopyMem (&Gateway
, &IfCb
->IfInfo
->RouteTable
[Index
].GatewayAddress
, sizeof (EFI_IPv4_ADDRESS
));
660 STRING_TOKEN (STR_IFCONFIG_INFO_IP_ADDR_BODY
),
661 gShellNetwork1HiiHandle
,
662 (UINTN
)Gateway
.Addr
[0],
663 (UINTN
)Gateway
.Addr
[1],
664 (UINTN
)Gateway
.Addr
[2],
665 (UINTN
)Gateway
.Addr
[3]
669 // Print route table entry.
671 ShellPrintHiiEx(-1, -1, NULL
,STRING_TOKEN (STR_IFCONFIG_ROUTES_SIZE
), gShellNetwork1HiiHandle
, IfCb
->IfInfo
->RouteTableSize
);
673 for (Index
= 0; Index
< IfCb
->IfInfo
->RouteTableSize
; Index
++) {
674 ShellPrintHiiEx(-1, -1, NULL
,STRING_TOKEN (STR_IFCONFIG_ROUTES_ENTRY_INDEX
), gShellNetwork1HiiHandle
, Index
);
680 STRING_TOKEN (STR_IFCONFIG_SHOW_IP_ADDR
),
681 gShellNetwork1HiiHandle
,
683 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].SubnetAddress
.Addr
[0],
684 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].SubnetAddress
.Addr
[1],
685 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].SubnetAddress
.Addr
[2],
686 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].SubnetAddress
.Addr
[3]
693 STRING_TOKEN (STR_IFCONFIG_SHOW_IP_ADDR
),
694 gShellNetwork1HiiHandle
,
696 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].SubnetMask
.Addr
[0],
697 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].SubnetMask
.Addr
[1],
698 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].SubnetMask
.Addr
[2],
699 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].SubnetMask
.Addr
[3]
706 STRING_TOKEN (STR_IFCONFIG_SHOW_IP_ADDR
),
707 gShellNetwork1HiiHandle
,
709 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].GatewayAddress
.Addr
[0],
710 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].GatewayAddress
.Addr
[1],
711 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].GatewayAddress
.Addr
[2],
712 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].GatewayAddress
.Addr
[3]
717 // Print dns server addresses list of the interface if has.
719 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_DNS_ADDR_HEAD
), gShellNetwork1HiiHandle
);
721 for (Index
= 0; Index
< IfCb
->DnsCnt
; Index
++) {
726 STRING_TOKEN (STR_IFCONFIG_INFO_DNS_ADDR_BODY
),
727 gShellNetwork1HiiHandle
,
728 (UINTN
) IfCb
->DnsAddr
[Index
].Addr
[0],
729 (UINTN
) IfCb
->DnsAddr
[Index
].Addr
[1],
730 (UINTN
) IfCb
->DnsAddr
[Index
].Addr
[2],
731 (UINTN
) IfCb
->DnsAddr
[Index
].Addr
[3]
734 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_NEWLINE
), gShellNetwork1HiiHandle
);
738 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_BREAK
), gShellNetwork1HiiHandle
);
740 return SHELL_SUCCESS
;
744 The clean process of the ifconfig command to clear interface info.
746 @param[in] IfList The pointer of IfList(interface list).
747 @param[in] IfName The pointer of interface name.
749 @retval SHELL_SUCCESS The ifconfig command clean processed successfully.
750 @retval others The ifconfig command clean process failed.
754 IfConfigClearInterfaceInfo (
755 IN LIST_ENTRY
*IfList
,
760 SHELL_STATUS ShellStatus
;
763 IFCONFIG_INTERFACE_CB
*IfCb
;
764 EFI_IP4_CONFIG2_POLICY Policy
;
766 Status
= EFI_SUCCESS
;
767 ShellStatus
= SHELL_SUCCESS
;
769 if (IsListEmpty (IfList
)) {
770 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INVALID_INTERFACE
), gShellNetwork1HiiHandle
);
774 // Go through the interface list.
775 // If the interface name is specified, DHCP DORA process will be
776 // triggered by the policy transition (static -> dhcp).
778 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, IfList
) {
779 IfCb
= NET_LIST_USER_STRUCT (Entry
, IFCONFIG_INTERFACE_CB
, Link
);
781 if ((IfName
!= NULL
) && (StrCmp (IfName
, IfCb
->IfInfo
->Name
) == 0)) {
782 Policy
= Ip4Config2PolicyStatic
;
784 Status
= IfCb
->IfCfg
->SetData (
786 Ip4Config2DataTypePolicy
,
787 sizeof (EFI_IP4_CONFIG2_POLICY
),
790 if (EFI_ERROR (Status
)) {
791 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_AD
), gShellNetwork1HiiHandle
, L
"ifconfig");
792 ShellStatus
= SHELL_ACCESS_DENIED
;
797 Policy
= Ip4Config2PolicyDhcp
;
799 Status
= IfCb
->IfCfg
->SetData (
801 Ip4Config2DataTypePolicy
,
802 sizeof (EFI_IP4_CONFIG2_POLICY
),
805 if (EFI_ERROR (Status
)) {
806 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_AD
), gShellNetwork1HiiHandle
, L
"ifconfig");
807 ShellStatus
= SHELL_ACCESS_DENIED
;
816 The set process of the ifconfig command.
818 @param[in] IfList The pointer of IfList(interface list).
819 @param[in] VarArg The pointer of ARG_LIST(Args with "-s" option).
821 @retval SHELL_SUCCESS The ifconfig command set processed successfully.
822 @retval others The ifconfig command set process failed.
826 IfConfigSetInterfaceInfo (
827 IN LIST_ENTRY
*IfList
,
832 SHELL_STATUS ShellStatus
;
833 IFCONFIG_INTERFACE_CB
*IfCb
;
834 VAR_CHECK_CODE CheckCode
;
835 EFI_EVENT TimeOutEvt
;
839 EFI_IP4_CONFIG2_POLICY Policy
;
840 EFI_IP4_CONFIG2_MANUAL_ADDRESS ManualAddress
;
842 EFI_IPv4_ADDRESS Gateway
;
844 IP4_ADDR TempGateway
;
845 EFI_IPv4_ADDRESS
*Dns
;
849 CONST CHAR16
* TempString
;
853 if (IsListEmpty (IfList
)) {
854 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INVALID_INTERFACE
), gShellNetwork1HiiHandle
);
855 return SHELL_INVALID_PARAMETER
;
859 // Make sure to set only one interface each time.
861 IfCb
= NET_LIST_USER_STRUCT (IfList
->ForwardLink
, IFCONFIG_INTERFACE_CB
, Link
);
862 Status
= EFI_SUCCESS
;
863 ShellStatus
= SHELL_SUCCESS
;
866 // Initialize check list mechanism.
868 CheckCode
= IfConfigRetriveCheckListByName(
875 // Create events & timers for asynchronous settings.
877 Status
= gBS
->CreateEvent (
884 if (EFI_ERROR (Status
)) {
885 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_AD
), gShellNetwork1HiiHandle
, L
"ifconfig");
886 ShellStatus
= SHELL_ACCESS_DENIED
;
890 Status
= gBS
->CreateEvent (
893 IfConfigManualAddressNotify
,
897 if (EFI_ERROR (Status
)) {
898 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_AD
), gShellNetwork1HiiHandle
, L
"ifconfig");
899 ShellStatus
= SHELL_ACCESS_DENIED
;
904 // Parse the setting variables.
906 while (VarArg
!= NULL
) {
908 // Check invalid parameters (duplication & unknown & conflict).
910 CheckCode
= IfConfigRetriveCheckListByName(
916 if (VarCheckOk
!= CheckCode
) {
918 case VarCheckDuplicate
:
919 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_DUPLICATE_COMMAND
), gShellNetwork1HiiHandle
, VarArg
->Arg
);
922 case VarCheckConflict
:
923 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_CONFLICT_COMMAND
), gShellNetwork1HiiHandle
, VarArg
->Arg
);
926 case VarCheckUnknown
:
928 // To handle unsupported option.
930 TempString
= PermanentString
;
931 if (StringNoCaseCompare(&VarArg
->Arg
, &TempString
) == 0) {
932 ShellPrintHiiEx(-1, -1, NULL
,STRING_TOKEN (STR_IFCONFIG_UNSUPPORTED_OPTION
), gShellNetwork1HiiHandle
, PermanentString
);
937 // To handle unknown option.
939 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_UNKNOWN_COMMAND
), gShellNetwork1HiiHandle
, VarArg
->Arg
);
946 VarArg
= VarArg
->Next
;
951 // Process valid variables.
953 if (StrCmp(VarArg
->Arg
, L
"dhcp") == 0) {
955 // Set dhcp config policy
957 Policy
= Ip4Config2PolicyDhcp
;
958 Status
= IfCb
->IfCfg
->SetData (
960 Ip4Config2DataTypePolicy
,
961 sizeof (EFI_IP4_CONFIG2_POLICY
),
964 if (EFI_ERROR(Status
)) {
965 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_AD
), gShellNetwork1HiiHandle
, L
"ifconfig");
966 ShellStatus
= SHELL_ACCESS_DENIED
;
970 VarArg
= VarArg
->Next
;
972 } else if (StrCmp (VarArg
->Arg
, L
"static") == 0) {
973 VarArg
= VarArg
->Next
;
974 if (VarArg
== NULL
) {
975 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_LACK_COMMAND
), gShellNetwork1HiiHandle
);
976 ShellStatus
= SHELL_INVALID_PARAMETER
;
980 ZeroMem (&ManualAddress
, sizeof (ManualAddress
));
983 // Get manual IP address.
985 Status
= NetLibStrToIp4 (VarArg
->Arg
, &ManualAddress
.Address
);
986 if (EFI_ERROR(Status
)) {
987 ShellPrintHiiEx(-1, -1, NULL
,STRING_TOKEN (STR_IFCONFIG_INVALID_IPADDRESS
), gShellNetwork1HiiHandle
, VarArg
->Arg
);
988 ShellStatus
= SHELL_INVALID_PARAMETER
;
995 VarArg
= VarArg
->Next
;
996 if (VarArg
== NULL
) {
997 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_LACK_COMMAND
), gShellNetwork1HiiHandle
);
998 ShellStatus
= SHELL_INVALID_PARAMETER
;
1002 Status
= NetLibStrToIp4 (VarArg
->Arg
, &ManualAddress
.SubnetMask
);
1003 if (EFI_ERROR(Status
)) {
1004 ShellPrintHiiEx(-1, -1, NULL
,STRING_TOKEN (STR_IFCONFIG_INVALID_IPADDRESS
), gShellNetwork1HiiHandle
, VarArg
->Arg
);
1005 ShellStatus
= SHELL_INVALID_PARAMETER
;
1012 VarArg
= VarArg
->Next
;
1013 if (VarArg
== NULL
) {
1014 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_LACK_COMMAND
), gShellNetwork1HiiHandle
);
1015 ShellStatus
= SHELL_INVALID_PARAMETER
;
1019 Status
= NetLibStrToIp4 (VarArg
->Arg
, &Gateway
);
1020 if (EFI_ERROR(Status
)) {
1021 ShellPrintHiiEx(-1, -1, NULL
,STRING_TOKEN (STR_IFCONFIG_INVALID_IPADDRESS
), gShellNetwork1HiiHandle
, VarArg
->Arg
);
1022 ShellStatus
= SHELL_INVALID_PARAMETER
;
1027 // Need to check the gateway validity before set Manual Address.
1028 // In case we can set manual address but fail to configure Gateway.
1030 CopyMem (&SubnetMask
, &ManualAddress
.SubnetMask
, sizeof (IP4_ADDR
));
1031 CopyMem (&TempGateway
, &Gateway
, sizeof (IP4_ADDR
));
1032 SubnetMask
= NTOHL (SubnetMask
);
1033 TempGateway
= NTOHL (TempGateway
);
1034 if ((SubnetMask
!= 0) &&
1035 !NetIp4IsUnicast (TempGateway
, SubnetMask
)) {
1036 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INVALID_GATEWAY
), gShellNetwork1HiiHandle
, VarArg
->Arg
);
1037 ShellStatus
= SHELL_INVALID_PARAMETER
;
1042 // Set manual config policy.
1044 Policy
= Ip4Config2PolicyStatic
;
1045 Status
= IfCb
->IfCfg
->SetData (
1047 Ip4Config2DataTypePolicy
,
1048 sizeof (EFI_IP4_CONFIG2_POLICY
),
1051 if (EFI_ERROR(Status
)) {
1052 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_AD
), gShellNetwork1HiiHandle
, L
"ifconfig");
1053 ShellStatus
= SHELL_ACCESS_DENIED
;
1058 // Set Manual Address.
1060 IsAddressOk
= FALSE
;
1062 Status
= IfCb
->IfCfg
->RegisterDataNotify (
1064 Ip4Config2DataTypeManualAddress
,
1067 if (EFI_ERROR (Status
)) {
1068 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_SET_ADDR_FAILED
), gShellNetwork1HiiHandle
, Status
);
1069 ShellStatus
= SHELL_ACCESS_DENIED
;
1073 DataSize
= sizeof (EFI_IP4_CONFIG2_MANUAL_ADDRESS
);
1075 Status
= IfCb
->IfCfg
->SetData (
1077 Ip4Config2DataTypeManualAddress
,
1082 if (Status
== EFI_NOT_READY
) {
1083 gBS
->SetTimer (TimeOutEvt
, TimerRelative
, 50000000);
1085 while (EFI_ERROR (gBS
->CheckEvent (TimeOutEvt
))) {
1087 Status
= EFI_SUCCESS
;
1093 IfCb
->IfCfg
->UnregisterDataNotify (
1095 Ip4Config2DataTypeManualAddress
,
1099 if (EFI_ERROR (Status
)) {
1100 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_SET_ADDR_FAILED
), gShellNetwork1HiiHandle
, Status
);
1101 ShellStatus
= SHELL_ACCESS_DENIED
;
1108 DataSize
= sizeof (EFI_IPv4_ADDRESS
);
1110 Status
= IfCb
->IfCfg
->SetData (
1112 Ip4Config2DataTypeGateway
,
1116 if (EFI_ERROR (Status
)) {
1117 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_SET_ADDR_FAILED
), gShellNetwork1HiiHandle
, Status
);
1118 ShellStatus
= SHELL_ACCESS_DENIED
;
1122 VarArg
= VarArg
->Next
;
1124 } else if (StrCmp (VarArg
->Arg
, L
"dns") == 0) {
1126 // Get DNS addresses.
1128 VarArg
= VarArg
->Next
;
1131 while (Tmp
!= NULL
) {
1136 Dns
= AllocatePool (Index
* sizeof (EFI_IPv4_ADDRESS
));
1138 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_OUT_MEM
), gShellNetwork1HiiHandle
, L
"ifconfig");
1139 ShellStatus
= SHELL_OUT_OF_RESOURCES
;
1144 while (Tmp
!= NULL
) {
1145 Status
= NetLibStrToIp4 (Tmp
->Arg
, Dns
+ Index
);
1146 if (EFI_ERROR(Status
)) {
1147 ShellPrintHiiEx(-1, -1, NULL
,STRING_TOKEN (STR_IFCONFIG_INVALID_IPADDRESS
), gShellNetwork1HiiHandle
, Tmp
->Arg
);
1148 ShellStatus
= SHELL_INVALID_PARAMETER
;
1158 // Set DNS addresses.
1160 DataSize
= Index
* sizeof (EFI_IPv4_ADDRESS
);
1162 Status
= IfCb
->IfCfg
->SetData (
1164 Ip4Config2DataTypeDnsServer
,
1168 if (EFI_ERROR (Status
)) {
1169 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_AD
), gShellNetwork1HiiHandle
, L
"ifconfig");
1170 ShellStatus
= SHELL_ACCESS_DENIED
;
1186 The ifconfig command main process.
1188 @param[in] Private The pointer of IFCONFIG_PRIVATE_DATA.
1190 @retval SHELL_SUCCESS ifconfig command processed successfully.
1191 @retval others The ifconfig command process failed.
1196 IN IFCONFIG_PRIVATE_DATA
*Private
1200 SHELL_STATUS ShellStatus
;
1202 ShellStatus
= SHELL_SUCCESS
;
1205 // Get configure information of all interfaces.
1207 Status
= IfConfigGetInterfaceInfo (
1211 if (EFI_ERROR (Status
)) {
1212 ShellStatus
= SHELL_NOT_FOUND
;
1216 switch (Private
->OpCode
) {
1217 case IfConfigOpList
:
1218 ShellStatus
= IfConfigShowInterfaceInfo (&Private
->IfList
);
1221 case IfConfigOpClear
:
1222 ShellStatus
= IfConfigClearInterfaceInfo (&Private
->IfList
, Private
->IfName
);
1226 ShellStatus
= IfConfigSetInterfaceInfo (&Private
->IfList
, Private
->VarArg
);
1230 ShellStatus
= SHELL_UNSUPPORTED
;
1238 The ifconfig command cleanup process, free the allocated memory.
1240 @param[in] Private The pointer of IFCONFIG_PRIVATE_DATA.
1245 IN IFCONFIG_PRIVATE_DATA
*Private
1249 LIST_ENTRY
*NextEntry
;
1250 IFCONFIG_INTERFACE_CB
*IfCb
;
1252 ASSERT (Private
!= NULL
);
1255 // Clean the list which save the set config Args.
1257 if (Private
->VarArg
!= NULL
) {
1258 FreeArgList (Private
->VarArg
);
1261 if (Private
->IfName
!= NULL
) {
1262 FreePool (Private
->IfName
);
1266 // Clean the IFCONFIG_INTERFACE_CB list.
1268 NET_LIST_FOR_EACH_SAFE (Entry
, NextEntry
, &Private
->IfList
) {
1269 IfCb
= NET_LIST_USER_STRUCT (Entry
, IFCONFIG_INTERFACE_CB
, Link
);
1271 RemoveEntryList (&IfCb
->Link
);
1273 if (IfCb
->IfInfo
!= NULL
) {
1275 FreePool (IfCb
->IfInfo
);
1285 Function for 'ifconfig' command.
1287 @param[in] ImageHandle Handle to the Image (NULL if Internal).
1288 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
1290 @retval EFI_SUCCESS ifconfig command processed successfully.
1291 @retval others The ifconfig command process failed.
1296 ShellCommandRunIfconfig (
1297 IN EFI_HANDLE ImageHandle
,
1298 IN EFI_SYSTEM_TABLE
*SystemTable
1302 IFCONFIG_PRIVATE_DATA
*Private
;
1303 LIST_ENTRY
*ParamPackage
;
1304 SHELL_STATUS ShellStatus
;
1305 CONST CHAR16
*ValueStr
;
1307 CHAR16
*ProblemParam
;
1310 Status
= EFI_INVALID_PARAMETER
;
1312 ShellStatus
= SHELL_SUCCESS
;
1314 Status
= ShellCommandLineParseEx (mIfConfigCheckList
, &ParamPackage
, &ProblemParam
, TRUE
, FALSE
);
1315 if (EFI_ERROR (Status
)) {
1316 if (Status
== EFI_VOLUME_CORRUPTED
&& ProblemParam
!= NULL
) {
1317 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_PARAM_INV
), gShellNetwork1HiiHandle
, L
"ifconfig", ProblemParam
);
1318 FreePool(ProblemParam
);
1319 ShellStatus
= SHELL_INVALID_PARAMETER
;
1328 // To handle unsupported option.
1330 if (ShellCommandLineGetFlag (ParamPackage
, L
"-c")) {
1331 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_UNSUPPORTED_OPTION
), gShellNetwork1HiiHandle
,L
"-c");
1332 ShellStatus
= SHELL_INVALID_PARAMETER
;
1337 // To handle no option.
1339 if (!ShellCommandLineGetFlag (ParamPackage
, L
"-r") && !ShellCommandLineGetFlag (ParamPackage
, L
"-s") &&
1340 !ShellCommandLineGetFlag (ParamPackage
, L
"-l")) {
1341 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_LACK_OPTION
), gShellNetwork1HiiHandle
);
1342 ShellStatus
= SHELL_INVALID_PARAMETER
;
1347 // To handle conflict options.
1349 if (((ShellCommandLineGetFlag (ParamPackage
, L
"-r")) && (ShellCommandLineGetFlag (ParamPackage
, L
"-s"))) ||
1350 ((ShellCommandLineGetFlag (ParamPackage
, L
"-r")) && (ShellCommandLineGetFlag (ParamPackage
, L
"-l"))) ||
1351 ((ShellCommandLineGetFlag (ParamPackage
, L
"-s")) && (ShellCommandLineGetFlag (ParamPackage
, L
"-l")))) {
1352 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_PARAM_CON
), gShellNetwork1HiiHandle
, L
"ifconfig");
1353 ShellStatus
= SHELL_INVALID_PARAMETER
;
1357 Private
= AllocateZeroPool (sizeof (IFCONFIG_PRIVATE_DATA
));
1358 if (Private
== NULL
) {
1359 ShellStatus
= SHELL_OUT_OF_RESOURCES
;
1363 InitializeListHead (&Private
->IfList
);
1366 // To get interface name for the list option.
1368 if (ShellCommandLineGetFlag (ParamPackage
, L
"-l")) {
1369 Private
->OpCode
= IfConfigOpList
;
1370 ValueStr
= ShellCommandLineGetValue (ParamPackage
, L
"-l");
1371 if (ValueStr
!= NULL
) {
1372 Str
= AllocateCopyPool (StrSize (ValueStr
), ValueStr
);
1374 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_OUT_MEM
), gShellNetwork1HiiHandle
, L
"ifconfig");
1375 ShellStatus
= SHELL_OUT_OF_RESOURCES
;
1378 Private
->IfName
= Str
;
1383 // To get interface name for the clear option.
1385 if (ShellCommandLineGetFlag (ParamPackage
, L
"-r")) {
1386 Private
->OpCode
= IfConfigOpClear
;
1387 ValueStr
= ShellCommandLineGetValue (ParamPackage
, L
"-r");
1388 if (ValueStr
!= NULL
) {
1389 Str
= AllocateCopyPool (StrSize (ValueStr
), ValueStr
);
1391 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_OUT_MEM
), gShellNetwork1HiiHandle
, L
"ifconfig");
1392 ShellStatus
= SHELL_OUT_OF_RESOURCES
;
1395 Private
->IfName
= Str
;
1400 // To get interface name and corresponding Args for the set option.
1402 if (ShellCommandLineGetFlag (ParamPackage
, L
"-s")) {
1403 ValueStr
= ShellCommandLineGetValue (ParamPackage
, L
"-s");
1404 if (ValueStr
== NULL
) {
1405 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_LACK_INTERFACE
), gShellNetwork1HiiHandle
);
1406 ShellStatus
= SHELL_INVALID_PARAMETER
;
1411 // To split the configuration into multi-section.
1413 ArgList
= SplitStrToList (ValueStr
, L
' ');
1414 if (ArgList
== NULL
) {
1415 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_OUT_MEM
), gShellNetwork1HiiHandle
, L
"ifconfig");
1416 ShellStatus
= SHELL_OUT_OF_RESOURCES
;
1420 Private
->OpCode
= IfConfigOpSet
;
1421 Private
->IfName
= ArgList
->Arg
;
1423 Private
->VarArg
= ArgList
->Next
;
1425 if (Private
->IfName
== NULL
|| Private
->VarArg
== NULL
) {
1426 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_LACK_COMMAND
), gShellNetwork1HiiHandle
);
1427 ShellStatus
= SHELL_INVALID_PARAMETER
;
1433 // Main process of ifconfig.
1435 ShellStatus
= IfConfig (Private
);
1439 ShellCommandLineFreeVarList (ParamPackage
);
1441 if (Private
!= NULL
) {
1442 IfConfigCleanup (Private
);