c20e84e031fad0e417ceee609bead26d94ab5b42
[platform/kernel/linux-starfive.git] / drivers / net / wireless / ath / ath11k / core.h
1 /* SPDX-License-Identifier: BSD-3-Clause-Clear */
2 /*
3  * Copyright (c) 2018-2019 The Linux Foundation. All rights reserved.
4  * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
5  */
6
7 #ifndef ATH11K_CORE_H
8 #define ATH11K_CORE_H
9
10 #include <linux/types.h>
11 #include <linux/interrupt.h>
12 #include <linux/irq.h>
13 #include <linux/bitfield.h>
14 #include <linux/dmi.h>
15 #include <linux/ctype.h>
16 #include <linux/rhashtable.h>
17 #include <linux/average.h>
18 #include "qmi.h"
19 #include "htc.h"
20 #include "wmi.h"
21 #include "hal.h"
22 #include "dp.h"
23 #include "ce.h"
24 #include "mac.h"
25 #include "hw.h"
26 #include "hal_rx.h"
27 #include "reg.h"
28 #include "thermal.h"
29 #include "dbring.h"
30 #include "spectral.h"
31 #include "wow.h"
32
33 #define SM(_v, _f) (((_v) << _f##_LSB) & _f##_MASK)
34
35 #define ATH11K_TX_MGMT_NUM_PENDING_MAX  512
36
37 #define ATH11K_TX_MGMT_TARGET_MAX_SUPPORT_WMI 64
38
39 /* Pending management packets threshold for dropping probe responses */
40 #define ATH11K_PRB_RSP_DROP_THRESHOLD ((ATH11K_TX_MGMT_TARGET_MAX_SUPPORT_WMI * 3) / 4)
41
42 #define ATH11K_INVALID_HW_MAC_ID        0xFF
43 #define ATH11K_CONNECTION_LOSS_HZ       (3 * HZ)
44
45 /* SMBIOS type containing Board Data File Name Extension */
46 #define ATH11K_SMBIOS_BDF_EXT_TYPE 0xF8
47
48 /* SMBIOS type structure length (excluding strings-set) */
49 #define ATH11K_SMBIOS_BDF_EXT_LENGTH 0x9
50
51 /* The magic used by QCA spec */
52 #define ATH11K_SMBIOS_BDF_EXT_MAGIC "BDF_"
53
54 extern unsigned int ath11k_frame_mode;
55
56 #define ATH11K_SCAN_TIMEOUT_HZ (20 * HZ)
57
58 #define ATH11K_MON_TIMER_INTERVAL  10
59 #define ATH11K_RESET_TIMEOUT_HZ (20 * HZ)
60 #define ATH11K_RESET_MAX_FAIL_COUNT_FIRST 3
61 #define ATH11K_RESET_MAX_FAIL_COUNT_FINAL 5
62 #define ATH11K_RESET_FAIL_TIMEOUT_HZ (20 * HZ)
63 #define ATH11K_RECONFIGURE_TIMEOUT_HZ (10 * HZ)
64 #define ATH11K_RECOVER_START_TIMEOUT_HZ (20 * HZ)
65
66 enum ath11k_supported_bw {
67         ATH11K_BW_20    = 0,
68         ATH11K_BW_40    = 1,
69         ATH11K_BW_80    = 2,
70         ATH11K_BW_160   = 3,
71 };
72
73 enum ath11k_bdf_search {
74         ATH11K_BDF_SEARCH_DEFAULT,
75         ATH11K_BDF_SEARCH_BUS_AND_BOARD,
76 };
77
78 enum wme_ac {
79         WME_AC_BE,
80         WME_AC_BK,
81         WME_AC_VI,
82         WME_AC_VO,
83         WME_NUM_AC
84 };
85
86 #define ATH11K_HT_MCS_MAX       7
87 #define ATH11K_VHT_MCS_MAX      9
88 #define ATH11K_HE_MCS_MAX       11
89
90 enum ath11k_crypt_mode {
91         /* Only use hardware crypto engine */
92         ATH11K_CRYPT_MODE_HW,
93         /* Only use software crypto */
94         ATH11K_CRYPT_MODE_SW,
95 };
96
97 static inline enum wme_ac ath11k_tid_to_ac(u32 tid)
98 {
99         return (((tid == 0) || (tid == 3)) ? WME_AC_BE :
100                 ((tid == 1) || (tid == 2)) ? WME_AC_BK :
101                 ((tid == 4) || (tid == 5)) ? WME_AC_VI :
102                 WME_AC_VO);
103 }
104
105 enum ath11k_skb_flags {
106         ATH11K_SKB_HW_80211_ENCAP = BIT(0),
107         ATH11K_SKB_CIPHER_SET = BIT(1),
108 };
109
110 struct ath11k_skb_cb {
111         dma_addr_t paddr;
112         u8 eid;
113         u8 flags;
114         u32 cipher;
115         struct ath11k *ar;
116         struct ieee80211_vif *vif;
117 } __packed;
118
119 struct ath11k_skb_rxcb {
120         dma_addr_t paddr;
121         bool is_first_msdu;
122         bool is_last_msdu;
123         bool is_continuation;
124         bool is_mcbc;
125         bool is_eapol;
126         struct hal_rx_desc *rx_desc;
127         u8 err_rel_src;
128         u8 err_code;
129         u8 mac_id;
130         u8 unmapped;
131         u8 is_frag;
132         u8 tid;
133         u16 peer_id;
134         u16 seq_no;
135 };
136
137 enum ath11k_hw_rev {
138         ATH11K_HW_IPQ8074,
139         ATH11K_HW_QCA6390_HW20,
140         ATH11K_HW_IPQ6018_HW10,
141         ATH11K_HW_QCN9074_HW10,
142         ATH11K_HW_WCN6855_HW20,
143         ATH11K_HW_WCN6855_HW21,
144         ATH11K_HW_WCN6750_HW10,
145 };
146
147 enum ath11k_firmware_mode {
148         /* the default mode, standard 802.11 functionality */
149         ATH11K_FIRMWARE_MODE_NORMAL,
150
151         /* factory tests etc */
152         ATH11K_FIRMWARE_MODE_FTM,
153
154         /* Cold boot calibration */
155         ATH11K_FIRMWARE_MODE_COLD_BOOT = 7,
156 };
157
158 extern bool ath11k_cold_boot_cal;
159
160 #define ATH11K_IRQ_NUM_MAX 52
161 #define ATH11K_EXT_IRQ_NUM_MAX  16
162
163 struct ath11k_ext_irq_grp {
164         struct ath11k_base *ab;
165         u32 irqs[ATH11K_EXT_IRQ_NUM_MAX];
166         u32 num_irq;
167         u32 grp_id;
168         u64 timestamp;
169         bool napi_enabled;
170         struct napi_struct napi;
171         struct net_device napi_ndev;
172 };
173
174 enum ath11k_smbios_cc_type {
175         /* disable country code setting from SMBIOS */
176         ATH11K_SMBIOS_CC_DISABLE = 0,
177
178         /* set country code by ANSI country name, based on ISO3166-1 alpha2 */
179         ATH11K_SMBIOS_CC_ISO = 1,
180
181         /* worldwide regdomain */
182         ATH11K_SMBIOS_CC_WW = 2,
183 };
184
185 struct ath11k_smbios_bdf {
186         struct dmi_header hdr;
187
188         u8 features_disabled;
189
190         /* enum ath11k_smbios_cc_type */
191         u8 country_code_flag;
192
193         /* To set specific country, you need to set country code
194          * flag=ATH11K_SMBIOS_CC_ISO first, then if country is United
195          * States, then country code value = 0x5553 ("US",'U' = 0x55, 'S'=
196          * 0x53). To set country to INDONESIA, then country code value =
197          * 0x4944 ("IN", 'I'=0x49, 'D'=0x44). If country code flag =
198          * ATH11K_SMBIOS_CC_WW, then you can use worldwide regulatory
199          * setting.
200          */
201         u16 cc_code;
202
203         u8 bdf_enabled;
204         u8 bdf_ext[];
205 } __packed;
206
207 #define HEHANDLE_CAP_PHYINFO_SIZE       3
208 #define HECAP_PHYINFO_SIZE              9
209 #define HECAP_MACINFO_SIZE              5
210 #define HECAP_TXRX_MCS_NSS_SIZE         2
211 #define HECAP_PPET16_PPET8_MAX_SIZE     25
212
213 #define HE_PPET16_PPET8_SIZE            8
214
215 /* 802.11ax PPE (PPDU packet Extension) threshold */
216 struct he_ppe_threshold {
217         u32 numss_m1;
218         u32 ru_mask;
219         u32 ppet16_ppet8_ru3_ru0[HE_PPET16_PPET8_SIZE];
220 };
221
222 struct ath11k_he {
223         u8 hecap_macinfo[HECAP_MACINFO_SIZE];
224         u32 hecap_rxmcsnssmap;
225         u32 hecap_txmcsnssmap;
226         u32 hecap_phyinfo[HEHANDLE_CAP_PHYINFO_SIZE];
227         struct he_ppe_threshold   hecap_ppet;
228         u32 heop_param;
229 };
230
231 #define MAX_RADIOS 3
232
233 enum {
234         WMI_HOST_TP_SCALE_MAX   = 0,
235         WMI_HOST_TP_SCALE_50    = 1,
236         WMI_HOST_TP_SCALE_25    = 2,
237         WMI_HOST_TP_SCALE_12    = 3,
238         WMI_HOST_TP_SCALE_MIN   = 4,
239         WMI_HOST_TP_SCALE_SIZE   = 5,
240 };
241
242 enum ath11k_scan_state {
243         ATH11K_SCAN_IDLE,
244         ATH11K_SCAN_STARTING,
245         ATH11K_SCAN_RUNNING,
246         ATH11K_SCAN_ABORTING,
247 };
248
249 enum ath11k_11d_state {
250         ATH11K_11D_IDLE,
251         ATH11K_11D_PREPARING,
252         ATH11K_11D_RUNNING,
253 };
254
255 enum ath11k_dev_flags {
256         ATH11K_CAC_RUNNING,
257         ATH11K_FLAG_CORE_REGISTERED,
258         ATH11K_FLAG_CRASH_FLUSH,
259         ATH11K_FLAG_RAW_MODE,
260         ATH11K_FLAG_HW_CRYPTO_DISABLED,
261         ATH11K_FLAG_BTCOEX,
262         ATH11K_FLAG_RECOVERY,
263         ATH11K_FLAG_UNREGISTERING,
264         ATH11K_FLAG_REGISTERED,
265         ATH11K_FLAG_QMI_FAIL,
266         ATH11K_FLAG_HTC_SUSPEND_COMPLETE,
267         ATH11K_FLAG_CE_IRQ_ENABLED,
268         ATH11K_FLAG_EXT_IRQ_ENABLED,
269         ATH11K_FLAG_FIXED_MEM_RGN,
270         ATH11K_FLAG_DEVICE_INIT_DONE,
271         ATH11K_FLAG_MULTI_MSI_VECTORS,
272 };
273
274 enum ath11k_monitor_flags {
275         ATH11K_FLAG_MONITOR_CONF_ENABLED,
276         ATH11K_FLAG_MONITOR_STARTED,
277         ATH11K_FLAG_MONITOR_VDEV_CREATED,
278 };
279
280 #define ATH11K_IPV6_UC_TYPE     0
281 #define ATH11K_IPV6_AC_TYPE     1
282
283 #define ATH11K_IPV6_MAX_COUNT   16
284 #define ATH11K_IPV4_MAX_COUNT   2
285
286 struct ath11k_arp_ns_offload {
287         u8  ipv4_addr[ATH11K_IPV4_MAX_COUNT][4];
288         u32 ipv4_count;
289         u32 ipv6_count;
290         u8  ipv6_addr[ATH11K_IPV6_MAX_COUNT][16];
291         u8  self_ipv6_addr[ATH11K_IPV6_MAX_COUNT][16];
292         u8  ipv6_type[ATH11K_IPV6_MAX_COUNT];
293         bool ipv6_valid[ATH11K_IPV6_MAX_COUNT];
294         u8  mac_addr[ETH_ALEN];
295 };
296
297 struct ath11k_rekey_data {
298         u8 kck[NL80211_KCK_LEN];
299         u8 kek[NL80211_KCK_LEN];
300         u64 replay_ctr;
301         bool enable_offload;
302 };
303
304 struct ath11k_vif {
305         u32 vdev_id;
306         enum wmi_vdev_type vdev_type;
307         enum wmi_vdev_subtype vdev_subtype;
308         u32 beacon_interval;
309         u32 dtim_period;
310         u16 ast_hash;
311         u16 ast_idx;
312         u16 tcl_metadata;
313         u8 hal_addr_search_flags;
314         u8 search_type;
315
316         struct ath11k *ar;
317         struct ieee80211_vif *vif;
318
319         u16 tx_seq_no;
320         struct wmi_wmm_params_all_arg wmm_params;
321         struct list_head list;
322         union {
323                 struct {
324                         u32 uapsd;
325                 } sta;
326                 struct {
327                         /* 127 stations; wmi limit */
328                         u8 tim_bitmap[16];
329                         u8 tim_len;
330                         u32 ssid_len;
331                         u8 ssid[IEEE80211_MAX_SSID_LEN];
332                         bool hidden_ssid;
333                         /* P2P_IE with NoA attribute for P2P_GO case */
334                         u32 noa_len;
335                         u8 *noa_data;
336                 } ap;
337         } u;
338
339         bool is_started;
340         bool is_up;
341         bool spectral_enabled;
342         bool ps;
343         u32 aid;
344         u8 bssid[ETH_ALEN];
345         struct cfg80211_bitrate_mask bitrate_mask;
346         struct delayed_work connection_loss_work;
347         int num_legacy_stations;
348         int rtscts_prot_mode;
349         int txpower;
350         bool rsnie_present;
351         bool wpaie_present;
352         bool bcca_zero_sent;
353         bool do_not_send_tmpl;
354         struct ieee80211_chanctx_conf chanctx;
355         struct ath11k_arp_ns_offload arp_ns_offload;
356         struct ath11k_rekey_data rekey_data;
357
358 #ifdef CONFIG_ATH11K_DEBUGFS
359         struct dentry *debugfs_twt;
360 #endif /* CONFIG_ATH11K_DEBUGFS */
361 };
362
363 struct ath11k_vif_iter {
364         u32 vdev_id;
365         struct ath11k_vif *arvif;
366 };
367
368 struct ath11k_rx_peer_stats {
369         u64 num_msdu;
370         u64 num_mpdu_fcs_ok;
371         u64 num_mpdu_fcs_err;
372         u64 tcp_msdu_count;
373         u64 udp_msdu_count;
374         u64 other_msdu_count;
375         u64 ampdu_msdu_count;
376         u64 non_ampdu_msdu_count;
377         u64 stbc_count;
378         u64 beamformed_count;
379         u64 mcs_count[HAL_RX_MAX_MCS + 1];
380         u64 nss_count[HAL_RX_MAX_NSS];
381         u64 bw_count[HAL_RX_BW_MAX];
382         u64 gi_count[HAL_RX_GI_MAX];
383         u64 coding_count[HAL_RX_SU_MU_CODING_MAX];
384         u64 tid_count[IEEE80211_NUM_TIDS + 1];
385         u64 pream_cnt[HAL_RX_PREAMBLE_MAX];
386         u64 reception_type[HAL_RX_RECEPTION_TYPE_MAX];
387         u64 rx_duration;
388         u64 dcm_count;
389         u64 ru_alloc_cnt[HAL_RX_RU_ALLOC_TYPE_MAX];
390 };
391
392 #define ATH11K_HE_MCS_NUM       12
393 #define ATH11K_VHT_MCS_NUM      10
394 #define ATH11K_BW_NUM           4
395 #define ATH11K_NSS_NUM          4
396 #define ATH11K_LEGACY_NUM       12
397 #define ATH11K_GI_NUM           4
398 #define ATH11K_HT_MCS_NUM       32
399
400 enum ath11k_pkt_rx_err {
401         ATH11K_PKT_RX_ERR_FCS,
402         ATH11K_PKT_RX_ERR_TKIP,
403         ATH11K_PKT_RX_ERR_CRYPT,
404         ATH11K_PKT_RX_ERR_PEER_IDX_INVAL,
405         ATH11K_PKT_RX_ERR_MAX,
406 };
407
408 enum ath11k_ampdu_subfrm_num {
409         ATH11K_AMPDU_SUBFRM_NUM_10,
410         ATH11K_AMPDU_SUBFRM_NUM_20,
411         ATH11K_AMPDU_SUBFRM_NUM_30,
412         ATH11K_AMPDU_SUBFRM_NUM_40,
413         ATH11K_AMPDU_SUBFRM_NUM_50,
414         ATH11K_AMPDU_SUBFRM_NUM_60,
415         ATH11K_AMPDU_SUBFRM_NUM_MORE,
416         ATH11K_AMPDU_SUBFRM_NUM_MAX,
417 };
418
419 enum ath11k_amsdu_subfrm_num {
420         ATH11K_AMSDU_SUBFRM_NUM_1,
421         ATH11K_AMSDU_SUBFRM_NUM_2,
422         ATH11K_AMSDU_SUBFRM_NUM_3,
423         ATH11K_AMSDU_SUBFRM_NUM_4,
424         ATH11K_AMSDU_SUBFRM_NUM_MORE,
425         ATH11K_AMSDU_SUBFRM_NUM_MAX,
426 };
427
428 enum ath11k_counter_type {
429         ATH11K_COUNTER_TYPE_BYTES,
430         ATH11K_COUNTER_TYPE_PKTS,
431         ATH11K_COUNTER_TYPE_MAX,
432 };
433
434 enum ath11k_stats_type {
435         ATH11K_STATS_TYPE_SUCC,
436         ATH11K_STATS_TYPE_FAIL,
437         ATH11K_STATS_TYPE_RETRY,
438         ATH11K_STATS_TYPE_AMPDU,
439         ATH11K_STATS_TYPE_MAX,
440 };
441
442 struct ath11k_htt_data_stats {
443         u64 legacy[ATH11K_COUNTER_TYPE_MAX][ATH11K_LEGACY_NUM];
444         u64 ht[ATH11K_COUNTER_TYPE_MAX][ATH11K_HT_MCS_NUM];
445         u64 vht[ATH11K_COUNTER_TYPE_MAX][ATH11K_VHT_MCS_NUM];
446         u64 he[ATH11K_COUNTER_TYPE_MAX][ATH11K_HE_MCS_NUM];
447         u64 bw[ATH11K_COUNTER_TYPE_MAX][ATH11K_BW_NUM];
448         u64 nss[ATH11K_COUNTER_TYPE_MAX][ATH11K_NSS_NUM];
449         u64 gi[ATH11K_COUNTER_TYPE_MAX][ATH11K_GI_NUM];
450 };
451
452 struct ath11k_htt_tx_stats {
453         struct ath11k_htt_data_stats stats[ATH11K_STATS_TYPE_MAX];
454         u64 tx_duration;
455         u64 ba_fails;
456         u64 ack_fails;
457 };
458
459 struct ath11k_per_ppdu_tx_stats {
460         u16 succ_pkts;
461         u16 failed_pkts;
462         u16 retry_pkts;
463         u32 succ_bytes;
464         u32 failed_bytes;
465         u32 retry_bytes;
466 };
467
468 DECLARE_EWMA(avg_rssi, 10, 8)
469
470 struct ath11k_sta {
471         struct ath11k_vif *arvif;
472
473         /* the following are protected by ar->data_lock */
474         u32 changed; /* IEEE80211_RC_* */
475         u32 bw;
476         u32 nss;
477         u32 smps;
478         enum hal_pn_type pn_type;
479
480         struct work_struct update_wk;
481         struct work_struct set_4addr_wk;
482         struct rate_info txrate;
483         u32 peer_nss;
484         struct rate_info last_txrate;
485         u64 rx_duration;
486         u64 tx_duration;
487         u8 rssi_comb;
488         struct ewma_avg_rssi avg_rssi;
489         s8 rssi_beacon;
490         s8 chain_signal[IEEE80211_MAX_CHAINS];
491         struct ath11k_htt_tx_stats *tx_stats;
492         struct ath11k_rx_peer_stats *rx_stats;
493
494 #ifdef CONFIG_MAC80211_DEBUGFS
495         /* protected by conf_mutex */
496         bool aggr_mode;
497 #endif
498
499         bool use_4addr_set;
500         u16 tcl_metadata;
501
502         /* Protected with ar->data_lock */
503         enum ath11k_wmi_peer_ps_state peer_ps_state;
504         u64 ps_start_time;
505         u64 ps_start_jiffies;
506         u64 ps_total_duration;
507         bool peer_current_ps_valid;
508
509         u32 bw_prev;
510 };
511
512 #define ATH11K_MIN_5G_FREQ 4150
513 #define ATH11K_MIN_6G_FREQ 5925
514 #define ATH11K_MAX_6G_FREQ 7115
515 #define ATH11K_NUM_CHANS 101
516 #define ATH11K_MAX_5G_CHAN 173
517
518 enum ath11k_state {
519         ATH11K_STATE_OFF,
520         ATH11K_STATE_ON,
521         ATH11K_STATE_RESTARTING,
522         ATH11K_STATE_RESTARTED,
523         ATH11K_STATE_WEDGED,
524         /* Add other states as required */
525 };
526
527 /* Antenna noise floor */
528 #define ATH11K_DEFAULT_NOISE_FLOOR -95
529
530 #define ATH11K_INVALID_RSSI_FULL -1
531
532 #define ATH11K_INVALID_RSSI_EMPTY -128
533
534 struct ath11k_fw_stats {
535         struct dentry *debugfs_fwstats;
536         u32 pdev_id;
537         u32 stats_id;
538         struct list_head pdevs;
539         struct list_head vdevs;
540         struct list_head bcn;
541 };
542
543 struct ath11k_dbg_htt_stats {
544         u8 type;
545         u8 reset;
546         struct debug_htt_stats_req *stats_req;
547         /* protects shared stats req buffer */
548         spinlock_t lock;
549 };
550
551 #define MAX_MODULE_ID_BITMAP_WORDS      16
552
553 struct ath11k_debug {
554         struct dentry *debugfs_pdev;
555         struct ath11k_dbg_htt_stats htt_stats;
556         u32 extd_tx_stats;
557         u32 extd_rx_stats;
558         u32 pktlog_filter;
559         u32 pktlog_mode;
560         u32 pktlog_peer_valid;
561         u8 pktlog_peer_addr[ETH_ALEN];
562         u32 rx_filter;
563         u32 mem_offset;
564         u32 module_id_bitmap[MAX_MODULE_ID_BITMAP_WORDS];
565         struct ath11k_debug_dbr *dbr_debug[WMI_DIRECT_BUF_MAX];
566 };
567
568 struct ath11k_per_peer_tx_stats {
569         u32 succ_bytes;
570         u32 retry_bytes;
571         u32 failed_bytes;
572         u16 succ_pkts;
573         u16 retry_pkts;
574         u16 failed_pkts;
575         u32 duration;
576         u8 ba_fails;
577         bool is_ampdu;
578 };
579
580 #define ATH11K_FLUSH_TIMEOUT (5 * HZ)
581 #define ATH11K_VDEV_DELETE_TIMEOUT_HZ (5 * HZ)
582
583 struct ath11k {
584         struct ath11k_base *ab;
585         struct ath11k_pdev *pdev;
586         struct ieee80211_hw *hw;
587         struct ieee80211_ops *ops;
588         struct ath11k_pdev_wmi *wmi;
589         struct ath11k_pdev_dp dp;
590         u8 mac_addr[ETH_ALEN];
591         struct ath11k_he ar_he;
592         enum ath11k_state state;
593         bool supports_6ghz;
594         struct {
595                 struct completion started;
596                 struct completion completed;
597                 struct completion on_channel;
598                 struct delayed_work timeout;
599                 enum ath11k_scan_state state;
600                 bool is_roc;
601                 int vdev_id;
602                 int roc_freq;
603                 bool roc_notify;
604         } scan;
605
606         struct {
607                 struct ieee80211_supported_band sbands[NUM_NL80211_BANDS];
608                 struct ieee80211_sband_iftype_data
609                         iftype[NUM_NL80211_BANDS][NUM_NL80211_IFTYPES];
610         } mac;
611
612         unsigned long dev_flags;
613         unsigned int filter_flags;
614         unsigned long monitor_flags;
615         u32 min_tx_power;
616         u32 max_tx_power;
617         u32 txpower_limit_2g;
618         u32 txpower_limit_5g;
619         u32 txpower_scale;
620         u32 power_scale;
621         u32 chan_tx_pwr;
622         u32 num_stations;
623         u32 max_num_stations;
624         /* To synchronize concurrent synchronous mac80211 callback operations,
625          * concurrent debugfs configuration and concurrent FW statistics events.
626          */
627         struct mutex conf_mutex;
628         /* protects the radio specific data like debug stats, ppdu_stats_info stats,
629          * vdev_stop_status info, scan data, ath11k_sta info, ath11k_vif info,
630          * channel context data, survey info, test mode data.
631          */
632         spinlock_t data_lock;
633
634         struct list_head arvifs;
635         /* should never be NULL; needed for regular htt rx */
636         struct ieee80211_channel *rx_channel;
637
638         /* valid during scan; needed for mgmt rx during scan */
639         struct ieee80211_channel *scan_channel;
640
641         u8 cfg_tx_chainmask;
642         u8 cfg_rx_chainmask;
643         u8 num_rx_chains;
644         u8 num_tx_chains;
645         /* pdev_idx starts from 0 whereas pdev->pdev_id starts with 1 */
646         u8 pdev_idx;
647         u8 lmac_id;
648
649         struct completion peer_assoc_done;
650         struct completion peer_delete_done;
651
652         int install_key_status;
653         struct completion install_key_done;
654
655         int last_wmi_vdev_start_status;
656         struct completion vdev_setup_done;
657         struct completion vdev_delete_done;
658
659         int num_peers;
660         int max_num_peers;
661         u32 num_started_vdevs;
662         u32 num_created_vdevs;
663         unsigned long long allocated_vdev_map;
664
665         struct idr txmgmt_idr;
666         /* protects txmgmt_idr data */
667         spinlock_t txmgmt_idr_lock;
668         atomic_t num_pending_mgmt_tx;
669         wait_queue_head_t txmgmt_empty_waitq;
670
671         /* cycle count is reported twice for each visited channel during scan.
672          * access protected by data_lock
673          */
674         u32 survey_last_rx_clear_count;
675         u32 survey_last_cycle_count;
676
677         /* Channel info events are expected to come in pairs without and with
678          * COMPLETE flag set respectively for each channel visit during scan.
679          *
680          * However there are deviations from this rule. This flag is used to
681          * avoid reporting garbage data.
682          */
683         bool ch_info_can_report_survey;
684         struct survey_info survey[ATH11K_NUM_CHANS];
685         struct completion bss_survey_done;
686
687         struct work_struct regd_update_work;
688
689         struct work_struct wmi_mgmt_tx_work;
690         struct sk_buff_head wmi_mgmt_tx_queue;
691
692         struct ath11k_wow wow;
693         struct completion target_suspend;
694         bool target_suspend_ack;
695         struct ath11k_per_peer_tx_stats peer_tx_stats;
696         struct list_head ppdu_stats_info;
697         u32 ppdu_stat_list_depth;
698
699         struct ath11k_per_peer_tx_stats cached_stats;
700         u32 last_ppdu_id;
701         u32 cached_ppdu_id;
702         int monitor_vdev_id;
703 #ifdef CONFIG_ATH11K_DEBUGFS
704         struct ath11k_debug debug;
705 #endif
706 #ifdef CONFIG_ATH11K_SPECTRAL
707         struct ath11k_spectral spectral;
708 #endif
709         bool dfs_block_radar_events;
710         struct ath11k_thermal thermal;
711         u32 vdev_id_11d_scan;
712         struct completion completed_11d_scan;
713         enum ath11k_11d_state state_11d;
714         bool regdom_set_by_user;
715         int hw_rate_code;
716         u8 twt_enabled;
717         bool nlo_enabled;
718         u8 alpha2[REG_ALPHA2_LEN + 1];
719         struct ath11k_fw_stats fw_stats;
720         struct completion fw_stats_complete;
721         bool fw_stats_done;
722
723         /* protected by conf_mutex */
724         bool ps_state_enable;
725         bool ps_timekeeper_enable;
726 };
727
728 struct ath11k_band_cap {
729         u32 phy_id;
730         u32 max_bw_supported;
731         u32 ht_cap_info;
732         u32 he_cap_info[2];
733         u32 he_mcs;
734         u32 he_cap_phy_info[PSOC_HOST_MAX_PHY_SIZE];
735         struct ath11k_ppe_threshold he_ppet;
736         u16 he_6ghz_capa;
737 };
738
739 struct ath11k_pdev_cap {
740         u32 supported_bands;
741         u32 ampdu_density;
742         u32 vht_cap;
743         u32 vht_mcs;
744         u32 he_mcs;
745         u32 tx_chain_mask;
746         u32 rx_chain_mask;
747         u32 tx_chain_mask_shift;
748         u32 rx_chain_mask_shift;
749         struct ath11k_band_cap band[NUM_NL80211_BANDS];
750         bool nss_ratio_enabled;
751         u8 nss_ratio_info;
752 };
753
754 struct ath11k_pdev {
755         struct ath11k *ar;
756         u32 pdev_id;
757         struct ath11k_pdev_cap cap;
758         u8 mac_addr[ETH_ALEN];
759 };
760
761 struct ath11k_board_data {
762         const struct firmware *fw;
763         const void *data;
764         size_t len;
765 };
766
767 struct ath11k_pci_ops {
768         int (*wakeup)(struct ath11k_base *ab);
769         void (*release)(struct ath11k_base *ab);
770         int (*get_msi_irq)(struct ath11k_base *ab, unsigned int vector);
771         void (*window_write32)(struct ath11k_base *ab, u32 offset, u32 value);
772         u32 (*window_read32)(struct ath11k_base *ab, u32 offset);
773 };
774
775 /* IPQ8074 HW channel counters frequency value in hertz */
776 #define IPQ8074_CC_FREQ_HERTZ 320000
777
778 struct ath11k_bp_stats {
779         /* Head Pointer reported by the last HTT Backpressure event for the ring */
780         u16 hp;
781
782         /* Tail Pointer reported by the last HTT Backpressure event for the ring */
783         u16 tp;
784
785         /* Number of Backpressure events received for the ring */
786         u32 count;
787
788         /* Last recorded event timestamp */
789         unsigned long jiffies;
790 };
791
792 struct ath11k_dp_ring_bp_stats {
793         struct ath11k_bp_stats umac_ring_bp_stats[HTT_SW_UMAC_RING_IDX_MAX];
794         struct ath11k_bp_stats lmac_ring_bp_stats[HTT_SW_LMAC_RING_IDX_MAX][MAX_RADIOS];
795 };
796
797 struct ath11k_soc_dp_tx_err_stats {
798         /* TCL Ring Descriptor unavailable */
799         u32 desc_na[DP_TCL_NUM_RING_MAX];
800         /* Other failures during dp_tx due to mem allocation failure
801          * idr unavailable etc.
802          */
803         atomic_t misc_fail;
804 };
805
806 struct ath11k_soc_dp_stats {
807         u32 err_ring_pkts;
808         u32 invalid_rbm;
809         u32 rxdma_error[HAL_REO_ENTR_RING_RXDMA_ECODE_MAX];
810         u32 reo_error[HAL_REO_DEST_RING_ERROR_CODE_MAX];
811         u32 hal_reo_error[DP_REO_DST_RING_MAX];
812         struct ath11k_soc_dp_tx_err_stats tx_err;
813         struct ath11k_dp_ring_bp_stats bp_stats;
814 };
815
816 struct ath11k_msi_user {
817         char *name;
818         int num_vectors;
819         u32 base_vector;
820 };
821
822 struct ath11k_msi_config {
823         int total_vectors;
824         int total_users;
825         struct ath11k_msi_user *users;
826         u16 hw_rev;
827 };
828
829 /* Master structure to hold the hw data which may be used in core module */
830 struct ath11k_base {
831         enum ath11k_hw_rev hw_rev;
832         struct platform_device *pdev;
833         struct device *dev;
834         struct ath11k_qmi qmi;
835         struct ath11k_wmi_base wmi_ab;
836         struct completion fw_ready;
837         int num_radios;
838         /* HW channel counters frequency value in hertz common to all MACs */
839         u32 cc_freq_hz;
840
841         struct ath11k_htc htc;
842
843         struct ath11k_dp dp;
844
845         void __iomem *mem;
846         unsigned long mem_len;
847
848         struct {
849                 enum ath11k_bus bus;
850                 const struct ath11k_hif_ops *ops;
851         } hif;
852
853         struct {
854                 struct completion wakeup_completed;
855         } wow;
856
857         struct ath11k_ce ce;
858         struct timer_list rx_replenish_retry;
859         struct ath11k_hal hal;
860         /* To synchronize core_start/core_stop */
861         struct mutex core_lock;
862         /* Protects data like peers */
863         spinlock_t base_lock;
864         struct ath11k_pdev pdevs[MAX_RADIOS];
865         struct {
866                 enum WMI_HOST_WLAN_BAND supported_bands;
867                 u32 pdev_id;
868         } target_pdev_ids[MAX_RADIOS];
869         u8 target_pdev_count;
870         struct ath11k_pdev __rcu *pdevs_active[MAX_RADIOS];
871         struct ath11k_hal_reg_capabilities_ext hal_reg_cap[MAX_RADIOS];
872         unsigned long long free_vdev_map;
873
874         /* To synchronize rhash tbl write operation */
875         struct mutex tbl_mtx_lock;
876
877         /* The rhashtable containing struct ath11k_peer keyed by mac addr */
878         struct rhashtable *rhead_peer_addr;
879         struct rhashtable_params rhash_peer_addr_param;
880
881         /* The rhashtable containing struct ath11k_peer keyed by id  */
882         struct rhashtable *rhead_peer_id;
883         struct rhashtable_params rhash_peer_id_param;
884
885         struct list_head peers;
886         wait_queue_head_t peer_mapping_wq;
887         u8 mac_addr[ETH_ALEN];
888         bool wmi_ready;
889         u32 wlan_init_status;
890         int irq_num[ATH11K_IRQ_NUM_MAX];
891         struct ath11k_ext_irq_grp ext_irq_grp[ATH11K_EXT_IRQ_GRP_NUM_MAX];
892         struct ath11k_targ_cap target_caps;
893         u32 ext_service_bitmap[WMI_SERVICE_EXT_BM_SIZE];
894         bool pdevs_macaddr_valid;
895         int bd_api;
896
897         struct ath11k_hw_params hw_params;
898
899         const struct firmware *cal_file;
900
901         /* Below regd's are protected by ab->data_lock */
902         /* This is the regd set for every radio
903          * by the firmware during initialization
904          */
905         struct ieee80211_regdomain *default_regd[MAX_RADIOS];
906         /* This regd is set during dynamic country setting
907          * This may or may not be used during the runtime
908          */
909         struct ieee80211_regdomain *new_regd[MAX_RADIOS];
910
911         /* Current DFS Regulatory */
912         enum ath11k_dfs_region dfs_region;
913 #ifdef CONFIG_ATH11K_DEBUGFS
914         struct dentry *debugfs_soc;
915         struct dentry *debugfs_ath11k;
916 #endif
917         struct ath11k_soc_dp_stats soc_stats;
918
919         unsigned long dev_flags;
920         struct completion driver_recovery;
921         struct workqueue_struct *workqueue;
922         struct work_struct restart_work;
923         struct work_struct update_11d_work;
924         u8 new_alpha2[3];
925         struct workqueue_struct *workqueue_aux;
926         struct work_struct reset_work;
927         atomic_t reset_count;
928         atomic_t recovery_count;
929         atomic_t recovery_start_count;
930         bool is_reset;
931         struct completion reset_complete;
932         struct completion reconfigure_complete;
933         struct completion recovery_start;
934         /* continuous recovery fail count */
935         atomic_t fail_cont_count;
936         unsigned long reset_fail_timeout;
937         struct {
938                 /* protected by data_lock */
939                 u32 fw_crash_counter;
940         } stats;
941         u32 pktlog_defs_checksum;
942
943         struct ath11k_dbring_cap *db_caps;
944         u32 num_db_cap;
945
946         /* To synchronize 11d scan vdev id */
947         struct mutex vdev_id_11d_lock;
948         struct timer_list mon_reap_timer;
949
950         struct completion htc_suspend;
951
952         struct {
953                 enum ath11k_bdf_search bdf_search;
954                 u32 vendor;
955                 u32 device;
956                 u32 subsystem_vendor;
957                 u32 subsystem_device;
958         } id;
959
960         struct {
961                 struct {
962                         const struct ath11k_msi_config *config;
963                         u32 ep_base_data;
964                         u32 irqs[32];
965                         u32 addr_lo;
966                         u32 addr_hi;
967                 } msi;
968
969                 const struct ath11k_pci_ops *ops;
970         } pci;
971
972         /* must be last */
973         u8 drv_priv[] __aligned(sizeof(void *));
974 };
975
976 struct ath11k_fw_stats_pdev {
977         struct list_head list;
978
979         /* PDEV stats */
980         s32 ch_noise_floor;
981         /* Cycles spent transmitting frames */
982         u32 tx_frame_count;
983         /* Cycles spent receiving frames */
984         u32 rx_frame_count;
985         /* Total channel busy time, evidently */
986         u32 rx_clear_count;
987         /* Total on-channel time */
988         u32 cycle_count;
989         u32 phy_err_count;
990         u32 chan_tx_power;
991         u32 ack_rx_bad;
992         u32 rts_bad;
993         u32 rts_good;
994         u32 fcs_bad;
995         u32 no_beacons;
996         u32 mib_int_count;
997
998         /* PDEV TX stats */
999         /* Num HTT cookies queued to dispatch list */
1000         s32 comp_queued;
1001         /* Num HTT cookies dispatched */
1002         s32 comp_delivered;
1003         /* Num MSDU queued to WAL */
1004         s32 msdu_enqued;
1005         /* Num MPDU queue to WAL */
1006         s32 mpdu_enqued;
1007         /* Num MSDUs dropped by WMM limit */
1008         s32 wmm_drop;
1009         /* Num Local frames queued */
1010         s32 local_enqued;
1011         /* Num Local frames done */
1012         s32 local_freed;
1013         /* Num queued to HW */
1014         s32 hw_queued;
1015         /* Num PPDU reaped from HW */
1016         s32 hw_reaped;
1017         /* Num underruns */
1018         s32 underrun;
1019         /* Num hw paused */
1020         u32 hw_paused;
1021         /* Num PPDUs cleaned up in TX abort */
1022         s32 tx_abort;
1023         /* Num MPDUs requeued by SW */
1024         s32 mpdus_requeued;
1025         /* excessive retries */
1026         u32 tx_ko;
1027         u32 tx_xretry;
1028         /* data hw rate code */
1029         u32 data_rc;
1030         /* Scheduler self triggers */
1031         u32 self_triggers;
1032         /* frames dropped due to excessive sw retries */
1033         u32 sw_retry_failure;
1034         /* illegal rate phy errors      */
1035         u32 illgl_rate_phy_err;
1036         /* wal pdev continuous xretry */
1037         u32 pdev_cont_xretry;
1038         /* wal pdev tx timeouts */
1039         u32 pdev_tx_timeout;
1040         /* wal pdev resets */
1041         u32 pdev_resets;
1042         /* frames dropped due to non-availability of stateless TIDs */
1043         u32 stateless_tid_alloc_failure;
1044         /* PhY/BB underrun */
1045         u32 phy_underrun;
1046         /* MPDU is more than txop limit */
1047         u32 txop_ovf;
1048         /* Num sequences posted */
1049         u32 seq_posted;
1050         /* Num sequences failed in queueing */
1051         u32 seq_failed_queueing;
1052         /* Num sequences completed */
1053         u32 seq_completed;
1054         /* Num sequences restarted */
1055         u32 seq_restarted;
1056         /* Num of MU sequences posted */
1057         u32 mu_seq_posted;
1058         /* Num MPDUs flushed by SW, HWPAUSED, SW TXABORT
1059          * (Reset,channel change)
1060          */
1061         s32 mpdus_sw_flush;
1062         /* Num MPDUs filtered by HW, all filter condition (TTL expired) */
1063         s32 mpdus_hw_filter;
1064         /* Num MPDUs truncated by PDG (TXOP, TBTT,
1065          * PPDU_duration based on rate, dyn_bw)
1066          */
1067         s32 mpdus_truncated;
1068         /* Num MPDUs that was tried but didn't receive ACK or BA */
1069         s32 mpdus_ack_failed;
1070         /* Num MPDUs that was dropped du to expiry. */
1071         s32 mpdus_expired;
1072
1073         /* PDEV RX stats */
1074         /* Cnts any change in ring routing mid-ppdu */
1075         s32 mid_ppdu_route_change;
1076         /* Total number of statuses processed */
1077         s32 status_rcvd;
1078         /* Extra frags on rings 0-3 */
1079         s32 r0_frags;
1080         s32 r1_frags;
1081         s32 r2_frags;
1082         s32 r3_frags;
1083         /* MSDUs / MPDUs delivered to HTT */
1084         s32 htt_msdus;
1085         s32 htt_mpdus;
1086         /* MSDUs / MPDUs delivered to local stack */
1087         s32 loc_msdus;
1088         s32 loc_mpdus;
1089         /* AMSDUs that have more MSDUs than the status ring size */
1090         s32 oversize_amsdu;
1091         /* Number of PHY errors */
1092         s32 phy_errs;
1093         /* Number of PHY errors drops */
1094         s32 phy_err_drop;
1095         /* Number of mpdu errors - FCS, MIC, ENC etc. */
1096         s32 mpdu_errs;
1097         /* Num overflow errors */
1098         s32 rx_ovfl_errs;
1099 };
1100
1101 struct ath11k_fw_stats_vdev {
1102         struct list_head list;
1103
1104         u32 vdev_id;
1105         u32 beacon_snr;
1106         u32 data_snr;
1107         u32 num_tx_frames[WLAN_MAX_AC];
1108         u32 num_rx_frames;
1109         u32 num_tx_frames_retries[WLAN_MAX_AC];
1110         u32 num_tx_frames_failures[WLAN_MAX_AC];
1111         u32 num_rts_fail;
1112         u32 num_rts_success;
1113         u32 num_rx_err;
1114         u32 num_rx_discard;
1115         u32 num_tx_not_acked;
1116         u32 tx_rate_history[MAX_TX_RATE_VALUES];
1117         u32 beacon_rssi_history[MAX_TX_RATE_VALUES];
1118 };
1119
1120 struct ath11k_fw_stats_bcn {
1121         struct list_head list;
1122
1123         u32 vdev_id;
1124         u32 tx_bcn_succ_cnt;
1125         u32 tx_bcn_outage_cnt;
1126 };
1127
1128 void ath11k_fw_stats_init(struct ath11k *ar);
1129 void ath11k_fw_stats_pdevs_free(struct list_head *head);
1130 void ath11k_fw_stats_vdevs_free(struct list_head *head);
1131 void ath11k_fw_stats_bcn_free(struct list_head *head);
1132 void ath11k_fw_stats_free(struct ath11k_fw_stats *stats);
1133
1134 extern const struct ce_pipe_config ath11k_target_ce_config_wlan_ipq8074[];
1135 extern const struct service_to_pipe ath11k_target_service_to_ce_map_wlan_ipq8074[];
1136 extern const struct service_to_pipe ath11k_target_service_to_ce_map_wlan_ipq6018[];
1137
1138 extern const struct ce_pipe_config ath11k_target_ce_config_wlan_qca6390[];
1139 extern const struct service_to_pipe ath11k_target_service_to_ce_map_wlan_qca6390[];
1140
1141 extern const struct ce_pipe_config ath11k_target_ce_config_wlan_qcn9074[];
1142 extern const struct service_to_pipe ath11k_target_service_to_ce_map_wlan_qcn9074[];
1143 int ath11k_core_qmi_firmware_ready(struct ath11k_base *ab);
1144 int ath11k_core_pre_init(struct ath11k_base *ab);
1145 int ath11k_core_init(struct ath11k_base *ath11k);
1146 void ath11k_core_deinit(struct ath11k_base *ath11k);
1147 struct ath11k_base *ath11k_core_alloc(struct device *dev, size_t priv_size,
1148                                       enum ath11k_bus bus);
1149 void ath11k_core_free(struct ath11k_base *ath11k);
1150 int ath11k_core_fetch_bdf(struct ath11k_base *ath11k,
1151                           struct ath11k_board_data *bd);
1152 int ath11k_core_fetch_regdb(struct ath11k_base *ab, struct ath11k_board_data *bd);
1153 int ath11k_core_fetch_board_data_api_1(struct ath11k_base *ab,
1154                                        struct ath11k_board_data *bd,
1155                                        const char *name);
1156 void ath11k_core_free_bdf(struct ath11k_base *ab, struct ath11k_board_data *bd);
1157 int ath11k_core_check_dt(struct ath11k_base *ath11k);
1158 int ath11k_core_check_smbios(struct ath11k_base *ab);
1159 void ath11k_core_halt(struct ath11k *ar);
1160 int ath11k_core_resume(struct ath11k_base *ab);
1161 int ath11k_core_suspend(struct ath11k_base *ab);
1162
1163 const struct firmware *ath11k_core_firmware_request(struct ath11k_base *ab,
1164                                                     const char *filename);
1165
1166 static inline const char *ath11k_scan_state_str(enum ath11k_scan_state state)
1167 {
1168         switch (state) {
1169         case ATH11K_SCAN_IDLE:
1170                 return "idle";
1171         case ATH11K_SCAN_STARTING:
1172                 return "starting";
1173         case ATH11K_SCAN_RUNNING:
1174                 return "running";
1175         case ATH11K_SCAN_ABORTING:
1176                 return "aborting";
1177         }
1178
1179         return "unknown";
1180 }
1181
1182 static inline struct ath11k_skb_cb *ATH11K_SKB_CB(struct sk_buff *skb)
1183 {
1184         BUILD_BUG_ON(sizeof(struct ath11k_skb_cb) >
1185                      IEEE80211_TX_INFO_DRIVER_DATA_SIZE);
1186         return (struct ath11k_skb_cb *)&IEEE80211_SKB_CB(skb)->driver_data;
1187 }
1188
1189 static inline struct ath11k_skb_rxcb *ATH11K_SKB_RXCB(struct sk_buff *skb)
1190 {
1191         BUILD_BUG_ON(sizeof(struct ath11k_skb_rxcb) > sizeof(skb->cb));
1192         return (struct ath11k_skb_rxcb *)skb->cb;
1193 }
1194
1195 static inline struct ath11k_vif *ath11k_vif_to_arvif(struct ieee80211_vif *vif)
1196 {
1197         return (struct ath11k_vif *)vif->drv_priv;
1198 }
1199
1200 static inline struct ath11k *ath11k_ab_to_ar(struct ath11k_base *ab,
1201                                              int mac_id)
1202 {
1203         return ab->pdevs[ath11k_hw_mac_id_to_pdev_id(&ab->hw_params, mac_id)].ar;
1204 }
1205
1206 static inline void ath11k_core_create_firmware_path(struct ath11k_base *ab,
1207                                                     const char *filename,
1208                                                     void *buf, size_t buf_len)
1209 {
1210         snprintf(buf, buf_len, "%s/%s/%s", ATH11K_FW_DIR,
1211                  ab->hw_params.fw.dir, filename);
1212 }
1213
1214 static inline const char *ath11k_bus_str(enum ath11k_bus bus)
1215 {
1216         switch (bus) {
1217         case ATH11K_BUS_PCI:
1218                 return "pci";
1219         case ATH11K_BUS_AHB:
1220                 return "ahb";
1221         }
1222
1223         return "unknown";
1224 }
1225
1226 #endif /* _CORE_H_ */