Merge tag 'u-boot-imx-20211020' of https://source.denx.de/u-boot/custodians/u-boot-imx
[platform/kernel/u-boot.git] / doc / board / amlogic / odroid-c4.rst
1 .. SPDX-License-Identifier: GPL-2.0+
2
3 U-Boot for ODROID-C4
4 ====================
5
6 ODROID-C4 is a single board computer manufactured by Hardkernel
7 Co. Ltd with the following specifications:
8
9  - Amlogic S905X3 Arm Cortex-A55 quad-core SoC
10  - 4GB DDR4 SDRAM
11  - Gigabit Ethernet
12  - HDMI 2.1 display
13  - 40-pin GPIO header
14  - 4x USB 3.0 Host
15  - 1x USB 2.0 Host/OTG (micro)
16  - eMMC, microSD
17  - UART serial
18  - Infrared receiver
19
20 The ODROID-HC4 is a variant with a PCIe-SATA controller, the same commands
21 applies for HC4.
22
23 Schematics are available on the manufacturer website.
24
25 U-Boot compilation
26 ------------------
27
28 .. code-block:: bash
29
30     $ export CROSS_COMPILE=aarch64-none-elf-
31     $ make odroid-c4_defconfig
32     $ make
33
34 Image creation
35 --------------
36
37 Amlogic doesn't provide sources for the firmware and for tools needed
38 to create the bootloader image, so it is necessary to obtain them from
39 the git tree published by the board vendor:
40
41 .. code-block:: bash
42
43     $ wget https://releases.linaro.org/archive/13.11/components/toolchain/binaries/gcc-linaro-aarch64-none-elf-4.8-2013.11_linux.tar.xz
44     $ wget https://releases.linaro.org/archive/13.11/components/toolchain/binaries/gcc-linaro-arm-none-eabi-4.8-2013.11_linux.tar.xz
45     $ tar xvfJ gcc-linaro-aarch64-none-elf-4.8-2013.11_linux.tar.xz
46     $ tar xvfJ gcc-linaro-arm-none-eabi-4.8-2013.11_linux.tar.xz
47     $ 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
48
49     $ DIR=odroid-c4
50     $ git clone --depth 1 \
51        https://github.com/hardkernel/u-boot.git -b odroidg12-v2015.01 \
52        $DIR
53
54     $ cd odroid-c4
55     $ make odroidc4_defconfig
56     $ make
57     $ export UBOOTDIR=$PWD
58
59 Go back to mainline U-Boot source tree then :
60
61 .. code-block:: bash
62
63     $ mkdir fip
64
65     $ wget https://github.com/BayLibre/u-boot/releases/download/v2017.11-libretech-cc/blx_fix_g12a.sh -O fip/blx_fix.sh
66     $ cp $UBOOTDIR/build/scp_task/bl301.bin fip/
67     $ cp $UBOOTDIR/build/board/hardkernel/odroidc4/firmware/acs.bin fip/
68     $ cp $UBOOTDIR/fip/g12a/bl2.bin fip/
69     $ cp $UBOOTDIR/fip/g12a/bl30.bin fip/
70     $ cp $UBOOTDIR/fip/g12a/bl31.img fip/
71     $ cp $UBOOTDIR/fip/g12a/ddr3_1d.fw fip/
72     $ cp $UBOOTDIR/fip/g12a/ddr4_1d.fw fip/
73     $ cp $UBOOTDIR/fip/g12a/ddr4_2d.fw fip/
74     $ cp $UBOOTDIR/fip/g12a/diag_lpddr4.fw fip/
75     $ cp $UBOOTDIR/fip/g12a/lpddr3_1d.fw fip/
76     $ cp $UBOOTDIR/fip/g12a/lpddr4_1d.fw fip/
77     $ cp $UBOOTDIR/fip/g12a/lpddr4_2d.fw fip/
78     $ cp $UBOOTDIR/fip/g12a/piei.fw fip/
79     $ cp $UBOOTDIR/fip/g12a/aml_ddr.fw fip/
80     $ cp u-boot.bin fip/bl33.bin
81
82     $ sh fip/blx_fix.sh \
83         fip/bl30.bin \
84         fip/zero_tmp \
85         fip/bl30_zero.bin \
86         fip/bl301.bin \
87         fip/bl301_zero.bin \
88         fip/bl30_new.bin \
89         bl30
90
91     $ sh fip/blx_fix.sh \
92         fip/bl2.bin \
93         fip/zero_tmp \
94         fip/bl2_zero.bin \
95         fip/acs.bin \
96         fip/bl21_zero.bin \
97         fip/bl2_new.bin \
98         bl2
99
100     $ $UBOOTDIR/fip/g12a/aml_encrypt_g12a --bl30sig --input fip/bl30_new.bin \
101                                         --output fip/bl30_new.bin.g12a.enc \
102                                         --level v3
103     $ $UBOOTDIR/fip/g12a/aml_encrypt_g12a --bl3sig --input fip/bl30_new.bin.g12a.enc \
104                                         --output fip/bl30_new.bin.enc \
105                                         --level v3 --type bl30
106     $ $UBOOTDIR/fip/g12a/aml_encrypt_g12a --bl3sig --input fip/bl31.img \
107                                         --output fip/bl31.img.enc \
108                                         --level v3 --type bl31
109     $ $UBOOTDIR/fip/g12a/aml_encrypt_g12a --bl3sig --input fip/bl33.bin --compress lz4 \
110                                         --output fip/bl33.bin.enc \
111                                         --level v3 --type bl33 --compress lz4
112     $ $UBOOTDIR/fip/g12a/aml_encrypt_g12a --bl2sig --input fip/bl2_new.bin \
113                                         --output fip/bl2.n.bin.sig
114     $ $UBOOTDIR/fip/g12a/aml_encrypt_g12a --bootmk \
115                 --output fip/u-boot.bin \
116                 --bl2 fip/bl2.n.bin.sig \
117                 --bl30 fip/bl30_new.bin.enc \
118                 --bl31 fip/bl31.img.enc \
119                 --bl33 fip/bl33.bin.enc \
120                 --ddrfw1 fip/ddr4_1d.fw \
121                 --ddrfw2 fip/ddr4_2d.fw \
122                 --ddrfw3 fip/ddr3_1d.fw \
123                 --ddrfw4 fip/piei.fw \
124                 --ddrfw5 fip/lpddr4_1d.fw \
125                 --ddrfw6 fip/lpddr4_2d.fw \
126                 --ddrfw7 fip/diag_lpddr4.fw \
127                 --ddrfw8 fip/aml_ddr.fw \
128                 --ddrfw9 fip/lpddr3_1d.fw \
129                 --level v3
130
131 and then write the image to SD with:
132
133 .. code-block:: bash
134
135     $ DEV=/dev/your_sd_device
136     $ dd if=fip/u-boot.bin.sd.bin of=$DEV conv=fsync,notrunc bs=512 skip=1 seek=1
137     $ dd if=fip/u-boot.bin.sd.bin of=$DEV conv=fsync,notrunc bs=1 count=444