1# OP-TEE Trusted OS 2## Contents 31. [Introduction](#1-introduction) 42. [License](#2-license) 53. [Platforms supported](#3-platforms-supported) 6 3. [Development board for community user] (#31-development-board-for-community-user) 74. [Get and build OP-TEE software](#4-get-and-build-op-tee-software) 8 4. [Prerequisites](#41-prerequisites) 9 4. [Basic setup](#42-basic-setup) 10 4. [STMicroelectronics boards](#44-stmicroelectronics-boards) 11 4. [Allwinner A80](#45-allwinner-a80) 12 4. [Freescale MX6UL EVK](#46-freescale-mx6ul-evk) 135. [repo manifests](#5-repo-manifests) 14 5. [Install repo](#51-install-repo) 15 5. [Get the source code](#52-get-the-source-code) 16 5. [Targets](#521-targets) 17 5. [Branches](#522-branches) 18 5. [Get the toolchains](#523-get-the-toolchains) 19 5. [QEMU](#53-qemu) 20 5. [FVP](#54-fvp) 21 5. [HiKey](#55-hikey) 22 5. [MT8173-EVB](#56-mt8173-evb) 23 5. [Juno](#57-juno) 24 5. [Update flash and its layout](#571-update-flash-and-its-layout) 25 5. [GlobalPlatform testsuite support](#572-globalplatform-testsuite-support) 26 5. [GCC5 support](#573-gcc5-support) 27 5. [Raspberry Pi 3](#58-raspberry-pi-3) 28 5. [Tips and tricks](#59-tips-and-tricks) 29 5. [Reference existing project to speed up repo sync](#581-reference-existing-project-to-speed-up-repo-sync) 30 5. [Use ccache](#582-use-ccache) 316. [Load driver, tee-supplicant and run xtest](#6-load-driver-tee-supplicant-and-run-xtest) 327. [Coding standards](#7-coding-standards) 33 7. [checkpatch](#71-checkpatch) 34 35# 1. Introduction 36The `optee_os git`, contains the source code for the TEE in Linux using the 37ARM® TrustZone® technology. This component meets the GlobalPlatform 38TEE System Architecture specification. It also provides the TEE Internal core API 39v1.1 as defined by the GlobalPlatform TEE Standard for the development of 40Trusted Applications. For a general overview of OP-TEE and to find out how to 41contribute, please see the [Notice.md](Notice.md) file. 42 43The Trusted OS is accessible from the Rich OS (Linux) using the 44[GlobalPlatform TEE Client API Specification v1.0](http://www.globalplatform.org/specificationsdevice.asp), 45which also is used to trigger secure execution of applications within the TEE. 46 47--- 48## 2. License 49The software is distributed mostly under the 50[BSD 2-Clause](http://opensource.org/licenses/BSD-2-Clause) open source 51license, apart from some files in the `optee_os/lib/libutils` directory 52which are distributed under the 53[BSD 3-Clause](http://opensource.org/licenses/BSD-3-Clause) or public domain 54licenses. 55 56--- 57## 3. Platforms supported 58Several platforms are supported. In order to manage slight differences 59between platforms, a `PLATFORM_FLAVOR` flag has been introduced. 60The `PLATFORM` and `PLATFORM_FLAVOR` flags define the whole configuration 61for a chip the where the Trusted OS runs. Note that there is also a 62composite form which makes it possible to append `PLATFORM_FLAVOR` directly, 63by adding a dash in-between the names. The composite form is shown below 64for the different boards. For more specific details about build flags etc, 65please read the file [build_system.md](documentation/build_system.md). Some 66platforms have different sub-maintainers, please refer to the file 67[MAINTAINERS.md](MAINTAINERS.md) for contact details for various platforms. 68 69<!-- Please keep this list sorted in alphabetic order --> 70| Platform | Composite PLATFORM flag | Publicly available? | 71|----------|-------------------------|---------------------| 72| [Allwinner A80 Board](http://www.allwinnertech.com/en/clq/processora/A80.html)|`PLATFORM=sunxi`| No | 73| [ARM Juno Board](http://www.arm.com/products/tools/development-boards/versatile-express/juno-arm-development-platform.php) |`PLATFORM=vexpress-juno`| Yes | 74| [FSL ls1021a](http://www.freescale.com/tools/embedded-software-and-tools/hardware-development-tools/tower-development-boards/mcu-and-processor-modules/powerquicc-and-qoriq-modules/qoriq-ls1021a-tower-system-module:TWR-LS1021A?lang_cd=en)|`PLATFORM=ls-ls1021atwr`| Yes | 75| [FSL i.MX6 UltraLite EVK Board](http://www.freescale.com/products/arm-processors/i.mx-applications-processors-based-on-arm-cores/i.mx-6-processors/i.mx6qp/i.mx6ultralite-evaluation-kit:MCIMX6UL-EVK) |`PLATFORM=imx`| Yes | 76| [ARM Foundation FVP](http://www.arm.com/fvp) |`PLATFORM=vexpress-fvp`| Yes | 77| [HiSilicon D02](http://open-estuary.org/d02-2)|`PLATFORM=d02`| No | 78| [HiKey Board (HiSilicon Kirin 620)](https://www.96boards.org/products/hikey)|`PLATFORM=hikey`| Yes | 79| [MediaTek MT8173 EVB Board](http://www.mediatek.com/en/products/mobile-communications/tablet/mt8173)|`PLATFORM=mediatek-mt8173`| No | 80| [QEMU](http://wiki.qemu.org/Main_Page) |`PLATFORM=vexpress-qemu_virt`| Yes | 81| [QEMUv8](http://wiki.qemu.org/Main_Page) |`PLATFORM=vexpress-qemu_armv8a`| Yes | 82| [Raspberry Pi 3](https://www.raspberrypi.org/products/raspberry-pi-3-model-b) |`PLATFORM=rpi3`| Yes | 83| [STMicroelectronics b2120 - h310 / h410](http://www.st.com/web/en/catalog/mmc/FM131/SC999/SS1628/PF258776) |`PLATFORM=stm-cannes`| No | 84| [STMicroelectronics b2020-h416](http://www.st.com/web/catalog/mmc/FM131/SC999/SS1633/PF253155?sc=internet/imag_video/product/253155.jsp)|`PLATFORM=stm-orly2`| No | 85| [Texas Instruments DRA7xx](http://www.ti.com/product/DRA746)|`PLATFORM=ti-dra7xx`| Yes | 86| [Xilinx Zynq UltraScale+ MPSOC](http://www.xilinx.com/products/silicon-devices/soc/zynq-ultrascale-mpsoc.html)|`PLATFORM=zynqmp-zcu102`| Yes | 87| [Spreadtrum SC9860](http://www.spreadtrum.com/en/SC9860GV.html)|`PLATFORM=sprd-sc9860`| No | 88 89### 3.1 Development board for community user 90For community users, we suggest using [HiKey board](https://www.96boards.org/products/ce/hikey/) 91as development board. It provides detailed documentation including chip 92datasheet, board schematics, source code, binaries etc on the download link at 93the website. 94 95--- 96## 4. Get and build OP-TEE software 97There are a couple of different build options depending on the target you are 98going to use. If you just want to get the software and compile it, then you 99should follow the instructions under the "Basic setup" below. In case you are 100going to run for a certain hardware or FVP, QEMU for example, then please follow 101the respective section found below instead, having that said, we are moving from 102the shell script based setups to instead use 103[repo](https://source.android.com/source/downloading.html), so for some targets 104you will see that we are using repo ([section 5](#5-repo-manifests)) and for 105others we are still using the shell script based setup 106([section 4](#4-get-and-build-op-tee-software)), please see this transitions as 107work in progress. 108 109--- 110### 4.1 Prerequisites 111We believe that you can use any Linux distribution to build OP-TEE, but as 112maintainers of OP-TEE we are mainly using Ubuntu-based distributions and to be 113able to build and run OP-TEE there are a few packages that needs to be installed 114to start with. Therefore install the following packages regardless of what 115target you will use in the end. 116``` 117$ sudo apt-get install android-tools-adb android-tools-fastboot autoconf bc \ 118 bison cscope curl flex gdisk libc6:i386 libfdt-dev libftdi-dev \ 119 libglib2.0-dev libhidapi-dev libncurses5-dev libpixman-1-dev \ 120 libstdc++6:i386 libtool libz1:i386 mtools netcat python-crypto \ 121 python-serial python-wand unzip uuid-dev xdg-utils xz-utils zlib1g-dev 122``` 123 124--- 125### 4.2 Basic setup 126#### 4.2.1 Get the compiler 127We strive to use the latest available compiler from Linaro. Start by downloading 128and unpacking the compiler. Then export the `PATH` to the compilers `bin` 129folder. Beware that we are using a couple of different toolchains depending on 130the target device. This includes both 64- and 32-bit toolchains. For the exact 131toolchain in use, please have a look at [toolchain.mk](https://github.com/OP-TEE/build/blob/master/toolchain.mk) 132and then look at the targets makefile (see [build.git](https://github.com/OP-TEE/build)) 133to find out where the respective toolchain will be used. For example in the 134[QEMU makefile](https://github.com/OP-TEE/build/blob/master/qemu.mk#L12-L15) you 135will see: 136``` 137CROSS_COMPILE_NS_USER ?= "$(CCACHE)$(AARCH32_CROSS_COMPILE)" 138CROSS_COMPILE_NS_KERNEL ?= "$(CCACHE)$(AARCH32_CROSS_COMPILE)" 139CROSS_COMPILE_S_USER ?= "$(CCACHE)$(AARCH32_CROSS_COMPILE)" 140CROSS_COMPILE_S_KERNEL ?= "$(CCACHE)$(AARCH32_CROSS_COMPILE)" 141``` 142 143However, if you only want to compile optee_os, then you can do like this: 144``` 145$ cd $HOME 146$ mkdir toolchains 147$ cd toolchains 148$ wget http://releases.linaro.org/14.08/components/toolchain/binaries/gcc-linaro-arm-linux-gnueabihf-4.9-2014.08_linux.tar.xz 149$ tar xvf gcc-linaro-arm-linux-gnueabihf-4.9-2014.08_linux.tar.xz 150$ export PATH=$HOME/toolchains/gcc-linaro-arm-linux-gnueabihf-4.9-2014.08_linux/bin:$PATH 151``` 152 153#### 4.2.2 Download the source code 154``` 155$ cd $HOME 156$ mkdir devel 157$ cd devel 158$ git clone https://github.com/OP-TEE/optee_os.git 159``` 160 161#### 4.2.3 Build 162``` 163$ cd $HOME/devel/optee_os 164$ CROSS_COMPILE=arm-linux-gnueabihf- make 165``` 166 167#### 4.2.4 Compiler flags 168To be able to see the full command when building you could build using 169following flag: 170``` 171$ make V=1 172``` 173 174To enable debug builds use the following flag: 175``` 176$ make DEBUG=1 177``` 178 179OP-TEE supports a couple of different levels of debug prints for both TEE core 180itself and for the Trusted Applications. The level ranges from 1 to 4, where 181four is the most verbose. To set the level you use the following flag: 182``` 183$ make CFG_TEE_CORE_LOG_LEVEL=4 184``` 185 186--- 187### 4.4 STMicroelectronics boards 188Currently OP-TEE is supported on Orly-2 (`b2020-h416`) and Cannes family 189(`b2120` both `h310` and `h410` chip). 190 191#### 4.4.1 Get the compiler for Orly-2 192Will be written soon. 193 194#### 4.4.2 Download the source code 195See section "4.2.2 Download the source code". 196 197#### 4.4.3 Build for Orly-2 198For Orly-2 do as follows 199``` 200$ PLATFORM=stm-orly2 CROSS_COMPILE=arm-linux-gnueabihf- make 201``` 202 203For Cannes family do as follows 204``` 205$ PLATFORM=stm-cannes CROSS_COMPILE=arm-linux-gnueabihf- make 206``` 207 208#### 4.4.4 Prepare and install the images 209Will be written soon. 210 211#### 4.4.5 Boot and run the software 212<!-- All magic with STM and so on must be stated here. --> 213Will be written soon. 214 215--- 216### 4.5 Allwinner A80 217 218#### 4.5.1 Locked versus unlocked A80 boards 219**Important!** All A80 boards sold to the general public are boards where secure 220side has been locked down, which means that you **cannot** use them for secure 221side development, i.e, it will not be possible to put OP-TEE on those devices. 222If you want to use A80 board for secure side development, then you will need to 223talk to 224[Allwinner](https://github.com/OP-TEE/optee_os/blob/master/MAINTAINERS.md) 225directly and ask if it is possible get a device from them. 226 227#### 4.5.2 Get the compiler and source 228Follow the instructions in the "4.2 Basic setup". 229 230#### 4.5.3 Build 231``` 232$ cd optee_os 233$ export PLATFORM=sunxi 234$ export CROSS_COMPILE=arm-linux-gnueabihf- 235$ make 236``` 237 238#### 4.5.4 Prepare the images to run on A80 Board 239 240Download Allwinner A80 platform SDK, the SDK refers to Allwinner A80 platform 241SDK root directory. A80 SDK directory tree looks like this: 242``` 243SDK/ 244 Android 245 lichee 246``` 247`Android` contains all source code related to Android and `lichee` 248contains the bootloader and Linux kernel. 249 250##### 4.5.4.1 Copy OP-TEE output to package directory 251Copy the OP-TEE output binary to `SDK/lichee/tools/pack/sun9i/bin` 252 253``` 254$ cd optee_os 255$ cp ./out/arm32-plat-sunxi/core/tee.bin SDK/lichee/tools/pack/sun9i/bin 256``` 257 258##### 4.5.4.2 Build Linux kernel 259In the `lichee` directory, run the following commands: 260``` 261$ cd SDK/lichee 262$ ./build.sh 263``` 264 265##### 4.5.4.3 Build Android 266In the Android directory, run the following commands: 267``` 268$ cd SDK/android 269$ extract-bsp 270$ make -j 271``` 272 273##### 4.5.4.4 Create the Android image 274In the Android directory, run the following commands: 275``` 276$ cd SDK/android 277$ pack 278``` 279The output image will been signed internally when packed. The output image name 280is `a80_android_board.img`. 281 282##### 4.5.4.5 Download the Android image 283Use `Allwinner PhoenixSuit` tool to download to A80 board. 284Choose the output image(`a80_android_board.img`), select download and wait 285for the download to complete. 286 287#### 4.5.5 Boot and run the software on A80 Board 288When the host platform is Windows, use a console application to connect A80 289board `uart0`. In the console window, You can install OP-TEE linux kernel 290driver `optee.ko`, load OP-TEE-Client daemon `tee-supplicant` and run 291the example "hello world" Trusted Application, do this by running: 292``` 293$ insmod /system/vendor/modules/optee.ko 294$ /system/bin/tee-supplicant & 295$ /system/bin/tee-helloworld 296``` 297 298--- 299### 4.6 Freescale MX6UL EVK 300 301Get U-Boot source: 302https://github.com/MrVan/uboot/commit/4f016adae573aaadd7bf6a37f8c58a882b391ae6 303 304Build U-Boot: 305``` 306 make ARCH=arm mx6ul_14x14_evk_optee_defconfig 307 make ARCH=arm 308 Burn u-boot.imx to offset 0x400 of SD card 309``` 310 311Get Kernel source: https://github.com/linaro-swg/linux/tree/optee 312 313Patch kernel: 314```c 315 diff --git a/arch/arm/boot/dts/imx6ul-14x14-evk.dts b/arch/arm/boot/dts/imx6ul-14x14-evk.dts 316 index 6aaa5ec..2ac9c80 100644 317 --- a/arch/arm/boot/dts/imx6ul-14x14-evk.dts 318 +++ b/arch/arm/boot/dts/imx6ul-14x14-evk.dts 319 @@ -23,6 +23,13 @@ 320 reg = <0x80000000 0x20000000>; 321 }; 322 323 + firmware { 324 + optee { 325 + compatible = "linaro,optee-tz"; 326 + method = "smc"; 327 + }; 328 + }; 329 + 330 regulators { 331 compatible = "simple-bus"; 332 #address-cells = <1>; 333``` 334 335Compile the Kernel: 336 337``` 338make ARCH=arm imx_v6_v7_defconfig 339make menuconfig 340select the two entries 341 CONFIG_TEE=y 342 CONFIG_OPTEE 343make ARCH=arm 344``` 345Copy zImage and imx6ul_14x14_evk.dtb to SD card. 346 347OPTEE OS Build: 348``` 349 PLATFORM_FLAVOR=mx6ulevk make PLATFORM=imx 350 ${CROSS_COMPILE}-objcopy -O binary out/arm-plat-imx/core/tee.elf optee.bin 351 copy optee.bin to the first partition of SD card which is used for boot. 352``` 353 354Run using U-Boot: 355``` 356 run loadfdt; 357 run loadimage; 358 fatload mmc 1:1 0x9c100000 optee.bin; 359 run mmcargs; 360 bootz ${loadaddr} - ${fdt_addr}; 361``` 362 363Note: 364 CAAM is not implemented now, this will be added later. 365 366More steps: http://mrvan.github.io/optee-imx6ul 367 368--- 369## 5. repo manifests 370 371A Git repository is available at https://github.com/OP-TEE/manifest where you 372will find XML-files for use with the Android 'repo' tool. 373 374### 5.1. Install repo 375Follow the instructions under the "Installing Repo" section 376[here](https://source.android.com/source/downloading.html). 377 378### 5.2. Get the source code 379First ensure that you have the necessary Ubuntu packages installed, see [4.1 380Prerequisites](#41-prerequisites) (this is the only important step from section 3814 in case you are setting up any of the target devices mentioned below). 382 383``` 384$ mkdir -p $HOME/devel/optee 385$ cd $HOME/devel/optee 386$ repo init -u https://github.com/OP-TEE/manifest.git -m ${TARGET}.xml [-b ${BRANCH}] 387$ repo sync 388``` 389**Notes**<br> 390* The folder could be at any location, we are just giving a suggestion by 391 saying `$HOME/devel/optee`. 392* `repo sync` can take an additional parameter -j to sync multiple remotes. For 393 example `repo sync -j3` will sync three remotes in parallel. 394 395#### 5.2.1 Targets 396| Target | Latest | Stable | 397|--------|--------|--------| 398| QEMU | `default.xml` | `default_stable.xml` | 399| QEMUv8 | `qemu_v8.xml` | `Not available` | 400| FVP | `fvp.xml` | `fvp_stable.xml` | 401| HiKey | `hikey.xml` | `hikey_stable.xml` | 402| HiKey Debian (experimental) | `hikey_debian.xml` | Not available | 403| MediaTek MT8173 EVB Board | `mt8173-evb.xml` | `mt8173-evb_stable.xml` | 404| ARM Juno board| `juno.xml` | `juno_stable.xml` | 405| Raspberry Pi 3 | `rpi3_experimental.xml` | Not available | 406 407#### 5.2.2 Branches 408Currently we are only using one branch, i.e, the `master` branch. 409 410#### 5.2.3 Get the toolchains 411This is a one time thing you run only once after getting all the source code 412using repo. 413``` 414$ cd build 415$ make toolchains 416``` 417 418##### Note : 419If you have been using GCC4.9 and are upgrading to GCC5 via [this commit] (https://github.com/OP-TEE/build/commit/69a8a37bc417d28d62ae57e7ca2a8df4bdec93c8), please make sure that you delete the `toolchains` directory before running `make toolchains` again, or else the toolchain binaries can get mixed up or corrupted, and generate errors during builds. 420 421--- 422### 5.3. QEMU 423After getting the source and toolchain, just run (from the `build` folder) 424``` 425$ make all run 426``` 427and everything should compile and at the end QEMU should start. 428 429--- 430### 5.4. FVP 431After getting the source and toolchain you must also obtain Foundation Model 432([link](http://www.arm.com/products/tools/models/fast-models/foundation-model.php)) 433binaries and untar it to the forest root, then just run (from the `build` folder) 434 435``` 436$ make all run 437``` 438and everything should compile and at the end FVP should start. 439 440--- 441### 5.5. HiKey 442#### 5.5.1 Initramfs based 443After getting the source and toolchain, just run (from the `build` folder) 444``` 445$ make all 446``` 447 448After that connect the board and flash the binaries by running: 449``` 450$ make flash 451``` 452 453(more information about how to flash individual binaries could be found 454[here](https://github.com/96boards/documentation/wiki/HiKeyUEFI#flash-binaries-to-emmc-)) 455 456The board is ready to be booted. 457#### 5.5.2 Debian based / 96boards RPB (experimental) 458Start by getting the source and toolchain (see above), then continue by 459downloading the system image (root fs). Note that this step is something you 460only should do once. 461 462``` 463$ make system-img 464``` 465 466Which should be followed by 467``` 468$ make all 469``` 470 471When everything has been built, flash the files to the device: 472``` 473$ make flash 474``` 475 476Now you can boot up the device, note that OP-TEE normal world binaries still 477hasn't been put on the device at this stage. So by now you're basically booting 478up an RPB build. When you have a prompt, the next step is to connect the device 479to the network. WiFi is preferable, since HiKey has no Ethernet jack. Easiest is 480to edit `/etc/network/interfaces`. To find out what to add, run: 481``` 482$ make help 483``` 484 485When that's been added, reboot and when you have a prompt again, you're ready to 486push the OP-TEE client binaries and the kernel with OP-TEE support. First find 487out the IP for your device (`ifconfig`). Then send the files to HiKey by 488running: 489``` 490$ IP=111.222.333.444 make send 491 492Credentials for the image are: 493username: linaro 494password: linaro 495``` 496 497When the files has been transfered, please follow the commands from the `make 498send` command which will install the debian packages on the device. Typically it 499tells you to run something like this on the device itself: 500``` 501$ dpkg --force-all -i /tmp/out/optee_2.0-1.deb 502$ dpkg --force-all -i /tmp/linux-image-*.deb 503``` 504 505Now you are ready to use OP-TEE on HiKey using Debian, please goto step 6 below 506to continue. 507 508##### Good to know 509Just want to update secure side? Put the device in fastboot mode and 510``` 511$ make arm-tf 512$ make flash-fip 513 514``` 515 516Just want to update OP-TEE client software? Put the device in fastboot mode and 517``` 518$ make optee-client 519$ make xtest 520``` 521 522Boot up the device and follow the instructions from make send 523``` 524$ IP=111.222.333.444 make send 525``` 526 527--- 528### 5.6. MT8173-EVB 529After getting the source and toolchain, just run (from the `build` folder) 530 531``` 532$ make all run 533``` 534 535When `< waiting for device >` prompt appears, press reset button and the 536flashing procedure should begin. 537 538--- 539### 5.7 Juno 540After getting the source and toolchain, just run (from the `build` folder) 541``` 542$ make all 543``` 544 545Enter the firmware console on the juno board and press enter to stop 546the auto boot flow 547``` 548ARM V2M_Juno Firmware v1.3.9 549Build Date: Nov 11 2015 550 551Time : 12:50:45 552Date : 29:03:2016 553 554Press Enter to stop auto boot... 555 556``` 557Enable ftp at the firmware prompt 558``` 559Cmd> ftp_on 560Enabling ftp server... 561 MAC address: xxxxxxxxxxxx 562 563 IP address: 192.168.1.158 564 565 Local host name = V2M-JUNO-A2 566``` 567 568Flash the binary by running (note the IP address from above): 569``` 570make JUNO_IP=192.168.1.158 flash 571``` 572 573Once the binaries are transferred, reboot the board: 574``` 575Cmd> reboot 576 577``` 578 579#### 5.7.1 Update flash and its layout 580The flash in the board may need to be updated for the flashing above to 581work. If the flashing fails or if ARM-TF refuses to boot due to wrong 582version of the SCP binary the flash needs to be updated. To update the 583flash please follow the instructions at [Using Linaro's deliverable on 584Juno](https://community.arm.com/docs/DOC-10804) selecting one of the zips 585under "4.1 Prebuilt configurations" flashing it as described under "5. 586Running the software". 587 588#### 5.7.2 GlobalPlatform testsuite support 589##### Warning : 590Depending on the Juno pre-built configuration, the built ramdisk.img 591size with GlobalPlatform testsuite may exceed its pre-defined Juno flash 592memory reserved location (image.txt file). 593In that case, you will need to extend the Juno flash block size reserved 594location for the ramdisk.img in the image.txt file accordingly and 595follow the instructions under "5.7.1 Update flash and its layout". 596 597##### Example with juno-latest-busybox-uboot.zip: 598The current ramdisk.img size with GlobalPlatform testsuite 599is 8.6 MBytes. 600 601###### Updated file is /JUNO/SITE1/HBI0262B/images.txt (limited to 8.3 MB) 602``` 603NOR4UPDATE: AUTO ;Image Update:NONE/AUTO/FORCE 604NOR4ADDRESS: 0x01800000 ;Image Flash Address 605NOR4FILE: \SOFTWARE\ramdisk.img ;Image File Name 606NOR4NAME: ramdisk.img 607NOR4LOAD: 00000000 ;Image Load Address 608NOR4ENTRY: 00000000 ;Image Entry Point 609``` 610 611###### Extended to 16MB 612``` 613NOR4UPDATE: AUTO ;Image Update:NONE/AUTO/FORCE 614NOR4ADDRESS: 0x01000000 ;Image Flash Address 615NOR4FILE: \SOFTWARE\ramdisk.img ;Image File Name 616NOR4NAME: ramdisk.img 617NOR4LOAD: 00000000 ;Image Load Address 618NOR4ENTRY: 00000000 ;Image Entry Point 619``` 620 621#### 5.7.3 GCC5 support 622##### Note : 623In case you are using the **Latest version** of the ARM Juno board (this is 624`juno.xml` manifest), the built `ramdisk.img` size with GCC5 compiler, at 625the moment, exceeds its pre-defined Juno flash memory reserved location 626(`image.txt` file). 627 628To solve this problem you will need to extend the Juno flash block size 629reserved location for the `ramdisk.img` and decrease the size for other 630images in the `image.txt` file accordingly and then follow the instructions 631under "5.7.1 Update flash and its layout". 632 633##### Example with juno-latest-busybox-uboot.zip: 634The current `ramdisk.img` size with GCC5 compiler is 29.15 MBytes we will 635extend it to 32 MBytes. The only changes that you need to do are those in 636**bold** 637 638###### File to update is /JUNO/SITE1/HBI0262B/images.txt 639<pre> 640NOR2UPDATE: AUTO ;Image Update:NONE/AUTO/FORCE 641NOR2ADDRESS: <b>0x00100000</b> ;Image Flash Address 642NOR2FILE: \SOFTWARE\Image ;Image File Name 643NOR2NAME: norkern ;Rename kernel to norkern 644NOR2LOAD: 00000000 ;Image Load Address 645NOR2ENTRY: 00000000 ;Image Entry Point 646 647NOR3UPDATE: AUTO ;Image Update:NONE/AUTO/FORCE 648NOR3ADDRESS: <b>0x02C00000</b> ;Image Flash Address 649NOR3FILE: \SOFTWARE\juno.dtb ;Image File Name 650NOR3NAME: board.dtb ;Specify target filename to preserve file extension 651NOR3LOAD: 00000000 ;Image Load Address 652NOR3ENTRY: 00000000 ;Image Entry Point 653 654NOR4UPDATE: AUTO ;Image Update:NONE/AUTO/FORCE 655NOR4ADDRESS: <b>0x00D00000</b> ;Image Flash Address 656NOR4FILE: \SOFTWARE\ramdisk.img ;Image File Name 657NOR4NAME: ramdisk.img 658NOR4LOAD: 00000000 ;Image Load Address 659NOR4ENTRY: 00000000 ;Image Entry Point 660 661NOR5UPDATE: AUTO ;Image Update:NONE/AUTO/FORCE 662NOR5ADDRESS: <b>0x02D00000</b> ;Image Flash Address 663NOR5FILE: \SOFTWARE\hdlcdclk.dat ;Image File Name 664NOR5LOAD: 00000000 ;Image Load Address 665NOR5ENTRY: 00000000 ;Image Entry Point 666</pre> 667 668--- 669### 5.8 Raspberry Pi 3 670There is a separate document for Raspberry Pi 3 [here](documentation/rpi3.md). 671That document will tell you how to flash, how to debug, known problems and 672things still to be done. 673 674--- 675### 5.9 Tips and tricks 676#### 5.9.1 Reference existing project to speed up repo sync 677Doing a `repo init`, `repo sync` from scratch can take a fair amount of time. 678The main reason for that is simply because of the size of some of the gits we 679are using, like for the Linux kernel and EDK2. With repo you can reference an 680existing forest and by doing so you can speed up repo sync to instead taking ~20 681seconds instead of an hour. The way to do this are as follows. 682 6831. Start by setup a clean forest that you will not touch, in this example, let 684 us call that `optee-ref` and put that under for `$HOME/devel/optee-ref`. This 685 step will take roughly an hour. 6862. Then setup a cronjob (`crontab -e`) that does a `repo sync` in this folder 687 particular folder once a night (that is more than enough). 6883. Now you should setup your actual tree which you are going to use as your 689 working tree. The way to do this is almost the same as stated in the 690 instructions above, the only difference is that you reference the other local 691 forest when running `repo init`, like this 692 ``` 693 repo init -u https://github.com/OP-TEE/manifest.git --reference /home/jbech/devel/optee-ref 694 ``` 6954. The rest is the same above, but now it will only take a couple of seconds to 696 clone a forest. 697 698Normally step 1 and 2 above is something you will only do once. Also if you 699ignore step 2, then you will still get the latest from official git trees, since 700repo will also check for updates that aren't at the local reference. 701 702#### 5.9.2. Use ccache 703ccache is a tool that caches build object-files etc locally on the disc and can 704speed up build time significantly in subsequent builds. On Debian-based systems 705(Ubuntu, Mint etc) you simply install it by running: 706``` 707$ sudo apt-get install ccache 708``` 709 710The helper makefiles are configured to automatically find and use ccache if 711ccache is installed on your system, so other than having it installed you don't 712have to think about anything. 713 714--- 715## 6. Load driver, tee-supplicant and run xtest 716Since release v2.0.0 you don't have to load the kernel driver explicitly. In the 717standard configuration it will be built into the kernel directly. To actually 718run something on a device you however need to run tee-supplicant. This is the 719same for all platforms, so when a device has booted, then run 720``` 721$ tee-supplicant & 722``` 723and OP-TEE is ready to be used. 724 725In case you want to try run something that triggers both normal and secure side 726code you could run xtest (the main test suite for OP-TEE), run 727``` 728$ xtest 729``` 730 731--- 732## 7. Coding standards 733In this project we are trying to adhere to the same coding convention as used in 734the Linux kernel (see 735[CodingStyle](https://www.kernel.org/doc/Documentation/CodingStyle)). We achieve this by running 736[checkpatch](http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/scripts/checkpatch.pl) 737from Linux kernel. However there are a few exceptions that we had to make since 738the code also follows GlobalPlatform standards. The exceptions are as follows: 739 740- CamelCase for GlobalPlatform types are allowed. 741- And we also exclude checking third party code that we might use in this 742 project, such as LibTomCrypt, MPA, newlib (not in this particular git, but 743 those are also part of the complete TEE solution). The reason for excluding 744 and not fixing third party code is because we would probably deviate too much 745 from upstream and therefore it would be hard to rebase against those projects 746 later on (and we don't expect that it is easy to convince other software 747 projects to change coding style). 748 749### 7.1 checkpatch 750Since checkpatch is licensed under the terms of GNU GPL License Version 2, we 751cannot include this script directly into this project. Therefore we have 752written the Makefile so you need to explicitly point to the script by exporting 753an environment variable, namely CHECKPATCH. So, suppose that the source code for 754the Linux kernel is at `$HOME/devel/linux`, then you have to export like follows: 755 756 $ export CHECKPATCH=$HOME/devel/linux/scripts/checkpatch.pl 757thereafter it should be possible to use one of the different checkpatch targets 758in the [Makefile](Makefile). There are targets for checking all files, checking 759against latest commit, against a certain base-commit etc. For the details, read 760the [Makefile](Makefile). 761