Received: by 2002:a05:6a10:22f:0:0:0:0 with SMTP id 15csp3417139pxk; Mon, 5 Oct 2020 09:08:47 -0700 (PDT) X-Google-Smtp-Source: ABdhPJwEyxO4sN0OUg62YFd058h2OCiMM0QQ1Uc2q+PR7YcQYJQO49i5PuJHF4adYu/XesUOeIC9 X-Received: by 2002:a17:906:468c:: with SMTP id a12mr404905ejr.269.1601914127347; Mon, 05 Oct 2020 09:08:47 -0700 (PDT) ARC-Seal: i=2; a=rsa-sha256; t=1601914127; cv=pass; d=google.com; s=arc-20160816; b=MS5exxBpw0Eh71/qp3vVZzAvNvokl1wTGb/vY5T5UuSEbuWdoZzRds+6TvQJutwPU1 4rgeESs576yzUHXVOWVe4M1PFvB4VSH4pvbXs/JZu6NCbdIQ588sP1RmBD9BD+4JUqfa dCVER9yh3sQw6z9vn3ohKd+p1aAHA2jTrpGtmYRwqzL5S4Ye0VLqNVaHSKad3tP36Wvn cJuxwLbgaNQyzrG3CK+SFepSlXMh8K1PKbQE4L2C+hUzfYrIBV/VSBED7u3DkHNVgBUG JCkconpVoB9fNRiN7UR8JpliT4xXGUVSzOcm7hSGMyStE1/2AAMyk/Ys9KVlcKFpPJUd ALtw== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:mime-version:references:in-reply-to:message-id :date:subject:cc:to:from:dkim-signature; bh=ZL1CODgo8zvHUTE+fuWfj8tFPjDSkWKFrWx0Gk7Eebw=; b=cIdTbmhPOPiIDU8MX1NGhYpZPXYt2ghde5WKrZJu3qPFb9iW04GseeV5rNz/isHdX1 c1lmfsSIYQNSx4sSlClRTeVMWVcJm0CvyJl5Bb3gj/l005pc/6v9lfb2sQYW3679IYSo HHXslvAUQTCH7er8dthqKbD5FyOQ2OIoDKFkiHZQRra3IT3MisAtyeYyaFtEmMGzvjfS YRUZ1IX70fv8pLbQxsw5DS0iMXjqULxiHQDBIg0Pp4ikA0CsZtw3Y5SsRtutTe5t8F// F+FRIv4nXEl3WH05tEK3lJ0RDLnZirRv1/iFO0TnKao5Q5TEqAGlRWcGjSG1RZ/1g3o7 ryYA== ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@xilinx.onmicrosoft.com header.s=selector2-xilinx-onmicrosoft-com header.b="rRzKqc/z"; arc=pass (i=1 spf=pass spfdomain=xilinx.com); 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 Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id o17si12201ejg.470.2020.10.05.09.08.17; Mon, 05 Oct 2020 09:08:47 -0700 (PDT) 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=@xilinx.onmicrosoft.com header.s=selector2-xilinx-onmicrosoft-com header.b="rRzKqc/z"; arc=pass (i=1 spf=pass spfdomain=xilinx.com); 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 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728419AbgJEQGc (ORCPT + 99 others); Mon, 5 Oct 2020 12:06:32 -0400 Received: from mail-bn8nam12on2086.outbound.protection.outlook.com ([40.107.237.86]:15011 "EHLO NAM12-BN8-obe.outbound.protection.outlook.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1727355AbgJEQGV (ORCPT ); Mon, 5 Oct 2020 12:06:21 -0400 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=H+5+VDEdJyDTdznc+8l8kIrJCN2Bpcwjj6OapKjTjxyvBV8mvxf4mKUsyCtAEkLABFw3sc59w3sJ6n6cwoUhVeIojo04OfHYZXwA7DP4pfXRj2U9Z4VIEuZ9fqVpYZagUeGuV4npl63c2XP4CSkDYuGUDZqMCIqEYsDVxpP4THCfXR0A4b9HS4yk7y1J7BBegqaeyKgHYk1LzmXlLEVj952IM6IkciEbYPApvHwiDm+8fxWW4FlwXqDDzauzA6AZwQGxhGGnQ0h3DHAxKd++Wryc0n3IDyVBMcJeCKGqTfdGG34237gqdsFUy+s7agVWQ98yti9MF+xjT8rI4+IZAg== 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=ZL1CODgo8zvHUTE+fuWfj8tFPjDSkWKFrWx0Gk7Eebw=; b=Uid9ZPErN4cvy5Skl9Qw2u39xlnD20mKgbEBLUWygSmMiBVdf3VT5xEwGelpqSSXvoZZxs+ADFVdADvqLCKZlSwMaEaOatiG/cHstGXE+eqfuRqX1mvYWebACLmWZ+KxoJNpw/7WSBWeRLEpu5QDyUOEaIU3lNL+eakS27XlozxHXfREs/qGIBD5dJ091//yTBHMRjmd2NjHbKEjdAeNZKJStOA+/yTRaFpW9F3E6i50P9oxHAhC74Plt/LWjouZaftMvM3LLw3Nu+DgiH/pSoZwDglQL2DcoiF6vG4d9ZUTLI88d94c3/7vcgpBqywNH/VGBCRV4xaaJ7Oz+N4V8w== 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=ZL1CODgo8zvHUTE+fuWfj8tFPjDSkWKFrWx0Gk7Eebw=; b=rRzKqc/zn05Kun22WlCjkrt1A3dtuz3kosZjYajxeVS8wheieWPUyBB9wWD+o8JMKSazGV0Cv2Do7oI0wKShFcZJ8h2BfS7h/M6mMpn0vpygXF8udol1RvjOwBaJRKdCqa9M035FlSbhbcbszZKec/Y3uoHGxwiIWjmS2VGu9nM= Received: from MN2PR01CA0055.prod.exchangelabs.com (2603:10b6:208:23f::24) by SN1PR02MB3823.namprd02.prod.outlook.com (2603:10b6:802:2e::19) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3433.35; Mon, 5 Oct 2020 16:06:17 +0000 Received: from BL2NAM02FT037.eop-nam02.prod.protection.outlook.com (2603:10b6:208:23f:cafe::53) by MN2PR01CA0055.outlook.office365.com (2603:10b6:208:23f::24) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3433.38 via Frontend Transport; Mon, 5 Oct 2020 16:06:16 +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 BL2NAM02FT037.mail.protection.outlook.com (10.152.77.11) with Microsoft SMTP Server id 15.20.3433.39 via Frontend Transport; Mon, 5 Oct 2020 16:06:16 +0000 Received: from [149.199.38.66] (port=36695 helo=smtp.xilinx.com) by xsj-pvapsmtpgw01 with esmtp (Exim 4.90) (envelope-from ) id 1kPSzf-0001tq-64; Mon, 05 Oct 2020 09:05:43 -0700 Received: from [127.0.0.1] (helo=localhost) by smtp.xilinx.com with smtp (Exim 4.63) (envelope-from ) id 1kPT0C-00026i-Fn; Mon, 05 Oct 2020 09:06:16 -0700 Received: from xsj-pvapsmtp01 (mailhost.xilinx.com [149.199.38.66]) by xsj-smtp-dlp1.xlnx.xilinx.com (8.13.8/8.13.1) with ESMTP id 095G6Eub027465; Mon, 5 Oct 2020 09:06:14 -0700 Received: from [172.19.2.206] (helo=xsjblevinsk50.xilinx.com) by xsj-pvapsmtp01 with esmtp (Exim 4.63) (envelope-from ) id 1kPT0A-000260-Gz; Mon, 05 Oct 2020 09:06:14 -0700 From: Ben Levinsky To: ed.mooring@xilinx.com, 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 v18 4/5] dt-bindings: remoteproc: Add documentation for ZynqMP R5 rproc bindings Date: Mon, 5 Oct 2020 09:06:13 -0700 Message-Id: <20201005160614.3749-5-ben.levinsky@xilinx.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20201005160614.3749-1-ben.levinsky@xilinx.com> References: <20201005160614.3749-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 Content-Type: text/plain X-MS-Office365-Filtering-Correlation-Id: db7bbc4f-71de-4a1e-0bdc-08d869489734 X-MS-TrafficTypeDiagnostic: SN1PR02MB3823: 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: RbpX+NovHxRQNwi6pIGVo7QbalIaXNuyYiUkHDFZCKxx1jPbsLNZm1uOzHhyxwBWF3vjBG/K72kNJaJLLzeJoL6oZ2LlGf+SYGChI8tbPzcVXnDDtOIA8GsxZRSK2zJs49TDGfQ0zqJ5yJg6GdEdiAv8JrzEMgtzhcabKXwzfD5E79jIzbi0wsNQrjUxFB/RKSaTg4X5PNCF6rflxX0xGON4Dz8tT7/oM/96RMDDVCn68nJRQIc/dhVKtksQN5f/ve/mPyd8fEZvBMgnf/7aw5tNTztL5VWpipI/oFnWK0+09gHoK16TYiCxJ42xtox5xSo78s8Y5zeJXjKD5e09JLUa8JWWXYg8PRe+KvdHIjO+pMJJxP4UNObC+pMdj9YFs+rrlKp+vClnfhQtBbgaqJfEhGe0HbSuybPM3/QokPLseqp/czsZgi/eEVylv41j01IKqmptp9VqmO+vxw2eNgtuDi4E61r6z9kQ30a/BGU= 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)(396003)(376002)(346002)(39860400002)(46966005)(4326008)(83080400001)(478600001)(70586007)(70206006)(2906002)(36756003)(83380400001)(186003)(82310400003)(7696005)(82740400003)(8936002)(9786002)(356005)(316002)(81166007)(26005)(8676002)(336012)(47076004)(1076003)(426003)(5660300002)(2616005)(44832011);DIR:OUT;SFP:1101; X-OriginatorOrg: xilinx.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Oct 2020 16:06:16.8127 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: db7bbc4f-71de-4a1e-0bdc-08d869489734 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: BL2NAM02FT037.eop-nam02.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: SN1PR02MB3823 Precedence: bulk List-ID: X-Mailing-List: linux-kernel@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 v18: - update example remoteproc zynqmp r5 compat string, remove version number --- .../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..c202dca3b6d0 --- /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"; + #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>; + }; + }; + +... -- 2.17.1