summaryrefslogtreecommitdiffstats
path: root/Documentation/devicetree/bindings/remoteproc/qcom,msm8996-mss-pil.yaml
blob: 971734085d512ec8bc7171b401e96198bee107d5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/remoteproc/qcom,msm8996-mss-pil.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Qualcomm MSM8996 MSS Peripheral Image Loader (and similar)

maintainers:
  - Bjorn Andersson <andersson@kernel.org>
  - Sibi Sankar <quic_sibis@quicinc.com>

description:
  MSS Peripheral Image Loader loads and boots firmware on the
  Qualcomm Technology Inc. MSM8996 Modem Hexagon Core (and similar).

properties:
  compatible:
    enum:
      - qcom,msm8996-mss-pil
      - qcom,msm8998-mss-pil
      - qcom,sdm660-mss-pil
      - qcom,sdm845-mss-pil

  reg:
    items:
      - description: MSS QDSP6 registers
      - description: RMB registers

  reg-names:
    items:
      - const: qdsp6
      - const: rmb

  iommus:
    items:
      - description: MSA Stream 1
      - description: MSA Stream 2

  interrupts:
    items:
      - description: Watchdog interrupt
      - description: Fatal interrupt
      - description: Ready interrupt
      - description: Handover interrupt
      - description: Stop acknowledge interrupt
      - description: Shutdown acknowledge interrupt

  interrupt-names:
    items:
      - const: wdog
      - const: fatal
      - const: ready
      - const: handover
      - const: stop-ack
      - const: shutdown-ack

  clocks:
    minItems: 8
    maxItems: 9

  clock-names:
    minItems: 8
    maxItems: 9

  power-domains:
    items:
      - description: CX power domain
      - description: MX power domain
      - description: MSS power domain (only valid for qcom,sdm845-mss-pil)
    minItems: 2

  power-domain-names:
    items:
      - const: cx
      - const: mx
      - const: mss # only valid for qcom,sdm845-mss-pil
    minItems: 2

  pll-supply:
    description: PLL supply

  resets:
    items:
      - description: AOSS restart
      - description: PDC reset (only valid for qcom,sdm845-mss-pil)
    minItems: 1

  reset-names:
    items:
      - const: mss_restart
      - const: pdc_reset # only valid for qcom,sdm845-mss-pil
    minItems: 1

  qcom,qmp:
    $ref: /schemas/types.yaml#/definitions/phandle
    description: Reference to the AOSS side-channel message RAM.

  qcom,smem-states:
    $ref: /schemas/types.yaml#/definitions/phandle-array
    description: States used by the AP to signal the Hexagon core
    items:
      - description: Stop modem

  qcom,smem-state-names:
    description: Names of the states used by the AP to signal the Hexagon core
    items:
      - const: stop

  qcom,halt-regs:
    $ref: /schemas/types.yaml#/definitions/phandle-array
    description:
      Halt registers are used to halt transactions of various sub-components
      within MSS.
    items:
      - items:
          - description: phandle to TCSR syscon region
          - description: offset to the Q6 halt register
          - description: offset to the modem halt register
          - description: offset to the nc halt register

  memory-region:
    items:
      - description: MBA reserved region
      - description: Modem reserved region
      - description: Metadata reserved region

  firmware-name:
    $ref: /schemas/types.yaml#/definitions/string-array
    items:
      - description: Name of MBA firmware
      - description: Name of modem firmware

  smd-edge:
    $ref: /schemas/remoteproc/qcom,smd-edge.yaml#
    description:
      Qualcomm Shared Memory subnode which represents communication edge,
      channels and devices related to the Modem.
    unevaluatedProperties: false

  glink-edge:
    $ref: /schemas/remoteproc/qcom,glink-edge.yaml#
    description:
      Qualcomm G-Link subnode which represents communication edge, channels
      and devices related to the Modem.
    unevaluatedProperties: false

  # Deprecated properties
  mba:
    type: object
    description:
      MBA reserved region

    properties:
      memory-region: true

    required:
      - memory-region

    additionalProperties: false
    deprecated: true

  mpss:
    type: object
    description:
      MPSS reserved region

    properties:
      memory-region: true

    required:
      - memory-region

    additionalProperties: false
    deprecated: true

  metadata:
    type: object
    description:
      Metadata reserved region

    properties:
      memory-region: true

    required:
      - memory-region

    additionalProperties: false
    deprecated: true

required:
  - compatible
  - reg
  - reg-names
  - interrupts
  - interrupt-names
  - clocks
  - clock-names
  - power-domains
  - power-domain-names
  - resets
  - reset-names
  - qcom,halt-regs
  - qcom,smem-states
  - qcom,smem-state-names

allOf:
  - if:
      properties:
        compatible:
          const: qcom,msm8996-mss-pil
    then:
      properties:
        clocks:
          items:
            - description: GCC MSS IFACE clock
            - description: GCC MSS BUS clock
            - description: GCC MSS MEM clock
            - description: RPM XO clock
            - description: GCC MSS GPLL0 clock
            - description: GCC MSS SNOC_AXI clock
            - description: GCC MSS MNOC_AXI clock
            - description: RPM QDSS clock
        clock-names:
          items:
            - const: iface
            - const: bus
            - const: mem
            - const: xo
            - const: gpll0_mss
            - const: snoc_axi
            - const: mnoc_axi
            - const: qdss
        glink-edge: false
      required:
        - pll-supply
        - smd-edge
    else:
      properties:
        pll-supply: false
        smd-edge: false

  - if:
      properties:
        compatible:
          enum:
            - qcom,msm8998-mss-pil
            - qcom,sdm660-mss-pil
    then:
      properties:
        clocks:
          items:
            - description: GCC MSS IFACE clock
            - description: GCC MSS BUS clock
            - description: GCC MSS MEM clock
            - description: GCC MSS GPLL0 clock
            - description: GCC MSS SNOC_AXI clock
            - description: GCC MSS MNOC_AXI clock
            - description: RPMH QDSS clock
            - description: RPMH XO clock
        clock-names:
          items:
            - const: iface
            - const: bus
            - const: mem
            - const: gpll0_mss
            - const: snoc_axi
            - const: mnoc_axi
            - const: qdss
            - const: xo
      required:
        - glink-edge

  - if:
      properties:
        compatible:
          const: qcom,sdm845-mss-pil
    then:
      properties:
        power-domains:
          minItems: 3
        power-domain-names:
          minItems: 3
        resets:
          minItems: 2
        reset-names:
          minItems: 2
        clocks:
          items:
            - description: GCC MSS IFACE clock
            - description: GCC MSS BUS clock
            - description: GCC MSS MEM clock
            - description: GCC MSS GPLL0 clock
            - description: GCC MSS SNOC_AXI clock
            - description: GCC MSS MNOC_AXI clock
            - description: GCC MSS PRNG clock
            - description: RPMH XO clock
        clock-names:
          items:
            - const: iface
            - const: bus
            - const: mem
            - const: gpll0_mss
            - const: snoc_axi
            - const: mnoc_axi
            - const: prng
            - const: xo
      required:
        - qcom,qmp
        - glink-edge
    else:
      properties:
        iommus: false
        power-domains:
          maxItems: 2
        power-domain-names:
          maxItems: 2
        resets:
          maxItems: 1
        reset-names:
          maxItems: 1
        qcom,qmp: false

  # Fallbacks for deprecated properties
  - oneOf:
      - required:
          - memory-region
      - required:
          - mba
          - mpss
          - metadata

additionalProperties: false

examples:
  - |
    #include <dt-bindings/clock/qcom,gcc-sdm845.h>
    #include <dt-bindings/clock/qcom,rpmh.h>
    #include <dt-bindings/interrupt-controller/arm-gic.h>
    #include <dt-bindings/power/qcom-rpmpd.h>
    #include <dt-bindings/reset/qcom,sdm845-aoss.h>
    #include <dt-bindings/reset/qcom,sdm845-pdc.h>

    remoteproc@4080000 {
        compatible = "qcom,sdm845-mss-pil";
        reg = <0x04080000 0x408>, <0x04180000 0x48>;
        reg-names = "qdsp6", "rmb";

        interrupts-extended = <&intc GIC_SPI 266 IRQ_TYPE_EDGE_RISING>,
                              <&modem_smp2p_in 0 IRQ_TYPE_EDGE_RISING>,
                              <&modem_smp2p_in 1 IRQ_TYPE_EDGE_RISING>,
                              <&modem_smp2p_in 2 IRQ_TYPE_EDGE_RISING>,
                              <&modem_smp2p_in 3 IRQ_TYPE_EDGE_RISING>,
                              <&modem_smp2p_in 7 IRQ_TYPE_EDGE_RISING>;
        interrupt-names = "wdog", "fatal", "ready", "handover", "stop-ack",
                          "shutdown-ack";

        clocks = <&gcc GCC_MSS_CFG_AHB_CLK>,
                 <&gcc GCC_MSS_Q6_MEMNOC_AXI_CLK>,
                 <&gcc GCC_BOOT_ROM_AHB_CLK>,
                 <&gcc GCC_MSS_GPLL0_DIV_CLK_SRC>,
                 <&gcc GCC_MSS_SNOC_AXI_CLK>,
                 <&gcc GCC_MSS_MFAB_AXIS_CLK>,
                 <&gcc GCC_PRNG_AHB_CLK>,
                 <&rpmhcc RPMH_CXO_CLK>;
        clock-names = "iface", "bus", "mem", "gpll0_mss",
                      "snoc_axi", "mnoc_axi", "prng", "xo";

        power-domains = <&rpmhpd SDM845_CX>,
                        <&rpmhpd SDM845_MX>,
                        <&rpmhpd SDM845_MSS>;
        power-domain-names = "cx", "mx", "mss";

        memory-region = <&mba_mem>, <&mpss_mem>, <&mdata_mem>;

        resets = <&aoss_reset AOSS_CC_MSS_RESTART>,
                 <&pdc_reset PDC_MODEM_SYNC_RESET>;
        reset-names = "mss_restart", "pdc_reset";

        qcom,halt-regs = <&tcsr_regs_1 0x3000 0x5000 0x4000>;

        qcom,qmp = <&aoss_qmp>;

        qcom,smem-states = <&modem_smp2p_out 0>;
        qcom,smem-state-names = "stop";

        glink-edge {
            interrupts = <GIC_SPI 449 IRQ_TYPE_EDGE_RISING>;
            label = "modem";
            qcom,remote-pid = <1>;
            mboxes = <&apss_shared 12>;
        };
    };