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