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;
95 struct ath10k_htt_txbuf *txbuf;
105 struct ath10k_skb_rxcb {
107 struct hlist_node hlist;
110 static inline struct ath10k_skb_cb *ATH10K_SKB_CB(struct sk_buff *skb)
112 BUILD_BUG_ON(sizeof(struct ath10k_skb_cb) >
113 IEEE80211_TX_INFO_DRIVER_DATA_SIZE);
114 return (struct ath10k_skb_cb *)&IEEE80211_SKB_CB(skb)->driver_data;
117 static inline struct ath10k_skb_rxcb *ATH10K_SKB_RXCB(struct sk_buff *skb)
119 BUILD_BUG_ON(sizeof(struct ath10k_skb_rxcb) > sizeof(skb->cb));
120 return (struct ath10k_skb_rxcb *)skb->cb;
123 #define ATH10K_RXCB_SKB(rxcb) \
124 container_of((void *)rxcb, struct sk_buff, cb)
126 static inline u32 host_interest_item_address(u32 item_offset)
128 return QCA988X_HOST_INTEREST_ADDRESS + item_offset;
135 struct ath10k_mem_chunk {
143 enum ath10k_fw_wmi_op_version op_version;
144 enum ath10k_htc_ep_id eid;
145 struct completion service_ready;
146 struct completion unified_ready;
147 wait_queue_head_t tx_credits_wq;
148 DECLARE_BITMAP(svc_map, WMI_SERVICE_MAX);
149 struct wmi_cmd_map *cmd;
150 struct wmi_vdev_param_map *vdev_param;
151 struct wmi_pdev_param_map *pdev_param;
152 const struct wmi_ops *ops;
155 struct ath10k_mem_chunk mem_chunks[WMI_MAX_MEM_REQS];
158 struct ath10k_fw_stats_peer {
159 struct list_head list;
161 u8 peer_macaddr[ETH_ALEN];
164 u32 peer_rx_rate; /* 10x only */
167 struct ath10k_fw_stats_vdev {
168 struct list_head list;
173 u32 num_tx_frames[4];
175 u32 num_tx_frames_retries[4];
176 u32 num_tx_frames_failures[4];
181 u32 num_tx_not_acked;
182 u32 tx_rate_history[10];
183 u32 beacon_rssi_history[10];
186 struct ath10k_fw_stats_pdev {
187 struct list_head list;
220 u32 sw_retry_failure;
221 u32 illgl_rate_phy_err;
222 u32 pdev_cont_xretry;
229 s32 mid_ppdu_route_change;
245 struct ath10k_fw_stats {
246 struct list_head pdevs;
247 struct list_head vdevs;
248 struct list_head peers;
251 struct ath10k_dfs_stats {
255 u32 pulses_discarded;
259 #define ATH10K_MAX_NUM_PEER_IDS (1 << 11) /* htt rx_desc limit */
262 struct list_head list;
265 DECLARE_BITMAP(peer_ids, ATH10K_MAX_NUM_PEER_IDS);
267 /* protected by ar->data_lock */
268 struct ieee80211_key_conf *keys[WMI_MAX_KEY_INDEX + 1];
272 struct ath10k_vif *arvif;
274 /* the following are protected by ar->data_lock */
275 u32 changed; /* IEEE80211_RC_* */
280 struct work_struct update_wk;
282 #ifdef CONFIG_MAC80211_DEBUGFS
283 /* protected by conf_mutex */
288 #define ATH10K_VDEV_SETUP_TIMEOUT_HZ (5*HZ)
290 enum ath10k_beacon_state {
291 ATH10K_BEACON_SCHEDULED = 0,
292 ATH10K_BEACON_SENDING,
297 struct list_head list;
300 enum wmi_vdev_type vdev_type;
301 enum wmi_vdev_subtype vdev_subtype;
304 struct sk_buff *beacon;
305 /* protected by data_lock */
306 enum ath10k_beacon_state beacon_state;
308 dma_addr_t beacon_paddr;
309 unsigned long tx_paused; /* arbitrary values defined by target */
312 struct ieee80211_vif *vif;
316 bool spectral_enabled;
321 struct ieee80211_key_conf *wep_keys[WMI_MAX_KEY_INDEX + 1];
335 u8 ssid[IEEE80211_MAX_SSID_LEN];
337 /* P2P_IE with NoA attribute for P2P_GO case */
344 int num_legacy_stations;
346 struct wmi_wmm_params_all_arg wmm_params;
347 struct work_struct ap_csa_work;
348 struct delayed_work connection_loss_work;
349 struct cfg80211_bitrate_mask bitrate_mask;
352 struct ath10k_vif_iter {
354 struct ath10k_vif *arvif;
357 /* used for crash-dump storage, protected by data-lock */
358 struct ath10k_fw_crash_data {
359 bool crashed_since_read;
362 struct timespec timestamp;
363 __le32 registers[REG_DUMP_COUNT_QCA988X];
366 struct ath10k_debug {
367 struct dentry *debugfs_phy;
369 struct ath10k_fw_stats fw_stats;
370 struct completion fw_stats_complete;
373 unsigned long htt_stats_mask;
374 struct delayed_work htt_stats_dwork;
375 struct ath10k_dfs_stats dfs_stats;
376 struct ath_dfs_pool_stats dfs_pool_stats;
378 /* 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,
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,
463 /* Firmware supports bypassing PLL setting on init. */
464 ATH10K_FW_FEATURE_SUPPORTS_SKIP_CLOCK_INIT = 9,
467 ATH10K_FW_FEATURE_COUNT,
470 enum ath10k_dev_flags {
471 /* Indicates that ath10k device is during CAC phase of DFS */
473 ATH10K_FLAG_CORE_REGISTERED,
475 /* Device has crashed and needs to restart. This indicates any pending
476 * waiters should immediately cancel instead of waiting for a time out.
478 ATH10K_FLAG_CRASH_FLUSH,
481 enum ath10k_cal_mode {
482 ATH10K_CAL_MODE_FILE,
487 static inline const char *ath10k_cal_mode_str(enum ath10k_cal_mode mode)
490 case ATH10K_CAL_MODE_FILE:
492 case ATH10K_CAL_MODE_OTP:
494 case ATH10K_CAL_MODE_DT:
501 enum ath10k_scan_state {
503 ATH10K_SCAN_STARTING,
505 ATH10K_SCAN_ABORTING,
508 static inline const char *ath10k_scan_state_str(enum ath10k_scan_state state)
511 case ATH10K_SCAN_IDLE:
513 case ATH10K_SCAN_STARTING:
515 case ATH10K_SCAN_RUNNING:
517 case ATH10K_SCAN_ABORTING:
524 enum ath10k_tx_pause_reason {
525 ATH10K_TX_PAUSE_Q_FULL,
530 struct ath_common ath_common;
531 struct ieee80211_hw *hw;
533 u8 mac_addr[ETH_ALEN];
535 enum ath10k_hw_rev hw_rev;
539 u32 fw_version_minor;
540 u16 fw_version_release;
541 u16 fw_version_build;
542 u32 fw_stats_req_mask;
549 u32 max_spatial_stream;
550 /* protected by conf_mutex */
553 DECLARE_BITMAP(fw_features, ATH10K_FW_FEATURE_COUNT);
559 const struct ath10k_hif_ops *ops;
562 struct completion target_suspend;
564 const struct ath10k_hw_regs *regs;
565 const struct ath10k_hw_values *hw_values;
566 struct ath10k_bmi bmi;
567 struct ath10k_wmi wmi;
568 struct ath10k_htc htc;
569 struct ath10k_htt htt;
571 struct ath10k_hw_params {
578 /* This is true if given HW chip has a quirky Cycle Counter
579 * wraparound which resets to 0x7fffffff instead of 0. All
580 * other CC related counters (e.g. Rx Clear Count) are divided
581 * by 2 so they never wraparound themselves.
583 bool has_shifted_cc_wraparound;
585 /* Some of chip expects fragment descriptor to be continuous
586 * memory for any TX operation. Set continuous_frag_desc flag
587 * for the hardware which have such requirement.
589 bool continuous_frag_desc;
591 struct ath10k_hw_params_fw {
597 size_t board_ext_size;
601 const struct firmware *board;
602 const void *board_data;
605 const struct firmware *otp;
606 const void *otp_data;
609 const struct firmware *firmware;
610 const void *firmware_data;
613 const struct firmware *cal_file;
616 const void *firmware_codeswap_data;
617 size_t firmware_codeswap_len;
618 struct ath10k_swap_code_seg_info *firmware_swap_code_seg_info;
621 char spec_board_id[100];
622 bool spec_board_loaded;
625 enum ath10k_cal_mode cal_mode;
628 struct completion started;
629 struct completion completed;
630 struct completion on_channel;
631 struct delayed_work timeout;
632 enum ath10k_scan_state state;
639 struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
642 /* should never be NULL; needed for regular htt rx */
643 struct ieee80211_channel *rx_channel;
645 /* valid during scan; needed for mgmt rx during scan */
646 struct ieee80211_channel *scan_channel;
648 /* current operating channel definition */
649 struct cfg80211_chan_def chandef;
651 unsigned long long free_vdev_map;
652 struct ath10k_vif *monitor_arvif;
655 bool monitor_started;
656 unsigned int filter_flags;
657 unsigned long dev_flags;
658 u32 dfs_block_radar_events;
660 /* protected by conf_mutex */
662 int num_started_vdevs;
664 /* Protected by conf-mutex */
665 u8 supp_tx_chainmask;
666 u8 supp_rx_chainmask;
670 struct completion install_key_done;
672 struct completion vdev_setup_done;
674 struct workqueue_struct *workqueue;
676 /* prevents concurrent FW reconfiguration */
677 struct mutex conf_mutex;
679 /* protects shared structure data */
680 spinlock_t data_lock;
682 struct list_head arvifs;
683 struct list_head peers;
684 wait_queue_head_t peer_mapping_wq;
686 /* protected by conf_mutex */
691 int max_num_stations;
693 int max_num_tdls_vdevs;
694 int num_active_peers;
697 struct work_struct offchan_tx_work;
698 struct sk_buff_head offchan_tx_queue;
699 struct completion offchan_tx_completed;
700 struct sk_buff *offchan_tx_skb;
702 struct work_struct wmi_mgmt_tx_work;
703 struct sk_buff_head wmi_mgmt_tx_queue;
705 enum ath10k_state state;
707 struct work_struct register_work;
708 struct work_struct restart_work;
710 /* cycle count is reported twice for each visited channel during scan.
711 * access protected by data_lock */
712 u32 survey_last_rx_clear_count;
713 u32 survey_last_cycle_count;
714 struct survey_info survey[ATH10K_NUM_CHANS];
716 /* Channel info events are expected to come in pairs without and with
717 * COMPLETE flag set respectively for each channel visit during scan.
719 * However there are deviations from this rule. This flag is used to
720 * avoid reporting garbage data.
722 bool ch_info_can_report_survey;
724 struct dfs_pattern_detector *dfs_detector;
726 unsigned long tx_paused; /* see ATH10K_TX_PAUSE_ */
728 #ifdef CONFIG_ATH10K_DEBUGFS
729 struct ath10k_debug debug;
733 /* relay(fs) channel for spectral scan */
734 struct rchan *rfs_chan_spec_scan;
736 /* spectral_mode and spec_config are protected by conf_mutex */
737 enum ath10k_spectral_mode mode;
738 struct ath10k_spec_scan config;
742 /* protected by conf_mutex */
743 const struct firmware *utf;
744 DECLARE_BITMAP(orig_fw_features, ATH10K_FW_FEATURE_COUNT);
745 enum ath10k_fw_wmi_op_version orig_wmi_op_version;
747 /* protected by data_lock */
752 /* protected by data_lock */
753 u32 fw_crash_counter;
754 u32 fw_warm_reset_counter;
755 u32 fw_cold_reset_counter;
758 struct ath10k_thermal thermal;
759 struct ath10k_wow wow;
762 u8 drv_priv[0] __aligned(sizeof(void *));
765 struct ath10k *ath10k_core_create(size_t priv_size, struct device *dev,
767 enum ath10k_hw_rev hw_rev,
768 const struct ath10k_hif_ops *hif_ops);
769 void ath10k_core_destroy(struct ath10k *ar);
770 void ath10k_core_get_fw_features_str(struct ath10k *ar,
774 int ath10k_core_start(struct ath10k *ar, enum ath10k_firmware_mode mode);
775 int ath10k_wait_for_suspend(struct ath10k *ar, u32 suspend_opt);
776 void ath10k_core_stop(struct ath10k *ar);
777 int ath10k_core_register(struct ath10k *ar, u32 chip_id);
778 void ath10k_core_unregister(struct ath10k *ar);
780 #endif /* _CORE_H_ */