1.. SPDX-License-Identifier: GPL-2.0+
2
3U-Boot for Khadas VIM3 (A311D)
4==============================
5
6Khadas VIM3 is a Single Board Computer manufactured by Shenzhen Wesion Technology Co. Ltd
7with the following specifications:
8
9 - Amlogic A311D Arm Cortex-A53 dual-core + Cortex-A73 quad-core SoC
10 - 4GB LPDDR4 SDRAM
11 - Gigabit Ethernet
12 - HDMI 2.1 display
13 - 40-pin GPIO header
14 - 1 x USB 3.0 Host, 1 x USB 2.0 Host
15 - eMMC, microSD
16 - M.2
17 - Infrared receiver
18
19Schematics are available on the manufacturer website.
20
21PCIe Setup
22----------
23
24The on-board MCU can mux the PCIe/USB3.0 shared differential lines using a FUSB340TMX USB
253.1 SuperSpeed Data Switch between a USB3.0 Type-A connector and an M.2 Key M slot. The
26PHY driving these differential lines is shared between the USB3.0 controller and the PCIe
27Controller, thus only a single controller can use it.
28
29To setup for PCIe run the following commands from U-Boot then power-cycle the board:
30
31.. code-block:: none
32
33    i2c dev i2c@5000
34    i2c mw 0x18 0x33 1
35
36To revert to USB3.0 run the following commands from U-Boot then power-cycle the board:
37
38.. code-block:: none
39
40    i2c dev i2c@5000
41    i2c mw 0x18 0x33 0
42
43U-Boot Compilation
44------------------
45
46.. code-block:: bash
47
48    $ export CROSS_COMPILE=aarch64-none-elf-
49    $ make khadas-vim3_defconfig
50    $ make
51
52U-Boot Signing with Pre-Built FIP repo
53--------------------------------------
54
55.. code-block:: bash
56
57    $ git clone https://github.com/LibreELEC/amlogic-boot-fip --depth=1
58    $ cd amlogic-boot-fip
59    $ mkdir my-output-dir
60    $ ./build-fip.sh khadas-vim3 /path/to/u-boot/u-boot.bin my-output-dir
61
62U-Boot Manual Signing
63---------------------
64
65Amlogic does not provide sources for the firmware and tools needed to create a bootloader
66image so it is necessary to obtain binaries from sources published by the board vendor:
67
68.. code-block:: bash
69
70    $ wget https://releases.linaro.org/archive/13.11/components/toolchain/binaries/gcc-linaro-aarch64-none-elf-4.8-2013.11_linux.tar.xz
71    $ wget https://releases.linaro.org/archive/13.11/components/toolchain/binaries/gcc-linaro-arm-none-eabi-4.8-2013.11_linux.tar.xz
72    $ tar xvfJ gcc-linaro-aarch64-none-elf-4.8-2013.11_linux.tar.xz
73    $ tar xvfJ gcc-linaro-arm-none-eabi-4.8-2013.11_linux.tar.xz
74    $ export PATH=$PWD/gcc-linaro-aarch64-none-elf-4.8-2013.11_linux/bin:$PWD/gcc-linaro-arm-none-eabi-4.8-2013.11_linux/bin:$PATH
75
76    $ DIR=vim3-u-boot
77    $ git clone --depth 1 https://github.com/khadas/u-boot.git -b khadas-vims-v2015.01 $DIR
78
79    $ cd vim3-u-boot
80    $ make kvim3_defconfig
81    $ make CROSS_COMPILE=aarch64-none-elf-
82    $ export UBOOTDIR=$PWD
83
84Go back to the mainline U-Boot source tree then:
85
86.. code-block:: bash
87
88    $ mkdir fip
89
90    $ wget https://github.com/BayLibre/u-boot/releases/download/v2017.11-libretech-cc/blx_fix_g12a.sh -O fip/blx_fix.sh
91    $ cp $UBOOTDIR/build/scp_task/bl301.bin fip/
92    $ cp $UBOOTDIR/build/board/khadas/kvim3/firmware/acs.bin fip/
93    $ cp $UBOOTDIR/fip/g12b/bl2.bin fip/
94    $ cp $UBOOTDIR/fip/g12b/bl30.bin fip/
95    $ cp $UBOOTDIR/fip/g12b/bl31.img fip/
96    $ cp $UBOOTDIR/fip/g12b/ddr3_1d.fw fip/
97    $ cp $UBOOTDIR/fip/g12b/ddr4_1d.fw fip/
98    $ cp $UBOOTDIR/fip/g12b/ddr4_2d.fw fip/
99    $ cp $UBOOTDIR/fip/g12b/diag_lpddr4.fw fip/
100    $ cp $UBOOTDIR/fip/g12b/lpddr3_1d.fw fip/
101    $ cp $UBOOTDIR/fip/g12b/lpddr4_1d.fw fip/
102    $ cp $UBOOTDIR/fip/g12b/lpddr4_2d.fw fip/
103    $ cp $UBOOTDIR/fip/g12b/piei.fw fip/
104    $ cp $UBOOTDIR/fip/g12b/aml_ddr.fw fip/
105    $ cp u-boot.bin fip/bl33.bin
106
107    $ bash fip/blx_fix.sh \
108           fip/bl30.bin \
109           fip/zero_tmp \
110           fip/bl30_zero.bin \
111           fip/bl301.bin \
112           fip/bl301_zero.bin \
113           fip/bl30_new.bin \
114           bl30
115
116    $ bash fip/blx_fix.sh \
117           fip/bl2.bin \
118           fip/zero_tmp \
119           fip/bl2_zero.bin \
120           fip/acs.bin \
121           fip/bl21_zero.bin \
122           fip/bl2_new.bin \
123           bl2
124
125    $ $UBOOTDIR/fip/g12b/aml_encrypt_g12b --bl30sig --input fip/bl30_new.bin \
126                                          --output fip/bl30_new.bin.g12a.enc \
127                                          --level v3
128    $ $UBOOTDIR/fip/g12b/aml_encrypt_g12b --bl3sig --input fip/bl30_new.bin.g12a.enc \
129                                          --output fip/bl30_new.bin.enc \
130                                          --level v3 --type bl30
131    $ $UBOOTDIR/fip/g12b/aml_encrypt_g12b --bl3sig --input fip/bl31.img \
132                                          --output fip/bl31.img.enc \
133                                          --level v3 --type bl31
134    $ $UBOOTDIR/fip/g12b/aml_encrypt_g12b --bl3sig --input fip/bl33.bin --compress lz4 \
135                                          --output fip/bl33.bin.enc \
136                                          --level v3 --type bl33 --compress lz4
137    $ $UBOOTDIR/fip/g12b/aml_encrypt_g12b --bl2sig --input fip/bl2_new.bin \
138                                          --output fip/bl2.n.bin.sig
139    $ $UBOOTDIR/fip/g12b/aml_encrypt_g12b --bootmk \
140                                          --output fip/u-boot.bin \
141                                          --bl2 fip/bl2.n.bin.sig \
142                                          --bl30 fip/bl30_new.bin.enc \
143                                          --bl31 fip/bl31.img.enc \
144                                          --bl33 fip/bl33.bin.enc \
145                                          --ddrfw1 fip/ddr4_1d.fw \
146                                          --ddrfw2 fip/ddr4_2d.fw \
147                                          --ddrfw3 fip/ddr3_1d.fw \
148                                          --ddrfw4 fip/piei.fw \
149                                          --ddrfw5 fip/lpddr4_1d.fw \
150                                          --ddrfw6 fip/lpddr4_2d.fw \
151                                          --ddrfw7 fip/diag_lpddr4.fw \
152                                          --ddrfw8 fip/aml_ddr.fw \
153                                          --ddrfw9 fip/lpddr3_1d.fw \
154                                          --level v3
155
156Then write U-Boot to SD or eMMC with:
157
158.. code-block:: bash
159
160    $ DEV=/dev/boot_device
161    $ dd if=fip/u-boot.bin.sd.bin of=$DEV conv=fsync,notrunc bs=512 skip=1 seek=1
162    $ dd if=fip/u-boot.bin.sd.bin of=$DEV conv=fsync,notrunc bs=1 count=440
163