doc/README.chromium

   1 Chromium OS Support in U-Boot
   2 =============================
   3
   4 Introduction
   5 ------------
   6
   7 This describes how to use U-Boot with Chromium OS. Several options are
   8 available:
   9
  10    - Running U-Boot from the 'altfw' feature, which is available on selected
  11         Chromebooks from 2019 onwards (initially Grunt). Press '1' from the
  12         developer-mode screen to get into U-Boot. See here for details:
  13         https://sites.google.com/a/chromium.org/dev/chromium-os/poking-around-your-chrome-os-device?pli=1
  14
  15    - Running U-Boot from the disk partition. This involves signing U-Boot and
  16         placing it on the disk, for booting as a 'kernel'. See
  17         README.chromium-chainload for information on this. This is the only
  18         option on non-U-Boot Chromebooks from 2013 to 2018 and is somewhat
  19         more involved.
  20
  21    - Running U-Boot with Chromium OS verified boot. This allows U-Boot to be
  22         used instead of either or both of depthcharge (a bootloader which forked
  23         from U-Boot in 2013) and coreboot. See below for more information on
  24         this.
  25
  26
  27 U-Boot with Chromium OS verified boot
  28 -------------------------------------
  29
  30 To obtain:
  31
  32    git clone https://github.com/sglass68/u-boot.git
  33    cd u-boot
  34    git checkout cros-master
  35
  36 To build for sandbox:
  37
  38    UB=/tmp/b/chromeos_sandbox    # U-Boot build directory
  39    CROS=/home/sglass/cosarm      # Chromium OS directory
  40    make O=$UB/chromeos_sandbox_defconfig
  41    make O=$UB -j20 -s VBOOT_SOURCE=$CROS/src/platform/vboot_reference \
  42         MAKEFLAGS_VBOOT=DEBUG=1 QUIET=1
  43
  44 Replace sandbox with another supported target.
  45
  46 This produces $UB/image.bin which contains the firmware binaries in a SPI
  47 flash image.
  48
  49 To run on sandbox:
  50
  51    $UB/tpl/u-boot-tpl -d $UB/u-boot.dtb.out \
  52         -L6 -c "host bind 0 $CROS/src/build/images/cheza/latest/chromiumos_image.bin; vboot go auto" \
  53         -l -w -s state.dtb -r
  54
  55 To run on other boards:
  56    Install image.bin in the SPI flash of your device
  57    Boot your system
  58
  59
  60 Sandbox
  61 -------
  62
  63 Most Chromium OS development with U-Boot is undertaken using sandbox. There is
  64 a sandbox target available (chromeos_sandbox) which allows running U-Boot on
  65 a Linux machine completion with emulations of the display, TPM, disk, etc.
  66
  67 Running sandbox starts TPL, which contains the first phase of vboot, providing
  68 a device tree and binding a Chromium OS disk image for use to find kernels
  69 (any Chromium OS image will do). It also saves driver state between U-Boot
  70 phases into state.dtb and will automatically ensure that memory is shared
  71 between all phases. TPL will jump to SPL and then on to U-Boot proper.
  72
  73 It is possible to run with debugging on, e.g.
  74
  75    gdb --args $UB/tpl/u-boot-tpl -d ....
  76
  77 Breakpoints can be set in any U-Boot phase. Overall this is a good debugging
  78 environment for new verified-boot features.
  79
  80
  81 Samus
  82 -----
  83
  84 Basic support is available for samus, using the chromeos_samus target. If you
  85 have an em100, use:
  86
  87    sudo em100 -s -c W25Q128FW -d $UB/image.bin -t -r
  88
  89 to write the image and then boot samus (Power-Refresh).
  90
  91
  92 Boot flow
  93 ---------
  94
  95 Verified boot starts in TPL, which selects the A or B SPL, which in turn selects
  96 the A or B U-Boot. Then this jumps to the selected kernel. If anything goes
  97 wrong, the device reboots and the recovery SPL and U-Boot are used instead.
  98
  99 More details are available here:
 100
 101    https://www.chromium.org/chromium-os/chromiumos-design-docs/firmware-boot-and-recovery
 102
 103
 104 New uclasses
 105 ------------
 106
 107 Several uclasses are provided in cros/:
 108
 109         UCLASS_CROS_AUX_FW              Chrome OS auxiliary firmware
 110         UCLASS_CROS_FWSTORE             Chrome OS firmware storage
 111         UCLASS_CROS_NVDATA              Chrome OS non-volatile data device
 112         UCLASS_CROS_VBOOT_EC            Chrome OS vboot EC operations
 113         UCLASS_CROS_VBOOT_FLAG          Chrome OS verified boot flag
 114
 115 The existing UCLASS_CROS_EC is also used.
 116
 117
 118 Commands
 119 --------
 120
 121 A new 'vboot' command is provided to run particular vboot stages. The most
 122 useful command is 'vboot go auto', which continues where the last stage left
 123 off.
 124
 125 Note that TPL and SPL do not supports commands as yet, so the vboot code is
 126 called directly from the SPL boot devices (BOOT_DEVICE_CROS_VBOOT). See
 127 cros_load_image_tpl() and cros_load_image_spl() which both call
 128 vboot_run_auto().
 129
 130
 131 Config options
 132 --------------
 133
 134 The main option is CONFIG_CHROMEOS, which enables a wide array of other options
 135 so that the required features are present.
 136
 137
 138 Device-tree config
 139 ------------------
 140
 141 Various options are available which control the operation of verified boot.
 142 See cros/dts/bindings/config.txt for details. Most config is handled at run-
 143 time, although build-time config (with Kconfig) could also be added fairly
 144 easily.
 145
 146
 147 Porting to other hardware
 148 -------------------------
 149
 150 A basic port to samus (Chromebook Pixel 2015) is in a basic working state,
 151 using the chromeos_samus target. Patches will likely be forthcoming in early
 152 2019. Ports to an ARM board and coreboot (for x86 Chromebooks) are in the
 153 dreaming state.
 154
 155
 156 Tests
 157 -----
 158
 159 Chromium OS firmware has a very limited set of tests. The tests that originally
 160 existed in U-Boot were not brought over to coreboot or depthcharge.
 161
 162 The U-Boot tests ('make check') do operate, but at present there are no
 163 Chromium OS tests available. These will hopefully come together over time. Of
 164 course the above sandbox feature provides a sort of functional test and can
 165 detecte problems that affect the flow or particular vboot features.
 166
 167
 168 TO DO
 169 -----
 170
 171 - Support for booting from coreboot (patches expected March 2019)
 172 - Support for booting from an ARM board, e.g. bob
 173
 174
 175 Simon Glass
 176 sjg@chromium.org
 177 7 October 2018