1# Copyright 2024 NXP
2# SPDX-License-Identifier: Apache-2.0
3
4description: |
5        System Control and Management Interface (SCMI) with doorbell
6        and shared memory (SHMEM) transport.
7
8        Devicetree example:
9            #include <mem.h>
10
11            scmi_res0: memory@44611000 {
12                compatible = "arm,scmi-shmem";
13                reg = <0x44611000 0x80>;
14            };
15
16            mu5: mailbox@44610000 {
17                compatible = "nxp,mbox-imx-mu";
18                reg = <0x44610000 DT_SIZE_K(4)>;
19                interrupts = <205 0>;
20                #mbox-cells = <1>;
21            };
22
23            scmi {
24                compatible = "arm,scmi";
25                shmem = <&scmi_res0>;
26                mboxes = <&mu5 0>;
27                mbox-names = "tx";
28
29                protocol@14 {
30                    compatible = "arm,scmi-clock";
31                    reg = <0x14>;
32                    #clock-cells = <1>;
33                };
34
35                protocol@19 {
36                    compatible = "arm,scmi-pinctrl";
37                    reg = <0x19>;
38
39                    pinctrl {
40                        compatible = "nxp,imx95-pinctrl", "nxp,imx93-pinctrl";
41                    };
42                };
43            };
44
45compatible: "arm,scmi"
46
47include: [base.yaml]
48
49properties:
50  shmem:
51    type: phandle
52    required: true
53    description: |
54      Phandle to node describing TX channel shared memory area.
55      This translates to a **single** SCMI transmit channel.
56
57  mboxes:
58    required: true
59    description: |
60      List of mailbox channel specifiers. It should contain one or two specifiers:
61        1) tx - 1 mbox / 1 shmem (platform and agent use the same
62        mailbox channel for signaling)
63        2) tx_reply - 2 mbox / 1 shmem (platform and agent use different
64        mailbox channels for signaling)
65
66  mbox-names:
67    required: true
68    description: mailbox channel specifier names
69