bindings/firmware/arm%2Cscmi.yaml

1 # SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
4 ---
5 $id: http://devicetree.org/schemas/firmware/arm,scmi.yaml#
6 $schema: http://devicetree.org/meta-schemas/core.yaml#
8 title: System Control and Management Interface (SCMI) Message Protocol
11   - Sudeep Holla <sudeep.holla@arm.com>
14   The SCMI is intended to allow agents such as OSPM to manage various functions
19   the SCMI as described in ARM document number ARM DEN 0056 ("ARM System Control
27     const: scmi
31       - description: SCMI compliant firmware with mailbox transport
33           - const: arm,scmi
34       - description: SCMI compliant firmware with ARM SMC/HVC transport
36           - const: arm,scmi-smc
37       - description: SCMI compliant firmware with ARM SMC/HVC transport
38                      with shmem address(4KB-page, offset) as parameters
40           - const: arm,scmi-smc-param
41       - description: SCMI compliant firmware with SCMI Virtio transport.
44           - const: arm,scmi-virtio
45       - description: SCMI compliant firmware with OP-TEE transport
47           - const: linaro,scmi-optee
52       rather than by the return of the smc call. This should not be used
56   interrupt-names:
59   mbox-names:
61       Specifies the mailboxes used to communicate with SCMI compliant
64       - items:
65           - const: tx
66           - const: rx
68       - items:
69           - const: tx
70           - const: tx_reply
71           - const: rx
83       while two channel descriptors are needed to represent the SCMI ("tx")
86       the SCMI subsystem determine unambiguosly which type of SCMI channels are
88        1 mbox / 1 shmem => SCMI TX over 1 mailbox bidirectional channel
89        2 mbox / 2 shmem => SCMI TX and RX over 2 mailbox bidirectional channels
90        2 mbox / 1 shmem => SCMI TX over 2 mailbox unidirectional channels
91        3 mbox / 2 shmem => SCMI TX and RX over 3 mailbox unidirectional channels
103   '#address-cells':
106   '#size-cells':
109   atomic-threshold-us:
112       platform, the threshold above which any SCMI command, advertised to have
113       an higher-than-threshold execution latency, should not be considered for
117   arm,smc-id:
120       SMC id required when using smc or hvc transports
122   linaro,optee-channel-id:
125       Channel specifier required when using OP-TEE transport.
128     $ref: '#/$defs/protocol-node'
135       '#power-domain-cells':
139       - '#power-domain-cells'
142     $ref: '#/$defs/protocol-node'
149       '#clock-cells':
153       - '#clock-cells'
156     $ref: '#/$defs/protocol-node'
163       '#clock-cells':
167       - '#clock-cells'
170     $ref: '#/$defs/protocol-node'
177       '#thermal-sensor-cells':
181       - '#thermal-sensor-cells'
184     $ref: '#/$defs/protocol-node'
191       '#reset-cells':
195       - '#reset-cells'
198     $ref: '#/$defs/protocol-node'
209           The list of all regulators provided by this SCMI controller.
212           '#address-cells':
215           '#size-cells':
219           '^regulator@[0-9a-f]+$':
230               - reg
233     $ref: '#/$defs/protocol-node'
243   protocol-node:
246       Each sub-node represents a protocol supported. If the platform
255       mbox-names:
257           - items:
258               - const: tx
259               - const: rx
261           - items:
262               - const: tx
263               - const: tx_reply
264               - const: rx
275       linaro,optee-channel-id:
278           Channel specifier required when using OP-TEE transport and
282       - reg
285   - compatible
291         const: arm,scmi
295     interrupt-names: false
298     - mboxes
299     - shmem
307             - arm,scmi-smc
308             - arm,scmi-smc-param
311       - arm,smc-id
312       - shmem
319             const: linaro,scmi-optee
322         - linaro,optee-channel-id
325   - |
327         scmi {
328             compatible = "arm,scmi";
331             mbox-names = "tx", "rx";
335             #address-cells = <1>;
336             #size-cells = <0>;
338             atomic-threshold-us = <10000>;
342                 #power-domain-cells = <1>;
347                 #clock-cells = <1>;
351                 mbox-names = "tx", "rx";
358                 #clock-cells = <1>;
363                 #thermal-sensor-cells = <1>;
368                 #reset-cells = <1>;
374                     #address-cells = <1>;
375                     #size-cells = <0>;
379                         regulator-max-microvolt = <3300000>;
384                         regulator-min-microvolt = <500000>;
385                         regulator-max-microvolt = <4200000>;
397         #address-cells = <2>;
398         #size-cells = <2>;
401             compatible = "mmio-sram";
404             #address-cells = <1>;
405             #size-cells = <1>;
408             cpu_scp_lpri0: scp-sram-section@0 {
409                 compatible = "arm,scmi-shmem";
413             cpu_scp_lpri1: scp-sram-section@80 {
414                 compatible = "arm,scmi-shmem";
418             cpu_scp_hpri0: scp-sram-section@100 {
419                 compatible = "arm,scmi-shmem";
423             cpu_scp_hpri2: scp-sram-section@180 {
424                 compatible = "arm,scmi-shmem";
430   - |
432         scmi {
433             compatible = "arm,scmi-smc";
435             arm,smc-id = <0xc3000001>;
437             #address-cells = <1>;
438             #size-cells = <0>;
442                 #power-domain-cells = <1>;
447   - |
449         scmi {
450             compatible = "linaro,scmi-optee";
451             linaro,optee-channel-id = <0>;
453             #address-cells = <1>;
454             #size-cells = <0>;
458                 linaro,optee-channel-id = <1>;
460                 #clock-cells = <1>;
465                 #clock-cells = <1>;
471         #address-cells = <2>;
472         #size-cells = <2>;
475             compatible = "mmio-sram";
478             #address-cells = <1>;
479             #size-cells = <1>;
482             cpu_optee_lpri0: optee-sram-section@0 {
483                 compatible = "arm,scmi-shmem";