board/sunxi/README.sunxi64

   1 Allwinner 64-bit boards README
   2 ==============================
   3
   4 Newer Allwinner SoCs feature ARMv8 cores (ARM Cortex-A53) with support for
   5 both the 64-bit AArch64 mode and the ARMv7 compatible 32-bit AArch32 mode.
   6 Examples are the Allwinner A64 (used for instance on the Pine64 board) or
   7 the Allwinner H5 SoC (as used on the OrangePi PC 2).
   8 These SoCs are wired to start in AArch32 mode on reset and execute 32-bit
   9 code from the Boot ROM (BROM). As this has some implications on U-Boot, this
  10 file describes how to make full use of the 64-bit capabilities.
  11
  12 Quick Start / Overview
  13 ======================
  14 - Build the ARM Trusted Firmware binary (see "ARM Trusted Firmware (ATF)" below)
  15   $ cd /src/arm-trusted-firmware
  16   $ make PLAT=sun50i_a64 DEBUG=1 bl31
  17 - Build U-Boot (see "SPL/U-Boot" below)
  18   $ export BL31=/path/to/bl31.bin
  19   $ make pine64_plus_defconfig && make -j5
  20 - Transfer to an uSD card (see "microSD card" below)
  21   $ dd if=u-boot-sunxi-with-spl.bin of=/dev/sdx bs=8k seek=1
  22 - Boot and enjoy!
  23
  24 Building the firmware
  25 =====================
  26
  27 The Allwinner A64/H5 firmware consists of three parts: U-Boot's SPL, an
  28 ARM Trusted Firmware (ATF) build and the U-Boot proper.
  29 The SPL will load both ATF and U-Boot proper along with the right device
  30 tree blob (.dtb) and will pass execution to ATF (in EL3), which in turn will
  31 drop into the U-Boot proper (in EL2).
  32 As the ATF binary will become part of the U-Boot image file, you will need
  33 to build it first.
  34
  35  ARM Trusted Firmware (ATF)
  36 ----------------------------
  37 Checkout the latest master branch from the official ATF repository [1] and
  38 build it:
  39 $ export CROSS_COMPILE=aarch64-linux-gnu-
  40 $ make PLAT=sun50i_a64 DEBUG=1 bl31
  41 The resulting binary is build/sun50i_a64/debug/bl31.bin. Either put the
  42 location of this file into the BL31 environment variable or copy this to
  43 the root of your U-Boot build directory (or create a symbolic link).
  44 $ export BL31=/src/arm-trusted-firmware/build/sun50i_a64/debug/bl31.bin
  45   (adjust the actual path accordingly)
  46 The platform target "sun50i_a64" covers all boards with either an Allwinner
  47 A64 or H5 SoC (since they are very similar). For boards with an Allwinner H6
  48 SoC use "sun50i_h6".
  49
  50 If you run into size issues with the resulting U-Boot image file, it might
  51 help to use a release build, by using "DEBUG=0" when building bl31.bin.
  52 As sometimes the ATF build process is a bit picky about the toolchain used,
  53 or if you can't be bothered with building ATF, there are known working
  54 binaries in the firmware repository[3], purely for convenience reasons.
  55
  56  SPL/U-Boot
  57 ------------
  58 Both U-Boot proper and the SPL are using the 64-bit mode. As the boot ROM
  59 enters the SPL still in AArch32 secure SVC mode, there is some shim code to
  60 enter AArch64 very early. The rest of the SPL runs in AArch64 EL3.
  61 U-Boot proper runs in EL2 and can load any AArch64 code (using the "go"
  62 command), EFI applications (with "bootefi") or arm64 Linux kernel images
  63 (often named "Image"), using the "booti" command.
  64
  65 $ make clean
  66 $ export CROSS_COMPILE=aarch64-linux-gnu-
  67 $ make pine64_plus_defconfig
  68 $ make
  69
  70 This will build the SPL in spl/sunxi-spl.bin and a FIT image called u-boot.itb,
  71 which contains the rest of the firmware. u-boot-sunxi-with-spl.bin joins those
  72 two components in one convenient image file.
  73
  74
  75 Boot process
  76 ============
  77 The on-die BROM code will try several methods to load and execute the firmware.
  78 On a typical board like the Pine64 this will result in the following boot order:
  79
  80 1) Reading 32KB from sector 16 (@8K) of the microSD card to SRAM A1. If the
  81 BROM finds the magic "eGON" header in the first bytes, it will execute that
  82 code. If not (no SD card at all or invalid magic), it will:
  83 2) Try to read 32KB from sector 16 (@8K) of memory connected to the MMC2
  84 controller, typically an on-board eMMC chip. If there is no eMMC or it does
  85 not contain a valid boot header, it will:
  86 3) Initialize the SPI0 controller and try to access a NOR flash connected to
  87 it (using the CS0 pin). If a flash chip is found, the BROM will load the
  88 first 32KB (from offset 0) into SRAM A1. Now it checks for the magic eGON
  89 header and checksum and will execute the code upon finding it. If not, it will:
  90 4) Initialize the USB OTG controller and will wait for a host to connect to
  91 it, speaking the Allwinner proprietary (but deciphered) "FEL" USB protocol.
  92
  93
  94 To boot the Pine64 board, you can use U-Boot and any of the described methods.
  95
  96 FEL boot (USB OTG)
  97 ------------------
  98 FEL is the name of the Allwinner defined USB boot protocol built in the
  99 mask ROM of most Allwinner SoCs. It allows to bootstrap a board solely
 100 by using the USB-OTG interface and a host port on another computer.
 101 As the FEL mode is controlled by the boot ROM, it expects to be running in
 102 AArch32. For now the AArch64 SPL cannot properly return into FEL mode, so the
 103 feature is disabled in the configuration at the moment.
 104 The repository in [3] contains FEL capable SPL binaries, built using an
 105 off-tree branch to generate 32-bit ARM code (along with instructions
 106 how to re-create them).
 107
 108 microSD card
 109 ------------
 110 Transfer the SPL and the U-Boot FIT image directly to an uSD card:
 111 # dd if=spl/sunxi-spl.bin of=/dev/sdx bs=8k seek=1
 112 # dd if=u-boot.itb of=/dev/sdx bs=8k seek=5
 113 # sync
 114 (replace /dev/sdx with you SD card device file name, which could be
 115 /dev/mmcblk[x] as well).
 116
 117 Alternatively you can use the SPL and the U-Boot FIT image combined into a
 118 single file and transfer that instead:
 119 # dd if=u-boot-sunxi-with-spl.bin of=/dev/sdx bs=8k seek=1
 120
 121 You can partition the microSD card, but leave the first MB unallocated (most
 122 partitioning tools will do this anyway).
 123
 124 NOR flash
 125 ---------
 126 Some boards (like the SoPine, Pinebook or the OrangePi PC2) come with a
 127 soldered SPI NOR flash chip. On other boards like the Pine64 such a chip
 128 can be connected to the SPI0/CS0 pins on the PI-2 headers.
 129 Create the SPL and FIT image like described above for the SD card.
 130 Now connect either an "A to A" USB cable to the upper USB port on the Pine64
 131 or get an adaptor and use a regular A-microB cable connected to it. Other
 132 boards often have a proper micro-B USB socket connected to the USB OTB port.
 133 Remove a microSD card from the slot and power on the board.
 134 On your host computer download and build the sunxi-tools package[2], then
 135 use "sunxi-fel" to access the board:
 136 $ ./sunxi-fel ver -v -p
 137 This should give you an output starting with: AWUSBFEX soc=00001689(A64) ...
 138 Now use the sunxi-fel tool to write to the NOR flash:
 139 $ ./sunxi-fel spiflash-write 0 spl/sunxi-spl.bin
 140 $ ./sunxi-fel spiflash-write 32768 u-boot.itb
 141 Now boot the board without an SD card inserted and you should see the
 142 U-Boot prompt on the serial console.
 143
 144 (Legacy) boot0 method
 145 ---------------------
 146 boot0 is Allwinner's secondary program loader and it can be used as some kind
 147 of SPL replacement to get U-Boot up and running from an microSD card.
 148 For some time using boot0 was the only option to get the Pine64 booted.
 149 With working DRAM init code in U-Boot's SPL this is no longer necessary,
 150 but this method is described here for the sake of completeness.
 151 Please note that this method works only with the boot0 files shipped with
 152 A64 based boards, the H5 uses an incompatible layout which is not supported
 153 by this method.
 154
 155 The boot0 binary is a 32 KByte blob and contained in the official Pine64 images
 156 distributed by Pine64 or Allwinner. It can be easily extracted from a micro
 157 SD card or an image file:
 158 # dd if=/dev/sd<x> of=boot0.bin bs=8k skip=1 count=4
 159 where /dev/sd<x> is the device name of the uSD card or the name of the image
 160 file. Apparently Allwinner allows re-distribution of this proprietary code
 161 "as-is".
 162 This boot0 blob takes care of DRAM initialisation and loads the remaining
 163 firmware parts, then switches the core into AArch64 mode.
 164 The original boot0 code looks for U-Boot at a certain place on an uSD card
 165 (at 19096 KB), also it expects a header with magic bytes and a checksum.
 166 There is a tool called boot0img[3] which takes a boot0.bin image and a compiled
 167 U-Boot binary (plus other binaries) and will populate that header accordingly.
 168 To make space for the magic header, the pine64_plus_defconfig will make sure
 169 there is sufficient space at the beginning of the U-Boot binary.
 170 boot0img will also take care of putting the different binaries at the right
 171 places on the uSD card and works around unused, but mandatory parts by using
 172 trampoline code. See the output of "boot0img -h" for more information.
 173 boot0img can also patch boot0 to avoid loading U-Boot from 19MB, instead
 174 fetching it from just behind the boot0 binary (-B option).
 175 $ ./boot0img -o firmware.img -B boot0.img -u u-boot-dtb.bin -e -s bl31.bin \
 176 -a 0x44008 -d trampoline64:0x44000
 177 Then write this image to a microSD card, replacing /dev/sdx with the right
 178 device file (see above):
 179 $ dd if=firmware.img of=/dev/sdx bs=8k seek=1
 180
 181 [1] https://github.com/ARM-software/arm-trusted-firmware.git
 182 [2] git://github.com/linux-sunxi/sunxi-tools.git
 183 [3] https://github.com/apritzel/pine64/