ArmPkg/AArch64Mmu: Fix XN attribute for device memory

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

/** @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
#ifndef __LINUX_LOADER_H__\r
#define __LINUX_LOADER_H__\r
\r
#include <Library/BdsLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/PerformanceLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/ShellLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiLib.h>\r
\r
#include <Protocol/EfiShellParameters.h>\r
#include <Protocol/EfiShell.h>\r
\r
#include <libfdt.h>\r
\r
//\r
// Definitions\r
//\r
\r
#define MAX_MSG_LEN 80\r
\r
#define LINUX_UIMAGE_SIGNATURE    0x56190527\r
#define LINUX_KERNEL_MAX_OFFSET   (SystemMemoryBase + PcdGet32(PcdArmLinuxKernelMaxOffset))\r
#define LINUX_ATAG_MAX_OFFSET     (SystemMemoryBase + PcdGet32(PcdArmLinuxAtagMaxOffset))\r
#define LINUX_FDT_MAX_OFFSET      (SystemMemoryBase + PcdGet32(PcdArmLinuxFdtMaxOffset))\r
\r
#define ARM_FDT_MACHINE_TYPE      0xFFFFFFFF\r
\r
// Additional size that could be used for FDT entries added by the UEFI OS Loader\r
// Estimation based on: EDID (300bytes) + bootargs (200bytes) + initrd region (20bytes)\r
//                      + system memory region (20bytes) + mp_core entries (200 bytes)\r
#define FDT_ADDITIONAL_ENTRIES_SIZE     0x300\r
\r
//\r
// Global variables\r
//\r
extern CONST EFI_GUID mLinuxLoaderHiiGuid;\r
extern EFI_HANDLE mLinuxLoaderHiiHandle;\r
\r
//\r
// Local Types\r
//\r
typedef struct _SYSTEM_MEMORY_RESOURCE {\r
  LIST_ENTRY                  Link; // This attribute must be the first entry of this structure (to avoid pointer computation)\r
  EFI_PHYSICAL_ADDRESS        PhysicalStart;\r
  UINT64                      ResourceLength;\r
} SYSTEM_MEMORY_RESOURCE;\r
\r
typedef VOID (*LINUX_KERNEL)(UINT32 Zero, UINT32 Arch, UINTN ParametersBase);\r
\r
//\r
// Functions\r
//\r
EFI_STATUS\r
PrintHii (\r
  IN CONST CHAR8          *Language OPTIONAL,\r
  IN CONST EFI_STRING_ID  HiiFormatStringId,\r
  ...\r
  );\r
\r
VOID\r
PrintHelp (\r
  IN CONST CHAR8  *Language OPTIONAL\r
  );\r
\r
EFI_STATUS\r
ProcessShellParameters (\r
  OUT  CHAR16   **KernelPath,\r
  OUT  CHAR16   **FdtPath,\r
  OUT  CHAR16   **InitrdPath,\r
  OUT  CHAR16   **LinuxCommandLine,\r
  OUT  UINTN    *AtagMachineType\r
  );\r
\r
EFI_STATUS\r
ProcessAppCommandLine (\r
  OUT  CHAR16   **KernelTextDevicePath,\r
  OUT  CHAR16   **FdtTextDevicePath,\r
  OUT  CHAR16   **InitrdTextDevicePath,\r
  OUT  CHAR16   **LinuxCommandLine,\r
  OUT  UINTN    *AtagMachineType\r
  );\r
\r
VOID\r
PrintPerformance (\r
  VOID\r
  );\r
\r
EFI_STATUS\r
GetSystemMemoryResources (\r
  IN  LIST_ENTRY *ResourceList\r
  );\r
\r
EFI_STATUS\r
PrepareFdt (\r
  IN     EFI_PHYSICAL_ADDRESS SystemMemoryBase,\r
  IN     CONST CHAR8*         CommandLineArguments,\r
  IN     EFI_PHYSICAL_ADDRESS InitrdImage,\r
  IN     UINTN                InitrdImageSize,\r
  IN OUT EFI_PHYSICAL_ADDRESS *FdtBlobBase,\r
  IN OUT UINTN                *FdtBlobSize\r
  );\r
\r
/**\r
  Start a Linux kernel from a Device Path\r
\r
  @param  SystemMemoryBase      Base of the system memory\r
  @param  LinuxKernel           Device Path to the Linux Kernel\r
  @param  Parameters            Linux kernel arguments\r
  @param  Fdt                   Device Path to the Flat Device Tree\r
  @param  MachineType           ARM machine type value\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
  @retval RETURN_UNSUPPORTED    ATAG is not support by this architecture\r
\r
**/\r
EFI_STATUS\r
BootLinuxAtag (\r
  IN  EFI_PHYSICAL_ADDRESS      SystemMemoryBase,\r
  IN  EFI_DEVICE_PATH_PROTOCOL* LinuxKernelDevicePath,\r
  IN  EFI_DEVICE_PATH_PROTOCOL* InitrdDevicePath,\r
  IN  CONST CHAR8*              CommandLineArguments,\r
  IN  UINTN                     MachineType\r
  );\r
\r
/**\r
  Start a Linux kernel from a Device Path\r
\r
  @param[in]  LinuxKernelDevicePath  Device Path to the Linux Kernel\r
  @param[in]  InitrdDevicePath       Device Path to the Initrd\r
  @param[in]  Arguments              Linux kernel arguments\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
EFI_STATUS\r
BootLinuxFdt (\r
  IN  EFI_PHYSICAL_ADDRESS      SystemMemoryBase,\r
  IN  EFI_DEVICE_PATH_PROTOCOL* LinuxKernelDevicePath,\r
  IN  EFI_DEVICE_PATH_PROTOCOL* InitrdDevicePath,\r
  IN  EFI_DEVICE_PATH_PROTOCOL* FdtDevicePath,\r
  IN  CONST CHAR8*              Arguments\r
  );\r
\r
#endif /* __LINUX_LOADER_H__ */\r