ArmVirtPkg: implement ArmVirtQemuKernel

This implements a version of ArmVirtQemu that does not execute in place from
emulated NOR flash, but implements the Linux kernel boot protocol, and executes
from DRAM instead. This allows UEFI to be loaded as a payload by a previous
bootloader stage such as ARM Trusted Firmware/OP-TEE.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Acked-by: Laszlo Ersek <lersek@redhat.com>

1 files changed, 400 insertions, 0 deletions

diff --git a/ArmVirtPkg/ArmVirtQemuKernel.fdf b/ArmVirtPkg/ArmVirtQemuKernel.fdf
new file mode 100644
index 0000000000..7491f8042b
--- /dev/null
+++ b/ArmVirtPkg/ArmVirtQemuKernel.fdf
@@ -0,0 +1,400 @@
+#

+#  Copyright (c) 2011-2015, ARM Limited. All rights reserved.

+#  Copyright (c) 2014, Linaro Limited. All rights reserved.

+#  Copyright (c) 2015, Intel Corporation. All rights reserved.

+#

+#  This program and the accompanying materials

+#  are licensed and made available under the terms and conditions of the BSD License

+#  which accompanies this distribution.  The full text of the license may be found at

+#  http://opensource.org/licenses/bsd-license.php

+#

+#  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+#  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+#

+

+################################################################################

+#

+# FD Section

+# The [FD] Section is made up of the definition statements and a

+# description of what goes into  the Flash Device Image.  Each FD section

+# defines one flash "device" image.  A flash device image may be one of

+# the following: Removable media bootable image (like a boot floppy

+# image,) an Option ROM image (that would be "flashed" into an add-in

+# card,) a System "Flash"  image (that would be burned into a system's

+# flash) or an Update ("Capsule") image that will be used to update and

+# existing system flash.

+#

+################################################################################

+

+[FD.QEMU_EFI]

+BaseAddress   = 0x00000000|gArmTokenSpaceGuid.PcdFdBaseAddress  # QEMU assigns 0 - 0x8000000 for a BootROM

+Size          = 0x00200000|gArmTokenSpaceGuid.PcdFdSize         # The size in bytes of the FLASH Device

+ErasePolarity = 1

+

+# This one is tricky, it must be: BlockSize * NumBlocks = Size

+BlockSize     = 0x00001000

+NumBlocks     = 0x200

+

+################################################################################

+#

+# Following are lists of FD Region layout which correspond to the locations of different

+# images within the flash device.

+#

+# Regions must be defined in ascending order and may not overlap.

+#

+# A Layout Region start with a eight digit hex offset (leading "0x" required) followed by

+# the pipe "|" character, followed by the size of the region, also in hex with the leading

+# "0x" characters. Like:

+# Offset|Size

+# PcdOffsetCName|PcdSizeCName

+# RegionType <FV, DATA, or FILE>

+#

+################################################################################

+

+#

+# Implement the Linux kernel header layout so that the Xen loader will identify

+# it as something bootable, and execute it with a FDT pointer in x0 or r2.

+# This area will be reused to store a copy of the FDT so round it up to 8 KB.

+#

+0x00000000|0x00002000

+DATA = {

+!if $(ARCH) == AARCH64

+  0x01, 0x00, 0x00, 0x10,                         # code0: adr x1, .

+  0xff, 0x07, 0x00, 0x14,                         # code1: b 0x2000

+  0x00, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, # text_offset: 512 KB

+  0x00, 0x00, 0x20, 0x00, 0x00, 0x00, 0x00, 0x00, # image_size: 2 MB

+  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, # flags

+  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, # res2

+  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, # res3

+  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, # res4

+  0x41, 0x52, 0x4d, 0x64,                         # magic: "ARM\x64"

+  0x00, 0x00, 0x00, 0x00                          # res5

+!else

+  0x08, 0x10, 0x4f, 0xe2, # adr r1, .

+  0x02, 0x00, 0xa0, 0xe1, # mov r0, r2 (DTB)

+  0x00, 0x00, 0xa0, 0xe1, # nop

+  0x00, 0x00, 0xa0, 0xe1, # nop

+  0x00, 0x00, 0xa0, 0xe1, # nop

+  0x00, 0x00, 0xa0, 0xe1, # nop

+  0x00, 0x00, 0xa0, 0xe1, # nop

+  0x00, 0x00, 0xa0, 0xe1, # nop

+

+  0xf6, 0x07, 0x00, 0xea, # b 0x2000

+  0x18, 0x28, 0x6f, 0x01, # magic

+  0x00, 0x00, 0x00, 0x00, # start

+  0x00, 0x00, 0x20, 0x00, # image size: 2 MB

+  0x01, 0x02, 0x03, 0x04  # endiannness flag

+!endif

+}

+

+0x00002000|0x001fe000

+gArmTokenSpaceGuid.PcdFvBaseAddress|gArmTokenSpaceGuid.PcdFvSize

+FV = FVMAIN_COMPACT

+

+

+################################################################################

+#

+# FV Section

+#

+# [FV] section is used to define what components or modules are placed within a flash

+# device file.  This section also defines order the components and modules are positioned

+# within the image.  The [FV] section consists of define statements, set statements and

+# module statements.

+#

+################################################################################

+

+[FV.FvMain]

+BlockSize          = 0x40

+NumBlocks          = 0         # This FV gets compressed so make it just big enough

+FvAlignment        = 16        # FV alignment and FV attributes setting.

+ERASE_POLARITY     = 1

+MEMORY_MAPPED      = TRUE

+STICKY_WRITE       = TRUE

+LOCK_CAP           = TRUE

+LOCK_STATUS        = TRUE

+WRITE_DISABLED_CAP = TRUE

+WRITE_ENABLED_CAP  = TRUE

+WRITE_STATUS       = TRUE

+WRITE_LOCK_CAP     = TRUE

+WRITE_LOCK_STATUS  = TRUE

+READ_DISABLED_CAP  = TRUE

+READ_ENABLED_CAP   = TRUE

+READ_STATUS        = TRUE

+READ_LOCK_CAP      = TRUE

+READ_LOCK_STATUS   = TRUE

+

+  APRIORI DXE {

+    INF MdeModulePkg/Universal/PCD/Dxe/Pcd.inf

+    INF ArmVirtPkg/VirtFdtDxe/VirtFdtDxe.inf

+  }

+  INF MdeModulePkg/Core/Dxe/DxeMain.inf

+  INF MdeModulePkg/Universal/PCD/Dxe/Pcd.inf

+  INF ArmVirtPkg/VirtFdtDxe/VirtFdtDxe.inf

+

+  #

+  # PI DXE Drivers producing Architectural Protocols (EFI Services)

+  #

+  INF ArmPkg/Drivers/CpuDxe/CpuDxe.inf

+  INF MdeModulePkg/Core/RuntimeDxe/RuntimeDxe.inf

+  INF MdeModulePkg/Universal/SecurityStubDxe/SecurityStubDxe.inf

+  INF MdeModulePkg/Universal/CapsuleRuntimeDxe/CapsuleRuntimeDxe.inf

+  INF MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf

+  INF MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf

+!if $(SECURE_BOOT_ENABLE) == TRUE

+  INF SecurityPkg/VariableAuthenticated/SecureBootConfigDxe/SecureBootConfigDxe.inf

+!endif

+  INF MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf

+  INF EmbeddedPkg/ResetRuntimeDxe/ResetRuntimeDxe.inf

+  INF EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClockRuntimeDxe.inf

+  INF EmbeddedPkg/MetronomeDxe/MetronomeDxe.inf

+  INF MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabaseDxe.inf

+

+  #

+  # Multiple Console IO support

+  #

+  INF MdeModulePkg/Universal/Console/ConPlatformDxe/ConPlatformDxe.inf

+  INF MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitterDxe.inf

+  INF MdeModulePkg/Universal/Console/GraphicsConsoleDxe/GraphicsConsoleDxe.inf

+  INF MdeModulePkg/Universal/Console/TerminalDxe/TerminalDxe.inf

+  INF MdeModulePkg/Universal/SerialDxe/SerialDxe.inf

+

+  INF ArmPkg/Drivers/ArmGic/ArmGicDxe.inf

+  INF ArmPkg/Drivers/TimerDxe/TimerDxe.inf

+!if $(SECURE_BOOT_ENABLE) == TRUE

+  INF ArmPlatformPkg/Drivers/NorFlashDxe/NorFlashAuthenticatedDxe.inf

+!else

+  INF ArmPlatformPkg/Drivers/NorFlashDxe/NorFlashDxe.inf

+!endif

+  INF MdeModulePkg/Universal/WatchdogTimerDxe/WatchdogTimer.inf

+

+  #

+  # FAT filesystem + GPT/MBR partitioning

+  #

+  INF MdeModulePkg/Universal/Disk/DiskIoDxe/DiskIoDxe.inf

+  INF MdeModulePkg/Universal/Disk/PartitionDxe/PartitionDxe.inf

+  INF FatBinPkg/EnhancedFatDxe/Fat.inf

+  INF MdeModulePkg/Universal/Disk/UnicodeCollation/EnglishDxe/EnglishDxe.inf

+

+  #

+  # Platform Driver

+  #

+  INF OvmfPkg/VirtioBlkDxe/VirtioBlk.inf

+  INF OvmfPkg/VirtioNetDxe/VirtioNet.inf

+  INF OvmfPkg/VirtioScsiDxe/VirtioScsi.inf

+

+  #

+  # UEFI application (Shell Embedded Boot Loader)

+  #

+  INF ShellPkg/Application/Shell/Shell.inf

+

+  #

+  # Bds

+  #

+  INF MdeModulePkg/Universal/DevicePathDxe/DevicePathDxe.inf

+  INF MdeModulePkg/Universal/DisplayEngineDxe/DisplayEngineDxe.inf

+  INF MdeModulePkg/Universal/SetupBrowserDxe/SetupBrowserDxe.inf

+  INF IntelFrameworkModulePkg/Universal/BdsDxe/BdsDxe.inf

+

+  #

+  # Networking stack

+  #

+  INF MdeModulePkg/Universal/Network/DpcDxe/DpcDxe.inf

+  INF MdeModulePkg/Universal/Network/ArpDxe/ArpDxe.inf

+  INF MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Dxe.inf

+  INF MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Dxe.inf

+  INF MdeModulePkg/Universal/Network/MnpDxe/MnpDxe.inf

+  INF MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigDxe.inf

+  INF MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Dxe.inf

+  INF MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Dxe.inf

+  INF MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Dxe.inf

+  INF MdeModulePkg/Universal/Network/UefiPxeBcDxe/UefiPxeBcDxe.inf

+  INF MdeModulePkg/Universal/Network/IScsiDxe/IScsiDxe.inf

+

+  #

+  # SCSI Bus and Disk Driver

+  #

+  INF MdeModulePkg/Bus/Scsi/ScsiBusDxe/ScsiBusDxe.inf

+  INF MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDiskDxe.inf

+

+  #

+  # SMBIOS Support

+  #

+  INF MdeModulePkg/Universal/SmbiosDxe/SmbiosDxe.inf

+  INF OvmfPkg/SmbiosPlatformDxe/SmbiosPlatformDxe.inf

+

+  #

+  # ACPI Support

+  #

+  INF MdeModulePkg/Universal/Acpi/AcpiTableDxe/AcpiTableDxe.inf

+  INF OvmfPkg/AcpiPlatformDxe/QemuFwCfgAcpiPlatformDxe.inf

+

+  #

+  # PCI support

+  #

+  INF ArmVirtPkg/PciHostBridgeDxe/PciHostBridgeDxe.inf

+  INF MdeModulePkg/Bus/Pci/PciBusDxe/PciBusDxe.inf

+  INF OvmfPkg/VirtioPciDeviceDxe/VirtioPciDeviceDxe.inf

+

+  #

+  # Video support

+  #

+  INF OvmfPkg/QemuVideoDxe/QemuVideoDxe.inf

+  INF OvmfPkg/PlatformDxe/Platform.inf

+

+  #

+  # USB Support

+  #

+  INF MdeModulePkg/Bus/Pci/UhciDxe/UhciDxe.inf

+  INF MdeModulePkg/Bus/Pci/EhciDxe/EhciDxe.inf

+  INF MdeModulePkg/Bus/Pci/XhciDxe/XhciDxe.inf

+  INF MdeModulePkg/Bus/Usb/UsbBusDxe/UsbBusDxe.inf

+  INF MdeModulePkg/Bus/Usb/UsbKbDxe/UsbKbDxe.inf

+

+  #

+  # TianoCore logo (splash screen)

+  #

+  FILE FREEFORM = PCD(gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdLogoFile) {

+    SECTION RAW = MdeModulePkg/Logo/Logo.bmp

+  }

+

+!if $(ARCH) == ARM

+  INF MdeModulePkg/Universal/FvSimpleFileSystemDxe/FvSimpleFileSystemDxe.inf

+  INF ArmPkg/Application/LinuxLoader/LinuxLoader.inf

+!endif

+

+[FV.FVMAIN_COMPACT]

+FvAlignment        = 16

+ERASE_POLARITY     = 1

+MEMORY_MAPPED      = TRUE

+STICKY_WRITE       = TRUE

+LOCK_CAP           = TRUE

+LOCK_STATUS        = TRUE

+WRITE_DISABLED_CAP = TRUE

+WRITE_ENABLED_CAP  = TRUE

+WRITE_STATUS       = TRUE

+WRITE_LOCK_CAP     = TRUE

+WRITE_LOCK_STATUS  = TRUE

+READ_DISABLED_CAP  = TRUE

+READ_ENABLED_CAP   = TRUE

+READ_STATUS        = TRUE

+READ_LOCK_CAP      = TRUE

+READ_LOCK_STATUS   = TRUE

+

+  INF ArmVirtPkg/PrePi/ArmVirtPrePiUniCoreRelocatable.inf

+

+  FILE FV_IMAGE = 9E21FD93-9C72-4c15-8C4B-E77F1DB2D792 {

+    SECTION GUIDED EE4E5898-3914-4259-9D6E-DC7BD79403CF PROCESSING_REQUIRED = TRUE {

+      SECTION FV_IMAGE = FVMAIN

+    }

+  }

+

+

+################################################################################

+#

+# Rules are use with the [FV] section's module INF type to define

+# how an FFS file is created for a given INF file. The following Rule are the default

+# rules for the different module type. User can add the customized rules to define the

+# content of the FFS file.

+#

+################################################################################

+

+

+############################################################################

+# Example of a DXE_DRIVER FFS file with a Checksum encapsulation section   #

+############################################################################

+#

+#[Rule.Common.DXE_DRIVER]

+#  FILE DRIVER = $(NAMED_GUID) {

+#    DXE_DEPEX    DXE_DEPEX               Optional $(INF_OUTPUT)/$(MODULE_NAME).depex

+#    COMPRESS PI_STD {

+#      GUIDED {

+#        PE32     PE32                    $(INF_OUTPUT)/$(MODULE_NAME).efi

+#        UI       STRING="$(MODULE_NAME)" Optional

+#        VERSION  STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)

+#      }

+#    }

+#  }

+#

+############################################################################

+

+[Rule.Common.SEC]

+  FILE SEC = $(NAMED_GUID) RELOCS_STRIPPED FIXED {

+    TE  TE Align = Auto                 $(INF_OUTPUT)/$(MODULE_NAME).efi

+  }

+

+[Rule.Common.PEI_CORE]

+  FILE PEI_CORE = $(NAMED_GUID) FIXED {

+    TE     TE Align = Auto              $(INF_OUTPUT)/$(MODULE_NAME).efi

+    UI     STRING ="$(MODULE_NAME)" Optional

+  }

+

+[Rule.Common.PEIM]

+  FILE PEIM = $(NAMED_GUID) FIXED {

+     PEI_DEPEX PEI_DEPEX Optional       $(INF_OUTPUT)/$(MODULE_NAME).depex

+     TE       TE Align = Auto           $(INF_OUTPUT)/$(MODULE_NAME).efi

+     UI       STRING="$(MODULE_NAME)" Optional

+  }

+

+[Rule.Common.PEIM.TIANOCOMPRESSED]

+  FILE PEIM = $(NAMED_GUID) DEBUG_MYTOOLS_IA32 {

+    PEI_DEPEX PEI_DEPEX Optional        $(INF_OUTPUT)/$(MODULE_NAME).depex

+    GUIDED A31280AD-481E-41B6-95E8-127F4C984779 PROCESSING_REQUIRED = TRUE {

+      PE32      PE32                    $(INF_OUTPUT)/$(MODULE_NAME).efi

+      UI        STRING="$(MODULE_NAME)" Optional

+    }

+  }

+

+[Rule.Common.DXE_CORE]

+  FILE DXE_CORE = $(NAMED_GUID) {

+    PE32     PE32                       $(INF_OUTPUT)/$(MODULE_NAME).efi

+    UI       STRING="$(MODULE_NAME)" Optional

+  }

+

+[Rule.Common.UEFI_DRIVER]

+  FILE DRIVER = $(NAMED_GUID) {

+    DXE_DEPEX    DXE_DEPEX              Optional $(INF_OUTPUT)/$(MODULE_NAME).depex

+    PE32         PE32                   $(INF_OUTPUT)/$(MODULE_NAME).efi

+    UI           STRING="$(MODULE_NAME)" Optional

+  }

+

+[Rule.Common.DXE_DRIVER]

+  FILE DRIVER = $(NAMED_GUID) {

+    DXE_DEPEX    DXE_DEPEX              Optional $(INF_OUTPUT)/$(MODULE_NAME).depex

+    PE32         PE32                   $(INF_OUTPUT)/$(MODULE_NAME).efi

+    UI           STRING="$(MODULE_NAME)" Optional

+  }

+

+[Rule.Common.DXE_RUNTIME_DRIVER]

+  FILE DRIVER = $(NAMED_GUID) {

+    DXE_DEPEX    DXE_DEPEX              Optional $(INF_OUTPUT)/$(MODULE_NAME).depex

+    PE32         PE32                   $(INF_OUTPUT)/$(MODULE_NAME).efi

+    UI           STRING="$(MODULE_NAME)" Optional

+  }

+

+[Rule.Common.UEFI_APPLICATION]

+  FILE APPLICATION = $(NAMED_GUID) {

+    UI     STRING ="$(MODULE_NAME)"     Optional

+    PE32   PE32                         $(INF_OUTPUT)/$(MODULE_NAME).efi

+  }

+

+[Rule.Common.UEFI_DRIVER.BINARY]

+  FILE DRIVER = $(NAMED_GUID) {

+    DXE_DEPEX DXE_DEPEX Optional      |.depex

+    PE32      PE32                    |.efi

+    UI        STRING="$(MODULE_NAME)" Optional

+    VERSION   STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)

+  }

+

+[Rule.Common.UEFI_APPLICATION.BINARY]

+  FILE APPLICATION = $(NAMED_GUID) {

+    PE32      PE32                    |.efi

+    UI        STRING="$(MODULE_NAME)" Optional

+    VERSION   STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)

+  }

+

+[Rule.Common.USER_DEFINED.ACPITABLE]

+  FILE FREEFORM = $(NAMED_GUID) {

+    RAW       ACPI                    |.acpi

+    RAW       ASL                     |.aml

+    UI        STRING="$(MODULE_NAME)" Optional

+  }