Received: by 2002:a05:6a10:f347:0:0:0:0 with SMTP id d7csp2585146pxu; Mon, 7 Dec 2020 10:07:07 -0800 (PST) X-Google-Smtp-Source: ABdhPJxw/mVjCImJDwxGz2Hd7Pa8PW/utijjDLHwgMnEMd9J3jonMyijugwJzXxrtab4cWpa4HgJ X-Received: by 2002:a17:906:16d6:: with SMTP id t22mr19875813ejd.154.1607364427515; Mon, 07 Dec 2020 10:07:07 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1607364427; cv=none; d=google.com; s=arc-20160816; b=mmvlpLZAIz2I2YgqpFYI34E7kZcJezaEWGgQ3UFi9o0AO72Wv21v9mD3cCW5qKVnJ7 nT6sL9RULM0UuaKfw7uMRkkUK4ETHR3Xw2EupCXdf1Ja/KnyQCiaWs49+zeePO7taNa3 zkpadr6FXYhdTSip2PRT2RX2V1S7EDZYtq5yHcp5OxUt9nfVc25HBpJyNcWrH/BFai1u bDT/c/b10Hqqli4+DYMBnqsRYQ2hZK4WU0G2PzngrxSuIvS+LAOdrqgQEEPDu0MkuHbR YEqjyTbQ+ZUWrHZ/WFV7+dGzDast2OVwFm97mEm6L6Xg5YhAVybyad1bWYv+CutOaLuu YqSw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:in-reply-to:content-disposition:mime-version :references:message-id:subject:cc:to:from:date:dkim-signature; bh=pemtUxbnIHdy7nZLjzIFWDscWKaIJzriqu/FiVLySJ4=; b=DbbCp1RS9A70U9su20Z44vvkYsxNn/g76IH4GaEetSJssgzIi50gzCln+Ua+YdNOG3 OBX34FLF3WELPZra3VPuGmwh8jyeNaVF/5F8HnkhJYCyRSXOKp1b5v47U9rvryNA92rZ DObmZAvzSBkMrp55B2MqVHjE1ZkpEnOhpXJ/c1p44qeydfqq5sC8Yh96NFMS+4gUqLtJ s/K7P3JlMxjwwl9EGA3Y7Vb7DNDpALdpAMZplHa0GhirpaRFOi2g7rSE3GnWPfG7rFNt IBn2Ktd8xoEEpqYyNsqgrs5SiVcU4NewUkxaitvgwYGGbDg9tuQGqJ5yj4PzLbikXb2u 2t5Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=XclHISPe; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id jz8si6972589ejb.182.2020.12.07.10.06.43; Mon, 07 Dec 2020 10:07:07 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=XclHISPe; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726355AbgLGSEz (ORCPT + 99 others); Mon, 7 Dec 2020 13:04:55 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45506 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726156AbgLGSEy (ORCPT ); Mon, 7 Dec 2020 13:04:54 -0500 Received: from mail-pf1-x441.google.com (mail-pf1-x441.google.com [IPv6:2607:f8b0:4864:20::441]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 3C3E8C061793 for ; Mon, 7 Dec 2020 10:04:14 -0800 (PST) Received: by mail-pf1-x441.google.com with SMTP id t7so10819114pfh.7 for ; Mon, 07 Dec 2020 10:04:14 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to; bh=pemtUxbnIHdy7nZLjzIFWDscWKaIJzriqu/FiVLySJ4=; b=XclHISPe5HvoXZsQw6QjDHa+9Wbj81p0X+sDCqlGs6Mc7gI5g20Oz31ilw9vj05Myk a3fxlydg+WSGUSqVNSMFXqGfzbxmby/ejXR9PR1yXAmqNSTIOxpOAd7jMZyac4v1KOLN vmUvS/UqHJ34DAA2XJKTtUpVODE238jhFDnTMMHSgB/ZzRTWdew/uhFy0y28f0RMqVKx qDvADqGyA3wuNRnzf7AAZ4QDqkNdDcXGmrQ9/Hrq0oLbUau2sE0zsZ2Bl3NBo8YMZcjj TMMo4KSeYkyMG/Y7TfKn4zDjVVthXeoIjEf3eCmT3N7yg2jHLKJnh6RlpmFEsxKvYRFV w5+w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to; bh=pemtUxbnIHdy7nZLjzIFWDscWKaIJzriqu/FiVLySJ4=; b=Nyb1vInFEREsT36FBG9QA5nm+3a/y9KfCNAvpm1IcV/fZcEmLLqBAGua1nCdDnE1YC G9+SoGPjEnaZthEdLqeqTVXVsS52drvjmsaLySKmsJQWLdjduskezDSKOsJp/p40oJMb ynjbLTIst9AEPT6Jawsytw+3wJO277kXG6f1k86R9XTw3iHqS39LpOGrBBj8A1o+zNSh YUtubEy/uuKP37pf3gVxfyOvK4rwmWEVMFrkHm/qR5T0mn3/Krq35lYksYRr5xzQkPli h5q5/vbthdRJ6HlzvuztWyAtoWt3W4gXVCWVVjxb07gmfz9ikNZvzKq1eiCeZa/M1vG3 D+NQ== X-Gm-Message-State: AOAM532tWoLf7bdYwZt9X8GWoN/+vUxKNhtcVYhTTpzRBysr3e/K7J95 uQbZPQYP9u/nkhO0I9LNyV1UkQ== X-Received: by 2002:a62:ed01:0:b029:19a:a667:9925 with SMTP id u1-20020a62ed010000b029019aa6679925mr16579784pfh.35.1607364253583; Mon, 07 Dec 2020 10:04:13 -0800 (PST) Received: from xps15 (S0106889e681aac74.cg.shawcable.net. [68.147.0.187]) by smtp.gmail.com with ESMTPSA id x18sm3405080pfr.158.2020.12.07.10.04.12 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 07 Dec 2020 10:04:12 -0800 (PST) Date: Mon, 7 Dec 2020 11:04:10 -0700 From: Mathieu Poirier To: Ben Levinsky Cc: devicetree@vger.kernel.org, linux-remoteproc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org Subject: Re: [PATCH v24 4/5] dt-bindings: remoteproc: Add documentation for ZynqMP R5 rproc bindings Message-ID: <20201207180410.GB1509079@xps15> References: <20201130155717.26008-1-ben.levinsky@xilinx.com> <20201130155717.26008-5-ben.levinsky@xilinx.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20201130155717.26008-5-ben.levinsky@xilinx.com> Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Rob Herring is the maintainer of all the yaml files - he is the one this patch needs to go to. I merely look at them to understand the platform device implementation. On Mon, Nov 30, 2020 at 07:57:16AM -0800, Ben Levinsky wrote: > Add binding for ZynqMP R5 OpenAMP. > > Represent the RPU domain resources in one device node. Each RPU > processor is a subnode of the top RPU domain node. > > Signed-off-by: Jason Wu > Signed-off-by: Wendy Liang > Signed-off-by: Michal Simek > Signed-off-by: Ben Levinsky > --- > v24: update for 'make dt_binding_check' errors > --- > .../xilinx,zynqmp-r5-remoteproc.yaml | 223 ++++++++++++++++++ > 1 file changed, 223 insertions(+) > create mode 100644 Documentation/devicetree/bindings/remoteproc/xilinx,zynqmp-r5-remoteproc.yaml > > diff --git a/Documentation/devicetree/bindings/remoteproc/xilinx,zynqmp-r5-remoteproc.yaml b/Documentation/devicetree/bindings/remoteproc/xilinx,zynqmp-r5-remoteproc.yaml > new file mode 100644 > index 000000000000..bccbdee8c3f2 > --- /dev/null > +++ b/Documentation/devicetree/bindings/remoteproc/xilinx,zynqmp-r5-remoteproc.yaml > @@ -0,0 +1,223 @@ > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: "http://devicetree.org/schemas/remoteproc/xilinx,zynqmp-r5-remoteproc.yaml#" > +$schema: "http://devicetree.org/meta-schemas/core.yaml#" > + > +title: Xilinx R5 remote processor controller bindings > + > +description: > + This document defines the binding for the remoteproc component that loads and > + boots firmwares on the Xilinx Zynqmp and Versal family chipsets. > + > + Note that the Linux has global addressing view of the R5-related memory (TCM) > + so the absolute address ranges are provided in TCM reg's. > + > +maintainers: > + - Ed Mooring > + - Ben Levinsky > + > +properties: > + $nodename: > + pattern: "^r5fss(@.*)?" > + > + compatible: > + enum: > + - xlnx,zynqmp-r5-remoteproc > + > + reg: > + items: > + - description: Address and Size of Xilinx RPU Configuration register > + > + "#address-cells": > + const: 2 > + > + "#size-cells": > + const: 2 > + > + ranges: true > + > +# Optional properties: > +# -------------------- > + xlnx,cluster-mode: > + $ref: /schemas/types.yaml#/definitions/uint32 > + enum: [0, 1] > + description: | > + Configuration Mode for the Dual R5F cores within the R5F cluster. > + Should be either a value of 1 (LockStep mode) or 0 (Split mode), > + default is LockStep mode if omitted. > + > + > +#R5F Processor Child Nodes: > +# ========================== > + > +patternProperties: > + "^r5f_[a-f0-9]+$": > + type: object > + description: | > + The R5F Sub-System device node should define one or two R5F child nodes, > + each node representing a Xilinx instantiation of the Arm Cortex R5F core. > + There should be one or two child nodes if the R5F is in Split mode and > + one child node if the R5F is in Lockstep mode. > + > + In Split mode each R5F core has two associated TCM Banks. R5_0 has > + TCM Banks 0A and 0B and R5_1 has TCM Banks 1A and 1B. > + > + In Lockstep mode only one R5F child node should be defined. This one > + child has access to TCM Banks 0A, 0B, 1A and 1B and any of the four can > + be included in the child R5F's sram property. > + > + The example below shows Split mode with two child nodes. > + > + properties: > + compatible: > + enum: > + - xilinx,r5f > + > +# The following properties are mandatory for R5F Core0 in both LockStep and Split > +# modes, and are mandatory for R5F Core1 _only_ in Split mode. > + > + memory-region: > + description: | > + Phandles to the memory nodes to be associated with the Is a word missing here? > + The reserved memory nodes should be carveout nodes, and > + should be defined with a "no-map" property as per the bindings in > + Documentation/devicetree/bindings/reserved-memory/reserved-memory.txt > + minItems: 1 > + maxItems: 6 > + items: > + - description: Region used for dynamic DMA allocations like vrings and > + vring buffers > + - description: region reserved for firmware image sections > + additionalItems: true > + > + power-domain: > + description: | > + Power node ID that is used to uniquely identify the RPU for Xilinx > + Power Management. > + maxItems: 1 > + > +# Optional properties: > +# -------------------- > +# The following properties are optional properties for each of the R5F cores: > + > + mboxes: > + description: | > + Standard property to specify a mailbox > + This property is required only if the rpmsg/virtio functionality > + is used > + > + Refer to the zynqmp-ipi-mailbox documentation for client usage of this > + property Indentation problem > + maxItems: 1 > + > + mbox-names: > + description: | > + Refer to the zynqmp-ipi-mailbox documentation for client usage of this > + property > + items: > + - const: tx > + - const: rx > + > + sram: > + $ref: /schemas/types.yaml#/definitions/phandle-array > + minItems: 1 > + maxItems: 4 > + description: | > + Phandles to one or more reserved on-chip SRAM regions. The regions > + should be defined as child nodes of the respective SRAM node, and > + should be defined as per the generic bindings in, > + Documentation/devicetree/bindings/sram/sram.yaml > + > + required: > + - compatible > + - power-domain > + > + unevaluatedProperties: false > + > +required: > + - reg > + - compatible > + - "#address-cells" > + - "#size-cells" > + - ranges > + > +additionalProperties: false > + > +examples: > + - | > + / { > + compatible = "xlnx,zynqmp-zcu102-rev1.0", "xlnx,zynqmp-zcu102", "xlnx,zynqmp"; > + #address-cells = <2>; > + #size-cells = <2>; > + model = "ZynqMP ZCU102 "; > + > + zynqmp_ipi1 { > + compatible = "xlnx,zynqmp-ipi-mailbox"; > + interrupt-parent = <&gic>; > + interrupts = <0 33 4>; > + xlnx,ipi-id = <5>; > + #address-cells = <1>; > + #size-cells = <0>; > + > + ipi_mailbox_rpu0: mailbox@ff990600 { > + reg = <0xff990600 0x20>, > + <0xff990620 0x20>, > + <0xff9900c0 0x20>, > + <0xff9900e0 0x20>; > + reg-names = "local_request_region", > + "local_response_region", > + "remote_request_region", > + "remote_response_region"; > + #mbox-cells = <1>; > + xlnx,ipi-id = <3>; > + }; > + ipi_mailbox_rpu1: mailbox@ff990780 { > + reg = <0xff990780 0x20>, > + <0xff9907a0 0x20>, > + <0xff9907c0 0x20>, > + <0xff9905a0 0x20>; > + reg-names = "local_request_region", > + "local_response_region", > + "remote_request_region", > + "remote_response_region"; > + #mbox-cells = <1>; > + xlnx,ipi-id = <3>; > + }; > + }; > + > + r5fss@ff9a0000 { > + compatible = "xlnx,zynqmp-r5-remoteproc"; > + #address-cells = <2>; > + #size-cells = <2>; > + ranges; > + reg = <0x0 0xff9a0000 0x0 0x10000>; > + xlnx,cluster-mode = <0>; > + > + r5f_0 { > + compatible = "xilinx,r5f"; > + memory-region = <&elf_load0>, > + <&rpu0vdev0vring0>, > + <&rpu0vdev0vring1>, > + <&rpu0vdev0buffer>; > + sram = <&tcm_0a>, <&tcm_0b>; > + mboxes = <&ipi_mailbox_rpu0 0x0 &ipi_mailbox_rpu0 0x1>; > + mbox-names = "tx", "rx"; > + power-domain = <0x7>; > + }; > + r5f_1 { > + compatible = "xilinx,r5f"; > + memory-region = <&elf_load1>, > + <&rpu1vdev0vring0>, > + <&rpu1vdev0vring1>, > + <&rpu1vdev0buffer>; > + sram = <&tcm_1a>, <&tcm_1b>; > + mboxes = <&ipi_mailbox_rpu1 0x0 &ipi_mailbox_rpu1 0x1>; > + mbox-names = "tx", "rx"; > + power-domain = <0x8>; > + }; > + > + }; > + }; > + > +... > -- > 2.17.1 >