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,imx8mq-cm4
19      - fsl,imx8mm-cm4
20      - fsl,imx8mn-cm7
21      - fsl,imx8mp-cm7
22      - fsl,imx7d-cm4
23      - fsl,imx7ulp-cm4
24      - fsl,imx6sx-cm4
25
26  clocks:
27    maxItems: 1
28
29  syscon:
30    $ref: /schemas/types.yaml#/definitions/phandle
31    description:
32      Phandle to syscon block which provide access to System Reset Controller
33
34  mbox-names:
35    items:
36      - const: tx
37      - const: rx
38      - const: rxdb
39
40  mboxes:
41    description:
42      This property is required only if the rpmsg/virtio functionality is used.
43      List of <&phandle type channel> - 1 channel for TX, 1 channel for RX, 1 channel for RXDB.
44      (see mailbox/fsl,mu.yaml)
45    minItems: 1
46    maxItems: 3
47
48  memory-region:
49    description:
50      If present, a phandle for a reserved memory area that used for vdev buffer,
51      resource table, vring region and others used by remote processor.
52    minItems: 1
53    maxItems: 32
54
55  fsl,auto-boot:
56    $ref: /schemas/types.yaml#/definitions/flag
57    description:
58      Indicate whether need to load the default firmware and start the remote
59      processor automatically.
60
61required:
62  - compatible
63
64additionalProperties: false
65
66examples:
67  - |
68    #include <dt-bindings/clock/imx7d-clock.h>
69    m4_reserved_sysmem1: cm4@80000000 {
70      reg = <0x80000000 0x80000>;
71    };
72
73    m4_reserved_sysmem2: cm4@81000000 {
74      reg = <0x81000000 0x80000>;
75    };
76
77    imx7d-cm4 {
78      compatible	= "fsl,imx7d-cm4";
79      memory-region	= <&m4_reserved_sysmem1>, <&m4_reserved_sysmem2>;
80      syscon		= <&src>;
81      clocks		= <&clks IMX7D_ARM_M4_ROOT_CLK>;
82    };
83
84  - |
85    #include <dt-bindings/clock/imx8mm-clock.h>
86
87    imx8mm-cm4 {
88      compatible = "fsl,imx8mm-cm4";
89      clocks = <&clk IMX8MM_CLK_M4_DIV>;
90      mbox-names = "tx", "rx", "rxdb";
91      mboxes = <&mu 0 1
92                &mu 1 1
93                &mu 3 1>;
94      memory-region = <&vdev0buffer>, <&vdev0vring0>, <&vdev0vring1>, <&rsc_table>;
95      syscon = <&src>;
96    };
97...
98