add README for tzdriver

Signed-off-by: suwanghw <wangsu14@huawei.com>
2026-08-26 17:16:37 -04:00 · 2023-12-29 11:44:08 +08:00
parent 029a1760dc
commit 8071d18088
5 changed files with 157 additions and 0 deletions
@@ -96,6 +96,7 @@ Note:If the text contains special characters, please escape them according to th
 				<filteritem type="filepath" name="xpm/figures/.*"/>
 				<filteritem type="filepath" name="qos_auth/figures/.*"/>
 				<filteritem type="filepath" name="ucollection/figures/.*"/>
+				<filteritem type="filepath" name="tzdriver/figures/.*"/>
 			</filefilter>
 		</filefilterlist>
 	</oatconfig>
@@ -0,0 +1,78 @@
+# Tzdriver driver
+
+## Introduction
+
+Tzdriver is a kernel driver deployed on the REE side, supporting communication between REE and TEE. Tzdriver processes commands from Tee Client and sends instructions to switch from REE to TEE. Tzdriver supports data sharing between REE and TEE by managing shared memory.
+
+Tzdriver includes the following main modules:
+
+smc: Send smc instructions to switch the CPU from the REE side to the TEE side for operation.
+
+session_manager: Manage communication sessions between REE and TEE.
+
+mailbox：Data is shared between REE and TEE through the mailbox.
+
+cmd_monitor：Monitor the operation of SMC instructions and provides a timeout detection mechanism.
+
+tzdebug：Create debugfs debugging nodes to facilitate developers in debugging TEE functionality
+
+tlogger：TEE log driver module, supporting TEE log recording and printing.
+
+Figure 1: Tzdriver architecture diagram
+
+![](figures/tzdriver.drawio_en.png)
+
+## Directory
+
+```
+/kernel/linux/common_modules/tzdriver
+├── core
+│   ├── cmdmonitor.c                # SMC instruction execution monitoring
+    ├── gp_ops.c                    # GP TEE specification processing logic
+    ├── mailbox_mempool.c           # REE and TEE shared memory management
+    ├── session_manager.c           # Session management for CA access to TA
+    ├── smc_smp.c                   # Send SMC command to switch to TEE
+    ├── tzdebug.c                   # Debugging module
+├── tlogger                         # TEE log driver
+```
+
+## Configuration Option
+
+If you want to enable the Tzdriver driver, you need to modify the defconfig file of the device in the Linux kernel code repository and add configuration options for Tzdriver:
+
+```
+#
+# TEEOS
+#
+CONFIG_TZDRIVER=y
+CONFIG_CPU_AFF_NR=1
+CONFIG_KERNEL_CLIENT=y
+CONFIG_TEELOG=y
+CONFIG_PAGES_MEM=y
+CONFIG_THIRDPARTY_COMPATIBLE=y
+```
+
+The meanings of each option are shown in the table below:
+
+**Table 1** Configuration Options Description
+
+| Parameters                        | Description                                                       |
+| ---------------------------- | ------------------------------------------------------------ |
+| CONFIG_TZDRIVER              | Tzdriver module switch.                                            |
+| CONFIG_CPU_AFF_NR            | CA binding core function, non-zero values represent restrictions on CPUID less than CONFIG_ CPU_ AFF_ NR's CPU can enter TEE, where 0 represents unlimited. Currently, Tzdriver only supports running on 0 cores, so the value is 1. |
+| CONFIG_KERNEL_CLIENT         | Support the kernel CA option.                                               |
+| CONFIG_TEELOG                | TEE log switch, it is recommended to enable.                                 |
+| CONFIG_PAGES_MEM             | TEE log memory management, it is recommended to enable.                        |
+| CONFIG_THIRDPARTY_COMPATIBLE | Used for compatibility with third-party optee, such as the RK3568 chip, which requires this option to be enabled. |
+
+## Compile Command
+
+Tzdriver is compiled together with the kernel. Taking the rk3568 chip as an example, the "boot_linux.img" can be compiled separately. The compilation command is as follows
+
+```
+./build.sh --product-name rk3568 --ccache --build-target kernel --gn-args linux_kernel_version=\"linux-5.10\"
+```
+
+## Related code repository
+
+[tee_client](https://gitee.com/openharmony/tee_tee_client)
@@ -0,0 +1,78 @@
+# Tzdriver驱动
+
+## 简介
+
+Tzdriver是部署在REE侧的内核驱动，支持REE和TEE之间通信。Tzdriver处理来自于Tee Client的命令，发送指令从REE切换到TEE。Tzdriver通过管理共享内存，支持REE和TEE之间共享数据。
+
+Tzdriver驱动包含如下主要模块：
+
+smc：发送smc指令，将CPU从REE侧切换到TEE侧运行。
+
+session_manager：管理REE与TEE之间的通信会话。
+
+mailbox：REE和TEE之间通过mailbox共享数据。
+
+cmd_monitor：监控smc指令的运行，提供超时检测机制。
+
+tzdebug：创建debugfs调试节点，方便开发人员调试TEE功能。
+
+tlogger：TEE日志驱动模块，支持TEE日志记录和打印。
+
+图1 Tzdriver驱动架构图
+
+![](figures/tzdriver.drawio.png)
+
+## 目录
+
+```
+/kernel/linux/common_modules/tzdriver
+├── core
+│   ├── cmdmonitor.c                # smc指令执行监控
+    ├── gp_ops.c                    # GP TEE规范处理逻辑
+    ├── mailbox_mempool.c           # REE和TEE共享内存管理
+    ├── session_manager.c           # CA访问TA的session管理
+    ├── smc_smp.c                   # 发送smc指令切换到TEE
+    ├── tzdebug.c                   # 调试模块
+├── tlogger                         # TEE日志驱动
+```
+
+## 配置选项
+
+如果要使能Tzdriver驱动，需要修改linux内核代码仓中设备的defconfig文件，增加Tzdriver的配置选项：
+
+```
+#
+# TEEOS
+#
+CONFIG_TZDRIVER=y
+CONFIG_CPU_AFF_NR=1
+CONFIG_KERNEL_CLIENT=y
+CONFIG_TEELOG=y
+CONFIG_PAGES_MEM=y
+CONFIG_THIRDPARTY_COMPATIBLE=y
+```
+
+各选项其含义如下表所示：
+
+**表 1** 配置选项说明
+
+| 参数                         | 说明                                                         |
+| ---------------------------- | ------------------------------------------------------------ |
+| CONFIG_TZDRIVER              | Tzdriver模块开关。                                             |
+| CONFIG_CPU_AFF_NR            | CA绑核功能，非零值代表限制仅cpuid小于CONFIG_CPU_AFF_NR的CPU可以进入TEE，0代表无限制，当前只支持在0核运行，所以值为1。 |
+| CONFIG_KERNEL_CLIENT         | 支持内核CA选项。                                               |
+| CONFIG_TEELOG                | TEE日志开关，建议开启。                                    |
+| CONFIG_PAGES_MEM             | TEE日志内存管理，建议开启。                                |
+| CONFIG_THIRDPARTY_COMPATIBLE | 兼容第三方opteed的适配，例如适配RK3568芯片需要开启此选项。     |
+
+## 编译命令
+
+Tzdriver驱动跟随kernel一起编译，以rk3568为例，可以单独编译boot_linux.img，编译命令如下
+
+```
+./build.sh --product-name rk3568 --ccache --build-target kernel --gn-args linux_kernel_version=\"linux-5.10\"
+```
+
+## 相关仓
+
+[tee_client](https://gitee.com/openharmony/tee_tee_client)