From patchwork Fri Jul 17 15:42:54 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Etienne Carriere X-Patchwork-Id: 235731 Delivered-To: patch@linaro.org Received: by 2002:a92:d244:0:0:0:0:0 with SMTP id v4csp1853318ilg; Fri, 17 Jul 2020 09:23:47 -0700 (PDT) X-Google-Smtp-Source: ABdhPJyGlyYYgqznNnsuciuBZUqzOHjNBApOyouXiBf/wFNF8W3T9JmKlk1jVwK6hm6eMtaU0xQM X-Received: by 2002:a17:906:5f98:: with SMTP id a24mr9004120eju.241.1595003026903; Fri, 17 Jul 2020 09:23:46 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1595003026; cv=none; d=google.com; s=arc-20160816; b=En4ZkoItlgY5TPa1ATU+zemPAdtZO59pjpqZaoS5YZX/sdYSuJQPzAY9AWZCQdeJKx 4NIZPEr7jGRnxvaOWAv6uy3JvrWCNe0uftuu7z985fTc5d8VpY5654b+mCfXxguDJ7x2 b6AFrskTLaiC6Qn2OvuBTtjyiUwIXE73fP4COtTtWTYFiMYXspK5JhgqFqiRD/nb2itf M4HOvRynXHNgxV0MaMTyeLBmbR78MsMoWI2Lo9E+gujCzNaYUG3ldyHTCfDfNM5oDAP6 TwCQnPqvaIfDtOp05um46vOpOlNdT7EVVCm4cUXNWOJh2VEYqisj3IMXQor6yTlHte1J QiXA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:references:in-reply-to :message-id:date:subject:cc:to:from:dkim-signature; bh=7ZF1rLgc7Bac8vKcvtLJ8us7X4ogVbIhW1ZcZadRnsU=; b=cueWdl49jf7lbCiJyp1vYgvV6K0a7EXgfSFYA120LWudYQxx7lczQaZ03vfJR+F7SU aJ+HRRSvIsOs+VFjr6JzYvyIx8ZEySvfC4BlVYTelzWmgWbDjWRrcwc+D/31/ctH8IGr 3j4caR2cvDDN0TsQtp7wQO2mnI3lgNlO8lKKjXpnPVnFIUiZ/d0ofwHdgMX43aHAsSN8 iUpsV7YZT2GNlL8CTqMAoOYssYbkRnztSIgxL8qu0VesCDwthNsW1L/9uPLu7vjDcIQk 7NLLN5ZaItWofA/+dCDx+sJoQ+QUORXPm4D2l7Bjvw1oAaMcWdQzO4dpuIB6x8jEtIqx XNug== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b="C1+l/jUd"; spf=pass (google.com: domain of u-boot-bounces@lists.denx.de designates 2a01:238:438b:c500:173d:9f52:ddab:ee01 as permitted sender) smtp.mailfrom=u-boot-bounces@lists.denx.de; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from phobos.denx.de (phobos.denx.de. [2a01:238:438b:c500:173d:9f52:ddab:ee01]) by mx.google.com with ESMTPS id k25si5448999ejv.672.2020.07.17.09.23.46 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 17 Jul 2020 09:23:46 -0700 (PDT) Received-SPF: pass (google.com: domain of u-boot-bounces@lists.denx.de designates 2a01:238:438b:c500:173d:9f52:ddab:ee01 as permitted sender) client-ip=2a01:238:438b:c500:173d:9f52:ddab:ee01; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b="C1+l/jUd"; spf=pass (google.com: domain of u-boot-bounces@lists.denx.de designates 2a01:238:438b:c500:173d:9f52:ddab:ee01 as permitted sender) smtp.mailfrom=u-boot-bounces@lists.denx.de; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 20AF081C00; Fri, 17 Jul 2020 18:23:32 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (2048-bit key; unprotected) header.d=linaro.org header.i=@linaro.org header.b="C1+l/jUd"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id BB9D881C0D; Fri, 17 Jul 2020 17:43:45 +0200 (CEST) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on phobos.denx.de X-Spam-Level: X-Spam-Status: No, score=-2.0 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,SPF_HELO_NONE,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.2 Received: from mail-wm1-x341.google.com (mail-wm1-x341.google.com [IPv6:2a00:1450:4864:20::341]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id 5334181BF9 for ; Fri, 17 Jul 2020 17:43:42 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=etienne.carriere@linaro.org Received: by mail-wm1-x341.google.com with SMTP id l2so17846357wmf.0 for ; Fri, 17 Jul 2020 08:43:42 -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=7ZF1rLgc7Bac8vKcvtLJ8us7X4ogVbIhW1ZcZadRnsU=; b=C1+l/jUdgUEG+BIcxNTGV+0QWdZXnacB6u4lAWPyg1KRI2dvfoGCltyWJwHvH9DxT6 S6iMgxWnhIAL/rA/XW4dqaSuVgq5io6XjNGILU3E8paQHQRSFvoEnfL66l1XcgFZvmXg FmSLH7mDojAZStCDSKe6RpzbdrGg3wqnN9W0c7nwEDRLFcWVHyE2eQtGuvYBziSpITYx hgv1KPYbMrHoCdZYD/Y9Agad4e7P+ZGDyINjD93R6BqMqhMn13zzOi07vNxGKAZJRnaf HOdZoFQSpYT+s8KOq4kEIhvRKyXSg5eXGavdC5ESAyLLQQeplqRv6wB0ytsF4mxlXjFn w2wQ== 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=7ZF1rLgc7Bac8vKcvtLJ8us7X4ogVbIhW1ZcZadRnsU=; b=PGLDSoDsxrIhaCzEMMsQQObgCQoII4QhyYs+VFDeVfnxSUXh3czXocGRuYW98DHMQf J75rwO8Kmj8GMg7bsbGjATD+HEbrNcir/bveaQMat7CFZ6T9PjsFaPSbpk6qQQYcyK3A XHi1tpFuWQv2AD6L9pfmJOClaj4tcvPyWPyzrc2iNS1V+JzkZ8+swnA0NOw4lQGeORn8 I/hon7L1fo12ntMnI3YRwulGdog/ozFJRfIZjKyeHlLtX8abl6tBkEKVSkYzaCwzxYiG iy2c2WUPmqtMFkYThRZeqa8xlyCehXZWvGRWl8lG7g2Ib9HpYsSDwrwMSwlnEMFzE0vb VI2w== X-Gm-Message-State: AOAM5328NOrAgxQvXFsqkbN59bBzkRGcM0yigh6zRS/ggvQoHh5AxZe2 z9qZEO64CpBspyWvTKmyf+PCtgdjRO6YZw== X-Received: by 2002:a1c:720e:: with SMTP id n14mr10560089wmc.144.1595000621422; Fri, 17 Jul 2020 08:43:41 -0700 (PDT) Received: from lmecxl0524.lme.st.com ([2a04:cec0:1057:28c5:7db6:61b:9cd8:ab62]) by smtp.gmail.com with ESMTPSA id n3sm2345286wre.29.2020.07.17.08.43.40 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 17 Jul 2020 08:43:40 -0700 (PDT) From: Etienne Carriere To: u-boot@lists.denx.de Cc: Bin Meng , Etienne Carriere , Fabio Estevam , Jagan Teki , Marek Szyprowski , Priyanka Jain , Simon Glass , Vignesh Raghavendra , Tom Rini , Lukasz Majewski , Matthias Brugger , Peng Fan , Trevor Woerner Subject: [PATCH 2/4] dt-bindings: arm: SCMI bindings documentation Date: Fri, 17 Jul 2020 17:42:54 +0200 Message-Id: <20200717154256.11001-2-etienne.carriere@linaro.org> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200717154256.11001-1-etienne.carriere@linaro.org> References: <20200717154256.11001-1-etienne.carriere@linaro.org> X-Mailman-Approved-At: Fri, 17 Jul 2020 18:23:26 +0200 X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.34 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.102.3 at phobos.denx.de X-Virus-Status: Clean Dump SCMI DT bindings documentation from Linux kernel source tree v5.8-rc1. Signed-off-by: Etienne Carriere --- doc/device-tree-bindings/arm/arm,scmi.txt | 197 ++++++++++++++++++++++ 1 file changed, 197 insertions(+) create mode 100644 doc/device-tree-bindings/arm/arm,scmi.txt -- 2.17.1 Reviewed-by: Simon Glass diff --git a/doc/device-tree-bindings/arm/arm,scmi.txt b/doc/device-tree-bindings/arm/arm,scmi.txt new file mode 100644 index 00000000000..1f293ea24cd --- /dev/null +++ b/doc/device-tree-bindings/arm/arm,scmi.txt @@ -0,0 +1,197 @@ +System Control and Management Interface (SCMI) Message Protocol +---------------------------------------------------------- + +The SCMI is intended to allow agents such as OSPM to manage various functions +that are provided by the hardware platform it is running on, including power +and performance functions. + +This binding is intended to define the interface the firmware implementing +the SCMI as described in ARM document number ARM DEN 0056A ("ARM System Control +and Management Interface Platform Design Document")[0] provide for OSPM in +the device tree. + +Required properties: + +The scmi node with the following properties shall be under the /firmware/ node. + +- compatible : shall be "arm,scmi" or "arm,scmi-smc" for smc/hvc transports +- mboxes: List of phandle and mailbox channel specifiers. It should contain + exactly one or two mailboxes, one for transmitting messages("tx") + and another optional for receiving the notifications("rx") if + supported. +- shmem : List of phandle pointing to the shared memory(SHM) area as per + generic mailbox client binding. +- #address-cells : should be '1' if the device has sub-nodes, maps to + protocol identifier for a given sub-node. +- #size-cells : should be '0' as 'reg' property doesn't have any size + associated with it. +- arm,smc-id : SMC id required when using smc or hvc transports + +Optional properties: + +- mbox-names: shall be "tx" or "rx" depending on mboxes entries. + +See Documentation/devicetree/bindings/mailbox/mailbox.txt for more details +about the generic mailbox controller and client driver bindings. + +The mailbox is the only permitted method of calling the SCMI firmware. +Mailbox doorbell is used as a mechanism to alert the presence of a +messages and/or notification. + +Each protocol supported shall have a sub-node with corresponding compatible +as described in the following sections. If the platform supports dedicated +communication channel for a particular protocol, the 3 properties namely: +mboxes, mbox-names and shmem shall be present in the sub-node corresponding +to that protocol. + +Clock/Performance bindings for the clocks/OPPs based on SCMI Message Protocol +------------------------------------------------------------ + +This binding uses the common clock binding[1]. + +Required properties: +- #clock-cells : Should be 1. Contains the Clock ID value used by SCMI commands. + +Power domain bindings for the power domains based on SCMI Message Protocol +------------------------------------------------------------ + +This binding for the SCMI power domain providers uses the generic power +domain binding[2]. + +Required properties: + - #power-domain-cells : Should be 1. Contains the device or the power + domain ID value used by SCMI commands. + +Sensor bindings for the sensors based on SCMI Message Protocol +-------------------------------------------------------------- +SCMI provides an API to access the various sensors on the SoC. + +Required properties: +- #thermal-sensor-cells: should be set to 1. This property follows the + thermal device tree bindings[3]. + + Valid cell values are raw identifiers (Sensor ID) + as used by the firmware. Refer to platform details + for your implementation for the IDs to use. + +Reset signal bindings for the reset domains based on SCMI Message Protocol +------------------------------------------------------------ + +This binding for the SCMI reset domain providers uses the generic reset +signal binding[5]. + +Required properties: + - #reset-cells : Should be 1. Contains the reset domain ID value used + by SCMI commands. + +SRAM and Shared Memory for SCMI +------------------------------- + +A small area of SRAM is reserved for SCMI communication between application +processors and SCP. + +The properties should follow the generic mmio-sram description found in [4] + +Each sub-node represents the reserved area for SCMI. + +Required sub-node properties: +- reg : The base offset and size of the reserved area with the SRAM +- compatible : should be "arm,scmi-shmem" for Non-secure SRAM based + shared memory + +[0] http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/index.html +[1] Documentation/devicetree/bindings/clock/clock-bindings.txt +[2] Documentation/devicetree/bindings/power/power-domain.yaml +[3] Documentation/devicetree/bindings/thermal/thermal.txt +[4] Documentation/devicetree/bindings/sram/sram.yaml +[5] Documentation/devicetree/bindings/reset/reset.txt + +Example: + +sram@50000000 { + compatible = "mmio-sram"; + reg = <0x0 0x50000000 0x0 0x10000>; + + #address-cells = <1>; + #size-cells = <1>; + ranges = <0 0x0 0x50000000 0x10000>; + + cpu_scp_lpri: scp-shmem@0 { + compatible = "arm,scmi-shmem"; + reg = <0x0 0x200>; + }; + + cpu_scp_hpri: scp-shmem@200 { + compatible = "arm,scmi-shmem"; + reg = <0x200 0x200>; + }; +}; + +mailbox@40000000 { + .... + #mbox-cells = <1>; + reg = <0x0 0x40000000 0x0 0x10000>; +}; + +firmware { + + ... + + scmi { + compatible = "arm,scmi"; + mboxes = <&mailbox 0 &mailbox 1>; + mbox-names = "tx", "rx"; + shmem = <&cpu_scp_lpri &cpu_scp_hpri>; + #address-cells = <1>; + #size-cells = <0>; + + scmi_devpd: protocol@11 { + reg = <0x11>; + #power-domain-cells = <1>; + }; + + scmi_dvfs: protocol@13 { + reg = <0x13>; + #clock-cells = <1>; + }; + + scmi_clk: protocol@14 { + reg = <0x14>; + #clock-cells = <1>; + }; + + scmi_sensors0: protocol@15 { + reg = <0x15>; + #thermal-sensor-cells = <1>; + }; + + scmi_reset: protocol@16 { + reg = <0x16>; + #reset-cells = <1>; + }; + }; +}; + +cpu@0 { + ... + reg = <0 0>; + clocks = <&scmi_dvfs 0>; +}; + +hdlcd@7ff60000 { + ... + reg = <0 0x7ff60000 0 0x1000>; + clocks = <&scmi_clk 4>; + power-domains = <&scmi_devpd 1>; + resets = <&scmi_reset 10>; +}; + +thermal-zones { + soc_thermal { + polling-delay-passive = <100>; + polling-delay = <1000>; + /* sensor ID */ + thermal-sensors = <&scmi_sensors0 3>; + ... + }; +};