xref: /linux/Documentation/devicetree/bindings/soc/qcom/qcom,aoss-qmp.yaml (revision cdd30ebb1b9f36159d66f088b61aee264e649d7a) 
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,qcs8300-aoss-qmp
29          - qcom,qdu1000-aoss-qmp
30          - qcom,sa8255p-aoss-qmp
31          - qcom,sa8775p-aoss-qmp
32          - qcom,sar2130p-aoss-qmp
33          - qcom,sc7180-aoss-qmp
34          - qcom,sc7280-aoss-qmp
35          - qcom,sc8180x-aoss-qmp
36          - qcom,sc8280xp-aoss-qmp
37          - qcom,sdx75-aoss-qmp
38          - qcom,sdm845-aoss-qmp
39          - qcom,sm6350-aoss-qmp
40          - qcom,sm8150-aoss-qmp
41          - qcom,sm8250-aoss-qmp
42          - qcom,sm8350-aoss-qmp
43          - qcom,sm8450-aoss-qmp
44          - qcom,sm8550-aoss-qmp
45          - qcom,sm8650-aoss-qmp
46          - qcom,sm8750-aoss-qmp
47          - qcom,x1e80100-aoss-qmp
48      - const: qcom,aoss-qmp
49
50  reg:
51    maxItems: 1
52    description:
53      The base address and size of the message RAM for this client's
54      communication with the AOSS
55
56  interrupts:
57    maxItems: 1
58    description:
59      Should specify the AOSS message IRQ for this client
60
61  mboxes:
62    maxItems: 1
63    description:
64      Reference to the mailbox representing the outgoing doorbell in APCS for
65      this client, as described in mailbox/mailbox.txt
66
67  "#clock-cells":
68    const: 0
69    description:
70      The single clock represents the QDSS clock.
71
72required:
73  - compatible
74  - reg
75  - interrupts
76  - mboxes
77  - "#clock-cells"
78
79additionalProperties: false
80
81patternProperties:
82  "^(cx|mx|ebi)$":
83    type: object
84    description:
85      The AOSS side channel also provides the controls for three cooling devices,
86      these are expressed as subnodes of the QMP node. The name of the node is
87      used to identify the resource and must therefore be "cx", "mx" or "ebi".
88
89    properties:
90      "#cooling-cells":
91        const: 2
92
93    required:
94      - "#cooling-cells"
95
96    additionalProperties: false
97
98examples:
99  - |
100    #include <dt-bindings/interrupt-controller/arm-gic.h>
101
102    aoss_qmp: qmp@c300000 {
103      compatible = "qcom,sdm845-aoss-qmp", "qcom,aoss-qmp";
104      reg = <0x0c300000 0x100000>;
105      interrupts = <GIC_SPI 389 IRQ_TYPE_EDGE_RISING>;
106      mboxes = <&apss_shared 0>;
107
108      #clock-cells = <0>;
109
110      cx_cdev: cx {
111        #cooling-cells = <2>;
112      };
113
114      mx_cdev: mx {
115        #cooling-cells = <2>;
116      };
117    };
118...
119