doc/README.efi

   1 #
   2 # Copyright (C) 2015 Google, Inc
   3 #
   4 # SPDX-License-Identifier:      GPL-2.0+
   5 #
   6
   7 U-Boot on EFI
   8 =============
   9 This document provides information about U-Boot running on top of EFI, either
  10 as an application or just as a means of getting U-Boot onto a new platform.
  11
  12
  13 In God's Name, Why?
  14 -------------------
  15 This is useful in several situations:
  16
  17 - You have EFI running on a board but U-Boot does not natively support it
  18 fully yet. You can boot into U-Boot from EFI and use that until U-Boot is
  19 fully ported
  20
  21 - You need to use an EFI implementation (e.g. UEFI) because your vendor
  22 requires it in order to provide support
  23
  24 - You plan to use coreboot to boot into U-Boot but coreboot support does
  25 not currently exist for your platform. In the meantime you can use U-Boot
  26 on EFI and then move to U-Boot on coreboot when ready
  27
  28 - You use EFI but want to experiment with a simpler alternative like U-Boot
  29
  30
  31 Status
  32 ------
  33 Only x86 is supported at present. If you are using EFI on another architecture
  34 you may want to reconsider. However, much of the code is generic so could be
  35 ported.
  36
  37 U-Boot supports running as an EFI application for 32-bit EFI only. This is
  38 not very useful since only a serial port is provided. You can look around at
  39 memory and type 'help' but that is about it.
  40
  41 More usefully, U-Boot supports building itself as a payload for either 32-bit
  42 or 64-bit EFI. U-Boot is packaged up and loaded in its entirety by EFI. Once
  43 started, U-Boot changes to 32-bit mode (currently) and takes over the
  44 machine. You can use devices, boot a kernel, etc.
  45
  46
  47 Build Instructions
  48 ------------------
  49 First choose a board that has EFI support and obtain an EFI implementation
  50 for that board. It will be either 32-bit or 64-bit. Alternatively, you can
  51 opt for using QEMU [1] and the OVMF [2], as detailed below.
  52
  53 To build U-Boot as an EFI application (32-bit EFI required), enable CONFIG_EFI
  54 and CONFIG_EFI_APP. The efi-x86 config (efi-x86_defconfig) is set up for this.
  55 Just build U-Boot as normal, e.g.
  56
  57    make efi-x86_defconfig
  58    make
  59
  60 To build U-Boot as an EFI payload (32-bit or 64-bit EFI can be used), adjust an
  61 existing config (like qemu-x86_defconfig) to enable CONFIG_EFI, CONFIG_EFI_STUB
  62 and either CONFIG_EFI_STUB_32BIT or CONFIG_EFI_STUB_64BIT. All of these are
  63 boolean Kconfig options. Then build U-Boot as normal, e.g.
  64
  65    make qemu-x86_defconfig
  66    make
  67
  68 You will end up with one of these files depending on what you build for:
  69
  70    u-boot-app.efi      - U-Boot EFI application
  71    u-boot-payload.efi  - U-Boot EFI payload application
  72
  73
  74 Trying it out
  75 -------------
  76 QEMU is an emulator and it can emulate an x86 machine. Please make sure your
  77 QEMU version is 2.3.0 or above to test this. You can run the payload with
  78 something like this:
  79
  80    mkdir /tmp/efi
  81    cp /path/to/u-boot*.efi /tmp/efi
  82    qemu-system-x86_64 -bios bios.bin -hda fat:/tmp/efi/
  83
  84 Add -nographic if you want to use the terminal for output. Once it starts
  85 type 'fs0:u-boot-payload.efi' to run the payload or 'fs0:u-boot-app.efi' to
  86 run the application. 'bios.bin' is the EFI 'BIOS'. Check [2] to obtain a
  87 prebuilt EFI BIOS for QEMU or you can build one from source as well.
  88
  89 To try it on real hardware, put u-boot-app.efi on a suitable boot medium,
  90 such as a USB stick. Then you can type something like this to start it:
  91
  92    fs0:u-boot-payload.efi
  93
  94 (or fs0:u-boot-app.efi for the application)
  95
  96 This will start the payload, copy U-Boot into RAM and start U-Boot. Note
  97 that EFI does not support booting a 64-bit application from a 32-bit
  98 EFI (or vice versa). Also it will often fail to print an error message if
  99 you get this wrong.
 100
 101
 102 Inner workings
 103 ==============
 104 Here follow a few implementation notes for those who want to fiddle with
 105 this and perhaps contribute patches.
 106
 107 The application and payload approaches sound similar but are in fact
 108 implemented completely differently.
 109
 110 EFI Application
 111 ---------------
 112 For the application the whole of U-Boot is built as a shared library. The
 113 efi_main() function is in lib/efi/efi_app.c. It sets up some basic EFI
 114 functions with efi_init(), sets up U-Boot global_data, allocates memory for
 115 U-Boot's malloc(), etc. and enters the normal init sequence (board_init_f()
 116 and board_init_r()).
 117
 118 Since U-Boot limits its memory access to the allocated regions very little
 119 special code is needed. The CONFIG_EFI_APP option controls a few things
 120 that need to change so 'git grep CONFIG_EFI_APP' may be instructive.
 121 The CONFIG_EFI option controls more general EFI adjustments.
 122
 123 The only available driver is the serial driver. This calls back into EFI
 124 'boot services' to send and receive characters. Although it is implemented
 125 as a serial driver the console device is not necessarilly serial. If you
 126 boot EFI with video output then the 'serial' device will operate on your
 127 target devices's display instead and the device's USB keyboard will also
 128 work if connected. If you have both serial and video output, then both
 129 consoles will be active. Even though U-Boot does the same thing normally,
 130 These are features of EFI, not U-Boot.
 131
 132 Very little code is involved in implementing the EFI application feature.
 133 U-Boot is highly portable. Most of the difficulty is in modifying the
 134 Makefile settings to pass the right build flags. In particular there is very
 135 little x86-specific code involved - you can find most of it in
 136 arch/x86/cpu. Porting to ARM (which can also use EFI if you are brave
 137 enough) should be straightforward.
 138
 139 Use the 'reset' command to get back to EFI.
 140
 141 EFI Payload
 142 -----------
 143 The payload approach is a different kettle of fish. It works by building
 144 U-Boot exactly as normal for your target board, then adding the entire
 145 image (including device tree) into a small EFI stub application responsible
 146 for booting it. The stub application is built as a normal EFI application
 147 except that it has a lot of data attached to it.
 148
 149 The stub application is implemented in lib/efi/efi_stub.c. The efi_main()
 150 function is called by EFI. It is responsible for copying U-Boot from its
 151 original location into memory, disabling EFI boot services and starting
 152 U-Boot. U-Boot then starts as normal, relocates, starts all drivers, etc.
 153
 154 The stub application is architecture-dependent. At present it has some
 155 x86-specific code and a comment at the top of efi_stub.c describes this.
 156
 157 While the stub application does allocate some memory from EFI this is not
 158 used by U-Boot (the payload). In fact when U-Boot starts it has all of the
 159 memory available to it and can operate as it pleases (but see the next
 160 section).
 161
 162 Tables
 163 ------
 164 The payload can pass information to U-Boot in the form of EFI tables. At
 165 present this feature is used to pass the EFI memory map, an inordinately
 166 large list of memory regions. You can use the 'efi mem all' command to
 167 display this list. U-Boot uses the list to work out where to relocate
 168 itself.
 169
 170 Although U-Boot can use any memory it likes, EFI marks some memory as used
 171 by 'run-time services', code that hangs around while U-Boot is running and
 172 is even present when Linux is running. This is common on x86 and provides
 173 a way for Linux to call back into the firmware to control things like CPU
 174 fan speed. U-Boot uses only 'conventional' memory, in EFI terminology. It
 175 will relocate itself to the top of the largest block of memory it can find
 176 below 4GB.
 177
 178 Interrupts
 179 ----------
 180 U-Boot drivers typically don't use interrupts. Since EFI enables interrupts
 181 it is possible that an interrupt will fire that U-Boot cannot handle. This
 182 seems to cause problems. For this reason the U-Boot payload runs with
 183 interrupts disabled at present.
 184
 185 32/64-bit
 186 ---------
 187 While the EFI application can in principle be built as either 32- or 64-bit,
 188 only 32-bit is currently supported. This means that the application can only
 189 be used with 32-bit EFI.
 190
 191 The payload stub can be build as either 32- or 64-bits. Only a small amount
 192 of code is built this way (see the extra- line in lib/efi/Makefile).
 193 Everything else is built as a normal U-Boot, so is always 32-bit on x86 at
 194 present.
 195
 196 Future work
 197 -----------
 198 This work could be extended in a number of ways:
 199
 200 - Add a generic x86 EFI payload configuration. At present you need to modify
 201 an existing one, but mostly the low-level x86 code is disabled when booting
 202 on EFI anyway, so a generic 'EFI' board could be created with a suitable set
 203 of drivers enabled.
 204
 205 - Add ARM support
 206
 207 - Add 64-bit application support
 208
 209 - Figure out how to solve the interrupt problem
 210
 211 - Add more drivers to the application side (e.g. video, block devices, USB,
 212 environment access). This would mostly be an academic exercise as a strong
 213 use case is not readily apparent, but it might be fun.
 214
 215 - Avoid turning off boot services in the stub. Instead allow U-Boot to make
 216 use of boot services in case it wants to. It is unclear what it might want
 217 though.
 218
 219 Where is the code?
 220 ------------------
 221 lib/efi
 222         payload stub, application, support code. Mostly arch-neutral
 223
 224 arch/x86/lib/efi
 225         helper functions for the fake DRAM init, etc. These can be used by
 226         any board that runs as a payload.
 227
 228 arch/x86/cpu/efi
 229         x86 support code for running as an EFI application
 230
 231 board/efi/efi-x86/efi.c
 232         x86 board code for running as an EFI application
 233
 234 common/cmd_efi.c
 235         the 'efi' command
 236
 237
 238 --
 239 Ben Stoltz, Simon Glass
 240 Google, Inc
 241 July 2015
 242
 243 [1] http://www.qemu.org
 244 [2] http://www.tianocore.org/ovmf/