Skip to content

Commit 4297739

Browse files
mchehabJonathan Corbet
authored andcommitted
tee.txt: standardize document format
Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - adjust identation of titles; - mark ascii artwork as a literal block; - adjust references. Signed-off-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
1 parent 633b11b commit 4297739

File tree

1 file changed

+31
-22
lines changed

1 file changed

+31
-22
lines changed

Documentation/tee.txt

Lines changed: 31 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1+
=============
12
TEE subsystem
3+
=============
4+
25
This document describes the TEE subsystem in Linux.
36

47
A TEE (Trusted Execution Environment) is a trusted OS running in some
@@ -80,27 +83,27 @@ The GlobalPlatform TEE Client API [5] is implemented on top of the generic
8083
TEE API.
8184

8285
Picture of the relationship between the different components in the
83-
OP-TEE architecture.
84-
85-
User space Kernel Secure world
86-
~~~~~~~~~~ ~~~~~~ ~~~~~~~~~~~~
87-
+--------+ +-------------+
88-
| Client | | Trusted |
89-
+--------+ | Application |
90-
/\ +-------------+
91-
|| +----------+ /\
92-
|| |tee- | ||
93-
|| |supplicant| \/
94-
|| +----------+ +-------------+
95-
\/ /\ | TEE Internal|
96-
+-------+ || | API |
97-
+ TEE | || +--------+--------+ +-------------+
98-
| Client| || | TEE | OP-TEE | | OP-TEE |
99-
| API | \/ | subsys | driver | | Trusted OS |
100-
+-------+----------------+----+-------+----+-----------+-------------+
101-
| Generic TEE API | | OP-TEE MSG |
102-
| IOCTL (TEE_IOC_*) | | SMCCC (OPTEE_SMC_CALL_*) |
103-
+-----------------------------+ +------------------------------+
86+
OP-TEE architecture::
87+
88+
User space Kernel Secure world
89+
~~~~~~~~~~ ~~~~~~ ~~~~~~~~~~~~
90+
+--------+ +-------------+
91+
| Client | | Trusted |
92+
+--------+ | Application |
93+
/\ +-------------+
94+
|| +----------+ /\
95+
|| |tee- | ||
96+
|| |supplicant| \/
97+
|| +----------+ +-------------+
98+
\/ /\ | TEE Internal|
99+
+-------+ || | API |
100+
+ TEE | || +--------+--------+ +-------------+
101+
| Client| || | TEE | OP-TEE | | OP-TEE |
102+
| API | \/ | subsys | driver | | Trusted OS |
103+
+-------+----------------+----+-------+----+-----------+-------------+
104+
| Generic TEE API | | OP-TEE MSG |
105+
| IOCTL (TEE_IOC_*) | | SMCCC (OPTEE_SMC_CALL_*) |
106+
+-----------------------------+ +------------------------------+
104107

105108
RPC (Remote Procedure Call) are requests from secure world to kernel driver
106109
or tee-supplicant. An RPC is identified by a special range of SMCCC return
@@ -109,10 +112,16 @@ kernel are handled by the kernel driver. Other RPC messages will be forwarded to
109112
tee-supplicant without further involvement of the driver, except switching
110113
shared memory buffer representation.
111114

112-
References:
115+
References
116+
==========
117+
113118
[1] https://github.com/OP-TEE/optee_os
119+
114120
[2] http://infocenter.arm.com/help/topic/com.arm.doc.den0028a/index.html
121+
115122
[3] drivers/tee/optee/optee_smc.h
123+
116124
[4] drivers/tee/optee/optee_msg.h
125+
117126
[5] http://www.globalplatform.org/specificationsdevice.asp look for
118127
"TEE Client API Specification v1.0" and click download.

0 commit comments

Comments
 (0)