EFISTUB - ArchWiki

# EFISTUB

From ArchWiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Related articles

- Arch boot process
- Unified Extensible Firmware Interface

The Linux kernel supports EFISTUB booting which allows EFI firmware to load the kernel as an EFI executable. The option is enabled by default on Arch Linux kernels, or if compiling the kernel one can activate it by setting `CONFIG_EFI_STUB=y` in the Kernel configuration. See The EFI Boot Stub for more information.

With EFISTUB a kernel can be booted directly by a UEFI motherboard or indirectly using a boot loader. Using a boot loader is recommended if you have multiple kernel/initramfs pairs and your motherboard's UEFI boot menu is not easy to use.

## Preparing for EFISTUB

First, you must create an EFI system partition and choose how it is mounted. See EFI system partition#Mount the partition for all available ESP mounting options.

Tip:

- pacman will directly update the kernel that the EFI firmware will read if you mount the ESP to `/boot`.
- You can keep the kernel and initramfs off of the ESP if you use a boot manager which has a file system driver for the partition where they reside, e.g. rEFInd.

## Booting EFISTUB

Note: Linux Kernel EFISTUB initramfs path should be relative to the EFI System Partition's root and use backslashes (in accordance with EFI standards). For example, if the initramfs is located in `esp/EFI/arch/initramfs-linux.img`, the corresponding UEFI formatted line should be `initrd=\EFI\arch\initramfs-linux.img`. In the following examples we will assume that everything is under `esp/`.

### Using a boot manager

This article or section needs language, wiki syntax or style improvements. See Help:Style for reference.

Reason: Convert this section into a tip. This article mainly focuses on booting without using a separate boot loader/manager. (Discuss in Talk:EFISTUB#)

There are several UEFI boot managers which can provide additional options or simplify the process of UEFI booting - especially if you have multiple kernels/operating systems. See Arch boot process#Boot loader for more information.

### Using UEFI directly

UEFI is designed to remove the need for an intermediate bootloader such as GRUB. If your motherboard has a good UEFI implementation, it is possible to embed the kernel parameters within a UEFI boot entry and for the motherboard to boot Arch directly. You can use efibootmgr or UEFI Shell v2 to modify your motherboard's boot entries.

Note:

- Outdated UEFI implementations may have compatibility issues with the Linux kernel. If there is a newer version of your UEFI with bug fixes, consider flashing it with the manufacturer's recommended tool.
- Some firmwares do not pass command line parameters from the boot entries in NVRAM to the EFI binaries.[1] In that case, the kernel and parameters can be combined into a unified kernel image, then create a boot entry with an .efi file.

#### efibootmgr

To create a boot entry with efibootmgr that will load the kernel:

    # efibootmgr --disk /dev/sdX --part Y --create --label "Arch Linux" --loader /vmlinuz-linux --unicode 'root=PARTUUID=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX rw initrd=\initramfs-linux.img' --verbose

or create a boot entry with efibootmgr and hibernation on swap partition:

    # efibootmgr --disk /dev/sdX --part Y --create --label "Arch Linux" --loader /vmlinuz-linux --unicode 'root=PARTUUID=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX resume=PARTUUID=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX rw initrd=\initramfs-linux.img' --verbose

Where `/dev/sdX` and `Y` are the drive and partition number where the ESP is located. Change the `root=` and `resume=` parameters to reflect your Linux root and swap partitions, see kernel parameters for supported device name formats, and persistent block device naming for how to obtain the corresponding value. If omitted, then the first partition on `/dev/sda` is used as the ESP.

Note that the `-u`/`--unicode` argument in quotes is just the list of kernel parameters, so you may need to add additional parameters (e.g. for suspend to disk or microcode).

After adding the boot entry, you can verify the entry was added properly with:

    # efibootmgr --verbose

To set the boot order:

    # efibootmgr --bootorder XXXX,XXXX --verbose

Where XXXX is the number that appears in the output of efibootmgr command against each entry.

Tip:

- It is convenient to save the command to create the boot entry in a shell script, which makes it easier to modify, for example when changing kernel parameters. In doing so, consider automating the deletion of old boot entries, as efibootmgr currently does not support editing existing entries.
- The forum post titled The linux kernel with build in bootloader? might also be of interest.

#### efibootmgr with .efi file

This article or section is a candidate for merging with systemd-boot#Preparing a unified kernel image.

Notes: A unified kernel image uses systemd-boot's stub first and only then kernel's EFI stub, so the content belongs in the systemd-boot article. (Discuss in Talk:EFISTUB#)

If using cryptbootAUR and sbupdate-gitAUR to generate your own keys for Secure Boot and sign the initramfs and kernel then create a bootable .efi image, efibootmgr can be used directly to boot the .efi file:

    # efibootmgr --create --disk /dev/sdX --part partition_number --label "label" --loader "EFI\folder\file.efi" --verbose

See efibootmgr(8) for an explanation of the options. To include microcode in a unified kernel image, concatenate it with the initramfs and use the resultant image with objtool.

#### bcfg

Some UEFI implementations make it difficult to modify the NVRAM successfully using efibootmgr. If efibootmgr cannot successfully create an entry, you can use the bcfg command in UEFI Shell v2 (i.e., from the Arch Linux live iso).

First, find out the device number where your ESP resides with:

    Shell> map

In this example, `1` is used as the device number. To list the contents of the ESP:

    Shell> ls FS1:

To view the current boot entries:

    Shell> bcfg boot dump

To add an entry for your kernel, use:

    Shell> bcfg boot add N FS1:\vmlinuz-linux "Arch Linux"

Where `N` is the location where the entry will be added in the boot menu. 0 is the first menu item. Menu items already existing will be shifted in the menu without being discarded.

Add the necessary kernel options by creating a file on your ESP:

    Shell> edit FS1:\options.txt

In the file, add the boot line. For example:

    root=/dev/sda2 ro initrd=\initramfs-linux.img

Note: Add extra spaces in the beginning of the line in the file. There is a byte order mark at the beginning of the line that will squash any character next to it which will cause an error when booting.

Press `F2` to save and then `F3` to exit.

Add these options to your previous entry:

    Shell> bcfg boot -opt N FS1:\options.txt

Repeat this process for any additional entries.

To remove a previously added item do:

    Shell> bcfg boot rm N

#### More tools

This section is being considered for removal.

Reason: Out of scope. (Discuss in Talk:EFISTUB#)

Some of the tools above, and more, are briefly discussed in rEFInd#Tools.

### Using UEFI Shell

If you do not want to create a permanent boot entry it is possible to launch the kernel from UEFI Shell as if it is a normal UEFI application:

    > FS0:
    > \vmlinuz-linux root=PARTUUID=3518bb68-d01e-45c9-b973-0b5d918aae96 rw initrd=\initramfs-linux.img

In this case, the kernel parameters are passed as normal parameters to the launched EFISTUB kernel file.

To avoid needing to remember all of your kernel parameters every time, you can save the executable command to a shell script such as `archlinux.nsh` on your UEFI System Partition, then run it with:

    > FS0:
    > archlinux

#### Using a startup.nsh script

Some UEFI implementations do not retain EFI variables between cold boots (e.g. VirtualBox before version 6.1) and anything set through the UEFI firmware interface is lost on poweroff.

The UEFI Shell Specification 2.0 establishes that a script called `startup.nsh` at the root of the ESP partition will always be interpreted and can contain arbitrary instructions; among those you can set a bootloading line. Make sure you mount the ESP partition on `/boot` and create a `startup.nsh` script that contains a kernel bootloading line. For example:

    vmlinuz-linux rw root=/dev/sdX [rootfs=myfs] [rootflags=myrootflags] \
     [kernel.flag=foo] [mymodule.flag=bar] \
     [initrd=\intel-ucode.img] initrd=\initramfs-linux.img

This method will work with almost all UEFI firmware versions you may encounter in real hardware, you can use it as last resort. The script must be a single long line. Sections in brackets are optional and given only as a guide. Shell style linebreaks are for visual clarification only. FAT filesystems use the backslash as path separator and in this case, the backslash declares the initramfs is located in the root of the ESP partition. Only Intel microcode is loaded in the booting parameters line; AMD microcode is read from disk later during the boot process; this is done automatically by the kernel.

## Troubleshooting

### Cannot create a new boot entry with efibootmgr

This article or section is a candidate for moving to Unified Extensible Firmware Interface#Troubleshooting.

Notes: This is not specific to EFISTUB. The issue is already briefly mentioned in Unified Extensible Firmware Interface#Requirements for UEFI variable support. (Discuss in Talk:EFISTUB#)

Some kernel and efibootmgr version combinations might refuse to create new boot entries. This could be due to lack of free space in the NVRAM. You can try deleting any EFI dump files:

    # rm /sys/firmware/efi/efivars/dump-*

Or, as a last resort, boot with the `efi_no_storage_paranoia` kernel parameter. You can also try to downgrade your efibootmgr install to version 0.11.0. This version works with Linux version 4.0.6. See the bug discussion FS#34641, in particular the closing comment, for more information.

### Newly created boot entries are removed

The factual accuracy of this article or section is disputed.

Reason: UEFI may remove boot entries after a referenced disk is removed, but it should not simply "remove boot entries after a couple of boots". Provide some reference for the issue. (Discuss in Talk:EFISTUB#)

Some motherboards may remove boot entries after a couple of boots. This could be due to lack of free space in the NVRAM. To prevent this from occurring, it may help to reduce the amount of Linux boot entries being added by efibootmgr by minimizing your entry creation process, as well as reducing the amount of automatic drive boot entries by the Compatibility Support Module (CSM) by disabling it from your UEFI settings.

### EFISTUB does not work on some Dell systems

Several generation Dell BIOSes are wrongly passing the arguments to the bootloader, thus making EFISTUB parse a null command line which normally means unbootable system (see the complete linux-efi thread).

A workaround has been found since Linux 5.10 to correct this behavior (see this commit ). For Linux < 5.10, you can use an efi-packer like arch-efiboot, or a different bootloader.

## See also

- Linux Kernel Documentation on EFISTUB
- Linux Kernel EFISTUB Git Commit
- Rod Smith's page on EFISTUB

Category:

- Boot loaders

Hidden categories:

- Pages or sections flagged with Template:Style
- Pages or sections flagged with Template:Merge
- Sections flagged with Template:Remove
- Pages or sections flagged with Template:Move
- Pages or sections flagged with Template:Accuracy