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