Re: [PATCH 2/2] ShellPkg/Ifconfig: Enable setting MAC address

["Carsey, Jaben" <jaben.carsey@intel.com>]

I think this is a good idea. But I see 2 issues.  
1 - ifconfig standard parameters are controlled by the UEFI Shell Specification.  If you want to extend the parameters you need to use parameters that start with underscore.  I do not quite know how to so this under the "-s" set of functions for this command.  Maybe just add this separate from "-s", using something like "-_mac"?
2 - whatever change is done here should also be done to the ipv6 version of the command.

-Jaben


> -----Original Message-----
> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of
> Marcin Wojtas
> Sent: Friday, November 04, 2016 11:29 AM
> To: edk2-devel@lists.01.org
> Cc: Tian, Feng <feng.tian@intel.com>; leif.lindholm@linaro.org; Gao, Liming
> <liming.gao@intel.com>; Kinney, Michael D <michael.d.kinney@intel.com>
> Subject: [edk2] [PATCH 2/2] ShellPkg/Ifconfig: Enable setting MAC address
> Importance: High
> 
> This adds new feature to ifconfig shell command, which allow
> for updating MAC address of the interface or resetting it to the
> initial value.
> 
> It consumes newly added NetLib helpers for parsing the Unicode
> string to EFI_MAC_ADDRESS, calling Snp->StationAddress() callback
> and reconnecting controller, so that all interface's children
> devices could get updated with new value of the MAC address.
> 
> Contributed-under: TianoCore Contribution Agreement 1.0
> Signed-off-by: Marcin Wojtas <mw@semihalf.com>
> ---
>  .../UefiShellNetwork1CommandsLib/Ifconfig.c        | 54
> ++++++++++++++++++++++
>  .../UefiShellNetwork1CommandsLib.uni               | 12 ++++-
>  2 files changed, 64 insertions(+), 2 deletions(-)
> 
> diff --git a/ShellPkg/Library/UefiShellNetwork1CommandsLib/Ifconfig.c
> b/ShellPkg/Library/UefiShellNetwork1CommandsLib/Ifconfig.c
> index 5e243d5..e4ea308 100644
> --- a/ShellPkg/Library/UefiShellNetwork1CommandsLib/Ifconfig.c
> +++ b/ShellPkg/Library/UefiShellNetwork1CommandsLib/Ifconfig.c
> @@ -120,6 +120,12 @@ VAR_CHECK_ITEM  mSetCheckList[] = {
>      FlagTypeSingle
>    },
>    {
> +    L"mac",
> +    0x00000010,
> +    0x00000005,
> +    FlagTypeSingle
> +  },
> +  {
>      NULL,
>      0x0,
>      0x0,
> @@ -832,6 +838,7 @@ IfConfigSetInterfaceInfo (
>    EFI_EVENT                        TimeOutEvt;
>    EFI_EVENT                        MappedEvt;
>    BOOLEAN                          IsAddressOk;
> +  BOOLEAN                          MacAddressReset;
> 
>    EFI_IP4_CONFIG2_POLICY           Policy;
>    EFI_IP4_CONFIG2_MANUAL_ADDRESS   ManualAddress;
> @@ -840,6 +847,7 @@ IfConfigSetInterfaceInfo (
>    EFI_IPv4_ADDRESS                 *Dns;
>    ARG_LIST                         *Tmp;
>    UINTN                            Index;
> +  EFI_MAC_ADDRESS                  NewMac;
> 
>    CONST CHAR16* TempString;
> 
> @@ -1150,6 +1158,52 @@ IfConfigSetInterfaceInfo (
>          ShellStatus = SHELL_ACCESS_DENIED;
>          goto ON_EXIT;
>        }
> +    } else if (StrCmp (VarArg->Arg, L"mac") == 0) {
> +      //
> +      // Set MAC address.
> +      //
> +      MacAddressReset = FALSE;
> +      VarArg = VarArg->Next;
> +      if (VarArg == NULL) {
> +        ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN
> (STR_IFCONFIG_LACK_COMMAND), gShellNetwork1HiiHandle);
> +        ShellStatus = SHELL_INVALID_PARAMETER;
> +        goto ON_EXIT;
> +      }
> +
> +      if (StrCmp (VarArg->Arg, L"reset") == 0) {
> +        MacAddressReset = TRUE;
> +      } else {
> +        Status = NetLibStrToMac (VarArg->Arg, &NewMac);
> +        if (EFI_ERROR(Status)) {
> +          ShellPrintHiiEx(-1, -1, NULL,STRING_TOKEN
> (STR_IFCONFIG_INVALID_MACADDRESS), gShellNetwork1HiiHandle, VarArg-
> >Arg);
> +          ShellStatus = SHELL_INVALID_PARAMETER;
> +          goto ON_EXIT;
> +        }
> +      }
> +
> +      Status = NetLibSetMacAddress (
> +                      IfCb->NicHandle,
> +                      &NewMac,
> +                      IfCb->IfInfo->HwAddressSize,
> +                      MacAddressReset
> +                      );
> +      if (EFI_ERROR(Status)) {
> +        ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN
> (STR_IFCONFIG_SET_ADDR_FAILED), gShellNetwork1HiiHandle, Status);
> +        ShellStatus = SHELL_ACCESS_DENIED;
> +        goto ON_EXIT;
> +      }
> +
> +      //
> +      // Reconnect controller, so that all children get updated with
> +      // new MAC address information.
> +      //
> +      Status = NetLibReconnectInterface (IfCb->NicHandle);
> +      if (EFI_ERROR(Status)) {
> +        ShellStatus = SHELL_DEVICE_ERROR;
> +        goto ON_EXIT;
> +      }
> +
> +      VarArg = VarArg->Next;
>      }
>    }
> 
> diff --git
> a/ShellPkg/Library/UefiShellNetwork1CommandsLib/UefiShellNetwork1Com
> mandsLib.uni
> b/ShellPkg/Library/UefiShellNetwork1CommandsLib/UefiShellNetwork1Com
> mandsLib.uni
> index 76b6188..ffc358d 100644
> ---
> a/ShellPkg/Library/UefiShellNetwork1CommandsLib/UefiShellNetwork1Com
> mandsLib.uni
> +++
> b/ShellPkg/Library/UefiShellNetwork1CommandsLib/UefiShellNetwork1Com
> mandsLib.uni
> @@ -66,6 +66,7 @@
>  #string STR_IFCONFIG_LACK_COMMAND             #language en-US    "Lack
> interface config option.\n"
>  #string STR_IFCONFIG_INVALID_INTERFACE        #language en-US    "Invalid
> interface name.\n"
>  #string STR_IFCONFIG_INVALID_IPADDRESS        #language en-US    "Invalid
> ipv4 address: '%H%s%N'\n"
> +#string STR_IFCONFIG_INVALID_MACADDRESS       #language en-US
> "Invalid MAC address: '%H%s%N'\n"
>  #string STR_IFCONFIG_DUPLICATE_COMMAND        #language en-US
> "Duplicate commands. Bad command %H%s%N is skipped.\n"
>  #string STR_IFCONFIG_CONFLICT_COMMAND         #language en-US
> "Conflict commands. Bad command %H%s%N is skipped.\n"
>  #string STR_IFCONFIG_UNKNOWN_COMMAND          #language en-US
> "Unknown commands. Bad command %H%s%N is skipped.\n"
> @@ -133,7 +134,7 @@
>  ".SH SYNOPSIS\r\n"
>  " \r\n"
>  "IFCONFIG [-r [Name]] [-l [Name]]\r\n"
> -"IFCONFIG [-s <Name> dhcp | <static <IP> <Mask>  <Gateway>> | <dns
> <IP>>]\r\n"
> +"IFCONFIG [-s <Name> dhcp | <static <IP> <Mask>  <Gateway>> | <dns
> <IP>> | <mac reset> | <mac <MAC>>]\r\n"
>  ".SH OPTIONS\r\n"
>  " \r\n"
>  "  -r          - Renew configuration of interface and set dhcp policy.\r\n"
> @@ -146,6 +147,8 @@
>  "                  - Example: 255.255.255.0\r\n"
>  "  GatewayMask - Specifies a default gateway in four integer values:\r\n"
>  "                  - Example: 192.168.0.1\r\n"
> +"  MAC         - Specifies the MAC address:\r\n"
> +"                  - Example: 00:11:22:33:44:55\r\n"
>  ".SH DESCRIPTION\r\n"
>  " \r\n"
>  "NOTES:\r\n"
> @@ -174,6 +177,11 @@
>  " \r\n"
>  "  * To configure DNS server address for the eth0 interface:\r\n"
>  "    fs0:\> ifconfig -s eth0 dns 192.168.0.8 192.168.0.9\r\n"
> -
> +" \r\n"
> +"  * To configure MAC address for the eth0 interface:\r\n"
> +"    fs0:\> ifconfig -s eth0 mac 00:11:22:33:44:55\r\n"
> +" \r\n"
> +"  * To reset MAC address of the eth0 interface to initial value:\r\n"
> +"    fs0:\> ifconfig -s eth0 mac reset\r\n"
> 
> 
> --
> 1.8.3.1
> 
> _______________________________________________
> edk2-devel mailing list
> edk2-devel@lists.01.org
> https://lists.01.org/mailman/listinfo/edk2-devel