From patchwork Thu Oct 1 21:05:40 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ben Levinsky X-Patchwork-Id: 11812425 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id ADE406CB for ; Thu, 1 Oct 2020 21:06:30 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 832AE20754 for ; Thu, 1 Oct 2020 21:06:30 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (1024-bit key) header.d=xilinx.onmicrosoft.com header.i=@xilinx.onmicrosoft.com header.b="qgDu4QQE" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2387403AbgJAVGO (ORCPT ); Thu, 1 Oct 2020 17:06:14 -0400 Received: from mail-bn8nam12on2054.outbound.protection.outlook.com ([40.107.237.54]:21856 "EHLO NAM12-BN8-obe.outbound.protection.outlook.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1727143AbgJAVF6 (ORCPT ); Thu, 1 Oct 2020 17:05:58 -0400 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=jqKgqW7eVwXW1rfrsRvfFA99HD3G1CUNoqzhRALjy+Pzy2ET3ZLlvWTNCixtRC62dknqjBGlOQXkBOpQrnn3BxIl51/NJDoO8QHUgHTjkHCprGsf88ih/yp8v+xWr1vZCsDNirTPgDCXA9zQwYLwWEeg68z1CcrWOx3s2VFEHbhDilVEZcTt/ndcn2SyhyG2b3fqALJEAAhRivz5Tg0I7TpH97EDCP1N1FtWsztCQFqCo7X2/TQCnSSp1s5eE/wt5/ezFjst2O5Og25htDoxE/n7CqEULNKVkV77BpeeRau/D18zKNu2Hg4VwA9J2sU1wR0IiM65thdBbXfjtz6nig== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=mCrrTqQ9QBzBECnyR+8k6jiLrQIMFW0KvN46i29KHwo=; b=IhLqnEP93wGeMSoKNOtpI3tRZmvFHdhKG9MiekYmCnn5nDSrTJqvDKpoYk8sGNeLEXBKwHT8gIue+mc3R/RAHJMvJY4Rnfo7THZ26gDVY39vEh+NUu0/T5w56vM7Xcih/tTeK1x+PAck48/obCxpWoRmzabGKKmbJoEwR/neeBDPj1BU6NLiVEsCk+XiIqcshDbuO7tYG6ToJAv6leDr1sQ/p8ZjUamuptGHpK69CqrWJUj3VjmQX24qyvAIIJke987cQCpbCOc8Ev/7ukdujbIDpf/GR71jtOptMg2Uqc+suyqjsO7cCTF6abS6+bYihQOTpV5mh3IcGHu3U4Xfdg== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 149.199.60.83) smtp.rcpttodomain=lists.infradead.org smtp.mailfrom=xilinx.com; dmarc=bestguesspass action=none header.from=xilinx.com; dkim=none (message not signed); arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=xilinx.onmicrosoft.com; s=selector2-xilinx-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=mCrrTqQ9QBzBECnyR+8k6jiLrQIMFW0KvN46i29KHwo=; b=qgDu4QQEZv8mNF9zzXE2ncCwbKWCDNDO10q9CopqQHcDXHboPNKujwAtLjhF7LmE/6wFDEzK10ET701ACSSPqVXkMbnACKGHbejovTsK93yMDyWoGB2g+98ojduVPoSZIMcHiKEVP/VK1azQ7D/28TpY8s1aXbinMP0595bWCms= Received: from DM5PR06CA0077.namprd06.prod.outlook.com (2603:10b6:3:4::15) by BYAPR02MB5061.namprd02.prod.outlook.com (2603:10b6:a03:6b::24) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3412.28; Thu, 1 Oct 2020 21:05:54 +0000 Received: from CY1NAM02FT022.eop-nam02.prod.protection.outlook.com (2603:10b6:3:4:cafe::a8) by DM5PR06CA0077.outlook.office365.com (2603:10b6:3:4::15) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3433.37 via Frontend Transport; Thu, 1 Oct 2020 21:05:54 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 149.199.60.83) smtp.mailfrom=xilinx.com; lists.infradead.org; dkim=none (message not signed) header.d=none;lists.infradead.org; dmarc=bestguesspass action=none header.from=xilinx.com; Received-SPF: Pass (protection.outlook.com: domain of xilinx.com designates 149.199.60.83 as permitted sender) receiver=protection.outlook.com; client-ip=149.199.60.83; helo=xsj-pvapsmtpgw01; Received: from xsj-pvapsmtpgw01 (149.199.60.83) by CY1NAM02FT022.mail.protection.outlook.com (10.152.75.185) with Microsoft SMTP Server id 15.20.3412.21 via Frontend Transport; Thu, 1 Oct 2020 21:05:54 +0000 Received: from [149.199.38.66] (port=60929 helo=smtp.xilinx.com) by xsj-pvapsmtpgw01 with esmtp (Exim 4.90) (envelope-from ) id 1kO5lW-0005ZI-JI; Thu, 01 Oct 2020 14:05:26 -0700 Received: from [127.0.0.1] (helo=localhost) by smtp.xilinx.com with smtp (Exim 4.63) (envelope-from ) id 1kO5ly-0000KR-C7; Thu, 01 Oct 2020 14:05:54 -0700 Received: from xsj-pvapsmtp01 (xsj-pvapsmtp01.xilinx.com [149.199.38.66]) by xsj-smtp-dlp2.xlnx.xilinx.com (8.13.8/8.13.1) with ESMTP id 091L5fvW030078; Thu, 1 Oct 2020 14:05:41 -0700 Received: from [172.19.2.206] (helo=xsjblevinsk50.xilinx.com) by xsj-pvapsmtp01 with esmtp (Exim 4.63) (envelope-from ) id 1kO5ll-0000Id-Dc; Thu, 01 Oct 2020 14:05:41 -0700 From: Ben Levinsky To: sunnyliangjy@gmail.com, punit1.agrawal@toshiba.co.jp, stefanos@xilinx.com, michals@xilinx.com, michael.auchter@ni.com Cc: devicetree@vger.kernel.org, mathieu.poirier@linaro.org, linux-remoteproc@vger.kernel.org, linux-kernel@vger.kernel.org, robh+dt@kernel.org, linux-arm-kernel@lists.infradead.org Subject: [PATCH v17 4/5] dt-bindings: remoteproc: Add documentation for ZynqMP R5 rproc bindings Date: Thu, 1 Oct 2020 14:05:40 -0700 Message-Id: <20201001210541.32042-5-ben.levinsky@xilinx.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20201001210541.32042-1-ben.levinsky@xilinx.com> References: <20201001210541.32042-1-ben.levinsky@xilinx.com> X-RCIS-Action: ALLOW X-TM-AS-Product-Ver: IMSS-7.1.0.1224-8.2.0.1013-23620.005 X-TM-AS-User-Approved-Sender: Yes;Yes X-EOPAttributedMessage: 0 X-MS-Office365-Filtering-HT: Tenant X-MS-PublicTrafficType: Email MIME-Version: 1.0 X-MS-Office365-Filtering-Correlation-Id: af459e4c-48ad-4310-8003-08d8664dc928 X-MS-TrafficTypeDiagnostic: BYAPR02MB5061: X-Microsoft-Antispam-PRVS: X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply X-MS-Oob-TLC-OOBClassifiers: OLM:9508; X-MS-Exchange-SenderADCheck: 1 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: vTZWexSYQlQBlJarkmvg52P122lXCFzwlg9RAfNgfTV0WBrCl+d3BMonun3CkhpNvvuCN6uKJ+G6b+u3KBt5u9rPzghptGXQgSuQeNNMhS+COwzbrt9hN2M6AwVSqNlAZJTEgDDnGPOw1exkEe0kEd0VdxGsbMLAToDO+EM6rSdod4Qsoyv3MJbPbwsOIw3kcQm622OQege7iwAKhskdXZAQGOcEAhl3ZLzfgodAskmgisgKx0TN1nH/ZD3sC2Atd1fTkzlmsuHTkpCOjSn63L5kFS1/5PI0hjRSHcpnY+WcJb0BDZy+coHPHYM376y5ee3OFoFcSBQ7zOqoQShdysVjTRcLvyEZpvWHyunwn7TahbpiSgue6sUJtlwgbHw8iYL4x20QleCJUlnXUx499QNqMgbrmzhtYJCBnwyDUXz88X8HUHL8BOKAwWQTKwvpbjUKC/fiaFX229jF4aduQzoZ9STp6K+9YMC+rDgTMOvg5+Y6zg69gqbaPqFZTjaooEqvcU4XHNs/d0+Vjr2/yw== X-Forefront-Antispam-Report: CIP:149.199.60.83;CTRY:US;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:xsj-pvapsmtpgw01;PTR:unknown-60-83.xilinx.com;CAT:NONE;SFS:(136003)(346002)(376002)(396003)(39860400002)(46966005)(426003)(9786002)(26005)(36756003)(82740400003)(70586007)(4326008)(316002)(336012)(70206006)(2616005)(44832011)(81166007)(82310400003)(8936002)(47076004)(8676002)(356005)(186003)(1076003)(83380400001)(2906002)(478600001)(5660300002)(7696005);DIR:OUT;SFP:1101; X-OriginatorOrg: xilinx.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 01 Oct 2020 21:05:54.6194 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: af459e4c-48ad-4310-8003-08d8664dc928 X-MS-Exchange-CrossTenant-Id: 657af505-d5df-48d0-8300-c31994686c5c X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=657af505-d5df-48d0-8300-c31994686c5c;Ip=[149.199.60.83];Helo=[xsj-pvapsmtpgw01] X-MS-Exchange-CrossTenant-AuthSource: CY1NAM02FT022.eop-nam02.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: BYAPR02MB5061 Precedence: bulk List-ID: X-Mailing-List: linux-remoteproc@vger.kernel.org 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 --- v3: - update zynqmp_r5 yaml parsing to not raise warnings for extra information in children of R5 node. The warning "node has a unit name, but no reg or ranges property" will still be raised though as this particular node is needed to describe the '#address-cells' and '#size-cells' information. v4:: - remove warning '/example-0/rpu@ff9a0000/r5@0: node has a unit name, but no reg or ranges property' by adding reg to r5 node. v5: - update device tree sample and yaml parsing to not raise any warnings - description for memory-region in yaml parsing - compatible string in yaml parsing for TCM v6: - remove coupling TCM nodes with remoteproc - remove mailbox as it is optional not needed v7: - change lockstep-mode to xlnx,cluster-mode v9: - show example IPC nodes and tcm bank nodes v11: - add property meta-memory-regions to illustrate link between r5 and TCM banks - update so no warnings from 'make dt_binding_check' v14: - concerns were raised about the new property meta-memory-regions. There is no clear direction so for the moment I kept it in the series - place IPC nodes in RAM in the reserved memory section v15: - change lockstep-mode prop as follows: if present, then RPU cluster is in lockstep mode. if not present, cluster is in split mode. v17: - remove compatible string from tcm bank nodes - fix style for bindings - add boolean type to lockstep mode in binding - add/update descriptions memory-region, meta-memory-regions, pnode-id, mbox* properties --- .../xilinx,zynqmp-r5-remoteproc.yaml | 142 ++++++++++++++++++ 1 file changed, 142 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..3982be2051dd --- /dev/null +++ b/Documentation/devicetree/bindings/remoteproc/xilinx,zynqmp-r5-remoteproc.yaml @@ -0,0 +1,142 @@ +# 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 chipset. + + 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: + compatible: + const: xlnx,zynqmp-r5-remoteproc + + lockstep-mode: + description: + If this property is present, then the configuration is lock-step. + Otherwise RPU is split. + type: boolean + maxItems: 1 + + interrupts: + description: + Interrupt mapping for remoteproc IPI. It is required if the + user uses the remoteproc driver with the RPMsg kernel driver. + maxItems: 6 + + memory-region: + description: + collection of memory carveouts used for elf-loading and inter-processor + communication. each carveout in this case should be in DDR, not + chip-specific memory. In Xilinx case, this is TCM, OCM, BRAM, etc. + $ref: /schemas/types.yaml#/definitions/phandle-array + + meta-memory-regions: + description: + collection of memories that are not present in the top level memory + nodes' mapping. For example, R5s' TCM banks. These banks are needed + for R5 firmware meta data such as the R5 firmware's heap and stack. + To be more precise, this is on-chip reserved SRAM regions, e.g. TCM, + BRAM, OCM, etc. + $ref: /schemas/types.yaml#/definitions/phandle-array + + pnode-id: + maxItems: 1 + description: + power node id that is used to uniquely identify the node for Xilinx + Power Management. The value is then passed to Xilinx platform + manager for power on/off and access. + $ref: /schemas/types.yaml#/definitions/uint32 + + mboxes: + description: + array of phandles that describe the rx and tx for xilinx zynqmp + mailbox driver. order of rx and tx is described by the mbox-names + property. This will be used for communication with remote + processor. + maxItems: 2 + + mbox-names: + description: + array of strings that denote which item in the mboxes property array + are the rx and tx for xilinx zynqmp mailbox driver + maxItems: 2 + $ref: /schemas/types.yaml#/definitions/string-array + + +examples: + - | + reserved-memory { + #address-cells = <1>; + #size-cells = <1>; + ranges; + elf_load: rproc@3ed000000 { + no-map; + reg = <0x3ed00000 0x40000>; + }; + + rpu0vdev0vring0: rpu0vdev0vring0@3ed40000 { + no-map; + reg = <0x3ed40000 0x4000>; + }; + rpu0vdev0vring1: rpu0vdev0vring1@3ed44000 { + no-map; + reg = <0x3ed44000 0x4000>; + }; + rpu0vdev0buffer: rpu0vdev0buffer@3ed48000 { + no-map; + reg = <0x3ed48000 0x100000>; + }; + + }; + + /* + * Below nodes are required if using TCM to load R5 firmware + * if not, then either do not provide nodes are label as disabled in + * status property + */ + tcm0a: tcm_0a@ffe00000 { + reg = <0xffe00000 0x10000>; + pnode-id = <0xf>; + no-map; + status = "okay"; + phandle = <0x40>; + }; + tcm0b: tcm_1a@ffe20000 { + reg = <0xffe20000 0x10000>; + pnode-id = <0x10>; + no-map; + status = "okay"; + phandle = <0x41>; + }; + + rpu { + compatible = "xlnx,zynqmp-r5-remoteproc-1.0"; + #address-cells = <1>; + #size-cells = <1>; + ranges; + lockstep-mode; + r5_0 { + ranges; + #address-cells = <1>; + #size-cells = <1>; + memory-region = <&elf_load>, + <&rpu0vdev0vring0>, + <&rpu0vdev0vring1>, + <&rpu0vdev0buffer>; + meta-memory-regions = <&tcm_0a>, <&tcm_0b>; + pnode-id = <0x7>; + }; + }; + +...