README.sunxi64 8.8 KB

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