]> git.proxmox.com Git - mirror_edk2.git/blob - ShellPkg/Library/UefiShellNetwork1CommandsLib/Ifconfig.c
ShellPkg: Fix 'ifconfig' can't get the address from dhcp in some case
[mirror_edk2.git] / ShellPkg / Library / UefiShellNetwork1CommandsLib / Ifconfig.c
1 /** @file
2 The implementation for Shell command ifconfig based on IP4Config2 protocol.
3
4 (C) Copyright 2013-2015 Hewlett-Packard Development Company, L.P.<BR>
5 Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>
6
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.
11
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.
14
15 **/
16
17 #include "UefiShellNetwork1CommandsLib.h"
18
19 typedef enum {
20 IfConfigOpList = 1,
21 IfConfigOpSet = 2,
22 IfConfigOpClear = 3
23 } IFCONFIG_OPCODE;
24
25 typedef enum {
26 VarCheckReserved = -1,
27 VarCheckOk = 0,
28 VarCheckDuplicate,
29 VarCheckConflict,
30 VarCheckUnknown,
31 VarCheckLackValue,
32 VarCheckOutOfMem
33 } VAR_CHECK_CODE;
34
35 typedef enum {
36 FlagTypeSingle = 0,
37 FlagTypeNeedVar,
38 FlagTypeNeedSet,
39 FlagTypeSkipUnknown
40 } VAR_CHECK_FLAG_TYPE;
41
42 #define MACADDRMAXSIZE 32
43
44 typedef struct _IFCONFIG_INTERFACE_CB {
45 EFI_HANDLE NicHandle;
46 LIST_ENTRY Link;
47 EFI_IP4_CONFIG2_PROTOCOL *IfCfg;
48 EFI_IP4_CONFIG2_INTERFACE_INFO *IfInfo;
49 EFI_IP4_CONFIG2_POLICY Policy;
50 UINT32 DnsCnt;
51 EFI_IPv4_ADDRESS DnsAddr[1];
52 } IFCONFIG_INTERFACE_CB;
53
54 typedef struct _ARG_LIST ARG_LIST;
55
56 struct _ARG_LIST {
57 ARG_LIST *Next;
58 CHAR16 *Arg;
59 };
60
61 typedef struct _IFCONFIG4_PRIVATE_DATA {
62 LIST_ENTRY IfList;
63
64 UINT32 OpCode;
65 CHAR16 *IfName;
66 ARG_LIST *VarArg;
67 } IFCONFIG_PRIVATE_DATA;
68
69 typedef struct _VAR_CHECK_ITEM{
70 CHAR16 *FlagStr;
71 UINT32 FlagID;
72 UINT32 ConflictMask;
73 VAR_CHECK_FLAG_TYPE FlagType;
74 } VAR_CHECK_ITEM;
75
76 SHELL_PARAM_ITEM mIfConfigCheckList[] = {
77 {
78 L"-b",
79 TypeFlag
80 },
81 {
82 L"-l",
83 TypeValue
84 },
85 {
86 L"-r",
87 TypeValue
88 },
89 {
90 L"-c",
91 TypeValue
92 },
93 {
94 L"-s",
95 TypeMaxValue
96 },
97 {
98 NULL,
99 TypeMax
100 },
101 };
102
103 VAR_CHECK_ITEM mSetCheckList[] = {
104 {
105 L"static",
106 0x00000001,
107 0x00000001,
108 FlagTypeSingle
109 },
110 {
111 L"dhcp",
112 0x00000002,
113 0x00000001,
114 FlagTypeSingle
115 },
116 {
117 L"dns",
118 0x00000008,
119 0x00000004,
120 FlagTypeSingle
121 },
122 {
123 NULL,
124 0x0,
125 0x0,
126 FlagTypeSkipUnknown
127 },
128 };
129
130 STATIC CONST CHAR16 PermanentString[10] = L"PERMANENT";
131
132 /**
133 Split a string with specified separator and save the substring to a list.
134
135 @param[in] String The pointer of the input string.
136 @param[in] Separator The specified separator.
137
138 @return The pointer of headnode of ARG_LIST.
139
140 **/
141 ARG_LIST *
142 SplitStrToList (
143 IN CONST CHAR16 *String,
144 IN CHAR16 Separator
145 )
146 {
147 CHAR16 *Str;
148 CHAR16 *ArgStr;
149 ARG_LIST *ArgList;
150 ARG_LIST *ArgNode;
151
152 if (*String == L'\0') {
153 return NULL;
154 }
155
156 //
157 // Copy the CONST string to a local copy.
158 //
159 Str = AllocateCopyPool (StrSize (String), String);
160 ASSERT (Str != NULL);
161 ArgStr = Str;
162
163 //
164 // init a node for the list head.
165 //
166 ArgNode = (ARG_LIST *) AllocateZeroPool (sizeof (ARG_LIST));
167 ASSERT (ArgNode != NULL);
168 ArgList = ArgNode;
169
170 //
171 // Split the local copy and save in the list node.
172 //
173 while (*Str != L'\0') {
174 if (*Str == Separator) {
175 *Str = L'\0';
176 ArgNode->Arg = ArgStr;
177 ArgStr = Str + 1;
178 ArgNode->Next = (ARG_LIST *) AllocateZeroPool (sizeof (ARG_LIST));
179 ASSERT (ArgNode->Next != NULL);
180 ArgNode = ArgNode->Next;
181 }
182
183 Str++;
184 }
185
186 ArgNode->Arg = ArgStr;
187 ArgNode->Next = NULL;
188
189 return ArgList;
190 }
191
192 /**
193 Check the correctness of input Args with '-s' option.
194
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.
198
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.
203
204 **/
205 VAR_CHECK_CODE
206 IfConfigRetriveCheckListByName(
207 IN VAR_CHECK_ITEM *CheckList,
208 IN CHAR16 *Name,
209 IN BOOLEAN Init
210 )
211 {
212 STATIC UINT32 CheckDuplicate;
213 STATIC UINT32 CheckConflict;
214 VAR_CHECK_CODE RtCode;
215 UINT32 Index;
216 VAR_CHECK_ITEM Arg;
217
218 if (Init) {
219 CheckDuplicate = 0;
220 CheckConflict = 0;
221 return VarCheckOk;
222 }
223
224 RtCode = VarCheckOk;
225 Index = 0;
226 Arg = CheckList[Index];
227
228 //
229 // Check the Duplicated/Conflicted/Unknown input Args.
230 //
231 while (Arg.FlagStr != NULL) {
232 if (StrCmp (Arg.FlagStr, Name) == 0) {
233
234 if (CheckDuplicate & Arg.FlagID) {
235 RtCode = VarCheckDuplicate;
236 break;
237 }
238
239 if (CheckConflict & Arg.ConflictMask) {
240 RtCode = VarCheckConflict;
241 break;
242 }
243
244 CheckDuplicate |= Arg.FlagID;
245 CheckConflict |= Arg.ConflictMask;
246 break;
247 }
248
249 Arg = CheckList[++Index];
250 }
251
252 if (Arg.FlagStr == NULL) {
253 RtCode = VarCheckUnknown;
254 }
255
256 return RtCode;
257 }
258
259 /**
260 The notify function of create event when performing a manual config.
261
262 @param[in] Event The event this notify function registered to.
263 @param[in] Context Pointer to the context data registered to the event.
264
265 **/
266 VOID
267 EFIAPI
268 IfConfigManualAddressNotify (
269 IN EFI_EVENT Event,
270 IN VOID *Context
271 )
272 {
273 *((BOOLEAN *) Context) = TRUE;
274 }
275
276
277 /**
278 Create an IP child, use it to start the auto configuration, then destroy it.
279
280 @param[in] Controller The controller which has the service installed.
281 @param[in] Image The image handle used to open service.
282
283 @retval EFI_SUCCESS The configuration is done.
284 **/
285 EFI_STATUS
286 EFIAPI
287 IfConfigStartIp4(
288 IN EFI_HANDLE Controller,
289 IN EFI_HANDLE Image
290 )
291 {
292 EFI_IP4_PROTOCOL *Ip4;
293 EFI_HANDLE Ip4Handle;
294 EFI_IP4_CONFIG_DATA Ip4ConfigData;
295 EFI_STATUS Status;
296
297 //
298 // Get the Ip4ServiceBinding Protocol
299 //
300 Ip4Handle = NULL;
301 Ip4 = NULL;
302
303 Status = NetLibCreateServiceChild (
304 Controller,
305 Image,
306 &gEfiIp4ServiceBindingProtocolGuid,
307 &Ip4Handle
308 );
309
310 if (EFI_ERROR (Status)) {
311 return Status;
312 }
313
314 Status = gBS->OpenProtocol (
315 Ip4Handle,
316 &gEfiIp4ProtocolGuid,
317 (VOID **) &Ip4,
318 Controller,
319 Image,
320 EFI_OPEN_PROTOCOL_GET_PROTOCOL
321 );
322
323 if (EFI_ERROR (Status)) {
324 goto ON_EXIT;
325 }
326
327 Ip4ConfigData.DefaultProtocol = EFI_IP_PROTO_ICMP;
328 Ip4ConfigData.AcceptAnyProtocol = FALSE;
329 Ip4ConfigData.AcceptIcmpErrors = FALSE;
330 Ip4ConfigData.AcceptBroadcast = FALSE;
331 Ip4ConfigData.AcceptPromiscuous = FALSE;
332 Ip4ConfigData.UseDefaultAddress = TRUE;
333 ZeroMem (&Ip4ConfigData.StationAddress, sizeof (EFI_IPv4_ADDRESS));
334 ZeroMem (&Ip4ConfigData.SubnetMask, sizeof (EFI_IPv4_ADDRESS));
335 Ip4ConfigData.TypeOfService = 0;
336 Ip4ConfigData.TimeToLive = 1;
337 Ip4ConfigData.DoNotFragment = FALSE;
338 Ip4ConfigData.RawData = FALSE;
339 Ip4ConfigData.ReceiveTimeout = 0;
340 Ip4ConfigData.TransmitTimeout = 0;
341
342 Ip4->Configure (Ip4, &Ip4ConfigData);
343
344 ON_EXIT:
345 NetLibDestroyServiceChild (
346 Controller,
347 Image,
348 &gEfiIp4ServiceBindingProtocolGuid,
349 Ip4Handle
350 );
351
352 return Status;
353 }
354
355
356 /**
357 Print MAC address.
358
359 @param[in] Node The pointer of MAC address buffer.
360 @param[in] Size The size of MAC address buffer.
361
362 **/
363 VOID
364 IfConfigPrintMacAddr (
365 IN UINT8 *Node,
366 IN UINT32 Size
367 )
368 {
369 UINTN Index;
370
371 ASSERT (Size <= MACADDRMAXSIZE);
372
373 for (Index = 0; Index < Size; Index++) {
374 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_MAC_ADDR_BODY), gShellNetwork1HiiHandle, Node[Index]);
375 if (Index + 1 < Size) {
376 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_COLON), gShellNetwork1HiiHandle);
377 }
378 }
379
380 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_NEWLINE), gShellNetwork1HiiHandle);
381 }
382
383
384 /**
385 The get current status of all handles.
386
387 @param[in] IfName The pointer of IfName(interface name).
388 @param[in] IfList The pointer of IfList(interface list).
389
390 @retval EFI_SUCCESS The get status processed successfully.
391 @retval others The get status process failed.
392
393 **/
394 EFI_STATUS
395 IfConfigGetInterfaceInfo (
396 IN CHAR16 *IfName,
397 IN LIST_ENTRY *IfList
398 )
399 {
400 EFI_STATUS Status;
401 UINTN HandleIndex;
402 UINTN HandleNum;
403 EFI_HANDLE *HandleBuffer;
404 EFI_IP4_CONFIG2_PROTOCOL *Ip4Cfg2;
405 EFI_IP4_CONFIG2_INTERFACE_INFO *IfInfo;
406 IFCONFIG_INTERFACE_CB *IfCb;
407 UINTN DataSize;
408
409 HandleBuffer = NULL;
410 HandleNum = 0;
411
412 IfInfo = NULL;
413 IfCb = NULL;
414
415 //
416 // Locate all the handles with ip4 service binding protocol.
417 //
418 Status = gBS->LocateHandleBuffer (
419 ByProtocol,
420 &gEfiIp4ServiceBindingProtocolGuid,
421 NULL,
422 &HandleNum,
423 &HandleBuffer
424 );
425 if (EFI_ERROR (Status) || (HandleNum == 0)) {
426 return EFI_ABORTED;
427 }
428
429 //
430 // Enumerate all handles that installed with ip4 service binding protocol.
431 //
432 for (HandleIndex = 0; HandleIndex < HandleNum; HandleIndex++) {
433 IfCb = NULL;
434 IfInfo = NULL;
435 DataSize = 0;
436
437 //
438 // Ip4config protocol and ip4 service binding protocol are installed
439 // on the same handle.
440 //
441 ASSERT (HandleBuffer != NULL);
442 Status = gBS->HandleProtocol (
443 HandleBuffer[HandleIndex],
444 &gEfiIp4Config2ProtocolGuid,
445 (VOID **) &Ip4Cfg2
446 );
447
448 if (EFI_ERROR (Status)) {
449 goto ON_ERROR;
450 }
451
452 //
453 // Get the interface information size.
454 //
455 Status = Ip4Cfg2->GetData (
456 Ip4Cfg2,
457 Ip4Config2DataTypeInterfaceInfo,
458 &DataSize,
459 NULL
460 );
461
462 if (Status != EFI_BUFFER_TOO_SMALL) {
463 goto ON_ERROR;
464 }
465
466 IfInfo = AllocateZeroPool (DataSize);
467
468 if (IfInfo == NULL) {
469 Status = EFI_OUT_OF_RESOURCES;
470 goto ON_ERROR;
471 }
472
473 //
474 // Get the interface info.
475 //
476 Status = Ip4Cfg2->GetData (
477 Ip4Cfg2,
478 Ip4Config2DataTypeInterfaceInfo,
479 &DataSize,
480 IfInfo
481 );
482
483 if (EFI_ERROR (Status)) {
484 goto ON_ERROR;
485 }
486
487 //
488 // Check the interface name if required.
489 //
490 if ((IfName != NULL) && (StrCmp (IfName, IfInfo->Name) != 0)) {
491 FreePool (IfInfo);
492 continue;
493 }
494
495 DataSize = 0;
496
497 //
498 // Get the size of dns server list.
499 //
500 Status = Ip4Cfg2->GetData (
501 Ip4Cfg2,
502 Ip4Config2DataTypeDnsServer,
503 &DataSize,
504 NULL
505 );
506
507 if ((Status != EFI_BUFFER_TOO_SMALL) && (Status != EFI_NOT_FOUND)) {
508 goto ON_ERROR;
509 }
510
511 IfCb = AllocateZeroPool (sizeof (IFCONFIG_INTERFACE_CB) + DataSize);
512
513 if (IfCb == NULL) {
514 Status = EFI_OUT_OF_RESOURCES;
515 goto ON_ERROR;
516 }
517
518 IfCb->NicHandle = HandleBuffer[HandleIndex];
519 IfCb->IfInfo = IfInfo;
520 IfCb->IfCfg = Ip4Cfg2;
521 IfCb->DnsCnt = (UINT32) (DataSize / sizeof (EFI_IPv4_ADDRESS));
522
523 //
524 // Get the dns server list if has.
525 //
526 if (DataSize > 0) {
527 Status = Ip4Cfg2->GetData (
528 Ip4Cfg2,
529 Ip4Config2DataTypeDnsServer,
530 &DataSize,
531 IfCb->DnsAddr
532 );
533
534 if (EFI_ERROR (Status)) {
535 goto ON_ERROR;
536 }
537 }
538
539 //
540 // Get the config policy.
541 //
542 DataSize = sizeof (EFI_IP4_CONFIG2_POLICY);
543 Status = Ip4Cfg2->GetData (
544 Ip4Cfg2,
545 Ip4Config2DataTypePolicy,
546 &DataSize,
547 &IfCb->Policy
548 );
549
550 if (EFI_ERROR (Status)) {
551 goto ON_ERROR;
552 }
553
554 InsertTailList (IfList, &IfCb->Link);
555
556 if ((IfName != NULL) && (StrCmp (IfName, IfInfo->Name) == 0)) {
557 //
558 // Only need the appointed interface, keep the allocated buffer.
559 //
560 IfCb = NULL;
561 IfInfo = NULL;
562 break;
563 }
564 }
565
566 if (HandleBuffer != NULL) {
567 FreePool (HandleBuffer);
568 }
569
570 return EFI_SUCCESS;
571
572 ON_ERROR:
573
574 if (IfInfo != NULL) {
575 FreePool (IfInfo);
576 }
577
578 if (IfCb != NULL) {
579 FreePool (IfCb);
580 }
581
582 return Status;
583 }
584
585 /**
586 The list process of the ifconfig command.
587
588 @param[in] IfList The pointer of IfList(interface list).
589
590 @retval EFI_SUCCESS The ifconfig command list processed successfully.
591 @retval others The ifconfig command list process failed.
592
593 **/
594 EFI_STATUS
595 IfConfigShowInterfaceInfo (
596 IN LIST_ENTRY *IfList
597 )
598 {
599 LIST_ENTRY *Entry;
600 LIST_ENTRY *Next;
601 IFCONFIG_INTERFACE_CB *IfCb;
602 EFI_IPv4_ADDRESS Gateway;
603 UINT32 Index;
604
605 if (IsListEmpty (IfList)) {
606 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INVALID_INTERFACE), gShellNetwork1HiiHandle);
607 }
608
609 //
610 // Go through the interface list.
611 //
612 NET_LIST_FOR_EACH_SAFE (Entry, Next, IfList) {
613 IfCb = NET_LIST_USER_STRUCT (Entry, IFCONFIG_INTERFACE_CB, Link);
614
615 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_BREAK), gShellNetwork1HiiHandle);
616
617 //
618 // Print interface name.
619 //
620 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_IF_NAME), gShellNetwork1HiiHandle, IfCb->IfInfo->Name);
621
622 //
623 // Print interface config policy.
624 //
625 if (IfCb->Policy == Ip4Config2PolicyDhcp) {
626 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_POLICY_DHCP), gShellNetwork1HiiHandle);
627 } else {
628 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_POLICY_MAN), gShellNetwork1HiiHandle);
629 }
630
631 //
632 // Print mac address of the interface.
633 //
634 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_MAC_ADDR_HEAD), gShellNetwork1HiiHandle);
635
636 IfConfigPrintMacAddr (
637 IfCb->IfInfo->HwAddress.Addr,
638 IfCb->IfInfo->HwAddressSize
639 );
640
641 //
642 // Print IPv4 address list of the interface.
643 //
644 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_IP_ADDR_HEAD), gShellNetwork1HiiHandle);
645
646 ShellPrintHiiEx(
647 -1,
648 -1,
649 NULL,
650 STRING_TOKEN (STR_IFCONFIG_INFO_IP_ADDR_BODY),
651 gShellNetwork1HiiHandle,
652 (UINTN)IfCb->IfInfo->StationAddress.Addr[0],
653 (UINTN)IfCb->IfInfo->StationAddress.Addr[1],
654 (UINTN)IfCb->IfInfo->StationAddress.Addr[2],
655 (UINTN)IfCb->IfInfo->StationAddress.Addr[3]
656 );
657
658 //
659 // Print subnet mask list of the interface.
660 //
661 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_SUBNET_MASK_HEAD), gShellNetwork1HiiHandle);
662
663 ShellPrintHiiEx(
664 -1,
665 -1,
666 NULL,
667 STRING_TOKEN (STR_IFCONFIG_INFO_IP_ADDR_BODY),
668 gShellNetwork1HiiHandle,
669 (UINTN)IfCb->IfInfo->SubnetMask.Addr[0],
670 (UINTN)IfCb->IfInfo->SubnetMask.Addr[1],
671 (UINTN)IfCb->IfInfo->SubnetMask.Addr[2],
672 (UINTN)IfCb->IfInfo->SubnetMask.Addr[3]
673 );
674
675 //
676 // Print default gateway of the interface.
677 //
678 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_GATEWAY_HEAD), gShellNetwork1HiiHandle);
679
680 ZeroMem (&Gateway, sizeof (EFI_IPv4_ADDRESS));
681
682 for (Index = 0; Index < IfCb->IfInfo->RouteTableSize; Index++) {
683 if ((CompareMem (&IfCb->IfInfo->RouteTable[Index].SubnetAddress, &mZeroIp4Addr, sizeof (EFI_IPv4_ADDRESS)) == 0) &&
684 (CompareMem (&IfCb->IfInfo->RouteTable[Index].SubnetMask , &mZeroIp4Addr, sizeof (EFI_IPv4_ADDRESS)) == 0) ){
685 CopyMem (&Gateway, &IfCb->IfInfo->RouteTable[Index].GatewayAddress, sizeof (EFI_IPv4_ADDRESS));
686 }
687 }
688
689 ShellPrintHiiEx(
690 -1,
691 -1,
692 NULL,
693 STRING_TOKEN (STR_IFCONFIG_INFO_IP_ADDR_BODY),
694 gShellNetwork1HiiHandle,
695 (UINTN)Gateway.Addr[0],
696 (UINTN)Gateway.Addr[1],
697 (UINTN)Gateway.Addr[2],
698 (UINTN)Gateway.Addr[3]
699 );
700
701 //
702 // Print route table entry.
703 //
704 ShellPrintHiiEx(-1, -1, NULL,STRING_TOKEN (STR_IFCONFIG_ROUTES_SIZE), gShellNetwork1HiiHandle, IfCb->IfInfo->RouteTableSize);
705
706 for (Index = 0; Index < IfCb->IfInfo->RouteTableSize; Index++) {
707 ShellPrintHiiEx(-1, -1, NULL,STRING_TOKEN (STR_IFCONFIG_ROUTES_ENTRY_INDEX), gShellNetwork1HiiHandle, Index);
708
709 ShellPrintHiiEx(
710 -1,
711 -1,
712 NULL,
713 STRING_TOKEN (STR_IFCONFIG_SHOW_IP_ADDR),
714 gShellNetwork1HiiHandle,
715 L"Subnet ",
716 (UINTN)IfCb->IfInfo->RouteTable[Index].SubnetAddress.Addr[0],
717 (UINTN)IfCb->IfInfo->RouteTable[Index].SubnetAddress.Addr[1],
718 (UINTN)IfCb->IfInfo->RouteTable[Index].SubnetAddress.Addr[2],
719 (UINTN)IfCb->IfInfo->RouteTable[Index].SubnetAddress.Addr[3]
720 );
721
722 ShellPrintHiiEx(
723 -1,
724 -1,
725 NULL,
726 STRING_TOKEN (STR_IFCONFIG_SHOW_IP_ADDR),
727 gShellNetwork1HiiHandle,
728 L"Netmask",
729 (UINTN)IfCb->IfInfo->RouteTable[Index].SubnetMask.Addr[0],
730 (UINTN)IfCb->IfInfo->RouteTable[Index].SubnetMask.Addr[1],
731 (UINTN)IfCb->IfInfo->RouteTable[Index].SubnetMask.Addr[2],
732 (UINTN)IfCb->IfInfo->RouteTable[Index].SubnetMask.Addr[3]
733 );
734
735 ShellPrintHiiEx(
736 -1,
737 -1,
738 NULL,
739 STRING_TOKEN (STR_IFCONFIG_SHOW_IP_ADDR),
740 gShellNetwork1HiiHandle,
741 L"Gateway",
742 (UINTN)IfCb->IfInfo->RouteTable[Index].GatewayAddress.Addr[0],
743 (UINTN)IfCb->IfInfo->RouteTable[Index].GatewayAddress.Addr[1],
744 (UINTN)IfCb->IfInfo->RouteTable[Index].GatewayAddress.Addr[2],
745 (UINTN)IfCb->IfInfo->RouteTable[Index].GatewayAddress.Addr[3]
746 );
747 }
748
749 //
750 // Print dns server addresses list of the interface if has.
751 //
752 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_DNS_ADDR_HEAD), gShellNetwork1HiiHandle);
753
754 for (Index = 0; Index < IfCb->DnsCnt; Index++) {
755 ShellPrintHiiEx(
756 -1,
757 -1,
758 NULL,
759 STRING_TOKEN (STR_IFCONFIG_INFO_DNS_ADDR_BODY),
760 gShellNetwork1HiiHandle,
761 (UINTN) IfCb->DnsAddr[Index].Addr[0],
762 (UINTN) IfCb->DnsAddr[Index].Addr[1],
763 (UINTN) IfCb->DnsAddr[Index].Addr[2],
764 (UINTN) IfCb->DnsAddr[Index].Addr[3]
765 );
766
767 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_NEWLINE), gShellNetwork1HiiHandle);
768 }
769 }
770
771 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_BREAK), gShellNetwork1HiiHandle);
772
773 return EFI_SUCCESS;
774 }
775
776 /**
777 The clean process of the ifconfig command to clear interface info.
778
779 @param[in] IfList The pointer of IfList(interface list).
780
781 @retval EFI_SUCCESS The ifconfig command clean processed successfully.
782 @retval others The ifconfig command clean process failed.
783
784 **/
785 EFI_STATUS
786 IfConfigClearInterfaceInfo (
787 IN LIST_ENTRY *IfList
788 )
789 {
790 EFI_STATUS Status;
791 LIST_ENTRY *Entry;
792 LIST_ENTRY *Next;
793 IFCONFIG_INTERFACE_CB *IfCb;
794 EFI_IP4_CONFIG2_POLICY Policy;
795
796 Policy = Ip4Config2PolicyDhcp;
797 Status = EFI_SUCCESS;
798
799 if (IsListEmpty (IfList)) {
800 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INVALID_INTERFACE), gShellNetwork1HiiHandle);
801 }
802
803 //
804 // Go through the interface list.
805 //
806 NET_LIST_FOR_EACH_SAFE (Entry, Next, IfList) {
807 IfCb = NET_LIST_USER_STRUCT (Entry, IFCONFIG_INTERFACE_CB, Link);
808
809 Status = IfCb->IfCfg->SetData (
810 IfCb->IfCfg,
811 Ip4Config2DataTypePolicy,
812 sizeof (EFI_IP4_CONFIG2_POLICY),
813 &Policy
814 );
815
816 if (EFI_ERROR (Status)) {
817 break;
818 }
819 }
820
821 return Status;
822 }
823
824 /**
825 The set process of the ifconfig command.
826
827 @param[in] IfList The pointer of IfList(interface list).
828 @param[in] VarArg The pointer of ARG_LIST(Args with "-s" option).
829
830 @retval EFI_SUCCESS The ifconfig command set processed successfully.
831 @retval others The ifconfig command set process failed.
832
833 **/
834 EFI_STATUS
835 IfConfigSetInterfaceInfo (
836 IN LIST_ENTRY *IfList,
837 IN ARG_LIST *VarArg
838 )
839 {
840
841 EFI_STATUS Status;
842 IFCONFIG_INTERFACE_CB *IfCb;
843 VAR_CHECK_CODE CheckCode;
844 EFI_EVENT TimeOutEvt;
845 EFI_EVENT MappedEvt;
846 BOOLEAN IsAddressOk;
847
848 EFI_IP4_CONFIG2_POLICY Policy;
849 EFI_IP4_CONFIG2_MANUAL_ADDRESS ManualAddress;
850 UINTN DataSize;
851 EFI_IPv4_ADDRESS Gateway;
852 EFI_IPv4_ADDRESS *Dns;
853 ARG_LIST *Tmp;
854 UINTN Index;
855
856 CONST CHAR16* TempString;
857
858 Dns = NULL;
859
860 if (IsListEmpty (IfList)) {
861 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INVALID_INTERFACE), gShellNetwork1HiiHandle);
862 return EFI_INVALID_PARAMETER;
863 }
864
865 //
866 // Make sure to set only one interface each time.
867 //
868 IfCb = NET_LIST_USER_STRUCT (IfList->ForwardLink, IFCONFIG_INTERFACE_CB, Link);
869 Status = EFI_SUCCESS;
870
871 //
872 // Initialize check list mechanism.
873 //
874 CheckCode = IfConfigRetriveCheckListByName(
875 NULL,
876 NULL,
877 TRUE
878 );
879
880 //
881 // Create events & timers for asynchronous settings.
882 //
883 Status = gBS->CreateEvent (
884 EVT_TIMER,
885 TPL_CALLBACK,
886 NULL,
887 NULL,
888 &TimeOutEvt
889 );
890 if (EFI_ERROR (Status)) {
891 goto ON_EXIT;
892 }
893
894 Status = gBS->CreateEvent (
895 EVT_NOTIFY_SIGNAL,
896 TPL_NOTIFY,
897 IfConfigManualAddressNotify,
898 &IsAddressOk,
899 &MappedEvt
900 );
901 if (EFI_ERROR (Status)) {
902 goto ON_EXIT;
903 }
904
905 //
906 // Parse the setting variables.
907 //
908 while (VarArg != NULL) {
909 //
910 // Check invalid parameters (duplication & unknown & conflict).
911 //
912 CheckCode = IfConfigRetriveCheckListByName(
913 mSetCheckList,
914 VarArg->Arg,
915 FALSE
916 );
917
918 if (VarCheckOk != CheckCode) {
919 switch (CheckCode) {
920 case VarCheckDuplicate:
921 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_DUPLICATE_COMMAND), gShellNetwork1HiiHandle, VarArg->Arg);
922 break;
923
924 case VarCheckConflict:
925 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_CONFLICT_COMMAND), gShellNetwork1HiiHandle, VarArg->Arg);
926 break;
927
928 case VarCheckUnknown:
929 //
930 // To handle unsupported option.
931 //
932 TempString = PermanentString;
933 if (StringNoCaseCompare(&VarArg->Arg, &TempString) == 0) {
934 ShellPrintHiiEx(-1, -1, NULL,STRING_TOKEN (STR_IFCONFIG_UNSUPPORTED_OPTION), gShellNetwork1HiiHandle, PermanentString);
935 goto ON_EXIT;
936 }
937
938 //
939 // To handle unknown option.
940 //
941 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_UNKNOWN_COMMAND), gShellNetwork1HiiHandle, VarArg->Arg);
942 break;
943
944 default:
945 break;
946 }
947
948 VarArg = VarArg->Next;
949 continue;
950 }
951
952 //
953 // Process valid variables.
954 //
955 if (StrCmp(VarArg->Arg, L"dhcp") == 0) {
956 if (IfCb->Policy == Ip4Config2PolicyDhcp) {
957 Status = IfConfigStartIp4 (IfCb->NicHandle, gImageHandle);
958 if (EFI_ERROR(Status)) {
959 goto ON_EXIT;
960 }
961 } else {
962 //
963 // Set dhcp config policy
964 //
965 Policy = Ip4Config2PolicyDhcp;
966 Status = IfCb->IfCfg->SetData (
967 IfCb->IfCfg,
968 Ip4Config2DataTypePolicy,
969 sizeof (EFI_IP4_CONFIG2_POLICY),
970 &Policy
971 );
972 if (EFI_ERROR(Status)) {
973 goto ON_EXIT;
974 }
975 }
976
977 VarArg= VarArg->Next;
978
979 } else if (StrCmp (VarArg->Arg, L"static") == 0) {
980 //
981 // Set manual config policy.
982 //
983 Policy = Ip4Config2PolicyStatic;
984 Status = IfCb->IfCfg->SetData (
985 IfCb->IfCfg,
986 Ip4Config2DataTypePolicy,
987 sizeof (EFI_IP4_CONFIG2_POLICY),
988 &Policy
989 );
990
991 if (EFI_ERROR(Status)) {
992 goto ON_EXIT;
993 }
994
995 VarArg= VarArg->Next;
996
997 ZeroMem (&ManualAddress, sizeof (ManualAddress));
998
999 //
1000 // Get manual IP address.
1001 //
1002 Status = NetLibStrToIp4 (VarArg->Arg, &ManualAddress.Address);
1003 if (EFI_ERROR(Status)) {
1004 goto ON_EXIT;
1005 }
1006
1007 //
1008 // Get subnetmask.
1009 //
1010 VarArg = VarArg->Next;
1011 Status = NetLibStrToIp4 (VarArg->Arg, &ManualAddress.SubnetMask);
1012 if (EFI_ERROR(Status)) {
1013 goto ON_EXIT;
1014 }
1015
1016 //
1017 // Get gateway.
1018 //
1019 VarArg = VarArg->Next;
1020 Status = NetLibStrToIp4 (VarArg->Arg, &Gateway);
1021 if (EFI_ERROR(Status)) {
1022 goto ON_EXIT;
1023 }
1024
1025 IsAddressOk = FALSE;
1026
1027 Status = IfCb->IfCfg->RegisterDataNotify (
1028 IfCb->IfCfg,
1029 Ip4Config2DataTypeManualAddress,
1030 MappedEvt
1031 );
1032 if (EFI_ERROR (Status)) {
1033 goto ON_EXIT;
1034 }
1035
1036 DataSize = sizeof (EFI_IP4_CONFIG2_MANUAL_ADDRESS);
1037
1038 Status = IfCb->IfCfg->SetData (
1039 IfCb->IfCfg,
1040 Ip4Config2DataTypeManualAddress,
1041 DataSize,
1042 &ManualAddress
1043 );
1044
1045 if (Status == EFI_NOT_READY) {
1046 gBS->SetTimer (TimeOutEvt, TimerRelative, 50000000);
1047
1048 while (EFI_ERROR (gBS->CheckEvent (TimeOutEvt))) {
1049 if (IsAddressOk) {
1050 Status = EFI_SUCCESS;
1051 break;
1052 }
1053 }
1054 }
1055
1056 IfCb->IfCfg->UnregisterDataNotify (
1057 IfCb->IfCfg,
1058 Ip4Config2DataTypeManualAddress,
1059 MappedEvt
1060 );
1061
1062 if (EFI_ERROR (Status)) {
1063 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_SET_ADDR_FAILED), gShellNetwork1HiiHandle, Status);
1064 goto ON_EXIT;
1065 }
1066
1067 //
1068 // Set gateway.
1069 //
1070 DataSize = sizeof (EFI_IPv4_ADDRESS);
1071
1072 Status = IfCb->IfCfg->SetData (
1073 IfCb->IfCfg,
1074 Ip4Config2DataTypeGateway,
1075 DataSize,
1076 &Gateway
1077 );
1078 VarArg = VarArg->Next;
1079
1080 } else if (StrCmp (VarArg->Arg, L"dns") == 0) {
1081 //
1082 // Get DNS addresses.
1083 //
1084 VarArg = VarArg->Next;
1085 Tmp = VarArg;
1086 Index = 0;
1087 while (Tmp != NULL) {
1088 Index ++;
1089 Tmp = Tmp->Next;
1090 }
1091
1092 Dns = AllocatePool (Index * sizeof (EFI_IPv4_ADDRESS));
1093 ASSERT(Dns != NULL);
1094 Tmp = VarArg;
1095 Index = 0;
1096 while (Tmp != NULL) {
1097 Status = NetLibStrToIp4 (Tmp->Arg, Dns + Index);
1098 if (EFI_ERROR(Status)) {
1099 goto ON_EXIT;
1100 }
1101 Index ++;
1102 Tmp = Tmp->Next;
1103 }
1104
1105 VarArg = Tmp;
1106
1107 //
1108 // Set DNS addresses.
1109 //
1110 DataSize = Index * sizeof (EFI_IPv4_ADDRESS);
1111
1112 Status = IfCb->IfCfg->SetData (
1113 IfCb->IfCfg,
1114 Ip4Config2DataTypeDnsServer,
1115 DataSize,
1116 Dns
1117 );
1118 }
1119 }
1120
1121 ON_EXIT:
1122 if (Dns != NULL) {
1123 FreePool (Dns);
1124 }
1125
1126 return Status;
1127
1128 }
1129
1130 /**
1131 The ifconfig command main process.
1132
1133 @param[in] Private The pointer of IFCONFIG_PRIVATE_DATA.
1134
1135 @retval EFI_SUCCESS ifconfig command processed successfully.
1136 @retval others The ifconfig command process failed.
1137
1138 **/
1139 EFI_STATUS
1140 IfConfig (
1141 IN IFCONFIG_PRIVATE_DATA *Private
1142 )
1143 {
1144 EFI_STATUS Status;
1145
1146 //
1147 // Get configure information of all interfaces.
1148 //
1149 Status = IfConfigGetInterfaceInfo (
1150 Private->IfName,
1151 &Private->IfList
1152 );
1153
1154 if (EFI_ERROR (Status)) {
1155 goto ON_EXIT;
1156 }
1157
1158 switch (Private->OpCode) {
1159 case IfConfigOpList:
1160 Status = IfConfigShowInterfaceInfo (&Private->IfList);
1161 break;
1162
1163 case IfConfigOpClear:
1164 Status = IfConfigClearInterfaceInfo (&Private->IfList);
1165 break;
1166
1167 case IfConfigOpSet:
1168 Status = IfConfigSetInterfaceInfo (&Private->IfList, Private->VarArg);
1169 break;
1170
1171 default:
1172 Status = EFI_ABORTED;
1173 }
1174
1175 ON_EXIT:
1176
1177 return Status;
1178 }
1179
1180 /**
1181 The ifconfig command cleanup process, free the allocated memory.
1182
1183 @param[in] Private The pointer of IFCONFIG_PRIVATE_DATA.
1184
1185 **/
1186 VOID
1187 IfConfigCleanup (
1188 IN IFCONFIG_PRIVATE_DATA *Private
1189 )
1190 {
1191 LIST_ENTRY *Entry;
1192 LIST_ENTRY *NextEntry;
1193 IFCONFIG_INTERFACE_CB *IfCb;
1194 ARG_LIST *ArgNode;
1195 ARG_LIST *ArgHead;
1196
1197 ASSERT (Private != NULL);
1198
1199 //
1200 // Clean the list which save the set config Args.
1201 //
1202 if (Private->VarArg != NULL) {
1203 ArgHead = Private->VarArg;
1204
1205 while (ArgHead->Next != NULL) {
1206 ArgNode = ArgHead->Next;
1207 FreePool (ArgHead);
1208 ArgHead = ArgNode;
1209 }
1210
1211 FreePool (ArgHead);
1212 }
1213
1214 if (Private->IfName != NULL) {
1215 FreePool (Private->IfName);
1216 }
1217
1218 //
1219 // Clean the IFCONFIG_INTERFACE_CB list.
1220 //
1221 NET_LIST_FOR_EACH_SAFE (Entry, NextEntry, &Private->IfList) {
1222 IfCb = NET_LIST_USER_STRUCT (Entry, IFCONFIG_INTERFACE_CB, Link);
1223
1224 RemoveEntryList (&IfCb->Link);
1225
1226 if (IfCb->IfInfo != NULL) {
1227
1228 FreePool (IfCb->IfInfo);
1229 }
1230
1231 FreePool (IfCb);
1232 }
1233
1234 FreePool (Private);
1235 }
1236
1237 /**
1238 Function for 'ifconfig' command.
1239
1240 @param[in] ImageHandle Handle to the Image (NULL if Internal).
1241 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
1242
1243 @retval EFI_SUCCESS ifconfig command processed successfully.
1244 @retval others The ifconfig command process failed.
1245
1246 **/
1247 SHELL_STATUS
1248 EFIAPI
1249 ShellCommandRunIfconfig (
1250 IN EFI_HANDLE ImageHandle,
1251 IN EFI_SYSTEM_TABLE *SystemTable
1252 )
1253 {
1254 EFI_STATUS Status;
1255 IFCONFIG_PRIVATE_DATA *Private;
1256 LIST_ENTRY *ParamPackage;
1257 CONST CHAR16 *ValueStr;
1258 ARG_LIST *ArgList;
1259 CHAR16 *ProblemParam;
1260 CHAR16 *Str;
1261
1262 Private = NULL;
1263
1264 Status = ShellCommandLineParseEx (mIfConfigCheckList, &ParamPackage, &ProblemParam, TRUE, FALSE);
1265 if (EFI_ERROR (Status)) {
1266 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellNetwork1HiiHandle, L"ifconfig", ProblemParam);
1267 goto ON_EXIT;
1268 }
1269
1270 //
1271 // To handle unsupported option.
1272 //
1273 if (ShellCommandLineGetFlag (ParamPackage, L"-c")) {
1274 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_UNSUPPORTED_OPTION), gShellNetwork1HiiHandle,L"-c");
1275 goto ON_EXIT;
1276 }
1277
1278 //
1279 // To handle no option.
1280 //
1281 if (!ShellCommandLineGetFlag (ParamPackage, L"-r") && !ShellCommandLineGetFlag (ParamPackage, L"-s") &&
1282 !ShellCommandLineGetFlag (ParamPackage, L"-l")) {
1283 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_LACK_OPTION), gShellNetwork1HiiHandle);
1284 goto ON_EXIT;
1285 }
1286
1287 //
1288 // To handle conflict options.
1289 //
1290 if (((ShellCommandLineGetFlag (ParamPackage, L"-r")) && (ShellCommandLineGetFlag (ParamPackage, L"-s"))) ||
1291 ((ShellCommandLineGetFlag (ParamPackage, L"-r")) && (ShellCommandLineGetFlag (ParamPackage, L"-l"))) ||
1292 ((ShellCommandLineGetFlag (ParamPackage, L"-s")) && (ShellCommandLineGetFlag (ParamPackage, L"-l")))) {
1293 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_CON), gShellNetwork1HiiHandle, L"ifconfig");
1294 goto ON_EXIT;
1295 }
1296
1297 Status = EFI_INVALID_PARAMETER;
1298
1299 Private = AllocateZeroPool (sizeof (IFCONFIG_PRIVATE_DATA));
1300
1301 if (Private == NULL) {
1302 Status = EFI_OUT_OF_RESOURCES;
1303 goto ON_EXIT;
1304 }
1305
1306 InitializeListHead (&Private->IfList);
1307
1308 //
1309 // To get interface name for the list option.
1310 //
1311 if (ShellCommandLineGetFlag (ParamPackage, L"-l")) {
1312 Private->OpCode = IfConfigOpList;
1313 ValueStr = ShellCommandLineGetValue (ParamPackage, L"-l");
1314 if (ValueStr != NULL) {
1315 Str = AllocateCopyPool (StrSize (ValueStr), ValueStr);
1316 ASSERT (Str != NULL);
1317 Private->IfName = Str;
1318 }
1319 }
1320
1321 //
1322 // To get interface name for the clear option.
1323 //
1324 if (ShellCommandLineGetFlag (ParamPackage, L"-r")) {
1325 Private->OpCode = IfConfigOpClear;
1326 ValueStr = ShellCommandLineGetValue (ParamPackage, L"-r");
1327 if (ValueStr != NULL) {
1328 Str = AllocateCopyPool (StrSize (ValueStr), ValueStr);
1329 ASSERT (Str != NULL);
1330 Private->IfName = Str;
1331 }
1332 }
1333
1334 //
1335 // To get interface name and corresponding Args for the set option.
1336 //
1337 if (ShellCommandLineGetFlag (ParamPackage, L"-s")) {
1338 ValueStr = ShellCommandLineGetValue (ParamPackage, L"-s");
1339 if (ValueStr == NULL) {
1340 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_LACK_INTERFACE), gShellNetwork1HiiHandle);
1341 goto ON_EXIT;
1342 }
1343
1344 //
1345 // To split the configuration into multi-section.
1346 //
1347 ArgList = SplitStrToList (ValueStr, L' ');
1348 ASSERT (ArgList != NULL);
1349
1350 Private->OpCode = IfConfigOpSet;
1351 Private->IfName = ArgList->Arg;
1352
1353 Private->VarArg = ArgList->Next;
1354
1355 if (Private->IfName == NULL || Private->VarArg == NULL) {
1356 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_LACK_COMMAND), gShellNetwork1HiiHandle);
1357 goto ON_EXIT;
1358 }
1359 }
1360
1361 //
1362 // Main process of ifconfig.
1363 //
1364 Status = IfConfig (Private);
1365
1366 ON_EXIT:
1367
1368 ShellCommandLineFreeVarList (ParamPackage);
1369
1370 if (Private != NULL) {
1371 IfConfigCleanup (Private);
1372 }
1373
1374 return Status;
1375 }