ArmPkg/Library/BdsLib/BdsLinuxLoader.c

   1 /** @file
   2 *
   3 *  Copyright (c) 2011-2012, ARM Limited. All rights reserved.
   4 *
   5 *  This program and the accompanying materials
   6 *  are licensed and made available under the terms and conditions of the BSD License
   7 *  which accompanies this distribution.  The full text of the license may be found at
   8 *  http://opensource.org/licenses/bsd-license.php
   9 *
  10 *  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 *  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12 *
  13 **/
  14
  15 #include "BdsInternal.h"
  16
  17 #define ALIGN32_BELOW(addr)   ALIGN_POINTER(addr - 32,32)
  18
  19 STATIC
  20 EFI_STATUS
  21 PreparePlatformHardware (
  22   VOID
  23   )
  24 {
  25   //Note: Interrupts will be disabled by the GIC driver when ExitBootServices() will be called.
  26
  27   // Clean, invalidate, disable data cache
  28   ArmCleanInvalidateDataCache();
  29   ArmDisableDataCache();
  30
  31   // Invalidate and disable the Instruction cache
  32   ArmInvalidateInstructionCache ();
  33   ArmDisableInstructionCache ();
  34
  35   // Turn off MMU
  36   ArmDisableMmu();
  37
  38   return EFI_SUCCESS;
  39 }
  40
  41 STATIC
  42 EFI_STATUS
  43 StartLinux (
  44   IN  EFI_PHYSICAL_ADDRESS  LinuxImage,
  45   IN  UINTN                 LinuxImageSize,
  46   IN  EFI_PHYSICAL_ADDRESS  KernelParamsAddress,
  47   IN  UINTN                 KernelParamsSize,
  48   IN  UINT32                MachineType
  49   )
  50 {
  51   EFI_STATUS            Status;
  52   LINUX_KERNEL          LinuxKernel;
  53
  54   // Shut down UEFI boot services. ExitBootServices() will notify every driver that created an event on
  55   // ExitBootServices event. Example the Interrupt DXE driver will disable the interrupts on this event.
  56   Status = ShutdownUefiBootServices ();
  57   if(EFI_ERROR(Status)) {
  58     DEBUG((EFI_D_ERROR,"ERROR: Can not shutdown UEFI boot services. Status=0x%X\n", Status));
  59     goto Exit;
  60   }
  61
  62   // Move the kernel parameters to any address inside the first 1MB.
  63   // This is necessary because the ARM Linux kernel requires
  64   // the FTD / ATAG List to reside entirely inside the first 1MB of
  65   // physical memory.
  66   if ((UINTN)KernelParamsAddress > LINUX_ATAG_MAX_OFFSET) {
  67     //Note: There is no requirement on the alignment
  68     KernelParamsAddress = (EFI_PHYSICAL_ADDRESS)(UINTN)CopyMem (ALIGN32_BELOW(LINUX_ATAG_MAX_OFFSET - KernelParamsSize), (VOID*)(UINTN)KernelParamsAddress, KernelParamsSize);
  69   }
  70
  71   if ((UINTN)LinuxImage > LINUX_KERNEL_MAX_OFFSET) {
  72     //Note: There is no requirement on the alignment
  73     LinuxKernel = (LINUX_KERNEL)CopyMem (ALIGN32_BELOW(LINUX_KERNEL_MAX_OFFSET - LinuxImageSize), (VOID*)(UINTN)LinuxImage, LinuxImageSize);
  74   } else {
  75     LinuxKernel = (LINUX_KERNEL)(UINTN)LinuxImage;
  76   }
  77
  78   // Check if the Linux Image is a uImage
  79   if (*(UINT32*)LinuxKernel == LINUX_UIMAGE_SIGNATURE) {
  80     // Assume the Image Entry Point is just after the uImage header (64-byte size)
  81     LinuxKernel = (LINUX_KERNEL)((UINTN)LinuxKernel + 64);
  82     LinuxImageSize -= 64;
  83   }
  84
  85   //TODO: Check there is no overlapping between kernel and Atag
  86
  87   //
  88   // Switch off interrupts, caches, mmu, etc
  89   //
  90   Status = PreparePlatformHardware ();
  91   ASSERT_EFI_ERROR(Status);
  92
  93   // Register and print out performance information
  94   PERF_END (NULL, "BDS", NULL, 0);
  95   if (PerformanceMeasurementEnabled ()) {
  96     PrintPerformance ();
  97   }
  98
  99   //
 100   // Start the Linux Kernel
 101   //
 102
 103   // Outside BootServices, so can't use Print();
 104   DEBUG((EFI_D_ERROR, "\nStarting the kernel:\n\n"));
 105
 106   // Jump to kernel with register set
 107   LinuxKernel ((UINTN)0, MachineType, (UINTN)KernelParamsAddress);
 108
 109   // Kernel should never exit
 110   // After Life services are not provided
 111   ASSERT(FALSE);
 112
 113 Exit:
 114   // Only be here if we fail to start Linux
 115   Print (L"ERROR  : Can not start the kernel. Status=0x%X\n", Status);
 116
 117   // Free Runtimee Memory (kernel and FDT)
 118   return Status;
 119 }
 120
 121 /**
 122   Start a Linux kernel from a Device Path
 123
 124   @param  LinuxKernel           Device Path to the Linux Kernel
 125   @param  Parameters            Linux kernel agruments
 126   @param  Fdt                   Device Path to the Flat Device Tree
 127
 128   @retval EFI_SUCCESS           All drivers have been connected
 129   @retval EFI_NOT_FOUND         The Linux kernel Device Path has not been found
 130   @retval EFI_OUT_OF_RESOURCES  There is not enough resource memory to store the matching results.
 131
 132 **/
 133 EFI_STATUS
 134 BdsBootLinuxAtag (
 135   IN  EFI_DEVICE_PATH_PROTOCOL* LinuxKernelDevicePath,
 136   IN  EFI_DEVICE_PATH_PROTOCOL* InitrdDevicePath,
 137   IN  CONST CHAR8*              Arguments
 138   )
 139 {
 140   EFI_STATUS            Status;
 141   UINT32                LinuxImageSize;
 142   UINT32                InitrdImageSize = 0;
 143   UINT32                KernelParamsSize;
 144   EFI_PHYSICAL_ADDRESS  KernelParamsAddress;
 145   EFI_PHYSICAL_ADDRESS  LinuxImage;
 146   EFI_PHYSICAL_ADDRESS  InitrdImage;
 147
 148   PERF_START (NULL, "BDS", NULL, 0);
 149
 150   // Load the Linux kernel from a device path
 151   LinuxImage = LINUX_KERNEL_MAX_OFFSET;
 152   Status = BdsLoadImage (LinuxKernelDevicePath, AllocateMaxAddress, &LinuxImage, &LinuxImageSize);
 153   if (EFI_ERROR(Status)) {
 154     Print (L"ERROR: Did not find Linux kernel.\n");
 155     return Status;
 156   }
 157
 158   if (InitrdDevicePath) {
 159     // Load the initrd near to the Linux kernel
 160     InitrdImage = LINUX_KERNEL_MAX_OFFSET;
 161     Status = BdsLoadImage (InitrdDevicePath, AllocateMaxAddress, &InitrdImage, &InitrdImageSize);
 162     if (Status == EFI_OUT_OF_RESOURCES) {
 163       Status = BdsLoadImage (InitrdDevicePath, AllocateAnyPages, &InitrdImage, &InitrdImageSize);
 164     }
 165     if (EFI_ERROR(Status)) {
 166       Print (L"ERROR: Did not find initrd image.\n");
 167       return Status;
 168     }
 169   }
 170
 171   //
 172   // Setup the Linux Kernel Parameters
 173   //
 174
 175   // By setting address=0 we leave the memory allocation to the function
 176   Status = PrepareAtagList (Arguments, InitrdImage, InitrdImageSize, &KernelParamsAddress, &KernelParamsSize);
 177   if (EFI_ERROR(Status)) {
 178     Print(L"ERROR: Can not prepare ATAG list. Status=0x%X\n", Status);
 179     return Status;
 180   }
 181
 182   return StartLinux (LinuxImage, LinuxImageSize, KernelParamsAddress, KernelParamsSize, PcdGet32(PcdArmMachineType));
 183 }
 184
 185 /**
 186   Start a Linux kernel from a Device Path
 187
 188   @param  LinuxKernel           Device Path to the Linux Kernel
 189   @param  Parameters            Linux kernel agruments
 190   @param  Fdt                   Device Path to the Flat Device Tree
 191
 192   @retval EFI_SUCCESS           All drivers have been connected
 193   @retval EFI_NOT_FOUND         The Linux kernel Device Path has not been found
 194   @retval EFI_OUT_OF_RESOURCES  There is not enough resource memory to store the matching results.
 195
 196 **/
 197 EFI_STATUS
 198 BdsBootLinuxFdt (
 199   IN  EFI_DEVICE_PATH_PROTOCOL* LinuxKernelDevicePath,
 200   IN  EFI_DEVICE_PATH_PROTOCOL* InitrdDevicePath,
 201   IN  CONST CHAR8*              Arguments,
 202   IN  EFI_DEVICE_PATH_PROTOCOL* FdtDevicePath
 203   )
 204 {
 205   EFI_STATUS            Status;
 206   UINT32                LinuxImageSize;
 207   UINT32                InitrdImageSize = 0;
 208   UINT32                KernelParamsSize;
 209   EFI_PHYSICAL_ADDRESS  KernelParamsAddress;
 210   UINT32                FdtMachineType;
 211   EFI_PHYSICAL_ADDRESS  LinuxImage;
 212   EFI_PHYSICAL_ADDRESS  InitrdImage;
 213
 214   FdtMachineType = 0xFFFFFFFF;
 215
 216   PERF_START (NULL, "BDS", NULL, 0);
 217
 218   // Load the Linux kernel from a device path
 219   LinuxImage = LINUX_KERNEL_MAX_OFFSET;
 220   Status = BdsLoadImage (LinuxKernelDevicePath, AllocateMaxAddress, &LinuxImage, &LinuxImageSize);
 221   if (EFI_ERROR(Status)) {
 222     Print (L"ERROR: Did not find Linux kernel.\n");
 223     return Status;
 224   }
 225
 226   if (InitrdDevicePath) {
 227     InitrdImage = LINUX_KERNEL_MAX_OFFSET;
 228     Status = BdsLoadImage (InitrdDevicePath, AllocateMaxAddress, &InitrdImage, &InitrdImageSize);
 229     if (Status == EFI_OUT_OF_RESOURCES) {
 230       Status = BdsLoadImage (InitrdDevicePath, AllocateAnyPages, &InitrdImage, &InitrdImageSize);
 231     }
 232     if (EFI_ERROR(Status)) {
 233       Print (L"ERROR: Did not find initrd image.\n");
 234       return Status;
 235     }
 236   }
 237
 238   // Load the FDT binary from a device path
 239   KernelParamsAddress = LINUX_ATAG_MAX_OFFSET;
 240   Status = BdsLoadImage (FdtDevicePath, AllocateMaxAddress, &KernelParamsAddress, &KernelParamsSize);
 241   if (EFI_ERROR(Status)) {
 242     Print (L"ERROR: Did not find Device Tree blob.\n");
 243     return Status;
 244   }
 245   return StartLinux (LinuxImage, LinuxImageSize, KernelParamsAddress, KernelParamsSize, FdtMachineType);
 246 }
 247