1 /*
2  * Copyright (c) 2005-2011 Atheros Communications Inc.
3  * Copyright (c) 2011-2017 Qualcomm Atheros, Inc.
4  *
5  * Permission to use, copy, modify, and/or distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  */
17 
18 #ifndef _CORE_H_
19 #define _CORE_H_
20 
21 #include <linux/completion.h>
22 #include <linux/if_ether.h>
23 #include <linux/types.h>
24 #include <linux/pci.h>
25 #include <linux/uuid.h>
26 #include <linux/time.h>
27 
28 #include "htt.h"
29 #include "htc.h"
30 #include "hw.h"
31 #include "targaddrs.h"
32 #include "wmi.h"
33 #include "../ath.h"
34 #include "../regd.h"
35 #include "../dfs_pattern_detector.h"
36 #include "spectral.h"
37 #include "thermal.h"
38 #include "wow.h"
39 #include "swap.h"
40 
41 #define MS(_v, _f) (((_v) & _f##_MASK) >> _f##_LSB)
42 #define SM(_v, _f) (((_v) << _f##_LSB) & _f##_MASK)
43 #define WO(_f)      ((_f##_OFFSET) >> 2)
44 
45 #define ATH10K_SCAN_ID 0
46 #define WMI_READY_TIMEOUT (5 * HZ)
47 #define ATH10K_FLUSH_TIMEOUT_HZ (5 * HZ)
48 #define ATH10K_CONNECTION_LOSS_HZ (3 * HZ)
49 #define ATH10K_NUM_CHANS 40
50 
51 /* Antenna noise floor */
52 #define ATH10K_DEFAULT_NOISE_FLOOR -95
53 
54 #define ATH10K_MAX_NUM_MGMT_PENDING 128
55 
56 /* number of failed packets (20 packets with 16 sw reties each) */
57 #define ATH10K_KICKOUT_THRESHOLD (20 * 16)
58 
59 /*
60  * Use insanely high numbers to make sure that the firmware implementation
61  * won't start, we have the same functionality already in hostapd. Unit
62  * is seconds.
63  */
64 #define ATH10K_KEEPALIVE_MIN_IDLE 3747
65 #define ATH10K_KEEPALIVE_MAX_IDLE 3895
66 #define ATH10K_KEEPALIVE_MAX_UNRESPONSIVE 3900
67 
68 /* NAPI poll budget */
69 #define ATH10K_NAPI_BUDGET      64
70 
71 /* SMBIOS type containing Board Data File Name Extension */
72 #define ATH10K_SMBIOS_BDF_EXT_TYPE 0xF8
73 
74 /* SMBIOS type structure length (excluding strings-set) */
75 #define ATH10K_SMBIOS_BDF_EXT_LENGTH 0x9
76 
77 /* Offset pointing to Board Data File Name Extension */
78 #define ATH10K_SMBIOS_BDF_EXT_OFFSET 0x8
79 
80 /* Board Data File Name Extension string length.
81  * String format: BDF_<Customer ID>_<Extension>\0
82  */
83 #define ATH10K_SMBIOS_BDF_EXT_STR_LENGTH 0x20
84 
85 /* The magic used by QCA spec */
86 #define ATH10K_SMBIOS_BDF_EXT_MAGIC "BDF_"
87 
88 struct ath10k;
89 
90 enum ath10k_bus {
91 	ATH10K_BUS_PCI,
92 	ATH10K_BUS_AHB,
93 	ATH10K_BUS_SDIO,
94 	ATH10K_BUS_USB,
95 	ATH10K_BUS_SNOC,
96 };
97 
98 static inline const char *ath10k_bus_str(enum ath10k_bus bus)
99 {
100 	switch (bus) {
101 	case ATH10K_BUS_PCI:
102 		return "pci";
103 	case ATH10K_BUS_AHB:
104 		return "ahb";
105 	case ATH10K_BUS_SDIO:
106 		return "sdio";
107 	case ATH10K_BUS_USB:
108 		return "usb";
109 	case ATH10K_BUS_SNOC:
110 		return "snoc";
111 	}
112 
113 	return "unknown";
114 }
115 
116 enum ath10k_skb_flags {
117 	ATH10K_SKB_F_NO_HWCRYPT = BIT(0),
118 	ATH10K_SKB_F_DTIM_ZERO = BIT(1),
119 	ATH10K_SKB_F_DELIVER_CAB = BIT(2),
120 	ATH10K_SKB_F_MGMT = BIT(3),
121 	ATH10K_SKB_F_QOS = BIT(4),
122 };
123 
124 struct ath10k_skb_cb {
125 	dma_addr_t paddr;
126 	u8 flags;
127 	u8 eid;
128 	u16 msdu_id;
129 	struct ieee80211_vif *vif;
130 	struct ieee80211_txq *txq;
131 } __packed;
132 
133 struct ath10k_skb_rxcb {
134 	dma_addr_t paddr;
135 	struct hlist_node hlist;
136 };
137 
138 static inline struct ath10k_skb_cb *ATH10K_SKB_CB(struct sk_buff *skb)
139 {
140 	BUILD_BUG_ON(sizeof(struct ath10k_skb_cb) >
141 		     IEEE80211_TX_INFO_DRIVER_DATA_SIZE);
142 	return (struct ath10k_skb_cb *)&IEEE80211_SKB_CB(skb)->driver_data;
143 }
144 
145 static inline struct ath10k_skb_rxcb *ATH10K_SKB_RXCB(struct sk_buff *skb)
146 {
147 	BUILD_BUG_ON(sizeof(struct ath10k_skb_rxcb) > sizeof(skb->cb));
148 	return (struct ath10k_skb_rxcb *)skb->cb;
149 }
150 
151 #define ATH10K_RXCB_SKB(rxcb) \
152 		container_of((void *)rxcb, struct sk_buff, cb)
153 
154 static inline u32 host_interest_item_address(u32 item_offset)
155 {
156 	return QCA988X_HOST_INTEREST_ADDRESS + item_offset;
157 }
158 
159 struct ath10k_bmi {
160 	bool done_sent;
161 };
162 
163 struct ath10k_mem_chunk {
164 	void *vaddr;
165 	dma_addr_t paddr;
166 	u32 len;
167 	u32 req_id;
168 };
169 
170 struct ath10k_wmi {
171 	enum ath10k_htc_ep_id eid;
172 	struct completion service_ready;
173 	struct completion unified_ready;
174 	struct completion barrier;
175 	wait_queue_head_t tx_credits_wq;
176 	DECLARE_BITMAP(svc_map, WMI_SERVICE_MAX);
177 	struct wmi_cmd_map *cmd;
178 	struct wmi_vdev_param_map *vdev_param;
179 	struct wmi_pdev_param_map *pdev_param;
180 	const struct wmi_ops *ops;
181 	const struct wmi_peer_flags_map *peer_flags;
182 
183 	u32 num_mem_chunks;
184 	u32 rx_decap_mode;
185 	struct ath10k_mem_chunk mem_chunks[WMI_MAX_MEM_REQS];
186 };
187 
188 struct ath10k_fw_stats_peer {
189 	struct list_head list;
190 
191 	u8 peer_macaddr[ETH_ALEN];
192 	u32 peer_rssi;
193 	u32 peer_tx_rate;
194 	u32 peer_rx_rate; /* 10x only */
195 	u32 rx_duration;
196 };
197 
198 struct ath10k_fw_extd_stats_peer {
199 	struct list_head list;
200 
201 	u8 peer_macaddr[ETH_ALEN];
202 	u32 rx_duration;
203 };
204 
205 struct ath10k_fw_stats_vdev {
206 	struct list_head list;
207 
208 	u32 vdev_id;
209 	u32 beacon_snr;
210 	u32 data_snr;
211 	u32 num_tx_frames[4];
212 	u32 num_rx_frames;
213 	u32 num_tx_frames_retries[4];
214 	u32 num_tx_frames_failures[4];
215 	u32 num_rts_fail;
216 	u32 num_rts_success;
217 	u32 num_rx_err;
218 	u32 num_rx_discard;
219 	u32 num_tx_not_acked;
220 	u32 tx_rate_history[10];
221 	u32 beacon_rssi_history[10];
222 };
223 
224 struct ath10k_fw_stats_pdev {
225 	struct list_head list;
226 
227 	/* PDEV stats */
228 	s32 ch_noise_floor;
229 	u32 tx_frame_count; /* Cycles spent transmitting frames */
230 	u32 rx_frame_count; /* Cycles spent receiving frames */
231 	u32 rx_clear_count; /* Total channel busy time, evidently */
232 	u32 cycle_count; /* Total on-channel time */
233 	u32 phy_err_count;
234 	u32 chan_tx_power;
235 	u32 ack_rx_bad;
236 	u32 rts_bad;
237 	u32 rts_good;
238 	u32 fcs_bad;
239 	u32 no_beacons;
240 	u32 mib_int_count;
241 
242 	/* PDEV TX stats */
243 	s32 comp_queued;
244 	s32 comp_delivered;
245 	s32 msdu_enqued;
246 	s32 mpdu_enqued;
247 	s32 wmm_drop;
248 	s32 local_enqued;
249 	s32 local_freed;
250 	s32 hw_queued;
251 	s32 hw_reaped;
252 	s32 underrun;
253 	u32 hw_paused;
254 	s32 tx_abort;
255 	s32 mpdus_requed;
256 	u32 tx_ko;
257 	u32 data_rc;
258 	u32 self_triggers;
259 	u32 sw_retry_failure;
260 	u32 illgl_rate_phy_err;
261 	u32 pdev_cont_xretry;
262 	u32 pdev_tx_timeout;
263 	u32 pdev_resets;
264 	u32 phy_underrun;
265 	u32 txop_ovf;
266 	u32 seq_posted;
267 	u32 seq_failed_queueing;
268 	u32 seq_completed;
269 	u32 seq_restarted;
270 	u32 mu_seq_posted;
271 	u32 mpdus_sw_flush;
272 	u32 mpdus_hw_filter;
273 	u32 mpdus_truncated;
274 	u32 mpdus_ack_failed;
275 	u32 mpdus_expired;
276 
277 	/* PDEV RX stats */
278 	s32 mid_ppdu_route_change;
279 	s32 status_rcvd;
280 	s32 r0_frags;
281 	s32 r1_frags;
282 	s32 r2_frags;
283 	s32 r3_frags;
284 	s32 htt_msdus;
285 	s32 htt_mpdus;
286 	s32 loc_msdus;
287 	s32 loc_mpdus;
288 	s32 oversize_amsdu;
289 	s32 phy_errs;
290 	s32 phy_err_drop;
291 	s32 mpdu_errs;
292 	s32 rx_ovfl_errs;
293 };
294 
295 struct ath10k_fw_stats {
296 	bool extended;
297 	struct list_head pdevs;
298 	struct list_head vdevs;
299 	struct list_head peers;
300 	struct list_head peers_extd;
301 };
302 
303 #define ATH10K_TPC_TABLE_TYPE_FLAG	1
304 #define ATH10K_TPC_PREAM_TABLE_END	0xFFFF
305 
306 struct ath10k_tpc_table {
307 	u32 pream_idx[WMI_TPC_RATE_MAX];
308 	u8 rate_code[WMI_TPC_RATE_MAX];
309 	char tpc_value[WMI_TPC_RATE_MAX][WMI_TPC_TX_N_CHAIN * WMI_TPC_BUF_SIZE];
310 };
311 
312 struct ath10k_tpc_stats {
313 	u32 reg_domain;
314 	u32 chan_freq;
315 	u32 phy_mode;
316 	u32 twice_antenna_reduction;
317 	u32 twice_max_rd_power;
318 	s32 twice_antenna_gain;
319 	u32 power_limit;
320 	u32 num_tx_chain;
321 	u32 ctl;
322 	u32 rate_max;
323 	u8 flag[WMI_TPC_FLAG];
324 	struct ath10k_tpc_table tpc_table[WMI_TPC_FLAG];
325 };
326 
327 struct ath10k_dfs_stats {
328 	u32 phy_errors;
329 	u32 pulses_total;
330 	u32 pulses_detected;
331 	u32 pulses_discarded;
332 	u32 radar_detected;
333 };
334 
335 #define ATH10K_MAX_NUM_PEER_IDS (1 << 11) /* htt rx_desc limit */
336 
337 struct ath10k_peer {
338 	struct list_head list;
339 	struct ieee80211_vif *vif;
340 	struct ieee80211_sta *sta;
341 
342 	bool removed;
343 	int vdev_id;
344 	u8 addr[ETH_ALEN];
345 	DECLARE_BITMAP(peer_ids, ATH10K_MAX_NUM_PEER_IDS);
346 
347 	/* protected by ar->data_lock */
348 	struct ieee80211_key_conf *keys[WMI_MAX_KEY_INDEX + 1];
349 };
350 
351 struct ath10k_txq {
352 	struct list_head list;
353 	unsigned long num_fw_queued;
354 	unsigned long num_push_allowed;
355 };
356 
357 struct ath10k_sta {
358 	struct ath10k_vif *arvif;
359 
360 	/* the following are protected by ar->data_lock */
361 	u32 changed; /* IEEE80211_RC_* */
362 	u32 bw;
363 	u32 nss;
364 	u32 smps;
365 	u16 peer_id;
366 	struct rate_info txrate;
367 
368 	struct work_struct update_wk;
369 	u64 rx_duration;
370 
371 #ifdef CONFIG_MAC80211_DEBUGFS
372 	/* protected by conf_mutex */
373 	bool aggr_mode;
374 #endif
375 };
376 
377 #define ATH10K_VDEV_SETUP_TIMEOUT_HZ (5 * HZ)
378 
379 enum ath10k_beacon_state {
380 	ATH10K_BEACON_SCHEDULED = 0,
381 	ATH10K_BEACON_SENDING,
382 	ATH10K_BEACON_SENT,
383 };
384 
385 struct ath10k_vif {
386 	struct list_head list;
387 
388 	u32 vdev_id;
389 	u16 peer_id;
390 	enum wmi_vdev_type vdev_type;
391 	enum wmi_vdev_subtype vdev_subtype;
392 	u32 beacon_interval;
393 	u32 dtim_period;
394 	struct sk_buff *beacon;
395 	/* protected by data_lock */
396 	enum ath10k_beacon_state beacon_state;
397 	void *beacon_buf;
398 	dma_addr_t beacon_paddr;
399 	unsigned long tx_paused; /* arbitrary values defined by target */
400 
401 	struct ath10k *ar;
402 	struct ieee80211_vif *vif;
403 
404 	bool is_started;
405 	bool is_up;
406 	bool spectral_enabled;
407 	bool ps;
408 	u32 aid;
409 	u8 bssid[ETH_ALEN];
410 
411 	struct ieee80211_key_conf *wep_keys[WMI_MAX_KEY_INDEX + 1];
412 	s8 def_wep_key_idx;
413 
414 	u16 tx_seq_no;
415 
416 	union {
417 		struct {
418 			u32 uapsd;
419 		} sta;
420 		struct {
421 			/* 512 stations */
422 			u8 tim_bitmap[64];
423 			u8 tim_len;
424 			u32 ssid_len;
425 			u8 ssid[IEEE80211_MAX_SSID_LEN];
426 			bool hidden_ssid;
427 			/* P2P_IE with NoA attribute for P2P_GO case */
428 			u32 noa_len;
429 			u8 *noa_data;
430 		} ap;
431 	} u;
432 
433 	bool use_cts_prot;
434 	bool nohwcrypt;
435 	int num_legacy_stations;
436 	int txpower;
437 	struct wmi_wmm_params_all_arg wmm_params;
438 	struct work_struct ap_csa_work;
439 	struct delayed_work connection_loss_work;
440 	struct cfg80211_bitrate_mask bitrate_mask;
441 };
442 
443 struct ath10k_vif_iter {
444 	u32 vdev_id;
445 	struct ath10k_vif *arvif;
446 };
447 
448 /* Copy Engine register dump, protected by ce-lock */
449 struct ath10k_ce_crash_data {
450 	__le32 base_addr;
451 	__le32 src_wr_idx;
452 	__le32 src_r_idx;
453 	__le32 dst_wr_idx;
454 	__le32 dst_r_idx;
455 };
456 
457 struct ath10k_ce_crash_hdr {
458 	__le32 ce_count;
459 	__le32 reserved[3]; /* for future use */
460 	struct ath10k_ce_crash_data entries[];
461 };
462 
463 #define MAX_MEM_DUMP_TYPE	5
464 
465 /* used for crash-dump storage, protected by data-lock */
466 struct ath10k_fw_crash_data {
467 	guid_t guid;
468 	struct timespec64 timestamp;
469 	__le32 registers[REG_DUMP_COUNT_QCA988X];
470 	struct ath10k_ce_crash_data ce_crash_data[CE_COUNT_MAX];
471 
472 	u8 *ramdump_buf;
473 	size_t ramdump_buf_len;
474 };
475 
476 struct ath10k_debug {
477 	struct dentry *debugfs_phy;
478 
479 	struct ath10k_fw_stats fw_stats;
480 	struct completion fw_stats_complete;
481 	bool fw_stats_done;
482 
483 	unsigned long htt_stats_mask;
484 	struct delayed_work htt_stats_dwork;
485 	struct ath10k_dfs_stats dfs_stats;
486 	struct ath_dfs_pool_stats dfs_pool_stats;
487 
488 	/* used for tpc-dump storage, protected by data-lock */
489 	struct ath10k_tpc_stats *tpc_stats;
490 
491 	struct completion tpc_complete;
492 
493 	/* protected by conf_mutex */
494 	u64 fw_dbglog_mask;
495 	u32 fw_dbglog_level;
496 	u32 reg_addr;
497 	u32 nf_cal_period;
498 	void *cal_data;
499 };
500 
501 enum ath10k_state {
502 	ATH10K_STATE_OFF = 0,
503 	ATH10K_STATE_ON,
504 
505 	/* When doing firmware recovery the device is first powered down.
506 	 * mac80211 is supposed to call in to start() hook later on. It is
507 	 * however possible that driver unloading and firmware crash overlap.
508 	 * mac80211 can wait on conf_mutex in stop() while the device is
509 	 * stopped in ath10k_core_restart() work holding conf_mutex. The state
510 	 * RESTARTED means that the device is up and mac80211 has started hw
511 	 * reconfiguration. Once mac80211 is done with the reconfiguration we
512 	 * set the state to STATE_ON in reconfig_complete().
513 	 */
514 	ATH10K_STATE_RESTARTING,
515 	ATH10K_STATE_RESTARTED,
516 
517 	/* The device has crashed while restarting hw. This state is like ON
518 	 * but commands are blocked in HTC and -ECOMM response is given. This
519 	 * prevents completion timeouts and makes the driver more responsive to
520 	 * userspace commands. This is also prevents recursive recovery.
521 	 */
522 	ATH10K_STATE_WEDGED,
523 
524 	/* factory tests */
525 	ATH10K_STATE_UTF,
526 };
527 
528 enum ath10k_firmware_mode {
529 	/* the default mode, standard 802.11 functionality */
530 	ATH10K_FIRMWARE_MODE_NORMAL,
531 
532 	/* factory tests etc */
533 	ATH10K_FIRMWARE_MODE_UTF,
534 };
535 
536 enum ath10k_fw_features {
537 	/* wmi_mgmt_rx_hdr contains extra RSSI information */
538 	ATH10K_FW_FEATURE_EXT_WMI_MGMT_RX = 0,
539 
540 	/* Firmware from 10X branch. Deprecated, don't use in new code. */
541 	ATH10K_FW_FEATURE_WMI_10X = 1,
542 
543 	/* firmware support tx frame management over WMI, otherwise it's HTT */
544 	ATH10K_FW_FEATURE_HAS_WMI_MGMT_TX = 2,
545 
546 	/* Firmware does not support P2P */
547 	ATH10K_FW_FEATURE_NO_P2P = 3,
548 
549 	/* Firmware 10.2 feature bit. The ATH10K_FW_FEATURE_WMI_10X feature
550 	 * bit is required to be set as well. Deprecated, don't use in new
551 	 * code.
552 	 */
553 	ATH10K_FW_FEATURE_WMI_10_2 = 4,
554 
555 	/* Some firmware revisions lack proper multi-interface client powersave
556 	 * implementation. Enabling PS could result in connection drops,
557 	 * traffic stalls, etc.
558 	 */
559 	ATH10K_FW_FEATURE_MULTI_VIF_PS_SUPPORT = 5,
560 
561 	/* Some firmware revisions have an incomplete WoWLAN implementation
562 	 * despite WMI service bit being advertised. This feature flag is used
563 	 * to distinguish whether WoWLAN is really supported or not.
564 	 */
565 	ATH10K_FW_FEATURE_WOWLAN_SUPPORT = 6,
566 
567 	/* Don't trust error code from otp.bin */
568 	ATH10K_FW_FEATURE_IGNORE_OTP_RESULT = 7,
569 
570 	/* Some firmware revisions pad 4th hw address to 4 byte boundary making
571 	 * it 8 bytes long in Native Wifi Rx decap.
572 	 */
573 	ATH10K_FW_FEATURE_NO_NWIFI_DECAP_4ADDR_PADDING = 8,
574 
575 	/* Firmware supports bypassing PLL setting on init. */
576 	ATH10K_FW_FEATURE_SUPPORTS_SKIP_CLOCK_INIT = 9,
577 
578 	/* Raw mode support. If supported, FW supports receiving and trasmitting
579 	 * frames in raw mode.
580 	 */
581 	ATH10K_FW_FEATURE_RAW_MODE_SUPPORT = 10,
582 
583 	/* Firmware Supports Adaptive CCA*/
584 	ATH10K_FW_FEATURE_SUPPORTS_ADAPTIVE_CCA = 11,
585 
586 	/* Firmware supports management frame protection */
587 	ATH10K_FW_FEATURE_MFP_SUPPORT = 12,
588 
589 	/* Firmware supports pull-push model where host shares it's software
590 	 * queue state with firmware and firmware generates fetch requests
591 	 * telling host which queues to dequeue tx from.
592 	 *
593 	 * Primary function of this is improved MU-MIMO performance with
594 	 * multiple clients.
595 	 */
596 	ATH10K_FW_FEATURE_PEER_FLOW_CONTROL = 13,
597 
598 	/* Firmware supports BT-Coex without reloading firmware via pdev param.
599 	 * To support Bluetooth coexistence pdev param, WMI_COEX_GPIO_SUPPORT of
600 	 * extended resource config should be enabled always. This firmware IE
601 	 * is used to configure WMI_COEX_GPIO_SUPPORT.
602 	 */
603 	ATH10K_FW_FEATURE_BTCOEX_PARAM = 14,
604 
605 	/* Unused flag and proven to be not working, enable this if you want
606 	 * to experiment sending NULL func data frames in HTT TX
607 	 */
608 	ATH10K_FW_FEATURE_SKIP_NULL_FUNC_WAR = 15,
609 
610 	/* Firmware allow other BSS mesh broadcast/multicast frames without
611 	 * creating monitor interface. Appropriate rxfilters are programmed for
612 	 * mesh vdev by firmware itself. This feature flags will be used for
613 	 * not creating monitor vdev while configuring mesh node.
614 	 */
615 	ATH10K_FW_FEATURE_ALLOWS_MESH_BCAST = 16,
616 
617 	/* Firmware does not support power save in station mode. */
618 	ATH10K_FW_FEATURE_NO_PS = 17,
619 
620 	/* Firmware allows management tx by reference instead of by value. */
621 	ATH10K_FW_FEATURE_MGMT_TX_BY_REF = 18,
622 
623 	/* Firmware load is done externally, not by bmi */
624 	ATH10K_FW_FEATURE_NON_BMI = 19,
625 
626 	/* keep last */
627 	ATH10K_FW_FEATURE_COUNT,
628 };
629 
630 enum ath10k_dev_flags {
631 	/* Indicates that ath10k device is during CAC phase of DFS */
632 	ATH10K_CAC_RUNNING,
633 	ATH10K_FLAG_CORE_REGISTERED,
634 
635 	/* Device has crashed and needs to restart. This indicates any pending
636 	 * waiters should immediately cancel instead of waiting for a time out.
637 	 */
638 	ATH10K_FLAG_CRASH_FLUSH,
639 
640 	/* Use Raw mode instead of native WiFi Tx/Rx encap mode.
641 	 * Raw mode supports both hardware and software crypto. Native WiFi only
642 	 * supports hardware crypto.
643 	 */
644 	ATH10K_FLAG_RAW_MODE,
645 
646 	/* Disable HW crypto engine */
647 	ATH10K_FLAG_HW_CRYPTO_DISABLED,
648 
649 	/* Bluetooth coexistance enabled */
650 	ATH10K_FLAG_BTCOEX,
651 
652 	/* Per Station statistics service */
653 	ATH10K_FLAG_PEER_STATS,
654 };
655 
656 enum ath10k_cal_mode {
657 	ATH10K_CAL_MODE_FILE,
658 	ATH10K_CAL_MODE_OTP,
659 	ATH10K_CAL_MODE_DT,
660 	ATH10K_PRE_CAL_MODE_FILE,
661 	ATH10K_PRE_CAL_MODE_DT,
662 	ATH10K_CAL_MODE_EEPROM,
663 };
664 
665 enum ath10k_crypt_mode {
666 	/* Only use hardware crypto engine */
667 	ATH10K_CRYPT_MODE_HW,
668 	/* Only use software crypto engine */
669 	ATH10K_CRYPT_MODE_SW,
670 };
671 
672 static inline const char *ath10k_cal_mode_str(enum ath10k_cal_mode mode)
673 {
674 	switch (mode) {
675 	case ATH10K_CAL_MODE_FILE:
676 		return "file";
677 	case ATH10K_CAL_MODE_OTP:
678 		return "otp";
679 	case ATH10K_CAL_MODE_DT:
680 		return "dt";
681 	case ATH10K_PRE_CAL_MODE_FILE:
682 		return "pre-cal-file";
683 	case ATH10K_PRE_CAL_MODE_DT:
684 		return "pre-cal-dt";
685 	case ATH10K_CAL_MODE_EEPROM:
686 		return "eeprom";
687 	}
688 
689 	return "unknown";
690 }
691 
692 enum ath10k_scan_state {
693 	ATH10K_SCAN_IDLE,
694 	ATH10K_SCAN_STARTING,
695 	ATH10K_SCAN_RUNNING,
696 	ATH10K_SCAN_ABORTING,
697 };
698 
699 static inline const char *ath10k_scan_state_str(enum ath10k_scan_state state)
700 {
701 	switch (state) {
702 	case ATH10K_SCAN_IDLE:
703 		return "idle";
704 	case ATH10K_SCAN_STARTING:
705 		return "starting";
706 	case ATH10K_SCAN_RUNNING:
707 		return "running";
708 	case ATH10K_SCAN_ABORTING:
709 		return "aborting";
710 	}
711 
712 	return "unknown";
713 }
714 
715 enum ath10k_tx_pause_reason {
716 	ATH10K_TX_PAUSE_Q_FULL,
717 	ATH10K_TX_PAUSE_MAX,
718 };
719 
720 struct ath10k_fw_file {
721 	const struct firmware *firmware;
722 
723 	char fw_version[ETHTOOL_FWVERS_LEN];
724 
725 	DECLARE_BITMAP(fw_features, ATH10K_FW_FEATURE_COUNT);
726 
727 	enum ath10k_fw_wmi_op_version wmi_op_version;
728 	enum ath10k_fw_htt_op_version htt_op_version;
729 
730 	const void *firmware_data;
731 	size_t firmware_len;
732 
733 	const void *otp_data;
734 	size_t otp_len;
735 
736 	const void *codeswap_data;
737 	size_t codeswap_len;
738 
739 	/* The original idea of struct ath10k_fw_file was that it only
740 	 * contains struct firmware and pointers to various parts (actual
741 	 * firmware binary, otp, metadata etc) of the file. This seg_info
742 	 * is actually created separate but as this is used similarly as
743 	 * the other firmware components it's more convenient to have it
744 	 * here.
745 	 */
746 	struct ath10k_swap_code_seg_info *firmware_swap_code_seg_info;
747 };
748 
749 struct ath10k_fw_components {
750 	const struct firmware *board;
751 	const void *board_data;
752 	size_t board_len;
753 
754 	struct ath10k_fw_file fw_file;
755 };
756 
757 struct ath10k_per_peer_tx_stats {
758 	u32	succ_bytes;
759 	u32	retry_bytes;
760 	u32	failed_bytes;
761 	u8	ratecode;
762 	u8	flags;
763 	u16	peer_id;
764 	u16	succ_pkts;
765 	u16	retry_pkts;
766 	u16	failed_pkts;
767 	u16	duration;
768 	u32	reserved1;
769 	u32	reserved2;
770 };
771 
772 struct ath10k {
773 	struct ath_common ath_common;
774 	struct ieee80211_hw *hw;
775 	struct ieee80211_ops *ops;
776 	struct device *dev;
777 	u8 mac_addr[ETH_ALEN];
778 
779 	enum ath10k_hw_rev hw_rev;
780 	u16 dev_id;
781 	u32 chip_id;
782 	u32 target_version;
783 	u8 fw_version_major;
784 	u32 fw_version_minor;
785 	u16 fw_version_release;
786 	u16 fw_version_build;
787 	u32 fw_stats_req_mask;
788 	u32 phy_capability;
789 	u32 hw_min_tx_power;
790 	u32 hw_max_tx_power;
791 	u32 hw_eeprom_rd;
792 	u32 ht_cap_info;
793 	u32 vht_cap_info;
794 	u32 num_rf_chains;
795 	u32 max_spatial_stream;
796 	/* protected by conf_mutex */
797 	u32 low_5ghz_chan;
798 	u32 high_5ghz_chan;
799 	bool ani_enabled;
800 
801 	bool p2p;
802 
803 	struct {
804 		enum ath10k_bus bus;
805 		const struct ath10k_hif_ops *ops;
806 	} hif;
807 
808 	struct completion target_suspend;
809 
810 	const struct ath10k_hw_regs *regs;
811 	const struct ath10k_hw_ce_regs *hw_ce_regs;
812 	const struct ath10k_hw_values *hw_values;
813 	struct ath10k_bmi bmi;
814 	struct ath10k_wmi wmi;
815 	struct ath10k_htc htc;
816 	struct ath10k_htt htt;
817 
818 	struct ath10k_hw_params hw_params;
819 
820 	/* contains the firmware images used with ATH10K_FIRMWARE_MODE_NORMAL */
821 	struct ath10k_fw_components normal_mode_fw;
822 
823 	/* READ-ONLY images of the running firmware, which can be either
824 	 * normal or UTF. Do not modify, release etc!
825 	 */
826 	const struct ath10k_fw_components *running_fw;
827 
828 	const struct firmware *pre_cal_file;
829 	const struct firmware *cal_file;
830 
831 	struct {
832 		u32 vendor;
833 		u32 device;
834 		u32 subsystem_vendor;
835 		u32 subsystem_device;
836 
837 		bool bmi_ids_valid;
838 		u8 bmi_board_id;
839 		u8 bmi_chip_id;
840 
841 		char bdf_ext[ATH10K_SMBIOS_BDF_EXT_STR_LENGTH];
842 	} id;
843 
844 	int fw_api;
845 	int bd_api;
846 	enum ath10k_cal_mode cal_mode;
847 
848 	struct {
849 		struct completion started;
850 		struct completion completed;
851 		struct completion on_channel;
852 		struct delayed_work timeout;
853 		enum ath10k_scan_state state;
854 		bool is_roc;
855 		int vdev_id;
856 		int roc_freq;
857 		bool roc_notify;
858 	} scan;
859 
860 	struct {
861 		struct ieee80211_supported_band sbands[NUM_NL80211_BANDS];
862 	} mac;
863 
864 	/* should never be NULL; needed for regular htt rx */
865 	struct ieee80211_channel *rx_channel;
866 
867 	/* valid during scan; needed for mgmt rx during scan */
868 	struct ieee80211_channel *scan_channel;
869 
870 	/* current operating channel definition */
871 	struct cfg80211_chan_def chandef;
872 
873 	/* currently configured operating channel in firmware */
874 	struct ieee80211_channel *tgt_oper_chan;
875 
876 	unsigned long long free_vdev_map;
877 	struct ath10k_vif *monitor_arvif;
878 	bool monitor;
879 	int monitor_vdev_id;
880 	bool monitor_started;
881 	unsigned int filter_flags;
882 	unsigned long dev_flags;
883 	bool dfs_block_radar_events;
884 
885 	/* protected by conf_mutex */
886 	bool radar_enabled;
887 	int num_started_vdevs;
888 
889 	/* Protected by conf-mutex */
890 	u8 cfg_tx_chainmask;
891 	u8 cfg_rx_chainmask;
892 
893 	struct completion install_key_done;
894 
895 	struct completion vdev_setup_done;
896 
897 	struct workqueue_struct *workqueue;
898 	/* Auxiliary workqueue */
899 	struct workqueue_struct *workqueue_aux;
900 
901 	/* prevents concurrent FW reconfiguration */
902 	struct mutex conf_mutex;
903 
904 	/* protects shared structure data */
905 	spinlock_t data_lock;
906 	/* protects: ar->txqs, artxq->list */
907 	spinlock_t txqs_lock;
908 
909 	struct list_head txqs;
910 	struct list_head arvifs;
911 	struct list_head peers;
912 	struct ath10k_peer *peer_map[ATH10K_MAX_NUM_PEER_IDS];
913 	wait_queue_head_t peer_mapping_wq;
914 
915 	/* protected by conf_mutex */
916 	int num_peers;
917 	int num_stations;
918 
919 	int max_num_peers;
920 	int max_num_stations;
921 	int max_num_vdevs;
922 	int max_num_tdls_vdevs;
923 	int num_active_peers;
924 	int num_tids;
925 
926 	struct work_struct svc_rdy_work;
927 	struct sk_buff *svc_rdy_skb;
928 
929 	struct work_struct offchan_tx_work;
930 	struct sk_buff_head offchan_tx_queue;
931 	struct completion offchan_tx_completed;
932 	struct sk_buff *offchan_tx_skb;
933 
934 	struct work_struct wmi_mgmt_tx_work;
935 	struct sk_buff_head wmi_mgmt_tx_queue;
936 
937 	enum ath10k_state state;
938 
939 	struct work_struct register_work;
940 	struct work_struct restart_work;
941 
942 	/* cycle count is reported twice for each visited channel during scan.
943 	 * access protected by data_lock
944 	 */
945 	u32 survey_last_rx_clear_count;
946 	u32 survey_last_cycle_count;
947 	struct survey_info survey[ATH10K_NUM_CHANS];
948 
949 	/* Channel info events are expected to come in pairs without and with
950 	 * COMPLETE flag set respectively for each channel visit during scan.
951 	 *
952 	 * However there are deviations from this rule. This flag is used to
953 	 * avoid reporting garbage data.
954 	 */
955 	bool ch_info_can_report_survey;
956 	struct completion bss_survey_done;
957 
958 	struct dfs_pattern_detector *dfs_detector;
959 
960 	unsigned long tx_paused; /* see ATH10K_TX_PAUSE_ */
961 
962 #ifdef CONFIG_ATH10K_DEBUGFS
963 	struct ath10k_debug debug;
964 	struct {
965 		/* relay(fs) channel for spectral scan */
966 		struct rchan *rfs_chan_spec_scan;
967 
968 		/* spectral_mode and spec_config are protected by conf_mutex */
969 		enum ath10k_spectral_mode mode;
970 		struct ath10k_spec_scan config;
971 	} spectral;
972 #endif
973 
974 	u32 pktlog_filter;
975 
976 #ifdef CONFIG_DEV_COREDUMP
977 	struct {
978 		struct ath10k_fw_crash_data *fw_crash_data;
979 	} coredump;
980 #endif
981 
982 	struct {
983 		/* protected by conf_mutex */
984 		struct ath10k_fw_components utf_mode_fw;
985 
986 		/* protected by data_lock */
987 		bool utf_monitor;
988 	} testmode;
989 
990 	struct {
991 		/* protected by data_lock */
992 		u32 fw_crash_counter;
993 		u32 fw_warm_reset_counter;
994 		u32 fw_cold_reset_counter;
995 	} stats;
996 
997 	struct ath10k_thermal thermal;
998 	struct ath10k_wow wow;
999 	struct ath10k_per_peer_tx_stats peer_tx_stats;
1000 
1001 	/* NAPI */
1002 	struct net_device napi_dev;
1003 	struct napi_struct napi;
1004 
1005 	struct work_struct set_coverage_class_work;
1006 	/* protected by conf_mutex */
1007 	struct {
1008 		/* writing also protected by data_lock */
1009 		s16 coverage_class;
1010 
1011 		u32 reg_phyclk;
1012 		u32 reg_slottime_conf;
1013 		u32 reg_slottime_orig;
1014 		u32 reg_ack_cts_timeout_conf;
1015 		u32 reg_ack_cts_timeout_orig;
1016 	} fw_coverage;
1017 
1018 	u32 ampdu_reference;
1019 
1020 	void *ce_priv;
1021 
1022 	/* must be last */
1023 	u8 drv_priv[0] __aligned(sizeof(void *));
1024 };
1025 
1026 static inline bool ath10k_peer_stats_enabled(struct ath10k *ar)
1027 {
1028 	if (test_bit(ATH10K_FLAG_PEER_STATS, &ar->dev_flags) &&
1029 	    test_bit(WMI_SERVICE_PEER_STATS, ar->wmi.svc_map))
1030 		return true;
1031 
1032 	return false;
1033 }
1034 
1035 extern unsigned long ath10k_coredump_mask;
1036 
1037 struct ath10k *ath10k_core_create(size_t priv_size, struct device *dev,
1038 				  enum ath10k_bus bus,
1039 				  enum ath10k_hw_rev hw_rev,
1040 				  const struct ath10k_hif_ops *hif_ops);
1041 void ath10k_core_destroy(struct ath10k *ar);
1042 void ath10k_core_get_fw_features_str(struct ath10k *ar,
1043 				     char *buf,
1044 				     size_t max_len);
1045 int ath10k_core_fetch_firmware_api_n(struct ath10k *ar, const char *name,
1046 				     struct ath10k_fw_file *fw_file);
1047 
1048 int ath10k_core_start(struct ath10k *ar, enum ath10k_firmware_mode mode,
1049 		      const struct ath10k_fw_components *fw_components);
1050 int ath10k_wait_for_suspend(struct ath10k *ar, u32 suspend_opt);
1051 void ath10k_core_stop(struct ath10k *ar);
1052 int ath10k_core_register(struct ath10k *ar, u32 chip_id);
1053 void ath10k_core_unregister(struct ath10k *ar);
1054 
1055 #endif /* _CORE_H_ */
1056