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"
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)
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 39
51 /* Antenna noise floor */
52 #define ATH10K_DEFAULT_NOISE_FLOOR -95
54 #define ATH10K_MAX_NUM_MGMT_PENDING 128
56 /* number of failed packets (20 packets with 16 sw reties each) */
57 #define ATH10K_KICKOUT_THRESHOLD (20 * 16)
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
64 #define ATH10K_KEEPALIVE_MIN_IDLE 3747
65 #define ATH10K_KEEPALIVE_MAX_IDLE 3895
66 #define ATH10K_KEEPALIVE_MAX_UNRESPONSIVE 3900
74 static inline const char *ath10k_bus_str(enum ath10k_bus bus)
84 struct ath10k_skb_cb {
88 enum ath10k_hw_txrx_mode txmode;
96 struct ath10k_htt_txbuf *txbuf;
106 struct ath10k_skb_rxcb {
108 struct hlist_node hlist;
111 static inline struct ath10k_skb_cb *ATH10K_SKB_CB(struct sk_buff *skb)
113 BUILD_BUG_ON(sizeof(struct ath10k_skb_cb) >
114 IEEE80211_TX_INFO_DRIVER_DATA_SIZE);
115 return (struct ath10k_skb_cb *)&IEEE80211_SKB_CB(skb)->driver_data;
118 static inline struct ath10k_skb_rxcb *ATH10K_SKB_RXCB(struct sk_buff *skb)
120 BUILD_BUG_ON(sizeof(struct ath10k_skb_rxcb) > sizeof(skb->cb));
121 return (struct ath10k_skb_rxcb *)skb->cb;
124 #define ATH10K_RXCB_SKB(rxcb) \
125 container_of((void *)rxcb, struct sk_buff, cb)
127 static inline u32 host_interest_item_address(u32 item_offset)
129 return QCA988X_HOST_INTEREST_ADDRESS + item_offset;
136 struct ath10k_mem_chunk {
144 enum ath10k_fw_wmi_op_version op_version;
145 enum ath10k_htc_ep_id eid;
146 struct completion service_ready;
147 struct completion unified_ready;
148 wait_queue_head_t tx_credits_wq;
149 DECLARE_BITMAP(svc_map, WMI_SERVICE_MAX);
150 struct wmi_cmd_map *cmd;
151 struct wmi_vdev_param_map *vdev_param;
152 struct wmi_pdev_param_map *pdev_param;
153 const struct wmi_ops *ops;
157 struct ath10k_mem_chunk mem_chunks[WMI_MAX_MEM_REQS];
160 struct ath10k_fw_stats_peer {
161 struct list_head list;
163 u8 peer_macaddr[ETH_ALEN];
166 u32 peer_rx_rate; /* 10x only */
169 struct ath10k_fw_stats_vdev {
170 struct list_head list;
175 u32 num_tx_frames[4];
177 u32 num_tx_frames_retries[4];
178 u32 num_tx_frames_failures[4];
183 u32 num_tx_not_acked;
184 u32 tx_rate_history[10];
185 u32 beacon_rssi_history[10];
188 struct ath10k_fw_stats_pdev {
189 struct list_head list;
222 u32 sw_retry_failure;
223 u32 illgl_rate_phy_err;
224 u32 pdev_cont_xretry;
231 s32 mid_ppdu_route_change;
247 struct ath10k_fw_stats {
248 struct list_head pdevs;
249 struct list_head vdevs;
250 struct list_head peers;
253 struct ath10k_dfs_stats {
257 u32 pulses_discarded;
261 #define ATH10K_MAX_NUM_PEER_IDS (1 << 11) /* htt rx_desc limit */
264 struct list_head list;
267 DECLARE_BITMAP(peer_ids, ATH10K_MAX_NUM_PEER_IDS);
269 /* protected by ar->data_lock */
270 struct ieee80211_key_conf *keys[WMI_MAX_KEY_INDEX + 1];
274 struct ath10k_vif *arvif;
276 /* the following are protected by ar->data_lock */
277 u32 changed; /* IEEE80211_RC_* */
282 struct work_struct update_wk;
284 #ifdef CONFIG_MAC80211_DEBUGFS
285 /* protected by conf_mutex */
290 #define ATH10K_VDEV_SETUP_TIMEOUT_HZ (5*HZ)
292 enum ath10k_beacon_state {
293 ATH10K_BEACON_SCHEDULED = 0,
294 ATH10K_BEACON_SENDING,
299 struct list_head list;
302 enum wmi_vdev_type vdev_type;
303 enum wmi_vdev_subtype vdev_subtype;
306 struct sk_buff *beacon;
307 /* protected by data_lock */
308 enum ath10k_beacon_state beacon_state;
310 dma_addr_t beacon_paddr;
311 unsigned long tx_paused; /* arbitrary values defined by target */
314 struct ieee80211_vif *vif;
318 bool spectral_enabled;
323 struct ieee80211_key_conf *wep_keys[WMI_MAX_KEY_INDEX + 1];
337 u8 ssid[IEEE80211_MAX_SSID_LEN];
339 /* P2P_IE with NoA attribute for P2P_GO case */
347 int num_legacy_stations;
349 struct wmi_wmm_params_all_arg wmm_params;
350 struct work_struct ap_csa_work;
351 struct delayed_work connection_loss_work;
352 struct cfg80211_bitrate_mask bitrate_mask;
355 struct ath10k_vif_iter {
357 struct ath10k_vif *arvif;
360 /* used for crash-dump storage, protected by data-lock */
361 struct ath10k_fw_crash_data {
362 bool crashed_since_read;
365 struct timespec timestamp;
366 __le32 registers[REG_DUMP_COUNT_QCA988X];
369 struct ath10k_debug {
370 struct dentry *debugfs_phy;
372 struct ath10k_fw_stats fw_stats;
373 struct completion fw_stats_complete;
376 unsigned long htt_stats_mask;
377 struct delayed_work htt_stats_dwork;
378 struct ath10k_dfs_stats dfs_stats;
379 struct ath_dfs_pool_stats dfs_pool_stats;
381 /* protected by conf_mutex */
388 struct ath10k_fw_crash_data *fw_crash_data;
392 ATH10K_STATE_OFF = 0,
395 /* When doing firmware recovery the device is first powered down.
396 * mac80211 is supposed to call in to start() hook later on. It is
397 * however possible that driver unloading and firmware crash overlap.
398 * mac80211 can wait on conf_mutex in stop() while the device is
399 * stopped in ath10k_core_restart() work holding conf_mutex. The state
400 * RESTARTED means that the device is up and mac80211 has started hw
401 * reconfiguration. Once mac80211 is done with the reconfiguration we
402 * set the state to STATE_ON in reconfig_complete(). */
403 ATH10K_STATE_RESTARTING,
404 ATH10K_STATE_RESTARTED,
406 /* The device has crashed while restarting hw. This state is like ON
407 * but commands are blocked in HTC and -ECOMM response is given. This
408 * prevents completion timeouts and makes the driver more responsive to
409 * userspace commands. This is also prevents recursive recovery. */
416 enum ath10k_firmware_mode {
417 /* the default mode, standard 802.11 functionality */
418 ATH10K_FIRMWARE_MODE_NORMAL,
420 /* factory tests etc */
421 ATH10K_FIRMWARE_MODE_UTF,
424 enum ath10k_fw_features {
425 /* wmi_mgmt_rx_hdr contains extra RSSI information */
426 ATH10K_FW_FEATURE_EXT_WMI_MGMT_RX = 0,
428 /* Firmware from 10X branch. Deprecated, don't use in new code. */
429 ATH10K_FW_FEATURE_WMI_10X = 1,
431 /* firmware support tx frame management over WMI, otherwise it's HTT */
432 ATH10K_FW_FEATURE_HAS_WMI_MGMT_TX = 2,
434 /* Firmware does not support P2P */
435 ATH10K_FW_FEATURE_NO_P2P = 3,
437 /* Firmware 10.2 feature bit. The ATH10K_FW_FEATURE_WMI_10X feature
438 * bit is required to be set as well. Deprecated, don't use in new
441 ATH10K_FW_FEATURE_WMI_10_2 = 4,
443 /* Some firmware revisions lack proper multi-interface client powersave
444 * implementation. Enabling PS could result in connection drops,
445 * traffic stalls, etc.
447 ATH10K_FW_FEATURE_MULTI_VIF_PS_SUPPORT = 5,
449 /* Some firmware revisions have an incomplete WoWLAN implementation
450 * despite WMI service bit being advertised. This feature flag is used
451 * to distinguish whether WoWLAN is really supported or not.
453 ATH10K_FW_FEATURE_WOWLAN_SUPPORT = 6,
455 /* Don't trust error code from otp.bin */
456 ATH10K_FW_FEATURE_IGNORE_OTP_RESULT = 7,
458 /* Some firmware revisions pad 4th hw address to 4 byte boundary making
459 * it 8 bytes long in Native Wifi Rx decap.
461 ATH10K_FW_FEATURE_NO_NWIFI_DECAP_4ADDR_PADDING = 8,
463 /* Firmware supports bypassing PLL setting on init. */
464 ATH10K_FW_FEATURE_SUPPORTS_SKIP_CLOCK_INIT = 9,
466 /* Raw mode support. If supported, FW supports receiving and trasmitting
467 * frames in raw mode.
469 ATH10K_FW_FEATURE_RAW_MODE_SUPPORT = 10,
472 ATH10K_FW_FEATURE_COUNT,
475 enum ath10k_dev_flags {
476 /* Indicates that ath10k device is during CAC phase of DFS */
478 ATH10K_FLAG_CORE_REGISTERED,
480 /* Device has crashed and needs to restart. This indicates any pending
481 * waiters should immediately cancel instead of waiting for a time out.
483 ATH10K_FLAG_CRASH_FLUSH,
485 /* Use Raw mode instead of native WiFi Tx/Rx encap mode.
486 * Raw mode supports both hardware and software crypto. Native WiFi only
487 * supports hardware crypto.
489 ATH10K_FLAG_RAW_MODE,
491 /* Disable HW crypto engine */
492 ATH10K_FLAG_HW_CRYPTO_DISABLED,
495 enum ath10k_cal_mode {
496 ATH10K_CAL_MODE_FILE,
501 enum ath10k_crypt_mode {
502 /* Only use hardware crypto engine */
503 ATH10K_CRYPT_MODE_HW,
504 /* Only use software crypto engine */
505 ATH10K_CRYPT_MODE_SW,
508 static inline const char *ath10k_cal_mode_str(enum ath10k_cal_mode mode)
511 case ATH10K_CAL_MODE_FILE:
513 case ATH10K_CAL_MODE_OTP:
515 case ATH10K_CAL_MODE_DT:
522 enum ath10k_scan_state {
524 ATH10K_SCAN_STARTING,
526 ATH10K_SCAN_ABORTING,
529 static inline const char *ath10k_scan_state_str(enum ath10k_scan_state state)
532 case ATH10K_SCAN_IDLE:
534 case ATH10K_SCAN_STARTING:
536 case ATH10K_SCAN_RUNNING:
538 case ATH10K_SCAN_ABORTING:
545 enum ath10k_tx_pause_reason {
546 ATH10K_TX_PAUSE_Q_FULL,
551 struct ath_common ath_common;
552 struct ieee80211_hw *hw;
554 u8 mac_addr[ETH_ALEN];
556 enum ath10k_hw_rev hw_rev;
561 u32 fw_version_minor;
562 u16 fw_version_release;
563 u16 fw_version_build;
564 u32 fw_stats_req_mask;
571 u32 max_spatial_stream;
572 /* protected by conf_mutex */
575 DECLARE_BITMAP(fw_features, ATH10K_FW_FEATURE_COUNT);
581 const struct ath10k_hif_ops *ops;
584 struct completion target_suspend;
586 const struct ath10k_hw_regs *regs;
587 const struct ath10k_hw_values *hw_values;
588 struct ath10k_bmi bmi;
589 struct ath10k_wmi wmi;
590 struct ath10k_htc htc;
591 struct ath10k_htt htt;
593 struct ath10k_hw_params {
600 /* This is true if given HW chip has a quirky Cycle Counter
601 * wraparound which resets to 0x7fffffff instead of 0. All
602 * other CC related counters (e.g. Rx Clear Count) are divided
603 * by 2 so they never wraparound themselves.
605 bool has_shifted_cc_wraparound;
607 /* Some of chip expects fragment descriptor to be continuous
608 * memory for any TX operation. Set continuous_frag_desc flag
609 * for the hardware which have such requirement.
611 bool continuous_frag_desc;
613 u32 channel_counters_freq_hz;
615 struct ath10k_hw_params_fw {
621 size_t board_ext_size;
625 const struct firmware *board;
626 const void *board_data;
629 const struct firmware *otp;
630 const void *otp_data;
633 const struct firmware *firmware;
634 const void *firmware_data;
637 const struct firmware *cal_file;
640 const void *firmware_codeswap_data;
641 size_t firmware_codeswap_len;
642 struct ath10k_swap_code_seg_info *firmware_swap_code_seg_info;
645 char spec_board_id[100];
646 bool spec_board_loaded;
649 enum ath10k_cal_mode cal_mode;
652 struct completion started;
653 struct completion completed;
654 struct completion on_channel;
655 struct delayed_work timeout;
656 enum ath10k_scan_state state;
664 struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
667 /* should never be NULL; needed for regular htt rx */
668 struct ieee80211_channel *rx_channel;
670 /* valid during scan; needed for mgmt rx during scan */
671 struct ieee80211_channel *scan_channel;
673 /* current operating channel definition */
674 struct cfg80211_chan_def chandef;
676 unsigned long long free_vdev_map;
677 struct ath10k_vif *monitor_arvif;
680 bool monitor_started;
681 unsigned int filter_flags;
682 unsigned long dev_flags;
683 u32 dfs_block_radar_events;
685 /* protected by conf_mutex */
687 int num_started_vdevs;
689 /* Protected by conf-mutex */
690 u8 supp_tx_chainmask;
691 u8 supp_rx_chainmask;
695 struct completion install_key_done;
697 struct completion vdev_setup_done;
699 struct workqueue_struct *workqueue;
700 /* Auxiliary workqueue */
701 struct workqueue_struct *workqueue_aux;
703 /* prevents concurrent FW reconfiguration */
704 struct mutex conf_mutex;
706 /* protects shared structure data */
707 spinlock_t data_lock;
709 struct list_head arvifs;
710 struct list_head peers;
711 wait_queue_head_t peer_mapping_wq;
713 /* protected by conf_mutex */
718 int max_num_stations;
720 int max_num_tdls_vdevs;
721 int num_active_peers;
724 struct work_struct svc_rdy_work;
725 struct sk_buff *svc_rdy_skb;
727 struct work_struct offchan_tx_work;
728 struct sk_buff_head offchan_tx_queue;
729 struct completion offchan_tx_completed;
730 struct sk_buff *offchan_tx_skb;
732 struct work_struct wmi_mgmt_tx_work;
733 struct sk_buff_head wmi_mgmt_tx_queue;
735 enum ath10k_state state;
737 struct work_struct register_work;
738 struct work_struct restart_work;
740 /* cycle count is reported twice for each visited channel during scan.
741 * access protected by data_lock */
742 u32 survey_last_rx_clear_count;
743 u32 survey_last_cycle_count;
744 struct survey_info survey[ATH10K_NUM_CHANS];
746 /* Channel info events are expected to come in pairs without and with
747 * COMPLETE flag set respectively for each channel visit during scan.
749 * However there are deviations from this rule. This flag is used to
750 * avoid reporting garbage data.
752 bool ch_info_can_report_survey;
754 struct dfs_pattern_detector *dfs_detector;
756 unsigned long tx_paused; /* see ATH10K_TX_PAUSE_ */
758 #ifdef CONFIG_ATH10K_DEBUGFS
759 struct ath10k_debug debug;
763 /* relay(fs) channel for spectral scan */
764 struct rchan *rfs_chan_spec_scan;
766 /* spectral_mode and spec_config are protected by conf_mutex */
767 enum ath10k_spectral_mode mode;
768 struct ath10k_spec_scan config;
772 /* protected by conf_mutex */
773 const struct firmware *utf;
774 DECLARE_BITMAP(orig_fw_features, ATH10K_FW_FEATURE_COUNT);
775 enum ath10k_fw_wmi_op_version orig_wmi_op_version;
777 /* protected by data_lock */
782 /* protected by data_lock */
783 u32 fw_crash_counter;
784 u32 fw_warm_reset_counter;
785 u32 fw_cold_reset_counter;
788 struct ath10k_thermal thermal;
789 struct ath10k_wow wow;
792 u8 drv_priv[0] __aligned(sizeof(void *));
795 struct ath10k *ath10k_core_create(size_t priv_size, struct device *dev,
797 enum ath10k_hw_rev hw_rev,
798 const struct ath10k_hif_ops *hif_ops);
799 void ath10k_core_destroy(struct ath10k *ar);
800 void ath10k_core_get_fw_features_str(struct ath10k *ar,
804 int ath10k_core_start(struct ath10k *ar, enum ath10k_firmware_mode mode);
805 int ath10k_wait_for_suspend(struct ath10k *ar, u32 suspend_opt);
806 void ath10k_core_stop(struct ath10k *ar);
807 int ath10k_core_register(struct ath10k *ar, u32 chip_id);
808 void ath10k_core_unregister(struct ath10k *ar);
810 #endif /* _CORE_H_ */