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