1Description 2=========== 3 4HiKey is one of 96boards. Hisilicon Kirin6220 processor is installed on HiKey. 5 6More information are listed in `link`_. 7 8How to build 9============ 10 11Code Locations 12-------------- 13 14- ARM Trusted Firmware: 15 `link <https://github.com/ARM-software/arm-trusted-firmware>`__ 16 17- OP-TEE 18 `link <https://github.com/OP-TEE/optee_os>`__ 19 20- edk2: 21 `link <https://github.com/96boards-hikey/edk2/tree/testing/hikey960_v2.5>`__ 22 23- OpenPlatformPkg: 24 `link <https://github.com/96boards-hikey/OpenPlatformPkg/tree/testing/hikey960_v1.3.4>`__ 25 26- l-loader: 27 `link <https://github.com/96boards-hikey/l-loader/tree/testing/hikey960_v1.2>`__ 28 29- uefi-tools: 30 `link <https://git.linaro.org/uefi/uefi-tools.git>`__ 31 32- atf-fastboot: 33 `link <https://github.com/96boards-hikey/atf-fastboot/tree/master>`__ 34 35Build Procedure 36--------------- 37 38- Fetch all the above repositories into local host. 39 Make all the repositories in the same ${BUILD\_PATH}. 40 41 .. code:: shell 42 43 git clone https://github.com/ARM-software/arm-trusted-firmware -b integration 44 git clone https://github.com/OP-TEE/optee_os 45 git clone https://github.com/96boards-hikey/edk2 -b testing/hikey960_v2.5 46 git clone https://github.com/96boards-hikey/OpenPlatformPkg -b testing/hikey960_v1.3.4 47 git clone https://github.com/96boards-hikey/l-loader -b testing/hikey960_v1.2 48 git clone https://git.linaro.org/uefi/uefi-tools 49 git clone https://github.com/96boards-hikey/atf-fastboot 50 51- Create the symbol link to OpenPlatformPkg in edk2. 52 53 .. code:: shell 54 55 $cd ${BUILD_PATH}/edk2 56 $ln -sf ../OpenPlatformPkg 57 58- Prepare AARCH64 && AARCH32 toolchain. Prepare python. 59 60- If your hikey hardware is built by CircuitCo, update *uefi-tools/platform.config* first. *(optional)* 61 **Uncomment the below sentence. Otherwise, UEFI can't output messages on serial 62 console on hikey.** 63 64 .. code:: shell 65 66 BUILDFLAGS=-DSERIAL_BASE=0xF8015000 67 68 If your hikey hardware is built by LeMarker, nothing to do. 69 70- Build it as debug mode. Create your own build script file or you could refer to **build\_uefi.sh** in l-loader git repository. 71 72 .. code:: shell 73 74 BUILD_OPTION=DEBUG 75 export AARCH64_TOOLCHAIN=GCC5 76 export UEFI_TOOLS_DIR=${BUILD_PATH}/uefi-tools 77 export EDK2_DIR=${BUILD_PATH}/edk2 78 EDK2_OUTPUT_DIR=${EDK2_DIR}/Build/HiKey/${BUILD_OPTION}_${AARCH64_TOOLCHAIN} 79 # Build fastboot for ARM Trust Firmware. It's used for recovery mode. 80 cd ${BUILD_PATH}/atf-fastboot 81 CROSS_COMPILE=aarch64-linux-gnu- make PLAT=hikey DEBUG=1 82 # Convert DEBUG/RELEASE to debug/release 83 FASTBOOT_BUILD_OPTION=$(echo ${BUILD_OPTION} | tr '[A-Z]' '[a-z]') 84 cd ${EDK2_DIR} 85 # Build UEFI & ARM Trust Firmware 86 ${UEFI_TOOLS_DIR}/uefi-build.sh -b ${BUILD_OPTION} -a ../arm-trusted-firmware -s ../optee_os hikey 87 88- Generate l-loader.bin and partition table for aosp. The eMMC capacity is either 8GB or 4GB. Just change "aosp-8g" to "linux-8g" for debian. 89 90 .. code:: shell 91 92 cd ${BUILD_PATH}/l-loader 93 ln -sf ${EDK2_OUTPUT_DIR}/FV/bl1.bin 94 ln -sf ${BUILD_PATH}/atf-fastboot/build/hikey/${FASTBOOT_BUILD_OPTION}/bl1.bin fastboot.bin 95 make hikey PTABLE_LST=aosp-8g 96 97Setup Console 98------------- 99 100- Install ser2net. Use telnet as the console since UEFI fails to display Boot Manager GUI in minicom. **If you don't need Boot Manager GUI, just ignore this section.** 101 102 .. code:: shell 103 104 $sudo apt-get install ser2net 105 106- Configure ser2net. 107 108 .. code:: shell 109 110 $sudo vi /etc/ser2net.conf 111 112 Append one line for serial-over-USB in below. 113 *#ser2net.conf* 114 115 .. code:: shell 116 117 2004:telnet:0:/dev/ttyUSB0:115200 8DATABITS NONE 1STOPBIT banner 118 119- Start ser2net 120 121 .. code:: shell 122 123 $sudo killall ser2net 124 $sudo ser2net -u 125 126- Open the console. 127 128 .. code:: shell 129 130 $telnet localhost 2004 131 132 And you could open the console remotely, too. 133 134Flash images in recovery mode 135----------------------------- 136 137- Make sure Pin3-Pin4 on J15 are connected for recovery mode. Then power on HiKey. 138 139- Remove the modemmanager package. This package may cause the idt tool failure. 140 141 .. code:: shell 142 143 $sudo apt-get purge modemmanager 144 145- Run the command to download l-loader.bin into HiKey. 146 147 .. code:: shell 148 149 $sudo python hisi-idt.py -d /dev/ttyUSB1 --img1 l-loader.bin 150 151- Update images. All aosp or debian images could be fetched from `link <https://builds.96boards.org/>`__. 152 153 .. code:: shell 154 155 $sudo fastboot flash ptable prm_ptable.img 156 $sudo fastboot flash fastboot fip.bin 157 $sudo fastboot flash boot boot.img 158 $sudo fastboot flash cache cache.img 159 $sudo fastboot flash system system.img 160 $sudo fastboot flash userdata userdata.img 161 162Boot UEFI in normal mode 163------------------------ 164 165- Make sure Pin3-Pin4 on J15 are open for normal boot mode. Then power on HiKey. 166 167- Reference `link <https://github.com/96boards-hikey/tools-images-hikey960/blob/master/build-from-source/README-ATF-UEFI-build-from-source.md>`__ 168 169.. _link: https://github.com/96boards/documentation/blob/master/ConsumerEdition/HiKey/Quickstart/README.md 170