2 * Copyright (c) 2005-2011 Atheros Communications Inc.
3 * Copyright (c) 2011-2013 Qualcomm Atheros, Inc.
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.
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.
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>
31 #include "targaddrs.h"
35 #include "../dfs_pattern_detector.h"
40 #define MS(_v, _f) (((_v) & _f##_MASK) >> _f##_LSB)
41 #define SM(_v, _f) (((_v) << _f##_LSB) & _f##_MASK)
42 #define WO(_f) ((_f##_OFFSET) >> 2)
44 #define ATH10K_SCAN_ID 0
45 #define WMI_READY_TIMEOUT (5 * HZ)
46 #define ATH10K_FLUSH_TIMEOUT_HZ (5*HZ)
47 #define ATH10K_CONNECTION_LOSS_HZ (3*HZ)
48 #define ATH10K_NUM_CHANS 39
50 /* Antenna noise floor */
51 #define ATH10K_DEFAULT_NOISE_FLOOR -95
53 #define ATH10K_MAX_NUM_MGMT_PENDING 128
55 /* number of failed packets (20 packets with 16 sw reties each) */
56 #define ATH10K_KICKOUT_THRESHOLD (20 * 16)
59 * Use insanely high numbers to make sure that the firmware implementation
60 * won't start, we have the same functionality already in hostapd. Unit
63 #define ATH10K_KEEPALIVE_MIN_IDLE 3747
64 #define ATH10K_KEEPALIVE_MAX_IDLE 3895
65 #define ATH10K_KEEPALIVE_MAX_UNRESPONSIVE 3900
73 static inline const char *ath10k_bus_str(enum ath10k_bus bus)
83 struct ath10k_skb_cb {
87 enum ath10k_hw_txrx_mode txmode;
94 struct ath10k_htt_txbuf *txbuf;
104 struct ath10k_skb_rxcb {
106 struct hlist_node hlist;
109 static inline struct ath10k_skb_cb *ATH10K_SKB_CB(struct sk_buff *skb)
111 BUILD_BUG_ON(sizeof(struct ath10k_skb_cb) >
112 IEEE80211_TX_INFO_DRIVER_DATA_SIZE);
113 return (struct ath10k_skb_cb *)&IEEE80211_SKB_CB(skb)->driver_data;
116 static inline struct ath10k_skb_rxcb *ATH10K_SKB_RXCB(struct sk_buff *skb)
118 BUILD_BUG_ON(sizeof(struct ath10k_skb_rxcb) > sizeof(skb->cb));
119 return (struct ath10k_skb_rxcb *)skb->cb;
122 #define ATH10K_RXCB_SKB(rxcb) \
123 container_of((void *)rxcb, struct sk_buff, cb)
125 static inline u32 host_interest_item_address(u32 item_offset)
127 return QCA988X_HOST_INTEREST_ADDRESS + item_offset;
134 struct ath10k_mem_chunk {
142 enum ath10k_fw_wmi_op_version op_version;
143 enum ath10k_htc_ep_id eid;
144 struct completion service_ready;
145 struct completion unified_ready;
146 wait_queue_head_t tx_credits_wq;
147 DECLARE_BITMAP(svc_map, WMI_SERVICE_MAX);
148 struct wmi_cmd_map *cmd;
149 struct wmi_vdev_param_map *vdev_param;
150 struct wmi_pdev_param_map *pdev_param;
151 const struct wmi_ops *ops;
154 struct ath10k_mem_chunk mem_chunks[WMI_MAX_MEM_REQS];
157 struct ath10k_fw_stats_peer {
158 struct list_head list;
160 u8 peer_macaddr[ETH_ALEN];
163 u32 peer_rx_rate; /* 10x only */
166 struct ath10k_fw_stats_vdev {
167 struct list_head list;
172 u32 num_tx_frames[4];
174 u32 num_tx_frames_retries[4];
175 u32 num_tx_frames_failures[4];
180 u32 num_tx_not_acked;
181 u32 tx_rate_history[10];
182 u32 beacon_rssi_history[10];
185 struct ath10k_fw_stats_pdev {
186 struct list_head list;
219 u32 sw_retry_failure;
220 u32 illgl_rate_phy_err;
221 u32 pdev_cont_xretry;
228 s32 mid_ppdu_route_change;
244 struct ath10k_fw_stats {
245 struct list_head pdevs;
246 struct list_head vdevs;
247 struct list_head peers;
250 struct ath10k_dfs_stats {
254 u32 pulses_discarded;
258 #define ATH10K_MAX_NUM_PEER_IDS (1 << 11) /* htt rx_desc limit */
261 struct list_head list;
264 DECLARE_BITMAP(peer_ids, ATH10K_MAX_NUM_PEER_IDS);
266 /* protected by ar->data_lock */
267 struct ieee80211_key_conf *keys[WMI_MAX_KEY_INDEX + 1];
271 struct ath10k_vif *arvif;
273 /* the following are protected by ar->data_lock */
274 u32 changed; /* IEEE80211_RC_* */
279 struct work_struct update_wk;
281 #ifdef CONFIG_MAC80211_DEBUGFS
282 /* protected by conf_mutex */
287 struct ath10k_chanctx {
288 /* Used to story copy of chanctx_conf to avoid inconsistencies. Ideally
289 * mac80211 should allow some sort of explicit locking to guarantee
290 * that the publicly available chanctx_conf can be accessed safely at
293 struct ieee80211_chanctx_conf conf;
296 #define ATH10K_VDEV_SETUP_TIMEOUT_HZ (5*HZ)
298 enum ath10k_beacon_state {
299 ATH10K_BEACON_SCHEDULED = 0,
300 ATH10K_BEACON_SENDING,
305 struct list_head list;
308 enum wmi_vdev_type vdev_type;
309 enum wmi_vdev_subtype vdev_subtype;
312 struct sk_buff *beacon;
313 /* protected by data_lock */
314 enum ath10k_beacon_state beacon_state;
316 dma_addr_t beacon_paddr;
317 unsigned long tx_paused; /* arbitrary values defined by target */
320 struct ieee80211_vif *vif;
324 bool spectral_enabled;
329 struct ieee80211_key_conf *wep_keys[WMI_MAX_KEY_INDEX + 1];
339 /* 127 stations; wmi limit */
343 u8 ssid[IEEE80211_MAX_SSID_LEN];
345 /* P2P_IE with NoA attribute for P2P_GO case */
352 int num_legacy_stations;
354 struct wmi_wmm_params_all_arg wmm_params;
355 struct work_struct ap_csa_work;
356 struct delayed_work connection_loss_work;
357 struct cfg80211_bitrate_mask bitrate_mask;
360 struct ath10k_vif_iter {
362 struct ath10k_vif *arvif;
365 /* used for crash-dump storage, protected by data-lock */
366 struct ath10k_fw_crash_data {
367 bool crashed_since_read;
370 struct timespec timestamp;
371 __le32 registers[REG_DUMP_COUNT_QCA988X];
374 struct ath10k_debug {
375 struct dentry *debugfs_phy;
377 struct ath10k_fw_stats fw_stats;
378 struct completion fw_stats_complete;
381 unsigned long htt_stats_mask;
382 struct delayed_work htt_stats_dwork;
383 struct ath10k_dfs_stats dfs_stats;
384 struct ath_dfs_pool_stats dfs_pool_stats;
386 /* protected by conf_mutex */
396 struct ath10k_fw_crash_data *fw_crash_data;
400 ATH10K_STATE_OFF = 0,
403 /* When doing firmware recovery the device is first powered down.
404 * mac80211 is supposed to call in to start() hook later on. It is
405 * however possible that driver unloading and firmware crash overlap.
406 * mac80211 can wait on conf_mutex in stop() while the device is
407 * stopped in ath10k_core_restart() work holding conf_mutex. The state
408 * RESTARTED means that the device is up and mac80211 has started hw
409 * reconfiguration. Once mac80211 is done with the reconfiguration we
410 * set the state to STATE_ON in reconfig_complete(). */
411 ATH10K_STATE_RESTARTING,
412 ATH10K_STATE_RESTARTED,
414 /* The device has crashed while restarting hw. This state is like ON
415 * but commands are blocked in HTC and -ECOMM response is given. This
416 * prevents completion timeouts and makes the driver more responsive to
417 * userspace commands. This is also prevents recursive recovery. */
424 enum ath10k_firmware_mode {
425 /* the default mode, standard 802.11 functionality */
426 ATH10K_FIRMWARE_MODE_NORMAL,
428 /* factory tests etc */
429 ATH10K_FIRMWARE_MODE_UTF,
432 enum ath10k_fw_features {
433 /* wmi_mgmt_rx_hdr contains extra RSSI information */
434 ATH10K_FW_FEATURE_EXT_WMI_MGMT_RX = 0,
436 /* Firmware from 10X branch. Deprecated, don't use in new code. */
437 ATH10K_FW_FEATURE_WMI_10X = 1,
439 /* firmware support tx frame management over WMI, otherwise it's HTT */
440 ATH10K_FW_FEATURE_HAS_WMI_MGMT_TX = 2,
442 /* Firmware does not support P2P */
443 ATH10K_FW_FEATURE_NO_P2P = 3,
445 /* Firmware 10.2 feature bit. The ATH10K_FW_FEATURE_WMI_10X feature
446 * bit is required to be set as well. Deprecated, don't use in new
449 ATH10K_FW_FEATURE_WMI_10_2 = 4,
451 /* Some firmware revisions lack proper multi-interface client powersave
452 * implementation. Enabling PS could result in connection drops,
453 * traffic stalls, etc.
455 ATH10K_FW_FEATURE_MULTI_VIF_PS_SUPPORT = 5,
457 /* Some firmware revisions have an incomplete WoWLAN implementation
458 * despite WMI service bit being advertised. This feature flag is used
459 * to distinguish whether WoWLAN is really supported or not.
461 ATH10K_FW_FEATURE_WOWLAN_SUPPORT = 6,
463 /* Don't trust error code from otp.bin */
464 ATH10K_FW_FEATURE_IGNORE_OTP_RESULT,
466 /* Some firmware revisions pad 4th hw address to 4 byte boundary making
467 * it 8 bytes long in Native Wifi Rx decap.
469 ATH10K_FW_FEATURE_NO_NWIFI_DECAP_4ADDR_PADDING,
471 /* Firmware supports bypassing PLL setting on init. */
472 ATH10K_FW_FEATURE_SUPPORTS_SKIP_CLOCK_INIT = 9,
475 ATH10K_FW_FEATURE_COUNT,
478 enum ath10k_dev_flags {
479 /* Indicates that ath10k device is during CAC phase of DFS */
481 ATH10K_FLAG_CORE_REGISTERED,
483 /* Device has crashed and needs to restart. This indicates any pending
484 * waiters should immediately cancel instead of waiting for a time out.
486 ATH10K_FLAG_CRASH_FLUSH,
489 enum ath10k_cal_mode {
490 ATH10K_CAL_MODE_FILE,
495 static inline const char *ath10k_cal_mode_str(enum ath10k_cal_mode mode)
498 case ATH10K_CAL_MODE_FILE:
500 case ATH10K_CAL_MODE_OTP:
502 case ATH10K_CAL_MODE_DT:
509 enum ath10k_scan_state {
511 ATH10K_SCAN_STARTING,
513 ATH10K_SCAN_ABORTING,
516 static inline const char *ath10k_scan_state_str(enum ath10k_scan_state state)
519 case ATH10K_SCAN_IDLE:
521 case ATH10K_SCAN_STARTING:
523 case ATH10K_SCAN_RUNNING:
525 case ATH10K_SCAN_ABORTING:
532 enum ath10k_tx_pause_reason {
533 ATH10K_TX_PAUSE_Q_FULL,
538 struct ath_common ath_common;
539 struct ieee80211_hw *hw;
541 u8 mac_addr[ETH_ALEN];
543 enum ath10k_hw_rev hw_rev;
547 u32 fw_version_minor;
548 u16 fw_version_release;
549 u16 fw_version_build;
550 u32 fw_stats_req_mask;
557 /* protected by conf_mutex */
560 DECLARE_BITMAP(fw_features, ATH10K_FW_FEATURE_COUNT);
566 const struct ath10k_hif_ops *ops;
569 struct completion target_suspend;
571 const struct ath10k_hw_regs *regs;
572 struct ath10k_bmi bmi;
573 struct ath10k_wmi wmi;
574 struct ath10k_htc htc;
575 struct ath10k_htt htt;
577 struct ath10k_hw_params {
583 /* This is true if given HW chip has a quirky Cycle Counter
584 * wraparound which resets to 0x7fffffff instead of 0. All
585 * other CC related counters (e.g. Rx Clear Count) are divided
586 * by 2 so they never wraparound themselves.
588 bool has_shifted_cc_wraparound;
590 struct ath10k_hw_params_fw {
596 size_t board_ext_size;
600 const struct firmware *board;
601 const void *board_data;
604 const struct firmware *otp;
605 const void *otp_data;
608 const struct firmware *firmware;
609 const void *firmware_data;
612 const struct firmware *cal_file;
614 char spec_board_id[100];
615 bool spec_board_loaded;
618 enum ath10k_cal_mode cal_mode;
621 struct completion started;
622 struct completion completed;
623 struct completion on_channel;
624 struct delayed_work timeout;
625 enum ath10k_scan_state state;
632 struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
635 /* should never be NULL; needed for regular htt rx */
636 struct ieee80211_channel *rx_channel;
638 /* valid during scan; needed for mgmt rx during scan */
639 struct ieee80211_channel *scan_channel;
641 /* current operating channel definition */
642 struct cfg80211_chan_def chandef;
644 unsigned long long free_vdev_map;
645 struct ath10k_vif *monitor_arvif;
648 bool monitor_started;
649 unsigned int filter_flags;
650 unsigned long dev_flags;
651 u32 dfs_block_radar_events;
653 /* protected by conf_mutex */
655 int num_started_vdevs;
657 /* Protected by conf-mutex */
658 u8 supp_tx_chainmask;
659 u8 supp_rx_chainmask;
663 struct completion install_key_done;
665 struct completion vdev_setup_done;
667 struct workqueue_struct *workqueue;
669 /* prevents concurrent FW reconfiguration */
670 struct mutex conf_mutex;
672 /* protects shared structure data */
673 spinlock_t data_lock;
675 struct list_head arvifs;
676 struct list_head peers;
677 wait_queue_head_t peer_mapping_wq;
679 /* protected by conf_mutex */
684 int max_num_stations;
686 int max_num_tdls_vdevs;
688 struct work_struct offchan_tx_work;
689 struct sk_buff_head offchan_tx_queue;
690 struct completion offchan_tx_completed;
691 struct sk_buff *offchan_tx_skb;
693 struct work_struct wmi_mgmt_tx_work;
694 struct sk_buff_head wmi_mgmt_tx_queue;
696 enum ath10k_state state;
698 struct work_struct register_work;
699 struct work_struct restart_work;
701 /* cycle count is reported twice for each visited channel during scan.
702 * access protected by data_lock */
703 u32 survey_last_rx_clear_count;
704 u32 survey_last_cycle_count;
705 struct survey_info survey[ATH10K_NUM_CHANS];
707 /* Channel info events are expected to come in pairs without and with
708 * COMPLETE flag set respectively for each channel visit during scan.
710 * However there are deviations from this rule. This flag is used to
711 * avoid reporting garbage data.
713 bool ch_info_can_report_survey;
715 struct dfs_pattern_detector *dfs_detector;
717 unsigned long tx_paused; /* see ATH10K_TX_PAUSE_ */
719 #ifdef CONFIG_ATH10K_DEBUGFS
720 struct ath10k_debug debug;
724 /* relay(fs) channel for spectral scan */
725 struct rchan *rfs_chan_spec_scan;
727 /* spectral_mode and spec_config are protected by conf_mutex */
728 enum ath10k_spectral_mode mode;
729 struct ath10k_spec_scan config;
733 /* protected by conf_mutex */
734 const struct firmware *utf;
735 DECLARE_BITMAP(orig_fw_features, ATH10K_FW_FEATURE_COUNT);
736 enum ath10k_fw_wmi_op_version orig_wmi_op_version;
738 /* protected by data_lock */
743 /* protected by data_lock */
744 u32 fw_crash_counter;
745 u32 fw_warm_reset_counter;
746 u32 fw_cold_reset_counter;
749 struct ath10k_thermal thermal;
750 struct ath10k_wow wow;
753 u8 drv_priv[0] __aligned(sizeof(void *));
756 struct ath10k *ath10k_core_create(size_t priv_size, struct device *dev,
758 enum ath10k_hw_rev hw_rev,
759 const struct ath10k_hif_ops *hif_ops);
760 void ath10k_core_destroy(struct ath10k *ar);
762 int ath10k_core_start(struct ath10k *ar, enum ath10k_firmware_mode mode);
763 int ath10k_wait_for_suspend(struct ath10k *ar, u32 suspend_opt);
764 void ath10k_core_stop(struct ath10k *ar);
765 int ath10k_core_register(struct ath10k *ar, u32 chip_id);
766 void ath10k_core_unregister(struct ath10k *ar);
768 #endif /* _CORE_H_ */