From patchwork Thu Aug 23 10:43:27 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jens Wiklander X-Patchwork-Id: 144913 Delivered-To: patches@linaro.org Received: by 2002:a2e:1648:0:0:0:0:0 with SMTP id 8-v6csp30626ljw; Thu, 23 Aug 2018 03:43:51 -0700 (PDT) X-Received: by 2002:a2e:3c1a:: with SMTP id j26-v6mr7142924lja.149.1535021031666; Thu, 23 Aug 2018 03:43:51 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1535021031; cv=none; d=google.com; s=arc-20160816; b=EcrdxsqHPuaRr9gzVMdQeTZktIMeawikxgKyl1/NmcqSHTav1q+kzecO3ZF3Tbe/0D G+YvxHsGJNXGfAdOx17daQIDegX2hQn8lVvlbgJDX5C8ICwsKGeLR0YwWoBCek5tVj1u MCinYc90/fNwPEItP0bpwmIeuIC4tkl9FcDpGLnR9+p1NOW7x0UrvJcKUnWXhEqDF6yL bHf90DtYoBMcTb12jo/1tfOUTxUexdKHhCPcdQLFNEhh3C4p9rIlBqzh1WKtjms1hrHM m/iSPao+05JdgXclgOJO48OltWmpy8nfQMcsR47w7WOhXb0gwjW7ylkVkvdlJYsxb3l3 9b9w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature:arc-authentication-results; bh=mOlAzX4rskDe688TGp+DOEy7nGfsRMcytWGRg/6ByEQ=; b=xGfW0Hol/tfcCVSg2r27w6E9kytaYTPDbUNZfkwzV5Qhk59eUgpG63ALylDh5lPT0Y mm2LjGtV0PjHpOLZ96QNutEdR5lnVdCBkM6W+5zIz/QBGupwkdsRcUYfPU9eXLAvCWmW 0LHbsXcfCVd4xs8gDa0N4/pc9/gU6MJSvA45vXT4m7mXiBSlgcb7ND+4yFjX4KS7LkhK 2QL4nEjXJqwVUoTUZRVz0pv0wwA15bdLtBHn4pAu1jlo1bsLFsuqlSrNno+wNvfKkzFI fTntlVXc3PAoyXWMfjrUkiUNliAZWVcVkK7yrl3pPRV5HEWh9PD8vpsG7g7MAHkOGkqB FXBQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=SO0yq9SR; spf=pass (google.com: domain of jens.wiklander@linaro.org designates 209.85.220.41 as permitted sender) smtp.mailfrom=jens.wiklander@linaro.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from mail-sor-f41.google.com (mail-sor-f41.google.com. [209.85.220.41]) by mx.google.com with SMTPS id v17-v6sor835798ljd.90.2018.08.23.03.43.51 for (Google Transport Security); Thu, 23 Aug 2018 03:43:51 -0700 (PDT) Received-SPF: pass (google.com: domain of jens.wiklander@linaro.org designates 209.85.220.41 as permitted sender) client-ip=209.85.220.41; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=SO0yq9SR; spf=pass (google.com: domain of jens.wiklander@linaro.org designates 209.85.220.41 as permitted sender) smtp.mailfrom=jens.wiklander@linaro.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=mOlAzX4rskDe688TGp+DOEy7nGfsRMcytWGRg/6ByEQ=; b=SO0yq9SR9ThssQKmINzwDf3is+33Nltsl8BSg1b7QNh89LKVT0aRHsFstMp13HED0I 2pXGr1yROozIPAymS3VS0dtPEhQIludtfIDrZSLIkqKiDPLEe0BLef6x1ngApNbiaOXi AoShiPQRg2+/UeXGs5w2tdschNRmtQdSkeLwc= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=mOlAzX4rskDe688TGp+DOEy7nGfsRMcytWGRg/6ByEQ=; b=uFLdSJZSB8d6SHmDCYqTdKmia7UI2qagdy0uu22oJrv0f2baO056jHePA4JpBkHcUs yqeIcXcQFTf9jCDHfjBpK5WfYkAQVWnm5O43avpKVcvg8F2fokmgGZ/L22Qt/POLmNMg nPSrNkGa6JdcSMygyV8x/65rwBX5L7w6wf+/tmqXuDF0QOQcshBrSy7fcdJTm9E0blqE /ggGnZ5fLL0nVezDFjpBxpnNlS0yylf+W8keVbFZBvhec8wTlXCnVHeUb6NjTwoBilTi /ggLPHeJU4NAtQPPjv50jEhPbgio0SeUgiKVp5tMbqG5CinINAEminwkeJOGv5XowQgU akGA== X-Gm-Message-State: AOUpUlGKydRPwdZYsnPTaLbd6nD1wmjtquBj4KWHn5qrsqjOGTXjbI0C cJLAzQm70TFpCxquP7cPkq+lECnD X-Google-Smtp-Source: AA+uWPwYPBsMjPnZ4VWDPiyxLPPYhm6sVKw8ux6sApcypJqd0eOPJ7E5nvBmUdP7tQigKQwosIqUQw== X-Received: by 2002:a2e:8:: with SMTP id 8-v6mr39636895lja.112.1535021031378; Thu, 23 Aug 2018 03:43:51 -0700 (PDT) Return-Path: Received: from jax.ideon.se ([85.235.10.227]) by smtp.gmail.com with ESMTPSA id y5-v6sm679771ljj.75.2018.08.23.03.43.50 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 23 Aug 2018 03:43:50 -0700 (PDT) From: Jens Wiklander To: u-boot@lists.denx.de Cc: Simon Glass , Igor Opaniuk , Tom Rini , Jaehoon Chung , Pierre Aubert , Albert Aribaud , Peter Griffin , Michal Simek , Jens Wiklander Subject: [PATCH v2 08/15] Documentation: tee uclass and op-tee driver Date: Thu, 23 Aug 2018 12:43:27 +0200 Message-Id: <20180823104334.16083-9-jens.wiklander@linaro.org> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20180823104334.16083-1-jens.wiklander@linaro.org> References: <20180823104334.16083-1-jens.wiklander@linaro.org> Signed-off-by: Jens Wiklander --- doc/README.tee | 112 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 112 insertions(+) create mode 100644 doc/README.tee -- 2.17.1 Reviewed-by: Simon Glass diff --git a/doc/README.tee b/doc/README.tee new file mode 100644 index 000000000000..e9c9ef67877a --- /dev/null +++ b/doc/README.tee @@ -0,0 +1,112 @@ +============= +TEE uclass +============= + +This document describes the TEE uclass in U-boot + +A TEE (Trusted Execution Environment) is a trusted OS running in some +secure environment, for example, TrustZone on ARM CPUs, or a separate +secure co-processor etc. A TEE driver handles the details needed to +communicate with the TEE. + +This uclass deals with: + +- Registration of TEE drivers + +- Managing shared memory between U-boot and the TEE + +- Providing a generic API to the TEE + +The TEE interface +================= + +include/tee.h defines the generic interface to a TEE. + +A client finds the TEE device via tee_find_device(). Other important functions +when interfacing with a TEE are: + +- tee_shm_alloc(), tee_shm_register() and tee_shm_free() to manage shared + memory objects often needed when communicating with the TEE. + +- tee_get_version() lets the client know which the capabilities of the TEE + device. + +- tee_open_session() opens a session to a Trusted Application + +- tee_invoke_func() invokes a function in a Trusted Application + +- tee_close_session() closes a session to a Trusted Application + +Much of the communication between clients and the TEE is opaque to the +driver. The main job for the driver is to receive requests from the +clients, forward them to the TEE and send back the results. + +OP-TEE driver +============= + +The OP-TEE driver handles OP-TEE [1] based TEEs. Currently it is only the ARM +TrustZone based OP-TEE solution that is supported. + +Lowest level of communication with OP-TEE builds on ARM SMC Calling +Convention (SMCCC) [2], which is the foundation for OP-TEE's SMC interface +[3] used internally by the driver. Stacked on top of that is OP-TEE Message +Protocol [4]. + +OP-TEE SMC interface provides the basic functions required by SMCCC and some +additional functions specific for OP-TEE. The most interesting functions are: + +- OPTEE_SMC_FUNCID_CALLS_UID (part of SMCCC) returns the version information + which is then returned by TEE_IOC_VERSION + +- OPTEE_SMC_CALL_GET_OS_UUID returns the particular OP-TEE implementation, used + to tell, for instance, a TrustZone OP-TEE apart from an OP-TEE running on a + separate secure co-processor. + +- OPTEE_SMC_CALL_WITH_ARG drives the OP-TEE message protocol + +- OPTEE_SMC_GET_SHM_CONFIG lets the driver and OP-TEE agree on which memory + range to used for shared memory between Linux and OP-TEE. + +The GlobalPlatform TEE Client API [5] is implemented on top of the generic +TEE API. + +Picture of the relationship between the different components in the +OP-TEE architecture: + + U-boot Secure world + ~~~~~~ ~~~~~~~~~~~~ + +------------+ +-------------+ + | Client | | Trusted | + | | | Application | + +------------+ +-------------+ + /\ /\ + || || + \/ \/ + +------------+ +-------------+ + | TEE | | TEE Internal| + | uclass | | API | + +------------+ +-------------+ + | OP-TEE | | OP-TEE | + | driver | | Trusted OS | + +------------+-----------+-------------+ + | OP-TEE MSG | + | SMCCC (OPTEE_SMC_CALL_*) | + +--------------------------------------+ + +RPC (Remote Procedure Call) are requests from secure world to the driver. +An RPC is identified by a special range of SMCCC return values from +OPTEE_SMC_CALL_WITH_ARG. + +References +========== + +[1] https://github.com/OP-TEE/optee_os + +[2] http://infocenter.arm.com/help/topic/com.arm.doc.den0028a/index.html + +[3] drivers/tee/optee/optee_smc.h + +[4] drivers/tee/optee/optee_msg.h + +[5] http://www.globalplatform.org/specificationsdevice.asp look for + "TEE Client API Specification v1.0" and click download.