diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-07-12 09:06:20 -0400 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2017-07-14 15:58:14 -0400 |
| commit | 4297739f2b5d4693d9b9f9e3dffeecf2ae9f8081 (patch) | |
| tree | e174429e73bac0262e79658e264f6c3dbb69bace | |
| parent | 633b11bee40c37fed3e9384f04a889af32fb8cf1 (diff) | |
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 <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| -rw-r--r-- | Documentation/tee.txt | 53 |
1 files changed, 31 insertions, 22 deletions
diff --git a/Documentation/tee.txt b/Documentation/tee.txt index 718599357596..56ea85ffebf2 100644 --- a/Documentation/tee.txt +++ b/Documentation/tee.txt | |||
| @@ -1,4 +1,7 @@ | |||
| 1 | ============= | ||
| 1 | TEE subsystem | 2 | TEE subsystem |
| 3 | ============= | ||
| 4 | |||
| 2 | This document describes the TEE subsystem in Linux. | 5 | This document describes the TEE subsystem in Linux. |
| 3 | 6 | ||
| 4 | A TEE (Trusted Execution Environment) is a trusted OS running in some | 7 | 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 | |||
| 80 | TEE API. | 83 | TEE API. |
| 81 | 84 | ||
| 82 | Picture of the relationship between the different components in the | 85 | Picture of the relationship between the different components in the |
| 83 | OP-TEE architecture. | 86 | OP-TEE architecture:: |
| 84 | 87 | ||
| 85 | User space Kernel Secure world | 88 | User space Kernel Secure world |
| 86 | ~~~~~~~~~~ ~~~~~~ ~~~~~~~~~~~~ | 89 | ~~~~~~~~~~ ~~~~~~ ~~~~~~~~~~~~ |
| 87 | +--------+ +-------------+ | 90 | +--------+ +-------------+ |
| 88 | | Client | | Trusted | | 91 | | Client | | Trusted | |
| 89 | +--------+ | Application | | 92 | +--------+ | Application | |
| 90 | /\ +-------------+ | 93 | /\ +-------------+ |
| 91 | || +----------+ /\ | 94 | || +----------+ /\ |
| 92 | || |tee- | || | 95 | || |tee- | || |
| 93 | || |supplicant| \/ | 96 | || |supplicant| \/ |
| 94 | || +----------+ +-------------+ | 97 | || +----------+ +-------------+ |
| 95 | \/ /\ | TEE Internal| | 98 | \/ /\ | TEE Internal| |
| 96 | +-------+ || | API | | 99 | +-------+ || | API | |
| 97 | + TEE | || +--------+--------+ +-------------+ | 100 | + TEE | || +--------+--------+ +-------------+ |
| 98 | | Client| || | TEE | OP-TEE | | OP-TEE | | 101 | | Client| || | TEE | OP-TEE | | OP-TEE | |
| 99 | | API | \/ | subsys | driver | | Trusted OS | | 102 | | API | \/ | subsys | driver | | Trusted OS | |
| 100 | +-------+----------------+----+-------+----+-----------+-------------+ | 103 | +-------+----------------+----+-------+----+-----------+-------------+ |
| 101 | | Generic TEE API | | OP-TEE MSG | | 104 | | Generic TEE API | | OP-TEE MSG | |
| 102 | | IOCTL (TEE_IOC_*) | | SMCCC (OPTEE_SMC_CALL_*) | | 105 | | IOCTL (TEE_IOC_*) | | SMCCC (OPTEE_SMC_CALL_*) | |
| 103 | +-----------------------------+ +------------------------------+ | 106 | +-----------------------------+ +------------------------------+ |
| 104 | 107 | ||
| 105 | RPC (Remote Procedure Call) are requests from secure world to kernel driver | 108 | RPC (Remote Procedure Call) are requests from secure world to kernel driver |
| 106 | or tee-supplicant. An RPC is identified by a special range of SMCCC return | 109 | 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 | |||
| 109 | tee-supplicant without further involvement of the driver, except switching | 112 | tee-supplicant without further involvement of the driver, except switching |
| 110 | shared memory buffer representation. | 113 | shared memory buffer representation. |
| 111 | 114 | ||
| 112 | References: | 115 | References |
| 116 | ========== | ||
| 117 | |||
| 113 | [1] https://github.com/OP-TEE/optee_os | 118 | [1] https://github.com/OP-TEE/optee_os |
| 119 | |||
| 114 | [2] http://infocenter.arm.com/help/topic/com.arm.doc.den0028a/index.html | 120 | [2] http://infocenter.arm.com/help/topic/com.arm.doc.den0028a/index.html |
| 121 | |||
| 115 | [3] drivers/tee/optee/optee_smc.h | 122 | [3] drivers/tee/optee/optee_smc.h |
| 123 | |||
| 116 | [4] drivers/tee/optee/optee_msg.h | 124 | [4] drivers/tee/optee/optee_msg.h |
| 125 | |||
| 117 | [5] http://www.globalplatform.org/specificationsdevice.asp look for | 126 | [5] http://www.globalplatform.org/specificationsdevice.asp look for |
| 118 | "TEE Client API Specification v1.0" and click download. | 127 | "TEE Client API Specification v1.0" and click download. |