xref: /freebsd/sys/contrib/device-tree/Bindings/remoteproc/fsl,imx-rproc.yaml (revision 4d846d260e2b9a3d4d0a701462568268cbfe7a5b) 
1# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: "http://devicetree.org/schemas/remoteproc/fsl,imx-rproc.yaml#"
5$schema: "http://devicetree.org/meta-schemas/core.yaml#"
6
7title: NXP i.MX Co-Processor Bindings
8
9description:
10  This binding provides support for ARM Cortex M4 Co-processor found on some NXP iMX SoCs.
11
12maintainers:
13  - Peng Fan <peng.fan@nxp.com>
14
15properties:
16  compatible:
17    enum:
18      - fsl,imx6sx-cm4
19      - fsl,imx7d-cm4
20      - fsl,imx7ulp-cm4
21      - fsl,imx8mm-cm4
22      - fsl,imx8mn-cm7
23      - fsl,imx8mp-cm7
24      - fsl,imx8mq-cm4
25      - fsl,imx8ulp-cm33
26      - fsl,imx93-cm33
27
28  clocks:
29    maxItems: 1
30
31  syscon:
32    $ref: /schemas/types.yaml#/definitions/phandle
33    description:
34      Phandle to syscon block which provide access to System Reset Controller
35
36  mbox-names:
37    items:
38      - const: tx
39      - const: rx
40      - const: rxdb
41
42  mboxes:
43    description:
44      This property is required only if the rpmsg/virtio functionality is used.
45      List of <&phandle type channel> - 1 channel for TX, 1 channel for RX, 1 channel for RXDB.
46      (see mailbox/fsl,mu.yaml)
47    minItems: 1
48    maxItems: 3
49
50  memory-region:
51    description:
52      If present, a phandle for a reserved memory area that used for vdev buffer,
53      resource table, vring region and others used by remote processor.
54    minItems: 1
55    maxItems: 32
56
57  fsl,auto-boot:
58    $ref: /schemas/types.yaml#/definitions/flag
59    description:
60      Indicate whether need to load the default firmware and start the remote
61      processor automatically.
62
63required:
64  - compatible
65
66additionalProperties: false
67
68examples:
69  - |
70    #include <dt-bindings/clock/imx7d-clock.h>
71    m4_reserved_sysmem1: cm4@80000000 {
72      reg = <0x80000000 0x80000>;
73    };
74
75    m4_reserved_sysmem2: cm4@81000000 {
76      reg = <0x81000000 0x80000>;
77    };
78
79    imx7d-cm4 {
80      compatible	= "fsl,imx7d-cm4";
81      memory-region	= <&m4_reserved_sysmem1>, <&m4_reserved_sysmem2>;
82      syscon		= <&src>;
83      clocks		= <&clks IMX7D_ARM_M4_ROOT_CLK>;
84    };
85
86  - |
87    #include <dt-bindings/clock/imx8mm-clock.h>
88
89    imx8mm-cm4 {
90      compatible = "fsl,imx8mm-cm4";
91      clocks = <&clk IMX8MM_CLK_M4_DIV>;
92      mbox-names = "tx", "rx", "rxdb";
93      mboxes = <&mu 0 1
94                &mu 1 1
95                &mu 3 1>;
96      memory-region = <&vdev0buffer>, <&vdev0vring0>, <&vdev0vring1>, <&rsc_table>;
97      syscon = <&src>;
98    };
99...
100