From patchwork Wed Jul 8 10:16:32 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jens Wiklander X-Patchwork-Id: 50869 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-lb0-f198.google.com (mail-lb0-f198.google.com [209.85.217.198]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 4027D22A03 for ; Wed, 8 Jul 2015 10:17:17 +0000 (UTC) Received: by lbbpo10 with SMTP id po10sf22823158lbb.1 for ; Wed, 08 Jul 2015 03:17:16 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:delivered-to:from:to:cc:subject :date:message-id:in-reply-to:references:x-original-sender :x-original-authentication-results:precedence:mailing-list:list-id :list-post:list-help:list-archive:list-unsubscribe; bh=AXaLj2YbF037Lmi4wY82xz+UaDT6pBsLSOtShOB6Gp4=; b=WVG2EF/BEnilh0MpxnkCnijF5PTluSUvnJ2unGe+vBJ7W7DqASeKPHJ0nu4lxWS/aA Q3AsvED14cli8qXGzjIvh+HzNkHZ56Kht1M3riWjXqLzxyB7acJKFKjPaGdWWpkwNLOR vOC6avJ6fDWfjJln2VSN493Q1Es0kpjT/ryrxnotib5RP2jrxwImZpcmWacFBN78iIhO t7iHMDWDek9vK3qUsRKqyXvUnkCGsJht9C/r+mvnNyCqxjXNuwaXvHl4djC54/akyri3 UBPdHBnL/bwkNsvCYj3F4Z7kmeDPeDk2q6j412UXreEW0859CoKM56l+DvwZ5xCAGTzo zqZg== X-Gm-Message-State: ALoCoQkeU2xLCxeqVVYSbDOan791cGvdBM6nR+gcY/bLHvr2+wqXkn1Ipfhr7GJP37t6DOZOHmci X-Received: by 10.112.42.236 with SMTP id r12mr4552216lbl.2.1436350636237; Wed, 08 Jul 2015 03:17:16 -0700 (PDT) MIME-Version: 1.0 X-BeenThere: patchwork-forward@linaro.org Received: by 10.153.5.35 with SMTP id cj3ls937530lad.7.gmail; Wed, 08 Jul 2015 03:17:16 -0700 (PDT) X-Received: by 10.152.28.73 with SMTP id z9mr8562312lag.93.1436350636092; Wed, 08 Jul 2015 03:17:16 -0700 (PDT) Received: from mail-la0-f54.google.com (mail-la0-f54.google.com. [209.85.215.54]) by mx.google.com with ESMTPS id ci2si1564689lbd.65.2015.07.08.03.17.16 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 08 Jul 2015 03:17:16 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.54 as permitted sender) client-ip=209.85.215.54; Received: by lagx9 with SMTP id x9so221979936lag.1 for ; Wed, 08 Jul 2015 03:17:16 -0700 (PDT) X-Received: by 10.152.5.228 with SMTP id v4mr1318649lav.36.1436350635941; Wed, 08 Jul 2015 03:17:15 -0700 (PDT) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patches@linaro.org Received: by 10.112.108.230 with SMTP id hn6csp2978665lbb; Wed, 8 Jul 2015 03:17:15 -0700 (PDT) X-Received: by 10.152.1.4 with SMTP id 4mr8700663lai.25.1436350632535; Wed, 08 Jul 2015 03:17:12 -0700 (PDT) Received: from mail-la0-f49.google.com (mail-la0-f49.google.com. [209.85.215.49]) by mx.google.com with ESMTPS id a4si1222633lak.156.2015.07.08.03.17.12 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 08 Jul 2015 03:17:12 -0700 (PDT) Received-SPF: pass (google.com: domain of jens.wiklander@linaro.org designates 209.85.215.49 as permitted sender) client-ip=209.85.215.49; Received: by laar3 with SMTP id r3so222534603laa.0 for ; Wed, 08 Jul 2015 03:17:12 -0700 (PDT) X-Received: by 10.152.87.70 with SMTP id v6mr128143laz.98.1436350632402; Wed, 08 Jul 2015 03:17:12 -0700 (PDT) Received: from ermac.urgonet (90-224-161-10-no121.tbcn.telia.com. [90.224.161.10]) by smtp.gmail.com with ESMTPSA id br6sm472819lbb.45.2015.07.08.03.17.10 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 08 Jul 2015 03:17:11 -0700 (PDT) From: Jens Wiklander To: linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org, devicetree@vger.kernel.org, Arnd Bergmann , Greg Kroah-Hartman , Rob Herring Cc: Herbert Xu , valentin.manea@huawei.com, jean-michel.delorme@st.com, emmanuel.michel@st.com, javier@javigon.com, Jason Gunthorpe , Mark Rutland , Michal Simek , Jens Wiklander Subject: [PATCH v4 5/5] Documentation: tee subsystem and op-tee driver Date: Wed, 8 Jul 2015 12:16:32 +0200 Message-Id: <1436350592-7732-6-git-send-email-jens.wiklander@linaro.org> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1436350592-7732-1-git-send-email-jens.wiklander@linaro.org> References: <1436350592-7732-1-git-send-email-jens.wiklander@linaro.org> X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: jens.wiklander@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.54 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Precedence: list Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org List-ID: X-Google-Group-Id: 836684582541 List-Post: , List-Help: , List-Archive: List-Unsubscribe: , Signed-off-by: Jens Wiklander --- Documentation/00-INDEX | 2 + Documentation/tee.txt | 117 +++++++++++++++++++++++++++++++++++++++++++++++++ MAINTAINERS | 1 + 3 files changed, 120 insertions(+) create mode 100644 Documentation/tee.txt diff --git a/Documentation/00-INDEX b/Documentation/00-INDEX index cd077ca..bd3f803 100644 --- a/Documentation/00-INDEX +++ b/Documentation/00-INDEX @@ -435,6 +435,8 @@ sysrq.txt - info on the magic SysRq key. target/ - directory with info on generating TCM v4 fabric .ko modules +tee.txt + - info on the TEE subsystem and drivers this_cpu_ops.txt - List rationale behind and the way to use this_cpu operations. thermal/ diff --git a/Documentation/tee.txt b/Documentation/tee.txt new file mode 100644 index 0000000..4ac91d2 --- /dev/null +++ b/Documentation/tee.txt @@ -0,0 +1,117 @@ +TEE subsystem +This document describes the TEE subsystem in Linux + +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 subsystem deals with: + +- Registration of TEE drivers + +- Managing shared memory between Linux and the TEE + +- Providing a generic API to the TEE + +The TEE interface +================= + +include/uapi/linux/tee.h defines the generic interface to a TEE. + +User space (the client) connects to the driver by opening /dev/tee[0-9]* or +/dev/teepriv[0-9]*. + +- TEE_IOC_SHM_ALLOC allocates shared memory and returns a file descriptor which + user space can mmap. When user space doesn't need the file descriptor anymore + it should be closed. When shared memory isn't needed any longer it should be + unmapped with munmap() to allow the reuse of memory. + +- TEE_IOC_VERSION lets user space know which TEE this driver handles and + the its capabilities. + +- TEE_IOC_OPEN_SESSION opens a new session to a Trusted Application + +- TEE_IOC_INVOKE invokes a function in a Trusted Application + +- TEE_IOC_CANCEL may cancel an ongoing TEE_IOC_OPEN_SESSION or TEE_IOC_INVOKE + +- TEE_IOC_CLOSE_SESSION closes a session to a Trusted Application + +There are two classes of clients, normal clients and supplicants. The latter is +a helper process for the TEE to access resources in Linux, for example file +system access. A normal client opens /dev/tee[0-9]* and a supplicant opens +/dev/teepriv[0-9]. + +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. In the case of +supplicants the communication goes in the other direction, the TEE sends +requests to the supplicant which then sends back the result. + +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. + + User space Kernel Secure world + ~~~~~~~~~~ ~~~~~~ ~~~~~~~~~~~~ + +--------+ +-------------+ + | Client | | Trusted | + +--------+ | Application | + /\ +-------------+ + || +----------+ /\ + || |tee- | || + || |supplicant| \/ + || +----------+ +-------------+ + \/ /\ | TEE Internal| + +-------+ || | API | + + TEE | || +--------+--------+ +-------------+ + | Client| || | TEE | OP-TEE | | OP-TEE | + | API | \/ | subsys | driver | | Trusted OS | + +-------+----------------+----+-------+----+-----------+-------------+ + | Generic TEE API | | OP-TEE MSG | + | IOCTL (TEE_IOC_*) | | SMCCC (OPTEE_SMC_CALL_*) | + +-----------------------------+ +------------------------------+ + +RPC (Remote Procedure Call) are requests from secure world to kernel driver +or tee-supplicant. An RPC is identified by a special range of SMCCC return +values from OPTEE_SMC_CALL_WITH_ARG. RPC messages which are intended for the +kernel are handled by the kernel driver. Other RPC messages will be forwarded to +tee-supplicant without further involvement of the driver, except switching +shared memory buffer representation. + +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. diff --git a/MAINTAINERS b/MAINTAINERS index 2df3f03..a48d718 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -8646,6 +8646,7 @@ S: Maintained F: include/linux/tee_drv.h F: include/uapi/linux/tee.h F: drivers/tee/ +F: Documentation/tee.txt THUNDERBOLT DRIVER M: Andreas Noever