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