- Introduction
- License
- Platforms supported 3. [Development board for community user] (#31-development-board-for-community-user)
- Get and build OP-TEE software 4. Prerequisites 4. Basic setup 4. ARM Juno board 4. STMicroelectronics boards 4. Allwinner A80 4. Freescale MX6UL EVK
- repo manifests 5. Install repo 5. Get the source code 5. Targets 5. Branches 5. Get the toolchains 5. QEMU 5. FVP 5. HiKey 5. MT8173-EVB 5. Tips and tricks 5. Reference existing project to speed up repo sync 5. Use ccache
- Load driver, tee-supplicant and run xtest
- Coding standards 7. checkpatch
The optee_os git, contains the source code for the TEE in Linux using the
ARM® TrustZone® technology. This component meets the GlobalPlatform
TEE System Architecture specification. It also provides the TEE Internal core API
v1.1 as defined by the GlobalPlatform TEE Standard for the development of
Trusted Applications. For a general overview of OP-TEE and to find out how to
contribute, please see the Notice.md file.
The Trusted OS is accessible from the Rich OS (Linux) using the GlobalPlatform TEE Client API Specification v1.0, which also is used to trigger secure execution of applications within the TEE.
The software is distributed mostly under the
BSD 2-Clause open source
license, apart from some files in the optee_os/lib/libutils directory
which are distributed under the
BSD 3-Clause or public domain
licenses.
Several platforms are supported. In order to manage slight differences
between platforms, a PLATFORM_FLAVOR flag has been introduced.
The PLATFORM and PLATFORM_FLAVOR flags define the whole configuration
for a chip the where the Trusted OS runs. Note that there is also a
composite form which makes it possible to append PLATFORM_FLAVOR directly,
by adding a dash in-between the names. The composite form is shown below
for the different boards. For more specific details about build flags etc,
please read the file build_system.md. Some
platforms have different sub-maintainers, please refer to the file
MAINTAINERS.md for contact details for various platforms.
| Platform | Composite PLATFORM flag | Publicly available? |
|---|---|---|
| Allwinner A80 Board | PLATFORM=sunxi |
No |
| ARM Juno Board | PLATFORM=vexpress-juno |
Yes |
| FSL ls1021a | PLATFORM=ls-ls1021atwr |
? |
| FSL i.MX6 UltraLite EVK Board | PLATFORM=imx |
Yes |
| ARM Foundation FVP | PLATFORM=vexpress-fvp |
Yes |
| HiKey Board (HiSilicon Kirin 620) | PLATFORM=hikey |
Yes |
| MediaTek MT8173 EVB Board | PLATFORM=mediatek-mt8173 |
No |
| QEMU | PLATFORM=vexpress-qemu_virt |
Yes |
| STMicroelectronics b2120 - h310 / h410 | PLATFORM=stm-cannes |
No |
| STMicroelectronics b2020-h416 | PLATFORM=stm-orly2 |
No |
| Texas Instruments DRA7xx | PLATFORM=ti-dra7xx |
Yes |
For community users, we suggest using HiKey board as development board. It provides detailed documentation including chip datasheet, board schematics, source code, binaries etc on the download link at the website.
There are a couple of different build options depending on the target you are going to use. If you just want to get the software and compile it, then you should follow the instructions under the "Basic setup" below. In case you are going to run for a certain hardware or FVP, QEMU for example, then please follow the respective section found below instead, having that said, we are moving from the shell script based setups to instead use repo, so for some targets you will see that we are using repo (section 5) and for others we are still using the shell script based setup (section 4), please see this transitions as work in progress.
We believe that you can use any Linux distribution to build OP-TEE, but as maintainers of OP-TEE we are mainly using Ubuntu-based distributions and to be able to build and run OP-TEE there are a few packages that needs to be installed to start with. Therefore install the following packages regardless of what target you will use in the end.
$ sudo apt-get install android-tools-fastboot autoconf bison cscope curl \
flex gdisk libc6:i386 libfdt-dev libglib2.0-dev \
libpixman-1-dev libstdc++6:i386 libz1:i386 netcat \
python-crypto python-serial uuid-dev xz-utils zlib1g-dev
We strive to use the latest available compiler from Linaro. Start by downloading
and unpacking the compiler. Then export the PATH to the compilers bin
folder.
$ cd $HOME
$ mkdir toolchains
$ cd toolchains
$ wget http://releases.linaro.org/14.08/components/toolchain/binaries/gcc-linaro-arm-linux-gnueabihf-4.9-2014.08_linux.tar.xz
$ tar xvf gcc-linaro-arm-linux-gnueabihf-4.9-2014.08_linux.tar.xz
$ export PATH=$HOME/toolchains/gcc-linaro-arm-linux-gnueabihf-4.9-2014.08_linux/bin:$PATH
$ cd $HOME
$ mkdir devel
$ cd devel
$ git clone https://github.com/OP-TEE/optee_os.git
$ cd $HOME/devel/optee_os
$ CROSS_COMPILE=arm-linux-gnueabihf- make
To be able to see the full command when building you could build using following flag:
$ make V=1
To enable debug builds use the following flag:
$ make DEBUG=1
OP-TEE supports a couple of different levels of debug prints for both TEE core itself and for the Trusted Applications. The level ranges from 1 to 4, where four is the most verbose. To set the level you use the following flag:
$ make CFG_TEE_CORE_LOG_LEVEL=4
Warning! This setup is currently broken, bl30.bin and bl33.bin doesn't
exist on the URLs stated any longer. We are working with a fix and once ready,
we will replace this section and instead put Juno board within the repo
section below. Until resolved, we will keep the information below for reference.
-
The script
setup_juno_optee.shscript provides a coherent set of components (OP-TEE client, driver, OS, Linux kernel version 3-16.0-rc5) -
Futures releases will align the Juno setup with other OP-TEE supported platforms:
- Linux kernel version alignment (3.18-rc1) with QEMU/FVP (DMA_BUF API change).
- Will need arch/arm/Kconfig patch(es) (i.e DMA_SHARED_BUFFER etc...).
-
Temporary patch files required for linux kernel and Juno DTB definition (found in the
./scriptsfolder)config.linux-linaro-tracking.a226b22057c22b433caafc58eeae6e9b13ac6c8d.patchjuno.dts.linux-linaro-tracking.a226b22057c22b433caafc58eeae6e9b13ac6c8d.patch
-
Download pre-built binaries (please see "Known issues" below)
- Juno boards pre-built binary
bl30.bin(SCP runtime) - Juno boards pre-built binary
bl33.bin(UEFI) - Download at → https://releases.linaro.org/members/arm/platforms/latest
- Juno boards pre-built binary
$ wget https://raw.githubusercontent.com/OP-TEE/optee_os/master/scripts/setup_juno_optee.sh
$ chmod 711 setup_juno_optee.sh
$ ./setup_juno_optee.sh
List of helper scripts generated during installation:
| Script | Explanation |
|---|---|
build_atf_opteed.sh |
This is used to build ARM-Trusted-Firmware and must be called when you have updated any component that are included in the FIP (like for example OP-TEE os). |
build_linux.sh |
This is used to build the Linux Kernel. |
build_normal.sh |
This is a pure helper script that build all the normal world components (in correct order). |
build_optee_client.sh |
This will build OP-TEEs client library. |
build_optee_linuxdriver.sh |
This will build OP-TEEs Linux Kernel driver (as a module). |
build_optee_os.sh |
Builds the Trusted OS itself |
build_optee_tests.sh |
This will build the test suite (pay attention to the access needed). |
build_secure.sh |
This is the helper script for the secure side that will build all secure side components in the correct order. |
clean_gits.sh |
This will clean all gits. Beware that it will not reset the commit to the one used when first cloning. Also note that it will only clean git's. |
Run the scripts in the following order:
$ ./build_secure.sh
$ ./build_normal.sh
-
Update the embedded flash memory (path:
JUNO/SOFTWARE):bl1.binfip.binImagejuno.dtb
-
Copy OP-TEE binaries on the filesystem(*) located on the external USB key:
- user client libraries:
libteec.so* - supplicant:
tee-supplicant - driver modules:
optee.ko optee_armtz.ko - CA:
xtest - TAs:
*.ta
- user client libraries:
-
Connect the USB flash drive (containing the filesystem) on any connector of the rear panel
-
Connect a serial terminal (
115200, 8, n, 1) to the upper 9-pin (UART0) connector. -
Connect the 12V power, then press the red button on the rear panel.
Note:
The default configuration is to automatically boot a Linux kernel, which expects
to find a root filesystem on /dev/sda1 (any one of the rear panel USB ports).
Download a minimal filesytem at → http://releases.linaro.org/14.02/openembedded/aarch64/linaro-image-minimal-genericarmv8-20140223-649.rootfs.tar.gz
UEFI offers a 10 second window to interrupt the boot sequence by pressing a key on the serial terminal, after which the kernel is launched.
Once booted you will get the prompt:
root@genericarmv8:~#
Write in the console:
root@genericarmv8:~# modprobe optee_armtz
root@genericarmv8:~# tee-supplicant &
Now everything has been set up and OP-TEE is ready to be used.
bl30.bin(SCP) andbl33.bin(UEFI) are not available on previous download location and therefore this setup is currently not working. We are working with sorting out this issue and once done, we will start using repo manifests for Juno also.- Not all USB flash drives seems to work, so we recommend using USB memory 3.0 formatted with an ext3/ext4 filesystem
Currently OP-TEE is supported on Orly-2 (b2020-h416) and Cannes family
(b2120 both h310 and h410 chip).
Will be written soon.
See section "4.2.2 Download the source code".
For Orly-2 do as follows
$ PLATFORM=stm-orly2 CROSS_COMPILE=arm-linux-gnueabihf- make
For Cannes family do as follows
$ PLATFORM=stm-cannes CROSS_COMPILE=arm-linux-gnueabihf- make
Will be written soon.
Will be written soon.
Important! All A80 boards sold to the general public are boards where secure side has been locked down, which means that you cannot use them for secure side development, i.e, it will not be possible to put OP-TEE on those devices. If you want to use A80 board for secure side development, then you will need to talk to Allwinner directly and ask if it is possible get a device from them.
Follow the instructions in the "4.2 Basic setup".
$ cd optee_os
$ export PLATFORM=sunxi
$ export CROSS_COMPILE=arm-linux-gnueabihf-
$ make
Download Allwinner A80 platform SDK, the SDK refers to Allwinner A80 platform SDK root directory. A80 SDK directory tree looks like this:
SDK/
Android
lichee
Android contains all source code related to Android and lichee
contains the bootloader and Linux kernel.
Copy the OP-TEE output binary to SDK/lichee/tools/pack/sun9i/bin
$ cd optee_os
$ cp ./out/arm32-plat-sunxi/core/tee.bin SDK/lichee/tools/pack/sun9i/bin
In the lichee directory, run the following commands:
$ cd SDK/lichee
$ ./build.sh
In the Android directory, run the following commands:
$ cd SDK/android
$ extract-bsp
$ make -j
In the Android directory, run the following commands:
$ cd SDK/android
$ pack
The output image will been signed internally when packed. The output image name
is a80_android_board.img.
Use Allwinner PhoenixSuit tool to download to A80 board.
Choose the output image(a80_android_board.img), select download and wait
for the download to complete.
When the host platform is Windows, use a console application to connect A80
board uart0. In the console window, You can install OP-TEE linux kernel
driver optee.ko, load OP-TEE-Client daemon tee-supplicant and run
the example "hello world" Trusted Application, do this by running:
$ insmod /system/vendor/modules/optee.ko
$ /system/bin/tee-supplicant &
$ /system/bin/tee-helloworld
Build:
PLATFORM_FLAVOR=mx6ulevk make PLATFORM=imx
${CROSS_COMPILE}-objcopy -O binary out/arm-plat-imx/core/tee.elf optee.bin
copy optee.bin to the first partition of SD card which is used for boot.
Run using U-Boot:
run loadfdt;
run loadimage;
fatload mmc 1:1 0x9c100000 optee.bin;
run mmcargs;
bootz ${loadaddr} - ${fdt_addr};
Note: CAAM is not implemented now, this will be added later.
A Git repository is available at https://github.com/OP-TEE/manifest where you will find XML-files for use with the Android 'repo' tool.
Follow the instructions under the "Installing Repo" section here.
First ensure that you have the necessary Ubuntu packages installed, see 4.1 Prerequisites (this is the only important step from section 4 in case you are setting up any of the target devices mentioned below).
$ mkdir -p $HOME/devel/optee
$ cd $HOME/devel/optee
$ repo init -u https://github.com/OP-TEE/manifest.git -m ${TARGET}.xml [-b ${BRANCH}]
$ repo sync
| Target | Latest | Stable |
|---|---|---|
| QEMU | default.xml |
default_stable.xml |
| FVP | fvp.xml |
fvp_stable.xml |
| HiKey | hikey.xml |
hikey_stable.xml |
| MediaTek MT8173 EVB Board | mt8173-evb.xml |
mt8173-evb_stable.xml |
Currently we are only using one branch, i.e, the master branch.
$ cd build
$ make toolchains
Notes
- The folder could be at any location, we are just giving a suggestion by
saying
$HOME/devel/optee. repo synccan take an additional parameter -j to sync multiple remotes. For examplerepo sync -j3will sync three remotes in parallel.
After getting the source and toolchain, just run (from the build folder)
$ make all run
and everything should compile and at the end QEMU should start.
After getting the source and toolchain you must also obtain Foundation Model
(link)
binaries and untar it to the forest root, then just run (from the build folder)
$ make all run
and everything should compile and at the end FVP should start.
After getting the source and toolchain, just run (from the build folder)
$ make all
After that connect the board and flash the binaries by running:
$ make flash
(more information about how to flash individual binaries could be found here)
The board is ready to be booted.
After getting the source and toolchain, just run (from the build folder)
$ make all run
When < waiting for device > prompt appears, press reset button and the
flashing procedure should begin.
Doing a repo init, repo sync from scratch can take a fair amount of time.
The main reason for that is simply because of the size of some of the gits we
are using, like for the Linux kernel and EDK2. With repo you can reference an
existing forest and by doing so you can speed up repo sync to instead taking ~20
seconds instead of an hour. The way to do this are as follows.
- Start by setup a clean forest that you will not touch, in this example, let
us call that
optee-refand put that under for$HOME/devel/optee-ref. This step will take roughly an hour. - Then setup a cronjob (
crontab -e) that does arepo syncin this folder particular folder once a night (that is more than enough). - Now you should setup your actual tree which you are going to use as your
working tree. The way to do this is almost the same as stated in the
instructions above, the only difference is that you reference the other local
forest when running
repo init, like thisrepo init -u https://github.com/OP-TEE/manifest.git --reference /home/jbech/devel/optee-ref - The rest is the same above, but now it will only take a couple of seconds to clone a forest.
Normally step 1 and 2 above is something you will only do once. Also if you ignore step 2, then you will still get the latest from official git trees, since repo will also check for updates that aren't at the local reference.
ccache is a tool that caches build object-files etc locally on the disc and can speed up build time significantly in subsequent builds. On Debian-based systems (Ubuntu, Mint etc) you simply install it by running:
$ sudo apt-get install ccache
The helper makefiles are configured to automatically find and use ccache if ccache is installed on your system, so other than having it installed you don't have to think about anything.
To actually run something on a device you need to probe the kernel driver for OP-TEE, run tee-supplicant. This is the same for almost all platforms, so when a device has booted, then run
$ modprobe optee_armtz
$ tee-supplicant &
In case you want to try run something triggering both normal and secure side code you could run xtest (the main test suite for OP-TEE), run
$ xtest
In this project we are trying to adhere to the same coding convention as used in the Linux kernel (see CodingStyle). We achieve this by running checkpatch from Linux kernel. However there are a few exceptions that we had to make since the code also follows GlobalPlatform standards. The exceptions are as follows:
- CamelCase for GlobalPlatform types are allowed.
- And we also exclude checking third party code that we might use in this project, such as LibTomCrypt, MPA, newlib (not in this particular git, but those are also part of the complete TEE solution). The reason for excluding and not fixing third party code is because we would probably deviate too much from upstream and therefore it would be hard to rebase against those projects later on (and we don't expect that it is easy to convince other software projects to change coding style).
Since checkpatch is licensed under the terms of GNU GPL License Version 2, we
cannot include this script directly into this project. Therefore we have
written the Makefile so you need to explicitly point to the script by exporting
an environment variable, namely CHECKPATCH. So, suppose that the source code for
the Linux kernel is at $HOME/devel/linux, then you have to export like follows:
$ export CHECKPATCH=$HOME/devel/linux/scripts/checkpatch.pl
thereafter it should be possible to use one of the different checkpatch targets in the Makefile. There are targets for checking all files, checking against latest commit, against a certain base-commit etc. For the details, read the Makefile.