2 # Copyright (C) 2014, Simon Glass <sjg@chromium.org>
3 # Copyright (C) 2014, Bin Meng <bmeng.cn@gmail.com>
5 # SPDX-License-Identifier: GPL-2.0+
11 This document describes the information about U-Boot running on x86 targets,
12 including supported boards, build instructions, todo list, etc.
16 U-Boot supports running as a coreboot [1] payload on x86. So far only Link
17 (Chromebook Pixel) and QEMU [2] x86 targets have been tested, but it should
18 work with minimal adjustments on other x86 boards since coreboot deals with
19 most of the low-level details.
21 U-Boot also supports booting directly from x86 reset vector without coreboot,
22 aka raw support or bare support. Currently Link, QEMU x86 targets and all
23 Intel boards support running U-Boot 'bare metal'.
25 As for loading an OS, U-Boot supports directly booting a 32-bit or 64-bit
26 Linux kernel as part of a FIT image. It also supports a compressed zImage.
30 Building U-Boot as a coreboot payload is just like building U-Boot for targets
31 on other architectures, like below:
33 $ make coreboot-x86_defconfig
36 Note this default configuration will build a U-Boot payload for the QEMU board.
37 To build a coreboot payload against another board, you can change the build
38 configuration during the 'make menuconfig' process.
42 (qemu-x86) Board configuration file
43 (qemu-x86_i440fx) Board Device Tree Source (dts) file
44 (0x01920000) Board specific Cache-As-RAM (CAR) address
45 (0x4000) Board specific Cache-As-RAM (CAR) size
47 Change the 'Board configuration file' and 'Board Device Tree Source (dts) file'
48 to point to a new board. You can also change the Cache-As-RAM (CAR) related
49 settings here if the default values do not fit your new board.
51 Building a ROM version of U-Boot (hereafter referred to as u-boot.rom) is a
52 little bit tricky, as generally it requires several binary blobs which are not
53 shipped in the U-Boot source tree. Due to this reason, the u-boot.rom build is
54 not turned on by default in the U-Boot source tree. Firstly, you need turn it
55 on by enabling the ROM build:
59 This tells the Makefile to build u-boot.rom as a target.
61 Link-specific instructions:
63 First, you need the following binary blobs:
65 * descriptor.bin - Intel flash descriptor
66 * me.bin - Intel Management Engine
67 * mrc.bin - Memory Reference Code, which sets up SDRAM
68 * video ROM - sets up the display
70 You can get these binary blobs by:
72 $ git clone http://review.coreboot.org/p/blobs.git
75 Find the following files:
77 * ./mainboard/google/link/descriptor.bin
78 * ./mainboard/google/link/me.bin
79 * ./northbridge/intel/sandybridge/systemagent-r6.bin
81 The 3rd one should be renamed to mrc.bin.
82 As for the video ROM, you can get it here [3] and rename it to vga.bin.
83 Make sure all these binary blobs are put in the board directory.
85 Now you can build U-Boot and obtain u-boot.rom:
87 $ make chromebook_link_defconfig
90 Intel Crown Bay specific instructions:
92 U-Boot support of Intel Crown Bay board [4] relies on a binary blob called
93 Firmware Support Package [5] to perform all the necessary initialization steps
94 as documented in the BIOS Writer Guide, including initialization of the CPU,
95 memory controller, chipset and certain bus interfaces.
97 Download the Intel FSP for Atom E6xx series and Platform Controller Hub EG20T,
98 install it on your host and locate the FSP binary blob. Note this platform
99 also requires a Chipset Micro Code (CMC) state machine binary to be present in
100 the SPI flash where u-boot.rom resides, and this CMC binary blob can be found
101 in this FSP package too.
103 * ./FSP/QUEENSBAY_FSP_GOLD_001_20-DECEMBER-2013.fd
104 * ./Microcode/C0_22211.BIN
106 Rename the first one to fsp.bin and second one to cmc.bin and put them in the
109 Note the FSP release version 001 has a bug which could cause random endless
110 loop during the FspInit call. This bug was published by Intel although Intel
111 did not describe any details. We need manually apply the patch to the FSP
112 binary using any hex editor (eg: bvi). Go to the offset 0x1fcd8 of the FSP
113 binary, change the following five bytes values from orginally E8 42 FF FF FF
116 As for the video ROM, you need manually extract it from the Intel provided
117 BIOS for Crown Bay here [6], using the AMI MMTool [7]. Check PCI option ROM
118 ID 8086:4108, extract and save it as vga.bin in the board directory.
120 Now you can build U-Boot and obtain u-boot.rom
122 $ make crownbay_defconfig
125 Intel Minnowboard Max instructions:
127 This uses as FSP as with Crown Bay, except it is for the Atom E3800 series.
128 Download this and get the .fd file (BAYTRAIL_FSP_GOLD_003_16-SEP-2014.fd at
129 the time of writing). Put it in the board directory:
130 board/intel/minnowmax/fsp.bin
132 Obtain the VGA RAM (Vga.dat at the time of writing) and put it into the same
133 directory: board/intel/minnowmax/vga.bin
135 You still need two more binary blobs. The first comes from the original
136 firmware image available from:
138 http://firmware.intel.com/sites/default/files/2014-WW42.4-MinnowBoardMax.73-64-bit.bin_Release.zip
142 $ unzip 2014-WW42.4-MinnowBoardMax.73-64-bit.bin_Release.zip
144 Use ifdtool in the U-Boot tools directory to extract the images from that
147 $ ./tools/ifdtool -x MNW2MAX1.X64.0073.R02.1409160934.bin
149 This will provide the descriptor file - copy this into the correct place:
151 $ cp flashregion_0_flashdescriptor.bin board/intel/minnowmax/descriptor.bin
153 Then do the same with the sample SPI image provided in the FSP (SPI.bin at
154 the time of writing) to obtain the last image. Note that this will also
155 produce a flash descriptor file, but it does not seem to work, probably
156 because it is not designed for the Minnowmax. That is why you need to get
157 the flash descriptor from the original firmware as above.
159 $ ./tools/ifdtool -x BayleyBay/SPI.bin
160 $ cp flashregion_2_intel_me.bin board/intel/minnowmax/me.bin
162 Now you can build U-Boot and obtain u-boot.rom
164 $ make minnowmax_defconfig
167 Checksums are as follows (but note that newer versions will invalidate this):
169 $ md5sum -b board/intel/minnowmax/*.bin
170 ffda9a3b94df5b74323afb328d51e6b4 board/intel/minnowmax/descriptor.bin
171 69f65b9a580246291d20d08cbef9d7c5 board/intel/minnowmax/fsp.bin
172 894a97d371544ec21de9c3e8e1716c4b board/intel/minnowmax/me.bin
173 a2588537da387da592a27219d56e9962 board/intel/minnowmax/vga.bin
175 The ROM image is broken up into these parts:
177 Offset Description Controlling config
178 ------------------------------------------------------------
179 000000 descriptor.bin Hard-coded to 0 in ifdtool
180 001000 me.bin Set by the descriptor
182 700000 u-boot-dtb.bin CONFIG_SYS_TEXT_BASE
183 790000 vga.bin CONFIG_X86_OPTION_ROM_ADDR
184 7c0000 fsp.bin CONFIG_FSP_ADDR
185 7f8000 <spare> (depends on size of fsp.bin)
186 7fe000 Environment CONFIG_ENV_OFFSET
187 7ff800 U-Boot 16-bit boot CONFIG_SYS_X86_START16
189 Overall ROM image size is controlled by CONFIG_ROM_SIZE.
192 Intel Galileo instructions:
194 Only one binary blob is needed for Remote Management Unit (RMU) within Intel
195 Quark SoC. Not like FSP, U-Boot does not call into the binary. The binary is
196 needed by the Quark SoC itself.
198 You can get the binary blob from Quark Board Support Package from Intel website:
200 * ./QuarkSocPkg/QuarkNorthCluster/Binary/QuarkMicrocode/RMU.bin
202 Rename the file and put it to the board directory by:
204 $ cp RMU.bin board/intel/galileo/rmu.bin
206 Now you can build U-Boot and obtain u-boot.rom
208 $ make galileo_defconfig
211 QEMU x86 target instructions:
213 To build u-boot.rom for QEMU x86 targets, just simply run
215 $ make qemu-x86_defconfig
218 Note this default configuration will build a U-Boot for the QEMU x86 i440FX
219 board. To build a U-Boot against QEMU x86 Q35 board, you can change the build
220 configuration during the 'make menuconfig' process like below:
222 Device Tree Control --->
224 (qemu-x86_q35) Default Device Tree for DT control
228 For testing U-Boot as the coreboot payload, there are things that need be paid
229 attention to. coreboot supports loading an ELF executable and a 32-bit plain
230 binary, as well as other supported payloads. With the default configuration,
231 U-Boot is set up to use a separate Device Tree Blob (dtb). As of today, the
232 generated u-boot-dtb.bin needs to be packaged by the cbfstool utility (a tool
233 provided by coreboot) manually as coreboot's 'make menuconfig' does not provide
234 this capability yet. The command is as follows:
236 # in the coreboot root directory
237 $ ./build/util/cbfstool/cbfstool build/coreboot.rom add-flat-binary \
238 -f u-boot-dtb.bin -n fallback/payload -c lzma -l 0x1110000 -e 0x1110015
240 Make sure 0x1110000 matches CONFIG_SYS_TEXT_BASE and 0x1110015 matches the
241 symbol address of _start (in arch/x86/cpu/start.S).
243 If you want to use ELF as the coreboot payload, change U-Boot configuration to
244 use CONFIG_OF_EMBED instead of CONFIG_OF_SEPARATE.
246 To enable video you must enable these options in coreboot:
248 - Set framebuffer graphics resolution (1280x1024 32k-color (1:5:5))
249 - Keep VESA framebuffer
251 At present it seems that for Minnowboard Max, coreboot does not pass through
252 the video information correctly (it always says the resolution is 0x0). This
253 works correctly for link though.
257 QEMU is a fancy emulator that can enable us to test U-Boot without access to
258 a real x86 board. Please make sure your QEMU version is 2.3.0 or above test
259 U-Boot. To launch QEMU with u-boot.rom, call QEMU as follows:
261 $ qemu-system-i386 -nographic -bios path/to/u-boot.rom
263 This will instantiate an emulated x86 board with i440FX and PIIX chipset. QEMU
264 also supports emulating an x86 board with Q35 and ICH9 based chipset, which is
265 also supported by U-Boot. To instantiate such a machine, call QEMU with:
267 $ qemu-system-i386 -nographic -bios path/to/u-boot.rom -M q35
269 Note by default QEMU instantiated boards only have 128 MiB system memory. But
270 it is enough to have U-Boot boot and function correctly. You can increase the
271 system memory by pass '-m' parameter to QEMU if you want more memory:
273 $ qemu-system-i386 -nographic -bios path/to/u-boot.rom -m 1024
275 This creates a board with 1 GiB system memory. Currently U-Boot for QEMU only
276 supports 3 GiB maximum system memory and reserves the last 1 GiB address space
277 for PCI device memory-mapped I/O and other stuff, so the maximum value of '-m'
280 QEMU emulates a graphic card which U-Boot supports. Removing '-nographic' will
281 show QEMU's VGA console window. Note this will disable QEMU's serial output.
282 If you want to check both consoles, use '-serial stdio'.
286 Modern CPUs usually require a special bit stream called microcode [8] to be
287 loaded on the processor after power up in order to function properly. U-Boot
288 has already integrated these as hex dumps in the source tree.
292 On a multicore system, U-Boot is executed on the bootstrap processor (BSP).
293 Additional application processors (AP) can be brought up by U-Boot. In order to
294 have an SMP kernel to discover all of the available processors, U-Boot needs to
295 prepare configuration tables which contain the multi-CPUs information before
296 loading the OS kernel. Currently U-Boot supports generating two types of tables
297 for SMP, called Simple Firmware Interface (SFI) [9] and Multi-Processor (MP)
298 [10] tables. The writing of these two tables are controlled by two Kconfig
299 options GENERATE_SFI_TABLE and GENERATE_MP_TABLE.
303 x86 has been converted to use driver model for serial and GPIO.
307 x86 uses device tree to configure the board thus requires CONFIG_OF_CONTROL to
308 be turned on. Not every device on the board is configured via device tree, but
309 more and more devices will be added as time goes by. Check out the directory
310 arch/x86/dts/ for these device tree source files.
314 In keeping with the U-Boot philosophy of providing functions to check and
315 adjust internal settings, there are several x86-specific commands that may be
318 hob - Display information about Firmware Support Package (FSP) Hand-off
319 Block. This is only available on platforms which use FSP, mostly
321 iod - Display I/O memory
322 iow - Write I/O memory
323 mtrr - List and set the Memory Type Range Registers (MTRR). These are used to
324 tell the CPU whether memory is cacheable and if so the cache write
325 mode to use. U-Boot sets up some reasonable values but you can
326 adjust then with this command.
330 These notes are for those who want to port U-Boot to a new x86 platform.
332 Since x86 CPUs boot from SPI flash, a SPI flash emulator is a good investment.
333 The Dediprog em100 can be used on Linux. The em100 tool is available here:
335 http://review.coreboot.org/p/em100.git
337 On Minnowboard Max the following command line can be used:
339 sudo em100 -s -p LOW -d u-boot.rom -c W25Q64DW -r
341 A suitable clip for connecting over the SPI flash chip is here:
343 http://www.dediprog.com/pd/programmer-accessories/EM-TC-8
345 This allows you to override the SPI flash contents for development purposes.
346 Typically you can write to the em100 in around 1200ms, considerably faster
347 than programming the real flash device each time. The only important
348 limitation of the em100 is that it only supports SPI bus speeds up to 20MHz.
349 This means that images must be set to boot with that speed. This is an
350 Intel-specific feature - e.g. tools/ifttool has an option to set the SPI
351 speed in the SPI descriptor region.
353 If your chip/board uses an Intel Firmware Support Package (FSP) it is fairly
354 easy to fit it in. You can follow the Minnowboard Max implementation, for
355 example. Hopefully you will just need to create new files similar to those
356 in arch/x86/cpu/baytrail which provide Bay Trail support.
358 If you are not using an FSP you have more freedom and more responsibility.
359 The ivybridge support works this way, although it still uses a ROM for
360 graphics and still has binary blobs containing Intel code. You should aim to
361 support all important peripherals on your platform including video and storage.
362 Use the device tree for configuration where possible.
364 For the microcode you can create a suitable device tree file using the
367 ./tools/microcode-tool -d microcode.dat create <model>
369 or if you only have header files and not the full Intel microcode.dat database:
371 ./tools/microcode-tool -H BAY_TRAIL_FSP_KIT/Microcode/M0130673322.h \
372 -H BAY_TRAIL_FSP_KIT/Microcode/M0130679901.h \
375 These are written to arch/x86/dts/microcode/ by default.
377 Note that it is possible to just add the micrcode for your CPU if you know its
378 model. U-Boot prints this information when it starts
380 CPU: x86_64, vendor Intel, device 30673h
382 so here we can use the M0130673322 file.
384 If you platform can display POST codes on two little 7-segment displays on
385 the board, then you can use post_code() calls from C or assembler to monitor
386 boot progress. This can be good for debugging.
388 If not, you can try to get serial working as early as possible. The early
389 debug serial port may be useful here. See setup_early_uart() for an example.
394 - Chrome OS verified boot
395 - SMI and ACPI support, to provide platform info and facilities to Linux
399 [1] http://www.coreboot.org
400 [2] http://www.qemu.org
401 [3] http://www.coreboot.org/~stepan/pci8086,0166.rom
402 [4] http://www.intel.com/content/www/us/en/embedded/design-tools/evaluation-platforms/atom-e660-eg20t-development-kit.html
403 [5] http://www.intel.com/fsp
404 [6] http://www.intel.com/content/www/us/en/secure/intelligent-systems/privileged/e6xx-35-b1-cmc22211.html
405 [7] http://www.ami.com/products/bios-uefi-tools-and-utilities/bios-uefi-utilities/
406 [8] http://en.wikipedia.org/wiki/Microcode
407 [9] http://simplefirmware.org
408 [10] http://www.intel.com/design/archives/processors/pro/docs/242016.htm