From patchwork Mon Oct 18 11:40:45 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Etienne Carriere X-Patchwork-Id: 12566093 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 676B0C433EF for ; Mon, 18 Oct 2021 11:44:12 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 2819360FD8 for ; Mon, 18 Oct 2021 11:44:12 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 2819360FD8 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:MIME-Version:List-Subscribe:List-Help: List-Post:List-Archive:List-Unsubscribe:List-Id:Message-Id:Date:Subject:Cc:To :From:Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To:References: List-Owner; bh=jQd0Oh4vdlyM6Fj/I4obWEwXptBy7173ch4e/EzsQLo=; b=wcNkYai2u4DDZ/ ODOw/YaXOKcKv4AsSpWLFGFbhYlSPbg/Kn29OuBczbHXLwLDmJ4eVlLP66JDt88CjS3UKKwFSLk51 q160ezCi8bw5uB6Zbwx2N3IwlAxwT9Qe9CSi1vvAoL5RITvCjaX45Gzp7gUPIhPBYI6oRO0HiYErX EFU3BlsS2/KJ3sEHiTo8LY86pm8ILwFV/nz/CPOxQoeoWquwAP7qqRoZIkpN5If16VGCH2/XGe68y NM2zjnLrn2nYNGdlZ/K0Th5a2Hn2aw6J4rGAZcb6KuzlIG/WAW5k1PElrpvBlZjdLWw+aPCvl63DZ zJTDwZarFvwe9bH0XD/w==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.94.2 #2 (Red Hat Linux)) id 1mcR2S-00FOlI-GJ; Mon, 18 Oct 2021 11:42:45 +0000 Received: from mail-wm1-x32e.google.com ([2a00:1450:4864:20::32e]) by bombadil.infradead.org with esmtps (Exim 4.94.2 #2 (Red Hat Linux)) id 1mcR11-00FO44-H1 for linux-arm-kernel@lists.infradead.org; Mon, 18 Oct 2021 11:41:18 +0000 Received: by mail-wm1-x32e.google.com with SMTP id g39so4326932wmp.3 for ; Mon, 18 Oct 2021 04:41:14 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id; bh=zPIojQ5RzeuaqadWrZEbZpzRMQdeFPgWbBMit52fPcI=; b=iCURnxjSOhHzfeFZMPq+Dv1DY6v6VIS3+6ETqypb9yCgscHKOnVOrAjPtOXGulwZZ2 yquC/Z7szQ0Pbn8pcuG2VwlscpvoQFBAow+6UllYlmDBMG6/iFxXQ9lFYt1MyLAjWlq6 BUmpKU3pHW5R0lbJNFXHAruQLO4gMIHiIgLqbvwSCbf7ciqBk4RAgSUdaw18GYyk1J1m NDyg3RV8Pr4iQu7EGa6rhrQ8BeuXTHex8Sr1n+EmVC9UHBICEYG4gYK1M4phkDGV8ci4 Sx6dx/uoqydpfWYpXElfxKfXAfrHNTWx4KjMxNiKLULnoYk+h1WKbi0zjFNbQXDJxo3H bzvQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=zPIojQ5RzeuaqadWrZEbZpzRMQdeFPgWbBMit52fPcI=; b=GVfSOamuqZge3tnFMfWt44JmTyw2ZGpGqpt+TRZu42mZH9jfqDzo4etzsZ3pDWwhux 7xXR9vcItZOFA6mmHdbu4BDCV+whB/7N16iam8RUOVxvJKJ9AOKNrPj+/yVJ3ak+k7pD fSyFgOhMlp0mfgatF3gbRRfWWS7gabQiNNstbRWK+fZAZVYZI3kFXkfFmw8ueSPMSR58 /rHEaOBraJE15eYIQCmtSnXffxab8olRlBFAffO9lBpJQArpmNo4Ku/49VdvBV+BL6sz RoGM5nBietgGWM9ZYUII8nBKX50/GPrRfs3TF5t71ADFRM/cboFNtSdE6ob1eezBL+4S Dpag== X-Gm-Message-State: AOAM533uIYbfhQYFX9Hu0HUlZ729xeQALAD8AtGd+8NaO77R5Bza/gsN /Af7dsU54KMYOAQRCt2PK6k7uA== X-Google-Smtp-Source: ABdhPJzmo20Ty+p4ZX0gCo3egFMPZJcbNMmW5ipqMgSzq8bz3svkpuRRIWcVRhAEXuO93/GkyzaueQ== X-Received: by 2002:a05:600c:1d1f:: with SMTP id l31mr42782729wms.44.1634557272930; Mon, 18 Oct 2021 04:41:12 -0700 (PDT) Received: from lmecxl0524.lme.st.com ([2a04:cec0:1042:58b3:f8bd:7b81:c866:9456]) by smtp.gmail.com with ESMTPSA id p18sm13595588wrt.54.2021.10.18.04.41.11 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 18 Oct 2021 04:41:12 -0700 (PDT) From: Etienne Carriere To: linux-kernel@vger.kernel.org Cc: linux-arm-kernel@lists.infradead.org, Sudeep Holla , Cristian Marussi , Vincent Guittot , Etienne Carriere , devicetree@vger.kernel.org, Rob Herring Subject: [PATCH v3 1/2] dt-bindings: arm: Add OP-TEE transport for SCMI Date: Mon, 18 Oct 2021 13:40:45 +0200 Message-Id: <20211018114046.25571-1-etienne.carriere@linaro.org> X-Mailer: git-send-email 2.17.1 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20211018_044115_605707_8A468D5F X-CRM114-Status: GOOD ( 11.11 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org Introduce compatible "linaro,scmi-optee" for SCMI transport channel based on an OP-TEE service invocation. The compatible mandates a channel ID defined with property "linaro,optee-channel-id". Cc: devicetree@vger.kernel.org Cc: Rob Herring Signed-off-by: Etienne Carriere --- Changes since v2: - Define mandatory property linaro,optee-channel-id - Rebased on yaml description file Changes since v1: - Removed modification regarding mboxes property description. --- .../bindings/firmware/arm,scmi.yaml | 44 +++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/Documentation/devicetree/bindings/firmware/arm,scmi.yaml b/Documentation/devicetree/bindings/firmware/arm,scmi.yaml index 5c4c6782e052..12154ecc081b 100644 --- a/Documentation/devicetree/bindings/firmware/arm,scmi.yaml +++ b/Documentation/devicetree/bindings/firmware/arm,scmi.yaml @@ -38,6 +38,9 @@ properties: The virtio transport only supports a single device. items: - const: arm,scmi-virtio + - description: SCMI compliant firmware with OP-TEE transport + items: + - const: linaro,scmi-optee interrupts: description: @@ -83,6 +86,11 @@ properties: description: SMC id required when using smc or hvc transports + linaro,optee-channel-id: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + Channel id required when using OP-TEE transports + protocol@11: type: object properties: @@ -195,6 +203,9 @@ patternProperties: minItems: 1 maxItems: 2 + linaro,optee-channel-id: + maxItems: 1 + required: - reg @@ -226,6 +237,16 @@ else: - arm,smc-id - shmem + else: + if: + properties: + compatible: + contains: + const: linaro,scmi-optee + then: + required: + - linaro,optee-channel-id + examples: - | firmware { @@ -340,7 +361,30 @@ examples: reg = <0x11>; #power-domain-cells = <1>; }; + }; + }; + + - | + firmware { + scmi { + compatible = "linaro,scmi-optee"; + linaro,optee-channel = <0>; + + #address-cells = <1>; + #size-cells = <0>; + + scmi_clk: protocol@14 { + reg = <0x14>; + #clock-cells = <1>; + }; + + scmi_dvfs: protocol@13 { + reg = <0x13>; + #clock-cells = <1>; + linaro,optee-channel = <1>; + shmem = <&cpu_scp_hpri0>; + }; }; }; From patchwork Mon Oct 18 11:40:46 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Etienne Carriere X-Patchwork-Id: 12566095 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id C1D47C433EF for ; Mon, 18 Oct 2021 11:44:47 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 8B28260F9D for ; Mon, 18 Oct 2021 11:44:47 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 8B28260F9D Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:MIME-Version:List-Subscribe:List-Help: List-Post:List-Archive:List-Unsubscribe:List-Id:References:In-Reply-To: Message-Id:Date:Subject:Cc:To:From:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=4JEGqromvkhSMcpO4R+WqdlXHQqv/gOfFNPQ7+qxaIc=; b=1a8HW0c2g0dJCc bcDoT/QMgK2i0O0z5tn28+AK6pj5Q1y9Xjpq0c2Om8WEhwhlZ/7DMkrvmRSy3ds/KUH5Rf1VNuFVo 3hv/z1Ndg/LdeuHXcnZ3LMXNIgrL6ZPoJEThxST4sfNB1GEz+IQtGLewyFGHhHYVXts8SZuaV7Lek ibqhLyZnXQvJv4qYatYwfLpRldgOZZ1fFMBseNlqDArtOvopHcx0nXdsuU1G9QKij1G8bK9OV5Z/o UKHoVc4JYA09DMifIMKPRwCC9Ww2BlkcWhCRducxpTe6DcH4he/JVABupCAa3P0XkoWjwO0geAuBl NTVCM0fMlY+5xHvjGs5A==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.94.2 #2 (Red Hat Linux)) id 1mcR2u-00FOzr-SK; Mon, 18 Oct 2021 11:43:13 +0000 Received: from mail-wr1-x429.google.com ([2a00:1450:4864:20::429]) by bombadil.infradead.org with esmtps (Exim 4.94.2 #2 (Red Hat Linux)) id 1mcR1G-00FOBl-Ur for linux-arm-kernel@lists.infradead.org; Mon, 18 Oct 2021 11:41:33 +0000 Received: by mail-wr1-x429.google.com with SMTP id e3so40540680wrc.11 for ; Mon, 18 Oct 2021 04:41:30 -0700 (PDT) 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=HU49kdSZlXfJsHh3n1FYDHKTTW2yz6H3NoV36qQXdWI=; b=pstQneN05iPy2bqRhu5mK6vZIJPmfPtpA9Kaue2yTOqPymSA2aSWcxGYNGI8fRGGiV QhZcJ4V1H9yRML/RA+Me0YsXT+x+YRyockvrBKvAizpk3uJ/2KCNVnJfqyQZsagODct+ rzsIs0Duc1EONteELAo0tFmFnkznBDqFHzDhTc6EUTRWavqvBYiO1hj9R+qt+SbdtxiE xwsW95V+xnmzd0exKI81b8QyK5aYlw6WbMLkLvzClRbXO+x8BAkSCng/6x07Vbj45loe Ke45CMiEx4S/YCb19q4dqC49d+6B+1YjZOagN+x/Ka0vnOMvjLWOGK49YvevybYzorg7 oZZQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=HU49kdSZlXfJsHh3n1FYDHKTTW2yz6H3NoV36qQXdWI=; b=xAkfTYaZYPsPj/rkM58y5y4hkvBU4aFJf0b5aTo9eqCJauuVrbcefq8pQ0ANQDKBn2 nINhBXCNwTtmJtJRbx3Vd+psay6YsETnA+OeuBr1ei0BuqvmUx3tQCOjbkUmOYZw/fKZ SVawA1cAAaOXutTDUprTRgdY156u2V5x/faePHlUlndj7Jy4odwAbRKUlTouiJe2S65J gi8hAGHYkLQAu8afZdJ8bxpLZTTbX4arX4dffD97EgAmDGF6yFXWMw9pEwF3fPpYe2HP EdMBt6e0WJ4G1u5pEvEM6b7iqQb6XYHH0LN1LicQVGMlQLNuX74ykV7otNFJRmQLXWy5 XzZA== X-Gm-Message-State: AOAM530wzvH7/IkSu2WqtHqtXojupT76wwTEUJlI0Gz+18QvvnlM7+r4 JXGLGMJ89SFzhwav75qX2eViEQ== X-Google-Smtp-Source: ABdhPJygNJX28fzovPbjDlb4rKe94Ah2VRzB8FFSpI41ijfUtuBJx9NEJt4Hf46ZxaFoXIUbNqHZ+g== X-Received: by 2002:adf:f1cd:: with SMTP id z13mr35400540wro.101.1634557289202; Mon, 18 Oct 2021 04:41:29 -0700 (PDT) Received: from lmecxl0524.lme.st.com ([2a04:cec0:1042:58b3:f8bd:7b81:c866:9456]) by smtp.gmail.com with ESMTPSA id p18sm13595588wrt.54.2021.10.18.04.41.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 18 Oct 2021 04:41:28 -0700 (PDT) From: Etienne Carriere To: linux-kernel@vger.kernel.org Cc: linux-arm-kernel@lists.infradead.org, Sudeep Holla , Cristian Marussi , Vincent Guittot , Etienne Carriere Subject: [PATCH v3 2/2] firmware: arm_scmi: Add optee transport Date: Mon, 18 Oct 2021 13:40:46 +0200 Message-Id: <20211018114046.25571-2-etienne.carriere@linaro.org> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20211018114046.25571-1-etienne.carriere@linaro.org> References: <20211018114046.25571-1-etienne.carriere@linaro.org> X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20211018_044131_059718_0402B977 X-CRM114-Status: GOOD ( 29.63 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org Add a new transport channel to the SCMI firmware interface driver for SCMI message exchange based on optee transport channel. The optee transport is realized by connecting and invoking OP-TEE SCMI service interface PTA. Optee transport support (CONFIG_ARM_SCMI_TRANSPORT_OPTEE) is default enabled when optee driver (CFG_OPTEE) is enabled. Effective optee transport is setup upon OP-TEE SCMI service discovery at optee device initialization. For this SCMI UUID is registered to the optee bus for probing. This is done at device_init initcall level, after optee bus initialization that is done at subsys_init level, as the scmi driver initialization. The optee transport can use a statically defined shared memory in which case SCMI device tree node defines it using an "arm,scmi-shmem" compatible phandle through property shmem. Alternatively, optee transport allocates the shared memory buffer from the optee driver when no shmem property is defined. The protocol used to exchange SCMI message over that shared memory is negotiated between optee transport driver and the OP-TEE service through capabilities exchange. OP-TEE SCMI service is integrated in OP-TEE since its release tag 3.13.0. The service interface is published in [1]. Link: [1] https://github.com/OP-TEE/optee_os/blob/3.13.0/lib/libutee/include/pta_scmi_client.h Cc: Cristian Marussi Cc: Sudeep Holla Signed-off-by: Etienne Carriere Reported-by: kernel test robot --- Changes since v2: - Rebase on for-next/scmi, based on Linux v5.15-rc1. - Implement support for dynamic and static shared memory. - Factorize some functions and simplify transport exit sequence. - Rename driver source file from optee_service.c to optee.c. No change since v1 --- drivers/firmware/arm_scmi/Kconfig | 12 + drivers/firmware/arm_scmi/Makefile | 1 + drivers/firmware/arm_scmi/common.h | 3 + drivers/firmware/arm_scmi/driver.c | 3 + drivers/firmware/arm_scmi/optee.c | 559 +++++++++++++++++++++++++++++ 5 files changed, 578 insertions(+) create mode 100644 drivers/firmware/arm_scmi/optee.c diff --git a/drivers/firmware/arm_scmi/Kconfig b/drivers/firmware/arm_scmi/Kconfig index 3d7081e84853..9107e249023c 100644 --- a/drivers/firmware/arm_scmi/Kconfig +++ b/drivers/firmware/arm_scmi/Kconfig @@ -77,6 +77,18 @@ config ARM_SCMI_TRANSPORT_VIRTIO If you want the ARM SCMI PROTOCOL stack to include support for a transport based on VirtIO, answer Y. +config ARM_SCMI_TRANSPORT_OPTEE + bool "SCMI transport based on OP-TEE service" + depends on OPTEE + select ARM_SCMI_HAVE_TRANSPORT + select ARM_SCMI_HAVE_SHMEM + default y + help + This enables the OP-TEE service based transport for SCMI. + + If you want the ARM SCMI PROTOCOL stack to include support for a + transport based on OP-TEE SCMI service, answer Y. + endif #ARM_SCMI_PROTOCOL config ARM_SCMI_POWER_DOMAIN diff --git a/drivers/firmware/arm_scmi/Makefile b/drivers/firmware/arm_scmi/Makefile index 1dcf123d64ab..ef66ec8ca917 100644 --- a/drivers/firmware/arm_scmi/Makefile +++ b/drivers/firmware/arm_scmi/Makefile @@ -6,6 +6,7 @@ scmi-transport-$(CONFIG_ARM_SCMI_TRANSPORT_MAILBOX) += mailbox.o scmi-transport-$(CONFIG_ARM_SCMI_TRANSPORT_SMC) += smc.o scmi-transport-$(CONFIG_ARM_SCMI_HAVE_MSG) += msg.o scmi-transport-$(CONFIG_ARM_SCMI_TRANSPORT_VIRTIO) += virtio.o +scmi-transport-$(CONFIG_ARM_SCMI_TRANSPORT_OPTEE) += optee.o scmi-protocols-y = base.o clock.o perf.o power.o reset.o sensors.o system.o voltage.o scmi-module-objs := $(scmi-bus-y) $(scmi-driver-y) $(scmi-protocols-y) \ $(scmi-transport-y) diff --git a/drivers/firmware/arm_scmi/common.h b/drivers/firmware/arm_scmi/common.h index dea1bfbe1052..82ff3c3a6d2d 100644 --- a/drivers/firmware/arm_scmi/common.h +++ b/drivers/firmware/arm_scmi/common.h @@ -421,6 +421,9 @@ extern const struct scmi_desc scmi_smc_desc; #ifdef CONFIG_ARM_SCMI_TRANSPORT_VIRTIO extern const struct scmi_desc scmi_virtio_desc; #endif +#ifdef CONFIG_OPTEE +extern const struct scmi_desc scmi_optee_desc; +#endif void scmi_rx_callback(struct scmi_chan_info *cinfo, u32 msg_hdr, void *priv); void scmi_free_channel(struct scmi_chan_info *cinfo, struct idr *idr, int id); diff --git a/drivers/firmware/arm_scmi/driver.c b/drivers/firmware/arm_scmi/driver.c index b406b3f78f46..06f0a9846c7e 100644 --- a/drivers/firmware/arm_scmi/driver.c +++ b/drivers/firmware/arm_scmi/driver.c @@ -1999,6 +1999,9 @@ static const struct of_device_id scmi_of_match[] = { #endif #ifdef CONFIG_ARM_SCMI_TRANSPORT_VIRTIO { .compatible = "arm,scmi-virtio", .data = &scmi_virtio_desc}, +#endif +#ifdef CONFIG_OPTEE + { .compatible = "linaro,scmi-optee", .data = &scmi_optee_desc }, #endif { /* Sentinel */ }, }; diff --git a/drivers/firmware/arm_scmi/optee.c b/drivers/firmware/arm_scmi/optee.c new file mode 100644 index 000000000000..e294cff37bea --- /dev/null +++ b/drivers/firmware/arm_scmi/optee.c @@ -0,0 +1,559 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Copyright (C) 2019-2021 Linaro Ltd. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "common.h" + +#define DRIVER_NAME "optee-scmi" + +enum optee_smci_pta_cmd { + /* + * PTA_SCMI_CMD_CAPABILITIES - Get channel capabilities + * + * [out] value[0].a: Capability bit mask (enum pta_scmi_caps) + * [out] value[0].b: Extended capabilities or 0 + */ + PTA_SCMI_CMD_CAPABILITIES = 0, + + /* + * PTA_SCMI_CMD_PROCESS_SMT_CHANNEL - Process SCMI message in SMT buffer + * + * [in] value[0].a: Channel handle + * + * Shared memory used for SCMI message/response exhange is expected + * already identified and bound to channel handle in both SCMI agent + * and SCMI server (OP-TEE) parts. + * The memory uses SMT header to carry SCMI meta-data (protocol ID and + * protocol message ID). + */ + PTA_SCMI_CMD_PROCESS_SMT_CHANNEL = 1, + + /* + * PTA_SCMI_CMD_PROCESS_SMT_CHANNEL_MESSAGE - Process SMT/SCMI message + * + * [in] value[0].a: Channel handle + * [in/out] memref[1]: Message/response buffer (SMT and SCMI payload) + * + * Shared memory used for SCMI message/response is a SMT buffer + * referenced by param[1]. It shall be 128 bytes large to fit response + * payload whatever message playload size. + * The memory uses SMT header to carry SCMI meta-data (protocol ID and + * protocol message ID). + */ + PTA_SCMI_CMD_PROCESS_SMT_CHANNEL_MESSAGE = 2, + + /* + * PTA_SCMI_CMD_GET_CHANNEL - Get channel handle + * + * SCMI shm information are 0 if agent expects to use OP-TEE regular SHM + * + * [in] value[0].a: Channel identifier + * [out] value[0].a: Returned channel handle + * [in] value[0].b: Requested capabilities mask (enum pta_scmi_caps) + */ + PTA_SCMI_CMD_GET_CHANNEL = 3, +}; + +/* + * Capabilities + */ +enum pta_scmi_caps { + PTA_SCMI_CAPS_NONE = 0, + /* + * Supports command using SMT header protocol (SCMI shmem) in shared + * memory buffers to carry SCMI protocol synchronisation information. + */ + PTA_SCMI_CAPS_SMT_HEADER = BIT(0), +}; + +/** + * struct optee_channel - Description of an OP-TEE SCMI channel + * + * @channel_id: OP-TEE channel ID used for this transport + * @mu: Mutex protection on channel access + * @tee_session: TEE session identifier + * @cinfo: SCMI channel information + * @shmem: Virtual base address of the shared memory + * @tee_shm: Reference to TEE shared memory or NULL if using static shmem + * @caps: OP-TEE SCMI channel capabilities + * @link: Reference in agent's channel list + */ +struct optee_channel { + u32 channel_id; + struct mutex mu; + u32 tee_session; + struct scmi_chan_info *cinfo; + struct scmi_shared_mem __iomem *shmem; + struct tee_shm *tee_shm; + enum pta_scmi_caps caps; + struct list_head link; +}; + +/** + * struct optee_agent - OP-TEE transport private data + * + * @dev: Device used for communication with TEE + * @tee_ctx: TEE context used for communication + * @caps: Supported channel capabilities + * @mu: Mutex for protection of @channel_list + * @channel_list: List of all created channels for the agent + */ +struct optee_agent { + struct device *dev; + struct tee_context *tee_ctx; + enum pta_scmi_caps caps; + struct mutex mu; + struct list_head channel_list; +}; + +/* There can be only 1 SCMI service in OP-TEE we connect to */ +static struct optee_agent *optee_private; + +/* Open a session toward SCMI OP-TEE service with REE_KERNEL identity */ +static int open_session(u32 *tee_session) +{ + struct device *dev = optee_private->dev; + struct tee_client_device *scmi_pta = to_tee_client_device(dev); + struct tee_ioctl_open_session_arg arg = { }; + int ret; + + memcpy(arg.uuid, scmi_pta->id.uuid.b, TEE_IOCTL_UUID_LEN); + arg.clnt_login = TEE_IOCTL_LOGIN_REE_KERNEL; + + ret = tee_client_open_session(optee_private->tee_ctx, &arg, NULL); + if (ret < 0 || arg.ret) { + dev_err(dev, "Can't open tee session: %d / %#x\n", ret, arg.ret); + + return -EOPNOTSUPP; + } + + *tee_session = arg.session; + + return 0; +} + +static void close_session(u32 tee_session) +{ + tee_client_close_session(optee_private->tee_ctx, tee_session); +} + +static int get_capabilities(void) +{ + struct optee_agent *agent = optee_private; + struct tee_ioctl_invoke_arg arg = { }; + struct tee_param param[1] = { }; + u32 tee_session; + int ret; + + ret = open_session(&tee_session); + if (ret) + return ret; + + arg.func = PTA_SCMI_CMD_CAPABILITIES; + arg.session = tee_session; + arg.num_params = 1; + + param[0].attr = TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_OUTPUT; + + ret = tee_client_invoke_func(agent->tee_ctx, &arg, param); + + close_session(tee_session); + + if (ret < 0 || arg.ret) { + dev_err(agent->dev, "Can't get capabilities: %d / %#x\n", ret, arg.ret); + + return -EOPNOTSUPP; + } + + agent->caps = param[0].u.value.a; + + if (!(agent->caps & PTA_SCMI_CAPS_SMT_HEADER)) { + dev_err(agent->dev, "OP-TEE SCMI PTA doesn't support SMT\n"); + + return -EOPNOTSUPP; + } + + return 0; +} + +static int get_channel(struct optee_channel *channel) +{ + struct device *dev = optee_private->dev; + struct tee_ioctl_invoke_arg arg = { }; + struct tee_param param[1] = { }; + unsigned int caps = PTA_SCMI_CAPS_SMT_HEADER; + int ret; + + arg.func = PTA_SCMI_CMD_GET_CHANNEL; + arg.session = channel->tee_session; + arg.num_params = 1; + + param[0].attr = TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INOUT; + param[0].u.value.a = channel->channel_id; + param[0].u.value.b = caps; + + ret = tee_client_invoke_func(optee_private->tee_ctx, &arg, param); + + if (ret || arg.ret) { + dev_err(dev, "Can't get channel with caps %#x: %d / %#x\n", caps, ret, arg.ret); + + return -EOPNOTSUPP; + } + + /* From now on use channel identifer provided by OP-TEE SCMI service */ + channel->channel_id = param[0].u.value.a; + channel->caps = caps; + + return 0; +} + +static int invoke_process_smt_channel(struct optee_channel *channel) +{ + struct tee_ioctl_invoke_arg arg = { }; + struct tee_param param[2] = { }; + int ret; + + arg.session = channel->tee_session; + param[0].attr = TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INPUT; + param[0].u.value.a = channel->channel_id; + + if (channel->tee_shm) { + const size_t msg_size = scmi_optee_desc.max_msg_size; + + param[1].attr = TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INOUT; + param[1].u.memref.shm = channel->tee_shm; + param[1].u.memref.size = msg_size; + arg.num_params = 2; + arg.func = PTA_SCMI_CMD_PROCESS_SMT_CHANNEL_MESSAGE; + } else { + arg.num_params = 1; + arg.func = PTA_SCMI_CMD_PROCESS_SMT_CHANNEL; + } + + ret = tee_client_invoke_func(optee_private->tee_ctx, &arg, param); + if (ret < 0 || arg.ret) { + dev_err(optee_private->dev, "Failed on channel %u: %d / %#x\n", + channel->channel_id, ret, arg.ret); + + return -EIO; + } + + return 0; +} + +static bool optee_chan_available(struct device *dev, int idx) +{ + u32 channel_id; + + return !of_property_read_u32_index(dev->of_node, "linaro,optee-channel-id", + idx, &channel_id); +} + +static int setup_dynamic_shmem(struct device *dev, struct optee_channel *channel) +{ + const size_t msg_size = scmi_optee_desc.max_msg_size; + + channel->tee_shm = tee_shm_alloc_kernel_buf(optee_private->tee_ctx, msg_size); + if (IS_ERR(channel->tee_shm)) { + dev_err(channel->cinfo->dev, "shmem allocation failed\n"); + return -ENOMEM; + } + + channel->shmem = (void *)tee_shm_get_va(channel->tee_shm, 0); + memset(channel->shmem, 0, msg_size); + shmem_clear_channel(channel->shmem); + + return 0; +} + +static int setup_static_shmem(struct device *dev, struct scmi_chan_info *cinfo, + struct optee_channel *channel) +{ + struct device_node *np; + resource_size_t size; + struct resource res; + int ret; + + np = of_parse_phandle(cinfo->dev->of_node, "shmem", 0); + if (!of_device_is_compatible(np, "arm,scmi-shmem")) { + ret = -ENXIO; + goto out; + } + + ret = of_address_to_resource(np, 0, &res); + if (ret) { + dev_err(dev, "Failed to get SCMI Tx shared memory\n"); + goto out; + } + + size = resource_size(&res); + + channel->shmem = devm_ioremap(dev, res.start, size); + if (!channel->shmem) { + dev_err(dev, "Failed to ioremap SCMI Tx shared memory\n"); + ret = -EADDRNOTAVAIL; + goto out; + } + + ret = 0; + +out: + of_node_put(np); + + return ret; +} + +static int optee_chan_setup_shmem(struct device *dev, struct scmi_chan_info *cinfo, + bool tx, struct optee_channel *channel) +{ + struct device *cdev = cinfo->dev; + + if (of_find_property(cdev->of_node, "shmem", NULL)) + return setup_static_shmem(dev, cinfo, channel); + else + return setup_dynamic_shmem(dev, channel); +} + +static void optee_clear_channel(struct scmi_chan_info *cinfo) +{ + struct optee_channel *channel = cinfo->transport_info; + + shmem_clear_channel(channel->shmem); +} + +static int optee_chan_setup(struct scmi_chan_info *cinfo, struct device *dev, bool tx) +{ + struct optee_channel *channel; + uint32_t channel_id; + int ret; + + if (!tx) + return -ENODEV; + + /* Shall wait for OP-TEE driver to be up and ready */ + if (!optee_private || !optee_private->tee_ctx) + return -EPROBE_DEFER; + + channel = devm_kzalloc(dev, sizeof(*channel), GFP_KERNEL); + if (!channel) + return -ENOMEM; + + ret = of_property_read_u32_index(cinfo->dev->of_node, "linaro,optee-channel-id", + 0, &channel_id); + if (ret) + return ret; + + cinfo->transport_info = channel; + channel->cinfo = cinfo; + channel->channel_id = channel_id; + mutex_init(&channel->mu); + + ret = optee_chan_setup_shmem(dev, cinfo, tx, channel); + if (ret) + return ret; + + ret = open_session(&channel->tee_session); + if (ret) + return ret; + + ret = get_channel(channel); + if (ret) { + close_session(channel->tee_session); + + return ret; + } + + mutex_lock(&optee_private->mu); + list_add(&channel->link, &optee_private->channel_list); + mutex_unlock(&optee_private->mu); + + return 0; +} + +static int optee_chan_free(int id, void *p, void *data) +{ + struct scmi_chan_info *cinfo = p; + struct optee_channel *channel = cinfo->transport_info; + + mutex_lock(&optee_private->mu); + list_del(&channel->link); + mutex_unlock(&optee_private->mu); + + if (channel->tee_shm) { + tee_shm_free(channel->tee_shm); + channel->tee_shm = NULL; + } + + cinfo->transport_info = NULL; + channel->cinfo = NULL; + + scmi_free_channel(cinfo, data, id); + + return 0; +} + +static struct scmi_shared_mem *get_channel_shm(struct optee_channel *chan, struct scmi_xfer *xfer) +{ + if (!chan) + return NULL; + + return chan->shmem; +} + + +static int optee_send_message(struct scmi_chan_info *cinfo, + struct scmi_xfer *xfer) +{ + struct optee_channel *channel = cinfo->transport_info; + struct scmi_shared_mem *shmem = get_channel_shm(channel, xfer); + int ret; + + mutex_lock(&channel->mu); + shmem_tx_prepare(shmem, xfer); + + ret = invoke_process_smt_channel(channel); + + scmi_rx_callback(cinfo, shmem_read_header(shmem), NULL); + mutex_unlock(&channel->mu); + + return ret; +} + +static void optee_fetch_response(struct scmi_chan_info *cinfo, + struct scmi_xfer *xfer) +{ + struct optee_channel *channel = cinfo->transport_info; + struct scmi_shared_mem *shmem = get_channel_shm(channel, xfer); + + shmem_fetch_response(shmem, xfer); +} + +static bool optee_poll_done(struct scmi_chan_info *cinfo, + struct scmi_xfer *xfer) +{ + struct optee_channel *channel = cinfo->transport_info; + struct scmi_shared_mem *shmem = get_channel_shm(channel, xfer); + + return shmem_poll_done(shmem, xfer); +} + +static struct scmi_transport_ops scmi_optee_ops = { + .chan_available = optee_chan_available, + .chan_setup = optee_chan_setup, + .chan_free = optee_chan_free, + .send_message = optee_send_message, + .fetch_response = optee_fetch_response, + .clear_channel = optee_clear_channel, + .poll_done = optee_poll_done, +}; + +const struct scmi_desc scmi_optee_desc = { + .ops = &scmi_optee_ops, + .max_rx_timeout_ms = 30, + .max_msg = 20, + .max_msg_size = 128, +}; + +static int optee_ctx_match(struct tee_ioctl_version_data *ver, const void *data) +{ + return ver->impl_id == TEE_IMPL_ID_OPTEE; +} + +static int optee_service_probe(struct device *dev) +{ + struct optee_agent *agent; + struct tee_context *tee_ctx; + int ret; + + /* Only one SCMI OP-TEE device allowed */ + if (optee_private) { + dev_err(dev, "An SCMI OP-TEE device was already initialized: only one allowed\n"); + return -EBUSY; + } + + tee_ctx = tee_client_open_context(NULL, optee_ctx_match, NULL, NULL); + if (IS_ERR(tee_ctx)) + return -ENODEV; + + agent = devm_kzalloc(dev, sizeof(*agent), GFP_KERNEL); + if (!agent) { + ret = -ENOMEM; + goto out; + } + + agent->dev = dev; + agent->tee_ctx = tee_ctx; + INIT_LIST_HEAD(&agent->channel_list); + + optee_private = agent; + + ret = get_capabilities(); + +out: + if (ret) { + tee_client_close_context(tee_ctx); + optee_private = NULL; + } + + return ret; +} + +static int optee_service_remove(struct device *dev) +{ + if (optee_private) + return -EINVAL; + + if (!list_empty(&optee_private->channel_list)) + return -EBUSY; + + tee_client_close_context(optee_private->tee_ctx); + + optee_private = NULL; + + return 0; +} + +static const struct tee_client_device_id scmi_optee_service_id[] = { + { + UUID_INIT(0xa8cfe406, 0xd4f5, 0x4a2e, + 0x9f, 0x8d, 0xa2, 0x5d, 0xc7, 0x54, 0xc0, 0x99) + }, + { } +}; + +MODULE_DEVICE_TABLE(tee, scmi_optee_service_id); + +static struct tee_client_driver scmi_optee_driver = { + .id_table = scmi_optee_service_id, + .driver = { + .name = "scmi-optee", + .bus = &tee_bus_type, + .probe = optee_service_probe, + .remove = optee_service_remove, + }, +}; + +static int __init scmi_optee_init(void) +{ + return driver_register(&scmi_optee_driver.driver); +} + +static void __exit scmi_optee_exit(void) +{ + driver_unregister(&scmi_optee_driver.driver); +} + +device_initcall(scmi_optee_init) +module_exit(scmi_optee_exit);