1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/remoteproc/qcom,sc7180-mss-pil.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Qualcomm SC7180 MSS Peripheral Image Loader
8
9maintainers:
10  - Sibi Sankar <quic_sibis@quicinc.com>
11
12description:
13  This document describes the hardware for a component that loads and boots firmware
14  on the Qualcomm Technology Inc. SC7180 Modem Hexagon Core.
15
16properties:
17  compatible:
18    enum:
19      - qcom,sc7180-mss-pil
20
21  reg:
22    items:
23      - description: MSS QDSP6 registers
24      - description: RMB registers
25
26  reg-names:
27    items:
28      - const: qdsp6
29      - const: rmb
30
31  iommus:
32    items:
33      - description: MSA Stream 1
34      - description: MSA Stream 2
35
36  interrupts:
37    items:
38      - description: Watchdog interrupt
39      - description: Fatal interrupt
40      - description: Ready interrupt
41      - description: Handover interrupt
42      - description: Stop acknowledge interrupt
43      - description: Shutdown acknowledge interrupt
44
45  interrupt-names:
46    items:
47      - const: wdog
48      - const: fatal
49      - const: ready
50      - const: handover
51      - const: stop-ack
52      - const: shutdown-ack
53
54  clocks:
55    items:
56      - description: GCC MSS IFACE clock
57      - description: GCC MSS BUS clock
58      - description: GCC MSS NAV clock
59      - description: GCC MSS SNOC_AXI clock
60      - description: GCC MSS MFAB_AXIS clock
61      - description: RPMH XO clock
62
63  clock-names:
64    items:
65      - const: iface
66      - const: bus
67      - const: nav
68      - const: snoc_axi
69      - const: mnoc_axi
70      - const: xo
71
72  power-domains:
73    items:
74      - description: CX power domain
75      - description: MX power domain
76      - description: MSS power domain
77
78  power-domain-names:
79    items:
80      - const: cx
81      - const: mx
82      - const: mss
83
84  resets:
85    items:
86      - description: AOSS restart
87      - description: PDC reset
88
89  reset-names:
90    items:
91      - const: mss_restart
92      - const: pdc_reset
93
94  memory-region:
95    items:
96      - description: MBA reserved region
97      - description: modem reserved region
98
99  firmware-name:
100    $ref: /schemas/types.yaml#/definitions/string-array
101    items:
102      - description: Name of MBA firmware
103      - description: Name of modem firmware
104
105  qcom,halt-regs:
106    $ref: /schemas/types.yaml#/definitions/phandle-array
107    description:
108      Halt registers are used to halt transactions of various sub-components
109      within MSS.
110    items:
111      - items:
112          - description: phandle to TCSR_MUTEX registers
113          - description: offset to the Q6 halt register
114          - description: offset to the modem halt register
115          - description: offset to the nc halt register
116
117  qcom,spare-regs:
118    $ref: /schemas/types.yaml#/definitions/phandle-array
119    description:
120      Spare registers are multipurpose registers used for errata
121      handling.
122    items:
123      - items:
124          - description: phandle to TCSR_MUTEX registers
125          - description: offset to the conn_box_spare0 register
126
127  qcom,qmp:
128    $ref: /schemas/types.yaml#/definitions/phandle
129    description: Reference to the AOSS side-channel message RAM.
130
131  qcom,smem-states:
132    $ref: /schemas/types.yaml#/definitions/phandle-array
133    description: States used by the AP to signal the Hexagon core
134    items:
135      - description: Stop the modem
136
137  qcom,smem-state-names:
138    description: The names of the state bits used for SMP2P output
139    const: stop
140
141  glink-edge:
142    $ref: qcom,glink-edge.yaml#
143    unevaluatedProperties: false
144    description:
145      Qualcomm G-Link subnode which represents communication edge, channels
146      and devices related to the DSP.
147
148    properties:
149      interrupts:
150        items:
151          - description: IRQ from MSS to GLINK
152
153      mboxes:
154        items:
155          - description: Mailbox for communication between APPS and MSS
156
157      label:
158        const: modem
159
160      apr: false
161      fastrpc: false
162
163required:
164  - compatible
165  - reg
166  - reg-names
167  - iommus
168  - interrupts
169  - interrupt-names
170  - clocks
171  - clock-names
172  - power-domains
173  - power-domain-names
174  - resets
175  - reset-names
176  - qcom,halt-regs
177  - qcom,spare-regs
178  - memory-region
179  - qcom,qmp
180  - qcom,smem-states
181  - qcom,smem-state-names
182  - glink-edge
183
184additionalProperties: false
185
186examples:
187  - |
188    #include <dt-bindings/clock/qcom,gcc-sc7180.h>
189    #include <dt-bindings/clock/qcom,rpmh.h>
190    #include <dt-bindings/interrupt-controller/arm-gic.h>
191    #include <dt-bindings/power/qcom-rpmpd.h>
192    #include <dt-bindings/reset/qcom,sdm845-aoss.h>
193    #include <dt-bindings/reset/qcom,sdm845-pdc.h>
194
195    remoteproc_mpss: remoteproc@4080000 {
196        compatible = "qcom,sc7180-mss-pil";
197        reg = <0x04080000 0x10000>, <0x04180000 0x48>;
198        reg-names = "qdsp6", "rmb";
199
200        iommus = <&apps_smmu 0x461 0x0>, <&apps_smmu 0x444 0x3>;
201
202        interrupts-extended = <&intc GIC_SPI 264 IRQ_TYPE_EDGE_RISING>,
203                              <&modem_smp2p_in 0 IRQ_TYPE_EDGE_RISING>,
204                              <&modem_smp2p_in 1 IRQ_TYPE_EDGE_RISING>,
205                              <&modem_smp2p_in 2 IRQ_TYPE_EDGE_RISING>,
206                              <&modem_smp2p_in 3 IRQ_TYPE_EDGE_RISING>,
207                              <&modem_smp2p_in 7 IRQ_TYPE_EDGE_RISING>;
208
209        interrupt-names = "wdog", "fatal", "ready", "handover",
210                          "stop-ack", "shutdown-ack";
211
212        clocks = <&gcc GCC_MSS_CFG_AHB_CLK>,
213                 <&gcc GCC_MSS_Q6_MEMNOC_AXI_CLK>,
214                 <&gcc GCC_MSS_NAV_AXI_CLK>,
215                 <&gcc GCC_MSS_SNOC_AXI_CLK>,
216                 <&gcc GCC_MSS_MFAB_AXIS_CLK>,
217                 <&rpmhcc RPMH_CXO_CLK>;
218        clock-names = "iface", "bus", "nav", "snoc_axi",
219                      "mnoc_axi", "xo";
220
221        power-domains = <&rpmhpd SC7180_CX>,
222                        <&rpmhpd SC7180_MX>,
223                        <&rpmhpd SC7180_MSS>;
224        power-domain-names = "cx", "mx", "mss";
225
226        memory-region = <&mba_mem>, <&mpss_mem>;
227
228        qcom,qmp = <&aoss_qmp>;
229
230        qcom,smem-states = <&modem_smp2p_out 0>;
231        qcom,smem-state-names = "stop";
232
233        resets = <&aoss_reset AOSS_CC_MSS_RESTART>,
234                 <&pdc_reset PDC_MODEM_SYNC_RESET>;
235        reset-names = "mss_restart", "pdc_reset";
236
237        qcom,halt-regs = <&tcsr_mutex_regs 0x23000 0x25000 0x24000>;
238        qcom,spare-regs = <&tcsr_regs 0xb3e4>;
239
240        glink-edge {
241            interrupts = <GIC_SPI 449 IRQ_TYPE_EDGE_RISING>;
242            mboxes = <&apss_shared 12>;
243            qcom,remote-pid = <1>;
244            label = "modem";
245        };
246    };
247