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