blob: 9b89b7ba6463f3107ce3902a5eb6a46ec42685c9 [file] [log] [blame]
Joakim Bech8e5c5b32018-10-25 08:18:32 +02001.. _hikey960:
2
3#########
4HiKey 960
5#########
6
7The instructions here will tell how to run OP-TEE on `HiKey 960`_.
8
9Supported HiKey960 boards
10*************************
Joakim Bech3595eb52021-04-14 08:31:18 +020011There are three different versions of the HiKey960 board.
Joakim Bech8e5c5b32018-10-25 08:18:32 +020012
Joakim Bech3595eb52021-04-14 08:31:18 +020013+----------+--------------------+--------+-------+--------------------------------------------------+
14| Name | Manufacturer | Memory | Flash | Comment |
15+==========+====================+========+=======+==================================================+
16| HiKey960 | Archermind/LeMaker | 4GB | 32GB | v2 uses DIP Switches (SW2201), rev B has 4GB RAM |
17+----------+--------------------+--------+-------+--------------------------------------------------+
18| HiKey960 | Archermind/LeMaker | 3GB | 32GB | v2 uses DIP Switches (SW2201), rev A has 3GB RAM |
19+----------+--------------------+--------+-------+--------------------------------------------------+
20| HiKey960 | Archermind/LeMaker | 3GB | 32GB | v1 uses Jumpers (J2001) |
21+----------+--------------------+--------+-------+--------------------------------------------------+
Joakim Bech8e5c5b32018-10-25 08:18:32 +020022
23UART adapter board
24******************
25Everything is configured to use the 96Boards `UART Serial`_ adapter. The UART is
26by default configured to UART6. If you have a v1 board and need to use UART5,
27then you need to change that before building. See ``CFG_CONSOLE_UART`` in
28`hikey960.mk`_.
29
30Build instructions
31******************
32Just follow the instructions at ":ref:`get_and_build_the_solution`". If ``make
33flash`` doesn't work, try ``make recovery``.
34
Joakim Bech3595eb52021-04-14 08:31:18 +020035For the 4GB RAM board version (rev B), an update to the ``CFG_DRAM_SIZE_GB``
36setting in `conf.mk`_ is needed. Either update the value from ``3`` to ``4`` in
37`conf.mk`_ before building, or set the value on the command line when building,
38i.e ``make PLATFORM=hikey-hikey960 CFG_DRAM_SIZE_GB=4``
39
Joakim Bech8e5c5b32018-10-25 08:18:32 +020040Recovery
41********
42If you manage to corrupt the device, such that fastboot doesn't load
43automatically on boot, then you will need to run the recovery procedure.
44Basically what you will need to do is use another make target and change some
45jumpers. All that is described when you run the target:
46
47External guide
48**************
49https://github.com/ARM-software/arm-trusted-firmware/blob/master/docs/plat/hikey960.rst
50
51.. code-block:: bash
52
53 $ make recovery
54
55.. _HiKey 960: https://www.96boards.org/product/hikey960/
56.. _hikey960.mk: https://github.com/OP-TEE/build/blob/master/hikey960.mk
Joakim Bech3595eb52021-04-14 08:31:18 +020057.. _conf.mk: https://github.com/OP-TEE/optee_os/blob/master/core/arch/arm/plat-hikey/conf.mk
Joakim Bech8e5c5b32018-10-25 08:18:32 +020058.. _UART Serial: https://www.96boards.org/product/uartserial/