Re: [edk2-devel] [Platform Redfish Host Interface PATCH 4/6] EmulatorPkg/Application: Publish Redfish Host Interface Record

["Ni, Ray" <ray.ni@intel.com>]

Acked-by: Ray Ni <ray.ni@intel.com>

> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Chang,
> Abner (HPS SW/FW Technologist)
> Sent: Thursday, November 5, 2020 10:39 PM
> To: devel@edk2.groups.io
> Cc: Justen, Jordan L <jordan.l.justen@intel.com>; Andrew Fish
> <afish@apple.com>; Ni, Ray <ray.ni@intel.com>; Wang, Nickle (HPS SW)
> <nickle.wang@hpe.com>; O'Hanley, Peter (EXL) <peter.ohanley@hpe.com>
> Subject: [edk2-devel] [Platform Redfish Host Interface PATCH 4/6]
> EmulatorPkg/Application: Publish Redfish Host Interface Record
> 
> Signed-off-by: Jiaxin Wu <jiaxin.wu@intel.com>
> Signed-off-by: Ting Ye <ting.ye@intel.com>
> Signed-off-by: Siyuan Fu <siyuan.fu@intel.com>
> Signed-off-by: Fan Wang <fan.wang@intel.com>
> Signed-off-by: Abner Chang <abner.chang@hpe.com>
> 
> Cc: Jordan Justen <jordan.l.justen@intel.com>
> Cc: Andrew Fish <afish@apple.com>
> Cc: Ray Ni <ray.ni@intel.com>
> Cc: Nickle Wang <nickle.wang@hpe.com>
> Cc: Peter O'Hanley <peter.ohanley@hpe.com>
> ---
>  .../RedfishPlatformConfig.c                   | 298 ++++++++++++++++++
>  .../RedfishPlatformConfig.inf                 |  42 +++
>  2 files changed, 340 insertions(+)
>  create mode 100644
> EmulatorPkg/Application/RedfishPlatformConfig/RedfishPlatformConfig.c
>  create mode 100644
> EmulatorPkg/Application/RedfishPlatformConfig/RedfishPlatformConfig.inf
> 
> diff --git
> a/EmulatorPkg/Application/RedfishPlatformConfig/RedfishPlatformConfig.c
> b/EmulatorPkg/Application/RedfishPlatformConfig/RedfishPlatformConfig.c
> new file mode 100644
> index 0000000000..89d4c760a7
> --- /dev/null
> +++
> b/EmulatorPkg/Application/RedfishPlatformConfig/RedfishPlatformConfig.c
> @@ -0,0 +1,298 @@
> +/** @file
> +  The implementation for Redfish Platform Configuration application.
> +
> +  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
> +  (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>
> +
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
> +
> +**/
> +
> +#include <Uefi.h>
> +#include <Library/DebugLib.h>
> +#include <Library/NetLib.h>
> +#include <Library/UefiApplicationEntryPoint.h>
> +#include <Library/UefiBootServicesTableLib.h>
> +#include <Library/UefiRuntimeServicesTableLib.h>
> +#include <Library/UefiLib.h>
> +#include <Protocol/ShellParameters.h>
> +
> +UINTN  Argc;
> +CHAR16 **Argv;
> +
> +/**
> +
> +  This function parse application ARG.
> +
> +  @return Status
> +**/
> +EFI_STATUS
> +GetArg (
> +  VOID
> +  )
> +{
> +  EFI_STATUS                    Status;
> +  EFI_SHELL_PARAMETERS_PROTOCOL *ShellParameters;
> +
> +  Status = gBS->HandleProtocol (
> +                  gImageHandle,
> +                  &gEfiShellParametersProtocolGuid,
> +                  (VOID**)&ShellParameters
> +                  );
> +  if (EFI_ERROR(Status)) {
> +    return Status;
> +  }
> +
> +  Argc = ShellParameters->Argc;
> +  Argv = ShellParameters->Argv;
> +  return EFI_SUCCESS;
> +}
> +
> +/**
> +
> +  This function print the help message.
> +
> +**/
> +VOID
> +PrintHelp (
> +  VOID
> +  )
> +{
> +  Print (L"\n");
> +  Print (L"Format (Only Ipv4 Address is supported):\n");
> +  Print (L"RedfishPlatformConfig.efi -s HostIpAddress HostIpMask
> RedfishServiceIpAddress RedfishServiceIpMask RedfishServiceIpPort\n");
> +  Print (L"OR:\n");
> +  Print (L"RedfishPlatformConfig.efi -a RedfishServiceIpAddress
> RedfishServiceIpMask RedfishServiceIpPort\n");
> +  Print (L"\n");
> +}
> +
> +/**
> +  The user Entry Point for Application. The user code starts with this function
> +  as the real entry point for the application.
> +
> +  @param[in] ImageHandle    The firmware allocated handle for the EFI image.
> +  @param[in] SystemTable    A pointer to the EFI System Table.
> +
> +  @retval EFI_SUCCESS       The entry point is executed successfully.
> +  @retval other             Some error occurs when executing this entry point.
> +
> +**/
> +EFI_STATUS
> +EFIAPI
> +UefiMain (
> +  IN EFI_HANDLE        ImageHandle,
> +  IN EFI_SYSTEM_TABLE  *SystemTable
> +  )
> +{
> +  EFI_STATUS    Status;
> +  RETURN_STATUS ReturnStatus;
> +
> +  UINT8             HostIpAssignmentType;
> +  EFI_IPv4_ADDRESS  HostIpAddress;
> +  EFI_IPv4_ADDRESS  HostIpMask;
> +  EFI_IPv4_ADDRESS  RedfishServiceIpAddress;
> +  EFI_IPv4_ADDRESS  RedfishServiceIpMask;
> +  UINTN             RedfishServiceIpPort;
> +
> +  Status = GetArg();
> +  if (EFI_ERROR(Status)) {
> +    return Status;
> +  }
> +
> +  //
> +  // Format is like :
> +  // RedfishPlatformConfig.efi -s HostIpAddress HostIpMask
> RedfishServiceIpAddress RedfishServiceIpMask RedfishServiceIpPort
> +  // RedfishPlatformConfig.efi -a RedfishServiceIpAddress
> RedfishServiceIpMask RedfishServiceIpPort
> +  //
> +  if (Argc != 7 && Argc != 5) {
> +
> +    PrintHelp();
> +    return EFI_UNSUPPORTED;
> +  }
> +
> +  if (StrCmp(Argv[1], L"-s") == 0) {
> +
> +    HostIpAssignmentType = 1;
> +
> +    Status = NetLibStrToIp4 (Argv[2], &HostIpAddress);
> +    if (EFI_ERROR (Status)) {
> +      PrintHelp();
> +      return Status;
> +    }
> +    Status = NetLibStrToIp4 (Argv[3], &HostIpMask);
> +    if (EFI_ERROR (Status)) {
> +      PrintHelp();
> +      return Status;
> +    }
> +    Status = NetLibStrToIp4 (Argv[4], &RedfishServiceIpAddress);
> +    if (EFI_ERROR (Status)) {
> +      PrintHelp();
> +      return Status;
> +    }
> +    Status = NetLibStrToIp4 (Argv[5], &RedfishServiceIpMask);
> +    if (EFI_ERROR (Status)) {
> +      PrintHelp();
> +      return Status;
> +    }
> +    ReturnStatus = StrDecimalToUintnS (Argv[6], NULL, &RedfishServiceIpPort);
> +    if (RETURN_ERROR (ReturnStatus)) {
> +      PrintHelp();
> +      return Status;
> +    }
> +
> +    Status = gRT->SetVariable (
> +                    L"HostIpAssignmentType",
> +                    &gEmuRedfishServiceGuid,
> +                    EFI_VARIABLE_NON_VOLATILE |
> EFI_VARIABLE_BOOTSERVICE_ACCESS,
> +                    sizeof (UINT8),
> +                    &HostIpAssignmentType
> +                    );
> +    if (EFI_ERROR (Status)) {
> +      return Status;
> +    }
> +
> +    Status = gRT->SetVariable (
> +                    L"HostIpAddress",
> +                    &gEmuRedfishServiceGuid,
> +                    EFI_VARIABLE_NON_VOLATILE |
> EFI_VARIABLE_BOOTSERVICE_ACCESS,
> +                    sizeof (EFI_IPv4_ADDRESS),
> +                    &HostIpAddress
> +                    );
> +    if (EFI_ERROR (Status)) {
> +      return Status;
> +    }
> +
> +    Status = gRT->SetVariable (
> +                    L"HostIpMask",
> +                    &gEmuRedfishServiceGuid,
> +                    EFI_VARIABLE_NON_VOLATILE |
> EFI_VARIABLE_BOOTSERVICE_ACCESS,
> +                    sizeof (EFI_IPv4_ADDRESS),
> +                    &HostIpMask
> +                    );
> +    if (EFI_ERROR (Status)) {
> +      return Status;
> +    }
> +
> +    Status = gRT->SetVariable (
> +                    L"RedfishServiceIpAddress",
> +                    &gEmuRedfishServiceGuid,
> +                    EFI_VARIABLE_NON_VOLATILE |
> EFI_VARIABLE_BOOTSERVICE_ACCESS,
> +                    sizeof (EFI_IPv4_ADDRESS),
> +                    &RedfishServiceIpAddress
> +                    );
> +    if (EFI_ERROR (Status)) {
> +      return Status;
> +    }
> +
> +    Status = gRT->SetVariable (
> +                    L"RedfishServiceIpMask",
> +                    &gEmuRedfishServiceGuid,
> +                    EFI_VARIABLE_NON_VOLATILE |
> EFI_VARIABLE_BOOTSERVICE_ACCESS,
> +                    sizeof (EFI_IPv4_ADDRESS),
> +                    &RedfishServiceIpMask
> +                    );
> +    if (EFI_ERROR (Status)) {
> +      return Status;
> +    }
> +
> +    Status = gRT->SetVariable (
> +                    L"RedfishServiceIpPort",
> +                    &gEmuRedfishServiceGuid,
> +                    EFI_VARIABLE_NON_VOLATILE |
> EFI_VARIABLE_BOOTSERVICE_ACCESS,
> +                    sizeof (UINT16),
> +                    &RedfishServiceIpPort
> +                    );
> +    if (EFI_ERROR (Status)) {
> +      return Status;
> +    }
> +
> +    Print (L"\n");
> +    Print (L"HostIpAssignmentType is Static!\n");
> +    Print (L"HostIpAddress: %s has been set Successfully!\n", Argv[2]);
> +    Print (L"HostIpMask: %s has been set Successfully!\n", Argv[3]);
> +    Print (L"RedfishServiceIpAddress: %s has been set Successfully!\n", Argv[4]);
> +    Print (L"RedfishServiceIpMask: %s has been set Successfully!\n", Argv[5]);
> +    Print (L"RedfishServiceIpPort: %s has been set Successfully!\n", Argv[6]);
> +    Print (L"Please Restart!\n");
> +
> +  } else if (StrCmp(Argv[1], L"-a") == 0) {
> +
> +    HostIpAssignmentType = 3;
> +
> +    Status = NetLibStrToIp4 (Argv[2], &RedfishServiceIpAddress);
> +    if (EFI_ERROR (Status)) {
> +      PrintHelp();
> +      return Status;
> +    }
> +    Status = NetLibStrToIp4 (Argv[3], &RedfishServiceIpMask);
> +    if (EFI_ERROR (Status)) {
> +      PrintHelp();
> +      return Status;
> +    }
> +    ReturnStatus = StrDecimalToUintnS (Argv[4], NULL, &RedfishServiceIpPort);
> +    if (RETURN_ERROR (ReturnStatus)) {
> +      PrintHelp();
> +      return Status;
> +    }
> +
> +    Status = gRT->SetVariable (
> +                    L"HostIpAssignmentType",
> +                    &gEmuRedfishServiceGuid,
> +                    EFI_VARIABLE_NON_VOLATILE |
> EFI_VARIABLE_BOOTSERVICE_ACCESS,
> +                    sizeof (UINT8),
> +                    &HostIpAssignmentType
> +                    );
> +    if (EFI_ERROR (Status)) {
> +      return Status;
> +    }
> +
> +    Status = gRT->SetVariable (
> +                    L"RedfishServiceIpAddress",
> +                    &gEmuRedfishServiceGuid,
> +                    EFI_VARIABLE_NON_VOLATILE |
> EFI_VARIABLE_BOOTSERVICE_ACCESS,
> +                    sizeof (EFI_IPv4_ADDRESS),
> +                    &RedfishServiceIpAddress
> +                    );
> +    if (EFI_ERROR (Status)) {
> +      return Status;
> +    }
> +
> +    Status = gRT->SetVariable (
> +                    L"RedfishServiceIpMask",
> +                    &gEmuRedfishServiceGuid,
> +                    EFI_VARIABLE_NON_VOLATILE |
> EFI_VARIABLE_BOOTSERVICE_ACCESS,
> +                    sizeof (EFI_IPv4_ADDRESS),
> +                    &RedfishServiceIpMask
> +                    );
> +    if (EFI_ERROR (Status)) {
> +      return Status;
> +    }
> +
> +    Status = gRT->SetVariable (
> +                    L"RedfishServiceIpPort",
> +                    &gEmuRedfishServiceGuid,
> +                    EFI_VARIABLE_NON_VOLATILE |
> EFI_VARIABLE_BOOTSERVICE_ACCESS,
> +                    sizeof (UINT16),
> +                    &RedfishServiceIpPort
> +                    );
> +    if (EFI_ERROR (Status)) {
> +      return Status;
> +    }
> +
> +    Print (L"\n");
> +    Print (L"HostIpAssignmentType is Auto!\n");
> +    Print (L"RedfishServiceIpAddress: %s has been set Successfully!\n", Argv[2]);
> +    Print (L"RedfishServiceIpMask: %s has been set Successfully!\n", Argv[3]);
> +    Print (L"RedfishServiceIpPort: %s has been set Successfully!\n", Argv[4]);
> +    Print (L"Please Restart!\n");
> +  } else if (StrCmp(Argv[1], L"-h") == 0 || StrCmp(Argv[1], L"-help") == 0) {
> +
> +    PrintHelp();
> +  } else {
> +
> +    PrintHelp();
> +    return EFI_UNSUPPORTED;
> +  }
> +
> +  return EFI_SUCCESS;
> +}
> diff --git
> a/EmulatorPkg/Application/RedfishPlatformConfig/RedfishPlatformConfig.inf
> b/EmulatorPkg/Application/RedfishPlatformConfig/RedfishPlatformConfig.inf
> new file mode 100644
> index 0000000000..386c9bdd8c
> --- /dev/null
> +++
> b/EmulatorPkg/Application/RedfishPlatformConfig/RedfishPlatformConfig.inf
> @@ -0,0 +1,42 @@
> +## @file
> +#  Sample UEFI Application Reference EDKII Module.
> +#
> +#  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
> +# (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>
> +#
> +# SPDX-License-Identifier: BSD-2-Clause-Patent
> +#
> +#
> +##
> +
> +[Defines]
> +  INF_VERSION                    = 0x0001000b
> +  BASE_NAME                      = RedfishPlatformConfig
> +  FILE_GUID                      = C02B67BB-3D19-4ACC-A080-1BDB575F8F36
> +  MODULE_TYPE                    = UEFI_APPLICATION
> +  VERSION_STRING                 = 1.0
> +  ENTRY_POINT                    = UefiMain
> +
> +[Sources]
> +  RedfishPlatformConfig.c
> +
> +[Packages]
> +  EmulatorPkg/EmulatorPkg.dec
> +  MdePkg/MdePkg.dec
> +  MdeModulePkg/MdeModulePkg.dec
> +  NetworkPkg/NetworkPkg.dec
> +  RedfishPkg/RedfishPkg.dec
> +
> +[LibraryClasses]
> +  DebugLib
> +  NetLib
> +  UefiApplicationEntryPoint
> +  UefiLib
> +  UefiBootServicesTableLib
> +  UefiRuntimeServicesTableLib
> +[Protocols]
> +  gEfiShellParametersProtocolGuid        ## CONSUMES
> +  gEfiShellProtocolGuid                  ## CONSUMES
> +
> +[Guids]
> +  gEmuRedfishServiceGuid
> --
> 2.17.1
> 
> 
> 
> 
>