EmbeddedPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / EmbeddedPkg / Application / AndroidFastboot / Arm / BootAndroidBootImg.c

/** @file\r
\r
  Copyright (c) 2013-2015, ARM Ltd. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "AndroidFastbootApp.h"\r
\r
#include <Protocol/DevicePath.h>\r
#include <Protocol/LoadedImage.h>\r
\r
#include <Library/DevicePathLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiLib.h>\r
\r
// Device Path representing an image in memory\r
#pragma pack(1)\r
typedef struct {\r
  MEMMAP_DEVICE_PATH                      Node1;\r
  EFI_DEVICE_PATH_PROTOCOL                End;\r
} MEMORY_DEVICE_PATH;\r
#pragma pack()\r
\r
STATIC CONST MEMORY_DEVICE_PATH MemoryDevicePathTemplate =\r
{\r
  {\r
    {\r
      HARDWARE_DEVICE_PATH,\r
      HW_MEMMAP_DP,\r
      {\r
        (UINT8)(sizeof (MEMMAP_DEVICE_PATH)),\r
        (UINT8)((sizeof (MEMMAP_DEVICE_PATH)) >> 8),\r
      },\r
    }, // Header\r
    0, // StartingAddress (set at runtime)\r
    0  // EndingAddress   (set at runtime)\r
  }, // Node1\r
  {\r
    END_DEVICE_PATH_TYPE,\r
    END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
    { sizeof (EFI_DEVICE_PATH_PROTOCOL), 0 }\r
  } // End\r
};\r
\r
\r
/**\r
  Start an EFI Application from a Device Path\r
\r
  @param  ParentImageHandle     Handle of the calling image\r
  @param  DevicePath            Location of the EFI Application\r
\r
  @retval EFI_SUCCESS           All drivers have been connected\r
  @retval EFI_NOT_FOUND         The Linux kernel Device Path has not been found\r
  @retval EFI_OUT_OF_RESOURCES  There is not enough resource memory to store the matching results.\r
\r
**/\r
STATIC\r
EFI_STATUS\r
StartEfiApplication (\r
  IN EFI_HANDLE                  ParentImageHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL    *DevicePath,\r
  IN UINTN                       LoadOptionsSize,\r
  IN VOID*                       LoadOptions\r
  )\r
{\r
  EFI_STATUS                   Status;\r
  EFI_HANDLE                   ImageHandle;\r
  EFI_LOADED_IMAGE_PROTOCOL*   LoadedImage;\r
\r
  // Load the image from the device path with Boot Services function\r
  Status = gBS->LoadImage (TRUE, ParentImageHandle, DevicePath, NULL, 0,\r
                  &ImageHandle);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  // Passed LoadOptions to the EFI Application\r
  if (LoadOptionsSize != 0) {\r
    Status = gBS->HandleProtocol (ImageHandle, &gEfiLoadedImageProtocolGuid,\r
                    (VOID **) &LoadedImage);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    LoadedImage->LoadOptionsSize  = LoadOptionsSize;\r
    LoadedImage->LoadOptions      = LoadOptions;\r
  }\r
\r
  // Before calling the image, enable the Watchdog Timer for  the 5 Minute period\r
  gBS->SetWatchdogTimer (5 * 60, 0x0000, 0x00, NULL);\r
  // Start the image\r
  Status = gBS->StartImage (ImageHandle, NULL, NULL);\r
  // Clear the Watchdog Timer after the image returns\r
  gBS->SetWatchdogTimer (0x0000, 0x0000, 0x0000, NULL);\r
\r
  return Status;\r
}\r
\r
EFI_STATUS\r
BootAndroidBootImg (\r
  IN UINTN    BufferSize,\r
  IN VOID    *Buffer\r
  )\r
{\r
  EFI_STATUS                          Status;\r
  CHAR8                               KernelArgs[ANDROID_BOOTIMG_KERNEL_ARGS_SIZE];\r
  VOID                               *Kernel;\r
  UINTN                               KernelSize;\r
  VOID                               *Ramdisk;\r
  UINTN                               RamdiskSize;\r
  MEMORY_DEVICE_PATH                  KernelDevicePath;\r
  CHAR16                              *LoadOptions, *NewLoadOptions;\r
\r
  Status = ParseAndroidBootImg (\r
            Buffer,\r
            &Kernel,\r
            &KernelSize,\r
            &Ramdisk,\r
            &RamdiskSize,\r
            KernelArgs\r
            );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  KernelDevicePath = MemoryDevicePathTemplate;\r
\r
  // Have to cast to UINTN before casting to EFI_PHYSICAL_ADDRESS in order to\r
  // appease GCC.\r
  KernelDevicePath.Node1.StartingAddress = (EFI_PHYSICAL_ADDRESS)(UINTN) Kernel;\r
  KernelDevicePath.Node1.EndingAddress   = (EFI_PHYSICAL_ADDRESS)(UINTN) Kernel + KernelSize;\r
\r
  // Initialize Linux command line\r
  LoadOptions = CatSPrint (NULL, L"%a", KernelArgs);\r
  if (LoadOptions == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  if (RamdiskSize != 0) {\r
    NewLoadOptions = CatSPrint (LoadOptions, L" initrd=0x%x,0x%x",\r
                       (UINTN)Ramdisk, RamdiskSize);\r
    FreePool (LoadOptions);\r
    if (NewLoadOptions == NULL) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
    LoadOptions = NewLoadOptions;\r
  }\r
\r
  Status = StartEfiApplication (gImageHandle,\r
             (EFI_DEVICE_PATH_PROTOCOL *) &KernelDevicePath,\r
             StrSize (LoadOptions),\r
             LoadOptions);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((EFI_D_ERROR, "Couldn't Boot Linux: %d\n", Status));\r
    Status = EFI_DEVICE_ERROR;\r
    goto FreeLoadOptions;\r
  }\r
\r
  // If we got here we do a confused face because BootLinuxFdt returned,\r
  // reporting success.\r
  DEBUG ((EFI_D_ERROR, "WARNING: BdsBootLinuxFdt returned EFI_SUCCESS.\n"));\r
  return EFI_SUCCESS;\r
\r
FreeLoadOptions:\r
  FreePool (LoadOptions);\r
  return Status;\r
}\r