3 * Copyright (c) 2011, ARM Limited. All rights reserved.
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
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.
15 #include "BdsInternal.h"
16 #include "BdsLinuxLoader.h"
18 #include <Library/PcdLib.h>
19 #include <Library/ArmLib.h>
20 #include <Library/HobLib.h>
22 #define ALIGN32_BELOW(addr) ALIGN_POINTER(addr - 32,32)
24 #define LINUX_ATAG_MAX_OFFSET (PcdGet32(PcdSystemMemoryBase) + PcdGet32(PcdArmLinuxAtagMaxOffset))
25 #define LINUX_KERNEL_MAX_OFFSET (PcdGet32(PcdSystemMemoryBase) + PcdGet32(PcdArmLinuxKernelMaxOffset))
27 // Point to the current ATAG
28 STATIC LINUX_ATAG
*mLinuxKernelCurrentAtag
;
36 mLinuxKernelCurrentAtag
->header
.size
= tag_size(LINUX_ATAG_CORE
);
37 mLinuxKernelCurrentAtag
->header
.type
= ATAG_CORE
;
39 mLinuxKernelCurrentAtag
->body
.core_tag
.flags
= 1; /* ensure read-only */
40 mLinuxKernelCurrentAtag
->body
.core_tag
.pagesize
= PageSize
; /* systems PageSize (4k) */
41 mLinuxKernelCurrentAtag
->body
.core_tag
.rootdev
= 0; /* zero root device (typically overridden from kernel command line )*/
43 // move pointer to next tag
44 mLinuxKernelCurrentAtag
= next_tag_address(mLinuxKernelCurrentAtag
);
50 IN UINTN StartAddress
,
54 mLinuxKernelCurrentAtag
->header
.size
= tag_size(LINUX_ATAG_MEM
);
55 mLinuxKernelCurrentAtag
->header
.type
= ATAG_MEM
;
57 mLinuxKernelCurrentAtag
->body
.mem_tag
.start
= StartAddress
; /* Start of memory chunk for AtagMem */
58 mLinuxKernelCurrentAtag
->body
.mem_tag
.size
= Size
; /* Size of memory chunk for AtagMem */
60 // move pointer to next tag
61 mLinuxKernelCurrentAtag
= next_tag_address(mLinuxKernelCurrentAtag
);
67 IN CONST CHAR8
*CmdLine
72 // Increment the line length by 1 to account for the null string terminator character
73 LineLength
= AsciiStrLen(CmdLine
) + 1;
75 /* Check for NULL strings.
76 * Do not insert a tag for an empty CommandLine, don't even modify the tag address pointer.
77 * Remember, you have at least one null string terminator character.
80 mLinuxKernelCurrentAtag
->header
.size
= ((UINT32
)sizeof(LINUX_ATAG_HEADER
) + LineLength
+ (UINT32
)3) >> 2;
81 mLinuxKernelCurrentAtag
->header
.type
= ATAG_CMDLINE
;
83 /* place CommandLine into tag */
84 AsciiStrCpy(mLinuxKernelCurrentAtag
->body
.cmdline_tag
.cmdline
, CmdLine
);
86 // move pointer to next tag
87 mLinuxKernelCurrentAtag
= next_tag_address(mLinuxKernelCurrentAtag
);
97 // Empty tag ends list; this has zero length and no body
98 mLinuxKernelCurrentAtag
->header
.type
= ATAG_NONE
;
99 mLinuxKernelCurrentAtag
->header
.size
= 0;
101 /* We can not calculate the next address by using the standard macro:
102 * Params = next_tag_address(Params);
103 * because it relies on the header.size, which here it is 0 (zero).
104 * The easiest way is to add the sizeof(mLinuxKernelCurrentAtag->header).
106 mLinuxKernelCurrentAtag
= (LINUX_ATAG
*)((UINT32
)mLinuxKernelCurrentAtag
+ sizeof(mLinuxKernelCurrentAtag
->header
));
112 IN CONST CHAR8
* CommandLineString
,
113 IN EFI_PHYSICAL_ADDRESS InitrdImage
,
114 IN UINTN InitrdImageSize
,
115 OUT LINUX_ATAG
**AtagBase
,
120 LIST_ENTRY
*ResourceLink
;
121 LIST_ENTRY ResourceList
;
122 EFI_PHYSICAL_ADDRESS AtagStartAddress
;
123 BDS_SYSTEM_MEMORY_RESOURCE
*Resource
;
125 AtagStartAddress
= LINUX_ATAG_MAX_OFFSET
;
126 Status
= gBS
->AllocatePages (AllocateMaxAddress
, EfiBootServicesData
, EFI_SIZE_TO_PAGES(ATAG_MAX_SIZE
), &AtagStartAddress
);
127 if (EFI_ERROR(Status
)) {
128 DEBUG ((EFI_D_ERROR
,"Failed to allocate Atag at 0x%lX (%r)\n",AtagStartAddress
,Status
));
129 Status
= gBS
->AllocatePages (AllocateAnyPages
, EfiBootServicesData
, EFI_SIZE_TO_PAGES(ATAG_MAX_SIZE
), &AtagStartAddress
);
130 ASSERT_EFI_ERROR(Status
);
133 // Ready to setup the atag list
134 mLinuxKernelCurrentAtag
= (LINUX_ATAG
*)(UINTN
)AtagStartAddress
;
136 // Standard core tag 4k PageSize
137 SetupCoreTag( (UINT32
)SIZE_4KB
);
139 // Physical memory setup
140 GetSystemMemoryResources (&ResourceList
);
141 ResourceLink
= ResourceList
.ForwardLink
;
142 while (ResourceLink
!= NULL
&& ResourceLink
!= &ResourceList
) {
143 Resource
= (BDS_SYSTEM_MEMORY_RESOURCE
*)ResourceLink
;
144 DEBUG((EFI_D_INFO
,"- [0x%08X,0x%08X]\n",(UINT32
)Resource
->PhysicalStart
,(UINT32
)Resource
->PhysicalStart
+(UINT32
)Resource
->ResourceLength
));
145 SetupMemTag( (UINT32
)Resource
->PhysicalStart
, (UINT32
)Resource
->ResourceLength
);
146 ResourceLink
= ResourceLink
->ForwardLink
;
149 // CommandLine setting root device
150 SetupCmdlineTag (CommandLineString
);
152 if (InitrdImageSize
> 0 && InitrdImage
!= 0) {
153 mLinuxKernelCurrentAtag
->header
.size
= tag_size(LINUX_ATAG_INITRD2
);
154 mLinuxKernelCurrentAtag
->header
.type
= ATAG_INITRD2
;
156 mLinuxKernelCurrentAtag
->body
.initrd2_tag
.start
= (UINT32
)InitrdImage
;
157 mLinuxKernelCurrentAtag
->body
.initrd2_tag
.size
= (UINT32
)InitrdImageSize
;
159 // Move pointer to next tag
160 mLinuxKernelCurrentAtag
= next_tag_address(mLinuxKernelCurrentAtag
);
166 // Calculate atag list size
167 *AtagBase
= (LINUX_ATAG
*)(UINTN
)AtagStartAddress
;
168 *AtagSize
= (UINT32
)mLinuxKernelCurrentAtag
- (UINT32
)AtagStartAddress
+ 1;
175 PreparePlatformHardware (
179 //Note: Interrupts will be disabled by the GIC driver when ExitBootServices() will be called.
181 // clean, invalidate, disable data cache
182 ArmCleanInvalidateDataCache();
183 ArmDisableDataCache();
185 // Invalidate and disable the Instruction cache
186 ArmInvalidateInstructionCache ();
187 ArmDisableInstructionCache ();
196 Start a Linux kernel from a Device Path
198 @param LinuxKernel Device Path to the Linux Kernel
199 @param Parameters Linux kernel agruments
200 @param Fdt Device Path to the Flat Device Tree
202 @retval EFI_SUCCESS All drivers have been connected
203 @retval EFI_NOT_FOUND The Linux kernel Device Path has not been found
204 @retval EFI_OUT_OF_RESOURCES There is not enough resource memory to store the matching results.
209 IN EFI_DEVICE_PATH_PROTOCOL
* LinuxKernelDevicePath
,
210 IN EFI_DEVICE_PATH_PROTOCOL
* InitrdDevicePath
,
211 IN CONST CHAR8
* Arguments
,
212 IN EFI_DEVICE_PATH_PROTOCOL
* FdtDevicePath
216 UINT32 LinuxImageSize
;
217 UINT32 InitrdImageSize
;
218 UINT32 KernelParamsSize
;
219 EFI_PHYSICAL_ADDRESS KernelParamsAddress
;
221 BOOLEAN FdtSupported
= FALSE
;
222 LINUX_KERNEL LinuxKernel
;
223 EFI_PHYSICAL_ADDRESS LinuxImage
;
224 EFI_PHYSICAL_ADDRESS InitrdImage
;
226 // Ensure the System Memory PCDs have been initialized (PcdSystemMemoryBase and PcdSystemMemorySize)
227 ASSERT (PcdGet32(PcdSystemMemorySize
) != 0);
229 PERF_START (NULL
, "BDS", NULL
, 0);
231 // Load the Linux kernel from a device path
232 LinuxImage
= LINUX_KERNEL_MAX_OFFSET
;
233 Status
= BdsLoadImage (LinuxKernelDevicePath
, AllocateMaxAddress
, &LinuxImage
, &LinuxImageSize
);
234 if (EFI_ERROR(Status
)) {
235 Print (L
"ERROR: Did not find Linux kernel.\n");
238 LinuxKernel
= (LINUX_KERNEL
)(UINTN
)LinuxImage
;
240 if (InitrdDevicePath
) {
242 Status
= BdsLoadImage (InitrdDevicePath
, AllocateAnyPages
, &InitrdImage
, &InitrdImageSize
);
243 if (EFI_ERROR(Status
)) {
244 Print (L
"ERROR: Did not find initrd image.\n");
250 // Load the FDT binary from a device path
251 KernelParamsAddress
= LINUX_ATAG_MAX_OFFSET
;
252 Status
= BdsLoadImage (FdtDevicePath
, AllocateMaxAddress
, &KernelParamsAddress
, &KernelParamsSize
);
253 if (EFI_ERROR(Status
)) {
254 Print (L
"ERROR: Did not find Device Tree blob.\n");
261 // Setup the Linux Kernel Parameters
264 // Non-FDT requires a specific machine type.
265 // This OS Boot loader supports just one machine type,
266 // but that could change in the future.
267 MachineType
= PcdGet32(PcdArmMachineType
);
269 // By setting address=0 we leave the memory allocation to the function
270 Status
= PrepareAtagList (Arguments
, InitrdImage
, InitrdImageSize
, (LINUX_ATAG
**)&KernelParamsAddress
, &KernelParamsSize
);
271 if(EFI_ERROR(Status
)) {
272 Print(L
"ERROR: Can not prepare ATAG list. Status=0x%X\n", Status
);
276 MachineType
= 0xFFFFFFFF;
279 // Shut down UEFI boot services. ExitBootServices() will notify every driver that created an event on
280 // ExitBootServices event. Example the Interrupt DXE driver will disable the interrupts on this event.
281 Status
= ShutdownUefiBootServices ();
282 if(EFI_ERROR(Status
)) {
283 DEBUG((EFI_D_ERROR
,"ERROR: Can not shutdown UEFI boot services. Status=0x%X\n", Status
));
287 // Move the kernel parameters to any address inside the first 1MB.
288 // This is necessary because the ARM Linux kernel requires
289 // the FTD / ATAG List to reside entirely inside the first 1MB of
291 if ((UINTN
)KernelParamsAddress
> LINUX_ATAG_MAX_OFFSET
) {
292 //Note: There is no requirement on the alignment
293 KernelParamsAddress
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)CopyMem (ALIGN32_BELOW(LINUX_ATAG_MAX_OFFSET
- KernelParamsSize
), (VOID
*)(UINTN
)KernelParamsAddress
, KernelParamsSize
);
296 if ((UINTN
)LinuxImage
> LINUX_KERNEL_MAX_OFFSET
) {
297 //Note: There is no requirement on the alignment
298 LinuxKernel
= (LINUX_KERNEL
)CopyMem (ALIGN32_BELOW(LINUX_KERNEL_MAX_OFFSET
- LinuxImageSize
), (VOID
*)(UINTN
)LinuxImage
, LinuxImageSize
);
301 //TODO: Check there is no overlapping between kernel and Atag
304 // Switch off interrupts, caches, mmu, etc
306 Status
= PreparePlatformHardware ();
307 ASSERT_EFI_ERROR(Status
);
309 // Register and print out performance information
310 PERF_END (NULL
, "BDS", NULL
, 0);
311 if (PerformanceMeasurementEnabled ()) {
316 // Start the Linux Kernel
319 // Outside BootServices, so can't use Print();
320 DEBUG((EFI_D_ERROR
, "\nStarting the kernel:\n\n"));
322 // jump to kernel with register set
323 LinuxKernel ((UINTN
)0, (UINTN
)MachineType
, (UINTN
)KernelParamsAddress
);
325 // Kernel should never exit
326 // After Life services are not provided
330 // Only be here if we fail to start Linux
331 Print (L
"ERROR : Can not start the kernel. Status=0x%X\n", Status
);
333 // Free Runtimee Memory (kernel and FDT)