x86: Add a 64-bit 'coreboot64' build
[oweals/u-boot.git] / doc / board / coreboot / coreboot.rst
1 .. SPDX-License-Identifier: GPL-2.0+
2 .. sectionauthor:: Bin Meng <bmeng.cn@gmail.com>
3
4 Coreboot
5 ========
6
7 Build Instructions for U-Boot as coreboot payload
8 -------------------------------------------------
9 Building U-Boot as a coreboot payload is just like building U-Boot for targets
10 on other architectures, like below::
11
12    $ make coreboot_defconfig
13    $ make all
14
15 Test with coreboot
16 ------------------
17 For testing U-Boot as the coreboot payload, there are things that need be paid
18 attention to. coreboot supports loading an ELF executable and a 32-bit plain
19 binary, as well as other supported payloads. With the default configuration,
20 U-Boot is set up to use a separate Device Tree Blob (dtb). As of today, the
21 generated u-boot-dtb.bin needs to be packaged by the cbfstool utility (a tool
22 provided by coreboot) manually as coreboot's 'make menuconfig' does not provide
23 this capability yet. The command is as follows::
24
25    # in the coreboot root directory
26    $ ./build/util/cbfstool/cbfstool build/coreboot.rom add-flat-binary \
27      -f u-boot-dtb.bin -n fallback/payload -c lzma -l 0x1110000 -e 0x1110000
28
29 Make sure 0x1110000 matches CONFIG_SYS_TEXT_BASE, which is the symbol address
30 of _x86boot_start (in arch/x86/cpu/start.S).
31
32 If you want to use ELF as the coreboot payload, change U-Boot configuration to
33 use CONFIG_OF_EMBED instead of CONFIG_OF_SEPARATE.
34
35 To enable video you must enable these options in coreboot:
36
37    - Set framebuffer graphics resolution (1280x1024 32k-color (1:5:5))
38    - Keep VESA framebuffer
39
40 At present it seems that for Minnowboard Max, coreboot does not pass through
41 the video information correctly (it always says the resolution is 0x0). This
42 works correctly for link though.
43
44 64-bit U-Boot
45 -------------
46
47 In addition to the 32-bit 'coreboot' build there is a 'coreboot64' build. This
48 produces an image which can be booted from coreboot (32-bit). Internally it
49 works by using a 32-bit SPL binary to switch to 64-bit for running U-Boot. It
50 can be useful for running UEFI applications, for example.
51
52 This has only been lightly tested.