OP-TEE的安装

前言

至于OP-TEE一些相关介绍我不罗嗦了。您可以去search。我仅翻译。

关于软件安装的文章，随着软件版本的更新迭代，最容易失效。
官网的安装过程最为可靠全面。这篇文章，翻译OP-TEE官网的安装过程，仅起引导作用。如果失效，建议去官网查看。

官网原文地址：https://optee.readthedocs.io/en/latest/building/gits/build.html

如有不对的地方，请指正。

---

正文

1、build

为什么是这个特别的git？事实证明，您完全有可能自己整理所有内容。您可以构建所有单独的组件，包括os，client，xtest，Linux kernel，TF-A，TianoCore，QEMU，Buildroot等，并将所有二进制文件放在正确的位置，并编写自己的命令行，Makefile，shell脚本等。在您感兴趣的设备上很好地工作。如果您知道该怎么做，很好，请加油。另外，如果出于某种原因，您想要以自动化方式运行某些程序，那么还需要其他一些方法来为您打包。

但设置一个工作环境，对于新手来说，并不友好。我们的目标是：有了这个特定的git build.git，新手可以快速使用我们在本文中列出的设备，开始使用OP-TEE之旅。

2、git location

https://github.com/OP-TEE/build

3、 Why repo?

我们讨论了替代方案：最初我们从一个简单的shell脚本开始。它最初有效，但是在使用了更多git和支持更多设备之后，就开始难以维护。 最后，我们在 repo fromGoogle AOSP和git submodules之间进行选择。 不管选择哪种方式，总会有人争论另一个更好。 对于我们来说，我们决定使用repo。 不是直接针对repo的功能本身，而是针对它可以简单地处理稳定和非稳定的 manifests 。 使用一些提示和技巧，还可以大大加快设置时间。 对于提交，分支等日常工作，我们倾向于直接使用git命令。

4、Root filesystem

我们在本文中介绍的构建中的rootfs尽可能小，它基于精简的Buildroot配置，在rootfs中添加的部分，仅能满足以下功能：

• Boot OP-TEE.
• Run xtest with no regressions.
• Easily add additional developer tools like, strace, valgrind etc.

note

由于仅有上面内容，基于非UART的环境可能无法立即使用。 也就是说，如果您尝试使用HDMI引导环境并连接键盘和其他设备，则可能无法正常工作。 为了使它们工作，您可能需要在启用了正确的驱动程序/框架，和在Buildroot中启用binaries/daemons的情况下重建Linux内（user space tools and drivers）。

5、How do I build using AOSP / OpenEmbedded?

有关如何构建AOSP的指南，请参阅我们的AOSP页面。 对于OpenEmbedded，我们尚未准备好指南，但是Linaro中有一些团队正在building OP-TEE using OpenEmbedded。 如果您想与他们联系，请与我们联系（请参阅Contact）。

6、Platforms supported by build.git

下表显示了build.git支持的平台。OP-TEE支持下面这些平台，还有一些其他平台是由Linaro以外的人维护，或正在使用特殊的设置。因此，如果您有任何相关的问题，我们建议您直接与该平台的维护者联系…… 请参阅MAINTAINERS文件以获取联系信息。

Platform	Composite flag	Publicly available?
ARM Juno Board	PLATFORM=vexpress-juno	Yes
ARM Foundation FVP	PLATFORM=vexpress-fvp	Yes
DeveloperBox	PLATFORM=synquacer	Yes
HiKey Kirin 620	PLATFORM=hikey	Yes
HiKey 960	PLATFORM=hikey-hikey960	Yes
MediaTek MT8173 EVB Board (deprecated)	PLATFORM=mediatek-mt8173	No
Poplar	PLATFORM=poplar	Yes
QEMU	PLATFORM=vexpress-qemu_virt	Yes
QEMUv8	PLATFORM=vexpress-qemu_armv8a	Yes
Raspberry Pi 3	PLATFORM=rpi3	Yes
Texas Instruments DRA7xx	PLATFORM=ti-dra7xx	Yes
Texas Instruments AM57xx	PLATFORM=ti-am57xx	Yes
Texas Instruments AM43xx	PLATFORM=ti-am43xx	Yes

7、Manifests

7.1 Current version

这是build.git中支持设备的 manifests。 有了这些，您将获得一个包含所有必要软件组件的设置，以在所选设备上运行OP-TEE。 请注意，这是运行OP-TEE gits上最新版本。这意味着如果您re-sync，则很可能会得到新的commit。 如果您需要一个 stable/tagged 版本，请改为参考下一节。

Target	Manifest xml	Device documentation
AM43xx	am43xx.xml	Texas Instruments SoCs
AM57xx	am57xx.xml	Texas Instruments SoCs
DeveloperBox	synquacer.xml	DeveloperBox
ARM Juno board	juno.xml	Juno
DRA7xx	dra7xx.xml	Texas Instruments SoCs
FVP	fvp.xml	FVP
HiKey 960	hikey960.xml	HiKey 960
HiKey	hikey.xml	HiKey 620
Poplar Debian	poplar.xml
QEMU	default.xml	QEMU v7
QEMUv8	qemu_v8.xml	QEMU v8
Raspberry Pi 3	rpi3.xml	Raspberry Pi 3

7.2 Stable releases

从OP-TEE v3.1开始，您可以使用与上述相同的 manifests 来check out稳定版本，但不同之处在于，还需要指定与发行版本相对应的分支,分支名与版本名相同。 即，当我们进行发布时，创建一个与发行版本相对应名称的分支。 因此，假设您要 check out Raspberry Pi 3的OP-TEE v3.4，您按照这样做，而不是待会下面“Step 3 - Get the source code”部分中提到的内容（注意 -b 3.4.0）：

$ repo init -u https://github.com/OP-TEE/manifest.git -m rpi3.xml -b 3.4.0

7.3 Stable releases prior to OP-TEE v3.1 (v1.0.0 to v3.0.0)

在OP-TEE v3.1之前，稳定版本的build有单独的 xml-manifest 。 如果出于某种原因需要较旧的稳定版本，则可以使用与设备相对应的xyz_stable.xml文件。 初始化repo的方式与上面描述的几乎相同，主要区别在于所引用 manifest 的名称（-m xyz_stable.xml)，并且我们引用的是 tag 而不是分支（-b refs/tags/MAJOR.MINOR.PATCH）。 举例来说，如果您需要为 安装 HiKey 2.1.0稳定版本，那么您会这样做，而不是待会下面“Step 3 - Get the source code”部分中提到的内容。

$ repo init -u https://github.com/OP-TEE/manifest.git -m hikey_stable.xml -b refs/tags/2.1.0

这是旧版本支持的Target列表和Stable manifest文件的名称：

Target	Stable manifest xml
AM43xx	am43xx_stable.xml
AM57xx	am57xx_stable.xml
ARM Juno board	juno_stable.xml
DRA7xx	dra7xx_stable.xml
FVP	fvp_stable.xml
HiKey 960	hikey960_stable.xml
HiKey Debian	hikey_debian_stable.xml
HiKey	hikey_stable.xml
MTK8173	mt8173-evb_stable.xml
QEMU	default_stable.xml
QEMUv8	qemu_v8_stable.xml
Raspberry Pi 3	rpi3_stable.xml

(译者注：不清楚这个target如何使用，但不推荐使用较旧的版本)

8、Get and build the solution

下面，我们将描述如何获取源代码，编译以及在设备上运行xtest。 有关设备的特定说明，请参阅“Current version”部分中表格中的链接。

8.1 Step 1 - Prerequisites

安装之前，根据 Prerequisites page 安装一些软件包安装。即

$ sudo apt-get install android-tools-adb android-tools-fastboot autoconf \
        automake bc bison build-essential ccache cscope curl device-tree-compiler \
        expect flex ftp-upload gdisk iasl libattr1-dev libc6:i386 libcap-dev \
        libfdt-dev libftdi-dev libglib2.0-dev libhidapi-dev libncurses5-dev \
        libpixman-1-dev libssl-dev libstdc++6:i386 libtool libz1:i386 make \
        mtools netcat python-crypto python3-crypto python-pyelftools \
        python3-pyelftools python-serial python3-serial rsync unzip uuid-dev \
        xdg-utils xterm xz-utils zlib1g-dev

注：
我们相信您可以使用任何Linux发行版来构建OP-TEE，但是作为OP-TEE的维护者，我们主要使用基于Ubuntu的发行版，并且为了能够构建和运行OP-TEE，需要一些软件包安装开始。因此，无论最终使用什么目标，都请安装以上软件包。

8.2 Step 2 - Install Android rep

请注意，这里您没有安装庞大的SDK，只是下载Python脚本并放入$ PATH中。 确切的 “install”
repo 的方法可以在Google repo 页面上找到。因此在继续之前，请按照那些说明进行操作。

8.3 Step 3 -Get the source code

选择与您要使用的平台相对应的manifest（请参阅“Current version”部分中的表。例如，如果您要使用Raspberry Pi3，则在下面的第3行中，$ {TARGET} .xml应为rpi3.xml）。 <optee-project>是您想要存储整个OP-TEE（开发人员设置） 的任何位置。

$ mkdir -p <optee-project>
$ cd <optee-project>
$ repo init -u https://github.com/OP-TEE/manifest.git -m ${TARGET}.xml [-b ${BRANCH}]
$ repo sync -j4 --no-clone-bundle

提示：
通过referencing现有的和本地保存的 repo，您可以节省大量时间。我们正在谈论在30秒而不是15-30分钟内执行repo sync（更多信息，请参见“ Tips and Tricks”）。

8.4 Step 4 - Get the toolchains

在OP-TEE中，我们针对不同的目标使用不同的 toolchains（取决于ARMv7-A ARMv8-A 64/32位解决方案）。 无论如何，首先通过以下方式下载工具链：

$ cd <optee-project>/build
$ make -j2 toolchains

8.5 Step 5 - Build the solution

我们已经配置了repo manifests。因此 repo 始终自动的将Makefile 符号链接（symlink）到正确设备的Makefile，这意味着您只需运行以下命令，即可开始构建(build)（仍在<optee-project> / build中）

$ make -j `nproc`

(译者注：不同的设备，对应不同的Makefile文件(eg:qume.mk)。而repo manifests的配置，使得Makefile软连接到特定设备的mk文件。使得操作统一。)

这步骤将花费一些时间，但是您可以通过启用 ccache 来加快后续构建(build)速度（再次参见“ Tips and Tricks”）。

注：
如果遇到构建(build)问题，则可以将整个构建(build)日志通过管道传输到文件中。这使得使用常规编辑器更容易搜索问题。 在这种情况下，也请避免使用-j标志，以便更轻松地了解事情发生的顺序。 要创建build.log文件，请执行以下操作：$ make 2>&1 | tee build.log

8.6 Step 6 - Flash the device

在 non-emulated 解决方案上（这意味着在运行QEMU-v7 / v8和FVP时不应执行此步骤），您将需要以某种方式 flash 软件。 我们已尝试将其“隐藏”在下面make target 中：

$ make flash

但是，由于某些设备比其他设备更难于刷新。因此参阅 Device specific information。 将此视为一般说明。

8.7 Step 7 - Boot up the device

对于特定于设备。（参见 Device specific information）

8.8 Step 8 - Load tee-supplicant

在大多数解决方案中，tee-supplicant已经运行（通过运行$ ps aux | grep tee-supplicant检查）。 如果它没有运行，请通过运行以下命令启动它：

$ tee-supplicant -d

注：
如果您是使用 manifest 创建，则无需修改任何OP-TEE / TEE内核驱动程序。因为它已经内置在我们设置中。

8.9 Step 9 - Run xtest

当您在之前进行build（编译/构建）时，整个xtest测试套件已部署完毕。即，通常无需手动复制任何二进制文件。 一切都已自动放入 Root filesystem文件系统中。 因此，要运行xtest，只需输入：

$ xtest

如果没有发现regressions / issues，则xtest应该以以下内容结尾：

...
+-----------------------------------------------------
23476 subtests of which 0 failed
67 test cases of which 0 failed
0 test case was skipped
TEE test application done!

提示：
有关运行xtest的其他方法，请参阅 optee_test 页面中的“Run xtestt”。

9 Tips and Tricks

9.1 Reference existing project to speed up repo sync

进行repo init，repo sync可能需要花费大量时间。 主要原因仅仅是因为我们正在使用的某些git较大，例如 Linux 内核和 EDK2。 使用 repo，您可以 reference an existing forest，这样可以将 repo sync 加快到30秒，而不是15-30分钟。 这样做的方法如下。

• 首先，设置一个 clean forest 。在本示例中，让我们将其称为optee-ref并将其放在$ HOME / devel / optee-ref下。 此步骤大约需要15到45分钟，具体取决于您与互联网的连接速度。

• 然后启动一个cronjob（crontab -e），它每晚在此文件夹特定的文件夹中执行一次repo sync。

• 现在，您应该设置将要用的working tree。 这样做的方式与上面的说明中所述几乎相同(see the “Step 3 - Get the source code” section)，唯一的区别是，在运行repo init时，您还引用了另一个本地 forest，就像这样

$ repo init -u https://github.com/OP-TEE/manifest.git --reference $HOME/devel/optee-ref

• 其余与上面相同，但是现在只需几秒钟即可克隆forest。

通常，上面的“ 1”和“ 2”只会执行一次。 同样，如果您忽略了步骤“ 2”，那么您仍将从官方git forest中获取最新消息，因为repo还将检查本地 reference 中没有的更新。

(译者注：这个方法我没有用过，猜测是使用定时任务拉取更新，在本地建立一个完整仓库，类容从本地拉取。具体的使用过程，不清楚。但是个好办法)

9.2 Use ccache

ccache 是一种工具，可将构建（build）的目标文件缓存在本地，并可在以后的构建（build）中大大加快构建时间。 在基于Debian的系统（Ubuntu，Mint等）上，只需运行以下命令即可安装：

$ sudo apt-get install ccache

如果在系统上安装了ccache，则build.git中的makefile配置为自动查找和使用ccache。因此除了安装它之外，您无需考虑任何其他事情。

---

译者(我de)安装过程

1、Environment

• Ubuntu 18.04 LTS

• QEMU v7

• OP-TEE 3.6

2、process

注意：确保每一步都正确无误，再往下执行

2.1 Prerequisites

sudo apt-get install android-tools-adb android-tools-fastboot autoconf \
        automake bc bison build-essential ccache cscope curl device-tree-compiler \
        expect flex ftp-upload gdisk iasl libattr1-dev libc6:i386 libcap-dev \
        libfdt-dev libftdi-dev libglib2.0-dev libhidapi-dev libncurses5-dev \
        libpixman-1-dev libssl-dev libstdc++6:i386 libtool libz1:i386 make \
        mtools netcat python-crypto python3-crypto python-pyelftools \
        python3-pyelftools python-serial python3-serial rsync unzip uuid-dev \
        xdg-utils xterm xz-utils zlib1g-dev    -y

2.2 Install Android repo

参见：清华源 Git Repo 镜像使用帮助

curl https://mirrors.tuna.tsinghua.edu.cn/git/git-repo -o repo
chmod +x repo

为了方便可以将其拷贝到你的PATH里。(注意不要与本地环境的repo”冲突“。请自行处理)

我直接使用 ./repo + 参数。

或者参考视频：Qemu中运行OP-TEE

2.3 Get the source code

$ mkdir -p <optee-project>
$ cd <optee-project>
$ repo init -u https://github.com/OP-TEE/manifest.git -m default.xml.xml -b 3.6 --repo-url=https://mirrors.tuna.tsinghua.edu.cn/git/git-repo 
$ repo sync -j4 --no-clone-bundle

请确保源码拉去完整。

2.4 Get the toolchains

$ cd <optee-project>/build
$ make -j2 toolchains

这一步，我当时失败过几次，可以分析qemu.mk内容，然后提取出来再命令行单独运行。

参考：Toolchains

所以我多做了下面这一步(我直接将它们放入~/.bashrc中，然后resource)

如果不执行下面命令，我不知道是否会有影响。

export PATH=$PATH:$HOME/toolchains/aarch32/bin:$HOME/toolchains/aarch64/bin

2.5 Build the solution

$ make -j `nproc`

编译报错，只能慢慢修改。

2.6 Load tee-supplicant

#检查是否已运行。我的已运行，不用加载
$ ps aux | grep tee-supplicant

2.7 Run xtest

#启动：在build目录下运行
make run
#按下 c 表继续
(qemu) c
# 在 normal world 中 用 test 登录
$ test
#进行测试
$ xtest 6001 

结果如下：

正确安装完成。

3、其他

• 按照配置文件，我上面两个终端名字应为Normal World 和 Secure World

  如上图所示，我的两个终端名字并非 Normal World 和 Secure World。（或许存在问题，但未知）

• 由于目前使用的是虚拟机，我并没有安装ccache。

• 我推荐使用Ubuntu 操作系统进行安装。我曾经尝试过使用Debian和Centos服务器安装，均没成功。

• 建议在网络稳定的地方进行安装。

• 在码云上有一些仓库，我并没有尝试过。

• docker for OP-TEE 或许也是不错的选择(并没有尝试过)。但是本地安装一遍，对于以后的移植或许会有帮助。

  

最后

• 9.1中关于git内容的翻译，可能不准确。因为我仅会git的简单操作，有些操作没有用过。可以去官网原文查看。
• 关于build的翻译，我采用了google翻译构建。如果是compile或许是编译更准确。
• 如有不对的地方，请指正。
• 2020/1/5 中雪
  
  （我特地跑出去，这冷~）