ArmPkg/LinuxLoader: eliminate calls to deprecated string functions

[mirror_edk2.git] / ArmPkg / Application / LinuxLoader / LinuxLoader.c

/** @file\r
*\r
*  Copyright (c) 2011-2015, ARM Limited. All rights reserved.\r
*\r
*  This program and the accompanying materials\r
*  are licensed and made available under the terms and conditions of the BSD License\r
*  which accompanies this distribution.  The full text of the license may be found at\r
*  http://opensource.org/licenses/bsd-license.php\r
*\r
*  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
*  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
*\r
**/\r
\r
#include <Library/UefiApplicationEntryPoint.h>\r
#include <Library/BaseMemoryLib.h>\r
\r
#include <Protocol/DevicePathFromText.h>\r
\r
#include "LinuxLoader.h"\r
\r
/**\r
  The user Entry Point for Application. The user code starts with this function\r
  as the real entry point for the application.\r
\r
  @param[in]  ImageHandle  The firmware allocated handle for the EFI image.\r
  @param[in]  SystemTable  A pointer to the EFI System Table.\r
\r
  @retval  EFI_SUCCESS            The entry point was executed successfully.\r
  @retval  EFI_NOT_FOUND          Protocol not found.\r
  @retval  EFI_NOT_FOUND          Path to the Linux kernel not found.\r
  @retval  EFI_ABORTED            The initialisation of the Shell Library failed.\r
  @retval  EFI_INVALID_PARAMETER  At least one parameter is not valid or there is a\r
                                  conflict between two parameters.\r
  @retval  EFI_OUT_OF_RESOURCES   A memory allocation failed.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
LinuxLoaderEntryPoint (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS                          Status;\r
  EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL  *EfiDevicePathFromTextProtocol;\r
  EFI_SHELL_PARAMETERS_PROTOCOL       *ShellParameters;\r
  CHAR16                              *KernelPath;\r
  CHAR16                              *FdtPath;\r
  CHAR16                              *InitrdPath;\r
  CHAR16                              *KernelTextDevicePath;\r
  CHAR16                              *FdtTextDevicePath;\r
  CHAR16                              *InitrdTextDevicePath;\r
  CHAR16                              *LinuxCommandLine;\r
  UINTN                               AtagMachineType;\r
  EFI_DEVICE_PATH                     *KernelDevicePath;\r
  EFI_DEVICE_PATH                     *FdtDevicePath;\r
  EFI_DEVICE_PATH                     *InitrdDevicePath;\r
  CHAR8                               *AsciiLinuxCommandLine;\r
  LIST_ENTRY                          ResourceList;\r
  LIST_ENTRY                          *ResourceLink;\r
  SYSTEM_MEMORY_RESOURCE              *Resource;\r
  EFI_PHYSICAL_ADDRESS                SystemMemoryBase;\r
  UINTN                               Length;\r
\r
  Status = gBS->LocateProtocol (\r
                  &gEfiDevicePathFromTextProtocolGuid,\r
                  NULL,\r
                  (VOID **)&EfiDevicePathFromTextProtocol\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  //\r
  // Register the strings for the user interface in the HII Database.\r
  // This shows the way to the multi-language support, even if\r
  // only the English language is actually supported. The strings to register\r
  // are stored in the "LinuxLoaderStrings[]" array. This array is\r
  // built by the building process from the "*.uni" file associated to\r
  // the present application (cf. LinuxLoader.inf). Examine the Build\r
  // folder of the application and you will find the array defined in the\r
  // LinuxLoaderStrDefs.h file.\r
  //\r
  mLinuxLoaderHiiHandle = HiiAddPackages (\r
                             &mLinuxLoaderHiiGuid,\r
                             ImageHandle,\r
                             LinuxLoaderStrings,\r
                             NULL\r
                             );\r
  if (mLinuxLoaderHiiHandle == NULL) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  Status = gBS->HandleProtocol (\r
                  ImageHandle,\r
                  &gEfiShellParametersProtocolGuid,\r
                  (VOID**)&ShellParameters\r
                  );\r
\r
  KernelDevicePath      = NULL;\r
  FdtDevicePath         = NULL;\r
  InitrdDevicePath      = NULL;\r
  AsciiLinuxCommandLine = NULL;\r
\r
  //\r
  // Call the proper function to handle the command line\r
  // depending on whether the application has been called\r
  // from the Shell or not.\r
  //\r
\r
  if (!EFI_ERROR (Status)) {\r
    KernelTextDevicePath = NULL;\r
    FdtTextDevicePath    = NULL;\r
    InitrdTextDevicePath = NULL;\r
\r
    Status = ProcessShellParameters (\r
               &KernelPath, &FdtPath, &InitrdPath, &LinuxCommandLine, &AtagMachineType\r
               );\r
    if (EFI_ERROR (Status)) {\r
      goto Error;\r
    }\r
\r
    KernelDevicePath = gEfiShellProtocol->GetDevicePathFromFilePath (KernelPath);\r
    if (KernelDevicePath != NULL) {\r
      FreePool (KernelPath);\r
    } else {\r
      KernelTextDevicePath = KernelPath;\r
    }\r
\r
    if (FdtPath != NULL) {\r
      FdtDevicePath = gEfiShellProtocol->GetDevicePathFromFilePath (FdtPath);\r
      if (FdtDevicePath != NULL) {\r
        FreePool (FdtPath);\r
      } else {\r
        FdtTextDevicePath = FdtPath;\r
      }\r
    }\r
\r
    if (InitrdPath != NULL) {\r
      InitrdDevicePath = gEfiShellProtocol->GetDevicePathFromFilePath (InitrdPath);\r
      if (InitrdDevicePath != NULL) {\r
        FreePool (InitrdPath);\r
      } else {\r
        InitrdTextDevicePath = InitrdPath;\r
      }\r
    }\r
\r
  } else {\r
    Status = ProcessAppCommandLine (\r
               &KernelTextDevicePath, &FdtTextDevicePath,\r
               &InitrdTextDevicePath, &LinuxCommandLine, &AtagMachineType\r
               );\r
    if (EFI_ERROR (Status)) {\r
      goto Error;\r
    }\r
  }\r
\r
  Status = EFI_INVALID_PARAMETER;\r
  if (KernelTextDevicePath != NULL) {\r
    KernelDevicePath = EfiDevicePathFromTextProtocol->ConvertTextToDevicePath (\r
                                                        KernelTextDevicePath\r
                                                        );\r
    if (KernelDevicePath == NULL) {\r
      goto Error;\r
    }\r
  }\r
  if (FdtTextDevicePath != NULL) {\r
    FdtDevicePath = EfiDevicePathFromTextProtocol->ConvertTextToDevicePath (\r
                                                     FdtTextDevicePath\r
                                                     );\r
    if (FdtDevicePath == NULL) {\r
      goto Error;\r
    }\r
  }\r
  if (InitrdTextDevicePath != NULL) {\r
    InitrdDevicePath = EfiDevicePathFromTextProtocol->ConvertTextToDevicePath (\r
                                                        InitrdTextDevicePath\r
                                                        );\r
    if (InitrdDevicePath == NULL) {\r
      goto Error;\r
    }\r
  }\r
\r
  if (LinuxCommandLine != NULL) {\r
    Length = StrLen (LinuxCommandLine) + 1;\r
    AsciiLinuxCommandLine = AllocatePool (Length);\r
    if (AsciiLinuxCommandLine == NULL) {\r
      Status = EFI_OUT_OF_RESOURCES;\r
      goto Error;\r
    }\r
    UnicodeStrToAsciiStrS (LinuxCommandLine, AsciiLinuxCommandLine, Length);\r
  }\r
\r
  //\r
  // Find Base of System Memory - we keep the lowest physical address\r
  //\r
  SystemMemoryBase = ~0;\r
  GetSystemMemoryResources (&ResourceList);\r
  ResourceLink = ResourceList.ForwardLink;\r
  while (ResourceLink != NULL && ResourceLink != &ResourceList) {\r
    Resource = (SYSTEM_MEMORY_RESOURCE*)ResourceLink;\r
    if (Resource->PhysicalStart < SystemMemoryBase) {\r
      SystemMemoryBase = Resource->PhysicalStart;\r
    }\r
    ResourceLink = ResourceLink->ForwardLink;\r
  }\r
\r
  if (AtagMachineType != ARM_FDT_MACHINE_TYPE) {\r
    Status = BootLinuxAtag (SystemMemoryBase, KernelDevicePath, InitrdDevicePath, AsciiLinuxCommandLine, AtagMachineType);\r
  } else {\r
    Status = BootLinuxFdt (SystemMemoryBase, KernelDevicePath, InitrdDevicePath, FdtDevicePath, AsciiLinuxCommandLine);\r
  }\r
\r
Error:\r
  if (KernelTextDevicePath != NULL) {\r
    FreePool (KernelTextDevicePath);\r
  }\r
  if (FdtTextDevicePath != NULL) {\r
    FreePool (FdtTextDevicePath);\r
  }\r
  if (InitrdTextDevicePath != NULL) {\r
    FreePool (InitrdTextDevicePath);\r
  }\r
  if (LinuxCommandLine != NULL) {\r
    FreePool (LinuxCommandLine);\r
  }\r
  if (KernelDevicePath != NULL) {\r
    FreePool (KernelDevicePath);\r
  }\r
  if (FdtDevicePath != NULL) {\r
    FreePool (FdtDevicePath);\r
  }\r
  if (InitrdDevicePath != NULL) {\r
    FreePool (InitrdDevicePath);\r
  }\r
  if (AsciiLinuxCommandLine != NULL) {\r
    FreePool (AsciiLinuxCommandLine);\r
  }\r
\r
  if (EFI_ERROR (Status)) {\r
    PrintHii (NULL, STRING_TOKEN (STR_ERROR), Status);\r
  }\r
\r
  HiiRemovePackages (mLinuxLoaderHiiHandle);\r
\r
  return Status;\r
}\r