xref: /linux/Documentation/devicetree/bindings/remoteproc/qcom,sc7180-mss-pil.yaml (revision 0526b56cbc3c489642bd6a5fe4b718dea7ef0ee8) 
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      - description: metadata reserved region
99
100  firmware-name:
101    $ref: /schemas/types.yaml#/definitions/string-array
102    items:
103      - description: Name of MBA firmware
104      - description: Name of modem firmware
105
106  qcom,halt-regs:
107    $ref: /schemas/types.yaml#/definitions/phandle-array
108    description:
109      Halt registers are used to halt transactions of various sub-components
110      within MSS.
111    items:
112      - items:
113          - description: phandle to TCSR_MUTEX registers
114          - description: offset to the Q6 halt register
115          - description: offset to the modem halt register
116          - description: offset to the nc halt register
117
118  qcom,spare-regs:
119    $ref: /schemas/types.yaml#/definitions/phandle-array
120    description:
121      Spare registers are multipurpose registers used for errata
122      handling.
123    items:
124      - items:
125          - description: phandle to TCSR_MUTEX registers
126          - description: offset to the conn_box_spare0 register
127
128  qcom,qmp:
129    $ref: /schemas/types.yaml#/definitions/phandle
130    description: Reference to the AOSS side-channel message RAM.
131
132  qcom,smem-states:
133    $ref: /schemas/types.yaml#/definitions/phandle-array
134    description: States used by the AP to signal the Hexagon core
135    items:
136      - description: Stop the modem
137
138  qcom,smem-state-names:
139    description: The names of the state bits used for SMP2P output
140    const: stop
141
142  glink-edge:
143    $ref: qcom,glink-edge.yaml#
144    unevaluatedProperties: false
145    description:
146      Qualcomm G-Link subnode which represents communication edge, channels
147      and devices related to the DSP.
148
149    properties:
150      interrupts:
151        items:
152          - description: IRQ from MSS to GLINK
153
154      mboxes:
155        items:
156          - description: Mailbox for communication between APPS and MSS
157
158      label:
159        const: modem
160
161      apr: false
162      fastrpc: false
163
164required:
165  - compatible
166  - reg
167  - reg-names
168  - iommus
169  - interrupts
170  - interrupt-names
171  - clocks
172  - clock-names
173  - power-domains
174  - power-domain-names
175  - resets
176  - reset-names
177  - qcom,halt-regs
178  - qcom,spare-regs
179  - memory-region
180  - qcom,qmp
181  - qcom,smem-states
182  - qcom,smem-state-names
183  - glink-edge
184
185additionalProperties: false
186
187examples:
188  - |
189    #include <dt-bindings/clock/qcom,gcc-sc7180.h>
190    #include <dt-bindings/clock/qcom,rpmh.h>
191    #include <dt-bindings/interrupt-controller/arm-gic.h>
192    #include <dt-bindings/power/qcom-rpmpd.h>
193    #include <dt-bindings/reset/qcom,sdm845-aoss.h>
194    #include <dt-bindings/reset/qcom,sdm845-pdc.h>
195
196    remoteproc_mpss: remoteproc@4080000 {
197        compatible = "qcom,sc7180-mss-pil";
198        reg = <0x04080000 0x10000>, <0x04180000 0x48>;
199        reg-names = "qdsp6", "rmb";
200
201        iommus = <&apps_smmu 0x461 0x0>, <&apps_smmu 0x444 0x3>;
202
203        interrupts-extended = <&intc GIC_SPI 264 IRQ_TYPE_EDGE_RISING>,
204                              <&modem_smp2p_in 0 IRQ_TYPE_EDGE_RISING>,
205                              <&modem_smp2p_in 1 IRQ_TYPE_EDGE_RISING>,
206                              <&modem_smp2p_in 2 IRQ_TYPE_EDGE_RISING>,
207                              <&modem_smp2p_in 3 IRQ_TYPE_EDGE_RISING>,
208                              <&modem_smp2p_in 7 IRQ_TYPE_EDGE_RISING>;
209
210        interrupt-names = "wdog", "fatal", "ready", "handover",
211                          "stop-ack", "shutdown-ack";
212
213        clocks = <&gcc GCC_MSS_CFG_AHB_CLK>,
214                 <&gcc GCC_MSS_Q6_MEMNOC_AXI_CLK>,
215                 <&gcc GCC_MSS_NAV_AXI_CLK>,
216                 <&gcc GCC_MSS_SNOC_AXI_CLK>,
217                 <&gcc GCC_MSS_MFAB_AXIS_CLK>,
218                 <&rpmhcc RPMH_CXO_CLK>;
219        clock-names = "iface", "bus", "nav", "snoc_axi",
220                      "mnoc_axi", "xo";
221
222        power-domains = <&rpmhpd SC7180_CX>,
223                        <&rpmhpd SC7180_MX>,
224                        <&rpmhpd SC7180_MSS>;
225        power-domain-names = "cx", "mx", "mss";
226
227        memory-region = <&mba_mem>, <&mpss_mem>, <&mdata_mem>;
228
229        qcom,qmp = <&aoss_qmp>;
230
231        qcom,smem-states = <&modem_smp2p_out 0>;
232        qcom,smem-state-names = "stop";
233
234        resets = <&aoss_reset AOSS_CC_MSS_RESTART>,
235                 <&pdc_reset PDC_MODEM_SYNC_RESET>;
236        reset-names = "mss_restart", "pdc_reset";
237
238        qcom,halt-regs = <&tcsr_mutex_regs 0x23000 0x25000 0x24000>;
239        qcom,spare-regs = <&tcsr_regs 0xb3e4>;
240
241        glink-edge {
242            interrupts = <GIC_SPI 449 IRQ_TYPE_EDGE_RISING>;
243            mboxes = <&apss_shared 12>;
244            qcom,remote-pid = <1>;
245            label = "modem";
246        };
247    };
248