From: Ben Levinsky <ben.levinsky@xilinx.com>
To: stefano.stabellini@xilinx.com, michals@xilinx.com
Cc: devicetree@vger.kernel.org, mathieu.poirier@linaro.org,
emooring@xilinx.com, linux-remoteproc@vger.kernel.org,
linux-kernel@vger.kernel.org, jliang@xilinx.com,
robh+dt@kernel.org, linux-arm-kernel@lists.infradead.org,
michael.auchter@ni.com
Subject: [PATCH v9 4/5] dt-bindings: remoteproc: Add documentation for ZynqMP R5 rproc bindings
Date: Wed, 26 Aug 2020 09:13:06 -0700 [thread overview]
Message-ID: <20200826161307.1064-5-ben.levinsky@xilinx.com> (raw)
In-Reply-To: <20200826161307.1064-1-ben.levinsky@xilinx.com>
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: Ben Levinsky <ben.levinsky@xilinx.com>
Signed-off-by: Jason Wu <j.wu@xilinx.com>
Signed-off-by: Wendy Liang <jliang@xilinx.com>
Signed-off-by: Michal Simek <michal.simek@xilinx.com>
---
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
---
.../xilinx,zynqmp-r5-remoteproc.yaml | 113 ++++++++++++++++++
1 file changed, 113 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..f4a28831af6c
--- /dev/null
+++ b/Documentation/devicetree/bindings/remoteproc/xilinx,zynqmp-r5-remoteproc.yaml
@@ -0,0 +1,113 @@
+# 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 <ed.mooring@xilinx.com>
+ - Ben Levinsky <ben.levinsky@xilinx.com>
+
+properties:
+ compatible:
+ const: "xlnx,zynqmp-r5-remoteproc-1.0"
+
+ lockstep-mode:
+ description:
+ R5 core configuration (split is 0 or lock-step and 1)
+ 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.
+ maxItems: 4
+ minItems: 4
+ pnode-id:
+ maxItems: 1
+ mboxes:
+ maxItems: 2
+ mbox-names:
+ maxItems: 2
+
+examples:
+ - |
+ reserved-memory {
+ #address-cells = <1>;
+ #size-cells = <1>;
+ ranges;
+ elf_load: rproc@3ed000000 {
+ no-map;
+ reg = <0x3ed00000 0x40000>;
+ };
+ };
+ rpu {
+ compatible = "xlnx,zynqmp-r5-remoteproc-1.0";
+ #address-cells = <1>;
+ #size-cells = <1>;
+ ranges;
+ lockstep-mode = <0>;
+ r5_0 {
+ ranges;
+ #address-cells = <1>;
+ #size-cells = <1>;
+ memory-region = <&elf_load>;
+ pnode-id = <0x7>;
+ };
+ };
+
+ /*
+ * 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
+ */
+ tcm_0a@0 {
+ reg = <0x0 0xffe00000 0x0 0x10000>;
+ pnode-id = <0xf>;
+ no-map;
+ status = "okay";
+ };
+ tcm_1a@0 {
+ reg = <0x0 0xffe20000 0x0 0x10000>;
+ pnode-id = <0x10>;
+ no-map;
+ status = "okay";
+ };
+
+ /*
+ * Below nodes are required for IPC, as Xilinx Kernel
+ * can potentially have other applications that use CMA
+ * and conflict from hardware design. With that in mind,
+ * explicitly state the address spaces for the IPC remoteproc
+ * mechanisms.
+ *
+ * If IPC not required and only elf-loading then these are not needed.
+ */
+ rpu0vdev0vring0: rpu0vdev0vring0@3ed40000 {
+ no-map;
+ reg = <0x0 0x3ed40000 0x0 0x4000>;
+ };
+ rpu0vdev0vring1: rpu0vdev0vring1@3ed44000 {
+ no-map;
+ reg = <0x0 0x3ed44000 0x0 0x4000>;
+ };
+ rpu0vdev0buffer: rpu0vdev0buffer@3ed48000 {
+ no-map;
+ reg = <0x0 0x3ed48000 0x0 0x100000>;
+ };
+
+...
--
2.17.1
next prev parent reply other threads:[~2020-08-26 16:15 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-08-26 16:13 [PATCH v9 0/5] Provide basic driver to control Arm R5 co-processor found on Xilinx ZynqMP Ben Levinsky
2020-08-26 16:13 ` [PATCH v9 1/5] firmware: xilinx: Add ZynqMP firmware ioctl enums for RPU configuration Ben Levinsky
2020-08-26 16:13 ` [PATCH v9 2/5] firmware: xilinx: Add shutdown/wakeup APIs Ben Levinsky
2020-08-26 16:13 ` [PATCH v9 3/5] firmware: xilinx: Add RPU configuration APIs Ben Levinsky
2020-08-26 16:13 ` Ben Levinsky [this message]
2020-08-26 16:13 ` [PATCH v9 5/5] remoteproc: Add initial zynqmp R5 remoteproc driver Ben Levinsky
2020-08-26 21:32 ` Michael Auchter
2020-08-26 21:34 ` Ben Levinsky
2020-09-01 15:10 ` Ben Levinsky
2020-09-01 17:43 ` Ben Levinsky
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200826161307.1064-5-ben.levinsky@xilinx.com \
--to=ben.levinsky@xilinx.com \
--cc=devicetree@vger.kernel.org \
--cc=emooring@xilinx.com \
--cc=jliang@xilinx.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-remoteproc@vger.kernel.org \
--cc=mathieu.poirier@linaro.org \
--cc=michael.auchter@ni.com \
--cc=michals@xilinx.com \
--cc=robh+dt@kernel.org \
--cc=stefano.stabellini@xilinx.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).