1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/soc/qcom/qcom,aoss-qmp.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Qualcomm Always-On Subsystem side channel
8
9maintainers:
10  - Bjorn Andersson <bjorn.andersson@linaro.org>
11
12description:
13  This binding describes the hardware component responsible for side channel
14  requests to the always-on subsystem (AOSS), used for certain power management
15  requests that is not handled by the standard RPMh interface. Each client in the
16  SoC has its own block of message RAM and IRQ for communication with the AOSS.
17  The protocol used to communicate in the message RAM is known as Qualcomm
18  Messaging Protocol (QMP)
19
20  The AOSS side channel exposes control over a set of resources, used to control
21  a set of debug related clocks and to affect the low power state of resources
22  related to the secondary subsystems.
23
24properties:
25  compatible:
26    items:
27      - enum:
28          - qcom,sc7180-aoss-qmp
29          - qcom,sc7280-aoss-qmp
30          - qcom,sc8180x-aoss-qmp
31          - qcom,sc8280xp-aoss-qmp
32          - qcom,sdm845-aoss-qmp
33          - qcom,sm6350-aoss-qmp
34          - qcom,sm8150-aoss-qmp
35          - qcom,sm8250-aoss-qmp
36          - qcom,sm8350-aoss-qmp
37          - qcom,sm8450-aoss-qmp
38          - qcom,sm8550-aoss-qmp
39      - const: qcom,aoss-qmp
40
41  reg:
42    maxItems: 1
43    description:
44      The base address and size of the message RAM for this client's
45      communication with the AOSS
46
47  interrupts:
48    maxItems: 1
49    description:
50      Should specify the AOSS message IRQ for this client
51
52  mboxes:
53    maxItems: 1
54    description:
55      Reference to the mailbox representing the outgoing doorbell in APCS for
56      this client, as described in mailbox/mailbox.txt
57
58  "#clock-cells":
59    const: 0
60    description:
61      The single clock represents the QDSS clock.
62
63required:
64  - compatible
65  - reg
66  - interrupts
67  - mboxes
68  - "#clock-cells"
69
70additionalProperties: false
71
72patternProperties:
73  "^(cx|mx|ebi)$":
74    type: object
75    description:
76      The AOSS side channel also provides the controls for three cooling devices,
77      these are expressed as subnodes of the QMP node. The name of the node is
78      used to identify the resource and must therefor be "cx", "mx" or "ebi".
79
80    properties:
81      "#cooling-cells":
82        const: 2
83
84    required:
85      - "#cooling-cells"
86
87    additionalProperties: false
88
89examples:
90  - |
91    #include <dt-bindings/interrupt-controller/arm-gic.h>
92
93    aoss_qmp: qmp@c300000 {
94      compatible = "qcom,sdm845-aoss-qmp", "qcom,aoss-qmp";
95      reg = <0x0c300000 0x100000>;
96      interrupts = <GIC_SPI 389 IRQ_TYPE_EDGE_RISING>;
97      mboxes = <&apss_shared 0>;
98
99      #clock-cells = <0>;
100
101      cx_cdev: cx {
102        #cooling-cells = <2>;
103      };
104
105      mx_cdev: mx {
106        #cooling-cells = <2>;
107      };
108    };
109...
110