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 - 2015, 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";
133 Split a string with specified separator and save the substring to a list.
135 @param[in] String The pointer of the input string.
136 @param[in] Separator The specified separator.
138 @return The pointer of headnode of ARG_LIST.
143 IN CONST CHAR16
*String
,
152 if (*String
== L
'\0') {
157 // Copy the CONST string to a local copy.
159 Str
= AllocateCopyPool (StrSize (String
), String
);
160 ASSERT (Str
!= NULL
);
164 // init a node for the list head.
166 ArgNode
= (ARG_LIST
*) AllocateZeroPool (sizeof (ARG_LIST
));
167 ASSERT (ArgNode
!= NULL
);
171 // Split the local copy and save in the list node.
173 while (*Str
!= L
'\0') {
174 if (*Str
== Separator
) {
176 ArgNode
->Arg
= ArgStr
;
178 ArgNode
->Next
= (ARG_LIST
*) AllocateZeroPool (sizeof (ARG_LIST
));
179 ASSERT (ArgNode
->Next
!= NULL
);
180 ArgNode
= ArgNode
->Next
;
186 ArgNode
->Arg
= ArgStr
;
187 ArgNode
->Next
= NULL
;
193 Check the correctness of input Args with '-s' option.
195 @param[in] CheckList The pointer of VAR_CHECK_ITEM array.
196 @param[in] Name The pointer of input arg.
197 @param[in] Init The switch to execute the check.
199 @return VarCheckOk Valid parameter or Initialize check successfully.
200 @return VarCheckDuplicate Duplicated parameter happened.
201 @return VarCheckConflict Conflicted parameter happened
202 @return VarCheckUnknown Unknown parameter.
206 IfConfigRetriveCheckListByName(
207 IN VAR_CHECK_ITEM
*CheckList
,
212 STATIC UINT32 CheckDuplicate
;
213 STATIC UINT32 CheckConflict
;
214 VAR_CHECK_CODE RtCode
;
226 Arg
= CheckList
[Index
];
229 // Check the Duplicated/Conflicted/Unknown input Args.
231 while (Arg
.FlagStr
!= NULL
) {
232 if (StrCmp (Arg
.FlagStr
, Name
) == 0) {
234 if (CheckDuplicate
& Arg
.FlagID
) {
235 RtCode
= VarCheckDuplicate
;
239 if (CheckConflict
& Arg
.ConflictMask
) {
240 RtCode
= VarCheckConflict
;
244 CheckDuplicate
|= Arg
.FlagID
;
245 CheckConflict
|= Arg
.ConflictMask
;
249 Arg
= CheckList
[++Index
];
252 if (Arg
.FlagStr
== NULL
) {
253 RtCode
= VarCheckUnknown
;
260 The notify function of create event when performing a manual config.
262 @param[in] Event The event this notify function registered to.
263 @param[in] Context Pointer to the context data registered to the event.
268 IfConfigManualAddressNotify (
273 *((BOOLEAN
*) Context
) = TRUE
;
279 @param[in] Node The pointer of MAC address buffer.
280 @param[in] Size The size of MAC address buffer.
284 IfConfigPrintMacAddr (
291 ASSERT (Size
<= MACADDRMAXSIZE
);
293 for (Index
= 0; Index
< Size
; Index
++) {
294 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_MAC_ADDR_BODY
), gShellNetwork1HiiHandle
, Node
[Index
]);
295 if (Index
+ 1 < Size
) {
296 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_COLON
), gShellNetwork1HiiHandle
);
300 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_NEWLINE
), gShellNetwork1HiiHandle
);
305 The get current status of all handles.
307 @param[in] IfName The pointer of IfName(interface name).
308 @param[in] IfList The pointer of IfList(interface list).
310 @retval EFI_SUCCESS The get status processed successfully.
311 @retval others The get status process failed.
315 IfConfigGetInterfaceInfo (
317 IN LIST_ENTRY
*IfList
323 EFI_HANDLE
*HandleBuffer
;
324 EFI_IP4_CONFIG2_PROTOCOL
*Ip4Cfg2
;
325 EFI_IP4_CONFIG2_INTERFACE_INFO
*IfInfo
;
326 IFCONFIG_INTERFACE_CB
*IfCb
;
336 // Locate all the handles with ip4 service binding protocol.
338 Status
= gBS
->LocateHandleBuffer (
340 &gEfiIp4ServiceBindingProtocolGuid
,
345 if (EFI_ERROR (Status
) || (HandleNum
== 0)) {
350 // Enumerate all handles that installed with ip4 service binding protocol.
352 for (HandleIndex
= 0; HandleIndex
< HandleNum
; HandleIndex
++) {
358 // Ip4config protocol and ip4 service binding protocol are installed
359 // on the same handle.
361 ASSERT (HandleBuffer
!= NULL
);
362 Status
= gBS
->HandleProtocol (
363 HandleBuffer
[HandleIndex
],
364 &gEfiIp4Config2ProtocolGuid
,
368 if (EFI_ERROR (Status
)) {
373 // Get the interface information size.
375 Status
= Ip4Cfg2
->GetData (
377 Ip4Config2DataTypeInterfaceInfo
,
382 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
386 IfInfo
= AllocateZeroPool (DataSize
);
388 if (IfInfo
== NULL
) {
389 Status
= EFI_OUT_OF_RESOURCES
;
394 // Get the interface info.
396 Status
= Ip4Cfg2
->GetData (
398 Ip4Config2DataTypeInterfaceInfo
,
403 if (EFI_ERROR (Status
)) {
408 // Check the interface name if required.
410 if ((IfName
!= NULL
) && (StrCmp (IfName
, IfInfo
->Name
) != 0)) {
418 // Get the size of dns server list.
420 Status
= Ip4Cfg2
->GetData (
422 Ip4Config2DataTypeDnsServer
,
427 if ((Status
!= EFI_BUFFER_TOO_SMALL
) && (Status
!= EFI_NOT_FOUND
)) {
431 IfCb
= AllocateZeroPool (sizeof (IFCONFIG_INTERFACE_CB
) + DataSize
);
434 Status
= EFI_OUT_OF_RESOURCES
;
438 IfCb
->NicHandle
= HandleBuffer
[HandleIndex
];
439 IfCb
->IfInfo
= IfInfo
;
440 IfCb
->IfCfg
= Ip4Cfg2
;
441 IfCb
->DnsCnt
= (UINT32
) (DataSize
/ sizeof (EFI_IPv4_ADDRESS
));
444 // Get the dns server list if has.
447 Status
= Ip4Cfg2
->GetData (
449 Ip4Config2DataTypeDnsServer
,
454 if (EFI_ERROR (Status
)) {
460 // Get the config policy.
462 DataSize
= sizeof (EFI_IP4_CONFIG2_POLICY
);
463 Status
= Ip4Cfg2
->GetData (
465 Ip4Config2DataTypePolicy
,
470 if (EFI_ERROR (Status
)) {
474 InsertTailList (IfList
, &IfCb
->Link
);
476 if ((IfName
!= NULL
) && (StrCmp (IfName
, IfInfo
->Name
) == 0)) {
478 // Only need the appointed interface, keep the allocated buffer.
486 if (HandleBuffer
!= NULL
) {
487 FreePool (HandleBuffer
);
494 if (IfInfo
!= NULL
) {
506 The list process of the ifconfig command.
508 @param[in] IfList The pointer of IfList(interface list).
510 @retval SHELL_SUCCESS The ifconfig command list processed successfully.
511 @retval others The ifconfig command list process failed.
515 IfConfigShowInterfaceInfo (
516 IN LIST_ENTRY
*IfList
521 IFCONFIG_INTERFACE_CB
*IfCb
;
522 BOOLEAN MediaPresent
;
523 EFI_IPv4_ADDRESS Gateway
;
528 if (IsListEmpty (IfList
)) {
529 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INVALID_INTERFACE
), gShellNetwork1HiiHandle
);
533 // Go through the interface list.
535 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, IfList
) {
536 IfCb
= NET_LIST_USER_STRUCT (Entry
, IFCONFIG_INTERFACE_CB
, Link
);
538 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_BREAK
), gShellNetwork1HiiHandle
);
541 // Print interface name.
543 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_IF_NAME
), gShellNetwork1HiiHandle
, IfCb
->IfInfo
->Name
);
548 NetLibDetectMedia (IfCb
->NicHandle
, &MediaPresent
);
550 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_MEDIA_STATE
), gShellNetwork1HiiHandle
, L
"Media disconnected");
552 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_MEDIA_STATE
), gShellNetwork1HiiHandle
, L
"Media present");
556 // Print interface config policy.
558 if (IfCb
->Policy
== Ip4Config2PolicyDhcp
) {
559 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_POLICY_DHCP
), gShellNetwork1HiiHandle
);
561 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_POLICY_MAN
), gShellNetwork1HiiHandle
);
565 // Print mac address of the interface.
567 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_MAC_ADDR_HEAD
), gShellNetwork1HiiHandle
);
569 IfConfigPrintMacAddr (
570 IfCb
->IfInfo
->HwAddress
.Addr
,
571 IfCb
->IfInfo
->HwAddressSize
575 // Print IPv4 address list of the interface.
577 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_IP_ADDR_HEAD
), gShellNetwork1HiiHandle
);
583 STRING_TOKEN (STR_IFCONFIG_INFO_IP_ADDR_BODY
),
584 gShellNetwork1HiiHandle
,
585 (UINTN
)IfCb
->IfInfo
->StationAddress
.Addr
[0],
586 (UINTN
)IfCb
->IfInfo
->StationAddress
.Addr
[1],
587 (UINTN
)IfCb
->IfInfo
->StationAddress
.Addr
[2],
588 (UINTN
)IfCb
->IfInfo
->StationAddress
.Addr
[3]
592 // Print subnet mask list of the interface.
594 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_SUBNET_MASK_HEAD
), gShellNetwork1HiiHandle
);
600 STRING_TOKEN (STR_IFCONFIG_INFO_IP_ADDR_BODY
),
601 gShellNetwork1HiiHandle
,
602 (UINTN
)IfCb
->IfInfo
->SubnetMask
.Addr
[0],
603 (UINTN
)IfCb
->IfInfo
->SubnetMask
.Addr
[1],
604 (UINTN
)IfCb
->IfInfo
->SubnetMask
.Addr
[2],
605 (UINTN
)IfCb
->IfInfo
->SubnetMask
.Addr
[3]
609 // Print default gateway of the interface.
611 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_GATEWAY_HEAD
), gShellNetwork1HiiHandle
);
613 ZeroMem (&Gateway
, sizeof (EFI_IPv4_ADDRESS
));
615 for (Index
= 0; Index
< IfCb
->IfInfo
->RouteTableSize
; Index
++) {
616 if ((CompareMem (&IfCb
->IfInfo
->RouteTable
[Index
].SubnetAddress
, &mZeroIp4Addr
, sizeof (EFI_IPv4_ADDRESS
)) == 0) &&
617 (CompareMem (&IfCb
->IfInfo
->RouteTable
[Index
].SubnetMask
, &mZeroIp4Addr
, sizeof (EFI_IPv4_ADDRESS
)) == 0) ){
618 CopyMem (&Gateway
, &IfCb
->IfInfo
->RouteTable
[Index
].GatewayAddress
, sizeof (EFI_IPv4_ADDRESS
));
626 STRING_TOKEN (STR_IFCONFIG_INFO_IP_ADDR_BODY
),
627 gShellNetwork1HiiHandle
,
628 (UINTN
)Gateway
.Addr
[0],
629 (UINTN
)Gateway
.Addr
[1],
630 (UINTN
)Gateway
.Addr
[2],
631 (UINTN
)Gateway
.Addr
[3]
635 // Print route table entry.
637 ShellPrintHiiEx(-1, -1, NULL
,STRING_TOKEN (STR_IFCONFIG_ROUTES_SIZE
), gShellNetwork1HiiHandle
, IfCb
->IfInfo
->RouteTableSize
);
639 for (Index
= 0; Index
< IfCb
->IfInfo
->RouteTableSize
; Index
++) {
640 ShellPrintHiiEx(-1, -1, NULL
,STRING_TOKEN (STR_IFCONFIG_ROUTES_ENTRY_INDEX
), gShellNetwork1HiiHandle
, Index
);
646 STRING_TOKEN (STR_IFCONFIG_SHOW_IP_ADDR
),
647 gShellNetwork1HiiHandle
,
649 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].SubnetAddress
.Addr
[0],
650 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].SubnetAddress
.Addr
[1],
651 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].SubnetAddress
.Addr
[2],
652 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].SubnetAddress
.Addr
[3]
659 STRING_TOKEN (STR_IFCONFIG_SHOW_IP_ADDR
),
660 gShellNetwork1HiiHandle
,
662 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].SubnetMask
.Addr
[0],
663 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].SubnetMask
.Addr
[1],
664 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].SubnetMask
.Addr
[2],
665 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].SubnetMask
.Addr
[3]
672 STRING_TOKEN (STR_IFCONFIG_SHOW_IP_ADDR
),
673 gShellNetwork1HiiHandle
,
675 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].GatewayAddress
.Addr
[0],
676 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].GatewayAddress
.Addr
[1],
677 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].GatewayAddress
.Addr
[2],
678 (UINTN
)IfCb
->IfInfo
->RouteTable
[Index
].GatewayAddress
.Addr
[3]
683 // Print dns server addresses list of the interface if has.
685 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_DNS_ADDR_HEAD
), gShellNetwork1HiiHandle
);
687 for (Index
= 0; Index
< IfCb
->DnsCnt
; Index
++) {
692 STRING_TOKEN (STR_IFCONFIG_INFO_DNS_ADDR_BODY
),
693 gShellNetwork1HiiHandle
,
694 (UINTN
) IfCb
->DnsAddr
[Index
].Addr
[0],
695 (UINTN
) IfCb
->DnsAddr
[Index
].Addr
[1],
696 (UINTN
) IfCb
->DnsAddr
[Index
].Addr
[2],
697 (UINTN
) IfCb
->DnsAddr
[Index
].Addr
[3]
700 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_NEWLINE
), gShellNetwork1HiiHandle
);
704 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INFO_BREAK
), gShellNetwork1HiiHandle
);
706 return SHELL_SUCCESS
;
710 The clean process of the ifconfig command to clear interface info.
712 @param[in] IfList The pointer of IfList(interface list).
714 @retval SHELL_SUCCESS The ifconfig command clean processed successfully.
715 @retval others The ifconfig command clean process failed.
719 IfConfigClearInterfaceInfo (
720 IN LIST_ENTRY
*IfList
724 SHELL_STATUS ShellStatus
;
727 IFCONFIG_INTERFACE_CB
*IfCb
;
728 EFI_IP4_CONFIG2_POLICY Policy
;
730 Policy
= Ip4Config2PolicyDhcp
;
731 Status
= EFI_SUCCESS
;
732 ShellStatus
= SHELL_SUCCESS
;
734 if (IsListEmpty (IfList
)) {
735 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INVALID_INTERFACE
), gShellNetwork1HiiHandle
);
739 // Go through the interface list.
741 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, IfList
) {
742 IfCb
= NET_LIST_USER_STRUCT (Entry
, IFCONFIG_INTERFACE_CB
, Link
);
744 Status
= IfCb
->IfCfg
->SetData (
746 Ip4Config2DataTypePolicy
,
747 sizeof (EFI_IP4_CONFIG2_POLICY
),
750 if (EFI_ERROR (Status
)) {
751 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_AD
), gShellNetwork1HiiHandle
, L
"ifconfig");
752 ShellStatus
= SHELL_ACCESS_DENIED
;
761 The set process of the ifconfig command.
763 @param[in] IfList The pointer of IfList(interface list).
764 @param[in] VarArg The pointer of ARG_LIST(Args with "-s" option).
766 @retval SHELL_SUCCESS The ifconfig command set processed successfully.
767 @retval others The ifconfig command set process failed.
771 IfConfigSetInterfaceInfo (
772 IN LIST_ENTRY
*IfList
,
777 SHELL_STATUS ShellStatus
;
778 IFCONFIG_INTERFACE_CB
*IfCb
;
779 VAR_CHECK_CODE CheckCode
;
780 EFI_EVENT TimeOutEvt
;
784 EFI_IP4_CONFIG2_POLICY Policy
;
785 EFI_IP4_CONFIG2_MANUAL_ADDRESS ManualAddress
;
787 EFI_IPv4_ADDRESS Gateway
;
788 EFI_IPv4_ADDRESS
*Dns
;
792 CONST CHAR16
* TempString
;
796 if (IsListEmpty (IfList
)) {
797 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_INVALID_INTERFACE
), gShellNetwork1HiiHandle
);
798 return SHELL_INVALID_PARAMETER
;
802 // Make sure to set only one interface each time.
804 IfCb
= NET_LIST_USER_STRUCT (IfList
->ForwardLink
, IFCONFIG_INTERFACE_CB
, Link
);
805 Status
= EFI_SUCCESS
;
806 ShellStatus
= SHELL_SUCCESS
;
809 // Initialize check list mechanism.
811 CheckCode
= IfConfigRetriveCheckListByName(
818 // Create events & timers for asynchronous settings.
820 Status
= gBS
->CreateEvent (
827 if (EFI_ERROR (Status
)) {
828 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_AD
), gShellNetwork1HiiHandle
, L
"ifconfig");
829 ShellStatus
= SHELL_ACCESS_DENIED
;
833 Status
= gBS
->CreateEvent (
836 IfConfigManualAddressNotify
,
840 if (EFI_ERROR (Status
)) {
841 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_AD
), gShellNetwork1HiiHandle
, L
"ifconfig");
842 ShellStatus
= SHELL_ACCESS_DENIED
;
847 // Parse the setting variables.
849 while (VarArg
!= NULL
) {
851 // Check invalid parameters (duplication & unknown & conflict).
853 CheckCode
= IfConfigRetriveCheckListByName(
859 if (VarCheckOk
!= CheckCode
) {
861 case VarCheckDuplicate
:
862 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_DUPLICATE_COMMAND
), gShellNetwork1HiiHandle
, VarArg
->Arg
);
865 case VarCheckConflict
:
866 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_CONFLICT_COMMAND
), gShellNetwork1HiiHandle
, VarArg
->Arg
);
869 case VarCheckUnknown
:
871 // To handle unsupported option.
873 TempString
= PermanentString
;
874 if (StringNoCaseCompare(&VarArg
->Arg
, &TempString
) == 0) {
875 ShellPrintHiiEx(-1, -1, NULL
,STRING_TOKEN (STR_IFCONFIG_UNSUPPORTED_OPTION
), gShellNetwork1HiiHandle
, PermanentString
);
880 // To handle unknown option.
882 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_UNKNOWN_COMMAND
), gShellNetwork1HiiHandle
, VarArg
->Arg
);
889 VarArg
= VarArg
->Next
;
894 // Process valid variables.
896 if (StrCmp(VarArg
->Arg
, L
"dhcp") == 0) {
898 // Set dhcp config policy
900 Policy
= Ip4Config2PolicyDhcp
;
901 Status
= IfCb
->IfCfg
->SetData (
903 Ip4Config2DataTypePolicy
,
904 sizeof (EFI_IP4_CONFIG2_POLICY
),
907 if (EFI_ERROR(Status
)) {
908 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_AD
), gShellNetwork1HiiHandle
, L
"ifconfig");
909 ShellStatus
= SHELL_ACCESS_DENIED
;
913 VarArg
= VarArg
->Next
;
915 } else if (StrCmp (VarArg
->Arg
, L
"static") == 0) {
916 VarArg
= VarArg
->Next
;
917 if (VarArg
== NULL
) {
918 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_LACK_COMMAND
), gShellNetwork1HiiHandle
);
919 ShellStatus
= SHELL_INVALID_PARAMETER
;
923 ZeroMem (&ManualAddress
, sizeof (ManualAddress
));
926 // Get manual IP address.
928 Status
= NetLibStrToIp4 (VarArg
->Arg
, &ManualAddress
.Address
);
929 if (EFI_ERROR(Status
)) {
930 ShellPrintHiiEx(-1, -1, NULL
,STRING_TOKEN (STR_IFCONFIG_INVALID_IPADDRESS
), gShellNetwork1HiiHandle
, VarArg
->Arg
);
931 ShellStatus
= SHELL_INVALID_PARAMETER
;
938 VarArg
= VarArg
->Next
;
939 if (VarArg
== NULL
) {
940 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_LACK_COMMAND
), gShellNetwork1HiiHandle
);
941 ShellStatus
= SHELL_INVALID_PARAMETER
;
945 Status
= NetLibStrToIp4 (VarArg
->Arg
, &ManualAddress
.SubnetMask
);
946 if (EFI_ERROR(Status
)) {
947 ShellPrintHiiEx(-1, -1, NULL
,STRING_TOKEN (STR_IFCONFIG_INVALID_IPADDRESS
), gShellNetwork1HiiHandle
, VarArg
->Arg
);
948 ShellStatus
= SHELL_INVALID_PARAMETER
;
955 VarArg
= VarArg
->Next
;
956 if (VarArg
== NULL
) {
957 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_LACK_COMMAND
), gShellNetwork1HiiHandle
);
958 ShellStatus
= SHELL_INVALID_PARAMETER
;
962 Status
= NetLibStrToIp4 (VarArg
->Arg
, &Gateway
);
963 if (EFI_ERROR(Status
)) {
964 ShellPrintHiiEx(-1, -1, NULL
,STRING_TOKEN (STR_IFCONFIG_INVALID_IPADDRESS
), gShellNetwork1HiiHandle
, VarArg
->Arg
);
965 ShellStatus
= SHELL_INVALID_PARAMETER
;
970 // Set manual config policy.
972 Policy
= Ip4Config2PolicyStatic
;
973 Status
= IfCb
->IfCfg
->SetData (
975 Ip4Config2DataTypePolicy
,
976 sizeof (EFI_IP4_CONFIG2_POLICY
),
979 if (EFI_ERROR(Status
)) {
980 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_AD
), gShellNetwork1HiiHandle
, L
"ifconfig");
981 ShellStatus
= SHELL_ACCESS_DENIED
;
986 // Set Manual Address.
990 Status
= IfCb
->IfCfg
->RegisterDataNotify (
992 Ip4Config2DataTypeManualAddress
,
995 if (EFI_ERROR (Status
)) {
996 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_SET_ADDR_FAILED
), gShellNetwork1HiiHandle
, Status
);
997 ShellStatus
= SHELL_ACCESS_DENIED
;
1001 DataSize
= sizeof (EFI_IP4_CONFIG2_MANUAL_ADDRESS
);
1003 Status
= IfCb
->IfCfg
->SetData (
1005 Ip4Config2DataTypeManualAddress
,
1010 if (Status
== EFI_NOT_READY
) {
1011 gBS
->SetTimer (TimeOutEvt
, TimerRelative
, 50000000);
1013 while (EFI_ERROR (gBS
->CheckEvent (TimeOutEvt
))) {
1015 Status
= EFI_SUCCESS
;
1021 IfCb
->IfCfg
->UnregisterDataNotify (
1023 Ip4Config2DataTypeManualAddress
,
1027 if (EFI_ERROR (Status
)) {
1028 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_SET_ADDR_FAILED
), gShellNetwork1HiiHandle
, Status
);
1029 ShellStatus
= SHELL_ACCESS_DENIED
;
1036 DataSize
= sizeof (EFI_IPv4_ADDRESS
);
1038 Status
= IfCb
->IfCfg
->SetData (
1040 Ip4Config2DataTypeGateway
,
1044 if (EFI_ERROR (Status
)) {
1045 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_SET_ADDR_FAILED
), gShellNetwork1HiiHandle
, Status
);
1046 ShellStatus
= SHELL_ACCESS_DENIED
;
1050 VarArg
= VarArg
->Next
;
1052 } else if (StrCmp (VarArg
->Arg
, L
"dns") == 0) {
1054 // Get DNS addresses.
1056 VarArg
= VarArg
->Next
;
1059 while (Tmp
!= NULL
) {
1064 Dns
= AllocatePool (Index
* sizeof (EFI_IPv4_ADDRESS
));
1065 ASSERT(Dns
!= NULL
);
1068 while (Tmp
!= NULL
) {
1069 Status
= NetLibStrToIp4 (Tmp
->Arg
, Dns
+ Index
);
1070 if (EFI_ERROR(Status
)) {
1071 ShellPrintHiiEx(-1, -1, NULL
,STRING_TOKEN (STR_IFCONFIG_INVALID_IPADDRESS
), gShellNetwork1HiiHandle
, Tmp
->Arg
);
1072 ShellStatus
= SHELL_INVALID_PARAMETER
;
1082 // Set DNS addresses.
1084 DataSize
= Index
* sizeof (EFI_IPv4_ADDRESS
);
1086 Status
= IfCb
->IfCfg
->SetData (
1088 Ip4Config2DataTypeDnsServer
,
1092 if (EFI_ERROR (Status
)) {
1093 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_AD
), gShellNetwork1HiiHandle
, L
"ifconfig");
1094 ShellStatus
= SHELL_ACCESS_DENIED
;
1110 The ifconfig command main process.
1112 @param[in] Private The pointer of IFCONFIG_PRIVATE_DATA.
1114 @retval SHELL_SUCCESS ifconfig command processed successfully.
1115 @retval others The ifconfig command process failed.
1120 IN IFCONFIG_PRIVATE_DATA
*Private
1124 SHELL_STATUS ShellStatus
;
1126 ShellStatus
= SHELL_SUCCESS
;
1129 // Get configure information of all interfaces.
1131 Status
= IfConfigGetInterfaceInfo (
1135 if (EFI_ERROR (Status
)) {
1136 ShellStatus
= SHELL_NOT_FOUND
;
1140 switch (Private
->OpCode
) {
1141 case IfConfigOpList
:
1142 ShellStatus
= IfConfigShowInterfaceInfo (&Private
->IfList
);
1145 case IfConfigOpClear
:
1146 ShellStatus
= IfConfigClearInterfaceInfo (&Private
->IfList
);
1150 ShellStatus
= IfConfigSetInterfaceInfo (&Private
->IfList
, Private
->VarArg
);
1154 ShellStatus
= SHELL_UNSUPPORTED
;
1162 The ifconfig command cleanup process, free the allocated memory.
1164 @param[in] Private The pointer of IFCONFIG_PRIVATE_DATA.
1169 IN IFCONFIG_PRIVATE_DATA
*Private
1173 LIST_ENTRY
*NextEntry
;
1174 IFCONFIG_INTERFACE_CB
*IfCb
;
1178 ASSERT (Private
!= NULL
);
1181 // Clean the list which save the set config Args.
1183 if (Private
->VarArg
!= NULL
) {
1184 ArgHead
= Private
->VarArg
;
1186 while (ArgHead
->Next
!= NULL
) {
1187 ArgNode
= ArgHead
->Next
;
1195 if (Private
->IfName
!= NULL
) {
1196 FreePool (Private
->IfName
);
1200 // Clean the IFCONFIG_INTERFACE_CB list.
1202 NET_LIST_FOR_EACH_SAFE (Entry
, NextEntry
, &Private
->IfList
) {
1203 IfCb
= NET_LIST_USER_STRUCT (Entry
, IFCONFIG_INTERFACE_CB
, Link
);
1205 RemoveEntryList (&IfCb
->Link
);
1207 if (IfCb
->IfInfo
!= NULL
) {
1209 FreePool (IfCb
->IfInfo
);
1219 Function for 'ifconfig' command.
1221 @param[in] ImageHandle Handle to the Image (NULL if Internal).
1222 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
1224 @retval EFI_SUCCESS ifconfig command processed successfully.
1225 @retval others The ifconfig command process failed.
1230 ShellCommandRunIfconfig (
1231 IN EFI_HANDLE ImageHandle
,
1232 IN EFI_SYSTEM_TABLE
*SystemTable
1236 IFCONFIG_PRIVATE_DATA
*Private
;
1237 LIST_ENTRY
*ParamPackage
;
1238 SHELL_STATUS ShellStatus
;
1239 CONST CHAR16
*ValueStr
;
1241 CHAR16
*ProblemParam
;
1244 Status
= EFI_INVALID_PARAMETER
;
1246 ShellStatus
= SHELL_SUCCESS
;
1248 Status
= ShellCommandLineParseEx (mIfConfigCheckList
, &ParamPackage
, &ProblemParam
, TRUE
, FALSE
);
1249 if (EFI_ERROR (Status
)) {
1250 if (Status
== EFI_VOLUME_CORRUPTED
&& ProblemParam
!= NULL
) {
1251 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_PARAM_INV
), gShellNetwork1HiiHandle
, L
"ifconfig", ProblemParam
);
1252 FreePool(ProblemParam
);
1253 ShellStatus
= SHELL_INVALID_PARAMETER
;
1262 // To handle unsupported option.
1264 if (ShellCommandLineGetFlag (ParamPackage
, L
"-c")) {
1265 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_UNSUPPORTED_OPTION
), gShellNetwork1HiiHandle
,L
"-c");
1266 ShellStatus
= SHELL_INVALID_PARAMETER
;
1271 // To handle no option.
1273 if (!ShellCommandLineGetFlag (ParamPackage
, L
"-r") && !ShellCommandLineGetFlag (ParamPackage
, L
"-s") &&
1274 !ShellCommandLineGetFlag (ParamPackage
, L
"-l")) {
1275 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_LACK_OPTION
), gShellNetwork1HiiHandle
);
1276 ShellStatus
= SHELL_INVALID_PARAMETER
;
1281 // To handle conflict options.
1283 if (((ShellCommandLineGetFlag (ParamPackage
, L
"-r")) && (ShellCommandLineGetFlag (ParamPackage
, L
"-s"))) ||
1284 ((ShellCommandLineGetFlag (ParamPackage
, L
"-r")) && (ShellCommandLineGetFlag (ParamPackage
, L
"-l"))) ||
1285 ((ShellCommandLineGetFlag (ParamPackage
, L
"-s")) && (ShellCommandLineGetFlag (ParamPackage
, L
"-l")))) {
1286 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_PARAM_CON
), gShellNetwork1HiiHandle
, L
"ifconfig");
1287 ShellStatus
= SHELL_INVALID_PARAMETER
;
1291 Private
= AllocateZeroPool (sizeof (IFCONFIG_PRIVATE_DATA
));
1292 if (Private
== NULL
) {
1293 ShellStatus
= SHELL_OUT_OF_RESOURCES
;
1297 InitializeListHead (&Private
->IfList
);
1300 // To get interface name for the list option.
1302 if (ShellCommandLineGetFlag (ParamPackage
, L
"-l")) {
1303 Private
->OpCode
= IfConfigOpList
;
1304 ValueStr
= ShellCommandLineGetValue (ParamPackage
, L
"-l");
1305 if (ValueStr
!= NULL
) {
1306 Str
= AllocateCopyPool (StrSize (ValueStr
), ValueStr
);
1307 ASSERT (Str
!= NULL
);
1308 Private
->IfName
= Str
;
1313 // To get interface name for the clear option.
1315 if (ShellCommandLineGetFlag (ParamPackage
, L
"-r")) {
1316 Private
->OpCode
= IfConfigOpClear
;
1317 ValueStr
= ShellCommandLineGetValue (ParamPackage
, L
"-r");
1318 if (ValueStr
!= NULL
) {
1319 Str
= AllocateCopyPool (StrSize (ValueStr
), ValueStr
);
1320 ASSERT (Str
!= NULL
);
1321 Private
->IfName
= Str
;
1326 // To get interface name and corresponding Args for the set option.
1328 if (ShellCommandLineGetFlag (ParamPackage
, L
"-s")) {
1329 ValueStr
= ShellCommandLineGetValue (ParamPackage
, L
"-s");
1330 if (ValueStr
== NULL
) {
1331 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_LACK_INTERFACE
), gShellNetwork1HiiHandle
);
1332 ShellStatus
= SHELL_INVALID_PARAMETER
;
1337 // To split the configuration into multi-section.
1339 ArgList
= SplitStrToList (ValueStr
, L
' ');
1340 ASSERT (ArgList
!= NULL
);
1342 Private
->OpCode
= IfConfigOpSet
;
1343 Private
->IfName
= ArgList
->Arg
;
1345 Private
->VarArg
= ArgList
->Next
;
1347 if (Private
->IfName
== NULL
|| Private
->VarArg
== NULL
) {
1348 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_IFCONFIG_LACK_COMMAND
), gShellNetwork1HiiHandle
);
1349 ShellStatus
= SHELL_INVALID_PARAMETER
;
1355 // Main process of ifconfig.
1357 ShellStatus
= IfConfig (Private
);
1361 ShellCommandLineFreeVarList (ParamPackage
);
1363 if (Private
!= NULL
) {
1364 IfConfigCleanup (Private
);