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 #define ATH10K_TPC_TABLE_TYPE_FLAG 1
254 #define ATH10K_TPC_PREAM_TABLE_END 0xFFFF
256 struct ath10k_tpc_table {
257 u32 pream_idx[WMI_TPC_RATE_MAX];
258 u8 rate_code[WMI_TPC_RATE_MAX];
259 char tpc_value[WMI_TPC_RATE_MAX][WMI_TPC_TX_N_CHAIN * WMI_TPC_BUF_SIZE];
262 struct ath10k_tpc_stats {
266 u32 twice_antenna_reduction;
267 u32 twice_max_rd_power;
268 s32 twice_antenna_gain;
273 u8 flag[WMI_TPC_FLAG];
274 struct ath10k_tpc_table tpc_table[WMI_TPC_FLAG];
277 struct ath10k_dfs_stats {
281 u32 pulses_discarded;
285 #define ATH10K_MAX_NUM_PEER_IDS (1 << 11) /* htt rx_desc limit */
288 struct list_head list;
291 DECLARE_BITMAP(peer_ids, ATH10K_MAX_NUM_PEER_IDS);
293 /* protected by ar->data_lock */
294 struct ieee80211_key_conf *keys[WMI_MAX_KEY_INDEX + 1];
298 struct ath10k_vif *arvif;
300 /* the following are protected by ar->data_lock */
301 u32 changed; /* IEEE80211_RC_* */
306 struct work_struct update_wk;
308 #ifdef CONFIG_MAC80211_DEBUGFS
309 /* protected by conf_mutex */
314 #define ATH10K_VDEV_SETUP_TIMEOUT_HZ (5*HZ)
316 enum ath10k_beacon_state {
317 ATH10K_BEACON_SCHEDULED = 0,
318 ATH10K_BEACON_SENDING,
323 struct list_head list;
326 enum wmi_vdev_type vdev_type;
327 enum wmi_vdev_subtype vdev_subtype;
330 struct sk_buff *beacon;
331 /* protected by data_lock */
332 enum ath10k_beacon_state beacon_state;
334 dma_addr_t beacon_paddr;
335 unsigned long tx_paused; /* arbitrary values defined by target */
338 struct ieee80211_vif *vif;
342 bool spectral_enabled;
347 struct ieee80211_key_conf *wep_keys[WMI_MAX_KEY_INDEX + 1];
361 u8 ssid[IEEE80211_MAX_SSID_LEN];
363 /* P2P_IE with NoA attribute for P2P_GO case */
371 int num_legacy_stations;
373 struct wmi_wmm_params_all_arg wmm_params;
374 struct work_struct ap_csa_work;
375 struct delayed_work connection_loss_work;
376 struct cfg80211_bitrate_mask bitrate_mask;
379 struct ath10k_vif_iter {
381 struct ath10k_vif *arvif;
384 /* used for crash-dump storage, protected by data-lock */
385 struct ath10k_fw_crash_data {
386 bool crashed_since_read;
389 struct timespec timestamp;
390 __le32 registers[REG_DUMP_COUNT_QCA988X];
393 struct ath10k_debug {
394 struct dentry *debugfs_phy;
396 struct ath10k_fw_stats fw_stats;
397 struct completion fw_stats_complete;
400 unsigned long htt_stats_mask;
401 struct delayed_work htt_stats_dwork;
402 struct ath10k_dfs_stats dfs_stats;
403 struct ath_dfs_pool_stats dfs_pool_stats;
405 /* used for tpc-dump storage, protected by data-lock */
406 struct ath10k_tpc_stats *tpc_stats;
408 struct completion tpc_complete;
410 /* protected by conf_mutex */
417 struct ath10k_fw_crash_data *fw_crash_data;
421 ATH10K_STATE_OFF = 0,
424 /* When doing firmware recovery the device is first powered down.
425 * mac80211 is supposed to call in to start() hook later on. It is
426 * however possible that driver unloading and firmware crash overlap.
427 * mac80211 can wait on conf_mutex in stop() while the device is
428 * stopped in ath10k_core_restart() work holding conf_mutex. The state
429 * RESTARTED means that the device is up and mac80211 has started hw
430 * reconfiguration. Once mac80211 is done with the reconfiguration we
431 * set the state to STATE_ON in reconfig_complete(). */
432 ATH10K_STATE_RESTARTING,
433 ATH10K_STATE_RESTARTED,
435 /* The device has crashed while restarting hw. This state is like ON
436 * but commands are blocked in HTC and -ECOMM response is given. This
437 * prevents completion timeouts and makes the driver more responsive to
438 * userspace commands. This is also prevents recursive recovery. */
445 enum ath10k_firmware_mode {
446 /* the default mode, standard 802.11 functionality */
447 ATH10K_FIRMWARE_MODE_NORMAL,
449 /* factory tests etc */
450 ATH10K_FIRMWARE_MODE_UTF,
453 enum ath10k_fw_features {
454 /* wmi_mgmt_rx_hdr contains extra RSSI information */
455 ATH10K_FW_FEATURE_EXT_WMI_MGMT_RX = 0,
457 /* Firmware from 10X branch. Deprecated, don't use in new code. */
458 ATH10K_FW_FEATURE_WMI_10X = 1,
460 /* firmware support tx frame management over WMI, otherwise it's HTT */
461 ATH10K_FW_FEATURE_HAS_WMI_MGMT_TX = 2,
463 /* Firmware does not support P2P */
464 ATH10K_FW_FEATURE_NO_P2P = 3,
466 /* Firmware 10.2 feature bit. The ATH10K_FW_FEATURE_WMI_10X feature
467 * bit is required to be set as well. Deprecated, don't use in new
470 ATH10K_FW_FEATURE_WMI_10_2 = 4,
472 /* Some firmware revisions lack proper multi-interface client powersave
473 * implementation. Enabling PS could result in connection drops,
474 * traffic stalls, etc.
476 ATH10K_FW_FEATURE_MULTI_VIF_PS_SUPPORT = 5,
478 /* Some firmware revisions have an incomplete WoWLAN implementation
479 * despite WMI service bit being advertised. This feature flag is used
480 * to distinguish whether WoWLAN is really supported or not.
482 ATH10K_FW_FEATURE_WOWLAN_SUPPORT = 6,
484 /* Don't trust error code from otp.bin */
485 ATH10K_FW_FEATURE_IGNORE_OTP_RESULT = 7,
487 /* Some firmware revisions pad 4th hw address to 4 byte boundary making
488 * it 8 bytes long in Native Wifi Rx decap.
490 ATH10K_FW_FEATURE_NO_NWIFI_DECAP_4ADDR_PADDING = 8,
492 /* Firmware supports bypassing PLL setting on init. */
493 ATH10K_FW_FEATURE_SUPPORTS_SKIP_CLOCK_INIT = 9,
495 /* Raw mode support. If supported, FW supports receiving and trasmitting
496 * frames in raw mode.
498 ATH10K_FW_FEATURE_RAW_MODE_SUPPORT = 10,
501 ATH10K_FW_FEATURE_COUNT,
504 enum ath10k_dev_flags {
505 /* Indicates that ath10k device is during CAC phase of DFS */
507 ATH10K_FLAG_CORE_REGISTERED,
509 /* Device has crashed and needs to restart. This indicates any pending
510 * waiters should immediately cancel instead of waiting for a time out.
512 ATH10K_FLAG_CRASH_FLUSH,
514 /* Use Raw mode instead of native WiFi Tx/Rx encap mode.
515 * Raw mode supports both hardware and software crypto. Native WiFi only
516 * supports hardware crypto.
518 ATH10K_FLAG_RAW_MODE,
520 /* Disable HW crypto engine */
521 ATH10K_FLAG_HW_CRYPTO_DISABLED,
524 enum ath10k_cal_mode {
525 ATH10K_CAL_MODE_FILE,
530 enum ath10k_crypt_mode {
531 /* Only use hardware crypto engine */
532 ATH10K_CRYPT_MODE_HW,
533 /* Only use software crypto engine */
534 ATH10K_CRYPT_MODE_SW,
537 static inline const char *ath10k_cal_mode_str(enum ath10k_cal_mode mode)
540 case ATH10K_CAL_MODE_FILE:
542 case ATH10K_CAL_MODE_OTP:
544 case ATH10K_CAL_MODE_DT:
551 enum ath10k_scan_state {
553 ATH10K_SCAN_STARTING,
555 ATH10K_SCAN_ABORTING,
558 static inline const char *ath10k_scan_state_str(enum ath10k_scan_state state)
561 case ATH10K_SCAN_IDLE:
563 case ATH10K_SCAN_STARTING:
565 case ATH10K_SCAN_RUNNING:
567 case ATH10K_SCAN_ABORTING:
574 enum ath10k_tx_pause_reason {
575 ATH10K_TX_PAUSE_Q_FULL,
580 struct ath_common ath_common;
581 struct ieee80211_hw *hw;
583 u8 mac_addr[ETH_ALEN];
585 enum ath10k_hw_rev hw_rev;
590 u32 fw_version_minor;
591 u16 fw_version_release;
592 u16 fw_version_build;
593 u32 fw_stats_req_mask;
600 u32 max_spatial_stream;
601 /* protected by conf_mutex */
604 DECLARE_BITMAP(fw_features, ATH10K_FW_FEATURE_COUNT);
610 const struct ath10k_hif_ops *ops;
613 struct completion target_suspend;
615 const struct ath10k_hw_regs *regs;
616 const struct ath10k_hw_values *hw_values;
617 struct ath10k_bmi bmi;
618 struct ath10k_wmi wmi;
619 struct ath10k_htc htc;
620 struct ath10k_htt htt;
622 struct ath10k_hw_params {
629 /* This is true if given HW chip has a quirky Cycle Counter
630 * wraparound which resets to 0x7fffffff instead of 0. All
631 * other CC related counters (e.g. Rx Clear Count) are divided
632 * by 2 so they never wraparound themselves.
634 bool has_shifted_cc_wraparound;
636 /* Some of chip expects fragment descriptor to be continuous
637 * memory for any TX operation. Set continuous_frag_desc flag
638 * for the hardware which have such requirement.
640 bool continuous_frag_desc;
642 u32 channel_counters_freq_hz;
644 /* Mgmt tx descriptors threshold for limiting probe response
647 u32 max_probe_resp_desc_thres;
649 struct ath10k_hw_params_fw {
655 size_t board_ext_size;
659 const struct firmware *board;
660 const void *board_data;
663 const struct firmware *otp;
664 const void *otp_data;
667 const struct firmware *firmware;
668 const void *firmware_data;
671 const struct firmware *cal_file;
674 const void *firmware_codeswap_data;
675 size_t firmware_codeswap_len;
676 struct ath10k_swap_code_seg_info *firmware_swap_code_seg_info;
682 u32 subsystem_vendor;
683 u32 subsystem_device;
692 enum ath10k_cal_mode cal_mode;
695 struct completion started;
696 struct completion completed;
697 struct completion on_channel;
698 struct delayed_work timeout;
699 enum ath10k_scan_state state;
707 struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
710 /* should never be NULL; needed for regular htt rx */
711 struct ieee80211_channel *rx_channel;
713 /* valid during scan; needed for mgmt rx during scan */
714 struct ieee80211_channel *scan_channel;
716 /* current operating channel definition */
717 struct cfg80211_chan_def chandef;
719 unsigned long long free_vdev_map;
720 struct ath10k_vif *monitor_arvif;
723 bool monitor_started;
724 unsigned int filter_flags;
725 unsigned long dev_flags;
726 u32 dfs_block_radar_events;
728 /* protected by conf_mutex */
730 int num_started_vdevs;
732 /* Protected by conf-mutex */
733 u8 supp_tx_chainmask;
734 u8 supp_rx_chainmask;
738 struct completion install_key_done;
740 struct completion vdev_setup_done;
742 struct workqueue_struct *workqueue;
743 /* Auxiliary workqueue */
744 struct workqueue_struct *workqueue_aux;
746 /* prevents concurrent FW reconfiguration */
747 struct mutex conf_mutex;
749 /* protects shared structure data */
750 spinlock_t data_lock;
752 struct list_head arvifs;
753 struct list_head peers;
754 wait_queue_head_t peer_mapping_wq;
756 /* protected by conf_mutex */
761 int max_num_stations;
763 int max_num_tdls_vdevs;
764 int num_active_peers;
767 struct work_struct svc_rdy_work;
768 struct sk_buff *svc_rdy_skb;
770 struct work_struct offchan_tx_work;
771 struct sk_buff_head offchan_tx_queue;
772 struct completion offchan_tx_completed;
773 struct sk_buff *offchan_tx_skb;
775 struct work_struct wmi_mgmt_tx_work;
776 struct sk_buff_head wmi_mgmt_tx_queue;
778 enum ath10k_state state;
780 struct work_struct register_work;
781 struct work_struct restart_work;
783 /* cycle count is reported twice for each visited channel during scan.
784 * access protected by data_lock */
785 u32 survey_last_rx_clear_count;
786 u32 survey_last_cycle_count;
787 struct survey_info survey[ATH10K_NUM_CHANS];
789 /* Channel info events are expected to come in pairs without and with
790 * COMPLETE flag set respectively for each channel visit during scan.
792 * However there are deviations from this rule. This flag is used to
793 * avoid reporting garbage data.
795 bool ch_info_can_report_survey;
797 struct dfs_pattern_detector *dfs_detector;
799 unsigned long tx_paused; /* see ATH10K_TX_PAUSE_ */
801 #ifdef CONFIG_ATH10K_DEBUGFS
802 struct ath10k_debug debug;
806 /* relay(fs) channel for spectral scan */
807 struct rchan *rfs_chan_spec_scan;
809 /* spectral_mode and spec_config are protected by conf_mutex */
810 enum ath10k_spectral_mode mode;
811 struct ath10k_spec_scan config;
815 /* protected by conf_mutex */
816 const struct firmware *utf;
817 DECLARE_BITMAP(orig_fw_features, ATH10K_FW_FEATURE_COUNT);
818 enum ath10k_fw_wmi_op_version orig_wmi_op_version;
820 /* protected by data_lock */
825 /* protected by data_lock */
826 u32 fw_crash_counter;
827 u32 fw_warm_reset_counter;
828 u32 fw_cold_reset_counter;
831 struct ath10k_thermal thermal;
832 struct ath10k_wow wow;
835 u8 drv_priv[0] __aligned(sizeof(void *));
838 struct ath10k *ath10k_core_create(size_t priv_size, struct device *dev,
840 enum ath10k_hw_rev hw_rev,
841 const struct ath10k_hif_ops *hif_ops);
842 void ath10k_core_destroy(struct ath10k *ar);
843 void ath10k_core_get_fw_features_str(struct ath10k *ar,
847 int ath10k_core_start(struct ath10k *ar, enum ath10k_firmware_mode mode);
848 int ath10k_wait_for_suspend(struct ath10k *ar, u32 suspend_opt);
849 void ath10k_core_stop(struct ath10k *ar);
850 int ath10k_core_register(struct ath10k *ar, u32 chip_id);
851 void ath10k_core_unregister(struct ath10k *ar);
853 #endif /* _CORE_H_ */