[mirror_edk2.git] / ShellPkg / Library / UefiShellNetwork1CommandsLib / Ifconfig.c

/** @file\r
  The implementation for Shell command ifconfig based on IP4Config2 protocol.\r
\r
  (C) Copyright 2013-2015 Hewlett-Packard Development Company, L.P.<BR>\r
  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "UefiShellNetwork1CommandsLib.h"\r
\r
typedef enum {\r
  IfConfigOpList     = 1,\r
  IfConfigOpSet      = 2,\r
  IfConfigOpClear    = 3\r
} IFCONFIG_OPCODE;\r
\r
typedef enum {\r
  VarCheckReserved      = -1,\r
  VarCheckOk            = 0,\r
  VarCheckDuplicate,\r
  VarCheckConflict,\r
  VarCheckUnknown,\r
  VarCheckLackValue,\r
  VarCheckOutOfMem\r
} VAR_CHECK_CODE;\r
\r
typedef enum {\r
  FlagTypeSingle         = 0,\r
  FlagTypeNeedVar,\r
  FlagTypeNeedSet,\r
  FlagTypeSkipUnknown\r
} VAR_CHECK_FLAG_TYPE;\r
\r
#define MACADDRMAXSIZE    32\r
\r
typedef struct _IFCONFIG_INTERFACE_CB {\r
  EFI_HANDLE                                  NicHandle;\r
  LIST_ENTRY                                  Link;\r
  EFI_IP4_CONFIG2_PROTOCOL                    *IfCfg;\r
  EFI_IP4_CONFIG2_INTERFACE_INFO              *IfInfo;\r
  EFI_IP4_CONFIG2_POLICY                      Policy;\r
  UINT32                                      DnsCnt;\r
  EFI_IPv4_ADDRESS                            DnsAddr[1];\r
} IFCONFIG_INTERFACE_CB;\r
\r
typedef struct _ARG_LIST ARG_LIST;\r
\r
struct _ARG_LIST {\r
  ARG_LIST    *Next;\r
  CHAR16      *Arg;\r
};\r
\r
typedef struct _IFCONFIG4_PRIVATE_DATA {\r
  LIST_ENTRY  IfList;\r
\r
  UINT32      OpCode;\r
  CHAR16      *IfName;\r
  ARG_LIST    *VarArg;\r
} IFCONFIG_PRIVATE_DATA;\r
\r
typedef struct _VAR_CHECK_ITEM{\r
  CHAR16                 *FlagStr;\r
  UINT32                 FlagID;\r
  UINT32                 ConflictMask;\r
  VAR_CHECK_FLAG_TYPE    FlagType;\r
} VAR_CHECK_ITEM;\r
\r
SHELL_PARAM_ITEM    mIfConfigCheckList[] = {\r
  {\r
    L"-b",\r
    TypeFlag\r
  },\r
  {\r
    L"-l",\r
    TypeValue\r
  },\r
  {\r
    L"-r",\r
    TypeValue\r
  },\r
  {\r
    L"-c",\r
    TypeValue\r
  },\r
  {\r
    L"-s",\r
    TypeMaxValue\r
  },\r
  {\r
    NULL,\r
    TypeMax\r
  },\r
};\r
\r
VAR_CHECK_ITEM  mSetCheckList[] = {\r
  {\r
   L"static",\r
    0x00000001,\r
    0x00000001,\r
    FlagTypeSingle\r
  },\r
  {\r
    L"dhcp",\r
    0x00000002,\r
    0x00000001,\r
    FlagTypeSingle\r
  },\r
  {\r
    L"dns",\r
    0x00000008,\r
    0x00000004,\r
    FlagTypeSingle\r
  },\r
  {\r
    NULL,\r
    0x0,\r
    0x0,\r
    FlagTypeSkipUnknown\r
  },\r
};\r
\r
STATIC CONST CHAR16 PermanentString[10] = L"PERMANENT";\r
\r
/**\r
  Free the ARG_LIST.\r
\r
  @param List Pointer to ARG_LIST to free.\r
**/\r
VOID\r
FreeArgList (\r
  ARG_LIST       *List\r
)\r
{\r
  ARG_LIST       *Next;\r
  while (List->Next != NULL) {\r
    Next = List->Next;\r
    FreePool (List);\r
    List = Next;\r
  }\r
\r
  FreePool (List);\r
}\r
\r
/**\r
  Split a string with specified separator and save the substring to a list.\r
\r
  @param[in]    String       The pointer of the input string.\r
  @param[in]    Separator    The specified separator.\r
\r
  @return The pointer of headnode of ARG_LIST.\r
\r
**/\r
ARG_LIST *\r
SplitStrToList (\r
  IN CONST CHAR16    *String,\r
  IN CHAR16          Separator\r
  )\r
{\r
  CHAR16      *Str;\r
  CHAR16      *ArgStr;\r
  ARG_LIST    *ArgList;\r
  ARG_LIST    *ArgNode;\r
\r
  if (*String == L'\0') {\r
    return NULL;\r
  }\r
\r
  //\r
  // Copy the CONST string to a local copy.\r
  //\r
  Str = AllocateCopyPool (StrSize (String), String);\r
  if (Str == NULL) {\r
    return NULL;\r
  }\r
  ArgStr  = Str;\r
\r
  //\r
  // init a node for the list head.\r
  //\r
  ArgNode = (ARG_LIST *) AllocateZeroPool (sizeof (ARG_LIST));\r
  if (ArgNode == NULL) {\r
    return NULL;\r
  }\r
  ArgList = ArgNode;\r
\r
  //\r
  // Split the local copy and save in the list node.\r
  //\r
  while (*Str != L'\0') {\r
    if (*Str == Separator) {\r
      *Str          = L'\0';\r
      ArgNode->Arg  = ArgStr;\r
      ArgStr        = Str + 1;\r
      ArgNode->Next = (ARG_LIST *) AllocateZeroPool (sizeof (ARG_LIST));\r
      if (ArgNode->Next == NULL) {\r
        //\r
        // Free the local copy of string stored in the first node\r
        //\r
        FreePool (ArgList->Arg);\r
        FreeArgList (ArgList);\r
        return NULL;\r
      }\r
      ArgNode = ArgNode->Next;\r
    }\r
\r
    Str++;\r
  }\r
\r
  ArgNode->Arg  = ArgStr;\r
  ArgNode->Next = NULL;\r
\r
  return ArgList;\r
}\r
\r
/**\r
  Check the correctness of input Args with '-s' option.\r
\r
  @param[in]    CheckList    The pointer of VAR_CHECK_ITEM array.\r
  @param[in]    Name         The pointer of input arg.\r
  @param[in]    Init         The switch to execute the check.\r
\r
  @return   VarCheckOk          Valid parameter or Initialize check successfully.\r
  @return   VarCheckDuplicate   Duplicated parameter happened.\r
  @return   VarCheckConflict    Conflicted parameter happened\r
  @return   VarCheckUnknown     Unknown parameter.\r
\r
**/\r
VAR_CHECK_CODE\r
IfConfigRetriveCheckListByName(\r
  IN VAR_CHECK_ITEM    *CheckList,\r
  IN CHAR16            *Name,\r
  IN BOOLEAN           Init\r
)\r
{\r
  STATIC UINT32     CheckDuplicate;\r
  STATIC UINT32     CheckConflict;\r
  VAR_CHECK_CODE    RtCode;\r
  UINT32            Index;\r
  VAR_CHECK_ITEM    Arg;\r
\r
  if (Init) {\r
    CheckDuplicate = 0;\r
    CheckConflict  = 0;\r
    return VarCheckOk;\r
  }\r
\r
  RtCode  = VarCheckOk;\r
  Index   = 0;\r
  Arg     = CheckList[Index];\r
\r
  //\r
  // Check the Duplicated/Conflicted/Unknown input Args.\r
  //\r
  while (Arg.FlagStr != NULL) {\r
    if (StrCmp (Arg.FlagStr, Name) == 0) {\r
\r
      if (CheckDuplicate & Arg.FlagID) {\r
        RtCode = VarCheckDuplicate;\r
        break;\r
      }\r
\r
      if (CheckConflict & Arg.ConflictMask) {\r
        RtCode = VarCheckConflict;\r
        break;\r
      }\r
\r
      CheckDuplicate |= Arg.FlagID;\r
      CheckConflict  |= Arg.ConflictMask;\r
      break;\r
    }\r
\r
    Arg = CheckList[++Index];\r
  }\r
\r
  if (Arg.FlagStr == NULL) {\r
    RtCode = VarCheckUnknown;\r
  }\r
\r
  return RtCode;\r
}\r
\r
/**\r
  The notify function of create event when performing a manual config.\r
\r
  @param[in]    Event        The event this notify function registered to.\r
  @param[in]    Context      Pointer to the context data registered to the event.\r
\r
**/\r
VOID\r
EFIAPI\r
IfConfigManualAddressNotify (\r
  IN EFI_EVENT    Event,\r
  IN VOID         *Context\r
  )\r
{\r
  *((BOOLEAN *) Context) = TRUE;\r
}\r
\r
/**\r
  Print MAC address.\r
\r
  @param[in]    Node    The pointer of MAC address buffer.\r
  @param[in]    Size    The size of MAC address buffer.\r
\r
**/\r
VOID\r
IfConfigPrintMacAddr (\r
  IN UINT8     *Node,\r
  IN UINT32    Size\r
  )\r
{\r
  UINTN    Index;\r
\r
  ASSERT (Size <= MACADDRMAXSIZE);\r
\r
  for (Index = 0; Index < Size; Index++) {\r
    ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_MAC_ADDR_BODY), gShellNetwork1HiiHandle, Node[Index]);\r
    if (Index + 1 < Size) {\r
      ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_COLON), gShellNetwork1HiiHandle);\r
    }\r
  }\r
\r
  ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_NEWLINE), gShellNetwork1HiiHandle);\r
}\r
\r
\r
/**\r
  The get current status of all handles.\r
\r
  @param[in]   IfName         The pointer of IfName(interface name).\r
  @param[in]   IfList         The pointer of IfList(interface list).\r
\r
  @retval EFI_SUCCESS    The get status processed successfully.\r
  @retval others         The get status process failed.\r
\r
**/\r
EFI_STATUS\r
IfConfigGetInterfaceInfo (\r
  IN CHAR16        *IfName,\r
  IN LIST_ENTRY    *IfList\r
  )\r
{\r
  EFI_STATUS                       Status;\r
  UINTN                            HandleIndex;\r
  UINTN                            HandleNum;\r
  EFI_HANDLE                       *HandleBuffer;\r
  EFI_IP4_CONFIG2_PROTOCOL         *Ip4Cfg2;\r
  EFI_IP4_CONFIG2_INTERFACE_INFO   *IfInfo;\r
  IFCONFIG_INTERFACE_CB            *IfCb;\r
  UINTN                            DataSize;\r
\r
  HandleBuffer = NULL;\r
  HandleNum    = 0;\r
\r
  IfInfo       = NULL;\r
  IfCb         = NULL;\r
\r
  //\r
  // Locate all the handles with ip4 service binding protocol.\r
  //\r
  Status = gBS->LocateHandleBuffer (\r
                  ByProtocol,\r
                  &gEfiIp4ServiceBindingProtocolGuid,\r
                  NULL,\r
                  &HandleNum,\r
                  &HandleBuffer\r
                 );\r
  if (EFI_ERROR (Status) || (HandleNum == 0)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Enumerate all handles that installed with ip4 service binding protocol.\r
  //\r
  for (HandleIndex = 0; HandleIndex < HandleNum; HandleIndex++) {\r
    IfCb      = NULL;\r
    IfInfo    = NULL;\r
    DataSize  = 0;\r
\r
    //\r
    // Ip4config protocol and ip4 service binding protocol are installed\r
    // on the same handle.\r
    //\r
    ASSERT (HandleBuffer != NULL);\r
    Status = gBS->HandleProtocol (\r
                    HandleBuffer[HandleIndex],\r
                    &gEfiIp4Config2ProtocolGuid,\r
                    (VOID **) &Ip4Cfg2\r
                    );\r
\r
    if (EFI_ERROR (Status)) {\r
      goto ON_ERROR;\r
    }\r
\r
    //\r
    // Get the interface information size.\r
    //\r
    Status = Ip4Cfg2->GetData (\r
                       Ip4Cfg2,\r
                       Ip4Config2DataTypeInterfaceInfo,\r
                       &DataSize,\r
                       NULL\r
                       );\r
\r
    if (Status != EFI_BUFFER_TOO_SMALL) {\r
      goto ON_ERROR;\r
    }\r
\r
    IfInfo = AllocateZeroPool (DataSize);\r
\r
    if (IfInfo == NULL) {\r
      Status = EFI_OUT_OF_RESOURCES;\r
      goto ON_ERROR;\r
    }\r
\r
    //\r
    // Get the interface info.\r
    //\r
    Status = Ip4Cfg2->GetData (\r
                       Ip4Cfg2,\r
                       Ip4Config2DataTypeInterfaceInfo,\r
                       &DataSize,\r
                       IfInfo\r
                       );\r
\r
    if (EFI_ERROR (Status)) {\r
      goto ON_ERROR;\r
    }\r
\r
    //\r
    // Check the interface name if required.\r
    //\r
    if ((IfName != NULL) && (StrCmp (IfName, IfInfo->Name) != 0)) {\r
      FreePool (IfInfo);\r
      continue;\r
    }\r
\r
    DataSize = 0;\r
\r
    //\r
    // Get the size of dns server list.\r
    //\r
    Status = Ip4Cfg2->GetData (\r
                       Ip4Cfg2,\r
                       Ip4Config2DataTypeDnsServer,\r
                       &DataSize,\r
                       NULL\r
                       );\r
\r
    if ((Status != EFI_BUFFER_TOO_SMALL) && (Status != EFI_NOT_FOUND)) {\r
      goto ON_ERROR;\r
    }\r
\r
    IfCb = AllocateZeroPool (sizeof (IFCONFIG_INTERFACE_CB) + DataSize);\r
\r
    if (IfCb == NULL) {\r
      Status = EFI_OUT_OF_RESOURCES;\r
      goto ON_ERROR;\r
    }\r
\r
    IfCb->NicHandle = HandleBuffer[HandleIndex];\r
    IfCb->IfInfo    = IfInfo;\r
    IfCb->IfCfg     = Ip4Cfg2;\r
    IfCb->DnsCnt    = (UINT32) (DataSize / sizeof (EFI_IPv4_ADDRESS));\r
\r
    //\r
    // Get the dns server list if has.\r
    //\r
    if (DataSize > 0) {\r
      Status = Ip4Cfg2->GetData (\r
                         Ip4Cfg2,\r
                         Ip4Config2DataTypeDnsServer,\r
                         &DataSize,\r
                         IfCb->DnsAddr\r
                         );\r
\r
      if (EFI_ERROR (Status)) {\r
        goto ON_ERROR;\r
      }\r
    }\r
\r
    //\r
    // Get the config policy.\r
    //\r
    DataSize = sizeof (EFI_IP4_CONFIG2_POLICY);\r
    Status   = Ip4Cfg2->GetData (\r
                         Ip4Cfg2,\r
                         Ip4Config2DataTypePolicy,\r
                         &DataSize,\r
                         &IfCb->Policy\r
                         );\r
\r
    if (EFI_ERROR (Status)) {\r
      goto ON_ERROR;\r
    }\r
\r
    InsertTailList (IfList, &IfCb->Link);\r
\r
    if ((IfName != NULL) && (StrCmp (IfName, IfInfo->Name) == 0)) {\r
      //\r
      // Only need the appointed interface, keep the allocated buffer.\r
      //\r
      IfCb   = NULL;\r
      IfInfo = NULL;\r
      break;\r
    }\r
  }\r
\r
  if (HandleBuffer != NULL) {\r
    FreePool (HandleBuffer);\r
  }\r
\r
  return EFI_SUCCESS;\r
\r
ON_ERROR:\r
\r
  if (IfInfo != NULL) {\r
    FreePool (IfInfo);\r
  }\r
\r
  if (IfCb != NULL) {\r
    FreePool (IfCb);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  The list process of the ifconfig command.\r
\r
  @param[in]   IfList    The pointer of IfList(interface list).\r
\r
  @retval SHELL_SUCCESS  The ifconfig command list processed successfully.\r
  @retval others         The ifconfig command list process failed.\r
\r
**/\r
SHELL_STATUS\r
IfConfigShowInterfaceInfo (\r
  IN LIST_ENTRY    *IfList\r
  )\r
{\r
  LIST_ENTRY                   *Entry;\r
  LIST_ENTRY                   *Next;\r
  IFCONFIG_INTERFACE_CB        *IfCb;\r
  EFI_STATUS                    MediaStatus;\r
  EFI_IPv4_ADDRESS              Gateway;\r
  UINT32                        Index;\r
\r
  MediaStatus = EFI_SUCCESS;\r
\r
  if (IsListEmpty (IfList)) {\r
    ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INVALID_INTERFACE), gShellNetwork1HiiHandle);\r
  }\r
\r
  //\r
  // Go through the interface list.\r
  //\r
  NET_LIST_FOR_EACH_SAFE (Entry, Next, IfList) {\r
    IfCb = NET_LIST_USER_STRUCT (Entry, IFCONFIG_INTERFACE_CB, Link);\r
\r
    ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_BREAK), gShellNetwork1HiiHandle);\r
\r
    //\r
    // Print interface name.\r
    //\r
    ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_IF_NAME), gShellNetwork1HiiHandle, IfCb->IfInfo->Name);\r
\r
    //\r
    // Get Media State.\r
    //\r
    if (EFI_SUCCESS == NetLibDetectMediaWaitTimeout (IfCb->NicHandle, 0, &MediaStatus)) {\r
      if (MediaStatus != EFI_SUCCESS) {\r
        ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_MEDIA_STATE), gShellNetwork1HiiHandle, L"Media disconnected");\r
      } else {\r
        ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_MEDIA_STATE), gShellNetwork1HiiHandle, L"Media present");\r
      }\r
    } else {\r
      ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_MEDIA_STATE), gShellNetwork1HiiHandle, L"Media state unknown");\r
    }\r
\r
    //\r
    // Print interface config policy.\r
    //\r
    if (IfCb->Policy == Ip4Config2PolicyDhcp) {\r
      ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_POLICY_DHCP), gShellNetwork1HiiHandle);\r
    } else {\r
      ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_POLICY_MAN), gShellNetwork1HiiHandle);\r
    }\r
\r
    //\r
    // Print mac address of the interface.\r
    //\r
    ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_MAC_ADDR_HEAD), gShellNetwork1HiiHandle);\r
\r
    IfConfigPrintMacAddr (\r
      IfCb->IfInfo->HwAddress.Addr,\r
      IfCb->IfInfo->HwAddressSize\r
      );\r
\r
    //\r
    // Print IPv4 address list of the interface.\r
    //\r
    ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_IP_ADDR_HEAD), gShellNetwork1HiiHandle);\r
\r
    ShellPrintHiiEx(\r
      -1,\r
      -1,\r
      NULL,\r
      STRING_TOKEN (STR_IFCONFIG_INFO_IP_ADDR_BODY),\r
      gShellNetwork1HiiHandle,\r
      (UINTN)IfCb->IfInfo->StationAddress.Addr[0],\r
      (UINTN)IfCb->IfInfo->StationAddress.Addr[1],\r
      (UINTN)IfCb->IfInfo->StationAddress.Addr[2],\r
      (UINTN)IfCb->IfInfo->StationAddress.Addr[3]\r
      );\r
\r
    //\r
    // Print subnet mask list of the interface.\r
    //\r
    ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_SUBNET_MASK_HEAD), gShellNetwork1HiiHandle);\r
\r
    ShellPrintHiiEx(\r
      -1,\r
      -1,\r
      NULL,\r
      STRING_TOKEN (STR_IFCONFIG_INFO_IP_ADDR_BODY),\r
      gShellNetwork1HiiHandle,\r
      (UINTN)IfCb->IfInfo->SubnetMask.Addr[0],\r
      (UINTN)IfCb->IfInfo->SubnetMask.Addr[1],\r
      (UINTN)IfCb->IfInfo->SubnetMask.Addr[2],\r
      (UINTN)IfCb->IfInfo->SubnetMask.Addr[3]\r
      );\r
\r
    //\r
    // Print default gateway of the interface.\r
    //\r
    ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_GATEWAY_HEAD), gShellNetwork1HiiHandle);\r
\r
    ZeroMem (&Gateway, sizeof (EFI_IPv4_ADDRESS));\r
\r
    for (Index = 0; Index < IfCb->IfInfo->RouteTableSize; Index++) {\r
      if ((CompareMem (&IfCb->IfInfo->RouteTable[Index].SubnetAddress, &mZeroIp4Addr, sizeof (EFI_IPv4_ADDRESS)) == 0) &&\r
          (CompareMem (&IfCb->IfInfo->RouteTable[Index].SubnetMask   , &mZeroIp4Addr, sizeof (EFI_IPv4_ADDRESS)) == 0) ){\r
        CopyMem (&Gateway, &IfCb->IfInfo->RouteTable[Index].GatewayAddress, sizeof (EFI_IPv4_ADDRESS));\r
      }\r
    }\r
\r
    ShellPrintHiiEx(\r
      -1,\r
      -1,\r
      NULL,\r
      STRING_TOKEN (STR_IFCONFIG_INFO_IP_ADDR_BODY),\r
      gShellNetwork1HiiHandle,\r
      (UINTN)Gateway.Addr[0],\r
      (UINTN)Gateway.Addr[1],\r
      (UINTN)Gateway.Addr[2],\r
      (UINTN)Gateway.Addr[3]\r
      );\r
\r
    //\r
    // Print route table entry.\r
    //\r
    ShellPrintHiiEx(-1, -1, NULL,STRING_TOKEN (STR_IFCONFIG_ROUTES_SIZE), gShellNetwork1HiiHandle, IfCb->IfInfo->RouteTableSize);\r
\r
    for (Index = 0; Index < IfCb->IfInfo->RouteTableSize; Index++) {\r
      ShellPrintHiiEx(-1, -1, NULL,STRING_TOKEN (STR_IFCONFIG_ROUTES_ENTRY_INDEX), gShellNetwork1HiiHandle, Index);\r
\r
      ShellPrintHiiEx(\r
        -1,\r
        -1,\r
        NULL,\r
        STRING_TOKEN (STR_IFCONFIG_SHOW_IP_ADDR),\r
        gShellNetwork1HiiHandle,\r
        L"Subnet ",\r
        (UINTN)IfCb->IfInfo->RouteTable[Index].SubnetAddress.Addr[0],\r
        (UINTN)IfCb->IfInfo->RouteTable[Index].SubnetAddress.Addr[1],\r
        (UINTN)IfCb->IfInfo->RouteTable[Index].SubnetAddress.Addr[2],\r
        (UINTN)IfCb->IfInfo->RouteTable[Index].SubnetAddress.Addr[3]\r
        );\r
\r
      ShellPrintHiiEx(\r
        -1,\r
        -1,\r
        NULL,\r
        STRING_TOKEN (STR_IFCONFIG_SHOW_IP_ADDR),\r
        gShellNetwork1HiiHandle,\r
        L"Netmask",\r
        (UINTN)IfCb->IfInfo->RouteTable[Index].SubnetMask.Addr[0],\r
        (UINTN)IfCb->IfInfo->RouteTable[Index].SubnetMask.Addr[1],\r
        (UINTN)IfCb->IfInfo->RouteTable[Index].SubnetMask.Addr[2],\r
        (UINTN)IfCb->IfInfo->RouteTable[Index].SubnetMask.Addr[3]\r
        );\r
\r
      ShellPrintHiiEx(\r
        -1,\r
        -1,\r
        NULL,\r
        STRING_TOKEN (STR_IFCONFIG_SHOW_IP_ADDR),\r
        gShellNetwork1HiiHandle,\r
        L"Gateway",\r
        (UINTN)IfCb->IfInfo->RouteTable[Index].GatewayAddress.Addr[0],\r
        (UINTN)IfCb->IfInfo->RouteTable[Index].GatewayAddress.Addr[1],\r
        (UINTN)IfCb->IfInfo->RouteTable[Index].GatewayAddress.Addr[2],\r
        (UINTN)IfCb->IfInfo->RouteTable[Index].GatewayAddress.Addr[3]\r
        );\r
    }\r
\r
    //\r
    // Print dns server addresses list of the interface if has.\r
    //\r
    ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_DNS_ADDR_HEAD), gShellNetwork1HiiHandle);\r
\r
    for (Index = 0; Index < IfCb->DnsCnt; Index++) {\r
      ShellPrintHiiEx(\r
        -1,\r
        -1,\r
        NULL,\r
        STRING_TOKEN (STR_IFCONFIG_INFO_DNS_ADDR_BODY),\r
        gShellNetwork1HiiHandle,\r
        (UINTN) IfCb->DnsAddr[Index].Addr[0],\r
        (UINTN) IfCb->DnsAddr[Index].Addr[1],\r
        (UINTN) IfCb->DnsAddr[Index].Addr[2],\r
        (UINTN) IfCb->DnsAddr[Index].Addr[3]\r
        );\r
\r
      ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_NEWLINE), gShellNetwork1HiiHandle);\r
    }\r
  }\r
\r
  ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INFO_BREAK), gShellNetwork1HiiHandle);\r
\r
  return SHELL_SUCCESS;\r
}\r
\r
/**\r
  The clean process of the ifconfig command to clear interface info.\r
\r
  @param[in]   IfList    The pointer of IfList(interface list).\r
  @param[in]   IfName    The pointer of interface name.\r
\r
  @retval SHELL_SUCCESS  The ifconfig command clean processed successfully.\r
  @retval others         The ifconfig command clean process failed.\r
\r
**/\r
SHELL_STATUS\r
IfConfigClearInterfaceInfo (\r
  IN LIST_ENTRY    *IfList,\r
  IN CHAR16        *IfName\r
  )\r
{\r
  EFI_STATUS                Status;\r
  SHELL_STATUS              ShellStatus;\r
  LIST_ENTRY                *Entry;\r
  LIST_ENTRY                *Next;\r
  IFCONFIG_INTERFACE_CB     *IfCb;\r
  EFI_IP4_CONFIG2_POLICY    Policy;\r
\r
  Status = EFI_SUCCESS;\r
  ShellStatus = SHELL_SUCCESS;\r
\r
  if (IsListEmpty (IfList)) {\r
    ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INVALID_INTERFACE), gShellNetwork1HiiHandle);\r
  }\r
\r
  //\r
  // Go through the interface list.\r
  // If the interface name is specified, DHCP DORA process will be\r
  // triggered by the policy transition (static -> dhcp).\r
  //\r
  NET_LIST_FOR_EACH_SAFE (Entry, Next, IfList) {\r
    IfCb = NET_LIST_USER_STRUCT (Entry, IFCONFIG_INTERFACE_CB, Link);\r
\r
    if ((IfName != NULL) && (StrCmp (IfName, IfCb->IfInfo->Name) == 0)) {\r
      Policy = Ip4Config2PolicyStatic;\r
\r
      Status = IfCb->IfCfg->SetData (\r
                              IfCb->IfCfg,\r
                              Ip4Config2DataTypePolicy,\r
                              sizeof (EFI_IP4_CONFIG2_POLICY),\r
                              &Policy\r
                              );\r
      if (EFI_ERROR (Status)) {\r
        ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_ERR_AD), gShellNetwork1HiiHandle, L"ifconfig");\r
        ShellStatus = SHELL_ACCESS_DENIED;\r
        break;\r
      }\r
    }\r
\r
    Policy = Ip4Config2PolicyDhcp;\r
\r
    Status = IfCb->IfCfg->SetData (\r
                            IfCb->IfCfg,\r
                            Ip4Config2DataTypePolicy,\r
                            sizeof (EFI_IP4_CONFIG2_POLICY),\r
                            &Policy\r
                            );\r
    if (EFI_ERROR (Status)) {\r
      ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_ERR_AD), gShellNetwork1HiiHandle, L"ifconfig");\r
      ShellStatus = SHELL_ACCESS_DENIED;\r
      break;\r
    }\r
  }\r
\r
  return ShellStatus;\r
}\r
\r
/**\r
  The set process of the ifconfig command.\r
\r
  @param[in]   IfList    The pointer of IfList(interface list).\r
  @param[in]   VarArg    The pointer of ARG_LIST(Args with "-s" option).\r
\r
  @retval SHELL_SUCCESS  The ifconfig command set processed successfully.\r
  @retval others         The ifconfig command set process failed.\r
\r
**/\r
SHELL_STATUS\r
IfConfigSetInterfaceInfo (\r
  IN LIST_ENTRY    *IfList,\r
  IN ARG_LIST      *VarArg\r
  )\r
{\r
  EFI_STATUS                       Status;\r
  SHELL_STATUS                     ShellStatus;\r
  IFCONFIG_INTERFACE_CB            *IfCb;\r
  VAR_CHECK_CODE                   CheckCode;\r
  EFI_EVENT                        TimeOutEvt;\r
  EFI_EVENT                        MappedEvt;\r
  BOOLEAN                          IsAddressOk;\r
\r
  EFI_IP4_CONFIG2_POLICY           Policy;\r
  EFI_IP4_CONFIG2_MANUAL_ADDRESS   ManualAddress;\r
  UINTN                            DataSize;\r
  EFI_IPv4_ADDRESS                 Gateway;\r
  IP4_ADDR                         SubnetMask;\r
  IP4_ADDR                         TempGateway;\r
  EFI_IPv4_ADDRESS                 *Dns;\r
  ARG_LIST                         *Tmp;\r
  UINTN                            Index;\r
\r
  CONST CHAR16* TempString;\r
\r
  Dns = NULL;\r
\r
  if (IsListEmpty (IfList)) {\r
    ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INVALID_INTERFACE), gShellNetwork1HiiHandle);\r
    return SHELL_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Make sure to set only one interface each time.\r
  //\r
  IfCb   = NET_LIST_USER_STRUCT (IfList->ForwardLink, IFCONFIG_INTERFACE_CB, Link);\r
  Status = EFI_SUCCESS;\r
  ShellStatus = SHELL_SUCCESS;\r
\r
  //\r
  // Initialize check list mechanism.\r
  //\r
  CheckCode = IfConfigRetriveCheckListByName(\r
                NULL,\r
                NULL,\r
                TRUE\r
                );\r
\r
  //\r
  // Create events & timers for asynchronous settings.\r
  //\r
  Status = gBS->CreateEvent (\r
                  EVT_TIMER,\r
                  TPL_CALLBACK,\r
                  NULL,\r
                  NULL,\r
                  &TimeOutEvt\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_ERR_AD), gShellNetwork1HiiHandle, L"ifconfig");\r
    ShellStatus = SHELL_ACCESS_DENIED;\r
    goto ON_EXIT;\r
  }\r
\r
  Status = gBS->CreateEvent (\r
                  EVT_NOTIFY_SIGNAL,\r
                  TPL_NOTIFY,\r
                  IfConfigManualAddressNotify,\r
                  &IsAddressOk,\r
                  &MappedEvt\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_ERR_AD), gShellNetwork1HiiHandle, L"ifconfig");\r
    ShellStatus = SHELL_ACCESS_DENIED;\r
    goto ON_EXIT;\r
  }\r
\r
  //\r
  // Parse the setting variables.\r
  //\r
  while (VarArg != NULL) {\r
    //\r
    // Check invalid parameters (duplication & unknown & conflict).\r
    //\r
    CheckCode = IfConfigRetriveCheckListByName(\r
                  mSetCheckList,\r
                  VarArg->Arg,\r
                  FALSE\r
                  );\r
\r
    if (VarCheckOk != CheckCode) {\r
      switch (CheckCode) {\r
        case VarCheckDuplicate:\r
          ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_DUPLICATE_COMMAND), gShellNetwork1HiiHandle, VarArg->Arg);\r
          break;\r
\r
        case VarCheckConflict:\r
          ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_CONFLICT_COMMAND), gShellNetwork1HiiHandle, VarArg->Arg);\r
          break;\r
\r
        case VarCheckUnknown:\r
          //\r
          // To handle unsupported option.\r
          //\r
          TempString = PermanentString;\r
          if (StringNoCaseCompare(&VarArg->Arg, &TempString) == 0) {\r
            ShellPrintHiiEx(-1, -1, NULL,STRING_TOKEN (STR_IFCONFIG_UNSUPPORTED_OPTION), gShellNetwork1HiiHandle, PermanentString);\r
            goto ON_EXIT;\r
          }\r
\r
          //\r
          // To handle unknown option.\r
          //\r
          ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_UNKNOWN_COMMAND), gShellNetwork1HiiHandle, VarArg->Arg);\r
          break;\r
\r
        default:\r
          break;\r
      }\r
\r
      VarArg = VarArg->Next;\r
      continue;\r
    }\r
\r
    //\r
    // Process valid variables.\r
    //\r
    if (StrCmp(VarArg->Arg, L"dhcp") == 0) {\r
      //\r
      // Set dhcp config policy\r
      //\r
      Policy = Ip4Config2PolicyDhcp;\r
      Status = IfCb->IfCfg->SetData (\r
                              IfCb->IfCfg,\r
                              Ip4Config2DataTypePolicy,\r
                              sizeof (EFI_IP4_CONFIG2_POLICY),\r
                              &Policy\r
                              );\r
      if (EFI_ERROR(Status)) {\r
        ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_ERR_AD), gShellNetwork1HiiHandle, L"ifconfig");\r
        ShellStatus = SHELL_ACCESS_DENIED;\r
        goto ON_EXIT;\r
      }\r
\r
      VarArg= VarArg->Next;\r
\r
    } else if (StrCmp (VarArg->Arg, L"static") == 0) {\r
      VarArg= VarArg->Next;\r
      if (VarArg == NULL) {\r
        ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_LACK_COMMAND), gShellNetwork1HiiHandle);\r
        ShellStatus = SHELL_INVALID_PARAMETER;\r
        goto ON_EXIT;\r
      }\r
\r
      ZeroMem (&ManualAddress, sizeof (ManualAddress));\r
\r
      //\r
      // Get manual IP address.\r
      //\r
      Status = NetLibStrToIp4 (VarArg->Arg, &ManualAddress.Address);\r
      if (EFI_ERROR(Status)) {\r
        ShellPrintHiiEx(-1, -1, NULL,STRING_TOKEN (STR_IFCONFIG_INVALID_IPADDRESS), gShellNetwork1HiiHandle, VarArg->Arg);\r
        ShellStatus = SHELL_INVALID_PARAMETER;\r
        goto ON_EXIT;\r
      }\r
\r
      //\r
      // Get subnetmask.\r
      //\r
      VarArg = VarArg->Next;\r
      if (VarArg == NULL) {\r
        ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_LACK_COMMAND), gShellNetwork1HiiHandle);\r
        ShellStatus = SHELL_INVALID_PARAMETER;\r
        goto ON_EXIT;\r
      }\r
\r
      Status = NetLibStrToIp4 (VarArg->Arg, &ManualAddress.SubnetMask);\r
      if (EFI_ERROR(Status)) {\r
        ShellPrintHiiEx(-1, -1, NULL,STRING_TOKEN (STR_IFCONFIG_INVALID_IPADDRESS), gShellNetwork1HiiHandle, VarArg->Arg);\r
        ShellStatus = SHELL_INVALID_PARAMETER;\r
        goto ON_EXIT;\r
      }\r
\r
      //\r
      // Get gateway.\r
      //\r
      VarArg = VarArg->Next;\r
      if (VarArg == NULL) {\r
        ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_LACK_COMMAND), gShellNetwork1HiiHandle);\r
        ShellStatus = SHELL_INVALID_PARAMETER;\r
        goto ON_EXIT;\r
      }\r
\r
      Status = NetLibStrToIp4 (VarArg->Arg, &Gateway);\r
      if (EFI_ERROR(Status)) {\r
        ShellPrintHiiEx(-1, -1, NULL,STRING_TOKEN (STR_IFCONFIG_INVALID_IPADDRESS), gShellNetwork1HiiHandle, VarArg->Arg);\r
        ShellStatus = SHELL_INVALID_PARAMETER;\r
        goto ON_EXIT;\r
      }\r
\r
      //\r
      // Need to check the gateway validity before set Manual Address.\r
      // In case we can set manual address but fail to configure Gateway.\r
      //\r
      CopyMem (&SubnetMask, &ManualAddress.SubnetMask, sizeof (IP4_ADDR));\r
      CopyMem (&TempGateway, &Gateway, sizeof (IP4_ADDR));\r
      SubnetMask  = NTOHL (SubnetMask);\r
      TempGateway = NTOHL (TempGateway);\r
      if ((SubnetMask != 0) &&\r
          (SubnetMask != 0xFFFFFFFFu) &&\r
          !NetIp4IsUnicast (TempGateway, SubnetMask)) {\r
        ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_INVALID_GATEWAY), gShellNetwork1HiiHandle, VarArg->Arg);\r
        ShellStatus = SHELL_INVALID_PARAMETER;\r
        goto ON_EXIT;\r
      }\r
\r
      //\r
      // Set manual config policy.\r
      //\r
      Policy = Ip4Config2PolicyStatic;\r
      Status = IfCb->IfCfg->SetData (\r
                              IfCb->IfCfg,\r
                              Ip4Config2DataTypePolicy,\r
                              sizeof (EFI_IP4_CONFIG2_POLICY),\r
                              &Policy\r
                              );\r
      if (EFI_ERROR(Status)) {\r
        ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_ERR_AD), gShellNetwork1HiiHandle, L"ifconfig");\r
        ShellStatus = SHELL_ACCESS_DENIED;\r
        goto ON_EXIT;\r
      }\r
\r
      //\r
      // Set Manual Address.\r
      //\r
      IsAddressOk = FALSE;\r
\r
      Status = IfCb->IfCfg->RegisterDataNotify (\r
                              IfCb->IfCfg,\r
                              Ip4Config2DataTypeManualAddress,\r
                              MappedEvt\r
                              );\r
      if (EFI_ERROR (Status)) {\r
        ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_SET_ADDR_FAILED), gShellNetwork1HiiHandle, Status);\r
        ShellStatus = SHELL_ACCESS_DENIED;\r
        goto ON_EXIT;\r
      }\r
\r
      DataSize = sizeof (EFI_IP4_CONFIG2_MANUAL_ADDRESS);\r
\r
      Status = IfCb->IfCfg->SetData (\r
                              IfCb->IfCfg,\r
                              Ip4Config2DataTypeManualAddress,\r
                              DataSize,\r
                              &ManualAddress\r
                              );\r
\r
      if (Status == EFI_NOT_READY) {\r
        gBS->SetTimer (TimeOutEvt, TimerRelative, 50000000);\r
\r
        while (EFI_ERROR (gBS->CheckEvent (TimeOutEvt))) {\r
          if (IsAddressOk) {\r
            Status = EFI_SUCCESS;\r
            break;\r
          }\r
        }\r
      }\r
\r
      IfCb->IfCfg->UnregisterDataNotify (\r
                     IfCb->IfCfg,\r
                     Ip4Config2DataTypeManualAddress,\r
                     MappedEvt\r
                     );\r
\r
      if (EFI_ERROR (Status)) {\r
        ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_SET_ADDR_FAILED), gShellNetwork1HiiHandle, Status);\r
        ShellStatus = SHELL_ACCESS_DENIED;\r
        goto ON_EXIT;\r
      }\r
\r
      //\r
      // Set gateway.\r
      //\r
      DataSize = sizeof (EFI_IPv4_ADDRESS);\r
\r
      Status = IfCb->IfCfg->SetData (\r
                              IfCb->IfCfg,\r
                              Ip4Config2DataTypeGateway,\r
                              DataSize,\r
                              &Gateway\r
                              );\r
      if (EFI_ERROR (Status)) {\r
        ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_SET_ADDR_FAILED), gShellNetwork1HiiHandle, Status);\r
        ShellStatus = SHELL_ACCESS_DENIED;\r
        goto ON_EXIT;\r
      }\r
\r
      VarArg = VarArg->Next;\r
\r
    } else if (StrCmp (VarArg->Arg, L"dns") == 0) {\r
      //\r
      // Get DNS addresses.\r
      //\r
      VarArg = VarArg->Next;\r
      Tmp    = VarArg;\r
      Index  = 0;\r
      while (Tmp != NULL) {\r
        Index ++;\r
        Tmp = Tmp->Next;\r
      }\r
\r
      Dns   = AllocatePool (Index * sizeof (EFI_IPv4_ADDRESS));\r
      if (Dns == NULL) {\r
        ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_OUT_MEM), gShellNetwork1HiiHandle, L"ifconfig");\r
        ShellStatus = SHELL_OUT_OF_RESOURCES;\r
        goto ON_EXIT;\r
      }\r
      Tmp   = VarArg;\r
      Index = 0;\r
      while (Tmp != NULL) {\r
        Status = NetLibStrToIp4 (Tmp->Arg, Dns + Index);\r
        if (EFI_ERROR(Status)) {\r
          ShellPrintHiiEx(-1, -1, NULL,STRING_TOKEN (STR_IFCONFIG_INVALID_IPADDRESS), gShellNetwork1HiiHandle, Tmp->Arg);\r
          ShellStatus = SHELL_INVALID_PARAMETER;\r
          goto ON_EXIT;\r
        }\r
        Index ++;\r
        Tmp = Tmp->Next;\r
      }\r
\r
      VarArg = Tmp;\r
\r
      //\r
      // Set DNS addresses.\r
      //\r
      DataSize = Index * sizeof (EFI_IPv4_ADDRESS);\r
\r
      Status = IfCb->IfCfg->SetData (\r
                              IfCb->IfCfg,\r
                              Ip4Config2DataTypeDnsServer,\r
                              DataSize,\r
                              Dns\r
                              );\r
      if (EFI_ERROR (Status)) {\r
        ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_ERR_AD), gShellNetwork1HiiHandle, L"ifconfig");\r
        ShellStatus = SHELL_ACCESS_DENIED;\r
        goto ON_EXIT;\r
      }\r
    }\r
  }\r
\r
ON_EXIT:\r
  if (Dns != NULL) {\r
    FreePool (Dns);\r
  }\r
\r
  return ShellStatus;\r
\r
}\r
\r
/**\r
  The ifconfig command main process.\r
\r
  @param[in]   Private    The pointer of IFCONFIG_PRIVATE_DATA.\r
\r
  @retval SHELL_SUCCESS  ifconfig command processed successfully.\r
  @retval others         The ifconfig command process failed.\r
\r
**/\r
SHELL_STATUS\r
IfConfig (\r
  IN IFCONFIG_PRIVATE_DATA    *Private\r
  )\r
{\r
  EFI_STATUS    Status;\r
  SHELL_STATUS  ShellStatus;\r
\r
  ShellStatus = SHELL_SUCCESS;\r
\r
  //\r
  // Get configure information of all interfaces.\r
  //\r
  Status = IfConfigGetInterfaceInfo (\r
             Private->IfName,\r
             &Private->IfList\r
             );\r
  if (EFI_ERROR (Status)) {\r
    ShellStatus = SHELL_NOT_FOUND;\r
    goto ON_EXIT;\r
  }\r
\r
  switch (Private->OpCode) {\r
  case IfConfigOpList:\r
    ShellStatus = IfConfigShowInterfaceInfo (&Private->IfList);\r
    break;\r
\r
  case IfConfigOpClear:\r
    ShellStatus = IfConfigClearInterfaceInfo (&Private->IfList, Private->IfName);\r
    break;\r
\r
  case IfConfigOpSet:\r
    ShellStatus = IfConfigSetInterfaceInfo (&Private->IfList, Private->VarArg);\r
    break;\r
\r
  default:\r
    ShellStatus = SHELL_UNSUPPORTED;\r
  }\r
\r
ON_EXIT:\r
  return ShellStatus;\r
}\r
\r
/**\r
  The ifconfig command cleanup process, free the allocated memory.\r
\r
  @param[in]   Private    The pointer of  IFCONFIG_PRIVATE_DATA.\r
\r
**/\r
VOID\r
IfConfigCleanup (\r
  IN IFCONFIG_PRIVATE_DATA  *Private\r
  )\r
{\r
  LIST_ENTRY                *Entry;\r
  LIST_ENTRY                *NextEntry;\r
  IFCONFIG_INTERFACE_CB     *IfCb;\r
\r
  ASSERT (Private != NULL);\r
\r
  //\r
  // Clean the list which save the set config Args.\r
  //\r
  if (Private->VarArg != NULL) {\r
    FreeArgList (Private->VarArg);\r
  }\r
\r
  if (Private->IfName != NULL) {\r
    FreePool (Private->IfName);\r
  }\r
\r
  //\r
  // Clean the IFCONFIG_INTERFACE_CB list.\r
  //\r
  NET_LIST_FOR_EACH_SAFE (Entry, NextEntry, &Private->IfList) {\r
    IfCb = NET_LIST_USER_STRUCT (Entry, IFCONFIG_INTERFACE_CB, Link);\r
\r
    RemoveEntryList (&IfCb->Link);\r
\r
    if (IfCb->IfInfo != NULL) {\r
\r
      FreePool (IfCb->IfInfo);\r
    }\r
\r
    FreePool (IfCb);\r
  }\r
\r
  FreePool (Private);\r
}\r
\r
/**\r
  Function for 'ifconfig' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
\r
  @retval EFI_SUCCESS    ifconfig command processed successfully.\r
  @retval others         The ifconfig command process failed.\r
\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunIfconfig (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS                Status;\r
  IFCONFIG_PRIVATE_DATA     *Private;\r
  LIST_ENTRY                *ParamPackage;\r
  SHELL_STATUS              ShellStatus;\r
  CONST CHAR16              *ValueStr;\r
  ARG_LIST                  *ArgList;\r
  CHAR16                    *ProblemParam;\r
  CHAR16                    *Str;\r
\r
  Status = EFI_INVALID_PARAMETER;\r
  Private = NULL;\r
  ShellStatus = SHELL_SUCCESS;\r
\r
  Status = ShellCommandLineParseEx (mIfConfigCheckList, &ParamPackage, &ProblemParam, TRUE, FALSE);\r
  if (EFI_ERROR (Status)) {\r
    if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {\r
      ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellNetwork1HiiHandle, L"ifconfig", ProblemParam);\r
      FreePool(ProblemParam);\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else {\r
      ASSERT(FALSE);\r
    }\r
\r
    goto ON_EXIT;\r
  }\r
\r
  //\r
  // To handle unsupported option.\r
  //\r
  if (ShellCommandLineGetFlag (ParamPackage, L"-c")) {\r
    ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_UNSUPPORTED_OPTION), gShellNetwork1HiiHandle,L"-c");\r
    ShellStatus = SHELL_INVALID_PARAMETER;\r
    goto ON_EXIT;\r
  }\r
\r
  //\r
  // To handle no option.\r
  //\r
  if (!ShellCommandLineGetFlag (ParamPackage, L"-r") && !ShellCommandLineGetFlag (ParamPackage, L"-s") &&\r
      !ShellCommandLineGetFlag (ParamPackage, L"-l")) {\r
    ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_LACK_OPTION), gShellNetwork1HiiHandle);\r
    ShellStatus = SHELL_INVALID_PARAMETER;\r
    goto ON_EXIT;\r
  }\r
\r
  //\r
  // To handle conflict options.\r
  //\r
  if (((ShellCommandLineGetFlag (ParamPackage, L"-r")) && (ShellCommandLineGetFlag (ParamPackage, L"-s"))) ||\r
      ((ShellCommandLineGetFlag (ParamPackage, L"-r")) && (ShellCommandLineGetFlag (ParamPackage, L"-l"))) ||\r
      ((ShellCommandLineGetFlag (ParamPackage, L"-s")) && (ShellCommandLineGetFlag (ParamPackage, L"-l")))) {\r
    ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_CON), gShellNetwork1HiiHandle, L"ifconfig");\r
    ShellStatus = SHELL_INVALID_PARAMETER;\r
    goto ON_EXIT;\r
  }\r
\r
  Private = AllocateZeroPool (sizeof (IFCONFIG_PRIVATE_DATA));\r
  if (Private == NULL) {\r
    ShellStatus = SHELL_OUT_OF_RESOURCES;\r
    goto ON_EXIT;\r
  }\r
\r
  InitializeListHead (&Private->IfList);\r
\r
  //\r
  // To get interface name for the list option.\r
  //\r
  if (ShellCommandLineGetFlag (ParamPackage, L"-l")) {\r
    Private->OpCode = IfConfigOpList;\r
    ValueStr = ShellCommandLineGetValue (ParamPackage, L"-l");\r
    if (ValueStr != NULL) {\r
      Str = AllocateCopyPool (StrSize (ValueStr), ValueStr);\r
      if (Str == NULL) {\r
        ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_OUT_MEM), gShellNetwork1HiiHandle, L"ifconfig");\r
        ShellStatus = SHELL_OUT_OF_RESOURCES;\r
        goto ON_EXIT;\r
      }\r
      Private->IfName = Str;\r
    }\r
  }\r
\r
  //\r
  // To get interface name for the clear option.\r
  //\r
  if (ShellCommandLineGetFlag (ParamPackage, L"-r")) {\r
    Private->OpCode = IfConfigOpClear;\r
    ValueStr = ShellCommandLineGetValue (ParamPackage, L"-r");\r
    if (ValueStr != NULL) {\r
      Str = AllocateCopyPool (StrSize (ValueStr), ValueStr);\r
      if (Str == NULL) {\r
        ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_OUT_MEM), gShellNetwork1HiiHandle, L"ifconfig");\r
        ShellStatus = SHELL_OUT_OF_RESOURCES;\r
        goto ON_EXIT;\r
      }\r
      Private->IfName = Str;\r
    }\r
  }\r
\r
  //\r
  // To get interface name and corresponding Args for the set option.\r
  //\r
  if (ShellCommandLineGetFlag (ParamPackage, L"-s")) {\r
    ValueStr = ShellCommandLineGetValue (ParamPackage, L"-s");\r
    if (ValueStr == NULL) {\r
      ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_LACK_INTERFACE), gShellNetwork1HiiHandle);\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
      goto ON_EXIT;\r
    }\r
\r
    //\r
    // To split the configuration into multi-section.\r
    //\r
    ArgList = SplitStrToList (ValueStr, L' ');\r
    if (ArgList == NULL) {\r
      ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_OUT_MEM), gShellNetwork1HiiHandle, L"ifconfig");\r
      ShellStatus = SHELL_OUT_OF_RESOURCES;\r
      goto ON_EXIT;\r
    }\r
\r
    Private->OpCode = IfConfigOpSet;\r
    Private->IfName = ArgList->Arg;\r
\r
    Private->VarArg = ArgList->Next;\r
\r
    if (Private->IfName == NULL || Private->VarArg == NULL) {\r
      ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_IFCONFIG_LACK_COMMAND), gShellNetwork1HiiHandle);\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
      goto ON_EXIT;\r
    }\r
  }\r
\r
  //\r
  // Main process of ifconfig.\r
  //\r
  ShellStatus = IfConfig (Private);\r
\r
ON_EXIT:\r
\r
  ShellCommandLineFreeVarList (ParamPackage);\r
\r
  if (Private != NULL) {\r
    IfConfigCleanup (Private);\r
  }\r
\r
  return ShellStatus;\r
}\r