git.sur5r.net Git - u-boot/blob - doc/README.u-boot_on_efi

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