arm64: efi: add EFI stub
[linux-2.6-block.git] / Documentation / efi-stub.txt
CommitLineData
0c759662
MF
1 The EFI Boot Stub
2 ---------------------------
3
719e2843
RF
4On the x86 and ARM platforms, a kernel zImage/bzImage can masquerade
5as a PE/COFF image, thereby convincing EFI firmware loaders to load
6it as an EFI executable. The code that modifies the bzImage header,
7along with the EFI-specific entry point that the firmware loader
8jumps to are collectively known as the "EFI boot stub", and live in
0c759662 9arch/x86/boot/header.S and arch/x86/boot/compressed/eboot.c,
719e2843
RF
10respectively. For ARM the EFI stub is implemented in
11arch/arm/boot/compressed/efi-header.S and
12arch/arm/boot/compressed/efi-stub.c. EFI stub code that is shared
13between architectures is in drivers/firmware/efi/efi-stub-helper.c.
0c759662
MF
14
15By using the EFI boot stub it's possible to boot a Linux kernel
16without the use of a conventional EFI boot loader, such as grub or
17elilo. Since the EFI boot stub performs the jobs of a boot loader, in
18a certain sense it *IS* the boot loader.
19
20The EFI boot stub is enabled with the CONFIG_EFI_STUB kernel option.
21
22
23**** How to install bzImage.efi
24
25The bzImage located in arch/x86/boot/bzImage must be copied to the EFI
bf651883 26System Partition (ESP) and renamed with the extension ".efi". Without
0c759662
MF
27the extension the EFI firmware loader will refuse to execute it. It's
28not possible to execute bzImage.efi from the usual Linux file systems
719e2843
RF
29because EFI firmware doesn't have support for them. For ARM the
30arch/arm/boot/zImage should be copied to the system partition, and it
31may not need to be renamed.
0c759662
MF
32
33
34**** Passing kernel parameters from the EFI shell
35
36Arguments to the kernel can be passed after bzImage.efi, e.g.
37
38 fs0:> bzImage.efi console=ttyS0 root=/dev/sda4
39
40
41**** The "initrd=" option
42
43Like most boot loaders, the EFI stub allows the user to specify
44multiple initrd files using the "initrd=" option. This is the only EFI
45stub-specific command line parameter, everything else is passed to the
46kernel when it boots.
47
48The path to the initrd file must be an absolute path from the
49beginning of the ESP, relative path names do not work. Also, the path
50is an EFI-style path and directory elements must be separated with
51backslashes (\). For example, given the following directory layout,
52
53fs0:>
54 Kernels\
55 bzImage.efi
56 initrd-large.img
57
58 Ramdisks\
59 initrd-small.img
60 initrd-medium.img
61
62to boot with the initrd-large.img file if the current working
63directory is fs0:\Kernels, the following command must be used,
64
65 fs0:\Kernels> bzImage.efi initrd=\Kernels\initrd-large.img
66
67Notice how bzImage.efi can be specified with a relative path. That's
68because the image we're executing is interpreted by the EFI shell,
69which understands relative paths, whereas the rest of the command line
70is passed to bzImage.efi.
719e2843
RF
71
72
73**** The "dtb=" option
74
75For the ARM architecture, we also need to be able to provide a device
76tree to the kernel. This is done with the "dtb=" command line option,
77and is processed in the same manner as the "initrd=" option that is
78described above.