xref: /linux/Documentation/devicetree/bindings/net/wireless/qcom,ath11k.yaml (revision 348f968b89bfeec0bb53dd82dba58b94d97fbd34)
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2# Copyright (c) 2018-2019 The Linux Foundation. All rights reserved.
3%YAML 1.2
4---
5$id: http://devicetree.org/schemas/net/wireless/qcom,ath11k.yaml#
6$schema: http://devicetree.org/meta-schemas/core.yaml#
7
8title: Qualcomm Technologies ath11k wireless devices
9
10maintainers:
11  - Jeff Johnson <jjohnson@kernel.org>
12
13description: |
14  These are dt entries for Qualcomm Technologies, Inc. IEEE 802.11ax
15  devices, for example like AHB based IPQ8074.
16
17properties:
18  compatible:
19    enum:
20      - qcom,ipq8074-wifi
21      - qcom,ipq6018-wifi
22      - qcom,wcn6750-wifi
23      - qcom,ipq5018-wifi
24
25  reg:
26    maxItems: 1
27
28  interrupts:
29    minItems: 32
30    maxItems: 52
31
32  interrupt-names:
33    maxItems: 52
34
35  qcom,rproc:
36    $ref: /schemas/types.yaml#/definitions/phandle
37    description:
38      DT entry of q6v5-wcss remoteproc driver.
39      Phandle to a node that can contain the following properties
40        * compatible
41        * reg
42        * reg-names
43
44  qcom,ath11k-calibration-variant:
45    $ref: /schemas/types.yaml#/definitions/string
46    description:
47      string to uniquely identify variant of the calibration data in the
48      board-2.bin for designs with colliding bus and device specific ids
49
50  memory-region:
51    minItems: 1
52    maxItems: 2
53    description:
54      phandle to a node describing reserved memory (System RAM memory)
55      used by ath11k firmware (see bindings/reserved-memory/reserved-memory.txt)
56
57  iommus:
58    minItems: 1
59    maxItems: 2
60
61  ieee80211-freq-limit: true
62
63  wifi-firmware:
64    type: object
65    description: |
66      WCN6750 wifi node can contain one optional firmware subnode.
67      Firmware subnode is needed when the platform does not have Trustzone.
68    required:
69      - iommus
70
71  qcom,smem-states:
72    $ref: /schemas/types.yaml#/definitions/phandle-array
73    description: State bits used by the AP to signal the WLAN Q6.
74    items:
75      - description: Signal bits used to enable/disable low power mode
76                     on WCN6750 in the case of WoW (Wake on Wireless).
77
78  qcom,smem-state-names:
79    description: The names of the state bits used for SMP2P output.
80    items:
81      - const: wlan-smp2p-out
82
83required:
84  - compatible
85  - reg
86  - interrupts
87  - qcom,rproc
88
89additionalProperties: false
90
91allOf:
92  - $ref: ieee80211.yaml#
93  - if:
94      properties:
95        compatible:
96          contains:
97            enum:
98              - qcom,ipq8074-wifi
99              - qcom,ipq6018-wifi
100    then:
101      properties:
102        interrupts:
103          items:
104            - description: misc-pulse1 interrupt events
105            - description: misc-latch interrupt events
106            - description: sw exception interrupt events
107            - description: watchdog interrupt events
108            - description: interrupt event for ring CE0
109            - description: interrupt event for ring CE1
110            - description: interrupt event for ring CE2
111            - description: interrupt event for ring CE3
112            - description: interrupt event for ring CE4
113            - description: interrupt event for ring CE5
114            - description: interrupt event for ring CE6
115            - description: interrupt event for ring CE7
116            - description: interrupt event for ring CE8
117            - description: interrupt event for ring CE9
118            - description: interrupt event for ring CE10
119            - description: interrupt event for ring CE11
120            - description: interrupt event for ring host2wbm-desc-feed
121            - description: interrupt event for ring host2reo-re-injection
122            - description: interrupt event for ring host2reo-command
123            - description: interrupt event for ring host2rxdma-monitor-ring3
124            - description: interrupt event for ring host2rxdma-monitor-ring2
125            - description: interrupt event for ring host2rxdma-monitor-ring1
126            - description: interrupt event for ring reo2ost-exception
127            - description: interrupt event for ring wbm2host-rx-release
128            - description: interrupt event for ring reo2host-status
129            - description: interrupt event for ring reo2host-destination-ring4
130            - description: interrupt event for ring reo2host-destination-ring3
131            - description: interrupt event for ring reo2host-destination-ring2
132            - description: interrupt event for ring reo2host-destination-ring1
133            - description: interrupt event for ring rxdma2host-monitor-destination-mac3
134            - description: interrupt event for ring rxdma2host-monitor-destination-mac2
135            - description: interrupt event for ring rxdma2host-monitor-destination-mac1
136            - description: interrupt event for ring ppdu-end-interrupts-mac3
137            - description: interrupt event for ring ppdu-end-interrupts-mac2
138            - description: interrupt event for ring ppdu-end-interrupts-mac1
139            - description: interrupt event for ring rxdma2host-monitor-status-ring-mac3
140            - description: interrupt event for ring rxdma2host-monitor-status-ring-mac2
141            - description: interrupt event for ring rxdma2host-monitor-status-ring-mac1
142            - description: interrupt event for ring host2rxdma-host-buf-ring-mac3
143            - description: interrupt event for ring host2rxdma-host-buf-ring-mac2
144            - description: interrupt event for ring host2rxdma-host-buf-ring-mac1
145            - description: interrupt event for ring rxdma2host-destination-ring-mac3
146            - description: interrupt event for ring rxdma2host-destination-ring-mac2
147            - description: interrupt event for ring rxdma2host-destination-ring-mac1
148            - description: interrupt event for ring host2tcl-input-ring4
149            - description: interrupt event for ring host2tcl-input-ring3
150            - description: interrupt event for ring host2tcl-input-ring2
151            - description: interrupt event for ring host2tcl-input-ring1
152            - description: interrupt event for ring wbm2host-tx-completions-ring3
153            - description: interrupt event for ring wbm2host-tx-completions-ring2
154            - description: interrupt event for ring wbm2host-tx-completions-ring1
155            - description: interrupt event for ring tcl2host-status-ring
156        interrupt-names:
157          items:
158            - const: misc-pulse1
159            - const: misc-latch
160            - const: sw-exception
161            - const: watchdog
162            - const: ce0
163            - const: ce1
164            - const: ce2
165            - const: ce3
166            - const: ce4
167            - const: ce5
168            - const: ce6
169            - const: ce7
170            - const: ce8
171            - const: ce9
172            - const: ce10
173            - const: ce11
174            - const: host2wbm-desc-feed
175            - const: host2reo-re-injection
176            - const: host2reo-command
177            - const: host2rxdma-monitor-ring3
178            - const: host2rxdma-monitor-ring2
179            - const: host2rxdma-monitor-ring1
180            - const: reo2ost-exception
181            - const: wbm2host-rx-release
182            - const: reo2host-status
183            - const: reo2host-destination-ring4
184            - const: reo2host-destination-ring3
185            - const: reo2host-destination-ring2
186            - const: reo2host-destination-ring1
187            - const: rxdma2host-monitor-destination-mac3
188            - const: rxdma2host-monitor-destination-mac2
189            - const: rxdma2host-monitor-destination-mac1
190            - const: ppdu-end-interrupts-mac3
191            - const: ppdu-end-interrupts-mac2
192            - const: ppdu-end-interrupts-mac1
193            - const: rxdma2host-monitor-status-ring-mac3
194            - const: rxdma2host-monitor-status-ring-mac2
195            - const: rxdma2host-monitor-status-ring-mac1
196            - const: host2rxdma-host-buf-ring-mac3
197            - const: host2rxdma-host-buf-ring-mac2
198            - const: host2rxdma-host-buf-ring-mac1
199            - const: rxdma2host-destination-ring-mac3
200            - const: rxdma2host-destination-ring-mac2
201            - const: rxdma2host-destination-ring-mac1
202            - const: host2tcl-input-ring4
203            - const: host2tcl-input-ring3
204            - const: host2tcl-input-ring2
205            - const: host2tcl-input-ring1
206            - const: wbm2host-tx-completions-ring3
207            - const: wbm2host-tx-completions-ring2
208            - const: wbm2host-tx-completions-ring1
209            - const: tcl2host-status-ring
210
211  - if:
212      properties:
213        compatible:
214          contains:
215            enum:
216              - qcom,ipq8074-wifi
217              - qcom,ipq6018-wifi
218    then:
219      required:
220        - interrupt-names
221
222  - if:
223      properties:
224        compatible:
225          contains:
226            enum:
227              - qcom,wcn6750-wifi
228    then:
229      properties:
230        interrupts:
231          items:
232            - description: interrupt event for ring CE1
233            - description: interrupt event for ring CE2
234            - description: interrupt event for ring CE3
235            - description: interrupt event for ring CE4
236            - description: interrupt event for ring CE5
237            - description: interrupt event for ring CE6
238            - description: interrupt event for ring CE7
239            - description: interrupt event for ring CE8
240            - description: interrupt event for ring CE9
241            - description: interrupt event for ring CE10
242            - description: interrupt event for ring DP1
243            - description: interrupt event for ring DP2
244            - description: interrupt event for ring DP3
245            - description: interrupt event for ring DP4
246            - description: interrupt event for ring DP5
247            - description: interrupt event for ring DP6
248            - description: interrupt event for ring DP7
249            - description: interrupt event for ring DP8
250            - description: interrupt event for ring DP9
251            - description: interrupt event for ring DP10
252            - description: interrupt event for ring DP11
253            - description: interrupt event for ring DP12
254            - description: interrupt event for ring DP13
255            - description: interrupt event for ring DP14
256            - description: interrupt event for ring DP15
257            - description: interrupt event for ring DP16
258            - description: interrupt event for ring DP17
259            - description: interrupt event for ring DP18
260            - description: interrupt event for ring DP19
261            - description: interrupt event for ring DP20
262            - description: interrupt event for ring DP21
263            - description: interrupt event for ring DP22
264
265examples:
266  - |
267    wifi0: wifi@c000000 {
268        compatible = "qcom,ipq8074-wifi";
269        reg = <0xc000000 0x2000000>;
270        interrupts = <0 320 1>,
271                     <0 319 1>,
272                     <0 318 1>,
273                     <0 317 1>,
274                     <0 316 1>,
275                     <0 315 1>,
276                     <0 314 1>,
277                     <0 311 1>,
278                     <0 310 1>,
279                     <0 411 1>,
280                     <0 410 1>,
281                     <0 40 1>,
282                     <0 39 1>,
283                     <0 302 1>,
284                     <0 301 1>,
285                     <0 37 1>,
286                     <0 36 1>,
287                     <0 296 1>,
288                     <0 295 1>,
289                     <0 294 1>,
290                     <0 293 1>,
291                     <0 292 1>,
292                     <0 291 1>,
293                     <0 290 1>,
294                     <0 289 1>,
295                     <0 288 1>,
296                     <0 239 1>,
297                     <0 236 1>,
298                     <0 235 1>,
299                     <0 234 1>,
300                     <0 233 1>,
301                     <0 232 1>,
302                     <0 231 1>,
303                     <0 230 1>,
304                     <0 229 1>,
305                     <0 228 1>,
306                     <0 224 1>,
307                     <0 223 1>,
308                     <0 203 1>,
309                     <0 183 1>,
310                     <0 180 1>,
311                     <0 179 1>,
312                     <0 178 1>,
313                     <0 177 1>,
314                     <0 176 1>,
315                     <0 163 1>,
316                     <0 162 1>,
317                     <0 160 1>,
318                     <0 159 1>,
319                     <0 158 1>,
320                     <0 157 1>,
321                     <0 156 1>;
322        interrupt-names = "misc-pulse1",
323                          "misc-latch",
324                          "sw-exception",
325                          "watchdog",
326                          "ce0",
327                          "ce1",
328                          "ce2",
329                          "ce3",
330                          "ce4",
331                          "ce5",
332                          "ce6",
333                          "ce7",
334                          "ce8",
335                          "ce9",
336                          "ce10",
337                          "ce11",
338                          "host2wbm-desc-feed",
339                          "host2reo-re-injection",
340                          "host2reo-command",
341                          "host2rxdma-monitor-ring3",
342                          "host2rxdma-monitor-ring2",
343                          "host2rxdma-monitor-ring1",
344                          "reo2ost-exception",
345                          "wbm2host-rx-release",
346                          "reo2host-status",
347                          "reo2host-destination-ring4",
348                          "reo2host-destination-ring3",
349                          "reo2host-destination-ring2",
350                          "reo2host-destination-ring1",
351                          "rxdma2host-monitor-destination-mac3",
352                          "rxdma2host-monitor-destination-mac2",
353                          "rxdma2host-monitor-destination-mac1",
354                          "ppdu-end-interrupts-mac3",
355                          "ppdu-end-interrupts-mac2",
356                          "ppdu-end-interrupts-mac1",
357                          "rxdma2host-monitor-status-ring-mac3",
358                          "rxdma2host-monitor-status-ring-mac2",
359                          "rxdma2host-monitor-status-ring-mac1",
360                          "host2rxdma-host-buf-ring-mac3",
361                          "host2rxdma-host-buf-ring-mac2",
362                          "host2rxdma-host-buf-ring-mac1",
363                          "rxdma2host-destination-ring-mac3",
364                          "rxdma2host-destination-ring-mac2",
365                          "rxdma2host-destination-ring-mac1",
366                          "host2tcl-input-ring4",
367                          "host2tcl-input-ring3",
368                          "host2tcl-input-ring2",
369                          "host2tcl-input-ring1",
370                          "wbm2host-tx-completions-ring3",
371                          "wbm2host-tx-completions-ring2",
372                          "wbm2host-tx-completions-ring1",
373                          "tcl2host-status-ring";
374        qcom,rproc = <&q6v5_wcss>;
375    };
376
377  - |
378
379    reserved-memory {
380        #address-cells = <2>;
381        #size-cells = <2>;
382
383        qcn9074_0: wifi@51100000 {
384            no-map;
385            reg = <0x0 0x51100000 0x0 0x03500000>;
386        };
387    };
388
389    pci {
390        pcie0 {
391            #size-cells = <2>;
392            #address-cells = <3>;
393
394            wifi_0: wifi@0 {
395                reg = <0 0 0 0 0>;
396                memory-region = <&qcn9074_0>;
397            };
398        };
399    };
400
401  - |
402    #include <dt-bindings/interrupt-controller/arm-gic.h>
403
404    reserved-memory {
405        #address-cells = <2>;
406        #size-cells = <2>;
407
408        wlan_ce_mem: memory@4cd000 {
409            no-map;
410            reg = <0x0 0x004cd000 0x0 0x1000>;
411        };
412
413        wlan_fw_mem: memory@80c00000 {
414            no-map;
415            reg = <0x0 0x80c00000 0x0 0xc00000>;
416        };
417    };
418
419    wifi: wifi@17a10040 {
420        compatible = "qcom,wcn6750-wifi";
421        reg = <0x17a10040 0x0>;
422        iommus = <&apps_smmu 0x1c00 0x1>;
423        interrupts = <GIC_SPI 768 IRQ_TYPE_EDGE_RISING>,
424                     <GIC_SPI 769 IRQ_TYPE_EDGE_RISING>,
425                     <GIC_SPI 770 IRQ_TYPE_EDGE_RISING>,
426                     <GIC_SPI 771 IRQ_TYPE_EDGE_RISING>,
427                     <GIC_SPI 772 IRQ_TYPE_EDGE_RISING>,
428                     <GIC_SPI 773 IRQ_TYPE_EDGE_RISING>,
429                     <GIC_SPI 774 IRQ_TYPE_EDGE_RISING>,
430                     <GIC_SPI 775 IRQ_TYPE_EDGE_RISING>,
431                     <GIC_SPI 776 IRQ_TYPE_EDGE_RISING>,
432                     <GIC_SPI 777 IRQ_TYPE_EDGE_RISING>,
433                     <GIC_SPI 778 IRQ_TYPE_EDGE_RISING>,
434                     <GIC_SPI 779 IRQ_TYPE_EDGE_RISING>,
435                     <GIC_SPI 780 IRQ_TYPE_EDGE_RISING>,
436                     <GIC_SPI 781 IRQ_TYPE_EDGE_RISING>,
437                     <GIC_SPI 782 IRQ_TYPE_EDGE_RISING>,
438                     <GIC_SPI 783 IRQ_TYPE_EDGE_RISING>,
439                     <GIC_SPI 784 IRQ_TYPE_EDGE_RISING>,
440                     <GIC_SPI 785 IRQ_TYPE_EDGE_RISING>,
441                     <GIC_SPI 786 IRQ_TYPE_EDGE_RISING>,
442                     <GIC_SPI 787 IRQ_TYPE_EDGE_RISING>,
443                     <GIC_SPI 788 IRQ_TYPE_EDGE_RISING>,
444                     <GIC_SPI 789 IRQ_TYPE_EDGE_RISING>,
445                     <GIC_SPI 790 IRQ_TYPE_EDGE_RISING>,
446                     <GIC_SPI 791 IRQ_TYPE_EDGE_RISING>,
447                     <GIC_SPI 792 IRQ_TYPE_EDGE_RISING>,
448                     <GIC_SPI 793 IRQ_TYPE_EDGE_RISING>,
449                     <GIC_SPI 794 IRQ_TYPE_EDGE_RISING>,
450                     <GIC_SPI 795 IRQ_TYPE_EDGE_RISING>,
451                     <GIC_SPI 796 IRQ_TYPE_EDGE_RISING>,
452                     <GIC_SPI 797 IRQ_TYPE_EDGE_RISING>,
453                     <GIC_SPI 798 IRQ_TYPE_EDGE_RISING>,
454                     <GIC_SPI 799 IRQ_TYPE_EDGE_RISING>;
455        qcom,rproc = <&remoteproc_wpss>;
456        memory-region = <&wlan_fw_mem>, <&wlan_ce_mem>;
457        qcom,smem-states = <&wlan_smp2p_out 0>;
458        qcom,smem-state-names = "wlan-smp2p-out";
459        wifi-firmware {
460            iommus = <&apps_smmu 0x1c02 0x1>;
461        };
462    };
463