Difference between revisions of "Unified Extensible Firmware Interface"

From ArchWiki
Jump to: navigation, search
m (Fix typo)
(clearer wording for archiso usb example)
(35 intermediate revisions by 15 users not shown)
Line 1: Line 1:
 
[[Category:Boot process]]
 
[[Category:Boot process]]
 +
[[it:Unified Extensible Firmware Interface]]
 
[[ru:Unified Extensible Firmware Interface]]
 
[[ru:Unified Extensible Firmware Interface]]
 +
[[zh-CN:Unified Extensible Firmware Interface]]
 
{{Article summary start}}
 
{{Article summary start}}
 
{{Article summary text|An overview of the Unified Extensible Firmware Interface.}}
 
{{Article summary text|An overview of the Unified Extensible Firmware Interface.}}
Line 25: Line 27:
 
=== Multiboot on BIOS ===
 
=== Multiboot on BIOS ===
  
Since very little can be achieved by a program that fits into the 440-byte boot code area, multi-booting using BIOS requires a multi-boot capable bootloader (multi-boot refers to booting multiple operating systems, not to booting a kernel in the Multiboot format specified by the GRUB developers). So usually a common bootloader like [[GRUB]] or [[GRUB2]] or [[Syslinux]] or [[LILO]] would be loaded by the BIOS, and it would load an operating system by either chain-loading or directly loading the kernel.
+
Since very little can be achieved by a program that fits into the 440-byte boot code area, multi-booting using BIOS requires a multi-boot capable bootloader (multi-boot refers to booting multiple operating systems, not to booting a kernel in the Multiboot format specified by the GRUB developers). So usually a common bootloader like [[GRUB]] or [[Syslinux]] or [[LILO]] would be loaded by the BIOS, and it would load an operating system by either chain-loading or directly loading the kernel.
  
 
== Booting an OS using UEFI ==
 
== Booting an OS using UEFI ==
Line 33: Line 35:
 
The commonly used UEFI firmwares support both MBR and GPT partition table. EFI in Apple-Intel Macs are known to support Apple Partition Map also apart from MBR and GPT. Most of the UEFI firmwares have support for accessing FAT12 (floppy disks) , FAT16 and FAT32 filesystems in HDD and ISO9660 (and UDF) in CD/DVDs. EFI in Apple-Intel Macs can access HFS/HFS+ filesystems also apart from the mentioned ones.
 
The commonly used UEFI firmwares support both MBR and GPT partition table. EFI in Apple-Intel Macs are known to support Apple Partition Map also apart from MBR and GPT. Most of the UEFI firmwares have support for accessing FAT12 (floppy disks) , FAT16 and FAT32 filesystems in HDD and ISO9660 (and UDF) in CD/DVDs. EFI in Apple-Intel Macs can access HFS/HFS+ filesystems also apart from the mentioned ones.
  
UEFI does not launch any boot code in the MBR whether it exists or not. Instead it uses a special partition in the partition table called "EFI SYSTEM PARTITION" in which files required to be launched by the firmware is stored. Each vendor can store its files under <EFI SYSTEM PARTITION>/EFI/<VENDOR NAME>/ folder and can use the firmware or its shell (UEFI shell) to launch the boot program. An EFI System Partition is usually formatted as FAT32.
+
UEFI does not launch any boot code in the MBR whether it exists or not. Instead it uses a special partition in the partition table called "EFI SYSTEM PARTITION" in which files required to be launched by the firmware are stored. Each vendor can store its files under <EFI SYSTEM PARTITION>/EFI/<VENDOR NAME>/ folder and can use the firmware or its shell (UEFI shell) to launch the boot program. An EFI System Partition is usually formatted as FAT32.
  
 
Under UEFI, every program whether they are OS loaders or some utilities (like memory testing apps) or recovery tools outside the OS, should be a UEFI Application corresponding to the EFI firmware architecture. Most of the UEFI firmware in the market, including recent Apple Macs use x86_64 EFI firmware. Only some older macs use i386 EFI firmware while no non-Apple UEFI system is known to use i386 EFI firmware.
 
Under UEFI, every program whether they are OS loaders or some utilities (like memory testing apps) or recovery tools outside the OS, should be a UEFI Application corresponding to the EFI firmware architecture. Most of the UEFI firmware in the market, including recent Apple Macs use x86_64 EFI firmware. Only some older macs use i386 EFI firmware while no non-Apple UEFI system is known to use i386 EFI firmware.
Line 55: Line 57:
 
# Firmware reads its Boot Manager to determine which UEFI application to be launched and from where (ie. from which disk and partition).
 
# Firmware reads its Boot Manager to determine which UEFI application to be launched and from where (ie. from which disk and partition).
 
# Firmware launches the UEFI application from the FAT32 formatted UEFISYS partition as defined in the boot entry in the firmware's boot manager.
 
# Firmware launches the UEFI application from the FAT32 formatted UEFISYS partition as defined in the boot entry in the firmware's boot manager.
# UEFI application may launch another application (in case of UEFI Shell or a boot manager like rEFInd) or the kernel and initramfs (in case of a bootloader like GRUB2) depending on how the UEFI application was configured.
+
# UEFI application may launch another application (in case of UEFI Shell or a boot manager like rEFInd) or the kernel and initramfs (in case of a bootloader like GRUB) depending on how the UEFI application was configured.
  
 
== Detecting UEFI Firmware Arch ==
 
== Detecting UEFI Firmware Arch ==
Line 74: Line 76:
 
</pre>
 
</pre>
  
If the command returns EFI32 the it is i386 EFI 1.x firmware. If it returns EFI64 then it is x86_64 EFI 1.x firmware. Macs do not have UEFI 2.x firmware as Apple's efi implementation is not fully compliant with UEFI Specification.
+
If the command returns EFI32 then it is i386 EFI 1.x firmware. If it returns EFI64 then it is x86_64 EFI 1.x firmware. Macs do not have UEFI 2.x firmware as Apple's EFI implementation is not fully compliant with UEFI Specification.
  
 
== UEFI Support in Linux Kernel ==
 
== UEFI Support in Linux Kernel ==
Line 110: Line 112:
 
UEFI defines variables through which an operating system can interact with the firmware. UEFI Boot Variables are used by the boot-loader and used by the OS only for early system start-up. UEFI Runtime Variables allow an OS to manage certain settings of the firmware like the UEFI Boot Manager or managing the keys for UEFI Secure Boot Protocol etc.
 
UEFI defines variables through which an operating system can interact with the firmware. UEFI Boot Variables are used by the boot-loader and used by the OS only for early system start-up. UEFI Runtime Variables allow an OS to manage certain settings of the firmware like the UEFI Boot Manager or managing the keys for UEFI Secure Boot Protocol etc.
  
{{Note|The below steps will not work if the system has been booted in BIOS mode and will not work if the UEFI processor architecture does not match the kernel one, i.e. x86_64 UEFI + ix86 32-bit Kernel and vice-versa config will not work. This is true only for efivars kernel module and efibootmgr step. The other steps (ie. upto setting up <UEFISYS>/efi/arch/grub.{efi,cfg} ) can be done even in BIOS/Legacy boot mode.}}
+
{{Note|The below steps will not work if the system has been booted in BIOS mode and will not work if the UEFI processor architecture does not match the kernel one, i.e. x86_64 UEFI + x86 32-bit Kernel and vice-versa config will not work. This is true only for efivars kernel module and efibootmgr step. The other steps (ie. upto setting up <UEFISYS>/EFI/arch/refind/{refindx64.efi,refind.conf} ) can be done even in BIOS/Legacy boot mode.}}
  
Access to UEFI Runtime services is provided by "efivars" kernel module which is enabled through the {{ic|<nowiki>CONFIG_EFI_VAR=m</nowiki>}} kernel config option. This module once loaded exposes the variables under the directory {{ic|/sys/firnware/efi/vars}}. One way to check whether the system has booted in UEFI boot mode is to load the "efivars" kernel module and check for the existence of {{ic|/sys/firnware/efi/vars}} directory with contents similar to :
+
Access to UEFI Runtime services is provided by "efivars" kernel module which is enabled through the {{ic|<nowiki>CONFIG_EFI_VAR=m</nowiki>}} kernel config option. This module once loaded exposes the variables under the directory {{ic|/sys/firmware/efi/vars}}. One way to check whether the system has booted in UEFI boot mode is to load the "efivars" kernel module and check for the existence of {{ic|/sys/firmware/efi/vars}} directory with contents similar to :
  
 
  Sample output (x86_64-UEFI 2.3.1 in x86_64 Kernel):
 
  Sample output (x86_64-UEFI 2.3.1 in x86_64 Kernel):
Line 164: Line 166:
 
Verify whether there are files in ''/sys/firmware/efi/vars/'' directory. This directory and its contents are created by "efivars" kernel module and it will exist only if you have booted in UEFI mode, without the "noefi" kernel parameter.
 
Verify whether there are files in ''/sys/firmware/efi/vars/'' directory. This directory and its contents are created by "efivars" kernel module and it will exist only if you have booted in UEFI mode, without the "noefi" kernel parameter.
  
If ''/sys/firmware/efi/vars/'' directory is empty or does not exist, then {{ic|efibootmgr}} command will not work. If you are unable to make the ISO/CD/DVD/USB boot in UEFI mode try https://gitorious.org/tianocore_uefi_duet_builds/pages/Linux_Windows_BIOS_UEFI_boot_USB.
+
If ''/sys/firmware/efi/vars/'' directory is empty or does not exist, then {{ic|efibootmgr}} command will not work. If you are unable to make the ISO/CD/DVD/USB boot in UEFI mode try [[#Create_UEFI_bootable_USB_from_ISO]].
  
{{Note| The below commands use grub-efi-x86_64 boot-loader as example.}}
+
{{Note| The below commands use {{Pkg|gummiboot-efi}} boot-loader as example.}}
  
Assume the boot-loader file to be launched is {{ic|/boot/efi/efi/arch_grub/grubx64.efi}}. {{ic|/boot/efi/efi/arch_grub/grubx64.efi}} can be split up as {{ic|/boot/efi}} and {{ic|/efi/arch_grub/grubx64.efi}}, wherein {{ic|/boot/efi}} is the mountpoint of the UEFI System Partition, which is assumed to be /dev/sdXY (here X and Y are just placeholders for the actual values - eg:- in /dev/sda1 , X=a Y=1).
+
Assume the boot-loader file to be launched is {{ic|/boot/efi/EFI/gummiboot/gummibootx64.efi}}. {{ic|/boot/efi/EFI/gummiboot/gummibootx64.efi}} can be split up as {{ic|/boot/efi}} and {{ic|/EFI/gummiboot/gummibootx64.efi}}, wherein {{ic|/boot/efi}} is the mountpoint of the UEFI System Partition, which is assumed to be {{ic|/dev/sdXY}} (here X and Y are just placeholders for the actual values - eg:- in {{ic|/dev/sda1}} , X=a Y=1).
  
To determine the actual device path for the UEFI System Partition, try :
+
To determine the actual device path for the UEFI System Partition (should be in the form {{ic|/dev/sdXY}}), try :
  
  # cat /proc/self/mounts | grep /boot/efi | awk '{print $1}'
+
  # findmnt /boot/efi
  /dev/sdXY
+
TARGET SOURCE  FSTYPE OPTIONS
 +
/boot/efi  /dev/sdXY vfat        rw,flush,tz=UTC
  
 
Then create the boot entry using efibootmgr as follows :
 
Then create the boot entry using efibootmgr as follows :
  
  # efibootmgr --create --gpt --disk /dev/sdX --part Y --write-signature --label "Arch Linux (GRUB2)" --loader '\EFI\arch_grub\grubx64.efi'
+
  # efibootmgr -c -g -d /dev/sdX -p Y -w -L "Gummiboot" -l '\EFI\gummiboot\gummibootx64.efi'
  
In the above command {{ic|/boot/efi/efi/arch_grub/grubx64.efi}} translates to {{ic|/boot/efi}} and {{ic|/efi/arch_grub/grubx64.efi}} which in turn translate to drive {{ic|/dev/sdX}} -> partition Y -> file {{ic|/EFI/arch_grub/grubx64.efi}}.
+
In the above command {{ic|/boot/efi/EFI/gummiboot/gummibootx64.efi}} translates to {{ic|/boot/efi}} and {{ic|/EFI/gummiboot/gummibootx64.efi}} which in turn translate to drive {{ic|/dev/sdX}} -> partition {{ic|Y}} -> file {{ic|/EFI/gummiboot/gummibootx64.efi}}.
  
 
UEFI uses backward slash as path separator (similar to Windows paths).
 
UEFI uses backward slash as path separator (similar to Windows paths).
Line 185: Line 188:
 
The 'label' is the name of the menu entry shown in the UEFI boot menu. This name is user's choice and does not affect the booting of the system. More info can be obtained from [http://linux.dell.com/cgi-bin/gitweb/gitweb.cgi?p=efibootmgr.git;a=blob_plain;f=README;hb=HEAD efibootmgr GIT README] .
 
The 'label' is the name of the menu entry shown in the UEFI boot menu. This name is user's choice and does not affect the booting of the system. More info can be obtained from [http://linux.dell.com/cgi-bin/gitweb/gitweb.cgi?p=efibootmgr.git;a=blob_plain;f=README;hb=HEAD efibootmgr GIT README] .
  
FAT32 filesystem is case-insensitive since it does not use UTF-8 encoding by default. In that case the firmware uses capital 'EFI' instead of small 'efi', therefore using {{ic|\EFI\arch_grub\grubx64.efi}} or {{ic|\efi\arch_grub\grubx64.efi}} does not matter (this will change if the filesystem encoding is UTF-8).
+
FAT32 filesystem is case-insensitive since it does not use UTF-8 encoding by default. In that case the firmware uses capital 'EFI' instead of small 'efi', therefore using {{ic|\EFI\gummiboot\gummibootx64.efi}} or {{ic|\efi\gummiboot\gummibootx64.efi}} does not matter (this will change if the filesystem encoding is UTF-8).
  
 
== Linux Bootloaders for UEFI ==
 
== Linux Bootloaders for UEFI ==
Line 193: Line 196:
 
== Create an UEFI System Partition in Linux ==
 
== Create an UEFI System Partition in Linux ==
  
{{Note|The UEFISYS partition can be of any size supported by FAT32 filesystem. According to Microsoft Documentation, the minimum partition/volume size for FAT32 is 512 MiB. Therefore it is recommended for UEFISYS partition to be atleast 512 MiB. Higher partition sizes are fine, especially if you use multiple UEFI bootloaders, or multiple OSes booting via UEFI, so that there is enough space to hold all the related files. If you are using Linux EFISTUB booting, then you need to make sure there is adequate space available for keeping the Kernel and Initramfs files in the UEFISYS partition.}}
+
{{Note|The UEFISYS partition can be of any size supported by FAT32 filesystem. According to Microsoft Documentation, the minimum partition/volume size for FAT32 is 512 MiB. Therefore it is recommended for UEFISYS partition to be at least 512 MiB. Higher partition sizes are fine, especially if you use multiple UEFI bootloaders, or multiple OSes booting via UEFI, so that there is enough space to hold all the related files. If you are using Linux EFISTUB booting, then you need to make sure there is adequate space available for keeping the Kernel and Initramfs files in the UEFISYS partition.}}
  
 
=== For GPT partitioned disks ===
 
=== For GPT partitioned disks ===
Line 250: Line 253:
 
  Shell> bcfg boot dump -v
 
  Shell> bcfg boot dump -v
  
To add a boot menu entry for grub2's grubx64.efi (for example) as 4th (numbeering starts from zero) option in the boot menu
+
To add a boot menu entry for rEFInd (for example) as 4th (numbering starts from zero) option in the boot menu
  
  Shell> bcfg boot add 3 fs0:\EFI\arch\grubx64.efi "Arch Linux (GRUB2)"
+
  Shell> bcfg boot add 3 fs0:\EFI\arch\refind\refindx64.efi "Arch Linux (rEFInd)"
  
where fs0: is the mapping corresponding to the UEFI System Partition and \EFI\arch\grubx64.efi is the file to be launched.
+
where fs0: is the mapping corresponding to the UEFI System Partition and \EFI\arch\refind\refindx64.efi is the file to be launched.
  
 
To remove the 4th boot option
 
To remove the 4th boot option
Line 276: Line 279:
 
EDIT command provides a basic text editor with an interface similar to nano text editor, but slightly less functional. It handles UTF-8 encoding and takes care or LF vs CRLF line endings.
 
EDIT command provides a basic text editor with an interface similar to nano text editor, but slightly less functional. It handles UTF-8 encoding and takes care or LF vs CRLF line endings.
  
To edit, for example grub2's grub.cfg in the UEFI System Partition (fs0: in the firmware)
+
To edit, for example rEFInd's refind.conf in the UEFI System Partition (fs0: in the firmware)
  
 
  Shell> fs0:
 
  Shell> fs0:
  FS0:\> cd \efi\grub
+
  FS0:\> cd \EFI\arch\refind
  FS0:\efi\grub\> edit grub.cfg
+
  FS0:\EFI\arch\refind\> edit refind.conf
  
 
== Hardware Compatibility ==
 
== Hardware Compatibility ==
Line 290: Line 293:
  
 
{{Note|dd'ing the ISO (isohybrid method) to the USB drive will not work for UEFI boot.}}
 
{{Note|dd'ing the ISO (isohybrid method) to the USB drive will not work for UEFI boot.}}
 +
 +
{{Note|It does not matter whether the USB is partitioned as MBR or GPT, as long as the filesystem is FAT32 or FAT16.}}
 +
 +
{{Note|UEFI bootable USB can be created on Windows as well. However bsdtar running in Cygwin has to be used for extracting files as most Windows applications ignore the case sensitivity. }}
  
 
=== Archiso ===
 
=== Archiso ===
  
1. Create a directory {{ic|/tmp/archiso}} and extract the archiso file contents to it.
+
1. Mount FAT32 (or FAT16) (fdisk type code "0x0c" for FAT32) USB Partition to {{ic|/tmp/archusb}}:
  
2. Create a directory {{ic|/tmp/archiso_efiboot}} and extract {{ic|/tmp/archiso/EFI/archiso/efiboot.img}} to it using {{ic|7z}} command from {{Pkg|p7zip}} package.
+
$ mkdir -p /tmp/archusb/
 +
# mount -o rw,users -t vfat <USB_Device_Partition> /tmp/archusb
  
3. Run the below commands:
+
2. Extract archiso image contents to USB:
  
  # mkdir -p /tmp/archiso/EFI/{archiso,boot}
+
  $ cd /tmp/archusb/
  # cp /tmp/archiso/arch/boot/x86_64/vmlinuz /tmp/archiso/EFI/archiso/vmlinuz.efi
+
  $ bsdtar xf <Full path to Archiso image>
  # cp /tmp/archiso/arch/boot/x86_64/archiso.img /tmp/archiso/EFI/archiso/archiso.img
+
  $ rm -f /tmp/archusb/[BOOT]        # If the directory or file exist
# cp /tmp/archiso_efiboot/EFI/boot/bootx64.efi /tmp/archiso/EFI/boot/bootx64.efi
+
  $ sync
  # cp /tmp/archiso_efiboot/EFI/boot/startup.nsh /tmp/archiso/EFI/boot/startup.nsh
+
  
4. Find out the filesystem label to be used for the USB by reading "{{ic|1=archisolabel=}}" part in {{ic|/tmp/archiso/EFI/boot/startup.nsh}}. For example if {{ic|/tmp/archiso/EFI/boot/startup.nsh}} has {{ic|1=archisolabel=ARCH_201208}} then the filesystem label to be used is {{ic|ARCH_201208}} .  
+
3. Find out the filesystem label to be used for the USB by reading "{{ic|1=archisolabel=}}" part in {{ic|/tmp/archusb/loader/entries/archiso-x86_64.conf}}. For example if {{ic|/tmp/archusb/loader/entries/archiso-x86_64.conf}} has {{ic|1=archisolabel=ARCH_201210}} then the filesystem label to be used is {{ic|ARCH_201210}} .  
  
5. Create a directory {{ic|/tmp/archisousb}} . Format the USB drive as FAT32 (or FAT16) (no other filesystem is supported) and set the filesystem label same as the one obtained in step 4, and mount it to {{ic|/tmp/archisousb}} .
+
4. Unmount USB device and change its FS Label:
  
6. Copy the contents of {{ic|/tmp/archiso}} to {{ic|/tmp/archisousb}} and then umount {{ic|/tmp/archisousb}} .
+
# umount <USB_Device_Partition>
 +
# dosfslabel <USB_Device_Partition> <archisolabel>
 +
$ sync
  
=== [[Archboot]] ===
+
Example for step 4.
  
1. Create a directory {{ic|/tmp/archboot}} and extract the archiso file contents to it.
+
# umount /dev/sdc1
 +
# dosfslabel /dev/sdc1 ARCH_201210
 +
$ sync
  
{{Note|Follow steps 2 and 3 only if {{ic|/tmp/archboot/EFI/boot/bootx64.efi}} does not exist, even after extracting archboot iso to {{ic|/tmp/archboot}} .}}
+
=== [[Archboot]] ===
  
2. Create a directory {{ic|/tmp/archboot_efiboot}} and extract {{ic|/tmp/archboot/boot/grub/grub_uefi_x86_64.bin}} to it using {{ic|7z}} command from {{Pkg|p7zip}} package.
+
1. Mount FAT32 (or FAT16) (fdisk type code "0x0c" for FAT32) USB Partition to {{ic|/tmp/archusb}}:
  
3. Run the below commands:
+
$ mkdir -p /tmp/archusb/
 +
# mount -o rw,users -t vfat <USB_Device_Partition> /tmp/archusb
  
# mkdir -p /tmp/archboot/EFI/boot
+
2. Extract archboot iso image contents to USB:
# cp /tmp/archboot_efiboot/EFI/boot/bootx64.efi /tmp/archboot/EFI/boot/bootx64.efi
+
  
4. Create a directory {{ic|/tmp/archbootusb}} . Format the USB drive as FAT32 (or FAT16) (no other filesystem is supported) and mount it to {{ic|/tmp/archbootusb}} .
+
$ cd /tmp/archusb/
 +
$ bsdtar xf <Full path to Archboot ISO>
 +
$ rm -f /tmp/archusb/[BOOT]        # If the directory or file exist
 +
$ sync
  
5. Copy the contents of {{ic|/tmp/archboot}} to {{ic|/tmp/archbootusb}} and then umount {{ic|/tmp/archbootusb}} .
+
3. Unmount the USB device:
 +
 
 +
# umount <USB_Device_Partition>
  
 
== Remove UEFI boot support from ISO ==
 
== Remove UEFI boot support from ISO ==
Line 334: Line 350:
 
=== Archiso ===
 
=== Archiso ===
  
1. Obtain the ISO label from the output of {{ic|file <path_to_iso>}}. Let it be {{ic|ARCH_201208}} for example.
+
1. Obtain the ISO label from the output of {{ic|file <path_to_iso>}}. Let it be {{ic|ARCH_201210}} for example.
  
 
2. Create a directory {{ic|/tmp/archiso}} and extract the archiso file contents to it.
 
2. Create a directory {{ic|/tmp/archiso}} and extract the archiso file contents to it.
  
3. Run xorriso (part of {{Pkg|libisoburn}} package) as shown below:
+
3. Run {{ic|xorriso}} (part of {{Pkg|libisoburn}} package) as shown below:
  
 
  $ xorriso -as mkisofs -iso-level 3 \
 
  $ xorriso -as mkisofs -iso-level 3 \
 
           -full-iso9660-filenames \
 
           -full-iso9660-filenames \
           -volid "ARCH_201208" \
+
           -volid "ARCH_201210" \
           -appid "Arch Linux Live/Rescue CD" \
+
           -appid "Arch Linux CD" \
           -publisher "Arch Linux <http://www.archlinux.org>" \
+
           -publisher "Arch Linux <https://www.archlinux.org>" \
 
           -preparer "prepared by user" \
 
           -preparer "prepared by user" \
 
           -eltorito-boot isolinux/isolinux.bin \
 
           -eltorito-boot isolinux/isolinux.bin \
Line 355: Line 371:
  
 
=== [[Archboot]] ===
 
=== [[Archboot]] ===
 +
 +
{{Note|Archboot 2012.10 and above isos do not support UEFI-CD booting (only UEFI-USB booting is supported) so the below steps are not required for those isos.}}
  
 
1. Create a directory {{ic|/tmp/archboot}} and extract the archboot iso file contents to it.
 
1. Create a directory {{ic|/tmp/archboot}} and extract the archboot iso file contents to it.
  
2. Run xorriso (part of {{Pkg|libisoburn}} package) as shown below:
+
2. Run {{ic|xorriso}} (part of {{Pkg|libisoburn}} package) as shown below:
  
 
  $ xorriso -as mkisofs -iso-level 3 -rock -joliet \
 
  $ xorriso -as mkisofs -iso-level 3 -rock -joliet \
Line 391: Line 409:
 
* [http://www.hpuxtips.es/?q=node/293 UEFI Shell - bcfg command info]
 
* [http://www.hpuxtips.es/?q=node/293 UEFI Shell - bcfg command info]
 
* [http://hackthejoggler.freeforums.org/download/file.php?id=28 Some useful 32-bit UEFI Shell utilities]
 
* [http://hackthejoggler.freeforums.org/download/file.php?id=28 Some useful 32-bit UEFI Shell utilities]
 +
* [http://linuxplumbers.ubicast.tv/videos/plumbing-uefi-into-linux/ LPC 2012 Plumbing UEFI into Linux]
 +
* [http://linuxplumbers.ubicast.tv/videos/uefi-tutorial-part-1/ LPC 2012 UEFI Tutorial : part 1]
 +
* [http://linuxplumbers.ubicast.tv/videos/uefi-tutorial-part-2/ LPC 2012 UEFI Tutorial : part 2]

Revision as of 08:45, 21 November 2012

Template:Article summary start Template:Article summary text Template:Article summary heading Template:Article summary text Template:Article summary heading Template:Article summary wiki Template:Article summary wiki Template:Article summary wiki Template:Article summary end

Unified Extensible Firmware Interface (or UEFI for short) is a new type of firmware that was initially designed by Intel (known as EFI then) mainly for its Itanium based systems. It introduces new ways of booting an OS that is distinct from the commonly used "MBR boot code" method followed for BIOS systems. It started as Intel's EFI in versions 1.x and then a group of companies called the UEFI Forum took over its development from which it was called Unified EFI starting with version 2.0 . As of 23 May 2012, UEFI Specification 2.3.1 is the most recent version.

Note: Unless specified as EFI 1.x , EFI and UEFI terms are used interchangeably to denote UEFI 2.x firmware. Also unless stated explicitely, these instructions are general and not Mac specific. Some of them may not work or may be different in Macs. Apple's EFI implementation is neither a EFI 1.x version nor UEFI 2.x version but mixes up both. This kind of firmware does not fall under any one UEFI Specification version and therefore it is not a standard UEFI firmware.

Booting an OS using BIOS

A BIOS or Basic Input-Output System is the very first program that is executed once the system is switched on. After all the hardware has been initialized and the POST operation has completed, the BIOS executes the first boot code in the first device in the device booting list.

If the list starts with a CD/DVD drive, then the El-Torito entry in the CD/DVD is executed. This is how bootable CD/DVD works. If the list starts with a HDD, then BIOS executes the very first 440 bytes MBR boot code. The boot code then chainloads or bootstraps a much larger and complex bootloader which then loads the OS.

Basically, the BIOS does not know how to read a partition table or filesystem. All it does is initialize the hardware, then load and run the 440-byte boot code.

Multiboot on BIOS

Since very little can be achieved by a program that fits into the 440-byte boot code area, multi-booting using BIOS requires a multi-boot capable bootloader (multi-boot refers to booting multiple operating systems, not to booting a kernel in the Multiboot format specified by the GRUB developers). So usually a common bootloader like GRUB or Syslinux or LILO would be loaded by the BIOS, and it would load an operating system by either chain-loading or directly loading the kernel.

Booting an OS using UEFI

UEFI firmware does not support booting through the above mentioned method which is the only way supported by BIOS. UEFI has support for reading both the partition table as well as understanding filesystems.

The commonly used UEFI firmwares support both MBR and GPT partition table. EFI in Apple-Intel Macs are known to support Apple Partition Map also apart from MBR and GPT. Most of the UEFI firmwares have support for accessing FAT12 (floppy disks) , FAT16 and FAT32 filesystems in HDD and ISO9660 (and UDF) in CD/DVDs. EFI in Apple-Intel Macs can access HFS/HFS+ filesystems also apart from the mentioned ones.

UEFI does not launch any boot code in the MBR whether it exists or not. Instead it uses a special partition in the partition table called "EFI SYSTEM PARTITION" in which files required to be launched by the firmware are stored. Each vendor can store its files under <EFI SYSTEM PARTITION>/EFI/<VENDOR NAME>/ folder and can use the firmware or its shell (UEFI shell) to launch the boot program. An EFI System Partition is usually formatted as FAT32.

Under UEFI, every program whether they are OS loaders or some utilities (like memory testing apps) or recovery tools outside the OS, should be a UEFI Application corresponding to the EFI firmware architecture. Most of the UEFI firmware in the market, including recent Apple Macs use x86_64 EFI firmware. Only some older macs use i386 EFI firmware while no non-Apple UEFI system is known to use i386 EFI firmware.

A x86_64 EFI firmware does not include support for launching 32-bit EFI apps unlike the 64-bit Linux and Windows which include such support. Therefore the bootloader must be compiled for that architecture correctly.

Multibooting on UEFI

Since each OS or vendor can maintain its own files within the EFI SYSTEM PARTITION without affecting the other, multi-booting using UEFI is just a matter of launching a different UEFI application corresponding to the particular OS's bootloader. This removes the need for relying on chainloading mechanisms of one bootloader to load another to switch OSes.

Linux Windows x86_64 UEFI-GPT Multiboot

Windows Vista (SP1+) and 7 pr 8 x86_64 versions support booting natively using UEFI firmware. But for this they need GPT partitioning of the disk used for UEFI booting. Windows x86_64 versions support either UEFI-GPT booting or BIOS-MBR booting. Windows 32-bit versions support only BIOS-MBR booting. Follow the instructions provided in the forum link given in the references sections as to how to do this. See http://support.microsoft.com/default.aspx?scid=kb;EN-US;2581408 for more info.

This limitation does not exist in Linux Kernel but rather depends on the bootloader used. For the sake of Windows UEFI booting, the Linux bootloader used should also be installed in UEFI-GPT mode if booting from the same disk.

Boot Process under UEFI

  1. System switched on - Power On Self Test, or POST process.
  2. UEFI firmware is loaded.
  3. Firmware reads its Boot Manager to determine which UEFI application to be launched and from where (ie. from which disk and partition).
  4. Firmware launches the UEFI application from the FAT32 formatted UEFISYS partition as defined in the boot entry in the firmware's boot manager.
  5. UEFI application may launch another application (in case of UEFI Shell or a boot manager like rEFInd) or the kernel and initramfs (in case of a bootloader like GRUB) depending on how the UEFI application was configured.

Detecting UEFI Firmware Arch

If you have a non-mac UEFI system, then you have a x86_64 (aka 64-bit) UEFI 2.x firmware.

Some of the known x86_64 UEFI 2.x firmwares are Phoenix SecureCore Tiano, AMI Aptio, Insyde H2O.

Some of the known systems using these firmwares are Asus EZ Mode BIOS (in Sandy Bridge P67 and H67 motherboards), MSI ClickBIOS, HP EliteBooks, Sony Vaio Z series, many Intel Server and Desktop motherboards


Pre-2008 Macs mostly have i386-efi firmware while >=2008 Macs have mostly x86_64-efi. All macs capable of running Mac OS X Snow Leopard 64-bit Kernel have x86_64 EFI 1.x firmware.

To find out the arch of the efi firmware in a Mac, boot into Mac OS X and type the following command

ioreg -l -p IODeviceTree | grep firmware-abi

If the command returns EFI32 then it is i386 EFI 1.x firmware. If it returns EFI64 then it is x86_64 EFI 1.x firmware. Macs do not have UEFI 2.x firmware as Apple's EFI implementation is not fully compliant with UEFI Specification.

UEFI Support in Linux Kernel

Linux Kernel config options for UEFI

The required Linux Kernel configuration options for UEFI systems are :

CONFIG_EFI=y
CONFIG_EFI_STUB=y
CONFIG_RELOCATABLE=y
CONFIG_FB_EFI=y
CONFIG_FRAMEBUFFER_CONSOLE=y

UEFI Runtime Variables/Services Support - 'efivars' kernel module . This option is important as this is required to manipulate UEFI Runtime Variables using tools like efibootmgr.

CONFIG_EFI_VARS=m
Note: This option is compiled as module in Arch core/testing kernel.
Note: For Linux to access UEFI Runtime Services, the UEFI Firmware processor architecture and the Linux kernel processor architecture must match. This is independent of the bootloader used.
Note: If the UEFI Firmware arch and Linux Kernel arch are different, then the "noefi" kernel parameter must be used to avoid the kernel panic and boot successfully. The "noefi" option instructs the kernel not to access the UEFI Runtime Services.

GUID Partition Table GPT config option - mandatory for UEFI support

CONFIG_EFI_PARTITION=y
Note: All of the above options are required to boot Linux via UEFI, and are enabled in Archlinux kernels in official repos.

Retrieved from http://git.kernel.org/?p=linux/kernel/git/torvalds/linux.git;a=blob_plain;f=Documentation/x86/x86_64/uefi.txt;hb=HEAD .

UEFI Variables Support

UEFI defines variables through which an operating system can interact with the firmware. UEFI Boot Variables are used by the boot-loader and used by the OS only for early system start-up. UEFI Runtime Variables allow an OS to manage certain settings of the firmware like the UEFI Boot Manager or managing the keys for UEFI Secure Boot Protocol etc.

Note: The below steps will not work if the system has been booted in BIOS mode and will not work if the UEFI processor architecture does not match the kernel one, i.e. x86_64 UEFI + x86 32-bit Kernel and vice-versa config will not work. This is true only for efivars kernel module and efibootmgr step. The other steps (ie. upto setting up <UEFISYS>/EFI/arch/refind/{refindx64.efi,refind.conf} ) can be done even in BIOS/Legacy boot mode.

Access to UEFI Runtime services is provided by "efivars" kernel module which is enabled through the CONFIG_EFI_VAR=m kernel config option. This module once loaded exposes the variables under the directory /sys/firmware/efi/vars. One way to check whether the system has booted in UEFI boot mode is to load the "efivars" kernel module and check for the existence of /sys/firmware/efi/vars directory with contents similar to :

Sample output (x86_64-UEFI 2.3.1 in x86_64 Kernel):

# ls -1 /sys/firmware/efi/vars/
Boot0000-8be4df61-93ca-11d2-aa0d-00e098032b8c/
BootCurrent-8be4df61-93ca-11d2-aa0d-00e098032b8c/
BootOptionSupport-8be4df61-93ca-11d2-aa0d-00e098032b8c/
BootOrder-8be4df61-93ca-11d2-aa0d-00e098032b8c/
ConIn-8be4df61-93ca-11d2-aa0d-00e098032b8c/
ConInDev-8be4df61-93ca-11d2-aa0d-00e098032b8c/
ConOut-8be4df61-93ca-11d2-aa0d-00e098032b8c/
ConOutDev-8be4df61-93ca-11d2-aa0d-00e098032b8c/
ErrOutDev-8be4df61-93ca-11d2-aa0d-00e098032b8c/
Lang-8be4df61-93ca-11d2-aa0d-00e098032b8c/
LangCodes-8be4df61-93ca-11d2-aa0d-00e098032b8c/
MTC-eb704011-1402-11d3-8e77-00a0c969723b/
MemoryTypeInformation-4c19049f-4137-4dd3-9c10-8b97a83ffdfa/
PlatformLang-8be4df61-93ca-11d2-aa0d-00e098032b8c/
PlatformLangCodes-8be4df61-93ca-11d2-aa0d-00e098032b8c/
RTC-378d7b65-8da9-4773-b6e4-a47826a833e1/
del_var
new_var

The UEFI Runtime Variables will not be exposed to the OS if you have used "noefi" kernel parameter in the boot-loader menu. This parameter instructs the kernel to completely ignore UEFI Runtime Services.

Userspace Tools

There are few tools that can access/modify the UEFI variables, namely

  1. efibootmgr - Used to create/modify boot entries in the UEFI Boot Manager - efibootmgr or efibootmgr-gitAUR
  2. uefivars - simply dumps the variables - uefivars-gitAUR - uses efibootmgr library
  3. Ubuntu's Firmware Test Suite - fwts - fwts-gitAUR - uefidump command - fwts uefidump

Non-Mac UEFI systems

efibootmgr

Warning: Using efibootmgr in Apple Macs will brick the firmware and may need reflash of the motherboard ROM. There have been bug reports regarding this in Ubuntu/Launchpad bug tracker. Use bless command alone in case of Macs. Experimental "bless" utility for Linux by Fedora developers - mactel-bootAUR.
Note: efibootmgr command will work only if you have booted the system in UEFI mode itself, since it requires access to UEFI Runtime Variables which are available only in UEFI boot mode (with "noefi" kernel parameter NOT being used). Otherwise the message Fatal: Couldn't open either sysfs or procfs directories for accessing EFI variables is shown.

Initially the user may be required to manually launch the boot-loader from the firmware itself (using maybe the UEFI Shell) if the UEFI boot-loader was installed when the system is booted in BIOS mode. Then efibootmgr should be run to make the UEFI boot-loader entry as the default entry in the UEFI Boot Manager.

To use efibootmgr, first load the 'efivars' kernel module:

# modprobe efivars

If you get no such device found error for this command, that means you have not booted in UEFI mode or due to some reason the kernel is unable to access UEFI Runtime Variables (noefi?).

Verify whether there are files in /sys/firmware/efi/vars/ directory. This directory and its contents are created by "efivars" kernel module and it will exist only if you have booted in UEFI mode, without the "noefi" kernel parameter.

If /sys/firmware/efi/vars/ directory is empty or does not exist, then efibootmgr command will not work. If you are unable to make the ISO/CD/DVD/USB boot in UEFI mode try #Create_UEFI_bootable_USB_from_ISO.

Note: The below commands use gummiboot-efi boot-loader as example.

Assume the boot-loader file to be launched is /boot/efi/EFI/gummiboot/gummibootx64.efi. /boot/efi/EFI/gummiboot/gummibootx64.efi can be split up as /boot/efi and /EFI/gummiboot/gummibootx64.efi, wherein /boot/efi is the mountpoint of the UEFI System Partition, which is assumed to be /dev/sdXY (here X and Y are just placeholders for the actual values - eg:- in /dev/sda1 , X=a Y=1).

To determine the actual device path for the UEFI System Partition (should be in the form /dev/sdXY), try :

# findmnt /boot/efi
TARGET SOURCE  FSTYPE OPTIONS
/boot/efi  /dev/sdXY  vfat         rw,flush,tz=UTC

Then create the boot entry using efibootmgr as follows :

# efibootmgr -c -g -d /dev/sdX -p Y -w -L "Gummiboot" -l '\EFI\gummiboot\gummibootx64.efi'

In the above command /boot/efi/EFI/gummiboot/gummibootx64.efi translates to /boot/efi and /EFI/gummiboot/gummibootx64.efi which in turn translate to drive /dev/sdX -> partition Y -> file /EFI/gummiboot/gummibootx64.efi.

UEFI uses backward slash as path separator (similar to Windows paths).

The 'label' is the name of the menu entry shown in the UEFI boot menu. This name is user's choice and does not affect the booting of the system. More info can be obtained from efibootmgr GIT README .

FAT32 filesystem is case-insensitive since it does not use UTF-8 encoding by default. In that case the firmware uses capital 'EFI' instead of small 'efi', therefore using \EFI\gummiboot\gummibootx64.efi or \efi\gummiboot\gummibootx64.efi does not matter (this will change if the filesystem encoding is UTF-8).

Linux Bootloaders for UEFI

See UEFI Bootloaders.

Create an UEFI System Partition in Linux

Note: The UEFISYS partition can be of any size supported by FAT32 filesystem. According to Microsoft Documentation, the minimum partition/volume size for FAT32 is 512 MiB. Therefore it is recommended for UEFISYS partition to be at least 512 MiB. Higher partition sizes are fine, especially if you use multiple UEFI bootloaders, or multiple OSes booting via UEFI, so that there is enough space to hold all the related files. If you are using Linux EFISTUB booting, then you need to make sure there is adequate space available for keeping the Kernel and Initramfs files in the UEFISYS partition.

For GPT partitioned disks

Two choices:

  • Using GNU Parted/GParted: Create a FAT32 partition. Set "boot" flag on for that partition.
  • Using GPT fdisk (aka gdisk): Create a partition with gdisk type code "EF00". Then format that partition as FAT32 using mkfs.vfat -F32 /dev/<THAT_PARTITION>
Note: Setting "boot" flag in parted in a MBR partition marks that partition as active, while the same "boot" flag in a GPT partition marks that partition as "UEFI System Partition".
Warning: Do not use util-linux fdisk, cfdisk or sfdisk to change the type codes in a GPT disk. Similarly do not use gptfdisk gdisk, cgdisk or sgdisk on a MBR disk, it will be automatically converted to GPT (no data loss will occur, but the system will fail to boot).

For MBR partitioned disks

Two choices:

  • Using GNU Parted/GParted: Create FAT32 partition. Change the type code of that partition to 0xEF using fdisk, cfdisk or sfdisk.
  • Using fdisk: Create a partition with partition type 0xEF and format it as FAT32 using mkfs.vfat -F32 /dev/<THAT_PARTITION>
Note: It is recommended to use always GPT for UEFI boot as some UEFI firmwares do not allow UEFI-MBR boot.

UEFI Shell

The UEFI Shell is a shell/terminal for the firmware which allows launching uefi applications which include uefi bootloaders. Apart from that, the shell can also be used to obtain various other information about the system or the firmware like memory map (memmap), modifying boot manager variables (bcfg), running partitioning programs (diskpart), loading uefi drivers, editing text files (edit), hexedit etc.

UEFI Shell download links

You can download a BSD licensed UEFI Shell from Intel's Tianocore UDK/EDK2 Sourceforge.net project.

Shell 2.0 works only in UEFI 2.3+ systems and is recommended over Shell 1.0 in those systems. Shell 1.0 should work in all UEFI systems irrespective of the spec. version the firmware follows. More info at ShellPkg and this mail

Launching UEFI Shell

Few Asus and other AMI Aptio x86_64 UEFI firmware based motherboards (from Sandy Bridge onwards) provide an option called "Launch EFI Shell from filesystem device" . For those motherboards, download the x86_64 UEFI Shell and copy it to your UEFI SYSTEM PARTITION as <UEFI_SYSTEM_PARTITION>/shellx64.efi (mostly /boot/efi/shellx64.efi) .

Systems with Phoenix SecureCore Tiano UEFI firmware are known to have embedded UEFI Shell which can be launched using either F6, F11 or F12 key.

Note: If you are unable to launch UEFI Shell from the firmware directly using any of the above mentioned methods, create a FAT32 USB pen drive with Shell.efi copied as (USB)/efi/boot/bootx64.efi . This USB should come up in the firmware boot menu. Launching this option will launch the UEFI Shell for you.

Important UEFI Shell Commands

More info at http://software.intel.com/en-us/articles/efi-shells-and-scripting/

bcfg

BCFG command is used to modify the UEFI NVRAM entries, which allow the user to change the boot entries or driver options. This command is described in detail in page 83 (Section 5.3) of "UEFI Shell Specification 2.0" pdf document.

Note: Users are recommended to try bcfg only if efibootmgr fails to create working boot entries in their system.
Note: UEFI Shell 1.0 does not support bcfg command.

To dump a list of current boot entries -

Shell> bcfg boot dump -v

To add a boot menu entry for rEFInd (for example) as 4th (numbering starts from zero) option in the boot menu

Shell> bcfg boot add 3 fs0:\EFI\arch\refind\refindx64.efi "Arch Linux (rEFInd)"

where fs0: is the mapping corresponding to the UEFI System Partition and \EFI\arch\refind\refindx64.efi is the file to be launched.

To remove the 4th boot option

Shell> bcfg boot rm 3

To move the boot option #3 to #0 (i.e. 1st or the default entry in the UEFI Boot menu)

Shell> bcfg boot mv 3 0

For bcfg help text

Shell> help bcfg -v -b

or

Shell> bcfg -? -v -b

edit

EDIT command provides a basic text editor with an interface similar to nano text editor, but slightly less functional. It handles UTF-8 encoding and takes care or LF vs CRLF line endings.

To edit, for example rEFInd's refind.conf in the UEFI System Partition (fs0: in the firmware)

Shell> fs0:
FS0:\> cd \EFI\arch\refind
FS0:\EFI\arch\refind\> edit refind.conf

Hardware Compatibility

Main page HCL/Firmwares/UEFI


Create UEFI bootable USB from ISO

Note: dd'ing the ISO (isohybrid method) to the USB drive will not work for UEFI boot.
Note: It does not matter whether the USB is partitioned as MBR or GPT, as long as the filesystem is FAT32 or FAT16.
Note: UEFI bootable USB can be created on Windows as well. However bsdtar running in Cygwin has to be used for extracting files as most Windows applications ignore the case sensitivity.

Archiso

1. Mount FAT32 (or FAT16) (fdisk type code "0x0c" for FAT32) USB Partition to /tmp/archusb:

$ mkdir -p /tmp/archusb/
# mount -o rw,users -t vfat <USB_Device_Partition> /tmp/archusb

2. Extract archiso image contents to USB:

$ cd /tmp/archusb/
$ bsdtar xf <Full path to Archiso image>
$ rm -f /tmp/archusb/[BOOT]        # If the directory or file exist
$ sync

3. Find out the filesystem label to be used for the USB by reading "archisolabel=" part in /tmp/archusb/loader/entries/archiso-x86_64.conf. For example if /tmp/archusb/loader/entries/archiso-x86_64.conf has archisolabel=ARCH_201210 then the filesystem label to be used is ARCH_201210 .

4. Unmount USB device and change its FS Label:

# umount <USB_Device_Partition>
# dosfslabel <USB_Device_Partition> <archisolabel>
$ sync

Example for step 4.

# umount /dev/sdc1
# dosfslabel /dev/sdc1 ARCH_201210
$ sync

Archboot

1. Mount FAT32 (or FAT16) (fdisk type code "0x0c" for FAT32) USB Partition to /tmp/archusb:

$ mkdir -p /tmp/archusb/
# mount -o rw,users -t vfat <USB_Device_Partition> /tmp/archusb

2. Extract archboot iso image contents to USB:

$ cd /tmp/archusb/
$ bsdtar xf <Full path to Archboot ISO>
$ rm -f /tmp/archusb/[BOOT]        # If the directory or file exist
$ sync

3. Unmount the USB device:

# umount <USB_Device_Partition>

Remove UEFI boot support from ISO

Most of the 32-bit EFI Macs and some 64-bit EFI Macs refuse to boot from a UEFI(X64)+BIOS bootable CD/DVD. In these cases the iso should be rebuilt without UEFI boot support, retaining only BIOS boot.

Archiso

1. Obtain the ISO label from the output of file <path_to_iso>. Let it be ARCH_201210 for example.

2. Create a directory /tmp/archiso and extract the archiso file contents to it.

3. Run xorriso (part of libisoburn package) as shown below:

$ xorriso -as mkisofs -iso-level 3 \
          -full-iso9660-filenames \
          -volid "ARCH_201210" \
          -appid "Arch Linux CD" \
          -publisher "Arch Linux <https://www.archlinux.org>" \
          -preparer "prepared by user" \
          -eltorito-boot isolinux/isolinux.bin \
          -eltorito-catalog isolinux/boot.cat \
          -no-emul-boot -boot-load-size 4 -boot-info-table \
          -isohybrid-mbr "/tmp/archiso/isolinux/isohdpfx.bin" \
          -output "/tmp/archiso.iso" "/tmp/archiso/"

4. Burn /tmp/archiso.iso to a CD and boot into your Mac using that CD.

Archboot

Note: Archboot 2012.10 and above isos do not support UEFI-CD booting (only UEFI-USB booting is supported) so the below steps are not required for those isos.

1. Create a directory /tmp/archboot and extract the archboot iso file contents to it.

2. Run xorriso (part of libisoburn package) as shown below:

$ xorriso -as mkisofs -iso-level 3 -rock -joliet \
          -max-iso9660-filenames -omit-period \
          -omit-version-number -allow-leading-dots \
          -relaxed-filenames -allow-lowercase -allow-multidot \
          -volid "ARCHBOOT" -preparer "prepared by user" \
          -eltorito-boot boot/syslinux/isolinux.bin \
          -eltorito-catalog boot/syslinux/boot.cat \
          -no-emul-boot -boot-load-size 4 -boot-info-table \
          -isohybrid-mbr /tmp/archboot/boot/syslinux/isohdpfx.bin \
          -output "/tmp/archboot.iso" "/tmp/archboot/"

3. Burn /tmp/archboot.iso to a CD and boot into your Mac using that CD.

See also